comfortable_mexican_sofa 0.0.18 → 1.0.0

data/lib/comfortable_mexican_sofa/cms_acts_as_tree.rb

@@ -1,65 +1,58 @@
 module ActiveRecord
   module Acts
     module Tree
+      
       def self.included(base)
         base.extend(ClassMethods)
       end
-
-      # Specify this +acts_as+ extension if you want to model a tree structure by providing a parent association and a children
-      # association. This requires that you have a foreign key column, which by default is called +parent_id+.
-      #
-      #   class Category < ActiveRecord::Base
-      #     acts_as_tree :order => "name"
-      #   end
-      #
-      #   Example:
-      #   root
-      #    \_ child1
-      #         \_ subchild1
-      #         \_ subchild2
-      #
-      #   root      = Category.create("name" => "root")
-      #   child1    = root.children.create("name" => "child1")
-      #   subchild1 = child1.children.create("name" => "subchild1")
-      #
-      #   root.parent   # => nil
-      #   child1.parent # => root
-      #   root.children # => [child1]
-      #   root.children.first.children.first # => subchild1
-      #
-      # In addition to the parent and children associations, the following instance methods are added to the class
-      # after calling <tt>acts_as_tree</tt>:
-      # * <tt>siblings</tt> - Returns all the children of the parent, excluding the current node (<tt>[subchild2]</tt> when called on <tt>subchild1</tt>)
-      # * <tt>self_and_siblings</tt> - Returns all the children of the parent, including the current node (<tt>[subchild1, subchild2]</tt> when called on <tt>subchild1</tt>)
-      # * <tt>ancestors</tt> - Returns all the ancestors of the current node (<tt>[child1, root]</tt> when called on <tt>subchild2</tt>)
-      # * <tt>root</tt> - Returns the root of the current node (<tt>root</tt> when called on <tt>subchild2</tt>)
+      
       module ClassMethods
-        # Configuration options are:
-        #
-        # * <tt>foreign_key</tt> - specifies the column name to use for tracking of the tree (default: +parent_id+)
-        # * <tt>order</tt> - makes it possible to sort the children according to this SQL snippet.
-        # * <tt>counter_cache</tt> - keeps a count in a +children_count+ column if set to +true+ (default: +false+).
         def acts_as_tree(options = {})
-          configuration = { :foreign_key => "parent_id", :order => nil, :counter_cache => nil }
+          configuration = {
+            :foreign_key    => 'parent_id', 
+            :order          => nil, 
+            :counter_cache  => nil,
+            :dependent      => :destroy,
+            :touch          => false }
           configuration.update(options) if options.is_a?(Hash)
-
-          belongs_to :parent, :class_name => name, :foreign_key => configuration[:foreign_key], :counter_cache => configuration[:counter_cache]
-          has_many :children, :class_name => name, :foreign_key => configuration[:foreign_key], :order => configuration[:order], :dependent => :destroy
-
+          
+          belongs_to :parent,
+            :class_name     => name, 
+            :foreign_key    => configuration[:foreign_key],
+            :counter_cache  => configuration[:counter_cache],
+            :touch          => configuration[:touch]
+            
+          has_many :children,
+            :class_name     => name, 
+            :foreign_key    => configuration[:foreign_key],
+            :order          => configuration[:order],
+            :dependent      => configuration[:dependent]
+            
           class_eval <<-EOV
             include ActiveRecord::Acts::Tree::InstanceMethods
-
-            def self.roots
-              find(:all, :conditions => "#{configuration[:foreign_key]} IS NULL", :order => #{configuration[:order].nil? ? "nil" : %Q{"#{configuration[:order]}"}})
-            end
-
+            
+            scope :roots,
+              :conditions => "#{configuration[:foreign_key]} IS NULL",
+              :order      => #{configuration[:order].nil? ? "nil" : %Q{"#{configuration[:order]}"}}
+            
             def self.root
-              find(:first, :conditions => "#{configuration[:foreign_key]} IS NULL", :order => #{configuration[:order].nil? ? "nil" : %Q{"#{configuration[:order]}"}})
+              roots.first
+            end
+            
+            validates_each "#{configuration[:foreign_key]}" do |record, attr, value|
+              if value
+                if record.id == value
+                  record.errors.add attr, "cannot be it's own id"
+                elsif record.descendants.map {|c| c.id}.include?(value)
+                  record.errors.add attr, "cannot be a descendant's id"
+                end
+              end
             end
+            
           EOV
         end
       end
-
+      
       module InstanceMethods
         # Returns list of ancestors, starting from parent until root.
         #
@@ -79,21 +72,21 @@ module ActiveRecord
           end
           nodes.flatten
         end
-
+        
         # Returns the root node of the tree.
         def root
           node = self
           node = node.parent while node.parent
           node
         end
-
+        
         # Returns all siblings of the current node.
         #
         #   subchild1.siblings # => [subchild2]
         def siblings
           self_and_siblings - [self]
         end
-
+        
         # Returns all siblings and a reference to the current node.
         #
         #   subchild1.self_and_siblings # => [subchild1, subchild2]

data/lib/comfortable_mexican_sofa/cms_form_builder.rb

@@ -0,0 +1,107 @@
+class CmsFormBuilder < ActionView::Helpers::FormBuilder
+  
+  helpers = field_helpers -
+    %w(hidden_field fields_for) +
+    %w(select)
+    
+  helpers.each do |name|
+    class_eval %Q^
+      def #{name}(field, *args)
+        options = args.extract_options!
+        args << options
+        return super if options.delete(:disable_builder)
+        default_field('#{name}', field, options){ super }
+      end
+    ^
+  end
+  
+  def default_field(type, field, options = {}, &block)
+    %(
+      <div class='form_element #{type}_element'>
+        <div class='label'>#{label_for(field, options)}</div>
+        <div class='value'>#{yield}</div>
+      </div>
+    ).html_safe
+  end
+  
+  def label_for(field, options)
+    label = options.delete(:label) || field.to_s.titleize.capitalize_all
+    "<label for=\"#{object_name}_#{field}\">#{label}</label>".html_safe
+  end
+  
+  def submit(value, options = {}, &block)
+    extra_content = @template.capture(&block) if block_given?
+    cancel_link ||= options[:cancel_url] ? ' or ' + options.delete(:cancel_url) : ''
+    %(
+      <div class='form_element submit_element'>
+        #{super(value, options)} #{extra_content} #{cancel_link}
+      </div>
+    ).html_safe
+  end
+  
+  # -- Tag Field Fields -----------------------------------------------------
+  def default_tag_field(tag, options = {})
+    label     = options[:label] || tag.label.to_s.titleize
+    css_class = options[:css_class] || tag.class.to_s.underscore.downcase.idify
+    
+    options[:content_field_method] ||= :text_field_tag
+    field = 
+      options[:field] || 
+      @template.send(options[:content_field_method], 'cms_page[cms_blocks_attributes][][content]', tag.content, :id => nil)
+    
+    %(
+      <div class='form_element #{css_class}'>
+        <div class='label'>#{label}</div>
+        <div class='value'>
+          #{field}
+          #{@template.hidden_field_tag('cms_page[cms_blocks_attributes][][label]', tag.label)}
+          #{@template.hidden_field_tag('cms_page[cms_blocks_attributes][][type]', tag.type)}
+          #{@template.hidden_field_tag('cms_page[cms_blocks_attributes][][id]', tag.id) unless tag.new_record?}
+        </div>
+      </div>
+    ).html_safe
+  end
+  
+  def field_date_time(tag)
+    default_tag_field(tag, :content_field_method => :datetime_field_tag)
+  end
+  
+  def field_integer(tag)
+    default_tag_field(tag, :content_field_method => :number_field_tag)
+  end
+  
+  def field_string(tag)
+    default_tag_field(tag)
+  end
+  
+  def field_text(tag)
+    default_tag_field(tag, :content_field_method => :text_area_tag)
+  end
+  
+  def page_date_time(tag)
+    default_tag_field(tag, :content_field_method => :datetime_field_tag)
+  end
+  
+  def page_integer(tag)
+    default_tag_field(tag, :content_field_method => :number_field_tag)
+  end
+  
+  def page_string(tag)
+    default_tag_field(tag)
+  end
+  
+  def page_text(tag)
+    default_tag_field(tag, :content_field_method => :text_area_tag)
+  end
+  
+  # Capturing all calls of cms_tag_* type. For those we'll try to render
+  # a form element. Everything else can trigger MethodNotFound error.
+  def method_missing(method_name, *args)
+    if m = method_name.to_s.match(/^cms_tag_(\w+)$/)
+      send(m[1], *args) if respond_to?(m[1])
+    else
+      super
+    end
+  end
+  
+end

data/lib/comfortable_mexican_sofa/cms_rails_extensions.rb

@@ -1,12 +1,32 @@
 class String
-
   # Converts string to something suitable to be used as an element id
   def idify
     self.strip.gsub(/\W/, '_').gsub(/\s|^_*|_*$/, '').squeeze('_')
   end
   
-  # Converts a string to something usable as a url slug
-  def slugify
-    self.downcase.gsub(/\W|_/, ' ').strip.squeeze(' ').gsub(/\s/, '-')
+  # Capitalize all words in the string
+  def capitalize_all(delimiter = ' ')
+    self.split(delimiter).collect{|w| w.capitalize }.join(' ')
   end
-end
+end
+
+module CmsViewHelpers
+  
+  # Wrapper around CmsFormBuilder
+  def cms_form_for(record_or_name_or_array, *args, &proc)
+    options = args.extract_options!
+    form_for(record_or_name_or_array, *(args << options.merge(:builder => CmsFormBuilder)), &proc)
+  end
+  
+  # Wrapper for <span>
+  def span_tag(*args)
+    content_tag(:span, *args)
+  end
+  
+  # Rails 3.0 doesn't have this helper defined
+  def datetime_field_tag(name, value = nil, options = {})
+    text_field_tag(name, value, options.stringify_keys.update('type' => 'datetime'))
+  end
+end
+
+ActionView::Base.send :include, CmsViewHelpers 

data/lib/comfortable_mexican_sofa/cms_tag.rb

@@ -1,109 +1,114 @@
+# This module provides all Tag classes with neccessary methods.
+# Example class that will behave as a Tag:
+#   class MySpecialTag
+#     include CmsTag
+#     ...
+#   end
 module CmsTag
   
-  class TagError < StandardError; end
+  attr_accessor :parent
   
-  # Initializes all tags found in the provided content
-  # Will ignore duplicate tags. Will use format definition of the first one.
-  def self.parse_tags(*args)
-    options = args.extract_options!
-    content = args.first
+  module ClassMethods
+    # Regex that is used to match tags in the content
+    # Example:
+    #   /<\s*?cms:page:(\w+)\/?>/
+    # will match tags like these:
+    #   <cms:page:my_label/>
+    def regex_tag_signature
+      nil
+    end
     
-    # bailing out if nothing was sent for parsing
-    return [] if content.blank?
-      
-    tags = []
-    CmsTag::Tag.subclasses.each do |tag|
-      tag = tag.constantize
-      tags << tag.parse_tags(content).group_by{|s| s.split(':')[0...2].join(':')}.collect{|g, tag_signature| tag.new(tag_signature.first, options)}
+    # Initializing tag object for a particular Tag type
+    # First capture group in the regex is the tag label
+    def initialize_tag(cms_page, tag_signature)
+      if match = tag_signature.match(regex_tag_signature)
+        if self.respond_to?(:initialize_or_find)
+          self.initialize_or_find(cms_page, match[1])
+        else
+          tag = self.new
+          tag.label = match[1]
+          tag
+        end
+      end
     end
-    tags.flatten
   end
   
-  class Tag
-    attr_accessor :tag_signature, :label, :view, :page
-    
-    # Returns tag type based on it's classname
-    #   CmsTag::MyAwesomeTag.tag_type => 'cms_my_awesome_tag'
-    def self.tag_type
-      'cms_' + to_s.split('::').last.underscore
-    end
-    
-    def tag_type
-      self.class.tag_type
-    end
-    
-    # regular expression that finds tag signature
-    def self.regex
-      'tag regex not defined'
-    end
-    
-    # regex needed for content substitution
-    def regex
-      'tag regex not defined'
-    end
-    
-    # Returns tag identifiers from passed content based on regex defined
-    # for the particular tag
-    def self.parse_tags(content)
-      content.scan(regex).flatten
-    end
-    
-    # order at which tags get replaced with their content during page rendering
-    def self.render_priority
-      0
-    end
-    
-    def self.has_form?
-      false
-    end
+  module InstanceMethods
     
-    def initialize(*args)
-      options = args.extract_options!
-      self.tag_signature = args.first
-      
-      # provides access to action view methods for rendering form elements
-      if options[:view]
-        unless options[:view].is_a?(ActionView::Base)
-          raise TagError, "Expected ActionView::Base but got #{options[:view].class}" 
-        end
-        self.view = options[:view]
-      end
-      
-      # owner of the the tag
-      if options[:page]
-        unless options[:page].is_a?(CmsPage)
-          raise TagError, "Expected CmsPage but got #{options[:page].class}"
-        end
-        self.page = options[:page]
-      end
-      
-      tokens = self.tag_signature.split(':')
-      self.label = tokens[1]
-      
-      assign_accessors
+    # String indentifier of the tag
+    def identifier
+      "#{self.class.name.underscore}_#{self.label}"
     end
     
-    def assign_accessors
-      # ... FIX: looks retarded
+    # Equality check. Content doesn't matter. Tag identifier does.
+    def ==(tag)
+      self.identifier == tag.identifier
     end
     
-    def form_label
-      "Label Undefined!"
+    # Ancestors of this tag constructed during rendering process.
+    def ancestors
+      node, nodes = self, []
+      nodes << node = node.parent while node.parent
+      nodes
     end
     
-    def form_input
-      "Form Field Undefined!"
+    # Regex that is used to identify instance of the tag
+    # Example:
+    #   /<\s*?cms:page:tag_label\/?>/
+    def regex_tag_signature
+      nil
     end
     
+    # Content that is accociated with Tag instance.
     def content
-      'Undefined Tag'
+      nil
     end
     
-    # when cms_page renders its content this is what tag outputs on the page
+    # Content that is used during page rendering. Outputting existing content
+    # as a default.
     def render
-      content
+      content.to_s
     end
-    
   end
   
+private
+  
+  # Initializes a tag. It's handled by one of the tag classes
+  def self.initialize_tag(cms_page, tag_signature)
+    tag_instance = nil
+    tag_classes.find{ |c| tag_instance = c.initialize_tag(cms_page, tag_signature) }
+    tag_instance
+  end
+  
+  # Scanning provided content and splitting it into [tag, text] tuples.
+  # Tags are processed further and their content is expanded in the same way.
+  # Tags are defined in the parent tags are ignored and not rendered.
+  def self.process_content(cms_page, content = '', parent_tag = nil)
+    tokens = content.to_s.scan(/(<\s*cms:\w+:\w+(?::\w+)?\s*\/?>)|((?:[^<]|\<(?!\s*cms:\w+:\w+(?::\w+)?\s*\/?>))+)/)
+    tokens.collect do |tag_signature, text|
+      if tag_signature
+        if tag = self.initialize_tag(cms_page, tag_signature)
+          tag.parent = parent_tag if parent_tag
+          unless tag.ancestors.member?(tag)
+            cms_page.cms_tags << tag
+            self.process_content(cms_page, tag.render, tag)
+          end
+        end
+      else
+        text
+      end
+    end.join('')
+  end
+  
+  def self.included(tag)
+    tag.send(:include, CmsTag::InstanceMethods)
+    tag.send(:extend, CmsTag::ClassMethods)
+    @@tag_classes ||= []
+    @@tag_classes << tag
+  end
+  
+  # A list of registered Tag classes
+  def self.tag_classes
+    @@tag_classes ||= []
+  end
 end