alchemy_cms 7.4.6 → 8.0.0.a

data/lib/alchemy_cms.rb

@@ -7,16 +7,15 @@ require "alchemy"
 require "acts_as_list"
 require "action_view/dependency_tracker"
 require "active_model_serializers"
+require "active_storage/engine"
 require "awesome_nested_set"
 require "cancan"
 require "dragonfly"
 require "gutentag"
 require "importmap-rails"
 require "kaminari"
-require "non_stupid_digest_assets"
 require "ransack"
 require "simple_form"
-require "sprockets/rails"
 require "turbo-rails"
 require "userstamp"
 require "view_component"
@@ -27,11 +26,9 @@ require_relative "alchemy/admin/locale"
 require_relative "alchemy/admin/preview_url"
 require_relative "alchemy/auth_accessors"
 require_relative "alchemy/cache_digests/template_tracker"
-require_relative "alchemy/config"
 require_relative "alchemy/configuration_methods"
 require_relative "alchemy/controller_actions"
 require_relative "alchemy/deprecation"
-require_relative "alchemy/element_definition"
 require_relative "alchemy/elements_finder"
 require_relative "alchemy/error_tracking"
 require_relative "alchemy/errors"
@@ -44,11 +41,8 @@ require_relative "alchemy/modules"
 require_relative "alchemy/name_conversions"
 require_relative "alchemy/on_page_layout"
 require_relative "alchemy/on_page_layout/callbacks_runner"
-require_relative "alchemy/page_layout"
 require_relative "alchemy/paths"
 require_relative "alchemy/permissions"
-require_relative "alchemy/resource"
-require_relative "alchemy/searchable_resource"
 require_relative "alchemy/tinymce"
 require_relative "alchemy/taggable"
 require_relative "alchemy/version"

data/lib/generators/alchemy/ingredient/ingredient_generator.rb

@@ -24,9 +24,6 @@ module Alchemy
 
       def copy_templates
         @ingredient_editor_local = "#{file_name}_editor"
-        @ingredient_view_local = "#{file_name}_view"
-        @ingredient_view_component_class = "#{@class_name}View"
-        template "view.html.erb", "#{@ingredients_view_path}/_#{file_name}_view.html.erb"
         template "editor.html.erb", "#{@ingredients_view_path}/_#{file_name}_editor.html.erb"
       end
 

data/lib/generators/alchemy/install/files/_article.html.erb

@@ -1,7 +1,9 @@
 <%- cache(article) do -%>
-  <%= element_view_for(article, tag: 'article') do |el| -%>
-    <h2><%= el.render :headline %></h2>
-    <%= el.render :picture, size: '1200x600' %>
-    <%= el.render :text %>
+  <%= element_view_for(article, tag: "article", class: "w-full max-w-xl mx-auto bg-slate-100 shadow my-8 px-8 py-4 rounded") do |el| -%>
+    <%= el.render :headline, {}, class: "text-2xl font-bold my-4" %>
+    <%= el.render :picture %>
+    <div class="[&>p]:my-2 [&>h2]:font-bold [&>h2]:text-xl [&>h2]:my-4 [&>h3]:font-bold [&>h3]:my-2 [&>ul]:list-disc [&>ul]:ml-4 [&>p>a]:underline [&>p>code]:text-sm [&>p>code]:bg-gray-50 [&>p>code]:p-1 [&>p>code]:whitespace-nowrap">
+      <%= el.render :text %>
+    </div>
   <%- end -%>
 <%- end -%>

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

@@ -17,14 +17,33 @@ en:
     # Default texts for new ingredients created
     default_ingredient_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/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: ingredients. The ingredients are:</p><ul><li>Text - <em>A single line of text</em></li><li>Richtext - <em>A TinyMCE powered formatted text block</em></li><li>Picture - <em>A reference to an image</em></li><li>Html - <em>HTML embed code</em></li><li>Select - <em>A selection of values</em></li><li>Boolean - <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>'
+      article_text: |
+        <h2>How to get started.</h2>
+        <p>First of all you should read about Alchemy and it's architecture <a class="external" href="https://guides.alchemy-cms.com/alchemy_approach.html" target="_blank" rel="noopener" data-link-target="blank">in the guidelines</a>.</p>
+        <p>The most important things to know about Alchemy are elements and page layouts.</p>
+        <h3>Elements:</h3>
+        <p>With Alchemy you can split pages into content parts, elements. These elements can be defined out of several base content types: ingredients. The ingredients are:</p>
+        <ul>
+          <li>Text - <em>A single line of text</em></li>
+          <li>Richtext - <em>A TinyMCE powered formatted text block</em></li>
+          <li>Picture - <em>A reference to an image</em></li>
+          <li>Html - <em>HTML embed code</em></li>
+          <li>Select - <em>A selection of values</em></li>
+          <li>Boolean - <em>A checkbox</em></li>
+        </ul>
+        <p>Elements get defined in <code>config/alchemy/elements.yml</code>.</p>
+        <p>Read more about elements and how to define them <a class="external" href="https://guides.alchemy-cms.com/elements.html" target="_blank" rel="noopener" data-link-target="blank">in the guidelines</a>.</p>
+        <h3>Page types:</h3>
+        <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 <code>config/alchemy/page_layouts.yml</code>.</p>
+        <p>Read more about defining page layouts <a class="external" href="https://guides.alchemy-cms.com/page_layouts.html" target="_blank" rel="noopener" data-link-target="blank">in the guidelines</a>.</p>
 
     # Hint texts for elements
     element_hints:
-      article: "This is a hint text for the article element. You can change this text in `config/locales/alchemy.en.yml`. Feel free to change it as you like, it's yours."
+      article: "This is a hint text for the article element. You can change this text in <code>config/locales/alchemy.en.yml</code>. Feel free to change it as you like, it's yours."
 
     # Hint texts for ingredients
     ingredient_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/customize_tinymce.html"
+      text: "This is a rich text block powered by TinyMCE editor. You can change the configuration of the editor. See https://guides.alchemy-cms.com/customize_tinymce.html"

data/lib/generators/alchemy/install/files/application.html.erb

@@ -7,6 +7,11 @@
 
     <%= stylesheet_link_tag 'application', media: 'all', 'data-turbo-track': 'reload' %>
     <%= javascript_include_tag 'application', 'data-turbo-track': 'reload' %>
+    <!--
+      Inserted by Alchemy demo file installer.
+      You probably want to remove this and use your custom css.
+    -->
+    <script src="https://cdn.tailwindcss.com"></script>
   </head>
 
   <body>

data/lib/generators/alchemy/install/install_generator.rb

@@ -53,18 +53,18 @@ module Alchemy
         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
-
       def copy_yml_files
         %w[elements page_layouts menus].each do |file|
           template "#{__dir__}/templates/#{file}.yml.tt", app_config_path.join("alchemy", "#{file}.yml")
         end
       end
 
+      def copy_config_rb
+        @default_config = Alchemy::Configurations::Main.new
+        template "#{__dir__}/templates/alchemy.rb.tt", app_config_path.join("initializers", "alchemy.rb")
+      end
+
       def install_assets
-        copy_file "all.js", app_vendor_assets_path.join("javascripts", "alchemy", "admin", "all.js")
         copy_file "custom.css", app_assets_path.join("stylesheets/alchemy/admin/custom.css")
       end
 
@@ -72,15 +72,6 @@ module Alchemy
         return if options[:skip_demo_files]
 
         copy_file "application.html.erb", app_views_path.join("layouts", "application.html.erb")
-        copy_file "article.css", app_assets_path.join("stylesheets", "alchemy", "elements", "_article.css")
-
-        stylesheet_require = %(@import "alchemy/elements/article";\n)
-        if File.exist?(app_assets_path.join("stylesheets", "application.css"))
-          prepend_file app_assets_path.join("stylesheets", "application.css"), stylesheet_require
-        else
-          create_file app_assets_path.join("stylesheets", "application.css"), stylesheet_require
-        end
-
         copy_file "_article.html.erb", app_views_path.join("alchemy", "elements", "_article.html.erb")
         copy_file "_standard.html.erb", app_views_path.join("alchemy", "page_layouts", "_standard.html.erb")
         copy_file "alchemy.en.yml", app_config_path.join("locales", "alchemy.en.yml")

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

@@ -0,0 +1,196 @@
+Alchemy.configure do |config|
+  # == This is the global Alchemy configuration file
+  #
+
+  # === Auto Log Out Time
+  #
+  # The amount of time of inactivity in minutes after which the user is kicked out of his current session.
+  #
+  # NOTE: This is only active in production environments
+  #
+  # config.auto_logout_time = <%= @default_config.auto_logout_time.inspect %>
+
+  # === Page caching
+  #
+  # Enable/Disable page caching globally.
+  #
+  # NOTE: You can enable/disable page caching for single Alchemy::Definitions in the page_layout.yml file.
+  #
+  # config.cache_pages = <%= @default_config.cache_pages.inspect %>
+
+  # === Sitemap
+  #
+  # Alchemy creates a XML, Google compatible, sitemap for you.
+  #
+  # The url is: http://your-domain.tld/sitemap.xml
+  #
+  # ==== Config Options:
+  #
+  #   show_root [Boolean] # Show language root page in sitemap?
+  #   show_flag [Boolean] # Enables the Checkbox in Page#update overlay. So your customer can set the visibility of pages in the sitemap.
+  #
+  # config.sitemap.tap do |sitemap|
+  #   sitemap.show_root = <%= @default_config.sitemap.show_root.inspect %>
+  #   sitemap.show_flag = <%= @default_config.sitemap.show_flag.inspect %>
+  # end
+
+  # === Default items per page in admin views
+  #
+  # In Alchemy's Admin, change how many items you would get shown per page by Kaminari
+  # config.items_per_page = <%= @default_config.items_per_page %>
+
+  # === Preview window URL configuration
+  #
+  # By default Alchemy uses its internal page preview renderer,
+  # but you can configure it to be any URL instead.
+  #
+  # Basic Auth is supported.
+  #
+  # config.preview = {
+  #   host: https://www.my-static-site.com
+  #   auth:
+  #     username: <%%= ENV["BASIC_AUTH_USERNAME"] %%>
+  #     password: <%%= ENV["BASIC_AUTH_PASSWORD"] %%>
+  # }
+  # Preview config per site is supported as well.
+  #
+  # config.preview = {
+  #   My site name:
+  #     host: https://www.my-static-site.com
+  #     auth:
+  #       username: <%%= ENV["BASIC_AUTH_USERNAME"] %%>
+  #       password: <%%= ENV["BASIC_AUTH_PASSWORD"] %%>
+  # }
+
+  # === Picture rendering settings
+  #
+  # Alchemy uses Dragonfly to render images. Settings for image rendering are specific to elements and are defined in elements.yml
+  #
+  # Example:
+  # - name: some_element
+  #   ingredients:
+  #   - role: some_picture
+  #     type: Picture
+  #     settings:
+  #       hint: true
+  #       crop: true  # turns on image cropping
+  #       size: '500x500' # image will be cropped to this size
+  #
+  # See http://markevans.github.com/dragonfly for further info.
+  #
+  # ==== Global Options:
+  #
+  #   output_image_quality      [Integer]       # If image gets rendered as JPG or WebP this is the quality setting for it. (Default 85)
+  #   preprocess_image_resize   [String]        # Use this option to resize images to the given size when they are uploaded to the image library. Downsizing example: '1000x1000>' (Default nil)
+  #   image_output_format       [String]        # The global image output format setting. (Default +original+)
+  #
+  # NOTE: You can always override the output format in the settings of your ingredients in elements.yml, I.E. {format: 'gif'}
+  #
+  # config.output_image_quality = <%= @default_config.output_image_quality %>
+  # config.preprocess_image_resize = <%= @default_config.preprocess_image_resize.inspect %>
+  # config.image_output_format = <%= @default_config.image_output_format.inspect %>
+
+  # This is used by the seeder to create the default site.
+  # config.default_site.tap do |default_site|
+  #   default_site.name = <%= @default_config.default_site.name.inspect %>
+  #   default_site.host = <%= @default_config.default_site.host.inspect %>
+  # end
+
+  # This is the default language when seeding.
+  # config.default_language.tap do |default_language|
+  #   default_language.code = <%= @default_config.default_language.code.inspect %>
+  #   default_language.name = <%= @default_config.default_language.name.inspect %>
+  #   default_language.page_layout = <%= @default_config.default_language.page_layout.inspect %>
+  #   default_language.frontpage_name = <%= @default_config.default_language.frontpage_name.inspect %>
+  # end
+
+  # === Mailer Settings:
+  #
+  # To send emails via contact forms, you can create your form fields here and set which fields are to be validated.
+  #
+  # === Validating fields:
+  #
+  # Pass the field name as a symbol and a message_id (will be translated) to :validate_fields:
+  #
+  # ==== Options:
+  #
+  #   page_layout_name:           [String] # A +Alchemy::PageDefinition+ name. Used to render the contactform on a page with this layout.
+  #   fields:                     [Array]  # An Array of fieldnames.
+  #   validate_fields:            [Array]  # An Array of fieldnames to be validated on presence.
+  #
+  # ==== Translating validation messages:
+  #
+  # The validation messages are passed through ::I18n.t so you can translate it in your language yml file.
+  #
+  # ==== Example:
+  #
+  #   de:
+  #     activemodel:
+  #       attributes:
+  #         alchemy/message:
+  #           firstname: Vorname
+  #
+  # config.mailer.tap do |mailer|
+  #   mailer.page_layout_name = <%= @default_config.mailer.page_layout_name.inspect %>
+  #   mailer.forward_to_page = <%= @default_config.mailer.forward_to_page.inspect %>
+  #   mailer.mail_success_page = <%= @default_config.mailer.mail_success_page.inspect %>
+  #   mailer.mail_from = <%= @default_config.mailer.mail_from.inspect %>
+  #   mailer.mail_to = <%= @default_config.mailer.mail_to.inspect %>
+  #   mailer.subject = <%= @default_config.mailer.subject.inspect %>
+  #   mailer.fields = <%= @default_config.mailer.fields.inspect %>
+  #   mailer.validate_fields = <%= @default_config.mailer.validate_fields.inspect %>
+  # end
+
+  # === User roles
+  #
+  # You can add own user roles.
+  #
+  # Further documentation for the auth system used please visit:
+  #
+  # https://github.com/ryanb/cancan/wiki
+  #
+  # ==== Translating User roles
+  #
+  # Userroles can be translated inside your the language yml file under:
+  #
+  #   alchemy:
+  #     user_roles:
+  #       rolename: Name of the role
+  #
+  # config.user_roles = <%= @default_config.user_roles.inspect %>
+
+  # === Uploader Settings
+  #
+  #   upload_limit       [Integer]    # Set an amount of files upload limit of files which can be uploaded at once. Set 0 for unlimited.
+  #   file_size_limit*   [Integer]    # Set a file size limit in mega bytes for a per file limit.
+  #
+  # *) Allow filetypes to upload. Pass * to allow all kind of files.
+  #
+  # config.uploader.tap do |uploader|
+  #   uploader.upload_limit = <%= @default_config.uploader.upload_limit.inspect %>
+  #   uploader.file_size_limit = <%= @default_config.uploader.file_size_limit.inspect %>
+  #   uploader.allowed_filetypes.tap do |file_types|
+  #     file_types.alchemy_attachments = <%= @default_config.uploader.allowed_filetypes.alchemy_attachments.inspect %>
+  #     file_types.alchemy_pictures = <%= @default_config.uploader.allowed_filetypes.alchemy_pictures.inspect %>
+  #   end
+  # end
+
+  # === Link Target Options
+  #
+  # Values for the link target selectbox inside the page link overlay.
+  # The value gets attached as a data-link-target attribute to the link.
+  #
+  # == Example:
+  #
+  # Open all links set to overlay inside an jQuery UI Dialog Window.
+  #
+  #   jQuery(a[data-link-target="overlay"]).dialog();
+  #
+  # config.link_target_options = <%= @default_config.link_target_options.inspect %>
+
+  # The layout used for rendering the +alchemy/admin/pages#show+ action.
+  # config.admin_page_preview_layout = <%= @default_config.admin_page_preview_layout.inspect %>
+
+  # The sizes for the preview size select in the page editor.
+  # config.page_preview_sizes = <%= @default_config.page_preview_sizes.inspect %>
+end

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

@@ -14,7 +14,6 @@
 Dragonfly.app(:alchemy_pictures).configure do
   dragonfly_url nil
   plugin :imagemagick
-  plugin :svg
   secret "<%= SecureRandom.hex(32) %>"
   url_format "/pictures/:job/:basename.:ext"
 

data/lib/generators/alchemy/install/templates/elements.yml.tt

@@ -8,12 +8,14 @@
   unique: true
   ingredients:
     - role: headline
-      type: Text
+      type: Headline
       default: :article_headline
       hint: true
     - role: picture
       type: Picture
       hint: true
+      settings:
+        size: 1200x600
     - role: text
       type: Richtext
       default: :article_text

data/lib/generators/alchemy/install/templates/menus.yml.tt

@@ -1,6 +1,6 @@
 # == In this configuration, you set up Alchemy's menu names.
 #
-# For further information please see http://guides.alchemy-cms.com/stable/menus.html
+# For further information please see https://guides.alchemy-cms.com/
 
 <%- unless @options[:skip_demo_files] -%>
 - main_menu

data/lib/generators/alchemy/install/templates/page_layouts.yml.tt

@@ -1,9 +1,9 @@
 # == This file defines the page layouts for new pages.
 #
-# For further information please see http://guides.alchemy-cms.com/stable/page_layouts.html
+# For further information please see https://guides.alchemy-cms.com/pages.html
 
 <%- unless @options[:skip_demo_files] -%>
-- name: <%= Alchemy::Config.get(:default_language)['page_layout'] %>
+- name: <%= Alchemy.config.default_language.page_layout %>
   unique: true
   elements: [article]
   autogenerate: [article]

data/lib/generators/alchemy/page_layouts/page_layouts_generator.rb

@@ -13,8 +13,8 @@ module Alchemy
         return unless @page_layouts
 
         @page_layouts.each do |page_layout|
-          @page_layout_name = page_layout["name"].underscore
-          conditional_template "layout.html.#{template_engine}", "#{page_layouts_dir}/_#{@page_layout_name}.html.#{template_engine}"
+          layout_name = page_layout.name.underscore
+          conditional_template "layout.html.#{template_engine}", "#{page_layouts_dir}/_#{layout_name}.html.#{template_engine}"
         end
       end
 

data/lib/tasks/alchemy/assets.rake

@@ -0,0 +1,14 @@
+if Rake::Task.task_defined?("assets:precompile") && defined?(Propshaft)
+  Rake::Task["assets:precompile"].enhance do
+    manifest_path = Rails.application.config.assets.manifest_path
+    assets_path = Rails.root.join("public#{Rails.application.config.assets.prefix}")
+    manifest = JSON.parse(manifest_path.read)
+    manifest.select { |k| k.include?("tinymce/") }.each do |k, v|
+      Propshaft.logger.info "Copying #{v} to #{k}"
+      FileUtils.cp(
+        assets_path.join(v),
+        assets_path.join(k)
+      )
+    end
+  end
+end

data/lib/tasks/alchemy/upgrade.rake

@@ -3,14 +3,16 @@
 require "alchemy/upgrader"
 require "alchemy/version"
 
+Upgrader = Alchemy::Upgrader.new("8.0")
+
 namespace :alchemy do
   desc "Upgrades your app to AlchemyCMS v#{Alchemy::VERSION}."
   task upgrade: [
     "alchemy:upgrade:prepare",
-    "alchemy:upgrade:7.3:run",
-    "alchemy:upgrade:7.4:run"
+    "alchemy:upgrade:8.0:run"
   ] do
-    Alchemy::Upgrader.display_todos
+    Upgrader.run_migrations
+    Upgrader.display_todos
   end
 
   namespace :upgrade do
@@ -22,58 +24,21 @@ namespace :alchemy do
 
     desc "Alchemy Upgrader: Prepares the database."
     task database: [
-      "alchemy:install:migrations",
-      "db:migrate"
+      "alchemy:install:migrations"
     ]
 
-    desc "Alchemy Upgrader: Copy configuration file."
+    desc "Alchemy Upgrader: Update configuration file."
     task config: [:environment] do
-      Alchemy::Upgrader.copy_new_config_file
-    end
-
-    desc "Upgrade Alchemy to v7.3"
-    task "7.3" => [
-      "alchemy:upgrade:prepare",
-      "alchemy:upgrade:7.3:run"
-    ] do
-      Alchemy::Upgrader.display_todos
-    end
-
-    desc "Upgrade Alchemy to v7.4"
-    task "7.4" => [
-      "alchemy:upgrade:prepare",
-      "alchemy:upgrade:7.4:run"
-    ] do
-      Alchemy::Upgrader.display_todos
-    end
-
-    namespace "7.3" do
-      task "run" => [
-        "alchemy:upgrade:7.3:remove_admin_stylesheets",
-        "alchemy:upgrade:7.3:generate_custom_css_entrypoint"
-      ] do
-        Alchemy::Upgrader::SevenPointThree.show_resource_table_notice
-      end
-
-      desc "Remove alchemy admin stylesheets"
-      task remove_admin_stylesheets: [:environment] do
-        Alchemy::Upgrader::SevenPointThree.remove_admin_stylesheets
-      end
-
-      desc "Generate custom css entrypoint"
-      task generate_custom_css_entrypoint: [:environment] do
-        Alchemy::Upgrader::SevenPointThree.generate_custom_css_entrypoint
-      end
+      Upgrader.update_config
     end
 
-    namespace "7.4" do
+    namespace "8.0" do
       task "run" => [
-        "alchemy:upgrade:7.4:update_custom_css_config"
+        "alchemy:upgrade:8.0:mention_alchemy_config_initializer"
       ]
 
-      desc "Update custom alchemy admin stylesheet config"
-      task update_custom_css_config: [:environment] do
-        Alchemy::Upgrader::SevenPointFour.update_custom_css_config
+      task :mention_alchemy_config_initializer do
+        Upgrader.mention_alchemy_config_initializer
       end
     end
   end