alchemy-dragonfly-s3 4.0.2 → 5.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 331b499588960ebd9ead52ad551fba5e01677654abb26e069d0b368ad16817a1
-  data.tar.gz: 01ba7e860a18fd8e100a488734ead2fc0da2ae4448833a65a0214c19940e0aac
+  metadata.gz: fd52621f3cabb437a417a753748da31392a0b640a779701239a62a53ea27bd9a
+  data.tar.gz: f1e3494d61ceea61d20c42b55d8a63a4822ed4290a13e69496b20cb3a70de588
 SHA512:
-  metadata.gz: 24ef9c786345029787101b8c305f6c23b195c1721ca58db62272cc60107c96c443e45e3f40aa9b32ce04417430fe9c4e3781ae7c9701f8a6f50d34357267cd90
-  data.tar.gz: c5d7f63a95a2fe8d9094da62c913c0887ca855f8b48f185b6221ff32f0dd0c5139b889d3155717027895b63f8c884b01ea42fa74c5332a601738202e65449f77
+  metadata.gz: f2f6450f5ea35d076f86390f91916e655cc39854d133f51cde2a07951b8fcd61e9f93ad3e53b17536a4e21f7918b716b65e6b6b72b8866ce28145130369e0e99
+  data.tar.gz: bf2d9c707d32ed7419d0544618754759d8bdf1ba97cf199d3696c105eed47dd67bb9d3c4ee66c8d956403863c84d402cf9c8c4fe18d2ddb001bc50af684acef5

data/README.md

@@ -1,4 +1,4 @@
-[![Build Status](https://travis-ci.com/AlchemyCMS/alchemy-dragonfly-s3.svg?branch=alchemy-4)](https://travis-ci.com/AlchemyCMS/alchemy-dragonfly-s3)
+[![Build Status](https://travis-ci.com/AlchemyCMS/alchemy-dragonfly-s3.svg?branch=alchemy-5)](https://travis-ci.com/AlchemyCMS/alchemy-dragonfly-s3)
 
 # AlchemyCMS AWS S3
 
@@ -6,9 +6,10 @@ Adds support for file attachments and rendered Alchemy thumbnails stored on Amaz
 
 ## Alchemy Version
 
-This branch works with Alchemy 4 only.
+This branch works with Alchemy 5.0 only.
 
-- For a Alchemy 5 compatible version use the `master` branch.
+- For a Alchemy 5.1 compatible version use the `master` branch.
+- For a Alchemy 4 compatible version use the `alchemy-4` branch.
 - For a Alchemy 3.6 compatible version use the `alchemy-3` branch.
 
 ## Installation
@@ -16,7 +17,7 @@ This branch works with Alchemy 4 only.
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'alchemy-dragonfly-s3', github: 'AlchemyCMS/alchemy-dragonfly-s3', branch: 'alchemy-4'
+gem 'alchemy-dragonfly-s3', github: 'AlchemyCMS/alchemy-dragonfly-s3', branch: 'alchemy-5'
 ```
 
 And then execute:

data/app/assets/config/alchemy_dragonfly_s3_manifest.js

@@ -0,0 +1 @@
+//= link alchemy/missing-image.svg

data/app/assets/images/alchemy/missing-image.svg

@@ -0,0 +1 @@
+<svg aria-hidden="true" focusable="false" role="img" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512" width="16" height="16"><path fill="#f7f7f7" d="M569.517 440.013C587.975 472.007 564.806 512 527.94 512H48.054c-36.937 0-59.999-40.055-41.577-71.987L246.423 23.985c18.467-32.009 64.72-31.951 83.154 0l239.94 416.028zM288 354c-25.405 0-46 20.595-46 46s20.595 46 46 46 46-20.595 46-46-20.595-46-46-46zm-43.673-165.346l7.418 136c.347 6.364 5.609 11.346 11.982 11.346h48.546c6.373 0 11.635-4.982 11.982-11.346l7.418-136c.375-6.874-5.098-12.654-11.982-12.654h-63.383c-6.884 0-12.356 5.78-11.981 12.654z" class=""></path></svg>

data/app/models/alchemy/attachment/s3_url.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Alchemy
+  class Attachment < BaseRecord
+    class S3Url
+      def self.call(attachment)
+        attachment.file.remote_url
+      end
+    end
+  end
+end

data/app/models/alchemy/picture/s3_url.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Alchemy
+  class Picture < BaseRecord
+    class S3Url
+      attr_reader :variant
+
+      # @param [Alchemy::PictureVariant]
+      #
+      def initialize(variant)
+        raise ArgumentError, "Variant missing!" if variant.nil?
+
+        @variant = variant
+      end
+
+      def call(*)
+        return variant.image.remote_url unless processible_image?
+
+        ::Dragonfly.app(:alchemy_pictures).remote_url_for(uid)
+      end
+
+      private
+
+      def processible_image?
+        variant.image.is_a?(::Dragonfly::Job)
+      end
+
+      def uid
+        signature = PictureThumb::Signature.call(variant)
+        thumb = variant.picture.thumbs.detect { |t| t.signature == signature }
+        if thumb
+          uid = thumb.uid
+        else
+          uid = PictureThumb::Uid.call(signature, variant)
+          PictureThumb::Create.call(variant, signature, uid)
+        end
+        uid
+      end
+    end
+  end
+end

data/app/models/alchemy/picture_thumb.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Alchemy
+  # The persisted version of a rendered picture variant
+  #
+  class PictureThumb < BaseRecord
+    belongs_to :picture, class_name: "Alchemy::Picture"
+
+    validates :signature, presence: true
+    validates :uid, presence: true
+
+    class << self
+      # Upfront generation of picture thumbnails
+      #
+      # Called after a Alchemy::Picture has been created (after an image has been uploaded)
+      #
+      # Generates three types of thumbnails that are used by Alchemys picture archive and
+      # persists them in the configures file store (Default Dragonfly::FileDataStore).
+      #
+      # @see Picture::THUMBNAIL_SIZES
+      def generate_thumbs!(picture)
+        Alchemy::Picture::THUMBNAIL_SIZES.values.map do |size|
+          variant = Alchemy::PictureVariant.new(picture, {
+            size: size,
+            flatten: true,
+          })
+          signature = Alchemy::PictureThumb::Signature.call(variant)
+          thumb = find_by(signature: signature)
+          next if thumb
+
+          uid = Alchemy::PictureThumb::Uid.call(signature, variant)
+          Alchemy::PictureThumb::Create.call(variant, signature, uid)
+          uid
+        end
+      end
+    end
+  end
+end

data/app/models/alchemy/picture_thumb/create.rb

@@ -0,0 +1,28 @@
+module Alchemy
+  class PictureThumb < BaseRecord
+    # Stores the render result of a Alchemy::PictureVariant
+    # in the Dragonfly S3 datastore
+    #
+    class Create
+      def self.call(variant, signature, uid)
+        # create the thumb before uploading
+        # to prevent db race conditions
+        thumb = variant.picture.thumbs.create!(
+          picture: variant.picture,
+          signature: signature,
+          uid: uid,
+        )
+        begin
+          # fetch and process the image
+          image = variant.image
+          # upload the processed image
+          image.store(path: uid)
+        rescue RuntimeError, Excon::Error => e
+          Rails.logger.warn(e)
+          # destroy the thumb if processing or upload fails
+          thumb.destroy
+        end
+      end
+    end
+  end
+end

data/app/models/alchemy/picture_thumb/signature.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Alchemy
+  class PictureThumb < BaseRecord
+    class Signature
+      # Returns a unique image process signature
+      #
+      # @param [Alchemy::PictureVariant]
+      #
+      # @return [String]
+      def self.call(variant)
+        steps_without_fetch = variant.image.steps.reject do |step|
+          step.is_a?(::Dragonfly::Job::Fetch)
+        end
+
+        steps_with_id = [[variant.picture.id]] + steps_without_fetch
+        job_string = steps_with_id.map(&:to_a).to_dragonfly_unique_s
+
+        Digest::SHA1.hexdigest(job_string)
+      end
+    end
+  end
+end

data/app/models/alchemy/picture_thumb/uid.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Alchemy
+  class PictureThumb < BaseRecord
+    class Uid
+      # Returns a image variant uid for storage
+      #
+      # @param [String]
+      # @param [Alchemy::PictureVariant]
+      #
+      # @return [String]
+      def self.call(signature, variant)
+        picture = variant.picture
+        filename = variant.image_file_name || "image"
+        name = File.basename(filename, ".*").gsub(/[^\w.]+/, "_")
+        ext = variant.render_format
+
+        "pictures/#{picture.id}/#{signature}/#{name}.#{ext}"
+      end
+    end
+  end
+end

data/app/models/alchemy/picture_variant.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+require "forwardable"
+
+module Alchemy
+  # Represents a rendered picture
+  #
+  # Resizes, crops and encodes the image with imagemagick
+  #
+  class PictureVariant
+    extend Forwardable
+
+    include Alchemy::Logger
+    include Alchemy::Picture::Transformations
+
+    attr_reader :picture, :render_format
+
+    def_delegators :@picture,
+      :image_file,
+      :image_file_width,
+      :image_file_height,
+      :image_file_name,
+      :image_file_size
+
+    # @param [Alchemy::Picture]
+    #
+    # @param [Hash] options passed to the image processor
+    # @option options [Boolean] :crop Pass true to enable cropping
+    # @option options [String] :crop_from Coordinates to start cropping from
+    # @option options [String] :crop_size Size of the cropping area
+    # @option options [Boolean] :flatten Pass true to flatten GIFs
+    # @option options [String|Symbol] :format Image format to encode the image in
+    # @option options [Integer] :quality JPEG compress quality
+    # @option options [String] :size Size of resulting image in WxH
+    # @option options [Boolean] :upsample Pass true to upsample (grow) an image if the original size is lower than the resulting size
+    #
+    def initialize(picture, options = {})
+      raise ArgumentError, "Picture missing!" if picture.nil?
+
+      @picture = picture
+      @options = options
+      @render_format = options[:format] || picture.default_render_format
+    end
+
+    # Process a variant of picture
+    #
+    # @return [Dragonfly::Attachment|Dragonfly::Job] The processed image variant
+    #
+    def image
+      image = image_file
+
+      raise MissingImageFileError, "Missing image file for #{picture.inspect}" if image.nil?
+
+      image = processed_image(image, @options)
+      image = encoded_image(image, @options)
+      image
+    rescue MissingImageFileError, WrongImageFormatError => e
+      log_warning(e.message)
+      nil
+    end
+
+    private
+
+    # Returns the processed image dependent of size and cropping parameters
+    def processed_image(image, options = {})
+      size = options[:size]
+      upsample = !!options[:upsample]
+
+      return image unless size.present? && picture.has_convertible_format?
+
+      if options[:crop]
+        crop(size, options[:crop_from], options[:crop_size], upsample)
+      else
+        resize(size, upsample)
+      end
+    end
+
+    # Returns the encoded image
+    #
+    # Flatten animated gifs, only if converting to a different format.
+    # Can be overwritten via +options[:flatten]+.
+    #
+    def encoded_image(image, options = {})
+      unless render_format.in?(Alchemy::Picture.allowed_filetypes)
+        raise WrongImageFormatError.new(picture, @render_format)
+      end
+
+      options = {
+        flatten: render_format != "gif" && picture.image_file_format == "gif",
+      }.with_indifferent_access.merge(options)
+
+      encoding_options = []
+
+      convert_format = render_format.sub("jpeg", "jpg") != picture.image_file_format.sub("jpeg", "jpg")
+
+      if render_format =~ /jpe?g/ && convert_format
+        quality = options[:quality] || Config.get(:output_image_jpg_quality)
+        encoding_options << "-quality #{quality}"
+      end
+
+      if options[:flatten]
+        encoding_options << "-flatten"
+      end
+
+      convertion_needed = convert_format || encoding_options.present?
+
+      if picture.has_convertible_format? && convertion_needed
+        image = image.encode(render_format, encoding_options.join(" "))
+      end
+
+      image
+    end
+  end
+end

data/app/views/alchemy/admin/attachments/show.html.erb

@@ -0,0 +1,54 @@
+<div class="resource_info">
+  <div class="value">
+    <label>
+      <%= render_icon @attachment.icon_css_class, style: 'regular', size: 'lg' %>
+    </label>
+    <p><%= @attachment.file_name %></p>
+  </div>
+  <div class="value with-icon">
+    <label><%= Alchemy::Attachment.human_attribute_name(:url) %></label>
+    <p><%= @attachment.url %></p>
+    <a data-clipboard-text="<%= @attachment.url %>" class="icon_button--right">
+      <%= render_icon(:clipboard, style: 'regular') %>
+    </a>
+  </div>
+  <div class="value with-icon">
+    <label><%= Alchemy::Attachment.human_attribute_name(:download_url) %></label>
+    <p><%= @attachment.url %></p>
+    <a data-clipboard-text="<%= @attachment.url %>" class="icon_button--right">
+      <%= render_icon(:clipboard, style: 'regular') %>
+    </a>
+  </div>
+</div>
+
+<% case @attachment.icon_css_class %>
+<% when "file-image" %>
+<div class="attachment_preview_container image-preview">
+  <%= image_tag(@attachment.url, class: "full_width") %>
+</div>
+<% when "file-audio" %>
+<div class="attachment_preview_container player-preview">
+  <%= audio_tag(@attachment.url, preload: "none", controls: true, class: "full_width") %>
+</div>
+<% when "file-video" %>
+<div class="attachment_preview_container player-preview">
+  <%= video_tag(@attachment.url, preload: "metadata", controls: true, class: "full_width") %>
+</div>
+<% when "file-pdf" %>
+<iframe src="<%= @attachment.url %>" frameborder=0 class="full-iframe">
+  Your browser does not support frames.
+</iframe>
+<% end %>
+
+<script type="text/javascript">
+  $(function() {
+    var clipboard = new Clipboard('.icon_button--right');
+    clipboard.on('success', function(e) {
+      Alchemy.growl('<%= Alchemy.t("Copied to clipboard") %>');
+      e.clearSelection();
+    });
+    Alchemy.currentDialog().dialog.on('DialogClose.Alchemy', function() {
+      clipboard.destroy();
+    });
+  });
+</script>

data/app/views/alchemy/admin/pictures/_picture.html.erb

@@ -0,0 +1,53 @@
+<div class="picture_thumbnail <%= @size %>" id="picture_<%= picture.id %>" name="<%= picture.name %>">
+  <span class="picture_tool select">
+    <%= check_box_tag "picture_ids[]", picture.id %>
+  </span>
+  <% if picture.deletable? && can?(:destroy, picture) %>
+  <span class="picture_tool delete">
+    <%= link_to_confirm_dialog(
+      render_icon(:minus),
+      Alchemy.t(:confirm_to_delete_image_from_server),
+      alchemy.admin_picture_path(
+        id: picture,
+        q: search_filter_params[:q],
+        page: params[:page],
+        tagged_with: search_filter_params[:tagged_with],
+        size: params[:size],
+        filter: search_filter_params[:filter]
+      ),
+      {
+        title: Alchemy.t('Delete image')
+      }
+    ) -%>
+  </span>
+  <% end %>
+  <% image = image_tag(
+    picture.url(size: preview_size(@size), flatten: true) || "alchemy/missing-image.svg",
+    alt: picture.name,
+    title: Alchemy.t(:zoom_image)
+  ) %>
+  <% if can?(:edit, picture) %>
+    <%= link_to(
+      image,
+      alchemy.admin_picture_path(
+        id: picture,
+        q: search_filter_params[:q],
+        page: params[:page],
+        tagged_with: search_filter_params[:tagged_with],
+        size: params[:size],
+        filter: search_filter_params[:filter]
+      ),
+      class: 'thumbnail_background'
+    ) %>
+  <% else %>
+    <%= image %>
+  <% end %>
+  <span class="picture_name" title="<%= picture.name %>">
+    <%= picture.name %>
+  </span>
+  <div class="picture_tags">
+  <% picture.tag_list.each do |tag| %>
+    <span class="tag"><%= tag %></span>
+  <% end %>
+  </div>
+</div>

data/app/views/alchemy/admin/pictures/_picture_to_assign.html.erb

@@ -0,0 +1,20 @@
+<div class="picture_thumbnail assign_image_list_detail <%= size.blank? ? 'medium' : size %>" name="<%= picture_to_assign.name %>" id="picture_to_assign_<%= picture_to_assign.id %>">
+  <%= link_to(
+    image_tag(
+      picture_to_assign.url(size: preview_size(size), flatten: true) || "alchemy/missing-image.svg",
+      alt: picture_to_assign.name
+    ),
+    alchemy.assign_admin_essence_pictures_path(
+      picture_id: picture_to_assign.id,
+      content_id: @content
+    ),
+    remote: true,
+    onclick: '$(self).attr("href", "#").off("click"); return false',
+    method: 'put',
+    title: Alchemy.t(:assign_image),
+    class: 'thumbnail_background'
+  ) %>
+  <div class="picture_name" title="<%= picture_to_assign.name %>">
+    <%= picture_to_assign.name %>
+  </div>
+</div>

data/app/views/alchemy/admin/pictures/show.html.erb

@@ -0,0 +1,43 @@
+<div class="zoomed-picture-background">
+  <%= image_tag @picture.url || "alchemy/missing-image.svg" %>
+</div>
+
+<div class="picture-overlay-navigation">
+  <% if @previous %>
+    <%= link_to alchemy.admin_picture_path(
+        id: @previous,
+        q: search_filter_params[:q],
+        page: params[:page],
+        tagged_with: search_filter_params[:tagged_with],
+        size: params[:size],
+        filter: search_filter_params[:filter]
+      ),
+      class: "previous-picture",
+      remote: true do %>
+      <i class="icon fas fa-angle-left fa-fw"></i>
+    <% end %>
+  <% end %>
+  <% if @next %>
+    <%= link_to alchemy.admin_picture_path(
+        id: @next,
+        q: search_filter_params[:q],
+        page: params[:page],
+        tagged_with: search_filter_params[:tagged_with],
+        size: params[:size],
+        filter: search_filter_params[:filter]
+      ),
+      class: "next-picture",
+      remote: true do %>
+      <i class="icon fas fa-angle-right fa-fw"></i>
+    <% end %>
+  <% end %>
+</div>
+
+<div class="picture-details-overlay">
+  <%= render 'form' %>
+  <%= render 'infos' %>
+</div>
+
+<div class="picture-overlay-handle">
+  <i class="icon fas fa-angle-double-right fa-fw"></i>
+</div>

data/app/views/alchemy/essences/_essence_file_view.html.erb

@@ -0,0 +1,14 @@
+<% content = local_assigns[:content] || local_assigns[:essence_file_view] %>
+<%- if attachment = content.ingredient -%>
+  <%- html_options = local_assigns.fetch(:html_options, {}) -%>
+  <%= link_to(
+    content.essence.link_text.presence ||
+      content.settings_value(:link_text, local_assigns.fetch(:options, {})) ||
+      attachment.name,
+    attachment.url,
+    {
+      class: content.essence.css_class.presence,
+      title: content.essence.title.presence
+    }.merge(html_options)
+  ) -%>
+<%- end -%>

data/db/migrate/1_create_alchemy_picture_thumbs.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+class CreateAlchemyPictureThumbs < ActiveRecord::Migration[5.0]
+  def change
+    create_table :alchemy_picture_thumbs do |t|
+      t.references :picture, null: false, foreign_key: { to_table: :alchemy_pictures }
+      t.string :signature, null: false
+      t.text :uid, null: false
+    end
+    add_index :alchemy_picture_thumbs, :signature, unique: true
+  end
+end

data/lib/alchemy/dragonfly/s3/version.rb

@@ -3,7 +3,7 @@
 module Alchemy
   module Dragonfly
     module S3
-      VERSION = "4.0.2"
+      VERSION = "5.0.6"
     end
   end
 end

data/lib/alchemy/essence_picture_monkey_patch.rb

@@ -6,11 +6,11 @@ module Alchemy
       super || "missing-image.png"
     end
 
-    def thumbnail_url(options = {})
+    def thumbnail_url
       super || "alchemy/missing-image.svg"
     end
 
-    def allow_image_cropping?(options = {})
+    def allow_image_cropping?
       super && !!picture.image_file
     end
 

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: alchemy-dragonfly-s3
 version: !ruby/object:Gem::Version
-  version: 4.0.2
+  version: 5.0.6
 platform: ruby
 authors:
 - Thomas von Deyen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-17 00:00:00.000000000 Z
+date: 2020-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: alchemy_cms
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 5.0.0.beta1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 5.0.0.beta1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: dragonfly-s3_data_store
   requirement: !ruby/object:Gem::Requirement
@@ -117,6 +123,21 @@ extra_rdoc_files: []
 files:
 - MIT-LICENSE
 - README.md
+- app/assets/config/alchemy_dragonfly_s3_manifest.js
+- app/assets/images/alchemy/missing-image.svg
+- app/models/alchemy/attachment/s3_url.rb
+- app/models/alchemy/picture/s3_url.rb
+- app/models/alchemy/picture_thumb.rb
+- app/models/alchemy/picture_thumb/create.rb
+- app/models/alchemy/picture_thumb/signature.rb
+- app/models/alchemy/picture_thumb/uid.rb
+- app/models/alchemy/picture_variant.rb
+- app/views/alchemy/admin/attachments/show.html.erb
+- app/views/alchemy/admin/pictures/_picture.html.erb
+- app/views/alchemy/admin/pictures/_picture_to_assign.html.erb
+- app/views/alchemy/admin/pictures/show.html.erb
+- app/views/alchemy/essences/_essence_file_view.html.erb
+- db/migrate/1_create_alchemy_picture_thumbs.rb
 - lib/alchemy-dragonfly-s3.rb
 - lib/alchemy/attachment_monkey_patch.rb
 - lib/alchemy/dragonfly/s3/engine.rb