activestorage 6.0.4 → 6.1.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e40851af6b9bf07e36ad4a7133f5d35a3291ccafe10ab1cde9d865122e7fbfbf
-  data.tar.gz: 71510a056f86062a2a796cbddd172f0e4e32c901bfc606b91a749804303bbba1
+  metadata.gz: 2b5828c669886bb3073bc9a325644f70785b9e7432fe34bf609369ae854472d1
+  data.tar.gz: c20c99725925af7c67f86c4ad99fcc5add79a4c373db3c1d5ae6fe4c2b1a893b
 SHA512:
-  metadata.gz: dd391607b9d0a43217ad794efd9644a800d3bbe04b8c2927959429d1d1fa7c7da18507ab722588082d3b7a863192f961d0ca3a78146d63ac929e597635f03c17
-  data.tar.gz: 70fccf7e11af2be2b8a3102981207351c5850ef94bf1526032b8fb462290e81c03314285cdc376943f26c0f7867880c6a2bf0e8e29f6991bcce7e6c6c188b426
+  metadata.gz: 7d0adc41784932bd392d92f120fadea916633ccf659a2b2d5d3b6a305eee2ca093a6d82045e322b40a5d6349cfeae880db08c87f1972bb40e954f52dd1457c45
+  data.tar.gz: adf193c0617237b63aaf251b0e0fe8ec0e48da5b3dc47d8a6e60a5b91ea976d3a205dd990a0a2b20d65bd21b70dc5eccbaed0a512a86c03445be84811fa5deda

data/CHANGELOG.md

@@ -1,278 +1,232 @@
-## Rails 6.0.4 (June 15, 2021) ##
-
-*   The Poppler PDF previewer renders a preview image using the original
-    document's crop box rather than its media box, hiding print margins. This
-    matches the behavior of the MuPDF previewer.
-
-    *Vincent Robert*
+## Rails 6.1.0.rc1 (November 02, 2020) ##
 
+*   Remove deprecated support to pass `:combine_options` operations to `ActiveStorage::Transformers::ImageProcessing`.
 
-## Rails 6.0.3.7 (May 05, 2021) ##
+    *Rafael Mendonça França*
 
-*   No changes.
+*   Remove deprecated `ActiveStorage::Transformers::MiniMagickTransformer`.
 
+    *Rafael Mendonça França*
 
-## Rails 6.0.3.6 (March 26, 2021) ##
+*   Remove deprecated `config.active_storage.queue`.
 
-*   Marcel is upgraded to version 1.0.0 to avoid a dependency on GPL-licensed
-    mime types data.
-
-    *George Claghorn*
+    *Rafael Mendonça França*
 
+*   Remove deprecated `ActiveStorage::Downloading`.
 
-## Rails 6.0.3.5 (February 10, 2021) ##
+    *Rafael Mendonça França*
 
-*   No changes.
+*   Add per-environment configuration support
 
+    *Pietro Moro*
 
-## Rails 6.0.3.4 (October 07, 2020) ##
+*   The Poppler PDF previewer renders a preview image using the original
+    document's crop box rather than its media box, hiding print margins. This
+    matches the behavior of the MuPDF previewer.
 
-*   No changes.
+    *Vincent Robert*
 
+*   Touch parent model when an attachment is purged.
 
-## Rails 6.0.3.3 (September 09, 2020) ##
+    *Víctor Pérez Rodríguez*
 
-*   No changes.
+*   Files can now be served by proxying them from the underlying storage service
+    instead of redirecting to a signed service URL. Use the
+    `rails_storage_proxy_path` and `_url` helpers to proxy an attached file:
 
+    ```erb
+    <%= image_tag rails_storage_proxy_path(@user.avatar) %>
+    ```
 
-## Rails 6.0.3.2 (June 17, 2020) ##
+    To proxy by default, set `config.active_storage.resolve_model_to_route`:
 
-*   No changes.
+    ```ruby
+    # Proxy attached files instead.
+    config.active_storage.resolve_model_to_route = :rails_storage_proxy
+    ```
 
+    ```erb
+    <%= image_tag @user.avatar %>
+    ```
 
-## Rails 6.0.3.1 (May 18, 2020) ##
+    To redirect to a signed service URL when the default file serving strategy
+    is set to proxying, use the `rails_storage_redirect_path` and `_url` helpers:
 
-*   [CVE-2020-8162] Include Content-Length in signature for ActiveStorage direct upload
+    ```erb
+    <%= image_tag rails_storage_redirect_path(@user.avatar) %>
+    ```
 
+    *Jonathan Fleckenstein*
 
-## Rails 6.0.3 (May 06, 2020) ##
+*   Add `config.active_storage.web_image_content_types` to allow applications
+    to add content types (like `image/webp`) in which variants can be processed,
+    instead of letting those images be converted to the fallback PNG format.
 
-*   No changes.
+    *Jeroen van Haperen*
 
+*   Add support for creating variants of `WebP` images out of the box.
 
-## Rails 6.0.2.2 (March 19, 2020) ##
+    *Dino Maric*
 
-*   No changes.
+*   Only enqueue analysis jobs for blobs with non-null analyzer classes.
 
+    *Gannon McGibbon*
 
-## Rails 6.0.2.1 (December 18, 2019) ##
+*   Previews are created on the same service as the original blob.
 
-*   No changes.
+    *Peter Zhu*
 
+*   Remove unused `disposition` and `content_type` query parameters for `DiskService`.
 
-## Rails 6.0.2 (December 13, 2019) ##
+    *Peter Zhu*
 
-*   No changes.
+*   Use `DiskController` for both public and private files.
 
+    `DiskController` is able to handle multiple services by adding a
+    `service_name` field in the generated URL in `DiskService`.
 
-## Rails 6.0.1 (November 5, 2019) ##
+    *Peter Zhu*
 
-*   `ActiveStorage::AnalyzeJob`s are discarded on `ActiveRecord::RecordNotFound` errors.
+*   Variants are tracked in the database to avoid existence checks in the storage service.
 
     *George Claghorn*
 
-*   Blobs are recorded in the database before being uploaded to the service.
-    This fixes that generated blob keys could silently collide, leading to
-    data loss.
-
-    *Julik Tarkhanov*
-
-
-## Rails 6.0.0 (August 16, 2019) ##
-
-*   No changes.
-
+*   Deprecate `service_url` methods in favour of `url`.
 
-## Rails 6.0.0.rc2 (July 22, 2019) ##
+    Deprecate `Variant#service_url` and `Preview#service_url` to instead use
+    `#url` method to be consistent with `Blob`.
 
-*   No changes.
+    *Peter Zhu*
 
+*   Permanent URLs for public storage blobs.
 
-## Rails 6.0.0.rc1 (April 24, 2019) ##
+    Services can be configured in `config/storage.yml` with a new key
+    `public: true | false` to indicate whether a service holds public
+    blobs or private blobs. Public services will always return a permanent URL.
 
-*   Don't raise when analyzing an image whose type is unsupported by ImageMagick.
+    Deprecates `Blob#service_url` in favor of `Blob#url`.
 
-    Fixes #36065.
+    *Peter Zhu*
 
-    *Guilherme Mansur*
+*   Make services aware of configuration names.
 
-*   Permit generating variants of BMP images.
+    *Gannon McGibbon*
 
-    *Younes Serraj*
+*   The `Content-Type` header is set on image variants when they're uploaded to third-party storage services.
 
+    *Kyle Ribordy*
 
-## Rails 6.0.0.beta3 (March 11, 2019) ##
+*   Allow storage services to be configured per attachment.
 
-*   No changes.
-
-
-## Rails 6.0.0.beta2 (February 25, 2019) ##
-
-*   No changes.
-
-
-## Rails 6.0.0.beta1 (January 18, 2019) ##
+    ```ruby
+    class User < ActiveRecord::Base
+      has_one_attached :avatar, service: :s3
+    end
 
-*   [Rename npm package](https://github.com/rails/rails/pull/34905) from
-    [`activestorage`](https://www.npmjs.com/package/activestorage) to
-    [`@rails/activestorage`](https://www.npmjs.com/package/@rails/activestorage).
+    class Gallery < ActiveRecord::Base
+      has_many_attached :photos, service: :s3
+    end
+    ```
 
-    *Javan Makhmali*
+    *Dmitry Tsepelev*
 
-*   Replace `config.active_storage.queue` with two options that indicate which
-    queues analysis and purge jobs should use, respectively:
+*   You can optionally provide a custom blob key when attaching a new file:
 
-    * `config.active_storage.queues.analysis`
-    * `config.active_storage.queues.purge`
+    ```ruby
+    user.avatar.attach key: "avatars/#{user.id}.jpg",
+      io: io, content_type: "image/jpeg", filename: "avatar.jpg"
+    ```
 
-    `config.active_storage.queue` is preferred over the new options when it's
-    set, but it is deprecated and will be removed in Rails 6.1.
+    Active Storage will store the blob's data on the configured service at the provided key.
 
     *George Claghorn*
 
-*   Permit generating variants of TIFF images.
+*   Replace `Blob.create_after_upload!` with `Blob.create_and_upload!` and deprecate the former.
 
-    *Luciano Sousa*
-
-*   Use base36 (all lowercase) for all new Blob keys to prevent
-    collisions and undefined behavior with case-insensitive filesystems and
-    database indices.
+    `create_after_upload!` has been removed since it could lead to data
+    corruption by uploading to a key on the storage service which happened to
+    be already taken. Creating the record would then correctly raise a
+    database uniqueness exception but the stored object would already have
+    overwritten another. `create_and_upload!` swaps the order of operations
+    so that the key gets reserved up-front or the uniqueness error gets raised,
+    before the upload to a key takes place.
 
     *Julik Tarkhanov*
 
-*   It doesn’t include an `X-CSRF-Token` header if a meta tag is not found on
-    the page. It previously included one with a value of `undefined`.
-
-    *Cameron Bothner*
-
-*   Fix `ArgumentError` when uploading to amazon s3
-
-    *Hiroki Sanpei*
-
-*   Add progressive JPG to default list of variable content types
-
-    *Maurice Kühlborn*
+*   Set content disposition in direct upload using `filename` and `disposition` parameters to `ActiveStorage::Service#headers_for_direct_upload`.
 
-*   Add `ActiveStorage.routes_prefix` for configuring generated routes.
+    *Peter Zhu*
 
-    *Chris Bisnett*
+*   Allow record to be optionally passed to blob finders to make sharding
+    easier.
 
-*   `ActiveStorage::Service::AzureStorageService` only handles specifically
-    relevant types of `Azure::Core::Http::HTTPError`. It previously obscured
-    other types of `HTTPError`, which is the azure-storage gem’s catch-all
-    exception class.
+    *Gannon McGibbon*
 
-    *Cameron Bothner*
+*   Switch from `azure-storage` gem to `azure-storage-blob` gem for Azure service.
 
-*   `ActiveStorage::DiskController#show` generates a 404 Not Found response when
-    the requested file is missing from the disk service. It previously raised
-    `Errno::ENOENT`.
+    *Peter Zhu*
 
-    *Cameron Bothner*
+*   Add `config.active_storage.draw_routes` to disable Active Storage routes.
 
-*   `ActiveStorage::Blob#download` and `ActiveStorage::Blob#open` raise
-    `ActiveStorage::FileNotFoundError` when the corresponding file is missing
-    from the storage service. Services translate service-specific missing object
-    exceptions (e.g. `Google::Cloud::NotFoundError` for the GCS service and
-    `Errno::ENOENT` for the disk service) into
-    `ActiveStorage::FileNotFoundError`.
+    *Gannon McGibbon*
 
-    *Cameron Bothner*
+*   Image analysis is skipped if ImageMagick returns an error.
 
-*   Added the `ActiveStorage::SetCurrent` concern for custom Active Storage
-    controllers that can't inherit from `ActiveStorage::BaseController`.
+    `ActiveStorage::Analyzer::ImageAnalyzer#metadata` would previously raise a
+    `MiniMagick::Error`, which caused persistent `ActiveStorage::AnalyzeJob`
+    failures. It now logs the error and returns `{}`, resulting in no metadata
+    being added to the offending image blob.
 
     *George Claghorn*
 
-*   Active Storage error classes like `ActiveStorage::IntegrityError` and
-    `ActiveStorage::UnrepresentableError` now inherit from `ActiveStorage::Error`
-    instead of `StandardError`. This permits rescuing `ActiveStorage::Error` to
-    handle all Active Storage errors.
+*   Method calls on singular attachments return `nil` when no file is attached.
 
-    *Andrei Makarov*, *George Claghorn*
-
-*   Uploaded files assigned to a record are persisted to storage when the record
-    is saved instead of immediately.
-
-    In Rails 5.2, the following causes an uploaded file in `params[:avatar]` to
-    be stored:
+    Previously, assuming the following User model, `user.avatar.filename` would
+    raise a `Module::DelegationError` if no avatar was attached:
 
     ```ruby
-    @user.avatar = params[:avatar]
+    class User < ApplicationRecord
+      has_one_attached :avatar
+    end
     ```
 
-    In Rails 6, the uploaded file is stored when `@user` is successfully saved.
-
-    *George Claghorn*
+    They now return `nil`.
 
-*   Add the ability to reflect on defined attachments using the existing
-    ActiveRecord reflection mechanism.
+    *Matthew Tanous*
 
-    *Kevin Deisz*
+*   The mirror service supports direct uploads.
 
-*   Variant arguments of `false` or `nil` will no longer be passed to the
-    processor. For example, the following will not have the monochrome
-    variation applied:
-
-    ```ruby
-      avatar.variant(monochrome: false)
-    ```
+    New files are directly uploaded to the primary service. When a
+    directly-uploaded file is attached to a record, a background job is enqueued
+    to copy it to each secondary service.
 
-    *Jacob Smith*
+    Configure the queue used to process mirroring jobs by setting
+    `config.active_storage.queues.mirror`. The default is `:active_storage_mirror`.
 
-*   Generated attachment getter and setter methods are created
-    within the model's `GeneratedAssociationMethods` module to
-    allow overriding and composition using `super`.
-
-    *Josh Susser*, *Jamon Douglas*
-
-*   Add `ActiveStorage::Blob#open`, which downloads a blob to a tempfile on disk
-    and yields the tempfile. Deprecate `ActiveStorage::Downloading`.
-
-    *David Robertson*, *George Claghorn*
-
-*   Pass in `identify: false` as an argument when providing a `content_type` for
-    `ActiveStorage::Attached::{One,Many}#attach` to bypass automatic content
-    type inference. For example:
+    *George Claghorn*
 
-    ```ruby
-      @message.image.attach(
-        io: File.open('/path/to/file'),
-        filename: 'file.pdf',
-        content_type: 'application/pdf',
-        identify: false
-      )
+*   The S3 service now permits uploading files larger than 5 gigabytes.
+
+    When uploading a file greater than 100 megabytes in size, the service
+    transparently switches to [multipart uploads](https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html)
+    using a part size computed from the file's total size and S3's part count limit.
+
+    No application changes are necessary to take advantage of this feature. You
+    can customize the default 100 MB multipart upload threshold in your S3
+    service's configuration:
+
+    ```yaml
+    production:
+      service: s3
+      access_key_id: <%= Rails.application.credentials.dig(:aws, :access_key_id) %>
+      secret_access_key: <%= Rails.application.credentials.dig(:aws, :secret_access_key) %>
+      region: us-east-1
+      bucket: my-bucket
+      upload:
+        multipart_threshold: <%= 250.megabytes %>
     ```
 
-    *Ryan Davidson*
-
-*   The Google Cloud Storage service properly supports streaming downloads.
-    It now requires version 1.11 or newer of the google-cloud-storage gem.
-
     *George Claghorn*
 
-*   Use the [ImageProcessing](https://github.com/janko-m/image_processing) gem
-    for Active Storage variants, and deprecate the MiniMagick backend.
-
-    This means that variants are now automatically oriented if the original
-    image was rotated. Also, in addition to the existing ImageMagick
-    operations, variants can now use `:resize_to_fit`, `:resize_to_fill`, and
-    other ImageProcessing macros. These are now recommended over raw `:resize`,
-    as they also sharpen the thumbnail after resizing.
-
-    The ImageProcessing gem also comes with a backend implemented on
-    [libvips](http://jcupitt.github.io/libvips/), an alternative to
-    ImageMagick which has significantly better performance than
-    ImageMagick in most cases, both in terms of speed and memory usage. In
-    Active Storage it's now possible to switch to the libvips backend by
-    changing `Rails.application.config.active_storage.variant_processor` to
-    `:vips`.
-
-    *Janko Marohnić*
-
-*   Rails 6 requires Ruby 2.5.0 or newer.
-
-    *Jeremy Daer*, *Kasper Timm Hansen*
-
 
-Please check [5-2-stable](https://github.com/rails/rails/blob/5-2-stable/activestorage/CHANGELOG.md) for previous changes.
+Please check [6-0-stable](https://github.com/rails/rails/blob/6-0-stable/activestorage/CHANGELOG.md) for previous changes.

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2017-2019 David Heinemeier Hansson, Basecamp
+Copyright (c) 2017-2020 David Heinemeier Hansson, Basecamp
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -10,13 +10,13 @@ You can read more about Active Storage in the [Active Storage Overview](https://
 
 ## Compared to other storage solutions
 
-A key difference to how Active Storage works compared to other attachment solutions in Rails is through the use of built-in [Blob](https://github.com/rails/rails/blob/main/activestorage/app/models/active_storage/blob.rb) and [Attachment](https://github.com/rails/rails/blob/main/activestorage/app/models/active_storage/attachment.rb) models (backed by Active Record). This means existing application models do not need to be modified with additional columns to associate with files. Active Storage uses polymorphic associations via the `Attachment` join model, which then connects to the actual `Blob`.
+A key difference to how Active Storage works compared to other attachment solutions in Rails is through the use of built-in [Blob](https://github.com/rails/rails/blob/master/activestorage/app/models/active_storage/blob.rb) and [Attachment](https://github.com/rails/rails/blob/master/activestorage/app/models/active_storage/attachment.rb) models (backed by Active Record). This means existing application models do not need to be modified with additional columns to associate with files. Active Storage uses polymorphic associations via the `Attachment` join model, which then connects to the actual `Blob`.
 
 `Blob` models store attachment metadata (filename, content-type, etc.), and their identifier key in the storage service. Blob models do not store the actual binary data. They are intended to be immutable in spirit. One file, one blob. You can associate the same blob with multiple application models as well. And if you want to do transformations of a given `Blob`, the idea is that you'll simply create a new one, rather than attempt to mutate the existing one (though of course you can delete the previous version later if you don't need it).
 
 ## Installation
 
-Run `rails active_storage:install` to copy over active_storage migrations.
+Run `bin/rails active_storage:install` to copy over active_storage migrations.
 
 NOTE: If the task cannot be found, verify that `require "active_storage/engine"` is present in `config/application.rb`.
 
@@ -55,7 +55,7 @@ url_for(user.avatar)
 
 class AvatarsController < ApplicationController
   def update
-    # params[:avatar] contains a ActionDispatch::Http::UploadedFile object
+    # params[:avatar] contains an ActionDispatch::Http::UploadedFile object
     Current.user.avatar.attach(params.require(:avatar))
     redirect_to Current.user
   end
@@ -106,6 +106,37 @@ Variation of image attachment:
 <%= image_tag user.avatar.variant(resize_to_limit: [100, 100]) %>
 ```
 
+## File serving strategies
+
+Active Storage supports two ways to serve files: redirecting and proxying.
+
+### Redirecting
+
+Active Storage generates stable application URLs for files which, when accessed, redirect to signed, short-lived service URLs. This relieves application servers of the burden of serving file data. It is the default file serving strategy.
+
+When the application is configured to proxy files by default, use the `rails_storage_redirect_path` and `_url` route helpers to redirect instead:
+
+```erb
+<%= image_tag rails_storage_redirect_path(@user.avatar) %>
+```
+
+### Proxying
+
+Optionally, files can be proxied instead. This means that your application servers will download file data from the storage service in response to requests. This can be useful for serving files from a CDN.
+
+Explicitly proxy attachments using the `rails_storage_proxy_path` and `_url` route helpers:
+
+```erb
+<%= image_tag rails_storage_proxy_path(@user.avatar) %>
+```
+
+Or configure Active Storage to use proxying by default:
+
+```ruby
+# config/initializers/active_storage.rb
+Rails.application.config.active_storage.resolve_model_to_route = :rails_storage_proxy
+```
+
 ## Direct uploads
 
 Active Storage, with its included JavaScript library, supports uploading directly from the client to the cloud.
@@ -120,7 +151,8 @@ Active Storage, with its included JavaScript library, supports uploading directl
     ```
     Using the npm package:
     ```js
-    require("@rails/activestorage").start()
+    import * as ActiveStorage from "@rails/activestorage"
+    ActiveStorage.start()
     ```
 2. Annotate file inputs with the direct upload URL.