alchemy-dragonfly-s3 5.0.4 → 5.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07b85abda41c799474122920cea92e2fddfa003314bca025bf29ab055b62061c
-  data.tar.gz: 182e4d22390fee03f7c652fc6fe6ad925a811e1768ce09e2028315830cd72d00
+  metadata.gz: ec1c13a542a1b63dd195077cd647d1e1bc0bdfaeae8a4eb51b702566d5202c12
+  data.tar.gz: 646fe1fa7a99c9ee7cb68eb8cc1bbddbd78640624cfafb168f5fb9371239bce0
 SHA512:
-  metadata.gz: 82976ed6c263722910b05bbdd3cb0dd9a1434d1f767967c7ae49e9fa2eda75bff7fe9d9795f8af45d2718ce9afb0a00b4674c743f144de0db938992a630aebb4
-  data.tar.gz: 2c0fdccf15ac1fd8870e47255e51b90738bacb43828bef8edb19d9b46186fb10dfa1b5b6beb6ef08244b5d9e0db62210c95d897b5bca226147c256f9095b195b
+  metadata.gz: c16231755be826fc40a78542cfb864753a0403eed16feb51186d9e526c2c76dc450810a228105644a0233844fa97171e7a83d35bd52ecedcbdaf7205d639961a
+  data.tar.gz: 946cf698073d4940257b251f8f53eb1ef189b53c4bf91ea081ff3142360cef5ef05cbf97631a5fad8c2c51cc58a98f1048b41e3c5e6093439ddc323786181f03

data/README.md

@@ -1,35 +1,43 @@
-[![Build Status](https://travis-ci.com/AlchemyCMS/alchemy-dragonfly-s3.svg?branch=alchemy-5)](https://travis-ci.com/AlchemyCMS/alchemy-dragonfly-s3)
+[![Build Status](https://travis-ci.com/AlchemyCMS/alchemy-dragonfly-s3.svg?branch=master)](https://travis-ci.com/AlchemyCMS/alchemy-dragonfly-s3)
 
 # AlchemyCMS AWS S3
 
-Adds support for file attachments and rendered Alchemy thumbnails stored on Amazon AWS S3.
+Provides classes for storing Alchemy pictures and file attachments on Amazon AWS S3.
 
 ## Alchemy Version
 
-This branch works with Alchemy 5.0 only.
+This branch works with Alchemy 5.1 only.
 
-- For a Alchemy 5.1 compatible version use the `master` branch.
+- For a Alchemy 5.0 compatible version use the `alchemy-5` branch.
 - For a Alchemy 4 compatible version use the `alchemy-4` branch.
-- For a Alchemy 3.6 compatible version use the `alchemy-3` branch.
+- For a Alchemy 3 compatible version use the `alchemy-3` branch.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'alchemy-dragonfly-s3', github: 'AlchemyCMS/alchemy-dragonfly-s3', branch: 'alchemy-5'
+gem 'alchemy-dragonfly-s3', github: 'AlchemyCMS/alchemy-dragonfly-s3'
 ```
 
+For now you also need the master branch of AlchemyCMS*
+
+```ruby
+gem 'alchemy_cms', github: 'AlchemyCMS/alchemy_cms', branch: 'master'
+```
+
+*only necessary until Alchemy 5.1 has been released.
+
 And then execute:
 
 ```
 $ bundle install
 ```
 
-Install the picture thumbs migration
+Install the picture thumbs migration from Alchemy 5.1
 
 ```
-$ bin/rake alchemy_dragonfly_s3:install:migrations
+$ bin/rake alchemy:install:migrations
 $ bin/rake db:migrate
 ```
 

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

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

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Alchemy
+  class Picture < BaseRecord
+    class S3Url < Url
+      def call(*)
+        return variant.image.remote_url unless processible_image?
+
+        ::Dragonfly.app(:alchemy_pictures).remote_url_for(uid)
+      end
+    end
+  end
+end

data/lib/alchemy-dragonfly-s3.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
 
 require "alchemy_cms"
+require "alchemy/dragonfly/s3/create_picture_thumb"
 require "alchemy/dragonfly/s3/engine"

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Alchemy
+  module Dragonfly
+    module S3
+      class CreatePictureThumb
+        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
+end

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

@@ -6,19 +6,10 @@ module Alchemy
       class Engine < ::Rails::Engine
         engine_name "alchemy_dragonfly_s3"
 
-        initializer "alchemy_dragonfly_s3.assets" do
-          Rails.application.config.assets.precompile << "alchemy_dragonfly_s3_manifest.js"
-        end
-
-        config.to_prepare do
-          files = [
-            "attachment_monkey_patch.rb",
-            "picture_monkey_patch.rb",
-            "essence_picture_monkey_patch.rb",
-          ].each do |filename|
-            file = Alchemy::Dragonfly::S3::Engine.root.join("lib", "alchemy", filename)
-            Rails.application.config.cache_classes ? require(file) : load(file)
-          end
+        config.after_initialize do
+          Alchemy::Attachment.url_class = Alchemy::Attachment::S3Url
+          Alchemy::Picture.url_class = Alchemy::Picture::S3Url
+          Alchemy::PictureThumb.generator_class = Alchemy::Dragonfly::S3::CreatePictureThumb
         end
       end
     end

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

@@ -3,7 +3,7 @@
 module Alchemy
   module Dragonfly
     module S3
-      VERSION = "5.0.4"
+      VERSION = "5.1.5"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alchemy-dragonfly-s3
 version: !ruby/object:Gem::Version
-  version: 5.0.4
+  version: 5.1.5
 platform: ruby
 authors:
 - Thomas von Deyen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-17 00:00:00.000000000 Z
+date: 2020-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: alchemy_cms
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.0.beta1
+        version: 5.1.0.alpha
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.0.beta1
+        version: 5.1.0.alpha
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: dragonfly-s3_data_store
   requirement: !ruby/object:Gem::Requirement
@@ -44,20 +44,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: capybara
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -78,14 +64,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -100,20 +86,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.17'
-- !ruby/object:Gem::Dependency
-  name: shoulda-matchers
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
 description: AlchemyCMS Integration for the Dragonfly S3 datastore.
 email:
 - thomas@vondeyen.com
@@ -123,13 +95,12 @@ extra_rdoc_files: []
 files:
 - MIT-LICENSE
 - README.md
+- app/models/alchemy/attachment/s3_url.rb
+- app/models/alchemy/picture/s3_url.rb
 - lib/alchemy-dragonfly-s3.rb
-- lib/alchemy/attachment_monkey_patch.rb
+- lib/alchemy/dragonfly/s3/create_picture_thumb.rb
 - lib/alchemy/dragonfly/s3/engine.rb
 - lib/alchemy/dragonfly/s3/version.rb
-- lib/alchemy/essence_picture_monkey_patch.rb
-- lib/alchemy/picture_monkey_patch.rb
-- lib/tasks/alchemy_dragonfly_s3/generate.rake
 homepage: https://alchemy-cms.com
 licenses:
 - MIT

data/lib/alchemy/attachment_monkey_patch.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module Alchemy
-  module AttachmentMonkeyPatch
-    def url
-      if file
-        Alchemy::Attachment::S3Url.call(self)
-      end
-    end
-
-    Attachment.prepend(self)
-  end
-end

data/lib/alchemy/essence_picture_monkey_patch.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module Alchemy
-  module EssencePictureMonkeyPatch
-    def picture_url(options = {})
-      super || "missing-image.png"
-    end
-
-    def thumbnail_url
-      super || "alchemy/missing-image.svg"
-    end
-
-    def allow_image_cropping?
-      super && !!picture.image_file
-    end
-
-    EssencePicture.prepend(self)
-  end
-end

data/lib/alchemy/picture_monkey_patch.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-module Alchemy
-  module PictureMonkeyPatch
-    def self.prepended(klass)
-      klass.has_many :thumbs, class_name: "Alchemy::PictureThumb", dependent: :destroy
-      klass.after_create -> { PictureThumb.generate_thumbs!(self) }
-    end
-
-    # Returns an url (or relative path) to a processed image for use inside an image_tag helper.
-    #
-    # Any additional options are passed to the url method, so you can add params to your url.
-    #
-    # Example:
-    #
-    #   <%= image_tag picture.url(size: '320x200', format: 'png') %>
-    #
-    # @see Alchemy::PictureVariant#call for transformation options
-    # @see Alchemy::Picture::Url#call for url options
-    # @return [String|Nil]
-    def url(options = {})
-      return unless image_file
-
-      variant = PictureVariant.new(self, options.slice(*Picture::TRANSFORMATION_OPTIONS))
-      Picture::S3Url.new(variant).call(options.except(*Picture::TRANSFORMATION_OPTIONS).merge(
-        basename: name,
-        ext: variant.render_format,
-        name: name,
-      ))
-    rescue ::Dragonfly::Job::Fetch::NotFound => e
-      log_warning(e.message)
-      nil
-    end
-
-    Picture::THUMBNAIL_SIZES = {
-      small: "80x60",
-      medium: "160x120",
-      large: "240x180",
-    }.with_indifferent_access.freeze
-
-    Picture.prepend(self)
-  end
-end

data/lib/tasks/alchemy_dragonfly_s3/generate.rake

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-namespace :alchemy_dragonfly_s3 do
-  namespace :generate do
-    desc "Generates all thumbnails for Alchemy Pictures and EssencePictures."
-    task thumbnails: [
-      "alchemy_dragonfly_s3:generate:picture_thumbnails",
-      "alchemy_dragonfly_s3:generate:essence_picture_thumbnails"
-    ]
-
-    desc "Generates thumbnails for Alchemy Pictures."
-    task picture_thumbnails: :environment do
-      puts "Regenerate #{Alchemy::Picture.count} picture thumbnails."
-      puts "Please wait..."
-
-      Alchemy::Picture.find_each do |picture|
-        puts Alchemy::PictureThumb.generate_thumbs!(picture)
-      end
-
-      puts "Done!"
-    end
-
-    desc "Generates thumbnails for Alchemy EssencePictures."
-    task essence_picture_thumbnails: :environment do
-      essence_pictures = Alchemy::EssencePicture.joins(:content, :ingredient_association)
-      puts "Regenerate #{essence_pictures.count} essence picture thumbnails."
-      puts "Please wait..."
-
-      essence_pictures.find_each do |essence_picture|
-        puts essence_picture.picture_url
-        puts essence_picture.thumbnail_url
-      end
-
-      puts "Done!"
-    end
-  end
-end