grip 0.3.0 → 0.4.0

data/.gitignore

@@ -1 +1,2 @@
-*.gem
+*.gem
+pkg/*

data/README.rdoc

@@ -1,9 +1,15 @@
-Grip
-==============
+= grip
 
-GridFS Attachment gem for MongoMapper
+GridFS attachments for MongoMapper
 
-**Sample Class**
+= installation
+
+The grip gem is hosted on gemcutter.org:
+
+* gem install grip
+
+
+= Usage
 
     class Foo
       include MongoMapper::Document

data/Rakefile

@@ -0,0 +1,26 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+ 
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |g|
+    g.name = 'grip'
+    g.summary = %(GridFS attachments for MongoMapper)
+    g.description = %(GridFS attachments for MongoMapper)
+    g.email = 'signalstatic@gmail.com'
+    g.homepage = 'http://github.com/twoism/grip'
+    g.authors = %w(twoism)
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts 'Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com'
+end
+ 
+Rake::TestTask.new do |t|
+  t.libs = %w(test)
+  t.pattern = 'test/**/*_test.rb'
+end
+ 
+task :default => :test

data/VERSION

@@ -0,0 +1 @@
+0.4.0

data/grip.gemspec

@@ -0,0 +1,52 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{grip}
+  s.version = "0.4.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["twoism"]
+  s.date = %q{2009-12-23}
+  s.description = %q{GridFS attachments for MongoMapper}
+  s.email = %q{signalstatic@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "grip.gemspec",
+     "lib/grip.rb",
+     "test/fixtures/cthulhu.png",
+     "test/fixtures/sample.pdf",
+     "test/test_grip.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/twoism/grip}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{GridFS attachments for MongoMapper}
+  s.test_files = [
+    "test/test_grip.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/lib/grip.rb

@@ -1,76 +1,74 @@
-include Mongo
-include GridFS
-module Grip
-  
-  module InstanceMethods
-    
-    # Save Path: <classname>/<id>/<method_name>/<file_basename>
-    def file_save_path name,file_name
-      [self.class.to_s.underscore,self.id,name,file_name].join("/")
-    end
-    
-    def save_attachments
-      self.class.attachment_definitions.each do |attachment|
-        name, file  = attachment
-        if file.is_a?(File)
-          
-          file_path   = file.original_filename rescue file.path.split("/").last
-          path        = file_save_path(name,file_path)
-          
-          GridStore.open(self.class.database, path, 'w') do |f|
-            content_type    = file.content_type rescue MIME::Types.type_for(file.path).first.content_type
-            f.content_type  = content_type
-            f.puts file.read
-          end
-        
-          self.send("#{name}_path=",path)
-          save_to_collection
-        end
-      end
-    end
-    
-    def destroy_attached_files
-      self.class.attachment_definitions.each do |name, attachment|
-        GridStore.unlink(self.class.database, send("#{name}_path"))
-      end
-    end
-    
-    def file_from_grid name
-      GridStore.open(self.class.database, send("#{name}_path"), 'r') {|f| f }
-    end
+require 'mongo/gridfs'
+require 'mime/types'
+require 'tempfile'
+
+# if thumbnailable?
+#   tmp = Tempfile.new("thumb_#{filename}")
+#   MojoMagick::resize(uploaded_file.path, tmp.path, {:width => 50, :height => 40, :scale => '>'})
+#   self.thumbnail = tmp.read      
+# end
 
+# open    : db, name, mode, options (:root, :metadata, :content_type)
+# read    : db, name, length, offset
+# unlink  : db, names
+# list    : db, root collection
+#
+# GridStore.open(database, 'filename', 'w') { |f|
+#   f.puts "Hello, world!"
+# }
+
+module Grip
+  def self.included(base)
+    base.extend Grip::ClassMethods
   end
+  
   module ClassMethods
-    
-    def has_grid_attachment name
-      include InstanceMethods
-      
-      # thanks to thoughtbot's paperclip!
+    def has_grid_attachment(name)
       write_inheritable_attribute(:attachment_definitions, {}) if attachment_definitions.nil?
       attachment_definitions[name] = {}
       
-      define_method name do
-        file_from_grid name
+      after_save :save_attachments
+      before_destroy :destroy_attached_files
+      
+      key "#{name}_size".to_sym, Integer
+      key "#{name}_path".to_sym, String
+      key "#{name}_name".to_sym, String
+      key "#{name}_content_type".to_sym, String
+      
+      define_method(name) do
+        GridFS::GridStore.read(self.class.database, self["#{name}_path"])
       end
-
-      define_method "#{name}=" do |file|
+      
+      define_method("#{name}=") do |file|
+        self['_id']                  = Mongo::ObjectID.new if _id.blank?
+        self["#{name}_size"]         = File.size(file)
+        self["#{name}_name"]         = File.basename(file.path)
+        self["#{name}_path"]         = "#{self.class.to_s.underscore}/#{name}/#{_id}"
+        self["#{name}_content_type"] = file.content_type rescue MIME::Types.type_for(self["#{name}_name"]).to_s
         self.class.attachment_definitions[name] = file
       end
-      
-      key "#{name}_path".to_sym, String
     end
     
     def attachment_definitions
       read_inheritable_attribute(:attachment_definitions)
     end
-
   end
   
-  def self.included(base)
-    base.extend Grip::ClassMethods
-    base.class_eval do |klass|
-      after_save :save_attachments
-      before_destroy :destroy_attached_files
+  def save_attachments
+    self.class.attachment_definitions.each do |attachment|
+      name, file = attachment
+      
+      if (file.is_a?(File) || file.is_a?(Tempfile))
+        GridFS::GridStore.open(self.class.database, self["#{name}_path"], 'w', :content_type => self["#{name}_content_type"]) do |f|
+          f.write(file.read)
+        end
+      end
+    end
+  end
+  
+  def destroy_attached_files
+    self.class.attachment_definitions.each do |name, attachment|
+      GridFS::GridStore.unlink(self.class.database, self["#{name}_path"])
     end
   end
 end

data/test/test_grip.rb

@@ -1,58 +1,73 @@
 require "test_helper"
-require File.expand_path(File.dirname(__FILE__) + '/../lib/grip')
-
 
 class Foo
   include MongoMapper::Document
   include Grip
-  key :name, String
+  
   has_grid_attachment :image
   has_grid_attachment :pdf
 end
 
-
-class TestContent< Test::Unit::TestCase
-  
-  context "A MongoMapper Document" do
+class GripTest < Test::Unit::TestCase
+  def setup
+    MongoMapper.connection.drop_database "test-attachments"
+    MongoMapper.database = "test-attachments"
     
-    context "with an attachment" do
-      setup do
-        @image = File.open("#{File.dirname(__FILE__)}/cthulhu.png",'r')
-        @pdf   = File.open("#{File.dirname(__FILE__)}/sample.pdf",'r')
-
-        @document = Foo.create(:image=>@image,:pdf=>@pdf)
-        @from_collection = Foo.first
-      end
-
-      should "only define callbacks once" do
-        assert_equal(1, Foo.after_save.collect(&:method).count)
-        assert_equal(1, Foo.before_destroy.collect(&:method).count)
-      end
-      
-      should "have correct mime type" do
-        assert_equal("image/png", @from_collection.image.content_type)
-        assert_equal("application/pdf", @from_collection.pdf.content_type)
-      end
-      
-      should "respond to the dynamic keys" do
-        [:pdf_path,:image_path].each {|k| assert @document.respond_to? k  }
-      end
-
-      should "have the correct paths" do
-        assert_equal("foo/#{@document.id}/image/cthulhu.png", @document.image_path)
-        assert_equal("foo/#{@document.id}/pdf/sample.pdf", @document.pdf_path)
-      end
-
-      should "cleanup attachments" do
-        img_path = "foo/#{@document._id}/image/cthulhu.png", @document.image_path
-        pdf_path = "foo/#{@document._id}/pdf/sample.pdf", @document.pdf_path
+    dir    = File.dirname(__FILE__) + '/fixtures'
+    @pdf   = File.open("#{dir}/sample.pdf",  'r')
+    @image = File.open("#{dir}/cthulhu.png", 'r')
+    
+    @doc = Foo.create(:image => @image, :pdf => @pdf)
+    @doc.reload
+  end
   
-        @document.destroy
+  def teardown
+    @pdf.close
+    @image.close
+  end
   
-        assert !GridStore.exist?(MONGO_DB,img_path)
-        assert !GridStore.exist?(MONGO_DB,pdf_path)
-      end
-      
+  test "assigns keys correctly" do
+    assert_equal 27582, @doc.image_size
+    assert_equal 8775,  @doc.pdf_size
+    
+    assert_equal 'cthulhu.png', @doc.image_name
+    assert_equal 'sample.pdf',  @doc.pdf_name
+    
+    assert_equal "image/png",       @doc.image_content_type
+    assert_equal "application/pdf", @doc.pdf_content_type
+    
+    assert_equal "foo/image/#{@doc.id}", @doc.image_path
+    assert_equal "foo/pdf/#{@doc.id}",   @doc.pdf_path
+    
+    collection = MongoMapper.database['fs.files']
+    
+    assert_equal "image/png", collection.find_one(:filename => @doc.image_path)['contentType']
+    assert_equal "application/pdf", collection.find_one(:filename => @doc.pdf_path)['contentType']
+  end
+  
+  test "responds to dynamic keys" do
+    [ :pdf_size, :pdf_path, :pdf_name, :pdf_content_type,
+      :image_size, :image_path, :image_name, :image_content_type
+    ].each do |method|
+      assert @doc.respond_to?(method)
     end
   end
+  
+  test "saves attachments correctly" do
+    assert_equal @image.read, @doc.image
+    assert_equal @pdf.read,   @doc.pdf
+    
+    assert GridFS::GridStore.exist?(MongoMapper.database, @doc.image_path)
+    assert GridFS::GridStore.exist?(MongoMapper.database, @doc.pdf_path)
+  end
+  
+  test "cleans up attachments on destroy" do
+    assert GridFS::GridStore.exist?(MongoMapper.database, @doc.image_path)
+    assert GridFS::GridStore.exist?(MongoMapper.database, @doc.pdf_path)
+    
+    @doc.destroy
+    
+    assert ! GridFS::GridStore.exist?(MongoMapper.database, @doc.image_path)
+    assert ! GridFS::GridStore.exist?(MongoMapper.database, @doc.pdf_path)
+  end
 end

data/test/test_helper.rb

@@ -1,25 +1,23 @@
-%w{rubygems mongomapper shoulda mongo/gridfs mime/types}.each {|f| require f}
+require 'test/unit'
+require 'pp'
 
+require 'mongo_mapper'
 
+require File.expand_path(File.dirname(__FILE__) + '/../lib/grip')
 
 MongoMapper.database = "test-attachments"
 
-# For Grip
-MONGO_DB = MongoMapper.database
-
-
-class ActiveSupport::TestCase
-  # Drop all columns after each test case.
-  def teardown
-    MongoMapper.connection.drop_database "test-attachments"
-    MongoMapper.database = "test-attachments"
-  end
-
-  # Make sure that each test case has a teardown
-  # method to clear the db after each test.
-  def inherited(base)
-    base.define_method teardown do 
-      super
+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
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: grip
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - twoism
@@ -25,12 +25,15 @@ extra_rdoc_files:
 files: 
 - .gitignore
 - LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- grip.gemspec
 - lib/grip.rb
-- test/cthulhu.png
-- test/sample.pdf
+- test/fixtures/cthulhu.png
+- test/fixtures/sample.pdf
 - test/test_grip.rb
 - test/test_helper.rb
-- README.rdoc
 has_rdoc: true
 homepage: http://github.com/twoism/grip
 licenses: []