carrierwave-mongoid 0.2.2 → 0.3.0

data/.gitignore

@@ -1,5 +1,6 @@
 pkg/*
 *.gem
+*.sw*
 .bundle
 spec/public
 .rvmrc

data/README.md

@@ -1,35 +1,45 @@
 # CarrierWave for Mongoid
 
-This gem adds support for Mongoid and MongoDB's GridFS to [CarrierWave](https://github.com/jnicklas/carrierwave/)
+This gem adds support for Mongoid and MongoDB's GridFS to
+[CarrierWave](https://github.com/jnicklas/carrierwave/)
 
-This functionality used to be part of CarrierWave but has since been extracted into this gem.
+This functionality used to be part of CarrierWave but has since been extracted
+into this gem.
 
 ## Installation
 
+Install the latest release:
+
     gem install carrierwave-mongoid
 
-## Requiring the gem
+Require it in your code:
 
     require 'carrierwave/mongoid'
 
-## Using Bundler
+Or, in Rails you can add it to your Gemfile:
 
     gem 'carrierwave-mongoid', :require => 'carrierwave/mongoid'
 
-## Using MongoDB's GridFS store
+## Getting Started
 
-You'll need to configure the database and host to use:
+Follow the "Getting Started" directions in the main
+[Carrierwave repository](https://raw.github.com/jnicklas/carrierwave/).
 
-```ruby
-CarrierWave.configure do |config|
-  config.grid_fs_database = 'my_mongo_database'
-  config.grid_fs_host = 'mongo.example.com'
-end
-```
+[Suggested] Add the field to your attr_accessor list for mass assignment
+protection:
+
+    attr_accessible :avatar, :avatar_cache
+
+Now you can cache files by assigning them to the attribute; they will
+automatically be stored when the record is saved. Ex:
 
-The defaults are `carrierwave` and `localhost`.
+    u = User.new
+    u.avatar = File.open('somewhere')
+    u.save!
 
-And then in your uploader, set the storage to `:grid_fs`:
+## Using MongoDB's GridFS store
+
+In your uploader, set the storage to `:grid_fs`:
 
 ```ruby
 class AvatarUploader < CarrierWave::Uploader::Base
@@ -39,18 +49,31 @@ end
 
 Since GridFS doesn't make the files available via HTTP, you'll need to stream
 them yourself. In Rails for example, you could use the `send_data` method. You
-can tell CarrierWave the URL you will serve your images from, allowing it to
-generate the correct URL, by setting eg:
+can optionally tell CarrierWave the URL you will serve your images from,
+allowing it to generate the correct URL, by setting eg:
+
+```ruby
+CarrierWave.configure do |config|
+  config.grid_fs_access_url = "/systems/uploads"
+end
+```
+
+Bringing it all together, you can also configure Carrierwave to use Mongoid's
+database connection and default all storage to GridFS. That might look something
+like this:
 
 ```ruby
 CarrierWave.configure do |config|
-  config.grid_fs_access_url = "/image/show"
+  config.grid_fs_connection = Mongoid.database
+  config.storage = :grid_fs
+  config.root = Rails.root.join('tmp')
+  config.cache_dir = "uploads"
 end
 ```
 
 ## Version differences
 
-### 0.2.0
+### 0.2.x
 
 carrierwave-mongoid ~> 0.2.0 is only compatible with Rails 3.2 or higher.
 

data/carrierwave-mongoid.gemspec

@@ -19,10 +19,11 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency "carrierwave", ["~> 0.6.1"]
-  s.add_dependency "mongoid", ["~> 2.1"]
+  s.add_dependency "carrierwave", ["~> 0.7.1"]
+  s.add_dependency "mongoid", ["~> 3.0"]
+  s.add_dependency "mongoid-grid_fs", ["~> 1.3"]
   s.add_development_dependency "rspec", ["~> 2.6"]
-  s.add_development_dependency "bson_ext", ["~> 1.3"]
-  s.add_development_dependency "rake", ["~> 0.9"]
+  s.add_development_dependency "rake", ["~> 10.0"]
   s.add_development_dependency "mini_magick"
+  s.add_development_dependency "pry"
 end

data/lib/carrierwave/mongoid.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 
 require 'mongoid'
+require 'mongoid-grid_fs'
 require 'carrierwave'
 require 'carrierwave/validations/active_model'
 
@@ -38,10 +39,6 @@ module CarrierWave
           super
         end
 
-        def remove_#{column}!
-          super unless paranoid? && flagged_for_destroy?
-        end
-
         # Overrides Mongoid's default dirty behavior to instead work more like
         # ActiveRecord's. Mongoid doesn't deem an attribute as changed unless
         # the new value is different than the original. Given that CarrierWave
@@ -60,14 +57,16 @@ module CarrierWave
             association = ancestors.inject(reloaded_parent) { |parent,(key,ancestor)| (parent.is_a?(Array) ? parent.find(ancestor.to_key.first) : parent).send(key) }
             association.is_a?(Array) ? association.find(to_key.first) : association
           else
-            self.class.unscoped.find(to_key.first)
+            self.class.unscoped.for_ids(to_key).first
           end
         end
 
         def serializable_hash(options=nil)
           hash = {}
           self.class.uploaders.each do |column, uploader|
-            hash[column.to_s] = _mounter(:#{column}).uploader.serializable_hash
+            if (!options[:only] && !options[:except]) || (options[:only] && options[:only].include?(column)) || (options[:except] && !options[:except].include?(column))
+              hash[column.to_s] = _mounter(:#{column}).uploader.serializable_hash
+            end
           end
           super(options).merge(hash)
         end
@@ -79,19 +78,10 @@ end # CarrierWave
 CarrierWave::Storage.autoload :GridFS, 'carrierwave/storage/grid_fs'
 
 class CarrierWave::Uploader::Base
-  add_config :grid_fs_connection
-  add_config :grid_fs_database
-  add_config :grid_fs_host
-  add_config :grid_fs_port
-  add_config :grid_fs_username
-  add_config :grid_fs_password
   add_config :grid_fs_access_url
 
   configure do |config|
     config.storage_engines[:grid_fs] = "CarrierWave::Storage::GridFS"
-    config.grid_fs_database = "carrierwave"
-    config.grid_fs_host = "localhost"
-    config.grid_fs_port = 27017
   end
 end
 

data/lib/carrierwave/mongoid/version.rb

@@ -1,5 +1,5 @@
 module Carrierwave
   module Mongoid
-    VERSION = "0.2.2"
+    VERSION = "0.3.0"
   end
 end

data/lib/carrierwave/storage/grid_fs.rb

@@ -1,5 +1,4 @@
 # encoding: utf-8
-require 'mongo'
 
 module CarrierWave
   module Storage
@@ -7,42 +6,29 @@ module CarrierWave
     ##
     # The GridFS store uses MongoDB's GridStore file storage system to store files
     #
-    # There are two ways of configuring the GridFS connection. Either you create a
-    # connection or you reuse an existing connection.
-    #
-    # Creating a connection looks something like this:
+    # When you already have a Mongo connection object (for example through Mongoid)
+    # you can also reuse this connection:
     #
     #     CarrierWave.configure do |config|
     #       config.storage = :grid_fs
-    #       config.grid_fs_host = "your-host.com"
-    #       config.grid_fs_port = "27017"
-    #       config.grid_fs_database = "your_dbs_app_name"
-    #       config.grid_fs_username = "user"
-    #       config.grid_fs_password = "verysecret"
-    #       config.grid_fs_access_url = "/images"
+    #       config.grid_fs_access_url = "/system/uploads"
     #     end
     #
     #   In the above example your documents url will look like:
     #
-    #      http://your-app.com/images/:document-identifier-here
-    #
-    # When you already have a Mongo connection object (for example through Mongoid)
-    # you can also reuse this connection:
-    #
-    #     CarrierWave.configure do |config|
-    #       config.storage = :grid_fs
-    #       config.grid_fs_connection = Mongoid.database
-    #       config.grid_fs_access_url = "/images"
-    #     end
+    #      http://your-app.com/system/uploads/:document-identifier-here
     #
     class GridFS < Abstract
 
       class File
         attr_reader :path
+        attr_reader :uploader
+        attr_reader :grid_file
 
         def initialize(uploader, path)
           @path = path
           @uploader = uploader
+          @grid_file = nil
         end
 
         def url
@@ -53,48 +39,42 @@ module CarrierWave
           end
         end
 
-        def read
-          grid.open(path, 'r').data
+        def grid_file(&block)
+          @grid_file ||= grid[path]
         end
 
         def write(file)
-          grid.open(@uploader.store_path, 'w', :content_type => file.content_type) do |f|
-            f.write(file.read)
-          end
+          grid[@uploader.store_path] = file
+        ensure
+          @grid_file = nil
         end
 
-        def delete
-          grid.delete(path)
+        def read
+          grid_file.data if grid_file
         end
 
-        def content_type
-          grid.open(path, 'r').content_type
+        %w( delete content_type length ).each do |method|
+          class_eval <<-__, __FILE__, __LINE__
+            def #{ method }
+              grid_file.#{ method } if grid_file
+            end
+          __
         end
 
-        def file_length
-          grid.open(path, 'r').file_length
-        end
-        alias :size :file_length
+        alias :content_length :length
+        alias :file_length :length
+        alias :size :length
 
       protected
-
-        def database
-          @connection ||= @uploader.grid_fs_connection || begin
-            host = @uploader.grid_fs_host
-            port = @uploader.grid_fs_port
-            database = @uploader.grid_fs_database
-            username = @uploader.grid_fs_username
-            password = @uploader.grid_fs_password
-            db = Mongo::Connection.new(host, port).db(database)
-            db.authenticate(username, password) if username && password
-            db
-          end
+        class << File
+          attr_accessor :grid
         end
 
+        self.grid = ::Mongoid::GridFS
+
         def grid
-          @grid ||= Mongo::GridFileSystem.new(database)
+          self.class.grid
         end
-
       end
 
       ##

data/spec/mongoid_spec.rb

@@ -6,7 +6,7 @@ require 'carrierwave/mongoid'
 def reset_mongo_class(uploader = MongoUploader)
   define_mongo_class('MongoUser') do
     include Mongoid::Document
-    store_in :users
+    store_in :collection => 'users'
     field :folder, :default => ''
     mount_uploader :image, uploader
   end
@@ -45,7 +45,7 @@ end
 describe CarrierWave::Mongoid do
 
   after do
-    MongoUser.collection.drop
+    MongoUser.collection.drop if MongoUser.count > 0
   end
 
   describe '#image' do
@@ -121,6 +121,20 @@ describe CarrierWave::Mongoid do
         JSON.parse({:data => @doc.image}.to_json).should == {"data"=>{"image"=>{"url"=>"/uploads/test.jpeg"}}}
       end
 
+      it "should respect options[:only] when passed to to_json for the serializable hash" do
+        @doc[:image] = 'test.jpeg'
+        @doc.save!
+        @doc.reload
+        JSON.parse(@doc.to_json({:only => [:_id]})).should == {"_id" => @doc.id.to_s}
+      end
+
+      it "should respect options[:except] when passed to to_json for the serializable hash" do
+        @doc[:image] = 'test.jpeg'
+        @doc.save!
+        @doc.reload
+
+        JSON.parse(@doc.to_json({:except => [:_id, :image]})).should == {"folder" => ""}
+      end
 
     end
 
@@ -751,31 +765,4 @@ describe CarrierWave::Mongoid do
     end
   end
 
-  describe "with paranoia enabled" do
-    before do
-      @class = reset_mongo_class
-      @class.collection.drop
-      @class.class_eval do
-        include Mongoid::Paranoia
-      end
-
-      @doc = @class.new(image: stub_file("old.jpeg"))
-      @doc.save.should be_true
-    end
-
-    it "should not remove underlying image after #destroy" do
-      @doc.destroy.should be_true
-      @class.count.should eql(0)
-      @class.deleted.count.should eql(1)
-      File.exist?(public_path('uploads/old.jpeg')).should be_true
-    end
-
-    it "should remove underlying image after #destroy!" do
-      @doc.destroy!.should be_true
-      @class.count.should eql(0)
-      @class.deleted.count.should eql(0)
-      File.exist?(public_path('uploads/old.jpeg')).should be_false
-    end
-  end
-
 end

data/spec/spec_helper.rb

@@ -2,15 +2,13 @@ require 'rubygems'
 require 'bundler/setup'
 require 'rspec'
 require 'tempfile'
+require 'stringio'
 
 require 'carrierwave'
 require 'carrierwave/mongoid'
 
 Mongoid.configure do |config|
-  logger = Logger.new('log/test.log')
-  config.logger = logger
-  config.master = Mongo::Connection.new('localhost', 27017,
-    :logger => logger).db('carrierwave_test')
+  config.connect_to('carrierwave_test')
 end
 
 def file_path( *paths )
@@ -61,6 +59,15 @@ module CarrierWave
   end
 end
 
+class SIO < StringIO 
+  attr_accessor :filename 
+ 
+  def initialize(filename, *args, &block) 
+    @filename = filename 
+    super(*args, &block) 
+  end
+end
+
 RSpec.configure do |config|
   config.include CarrierWave::Test::MockFiles
   config.include CarrierWave::Test::I18nHelpers

data/spec/storage/grid_fs_spec.rb

@@ -1,7 +1,8 @@
 # encoding: utf-8
 
+
 require 'spec_helper'
-require 'mongo'
+
 
 shared_examples_for "a GridFS connection" do
   describe '#store!' do
@@ -11,7 +12,11 @@ shared_examples_for "a GridFS connection" do
     end
 
     it "should upload the file to gridfs" do
-      @grid.open('uploads/bar.txt', 'r').data.should == 'this is stuff'
+      @grid['uploads/bar.txt'].data.should == 'this is stuff'
+    end
+
+    it "should upload the file to gridfs" do
+      @grid['uploads/bar.txt'].data.should == 'this is stuff'
     end
 
     it "should have the same path that it was stored as" do
@@ -28,11 +33,11 @@ shared_examples_for "a GridFS connection" do
 
     it "should be deletable" do
       @grid_fs_file.delete
-      lambda {@grid.open('uploads/bar.txt', 'r')}.should raise_error(Mongo::GridFileNotFound)
+      @grid['uploads/bar.txt'].should be_nil
     end
 
     it "should store the content type on GridFS" do
-      @grid_fs_file.content_type.should == 'application/xml'
+      @grid_fs_file.content_type.should == 'text/plain'
     end
 
     it "should have a file length" do
@@ -42,7 +47,8 @@ shared_examples_for "a GridFS connection" do
 
   describe '#retrieve!' do
     before do
-      @grid.open('uploads/bar.txt', 'w') { |f| f.write "A test, 1234" }
+      @grid.clear
+      @grid['uploads/bar.txt'] = StringIO.new('A test, 1234')
       @uploader.stub!(:store_path).with('bar.txt').and_return('uploads/bar.txt')
       @grid_fs_file = @storage.retrieve!('bar.txt')
     end
@@ -76,8 +82,7 @@ shared_examples_for "a GridFS connection" do
 
     it "should be deletable" do
       @grid_fs_file.delete
-      lambda {@grid.open('uploads/bar.txt', 'r')}.should raise_error(Mongo::GridFileNotFound)
-
+      @grid['uploads/bar.txt'].should be_nil
     end
   end
 
@@ -98,8 +103,6 @@ end
 describe CarrierWave::Storage::GridFS do
 
   before do
-    @database = Mongo::Connection.new('localhost', 27017).db('carrierwave_test')
-
     @uploader = mock('an uploader')
     @uploader.stub!(:grid_fs_access_url).and_return(nil)
   end
@@ -108,7 +111,7 @@ describe CarrierWave::Storage::GridFS do
     before do
       @uploader.stub!(:grid_fs_connection).and_return(@database)
 
-      @grid = Mongo::GridFileSystem.new(@database)
+      @grid = ::Mongoid::GridFs
 
       @storage = CarrierWave::Storage::GridFS.new(@uploader)
       @file = stub_tempfile('test.jpg', 'application/xml')
@@ -130,7 +133,6 @@ describe CarrierWave::Storage::GridFS do
         }
 
         @versioned = @uploader_class.new
-        @versioned.stub!(:grid_fs_connection).and_return(@database)
 
         @versioned.store! File.open(file_path('portrait.jpg'))
       end
@@ -157,7 +159,6 @@ describe CarrierWave::Storage::GridFS do
         }
 
         @versioned = @uploader_class.new
-        @versioned.stub!(:grid_fs_connection).and_return(@database)
 
         @versioned.store! File.open(file_path('portrait.jpg'))
       end
@@ -175,26 +176,7 @@ describe CarrierWave::Storage::GridFS do
     end
   end
 
-  context "when setting a connection manually" do
-    before do
-      @uploader.stub!(:grid_fs_database).and_return("carrierwave_test")
-      @uploader.stub!(:grid_fs_host).and_return("localhost")
-      @uploader.stub!(:grid_fs_port).and_return(27017)
-      @uploader.stub!(:grid_fs_username).and_return(nil)
-      @uploader.stub!(:grid_fs_password).and_return(nil)
-      @uploader.stub!(:grid_fs_connection).and_return(nil)
-
-      @grid = Mongo::GridFileSystem.new(@database)
-
-      @storage = CarrierWave::Storage::GridFS.new(@uploader)
-      @file = stub_tempfile('test.jpg', 'application/xml')
-    end
-
-    it_should_behave_like "a GridFS connection"
-  end
-
   after do
-    @grid.delete('uploads/bar.txt')
+    @grid.clear
   end
-
 end

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: carrierwave-mongoid
 version: !ruby/object:Gem::Version
-  version: 0.2.2
   prerelease: 
+  version: 0.3.0
 platform: ruby
 authors:
 - Jonas Nicklas
@@ -10,104 +10,120 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-18 00:00:00.000000000 Z
+date: 2012-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.1
   name: carrierwave
+  prerelease: false
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.6.1
+        version: 0.7.1
+- !ruby/object:Gem::Dependency
   type: :runtime
-  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.6.1
-- !ruby/object:Gem::Dependency
+        version: '3.0'
   name: mongoid
+  prerelease: false
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.0'
+- !ruby/object:Gem::Dependency
   type: :runtime
-  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.1'
-- !ruby/object:Gem::Dependency
-  name: rspec
+        version: '1.3'
+  name: mongoid-grid_fs
+  prerelease: false
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '1.3'
+- !ruby/object:Gem::Dependency
   type: :development
-  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.6'
-- !ruby/object:Gem::Dependency
-  name: bson_ext
+  name: rspec
+  prerelease: false
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.6'
+- !ruby/object:Gem::Dependency
   type: :development
-  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.3'
-- !ruby/object:Gem::Dependency
+        version: '10.0'
   name: rake
+  prerelease: false
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '10.0'
+- !ruby/object:Gem::Dependency
   type: :development
-  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0.9'
-- !ruby/object:Gem::Dependency
+        version: '0'
   name: mini_magick
+  prerelease: false
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
   type: :development
-  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+  name: pry
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Mongoid support for CarrierWave
 email:
 - jonas.nicklas@gmail.com
@@ -146,19 +162,19 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
       segments:
       - 0
-      hash: -2851600484236280792
+      hash: 177635873472418624
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
       segments:
       - 0
-      hash: -2851600484236280792
+      hash: 177635873472418624
+      version: '0'
 requirements: []
 rubyforge_project: carrierwave-mongoid
 rubygems_version: 1.8.23