alchemy_cms 5.0.0.rc1 → 5.1.0.beta2

data/config/alchemy/modules.yml

@@ -5,7 +5,7 @@
   position: 1
   navigation:
     name: 'modules.dashboard'
-    controller: 'alchemy/admin/dashboard'
+    controller: '/alchemy/admin/dashboard'
     action: index
     inline_image: '<svg xmlns="http://www.w3.org/2000/svg" viewBox="-4 -6 32 32" class="svg-inline--fa fa-lg fa-fw"><path fill="currentColor" d="M15.7 7.9L9.9 2.2 2.1 4.3 0 12.1l5.7 5.8 7.8-2.1 2.2-7.9zm-5.3 10.3l-1.2 4.4 3.2 3.2 4.4-1.2 1.2-4.4-3.2-3.2-4.4 1.2zM23.5 7.3L17.2 9l-1.7 6.2 4.5 4.6 6.2-1.7 1.7-6.2-4.4-4.6z"/></svg>'
 
@@ -14,18 +14,18 @@
   position: 2
   navigation:
     name: 'modules.pages'
-    controller: 'alchemy/admin/pages'
+    controller: '/alchemy/admin/pages'
     action: index
     icon: file-alt
     sub_navigation:
       - name: 'modules.pages'
-        controller: 'alchemy/admin/pages'
+        controller: '/alchemy/admin/pages'
         action: index
       - name: 'modules.layoutpages'
-        controller: 'alchemy/admin/layoutpages'
+        controller: '/alchemy/admin/layoutpages'
         action: index
     nested:
-      - controller: 'alchemy/admin/pages'
+      - controller: '/alchemy/admin/pages'
         action: edit
 
 - name: menus
@@ -33,7 +33,7 @@
   position: 3
   navigation:
     name: 'modules.menus'
-    controller: 'alchemy/admin/nodes'
+    controller: '/alchemy/admin/nodes'
     action: index
     icon: list-ul
 
@@ -42,7 +42,7 @@
   position: 4
   navigation:
     name: 'modules.languages'
-    controller: 'alchemy/admin/languages'
+    controller: '/alchemy/admin/languages'
     action: index
     icon: flag
 
@@ -51,7 +51,7 @@
   position: 5
   navigation:
     name: 'modules.sites'
-    controller: 'alchemy/admin/sites'
+    controller: '/alchemy/admin/sites'
     action: index
     icon: bullseye
 
@@ -60,7 +60,7 @@
   position: 6
   navigation:
     name: 'modules.tags'
-    controller: 'alchemy/admin/tags'
+    controller: '/alchemy/admin/tags'
     action: index
     icon: tags
 
@@ -68,14 +68,14 @@
   engine_name: alchemy
   position: 7
   navigation:
-    controller: 'alchemy/admin/pictures'
+    controller: '/alchemy/admin/pictures'
     action: index
     name: 'modules.library'
     icon: archive
     sub_navigation:
       - name: 'modules.pictures'
-        controller: 'alchemy/admin/pictures'
+        controller: '/alchemy/admin/pictures'
         action: index
       - name: 'modules.attachments'
-        controller: 'alchemy/admin/attachments'
+        controller: '/alchemy/admin/attachments'
         action: index

data/config/locales/alchemy.en.yml

@@ -521,6 +521,7 @@ en:
       '768': '768px (iPad - Portrait)'
       '1024': '1024px (iPad - Landscape)'
       '1280': '1280px (Desktop)'
+    preview_url: Preview
     recently_uploaded_only: 'Recently uploaded only'
     "regular method": "Regular method"
     remove: "Remove"
@@ -690,6 +691,7 @@ en:
       alchemy/message:
         one: Message
         other: Messages
+      alchemy/admin/preview_url: Internal
     attributes:
       alchemy/message:
         salutation: 'Salutation'

data/config/routes.rb

@@ -124,7 +124,7 @@ Alchemy::Engine.routes.draw do
 
   get "/attachment/:id/download(/:name)" => "attachments#download",
       as: :download_attachment
-  get "/attachment/:id/show" => "attachments#show",
+  get "/attachment/:id/show(/:name)" => "attachments#show",
       as: :show_attachment
 
   resources :messages, only: [:index, :new, :create]

data/db/migrate/20200617110713_create_alchemy_picture_thumbs.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+class CreateAlchemyPictureThumbs < ActiveRecord::Migration[5.2]
+  def up
+    return if table_exists?(:alchemy_picture_thumbs)
+
+    create_table :alchemy_picture_thumbs do |t|
+      t.references :picture, foreign_key: { to_table: :alchemy_pictures }, null: false
+      t.string :signature, null: false
+      t.text :uid, null: false
+    end
+    add_index :alchemy_picture_thumbs, :signature, unique: true
+  end
+
+  def down
+    return unless table_exists?(:alchemy_picture_thumbs)
+
+    remove_foreign_key :alchemy_picture_thumbs, :alchemy_pictures, column: :picture_id
+    remove_index :alchemy_picture_thumbs, :signature
+    drop_table :alchemy_picture_thumbs
+  end
+end

data/db/migrate/20200907111332_remove_tri_state_booleans.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+class RemoveTriStateBooleans < ActiveRecord::Migration[5.2]
+  def change
+    change_column_null :alchemy_elements, :public, false, false
+    change_column_default :alchemy_elements, :public, true
+
+    change_column_null :alchemy_elements, :folded, false
+    change_column_null :alchemy_elements, :unique, false
+
+    change_column_null :alchemy_essence_richtexts, :public, false, false
+    change_column_default :alchemy_essence_richtexts, :public, false
+
+    change_column_null :alchemy_essence_texts, :public, false
+
+    change_column_null :alchemy_folded_pages, :folded, false
+
+    change_column_null :alchemy_languages, :public, false
+    change_column_null :alchemy_languages, :default, false
+
+    change_column_null :alchemy_pages, :language_root, false, false
+    change_column_default :alchemy_pages, :language_root, false
+
+    change_column_null :alchemy_pages, :restricted, false
+    change_column_null :alchemy_pages, :robot_index, false
+    change_column_null :alchemy_pages, :robot_follow, false
+    change_column_null :alchemy_pages, :sitemap, false
+
+    change_column_null :alchemy_sites, :public, false
+    change_column_null :alchemy_sites, :redirect_to_primary_host, false, false
+    change_column_default :alchemy_sites, :redirect_to_primary_host, false
+  end
+end

data/lib/alchemy.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require "alchemy/admin/preview_url"
+
+module Alchemy
+  YAML_WHITELIST_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 ||= begin
+      Set.new << Alchemy::Admin::PreviewUrl
+    end
+  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
+end

data/lib/alchemy/admin/preview_url.rb

@@ -31,6 +31,8 @@ module Alchemy
     #           password: <%= ENV["BASIC_AUTH_PASSWORD"] %>
     #
     class PreviewUrl
+      extend ActiveModel::Translation
+
       class MissingProtocolError < StandardError; end
 
       def initialize(routes:)

data/lib/alchemy/auth_accessors.rb

@@ -91,16 +91,23 @@ module Alchemy
       @@user_class_name.constantize
     rescue NameError => e
       if e.message =~ /#{Regexp.escape(@@user_class_name)}/
-        abort <<-MSG.strip_heredoc
+        Rails.logger.warn <<~MSG
+          #{e.message}
+          #{e.backtrace.join("\n")}
 
-        AlchemyCMS cannot find any user class!
+          AlchemyCMS cannot find any user class!
 
-        Please add a user class and tell Alchemy about it or, if you don't want
-        to create your own class, add the `alchemy-devise` gem to your Gemfile.
+          Please add a user class and tell Alchemy about it:
 
-            bundle add alchemy-devise
+              # config/initializers/alchemy.rb
+              Alchemy.user_class_name = 'MyUser'
+
+          Or add the `alchemy-devise` gem to your Gemfile:
+
+              bundle add alchemy-devise
 
         MSG
+        nil
       else
         raise e
       end

data/lib/alchemy/config.rb

@@ -31,9 +31,7 @@ module Alchemy
       # a value of nil means there is no new default
       # any not nil value is the new default
       def deprecated_configs
-        {
-          redirect_to_public_child: nil,
-        }
+        {}
       end
 
       private

data/lib/alchemy/engine.rb

@@ -9,10 +9,6 @@ module Alchemy
       Alchemy::LOOKUP_CONTEXT = ActionView::LookupContext.new(Rails.root.join("app", "views", "alchemy"))
     end
 
-    initializer "alchemy.admin.preview_url" do
-      Alchemy::Admin::PREVIEW_URL = Alchemy::Admin::PreviewUrl.new(routes: Alchemy::Engine.routes)
-    end
-
     initializer "alchemy.dependency_tracker" do
       [:erb, :slim, :haml].each do |handler|
         ActionView::DependencyTracker.register_tracker(handler, CacheDigests::TemplateTracker)
@@ -40,8 +36,13 @@ module Alchemy
       end
     end
 
-    config.after_initialize do
-      require_relative "./userstamp"
+    initializer "alchemy.userstamp" do
+      if Alchemy.user_class
+        ActiveSupport.on_load(:active_record) do
+          Alchemy.user_class.model_stamper
+          Alchemy.user_class.stampable(stamper_class_name: Alchemy.user_class_name)
+        end
+      end
     end
   end
 end

data/lib/alchemy/modules.rb

@@ -72,7 +72,8 @@ module Alchemy
         alchemy_modules.detect do |alchemy_module|
           module_navi = alchemy_module.fetch("navigation", {})
           definition_from_mainnavi(module_navi, name_or_params) ||
-            definition_from_subnavi(module_navi, name_or_params)
+            definition_from_subnavi(module_navi, name_or_params) ||
+            definition_from_nested(module_navi, name_or_params)
         end
       else
         raise ArgumentError, "Could not find module definition for #{name_or_params}"
@@ -94,6 +95,15 @@ module Alchemy
       end
     end
 
+    def definition_from_nested(module_navi, params)
+      nested = module_navi["nested"]
+      return if nested.nil?
+
+      nested.any? do |navi|
+        controller_matches?(navi, params) && action_matches?(navi, params)
+      end
+    end
+
     def controller_matches?(navi, params)
       remove_slash(navi["controller"]) == remove_slash(params["controller"])
     end

data/lib/alchemy/resource.rb

@@ -210,7 +210,7 @@ module Alchemy
       @module_definition && @module_definition["engine_name"]
     end
 
-    # Returns a help text for resource's form
+    # Returns a help text for resource's form or nil if no help text is available
     #
     # === Example:
     #
@@ -223,7 +223,7 @@ module Alchemy
     def help_text_for(attribute)
       ::I18n.translate!(attribute[:name], scope: [:alchemy, :resource_help_texts, resource_name])
     rescue ::I18n::MissingTranslationData
-      false
+      nil
     end
 
     # Return attributes that should be viewable but not editable.

data/lib/alchemy/test_support/factories/picture_factory.rb

@@ -8,7 +8,6 @@ FactoryBot.define do
       File.new(Alchemy::Engine.root.join("lib", "alchemy", "test_support", "fixtures", "image.png"))
     end
     name { "image" }
-    image_file_name { "image.png" }
     upload_hash { Time.current.hash }
   end
 end

data/lib/alchemy/test_support/factories/picture_thumb_factory.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "factory_bot"
+require "securerandom"
+
+FactoryBot.define do
+  factory :alchemy_picture_thumb, class: "Alchemy::PictureThumb" do
+    picture { create(:alchemy_picture) }
+    signature { SecureRandom.hex(16) }
+    sequence(:uid) { |n| "#{Time.now.strftime("%Y/%m/%d")}/#{n}.jpg" }
+  end
+end

data/lib/alchemy/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Alchemy
-  VERSION = "5.0.0.rc1"
+  VERSION = "5.1.0.beta2"
 
   def self.version
     VERSION

data/lib/alchemy_cms.rb

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
+
 # Instantiate the global Alchemy namespace
-module Alchemy
-  YAML_WHITELIST_CLASSES = %w(Symbol Date Regexp)
-end
+require "alchemy"
 
 # Require globally used external libraries
 require "acts_as_list"

data/lib/generators/alchemy/install/files/alchemy.en.yml

@@ -18,7 +18,7 @@ en:
     # Default texts for new contents created
     default_content_texts:
       article_headline: "Welcome to your first Alchemy CMS page"
-      article_text: '<p><strong>How to get started.</strong></p><p>First of all you should read about Alchemy and its architecture in the <a class="external" href="http://guides.alchemy-cms.com/stable/alchemy_approach.html" target="_blank" data-link-target="blank">guidelines</a>.</p><p>The most important things to know about Alchemy are elements and page layouts.</p><p><span style="text-decoration: underline;"><strong>Elements:</strong></span></p><p>With Alchemy you can split pages into content parts, elements. These elements can be defined out of several base content types: essences. The basic essences are:</p><ul><li>EssenceText - <em>A single line of text</em></li><li>EssenceRichtext - <em>A TinyMCE powered formatted text block</em></li><li>EssencePicture - <em>A reference to an image</em></li><li>EssenceHtml - <em>HTML embed code</em></li><li>EssenceSelect - <em>A selection of values</em></li><li>EssenceBoolean - <em>A checkbox</em></li></ul><p>Elements get defined in a YAML file <strong>config/alchemy/elements.yml</strong></p><p><a class="external" href="http://guides.alchemy-cms.com/stable/elements.html" target="_blank" data-link-target="blank">Read more about elements and how to define them in the guidelines.</a></p><p><span style="text-decoration: underline;"><strong>Page types:</strong></span></p><p>You can define several types of pages, called page layouts. You can assign elements to page layouts and control how elements and the page of a certain layout behave.</p><p>Page layouts get defined in a YAML file <strong>config/alchemy/page_layouts.yml</strong></p><p><a class="external" href="http://guides.alchemy-cms.com/stable/page_layouts.html" target="_blank" data-link-target="blank">Read more about defining page layouts in the guidelines.</a></p>'
+      article_text: '<p><strong>How to get started.</strong></p><p>First of all you should read about Alchemy and its architecture in the <a class="external" href="http://guides.alchemy-cms.com/alchemy_approach.html" target="_blank" data-link-target="blank">guidelines</a>.</p><p>The most important things to know about Alchemy are elements and page layouts.</p><p><span style="text-decoration: underline;"><strong>Elements:</strong></span></p><p>With Alchemy you can split pages into content parts, elements. These elements can be defined out of several base content types: essences. The basic essences are:</p><ul><li>EssenceText - <em>A single line of text</em></li><li>EssenceRichtext - <em>A TinyMCE powered formatted text block</em></li><li>EssencePicture - <em>A reference to an image</em></li><li>EssenceHtml - <em>HTML embed code</em></li><li>EssenceSelect - <em>A selection of values</em></li><li>EssenceBoolean - <em>A checkbox</em></li></ul><p>Elements get defined in a YAML file <strong>config/alchemy/elements.yml</strong></p><p><a class="external" href="http://guides.alchemy-cms.com/elements.html" target="_blank" data-link-target="blank">Read more about elements and how to define them in the guidelines.</a></p><p><span style="text-decoration: underline;"><strong>Page types:</strong></span></p><p>You can define several types of pages, called page layouts. You can assign elements to page layouts and control how elements and the page of a certain layout behave.</p><p>Page layouts get defined in a YAML file <strong>config/alchemy/page_layouts.yml</strong></p><p><a class="external" href="http://guides.alchemy-cms.com/page_layouts.html" target="_blank" data-link-target="blank">Read more about defining page layouts in the guidelines.</a></p>'
 
     # Hint texts for elements
     element_hints:
@@ -28,4 +28,4 @@ en:
     content_hints:
       headline: "This is a single line of unformatable Text"
       picture: "Pictures are stored in the library. You can assign a picture multiple times throughout your site. Alchemy has an image cropper build right in."
-      text: "This is a rich text block powered by TinyMCE editor. You can change the configuration of the editor. See http://guides.alchemy-cms.com/stable/customize_tinymce.html"
+      text: "This is a rich text block powered by TinyMCE editor. You can change the configuration of the editor. See http://guides.alchemy-cms.com/customize_tinymce.html"

data/lib/generators/alchemy/install/templates/dragonfly.rb.tt

@@ -15,12 +15,12 @@ Dragonfly.app(:alchemy_pictures).configure do
   dragonfly_url nil
   plugin :imagemagick
   plugin :svg
-  secret '<%= SecureRandom.hex(32) %>'
-  url_format '/pictures/:job/:name.:ext'
+  secret "<%= SecureRandom.hex(32) %>"
+  url_format "/pictures/:job/:basename.:ext"
 
   datastore :file,
-    root_path: Rails.root.join('uploads/pictures').to_s,
-    server_root: Rails.root.join('public'),
+    root_path: Rails.root.join("uploads/pictures").to_s,
+    server_root: Rails.root.join("public"),
     store_meta: false
 end
 
@@ -30,6 +30,6 @@ Rails.application.middleware.use Dragonfly::Middleware, :alchemy_pictures
 # Attachments
 Dragonfly.app(:alchemy_attachments).configure do
   datastore :file,
-    root_path:  Rails.root.join('uploads/attachments').to_s,
+    root_path: Rails.root.join("uploads/attachments").to_s,
     store_meta: false
 end

data/lib/tasks/alchemy/thumbnails.rake

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+namespace :alchemy 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