alchemy_cms 3.2.1 → 3.3.0.rc1

data/app/mailers/alchemy/messages.rb

@@ -1,6 +1,5 @@
 module Alchemy
   class Messages < ActionMailer::Base
-
     def contact_form_mail(message, mail_to, mail_from, subject)
       @message = message
       mail(
@@ -10,6 +9,5 @@ module Alchemy
         subject: subject
       )
     end
-
   end
 end

data/app/models/alchemy.rb

@@ -1,7 +1,5 @@
 module Alchemy
-
   def self.table_name_prefix
     'alchemy_'
   end
-
 end

data/app/models/alchemy/attachment.rb

@@ -29,39 +29,33 @@ module Alchemy
 
     stampable stamper_class_name: Alchemy.user_class_name
 
-    has_many :essence_files, :class_name => 'Alchemy::EssenceFile', :foreign_key => 'attachment_id'
-    has_many :contents, :through => :essence_files
-    has_many :elements, :through => :contents
-    has_many :pages, :through => :elements
+    has_many :essence_files, class_name: 'Alchemy::EssenceFile', foreign_key: 'attachment_id'
+    has_many :contents, through: :essence_files
+    has_many :elements, through: :contents
+    has_many :pages, through: :elements
+
+    # We need to define this method here to have it available in the validations below.
+    class << self
+      def allowed_filetypes
+        Config.get(:uploader).fetch('allowed_filetypes', {}).fetch('alchemy/attachments', [])
+      end
+    end
 
     validates_presence_of :file
-    validates_format_of :file_name, with: /\A[A-Za-z0-9\.\-_]+\z/, on: :update
+    validates_format_of :file_name, with: /\A[A-Za-z0-9\. \-_äÄöÖüÜß]+\z/, on: :update
     validates_size_of :file, maximum: Config.get(:uploader)['file_size_limit'].megabytes
     validates_property :ext, of: :file,
-      in: Config.get(:uploader)['allowed_filetypes']['attachments'],
+      in: allowed_filetypes,
       case_sensitive: false,
-      message: I18n.t("not a valid file"),
-      unless: -> { Config.get(:uploader)['allowed_filetypes']['attachments'].include?('*') }
+      message: Alchemy.t("not a valid file"),
+      unless: -> { self.class.allowed_filetypes.include?('*') }
 
     before_create do
-      write_attribute(:name, convert_to_humanized_name(self.file_name, self.file.ext))
-      write_attribute(:file_name, sanitized_filename)
+      write_attribute(:name, convert_to_humanized_name(file_name, file.ext))
     end
 
     after_update :touch_contents
 
-    # Class methods
-
-    class << self
-
-      def find_paginated(params, per_page, order)
-        attachments = Attachment.arel_table
-        cond = attachments[:name].matches("%#{params[:query]}%").or(attachments[:file_name].matches("%#{params[:query]}%"))
-        self.where(cond).page(params[:page] || 1).per(per_page).order(order)
-      end
-
-    end
-
     # Instance methods
 
     def to_jq_upload
@@ -72,8 +66,9 @@ module Alchemy
       }
     end
 
+    # An url save filename without format suffix
     def urlname
-      read_attribute :file_name
+      CGI.escape(file_name.gsub(/\.#{extension}$/, '').tr('.', ' '))
     end
 
     # Checks if the attachment is restricted, because it is attached on restricted pages only
@@ -81,6 +76,7 @@ module Alchemy
       pages.any? && pages.not_restricted.blank?
     end
 
+    # File format suffix
     def extension
       file_name.split(".").last
     end
@@ -90,40 +86,33 @@ module Alchemy
     #
     def icon_css_class
       case file_mime_type
-        when *ARCHIVE_FILE_TYPES
-          then "archive"
-        when *AUDIO_FILE_TYPES
-          then "audio"
-        when *IMAGE_FILE_TYPES
-          then "image"
-        when *VIDEO_FILE_TYPES
-          then "video"
-        when "application/x-shockwave-flash"
-          then "flash"
-        when "image/x-psd"
-          then "psd"
-        when "text/plain"
-          then "text"
-        when "application/rtf"
-          then "rtf"
-        when "application/pdf"
-          then "pdf"
-        when "application/msword"
-          then "word"
-        when "application/vnd.ms-excel"
-          then "excel"
-        when *VCARD_FILE_TYPES
-          then "vcard"
-        else "file"
+      when "application/x-shockwave-flash"
+        then "flash"
+      when "image/x-psd"
+        then "psd"
+      when "text/plain"
+        then "text"
+      when "application/rtf"
+        then "rtf"
+      when "application/pdf"
+        then "pdf"
+      when "application/msword"
+        then "word"
+      when "application/vnd.ms-excel"
+        then "excel"
+      when *VCARD_FILE_TYPES
+        then "vcard"
+      when *ARCHIVE_FILE_TYPES
+        then "archive"
+      when *AUDIO_FILE_TYPES
+        then "audio"
+      when *IMAGE_FILE_TYPES
+        then "image"
+      when *VIDEO_FILE_TYPES
+        then "video"
+      else
+        "file"
       end
     end
-
-    def sanitized_filename
-      parts = self.file_name.split('.')
-      sfx = parts.pop
-      name = convert_to_urlname(parts.join('-'))
-      "#{name}.#{sfx}"
-    end
-
   end
 end

data/app/models/alchemy/cell.rb

@@ -50,10 +50,10 @@ module Alchemy
       end
 
       def translated_label_for(cell_name)
-        I18n.t(cell_name, scope: 'cell_names', default: cell_name.to_s.humanize)
+        Alchemy.t(cell_name, scope: 'cell_names', default: cell_name.to_s.humanize)
       end
 
-    private
+      private
 
       def read_yml_file
         ::YAML.load(ERB.new(File.read(yml_file_path)).result) || []
@@ -71,24 +71,23 @@ module Alchemy
     # Returns the cell definition defined in +config/alchemy/cells.yml+
     #
     def definition
-      definition = self.class.definition_for(self.name)
+      definition = self.class.definition_for(name)
       if definition.blank?
-        log_warning "Could not find cell definition for #{self.name}. Please check your cells.yml!"
+        log_warning "Could not find cell definition for #{name}. Please check your cells.yml!"
         return {}
       else
         definition
       end
     end
-    alias_method :description, :definition
 
     # Returns all elements that can be placed in this cell
-    def available_elements
+    def element_definitions
       definition['elements'] || []
     end
+    alias_method :available_elements, :element_definitions
 
     def name_for_label
-      self.class.translated_label_for(self.name)
+      self.class.translated_label_for(name)
     end
-
   end
 end

data/app/models/alchemy/content.rb

@@ -23,7 +23,7 @@ module Alchemy
     # Concerns
     include Alchemy::Content::Factory
 
-    belongs_to :essence, :polymorphic => true, :dependent => :destroy
+    belongs_to :essence, polymorphic: true, dependent: :destroy
     belongs_to :element, touch: true
     has_one :page, through: :element
 
@@ -44,7 +44,7 @@ module Alchemy
     scope :essence_htmls,     -> { where(essence_type: "Alchemy::EssenceHtml") }
     scope :essence_links,     -> { where(essence_type: "Alchemy::EssenceLink") }
     scope :essence_pictures,  -> { where(essence_type: "Alchemy::EssencePicture") }
-    scope :gallery_pictures,  -> { essence_pictures.where("#{self.table_name}.name LIKE 'essence_picture_%'") }
+    scope :gallery_pictures,  -> { essence_pictures.where("#{table_name}.name LIKE 'essence_picture_%'") }
     scope :essence_richtexts, -> { where(essence_type: "Alchemy::EssenceRichtext") }
     scope :essence_selects,   -> { where(essence_type: "Alchemy::EssenceSelect") }
     scope :essence_texts,     -> { where(essence_type: "Alchemy::EssenceText") }
@@ -75,10 +75,10 @@ module Alchemy
       #         foo: Baz
       #
       def translated_label_for(content_name, element_name = nil)
-        I18n.t(
+        Alchemy.t(
           content_name,
           scope: "content_names.#{element_name}",
-          default: I18n.t("content_names.#{content_name}", default: content_name.humanize)
+          default: Alchemy.t("content_names.#{content_name}", default: content_name.humanize)
         )
       end
     end
@@ -104,13 +104,23 @@ module Alchemy
 
     # Settings from the elements.yml definition
     def settings
-      return {} if description.blank?
-      @settings ||= description.fetch('settings', {}).symbolize_keys
+      return {} if definition.blank?
+      @settings ||= definition.fetch('settings', {}).symbolize_keys
+    end
+
+    # Fetches value from settings
+    #
+    # @param key [Symbol]               - The hash key you want to fetch the value from
+    # @param options [Hash]             - An optional Hash that can override the settings.
+    #                                     Normally passed as options hash into the content
+    #                                     editor view.
+    def settings_value(key, options = {})
+      settings.update(options || {}).symbolize_keys[key.to_sym]
     end
 
     def siblings
       return [] if !element
-      self.element.contents
+      element.contents
     end
 
     # Gets the ingredient from essence
@@ -165,7 +175,7 @@ module Alchemy
     end
 
     def has_validations?
-      description['validate'].present?
+      definition['validate'].present?
     end
 
     # Returns a string to be passed to Rails form field tags to ensure we have same params layout everywhere.
@@ -183,11 +193,11 @@ module Alchemy
     #   <%= text_field_tag content.form_field_name(:link), content.ingredient %>
     #
     def form_field_name(essence_column = 'ingredient')
-      "contents[#{self.id}][#{essence_column}]"
+      "contents[#{id}][#{essence_column}]"
     end
 
     def form_field_id(essence_column = 'ingredient')
-      "contents_#{self.id}_#{essence_column}"
+      "contents_#{id}_#{essence_column}"
     end
 
     # Returns a string used as dom id on html elements.
@@ -198,7 +208,7 @@ module Alchemy
 
     # Returns the translated name for displaying in labels, etc.
     def name_for_label
-      self.class.translated_label_for(self.name, self.element.name)
+      self.class.translated_label_for(name, element.name)
     end
 
     def linked?
@@ -207,10 +217,10 @@ module Alchemy
 
     # Returns true if this content should be taken for element preview.
     def preview_content?
-      if description['take_me_for_preview']
+      if definition['take_me_for_preview']
         ActiveSupport::Deprecation.warn("Content definition's `take_me_for_preview` key is deprecated. Please use `as_element_title` instead.")
       end
-      !!description['take_me_for_preview'] || !!description['as_element_title']
+      !!definition['take_me_for_preview'] || !!definition['as_element_title']
     end
 
     # Proxy method that returns the preview text from essence.
@@ -225,31 +235,36 @@ module Alchemy
     end
 
     def normalized_essence_type
-      self.class.normalize_essence_type(self.essence_type)
+      self.class.normalize_essence_type(essence_type)
+    end
+
+    # Returns true if there is a tinymce setting defined on the content definiton
+    # or if the +essence.has_tinymce?+ returns true.
+    def has_tinymce?
+      settings[:tinymce].present? || essence.has_tinymce?
     end
 
+    # Returns true if there is a tinymce setting defined that contains settings.
     def has_custom_tinymce_config?
-      settings[:tinymce].present?
+      settings[:tinymce].is_a?(Hash)
     end
 
+    # Returns css class names for the content textarea.
     def tinymce_class_name
-      if has_custom_tinymce_config?
-        "custom_tinymce #{element.name}_#{name}"
-      else
-        "default_tinymce"
-      end
+      "has_tinymce" + (has_custom_tinymce_config? ? " #{element.name}_#{name}" : "")
     end
 
-    # Returns the default value from content description
-    # If the value is a symbol it gets passed through i18n inside the +alchemy.default_content_texts+ scope
+    # Returns the default value from content definition
+    #
+    # If the value is a symbol it gets passed through i18n
+    # inside the +alchemy.default_content_texts+ scope
     def default_text(default)
       case default
       when Symbol
-        I18n.t(default, scope: :default_content_texts)
+        Alchemy.t(default, scope: :default_content_texts)
       else
         default
       end
     end
-
   end
 end

data/app/models/alchemy/content/factory.rb

@@ -1,5 +1,4 @@
 module Alchemy
-
   # Holds everything concerning the building and creating of contents and the related essence object.
   #
   module Content::Factory
@@ -13,17 +12,18 @@ module Alchemy
       # @param [Alchemy::Element]
       #   The element the content is for
       # @param [Hash]
-      #   The content description used for finding the content in +elements.yml+ file
+      #   The content definition used for finding the content in +elements.yml+ file
       #
       def build(element, essence_hash)
-        if (description = content_description(element, essence_hash)).blank?
-          raise ContentDefinitionError, "No description found in elements.yml for #{essence_hash.inspect} and #{element.inspect}"
+        definition = content_definition(element, essence_hash)
+        if definition.blank?
+          raise ContentDefinitionError, "No definition found in elements.yml for #{essence_hash.inspect} and #{element.inspect}"
         else
-          new(name: description['name'], element_id: element.id)
+          new(name: definition['name'], element_id: element.id)
         end
       end
 
-      # Creates a new content from elements description in the +elements.yml+ file.
+      # Creates a new content from elements definition in the +elements.yml+ file.
       #
       # 1. It builds the content
       # 2. It creates the essence record (content object gets saved)
@@ -49,7 +49,7 @@ module Alchemy
       #
       def copy(source, differences = {})
         attributes = source.attributes.except(*SKIPPED_ATTRIBUTES_ON_COPY).merge(differences.stringify_keys)
-        content = self.create!(attributes)
+        content = create!(attributes)
         new_essence = content.essence.class.new(content.essence.attributes.except(*SKIPPED_ATTRIBUTES_ON_COPY))
         new_essence.save!
         raise "Essence not cloned" if new_essence.id == content.essence_id
@@ -57,18 +57,18 @@ module Alchemy
         content
       end
 
-      # Returns the content description for building a content.
+      # Returns the content definition for building a content.
       #
-      # 1. It looks in the element's contents description
-      # 2. It builds a description hash from essence type, if the the name key is not present
+      # 1. It looks in the element's contents definition
+      # 2. It builds a definition hash from essence type, if the the name key is not present
       #
-      def content_description(element, essence_hash)
+      def content_definition(element, essence_hash)
         essence_hash.stringify_keys!
         # No name given. We build the content from essence type.
         if essence_hash['name'].blank? && essence_hash['essence_type'].present?
-          content_description_from_essence_type(element, essence_hash['essence_type'])
+          content_definition_from_essence_type(element, essence_hash['essence_type'])
         else
-          content_description_from_element(element, essence_hash['name'])
+          element.content_definition_for(essence_hash['name'])
         end
       end
 
@@ -79,7 +79,7 @@ module Alchemy
       # @param [String]
       #   The essence type the content is from
       #
-      def content_description_from_essence_type(element, essence_type)
+      def content_definition_from_essence_type(element, essence_type)
         {
           'type' => essence_type,
           'name' => content_name_from_element_and_essence_type(element, essence_type)
@@ -97,26 +97,10 @@ module Alchemy
         "#{essence_type.classify.demodulize.underscore}_#{essences_of_same_type.count + 1}"
       end
 
-      # Returns the content description hash from element.
-      #
-      # It first uses the normal content description described in the +elements.yml+ +contents+ array.
-      #
-      # If the content description could not be found it tries to load it from +available_contents+ array.
-      #
-      # @param [Alchemy::Element]
-      #   The element instance the content is for
-      # @param [String]
-      #   The name of the content
-      #
-      def content_description_from_element(element, name)
-        element.content_description_for(name) ||
-          element.available_content_description_for(name)
-      end
-
-      # Returns all content descriptions from elements.yml
+      # Returns all content definitions from elements.yml
       #
-      def descriptions
-        Element.descriptions.collect { |e| e['contents'] }.flatten.compact
+      def definitions
+        Element.definitions.collect { |e| e['contents'] }.flatten.compact
       end
 
       # Returns a normalized Essence type
@@ -146,34 +130,33 @@ module Alchemy
 
     # Instance Methods
 
-    # Returns the description hash from +elements.yml+ file.
+    # Returns the definition hash from +elements.yml+ file.
     #
-    def description
+    def definition
       if element.blank?
-        log_warning "Content with id #{self.id} is missing its Element."
+        log_warning "Content with id #{id} is missing its Element."
         return {}
       end
-      Content.content_description_from_element(element, name) || {}
+      element.content_definition_for(name) || {}
     end
-    alias_method :definition, :description
 
-    # Creates essence from description.
+    # Creates essence from definition.
     #
     # If an optional type is passed, this type of essence gets created.
     #
     def create_essence!(type = nil)
       self.essence = essence_class(type).create!(prepared_attributes_for_essence)
-      self.save!
+      save!
     end
 
-  private
+    private
 
-    # Returns a class constant from description's type field.
+    # Returns a class constant from definition's type field.
     #
     # If an optional type is passed, this type of essence gets constantized.
     #
     def essence_class(type = nil)
-      Content.normalize_essence_type(type || description['type']).constantize
+      Content.normalize_essence_type(type || definition['type']).constantize
     end
 
     # Prepares the attributes for creating the essence.
@@ -182,7 +165,7 @@ module Alchemy
     #
     def prepared_attributes_for_essence
       attributes = {
-        ingredient: default_text(description['default'])
+        ingredient: default_text(definition['default'])
       }
       attributes
     end