jnunemaker-grip 0.1

data/.gitignore

@@ -0,0 +1,9 @@
+.DS_Store
+**/.DS_Store
+db/mongo*
+log/*
+tmp/*
+tmp/**/*
+config/database.yml
+coverage/*
+coverage/**/*

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 John Nunemaker
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,36 @@
+= Grip
+
+Attachment plugin for MongoMapper that uses GridFS.
+
+== Usage
+
+Declare the plugin and use the attachment method to make attachments.
+
+  class Foo
+    include MongoMapper::Document
+    plugin Grip
+
+    attachment :image
+    attachment :pdf
+  end
+
+This gives you #image, #image=, #pdf, and #pdf=. The = methods take any IO that responds to read (File, Tempfile, etc). The image and pdf methods return a GridIO instance (can be found in the ruby driver).
+
+== Dependencies
+
+* MongoMapper 0.7.1 - gem install mongo_mapper
+* Wand >= 0.2.1 - gem install wand
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 John Nunemaker. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,59 @@
+require 'rubygems'
+require 'rake'
+
+require File.join(File.dirname(__FILE__), 'lib', 'grip', 'version')
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name        = "jnunemaker-grip"
+    gem.summary     = %Q{Attachment plugin for MongoMapper that uses GridFS.}
+    gem.description = %Q{Attachment plugin for MongoMapper that uses GridFS.}
+    gem.email       = "nunemaker@gmail.com"
+    gem.homepage    = "http://github.com/jnunemaker/grip"
+    gem.authors     = ["John Nunemaker"]
+    gem.version     = Grip::Version
+
+    gem.add_dependency 'wand', '>= 0.2.1'
+    gem.add_development_dependency 'mongo_mapper', '0.7.1'
+    gem.add_development_dependency 'shoulda'
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.ruby_opts << '-rubygems'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "grip #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/jnunemaker-grip.gemspec

@@ -0,0 +1,61 @@
+# 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{jnunemaker-grip}
+  s.version = "0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["John Nunemaker"]
+  s.date = %q{2010-03-10}
+  s.description = %q{Attachment plugin for MongoMapper that uses GridFS.}
+  s.email = %q{nunemaker@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "jnunemaker-grip.gemspec",
+     "lib/grip.rb",
+     "lib/grip/version.rb",
+     "test/fixtures/cthulhu.png",
+     "test/fixtures/sample.pdf",
+     "test/helper.rb",
+     "test/test_grip.rb"
+  ]
+  s.homepage = %q{http://github.com/jnunemaker/grip}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Attachment plugin for MongoMapper that uses GridFS.}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_grip.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
+      s.add_runtime_dependency(%q<wand>, [">= 0.2.1"])
+      s.add_development_dependency(%q<mongo_mapper>, ["= 0.7.1"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<wand>, [">= 0.2.1"])
+      s.add_dependency(%q<mongo_mapper>, ["= 0.7.1"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<wand>, [">= 0.2.1"])
+    s.add_dependency(%q<mongo_mapper>, ["= 0.7.1"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+  end
+end
+

data/lib/grip/version.rb

@@ -0,0 +1,3 @@
+module Grip
+  Version = '0.1'
+end

data/lib/grip.rb

@@ -0,0 +1,59 @@
+require 'mime/types'
+require 'wand'
+
+module Grip
+  module ClassMethods
+    def attachment(name)
+      write_inheritable_attribute(:attachment_definitions, {}) if attachment_definitions.nil?
+      attachment_definitions[name] = {}
+
+      after_save     :save_attachments
+      before_destroy :destroy_attached_files
+
+      key "#{name}_id".to_sym,   ObjectId
+      key "#{name}_name".to_sym, String
+      key "#{name}_size".to_sym, Integer
+      key "#{name}_type".to_sym, String
+
+      define_method(name) do
+        self.class.grid.get(self["#{name}_id"])
+      end
+
+      define_method("#{name}=") do |file|
+        self["#{name}_id"]   = Mongo::ObjectID.new
+        self["#{name}_size"] = File.size(file)
+        self["#{name}_name"] = File.basename(file.path)
+        self["#{name}_type"] = Wand.wave(file.path)
+        self.class.attachment_definitions[name] = file
+      end
+    end
+
+    def grid
+      @grid ||= Mongo::Grid.new(database)
+    end
+
+    def attachment_definitions
+      read_inheritable_attribute(:attachment_definitions)
+    end
+  end
+
+  module InstanceMethods
+    private
+      def save_attachments
+        self.class.attachment_definitions.each do |attachment|
+          name, file = attachment
+          content_type = self["#{name}_type"]
+
+          if file.respond_to?(:read)
+            self.class.grid.put(file.read, self["#{name}_name"], :content_type => content_type, :_id => self["#{name}_id"])
+          end
+        end
+      end
+
+      def destroy_attached_files
+        self.class.attachment_definitions.each do |name, attachment|
+          self.class.grid.delete(self["#{name}_id"])
+        end
+      end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,23 @@
+require 'test/unit'
+require 'pp'
+
+require 'mongo_mapper'
+
+require File.expand_path(File.dirname(__FILE__) + '/../lib/grip')
+
+MongoMapper.database = "testing"
+
+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

data/test/test_grip.rb

@@ -0,0 +1,68 @@
+require 'helper'
+
+class Foo
+  include MongoMapper::Document
+  plugin Grip
+
+  attachment :image
+  attachment :pdf
+end
+
+class GripTest < Test::Unit::TestCase
+  def setup
+    MongoMapper.database.collections.each(&:remove)
+    @grid = Mongo::Grid.new(MongoMapper.database)
+
+    dir    = File.dirname(__FILE__) + '/fixtures'
+    @pdf   = File.open("#{dir}/sample.pdf",  'r')
+    @pdf_contents = File.read("#{dir}/sample.pdf")
+    @image = File.open("#{dir}/cthulhu.png", 'r')
+    @image_contents = File.read("#{dir}/cthulhu.png")
+
+    @doc = Foo.create(:image => @image, :pdf => @pdf)
+    @doc.reload
+  end
+
+  def teardown
+    @pdf.close
+    @image.close
+  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_type
+    assert_equal "application/pdf", @doc.pdf_type
+
+    assert_not_nil @doc.image_id
+    assert_not_nil @doc.pdf_id
+    assert_kind_of Mongo::ObjectID, @doc.image_id
+    assert_kind_of Mongo::ObjectID, @doc.pdf_id
+
+    assert_equal "image/png", @grid.get(@doc.image_id).content_type
+    assert_equal "application/pdf", @grid.get(@doc.pdf_id).content_type
+  end
+
+  test "responds to keys" do
+    [ :pdf_size,   :pdf_id,   :pdf_name,   :pdf_type,
+      :image_size, :image_id, :image_name, :image_type
+    ].each do |method|
+      assert @doc.respond_to?(method)
+    end
+  end
+
+  test "saves attachments correctly" do
+    assert_equal @pdf_contents, @doc.pdf.read
+    assert_equal @image_contents, @doc.image.read
+  end
+
+  test "cleans up attachments on destroy" do
+    @doc.destroy
+    assert_raises(Mongo::GridError) { @grid.get(@doc.image_id) }
+    assert_raises(Mongo::GridError) { @grid.get(@doc.pdf_id) }
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification 
+name: jnunemaker-grip
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+platform: ruby
+authors: 
+- John Nunemaker
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-10 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: wand
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mongo_mapper
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.7.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Attachment plugin for MongoMapper that uses GridFS.
+email: nunemaker@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- jnunemaker-grip.gemspec
+- lib/grip.rb
+- lib/grip/version.rb
+- test/fixtures/cthulhu.png
+- test/fixtures/sample.pdf
+- test/helper.rb
+- test/test_grip.rb
+has_rdoc: true
+homepage: http://github.com/jnunemaker/grip
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Attachment plugin for MongoMapper that uses GridFS.
+test_files: 
+- test/helper.rb
+- test/test_grip.rb