comfypress 0.1.3

data/lib/comfypress/sitemap.rb

@@ -0,0 +1,27 @@
+class ComfyPress::Sitemap
+  
+  # we want our callback to include the cms_site and 
+  # the view so we have whatever routes are available to us
+  # xml is an xml_builder which expects a sitemap url definition, e.g:
+  #   xml.url do
+  #     xml.loc view.url_for("http://example.org/example")
+  #     xml.lastmod 2.days.ago.strftime('%Y-%m-%d')
+  #   end
+  def self.process(cms_site, view, xml)
+    self.sitemap_extensions.each do |extension|
+      extension.call(cms_site, view, xml)
+    end
+  end
+  
+  def self.register_extension(callback)
+    self.sitemap_extensions.push(callback)
+  end
+  
+private
+  
+  # A list of registered sitemap extension methods
+  def self.sitemap_extensions
+    @@sitemap_extensions ||= []
+  end
+  
+end

data/lib/comfypress/tag.rb

@@ -0,0 +1,154 @@
+# encoding: utf-8
+
+require 'csv'
+
+# This module provides all Tag classes with neccessary methods.
+# Example class that will behave as a Tag:
+#   class MySpecialTag
+#     include ComfyPress::Tag
+#     ...
+#   end
+module ComfyPress::Tag
+  
+  TOKENIZER_REGEX   = /(\{\{\s*cms:[^{}]*\}\})|((?:\{?[^{])+|\{+)/
+  IDENTIFIER_REGEX  = /\w+[\-\.\w]+\w+/
+  
+  attr_accessor :page,
+                :identifier,
+                :namespace,
+                :params,
+                :parent
+  
+  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_identifier}}
+    def regex_tag_signature(identifier = nil)
+      nil
+    end
+    
+    # Initializing tag object for a particular Tag type
+    # First capture group in the regex is the tag identifier
+    # Namespace is the string separated by a dot. So if identifier is:
+    # 'sidebar.about' namespace is: 'sidebar'
+    def initialize_tag(page, tag_signature)
+      if match = tag_signature.match(regex_tag_signature)
+        
+        params = begin
+          (CSV.parse_line(match[2].to_s, :col_sep => ':') || []).compact
+        rescue
+          []
+        end.map{|p| p.gsub(/\\|'/) { |c| "\\#{c}" } }
+        
+        tag = self.new
+        tag.page        = page
+        tag.identifier  = match[1]
+        tag.namespace   = (ns = tag.identifier.split('.')[0...-1].join('.')).blank?? nil : ns
+        tag.params      = params
+        tag
+      end
+    end
+  end
+  
+  module InstanceMethods
+    
+    # String indentifier of the tag
+    def id
+      "#{self.class.to_s.demodulize.underscore}_#{self.identifier}"
+    end
+    
+    # Ancestors of this tag constructed during rendering process.
+    def ancestors
+      node, nodes = self, []
+      nodes << node = node.parent while node.parent
+      nodes
+    end
+    
+    # Regex that is used to identify instance of the tag
+    # Example:
+    #   /<\{\s*?cms:page:tag_identifier\}/
+    def regex_tag_signature
+      self.class.regex_tag_signature(identifier)
+    end
+    
+    # Content that is accociated with Tag instance.
+    def content
+      nil
+    end
+    
+    # Content that is used during page rendering. Outputting existing content
+    # as a default.
+    def render
+      ignore = [ComfyPress::Tag::Partial, ComfyPress::Tag::Helper].member?(self.class)
+      ComfyPress::Tag.sanitize_irb(content, ignore)
+    end
+    
+    # Find or initialize Cms::Block object
+    def block
+      page.blocks.detect{|b| b.identifier == self.identifier.to_s} || 
+      page.blocks.build(:identifier => self.identifier.to_s)
+    end
+    
+    # Checks if this tag is using Cms::Block
+    def is_cms_block?
+      %w(page field collection).member?(self.class.to_s.demodulize.underscore.split(/_/).first)
+    end
+    
+    # Used in displaying form elements for Cms::Block
+    def record_id
+      block.id
+    end
+  end
+  
+private
+  
+  # Initializes a tag. It's handled by one of the tag classes
+  def self.initialize_tag(page, tag_signature)
+    tag_instance = nil
+    tag_classes.find{ |c| tag_instance = c.initialize_tag(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(page, content = '', parent_tag = nil)
+    tokens = content.to_s.scan(TOKENIZER_REGEX)
+    tokens.collect do |tag_signature, text|
+      if tag_signature
+        if tag = self.initialize_tag(page, tag_signature)
+          tag.parent = parent_tag if parent_tag
+          if tag.ancestors.select{|a| a.id == tag.id}.blank?
+            page.tags << tag
+            self.process_content(page, tag.render, tag)
+          end
+        end
+      else
+        text
+      end
+    end.join('')
+  end
+  
+  # Cleaning content from possible irb stuff. Partial and Helper tags are OK.
+  def self.sanitize_irb(content, ignore = false)
+    if ComfyPress.config.allow_irb || ignore
+      content.to_s
+    else
+      content.to_s.gsub('<%', '&lt;%').gsub('%>', '%&gt;')
+    end
+  end
+  
+  def self.included(tag)
+    tag.send(:include, ComfyPress::Tag::InstanceMethods)
+    tag.send(:extend, ComfyPress::Tag::ClassMethods)
+    @@tag_classes ||= []
+    @@tag_classes << tag
+  end
+  
+  # A list of registered Tag classes
+  def self.tag_classes
+    @@tag_classes ||= []
+  end
+end

data/lib/comfypress/tags/asset.rb

@@ -0,0 +1,25 @@
+class ComfyPress::Tag::Asset
+  include ComfyPress::Tag
+
+  def self.regex_tag_signature(identifier = nil)
+    identifier ||= IDENTIFIER_REGEX
+    /\{\{\s*cms:asset:(#{identifier}):?(.*?)\s*\}\}/
+  end
+
+  def content
+    return unless (layout = Cms::Layout.find_by_identifier(identifier))
+    type    = params[0]
+    format  = params[1]
+    
+    case type
+    when 'css'
+      out = "/cms-css/#{page.site.id}/#{identifier}.css"
+      out = "<link href='#{out}' media='screen' rel='stylesheet' type='text/css' />" if format == 'html_tag'
+      out
+    when 'js'
+      out = "/cms-js/#{page.site.id}/#{identifier}.js"
+      out = "<script src='#{out}' type='text/javascript'></script>" if format == 'html_tag'
+      out
+    end
+  end
+end

data/lib/comfypress/tags/collection.rb

@@ -0,0 +1,64 @@
+class ComfyPress::Tag::Collection
+  include ComfyPress::Tag
+  
+  # Here's a full tag signature:
+  #   {{ cms:collection:label:collection_class:collection_partial:collection_title:collection_identifier:collection_params }}
+  # Most minimal tag can look like this:
+  #   {{ cms:collection:album:foo/my_album }}
+  # A more complete example of the above:
+  #   {{ cms:collection:album:foo/my_album:albums/show:title:slug:param_a:param_b }}
+  def self.regex_tag_signature(identifier = nil)
+    identifier ||= IDENTIFIER_REGEX
+    /\{\{\s*cms:collection:(#{identifier}):(.*?)\s*\}\}/
+  end
+  
+  # Class definitition. It's basically `Herp::DerpityDerp.undescore` so an example
+  # of valid definition is: `herp/derpity_derp`
+  def collection_class
+    self.params[0].classify
+  end
+  
+  # Path to the partial. Example: `path/to/partial`
+  def collection_partial
+    self.params[1] || "partials/#{self.collection_class.underscore.pluralize}"
+  end
+  
+  # Title method for the Collection objects. Default is `label`
+  def collection_title
+    self.params[2] || 'label'
+  end
+  
+  # Identifier that will be used to find selected collection object. Defaults to `id`
+  def collection_identifier
+    self.params[3] || 'id'
+  end
+  
+  # Extra params that will be passed to the partial AND ALSO will be passed as parameters
+  # for the `cms_collection` scope you can define for your Collection object
+  def collection_params
+    self.params[4..-1] || []
+  end
+  
+  # Array of objects used in the collection
+  # You may set up a scope on the model `scope :cms_collection, lambda|*args| do ... end `
+  # `args` will be the set of `collection_params`
+  def collection_objects
+    klass = self.collection_class.constantize
+    klass.respond_to?(:cms_collection) ? klass.cms_collection(*collection_params).all : klass.all
+  end
+  
+  def content
+    block.content
+  end
+  
+  def render
+    if self.content.present?
+      ps = collection_params.collect_with_index{|p, i| ":param_#{i+1} => '#{p}'"}.join(', ')
+      ps = ps.present?? ", #{ps}" : ''
+      "<%= render :partial => '#{collection_partial}', :locals => {:model => '#{collection_class}', :identifier => '#{content}'#{ps}} %>"
+    else
+      ''
+    end
+  end
+  
+end

data/lib/comfypress/tags/field_datetime.rb

@@ -0,0 +1,17 @@
+class ComfyPress::Tag::FieldDateTime
+  include ComfyPress::Tag
+  
+  def self.regex_tag_signature(identifier = nil)
+    identifier ||= IDENTIFIER_REGEX
+    /\{\{\s*cms:field:(#{identifier}):datetime\s*\}\}/
+  end
+  
+  def content
+    block.content
+  end
+  
+  def render
+    ''
+  end
+  
+end

data/lib/comfypress/tags/field_integer.rb

@@ -0,0 +1,17 @@
+class ComfyPress::Tag::FieldInteger
+  include ComfyPress::Tag
+  
+  def self.regex_tag_signature(identifier = nil)
+    identifier ||= IDENTIFIER_REGEX
+    /\{\{\s*cms:field:(#{identifier}):integer\s*\}\}/
+  end
+  
+  def content
+    block.content
+  end
+  
+  def render
+    ''
+  end
+  
+end

data/lib/comfypress/tags/field_rich_text.rb

@@ -0,0 +1,17 @@
+class ComfyPress::Tag::FieldRichText
+  include ComfyPress::Tag
+  
+  def self.regex_tag_signature(identifier = nil)
+    identifier ||= IDENTIFIER_REGEX
+    /\{\{\s*cms:field:(#{identifier}):rich_text\s*?\}\}/
+  end
+  
+  def content
+    block.content
+  end
+  
+  def render
+    ''
+  end
+  
+end

data/lib/comfypress/tags/field_string.rb

@@ -0,0 +1,17 @@
+class ComfyPress::Tag::FieldString
+  include ComfyPress::Tag
+  
+  def self.regex_tag_signature(identifier = nil)
+    identifier ||= IDENTIFIER_REGEX
+    /\{\{\s*cms:field:(#{identifier}):?(?:string)?\s*\}\}/
+  end
+  
+  def content
+    block.content
+  end
+  
+  def render
+    ''
+  end
+  
+end

data/lib/comfypress/tags/field_text.rb

@@ -0,0 +1,17 @@
+class ComfyPress::Tag::FieldText
+  include ComfyPress::Tag
+  
+  def self.regex_tag_signature(identifier = nil)
+    identifier ||= IDENTIFIER_REGEX
+    /\{\{\s*cms:field:(#{identifier}):?(?:text)?\s*?\}\}/
+  end
+  
+  def content
+    block.content
+  end
+  
+  def render
+    ''
+  end
+  
+end

data/lib/comfypress/tags/file.rb

@@ -0,0 +1,29 @@
+class ComfyPress::Tag::File
+  include ComfyPress::Tag
+  
+  def self.regex_tag_signature(identifier = nil)
+    identifier ||= IDENTIFIER_REGEX
+    /\{\{\s*cms:file:(#{identifier}):?(.*?)\s*\}\}/
+  end
+  
+  # Initializing Cms::File object
+  def file
+    page.site.files.detect{|f| f.file_file_name == self.identifier.to_s}
+  end
+  
+  def content
+    return unless file
+    
+    format  = params[0]
+    text    = params[1] || identifier
+    
+    case format
+    when 'link'
+      "<a href='#{file.file.url}' target='_blank'>#{text}</a>"
+    when 'image'
+      "<img src='#{file.file.url}' alt='#{text}' />"
+    else
+      file.file.url
+    end
+  end
+end

data/lib/comfypress/tags/helper.rb

@@ -0,0 +1,24 @@
+class ComfyPress::Tag::Helper
+  include ComfyPress::Tag
+  
+  BLACKLIST = %w(eval class_eval instance_eval render)
+  
+  def self.regex_tag_signature(identifier = nil)
+    identifier ||= /[\w\-]+/
+    /\{\{\s*cms:helper:(#{identifier}):?(.*?)\s*\}\}/
+  end
+  
+  def content
+    "<%= #{identifier}(#{params.collect{|p| "'#{p}'"}.join(', ')}) %>"
+  end
+  
+  def render
+    whitelist = ComfyPress.config.allowed_helpers
+    if whitelist.is_a?(Array)
+      content if whitelist.map!(&:to_s).member?(identifier)
+    else 
+      content unless BLACKLIST.member?(identifier)
+    end
+  end
+  
+end

data/lib/comfypress/tags/menu.rb

@@ -0,0 +1,27 @@
+class ComfyPress::Tag::Menu
+  include ComfyPress::Tag
+
+  def self.regex_tag_signature(identifier = nil)
+    # identifier ||= /[\w\-]+/
+    # /\{\{\s*cms:menu:(#{identifier})\s*\}\}/
+    identifier ||= /[\w\/\-]+/
+    /\{\{\s*cms:menu:(#{identifier}):?(.*?)\s*\}\}/
+  end
+
+  def content
+    # Find or initialize Cms::Menu object
+    menu = page.site.menus.detect{|s| s.identifier == self.identifier.to_s}
+    if menu
+      "<%= render partial: 'cms_content/menu', locals: {menu_id: #{menu.id}} %>"
+    end
+  end
+
+  def render
+    whitelist = ComfyPress.config.allowed_partials
+    if whitelist.is_a?(Array)
+      content if whitelist.member?(identifier)
+    else
+      content
+    end
+  end
+end

data/lib/comfypress/tags/page_datetime.rb

@@ -0,0 +1,13 @@
+class ComfyPress::Tag::PageDateTime
+  include ComfyPress::Tag
+  
+  def self.regex_tag_signature(identifier = nil)
+    identifier ||= IDENTIFIER_REGEX
+    /\{\{\s*cms:page:(#{identifier}):datetime\s*\}\}/
+  end
+  
+  def content
+    block.content
+  end
+  
+end

data/lib/comfypress/tags/page_file.rb

@@ -0,0 +1,51 @@
+class ComfyPress::Tag::PageFile
+  include ComfyPress::Tag
+  
+  # Signature of a tag:
+  #   {{ cms:page_file:some_label:type:params }}
+  # Simple tag can be:
+  #   {{ cms:page_file:some_label }}
+  def self.regex_tag_signature(identifier = nil)
+    identifier ||= IDENTIFIER_REGEX
+    /\{\{\s*cms:page_file:(#{identifier}):?(.*?)\s*\}\}/
+  end
+  
+  # Type of the tag controls how file is rendered
+  def type
+    s = params[0].to_s.gsub(/\[.*?\]/, '')
+    %w(partial url image link field).member?(s) ? s : 'url'
+  end
+  
+  def dimensions
+    params[0].to_s.match(/\[(.*?)\]/)[1] rescue nil
+  end
+  
+  def content
+    block.files.first
+  end
+  
+  def render
+    file = block.files.first
+    case self.type
+    when 'url'
+      return '' unless file
+      file.file.url
+    when 'link'
+      return '' unless file
+      text = params[1] || identifier
+      "<a href='#{file.file.url}' target='_blank'>#{text}</a>"
+    when 'image'
+      return '' unless file
+      text = params[1] || identifier
+      "<img src='#{file.file.url}' alt='#{text}' />"
+    when 'partial'
+      path = params[1] || 'partials/page_file'
+      ps = (self.params[2..-1] || []).collect_with_index{|p, i| ":param_#{i+1} => '#{p}'"}.join(', ')
+      ps = ps.present?? ", #{ps}" : ''
+      "<%= render :partial => '#{path}', :locals => {:identifier => #{file.try(:id) || 'nil'}#{ps}} %>"
+    when 'field'
+      ''
+    end
+  end
+  
+end

data/lib/comfypress/tags/page_files.rb

@@ -0,0 +1,52 @@
+class ComfyPress::Tag::PageFiles
+  include ComfyPress::Tag
+  
+  def self.regex_tag_signature(identifier = nil)
+    identifier ||= IDENTIFIER_REGEX
+    /\{\{\s*cms:page_files:(#{identifier}):?(.*?)\s*\}\}/
+  end
+  
+  # Type of the tag controls how file is rendered
+  def type
+    s = params[0].to_s.gsub(/\[.*?\]/, '')
+    %w(partial url image link field).member?(s) ? s : 'url'
+  end
+  
+  def dimensions
+    params[0].to_s.match(/\[(.*?)\]/)[1] rescue nil
+  end
+  
+  def content
+    block.files
+  end
+  
+  def render
+    files = block.files
+    case self.type
+    when 'url'
+      return '' if files.blank?
+      files.collect do |file|
+        file.file.url
+      end.join(', ')
+    when 'link'
+      return '' if files.blank?
+      files.collect do |file|
+        "<a href='#{file.file.url}' target='_blank'>#{file.label}</a>"
+      end.join(' ')
+    when 'image'
+      return '' if files.blank?
+      files.collect do |file|
+        "<img src='#{file.file.url}' alt='#{file.label}' />"
+      end.join(' ')
+    when 'partial'
+      path = params[1] || 'partials/page_files'
+      ps = (self.params[2..-1] || []).collect_with_index{|p, i| ":param_#{i+1} => '#{p}'"}.join(', ')
+      ps = ps.present?? ", #{ps}" : ''
+      ids = files.present?? files.collect(&:id).join(',') : ''
+      "<%= render :partial => '#{path}', :locals => {:identifier => [#{ids}]#{ps}} %>"
+    when 'field'
+      ''
+    end
+  end
+  
+end

data/lib/comfypress/tags/page_integer.rb

@@ -0,0 +1,13 @@
+class ComfyPress::Tag::PageInteger
+  include ComfyPress::Tag
+  
+  def self.regex_tag_signature(identifier = nil)
+    identifier ||= IDENTIFIER_REGEX
+    /\{\{\s*cms:page:(#{identifier}):integer\s*\}\}/
+  end
+  
+  def content
+    block.content
+  end
+  
+end

data/lib/comfypress/tags/page_markdown.rb

@@ -0,0 +1,22 @@
+class ComfyPress::Tag::PageMarkdown
+  include ComfyPress::Tag
+  
+  def self.regex_tag_signature(identifier = nil)
+    identifier ||= IDENTIFIER_REGEX
+    /\{\{\s*cms:page:(#{identifier}):markdown\s*\}\}/
+  end
+  
+  def content
+    block.content
+  end
+  
+  def render
+    md = Redcarpet::Markdown.new(Redcarpet::Render::HTML,
+      :autolink           => true,
+      :no_intra_emphasis  => true,
+      :fenced_code_blocks => true,
+      :lax_spacing        => true
+    )
+    md.render(content.to_s)
+  end
+end

data/lib/comfypress/tags/page_rich_text.rb

@@ -0,0 +1,13 @@
+class ComfyPress::Tag::PageRichText
+  include ComfyPress::Tag
+  
+  def self.regex_tag_signature(identifier = nil)
+    identifier ||= IDENTIFIER_REGEX
+    /\{\{\s*cms:page:(#{identifier}):rich_text\s*\}\}/
+  end
+  
+  def content
+    block.content
+  end
+  
+end

data/lib/comfypress/tags/page_string.rb

@@ -0,0 +1,13 @@
+class ComfyPress::Tag::PageString
+  include ComfyPress::Tag
+  
+  def self.regex_tag_signature(identifier = nil)
+    identifier ||= IDENTIFIER_REGEX
+    /\{\{\s*cms:page:(#{identifier}):string\s*\}\}/
+  end
+  
+  def content
+    block.content
+  end
+  
+end

data/lib/comfypress/tags/page_text.rb

@@ -0,0 +1,13 @@
+class ComfyPress::Tag::PageText
+  include ComfyPress::Tag
+  
+  def self.regex_tag_signature(identifier = nil)
+    identifier ||= IDENTIFIER_REGEX
+    /\{\{\s*cms:page:(#{identifier}):?(?:text)?\s*\}\}/
+  end
+  
+  def content
+    block.content
+  end
+  
+end

data/lib/comfypress/tags/partial.rb

@@ -0,0 +1,23 @@
+class ComfyPress::Tag::Partial
+  include ComfyPress::Tag
+  
+  def self.regex_tag_signature(identifier = nil)
+    identifier ||= /[\w\/\-]+/
+    /\{\{\s*cms:partial:(#{identifier}):?(.*?)\s*\}\}/
+  end
+  
+  def content
+    ps = params.collect_with_index{|p, i| ":param_#{i+1} => '#{p}'"}.join(', ')
+    "<%= render :partial => '#{identifier}'#{ps.blank?? nil : ", :locals => {#{ps}}"} %>"
+  end
+  
+  def render
+    whitelist = ComfyPress.config.allowed_partials
+    if whitelist.is_a?(Array)
+      content if whitelist.member?(identifier)
+    else
+      content
+    end
+  end
+  
+end

data/lib/comfypress/tags/snippet.rb

@@ -0,0 +1,19 @@
+class ComfyPress::Tag::Snippet
+  include ComfyPress::Tag
+  
+  def self.regex_tag_signature(identifier = nil)
+    identifier ||= /[\w\-]+/
+    /\{\{\s*cms:snippet:(#{identifier})\s*\}\}/
+  end
+  
+  # Find or initialize Cms::Snippet object
+  def snippet
+    page.site.snippets.detect{|s| s.identifier == self.identifier.to_s} ||
+      page.site.snippets.build(:identifier => self.identifier.to_s)
+  end
+  
+  def content
+    snippet.content
+  end
+  
+end