activestorage 6.1.4.4 → 7.0.0.alpha1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15736d93623ce99c6d521c797c51d4a764e684191f575cf8b7ad521b72e9ba3f
-  data.tar.gz: 95ef6c6c968b0ca1a283fcd40c6976d860817ab08d4b667e9eb83a4246d7e777
+  metadata.gz: c267f362a238a90819d7e7cd23917d10970b03acd2956d099ea6aeb26c2ce192
+  data.tar.gz: c669f3a56d9b6f3f5a08e89cfb49725d65d1abf0d7e933c50b6a3fc12c7d9a6d
 SHA512:
-  metadata.gz: bff2aacb5bc1ee40540d7720fbd4a96aa914ff627956d1a63a20ea219c3b9e6026fe6380c2f626a0a1c2af96a0ea00f7a40076d0a46e4f5484420311a72bd665
-  data.tar.gz: 43f9315265d1bb707f0c9166b6c0ac1581f02120a3c1d226a3320357e91c49516f792f304082407fd77ff2753292d71ee896378748d4512ce1e631faa46a540f
+  metadata.gz: cf96bff832fd497ff5475a475c2b8d5d22b12243d4126bd973ec28c670f9fb57e2e787c073c2ebf4edd89fb3a1d2fbd703a47e0f9a76490389b22e7e9483e2bd
+  data.tar.gz: a405ab97196c4b8c60f284b3e7c664ed30756a08abfe2d1f5d50c43630ec5cfd46d71dcd533e545151312f16459aec534a55f533be95aa6ee47021d29ce30466

data/CHANGELOG.md

@@ -1,326 +1,221 @@
-## Rails 6.1.4.4 (December 15, 2021) ##
+## Rails 7.0.0.alpha1 (September 15, 2021) ##
 
-*   No changes.
+*   Emit Active Support instrumentation events from Active Storage analyzers.
 
+    Fixes #42930
 
-## Rails 6.1.4.3 (December 14, 2021) ##
+    *Shouichi Kamiya*
 
-*   No changes.
+*   Add support for byte range requests
 
+    *Tom Prats*
 
-## Rails 6.1.4.2 (December 14, 2021) ##
+*   Attachments can be deleted after their association is no longer defined.
 
-*   No changes.
+    Fixes #42514
 
+    *Don Sisco*
 
-## Rails 6.1.4.1 (August 19, 2021) ##
+*   Make `vips` the default variant processor for new apps.
 
-*   No changes.
+    See the upgrade guide for instructions on converting from `mini_magick` to `vips`. `mini_magick` is
+    not deprecated, existing apps can keep using it.
 
+    *Breno Gazzola*
 
-## Rails 6.1.4 (June 24, 2021) ##
+*   Deprecate `ActiveStorage::Current.host` in favor of `ActiveStorage::Current.url_options` which accepts
+    a host, protocol and port.
 
-*   The parameters sent to `ffmpeg` for generating a video preview image are now
-    configurable under `config.active_storage.video_preview_arguments`.
-
-    *Brendon Muir*
-
-*   Fix Active Storage update task when running in an engine.
-
-    Justin Malčić*
-
-*   Don't raise an error if the mime type is not recognized.
-
-    Fixes #41777.
-
-    *Alex Ghiculescu*
-
-*   `ActiveStorage::PreviewError` is raised when a previewer is unable to generate a preview image.
-
-    *Alex Robbin*
-
-*   respond with 404 given invalid variation key when asking for representations.
-
-    *George Claghorn*
-
-*   `Blob` creation shouldn't crash if no service selected.
-
-    *Alex Ghiculescu*
-
-
-## Rails 6.1.3.2 (May 05, 2021) ##
-
-*   No changes.
+    *Santiago Bartesaghi*
 
+*   Allow using [IAM](https://cloud.google.com/storage/docs/access-control/signed-urls) when signing URLs with GCS.
 
-## Rails 6.1.3.1 (March 26, 2021) ##
-
-*  Marcel is upgraded to version 1.0.0 to avoid a dependency on GPL-licensed
-   mime types data.
-
-   *George Claghorn*
-
-
-## Rails 6.1.3 (February 17, 2021) ##
-
-*   No changes.
-
-
-## Rails 6.1.2.1 (February 10, 2021) ##
+    ```yaml
+    gcs:
+      service: GCS
+      ...
+      iam: true
+    ```
 
-*   No changes.
+    *RRethy*
 
+*   OpenSSL constants are now used for Digest computations.
 
-## Rails 6.1.2 (February 09, 2021) ##
+    *Dirkjan Bussink*
 
-*   No changes.
+*   Deprecate `config.active_storage.replace_on_assign_to_many`. Future versions of Rails
+    will behave the same way as when the config is set to `true`.
 
+    *Santiago Bartesaghi*
 
-## Rails 6.1.1 (January 07, 2021) ##
+*   Remove deprecated methods: `build_after_upload`, `create_after_upload!` in favor of `create_and_upload!`,
+    and `service_url` in favor of `url`.
 
-*   Fix S3 multipart uploads when threshold is larger than file.
+    *Santiago Bartesaghi*
 
-    *Matt Muller*
+*   Add support of `strict_loading_by_default` to `ActiveStorage::Representations` controllers.
 
+    *Anton Topchii*, *Andrew White*
 
-## Rails 6.1.0 (December 09, 2020) ##
+*   Allow to detach an attachment when record is not persisted.
 
-*   Change default queue name of the analysis (`:active_storage_analysis`) and
-    purge (`:active_storage_purge`) jobs to be the job adapter's default (`:default`).
+    *Jacopo Beschi*
 
-    *Rafael Mendonça França*
+*   Use libvips instead of ImageMagick to analyze images when `active_storage.variant_processor = vips`.
 
-*   Implement `strict_loading` on ActiveStorage associations.
+    *Breno Gazzola*
 
-    *David Angulo*
+*   Add metadata value for presence of video channel in video blobs.
 
-*   Remove deprecated support to pass `:combine_options` operations to `ActiveStorage::Transformers::ImageProcessing`.
+    The `metadata` attribute of video blobs has a new boolean key named `video` that is set to
+    `true` if the file has an video channel and `false` if it doesn't.
 
-    *Rafael Mendonça França*
+    *Breno Gazzola*
 
-*   Remove deprecated `ActiveStorage::Transformers::MiniMagickTransformer`.
+*   Deprecate usage of `purge` and `purge_later` from the association extension.
 
-    *Rafael Mendonça França*
+    *Jacopo Beschi*
 
-*   Remove deprecated `config.active_storage.queue`.
+*   Passing extra parameters in `ActiveStorage::Blob#url` to S3 Client.
 
-    *Rafael Mendonça França*
+    This allows calls of `ActiveStorage::Blob#url` to have more interaction with
+    the S3 Presigner, enabling, amongst other options, custom S3 domain URL
+    Generation.
 
-*   Remove deprecated `ActiveStorage::Downloading`.
+    ```ruby
+    blob = ActiveStorage::Blob.last
 
-    *Rafael Mendonça França*
+    blob.url # => https://<bucket-name>.s3.<region>.amazonaws.com/<key>
+    blob.url(virtual_host: true) # => # => https://<bucket-name>/<key>
+    ```
 
-*   Add per-environment configuration support
+    *josegomezr*
 
-    *Pietro Moro*
+*   Allow setting a `Cache-Control` on files uploaded to GCS.
 
-*   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.
+    ```yaml
+    gcs:
+      service: GCS
+      ...
+      cache_control: "public, max-age=3600"
+    ```
 
-    *Vincent Robert*
+    *maleblond*
 
-*   Touch parent model when an attachment is purged.
+*   The parameters sent to `ffmpeg` for generating a video preview image are now
+    configurable under `config.active_storage.video_preview_arguments`.
 
-    *Víctor Pérez Rodríguez*
+    *Brendon Muir*
 
-*   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:
+*   The ActiveStorage video previewer will now use scene change detection to generate
+    better preview images (rather than the previous default of using the first frame
+    of the video). This change requires FFmpeg v3.4+.
 
-    ```erb
-    <%= image_tag rails_storage_proxy_path(@user.avatar) %>
-    ```
+    *Jonathan Hefner*
 
-    To proxy by default, set `config.active_storage.resolve_model_to_route`:
+*   Add support for ActiveStorage expiring URLs.
 
     ```ruby
-    # Proxy attached files instead.
-    config.active_storage.resolve_model_to_route = :rails_storage_proxy
-    ```
+    rails_blob_path(user.avatar, disposition: "attachment", expires_in: 30.minutes)
 
-    ```erb
-    <%= image_tag @user.avatar %>
+    <%= image_tag rails_blob_path(user.avatar.variant(resize: "100x100"), expires_in: 30.minutes) %>
     ```
 
-    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:
-
-    ```erb
-    <%= image_tag rails_storage_redirect_path(@user.avatar) %>
-    ```
-
-    *Jonathan Fleckenstein*
-
-*   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.
+    If you want to set default expiration time for ActiveStorage URLs throughout your application, set `config.active_storage.urls_expire_in`.
 
-    *Jeroen van Haperen*
+    *aki77*
 
-*   Add support for creating variants of `WebP` images out of the box.
+*   Allow to purge an attachment when record is not persisted for `has_many_attached`.
 
-    *Dino Maric*
+    *Jacopo Beschi*
 
-*   Only enqueue analysis jobs for blobs with non-null analyzer classes.
+*   Add `with_all_variant_records` method to eager load all variant records on an attachment at once.
+    `with_attached_image` scope now eager loads variant records if using variant tracking.
 
-    *Gannon McGibbon*
-
-*   Previews are created on the same service as the original blob.
-
-    *Peter Zhu*
+    *Alex Ghiculescu*
 
-*   Remove unused `disposition` and `content_type` query parameters for `DiskService`.
+*   Add metadata value for presence of audio channel in video blobs.
 
-    *Peter Zhu*
+    The `metadata` attribute of video blobs has a new boolean key named `audio` that is set to
+    `true` if the file has an audio channel and `false` if it doesn't.
 
-*   Use `DiskController` for both public and private files.
+    *Breno Gazzola*
 
-    `DiskController` is able to handle multiple services by adding a
-    `service_name` field in the generated URL in `DiskService`.
+*   Adds analyzer for audio files.
 
-    *Peter Zhu*
+    *Breno Gazzola*
 
-*   Variants are tracked in the database to avoid existence checks in the storage service.
+*   Respect Active Record's primary_key_type in Active Storage migrations.
 
-    *George Claghorn*
+    *fatkodima*
 
-*   Deprecate `service_url` methods in favour of `url`.
+*   Allow `expires_in` for ActiveStorage signed ids.
 
-    Deprecate `Variant#service_url` and `Preview#service_url` to instead use
-    `#url` method to be consistent with `Blob`.
+    *aki77*
 
-    *Peter Zhu*
+*   Allow to purge an attachment when record is not persisted for `has_one_attached`.
 
-*   Permanent URLs for public storage blobs.
+    *Jacopo Beschi*
 
-    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.
+*   Add a load hook called `active_storage_variant_record` (providing `ActiveStorage::VariantRecord`)
+    to allow for overriding aspects of the `ActiveStorage::VariantRecord` class. This makes
+    `ActiveStorage::VariantRecord` consistent with `ActiveStorage::Blob` and `ActiveStorage::Attachment`
+    that already have load hooks.
 
-    Deprecates `Blob#service_url` in favor of `Blob#url`.
+    *Brendon Muir*
 
-    *Peter Zhu*
+*   `ActiveStorage::PreviewError` is raised when a previewer is unable to generate a preview image.
 
-*   Make services aware of configuration names.
+    *Alex Robbin*
 
-    *Gannon McGibbon*
+*   Add `ActiveStorage::Streaming` module that can be included in a controller to get access to `#send_blob_stream`,
+    which wraps the new `ActionController::Base#send_stream` method to stream a blob from cloud storage:
 
-*   The `Content-Type` header is set on image variants when they're uploaded to third-party storage services.
+    ```ruby
+    class MyPublicBlobsController < ApplicationController
+      include ActiveStorage::SetBlob, ActiveStorage::Streaming
+
+      def show
+        http_cache_forever(public: true) do
+          send_blob_stream @blob, disposition: params[:disposition]
+        end
+      end
+    end
+    ```
 
-    *Kyle Ribordy*
+    *DHH*
 
-*   Allow storage services to be configured per attachment.
+*   Add ability to use pre-defined variants.
 
     ```ruby
     class User < ActiveRecord::Base
-      has_one_attached :avatar, service: :s3
+      has_one_attached :avatar do |attachable|
+        attachable.variant :thumb, resize: "100x100"
+        attachable.variant :medium, resize: "300x300", monochrome: true
+      end
     end
 
     class Gallery < ActiveRecord::Base
-      has_many_attached :photos, service: :s3
+      has_many_attached :photos do |attachable|
+        attachable.variant :thumb, resize: "100x100"
+        attachable.variant :medium, resize: "300x300", monochrome: true
+      end
     end
-    ```
-
-    *Dmitry Tsepelev*
 
-*   You can optionally provide a custom blob key when attaching a new file:
-
-    ```ruby
-    user.avatar.attach key: "avatars/#{user.id}.jpg",
-      io: io, content_type: "image/jpeg", filename: "avatar.jpg"
+    <%= image_tag user.avatar.variant(:thumb) %>
     ```
 
-    Active Storage will store the blob's data on the configured service at the provided key.
-
-    *George Claghorn*
-
-*   Replace `Blob.create_after_upload!` with `Blob.create_and_upload!` and deprecate the former.
-
-    `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*
-
-*   Set content disposition in direct upload using `filename` and `disposition` parameters to `ActiveStorage::Service#headers_for_direct_upload`.
-
-    *Peter Zhu*
-
-*   Allow record to be optionally passed to blob finders to make sharding
-    easier.
-
-    *Gannon McGibbon*
-
-*   Switch from `azure-storage` gem to `azure-storage-blob` gem for Azure service.
+    *fatkodima*
 
-    *Peter Zhu*
+*   After setting `config.active_storage.resolve_model_to_route = :rails_storage_proxy`
+    `rails_blob_path` and `rails_representation_path` will generate proxy URLs by default.
 
-*   Add `config.active_storage.draw_routes` to disable Active Storage routes.
+    *Ali Ismayilov*
 
-    *Gannon McGibbon*
-
-*   Image analysis is skipped if ImageMagick returns an error.
-
-    `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*
-
-*   Method calls on singular attachments return `nil` when no file is attached.
-
-    Previously, assuming the following User model, `user.avatar.filename` would
-    raise a `Module::DelegationError` if no avatar was attached:
-
-    ```ruby
-    class User < ApplicationRecord
-      has_one_attached :avatar
-    end
-    ```
-
-    They now return `nil`.
-
-    *Matthew Tanous*
-
-*   The mirror service supports direct uploads.
-
-    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.
-
-    Configure the queue used to process mirroring jobs by setting
-    `config.active_storage.queues.mirror`. The default is `:active_storage_mirror`.
-
-    *George Claghorn*
-
-*   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 %>
-    ```
+*   Declare `ActiveStorage::FixtureSet` and `ActiveStorage::FixtureSet.blob` to
+    improve fixture integration.
 
-    *George Claghorn*
+    *Sean Doyle*
 
 
-Please check [6-0-stable](https://github.com/rails/rails/blob/6-0-stable/activestorage/CHANGELOG.md) for previous changes.
+Please check [6-1-stable](https://github.com/rails/rails/blob/6-1-stable/activestorage/CHANGELOG.md) for previous changes.

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2017-2020 David Heinemeier Hansson, Basecamp
+Copyright (c) 2017-2021 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

@@ -32,7 +32,7 @@ class User < ApplicationRecord
 end
 
 # Attach an avatar to the user.
-user.avatar.attach(io: File.open("/path/to/face.jpg"), filename: "face.jpg", content_type: "image/jpg")
+user.avatar.attach(io: File.open("/path/to/face.jpg"), filename: "face.jpg", content_type: "image/jpeg")
 
 # Does the user have an avatar?
 user.avatar.attached? # => true
@@ -88,8 +88,7 @@ class MessagesController < ApplicationController
   end
 
   def create
-    message = Message.create! params.require(:message).permit(:title, :content)
-    message.images.attach(params[:message][:images])
+    message = Message.create! params.require(:message).permit(:title, :content, images: [])
     redirect_to message
   end
 
@@ -124,27 +123,42 @@ When the application is configured to proxy files by default, use the `rails_sto
 
 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:
+You can 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
 ```
 
+Or if you want to explicitly proxy specific attachments there are URL helpers you can use in the form of `rails_storage_proxy_path` and `rails_storage_proxy_url`.
+
+```erb
+<%= image_tag rails_storage_proxy_path(@user.avatar) %>
+```
+
 ## Direct uploads
 
 Active Storage, with its included JavaScript library, supports uploading directly from the client to the cloud.
 
 ### Direct upload installation
 
-1. Include `activestorage.js` in your application's JavaScript bundle.
+1. Include the Active Storage JavaScript in your application's JavaScript bundle or reference it directly.
 
+    Requiring directly without bundling through the asset pipeline in the application html with autostart:
+    ```html
+    <%= javascript_include_tag "activestorage" %>
+    ```
+    Requiring via importmap-rails without bundling through the asset pipeline in the application html without autostart as ESM:
+    ```ruby
+    # config/importmap.rb
+    pin "@rails/activestorage", to: "activestorage.esm.js"
+    ```
+    ```html
+    <script type="module-shim">
+      import * as ActiveStorage from "@rails/activestorage"
+      ActiveStorage.start()
+    </script>
+    ```
     Using the asset pipeline:
     ```js
     //= require activestorage