alchemy_cms 5.1.4 → 6.0.0.b1

data/app/controllers/alchemy/admin/ingredients_controller.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Alchemy
+  module Admin
+    class IngredientsController < Alchemy::Admin::BaseController
+      load_and_authorize_resource class: Alchemy::Ingredient
+
+      include CropAction
+
+      helper "Alchemy::Admin::Ingredients"
+
+      def edit
+      end
+
+      def update
+        @ingredient.update(ingredient_params)
+      end
+
+      private
+
+      def ingredient_params
+        params.require(:ingredient).permit(@ingredient.class.stored_attributes[:data])
+      end
+
+      def load_croppable_resource
+        @croppable_resource = @ingredient
+      end
+    end
+  end
+end

data/app/controllers/alchemy/admin/layoutpages_controller.rb

@@ -16,7 +16,6 @@ module Alchemy
 
       def edit
         @page = Page.find(params[:id])
-        @page_layouts = PageLayout.layouts_with_own_for_select(@page.page_layout, @current_language.id, true)
       end
     end
   end

data/app/controllers/alchemy/admin/pages_controller.rb

@@ -33,6 +33,8 @@ module Alchemy
 
       before_action :set_view, only: [:index]
 
+      before_action :set_page_version, only: [:show, :edit]
+
       def index
         @query = @current_language.pages.contentpages.ransack(search_filter_params[:q])
 
@@ -118,7 +120,6 @@ module Alchemy
 
       # Set page configuration like page names, meta tags and states.
       def configure
-        @page_layouts = PageLayout.layouts_with_own_for_select(@page.page_layout, @current_language.id, @page.layoutpage?)
       end
 
       # Updates page
@@ -191,24 +192,12 @@ module Alchemy
         end
       end
 
-      def visit
-        @page.unlock!
-        redirect_to show_page_url(
-          urlname: @page.urlname,
-          locale: prefix_locale? ? @page.language_code : nil,
-          host: @page.site.host == "*" ? request.host : @page.site.host,
-        )
-      end
-
       # Sets the page public and updates the published_at attribute that is used as cache_key
       #
       def publish
         # fetching page via before filter
         @page.publish!
 
-        # Send publish notification to all registered publish targets
-        Alchemy.publish_targets.each { |p| p.perform_later(@page) }
-
         flash[:notice] = Alchemy.t(:page_published, name: @page.name)
         redirect_back(fallback_location: admin_pages_path)
       end
@@ -403,6 +392,10 @@ module Alchemy
         @page_root = @current_language.root_page
       end
 
+      def set_page_version
+        @page_version = @page.draft_version
+      end
+
       def serialized_page_tree
         PageTreeSerializer.new(@page, ability: current_ability,
                                       user: current_alchemy_user,

data/app/controllers/alchemy/admin/pictures_controller.rb

@@ -9,12 +9,16 @@ module Alchemy
       helper "alchemy/admin/tags"
 
       before_action :load_resource,
-        only: [:show, :edit, :update, :destroy, :info]
+        only: [:show, :edit, :update, :url, :destroy, :info]
 
       before_action :set_size, only: [:index, :show, :edit_multiple]
 
       authorize_resource class: Alchemy::Picture
 
+      before_action(only: :assign) do
+        @picture = Picture.find(params[:id])
+      end
+
       def index
         @query = Picture.ransack(search_filter_params[:q])
         @pictures = Picture.search_by(
@@ -32,10 +36,21 @@ module Alchemy
       def show
         @previous = @picture.previous(params)
         @next = @picture.next(params)
-        @assignments = @picture.essence_pictures.joins(content: {element: :page})
+        @assignments = @picture.essence_pictures.joins(content: { element: :page })
         render action: "show"
       end
 
+      def url
+        options = picture_url_params.to_h.symbolize_keys.transform_values! do |value|
+          value.in?(%w[true false]) ? value == "true" : value
+        end
+        render json: {
+          url: @picture.url(options),
+          alt: @picture.name,
+          title: Alchemy.t(:image_name, name: @picture.name),
+        }
+      end
+
       def create
         @picture = Picture.new(picture_params)
         @picture.name = @picture.humanized_name
@@ -125,8 +140,8 @@ module Alchemy
           end
         else
           cookies[:alchemy_pictures_per_page] = params[:per_page] ||
-            cookies[:alchemy_pictures_per_page] ||
-            pictures_per_page_for_size
+                                                cookies[:alchemy_pictures_per_page] ||
+                                                pictures_per_page_for_size
         end
       end
 
@@ -158,17 +173,28 @@ module Alchemy
       def search_filter_params
         @_search_filter_params ||= params.except(*COMMON_SEARCH_FILTER_EXCLUDES + [:picture_ids]).permit(
           *common_search_filter_includes + [
-            :size,
-            :element_id,
-            :swap,
-            :content_id,
-          ],
+          :size,
+          :form_field_id,
+        ],
         )
       end
 
       def picture_params
         params.require(:picture).permit(:image_file, :upload_hash, :name, :tag_list)
       end
+
+      def picture_url_params
+        params.permit(
+          :crop_from,
+          :crop_size,
+          :crop,
+          :flatten,
+          :format,
+          :quality,
+          :size,
+          :upsample
+        )
+      end
     end
   end
 end

data/app/controllers/alchemy/api/elements_controller.rb

@@ -9,18 +9,21 @@ module Alchemy
     # If you want to only load a specific type of element pass ?named=an_element_name
     #
     def index
-      @elements = Element.not_nested
+      if params[:page_id].present?
+        @page = Page.find(params[:page_id])
+        @elements = @page.elements.not_nested
+      else
+        @elements = Element.not_nested.joins(:page_version).merge(PageVersion.published)
+      end
+
       # Fix for cancancan not able to merge multiple AR scopes for logged in users
       if cannot? :manage, Alchemy::Element
         @elements = @elements.accessible_by(current_ability, :index)
       end
-      if params[:page_id].present?
-        @elements = @elements.where(page_id: params[:page_id])
-      end
       if params[:named].present?
         @elements = @elements.named(params[:named])
       end
-      @elements = @elements.includes(*element_includes)
+      @elements = @elements.includes(*element_includes).order(:position)
 
       render json: @elements, adapter: :json, root: "elements"
     end
@@ -43,6 +46,7 @@ module Alchemy
               contents: {
                 essence: :ingredient_association,
               },
+              ingredients: :related_object,
             },
             :tags,
           ],
@@ -51,6 +55,7 @@ module Alchemy
           contents: {
             essence: :ingredient_association,
           },
+          ingredients: :related_object,
         },
         :tags,
       ]

data/app/controllers/alchemy/api/pages_controller.rb

@@ -7,11 +7,10 @@ module Alchemy
     # Returns all pages as json object
     #
     def index
+      @pages = Language.current&.pages.presence || Alchemy::Page.none
       # Fix for cancancan not able to merge multiple AR scopes for logged in users
-      if can? :edit_content, Alchemy::Page
-        @pages = Page.all
-      else
-        @pages = Page.accessible_by(current_ability, :index)
+      if cannot? :edit_content, Alchemy::Page
+        @pages = @pages.accessible_by(current_ability, :index)
       end
       @pages = @pages.includes(*page_includes)
       @pages = @pages.ransack(params[:q]).result

data/app/controllers/concerns/alchemy/admin/archive_overlay.rb

@@ -2,18 +2,28 @@
 module Alchemy
   module Admin
     module ArchiveOverlay
+      # Sets assignable id on given form field via JS.
+      #
+      # When the user saves the model the assignable
+      # gets persisted with the model as well.
+      #
+      def assign
+        @assignable_id = params[:id]
+        @form_field_id = params[:form_field_id]
+      end
+
       private
 
       def in_overlay?
-        params[:content_id].present?
+        params[:form_field_id].present?
       end
 
       def archive_overlay
-        @content = Content.find_by(id: params[:content_id])
+        @form_field_id = params[:form_field_id]
 
         respond_to do |format|
           format.html { render partial: "archive_overlay" }
-          format.js   { render action:  "archive_overlay" }
+          format.js { render action: "archive_overlay" }
         end
       end
     end

data/app/controllers/concerns/alchemy/admin/crop_action.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Alchemy
+  module Admin
+    module CropAction
+      extend ActiveSupport::Concern
+
+      included do
+        before_action :load_croppable_resource, only: [:crop]
+      end
+
+      def crop
+        @picture = Alchemy::Picture.find_by(id: params[:picture_id])
+        if @picture
+          @croppable_resource.picture = @picture
+          @settings = @croppable_resource.image_cropper_settings
+          @element = @croppable_resource.element
+        else
+          @no_image_notice = Alchemy.t(:no_image_for_cropper_found)
+        end
+
+        render template: "alchemy/admin/crop"
+      end
+    end
+  end
+end

data/app/decorators/alchemy/content_editor.rb

@@ -12,6 +12,7 @@ module Alchemy
       [
         "content_editor",
         essence_partial_name,
+        deprecated? ? "deprecated" : nil,
       ].compact
     end
 
@@ -51,5 +52,68 @@ module Alchemy
 
       super
     end
+
+    def has_warnings?
+      definition.blank? || deprecated?
+    end
+
+    def warnings
+      return unless has_warnings?
+
+      if definition.blank?
+        Logger.warn("Content #{name} is missing its definition", caller(1..1))
+        Alchemy.t(:content_definition_missing)
+      else
+        deprecation_notice
+      end
+    end
+
+    # Returns a deprecation notice for contents marked deprecated
+    #
+    # You can either use localizations or pass a String as notice
+    # in the content definition.
+    #
+    # == Custom deprecation notices
+    #
+    # Use general content deprecation notice
+    #
+    #     - name: element_name
+    #       contents:
+    #         - name: old_content
+    #           type: EssenceText
+    #           deprecated: true
+    #
+    # Add a translation to your locale file for a per content notice.
+    #
+    #     en:
+    #       alchemy:
+    #         content_deprecation_notices:
+    #           element_name:
+    #             old_content: Foo baz widget is deprecated
+    #
+    # or use the global translation that apply to all deprecated contents.
+    #
+    #     en:
+    #       alchemy:
+    #         content_deprecation_notice: Foo baz widget is deprecated
+    #
+    # or pass string as deprecation notice.
+    #
+    #     - name: element_name
+    #       contents:
+    #         - name: old_content
+    #           type: EssenceText
+    #           deprecated: This content will be removed soon.
+    #
+    def deprecation_notice
+      case definition["deprecated"]
+      when String
+        definition["deprecated"]
+      when TrueClass
+        Alchemy.t(name,
+                  scope: [:content_deprecation_notices, element.name],
+                  default: Alchemy.t(:content_deprecated))
+      end
+    end
   end
 end

data/app/decorators/alchemy/element_editor.rb

@@ -19,6 +19,23 @@ module Alchemy
       end
     end
 
+    # Returns ingredient editor instances for defined ingredients
+    #
+    # Creates ingredient on demand if the ingredient is not yet present on the element
+    #
+    # @return Array<Alchemy::IngredientEditor>
+    def ingredients
+      element.definition.fetch(:ingredients, []).map do |ingredient|
+        Alchemy::IngredientEditor.new(find_or_create_ingredient(ingredient[:role]))
+      end
+    end
+
+    # Are any ingredients defined?
+    # @return [Boolean]
+    def has_ingredients_defined?
+      element.definition.fetch(:ingredients, []).any?
+    end
+
     # CSS classes for the element editor partial.
     def css_classes
       [
@@ -28,6 +45,7 @@ module Alchemy
         taggable? ? "taggable" : "not-taggable",
         folded ? "folded" : "expanded",
         compact? ? "compact" : nil,
+        deprecated? ? "deprecated" : nil,
         fixed? ? "is-fixed" : "not-fixed",
         public? ? "visible" : "hidden",
       ].join(" ")
@@ -37,7 +55,7 @@ module Alchemy
     def editable?
       return false if folded?
 
-      content_definitions.present? || taggable?
+      content_definitions.present? || ingredient_definitions.any? || taggable?
     end
 
     # Fixes Rails partial renderer calling to_model on the object
@@ -102,5 +120,10 @@ module Alchemy
     def create_content(name)
       Alchemy::Content.create(element: element, name: name)
     end
+
+    def find_or_create_ingredient(role)
+      element.ingredients.find { |i| i.role == role } ||
+        Ingredient.create(element: element, role: role)
+    end
   end
 end

data/app/decorators/alchemy/ingredient_editor.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+module Alchemy
+  class IngredientEditor < SimpleDelegator
+    alias_method :ingredient, :__getobj__
+
+    def to_partial_path
+      "alchemy/ingredients/#{partial_name}_editor"
+    end
+
+    # Returns the translated role for displaying in labels
+    #
+    # Translate it in your locale yml file:
+    #
+    #   alchemy:
+    #     ingredient_roles:
+    #       foo: Bar
+    #
+    # Optionally you can scope your ingredient role to an element:
+    #
+    #   alchemy:
+    #     ingredient_roles:
+    #       article:
+    #         foo: Baz
+    #
+    def translated_role
+      Alchemy.t(
+        role,
+        scope: "ingredient_roles.#{element.name}",
+        default: Alchemy.t("ingredient_roles.#{role}", default: role.humanize),
+      )
+    end
+
+    def css_classes
+      [
+        "ingredient-editor",
+        partial_name,
+        deprecated? ? "deprecated" : nil,
+      ].compact
+    end
+
+    def data_attributes
+      {
+        ingredient_id: id,
+        ingredient_role: role,
+      }
+    end
+
+    # Returns a string to be passed to Rails form field tags to ensure it can be used with Rails' nested attributes.
+    #
+    # === Example:
+    #
+    #   <%= text_field_tag text_editor.form_field_name, text_editor.value %>
+    #
+    # === Options:
+    #
+    # You can pass an Ingredient column_name. Default is 'value'
+    #
+    # ==== Example:
+    #
+    #   <%= text_field_tag text_editor.form_field_name(:link), text_editor.value %>
+    #
+    def form_field_name(column = "value")
+      "element[ingredients_attributes][#{form_field_counter}][#{column}]"
+    end
+
+    def form_field_id(column = "value")
+      "element_ingredients_attributes_#{form_field_counter}_#{column}"
+    end
+
+    # Fixes Rails partial renderer calling to_model on the object
+    # which reveals the delegated ingredient instead of this decorator.
+    def respond_to?(method_name)
+      return false if method_name == :to_model
+
+      super
+    end
+
+    def has_warnings?
+      definition.blank? || deprecated?
+    end
+
+    def linked?
+      link.try(:present?)
+    end
+
+    def warnings
+      return unless has_warnings?
+
+      if definition.blank?
+        Logger.warn("ingredient #{role} is missing its definition", caller(1..1))
+        Alchemy.t(:ingredient_definition_missing)
+      else
+        deprecation_notice
+      end
+    end
+
+    # Returns a deprecation notice for ingredients marked deprecated
+    #
+    # You can either use localizations or pass a String as notice
+    # in the ingredient definition.
+    #
+    # == Custom deprecation notices
+    #
+    # Use general ingredient deprecation notice
+    #
+    #     - name: element_name
+    #       ingredients:
+    #         - role: old_ingredient
+    #           type: Text
+    #           deprecated: true
+    #
+    # Add a translation to your locale file for a per ingredient notice.
+    #
+    #     en:
+    #       alchemy:
+    #         ingredient_deprecation_notices:
+    #           element_name:
+    #             old_ingredient: Foo baz widget is deprecated
+    #
+    # or use the global translation that apply to all deprecated ingredients.
+    #
+    #     en:
+    #       alchemy:
+    #         ingredient_deprecation_notice: Foo baz widget is deprecated
+    #
+    # or pass string as deprecation notice.
+    #
+    #     - name: element_name
+    #       ingredients:
+    #         - role: old_ingredient
+    #           type: Text
+    #           deprecated: This ingredient will be removed soon.
+    #
+    def deprecation_notice
+      case definition[:deprecated]
+      when String
+        definition[:deprecated]
+      when TrueClass
+        Alchemy.t(
+          role,
+          scope: [:ingredient_deprecation_notices, element.name],
+          default: Alchemy.t(:ingredient_deprecated),
+        )
+      end
+    end
+
+    private
+
+    def form_field_counter
+      element.definition.fetch(:ingredients, []).index { |i| i[:role] == role }
+    end
+  end
+end