alchemy_cms 5.0.0.beta2 → 5.1.0.beta1

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/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

@@ -74,11 +74,11 @@ module Alchemy
         if deprecated_configs.key?(name.to_sym)
           config = deprecated_configs[name.to_sym]
           if config.nil?
-            Alchemy::Deprecation.warn("#{name} configuration is deprecated and will be removed from Alchemy 5.0")
+            Alchemy::Deprecation.warn("#{name} configuration is deprecated and will be removed from Alchemy 5.1")
           else
             value = show[name.to_s]
             if value != config
-              Alchemy::Deprecation.warn("Setting #{name} configuration to #{value} is deprecated and will be always #{config} in Alchemy 5.0")
+              Alchemy::Deprecation.warn("Setting #{name} configuration to #{value} is deprecated and will be always #{config} in Alchemy 5.1")
             end
           end
         end

data/lib/alchemy/deprecation.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Alchemy
-  Deprecation = ActiveSupport::Deprecation.new("5.0", "Alchemy")
+  Deprecation = ActiveSupport::Deprecation.new("5.1", "Alchemy")
 end

data/lib/alchemy/engine.rb

@@ -40,8 +40,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/install/tasks.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+require "thor"
+
+module Alchemy
+  module Install
+    class Tasks < Thor
+      include Thor::Actions
+
+      no_tasks do
+        def inject_routes(auto_accept = false)
+          return if File.read("./config/routes.rb").match?("mount Alchemy::Engine")
+
+          mountpoint = "/"
+          unless auto_accept
+            mountpoint = ask("- At which path do you want to mount Alchemy CMS at?", default: mountpoint)
+          end
+          sentinel = /\.routes\.draw do(?:\s*\|map\|)?\s*$/
+          inject_into_file "./config/routes.rb", "\n  mount Alchemy::Engine => '#{mountpoint}'\n", { after: sentinel, verbose: true }
+        end
+
+        def set_primary_language(auto_accept = false)
+          code = "en"
+          unless auto_accept
+            code = ask("- What is the language code of your site's primary language?", default: code)
+          end
+          name = "English"
+          unless auto_accept
+            name = ask("- What is the name of your site's primary language?", default: name)
+          end
+          gsub_file "./config/alchemy/config.yml", /default_language:\n\s\scode:\sen\n\s\sname:\sEnglish/m do
+            "default_language:\n  code: #{code}\n  name: #{name}"
+          end
+        end
+
+        def inject_seeder
+          append_file "./db/seeds.rb", "Alchemy::Seeder.seed!\n"
+        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.beta2"
+  VERSION = "5.1.0.beta1"
 
   def self.version
     VERSION

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/install_generator.rb

@@ -1,11 +1,17 @@
 # frozen_string_literal: true
 require "rails/generators"
+require "alchemy/install/tasks"
 
 module Alchemy
   module Generators
     class InstallGenerator < ::Rails::Generators::Base
       desc "Installs Alchemy into your App."
 
+      class_option :auto_accept,
+        type: :boolean,
+        default: false,
+        desc: "Automatically accept defaults."
+
       class_option :skip_demo_files,
         type: :boolean,
         default: false,
@@ -18,6 +24,13 @@ module Alchemy
 
       source_root File.expand_path("files", __dir__)
 
+      def setup
+        header
+        say "Welcome to AlchemyCMS!"
+        say "Let's begin with some questions.\n\n"
+        install_tasks.inject_routes(options[:auto_accept])
+      end
+
       def copy_config
         copy_file "#{gem_config_path}/config.yml", app_config_path.join("alchemy", "config.yml")
       end
@@ -53,7 +66,11 @@ module Alchemy
       end
 
       def copy_dragonfly_config
-        template "#{__dir__}/templates/dragonfly.rb.tt", app_config_path.join("initializers", "dragonfly.rb")
+        template(
+          "#{__dir__}/templates/dragonfly.rb.tt",
+          app_config_path.join("initializers", "dragonfly.rb"),
+          skip: options[:auto_accept]
+        )
       end
 
       def install_gutentag_migrations
@@ -80,8 +97,46 @@ module Alchemy
           app_root.join(webpack_config["source_path"], webpack_config["source_entry_path"], "alchemy/admin.js")
       end
 
+      def set_primary_language
+        header
+        install_tasks.set_primary_language(options[:auto_accept])
+      end
+
+      def setup_database
+        rake("db:create", abort_on_failure: true)
+        # We can't invoke this rake task, because Rails will use wrong engine names otherwise
+        rake("railties:install:migrations", abort_on_failure: true)
+        rake("db:migrate", abort_on_failure: true)
+        install_tasks.inject_seeder
+        rake("db:seed", abort_on_failure: true)
+      end
+
+      def finalize
+        header
+        say "Alchemy successfully installed!"
+        say "Now start the server with:\n\n"
+        say "  bin/rails server\n\n"
+        say "and point your browser to\n\n"
+        say "  http://localhost:3000/admin\n\n"
+        say "and follow the onscreen instructions to finalize the installation.\n\n"
+      end
+
       private
 
+      def header
+        return if options[:auto_accept]
+
+        puts "─────────────────────"
+        puts "* Alchemy Installer *"
+        puts "─────────────────────"
+      end
+
+      def say(something)
+        return if options[:auto_accept]
+
+        puts "  #{something}"
+      end
+
       def gem_config_path
         @_config_path ||= File.expand_path("../../../../config/alchemy", __dir__)
       end
@@ -105,6 +160,10 @@ module Alchemy
       def app_root
         @_app_root ||= Rails.root
       end
+
+      def install_tasks
+        @_install_tasks ||= Alchemy::Install::Tasks.new
+      end
     end
   end
 end

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/install.rake

@@ -1,59 +1,15 @@
 # frozen_string_literal: true
-require "thor"
-
-class Alchemy::InstallTask < Thor
-  include Thor::Actions
-
-  no_tasks do
-    def inject_routes
-      mountpoint = ask "\nAt which path do you want to mount Alchemy CMS at? (DEFAULT: At root path '/')"
-      mountpoint = "/" if mountpoint.empty?
-      sentinel = /\.routes\.draw do(?:\s*\|map\|)?\s*$/
-      inject_into_file "./config/routes.rb", "\n  mount Alchemy::Engine => '#{mountpoint}'\n", { after: sentinel, verbose: true }
-    end
-
-    def set_primary_language
-      code = ask "\nWhat's the language code of your site's primary language? (DEFAULT: en)"
-      code = "en" if code.empty?
-      name = ask "What's the name of your site's primary language? (DEFAULT: English)"
-      name = "English" if name.empty?
-      gsub_file "./config/alchemy/config.yml", /default_language:\n\s\scode:\sen\n\s\sname:\sEnglish/m do
-        "default_language:\n  code: #{code}\n  name: #{name}"
-      end
-    end
-
-    def inject_seeder
-      append_file "./db/seeds.rb", "Alchemy::Seeder.seed!\n"
-    end
-  end
-end
 
 namespace :alchemy do
   desc "Installs Alchemy CMS into your app."
-  task install: "alchemy:yarn:install" do
-    install_helper = Alchemy::InstallTask.new
-
-    puts "\nAlchemy Installer"
-    puts "-----------------"
-
-    Rake::Task["alchemy:mount"].invoke
-    system("rails g alchemy:install") || exit!(1)
-    install_helper.set_primary_language
-    Rake::Task["db:create"].invoke
-    # We can't invoke this rake task, because Rails will use wrong engine names otherwise
-    `bundle exec rake railties:install:migrations`
-    Rake::Task["db:migrate"].invoke
-    install_helper.inject_seeder
-    Rake::Task["db:seed"].invoke
-
-    puts "\nAlchemy successfully installed."
-    puts "\nNow start the server with:"
-    puts "\n$ bin/rails server"
-    puts "\nand point your browser to http://localhost:3000/admin and follow the onscreen instructions to finalize the installation."
+  task :install do
+    require "generators/alchemy/install/install_generator"
+    Alchemy::Generators::InstallGenerator.start
   end
 
   desc "Mounts Alchemy into your routes."
   task :mount do
-    Alchemy::InstallTask.new.inject_routes
+    require "alchemy/install/tasks"
+    Alchemy::InstallTasks.new.inject_routes
   end
 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