paperclip 5.0.0.beta2 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f6fccc7d5627358582473c510bef269b25156565
-  data.tar.gz: 07eb1f02126bb0022635083684eaf43ba049a466
+  metadata.gz: 823fa4ed80655c6ae50b1d241142e5afb3ed9e22
+  data.tar.gz: bb9ceacd62b0e1f6167f6d0c6392a696b788ca73
 SHA512:
-  metadata.gz: 7bf6930cb7bd20a9dd477d1596f9a4ea6ec78108f079424ed4163125f86358275e164667597a6bedec27244435e749dbaf97fbff73a2df724eeb4174ec60ba6c
-  data.tar.gz: ee22ab27c69ca3a529ba6b41fcbe6a4f580a16f46b31eae9e1427d13d0bf29bbbe01b65471ebc148c0c21f53213ad39ff2b74f60287b70671d7b676abd2b1d76
+  metadata.gz: 4e5b7a64e9db33be68a6a5b8467a8df6c074d16990e51c93bea5a070896b2ce3905ccdc0cad6323148229f3a03209974791a90234d948bb65f7f85868cab35f2
+  data.tar.gz: 376768f292bdc225375aee8dce8c22b58e22904dabbf5044a7a2383b760b362e7a39830e9c63091e5ff1774b49ecd6f1dfbfdb293f198c66f80d3d8bb1fe1987

data/.codeclimate.yml

@@ -0,0 +1,17 @@
+---
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - "**.rb"
+exclude_paths:
+- features/
+- spec/

data/.hound.yml

@@ -20,7 +20,8 @@ AllCops:
     - "db/schema.rb"
     - 'vendor/**/*'
     - 'gemfiles/vendor/**/*'
-  RunRailsCops: false
+  Rails:
+    Enabled: false
   DisplayCopNames: false
   StyleGuideCopsOnly: false
 Style/AccessModifierIndentation:
@@ -434,7 +435,7 @@ Style/TrailingBlankLines:
   SupportedStyles:
   - final_newline
   - final_blank_line
-Style/TrailingComma:
+Style/TrailingCommaInLiteral:
   Description: Checks for trailing comma in parameter lists and literals.
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas
   Enabled: false
@@ -560,11 +561,6 @@ Rails/ActionFilter:
   - filter
   Include:
   - app/controllers/**/*.rb
-Rails/DefaultScope:
-  Description: Checks if the argument passed to default_scope is a block.
-  Enabled: true
-  Include:
-  - app/models/**/*.rb
 Rails/HasAndBelongsToMany:
   Description: Prefer has_many :through to has_and_belongs_to_many.
   Enabled: true
@@ -685,10 +681,6 @@ Style/DefWithParentheses:
   Description: Use def with parentheses when there are arguments.
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#method-parens
   Enabled: true
-Style/DeprecatedHashMethods:
-  Description: Checks for use of deprecated Hash methods.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#hash-key
-  Enabled: false
 Style/Documentation:
   Description: Document classes and non-namespace modules.
   Enabled: false
@@ -840,7 +832,7 @@ Style/SelfAssignment:
     used.
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#self-assignment
   Enabled: false
-Style/SingleSpaceBeforeFirstArg:
+Style/SpaceBeforeFirstArg:
   Description: Checks that exactly one space is used between a method name and the
     first argument for method calls without parentheses.
   Enabled: true
@@ -852,7 +844,7 @@ Style/SpaceAfterComma:
   Description: Use spaces after commas.
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#spaces-operators
   Enabled: true
-Style/SpaceAfterControlKeyword:
+Style/SpaceAroundKeyword:
   Description: Use spaces after if/elsif/unless/while/until/case/when.
   Enabled: true
 Style/SpaceAfterMethodName:
@@ -881,9 +873,6 @@ Style/SpaceAroundOperators:
   Description: Use spaces around operators.
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#spaces-operators
   Enabled: true
-Style/SpaceBeforeModifierKeyword:
-  Description: Put a space before the modifier keyword.
-  Enabled: true
 Style/SpaceInsideBrackets:
   Description: No spaces after [ or before ].
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-spaces-braces

data/.travis.yml

@@ -1,26 +1,25 @@
+language: ruby
+sudo: false
+
 rvm:
   - 2.1
-  - 2.2.2
+  - 2.2
+  - 2.3
+  - 2.4
 
 script: "bundle exec rake clean spec cucumber"
 
+addons:
+  apt:
+    packages:
+    - ghostscript
+
 gemfile:
-  - gemfiles/4.2.awsv2.0.gemfile
-  - gemfiles/4.2.awsv2.1.gemfile
-  - gemfiles/5.0.awsv2.0.gemfile
-  - gemfiles/5.0.awsv2.1.gemfile
+  - gemfiles/4.2.gemfile
+  - gemfiles/5.0.gemfile
 
 matrix:
   fast_finish: true
   exclude:
-    - gemfile: gemfiles/5.0.awsv2.0.gemfile
-      rvm: 2.0
-    - gemfile: gemfiles/5.0.awsv2.1.gemfile
-      rvm: 2.0
-    - gemfile: gemfiles/5.0.awsv2.0.gemfile
+    - gemfile: gemfiles/5.0.gemfile
       rvm: 2.1
-    - gemfile: gemfiles/5.0.awsv2.1.gemfile
-      rvm: 2.1
-
-sudo: false
-cache: bundler

data/Appraisals

@@ -1,27 +1,7 @@
-appraise "4.2.awsv2.0" do
+appraise "4.2" do
   gem "rails", "~> 4.2.0"
-  gem "aws-sdk", "~> 2.0.0"
 end
 
-appraise "4.2.awsv2.1" do
-  gem "rails", "~> 4.2.0"
-  gem "aws-sdk", "~> 2.1.0"
-
-  group :development, :test do
-    gem 'mime-types', '>= 1.16', '< 4'
-  end
-end
-
-appraise "5.0.awsv2.0" do
-  gem "rails", "5.0.0.beta3"
-  gem "aws-sdk", "~> 2.0.0"
-
-  group :development, :test do
-    gem 'mime-types', '>= 1.16', '< 4'
-  end
-end
-
-appraise "5.0.awsv2.1" do
-  gem "rails", "5.0.0.beta3"
-  gem "aws-sdk", "~> 2.1.0"
+appraise "5.0" do
+  gem "rails", "~> 5.0.0"
 end

data/CONTRIBUTING.md

@@ -10,16 +10,22 @@ Here's a quick guide for contributing:
 
 1. Fork the repo.
 
-2. Run the tests. We only take pull requests with passing tests, and it's great
+1. Make sure you have ImageMagick and Ghostscript installed. See [this section]
+(./README.md#image-processor) of the README.
+
+1. Run the tests. We only take pull requests with passing tests, and it's great
 to know that you have a clean slate: `bundle && bundle exec rake`
 
-3. Add a test for your change. Only refactoring and documentation changes
+1. Add a test for your change. Only refactoring and documentation changes
 require no new tests. If you are adding functionality or fixing a bug, we need
 a test!
 
-4. Make the test pass.
+1. Make the test pass.
+
+1. Mention how your changes affect the project to other developers and users in
+   the `NEWS.md` file.
 
-5. Push to your fork and submit a pull request.
+1. Push to your fork and submit a pull request.
 
 At this point you're waiting on us. We like to at least comment on, if not
 accept, pull requests within seven business days (most of the work on Paperclip

data/Gemfile

@@ -12,4 +12,5 @@ group :development, :test do
   gem 'mime-types'
   gem 'builder'
   gem 'rubocop', require: false
+  gem 'rspec'
 end

data/NEWS

@@ -1,12 +1,88 @@
-5.0.0.beta2 (2015-04-01):
+5.3.0 (2018-03-09):
+
+* Improvement: Use `FactoryBot` instead of `FactoryGirl` (https://github.com/thoughtbot/paperclip/pull/2501)
+* Improvement: README updates (https://github.com/thoughtbot/paperclip/pull/2411, https://github.com/thoughtbot/paperclip/pull/2433, https://github.com/thoughtbot/paperclip/pull/2374, https://github.com/thoughtbot/paperclip/pull/2417, https://github.com/thoughtbot/paperclip/pull/2536)
+* Improvement: Remove Ruby 2.4 deprecation warning (https://github.com/thoughtbot/paperclip/pull/2401)
+* Improvement: Rails 5 migration compatibility (https://github.com/thoughtbot/paperclip/pull/2470)
+* Improvement: Documentation around post processing (https://github.com/thoughtbot/paperclip/pull/2381)
+* Improvement: S3 hostname example documentation (https://github.com/thoughtbot/paperclip/pull/2379)
+* Bugfix: Allow paperclip to load in IRB (https://github.com/thoughtbot/paperclip/pull/2369)
+* Bugfix: MIME type detection (https://github.com/thoughtbot/paperclip/issues/2527)
+* Bugfix: Bad tempfile state after symlink failure (https://github.com/thoughtbot/paperclip/pull/2540)
+* Bugfix: Rewind file after Fog bucket creation (https://github.com/thoughtbot/paperclip/pull/2572)
+* Improvement: Use `Terrapin` instead of `Cocaine` (https://github.com/thoughtbot/paperclip/pull/2553)
+
+5.2.1 (2018-01-25):
+
+* Bugfix: Fix copying files on Windows. (#2532)
+
+5.2.0 (2018-01-23):
+
+* Security: Remove the automatic loading of URI adapters. Some of these
+  adapters can be specially crafted to expose your network topology. (#2435)
+* Bugfix: The rake task no longer rescues `Exception`. (#2476)
+* Bugfix: Handle malformed `Content-Disposition` headers (#2283)
+* Bugfix: The `:only_process` option works when passed a lambda again. (#2289)
+* Improvement: Added `:use_accelerate_endpoint` option when using S3 to enable
+  [Amazon S3 Transfer Acceleration](http://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html)
+  (#2291)
+* Improvement: Make the fingerprint digest configurable per attachment. The
+  default remains MD5. Making this configurable means it can change in a future
+  version because it is not considered secure anymore against intentional file
+  corruption. For more info, see https://en.wikipedia.org/wiki/MD5#Security
+
+  You can change the digest used for an attachment by adding the
+  `:adapter_options` parameter to the `has_attached_file` options like this:
+  `has_attached_file :avatar, adapter_options: { hash_digest: Digest::SHA256 }`
+
+  Use the rake task to regenerate fingerprints with the new digest for a given
+  class. Note that this does **not** check the file integrity using the old
+  fingerprint. Run the following command to regenerate fingerprints for all
+  User attachments:
+  `CLASS=User rake paperclip:refresh:fingerprints`
+  You can optionally limit the attachment that will be processed, e.g:
+  `CLASS=User ATTACHMENT=avatar rake paperclip:refresh:fingerprints` (#2229)
+* Improvement: The new `frame_index` option on the thumbnail processor allows
+  you to select a specific frame from an animated upload to use as a thumbnail.
+  Initial support is for mkv, avi, MP4, mov, MPEG, and GIF. (#2155)
+* Improvement: Instead of copying files, use hard links. This is an
+  optimization. (#2120)
+* Improvement: S3 storage option `:s3_prefixes_in_alias`. (#2287)
+* Improvement: Fog option `:fog_public` can be a lambda. (#2302)
+* Improvement: One fewer warning on JRuby. (#2352)
+* Ruby 2.4.0 compatibility (doesn't use Fixnum anymore)
+
+5.1.0 (2016-08-19):
+
+* Add default `content_type_detector` to `UploadedFileAdapter` (#2270)
+* Default S3 protocol to empty string (#2038)
+* Don't write original file if it wasn't reprocessed (#1993)
+* Disallow trailing newlines in regular expressions (#2266)
+* Support for readbyte in Paperclip attachments (#2034)
+* (port from 4.3) Uri io adapter uses the content-disposition filename (#2250)
+* General refactors and documentation improvements
+
+5.0.0 (2016-07-01):
+
+* Improvement: Add `read_timeout` configuration for URI Adapter download_content method.
+* README adjustments for Ruby beginners (add links, elucidate model in Quick Start)
+* Bugfix: Now it's possible to save images from URLs with special characters [#1932]
+* Bugfix: Return false when file to copy is not present in cloud storage [#2173]
+* Automatically close file while checking mime type [#2016]
+* Add `read_timeout` option to `UriAdapter#download_content` method [#2232]
+* Fix a nil error in content type validation matcher [#1910]
+* Documentation improvements
+
+5.0.0.beta2 (2016-04-01):
 
 * Bugfix: Dynamic fog directory option is now respected
 * Bugfix: Fixes cocaine duplicated paths [#2169]
 * Removal of dead code (older versions of Rails and AWS SDK)
 * README adjustments
 
-5.0.0.beta1 (2015-03-13):
+5.0.0.beta1 (2016-03-13):
 
+* Bug Fix: megabytes of mime-types info in logs when a spoofed media type is detected.
 * Drop support to end-of-life'd ruby 2.0.
 * Drop support for end-of-life'd Rails 3.2 and 4.1
 * Drop support for AWS v1

data/README.md

@@ -14,6 +14,9 @@ https://github.com/thoughtbot/paperclip/releases
 [![Inline docs](http://inch-ci.org/github/thoughtbot/paperclip.svg)](http://inch-ci.org/github/thoughtbot/paperclip)
 [![Security](https://hakiri.io/github/thoughtbot/paperclip/master.svg)](https://hakiri.io/github/thoughtbot/paperclip/master)
 
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+
 - [Requirements](#requirements)
   - [Ruby and Rails](#ruby-and-rails)
   - [Image Processor](#image-processor)
@@ -25,7 +28,8 @@ https://github.com/thoughtbot/paperclip/releases
   - [Edit and New Views](#edit-and-new-views)
   - [Edit and New Views with Simple Form](#edit-and-new-views-with-simple-form)
   - [Controller](#controller)
-  - [Show View](#show-view)
+  - [View Helpers](#view-helpers)
+  - [Checking a File Exists](#checking-a-file-exists)
   - [Deleting an Attachment](#deleting-an-attachment)
 - [Usage](#usage)
 - [Validations](#validations)
@@ -35,25 +39,29 @@ https://github.com/thoughtbot/paperclip/releases
 - [Migrations](#migrations-1)
   - [Add Attachment Column To A Table](#add-attachment-column-to-a-table)
   - [Schema Definition](#schema-definition)
-  - [Vintage syntax](#vintage-syntax)
+  - [Vintage Syntax](#vintage-syntax)
 - [Storage](#storage)
   - [Understanding Storage](#understanding-storage)
+- [IO Adapters](#io-adapters)
 - [Post Processing](#post-processing)
+- [Custom Attachment Processors](#custom-attachment-processors)
 - [Events](#events)
 - [URI Obfuscation](#uri-obfuscation)
-- [MD5 Checksum / Fingerprint](#md5-checksum--fingerprint)
+- [Checksum / Fingerprint](#checksum--fingerprint)
 - [File Preservation for Soft-Delete](#file-preservation-for-soft-delete)
-- [Custom Attachment Processors](#custom-attachment-processors)
 - [Dynamic Configuration](#dynamic-configuration)
-  - [Dynamic Styles](#dynamic-styles)
-  - [Dynamic Processors](#dynamic-processors)
+  - [Dynamic Styles:](#dynamic-styles)
+  - [Dynamic Processors:](#dynamic-processors)
 - [Logging](#logging)
 - [Deployment](#deployment)
+  - [Attachment Styles](#attachment-styles)
 - [Testing](#testing)
 - [Contributing](#contributing)
 - [License](#license)
 - [About thoughtbot](#about-thoughtbot)
 
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 Paperclip is intended as an easy file attachment library for ActiveRecord. The
 intent behind it was to keep setup as easy as possible and to treat files as
 much like other attributes as possible. This means they aren't saved to their
@@ -79,7 +87,7 @@ Requirements
 ### Ruby and Rails
 
 Paperclip now requires Ruby version **>= 2.1** and Rails version **>= 4.2**
-(only if you're going to use Paperclip with Ruby on Rails.)
+(only if you're going to use Paperclip with Ruby on Rails).
 
 ### Image Processor
 
@@ -97,7 +105,7 @@ In development mode, you might add this line to `config/environments/development
 Paperclip.options[:command_path] = "/usr/local/bin/"
 ```
 
-If you're on Mac OS X, you'll want to run the following with Homebrew:
+If you're on Mac OS X, you'll want to run the following with [Homebrew](http://www.brew.sh):
 
     brew install imagemagick
 
@@ -159,7 +167,7 @@ Paperclip is distributed as a gem, which is how it should be used in your app.
 Include the gem in your Gemfile:
 
 ```ruby
-gem "paperclip", "~> 5.0.0.beta1"
+gem "paperclip", "~> 5.2.1"
 ```
 
 Or, if you want to get the latest, you can get master from the main paperclip repository:
@@ -192,12 +200,14 @@ Quick Start
 ```ruby
 class User < ActiveRecord::Base
   has_attached_file :avatar, styles: { medium: "300x300>", thumb: "100x100>" }, default_url: "/images/:style/missing.png"
-  validates_attachment_content_type :avatar, content_type: /\Aimage\/.*\Z/
+  validates_attachment_content_type :avatar, content_type: /\Aimage\/.*\z/
 end
 ```
 
 ### Migrations
 
+
+Assuming you have a `users` table, add an `avatar` column to the `users` table:
 ```ruby
 class AddAvatarColumnsToUsers < ActiveRecord::Migration
   def up
@@ -213,17 +223,20 @@ end
 (Or you can use the Rails migration generator: `rails generate paperclip user avatar`)
 
 ### Edit and New Views
-
+Make sure you have corresponding methods in your controller:
 ```erb
 <%= form_for @user, url: users_path, html: { multipart: true } do |form| %>
   <%= form.file_field :avatar %>
+  <%= form.submit %>
 <% end %>
 ```
 
-### Edit and New Views with Simple Form
+### Edit and New Views with [Simple Form](https://github.com/plataformatec/simple_form)
+
 ```erb
 <%= simple_form_for @user, url: users_path do |form| %>
   <%= form.input :avatar, as: :file %>
+  <%= form.submit %>
 <% end %>
 ```
 
@@ -231,7 +244,7 @@ end
 
 ```ruby
 def create
-  @user = User.create( user_params )
+  @user = User.create(user_params)
 end
 
 private
@@ -244,14 +257,24 @@ def user_params
 end
 ```
 
-### Show View
-
+### View Helpers
+Add these to the view where you want your images displayed:
 ```erb
 <%= image_tag @user.avatar.url %>
 <%= image_tag @user.avatar.url(:medium) %>
 <%= image_tag @user.avatar.url(:thumb) %>
 ```
 
+### Checking a File Exists
+
+There are two methods for checking if a file exists:
+
+- `file?` and `present?` checks if the `_file_name` field is populated
+- `exists?` checks if the file exists (will perform a TCP connection if stored in the cloud)
+
+Keep this in mind if you are checking if files are present in a loop. The first
+version is significantly more performant, but has different semantics.
+
 ### Deleting an Attachment
 
 Set the attribute to `nil` and save.
@@ -328,7 +351,7 @@ called with valid attachments._
 
 ```ruby
 class Message < ActiveRecord::Base
-  has_attached_file :asset, styles: {thumb: "100x100#"}
+  has_attached_file :asset, styles: { thumb: "100x100#" }
 
   before_post_process :skip_for_audio
 
@@ -344,7 +367,7 @@ afterwards, then assign manually:
 
 ```ruby
 class Book < ActiveRecord::Base
-  has_attached_file :document, styles: {thumbnail: "60x60#"}
+  has_attached_file :document, styles: { thumbnail: "60x60#" }
   validates_attachment :document, content_type: { content_type: "application/pdf" }
   validates_something_else # Other validations that conflict with Paperclip's
 end
@@ -409,7 +432,7 @@ class ActiveRecord::Base
   # Validate content type
   validates_attachment_content_type :avatar, content_type: /\Aimage/
   # Validate filename
-  validates_attachment_file_name :avatar, matches: [/png\Z/, /jpe?g\Z/]
+  validates_attachment_file_name :avatar, matches: [/png\z/, /jpe?g\z/]
   # Explicitly do not validate
   do_not_validate_attachment_file_type :avatar
 end
@@ -531,7 +554,7 @@ class AddAttachmentColumnsToUsers < ActiveRecord::Migration
 end
 ```
 
-### Vintage syntax
+### Vintage Syntax
 
 Vintage syntax (such as `t.has_attached_file` and `drop_attached_file`) is still supported in
 Paperclip 3.x, but you're advised to update those migration files to use this new syntax.
@@ -550,6 +573,7 @@ Paperclip ships with 3 storage adapters:
 If you would like to use Paperclip with another storage, you can install these
 gems along side with Paperclip:
 
+* [paperclip-azure](https://github.com/supportify/paperclip-azure)
 * [paperclip-azure-storage](https://github.com/gmontard/paperclip-azure-storage)
 * [paperclip-dropbox](https://github.com/janko-m/paperclip-dropbox)
 
@@ -559,8 +583,8 @@ The files that are assigned as attachments are, by default, placed in the
 directory specified by the `:path` option to `has_attached_file`. By default, this
 location is `:rails_root/public/system/:class/:attachment/:id_partition/:style/:filename`.
 This location was chosen because, on standard Capistrano deployments, the
-`public/system` directory is symlinked to the app's shared directory, meaning it
-will survive between deployments. For example, using that `:path`, you may have a
+`public/system` directory can be symlinked to the app's shared directory, meaning it
+survives between deployments. For example, using that `:path`, you may have a
 file at
 
     /data/myapp/releases/20081229172410/public/system/users/avatar/000/000/013/small/my_pic.png
@@ -572,7 +596,7 @@ You may also choose to store your files using Amazon's S3 service. To do so, inc
 the `aws-sdk` gem in your Gemfile:
 
 ```ruby
-gem 'aws-sdk', '>= 2.0.34'
+gem 'aws-sdk', '~> 2.3.0'
 ```
 
 And then you can specify using S3 from `has_attached_file`.
@@ -588,64 +612,121 @@ variables.
 
 ---
 
+IO Adapters
+-----------
+
+When a file is uploaded or attached, it can be in one of a few different input
+forms, from Rails' UploadedFile object to a StringIO to a Tempfile or even a
+simple String that is a URL that points to an image.
+
+Paperclip will accept, by default, many of these sources. It also is capable of
+handling even more with a little configuration. The IO Adapters that handle
+images from non-local sources are not enabled by default. They can be enabled by
+adding a line similar to the following into `config/initializers/paperclip.rb`:
+
+```ruby
+Paperclip::DataUriAdapter.register
+```
+
+It's best to only enable a remote-loading adapter if you need it. Otherwise
+there's a chance that someone can gain insight into your internal network
+structure using it as a vector.
+
+The following adapters are *not* loaded by default:
+
+* `Paperclip::UriAdapter` - which accepts a `URI` instance.
+* `Paperclip::HttpUrlProxyAdapter` - which accepts a `http` string.
+* `Paperclip::DataUriAdapter` - which accepts a Base64-encoded `data:` string.
+
+---
+
 Post Processing
 ---------------
 
 Paperclip supports an extensible selection of post-processors. When you define
 a set of styles for an attachment, by default it is expected that those
-"styles" are actually "thumbnails." However, you can do much more than just
-thumbnail images. By defining a subclass of Paperclip::Processor, you can
-perform any processing you want on the files that are attached. Any file in
-your Rails app's `lib/paperclip` and `lib/paperclip_processors` directories is
-automatically loaded by Paperclip, allowing you to easily define custom
-processors. You can specify a processor with the `:processors` option to
-`has_attached_file`:
+"styles" are actually "thumbnails." These are processed by
+`Paperclip::Thumbnail`.  For backward compatibility reasons you can pass either
+a single geometry string, or an array containing a geometry and a format that
+the file will be converted to, like so:
 
 ```ruby
-has_attached_file :scan, styles: { text: { quality: :better } },
-                         processors: [:ocr]
+has_attached_file :avatar, styles: { thumb: ["32x32#", :png] }
 ```
 
-This would load the hypothetical class Paperclip::Ocr, which would have the
-hash "{ quality: :better }" passed to it along with the uploaded file. For
-more information about defining processors, see Paperclip::Processor.
+This will convert the "thumb" style to a 32x32 square in PNG format, regardless
+of what was uploaded. If the format is not specified, it is kept the same (e.g.
+JPGs will remain JPGs). `Paperclip::Thumbnail` uses ImageMagick to process
+images; [ImageMagick's geometry documentation](http://www.imagemagick.org/script/command-line-processing.php#geometry)
+has more information on the accepted style formats.
 
-The default processor is Paperclip::Thumbnail. For backward compatibility
-reasons, you can pass a single geometry string or an array containing a
-geometry and a format that the file will be converted to, like so:
+For more fine-grained control of the conversion process, `source_file_options` and `convert_options` can be used to pass flags and settings directly to ImageMagick's powerful Convert tool, [documented here](https://www.imagemagick.org/script/convert.php). For example:
 
 ```ruby
-has_attached_file :avatar, styles: { thumb: ["32x32#", :png] }
+has_attached_file :image, styles: { regular: ['800x800>', :png]}, 
+    source_file_options: { regular: "-density 96 -depth 8 -quality 85" },
+    convert_options: { regular: "-posterize 3"}
 ```
 
-This will convert the "thumb" style to a 32x32 square in PNG format, regardless
-of what was uploaded. If the format is not specified, it is kept the same (i.e.
-JPGs will remain JPGs). For more information on the accepted style formats, see
-[here](http://www.imagemagick.org/script/command-line-processing.php#geometry).
+ImageMagick supports a number of environment variables for controlling its resource limits. For example, you can enforce memory or execution time limits by setting the following variables in your application's process environment:
+
+* `MAGICK_MEMORY_LIMIT=128MiB`
+* `MAGICK_MAP_LIMIT=64MiB`
+* `MAGICK_TIME_LIMIT=30`
+
+For a full list of variables and description, see [ImageMagick's resources documentation](http://www.imagemagick.org/script/resources.php).
+
+---
+
+Custom Attachment Processors
+-------
+
+You can write your own custom attachment processors to carry out tasks like
+adding watermarks, compressing images, or encrypting files. Custom processors
+must be defined within the `Paperclip` module, inherit from
+`Paperclip::Processor` (see [`lib/paperclip/processor.rb`](https://github.com/thoughtbot/paperclip/blob/master/lib/paperclip/processor.rb)),
+and implement a `make` method that returns a `File`. All files in your Rails
+app's `lib/paperclip` and `lib/paperclip_processors` directories will be
+automatically loaded by Paperclip. Processors are specified using the
+`:processors` option to `has_attached_file`:
+
+```ruby
+has_attached_file :scan, styles: { text: { quality: :better } },
+                         processors: [:ocr]
+```
+
+This would load the hypothetical class `Paperclip::Ocr`, and pass it the
+options hash `{ quality: :better }`, along with the uploaded file.
 
 Multiple processors can be specified, and they will be invoked in the order
-they are defined in the `:processors` array. Each successive processor will
-be given the result of the previous processor's execution. All processors will
-receive the same parameters, which are defined in the `:styles` hash.
-For example, assuming we had this definition:
+they are defined in the `:processors` array. Each successive processor is given
+the result from the previous processor. All processors receive the same
+parameters, which are defined in the `:styles` hash.  For example, assuming we
+had this definition:
 
 ```ruby
 has_attached_file :scan, styles: { text: { quality: :better } },
                          processors: [:rotator, :ocr]
 ```
 
-then both the :rotator processor and the :ocr processor would receive the
-options `{ quality: :better }`. This parameter may not mean anything to one
-or more or the processors, and they are expected to ignore it.
+Both the `:rotator` processor and the `:ocr` processor would receive the
+options `{ quality: :better }`. If a processor receives an option it doesn't
+recognise, it's expected to ignore it.
 
 _NOTE: Because processors operate by turning the original attachment into the
 styles, no processors will be run if there are no styles defined._
 
 If you're interested in caching your thumbnail's width, height and size in the
-database, take a look at the [paperclip-meta](https://github.com/teeparham/paperclip-meta) gem.
+database, take a look at the [paperclip-meta](https://github.com/teeparham/paperclip-meta)
+gem.
 
 Also, if you're interested in generating the thumbnail on-the-fly, you might want
-to look into the [attachment_on_the_fly](https://github.com/drpentode/Attachment-on-the-Fly) gem.
+to look into the [attachment_on_the_fly](https://github.com/drpentode/Attachment-on-the-Fly)
+gem.
+
+Paperclip's thumbnail generator (see [`lib/paperclip/thumbnail.rb`](lib/paperclip/thumbnail.rb))
+is implemented as a processor, and may be a good reference for writing your own
+processors.
 
 ---
 
@@ -669,7 +750,7 @@ called with valid attachments._
 
 ```ruby
 class Message < ActiveRecord::Base
-  has_attached_file :asset, styles: {thumb: "100x100#"}
+  has_attached_file :asset, styles: { thumb: "100x100#" }
 
   before_post_process :skip_for_audio
 
@@ -704,10 +785,10 @@ is specified in `:hash_data`. The default value for `:hash_data` is `":class/:at
 
 For more on this feature, read [the author's own explanation](https://github.com/thoughtbot/paperclip/pull/416)
 
-MD5 Checksum / Fingerprint
+Checksum / Fingerprint
 -------
 
-An MD5 checksum of the original file assigned will be placed in the model if it
+A checksum of the original file assigned will be placed in the model if it
 has an attribute named fingerprint.  Following the user model migration example
 above, the migration would look like the following:
 
@@ -723,6 +804,17 @@ class AddAvatarFingerprintColumnToUser < ActiveRecord::Migration
 end
 ```
 
+The algorithm can be specified using a configuration option; it defaults to MD5
+for backwards compatibility with Paperclip 5 and earlier.
+
+```ruby
+has_attached_file :some_attachment, adapter_options: { hash_digest: Digest::SHA256 }
+```
+
+Run `CLASS=User ATTACHMENT=avatar rake paperclip:refresh:fingerprints` after
+changing the digest on existing attachments to update the fingerprints in the
+database.
+
 File Preservation for Soft-Delete
 -------
 
@@ -730,7 +822,7 @@ An option is available to preserve attachments in order to play nicely with soft
 
 ```ruby
 has_attached_file :some_attachment, {
-    preserve_files: "true",
+    preserve_files: true,
 }
 ```
 
@@ -738,25 +830,6 @@ This will prevent ```some_attachment``` from being wiped out when the model gets
 
 ---
 
-Custom Attachment Processors
--------
-
-Custom attachment processors can be implemented and their only requirement is
-to inherit from `Paperclip::Processor` (see `lib/paperclip/processor.rb`).
-For example, when `:styles` are specified for an image attachment, the
-thumbnail processor (see `lib/paperclip/thumbnail.rb`) is loaded without having
-to specify it as a `:processor` parameter to `has_attached_file`.  When any
-other processor is defined, it must be called out in the `:processors`
-parameter if it is to be applied to the attachment.  The thumbnail processor
-uses the ImageMagick `convert` command to do the work of resizing image
-thumbnails.  It would be easy to create a custom processor that watermarks
-an image using ImageMagick's `composite` command.  Following the
-implementation pattern of the thumbnail processor would be a way to implement a
-watermark processor.  All kinds of attachment processors can be created;
-a few utility examples would be compression and encryption processors.
-
----
-
 Dynamic Configuration
 ---------------------
 
@@ -821,6 +894,16 @@ More information in the [rdocs](http://www.rubydoc.info/github/thoughtbot/paperc
 Deployment
 ----------
 
+To make Capistrano symlink the `public/system` directory so that attachments
+survive new deployments, set the `linked_dirs` option in your `config/deploy.rb`
+file:
+
+```ruby
+set :linked_dirs, fetch(:linked_dirs, []).push('public/system')
+```
+
+### Attachment Styles
+
 Paperclip is aware of new attachment styles you have added in previous deploys. The only thing you should do after each deployment is to call
 `rake paperclip:refresh:missing_styles`.  It will store current attachment styles in `RAILS_ROOT/public/system/paperclip_attachments.yml`
 by default. You can change it by:
@@ -832,9 +915,9 @@ Paperclip.registered_attachments_styles_path = '/tmp/config/paperclip_attachment
 Here is an example for Capistrano:
 
 ```ruby
-namespace :deploy do
+namespace :paperclip do
   desc "build missing paperclip styles"
-  task :build_missing_paperclip_styles do
+  task :build_missing_styles do
     on roles(:app) do
       within release_path do
         with rails_env: fetch(:rails_env) do
@@ -845,7 +928,7 @@ namespace :deploy do
   end
 end
 
-after("deploy:compile_assets", "deploy:build_missing_paperclip_styles")
+after("deploy:compile_assets", "paperclip:build_missing_styles")
 ```
 
 Now you don't have to remember to refresh thumbnails in production every time you add a new style.
@@ -912,7 +995,7 @@ similar mechanism for whichever parallel testing library you use.
 
 **Integration Tests**
 
-Using integration tests with FactoryGirl may save multiple copies of
+Using integration tests with FactoryBot may save multiple copies of
 your test files within the app. To avoid this, specify a custom path in
 the `config/environments/test.rb` like so:
 
@@ -928,6 +1011,17 @@ config.after(:suite) do
   FileUtils.rm_rf(Dir["#{Rails.root}/spec/test_files/"])
 end
 ```
+
+**Example of test configuration with Factory Bot**
+
+
+```ruby
+FactoryBot.define do
+  factory :user do
+    avatar { File.new("#{Rails.root}/spec/support/fixtures/image.jpg") }
+  end
+end
+```
 ---
 
 Contributing
@@ -943,20 +1037,20 @@ guidelines:
    about writing tests for paperclip, please open a
    [GitHub issue](https://github.com/thoughtbot/paperclip/issues/new).
 
-Please see `CONTRIBUTING.md` for more details on contributing and running test.
+Please see [`CONTRIBUTING.md`](./CONTRIBUTING.md) for more details on contributing and running test.
 
 Thank you to all [the contributors](https://github.com/thoughtbot/paperclip/graphs/contributors)!
 
 License
 -------
 
-Paperclip is Copyright © 2008-2016 thoughtbot, inc. It is free software, and may be
+Paperclip is Copyright © 2008-2017 thoughtbot, inc. It is free software, and may be
 redistributed under the terms specified in the MIT-LICENSE file.
 
 About thoughtbot
 ----------------
 
-![thoughtbot](https://thoughtbot.com/logo.png)
+![thoughtbot](http://presskit.thoughtbot.com/images/thoughtbot-logo-for-readmes.svg)
 
 Paperclip is maintained and funded by thoughtbot.
 The names and logos for thoughtbot are trademarks of thoughtbot, inc.