alchemy-dragonfly-s3 5.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 07b85abda41c799474122920cea92e2fddfa003314bca025bf29ab055b62061c
+  data.tar.gz: 182e4d22390fee03f7c652fc6fe6ad925a811e1768ce09e2028315830cd72d00
+SHA512:
+  metadata.gz: 82976ed6c263722910b05bbdd3cb0dd9a1434d1f767967c7ae49e9fa2eda75bff7fe9d9795f8af45d2718ce9afb0a00b4674c743f144de0db938992a630aebb4
+  data.tar.gz: 2c0fdccf15ac1fd8870e47255e51b90738bacb43828bef8edb19d9b46186fb10dfa1b5b6beb6ef08244b5d9e0db62210c95d897b5bca226147c256f9095b195b

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 Thomas von Deyen
+
+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.

data/README.md

@@ -0,0 +1,66 @@
+[![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
+
+Adds support for file attachments and rendered Alchemy thumbnails stored on Amazon AWS S3.
+
+## Alchemy Version
+
+This branch works with Alchemy 5.0 only.
+
+- 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
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'alchemy-dragonfly-s3', github: 'AlchemyCMS/alchemy-dragonfly-s3', branch: 'alchemy-5'
+```
+
+And then execute:
+
+```
+$ bundle install
+```
+
+Install the picture thumbs migration
+
+```
+$ bin/rake alchemy_dragonfly_s3:install:migrations
+$ bin/rake db:migrate
+```
+
+## Setup
+
+Configure a S3 datastore for Dragonfly
+
+```ruby
+# config/initializers/dragonfly
+
+require "dragonfly/s3_data_store"
+
+Dragonfly.app(:alchemy_pictures).configure do
+  plugin :imagemagick
+  plugin :svg
+
+  datastore :s3,
+    bucket_name: ENV.fetch("ALCHEMY_S3_BUCKET_NAME"),
+    access_key_id: ENV.fetch("ALCHEMY_S3_ACCESS_KEY_ID"),
+    secret_access_key: ENV.fetch("ALCHEMY_S3_SECRET_ACCESS_KEY"),
+    region: ENV.fetch("ALCHEMY_S3_REGION")
+end
+
+Dragonfly.app(:alchemy_attachments).configure do
+  datastore :s3,
+    bucket_name: ENV.fetch("ALCHEMY_S3_BUCKET_NAME"),
+    access_key_id: ENV.fetch("ALCHEMY_S3_ACCESS_KEY_ID"),
+    secret_access_key: ENV.fetch("ALCHEMY_S3_SECRET_ACCESS_KEY"),
+    region: ENV.fetch("ALCHEMY_S3_REGION")
+end
+```
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/alchemy-dragonfly-s3.rb

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

data/lib/alchemy/attachment_monkey_patch.rb

@@ -0,0 +1,13 @@
+# 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/dragonfly/s3/engine.rb

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

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

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Alchemy
+  module Dragonfly
+    module S3
+      VERSION = "5.0.4"
+    end
+  end
+end

data/lib/alchemy/essence_picture_monkey_patch.rb

@@ -0,0 +1,19 @@
+# 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

@@ -0,0 +1,43 @@
+# 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

@@ -0,0 +1,37 @@
+# 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

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: alchemy-dragonfly-s3
+version: !ruby/object:Gem::Version
+  version: 5.0.4
+platform: ruby
+authors:
+- Thomas von Deyen
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-07-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: alchemy_cms
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        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: 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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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
+    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'
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- lib/alchemy-dragonfly-s3.rb
+- lib/alchemy/attachment_monkey_patch.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
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: AlchemyCMS Dragonfly S3.
+test_files: []