joint 0.5 → 0.5.5

data/.gitignore

@@ -0,0 +1,7 @@
+.DS_Store
+log/*
+tmp/*
+doc/*
+pkg/*
+.bundle
+*.swp

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+gem 'i18n', '0.4.2'
+gem 'bson_ext', '~> 1.1', :require => false
+gemspec

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    joint (0.5.2)
+      mime-types
+      mongo_mapper (~> 0.8.6)
+      wand (~> 0.4)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.0.3)
+    bson (1.1.5)
+    bson_ext (1.1.5)
+    i18n (0.4.2)
+    jnunemaker-matchy (0.4.0)
+    jnunemaker-validatable (1.8.4)
+      activesupport (>= 2.3.4)
+    mime-types (1.16)
+    mocha (0.9.10)
+      rake
+    mongo (1.1.5)
+      bson (>= 1.1.5)
+    mongo_mapper (0.8.6)
+      activesupport (>= 2.3.4)
+      jnunemaker-validatable (~> 1.8.4)
+      plucky (~> 0.3.6)
+    plucky (0.3.6)
+      mongo (~> 1.1)
+    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 (~> 1.1)
+  i18n (= 0.4.2)
+  jnunemaker-matchy
+  joint!
+  mime-types
+  mocha
+  mongo_mapper (~> 0.8.6)
+  shoulda
+  wand (~> 0.4)

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+Rake::TestTask.new do |test|
+  test.libs      << 'lib' << 'test'
+  test.pattern   = 'test/**/test_*.rb'
+  test.ruby_opts = ['-rubygems']
+  test.verbose   = true
+end
+
+task :default => :test

data/joint.gemspec

@@ -0,0 +1,25 @@
+# encoding: UTF-8
+require File.expand_path('../lib/joint/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "joint"
+  s.summary     = %Q{MongoMapper and GridFS joined in file upload love.}
+  s.description = %Q{MongoMapper and GridFS joined in file upload love.}
+  s.email       = "nunemaker@gmail.com"
+  s.homepage    = "http://github.com/jnunemaker/joint"
+  s.authors     = ["John Nunemaker"]
+  s.version     = Joint::Version
+
+  s.add_dependency 'wand', '~> 0.4'
+  s.add_dependency 'mime-types'
+  s.add_dependency 'mongo_mapper', '~> 0.8.6'
+
+  s.add_development_dependency 'shoulda'
+  s.add_development_dependency 'mocha'
+  s.add_development_dependency 'jnunemaker-matchy'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/joint/attachment_proxy.rb

@@ -0,0 +1,35 @@
+module Joint
+  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 nil?
+      !@instance.send("#{@name}?")
+    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/class_methods.rb

@@ -0,0 +1,49 @@
+module Joint
+  module ClassMethods
+    def attachment_accessor_module
+      @attachment_accessor_module ||= Module.new
+    end
+
+    def attachment(name, options = {})
+      options.symbolize_keys!
+      name = name.to_sym
+
+      self.attachment_names << name
+
+      after_save     :save_attachments
+      after_save     :destroy_nil_attachments
+      before_destroy :destroy_all_attachments
+
+      key :"#{name}_id",   ObjectId
+      key :"#{name}_name", String
+      key :"#{name}_size", Integer
+      key :"#{name}_type", String
+
+      validates_presence_of(name) if options[:required]
+
+      attachment_accessor_module.module_eval <<-EOC
+        def #{name}
+          @#{name} ||= AttachmentProxy.new(self, :#{name})
+        end
+
+        def #{name}?
+          !nil_attachments.include?(:#{name}) && send(:#{name}_id?)
+        end
+
+        def #{name}=(file)
+          if file.nil?
+            nil_attachments << :#{name}
+            assigned_attachments.delete(:#{name})
+          else
+            send("#{name}_id=", BSON::ObjectId.new) if send("#{name}_id").nil?
+            send("#{name}_name=", Joint.name(file))
+            send("#{name}_size=", Joint.size(file))
+            send("#{name}_type=", Joint.type(file))
+            assigned_attachments[:#{name}] = file
+            nil_attachments.delete(:#{name})
+          end
+        end
+      EOC
+    end
+  end
+end

data/lib/joint/instance_methods.rb

@@ -0,0 +1,54 @@
+module Joint
+  module InstanceMethods
+    def grid
+      @grid ||= Mongo::Grid.new(database)
+    end
+
+    private
+      def assigned_attachments
+        @assigned_attachments ||= {}
+      end
+
+      def nil_attachments
+        @nil_attachments ||= Set.new
+      end
+
+      # IO must respond to read and rewind
+      def save_attachments
+        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, {
+            :_id          => send(name).id,
+            :filename     => send(name).name,
+            :content_type => send(name).type,
+          })
+        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)
+          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
+
+        nil_attachments.clear
+      end
+
+      def destroy_all_attachments
+        self.class.attachment_names.map { |name| grid.delete(send(name).id) }
+      end
+  end
+end

data/lib/joint/io.rb

@@ -0,0 +1,14 @@
+module Joint
+  class IO
+    attr_accessor :name, :content, :type, :size
+
+    def initialize(attrs={})
+      attrs.each { |key, value| send("#{key}=", value) }
+      @type ||= 'plain/text'
+      @size ||= @content.size unless @content.nil?
+    end
+
+    alias path name
+    alias read content
+  end
+end

data/lib/joint/version.rb

@@ -1,3 +1,3 @@
 module Joint
-  Version = '0.5'
+  Version = '0.5.5'
 end

data/lib/joint.rb

@@ -3,150 +3,40 @@ require 'mime/types'
 require 'wand'
 
 module Joint
-  autoload :Version, 'joint/version'
-
   def self.configure(model)
     model.class_inheritable_accessor :attachment_names
     model.attachment_names = Set.new
     model.send(:include, model.attachment_accessor_module)
   end
 
-  module ClassMethods
-    def attachment_accessor_module
-      @attachment_accessor_module ||= Module.new
-    end
-
-    def attachment(name, options = {})
-      options.symbolize_keys!
-      name = name.to_sym
-
-      self.attachment_names << name
-
-      after_save     :save_attachments
-      after_save     :destroy_nil_attachments
-      before_destroy :destroy_all_attachments
-
-      key :"#{name}_id",   ObjectId
-      key :"#{name}_name", String
-      key :"#{name}_size", Integer
-      key :"#{name}_type", String
-
-      validates_presence_of(name) if options[:required]
-
-      attachment_accessor_module.module_eval <<-EOC
-        def #{name}
-          @#{name} ||= AttachmentProxy.new(self, :#{name})
-        end
-
-        def #{name}?
-          !nil_attachments.include?(:#{name}) && send(:#{name}_id?)
-        end
-
-        def #{name}=(file)
-          if file.nil?
-            nil_attachments << :#{name}
-            assigned_attachments.delete(:#{name})
-          else
-            send("#{name}_id=", BSON::ObjectId.new) if send("#{name}_id").nil?
-            send("#{name}_size=", File.size(file))
-            send("#{name}_type=", Wand.wave(file.path))
-            send("#{name}_name=", Joint.file_name(file))
-            assigned_attachments[:#{name}] = file
-            nil_attachments.delete(:#{name})
-          end
-        end
-      EOC
+  def self.name(file)
+    if file.respond_to?(:original_filename)
+      file.original_filename
+    else
+      File.basename(file.path)
     end
   end
 
-  module InstanceMethods
-    def grid
-      @grid ||= Mongo::Grid.new(database)
+  def self.size(file)
+    if file.respond_to?(:size)
+      file.size
+    else
+      File.size(file)
     end
-
-    private
-      def assigned_attachments
-        @assigned_attachments ||= {}
-      end
-
-      def nil_attachments
-        @nil_attachments ||= Set.new
-      end
-
-      # IO must respond to read and rewind
-      def save_attachments
-        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, {
-            :_id          => send(name).id,
-            :filename     => send(name).name,
-            :content_type => send(name).type,
-          })
-        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)
-          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
-
-        nil_attachments.clear
-      end
-
-      def destroy_all_attachments
-        self.class.attachment_names.map { |name| grid.delete(send(name).id) }
-      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 nil?
-      !@instance.send("#{@name}?")
-    end
-
-    def grid_io
-      @grid_io ||= @instance.grid.get(id)
-    end
-
-    def method_missing(method, *args, &block)
-      grid_io.send(method, *args, &block)
-    end
+  def self.type(file)
+    return file.type if file.is_a?(Joint::IO)
+    Wand.wave(file.path, :original_filename => Joint.name(file))
   end
 
-  def self.file_name(file)
-    file.respond_to?(:original_filename) ? file.original_filename : File.basename(file.path)
+private
+  def self.blank?(str)
+    str.nil? || str !~ /\S/
   end
 end
+
+require 'joint/class_methods'
+require 'joint/instance_methods'
+require 'joint/attachment_proxy'
+require 'joint/io'

data/specs.watchr

@@ -0,0 +1,38 @@
+def run(cmd)
+  puts(cmd)
+  output = ""
+  IO.popen(cmd) do |com|
+    com.each_char do |c|
+      print c
+      output << c
+      $stdout.flush
+    end
+  end
+  output
+end
+
+def run_test_file(file)
+  run %Q(ruby -I"lib:test" -rubygems #{file})
+end
+
+def run_all_tests
+  run "rake test"
+end
+
+def related_test_files(path)
+  Dir['test/**/*.rb'].select { |file| file =~ /test_#{File.basename(path)}/ }
+end
+
+watch('test/test_helper\.rb') { system('clear'); run_all_tests }
+watch('test/.*test_.*\.rb')     { |m| system('clear'); run_test_file(m[0]) }
+watch('lib/.*')               { |m| related_test_files(m[0]).each { |file| run_test_file(file) } }
+
+# Ctrl-\
+Signal.trap('QUIT') do
+  puts " --- Running all tests ---\n\n"
+  run_all_tests
+end
+
+# Ctrl-C
+Signal.trap('INT') { abort("\n") }
+

data/test/helper.rb

@@ -37,4 +37,44 @@ class Test::Unit::TestCase
   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
+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)
+    File.open(File.join(File.dirname(__FILE__), 'fixtures', name), 'r')
+  end
+
+  def grid
+    @grid ||= Mongo::Grid.new(MongoMapper.database)
+  end
+
+  def key_names
+    [:id, :name, :type, :size]
+  end
 end

data/test/joint/test_io.rb

@@ -0,0 +1,28 @@
+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
+end

data/test/test_joint.rb

@@ -1,45 +1,5 @@
 require 'helper'
 
-class Asset
-  include MongoMapper::Document
-  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)
-    File.open(File.join(File.dirname(__FILE__), 'fixtures', name), 'r')
-  end
-
-  def grid
-    @grid ||= Mongo::Grid.new(MongoMapper.database)
-  end
-
-  def key_names
-    [:id, :name, :type, :size]
-  end
-end
-
 class JointTest < Test::Unit::TestCase
   include JointTestHelpers
 
@@ -56,6 +16,43 @@ class JointTest < Test::Unit::TestCase
     all_files.each { |file| file.close }
   end
 
+  context ".name" do
+    should "return original_filename" do
+      def @image.original_filename
+        'frank.jpg'
+      end
+      Joint.name(@image).should == 'frank.jpg'
+    end
+
+    should "fall back to File.basename" do
+      Joint.name(@image).should == 'mr_t.jpg'
+    end
+  end
+
+  context ".size" do
+    should "return size" do
+      def @image.size
+        25
+      end
+      Joint.size(@image).should == 25
+    end
+
+    should "fall back to File.size" do
+      Joint.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.type(@image).should == 'image/jpeg'
+    end
+
+    should "fall back to Wand" do
+      Joint.type(@image).should == 'image/jpeg'
+    end
+  end
+
   context "Using Joint plugin" do
     should "add each attachment to attachment_names" do
       Asset.attachment_names.should == Set.new([:image, :file])
@@ -343,4 +340,53 @@ class JointTest < Test::Unit::TestCase
       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',
+        :size    => 19,
+      })
+      @asset = Asset.create(:file => io)
+    end
+
+    should "work" do
+      @asset.file_name.should == 'foo.txt'
+      @asset.file_size.should == 19
+      @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

metadata

@@ -6,7 +6,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 5
-  version: "0.5"
+  - 5
+  version: 0.5.5
 platform: ruby
 authors: 
 - John Nunemaker
@@ -14,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-06 00:00:00 -05:00
+date: 2011-01-22 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,12 +26,11 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 21
+        hash: 3
         segments: 
         - 0
-        - 2
-        - 1
-        version: 0.2.1
+        - 4
+        version: "0.4"
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -114,17 +114,30 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- lib/joint/version.rb
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.rdoc
+- Rakefile
+- joint.gemspec
 - lib/joint.rb
+- lib/joint/attachment_proxy.rb
+- lib/joint/class_methods.rb
+- lib/joint/instance_methods.rb
+- lib/joint/io.rb
+- lib/joint/version.rb
+- specs.watchr
+- test/fixtures/example.m4r
+- test/fixtures/font.eot
 - 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/joint/test_io.rb
 - test/test_joint.rb
-- LICENSE
-- README.rdoc
 has_rdoc: true
 homepage: http://github.com/jnunemaker/joint
 licenses: []
@@ -160,10 +173,13 @@ signing_key:
 specification_version: 3
 summary: MongoMapper and GridFS joined in file upload love.
 test_files: 
+- test/fixtures/example.m4r
+- test/fixtures/font.eot
 - 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/joint/test_io.rb
 - test/test_joint.rb