joint 0.1

data/README.rdoc

@@ -0,0 +1,36 @@
+= Joint
+
+MongoMapper and GridFS united in file upload love.
+
+== Usage
+
+Declare the plugin and use the attachment method to make attachments.
+
+  class Foo
+    include MongoMapper::Document
+    plugin Joint
+
+    attachment :image
+    attachment :pdf
+  end
+
+This gives you #image, #image=, #pdf, and #pdf=. The = methods take any IO that responds to read (File, Tempfile, etc). The image and pdf methods return a GridIO instance (can be found in the ruby driver).
+
+== Dependencies
+
+* MongoMapper 0.7.2 - gem install mongo_mapper
+* Wand >= 0.2.1 - gem install wand
+
+== 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.
+
+== Copyright
+
+Copyright (c) 2010 John Nunemaker. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,36 @@
+require 'rubygems'
+require 'rake'
+require 'yard'
+require 'jeweler'
+require 'rake/testtask'
+
+require File.join(File.dirname(__FILE__), 'lib', 'joint', 'version')
+
+Jeweler::Tasks.new do |gem|
+  gem.name        = "joint"
+  gem.summary     = %Q{MongoMapper and GridFS united in file upload love.}
+  gem.description = %Q{MongoMapper and GridFS united in file upload love.}
+  gem.email       = "nunemaker@gmail.com"
+  gem.homepage    = "http://github.com/jnunemaker/joint"
+  gem.authors     = ["John Nunemaker"]
+  gem.version     = Joint::Version
+  gem.files       = FileList['lib/**/*.rb', 'bin/*', '[A-Z]*', 'test/**/*'].to_a
+  gem.test_files  = FileList['test/**/*'].to_a
+  
+  gem.add_dependency 'wand', '>= 0.2.1'
+  gem.add_dependency 'mime-types'
+
+  gem.add_development_dependency 'jeweler'
+  gem.add_development_dependency 'mongo_mapper'
+end
+Jeweler::GemcutterTasks.new
+
+Rake::TestTask.new(:test) do |test|
+  test.libs      << 'lib' << 'test'
+  test.ruby_opts << '-rubygems'
+  test.pattern   = 'test/**/test_*.rb'
+  test.verbose   = true
+end
+
+task :test    => :check_dependencies
+task :default => :test

data/lib/joint.rb

@@ -0,0 +1,102 @@
+require 'mime/types'
+require 'wand'
+
+module Joint
+  autoload :Version, 'joint/version'
+
+  def self.file_name(file)
+    file.respond_to?(:original_filename) ? file.original_filename : File.basename(file.path)
+  end
+
+  module ClassMethods
+    def attachment(name)
+      self.class.class_inheritable_accessor :attachment_names
+      self.class.attachment_names ||= []
+      self.class.attachment_names << name
+
+      after_save     :save_attachments
+      before_destroy :destroy_attached_files
+
+      key "#{name}_id".to_sym,   ObjectId
+      key "#{name}_name".to_sym, String
+      key "#{name}_size".to_sym, Integer
+      key "#{name}_type".to_sym, String
+
+      define_method(name) do
+        AttachmentProxy.new(self, name)
+      end
+
+      define_method("#{name}=") do |file|
+        self["#{name}_id"]           = Mongo::ObjectID.new
+        self["#{name}_size"]         = File.size(file)
+        self["#{name}_type"]         = Wand.wave(file.path)
+        self["#{name}_name"]         = Joint.file_name(file)
+        attachment_assignments[name] = file
+      end
+    end
+    
+    def grid
+      @grid ||= Mongo::Grid.new(database)
+    end
+  end
+
+  module InstanceMethods
+    def attachment_assignments
+      @attachment_assignments ||= {}
+    end
+
+    def grid
+      self.class.grid
+    end
+
+    private
+      def save_attachments
+        attachment_assignments.each do |attachment|
+          name, file = attachment
+          content_type = self["#{name}_type"]
+
+          if file.respond_to?(:read)
+            grid.put(file.read, self["#{name}_name"], :content_type => content_type, :_id => self["#{name}_id"])
+          end
+        end
+
+        @attachment_assignments.clear
+      end
+
+      def destroy_attached_files
+        self.class.attachment_names.each do |name|
+          grid.delete(self["#{name}_id"])
+        end
+      end
+  end
+
+  class AttachmentProxy
+    def initialize(instance, name)
+      @instance, @name = instance, name
+    end
+
+    def id
+      @instance.send("#{@name}_id")
+    end
+
+    def name
+      @instance.send("#{@name}_name")
+    end
+
+    def size
+      @instance.send("#{@name}_size")
+    end
+
+    def type
+      @instance.send("#{@name}_type")
+    end
+
+    def grid_io
+      @grid_io ||= @instance.grid.get(id)
+    end
+
+    def method_missing(method, *args, &block)
+      grid_io.send(method, *args, &block)
+    end
+  end
+end

data/lib/joint/version.rb

@@ -0,0 +1,3 @@
+module Joint
+  Version = '0.1'
+end

data/test/helper.rb

@@ -0,0 +1,23 @@
+require 'test/unit'
+require 'tempfile'
+require 'pp'
+require 'mongo_mapper'
+
+require File.expand_path(File.dirname(__FILE__) + '/../lib/joint')
+
+MongoMapper.database = "testing"
+
+class Test::Unit::TestCase
+  def self.test(name, &block)
+    test_name = "test_#{name.gsub(/\s+/,'_')}".to_sym
+    defined = instance_method(test_name) rescue false
+    raise "#{test_name} is already defined in #{self}" if defined
+    if block_given?
+      define_method(test_name, &block)
+    else
+      define_method(test_name) do
+        flunk "No implementation provided for #{name}"
+      end
+    end
+  end
+end

data/test/test_joint.rb

@@ -0,0 +1,108 @@
+require 'helper'
+
+class Foo
+  include MongoMapper::Document
+  plugin Joint
+
+  attachment :image
+  attachment :pdf
+end
+
+class JointTest < Test::Unit::TestCase
+  def setup
+    MongoMapper.database.collections.each(&:remove)
+    @grid = Mongo::Grid.new(MongoMapper.database)
+
+    dir    = File.dirname(__FILE__) + '/fixtures'
+    @pdf   = File.open("#{dir}/unixref.pdf",  'r')
+    @image = File.open("#{dir}/mr_t.jpg", 'r')
+
+    @pdf_contents   = File.read("#{dir}/unixref.pdf")
+    @image_contents = File.read("#{dir}/mr_t.jpg")
+
+    @doc = Foo.create(:image => @image, :pdf => @pdf)
+    @doc.reload
+  end
+
+  def teardown
+    @pdf.close
+    @image.close
+  end
+
+  test "assigns grid fs content type correctly" do
+    assert_equal "image/jpeg",      @grid.get(@doc.image_id).content_type
+    assert_equal "application/pdf", @grid.get(@doc.pdf_id).content_type
+  end
+
+  test "assigns keys correctly" do
+    assert_equal 13661, @doc.image_size
+    assert_equal 68926,  @doc.pdf_size
+
+    assert_equal "image/jpeg",      @doc.image_type
+    assert_equal "application/pdf", @doc.pdf_type
+
+    assert_not_nil @doc.image_id
+    assert_not_nil @doc.pdf_id
+
+    assert_kind_of Mongo::ObjectID, @doc.image_id
+    assert_kind_of Mongo::ObjectID, @doc.pdf_id
+  end
+
+  test "accessing keys through attachment proxy" do
+    assert_equal 13661, @doc.image.size
+    assert_equal 68926,  @doc.pdf.size
+
+    assert_equal "image/jpeg",      @doc.image.type
+    assert_equal "application/pdf", @doc.pdf.type
+
+    assert_not_nil @doc.image.id
+    assert_not_nil @doc.pdf.id
+
+    assert_kind_of Mongo::ObjectID, @doc.image.id
+    assert_kind_of Mongo::ObjectID, @doc.pdf.id
+  end
+
+  test "sends unknown proxy methods to grid io object" do
+    assert_equal 13661,         @doc.image.file_length
+    assert_equal 'image/jpeg',  @doc.image.content_type
+    assert_equal 'mr_t.jpg',    @doc.image.filename
+    assert_equal @doc.image_id, @doc.image.files_id
+  end
+
+  test "assigns file name from path if original file name not available" do
+    assert_equal 'mr_t.jpg',    @doc.image_name
+    assert_equal 'unixref.pdf', @doc.pdf_name
+  end
+
+  test "assigns file name from original filename if available" do
+    begin
+      file = Tempfile.new('testing.txt')
+      def file.original_filename
+        'testing.txt'
+      end
+      doc = Foo.create(:image => file)
+      assert_equal 'testing.txt', doc.image_name
+    ensure
+      file.close
+    end
+  end
+
+  test "responds to keys" do
+    [ :pdf_size,   :pdf_id,   :pdf_name,   :pdf_type,
+      :image_size, :image_id, :image_name, :image_type
+    ].each do |method|
+      assert @doc.respond_to?(method)
+    end
+  end
+
+  test "saves attachments correctly" do
+    assert_equal @pdf_contents, @doc.pdf.read
+    assert_equal @image_contents, @doc.image.read
+  end
+
+  test "cleans up attachments on destroy" do
+    @doc.destroy
+    assert_raises(Mongo::GridError) { @grid.get(@doc.image_id) }
+    assert_raises(Mongo::GridError) { @grid.get(@doc.pdf_id) }
+  end
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification 
+name: joint
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- John Nunemaker
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-26 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: wand
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 2
+        - 1
+        version: 0.2.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mime-types
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: mongo_mapper
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: MongoMapper and GridFS united in file upload love.
+email: nunemaker@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- Rakefile
+- lib/joint.rb
+- lib/joint/version.rb
+- test/fixtures/mr_t.jpg
+- test/fixtures/unixref.pdf
+- test/helper.rb
+- test/test_joint.rb
+has_rdoc: true
+homepage: http://github.com/jnunemaker/joint
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: MongoMapper and GridFS united in file upload love.
+test_files: 
+- test/fixtures/mr_t.jpg
+- test/fixtures/unixref.pdf
+- test/helper.rb
+- test/test_joint.rb