associo 0.1.0

data/test/fixtures/test1.txt

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

data/test/fixtures/test2.txt

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

data/test/helper.rb

@@ -0,0 +1,96 @@
+require 'bundler/setup'
+Bundler.setup(:default, 'test', 'development')
+
+require 'tempfile'
+require 'pp'
+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)
+    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
+      after = eval(e, b)
+      assert_equal(before[i] + difference, after, error)
+    end
+  end
+
+  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
+
+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
+end
+
+class BaseModel
+  include MongoMapper::Document
+  plugin Joint
+  attachment :file
+end
+
+class Image < BaseModel; attachment :image end
+class Video < BaseModel; attachment :video 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)
+    f = File.open(File.join(File.dirname(__FILE__), 'fixtures', name), 'r')
+    f.binmode
+    f
+  end
+
+  def grid
+    @grid ||= Mongo::Grid.new(MongoMapper.database)
+  end
+
+  def key_names
+    [:id, :name, :type, :size]
+  end
+end

data/test/joint/test_file_helpers.rb

@@ -0,0 +1,52 @@
+require 'helper'
+
+class FileHelpersTest < Test::Unit::TestCase
+  include JointTestHelpers
+
+  def setup
+    super
+    @image  = open_file('mr_t.jpg')
+  end
+
+  def teardown
+    @image.close
+  end
+
+  context ".name" do
+    should "return original_filename" do
+      def @image.original_filename
+        'frank.jpg'
+      end
+      Joint::FileHelpers.name(@image).should == 'frank.jpg'
+    end
+
+    should "fall back to File.basename" do
+      Joint::FileHelpers.name(@image).should == 'mr_t.jpg'
+    end
+  end
+
+  context ".size" do
+    should "return size" do
+      def @image.size
+        25
+      end
+      Joint::FileHelpers.size(@image).should == 25
+    end
+
+    should "fall back to File.size" do
+      Joint::FileHelpers.size(@image).should == 13661
+    end
+  end
+
+  context ".type" do
+    should "return type if Joint::Io instance" do
+      file = Joint::IO.new(:type => 'image/jpeg')
+      Joint::FileHelpers.type(@image).should == 'image/jpeg'
+    end
+
+    should "fall back to Wand" do
+      Joint::FileHelpers.type(@image).should == 'image/jpeg'
+    end
+  end
+
+end

data/test/joint/test_io.rb

@@ -0,0 +1,39 @@
+require 'helper'
+
+class IOTest < Test::Unit::TestCase
+  context "#initialize" do
+    should "set attributes from hash" do
+      Joint::IO.new(:name => 'foo').name.should == 'foo'
+    end
+  end
+
+  should "default type to plain text" do
+    Joint::IO.new.type.should == 'plain/text'
+  end
+
+  should "default size to content size" do
+    content = 'This is my content'
+    Joint::IO.new(:content => content).size.should == content.size
+  end
+
+  should "alias path to name" do
+    Joint::IO.new(:name => 'foo').path.should == 'foo'
+  end
+
+  context "#read" do
+    should "return content" do
+      Joint::IO.new(:content => 'Testing').read.should == 'Testing'
+    end
+  end
+  
+  context "#rewind" do
+    should "rewinds the io to position 0" do
+      io = Joint::IO.new(:content => 'Testing')
+      io.read.should == 'Testing'
+      io.read.should == ''
+      io.rewind
+      io.read.should == 'Testing'
+    end
+  end
+  
+end

data/test/test_joint.rb

@@ -0,0 +1,554 @@
+require 'helper'
+
+class JointTest < Test::Unit::TestCase
+  include JointTestHelpers
+
+  def setup
+    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
+    all_files.each { |file| file.close }
+  end
+
+  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
+      should "add attachment to attachment_names" do
+        BaseModel.attachment_names.should == Set.new([:file])
+      end
+
+      should "inherit attachments from superclass, but not share other inherited class attachments" do
+        Image.attachment_names.should == Set.new([:file, :image])
+        Video.attachment_names.should == Set.new([:file, :video])
+      end
+
+      should "add inherit keys from superclass" do
+        key_names.each do |key|
+          BaseModel.keys.should include("file_#{key}")
+          Image.keys.should     include("file_#{key}")
+          Image.keys.should     include("image_#{key}")
+          Video.keys.should     include("file_#{key}")
+          Video.keys.should     include("video_#{key}")
+        end
+      end
+    end
+  end
+
+  context "Assigning new attachments to document" do
+    setup do
+      @doc = Asset.create(:image => @image, :file => @file)
+      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
+      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
+      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 "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
+
+  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)
+      @doc.update_attributes(:title => 'Updated')
+      @doc.reload
+      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 "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
+      @doc = Asset.create(:image => @image)
+      @doc.reload
+      rewind_files
+    end
+    subject { @doc }
+
+    should "rewind and correctly store contents" do
+      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_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
+      subject.reload
+      assert_nil subject.image_id
+      assert_nil subject.image_name
+      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
+    setup do
+      @doc = Asset.create
+      rewind_files
+    end
+    subject { @doc }
+
+    should "know that the attachment is not present" do
+      subject.image?.should be(false)
+    end
+
+    should "respond with true when asked if the attachment is nil?" do
+      subject.image.nil?.should be(true)
+    end
+
+    should "raise Mongo::GridFileNotFound" do
+      assert_raises(Mongo::GridFileNotFound) { 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_grid_difference(-1) { subject.destroy }
+    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'
+    end
+
+    should "use original_filename if available" do
+      def @image.original_filename
+        'testing.txt'
+      end
+      doc = Asset.create(:image => @image)
+      assert_equal 'testing.txt', doc.image_name
+    end
+  end
+
+  context "Validating attachment presence" do
+    setup do
+      @model_class = Class.new do
+        include MongoMapper::Document
+        plugin Joint
+        attachment :file, :required => true
+
+        def self.name; "Foo"; end
+      end
+    end
+
+    should "work" do
+      model = @model_class.new
+      model.should_not be_valid
+
+      model.file = @file
+      model.should be_valid
+
+      model.file = nil
+      model.should_not be_valid
+
+      model.file = @image
+      model.should be_valid
+    end
+  end
+
+  context "Assigning joint io instance" do
+    setup do
+      io = Joint::IO.new({
+        :name    => 'foo.txt',
+        :type    => 'plain/text',
+        :content => 'This is my stuff'
+      })
+      @asset = Asset.create(:file => io)
+    end
+
+    should "work" do
+      @asset.file_name.should == 'foo.txt'
+      @asset.file_size.should == 16
+      @asset.file_type.should == 'plain/text'
+      @asset.file.read.should == 'This is my stuff'
+    end
+  end
+
+  context "A font file" do
+    setup do
+      @file = open_file('font.eot')
+      @doc = Asset.create(:file => @file)
+    end
+    subject { @doc }
+
+    should "assign joint keys" do
+      subject.file_size.should   == 17610
+      subject.file_type.should   == "application/octet-stream"
+      subject.file_id.should_not be_nil
+      subject.file_id.should be_instance_of(BSON::ObjectId)
+    end
+  end
+
+  context "A music file" do
+    setup do
+      @file = open_file('example.m4r')
+      @doc = Asset.create(:file => @file)
+    end
+    subject { @doc }
+
+    should "assign joint keys" do
+      subject.file_size.should   == 50790
+      subject.file_type.should   == "audio/mp4"
+      subject.file_id.should_not be_nil
+      subject.file_id.should be_instance_of(BSON::ObjectId)
+    end
+  end
+end