alchemy_cms 3.2.1 → 3.3.0.rc1

data/lib/alchemy/errors.rb

@@ -1,7 +1,6 @@
 # Custom error classes.
 #
 module Alchemy
-
   class CellDefinitionError < StandardError
     # Raised if no cell definition can be found.
   end

data/lib/alchemy/essence.rb

@@ -13,7 +13,6 @@ module Alchemy #:nodoc:
     #   * several getters (ie: page, element, content, ingredient, preview_text)
     #
     module ClassMethods
-
       # Turn any active record model into an essence by calling this class method
       #
       # @option options [String || Symbol] ingredient_column ('body')
@@ -23,7 +22,7 @@ module Alchemy #:nodoc:
       # @option options [String || Symbol] preview_text_column (ingredient_column)
       #   Specify the column for the preview_text method.
       #
-      def acts_as_essence(options={})
+      def acts_as_essence(options = {})
         register_as_essence_association!
 
         configuration = {
@@ -50,7 +49,7 @@ module Alchemy #:nodoc:
           after_update :touch_content
 
           def acts_as_essence_class
-            #{self.name}
+            #{name}
           end
 
           def ingredient_column
@@ -69,7 +68,7 @@ module Alchemy #:nodoc:
 
       # Register the current class as has_many association on +Alchemy::Page+ and +Alchemy::Element+ models
       def register_as_essence_association!
-        klass_name = self.model_name.to_s
+        klass_name = model_name.to_s
         arguments = [:has_many, klass_name.demodulize.tableize.to_sym, through: :contents,
           source: :essence, source_type: klass_name]
         %w(Page Element).each { |k| "Alchemy::#{k}".constantize.send(*arguments) }
@@ -77,7 +76,6 @@ module Alchemy #:nodoc:
     end
 
     module InstanceMethods
-
       # Essence Validations:
       #
       # Essence validations can be set inside the config/elements.yml file.
@@ -125,16 +123,16 @@ module Alchemy #:nodoc:
         validations.each do |validation|
           if validation.respond_to?(:keys)
             validation.map do |key, value|
-              self.send("validate_#{key}", value)
+              send("validate_#{key}", value)
             end
           else
-            self.send("validate_#{validation}")
+            send("validate_#{validation}")
           end
         end
       end
 
       def validations
-        @validations ||= description.present? ? description['validate'] || [] : []
+        @validations ||= definition.present? ? definition['validate'] || [] : []
       end
 
       def validation_errors
@@ -168,21 +166,21 @@ module Alchemy #:nodoc:
         acts_as_essence_class
           .available
           .from_element(element.name)
-          .where("#{ingredient_column}" => ingredient)
-          .where.not(id: self.id)
+          .where(ingredient_column.to_s => ingredient)
+          .where.not(id: id)
       end
 
       # Returns the value stored from the database column that is configured as ingredient column.
       def ingredient
-        if self.respond_to?(ingredient_column)
-          self.send(ingredient_column)
+        if respond_to?(ingredient_column)
+          send(ingredient_column)
         end
       end
 
       # Returns the value stored from the database column that is configured as ingredient column.
       def ingredient=(value)
-        if self.respond_to?(ingredient_setter_method)
-          self.send(ingredient_setter_method, value)
+        if respond_to?(ingredient_setter_method)
+          send(ingredient_setter_method, value)
         end
       end
 
@@ -191,10 +189,10 @@ module Alchemy #:nodoc:
         ingredient_column.to_s + '='
       end
 
-      # Essence description from config/elements.yml
-      def description
-        return {} if element.nil? or element.content_descriptions.nil?
-        element.content_descriptions.detect { |c| c['name'] == self.content.name } || {}
+      # Essence definition from config/elements.yml
+      def definition
+        return {} if element.nil? || element.content_definitions.nil?
+        element.content_definitions.detect { |c| c['name'] == content.name } || {}
       end
 
       # Touch content. Called after update.
@@ -206,7 +204,7 @@ module Alchemy #:nodoc:
       # Returns the first x (default 30) characters of ingredient for the Element#preview_text method.
       #
       def preview_text(maxlength = 30)
-        self.send(preview_text_column).to_s[0..maxlength-1]
+        send(preview_text_column).to_s[0..maxlength - 1]
       end
 
       def open_link_in_new_window?
@@ -225,8 +223,10 @@ module Alchemy #:nodoc:
         "alchemy/essences/#{partial_name}_view"
       end
 
+      def has_tinymce?
+        false
+      end
     end
-
   end
 end
 ActiveRecord::Base.class_eval { include Alchemy::Essence } if defined?(Alchemy::Essence)

data/lib/alchemy/filetypes.rb

@@ -1,6 +1,5 @@
 module Alchemy
   module Filetypes
-
     ARCHIVE_FILE_TYPES = ["application/zip", "application/x-rar"]
 
     AUDIO_FILE_TYPES = [
@@ -28,6 +27,5 @@ module Alchemy
       "video/x-msvideo",
       "video/x-ms-wmv"
     ]
-
   end
-end
+end

data/lib/alchemy/forms/builder.rb

@@ -1,7 +1,6 @@
 module Alchemy
   module Forms
     class Builder < SimpleForm::FormBuilder
-
       # Renders a simple_form input, but uses input alchemy_wrapper
       #
       def input(attribute_name, options = {}, &block)
@@ -17,7 +16,6 @@ module Alchemy
           template.content_tag('button', label, options[:input_html])
         end
       end
-
     end
   end
 end

data/lib/alchemy/hints.rb

@@ -1,6 +1,5 @@
 module Alchemy
   module Hints
-
     # Returns a hint
     #
     # To add a hint to a content pass +hint: true+ to the element definition in its element.yml
@@ -36,7 +35,7 @@ module Alchemy
     def hint
       hint = definition['hint']
       if hint == true
-        I18n.t(name, scope: hint_translation_scope)
+        Alchemy.t(name, scope: hint_translation_scope)
       else
         hint
       end
@@ -52,6 +51,5 @@ module Alchemy
     def hint_translation_scope
       "#{self.class.model_name.to_s.demodulize.downcase}_hints"
     end
-
   end
 end

data/lib/alchemy/i18n.rb

@@ -1,70 +1,98 @@
 module Alchemy
-  module I18n
-
-    # Alchemy translation methods
-    #
-    # Instead of having to translate strings and defining a default value:
-    #
-    #     Alchemy::I18n.t("Hello World!", :default => 'Hello World!')
-    #
-    # We define this method to define the value only once:
-    #
-    #     Alchemy::I18n.t("Hello World!")
-    #
-    # Note that interpolation still works:
+  class << self
+    # Alchemy shortcut translation method
     #
-    #     Alchemy::I18n.t("Hello %{world}!", :world => @world)
+    # Instead of having to call:
     #
-    # It offers a shortcut method and view helper called _t
+    #     Alchemy::I18n.translate(:hello)
     #
-    # === Notes
+    # You can use this shortcut method:
     #
-    # All translations are scoped into the +alchemy+ namespace.
-    # Even scopes are scoped into the +alchemy+ namespace.
+    #     Alchemy.t(:hello)
     #
-    # So a call for _t('hello', :scope => :world) has to be translated like this:
-    #
-    #   de:
-    #     alchemy:
-    #       world:
-    #         hello: Hallo
-    #
-    def self.t(msg, *args)
-      options = args.extract_options!
-      humanize_default_string!(msg, options)
-      scope = ['alchemy']
-      case options[:scope].class.name
-      when "Array"
-        scope += options[:scope]
-      when "String"
-        scope << options[:scope]
-      when "Symbol"
-        scope << options[:scope] unless options[:scope] == :alchemy
-      end
-      ::I18n.t(msg, options.merge(:scope => scope))
+    def t(msg, *args)
+      Alchemy::I18n.translate(msg, *args)
     end
+  end
 
-    def self.available_locales
-      @@available_locales ||= nil
-      @@available_locales || translation_files.collect { |f| f.match(/.{2}\.yml$/).to_s.gsub(/\.yml/, '').to_sym }
-    end
+  module I18n
+    class << self
+      def t(msg, *args)
+        ActiveSupport::Deprecation.warn('`Alchemy::I18n.t` is deprecated! Use `Alchemy.t` instead.', caller.unshift)
+        Alchemy::I18n.translate(msg, *args)
+      end
 
-    def self.available_locales=(locales)
-      @@available_locales = Array(locales).map { |locale| locale.to_sym }
-      @@available_locales = nil if @@available_locales.empty?
-    end
+      # Alchemy translation methods
+      #
+      # Instead of having to translate strings and defining a default value:
+      #
+      #     Alchemy::I18n.translate("Hello World!", default: 'Hello World!')
+      #
+      # We define this method to define the value only once:
+      #
+      #     Alchemy::I18n.translate("Hello World!")
+      #
+      # Note that interpolation still works:
+      #
+      #     Alchemy::I18n.translate("Hello %{world}!", world: @world)
+      #
+      # === Notes
+      #
+      # All translations are scoped into the +alchemy+ namespace.
+      # Even scopes are scoped into the +alchemy+ namespace.
+      #
+      # So a call for Alchemy::translate('hello', scope: 'world') has to be translated like this:
+      #
+      #   de:
+      #     alchemy:
+      #       world:
+      #         hello: Hallo
+      #
+      def translate(msg, *args)
+        options = args.extract_options!
+        humanize_default_string!(msg, options)
+        scope = alchemy_scoped_scope(options)
+        ::I18n.t(msg, options.merge(scope: scope))
+      end
 
-    def self.translation_files
-      Dir.glob(File.join(File.dirname(__FILE__), '../../config/locales/alchemy.*.yml'))
-    end
+      def available_locales
+        @@available_locales ||= nil
+        @@available_locales || translation_files.collect do |f|
+          f.match(/.{2}\.yml$/).to_s.gsub(/\.yml/, '').to_sym
+        end
+      end
+
+      def available_locales=(locales)
+        @@available_locales = Array(locales).map(&:to_sym)
+        @@available_locales = nil if @@available_locales.empty?
+      end
+
+      def translation_files
+        Dir.glob(File.join(File.dirname(__FILE__), '../../config/locales/alchemy.*.yml'))
+      end
 
-  private
+      private
 
-    def self.humanize_default_string!(msg, options)
-      if options[:default].blank?
+      def humanize_default_string!(msg, options)
+        return if options[:default].present?
         options[:default] = msg.is_a?(Symbol) ? msg.to_s.humanize : msg
       end
-    end
 
+      def alchemy_scoped_scope(options)
+        default_scope = ['alchemy']
+        case options[:scope]
+        when Array
+          default_scope += options[:scope]
+        when String
+          default_scope << options[:scope]
+        when Symbol
+          if options[:scope] != :alchemy
+            default_scope << options[:scope]
+          end
+        else
+          default_scope
+        end
+      end
+    end
   end
 end

data/lib/alchemy/kaminari/scoped_pagination_url_helper.rb

@@ -1,6 +1,5 @@
 # A Kaminari patch for scoping the urls.
 Kaminari::Helpers::Tag.class_eval do
-
   def page_url_for(page)
     params = @params.merge(@param_name => (page <= 1 ? nil : page))
     if @options[:scope]
@@ -9,5 +8,4 @@ Kaminari::Helpers::Tag.class_eval do
       @template.url_for params
     end
   end
-
 end

data/lib/alchemy/locale.rb

@@ -60,6 +60,5 @@ module Alchemy
     def locale_from_browser
       request.env['HTTP_ACCEPT_LANGUAGE'].try(:scan, /\A[a-z]{2}/).try(:first)
     end
-
   end
 end

data/lib/alchemy/logger.rb

@@ -1,15 +1,13 @@
 module Alchemy
   module Logger
-
     # Logs a debug message to the Rails standard logger and adds some nicer formatting
     def self.warn(message, caller_string)
       Rails.logger.debug %(\n++++ WARNING: #{message}\nCalled from: #{caller_string}\n)
-      return nil
+      nil
     end
 
     def log_warning(message)
       Alchemy::Logger.warn(message, caller.first)
     end
-
   end
 end

data/lib/alchemy/modules.rb

@@ -54,8 +54,9 @@ module Alchemy
       module_navi = alchemy_module_navigation(alchemy_module)
       subnavi = module_navi['sub_navigation']
       return if subnavi.nil?
-      subnavi.map(&:stringify_keys).detect do |subnavi|
-        controller_matches?(subnavi, name) && action_matches?(subnavi, name)
+
+      subnavi.map(&:stringify_keys).detect do |sn|
+        controller_matches?(sn, name) && action_matches?(sn, name)
       end
     end
 
@@ -70,6 +71,5 @@ module Alchemy
     def remove_slash(name)
       name.gsub(/^\//, '')
     end
-
   end
 end

data/lib/alchemy/mount_point.rb

@@ -1,14 +1,12 @@
 require 'rails'
 
 module Alchemy
-
   # Utilities for Alchemy's mount point in the host rails app.
   #
   class MountPoint
     MOUNT_POINT_REGEXP = /mount\sAlchemy::Engine\s=>\s['|"](\/\w*)['|"]/
 
     class << self
-
       # Returns the path of Alchemy's mount point in current rails app.
       #
       # @param [Boolean] remove_leading_slash_if_blank

data/lib/alchemy/name_conversions.rb

@@ -4,7 +4,6 @@ module Alchemy
   # Provides methods for converting names into urlnames and vice versa.
   #
   module NameConversions
-
     # Converts a given name into url save and readable urlanme.
     # Uses rails parameterize, but converts german umlauts before.
     #
@@ -21,8 +20,7 @@ module Alchemy
     # Converts a filename and suffix into a human readable name.
     #
     def convert_to_humanized_name(name, suffix)
-      name.gsub(/\.#{::Regexp.quote(suffix)}$/i, '').gsub(/_/, ' ').strip
+      name.gsub(/\.#{::Regexp.quote(suffix)}$/i, '').tr('_', ' ').strip
     end
-
   end
 end

data/lib/alchemy/on_page_layout.rb

@@ -1,15 +1,14 @@
 module Alchemy
-
-  # = Adds before filter to pages show action
+  # = Provides a DSL to define callbacks run in a before filter on pages show action
   #
   # Use this mixin to add the +on_page_layout+ class method
   # into your +ApplicationController+.
   #
-  # Pass a block or method name in which you have the +@page+ object and can do
-  # everything as if you where in a normal controller action.
+  # Pass a block or method name in which you have the +@page+ object available and can do
+  # everything as if you were in a normal controller action.
   #
-  # Pass a +Alchemy::PageLayout+ name or +:all+ to
-  # call this callback only on specific pages or all pages.
+  # You can pass a +Alchemy::PageLayout+ name, an array of names, or +:all+ to
+  # evaluate the callback on either some specific or all the pages.
   #
   # == Example:
   #
@@ -21,36 +20,51 @@ module Alchemy
   #       end
   #
   #       on_page_layout :contact, :do_something
+  #       on_page_layout [:standard, :home, :news], :do_something_else
   #
   #       private
   #
   #       def do_something
   #         @contacts = Contact.all
   #         if @page.tag_list.include?('something')
-  #           do_something
+  #           ...
   #         end
   #       end
+  #
+  #       def do_something_else
+  #         ...
+  #       end
   #     end
   #
   module OnPageLayout
+    # All registered callbacks
+    def self.callbacks
+      @callbacks
+    end
 
-    def on_page_layout(page_layout, callback = nil)
-      Alchemy::PagesController.class_eval do
-
-        append_before_action only: :show, if: -> { call_page_layout_callback_for?(page_layout) } do
-          if block_given?
-            instance_eval(&Proc.new)
-          elsif callback
-            self.send(callback)
-          else
-            raise "You need to either pass a block or method name as callback for `on_page_layout`"
-          end
-        end
-
-        private
+    # Registers a callback for given page layout
+    def self.register_callback(page_layout, callback)
+      @callbacks ||= {}
+      @callbacks[page_layout] ||= []
+      @callbacks[page_layout] << callback
+    end
 
-        def call_page_layout_callback_for?(page_layout)
-          page_layout.to_sym == :all || @page.page_layout.to_sym == page_layout.to_sym
+    # Define a page layout callback
+    #
+    # Pass a block or method name in which you have the +@page+ object available and can do
+    # everything as if you were in a normal controller action.
+    #
+    # Pass a +Alchemy::PageLayout+ name, an array of names, or +:all+ to
+    # evaluate the callback on either some specific or all the pages.
+    #
+    def on_page_layout(page_layouts, callback = nil, &block)
+      callback = block || callback
+      [page_layouts].flatten.each do |page_layout|
+        if callback
+          OnPageLayout.register_callback(page_layout, callback)
+        else
+          raise ArgumentError,
+            "You need to either pass a block or method name as a callback for `on_page_layout`"
         end
       end
     end