lc_alchemy_cms 3.2.0

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

@@ -0,0 +1,52 @@
+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
+      # your own set of elements
+      #
+      def definitions
+        @definitions ||= read_definitions_file
+      end
+      alias_method :descriptions, :definitions
+
+    private
+
+      # Reads the element definitions file named +elements.yml+ from +config/alchemy/+ folder.
+      #
+      def read_definitions_file
+        if ::File.exists?(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`"
+        end
+      end
+
+      # Returns the +elements.yml+ file path
+      #
+      def definitions_file_path
+        Rails.root.join 'config/alchemy/elements.yml'
+      end
+    end
+
+    # The definition of this element.
+    #
+    def definition
+      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!"
+        return {}
+      end
+    end
+    alias_method :description, :definition
+
+  end
+end

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

@@ -0,0 +1,87 @@
+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+
+      #
+      # Translate the name in your +config/locales+ language file.
+      #
+      # == Example:
+      #
+      #   de:
+      #     alchemy:
+      #       element_names:
+      #         contactform: 'Kontakt Formular'
+      #
+      # 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)
+      end
+    end
+
+    # Returns the translated name
+    #
+    # @see Alchemy::Element::Presenters#display_name_for
+    #
+    def display_name
+      self.class.display_name_for(description['name'] || self.name)
+    end
+
+    # Returns a preview text for element.
+    #
+    # It's taken from the first Content found in the +elements.yml+ description file.
+    #
+    # You can flag a Content as +as_element_title+ to take this as preview.
+    #
+    # @param maxlength [Fixnum] (30)
+    #   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)
+    end
+
+    # Generates a preview text containing Element#display_name and Element#preview_text.
+    #
+    # It is displayed inside the head of the Element in the Elements.list overlay window from the Alchemy Admin::Page#edit view.
+    #
+    # === Example
+    #
+    # A Element described as:
+    #
+    #     - name: funky_element
+    #       display_name: Funky Element
+    #       contents:
+    #       - name: headline
+    #         type: EssenceText
+    #       - name: text
+    #         type EssenceRichtext
+    #         as_element_title: true
+    #
+    # With "I want to tell you a funky story" as stripped_body for the EssenceRichtext Content produces:
+    #
+    #     Funky Element: I want to tell ...
+    #
+    # @param maxlength [Fixnum] (30)
+    #   Length of characters after the text will be cut off.
+    #
+    def display_name_with_preview_text(maxlength = 30)
+      "#{display_name}: #{preview_text(maxlength)}"
+    end
+
+    # Returns a dom id used for elements html id tag.
+    #
+    def dom_id
+      "#{name}_#{id}"
+    end
+
+  end
+
+end

data/app/models/alchemy/element_to_page.rb

@@ -0,0 +1,7 @@
+module Alchemy
+  class ElementToPage
+    def self.table_name
+      [Element.table_name, Page.table_name].join('_')
+    end
+  end
+end

data/app/models/alchemy/essence_boolean.rb

@@ -0,0 +1,19 @@
+# == Schema Information
+#
+# Table name: alchemy_essence_booleans
+#
+#  id         :integer          not null, primary key
+#  value      :boolean
+#  created_at :datetime         not null
+#  updated_at :datetime         not null
+#  creator_id :integer
+#  updater_id :integer
+#
+
+# Stores boolean values.
+# Provides a checkbox in the editor views.
+module Alchemy
+  class EssenceBoolean < ActiveRecord::Base
+    acts_as_essence ingredient_column: 'value'
+  end
+end

data/app/models/alchemy/essence_date.rb

@@ -0,0 +1,24 @@
+# == Schema Information
+#
+# Table name: alchemy_essence_dates
+#
+#  id         :integer          not null, primary key
+#  date       :datetime
+#  creator_id :integer
+#  updater_id :integer
+#  created_at :datetime         not null
+#  updated_at :datetime         not null
+#
+
+module Alchemy
+  class EssenceDate < ActiveRecord::Base
+    acts_as_essence ingredient_column: 'date'
+
+    # Returns self.date for the Element#preview_text method.
+    def preview_text(maxlength=nil)
+      return "" if date.blank?
+      ::I18n.l(date, format: :date)
+    end
+
+  end
+end

data/app/models/alchemy/essence_file.rb

@@ -0,0 +1,42 @@
+# == Schema Information
+#
+# Table name: alchemy_essence_files
+#
+#  id            :integer          not null, primary key
+#  attachment_id :integer
+#  title         :string(255)
+#  css_class     :string(255)
+#  creator_id    :integer
+#  updater_id    :integer
+#  created_at    :datetime         not null
+#  updated_at    :datetime         not null
+#
+
+module Alchemy
+  class EssenceFile < ActiveRecord::Base
+    belongs_to :attachment
+    acts_as_essence ingredient_column: 'attachment'
+
+    def attachment_url
+      return if attachment.nil?
+      routes.download_attachment_path(id: attachment.id, name: attachment.file_name)
+    end
+
+    def preview_text(max=30)
+      return "" if attachment.blank?
+      attachment.name.to_s[0..max-1]
+    end
+
+    # Returns a serialized ingredient value for json api
+    def serialized_ingredient
+      attachment_url
+    end
+
+    private
+
+    def routes
+      @routes ||= Engine.routes.url_helpers
+    end
+
+  end
+end

data/app/models/alchemy/essence_html.rb

@@ -0,0 +1,23 @@
+# == Schema Information
+#
+# Table name: alchemy_essence_htmls
+#
+#  id         :integer          not null, primary key
+#  source     :text
+#  creator_id :integer
+#  updater_id :integer
+#  created_at :datetime         not null
+#  updated_at :datetime         not null
+#
+
+module Alchemy
+  class EssenceHtml < ActiveRecord::Base
+    acts_as_essence ingredient_column: 'source'
+
+    # Returns the first x (default = 30) (HTML escaped) characters from self.source for the Element#preview_text method.
+    def preview_text(maxlength = 30)
+      ::CGI.escapeHTML(source.to_s)[0..maxlength]
+    end
+
+  end
+end

data/app/models/alchemy/essence_link.rb

@@ -0,0 +1,20 @@
+# == Schema Information
+#
+# Table name: alchemy_essence_links
+#
+#  id              :integer          not null, primary key
+#  link            :string(255)
+#  link_title      :string(255)
+#  link_target     :string(255)
+#  link_class_name :string(255)
+#  created_at      :datetime         not null
+#  updated_at      :datetime         not null
+#  creator_id      :integer
+#  updater_id      :integer
+#
+
+module Alchemy
+  class EssenceLink < ActiveRecord::Base
+    acts_as_essence ingredient_column: 'link'
+  end
+end

data/app/models/alchemy/essence_picture.rb

@@ -0,0 +1,152 @@
+# == Schema Information
+#
+# Table name: alchemy_essence_pictures
+#
+#  id              :integer          not null, primary key
+#  picture_id      :integer
+#  caption         :string(255)
+#  title           :string(255)
+#  alt_tag         :string(255)
+#  link            :string(255)
+#  link_class_name :string(255)
+#  link_title      :string(255)
+#  css_class       :string(255)
+#  link_target     :string(255)
+#  creator_id      :integer
+#  updater_id      :integer
+#  created_at      :datetime         not null
+#  updated_at      :datetime         not null
+#  crop_from       :string(255)
+#  crop_size       :string(255)
+#  render_size     :string(255)
+#
+
+module Alchemy
+  class EssencePicture < ActiveRecord::Base
+    acts_as_essence ingredient_column: 'picture'
+
+    belongs_to :picture
+    delegate :image_file_width, :image_file_height, :image_file, to: :picture
+    before_save :fix_crop_values
+    before_save :replace_newlines
+
+    include Alchemy::Picture::Transformations
+
+    # The url to show the picture.
+    #
+    # Takes all values like +name+ and crop sizes (+crop_from+, +crop_size+ from the build in graphical image cropper)
+    # and also adds the security token.
+    #
+    # You typically want to set the size the picture should be resized to.
+    #
+    # === Example:
+    #
+    #   essence_picture.picture_url(size: '200x300', crop: true, format: 'gif')
+    #   # '/pictures/1/show/200x300/crop/cats.gif?sh=765rfghj'
+    #
+    # @option options size [String]
+    #   The size the picture should be resized to.
+    #
+    # @option options format [String]
+    #   The format the picture should be rendered in.
+    #   Defaults to the +image_output_format+ from the +Alchemy::Config+.
+    #
+    # @option options crop [Boolean]
+    #   If set to true the picture will be cropped to fit the size value.
+    #
+    def picture_url(options = {})
+      return if picture.nil?
+      # routes.show_picture_path(picture_params(options))
+      Dragonfly.app(:alchemy_pictures).remote_url_for content.essence.picture.image_file.send(:uid)
+    end
+
+    # The name of the picture used as preview text in element editor views.
+    #
+    # @param max [Integer]
+    #   The maximum length of the text returned.
+    #
+    def preview_text(max = 30)
+      return "" if picture.nil?
+      picture.name.to_s[0..max-1]
+    end
+
+    # A Hash of coordinates suitable for the graphical image cropper.
+    #
+    def cropping_mask
+      return if crop_from.blank? || crop_size.blank?
+      crop_from = point_from_string(read_attribute(:crop_from))
+      crop_size = sizes_from_string(read_attribute(:crop_size))
+
+      point_and_mask_to_points(crop_from, crop_size)
+    end
+
+    # Returns a serialized ingredient value for json api
+    def serialized_ingredient
+      picture_url(content.settings)
+    end
+
+    private
+
+    def fix_crop_values
+      %w(crop_from crop_size).each do |crop_value|
+        write_attribute crop_value, normalize_crop_value(crop_value)
+      end
+    end
+
+    def normalize_crop_value(crop_value)
+      self.send(crop_value).to_s.split('x').map { |n| normalize_number(n) }.join('x')
+    end
+
+    def normalize_number(number)
+      number = number.to_f.round
+      number < 0 ? 0 : number
+    end
+
+    def replace_newlines
+      return nil if caption.nil?
+      caption.gsub!(/(\r\n|\r|\n)/, "<br/>")
+    end
+
+    # Returns Alchemy's url helpers.
+    def routes
+      @routes ||= Engine.routes.url_helpers
+    end
+
+    # Params for picture_path and picture_url methods
+    #
+    # @see +picture_url+ for options
+    #
+    def picture_params(options = {})
+      return {} if picture.nil?
+      params = {
+        id: picture.id,
+        name: picture.urlname,
+        format: Config.get(:image_output_format)
+      }.merge(options)
+      if crop_from.present? && crop_size.present?
+        params = {
+          crop: true,
+          crop_from: crop_from,
+          crop_size: crop_size
+        }.merge(params)
+      end
+      params = clean_picture_params(params)
+      params.merge(sh: picture.security_token(params))
+    end
+
+    # Ensures correct and clean params for show picture path.
+    #
+    def clean_picture_params(params)
+      if params[:crop] == true
+        params[:crop] = 'crop'
+      end
+      if params[:image_size]
+        params[:size] = params.delete(:image_size)
+      end
+      secure_attributes = PictureAttributes::SECURE_ATTRIBUTES.dup
+      secure_attributes += %w(name format sh)
+      params.delete_if { |k, v| !secure_attributes.include?(k.to_s) || v.blank? }
+    end
+
+  end
+end

data/app/models/alchemy/essence_richtext.rb

@@ -0,0 +1,47 @@
+# == Schema Information
+#
+# Table name: alchemy_essence_richtexts
+#
+#  id            :integer          not null, primary key
+#  body          :text
+#  stripped_body :text
+#  public        :boolean
+#  creator_id    :integer
+#  updater_id    :integer
+#  created_at    :datetime         not null
+#  updated_at    :datetime         not null
+#
+
+module Alchemy
+  class EssenceRichtext < ActiveRecord::Base
+    acts_as_essence preview_text_column: 'stripped_body'
+
+    before_save :strip_content
+
+  private
+
+    def strip_content
+      self.stripped_body = strip_tags(self.body)
+    end
+
+    # Stripping HTML Tags and only returns plain text.
+    def strip_tags(html)
+      return html if html.blank?
+      if html.index("<")
+        text = ""
+        tokenizer = ::HTML::Tokenizer.new(html)
+        while token = tokenizer.next
+          node = ::HTML::Node.parse(nil, 0, 0, token, false)
+          # result is only the content of any Text nodes
+          text << node.to_s if node.class == ::HTML::Text
+        end
+        # strip any comments, and if they have a newline at the end (ie. line with
+        # only a comment) strip that too
+        text.gsub(/<!--(.*?)-->[\n]?/m, "")
+      else
+        html # already plain text
+      end
+    end
+
+  end
+end