mongo_odm_grid 0.0.1

data/README.txt

@@ -0,0 +1,45 @@
+Summary
+
+   MongoODM::Document::Grid is a Grid plugin for MongoODM
+
+   Support is built in for rack_grid and rack_grid_thumb to generate URLS and thumbnails:
+     http://github.com/dusty/rack_grid
+     http://github.com/dusty/rack_grid_thumb
+
+Installation
+
+  # gem install mongo_odm_grid
+
+Usage
+
+  require 'mongo_odm_grid'
+
+  class Monkey
+    include MongoODM::Document::Grid
+
+    attachment :image, :prefix => :grid
+  end
+
+  m = Monkey.new(:name => 'name')
+  m.save
+
+  # To add an attachment
+  m.image = File.open('/tmp/me.jpg')
+  m.save
+
+  # To remove an attachment
+  m.image = nil
+  m.save
+
+  # To get the attachment
+  m.image.read
+
+  # To get the URL for rack_grid
+  m.image_url                          # /grid/4e049e7c69c3b27d53000005/me.jpg
+
+  # To get the thumbail URL for rack_grid_thumb
+  m.image_thumb('50x50')               # /grid/4e049e7c69c3b27d53000005/me_50x50.jpg
+
+Inspired By
+  - http://github.com/jnunemaker/joint
+

data/lib/mongo_odm_grid.rb

@@ -0,0 +1,243 @@
+require 'mime/types'
+
+module MongoODM
+  module Document
+    module Grid
+
+      def self.included(base)
+        base.send(:include, InstanceMethods)
+        base.send(:extend, ClassMethods)
+      end
+
+      module ClassMethods
+
+        ##
+        # Declare an attachment for the object
+        #
+        # eg: attachment :image
+        def attachment(name,options={})
+          prefix = options[:prefix] ||= :grid
+
+          ##
+          # Callbacks to handle the attachment saving and deleting
+          after_save     :create_attachments
+          after_save     :delete_attachments
+          after_destroy  :queue_delete_attachments
+          after_destroy  :delete_attachments
+
+          ##
+          # Fields for the attachment.
+          #
+          # Only the _id is really needed, the others are helpful cached
+          # so you don't need to hit GridFS
+          field "#{name}_id".to_sym,   BSON::ObjectId
+          field "#{name}_name".to_sym, String
+          field "#{name}_size".to_sym, Integer
+          field "#{name}_type".to_sym, String
+
+          ##
+          # Add this name to the attachment_types
+          attachment_types.push(name).uniq!
+
+          ##
+          # Return the Grid object.
+          # eg: image.filename, image.read
+          define_method(name) do
+            grid.get(read_attribute("#{name}_id")) if read_attribute("#{name}_id")
+          end
+
+          ##
+          # Create a method to set the attachment
+          # eg: object.image = File.open('/tmp/somefile.jpg')
+          define_method("#{name}=") do |file|
+            # delete the old file if it exists
+            unless read_attribute("#{name}_id").blank?
+              send(:delete_attachment, name, read_attribute("#{name}_id"))
+            end
+            case
+            when file.is_a?(Hash) && file[:tempfile]
+              send(:create_attachment, name, file)
+            when file.respond_to?(:read)
+              send(:create_attachment, name, file)
+            end
+          end
+
+          ##
+          # Create a method to set the attachment for binary string.
+          # eg: object.set_image(binary_string, "generated_filename.png")
+          define_method("set_#{name}") do |binary, filename|
+            if !binary.nil?
+              send(:create_attachment_raw, name, binary, filename)
+            else
+              send(:delete_attachment, name, read_attribute("#{name}_id"))
+            end
+          end
+
+          ##
+          # Unset the attachment, queue for removal
+          define_method("unset_#{name}") do
+            send(:delete_attachment, name, read_attribute("#{name}_id"))
+          end
+
+          ##
+          # Return the relative URL to the attachment for use with Rack::Grid
+          # eg: /grid/4ba69fde8c8f369a6e000003/somefile.png
+          define_method("#{name}_url") do
+            _id   = read_attribute("#{name}_id")
+            _name = read_attribute("#{name}_name")
+            ["/#{prefix}", _id, _name].join('/') if _id && _name
+          end
+
+          ##
+          # Return the relative URL to the thumbnail for use with Rack::GridThumb
+          # eg: /grid/4ba69fde8c8f369a6e000003/somefile_50x.png
+          define_method("#{name}_thumb") do |thumb|
+            _id   = read_attribute("#{name}_id")
+            _name = read_attribute("#{name}_name")
+            _ext  = File.extname(_name)
+            _base = File.basename(_name,_ext)
+            _name = "#{_base}_#{thumb}#{_ext}"
+            ["/#{prefix}", _id, _name].join('/') if _id && _name
+          end
+        end
+
+        ##
+        # Accessor to Grid
+        def grid
+          @grid ||= Mongo::Grid.new(MongoODM.database)
+        end
+
+        ##
+        # All the attachments types for this class
+        def attachment_types
+          @attachment_types ||= []
+        end
+
+      end
+
+      module InstanceMethods
+
+        ##
+        # Accessor to Grid
+        def grid
+          self.class.grid
+        end
+
+        private
+        ##
+        # Holds queue of attachments to create
+        def create_attachment_queue
+          @create_attachment_queue ||= {}
+        end
+
+        ##
+        # Holds queue of attachments to delete
+        def delete_attachment_queue
+          @delete_attachment_queue ||= {}
+        end
+
+        ##
+        # Attachments we need to add after save.
+        def create_attachment(name,file)
+          case
+          when file.is_a?(Hash)
+            filename = file[:filename]
+            size     = File.size(file[:tempfile])
+            mime     = file[:type]
+            unless mime
+              type = MIME::Types.type_for(filename).first
+              mime = type ? type.content_type : "application/octet-stream"
+            end
+          when file.respond_to?(:read)
+            filename = case
+            when file.respond_to?(:original_filename) && file.original_filename
+              file.original_filename
+            when file.respond_to?(:tempfile)
+              File.basename(file.tempfile.path)
+            else
+              File.basename(file.path)
+            end
+            size = File.size(file.respond_to?(:tempfile) ? file.tempfile : file)
+            type = MIME::Types.type_for(filename).first
+            mime = type ? type.content_type : "application/octet-stream"
+          else
+            return
+          end
+          write_attribute("#{name}_id", BSON::ObjectId.new)
+          write_attribute("#{name}_name", filename)
+          write_attribute("#{name}_size", size)
+          write_attribute("#{name}_type", mime)
+          create_attachment_queue[name] = file
+        end
+
+        ##
+        # Attachments we need to add after save.
+        # For binary String data.
+        def create_attachment_raw(name, binary, filename)
+          type = MIME::Types.type_for(filename).first
+          mime = type ? type.content_type : "application/octet-stream"
+          write_attribute("#{name}_id", BSON::ObjectId.new)
+          write_attribute("#{name}_name", filename)
+          write_attribute("#{name}_size", binary.size)
+          write_attribute("#{name}_type", mime)
+          create_attachment_queue[name] = binary
+        end
+
+        ##
+        # Save an attachment to Grid
+        def create_grid_attachment(name,file)
+          data = case
+          when file.is_a?(Hash)
+            file[:tempfile].read
+          else
+            file.respond_to?(:read) ? file.read : file
+          end
+          grid.put(
+            data,
+            :filename => read_attribute("#{name}_name"),
+            :content_type => read_attribute("#{name}_type"),
+            :_id => read_attribute("#{name}_id")
+          )
+          create_attachment_queue.delete(name)
+        end
+
+        ##
+        # Attachments we need to remove after save
+        def delete_attachment(name,id)
+          delete_attachment_queue[name] = id if id.is_a?(BSON::ObjectId)
+          write_attribute("#{name}_id", nil)
+          write_attribute("#{name}_name", nil)
+          write_attribute("#{name}_size", nil)
+          write_attribute("#{name}_type", nil)
+        end
+
+        ##
+        # Delete an attachment from Grid
+        def delete_grid_attachment(name,id)
+          grid.delete(id) if id.is_a?(BSON::ObjectId)
+          delete_attachment_queue.delete(name)
+        end
+
+        ##
+        # Create attachments marked for creation
+        def create_attachments
+          create_attachment_queue.each {|k,v| create_grid_attachment(k,v)}
+        end
+
+        ##
+        # Delete attachments marked for deletion
+        def delete_attachments
+          delete_attachment_queue.each {|k,v| delete_grid_attachment(k,v)}
+        end
+
+        ##
+        # Queues all attachments for deletion
+        def queue_delete_attachments
+          self.class.attachment_types.each do |name|
+            delete_attachment(name, read_attribute("#{name}_id"))
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: mongo_odm_grid
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Dusty Doris
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-07-08 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: &2153373660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153373660
+description: Plugin for MongoODM to attach files via Grid
+email: github@dusty.name
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.txt
+files:
+- README.txt
+- lib/mongo_odm_grid.rb
+- test/test_mongo_odm_grid.rb
+homepage: http://github.com/dusty/mongo_odm_grid
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: none
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: Plugin for MongoODM to attach files via Grid
+test_files: []