alchemy_cms 2.0.pre2

data/lib/alchemy/version.rb

@@ -0,0 +1,5 @@
+module Alchemy
+  
+  VERSION = "2.0.pre2"
+  
+end

data/lib/extensions/action_view.rb

@@ -0,0 +1,17 @@
+module ActionView
+  module Helpers
+    module FormHelper
+      def button(label, options = {})
+        content_tag(:button, {:type => :submit}.update(options)) do
+          label.to_s
+        end
+      end
+    end
+    
+    class FormBuilder
+      def button(label, options = {})
+        @template.button(label, options)
+      end
+    end
+  end
+end

data/lib/extensions/array.rb

@@ -0,0 +1,25 @@
+Array.class_eval do
+  
+  def stringify
+    map do |value|
+      if value.is_a?(Hash) || value.is_a?(Array)
+        value.stringify
+      else
+        value.to_s
+      end
+    end
+  end
+  
+  def stringify!
+    a = []
+    each do |value|
+      if value.is_a?(Hash) || value.is_a?(Array)
+        a << value.stringify!
+      else
+        a << value.to_s
+      end
+    end
+    replace(a)
+  end
+  
+end

data/lib/extensions/hash.rb

@@ -0,0 +1,34 @@
+class Hash
+
+  #this method adds an key/value pair in the pattern of :<name> => [] to the hash
+  #only if the key <name> doesn't already exists. this function is provided
+  #due to  http post's lack of providing the checkboxes field when no cb is
+  #selected. I'm pretty sure that this could be moved direcly into the model
+  #or even ActiveRecord.
+  def add_key_for_checkboxes name
+    self[name.to_s] = [] if self.stringify_keys[name.to_s].nil?
+  end
+  
+  def stringify
+    inject({}) do |options, (key, value)|
+      if value.is_a?(Hash) || value.is_a?(Array)
+        options[key.to_s] = value.stringify
+      else
+        options[key.to_s] = value.to_s
+      end
+      options
+    end
+  end
+  
+  def stringify!
+    each do |key, value|
+      delete(key)
+      if value.is_a?(Hash) || value.is_a?(Array)
+        store(key.to_s, value.stringify!)
+      else
+        store(key.to_s, value.to_s)
+      end
+    end
+  end
+  
+end

data/lib/middleware/flash_session_cookie.rb

@@ -0,0 +1,22 @@
+require 'rack/utils'
+
+module Alchemy
+  module Middleware
+
+    class FlashSessionCookie
+      def initialize(app, session_key = '_session_id')
+        @app = app
+        @session_key = session_key
+      end
+
+      def call(env)
+        if env['HTTP_USER_AGENT'] =~ /^(Adobe|Shockwave) Flash/
+          params = ::Rack::Utils.parse_query(env['QUERY_STRING'])
+          env['HTTP_COOKIE'] = [ @session_key, params[@session_key] ].join('=').freeze unless params[@session_key].nil?
+        end
+        @app.call(env)
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,35 @@
+require 'rails'
+
+module Alchemy
+  module Generators
+    class ElementsGenerator < ::Rails::Generators::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/elements"
+        empty_directory @elements_dir
+      end
+      
+      def create_partials
+        @elements = get_elements_from_yaml
+        @elements.each do |element|
+          @element = element
+          @contents = element["contents"]
+          @element_name = element["name"].underscore
+          template "editor.html.erb", "#{@elements_dir}/_#{@element_name}_editor.html.erb"
+          template "view.html.erb", "#{@elements_dir}/_#{@element_name}_view.html.erb"
+        end if @elements
+      end
+      
+    private
+      
+      def get_elements_from_yaml
+        YAML.load_file "#{Rails.root}/config/alchemy/elements.yml"
+      rescue Errno::ENOENT
+        puts "\nERROR: Could not read config/alchemy/elements.yml file. Please run: rails generate alchemy:scaffold"
+      end
+      
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+<%- unless @contents.blank? -%>
+	<%- @contents.each do |content| -%>
+		<%- unless content["type"] == "EssencePicture" -%>
+<%%= render_essence_editor_by_name(element, '<%= content["name"] %>') %>
+		<%- else -%>
+<%%= render_picture_editor(element) %>
+		<%- end -%>
+	<%- end -%>
+<%- end -%>

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

@@ -0,0 +1,21 @@
+<div class="<%= @element_name %>" id="<%%= element_dom_id(element) %>"<%%= element_preview_code(element) -%>>
+<%- unless @contents.blank? -%>
+<%- @contents.each do |content| -%>
+	<%- if content["type"] == "EssencePicture" -%>
+	<div class="<%= @element_name %>_images">
+		<%%- element.all_contents_by_type("EssencePicture").each do |content| -%>
+		<div class="<%= @element_name %>_image <%%= content.essence.css_class %>">
+			<%%= render_essence_view(content, :image_size => "160x120") %>
+		</div>
+		<%%- end -%>
+	</div>
+	<%- elsif @contents.size > 1 -%>
+	<div class="<%= content["name"] %>">
+		<%%= render_essence_view_by_name(element, '<%= content["name"] %>') %>
+	</div>
+	<%- else -%>
+	<%%= render_essence_view_by_name(element, '<%= content["name"] %>') %>
+	<%- end -%>
+<%- end -%>
+<%- end -%>
+</div>

data/lib/rails/generators/alchemy/page_layouts/page_layouts_generator.rb

@@ -0,0 +1,32 @@
+require 'rails'
+
+module Alchemy
+  module Generators
+    class PageLayoutsGenerator < ::Rails::Generators::Base
+      desc "This generator generates your page_layouts view partials."
+      source_root File.expand_path('templates', File.dirname(__FILE__))
+      
+      def create_directory
+        @page_layouts_dir = "#{Rails.root}/app/views/page_layouts"
+        empty_directory @page_layouts_dir
+      end
+      
+      def create_partials
+        @page_layouts = get_page_layouts_from_yaml
+        @page_layouts.each do |page_layout|
+          @page_layout_name = page_layout["name"].underscore
+          template "layout.html.erb", "#{@page_layouts_dir}/_#{@page_layout_name}.html.erb"
+        end if @page_layouts
+      end
+      
+    private
+      
+      def get_page_layouts_from_yaml
+        YAML.load_file "#{Rails.root}/config/alchemy/page_layouts.yml"
+      rescue Errno::ENOENT
+        puts "\nERROR: Could not read config/alchemy/page_layouts.yml file. Please run: rails generate alchemy:scaffold"
+      end
+      
+    end
+  end
+end

data/lib/rails/generators/alchemy/page_layouts/templates/layout.html.erb

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

data/lib/rails/generators/alchemy/plugin/plugin_generator.rb

@@ -0,0 +1,29 @@
+require 'rails'
+
+module Alchemy
+  module Generators
+    class PluginGenerator < ::Rails::Generators::Base
+      desc "This generator generates a Alchemy plugin skeleton for you."
+      argument :plugin_name, :banner => "your_plugin_name"
+      source_root File.expand_path('templates', File.dirname(__FILE__))
+      
+      def create_directories
+        @plugin_path = File.join(Rails.root, 'vendor', 'plugins', plugin_name.underscore)
+        empty_directory "#{@plugin_path}/app/controllers/admin"
+        empty_directory "#{@plugin_path}/app/models"
+        empty_directory "#{@plugin_path}/app/views/admin"
+        empty_directory "#{@plugin_path}/config/alchemy"
+        empty_directory "#{@plugin_path}/locale"
+      end
+      
+      def create_defaults
+        @plugin_name = plugin_name
+        template("init.rb", "#{@plugin_path}/init.rb")
+        template("config.yml", "#{@plugin_path}/config/alchemy/config.yml")
+        template("authorization_rules.rb", "#{@plugin_path}/config/authorization_rules.rb")
+        template("routes.rb", "#{@plugin_path}/config/routes.rb")
+      end
+      
+    end
+  end
+end

data/lib/rails/generators/alchemy/plugin/templates/authorization_rules.rb

@@ -0,0 +1,5 @@
+# Define permissions for your plugin in here.
+# See https://github.com/stffn/declarative_authorization for further informations.
+authorization do
+  
+end

data/lib/rails/generators/alchemy/plugin/templates/config.yml

@@ -0,0 +1,30 @@
+# These is your plugin configuration file.
+# ========================================
+# 
+# Options:
+# --------
+# 
+#   name:                              # Name of your plugin [String]
+#   order:                             # [Optional] Use this to set the order of plugins in the alchemy navigation, if more then one plugin is loaded. [Integer]
+#   settings:                          # [Optional] Put your own settings in YAML format into here. You can access them with plugin_conf('<%= @plugin_name.underscore %>')['settings'] [YAML]
+#   navigation:
+#     name:                            # The name is used in the Alchemy mainnavi. [String]
+#     controller:                      # The name of the controller to be called when clicking the mainnavi button [String]
+#     action:                          # The name of the action from the controller to be called when clicking the mainnavi button [String]
+#     image:                           # Path to an image inside your public folder used for the icon in the alchemy mainnavi. [String]
+#     sub_navigation:                  # Your plugins sub navigation. Put as much as sub navi entries as you want into here
+#       - name:                        # [String]
+#         controller:                  # Typically your controller and action you set for mainnavi entry.
+#         action:                      # [String]
+
+name: <%= @plugin_name.underscore %>
+  
+navigation:
+  name: <%= @plugin_name.camelcase %>
+  controller: 
+  action: 
+  image: 
+  sub_navigation:
+    - name: 
+      controller: 
+      action: 

data/lib/rails/generators/alchemy/plugin/templates/init.rb

@@ -0,0 +1,4 @@
+if defined? FastGettext
+  FastGettext.add_text_domain '<%= @plugin_name %>', :path => File.join(File.dirname(__FILE__), 'locale'), :format => :po
+  FastGettext.text_domain = '<%= @plugin_name %>'
+end

data/lib/rails/generators/alchemy/plugin/templates/routes.rb

@@ -0,0 +1,4 @@
+# Put your plugin routes into here.
+ActionController::Routing::Routes.draw do |map|
+  
+end

data/lib/rails/generators/alchemy/scaffold/scaffold_generator.rb

@@ -0,0 +1,35 @@
+require 'rails'
+
+module Alchemy
+  module Generators
+    class ScaffoldGenerator < ::Rails::Generators::Base
+      desc "This generator generates the Alchemy scaffold. Pass --with-standard-set to copy Alchemys standard set into your app."
+      class_option :with_standard_set, :type => :boolean, :desc => "Copy standard set files."
+      source_root File.expand_path('templates', File.dirname(__FILE__))
+      
+      def create_config_dir
+        empty_directory "#{Rails.root}/config/alchemy"
+      end
+      
+      def copy_config
+        @config_path = File.expand_path('../../../../../config/alchemy', File.dirname(__FILE__)) 
+        copy_file "#{@config_path}/config.yml", "#{Rails.root}/config/alchemy/config.yml"
+      end
+      
+      def copy_yamls
+        if options['--with-standard-set']
+          layouts_path = File.expand_path('../../../../../app/views/layouts', File.dirname(__FILE__)) 
+          copy_file "#{@config_path}/elements.yml", "#{Rails.root}/config/alchemy/elements.yml"
+          copy_file "#{@config_path}/page_layouts.yml", "#{Rails.root}/config/alchemy/page_layouts.yml"
+          copy_file "#{layouts_path}/pages.html.erb", "#{Rails.root}/app/views/layouts/pages.html.erb"
+          Rails::Generators.invoke("alchemy:elements")
+          Rails::Generators.invoke("alchemy:page_layouts")
+        else
+          template "elements.yml", "#{Rails.root}/config/alchemy/elements.yml"
+          template "page_layouts.yml", "#{Rails.root}/config/alchemy/page_layouts.yml"
+        end
+      end
+      
+    end
+  end
+end

data/lib/rails/generators/alchemy/scaffold/templates/elements.yml

@@ -0,0 +1,91 @@
+# == In this configuration you setup Alchemy´s element layouts.
+# 
+# Use rails generate alchemy:scaffold to generate this file for your app.
+# 
+# Elements containing all necessary basic tools for displaying and editing content inside Alchemy.
+# They consists of composed contents (different essence-types) as shown in the illustration of an elements-sheme below.
+#
+# == Schema of an element
+# 
+#   =================================
+#   #  Content 1 (EssenceText)      #
+#   #                               #
+#   #  Content 2 (EssencePicture)   #
+#   #                               #
+#   #  Content 3 (EssenceRichtext)  #
+#   =================================
+#
+# == Example of a basic element layout
+# 
+#   - name: a_unique_name (Used for the partial name in +app/views/elements+ and translated as Element.display_name)
+#     unique: Bool //pass true if this element only can be displayed once on page
+#     contents:
+#     - name: head
+#       type: EssenceText
+#     - name: text
+#       type: EssenceRichtext
+#
+# As already mentioned above, there are different content-types wich can be defined for each content in an element.
+# Defining these types is used to render predefined views in the element.
+#
+# == Content-Types:
+#
+# * EssenceText               (Used to store a String (max. 255 Chars.) i.e. a headline, or productname. The editor is renderd as a single-lined input field. The view output will be sanitized and escaped. So it's XSS save.)
+# * EssenceRichtext           (Used to store editable richtext. Editor is rendered as a textarea with TinyMCE Editor.)
+# * EssencePicture            (Used to store picture ids from pictures assigned through the library. The editor is rendered as a picture-editor collection with a lot of options (i.e. image cropper). The view renders the assigned picture, resizes it, crops it and caches the result.)
+# * EssenceFlash              (Used to store attachment ids from attachments assigned through the library. The view renders an embeded object.)
+# * EssenceDate               (Used to store a DateTime object. The view output is passed through Rails I18n Library, so it will be fully localized.)
+# * EssenceHtml               (Used to store a String (max. 255 Chars.). The view output renders the raw, not sanitized or unescaped String. So be carefull!)
+# 
+# After finishing the setup of your element layouts, you need to generate the files for the elements before using them in Alchemy.
+# For creating these files, use the following command in your terminal:
+# 
+#   rails generate elements
+# 
+# All new elements will be created as two different partials in Rails.root/app/views/elements.
+# For each element there is an editor-view wich will be rendered when editing them in Alchemy and another view for the website´s frontend.
+# 
+#   app/views/elements/_elements_name_editor.html.erb
+#   app/views/elements/_elements_name_view.html.erb
+# 
+# For most contents in an element you can specify additional options, so they get rendered in a specific way.
+# These options can be defined as symbols, but its too much to list them up here.
+# You can find these options described in the application_helper.rb, most of them at the render_essence method.
+#
+# == Setting a content as preview-text for the element
+# 
+# You can set a content-essence as preview-text for its element like this
+# take_me_for_preview: true
+#
+#
+# == Adding contents dynamically in the frontend
+# 
+# You are able to add content-essences dynamically to the element from the Alchemy frontend.
+# You just have to make contents available for adding them.
+# This example enables this feature
+# 
+#   - name: headline
+#     unique: false
+#     contents:
+#     - name: headline
+#       type: EssenceText
+#     - name: big_text
+#       type: EssenceRichtext
+#     available_contents:
+#     - name: big_text
+#       type: EssenceRichtext
+#
+# Now an Alchemy user can add the content 'big_text' from the element as much as desired.
+#
+# === Translate element names
+# 
+# Element names are passed through the I18n library. So you can translate them in your config/locales language yml file.
+# 
+# Example:
+#   
+#   de:
+#     alchemy:
+#       element_names:
+#         contact: Kontakt
+#         search: Suche
+

data/lib/rails/generators/alchemy/scaffold/templates/page_layouts.yml

@@ -0,0 +1,29 @@
+# == This file defines the page_layouts for new pages.
+# 
+# Please make your own page_layouts for your app in your own Rails.root/config/alchemy/page_layouts.yml file.
+#
+# === DSL:
+#   - name: String                  # The name of the layout used for views and inside the database. You can render a layout with the render_page_layout(name) helper.
+#     unique: Bool                  # Pass true and the user can only choose this layout once inside a language tree.
+#     hide: Bool                    # Pass true to hide this layout from the user.
+#     elements: Array               # A list of element names that can be placed on this layout i.e. [text, picture]. Elements are defined inside the elements.yml file.
+#     autogenerate: Array           # A list of element names that are autogenerated after creating the Page.
+#     layoutpage: Bool              # Layoutpages are outside the normal pagetree and can be used to place "global" language independent Elements.
+#     cache: Bool                   # Pass false to disable the caching for this pages.
+#     feed: Bool                    # Pass true to enable a RSS feed of news elements from this page.
+#     redirects_to_external: Bool   # Pass true to disable normal page rendering and redirect to a external page instead.
+#     controller: controller_name   # Controller to use instead of the default PagesController
+#     action: action_name           # Controllers action to use instead of the default PagesController#show
+#
+# === Translate page layout names
+# 
+# Page layout names are passed through the I18n library. So you can translate them in your config/locales language yml file.
+# 
+# Example:
+#   
+#   de:
+#     alchemy:
+#       page_layout_names:
+#         contact: Kontakt
+#         search: Suche
+#