matic_grid 0.0.1

data/README.txt

@@ -0,0 +1,44 @@
+Summary
+
+   Mongomatic::Plugins::Grid is a Grid plugin for Mongomatic
+
+   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 matic_grid
+
+Usage
+
+  require 'matic_grid'
+
+  class Monkey < Mongomatic::Base
+    include Mongomatic::Plugins::Grid
+
+    attachment :image, :prefix => 'grid'
+  end
+
+  m = Monkey.new(:name => 'name').insert
+
+  # To add an attachment
+  m.image = File.open('/tmp/me.jpg')
+  m.update
+
+  # To remove an attachment
+  m.image = nil
+  m.update
+
+  # 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/grip
+

data/lib/matic_grid.rb

@@ -0,0 +1,225 @@
+require 'mime/types'
+
+class GridmaticObserver < Mongomatic::Observer
+  def after_insert_or_update(instance, opts)
+    instance.send(:create_attachments)
+    instance.send(:delete_attachments)
+  end
+  def before_remove(instance,opts)
+    instance.send(:queue_delete_attachments)
+    instance.send(:delete_attachments)
+  end
+end
+
+module Mongomatic
+  module Plugins
+    module Grid
+
+      def self.included(base)
+        base.send(:include, Mongomatic::Observable)
+        base.send(:observer, :GridmaticObserver)
+        base.send(:include, InstanceMethods)
+        base.send(:extend, ClassMethods)
+      end
+
+      module ClassMethods
+
+        ##
+        # Declare an attachment for the object
+        #
+        # eg: attachment :image
+        def attachment(name,prefix='grid')
+          ##
+          # 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(self["#{name}_id"]) if self["#{name}_id"]
+          end
+
+          ##
+          # Create a method to set the attachment
+          # eg: object.image = File.open('/tmp/somefile.jpg')
+          define_method("#{name}=") do |file|
+            if file.respond_to?(:read)
+              send(:create_attachment, name, file)
+            else
+              send(:delete_attachment, name, self["#{name}_id"])
+            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, self["#{name}_id"])
+            end
+          end
+
+          ##
+          # Unset the attachment, queue for removal
+          define_method("unset_#{name}") do
+            send(:delete_attachment, name, self["#{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   = self["#{name}_id"]
+            _name = self["#{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.png
+          define_method("#{name}_thumb") do |thumb|
+            _id   = self["#{name}_id"]
+            _name = self["#{name}_name"]
+            base  = File.basename(_name)
+            ext   = File.extname(_name)
+            _name = "#{_name}_#{thumb}#{ext}"
+            ["/#{prefix}", _id, _name].join('/') if _id && _name
+          end
+
+          ##
+          # Helper methods for details about the file
+          # eg: image_name, image_size, image_type, image_id
+          %W{ #{name}_name #{name}_size #{name}_type #{name}_id }.each do |attr|
+            define_method(attr) do
+              self[attr]
+            end
+          end
+        end
+
+        ##
+        # Accessor to Grid
+        def grid
+          @grid ||= Mongo::Grid.new(Mongomatic.db)
+        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)
+          if file.respond_to?(:read)
+            filename = if file.respond_to?(:original_filename) && file.original_filename
+                        file.original_filename
+                       elsif file.respond_to?(:tempfile)
+                         File.basename(file.tempfile.path)
+                       else
+                         File.basename(file.path)
+                       end
+            type = MIME::Types.type_for(filename).first
+            mime = type ? type.content_type : "application/octet-stream"
+            self["#{name}_id"]   = BSON::ObjectId.new
+            self["#{name}_name"] = filename
+            self["#{name}_size"] = File.size(file.respond_to?(:tempfile) ? file.tempfile : file)
+            self["#{name}_type"] = mime
+            create_attachment_queue[name] = file
+          end
+        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"
+          self["#{name}_id"]   = BSON::ObjectId.new
+          self["#{name}_name"] = filename
+          self["#{name}_size"] = binary.size
+          self["#{name}_type"] = mime
+          create_attachment_queue[name] = binary
+        end
+
+        ##
+        # Save an attachment to Grid
+        def create_grid_attachment(name,file)
+          data = file.respond_to?(:read) ? file.read : file
+          grid.put(
+            data,
+            :filename => self["#{name}_name"],
+            :content_type => self["#{name}_type"],
+            :_id => self["#{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)
+          unless removed?
+            self["#{name}_id"]   = nil
+            self["#{name}_name"] = nil
+            self["#{name}_size"] = nil
+            self["#{name}_type"] = nil
+          end
+        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, self["#{name}_id"])
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: matic_grid
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Dusty Doris
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-06-24 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: &2156911780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2156911780
+description: Plugin for Mongomatic to attach files via Grid
+email: github@dusty.name
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.txt
+files:
+- README.txt
+- lib/matic_grid.rb
+- test/test_matic_grid.rb
+homepage: http://github.com/dusty/matic_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 Mongomatic to attach files via Grid
+test_files: []