Sha256: dccd74ff19952d75e21a8d5fea0eb79d5ead49753bc048f9a94728c136d800cb

Contents?: true

Size: 1.37 KB

Versions: 33

Compression:

Stored size: 1.37 KB

Contents

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_file(definitions_file_path) || []
        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

Version data entries

33 entries across 33 versions & 1 rubygems

Version Path
alchemy_cms-3.1.3 app/models/alchemy/element/definitions.rb
alchemy_cms-3.2.0.beta app/models/alchemy/element/definitions.rb
alchemy_cms-2.9.1 app/models/alchemy/element/definitions.rb
alchemy_cms-3.1.1 app/models/alchemy/element/definitions.rb
alchemy_cms-3.0.4 app/models/alchemy/element/definitions.rb
alchemy_cms-3.1.0 app/models/alchemy/element/definitions.rb
alchemy_cms-3.1.0.rc3 app/models/alchemy/element/definitions.rb
alchemy_cms-3.1.0.rc2 app/models/alchemy/element/definitions.rb
alchemy_cms-3.1.0.rc1 app/models/alchemy/element/definitions.rb
alchemy_cms-3.1.0.beta6 app/models/alchemy/element/definitions.rb
alchemy_cms-3.1.0.beta5 app/models/alchemy/element/definitions.rb
alchemy_cms-3.1.0.beta4 app/models/alchemy/element/definitions.rb
alchemy_cms-3.0.3 app/models/alchemy/element/definitions.rb
alchemy_cms-3.1.0.beta3 app/models/alchemy/element/definitions.rb
alchemy_cms-3.1.0.beta2 app/models/alchemy/element/definitions.rb
alchemy_cms-3.1.0.beta1 app/models/alchemy/element/definitions.rb
alchemy_cms-3.0.2 app/models/alchemy/element/definitions.rb
alchemy_cms-3.0.1 app/models/alchemy/element/definitions.rb
alchemy_cms-3.0.0 app/models/alchemy/element/definitions.rb
alchemy_cms-3.0.0.rc8 app/models/alchemy/element/definitions.rb