alchemy_cms 5.2.0 → 6.0.0.b3

data/app/models/alchemy/ingredient_validator.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module Alchemy
+  # Ingredient Validations:
+  #
+  # Ingredient validations can be set inside the +config/elements.yml+ file.
+  #
+  # Supported validations are:
+  #
+  # * presence
+  # * uniqueness
+  # * format
+  #
+  # *) format needs to come with a regex or a predefined matcher string as its value.
+  #
+  # There are already predefined format matchers listed in the +config/alchemy/config.yml+ file.
+  # It is also possible to add own format matchers there.
+  #
+  # Example of format matchers in +config/alchemy/config.yml+:
+  #
+  # format_matchers:
+  #   email: !ruby/regexp '/\A[^@\s]+@([^@\s]+\.)+[^@\s]+\z/'
+  #   url:   !ruby/regexp '/\A[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,5}(:[0-9]{1,5})?(\/.*)?\z/ix'
+  #   ssl:   !ruby/regexp '/https:\/\/[\S]+/'
+  #
+  # Example of an element definition with ingredient validations:
+  #
+  #   - name: person
+  #     ingredients:
+  #     - role: name
+  #       type: Text
+  #       validate: [presence]
+  #     - role: email
+  #       type: Text
+  #       validate: [format: 'email']
+  #     - role: homepage
+  #       type: Text
+  #       validate: [format: !ruby/regexp '^[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,5}(:[0-9]{1,5})?(\/.*)?$']
+  #
+  # Example of an element definition with chained validations.
+  #
+  #   - name: person
+  #     ingredients:
+  #     - role: name
+  #       type: Text
+  #       validate: [presence, uniqueness, format: 'name']
+  #
+  class IngredientValidator < ActiveModel::Validator
+    def validate(ingredient)
+      @ingredient = ingredient
+      validations.each do |validation|
+        if validation.respond_to?(:keys)
+          validation.map do |key, value|
+            send("validate_#{key}", value)
+          end
+        else
+          send("validate_#{validation}")
+        end
+      end
+    end
+
+    private
+
+    attr_reader :ingredient
+
+    def validations
+      ingredient.definition.fetch(:validate, [])
+    end
+
+    def validate_presence(*)
+      if ingredient.value.blank?
+        ingredient.errors.add(:value, :blank)
+      end
+    end
+
+    def validate_uniqueness(*)
+      if duplicates.any?
+        ingredient.errors.add(:value, :taken)
+      end
+    end
+
+    def validate_format(format)
+      matcher = Alchemy::Config.get("format_matchers")[format] || format
+      if !ingredient.value.to_s.match?(Regexp.new(matcher))
+        ingredient.errors.add(:value, :invalid)
+      end
+    end
+
+    def duplicates
+      ingredient.class
+        .joins(:element).merge(Alchemy::Element.available)
+        .where(Alchemy::Element.table_name => { name: ingredient.element.name })
+        .where(value: ingredient.value)
+        .where.not(id: ingredient.id)
+    end
+  end
+end

data/app/models/alchemy/ingredients/audio.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Alchemy
+  module Ingredients
+    # A audio attachment
+    #
+    class Audio < Alchemy::Ingredient
+      store_accessor :data,
+        :autoplay,
+        :controls,
+        :muted,
+        :loop
+
+      related_object_alias :attachment, class_name: "Alchemy::Attachment"
+
+      delegate :name, to: :attachment, allow_nil: true
+
+      # The first 30 characters of the attachments name
+      #
+      # Used by the Element#preview_text method.
+      #
+      # @param [Integer] max_length (30)
+      #
+      def preview_text(max_length = 30)
+        name.to_s[0..max_length - 1]
+      end
+    end
+  end
+end

data/app/models/alchemy/ingredients/boolean.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Alchemy
+  module Ingredients
+    # A boolean value
+    #
+    class Boolean < Alchemy::Ingredient
+      def value
+        ActiveRecord::Type::Boolean.new.cast(self[:value])
+      end
+
+      # The localized value
+      #
+      # Used by the Element#preview_text method.
+      #
+      def preview_text(_max_length = nil)
+        Alchemy.t(value, scope: "ingredient_values.boolean")
+      end
+    end
+  end
+end

data/app/models/alchemy/ingredients/datetime.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Alchemy
+  module Ingredients
+    # A datetime value
+    #
+    class Datetime < Alchemy::Ingredient
+      def value
+        ActiveRecord::Type::DateTime.new.cast(self[:value])
+      end
+
+      # Returns localized date for the Element#preview_text method.
+      def preview_text(_maxlength = nil)
+        return "" unless value
+
+        ::I18n.l(value, format: :'alchemy.essence_date')
+      end
+    end
+  end
+end

data/app/models/alchemy/ingredients/file.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Alchemy
+  module Ingredients
+    # A link to a file
+    #
+    # Attach Alchemy::Attachment into this ingredient
+    #
+    class File < Alchemy::Ingredient
+      store_accessor :data,
+        :css_class,
+        :link_text,
+        :title
+
+      related_object_alias :attachment, class_name: "Alchemy::Attachment"
+
+      delegate :name, to: :attachment, allow_nil: true
+
+      # The first 30 characters of the attachments name
+      #
+      # Used by the Element#preview_text method.
+      #
+      # @param [Integer] max_length (30)
+      #
+      def preview_text(max_length = 30)
+        attachment&.name.to_s[0..max_length - 1]
+      end
+    end
+  end
+end

data/app/models/alchemy/ingredients/headline.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Alchemy
+  module Ingredients
+    # A text headline
+    #
+    class Headline < Alchemy::Ingredient
+      store_accessor :data,
+        :level,
+        :size
+
+      before_create :set_level_and_size
+
+      def preview_text(maxlength = 30)
+        "H#{level}: #{value}"[0..maxlength - 1]
+      end
+
+      def level_options
+        levels.map { |level| ["H#{level}", level] }
+      end
+
+      def size_options
+        sizes.map { |size| ["H#{size}", size] }
+      end
+
+      private
+
+      def levels
+        settings.fetch(:levels, (1..6))
+      end
+
+      def sizes
+        settings.fetch(:sizes, [])
+      end
+
+      def set_level_and_size
+        self.level ||= levels.first
+        self.size ||= sizes.first
+      end
+    end
+  end
+end

data/app/models/alchemy/ingredients/html.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Alchemy
+  module Ingredients
+    # A HTML string
+    #
+    class Html < Alchemy::Ingredient
+      # The first 30 escaped characters from value
+      #
+      # Used by the Element#preview_text method.
+      #
+      # @param [Integer] max_length (30)
+      #
+      def preview_text(max_length = 30)
+        ::CGI.escapeHTML(value.to_s)[0..max_length - 1]
+      end
+    end
+  end
+end

data/app/models/alchemy/ingredients/link.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Alchemy
+  module Ingredients
+    # A URL
+    #
+    class Link < Alchemy::Ingredient
+      store_accessor :data,
+        :link_class_name,
+        :link_target,
+        :link_title
+
+      alias_method :link, :value
+    end
+  end
+end

data/app/models/alchemy/ingredients/node.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Alchemy
+  module Ingredients
+    # A link to a menu node
+    #
+    # Assign Alchemy::Node to this ingredient
+    #
+    class Node < Alchemy::Ingredient
+      related_object_alias :node, class_name: "Alchemy::Node"
+
+      # The first 30 characters of node name
+      #
+      # Used by the Element#preview_text method.
+      #
+      # @param [Integer] max_length (30)
+      #
+      def preview_text(max_length = 30)
+        node&.name.to_s[0..max_length - 1]
+      end
+    end
+  end
+end

data/app/models/alchemy/ingredients/page.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Alchemy
+  module Ingredients
+    # A link to a page
+    #
+    # Assign Alchemy::Page to this ingredient
+    #
+    class Page < Alchemy::Ingredient
+      related_object_alias :page, class_name: "Alchemy::Page"
+
+      # The first 30 characters of page name
+      #
+      # Used by the Element#preview_text method.
+      #
+      # @param [Integer] max_length (30)
+      #
+      def preview_text(max_length = 30)
+        page&.name.to_s[0..max_length - 1]
+      end
+    end
+  end
+end

data/app/models/alchemy/ingredients/picture.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Alchemy
+  module Ingredients
+    # A picture assignment
+    #
+    # Assign Alchemy::Picture to this ingredient
+    #
+    # Optionally you can add a link
+    # As well as set the alt tag, a caption and title
+    #
+    class Picture < Alchemy::Ingredient
+      include Alchemy::PictureThumbnails
+
+      store_accessor :data,
+        :alt_tag,
+        :caption,
+        :crop_from,
+        :crop_size,
+        :css_class,
+        :link_class_name,
+        :link_target,
+        :link_title,
+        :link,
+        :render_size,
+        :title
+
+      related_object_alias :picture, class_name: "Alchemy::Picture"
+
+      # The first 30 characters of the pictures name
+      #
+      # Used by the Element#preview_text method.
+      #
+      # @param [Integer] max_length (30)
+      #
+      def preview_text(max_length = 30)
+        picture&.name.to_s[0..max_length - 1]
+      end
+    end
+  end
+end

data/app/models/alchemy/ingredients/richtext.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Alchemy
+  module Ingredients
+    # A blob of richtext
+    #
+    class Richtext < Alchemy::Ingredient
+      store_accessor :data,
+        :stripped_body,
+        :sanitized_body
+
+      before_save :strip_content
+      before_save :sanitize_content
+
+      # The first 30 characters of the stripped_body
+      #
+      # Used by the Element#preview_text method.
+      #
+      # @param [Integer] max_length (30)
+      #
+      def preview_text(max_length = 30)
+        stripped_body.to_s[0..max_length - 1]
+      end
+
+      # Returns css class names for the editor textarea.
+      def tinymce_class_name
+        "has_tinymce#{has_custom_tinymce_config? ? " #{element.name}_#{role}" : ""}"
+      end
+
+      def has_tinymce?
+        true
+      end
+
+      private
+
+      def strip_content
+        self.stripped_body = Rails::Html::FullSanitizer.new.sanitize(value)
+      end
+
+      def sanitize_content
+        self.sanitized_body = Rails::Html::SafeListSanitizer.new.sanitize(
+          value,
+          sanitizer_settings
+        )
+      end
+
+      def sanitizer_settings
+        settings[:sanitizer] || {}
+      end
+
+      # Returns true if there is a tinymce setting defined that contains settings.
+      def has_custom_tinymce_config?
+        settings[:tinymce].is_a?(Hash)
+      end
+    end
+  end
+end

data/app/models/alchemy/ingredients/select.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Alchemy
+  module Ingredients
+    # A text value from a select box
+    #
+    class Select < Alchemy::Ingredient
+    end
+  end
+end