lc_alchemy_cms 3.2.0

data/lib/alchemy/version.rb

@@ -0,0 +1,7 @@
+module Alchemy
+  VERSION = "3.2.0"
+
+  def self.version
+    VERSION
+  end
+end

data/lib/alchemy_cms.rb

@@ -0,0 +1,5 @@
+# Instantiate the global Alchemy namespace
+module Alchemy
+end
+
+require 'alchemy/engine'

data/lib/rails/generators/alchemy/base.rb

@@ -0,0 +1,41 @@
+require 'rails'
+
+module Alchemy
+  module Generators
+    class Base < ::Rails::Generators::Base
+      class_option :template_engine, :type => :string, :aliases => '-e', :desc => 'Template engine for the views. Available options are "erb", "haml", and "slim".'
+
+      private
+
+      def conditional_template(source, destination)
+        files = Dir.glob(destination.gsub(/\.([a-z]+)$/, '*'))
+        if files.any?
+          ext = File.extname(files.first)[1..-1]
+
+          # If view already exists using a different template engine, change
+          # source and destination file names to use that engine.
+          if ext != template_engine.to_s
+            say_status :warning, "View uses unexpected template engine '#{ext}'.", :cyan
+            destination.gsub!(/#{template_engine}$/, ext)
+            source.gsub!(/#{template_engine}$/, ext)
+          end
+        end
+
+        template source, destination
+      end
+
+      def template_engine
+        # Rails is clever enough to default this to whatever template
+        # engine is configured through its generator configuration,
+        # but we'll default it to erb anyway, just in case.
+        options[:template_engine] || 'erb'
+      end
+
+      def load_alchemy_yaml(name)
+        YAML.load(ERB.new(File.read("#{Rails.root}/config/alchemy/#{name}")).result)
+      rescue Errno::ENOENT
+        puts "\nERROR: Could not read config/alchemy/#{name} file. Please run: rails generate alchemy:scaffold"
+      end
+    end
+  end
+end

data/lib/rails/generators/alchemy/elements/elements_generator.rb

@@ -0,0 +1,37 @@
+require File.join(__FILE__, '../../base')
+
+module Alchemy
+  module Generators
+    class ElementsGenerator < Base
+      desc "This generator generates your elements view partials."
+      source_root File.expand_path('templates', File.dirname(__FILE__))
+
+      def create_directory
+        @elements_dir = "#{Rails.root}/app/views/alchemy/elements"
+        empty_directory @elements_dir
+      end
+
+      def create_partials
+        @elements = load_alchemy_yaml('elements.yml')
+        @elements.each do |element|
+          @element = element
+          contents = element["contents"] || []
+          if @element['available_contents']
+            @available_contents_names = @element['available_contents'].collect { |c| c['name'] }
+            @contents = contents.delete_if { |c| @available_contents_names.include?(c['name']) } or []
+          else
+            @contents = contents
+          end
+          if element["name"] =~ /\A[a-z0-9_-]+\z/
+            @element_name = element["name"].underscore
+          else
+            raise "Element name '#{element['name']}' has wrong format. Only lowercase and non whitespace characters allowed."
+          end
+
+          conditional_template "editor.html.#{template_engine}", "#{@elements_dir}/_#{@element_name}_editor.html.#{template_engine}"
+          conditional_template "view.html.#{template_engine}", "#{@elements_dir}/_#{@element_name}_view.html.#{template_engine}"
+        end if @elements
+      end
+    end
+  end
+end

data/lib/rails/generators/alchemy/elements/templates/editor.html.erb

@@ -0,0 +1,14 @@
+<%%= element_editor_for(element) do |el| -%>
+<%- if @element['picture_gallery'] -%>
+  <%%= render_picture_gallery_editor(element, max_images: nil, crop: true) %>
+<%- end -%>
+<% @contents.each do |content| -%>
+  <%%= el.edit :<%= content["name"] %> %>
+<% end -%>
+<%- if @element['available_contents'] -%>
+  <%% element.contents.where(name: ['<%= @available_contents_names.join("', '") %>']).each do |content| %>
+    <%%= render_essence_editor content %>
+  <%% end %>
+  <p><%%= render_new_content_link(element) %></p>
+<%- end -%>
+<%%- end -%>

data/lib/rails/generators/alchemy/elements/templates/editor.html.haml

@@ -0,0 +1,13 @@
+= element_editor_for(element) do |el|
+<%- if @element['picture_gallery'] -%>
+  = render_picture_gallery_editor(element, max_images: nil, crop: true)
+<%- end -%>
+<% @contents.each do |content| -%>
+  = el.edit :<%= content["name"] %>
+<% end -%>
+<%- if @element['available_contents'] -%>
+  - element.contents.where(name: ['<%= @available_contents_names.join("', '") %>']).each do |content|
+    = render_essence_editor content
+  %p
+    = render_new_content_link(element)
+<% end -%>

data/lib/rails/generators/alchemy/elements/templates/editor.html.slim

@@ -0,0 +1,12 @@
+= element_editor_for(element) do |el|
+<%- if @element['picture_gallery'] -%>
+  = render_picture_gallery_editor(element, max_images: nil, crop: true)
+<%- end -%>
+<% @contents.each do |content| -%>
+  = el.edit :<%= content["name"] %>
+<% end -%>
+<%- if @element['available_contents'] -%>
+  - element.contents.where(name: ['<%= @available_contents_names.join("', '") %>']).each do |content|
+    = render_essence_editor content
+  p = render_new_content_link(element)
+<% end -%>

data/lib/rails/generators/alchemy/elements/templates/view.html.erb

@@ -0,0 +1,27 @@
+<%%- cache(element) do -%>
+  <%%= element_view_for(element) do |el| -%>
+  <%- if @element["picture_gallery"] -%>
+    <div class="<%= @element_name %>_images">
+      <%%- element.contents.gallery_pictures.each do |image| -%>
+      <div class="<%= @element_name %>_image <%%= image.essence.css_class %>">
+        <%%= render_essence_view(image, image_size: '160x120') %>
+      </div>
+      <%%- end -%>
+    </div>
+  <%- end -%>
+  <%- @contents.each do |content| -%>
+    <%- if @contents.length > 1 -%>
+    <div class="<%= content["name"] %>">
+      <%%= el.render :<%= content["name"] %> %>
+    </div>
+    <%- else -%>
+    <%%= el.render :<%= content["name"] %> %>
+    <%- end -%>
+  <%- end -%>
+  <%- if @element['available_contents'] -%>
+    <%%- element.contents.where(name: ['<%= @available_contents_names.join("', '") %>']).each do |content| -%>
+      <%%= render_essence_view(content) %>
+    <%%- end -%>
+  <%- end -%>
+  <%%- end -%>
+<%%- end -%>

data/lib/rails/generators/alchemy/elements/templates/view.html.haml

@@ -0,0 +1,20 @@
+- cache(element) do
+  = element_view_for(element) do |el|
+  <%- if @element["picture_gallery"] -%>
+    .<%= @element_name %>_images
+      - element.contents.gallery_pictures.each do |image|
+        .<%= @element_name %>_image{class: image.essence.css_class}
+          = render_essence_view(image, image_size: "160x120")
+  <%- end -%>
+  <%- @contents.each do |content| -%>
+    <%- if @contents.length > 1 -%>
+    .<%= content["name"] %>
+      = el.render :<%= content["name"] %>
+    <%- else -%>
+    = el.render :<%= content["name"] %>
+    <%- end -%>
+  <%- end -%>
+  <%- if @element['available_contents'] -%>
+    - element.contents.where(name: ['<%= @available_contents_names.join("', '") %>']).each do |content|
+      = render_essence_view(content)
+  <%- end -%>

data/lib/rails/generators/alchemy/elements/templates/view.html.slim

@@ -0,0 +1,20 @@
+- cache(element) do
+  = element_view_for(element) do |el|
+  <%- if @element["picture_gallery"] -%>
+    .<%= @element_name %>_images
+      - element.contents.gallery_pictures.each do |image|
+        .<%= @element_name %>_image class=image.essence.css_class
+          = render_essence_view(image, image_size: "160x120")
+  <%- end -%>
+  <%- @contents.each do |content| -%>
+    <%- if @contents.length > 1 -%>
+    .<%= content["name"] %>
+      = el.render :<%= content["name"] %>
+    <%- else -%>
+    = el.render :<%= content["name"] %>
+    <%- end -%>
+  <%- end -%>
+  <%- if @element['available_contents'] -%>
+    - element.contents.where(name: ['<%= @available_contents_names.join("', '") %>']).each do |content|
+      = render_essence_view(content)
+  <%- end -%>

data/lib/rails/generators/alchemy/essence/essence_generator.rb

@@ -0,0 +1,52 @@
+require 'rails'
+
+module Alchemy
+  module Generators
+    class EssenceGenerator < ::Rails::Generators::Base
+      desc "This generator generates an Alchemy essence for you."
+      argument :essence_name, :banner => "YourEssenceName"
+      source_root File.expand_path('templates', File.dirname(__FILE__))
+
+      def init
+        @essence_name = Alchemy::Content.normalize_essence_type(essence_name).underscore
+        @essence_view_path = Rails.root.join('app/views/alchemy/essences')
+      end
+
+      def create_model
+        invoke("model", [@essence_name])
+      end
+
+      def create_directory
+        empty_directory @essence_view_path
+      end
+
+      def act_as_essence
+        essence_class_file = Rails.root.join('app/models', "#{@essence_name}.rb")
+        essence_class = @essence_name.classify
+        inject_into_class essence_class_file, essence_class, <<-CLASSMETHOD
+  acts_as_essence(
+    # Your options:
+    #
+    # ingredient_column:   [String or Symbol] - Specifies the column name you use for storing the content in the database. (Default :body)
+    # validate_column:     [String or Symbol] - Which column should be validated. (Default: ingredient_column)
+    # preview_text_column: [String or Symbol] - Specifies the column for the preview_text method. (Default: ingredient_column)
+    # preview_text_method: [String or Symbol] - A method called on ingredient to get the preview text. (Default: ingredient_column)
+  )
+CLASSMETHOD
+      end
+
+      def copy_templates
+        essence_name = @essence_name.classify.demodulize.underscore
+        template "view.html.erb", "#{@essence_view_path}/_#{essence_name}_view.html.erb"
+        template "editor.html.erb", "#{@essence_view_path}/_#{essence_name}_editor.html.erb"
+      end
+
+      def show_todo
+        say "\nPlease open the generated migration file and add your columns to your table."
+        say "Then run 'rake db:migrate' to update your database."
+        say "Also check the generated view files and alter them to fit your needs."
+      end
+
+    end
+  end
+end

data/lib/rails/generators/alchemy/essence/templates/editor.html.erb

@@ -0,0 +1,17 @@
+<%%#
+  Available locals:
+  * content (The object the essence is linked to the element)
+  * html_options
+
+  Please consult Alchemy::Content.rb docs for further methods on the content object
+%>
+<%% cache(content) do %>
+<div class="content_editor <%= @essence_name.classify.demodulize.underscore %>" id="<%%= content.dom_id %>" data-content-id="<%%= content.id %>">
+  <%%= label_and_remove_link(content) %>
+  <%%= text_field_tag(
+    content.form_field_name,
+    content.ingredient,
+    :id => content.form_field_id
+  ) %>
+</div>
+<%% end %>

data/lib/rails/generators/alchemy/essence/templates/view.html.erb

@@ -0,0 +1,2 @@
+<%%# The content object holds the essence %>
+<%%= content.ingredient %>

data/lib/rails/generators/alchemy/install/files/_article_editor.html.erb

@@ -0,0 +1,5 @@
+<%= element_editor_for(element) do |el| -%>
+  <%= el.edit :headline %>
+  <%= el.edit :picture, crop: true, fixed_ratio: false %>
+  <%= el.edit :text %>
+<%- end -%>

data/lib/rails/generators/alchemy/install/files/_article_view.html.erb

@@ -0,0 +1,7 @@
+<%- cache(element) do -%>
+  <%= element_view_for(element, tag: 'article') do |el| -%>
+    <h2><%= el.render :headline %></h2>
+    <%= el.render :picture, image_size: '1200x600' %>
+    <%= el.render :text %>
+  <%- end -%>
+<%- end -%>

data/lib/rails/generators/alchemy/install/files/_standard.html.erb

@@ -0,0 +1 @@
+<%= render_elements %>

data/lib/rails/generators/alchemy/install/files/alchemy.de.yml

@@ -0,0 +1,31 @@
+de:
+  alchemy:
+
+    # Translations for page layout names
+    page_layout_names:
+      index: Startseite
+
+    # Translations for element names
+    element_names:
+      article: Artikel
+
+    # Translations for content names
+    content_names:
+      headline: Überschrift
+      text: Text
+      picture: Bild
+
+    # Default texts for new contents created
+    default_content_texts:
+      article_headline: "Willkommen auf Ihrer Alchemy Seite"
+      article_text: '<p>Als erstes sollte man sich mit der Struktur von Alchemy vertraut machen. <a class="external" href="http://guides.alchemy-cms.com/edge/alchemy_approach.html" target="_blank" data-link-target="blank">Mehr dazu in den Guidelines</a>.</p><p>Die wichtigsten beiden Dinge die man über Alchemy wissen muss sind Elemente und Seitentypen.</p><p><span style="text-decoration: underline;"><strong>Elemente:</strong></span></p><p>Mit Alchemy kann man eine Seite in Inhaltsbereiche aufteilen, Elemente. Diese Elemente werden aus verschiedenen Grundtypen (Essenzen) zusammengesetzt. Die Essenzen sind:</p><ul><li>EssenceText - <em>Eine Zeile Text</em></li><li>EssenceRichtext - <em>Ein TinyMCE basierter formatierter Textblock</em></li><li>EssencePicture - <em>Ein Verweis auf ein Bild</em></li><li>EssenceHtml - <em>HTML Code</em></li><li>EssenceSelect - <em>Eine Auswahl an Werten</em></li><li>EssenceBoolean - <em>Eine Checkbox</em></li></ul><p>Elemente werden in einer YAML Datei definiert: <strong>config/alchemy/elements.yml</strong></p><p><a class="external" href="http://guides.alchemy-cms.com/edge/elements.html" target="_blank" data-link-target="blank">Mehr über Elemente und wie sie definiert werden, kann in den Guidelines nachgelesen werden.</a></p><p><span style="text-decoration: underline;"><strong>Seitentypen:</strong></span></p><p>Es können verschiedene Seitentypen definiert werden. Diesen können Elemente zugewiesen und ihr Verhalten definiert werden.</p><p>Seitentypen werden ein einer YAML Datei definiert: <strong>config/alchemy/page_layouts.yml</strong></p><p><a class="external" href="http://guides.alchemy-cms.com/edge/page_layouts.html" target="_blank" data-link-target="blank">Mehr über das Erstellen von Seitentypen kann in den Guidelines nachgelesen werden.</a></p>'
+
+    # Hint texts for elements
+    element_hints:
+      article: "Dies ist ein Hinweistext für das Artikel Element. Dieser Text kann in der `config/locales/alchemy.de.yml` Datei angepasst werden."
+
+    # Hint texts for contents
+    content_hints:
+      headline: "Dies ist ein einzeiliger unformatierter Text"
+      picture: "Bilder werden in der Bibliothek gespeichert. Ein Bild kann mehrfach einem Element zugewiesen werden. Auch ein Bildauswahlwerkzeug ist in Alchemy integriert."
+      text: "Dies ist ein formatierbarer Textblock. Die Einstellungen des Editors können angepasst werden. Siehe http://guides.alchemy-cms.com/edge/customize_tinymce.html"

data/lib/rails/generators/alchemy/install/files/alchemy.elements.css.scss

@@ -0,0 +1,30 @@
+article {
+  width: 50%;
+  font: 16px/20px Helvetica, Arial, sans-serif;
+  color: #333;
+  margin: 1em auto;
+  padding: 0.5em 1em;
+  background: #f4f4f4;
+
+  h2 {
+    font-size: 24px;
+    line-height: 1.25;
+    font-weight: bold;
+  }
+
+  a {
+    color: #5588D3;
+  }
+
+  img {
+    max-width: 100%;
+  }
+
+  figure {
+    margin: 0;
+  }
+
+  figcaption {
+    font-size: 14px;
+  }
+}

data/lib/rails/generators/alchemy/install/files/alchemy.en.yml

@@ -0,0 +1,31 @@
+en:
+  alchemy:
+
+    # Translations for page layout names
+    page_layout_names:
+      index: Homepage
+
+    # Translations for element names
+    element_names:
+      article: Article
+
+    # Translations for content names
+    content_names:
+      headline: Headline
+      text: Text
+      picture: Picture
+
+    # Default texts for new contents created
+    default_content_texts:
+      article_headline: "Welcome to your first Alchemy CMS page"
+      article_text: '<p><strong>How to get started.</strong></p><p>First of all you should read about Alchemy and its architecture in the <a class="external" href="http://guides.alchemy-cms.com/edge/alchemy_approach.html" target="_blank" data-link-target="blank">guidelines</a>.</p><p>The most important things to know about Alchemy are elements and page layouts.</p><p><span style="text-decoration: underline;"><strong>Elements:</strong></span></p><p>With Alchemy you can split pages into content parts, elements. These elements can be defined out of several base content types: essences. The basic essences are:</p><ul><li>EssenceText - <em>A single line of text</em></li><li>EssenceRichtext - <em>A TinyMCE powered formatted text block</em></li><li>EssencePicture - <em>A reference to an image</em></li><li>EssenceHtml - <em>HTML embed code</em></li><li>EssenceSelect - <em>A selection of values</em></li><li>EssenceBoolean - <em>A checkbox</em></li></ul><p>Elements get defined in a YAML file <strong>config/alchemy/elements.yml</strong></p><p><a class="external" href="http://guides.alchemy-cms.com/edge/elements.html" target="_blank" data-link-target="blank">Read more about elements and how to define them in the guidelines.</a></p><p><span style="text-decoration: underline;"><strong>Page types:</strong></span></p><p>You can define several types of pages, called page layouts. You can assign elements to page layouts and control how elements and the page of a certain layout behave.</p><p>Page layouts get defined in a YAML file <strong>config/alchemy/page_layouts.yml</strong></p><p><a class="external" href="http://guides.alchemy-cms.com/edge/page_layouts.html" target="_blank" data-link-target="blank">Read more about defining page layouts in the guidelines.</a></p>'
+
+    # Hint texts for elements
+    element_hints:
+      article: "This is a hint text for the article element. You can change this text in `config/locales/alchemy.en.yml`. Feel free to change it as you like, it's yours."
+
+    # Hint texts for contents
+    content_hints:
+      headline: "This is a single line of unformatable Text"
+      picture: "Pictures are stored in the library. You can assign a picture multiple times throughout your site. Alchemy has an image cropper build right in."
+      text: "This is a rich text block powered by TinyMCE editor. You can change the configuration of the editor. See http://guides.alchemy-cms.com/edge/customize_tinymce.html"

data/lib/rails/generators/alchemy/install/files/alchemy.es.yml

@@ -0,0 +1,31 @@
+es:
+  alchemy:
+
+    # Translations for page layout names
+    page_layout_names:
+      index: Inicio
+
+    # Translations for element names
+    element_names:
+      article: Artículo
+
+    # Translations for content names
+    content_names:
+      headline: Titular
+      text: Texto
+      picture: Imagen
+
+    # Default texts for new contents created
+    default_content_texts:
+      article_headline: "Bienvenido a tu primera página de Alchemy CMS"
+      article_text: '<p><strong>Como empezar.</strong></p><p>Lo primero de todo deberías leer sobre Alchemy y su arquitectura en las <a class="external" href="http://guides.alchemy-cms.com/edge/alchemy_approach.html" target="_blank" data-link-target="blank">guías</a>.</p><p>Las cosas más importantes que debes saber sobre Alchemy son elementos (<i>elements</i>) y disposiciones de página (<i>page layouts</i>).</p><p><span style="text-decoration: underline;"><strong>Elementos:</strong></span></p><p>Con Alchemy puedes dividir las páginas en partes de contenido, elementos. Estos elementos se pueden definir mediante varios tipos de contenido básicos: esencias (<i>essences</i>). Las esencias básicas son:</p><ul><li>EssenceText - <em>Un única línea de texto</em></li><li>EssenceRichtext - <em>Un bloque de texto formateado mediante TinyMCE</em></li><li>EssencePicture - <em>Una referencia a una imagen</em></li><li>EssenceHtml - <em>Código HTML empotrado</em></li><li>EssenceSelect - <em>Una selección de valores</em></li><li>EssenceBoolean - <em>Una casilla de verificación</em></li></ul><p>Los elementos se definen en el fichero YAML <strong>config/alchemy/elements.yml</strong></p><p><a class="external" href="http://guides.alchemy-cms.com/edge/elements.html" target="_blank" data-link-target="blank">Lee más sobre elementos y cómo definirlos en las guías.</a></p><p><span style="text-decoration: underline;"><strong>Tipos de página:</strong></span></p><p>Puedes definir varios tipos de páginas, llamados disposiciones de páginas (<i>page layouts</i>). Puedes asignar elementos a las disposiciones de páginas y controlar cómo se comportan los elementos y una página con una disposición concreta.</p><p>Las disposiciones de páginas se definen en el fichero YAML <strong>config/alchemy/page_layouts.yml</strong></p><p><a class="external" href="http://guides.alchemy-cms.com/edge/page_layouts.html" target="_blank" data-link-target="blank">Lee más sobre definir disposiciones de páginas en las guías.</a></p>'
+    
+    # Hint texts for elements
+    element_hints:
+      article: "Este es el texto de ayuda del elemento artículo. Puedes cambiar este texto en `config/locales/alchemy.en.yml`. Siéntete libre de cambiarlo a tu gusto, es tuyo."
+
+    # Hint texts for contents
+    content_hints:
+      headline: "Esta es una sencilla linea de texto sin formato"
+      picture: "Las imágenes se almacenan en la librería. Puedes asignar una imagen varias veces en tu sitio. Alchemy tiene una herramienta de recorte de imagen integrada."
+      text: "Este es un bloque de texto enriquecido mediante el editor TinyMCE. Puedes cambiar la configuración del editor. Ver http://guides.alchemy-cms.com/edge/customize_tinymce.html"

data/lib/rails/generators/alchemy/install/files/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <%= render_meta_data %>
+  <%= stylesheet_link_tag 'application', media: 'all' %>
+  <%= javascript_include_tag 'application' %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+  <%= yield %>
+  <%= alchemy_preview_mode_code %>
+  <%= render "alchemy/menubar" %>
+</body>
+</html>