joint 0.6.0 → 0.6.1

data/.gitignore

@@ -5,3 +5,4 @@ doc/*
 pkg/*
 .bundle
 *.swp
+Gemfile.lock

data/Gemfile

@@ -2,6 +2,7 @@ source :rubygems
 
 gemspec
 
+gem 'rake'
 gem 'bson_ext', :require => false
 gem 'shoulda'
 gem 'mocha'

data/joint.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'wand', '~> 0.4'
   s.add_dependency 'mime-types'
-  s.add_dependency 'mongo_mapper', '~> 0.9.0'
+  s.add_dependency 'mongo_mapper', '~> 0.9'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/joint/class_methods.rb

@@ -11,6 +11,7 @@ module Joint
       self.attachment_names = attachment_names.dup.add(name)
 
       after_save     :save_attachments
+      before_save    :nullify_nil_attachments_attributes
       after_save     :destroy_nil_attachments
       before_destroy :destroy_all_attachments
 
@@ -27,12 +28,12 @@ module Joint
         end
 
         def #{name}?
-          !nil_attachments.include?(:#{name}) && send(:#{name}_id?)
+          !nil_attachments.has_key?(:#{name}) && send(:#{name}_id?)
         end
 
         def #{name}=(file)
           if file.nil?
-            nil_attachments << :#{name}
+            nil_attachments[:#{name}] = send("#{name}_id")
             assigned_attachments.delete(:#{name})
           else
             send("#{name}_id=", BSON::ObjectId.new) if send("#{name}_id").nil?

data/lib/joint/instance_methods.rb

@@ -10,7 +10,7 @@ module Joint
       end
 
       def nil_attachments
-        @nil_attachments ||= Set.new
+        @nil_attachments ||= {}
       end
 
       # IO must respond to read and rewind
@@ -27,21 +27,19 @@ module Joint
         end
         assigned_attachments.clear
       end
-
-      def destroy_nil_attachments
-        # currently MM does not send sets to instance as well
-        nil_attachments.each do |name|
-          grid.delete(send(name).id)
+      
+      def nullify_nil_attachments_attributes
+        nil_attachments.each_key do |name|
           send(:"#{name}_id=", nil)
           send(:"#{name}_size=", nil)
           send(:"#{name}_type=", nil)
           send(:"#{name}_name=", nil)
-          set({
-            :"#{name}_id"   => nil,
-            :"#{name}_size" => nil,
-            :"#{name}_type" => nil,
-            :"#{name}_name" => nil,
-          })
+        end
+      end
+
+      def destroy_nil_attachments
+        nil_attachments.each_value do |id|
+          grid.delete(id)
         end
 
         nil_attachments.clear

data/lib/joint/version.rb

@@ -1,3 +1,3 @@
 module Joint
-  Version = '0.6.0'
+  Version = '0.6.1'
 end

data/test/helper.rb

@@ -25,7 +25,8 @@ class Test::Unit::TestCase
     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)
+      after = eval(e, b)
+      assert_equal(before[i] + difference, after, error)
     end
   end
 
@@ -46,6 +47,16 @@ class Asset
   include MongoMapper::Document
   plugin Joint
 
+  key :title, String
+  attachment :image
+  attachment :file
+  has_many :embedded_assets
+end
+
+class EmbeddedAsset
+  include MongoMapper::EmbeddedDocument
+  plugin Joint
+
   key :title, String
   attachment :image
   attachment :file

data/test/test_joint.rb

@@ -56,17 +56,21 @@ class JointTest < Test::Unit::TestCase
   context "Using Joint plugin" do
     should "add each attachment to attachment_names" do
       Asset.attachment_names.should == Set.new([:image, :file])
+      EmbeddedAsset.attachment_names.should == Set.new([:image, :file])
     end
 
     should "add keys for each attachment" do
       key_names.each do |key|
         Asset.keys.should include("image_#{key}")
         Asset.keys.should include("file_#{key}")
+        EmbeddedAsset.keys.should include("image_#{key}")
+        EmbeddedAsset.keys.should include("file_#{key}")
       end
     end
 
     should "add memoized accessors module" do
       Asset.attachment_accessor_module.should be_instance_of(Module)
+      EmbeddedAsset.attachment_accessor_module.should be_instance_of(Module)
     end
 
     context "with inheritance" do
@@ -153,9 +157,79 @@ class JointTest < Test::Unit::TestCase
       subject.file?.should be(true)
     end
 
-    should "respond with false when asked if the attachment is nil?" do
-      subject.image.nil?.should be(false)
-      subject.file.nil?.should be(false)
+    should "respond with false when asked if the attachment is blank?" do
+      subject.image.blank?.should be(false)
+      subject.file.blank?.should be(false)
+    end
+
+    should "clear assigned attachments so they don't get uploaded twice" do
+      Mongo::Grid.any_instance.expects(:put).never
+      subject.save
+    end
+  end
+
+  context "Assigning new attachments to embedded document" do
+    setup do
+      @asset = Asset.new
+      @doc = @asset.embedded_assets.build(:image => @image, :file => @file)
+      @asset.save!
+      rewind_files
+    end
+    subject { @doc }
+
+    should "assign GridFS content_type" do
+      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
+      subject.image_size.should  == 13661
+      subject.file_size.should   == 68926
+
+      subject.image_type.should  == "image/jpeg"
+      subject.file_type.should   == "application/pdf"
+
+      subject.image_id.should_not be_nil
+      subject.file_id.should_not be_nil
+
+      subject.image_id.should be_instance_of(BSON::ObjectId)
+      subject.file_id.should be_instance_of(BSON::ObjectId)
+    end
+
+    should "allow accessing keys through attachment proxy" do
+      subject.image.size.should  == 13661
+      subject.file.size.should   == 68926
+
+      subject.image.type.should  == "image/jpeg"
+      subject.file.type.should   == "application/pdf"
+
+      subject.image.id.should_not be_nil
+      subject.file.id.should_not be_nil
+
+      subject.image.id.should be_instance_of(BSON::ObjectId)
+      subject.file.id.should be_instance_of(BSON::ObjectId)
+    end
+
+    should "proxy unknown methods to GridIO object" do
+      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
+      subject.image_name.should  == 'mr_t.jpg'
+      subject.file_name.should   == 'unixref.pdf'
+    end
+
+    should "save attachment contents correctly" do
+      subject.file.read.should   == @file.read
+      subject.image.read.should  == @image.read
+    end
+
+    should "know that attachment exists" do
+      subject.image?.should be(true)
+      subject.file?.should be(true)
     end
 
     should "respond with false when asked if the attachment is blank?" do
@@ -198,6 +272,33 @@ class JointTest < Test::Unit::TestCase
     end
   end
 
+  context "Updating existing attachment in embedded document" do
+    setup do
+      @asset = Asset.new
+      @doc = @asset.embedded_assets.build(:file => @test1)
+      @asset.save!
+      assert_no_grid_difference do
+        @doc.file = @test2
+        @doc.save!
+      end
+      rewind_files
+    end
+    subject { @doc }
+
+    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
+
   context "Updating document but not attachments" do
     setup do
       @doc = Asset.create(:image => @image)
@@ -216,6 +317,26 @@ class JointTest < Test::Unit::TestCase
     end
   end
 
+  context "Updating embedded document but not attachments" do
+    setup do
+      @asset = Asset.new
+      @doc = @asset.embedded_assets.build(:image => @image)
+      @doc.update_attributes(:title => 'Updated')
+      @asset.reload
+      @doc = @asset.embedded_assets.first
+      rewind_files
+    end
+    subject { @doc }
+
+    should "not affect attachment" do
+      subject.image.read.should == @image.read
+    end
+
+    should "update document attributes" do
+      subject.title.should == 'Updated'
+    end
+  end
+
   context "Assigning file where file pointer is not at beginning" do
     setup do
       @image.read
@@ -278,7 +399,58 @@ class JointTest < Test::Unit::TestCase
       assert_nil subject.image_type
       assert_nil subject.image_size
     end
+  end
+
+  context "Setting attachment to nil on embedded document" do
+    setup do
+      @asset = Asset.new
+      @doc = @asset.embedded_assets.build(:image => @image)
+      @asset.save!
+      rewind_files
+    end
+    subject { @doc }
+
+    should "delete attachment after save" do
+      assert_no_grid_difference   { subject.image = nil }
+      assert_grid_difference(-1)  { subject.save }
+    end
 
+    should "know that the attachment has been nullified" do
+      subject.image = nil
+      subject.image?.should be(false)
+    end
+
+    should "respond with true when asked if the attachment is nil?" do
+      subject.image = nil
+      subject.image.nil?.should be(true)
+    end
+
+    should "respond with true when asked if the attachment is blank?" do
+      subject.image = nil
+      subject.image.blank?.should be(true)
+    end
+
+    should "clear nil attachments after save and not attempt to delete again" do
+      Mongo::Grid.any_instance.expects(:delete).once
+      subject.image = nil
+      subject.save
+      Mongo::Grid.any_instance.expects(:delete).never
+      subject.save
+    end
+
+    should "clear id, name, type, size" do
+      subject.image = nil
+      subject.save
+      assert_nil subject.image_id
+      assert_nil subject.image_name
+      assert_nil subject.image_type
+      assert_nil subject.image_size
+      s = subject._root_document.reload.embedded_assets.first
+      assert_nil s.image_id
+      assert_nil s.image_name
+      assert_nil s.image_type
+      assert_nil s.image_size
+    end
   end
 
   context "Retrieving attachment that does not exist" do
@@ -313,6 +485,22 @@ class JointTest < Test::Unit::TestCase
     end
   end
 
+  context "Destroying an embedded document's _root_document" do
+    setup do
+      @asset = Asset.new
+      @doc = @asset.embedded_assets.build(:image => @image)
+      @doc.save!
+      rewind_files
+    end
+    subject { @doc }
+
+    should "remove files from grid fs as well" do
+      assert_grid_difference(-1) { subject._root_document.destroy }
+    end
+  end
+
+  # What about when an embedded document is removed?
+
   context "Assigning file name" do
     should "default to path" do
       Asset.create(:image => @image).image.name.should == 'mr_t.jpg'
@@ -358,15 +546,14 @@ class JointTest < Test::Unit::TestCase
       io = Joint::IO.new({
         :name    => 'foo.txt',
         :type    => 'plain/text',
-        :content => 'This is my stuff',
-        :size    => 19,
+        :content => 'This is my stuff'
       })
       @asset = Asset.create(:file => io)
     end
 
     should "work" do
       @asset.file_name.should == 'foo.txt'
-      @asset.file_size.should == 19
+      @asset.file_size.should == 16
       @asset.file_type.should == 'plain/text'
       @asset.file.read.should == 'This is my stuff'
     end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: joint
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 5
   prerelease: 
   segments: 
   - 0
   - 6
-  - 0
-  version: 0.6.0
+  - 1
+  version: 0.6.1
 platform: ruby
 authors: 
 - John Nunemaker
@@ -15,12 +15,14 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-14 00:00:00 Z
+date: 2011-12-14 00:00:00 -05:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
+  type: :runtime
   name: wand
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -30,12 +32,12 @@ dependencies:
         - 0
         - 4
         version: "0.4"
-  type: :runtime
-  version_requirements: *id001
+  requirement: *id001
 - !ruby/object:Gem::Dependency 
+  type: :runtime
   name: mime-types
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -44,24 +46,22 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :runtime
-  version_requirements: *id002
+  requirement: *id002
 - !ruby/object:Gem::Dependency 
+  type: :runtime
   name: mongo_mapper
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 59
+        hash: 25
         segments: 
         - 0
         - 9
-        - 0
-        version: 0.9.0
-  type: :runtime
-  version_requirements: *id003
+        version: "0.9"
+  requirement: *id003
 description: MongoMapper and GridFS joined in file upload love.
 email: nunemaker@gmail.com
 executables: []
@@ -73,7 +73,6 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.rdoc
 - Rakefile
@@ -95,6 +94,7 @@ files:
 - test/helper.rb
 - test/joint/test_io.rb
 - test/test_joint.rb
+has_rdoc: true
 homepage: http://github.com/jnunemaker/joint
 licenses: []
 
@@ -124,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.9
+rubygems_version: 1.6.1
 signing_key: 
 specification_version: 3
 summary: MongoMapper and GridFS joined in file upload love.

data/Gemfile.lock

@@ -1,52 +0,0 @@
-PATH
-  remote: .
-  specs:
-    joint (0.6.0)
-      mime-types
-      mongo_mapper (~> 0.9.0)
-      wand (~> 0.4)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    activemodel (3.1.0)
-      activesupport (= 3.1.0)
-      bcrypt-ruby (~> 3.0.0)
-      builder (~> 3.0.0)
-      i18n (~> 0.6)
-    activesupport (3.1.0)
-      multi_json (~> 1.0)
-    bcrypt-ruby (3.0.1)
-    bson (1.3.1)
-    bson_ext (1.3.1)
-    builder (3.0.0)
-    i18n (0.6.0)
-    jnunemaker-matchy (0.4.0)
-    mime-types (1.16)
-    mocha (0.9.10)
-      rake
-    mongo (1.3.1)
-      bson (>= 1.3.1)
-    mongo_mapper (0.9.2)
-      activemodel (~> 3.0)
-      activesupport (~> 3.0)
-      plucky (~> 0.3.8)
-    multi_json (1.0.2)
-    plucky (0.3.8)
-      mongo (~> 1.3)
-    rake (0.8.7)
-    safe_shell (1.0.0)
-    shoulda (2.11.3)
-    wand (0.4)
-      mime-types
-      safe_shell (~> 1.0.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bson_ext
-  jnunemaker-matchy
-  joint!
-  mocha
-  shoulda