alchemy_cms 7.4.6 → 8.0.0.a

data/lib/alchemy/test_support/having_picture_thumbnails_examples.rb

@@ -86,8 +86,8 @@ RSpec.shared_examples_for "having picture thumbnails" do
           allow(record).to receive(:settings) { {} }
         end
 
-        it "adds them to the url" do
-          expect(picture_url).to match(/\?foo=baz/)
+        it "does not add them to the url" do
+          expect(picture_url).to_not match(/\?foo=baz/)
         end
       end
     end
@@ -112,7 +112,7 @@ RSpec.shared_examples_for "having picture thumbnails" do
   describe "#picture_url_options" do
     subject(:picture_url_options) { record.picture_url_options }
 
-    let(:picture) { build_stubbed(:alchemy_picture) }
+    let(:picture) { build(:alchemy_picture) }
 
     it { is_expected.to be_a(HashWithIndifferentAccess) }
 
@@ -418,7 +418,7 @@ RSpec.shared_examples_for "having picture thumbnails" do
     end
 
     context "with picture assigned" do
-      let(:picture) { build_stubbed(:alchemy_picture) }
+      let(:picture) { build(:alchemy_picture) }
 
       let(:default_mask) do
         [
@@ -432,8 +432,8 @@ RSpec.shared_examples_for "having picture thumbnails" do
       let(:settings) { {} }
 
       before do
-        picture.image_file_width = 300
-        picture.image_file_height = 250
+        allow(picture).to receive(:image_file_width) { 300 }
+        allow(picture).to receive(:image_file_height) { 250 }
         allow(record).to receive(:settings) { settings }
       end
 
@@ -555,8 +555,8 @@ RSpec.shared_examples_for "having picture thumbnails" do
         let(:settings) { {crop: true, size: size} }
 
         before do
-          picture.image_file_width = 200
-          picture.image_file_height = 100
+          allow(picture).to receive(:image_file_width) { 200 }
+          allow(picture).to receive(:image_file_height) { 100 }
         end
 
         context "size 200x50" do
@@ -619,45 +619,99 @@ RSpec.shared_examples_for "having picture thumbnails" do
   end
 
   describe "#allow_image_cropping?" do
-    let(:picture) do
-      stub_model(Alchemy::Picture, image_file_width: 400, image_file_height: 300)
+    let(:picture) { Alchemy::Picture.new }
+    let(:image_file_width) { 400 }
+    let(:image_file_height) { 300 }
+    let(:crop) { false }
+    let(:size) { "400x300" }
+    let(:upsample) { false }
+
+    before do
+      allow(picture).to receive(:image_file_width) { image_file_width }
+      allow(picture).to receive(:image_file_height) { image_file_height }
+      allow(record).to receive(:settings) { {crop:, size:, upsample:} }
     end
 
     subject { record.allow_image_cropping? }
 
-    it { is_expected.to be_falsy }
+    shared_context "with image file" do
+      before do
+        if Alchemy.storage_adapter.dragonfly?
+          expect(picture).to receive(:image_file) { fixture_file_upload("image.png") }
+        elsif Alchemy.storage_adapter.active_storage?
+          expect(picture.image_file).to receive(:attached?) { true }
+        end
+      end
+    end
 
-    context "with picture assigned" do
+    shared_context "without image file" do
       before do
-        allow(record).to receive(:picture) { picture }
+        if Alchemy.storage_adapter.dragonfly?
+          expect(picture).to receive(:image_file) { nil }
+        elsif Alchemy.storage_adapter.active_storage?
+          expect(picture.image_file).to receive(:attached?) { false }
+        end
       end
+    end
+
+    context "with crop set to false" do
+      let(:crop) { false }
 
       it { is_expected.to be_falsy }
+    end
+
+    context "with crop set to true" do
+      let(:crop) { true }
 
-      context "and with image larger than crop size" do
+      context "with picture assigned" do
         before do
-          allow(picture).to receive(:can_be_cropped_to?) { true }
+          allow(record).to receive(:picture) { picture }
         end
 
-        it { is_expected.to be_falsy }
+        context "and image smaller or equal to crop size" do
+          context "if picture.image_file is nil" do
+            include_context "without image file"
 
-        context "with crop set to true" do
-          before do
-            allow(record).to receive(:settings) { {crop: true} }
+            it { is_expected.to be_falsy }
           end
 
-          context "if picture.image_file is nil" do
-            before do
-              expect(picture).to receive(:image_file) { nil }
-            end
+          context "if picture.image_file is present" do
+            include_context "with image file"
 
             it { is_expected.to be_falsy }
+
+            context "but with upsample set to true" do
+              let(:upsample) { true }
+
+              it { is_expected.to be(true) }
+            end
           end
+        end
 
-          context "if picture.image_file is present" do
-            let(:picture) { build_stubbed(:alchemy_picture) }
+        context "and with image larger than crop size" do
+          let(:image_file_width) { 1201 }
+          let(:image_file_height) { 481 }
+
+          it { is_expected.to be_falsy }
 
-            it { is_expected.to be(true) }
+          context "with crop set to true" do
+            context "if picture.image_file is nil" do
+              include_context "without image file"
+
+              it { is_expected.to be_falsy }
+            end
+
+            context "if picture.image_file is present" do
+              include_context "with image file"
+
+              it { is_expected.to be(true) }
+
+              context "with size setting being nil" do
+                let(:size) { nil }
+
+                it { is_expected.to be_falsey }
+              end
+            end
           end
         end
       end

data/lib/alchemy/test_support/shared_ingredient_examples.rb

@@ -29,11 +29,11 @@ RSpec.shared_examples_for "an alchemy ingredient" do
     context "with element" do
       before do
         expect(element).to receive(:ingredient_definition_for).at_least(:once) do
-          {
+          Alchemy::IngredientDefinition.new(
             settings: {
               linkable: true
             }
-          }.with_indifferent_access
+          )
         end
       end
 
@@ -47,19 +47,19 @@ RSpec.shared_examples_for "an alchemy ingredient" do
     context "without element" do
       let(:element) { nil }
 
-      it { is_expected.to eq({}) }
+      it { is_expected.to be_a(Alchemy::IngredientDefinition) }
     end
 
     context "with element" do
       let(:definition) do
-        {
+        Alchemy::IngredientDefinition.new(
           role: "headline",
           type: "Text",
           default: "Hello World",
           settings: {
             linkable: true
           }
-        }.with_indifferent_access
+        )
       end
 
       before do

data/lib/alchemy/upgrader/eight_zero.rb

@@ -0,0 +1,14 @@
+module Alchemy
+  class Upgrader
+    module EightZero
+      def mention_alchemy_config_initializer
+        todo <<~TEXT, "Configuration has changed to initializer"
+          Check the new configuration file `./config/initializers/alchemy.rb` and
+          update values from your `config/alchemy/config.yml` file.
+
+          Then you can safely remove the `config/alchemy/config.yml` file.
+        TEXT
+      end
+    end
+  end
+end

data/lib/alchemy/upgrader.rb

@@ -1,29 +1,42 @@
 # frozen_string_literal: true
 
 require "alchemy/shell"
+require "thor"
 
 module Alchemy
   class Upgrader
-    extend Alchemy::Shell
-
-    Dir["#{File.dirname(__FILE__)}/upgrader/*.rb"].sort.each { |f| require f }
-
-    class << self
-      def copy_new_config_file
-        desc "Copy configuration file."
-        config_file = Rails.root.join("config/alchemy/config.yml")
-        default_config = File.join(File.dirname(__FILE__), "../../config/alchemy/config.yml")
-        if !File.exist? config_file
-          log "No configuration file found. Creating it."
-          FileUtils.cp default_config, Rails.root.join("config/alchemy/config.yml")
-        elsif FileUtils.identical? default_config, config_file
-          log "Configuration file already present.", :skip
-        else
-          log "Custom configuration file found."
-          FileUtils.cp default_config, Rails.root.join("config/alchemy/config.yml.defaults")
-          log "Copied new default configuration file."
-          todo "Check the default configuration file (./config/alchemy/config.yml.defaults) for new configuration options and insert them into your config file.", "Configuration has changed"
-        end
+    include Alchemy::Shell
+    include Thor::Base
+    include Thor::Actions
+
+    Dir["#{File.dirname(__FILE__)}/upgrader/*.rb"].sort.each { require(_1) }
+
+    VERSION_MODULE_MAP = {
+      "8.0" => "Alchemy::Upgrader::EightZero"
+    }
+
+    source_root Alchemy::Engine.root.join("lib/generators/alchemy/install")
+
+    def initialize(version)
+      super()
+      self.class.include VERSION_MODULE_MAP[version.to_s].constantize
+    end
+
+    def update_config
+      desc "Copy configuration file."
+      @default_config = Alchemy::Configurations::Main.new
+      template("templates/alchemy.rb.tt", "config/initializers/alchemy.rb")
+    end
+
+    def run_migrations
+      ActiveRecord::Migration.check_all_pending!
+    rescue ActiveRecord::PendingMigrationError
+      desc "Pending Database migrations."
+      if yes?("Run database migrations now? (y/N)")
+        log "Migrating Database..."
+        Rake::Task["db:migrate"].invoke
+      else
+        log "Don't forget to run database migrations later with rake `db:migrate`.", :skip
       end
     end
   end

data/lib/alchemy/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Alchemy
-  VERSION = "7.4.6"
+  VERSION = "8.0.0.a"
 
   def self.version
     VERSION

data/lib/alchemy.rb

@@ -2,190 +2,212 @@
 
 require "alchemy/admin/preview_url"
 require "importmap-rails"
+require "alchemy/configurations/main"
+require "alchemy/config_missing"
 
 module Alchemy
+  include Alchemy::ConfigMissing
+  extend Alchemy::ConfigMissing
+
   YAML_PERMITTED_CLASSES = %w[Symbol Date Regexp]
 
-  # Define page preview sources
-  #
-  # A preview source is a Ruby class returning an URL
-  # that is used as source for the preview frame in the
-  # admin UI.
-  #
-  # == Example
-  #
-  #     # lib/acme/preview_source.rb
-  #     class Acme::PreviewSource < Alchemy::Admin::PreviewUrl
-  #       def url_for(page)
-  #         if page.site.name == "Next"
-  #           "https://user:#{ENV['PREVIEW_HTTP_PASS']}@next.acme.com"
-  #         else
-  #           "https://www.acme.com"
-  #         end
-  #       end
-  #     end
-  #
-  #     # config/initializers/alchemy.rb
-  #     require "acme/preview_source"
-  #     Alchemy.preview_sources << Acme::PreviewSource
-  #
-  #     # config/locales/de.yml
-  #     de:
-  #       activemodel:
-  #         models:
-  #           acme/preview_source: Acme Vorschau
-  #
-  def self.preview_sources
-    @_preview_sources ||= Set.new << Alchemy::Admin::PreviewUrl
-  end
+  # JS Importmap instance
+  singleton_class.attr_accessor :importmap
+  self.importmap = Importmap::Map.new
 
-  def self.preview_sources=(sources)
-    @_preview_sources = Array(sources)
-  end
+  class << self
+    def config
+      @_config ||= Alchemy::Configurations::Main.new
+    end
 
-  # Additional JS modules to be imported in the Alchemy admin UI
-  #
-  # Be sure to also pin the modules with +Alchemy.importmap+.
-  #
-  # == Example
-  #
-  #    Alchemy.importmap.pin "flatpickr/de",
-  #      to: "https://ga.jspm.io/npm:flatpickr@4.6.13/dist/l10n/de.js"
-  #
-  #    Alchemy.admin_js_imports << "flatpickr/de"
-  #
-  def self.admin_js_imports
-    @_admin_js_imports ||= Set.new
-  end
+    def configure(&blk)
+      yield config
+    end
 
-  def self.admin_js_imports=(sources)
-    @_admin_js_imports = Set[sources]
-  end
+    enable_searchable_deprecation_msg = "Use `Alchemy.config.show_page_searchable_checkbox` instead."
+    def enable_searchable = config.show_page_searchable_checkbox
+    deprecate :enable_searchable= => enable_searchable_deprecation_msg, :deprecator => Alchemy::Deprecation
 
-  # Additional importmaps to be included in the Alchemy admin UI
-  #
-  # Be sure to also pin modules with +Alchemy.importmap+.
-  #
-  # == Example
-  #
-  #    # config/alchemy/importmap.rb
-  #    Alchemy.importmap.pin "alchemy_solidus", to: "alchemy_solidus.js", preload: true
-  #    Alchemy.importmap.pin_all_from Alchemy::Solidus::Engine.root.join("app/javascript/alchemy_solidus"),
-  #      under: "alchemy_solidus",
-  #      preload: true
-  #
-  #    # lib/alchemy/solidus/engine.rb
-  #    initializer "alchemy_solidus.assets", before: "alchemy.importmap" do |app|
-  #      Alchemy.admin_importmaps.add({
-  #        importmap_path: root.join("config/importmap.rb"),
-  #        source_paths: [
-  #          root.join("app/javascript")
-  #        ],
-  #        name: "alchemy_solidus"
-  #      })
-  #      app.config.assets.precompile << "alchemy_solidus/manifest.js"
-  #    end
-  #
-  # @return [Set<Hash>]
-  def self.admin_importmaps
-    @_admin_importmaps ||= Set.new([{
-      importmap_path: Engine.root.join("config/importmap.rb"),
-      source_paths: [
-        Engine.root.join("app/javascript"),
-        Engine.root.join("vendor/javascript")
-      ],
-      name: "alchemy_admin"
-    }])
-  end
+    def enable_searchable=(other)
+      config.show_page_searchable_checkbox = other
+    end
+    deprecate enable_searchable: enable_searchable_deprecation_msg, deprecator: Alchemy::Deprecation
 
-  # Additional stylesheets to be included in the Alchemy admin UI
-  #
-  # == Example
-  #
-  #    # lib/alchemy/devise/engine.rb
-  #    initializer "alchemy.devise.stylesheets", before: "alchemy.admin_stylesheets" do
-  #      Alchemy.admin_stylesheets << "alchemy/devise/admin.css"
-  #    end
-  #
-  # @return [Set<String>]
-  def self.admin_stylesheets
-    @_admin_stylesheets ||= Set.new(["alchemy/admin/custom.css"])
-  end
+    # Define page preview sources
+    #
+    # A preview source is a Ruby class returning an URL
+    # that is used as source for the preview frame in the
+    # admin UI.
+    #
+    # == Example
+    #
+    #     # lib/acme/preview_source.rb
+    #     class Acme::PreviewSource < Alchemy::Admin::PreviewUrl
+    #       def url_for(page)
+    #         if page.site.name == "Next"
+    #           "https://user:#{ENV['PREVIEW_HTTP_PASS']}@next.acme.com"
+    #         else
+    #           "https://www.acme.com"
+    #         end
+    #       end
+    #     end
+    #
+    #     # config/initializers/alchemy.rb
+    #     require "acme/preview_source"
+    #     Alchemy.preview_sources << Acme::PreviewSource
+    #
+    #     # config/locales/de.yml
+    #     de:
+    #       activemodel:
+    #         models:
+    #           acme/preview_source: Acme Vorschau
+    #
+    def preview_sources
+      @_preview_sources ||= Set.new << Alchemy::Admin::PreviewUrl
+    end
 
-  # Define page publish targets
-  #
-  # A publish target is a ActiveJob that gets performed
-  # whenever a user clicks the publish page button.
-  #
-  # Use this to trigger deployment hooks of external
-  # services in an asychronous way.
-  #
-  # == Example
-  #
-  #     # app/jobs/publish_job.rb
-  #     class PublishJob < ApplicationJob
-  #       def perform(page)
-  #         RestClient.post(ENV['BUILD_HOOK_URL'])
-  #       end
-  #     end
-  #
-  #     # config/initializers/alchemy.rb
-  #     Alchemy.publish_targets << PublishJob
-  #
-  def self.publish_targets
-    @_publish_targets ||= Set.new
-  end
+    def preview_sources=(sources)
+      @_preview_sources = Array(sources)
+    end
 
-  # Enable full text search configuration
-  #
-  # It enables a searchable checkbox in the page form to toggle
-  # the searchable field. These information can used in a search
-  # plugin (e.g. https://github.com/AlchemyCMS/alchemy-pg_search).
-  #
-  # == Example
-  #
-  #     # config/initializers/alchemy.rb
-  #     Alchemy.enable_searchable = true
-  #
-  mattr_accessor :enable_searchable, default: false
+    # Additional JS modules to be imported in the Alchemy admin UI
+    #
+    # Be sure to also pin the modules with +Alchemy.importmap+.
+    #
+    # == Example
+    #
+    #    Alchemy.importmap.pin "flatpickr/de",
+    #      to: "https://ga.jspm.io/npm:flatpickr@4.6.13/dist/l10n/de.js"
+    #
+    #    Alchemy.admin_js_imports << "flatpickr/de"
+    #
+    def admin_js_imports
+      @_admin_js_imports ||= Set.new
+    end
 
-  # JS Importmap instance
-  singleton_class.attr_accessor :importmap
-  self.importmap = Importmap::Map.new
+    def admin_js_imports=(sources)
+      @_admin_js_imports = Set[sources]
+    end
 
-  # Configure tabs in the link dialog
-  #
-  # With this configuration that tabs in the link dialog can be extended
-  # without overwriting or defacing the Admin Interface.
-  #
-  # == Example
-  #
-  #    # components/acme/link_tab.rb
-  #    module Acme
-  #      class LinkTab < ::Alchemy::Admin::LinkDialog::BaseTab
-  #        def title
-  #          "Awesome Tab Title"
-  #        end
-  #
-  #        def name
-  #          :unique_name
-  #        end
-  #
-  #        def fields
-  #           [ title_input, target_select ]
-  #        end
-  #      end
-  #    end
+    # Additional importmaps to be included in the Alchemy admin UI
+    #
+    # Be sure to also pin modules with +Alchemy.importmap+.
+    #
+    # == Example
+    #
+    #    # config/alchemy/importmap.rb
+    #    Alchemy.importmap.pin "alchemy_solidus", to: "alchemy_solidus.js", preload: true
+    #    Alchemy.importmap.pin_all_from Alchemy::Solidus::Engine.root.join("app/javascript/alchemy_solidus"),
+    #      under: "alchemy_solidus",
+    #      preload: true
+    #
+    #    # lib/alchemy/solidus/engine.rb
+    #    initializer "alchemy_solidus.assets", before: "alchemy.importmap" do |app|
+    #      Alchemy.admin_importmaps.add({
+    #        importmap_path: root.join("config/importmap.rb"),
+    #        source_paths: [
+    #          root.join("app/javascript")
+    #        ],
+    #        name: "alchemy_solidus"
+    #      })
+    #      app.config.assets.precompile << "alchemy_solidus/manifest.js"
+    #    end
+    #
+    # @return [Set<Hash>]
+    def admin_importmaps
+      @_admin_importmaps ||= Set.new([{
+        importmap_path: Engine.root.join("config/importmap.rb"),
+        source_paths: [
+          Engine.root.join("app/javascript"),
+          Engine.root.join("vendor/javascript")
+        ],
+        name: "alchemy_admin"
+      }])
+    end
+
+    # Additional stylesheets to be included in the Alchemy admin UI
+    #
+    # == Example
+    #
+    #    # lib/alchemy/devise/engine.rb
+    #    initializer "alchemy.devise.stylesheets", before: "alchemy.admin_stylesheets" do
+    #      Alchemy.admin_stylesheets << "alchemy/devise/admin.css"
+    #    end
+    #
+    # @return [Set<String>]
+    def admin_stylesheets
+      @_admin_stylesheets ||= Set.new(["alchemy/admin/custom.css"])
+    end
+
+    # Define page publish targets
+    #
+    # A publish target is a ActiveJob that gets performed
+    # whenever a user clicks the publish page button.
+    #
+    # Use this to trigger deployment hooks of external
+    # services in an asychronous way.
+    #
+    # == Example
+    #
+    #     # app/jobs/publish_job.rb
+    #     class PublishJob < ApplicationJob
+    #       def perform(page)
+    #         RestClient.post(ENV['BUILD_HOOK_URL'])
+    #       end
+    #     end
+    #
+    #     # config/initializers/alchemy.rb
+    #     Alchemy.publish_targets << PublishJob
+    #
+    def publish_targets
+      @_publish_targets ||= Set.new
+    end
+
+    # Configure tabs in the link dialog
+    #
+    # With this configuration that tabs in the link dialog can be extended
+    # without overwriting or defacing the Admin Interface.
+    #
+    # == Example
+    #
+    #    # components/acme/link_tab.rb
+    #    module Acme
+    #      class LinkTab < ::Alchemy::Admin::LinkDialog::BaseTab
+    #        def title
+    #          "Awesome Tab Title"
+    #        end
+    #
+    #        def name
+    #          :unique_name
+    #        end
+    #
+    #        def fields
+    #           [ title_input, target_select ]
+    #        end
+    #      end
+    #    end
+    #
+    #    # config/initializers/alchemy.rb
+    #    Alchemy.link_dialog_tabs << Acme::LinkTab
+    #
+    def link_dialog_tabs
+      @_link_dialog_tabs ||= Set.new([
+        Alchemy::Admin::LinkDialog::InternalTab,
+        Alchemy::Admin::LinkDialog::AnchorTab,
+        Alchemy::Admin::LinkDialog::ExternalTab,
+        Alchemy::Admin::LinkDialog::FileTab
+      ])
+    end
+  end
+
+  # The storage adapter for Pictures and Attachments
   #
-  #    # config/initializers/alchemy.rb
-  #    Alchemy.link_dialog_tabs << Acme::LinkTab
+  # Chose between 'active_storage' (default) or 'dragonfly' (legacy)
   #
-  def self.link_dialog_tabs
-    @_link_dialog_tabs ||= Set.new([
-      Alchemy::Admin::LinkDialog::InternalTab,
-      Alchemy::Admin::LinkDialog::AnchorTab,
-      Alchemy::Admin::LinkDialog::ExternalTab,
-      Alchemy::Admin::LinkDialog::FileTab
-    ])
+  # Can be set via 'ALCHEMY_STORAGE_ADAPTER' env var.
+  def self.storage_adapter
+    @_storage_adapter ||= Alchemy::StorageAdapter.new(
+      ENV.fetch("ALCHEMY_STORAGE_ADAPTER", Alchemy.config.storage_adapter)
+    )
   end
 end