MOSTLY DEAD AND UNMAINTAINED

Joint

MongoMapper and GridFS joined in file upload love.

Updated for MongoMapper 0.15.x and Mongo Ruby driver 2.16.x

This version brings Joint into the (near) current world of the Mongo Ruby driver 2.x series. I've targeted MongoMapper 0.15.x and Mongo driver 2.16.x as a first step bridge between the old Mongo driver 1.x and more recent versions. Although I am not currently developing any Ruby projects using Joint, I had an itch to scratch on a very large old project that I wanted to make run on recenct Mongodb versions (my code was stuck on Mongodb 3.2).

I targeted Mongo driver 2.16.x because it is compatible with Mongodb versions from 2.6 to 5.0 and Ruby versions from 2.4 to 3.0

Mostly Dead

As such, this project is still mostly dead, but I will likely update this for newer MongoMapper and Mongo Ruby driver versions.

Usage

Declare the plugin and use the attachment method to make attachments.

class Foo
  include MongoMapper::Document
  plugin Joint

  attachment :file
  attachment :image
  attachment :pdf
end

This gives you #file, #file=, #image, #image=, #pdf, and #pdf=. The = methods take any IO that responds to read() (File, Tempfile, etc).

The file(), image() and pdf() methods return a Mongo::Grid::FSBucket::Stream::Read instance (can be found in the ruby driver).

Also, #file, #image and #pdf are instances of Joint::AttachmentProxy so you can do stuff like:

doc.image.id, doc.image.size, doc.image.type, doc.image.name

If you call a method other than those in the proxy it calls it on the GridIO instance so you can still get at all the GridIO instance methods.

AttachmentProxy#method_missing(..) has been removed as the Mongo Ruby driver has changed dramatically. Instead, methods are include to get the info from the driver.

content_type(), file_id(), filename(), file_length(), upload_date()

For consistency with the Joint API, file_size() is aliased to file_length(). These are methods on instances of Grid::File::Info

Note on Patches/Pull Requests

• Fork the project.
• Make your feature addition or bug fix.
• Add tests for it. This is important so I don't break it in a future version unintentionally.
• Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
• Send me a pull request. Bonus points for topic branches.

Main authors

This gem was originally created and maintained by John Nunemaker. Blake Carlson made important updates after John stopped mainting the code. I've taken Blake's fork, forked that and updated the code for Mongo driver 2.16.

Copyright

Copyright (c) 2010 John Nunemaker. See LICENSE for details.