alchemy_cms 3.2.1 → 3.3.0.rc1

data/app/models/alchemy/element/definitions.rb

@@ -1,12 +1,10 @@
 module Alchemy
-
   # Module concerning element definitions
   #
   module Element::Definitions
     extend ActiveSupport::Concern
 
     module ClassMethods
-
       # Returns the definitions from elements.yml file.
       #
       # Place a +elements.yml+ file inside your apps +config/alchemy+ folder to define
@@ -15,14 +13,19 @@ module Alchemy
       def definitions
         @definitions ||= read_definitions_file
       end
-      alias_method :descriptions, :definitions
 
-    private
+      # Returns one element definition by given name.
+      #
+      def definition_by_name(name)
+        definitions.detect { |d| d['name'] == name }
+      end
+
+      private
 
       # Reads the element definitions file named +elements.yml+ from +config/alchemy/+ folder.
       #
       def read_definitions_file
-        if ::File.exists?(definitions_file_path)
+        if ::File.exist?(definitions_file_path)
           ::YAML.load(ERB.new(File.read(definitions_file_path)).result) || []
         else
           raise LoadError, "Could not find elements.yml file! Please run `rails generate alchemy:scaffold`"
@@ -42,11 +45,9 @@ module Alchemy
       if definition = self.class.definitions.detect { |d| d['name'] == name }
         definition
       else
-        log_warning "Could not find element definition for #{self.name}. Please check your elements.yml file!"
+        log_warning "Could not find element definition for #{name}. Please check your elements.yml file!"
         return {}
       end
     end
-    alias_method :description, :definition
-
   end
 end

data/app/models/alchemy/element/element_contents.rb

@@ -0,0 +1,150 @@
+# Methods concerning contents for elements
+#
+module Alchemy
+  module Element::ElementContents
+    # Find first content from element by given name.
+    def content_by_name(name)
+      contents_by_name(name).first
+    end
+
+    # Find first content from element by given essence type.
+    def content_by_type(essence_type)
+      contents_by_type(essence_type).first
+    end
+
+    # All contents from element by given name.
+    def contents_by_name(name)
+      contents.where(name: name)
+    end
+    alias_method :all_contents_by_name, :contents_by_name
+
+    # All contents from element by given essence type.
+    def contents_by_type(essence_type)
+      contents.where(essence_type: Content.normalize_essence_type(essence_type))
+    end
+    alias_method :all_contents_by_type, :contents_by_type
+
+    # Updates all related contents by calling +update_essence+ on each of them.
+    #
+    # @param contents_attributes [Hash]
+    #   Hash of contents attributes.
+    #   The keys has to be the #id of the content to update.
+    #   The values a Hash of attribute names and values
+    #
+    # @return [Boolean]
+    #   True if +errors+ are blank or +contents_attributes+ hash is nil
+    #
+    # == Example
+    #
+    #   @element.update_contents(
+    #     "1" => {ingredient: "Title"},
+    #     "2" => {link: "https://google.com"}
+    #   )
+    #
+    def update_contents(contents_attributes)
+      return true if contents_attributes.nil?
+      contents.each do |content|
+        content_hash = contents_attributes[content.id.to_s] || next
+        content.update_essence(content_hash) || errors.add(:base, :essence_validation_failed)
+      end
+      errors.blank?
+    end
+
+    # Copy current content's contents to given target element
+    def copy_contents_to(element)
+      contents.map do |content|
+        Content.copy(content, element_id: element.id)
+      end
+    end
+
+    # Returns the content that is marked as rss title.
+    #
+    # Mark a content as rss title in your +elements.yml+ file:
+    #
+    #   - name: news
+    #     contents:
+    #     - name: headline
+    #       type: EssenceText
+    #       rss_title: true
+    #
+    def content_for_rss_title
+      content_for_rss_meta('title')
+    end
+
+    # Returns the content that is marked as rss description.
+    #
+    # Mark a content as rss description in your +elements.yml+ file:
+    #
+    #   - name: news
+    #     contents:
+    #     - name: body
+    #       type: EssenceRichtext
+    #       rss_description: true
+    #
+    def content_for_rss_description
+      content_for_rss_meta('description')
+    end
+
+    # Returns the array with the hashes for all element contents in the elements.yml file
+    def content_definitions
+      return nil if definition.blank?
+      definition['contents']
+    end
+
+    # Returns the definition for given content_name
+    def content_definition_for(content_name)
+      if content_definitions.blank?
+        log_warning "Element #{name} is missing the content definition for #{content_name}"
+        return nil
+      else
+        content_definitions.detect { |d| d['name'] == content_name }
+      end
+    end
+
+    # Returns an array of all EssenceRichtext contents ids from elements
+    #
+    # This is used to re-initialize the TinyMCE editor in the element editor.
+    #
+    def richtext_contents_ids
+      # This is not very efficient SQL wise I know, but we need to iterate
+      # recursivly through all descendent elements and I don't know how to do this
+      # in pure SQL. Anyone with a better idea is welcome to submit a patch.
+      ids = contents.select(&:has_tinymce?).collect(&:id)
+      expanded_nested_elements = nested_elements.expanded
+      if expanded_nested_elements.present?
+        ids += expanded_nested_elements.collect(&:richtext_contents_ids)
+      end
+      ids.flatten
+    end
+
+    # True, if any of the element's contents has essence validations defined.
+    def has_validations?
+      !contents.detect(&:has_validations?).blank?
+    end
+
+    # All element contents where the essence validation has failed.
+    def contents_with_errors
+      contents.select(&:essence_validation_failed?)
+    end
+
+    private
+
+    def content_for_rss_meta(type)
+      definition = content_definitions.detect { |c| c["rss_#{type}"] }
+      return if definition.blank?
+      contents.find_by(name: definition['name'])
+    end
+
+    # creates the contents for this element as described in the elements.yml
+    def create_contents
+      contents = []
+      if definition["contents"].blank?
+        log_warning "Could not find any content definitions for element: #{name}"
+      else
+        definition["contents"].each do |content_hash|
+          contents << Content.create_from_scratch(self, content_hash.symbolize_keys)
+        end
+      end
+    end
+  end
+end

data/app/models/alchemy/element/element_essences.rb

@@ -0,0 +1,109 @@
+module Alchemy
+  module Element::ElementEssences
+    # Returns the contents essence value (aka. ingredient) for passed content name.
+    def ingredient(name)
+      content = content_by_name(name)
+      return nil if content.blank?
+      content.ingredient
+    end
+
+    # True if the element has a content for given name,
+    # that has an essence value (aka. ingredient) that is not blank.
+    def has_ingredient?(name)
+      ingredient(name).present?
+    end
+
+    # Returns all essence errors in the format of:
+    #
+    #   {
+    #     content.name => [
+    #       error_message_for_validation_1,
+    #       error_message_for_validation_2
+    #     ]
+    #   }
+    #
+    # Get translated error messages with +Element#essence_error_messages+
+    #
+    def essence_errors
+      essence_errors = {}
+      contents.each do |content|
+        if content.essence_validation_failed?
+          essence_errors[content.name] = content.essence.validation_errors
+        end
+      end
+      essence_errors
+    end
+
+    # Essence validation errors
+    #
+    # == Error messages are translated via I18n
+    #
+    # Inside your translation file add translations like:
+    #
+    #   alchemy:
+    #     content_validations:
+    #       name_of_the_element:
+    #         name_of_the_content:
+    #           validation_error_type: Error Message
+    #
+    # NOTE: +validation_error_type+ has to be one of:
+    #
+    #   * blank
+    #   * taken
+    #   * invalid
+    #
+    # === Example:
+    #
+    #   de:
+    #     alchemy:
+    #       content_validations:
+    #         contactform:
+    #           email:
+    #             invalid: 'Die Email hat nicht das richtige Format'
+    #
+    #
+    # == Error message translation fallbacks
+    #
+    # In order to not translate every single content for every element
+    # you can provide default error messages per content name:
+    #
+    # === Example
+    #
+    #   en:
+    #     alchemy:
+    #       content_validations:
+    #         fields:
+    #           email:
+    #             invalid: E-Mail has wrong format
+    #             blank: E-Mail can't be blank
+    #
+    # And even further you can provide general field agnostic error messages:
+    #
+    # === Example
+    #
+    #   en:
+    #     alchemy:
+    #       content_validations:
+    #         errors:
+    #           invalid: %{field} has wrong format
+    #           blank: %{field} can't be blank
+    #
+    def essence_error_messages
+      messages = []
+      essence_errors.each do |content_name, errors|
+        errors.each do |error|
+          messages << Alchemy.t(
+            "#{name}.#{content_name}.#{error}",
+            scope: 'content_validations',
+            default: [
+              "fields.#{content_name}.#{error}".to_sym,
+              "errors.#{error}".to_sym
+            ],
+            field: Content.translated_label_for(content_name, name)
+          )
+        end
+      end
+      messages
+    end
+  end
+end

data/app/models/alchemy/element/presenters.rb

@@ -1,12 +1,10 @@
 module Alchemy
-
   # Methods used for presenting an Alchemy Element.
   #
   module Element::Presenters
     extend ActiveSupport::Concern
 
     module ClassMethods
-
       # Human name for displaying elements in select boxes and element editor views.
       #
       # The name is beeing translated from given name value as described in +config/alchemy/elements.yml+
@@ -23,7 +21,7 @@ module Alchemy
       # If no translation is found a humanized name is used.
       #
       def display_name_for(name)
-        I18n.t(name, scope: 'element_names', default: name.to_s.humanize)
+        Alchemy.t(name, scope: 'element_names', default: name.to_s.humanize)
       end
     end
 
@@ -32,12 +30,12 @@ module Alchemy
     # @see Alchemy::Element::Presenters#display_name_for
     #
     def display_name
-      self.class.display_name_for(description['name'] || self.name)
+      self.class.display_name_for(definition['name'] || name)
     end
 
     # Returns a preview text for element.
     #
-    # It's taken from the first Content found in the +elements.yml+ description file.
+    # It's taken from the first Content found in the +elements.yml+ definition file.
     #
     # You can flag a Content as +as_element_title+ to take this as preview.
     #
@@ -45,7 +43,7 @@ module Alchemy
     #   Length of characters after the text will be cut off.
     #
     def preview_text(maxlength = 30)
-      (contents.detect(&:preview_content?) || contents.first).try(:preview_text, maxlength)
+      preview_text_from_preview_content(maxlength) || preview_text_from_nested_elements(maxlength)
     end
 
     # Generates a preview text containing Element#display_name and Element#preview_text.
@@ -82,6 +80,19 @@ module Alchemy
       "#{name}_#{id}"
     end
 
-  end
+    def preview_content
+      @_preview_content ||= contents.detect(&:preview_content?)
+    end
+
+    private
 
+    def preview_text_from_nested_elements(maxlength)
+      return unless nested_elements.present?
+      nested_elements.first.preview_text(maxlength)
+    end
+
+    def preview_text_from_preview_content(maxlength)
+      (preview_content || contents.first).try(:preview_text, maxlength)
+    end
+  end
 end

data/app/models/alchemy/essence_date.rb

@@ -15,10 +15,9 @@ module Alchemy
     acts_as_essence ingredient_column: 'date'
 
     # Returns self.date for the Element#preview_text method.
-    def preview_text(maxlength=nil)
+    def preview_text(_maxlength = nil)
       return "" if date.blank?
       ::I18n.l(date, format: :date)
     end
-
   end
 end

data/app/models/alchemy/essence_file.rb

@@ -4,12 +4,13 @@
 #
 #  id            :integer          not null, primary key
 #  attachment_id :integer
-#  title         :string(255)
-#  css_class     :string(255)
+#  title         :string
+#  css_class     :string
 #  creator_id    :integer
 #  updater_id    :integer
 #  created_at    :datetime         not null
 #  updated_at    :datetime         not null
+#  link_text     :string
 #
 
 module Alchemy
@@ -19,12 +20,16 @@ module Alchemy
 
     def attachment_url
       return if attachment.nil?
-      routes.download_attachment_path(id: attachment.id, name: attachment.file_name)
+      routes.download_attachment_path(
+        id: attachment.id,
+        name: attachment.urlname,
+        format: attachment.suffix
+      )
     end
 
-    def preview_text(max=30)
+    def preview_text(max = 30)
       return "" if attachment.blank?
-      attachment.name.to_s[0..max-1]
+      attachment.name.to_s[0..max - 1]
     end
 
     # Returns a serialized ingredient value for json api
@@ -37,6 +42,5 @@ module Alchemy
     def routes
       @routes ||= Engine.routes.url_helpers
     end
-
   end
 end

data/app/models/alchemy/essence_html.rb

@@ -18,6 +18,5 @@ module Alchemy
     def preview_text(maxlength = 30)
       ::CGI.escapeHTML(source.to_s)[0..maxlength]
     end
-
   end
 end

data/app/models/alchemy/essence_picture.rb

@@ -66,7 +66,7 @@ module Alchemy
     #
     def preview_text(max = 30)
       return "" if picture.nil?
-      picture.name.to_s[0..max-1]
+      picture.name.to_s[0..max - 1]
     end
 
     # A Hash of coordinates suitable for the graphical image cropper.
@@ -84,6 +84,15 @@ module Alchemy
       picture_url(content.settings)
     end
 
+    # Show image cropping link for content and options?
+    def allow_image_cropping?(options = {})
+      content && content.settings_value(:crop, options) && picture &&
+        picture.can_be_cropped_to(
+          content.settings_value(:image_size, options),
+          content.settings_value(:upsample, options)
+        )
+    end
+
     private
 
     def fix_crop_values
@@ -93,7 +102,7 @@ module Alchemy
     end
 
     def normalize_crop_value(crop_value)
-      self.send(crop_value).to_s.split('x').map { |n| normalize_number(n) }.join('x')
+      send(crop_value).to_s.split('x').map { |n| normalize_number(n) }.join('x')
     end
 
     def normalize_number(number)
@@ -122,7 +131,7 @@ module Alchemy
         name: picture.urlname,
         format: Config.get(:image_output_format)
       }.merge(options)
-      if crop_from.present? && crop_size.present?
+      if options[:crop] && crop_from.present? && crop_size.present?
         params = {
           crop: true,
           crop_from: crop_from,
@@ -146,6 +155,5 @@ module Alchemy
       secure_attributes += %w(name format sh)
       params.delete_if { |k, v| !secure_attributes.include?(k.to_s) || v.blank? }
     end
-
   end
 end