joint 0.1.1 → 0.2

data/README.rdoc

@@ -1,6 +1,6 @@
 = Joint
 
-MongoMapper and GridFS united in file upload love.
+MongoMapper and GridFS joined in file upload love.
 
 == Usage
 
@@ -22,11 +22,6 @@ Also, #image and #pdf are proxies so you can do stuff like:
 
 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.
 
-== Dependencies
-
-* MongoMapper >= 0.7 - gem install mongo_mapper
-* Wand >= 0.2.1 - gem install wand
-
 == Note on Patches/Pull Requests
  
 * Fork the project.

data/Rakefile

@@ -8,8 +8,8 @@ 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.summary     = %Q{MongoMapper and GridFS joined in file upload love.}
+  gem.description = %Q{MongoMapper and GridFS joined in file upload love.}
   gem.email       = "nunemaker@gmail.com"
   gem.homepage    = "http://github.com/jnunemaker/joint"
   gem.authors     = ["John Nunemaker"]

data/lib/joint.rb

@@ -1,68 +1,82 @@
+require 'set'
 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.class_inheritable_accessor :attachment_names unless self.class.respond_to?(:attachment_names)
       self.class.attachment_names ||= []
       self.class.attachment_names << name
 
       after_save     :save_attachments
-      before_destroy :destroy_attached_files
+      after_save     :destroy_nil_attachments
+      before_destroy :destroy_all_attachments
 
       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
+      class_eval <<-EOC
+        def #{name}
+          @#{name} ||= 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
+        def #{name}?
+          self.send(:#{name}_id?)
+        end
+
+        def #{name}=(file)
+          if file.nil?
+            nil_attachments << :#{name}
+          else
+            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)
+            assigned_attachments[:#{name}] = file
+          end
+        end
+      EOC
     end
   end
 
   module InstanceMethods
-    def attachment_assignments
-      @attachment_assignments ||= {}
-    end
-
     def grid
       @grid ||= Mongo::Grid.new(database)
     end
 
     private
+      def assigned_attachments
+        @assigned_attachments ||= {}
+      end
+
+      def nil_attachments
+        @nil_attachments ||= Set.new
+      end
+
       def save_attachments
-        attachment_assignments.each do |attachment|
+        assigned_attachments.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"])
+            file.rewind if file.respond_to?(:rewind)
+            grid.put(file.read, self["#{name}_name"], {
+              :_id          => self["#{name}_id"],
+              :content_type => self["#{name}_type"],
+            })
           end
-        end
+        end.tap(&:clear)
+      end
 
-        @attachment_assignments.clear
+      def destroy_nil_attachments
+        nil_attachments.each { |name| grid.delete(self["#{name}_id"]) }.tap(&:clear)
       end
 
-      def destroy_attached_files
-        self.class.attachment_names.each do |name|
-          grid.delete(self["#{name}_id"])
-        end
+      def destroy_all_attachments
+        self.class.attachment_names.each { |name| grid.delete(self["#{name}_id"]) }
       end
   end
 
@@ -95,4 +109,8 @@ module Joint
       grid_io.send(method, *args, &block)
     end
   end
+
+  def self.file_name(file)
+    file.respond_to?(:original_filename) ? file.original_filename : File.basename(file.path)
+  end
 end

data/lib/joint/version.rb

@@ -1,3 +1,3 @@
 module Joint
-  Version = '0.1.1'
+  Version = '0.2'
 end

data/test/helper.rb

@@ -1,23 +1,28 @@
-require 'test/unit'
 require 'tempfile'
 require 'pp'
 require 'mongo_mapper'
+require 'shoulda'
+require 'matchy'
+require 'mocha'
 
 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
+  def assert_difference(expression, difference = 1, message = nil, &block)
+    b      = block.send(:binding)
+    exps   = Array.wrap(expression)
+    before = exps.map { |e| eval(e, b) }
+    yield
+    exps.each_with_index do |e, i|
+      error = "#{e.inspect} didn't change by #{difference}"
+      error = "#{message}.\n#{error}" if message
+      assert_equal(before[i] + difference, eval(e, b), error)
     end
   end
+
+  def assert_no_difference(expression, message = nil, &block)
+    assert_difference(expression, 0, message, &block)
+  end
 end

data/test/test_joint.rb

@@ -1,9 +1,10 @@
 require 'helper'
 
-class Foo
+class Asset
   include MongoMapper::Document
   plugin Joint
 
+  key :title, String
   attachment :image
   attachment :pdf
 end
@@ -11,17 +12,14 @@ 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
+    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")
+    @grid              = Mongo::Grid.new(MongoMapper.database)
+    @gridfs_collection = MongoMapper.database['fs.files']
   end
 
   def teardown
@@ -29,80 +27,180 @@ class JointTest < Test::Unit::TestCase
     @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
+  context "Using Joint plugin" do
+    should "add each attachment to attachment_names" do
+      Asset.attachment_names.should == [:image, :pdf]
+    end
+
+    should "add keys for each attachment" do
+      [:image, :pdf].each do |attachment|
+        [:id, :name, :type, :size].each do |key|
+          Asset.keys.include?("#{attachment}_#{key}")
+        end
+      end
+    end
   end
 
-  test "assigns keys correctly" do
-    assert_equal 13661, @doc.image_size
-    assert_equal 68926,  @doc.pdf_size
+  context "Assigning attachments to document" do
+    setup do
+      @doc = Asset.create(:image => @image, :pdf => @pdf)
+      @doc.reload
+    end
 
-    assert_equal "image/jpeg",      @doc.image_type
-    assert_equal "application/pdf", @doc.pdf_type
+    should "assign GridFS content_type" do
+      @grid.get(@doc.image_id).content_type.should == 'image/jpeg'
+      @grid.get(@doc.pdf_id).content_type.should == 'application/pdf'
+    end
 
-    assert_not_nil @doc.image_id
-    assert_not_nil @doc.pdf_id
+    should "assign joint keys" do
+      @doc.image_size.should  == 13661
+      @doc.pdf_size.should    == 68926
 
-    assert_kind_of Mongo::ObjectID, @doc.image_id
-    assert_kind_of Mongo::ObjectID, @doc.pdf_id
-  end
+      @doc.image_type.should  == "image/jpeg"
+      @doc.pdf_type.should    == "application/pdf"
+
+      @doc.image_id.should_not be_nil
+      @doc.pdf_id.should_not be_nil
+
+      @doc.image_id.should be_instance_of(Mongo::ObjectID)
+      @doc.pdf_id.should be_instance_of(Mongo::ObjectID)
+    end
 
-  test "accessing keys through attachment proxy" do
-    assert_equal 13661, @doc.image.size
-    assert_equal 68926,  @doc.pdf.size
+    should "allow accessing keys through attachment proxy" do
+      @doc.image.size.should  == 13661
+      @doc.pdf.size.should    == 68926
 
-    assert_equal "image/jpeg",      @doc.image.type
-    assert_equal "application/pdf", @doc.pdf.type
+      @doc.image.type.should  == "image/jpeg"
+      @doc.pdf.type.should    == "application/pdf"
 
-    assert_not_nil @doc.image.id
-    assert_not_nil @doc.pdf.id
+      @doc.image.id.should_not be_nil
+      @doc.pdf.id.should_not be_nil
 
-    assert_kind_of Mongo::ObjectID, @doc.image.id
-    assert_kind_of Mongo::ObjectID, @doc.pdf.id
+      @doc.image.id.should be_instance_of(Mongo::ObjectID)
+      @doc.pdf.id.should be_instance_of(Mongo::ObjectID)
+    end
+
+    should "proxy unknown methods to GridIO object" do
+      @doc.image.files_id.should      == @doc.image_id
+      @doc.image.content_type.should  == 'image/jpeg'
+      @doc.image.filename.should      == 'mr_t.jpg'
+      @doc.image.file_length.should   == 13661
+    end
+
+    should "assign file name from path if original file name not available" do
+      @doc.image_name.should  == 'mr_t.jpg'
+      @doc.pdf_name.should    == 'unixref.pdf'
+    end
+
+    should "save attachment contents correctly" do
+      @doc.pdf.read.should    == @pdf_contents
+      @doc.image.read.should  == @image_contents
+    end
+
+    should "know that attachment exists" do
+      @doc.image?.should be(true)
+      @doc.pdf?.should be(true)
+    end
+
+    should "clear assigned attachments so they don't get uploaded twice" do
+      Mongo::Grid.any_instance.expects(:put).never
+      @doc.save
+    end
   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
+  context "Updating document but not attachments" do
+    setup do
+      @doc = Asset.create(:image => @image)
+      @doc.update_attributes(:title => 'Updated')
+      @doc.reload
+    end
+
+    should "not affect attachment" do
+      @doc.image.read.should == @image_contents
+    end
+
+    should "update document attributes" do
+      @doc.title.should == 'Updated'
+    end
   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
+  context "Assigning file with where file pointer is not at beginning" do
+    setup do
+      @image.read
+      @doc = Asset.create(:image => @image)
+      @doc.reload
+    end
+
+    should "rewind and correctly store contents" do
+      @doc.image.read.should == @image_contents
+    end
   end
 
-  test "assigns file name from original filename if available" do
-    begin
-      file = Tempfile.new('testing.txt')
-      def file.original_filename
-        'testing.txt'
+  context "Setting attachment to nil" do
+    setup do
+      @doc = Asset.create(:image => @image)
+    end
+
+    should "delete attachment after save" do
+      assert_no_difference '@gridfs_collection.find().count' do
+        @doc.image = nil
       end
-      doc = Foo.create(:image => file)
-      assert_equal 'testing.txt', doc.image_name
-    ensure
-      file.close
+
+      assert_difference '@gridfs_collection.find().count', -1 do
+        @doc.save
+      end
+    end
+    
+    should "clear nil attachments after save and not attempt to delete again" do
+      @doc.image = nil
+      @doc.save
+      Mongo::Grid.any_instance.expects(:delete).never
+      @doc.save
     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)
+  context "Retrieving attachment that does not exist" do
+    setup do
+      @doc = Asset.create
+    end
+
+    should "know that the attachment is not present" do
+      @doc.image?.should be(false)
+    end
+
+    should "raise Mongo::GridError" do
+      assert_raises(Mongo::GridError) { @doc.image.read }
     end
   end
 
-  test "saves attachments correctly" do
-    assert_equal @pdf_contents, @doc.pdf.read
-    assert_equal @image_contents, @doc.image.read
+  context "Destroying a document" do
+    setup do
+      @doc = Asset.create(:image => @image)
+    end
+
+    should "remove files from grid fs as well" do
+      assert_difference "@gridfs_collection.find().count", -1 do
+        @doc.destroy
+      end
+    end
   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) }
+  context "Assigning file name" do
+    should "default to path" do
+      Asset.create(:image => @image).image.name.should == 'mr_t.jpg'
+    end
+
+    should "use original_filename if available" do
+      begin
+        file = Tempfile.new('testing.txt')
+        def file.original_filename
+          'testing.txt'
+        end
+        doc = Asset.create(:image => file)
+        assert_equal 'testing.txt', doc.image_name
+      ensure
+        file.close
+      end
+    end
   end
 end

metadata

@@ -4,9 +4,8 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: "0.2"
 platform: ruby
 authors: 
 - John Nunemaker
@@ -14,7 +13,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-26 00:00:00 -04:00
+date: 2010-03-29 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -67,7 +66,7 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id004
-description: MongoMapper and GridFS united in file upload love.
+description: MongoMapper and GridFS joined in file upload love.
 email: nunemaker@gmail.com
 executables: []
 
@@ -113,7 +112,7 @@ rubyforge_project:
 rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
-summary: MongoMapper and GridFS united in file upload love.
+summary: MongoMapper and GridFS joined in file upload love.
 test_files: 
 - test/fixtures/mr_t.jpg
 - test/fixtures/unixref.pdf