activestorage 5.2.4.rc1 → 6.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 559e9060c795a26d5257347fac7963777e9761e9815264f56361e7f9ef99d2c5
-  data.tar.gz: 145db20b023b128a55484f484807e308a3f15985d6343fcaf6e4d6713507ab94
+  metadata.gz: c76cc0190a59a7e19312ae68c2b6c3712f62eca50d9fa4d287cdc6feca94a5aa
+  data.tar.gz: 6d8f47c3d81c83b98b0dfc254a6e9fe6ae9b447501db6176cb96691ceb77c61c
 SHA512:
-  metadata.gz: f3fa788f237112d6a997c8bf587b4669fadce5a9d2bb97403a85b2fcce15830bcacb24f0c6e3d5eaf4387f4c0d577f105f69104ef59f65fac93cb633898deb44
-  data.tar.gz: 7e65b559068720a3e706b6c41737a6446c7363b023f143f1052fc6f4fb2febe5d7d67e8054a01accc899ce7b245480f49322eb43d6f49062d246e2b88f4c7298
+  metadata.gz: a86e9a4fd481f1aa56946f24ff7e02869fe6591952929021e5c46428b230a34f18f324847db51eb0ebfd17ed8f43fb61f215798997766d072a6dbf51de21369d
+  data.tar.gz: 0231fa7771d92de8b9a9012291d69e2c5b976af3fa3f932c5fd0331f9cccd76ad90887d1101f96d47a6c7949832dabff1f1011412ab27a4a4ed76091ba851e10

data/CHANGELOG.md

@@ -1,122 +1,159 @@
-## Rails 5.2.4.rc1 (November 22, 2019) ##
+## Rails 6.0.0.beta1 (January 18, 2019) ##
 
-*   No changes.
+*   Replace `config.active_storage.queue` with two options that indicate which
+    queues analysis and purge jobs should use, respectively:
 
+    * `config.active_storage.queues.analysis`
+    * `config.active_storage.queues.purge`
 
-## Rails 5.2.3 (March 27, 2019) ##
-
-*   No changes.
+    `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.
 
+    *George Claghorn*
 
-## Rails 5.2.2.1 (March 11, 2019) ##
+*   Permit generating variants of TIFF images.
 
-*   No changes.
+    *Luciano Sousa*
 
+*   Use base36 (all lowercase) for all new Blob keys to prevent
+    collisions and undefined behavior with case-insensitive filesystems and
+    database indices.
 
-## Rails 5.2.2 (December 04, 2018) ##
+    *Julik Tarkhanov*
 
-*   Support multiple submit buttons in Active Storage forms.
+*   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`.
 
-    *Chrıs Seelus*
+    *Cameron Bothner*
 
 *   Fix `ArgumentError` when uploading to amazon s3
 
     *Hiroki Sanpei*
 
-*   Add a foreign-key constraint to the `active_storage_attachments` table for blobs.
-
-    *George Claghorn*
+*   Add progressive JPG to default list of variable content types
 
-*   Discard `ActiveStorage::PurgeJobs` for missing blobs.
+    *Maurice Kühlborn*
 
-    *George Claghorn*
+*   Add `ActiveStorage.routes_prefix` for configuring generated routes.
 
-*   Fix uploading Tempfiles to Azure Storage.
+    *Chris Bisnett*
 
-    *George Claghorn*
+*   `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.
 
+    *Cameron Bothner*
 
-## Rails 5.2.1.1 (November 27, 2018) ##
+*   `ActiveStorage::DiskController#show` generates a 404 Not Found response when
+    the requested file is missing from the disk service. It previously raised
+    `Errno::ENOENT`.
 
-*   Prevent content type and disposition bypass in storage service URLs.
+    *Cameron Bothner*
 
-    Fix CVE-2018-16477.
+*   `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`.
 
-    *Rosa Gutierrez*
+    *Cameron Bothner*
 
-
-## Rails 5.2.1 (August 07, 2018) ##
-
-*   Fix direct upload with zero-byte files.
+*   Added the `ActiveStorage::SetCurrent` concern for custom Active Storage
+    controllers that can't inherit from `ActiveStorage::BaseController`.
 
     *George Claghorn*
 
-*   Exclude JSON root from `active_storage/direct_uploads#create` response.
+*   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.
 
-    *Javan Makhmali*
+    *Andrei Makarov*, *George Claghorn*
 
+*   Uploaded files assigned to a record are persisted to storage when the record
+    is saved instead of immediately.
 
-## Rails 5.2.0 (April 09, 2018) ##
+    In Rails 5.2, the following causes an uploaded file in `params[:avatar]` to
+    be stored:
 
-*   Allow full use of the AWS S3 SDK options for authentication. If an
-    explicit AWS key pair and/or region is not provided in `storage.yml`,
-    attempt to use environment variables, shared credentials, or IAM
-    (instance or task) role credentials. Order of precedence is determined
-    by the [AWS SDK](https://docs.aws.amazon.com/sdk-for-ruby/v3/developer-guide/setup-config.html).
+    ```ruby
+    @user.avatar = params[:avatar]
+    ```
 
-    *Brian Knight*
+    In Rails 6, the uploaded file is stored when `@user` is successfully saved.
 
-*   Remove path config option from Azure service.
+    *George Claghorn*
 
-    The Active Storage service for Azure Storage has an option called `path`
-    that is ambiguous in meaning. It needs to be set to the primary blob
-    storage endpoint but that can be determined from the blobs client anyway.
+*   Add the ability to reflect on defined attachments using the existing
+    ActiveRecord reflection mechanism.
 
-    To simplify the configuration, we've removed the `path` option and
-    now get the endpoint from the blobs client instead.
+    *Kevin Deisz*
 
-    Closes #32225.
+*   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:
 
-    *Andrew White*
+    ```ruby
+      avatar.variant(monochrome: false)
+    ```
 
-*   Generate root-relative paths in disk service URL methods.
+    *Jacob Smith*
 
-    Obviate the disk service's `:host` configuration option.
+*   Generated attachment getter and setter methods are created
+    within the model's `GeneratedAssociationMethods` module to
+    allow overriding and composition using `super`.
 
-    *George Claghorn*
+    *Josh Susser*, *Jamon Douglas*
+
+*   Add `ActiveStorage::Blob#open`, which downloads a blob to a tempfile on disk
+    and yields the tempfile. Deprecate `ActiveStorage::Downloading`.
 
-*   Add source code to published npm package.
+    *David Robertson*, *George Claghorn*
 
-    This allows activestorage users to depend on the javascript source code
-    rather than the compiled code, which can produce smaller javascript bundles.
+*   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:
 
-    *Richard Macklin*
+    ```ruby
+      @message.image.attach(
+        io: File.open('/path/to/file'),
+        filename: 'file.pdf',
+        content_type: 'application/pdf',
+        identify: false
+      )
+    ```
 
-*   Preserve display aspect ratio when extracting width and height from videos
-    with rectangular samples in `ActiveStorage::Analyzer::VideoAnalyzer`.
+    *Ryan Davidson*
 
-    When a video contains a display aspect ratio, emit it in metadata as
-    `:display_aspect_ratio` rather than the ambiguous `:aspect_ratio`. Compute
-    its height by scaling its encoded frame width according to the DAR.
+*   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 `after_destroy_commit` instead of `before_destroy` for purging
-    attachments when a record is destroyed.
+*   Use the [ImageProcessing](https://github.com/janko-m/image_processing) gem
+    for Active Storage variants, and deprecate the MiniMagick backend.
 
-    *Hiroki Zenigami*
+    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.
 
-*   Force `:attachment` disposition for specific, configurable content types.
-    This mitigates possible security issues such as XSS or phishing when
-    serving them inline. A list of such content types is included by default,
-    and can be configured via `content_types_to_serve_as_binary`.
+    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`.
 
-    *Rosa Gutierrez*
+    *Janko Marohnić*
 
-*   Fix the gem adding the migrations files to the package.
+*   Rails 6 requires Ruby 2.5.0 or newer.
 
-    *Yuji Yaginuma*
+    *Jeremy Daer*, *Kasper Timm Hansen*
 
-*   Added to Rails.
 
-    *DHH*
+Please check [5-2-stable](https://github.com/rails/rails/blob/5-2-stable/activestorage/CHANGELOG.md) for previous changes.

data/MIT-LICENSE

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

@@ -4,11 +4,11 @@ Active Storage makes it simple to upload and reference files in cloud services l
 
 Files can be uploaded from the server to the cloud or directly from the client to the cloud.
 
-Image files can furthermore be transformed using on-demand variants for quality, aspect ratio, size, or any other [MiniMagick](https://github.com/minimagick/minimagick) supported transformation.
+Image files can furthermore be transformed using on-demand variants for quality, aspect ratio, size, or any other [MiniMagick](https://github.com/minimagick/minimagick) or [Vips](http://www.rubydoc.info/gems/ruby-vips/Vips/Image) supported transformation.
 
 ## 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/5-2-stable/activestorage/app/models/active_storage/blob.rb) and [Attachment](https://github.com/rails/rails/blob/5-2-stable/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).
 
@@ -16,6 +16,8 @@ A key difference to how Active Storage works compared to other attachment soluti
 
 Run `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`.
+
 ## Examples
 
 One attachment:
@@ -99,7 +101,7 @@ Variation of image attachment:
 
 ```erb
 <%# Hitting the variant URL will lazy transform the original blob and then redirect to its new service location %>
-<%= image_tag user.avatar.variant(resize: "100x100") %>
+<%= image_tag user.avatar.variant(resize_to_fit: [100, 100]) %>
 ```
 
 ## Direct uploads
@@ -116,8 +118,7 @@ Active Storage, with its included JavaScript library, supports uploading directl
     ```
     Using the npm package:
     ```js
-    import * as ActiveStorage from "activestorage"
-    ActiveStorage.start()
+    require("@rails/activestorage").start()
     ```
 2. Annotate file inputs with the direct upload URL.
 

data/app/assets/javascripts/activestorage.js

@@ -560,7 +560,10 @@
       this.xhr.setRequestHeader("Content-Type", "application/json");
       this.xhr.setRequestHeader("Accept", "application/json");
       this.xhr.setRequestHeader("X-Requested-With", "XMLHttpRequest");
-      this.xhr.setRequestHeader("X-CSRF-Token", getMetaValue("csrf-token"));
+      var csrfToken = getMetaValue("csrf-token");
+      if (csrfToken != undefined) {
+        this.xhr.setRequestHeader("X-CSRF-Token", csrfToken);
+      }
       this.xhr.addEventListener("load", function(event) {
         return _this.requestDidLoad(event);
       });

data/app/controllers/active_storage/base_controller.rb

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
 
-# The base controller for all ActiveStorage controllers.
+# The base class for all Active Storage controllers.
 class ActiveStorage::BaseController < ActionController::Base
-  protect_from_forgery with: :exception
+  include ActiveStorage::SetCurrent
 
-  before_action do
-    ActiveStorage::Current.host = request.base_url
-  end
+  protect_from_forgery with: :exception
 end

data/app/controllers/active_storage/blobs_controller.rb

@@ -8,7 +8,7 @@ class ActiveStorage::BlobsController < ActiveStorage::BaseController
   include ActiveStorage::SetBlob
 
   def show
-    expires_in ActiveStorage::Blob.service.url_expires_in
+    expires_in ActiveStorage.service_urls_expire_in
     redirect_to @blob.service_url(disposition: params[:disposition])
   end
 end

data/app/controllers/active_storage/disk_controller.rb

@@ -13,16 +13,19 @@ class ActiveStorage::DiskController < ActiveStorage::BaseController
     else
       head :not_found
     end
+  rescue Errno::ENOENT
+    head :not_found
   end
 
   def update
     if token = decode_verified_token
       if acceptable_content?(token)
         disk_service.upload token[:key], request.body, checksum: token[:checksum]
-        head :no_content
       else
         head :unprocessable_entity
       end
+    else
+      head :not_found
     end
   rescue ActiveStorage::IntegrityError
     head :unprocessable_entity

data/app/controllers/active_storage/representations_controller.rb

@@ -8,7 +8,7 @@ class ActiveStorage::RepresentationsController < ActiveStorage::BaseController
   include ActiveStorage::SetBlob
 
   def show
-    expires_in ActiveStorage::Blob.service.url_expires_in
+    expires_in ActiveStorage.service_urls_expire_in
     redirect_to @blob.representation(params[:variation_key]).processed.service_url(disposition: params[:disposition])
   end
 end

data/app/controllers/concerns/active_storage/set_current.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# Sets the <tt>ActiveStorage::Current.host</tt> attribute, which the disk service uses to generate URLs.
+# Include this concern in custom controllers that call ActiveStorage::Blob#service_url,
+# ActiveStorage::Variant#service_url, or ActiveStorage::Preview#service_url so the disk service can
+# generate URLs using the same host, protocol, and base path as the current request.
+module ActiveStorage::SetCurrent
+  extend ActiveSupport::Concern
+
+  included do
+    before_action do
+      ActiveStorage::Current.host = request.base_url
+    end
+  end
+end

data/app/javascript/activestorage/blob_record.js

@@ -17,7 +17,12 @@ export class BlobRecord {
     this.xhr.setRequestHeader("Content-Type", "application/json")
     this.xhr.setRequestHeader("Accept", "application/json")
     this.xhr.setRequestHeader("X-Requested-With", "XMLHttpRequest")
-    this.xhr.setRequestHeader("X-CSRF-Token", getMetaValue("csrf-token"))
+
+    const csrfToken = getMetaValue("csrf-token")
+    if (csrfToken != undefined) {
+      this.xhr.setRequestHeader("X-CSRF-Token", csrfToken)
+    }
+
     this.xhr.addEventListener("load", event => this.requestDidLoad(event))
     this.xhr.addEventListener("error", event => this.requestDidError(event))
   }

data/app/jobs/active_storage/analyze_job.rb

@@ -2,6 +2,10 @@
 
 # Provides asynchronous analysis of ActiveStorage::Blob records via ActiveStorage::Blob#analyze_later.
 class ActiveStorage::AnalyzeJob < ActiveStorage::BaseJob
+  queue_as { ActiveStorage.queues[:analysis] }
+
+  retry_on ActiveStorage::IntegrityError, attempts: 10, wait: :exponentially_longer
+
   def perform(blob)
     blob.analyze
   end

data/app/jobs/active_storage/base_job.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
 
 class ActiveStorage::BaseJob < ActiveJob::Base
-  queue_as { ActiveStorage.queue }
 end

data/app/jobs/active_storage/purge_job.rb

@@ -2,7 +2,10 @@
 
 # Provides asynchronous purging of ActiveStorage::Blob records via ActiveStorage::Blob#purge_later.
 class ActiveStorage::PurgeJob < ActiveStorage::BaseJob
+  queue_as { ActiveStorage.queues[:purge] }
+
   discard_on ActiveRecord::RecordNotFound
+  retry_on ActiveRecord::Deadlocked, attempts: 10, wait: :exponentially_longer
 
   def perform(blob)
     blob.purge

data/app/models/active_storage/attachment.rb

@@ -3,9 +3,8 @@
 require "active_support/core_ext/module/delegation"
 
 # Attachments associate records with blobs. Usually that's a one record-many blobs relationship,
-# but it is possible to associate many different records with the same blob. If you're doing that,
-# you'll want to declare with <tt>has_one/many_attached :thingy, dependent: false</tt>, so that destroying
-# any one record won't destroy the blob as well. (Then you'll need to do your own garbage collecting, though).
+# but it is possible to associate many different records with the same blob. A foreign-key constraint
+# on the attachments table prevents blobs from being purged if they’re still attached to any records.
 class ActiveStorage::Attachment < ActiveRecord::Base
   self.table_name = "active_storage_attachments"
 
@@ -15,17 +14,18 @@ class ActiveStorage::Attachment < ActiveRecord::Base
   delegate_missing_to :blob
 
   after_create_commit :analyze_blob_later, :identify_blob
+  after_destroy_commit :purge_dependent_blob_later
 
-  # Synchronously purges the blob (deletes it from the configured service) and destroys the attachment.
+  # Synchronously deletes the attachment and {purges the blob}[rdoc-ref:ActiveStorage::Blob#purge].
   def purge
-    destroy
-    blob.purge
+    delete
+    blob&.purge
   end
 
-  # Destroys the attachment and asynchronously purges the blob (deletes it from the configured service).
+  # Deletes the attachment and {enqueues a background job}[rdoc-ref:ActiveStorage::Blob#purge_later] to purge the blob.
   def purge_later
-    destroy
-    blob.purge_later
+    delete
+    blob&.purge_later
   end
 
   private
@@ -36,4 +36,13 @@ class ActiveStorage::Attachment < ActiveRecord::Base
     def analyze_blob_later
       blob.analyze_later unless blob.analyzed?
     end
+
+    def purge_dependent_blob_later
+      blob&.purge_later if dependent == :purge_later
+    end
+
+
+    def dependent
+      record.attachment_reflections[name]&.options[:dependent]
+    end
 end