joint 0.2 → 0.3

data/Rakefile

@@ -1,6 +1,5 @@
 require 'rubygems'
 require 'rake'
-require 'yard'
 require 'jeweler'
 require 'rake/testtask'
 
@@ -21,7 +20,10 @@ Jeweler::Tasks.new do |gem|
   gem.add_dependency 'mime-types'
 
   gem.add_development_dependency 'jeweler'
-  gem.add_development_dependency 'mongo_mapper'
+  gem.add_development_dependency 'shoulda'
+  gem.add_development_dependency 'mocha'
+  gem.add_development_dependency 'jnunemaker-matchy'
+  gem.add_development_dependency 'mongo_mapper', '>= 0.7.2'
 end
 Jeweler::GemcutterTasks.new
 

data/lib/joint.rb

@@ -8,7 +8,7 @@ module Joint
   module ClassMethods
     def attachment(name)
       self.class.class_inheritable_accessor :attachment_names unless self.class.respond_to?(:attachment_names)
-      self.class.attachment_names ||= []
+      self.class.attachment_names ||= Set.new
       self.class.attachment_names << name
 
       after_save     :save_attachments
@@ -33,10 +33,10 @@ module Joint
           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)
+            self["#{name}_id"]             = Mongo::ObjectID.new if self["#{name}_id"].nil?
+            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
@@ -58,25 +58,27 @@ module Joint
         @nil_attachments ||= Set.new
       end
 
+      # IO must respond to read and rewind
       def save_attachments
-        assigned_attachments.each do |attachment|
-          name, file = attachment
-          if file.respond_to?(:read)
-            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.tap(&:clear)
+        assigned_attachments.each_pair do |name, io|
+          next unless io.respond_to?(:read)
+          io.rewind if io.respond_to?(:rewind)
+          grid.delete(send(name).id)
+          grid.put(io.read, send(name).name, {
+            :_id          => send(name).id,
+            :content_type => send(name).type,
+          })
+        end
+        assigned_attachments.clear
       end
 
       def destroy_nil_attachments
-        nil_attachments.each { |name| grid.delete(self["#{name}_id"]) }.tap(&:clear)
+        nil_attachments.each { |name| grid.delete(send(name).id) }
+        nil_attachments.clear
       end
 
       def destroy_all_attachments
-        self.class.attachment_names.each { |name| grid.delete(self["#{name}_id"]) }
+        self.class.attachment_names.map { |name| grid.delete(send(name).id) }
       end
   end
 

data/lib/joint/version.rb

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

data/test/fixtures/test1.txt

@@ -0,0 +1 @@
+test1

data/test/fixtures/test2.txt

@@ -0,0 +1 @@
+test2

data/test/helper.rb

@@ -1,15 +1,19 @@
 require 'tempfile'
 require 'pp'
-require 'mongo_mapper'
 require 'shoulda'
 require 'matchy'
 require 'mocha'
+require 'mongo_mapper'
 
 require File.expand_path(File.dirname(__FILE__) + '/../lib/joint')
 
 MongoMapper.database = "testing"
 
 class Test::Unit::TestCase
+  def setup
+    MongoMapper.database.collections.each(&:remove)
+  end
+
   def assert_difference(expression, difference = 1, message = nil, &block)
     b      = block.send(:binding)
     exps   = Array.wrap(expression)
@@ -25,4 +29,12 @@ class Test::Unit::TestCase
   def assert_no_difference(expression, message = nil, &block)
     assert_difference(expression, 0, message, &block)
   end
+
+  def assert_grid_difference(difference=1, &block)
+    assert_difference("MongoMapper.database['fs.files'].find().count", difference, &block)
+  end
+
+  def assert_no_grid_difference(&block)
+    assert_grid_difference(0, &block)
+  end
 end

data/test/test_joint.rb

@@ -6,105 +6,151 @@ class Asset
 
   key :title, String
   attachment :image
-  attachment :pdf
+  attachment :file
+end
+
+module JointTestHelpers
+  def all_files
+    [@file, @image, @image2, @test1, @test2]
+  end
+
+  def rewind_files
+    all_files.each { |file| file.rewind }
+  end
+
+  def open_file(name)
+    File.open(File.join(File.dirname(__FILE__), 'fixtures', name), 'r')
+  end
+
+  def grid
+    @grid ||= Mongo::Grid.new(MongoMapper.database)
+  end
 end
 
 class JointTest < Test::Unit::TestCase
+  include JointTestHelpers
+
   def setup
-    MongoMapper.database.collections.each(&:remove)
-
-    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']
+    super
+    @file   = open_file('unixref.pdf')
+    @image  = open_file('mr_t.jpg')
+    @image2 = open_file('harmony.png')
+    @test1  = open_file('test1.txt')
+    @test2  = open_file('test2.txt')
   end
 
   def teardown
-    @pdf.close
-    @image.close
+    all_files.each { |file| file.close }
   end
 
   context "Using Joint plugin" do
     should "add each attachment to attachment_names" do
-      Asset.attachment_names.should == [:image, :pdf]
+      Asset.attachment_names.should == Set.new([:image, :file])
     end
 
     should "add keys for each attachment" do
-      [:image, :pdf].each do |attachment|
+      [:image, :file].each do |attachment|
         [:id, :name, :type, :size].each do |key|
-          Asset.keys.include?("#{attachment}_#{key}")
+          Asset.keys.should include("#{attachment}_#{key}")
         end
       end
     end
   end
 
-  context "Assigning attachments to document" do
+  context "Assigning new attachments to document" do
     setup do
-      @doc = Asset.create(:image => @image, :pdf => @pdf)
-      @doc.reload
+      @doc = Asset.create(:image => @image, :file => @file)
+      rewind_files
     end
+    subject { @doc }
 
     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'
+      grid.get(subject.image_id).content_type.should == 'image/jpeg'
+      grid.get(subject.file_id).content_type.should == 'application/pdf'
     end
 
     should "assign joint keys" do
-      @doc.image_size.should  == 13661
-      @doc.pdf_size.should    == 68926
+      subject.image_size.should  == 13661
+      subject.file_size.should   == 68926
 
-      @doc.image_type.should  == "image/jpeg"
-      @doc.pdf_type.should    == "application/pdf"
+      subject.image_type.should  == "image/jpeg"
+      subject.file_type.should   == "application/pdf"
 
-      @doc.image_id.should_not be_nil
-      @doc.pdf_id.should_not be_nil
+      subject.image_id.should_not be_nil
+      subject.file_id.should_not be_nil
 
-      @doc.image_id.should be_instance_of(Mongo::ObjectID)
-      @doc.pdf_id.should be_instance_of(Mongo::ObjectID)
+      subject.image_id.should be_instance_of(Mongo::ObjectID)
+      subject.file_id.should be_instance_of(Mongo::ObjectID)
     end
 
     should "allow accessing keys through attachment proxy" do
-      @doc.image.size.should  == 13661
-      @doc.pdf.size.should    == 68926
+      subject.image.size.should  == 13661
+      subject.file.size.should   == 68926
 
-      @doc.image.type.should  == "image/jpeg"
-      @doc.pdf.type.should    == "application/pdf"
+      subject.image.type.should  == "image/jpeg"
+      subject.file.type.should   == "application/pdf"
 
-      @doc.image.id.should_not be_nil
-      @doc.pdf.id.should_not be_nil
+      subject.image.id.should_not be_nil
+      subject.file.id.should_not be_nil
 
-      @doc.image.id.should be_instance_of(Mongo::ObjectID)
-      @doc.pdf.id.should be_instance_of(Mongo::ObjectID)
+      subject.image.id.should be_instance_of(Mongo::ObjectID)
+      subject.file.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
+      subject.image.files_id.should      == subject.image_id
+      subject.image.content_type.should  == 'image/jpeg'
+      subject.image.filename.should      == 'mr_t.jpg'
+      subject.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'
+      subject.image_name.should  == 'mr_t.jpg'
+      subject.file_name.should   == 'unixref.pdf'
     end
 
     should "save attachment contents correctly" do
-      @doc.pdf.read.should    == @pdf_contents
-      @doc.image.read.should  == @image_contents
+      subject.file.read.should   == @file.read
+      subject.image.read.should  == @image.read
     end
 
     should "know that attachment exists" do
-      @doc.image?.should be(true)
-      @doc.pdf?.should be(true)
+      subject.image?.should be(true)
+      subject.file?.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
+      subject.save
+    end
+  end
+
+  context "Updating existing attachment" do
+    setup do
+      @doc = Asset.create(:file => @test1)
+      assert_no_grid_difference do
+        @doc.file = @test2
+        @doc.save!
+      end
+      rewind_files
+    end
+    subject { @doc }
+
+    should "not change attachment id" do
+      subject.file_id_changed?.should be(false)
+    end
+
+    should "update keys" do
+      subject.file_name.should == 'test2.txt'
+      subject.file_type.should == "text/plain"
+      subject.file_size.should == 5
+    end
+
+    should "update GridFS" do
+      grid.get(subject.file_id).filename.should     == 'test2.txt'
+      grid.get(subject.file_id).content_type.should == 'text/plain'
+      grid.get(subject.file_id).file_length.should  == 5
+      grid.get(subject.file_id).read.should         == @test2.read
     end
   end
 
@@ -113,75 +159,79 @@ class JointTest < Test::Unit::TestCase
       @doc = Asset.create(:image => @image)
       @doc.update_attributes(:title => 'Updated')
       @doc.reload
+      rewind_files
     end
+    subject { @doc }
 
     should "not affect attachment" do
-      @doc.image.read.should == @image_contents
+      subject.image.read.should == @image.read
     end
 
     should "update document attributes" do
-      @doc.title.should == 'Updated'
+      subject.title.should == 'Updated'
     end
   end
 
-  context "Assigning file with where file pointer is not at beginning" do
+  context "Assigning file where file pointer is not at beginning" do
     setup do
       @image.read
       @doc = Asset.create(:image => @image)
       @doc.reload
+      rewind_files
     end
+    subject { @doc }
 
     should "rewind and correctly store contents" do
-      @doc.image.read.should == @image_contents
+      subject.image.read.should == @image.read
     end
   end
 
   context "Setting attachment to nil" do
     setup do
       @doc = Asset.create(:image => @image)
+      rewind_files
     end
+    subject { @doc }
 
     should "delete attachment after save" do
-      assert_no_difference '@gridfs_collection.find().count' do
-        @doc.image = nil
-      end
-
-      assert_difference '@gridfs_collection.find().count', -1 do
-        @doc.save
-      end
+      assert_no_grid_difference   { subject.image = nil }
+      assert_grid_difference(-1)  { subject.save }
     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).once
+      subject.image = nil
+      subject.save
       Mongo::Grid.any_instance.expects(:delete).never
-      @doc.save
+      subject.save
     end
   end
 
   context "Retrieving attachment that does not exist" do
     setup do
       @doc = Asset.create
+      rewind_files
     end
+    subject { @doc }
 
     should "know that the attachment is not present" do
-      @doc.image?.should be(false)
+      subject.image?.should be(false)
     end
 
     should "raise Mongo::GridError" do
-      assert_raises(Mongo::GridError) { @doc.image.read }
+      assert_raises(Mongo::GridError) { subject.image.read }
     end
   end
 
   context "Destroying a document" do
     setup do
       @doc = Asset.create(:image => @image)
+      rewind_files
     end
+    subject { @doc }
 
     should "remove files from grid fs as well" do
-      assert_difference "@gridfs_collection.find().count", -1 do
-        @doc.destroy
-      end
+      assert_grid_difference(-1) { subject.destroy }
     end
   end
 
@@ -191,16 +241,11 @@ class JointTest < Test::Unit::TestCase
     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
+      def @image.original_filename
+        'testing.txt'
       end
+      doc = Asset.create(:image => @image)
+      assert_equal 'testing.txt', doc.image_name
     end
   end
 end

metadata

@@ -4,8 +4,8 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
-  version: "0.2"
+  - 3
+  version: "0.3"
 platform: ruby
 authors: 
 - John Nunemaker
@@ -13,7 +13,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-29 00:00:00 -04:00
+date: 2010-04-05 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -55,7 +55,7 @@ dependencies:
   type: :development
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: mongo_mapper
+  name: shoulda
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     requirements: 
@@ -66,6 +66,44 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: jnunemaker-matchy
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: mongo_mapper
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 7
+        - 2
+        version: 0.7.2
+  type: :development
+  version_requirements: *id007
 description: MongoMapper and GridFS joined in file upload love.
 email: nunemaker@gmail.com
 executables: []
@@ -79,7 +117,10 @@ files:
 - Rakefile
 - lib/joint.rb
 - lib/joint/version.rb
+- test/fixtures/harmony.png
 - test/fixtures/mr_t.jpg
+- test/fixtures/test1.txt
+- test/fixtures/test2.txt
 - test/fixtures/unixref.pdf
 - test/helper.rb
 - test/test_joint.rb
@@ -114,7 +155,10 @@ signing_key:
 specification_version: 3
 summary: MongoMapper and GridFS joined in file upload love.
 test_files: 
+- test/fixtures/harmony.png
 - test/fixtures/mr_t.jpg
+- test/fixtures/test1.txt
+- test/fixtures/test2.txt
 - test/fixtures/unixref.pdf
 - test/helper.rb
 - test/test_joint.rb