ruby-on-quails 0.1.0

data/activestorage/app/models/active_storage/variant.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+# Image blobs can have variants that are the result of a set of transformations applied to the original.
+# These variants are used to create thumbnails, fixed-size avatars, or any other derivative image from the
+# original.
+#
+# Variants rely on {MiniMagick}[https://github.com/minimagick/minimagick] for the actual transformations
+# of the file, so you must add <tt>gem "mini_magick"</tt> to your Gemfile if you wish to use variants.
+#
+# Note that to create a variant it's necessary to download the entire blob file from the service and load it
+# into memory. The larger the image, the more memory is used. Because of this process, you also want to be
+# considerate about when the variant is actually processed. You shouldn't be processing variants inline in a
+# template, for example. Delay the processing to an on-demand controller, like the one provided in
+# ActiveStorage::VariantsController.
+#
+# To refer to such a delayed on-demand variant, simply link to the variant through the resolved route provided
+# by Active Storage like so:
+#
+#   <%= image_tag url_for(Current.user.avatar.variant(resize: "100x100")) %>
+#
+# This will create a URL for that specific blob with that specific variant, which the ActiveStorage::VariantsController
+# can then produce on-demand.
+#
+# When you do want to actually produce the variant needed, call +processed+. This will check that the variant
+# has already been processed and uploaded to the service, and, if so, just return that. Otherwise it will perform
+# the transformations, upload the variant to the service, and return itself again. Example:
+#
+#   avatar.variant(resize: "100x100").processed.service_url
+#
+# This will create and process a variant of the avatar blob that's constrained to a height and width of 100.
+# Then it'll upload said variant to the service according to a derivative key of the blob and the transformations.
+#
+# A list of all possible transformations is available at https://www.imagemagick.org/script/mogrify.php. You can
+# combine as many as you like freely:
+#
+#   avatar.variant(resize: "100x100", monochrome: true, flip: "-90")
+class ActiveStorage::Variant
+  attr_reader :blob, :variation
+  delegate :service, to: :blob
+
+  def initialize(blob, variation)
+    @blob, @variation = blob, variation
+  end
+
+  # Returns the variant instance itself after it's been processed or an existing processing has been found on the service.
+  def processed
+    process unless processed?
+    self
+  end
+
+  # Returns a combination key of the blob and the variation that together identifies a specific variant.
+  def key
+    "variants/#{blob.key}/#{variation.key}"
+  end
+
+  # Returns the URL of the variant on the service. This URL is intended to be short-lived for security and not used directly
+  # with users. Instead, the +service_url+ should only be exposed as a redirect from a stable, possibly authenticated URL.
+  # Hiding the +service_url+ behind a redirect also gives you the power to change services without updating all URLs. And
+  # it allows permanent URLs that redirect to the +service_url+ to be cached in the view.
+  #
+  # Use <tt>url_for(variant)</tt> (or the implied form, like +link_to variant+ or +redirect_to variant+) to get the stable URL
+  # for a variant that points to the ActiveStorage::VariantsController, which in turn will use this +service_call+ method
+  # for its redirection.
+  def service_url(expires_in: 5.minutes, disposition: :inline)
+    service.url key, expires_in: expires_in, disposition: disposition, filename: blob.filename, content_type: blob.content_type
+  end
+
+
+  private
+    def processed?
+      service.exist?(key)
+    end
+
+    def process
+      service.upload key, transform(service.download(blob.key))
+    end
+
+    def transform(io)
+      require "mini_magick"
+      File.open MiniMagick::Image.read(io).tap { |image| variation.transform(image) }.path
+    end
+end

data/activestorage/app/models/active_storage/variation.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/object/inclusion"
+
+# A set of transformations that can be applied to a blob to create a variant. This class is exposed via
+# the ActiveStorage::Blob#variant method and should rarely be used directly.
+#
+# In case you do need to use this directly, it's instantiated using a hash of transformations where
+# the key is the command and the value is the arguments. Example:
+#
+#   ActiveStorage::Variation.new(resize: "100x100", monochrome: true, trim: true, rotate: "-90")
+#
+# A list of all possible transformations is available at https://www.imagemagick.org/script/mogrify.php.
+class ActiveStorage::Variation
+  attr_reader :transformations
+
+  class << self
+    # Returns a variation instance with the transformations that were encoded by +encode+.
+    def decode(key)
+      new ActiveStorage.verifier.verify(key, purpose: :variation)
+    end
+
+    # Returns a signed key for the +transformations+, which can be used to refer to a specific
+    # variation in a URL or combined key (like <tt>ActiveStorage::Variant#key</tt>).
+    def encode(transformations)
+      ActiveStorage.verifier.generate(transformations, purpose: :variation)
+    end
+  end
+
+  def initialize(transformations)
+    @transformations = transformations
+  end
+
+  # Accepts an open MiniMagick image instance, like what's returned by <tt>MiniMagick::Image.read(io)</tt>,
+  # and performs the +transformations+ against it. The transformed image instance is then returned.
+  def transform(image)
+    transformations.each do |(method, argument)|
+      if eligible_argument?(argument)
+        image.public_send(method, argument)
+      else
+        image.public_send(method)
+      end
+    end
+  end
+
+  # Returns a signed key for all the +transformations+ that this variation was instantiated with.
+  def key
+    self.class.encode(transformations)
+  end
+
+  private
+    def eligible_argument?(argument)
+      argument.present? && argument != true
+    end
+end

data/activestorage/bin/test

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+COMPONENT_ROOT = File.expand_path("..", __dir__)
+require_relative "../../tools/test"

data/activestorage/config/routes.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+Quails.application.routes.draw do
+  get "/quails/active_storage/blobs/:signed_id/*filename" => "active_storage/blobs#show", as: :quails_service_blob
+
+  direct :quails_blob do |blob|
+    route_for(:quails_service_blob, blob.signed_id, blob.filename)
+  end
+
+  resolve("ActiveStorage::Blob")       { |blob| route_for(:quails_blob, blob) }
+  resolve("ActiveStorage::Attachment") { |attachment| route_for(:quails_blob, attachment.blob) }
+
+
+  get "/quails/active_storage/variants/:signed_blob_id/:variation_key/*filename" => "active_storage/variants#show", as: :quails_blob_variation
+
+  direct :quails_variant do |variant|
+    signed_blob_id = variant.blob.signed_id
+    variation_key  = variant.variation.key
+    filename       = variant.blob.filename
+
+    route_for(:quails_blob_variation, signed_blob_id, variation_key, filename)
+  end
+
+  resolve("ActiveStorage::Variant") { |variant| route_for(:quails_variant, variant) }
+
+
+  get  "/quails/active_storage/disk/:encoded_key/*filename" => "active_storage/disk#show", as: :quails_disk_service
+  put  "/quails/active_storage/disk/:encoded_token" => "active_storage/disk#update", as: :update_quails_disk_service
+  post "/quails/active_storage/direct_uploads" => "active_storage/direct_uploads#create", as: :quails_direct_uploads
+end

data/activestorage/db/migrate/20170806125915_create_active_storage_tables.rb

@@ -0,0 +1,25 @@
+class CreateActiveStorageTables < ActiveRecord::Migration[5.2]
+  def change
+    create_table :active_storage_blobs do |t|
+      t.string   :key,        null: false
+      t.string   :filename,   null: false
+      t.string   :content_type
+      t.text     :metadata
+      t.bigint   :byte_size,  null: false
+      t.string   :checksum,   null: false
+      t.datetime :created_at, null: false
+
+      t.index [ :key ], unique: true
+    end
+
+    create_table :active_storage_attachments do |t|
+      t.string     :name,     null: false
+      t.references :record,   null: false, polymorphic: true, index: false
+      t.references :blob,     null: false
+
+      t.datetime :created_at, null: false
+
+      t.index [ :record_type, :record_id, :name, :blob_id ], name: "index_active_storage_attachments_uniqueness", unique: true
+    end
+  end
+end

data/activestorage/lib/active_storage.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+#--
+# Copyright (c) 2017 David Heinemeier Hansson
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#++
+
+require "active_record"
+require "active_support"
+require "active_support/quails"
+require_relative "active_storage/version"
+
+module ActiveStorage
+  extend ActiveSupport::Autoload
+
+  autoload :Attached
+  autoload :Service
+
+  mattr_accessor :verifier
+end

data/activestorage/lib/active_storage/attached.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "action_dispatch"
+require "action_dispatch/http/upload"
+require "active_support/core_ext/module/delegation"
+
+module ActiveStorage
+  # Abstract base class for the concrete ActiveStorage::Attached::One and ActiveStorage::Attached::Many
+  # classes that both provide proxy access to the blob association for a record.
+  class Attached
+    attr_reader :name, :record, :dependent
+
+    def initialize(name, record, dependent:)
+      @name, @record, @dependent = name, record, dependent
+    end
+
+    private
+      def create_blob_from(attachable)
+        case attachable
+        when ActiveStorage::Blob
+          attachable
+        when ActionDispatch::Http::UploadedFile, Rack::Test::UploadedFile
+          ActiveStorage::Blob.create_after_upload! \
+            io: attachable.open,
+            filename: attachable.original_filename,
+            content_type: attachable.content_type
+        when Hash
+          ActiveStorage::Blob.create_after_upload!(attachable)
+        when String
+          ActiveStorage::Blob.find_signed(attachable)
+        else
+          nil
+        end
+      end
+  end
+end
+
+require "active_storage/attached/one"
+require "active_storage/attached/many"
+require "active_storage/attached/macros"

data/activestorage/lib/active_storage/attached/macros.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module ActiveStorage
+  # Provides the class-level DSL for declaring that an Active Record model has attached blobs.
+  module Attached::Macros
+    # Specifies the relation between a single attachment and the model.
+    #
+    #   class User < ActiveRecord::Base
+    #     has_one_attached :avatar
+    #   end
+    #
+    # There is no column defined on the model side, Active Storage takes
+    # care of the mapping between your records and the attachment.
+    #
+    # Under the covers, this relationship is implemented as a +has_one+ association to a
+    # ActiveStorage::Attachment record and a +has_one-through+ association to a
+    # ActiveStorage::Blob record. These associations are available as +avatar_attachment+
+    # and +avatar_blob+. But you shouldn't need to work with these associations directly in
+    # most circumstances.
+    #
+    # The system has been designed to having you go through the ActiveStorage::Attached::One
+    # proxy that provides the dynamic proxy to the associations and factory methods, like +attach+.
+    #
+    # If the +:dependent+ option isn't set, the attachment will be purged
+    # (i.e. destroyed) whenever the record is destroyed.
+    def has_one_attached(name, dependent: :purge_later)
+      class_eval <<-CODE, __FILE__, __LINE__ + 1
+        def #{name}
+          @active_storage_attached_#{name} ||= ActiveStorage::Attached::One.new("#{name}", self, dependent: #{dependent == :purge_later ? ":purge_later" : "false"})
+        end
+      CODE
+
+      has_one :"#{name}_attachment", -> { where(name: name) }, class_name: "ActiveStorage::Attachment", as: :record
+      has_one :"#{name}_blob", through: :"#{name}_attachment", class_name: "ActiveStorage::Blob", source: :blob
+
+      if dependent == :purge_later
+        before_destroy { public_send(name).purge_later }
+      end
+    end
+
+    # Specifies the relation between multiple attachments and the model.
+    #
+    #   class Gallery < ActiveRecord::Base
+    #     has_many_attached :photos
+    #   end
+    #
+    # There are no columns defined on the model side, Active Storage takes
+    # care of the mapping between your records and the attachments.
+    #
+    # To avoid N+1 queries, you can include the attached blobs in your query like so:
+    #
+    #   Gallery.where(user: Current.user).with_attached_photos
+    #
+    # Under the covers, this relationship is implemented as a +has_many+ association to a
+    # ActiveStorage::Attachment record and a +has_many-through+ association to a
+    # ActiveStorage::Blob record. These associations are available as +photos_attachments+
+    # and +photos_blobs+. But you shouldn't need to work with these associations directly in
+    # most circumstances.
+    #
+    # The system has been designed to having you go through the ActiveStorage::Attached::Many
+    # proxy that provides the dynamic proxy to the associations and factory methods, like +#attach+.
+    #
+    # If the +:dependent+ option isn't set, all the attachments will be purged
+    # (i.e. destroyed) whenever the record is destroyed.
+    def has_many_attached(name, dependent: :purge_later)
+      class_eval <<-CODE, __FILE__, __LINE__ + 1
+        def #{name}
+          @active_storage_attached_#{name} ||= ActiveStorage::Attached::Many.new("#{name}", self, dependent: #{dependent == :purge_later ? ":purge_later" : "false"})
+        end
+      CODE
+
+      has_many :"#{name}_attachments", -> { where(name: name) }, as: :record, class_name: "ActiveStorage::Attachment"
+      has_many :"#{name}_blobs", through: :"#{name}_attachments", class_name: "ActiveStorage::Blob", source: :blob
+
+      scope :"with_attached_#{name}", -> { includes("#{name}_attachments": :blob) }
+
+      if dependent == :purge_later
+        before_destroy { public_send(name).purge_later }
+      end
+    end
+  end
+end

data/activestorage/lib/active_storage/attached/many.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module ActiveStorage
+  # Decorated proxy object representing of multiple attachments to a model.
+  class Attached::Many < Attached
+    delegate_missing_to :attachments
+
+    # Returns all the associated attachment records.
+    #
+    # All methods called on this proxy object that aren't listed here will automatically be delegated to +attachments+.
+    def attachments
+      record.public_send("#{name}_attachments")
+    end
+
+    # Associates one or several attachments with the current record, saving them to the database.
+    # Examples:
+    #
+    #   document.images.attach(params[:images]) # Array of ActionDispatch::Http::UploadedFile objects
+    #   document.images.attach(params[:signed_blob_id]) # Signed reference to blob from direct upload
+    #   document.images.attach(io: File.open("~/racecar.jpg"), filename: "racecar.jpg", content_type: "image/jpg")
+    #   document.images.attach([ first_blob, second_blob ])
+    def attach(*attachables)
+      attachables.flatten.collect do |attachable|
+        attachments.create!(name: name, blob: create_blob_from(attachable))
+      end
+    end
+
+    # Returns true if any attachments has been made.
+    #
+    #   class Gallery < ActiveRecord::Base
+    #     has_many_attached :photos
+    #   end
+    #
+    #   Gallery.new.photos.attached? # => false
+    def attached?
+      attachments.any?
+    end
+
+    # Directly purges each associated attachment (i.e. destroys the blobs and
+    # attachments and deletes the files on the service).
+    def purge
+      if attached?
+        attachments.each(&:purge)
+        attachments.reload
+      end
+    end
+
+    # Purges each associated attachment through the queuing system.
+    def purge_later
+      if attached?
+        attachments.each(&:purge_later)
+      end
+    end
+  end
+end

data/activestorage/lib/active_storage/attached/one.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module ActiveStorage
+  # Representation of a single attachment to a model.
+  class Attached::One < Attached
+    delegate_missing_to :attachment
+
+    # Returns the associated attachment record.
+    #
+    # You don't have to call this method to access the attachment's methods as
+    # they are all available at the model level.
+    def attachment
+      record.public_send("#{name}_attachment")
+    end
+
+    # Associates a given attachment with the current record, saving it to the database.
+    # Examples:
+    #
+    #   person.avatar.attach(params[:avatar]) # ActionDispatch::Http::UploadedFile object
+    #   person.avatar.attach(params[:signed_blob_id]) # Signed reference to blob from direct upload
+    #   person.avatar.attach(io: File.open("~/face.jpg"), filename: "face.jpg", content_type: "image/jpg")
+    #   person.avatar.attach(avatar_blob) # ActiveStorage::Blob object
+    def attach(attachable)
+      if attached? && dependent == :purge_later
+        replace attachable
+      else
+        write_attachment create_attachment_from(attachable)
+      end
+    end
+
+    # Returns +true+ if an attachment has been made.
+    #
+    #   class User < ActiveRecord::Base
+    #     has_one_attached :avatar
+    #   end
+    #
+    #   User.new.avatar.attached? # => false
+    def attached?
+      attachment.present?
+    end
+
+    # Directly purges the attachment (i.e. destroys the blob and
+    # attachment and deletes the file on the service).
+    def purge
+      if attached?
+        attachment.purge
+        write_attachment nil
+      end
+    end
+
+    # Purges the attachment through the queuing system.
+    def purge_later
+      if attached?
+        attachment.purge_later
+      end
+    end
+
+    private
+      def replace(attachable)
+        blob.tap do
+          transaction do
+            destroy
+            write_attachment create_attachment_from(attachable)
+          end
+        end.purge_later
+      end
+
+      def create_attachment_from(attachable)
+        ActiveStorage::Attachment.create!(record: record, name: name, blob: create_blob_from(attachable))
+      end
+
+      def write_attachment(attachment)
+        record.public_send("#{name}_attachment=", attachment)
+      end
+  end
+end