glebtv-carrierwave-mongoid 0.6.4 → 0.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 63aa8f7996ffb3670a34b599f0fc60e11f9b2519
-  data.tar.gz: c1d7e5906fdec920f9552bc56878426378e22d8a
+  metadata.gz: 1c88e0e0662ea059d12b9b6d8d6c692552ac4c25
+  data.tar.gz: f145561e76ac5ddb30ba2c38d4f4dcdc548ed4de
 SHA512:
-  metadata.gz: e424ee1a53b51861c2d3d2495652bf903770ea1d1b87693512603f3075b6b628984fe76e63f02fd6bfe553034c5f859721bc9fc426772421d555c60c6ca51a81
-  data.tar.gz: 9e9fc722074c699e31103e0460e10225c647a99aba4352544b444d2cebd9a85f72527d5f8a202b0376a23a505af96cb6530aa1fdc8ec72661536a108b59591c4
+  metadata.gz: 1c079cfc4e0d55bb0e3336e3cf7f0171222ff803c99a55c4e6db18b4b89c82270976279fa2a9b10281bf25509e0e71fd67ff915f3c0843ce5b208c35207204b9
+  data.tar.gz: 606aa75b38a400347eee1033a7685c745225bc3d2309bf06a39621ec4148650eb3695b26c591977e9f7f1758331013691c2ba663e1812dc23502e30c58af096c

data/.travis.yml

@@ -12,6 +12,7 @@ rvm:
 
 gemfile:
   - Gemfile
+  - gemfiles/carrierwave-0.8.gemfile
   - gemfiles/carrierwave-master.gemfile
   - gemfiles/mongoid-3.0.gemfile
   - gemfiles/mongoid-3.1.gemfile

data/Gemfile.lock

@@ -1,17 +1,18 @@
 PATH
   remote: .
   specs:
-    glebtv-carrierwave-mongoid (0.6.4)
-      carrierwave (~> 0.9.0)
+    glebtv-carrierwave-mongoid (0.6.5)
+      carrierwave (>= 0.8.0, < 0.10.0)
+      mongoid (>= 3.0, < 5.0)
       mongoid (>= 3.0, < 5.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (3.2.14)
-      activesupport (= 3.2.14)
+    activemodel (3.2.15)
+      activesupport (= 3.2.15)
       builder (~> 3.0.0)
-    activesupport (3.2.14)
+    activesupport (3.2.15)
       i18n (~> 0.6, >= 0.6.4)
       multi_json (~> 1.0)
     builder (3.0.4)
@@ -21,18 +22,18 @@ GEM
       json (>= 1.7)
     coderay (1.0.9)
     diff-lcs (1.2.4)
-    i18n (0.6.4)
-    json (1.8.0)
+    i18n (0.6.5)
+    json (1.8.1)
     method_source (0.8.2)
     mini_magick (3.6.0)
       subexec (~> 0.2.1)
-    mongoid (3.1.4)
+    mongoid (3.1.5)
       activemodel (~> 3.2)
       moped (~> 1.4)
       origin (~> 1.0)
-      tzinfo (~> 0.3.22)
-    moped (1.5.0)
-    multi_json (1.7.8)
+      tzinfo (~> 0.3.29)
+    moped (1.5.1)
+    multi_json (1.8.2)
     origin (1.1.0)
     pry (0.9.12.2)
       coderay (~> 1.0.5)
@@ -43,13 +44,13 @@ GEM
       rspec-core (~> 2.14.0)
       rspec-expectations (~> 2.14.0)
       rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.4)
-    rspec-expectations (2.14.0)
+    rspec-core (2.14.6)
+    rspec-expectations (2.14.3)
       diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.2)
+    rspec-mocks (2.14.4)
     slop (3.4.6)
     subexec (0.2.3)
-    tzinfo (0.3.37)
+    tzinfo (0.3.38)
 
 PLATFORMS
   ruby
@@ -59,4 +60,4 @@ DEPENDENCIES
   mini_magick
   pry
   rake (~> 10.0)
-  rspec (~> 2.6)
+  rspec (~> 2.14)

data/README.md

@@ -3,3 +3,217 @@
 # CarrierWave for Mongoid 
 
 See upstream for details: https://github.com/carrierwaveuploader/carrierwave-mongoid
+
+
+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
+
+Require it in your code:
+
+```ruby
+require 'carrierwave/mongoid'
+```
+
+Or, in Rails you can add it to your Gemfile:
+
+```ruby
+gem 'carrierwave-mongoid', :require => 'carrierwave/mongoid'
+```
+
+Note: If using Rails 4, you'll need to make sure `mongoid-grid_fs` is `>= 1.9.0`.
+If in doubt, run `bundle update mongoid-grid_fs`
+
+```ruby
+gem 'mongoid-grid_fs', github: 'ahoward/mongoid-grid_fs'
+```
+
+## Getting Started
+
+Follow the "Getting Started" directions in the main
+[Carrierwave repository](https://raw.github.com/carrierwaveuploader/carrierwave/).
+
+[Suggested] Add the field to your attr_accessor list for mass assignment
+protection:
+
+```ruby
+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:
+
+```ruby
+u = User.new
+u.avatar = File.open('somewhere')
+u.save!
+```
+
+## Using MongoDB's GridFS store
+
+In your uploader, set the storage to `:grid_fs`:
+
+```ruby
+class AvatarUploader < CarrierWave::Uploader::Base
+  storage :grid_fs
+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.storage = :grid_fs
+  config.root = Rails.root.join('tmp')
+  config.cache_dir = "uploads"
+end
+```
+
+## Serving uploading files
+
+Since GridFS doesn't make the files available via HTTP, you'll need to stream
+them yourself. For example, in Rails, you could use the `send_data` method:
+
+```ruby
+class UsersController < ApplicationController
+  def avatar
+    content = @user.avatar.read
+    if stale?(etag: content, last_modified: @user.updated_at.utc, public: true)
+      send_data content, type: @user.avatar.file.content_type, disposition: "inline"
+      expires_in 0, public: true
+    end
+  end
+end
+
+# and in routes.rb
+resources :users do
+  get :avatar, on: :member
+end
+```
+
+You can optionally tell CarrierWave the URL you will serve your images from,
+allowing it to generate the correct URL, by setting `grid_fs_access_url`:
+
+```ruby
+CarrierWave.configure do |config|
+  config.grid_fs_access_url = "/systems/uploads"
+end
+```
+
+## Route configuration
+
+If you follow the instruction to this point, the uploaded images will be
+stored to GridFS, and you are responsible for serving the images a public
+endpoint. If you would like to use the `#url` method on the uploaded file, you
+will need to take some additional steps.
+
+The `grid_fs_access_url` configuration option is the prefix for the path of
+the stored file in carrierwave.
+
+Let's assume that we have a mounted `avatar` uploader on a `User` model and a
+`GridfsController`. Let's also assume that your uploader definition
+(i.e. `app/uploaders/avatar_uploader.rb`) defines `store_dir` like this:
+
+```ruby
+def store_dir
+  "#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}"
+end
+```
+
+If `grid_fs_access_url` (in `config/initializers/carrierwave.rb`) were:
+
+```ruby
+config.grid_fs_access_url = '/uploads/grid'
+```
+
+You would need to define a route in your `config/routes.rb` like so:
+
+```ruby
+match '/uploads/grid/user/avatar/:id/:filename' => 'gridfs#avatar'
+```
+
+Now, `user.avatar.url` should return an appropriate url path to use in your
+views.
+
+### Different uploaded versions
+
+If you need to include different versions (e.g. thumbnails), additional routes
+will help:
+
+```ruby
+match '/uploads/grid/user/avatar/:id/:filename' => 'gridfs#thumb_avatar', constraints: { filename: /thumb.*/ }
+```
+
+## Version differences
+
+| Version  | Notes                                                                           |
+|----------|---------------------------------------------------------------------------------|
+| ~> 0.6.0 | ([compare][compare-0.6], [dependencies][deps-0.6]) Mongoid 3 & 4, bug fixes     |
+| ~> 0.5.0 | ([compare][compare-0.5], [dependencies][deps-0.5]) Mongoid::Paranoia support    |
+| ~> 0.4.0 | ([compare][compare-0.4], [dependencies][deps-0.4]) Carrierwave bump             |
+| ~> 0.3.0 | ([compare][compare-0.3], [dependencies][deps-0.3]) Mongoid >= 3.0               |
+| ~> 0.2.0 | ([compare][compare-0.2], [dependencies][deps-0.2]) Rails >= 3.2, Mongoid ~> 2.0 |
+| ~> 0.1.0 | ([compare][compare-0.1], [dependencies][deps-0.1]) Rails <= 3.1                 |
+
+[compare-0.6]: https://github.com/carrierwaveuploader/carrierwave-mongoid/compare/v0.5.0...v0.6.3
+[compare-0.5]: https://github.com/carrierwaveuploader/carrierwave-mongoid/compare/v0.4.0...v0.5.0
+[compare-0.4]: https://github.com/carrierwaveuploader/carrierwave-mongoid/compare/v0.3.1...v0.4.0
+[compare-0.3]: https://github.com/carrierwaveuploader/carrierwave-mongoid/compare/v0.2.1...v0.3.1
+[compare-0.2]: https://github.com/carrierwaveuploader/carrierwave-mongoid/compare/v0.1.7...v0.2.2
+[compare-0.1]: https://github.com/carrierwaveuploader/carrierwave-mongoid/compare/v0.1.1...v0.1.7
+
+[deps-0.6]: https://rubygems.org/gems/carrierwave-mongoid/versions/0.6.3
+[deps-0.5]: https://rubygems.org/gems/carrierwave-mongoid/versions/0.5.0
+[deps-0.4]: https://rubygems.org/gems/carrierwave-mongoid/versions/0.4.0
+[deps-0.3]: https://rubygems.org/gems/carrierwave-mongoid/versions/0.3.1
+[deps-0.2]: https://rubygems.org/gems/carrierwave-mongoid/versions/0.2.2
+[deps-0.1]: https://rubygems.org/gems/carrierwave-mongoid/versions/0.1.7
+
+### Changes from earlier versions of CarrierWave <= 0.5.6
+
+CarrierWave used to have built-in Mongoid support. This gem replaces that
+support and only supports Mongoid ~> 2.1
+
+You can use `upload_identifier` to retrieve the original name of the uploaded file.
+
+In the earlier version, the mount_uploader-method for mongoid had been defined
+in lib/carrierwave/orm/mongoid. This code has been moved to
+carrierwave/mongoid. If you update from earlier versions, don't forget to adjust
+your require accordingly in your carrierwave-initializer.
+
+The default mount column used to be the name of the upload column plus
+`_filename`. Now it is simply the name of the column. Most of the time, the
+column was called `upload`, so it would have been mounted to `upload_filename`.
+If you'd like to avoid a database migration, simply use the `:mount_on` option
+to specify the field name explicitly. Therefore, you only have to add a
+`_filename` to your column name. For example, if your column is called
+`:upload`:
+
+```ruby
+class Dokument
+  mount_uploader :upload, DokumentUploader, mount_on: :upload_filename
+end
+```
+
+## Known issues and limitations
+
+Note that files mounted in embedded documents aren't saved when parent documents
+are saved. By default, mongoid does not cascade callbacks on embedded
+documents. In order to save the attached files on embedded documents, you must
+either explicitly call save on the embedded documents or you must configure the
+embedded association to cascade the callbacks automatically. For example:
+
+```ruby
+class User
+  embeds_many :pictures, cascade_callbacks: true
+end
+```
+
+You can read more about this [here](https://github.com/carrierwaveuploader/carrierwave/issues#issue/81)

data/gemfiles/carrierwave-0.8.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "carrierwave", "~> 0.8.0"
+
+gemspec path: "../"

data/gemfiles/mongoid-3.0.gemfile

@@ -1,5 +1,6 @@
 source "https://rubygems.org"
 
 gem "mongoid", github: "mongoid/mongoid", branch: "3.0.0-stable"
+gem "activemodel", "~> 3.2"
 
 gemspec path: "../"

data/glebtv-carrierwave-mongoid.gemspec

@@ -18,9 +18,10 @@ 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.9.0"]
   s.add_dependency "mongoid", [">= 3.0", "< 5.0"]
-  s.add_development_dependency "rspec", ["~> 2.6"]
+  s.add_dependency "carrierwave", [">= 0.8.0", "< 0.10.0"]
+  s.add_dependency "mongoid", [">= 3.0", "< 5.0"]
+  s.add_development_dependency "rspec", ["~> 2.14"]
   s.add_development_dependency "rake", ["~> 10.0"]
   s.add_development_dependency "mini_magick"
   s.add_development_dependency "pry"

data/lib/carrierwave/mongoid.rb

@@ -45,6 +45,12 @@ module CarrierWave
           super
         end
 
+        def remove_#{column}=(arg)
+          column = _mounter(:#{column}).serialization_column
+          send(:"\#{column}_will_change!")
+          super
+        end
+
         def remove_#{column}!
           super unless respond_to?(:paranoid?) && paranoid? && flagged_for_destroy?
         end
@@ -59,6 +65,14 @@ module CarrierWave
           changed_attributes.has_key?("#{column}")
         end
 
+        # The default Mongoid attribute_will_change! method is not enough
+        # when we want to upload a new file in an existing embedded document.
+        # The custom version of that method forces the callbacks to be
+        # ran and so does the upload.
+        def #{column}_will_change!
+          changed_attributes["#{column}"] = '_new_'
+        end
+
         def find_previous_model_for_#{column}
           if self.embedded?
             ancestors       = [[ self.metadata.key, self._parent ]].tap { |x| x.unshift([ x.first.last.metadata.key, x.first.last._parent ]) while x.first.last.embedded? }

data/lib/carrierwave/mongoid/version.rb

@@ -1,5 +1,5 @@
 module Carrierwave
   module Mongoid
-    VERSION = "0.6.4"
+    VERSION = "0.6.5"
   end
 end

data/spec/mongoid_spec.rb

@@ -569,6 +569,7 @@ describe CarrierWave::Mongoid do
 
         @class.class_eval do
           embeds_many :mongo_locations, cascade_callbacks: true
+          accepts_nested_attributes_for :mongo_locations
         end
 
         @doc = @class.new
@@ -592,6 +593,18 @@ describe CarrierWave::Mongoid do
         doc.mongo_locations.first[:image].should == 'test.jpeg'
       end
 
+      it "changes the file" do
+        @doc.update_attributes mongo_locations_attributes: { '0' => { _id: @embedded_doc._id, image: stub_file('test.jpeg') } }
+        @doc.reload
+        @doc.mongo_locations.first[:image].should == 'test.jpeg'
+      end
+
+      it "removes a file" do
+        @doc.update_attributes mongo_locations_attributes: { '0' => { _id: @embedded_doc._id, remove_image: "1" } }
+        @doc.reload
+        @doc.mongo_locations.first[:image].should_not be_present
+      end
+
       describe 'with double embedded documents' do
 
         before do
@@ -666,6 +679,38 @@ describe CarrierWave::Mongoid do
         include_examples "double embedded documents"
       end
     end
+
+    describe 'with embedded documents and nested attributes' do
+      before do
+        @embedded_doc_class = define_mongo_class('MongoLocation') do
+          include Mongoid::Document
+          mount_uploader :image, @uploader
+          embedded_in :mongo_user
+        end
+
+        @class.class_eval do
+          embeds_many :mongo_locations, cascade_callbacks: true
+          accepts_nested_attributes_for :mongo_locations
+        end
+
+        @doc = @class.new(mongo_locations_attributes: [{image: stub_file("old.jpeg")}])
+        @doc.save.should be_true
+        @embedded_doc = @doc.mongo_locations.first
+      end
+
+      it "should set the image on a save" do
+        @doc.reload
+        @doc.mongo_locations.first.image.path.should match(/old\.jpeg$/)
+        @embedded_doc.image.path.should match(/old\.jpeg$/)
+      end
+
+      it "should update the image on update_attributes" do
+        @doc.update_attributes(mongo_locations_attributes: [{id: @embedded_doc.id, image: stub_file("new.jpeg")}]).should be_true
+        @doc.reload
+        @doc.mongo_locations.first.image.path.should match(/new\.jpeg$/)
+        @embedded_doc.image.path.should match(/new\.jpeg$/)
+      end
+    end
   end
 
   describe '#mount_uploader removing old files with versions' do

data/spec/spec_helper.rb

@@ -35,9 +35,9 @@ module CarrierWave
         t = Tempfile.new(filename)
         FileUtils.copy_file(file_path(filename), t.path)
 
-        t.stub!(:local_path => "",
-                :original_filename => filename || fake_name,
-                :content_type => mime_type)
+        t.stub(:local_path => "",
+               :original_filename => filename || fake_name,
+               :content_type => mime_type)
 
         return t
       end
@@ -59,12 +59,12 @@ module CarrierWave
   end
 end
 
-class SIO < StringIO 
-  attr_accessor :filename 
- 
-  def initialize(filename, *args, &block) 
-    @filename = filename 
-    super(*args, &block) 
+class SIO < StringIO
+  attr_accessor :filename
+
+  def initialize(filename, *args, &block)
+    @filename = filename
+    super(*args, &block)
   end
 end
 

data/spec/storage/grid_fs_spec.rb

@@ -7,7 +7,7 @@ require 'spec_helper'
 shared_examples_for "a GridFS connection" do
   describe '#store!' do
     before do
-      @uploader.stub!(:store_path).and_return('uploads/bar.txt')
+      @uploader.stub(:store_path).and_return('uploads/bar.txt')
       @grid_fs_file = @storage.store!(@file)
     end
 
@@ -49,7 +49,7 @@ shared_examples_for "a GridFS connection" do
     before do
       @grid.clear
       @grid['uploads/bar.txt'] = StringIO.new('A test, 1234')
-      @uploader.stub!(:store_path).with('bar.txt').and_return('uploads/bar.txt')
+      @uploader.stub(:store_path).with('bar.txt').and_return('uploads/bar.txt')
       @grid_fs_file = @storage.retrieve!('bar.txt')
     end
 
@@ -66,17 +66,17 @@ shared_examples_for "a GridFS connection" do
     end
 
     it "should return a relative URL path if access_url is set to the root path" do
-      @uploader.stub!(:grid_fs_access_url).and_return("/")
+      @uploader.stub(:grid_fs_access_url).and_return("/")
       @grid_fs_file.url.should == "/uploads/bar.txt"
     end
 
     it "should return a URL path if access_url is set to a file path" do
-      @uploader.stub!(:grid_fs_access_url).and_return("/image/show")
+      @uploader.stub(:grid_fs_access_url).and_return("/image/show")
       @grid_fs_file.url.should == "/image/show/uploads/bar.txt"
     end
 
     it "should return an absolute URL if access_url is set to an absolute URL" do
-      @uploader.stub!(:grid_fs_access_url).and_return("http://example.com/images/")
+      @uploader.stub(:grid_fs_access_url).and_return("http://example.com/images/")
       @grid_fs_file.url.should == "http://example.com/images/uploads/bar.txt"
     end
 
@@ -88,12 +88,12 @@ shared_examples_for "a GridFS connection" do
 
   describe '#retrieve! on a store_dir with leading slash' do
     before do
-      @uploader.stub!(:store_path).with('bar.txt').and_return('/uploads/bar.txt')
+      @uploader.stub(:store_path).with('bar.txt').and_return('/uploads/bar.txt')
       @grid_fs_file = @storage.retrieve!('bar.txt')
     end
 
     it "should return a relative URL path if access_url is set to the root path" do
-      @uploader.stub!(:grid_fs_access_url).and_return("/")
+      @uploader.stub(:grid_fs_access_url).and_return("/")
       @grid_fs_file.url.should == "/uploads/bar.txt"
     end
   end
@@ -181,4 +181,4 @@ if defined?(Mongoid::GridFs)
       @grid.clear
     end
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: glebtv-carrierwave-mongoid
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 0.6.5
 platform: ruby
 authors:
 - GlebTv
@@ -10,22 +10,48 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-05 00:00:00.000000000 Z
+date: 2013-10-29 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: carrierwave
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+    - - <
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+    - - <
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.10.0
 - !ruby/object:Gem::Dependency
   name: mongoid
   requirement: !ruby/object:Gem::Requirement
@@ -52,14 +78,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '2.14'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -118,6 +144,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- gemfiles/carrierwave-0.8.gemfile
 - gemfiles/carrierwave-master.gemfile
 - gemfiles/mongoid-3.0.gemfile
 - gemfiles/mongoid-3.1.gemfile
@@ -158,7 +185,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.6
+rubygems_version: 2.1.10
 signing_key: 
 specification_version: 4
 summary: This fork makes GridFS optional