README.md in carrierwave-mongoid-0.6.0 vs README.md in carrierwave-mongoid-0.6.1
- old
+ new
@@ -1,9 +1,9 @@
-# CarrierWave for Mongoid [](http://badge.fury.io/rb/carrierwave-mongoid) [](http://travis-ci.org/jnicklas/carrierwave-mongoid) [](https://codeclimate.com/github/jnicklas/carrierwave-mongoid)
+# CarrierWave for Mongoid [](http://badge.fury.io/rb/carrierwave-mongoid) [](http://travis-ci.org/carrierwaveuploader/carrierwave-mongoid) [](https://codeclimate.com/github/carrierwaveuploader/carrierwave-mongoid)
This gem adds support for Mongoid and MongoDB's GridFS to
-[CarrierWave](https://github.com/jnicklas/carrierwave/)
+[CarrierWave](https://github.com/carrierwaveuploader/carrierwave/)
This functionality used to be part of CarrierWave but has since been extracted
into this gem.
## Installation
@@ -25,11 +25,11 @@
```
## Getting Started
Follow the "Getting Started" directions in the main
-[Carrierwave repository](https://raw.github.com/jnicklas/carrierwave/).
+[Carrierwave repository](https://raw.github.com/carrierwaveuploader/carrierwave/).
[Suggested] Add the field to your attr_accessor list for mass assignment
protection:
```ruby
@@ -53,33 +53,97 @@
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. In Rails for example, you could use the `send_data` method. You
-can optionally tell CarrierWave the URL you will serve your images from,
-allowing it to generate the correct URL, by setting eg:
+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
```
-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:
+## 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
-CarrierWave.configure do |config|
- config.storage = :grid_fs
- config.root = Rails.root.join('tmp')
- config.cache_dir = "uploads"
+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 |
@@ -87,18 +151,18 @@
| ~> 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/jnicklas/carrierwave-mongoid/compare/v0.5.0...v0.6.0
-[compare-0.5]: https://github.com/jnicklas/carrierwave-mongoid/compare/v0.4.0...v0.5.0
-[compare-0.4]: https://github.com/jnicklas/carrierwave-mongoid/compare/v0.3.1...v0.4.0
-[compare-0.3]: https://github.com/jnicklas/carrierwave-mongoid/compare/v0.2.1...v0.3.1
-[compare-0.2]: https://github.com/jnicklas/carrierwave-mongoid/compare/v0.1.7...v0.2.2
-[compare-0.1]: https://github.com/jnicklas/carrierwave-mongoid/compare/v0.1.1...v0.1.7
+[compare-0.6]: https://github.com/carrierwaveuploader/carrierwave-mongoid/compare/v0.5.0...v0.6.1
+[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.0
+[deps-0.6]: https://rubygems.org/gems/carrierwave-mongoid/versions/0.6.1
[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
@@ -141,6 +205,6 @@
class User
embeds_many :pictures, cascade_callbacks: true
end
```
-You can read more about this [here](https://github.com/jnicklas/carrierwave/issues#issue/81)
+You can read more about this [here](https://github.com/carrierwaveuploader/carrierwave/issues#issue/81)