zen 0.1a

data/lib/zen/helper/common.rb

@@ -0,0 +1,157 @@
+module Ramaze
+  module Helper
+    ##
+    # Helper that contains several common methods for which creating their
+    # own helper would be a bit of an overkill.
+    #
+    # @author Yorick Peterse
+    # @since  0.1
+    #
+    module Common
+      ##
+      # Generate the required data for showing a Javascript based notification.
+      # Basically all this method does is storing a hash in the flash data and
+      # making the required code to do so slightly shorter.
+      #
+      # @author Yorick Peterse
+      # @param  [Symbol] type The type of notification to generate (error, notice, etc).
+      # @param  [String] title The title of the notification.
+      # @param  [String] message The message to display in the notification.
+      # @param  [String] image An optional path to a custom image to use. If no image is specified
+      # the type of notification will be used for the image. For example, an error message would
+      # result in an image named "error.png" (.png is used for all default icons).
+      # @param  [Boolean] sticky Boolean that indicates that the notification shouldn't
+      # be automatically removed after a certain period of time.
+      # @since  0.1
+      #
+      def notification type, title, message, image = nil, sticky = false
+        if image.nil?
+          image = "/admin/images/icons/large/#{type.to_s}.png"
+        end
+        
+        sticky = true if type === :error
+        
+        flash[:notification] = {
+          :title   => title,
+          :content => message,
+          :image   => image,
+          :sticky  => sticky
+        }
+      end
+      
+      ##
+      # Generate an anchor tag inspired by the way Rails does this. 
+      # The first parameter is the text to display, the second parameter is the URL.
+      #
+      # The anchor_to tag supports both query string parameters just like the link helper
+      # that ships with Ramaze but it also supports the possibility of adding HTML
+      # attributes such as an ID or class. 
+      # 
+      # URLs can be formatted in two ways. The first one, which is the most common one,
+      # is using a path to a controller/method. Simply specify a string such as
+      # "controller/method". If you want to create an anchor that points to an external
+      # website, say Google, simply start the string with "http://" and you're good to go.
+      #
+      # @example
+      #  # Rather verbose isn't it?
+      #  anchor_to 'Google Search', {:href => 'http://google.com', :q => 'Search term' }, :class => 'anchor_class', :title => 'Google Search Results :D' 
+      #
+      #  # This is also perfectly fine
+      #  anchor_to 'Dashboard', 'dashboard'
+      #
+      # @author Yorick Peterse
+      # @since  0.1
+      # @param  [String] text The text to display in the anchor tag.
+      # @param  [Hash/String] url Either a hash or a string that defines the URL.
+      # When using a hash the :href key will be used for the link location.
+      # Other keys will be used to create query string items. If the URL starts with
+      # http:// it will be an external URL.
+      # @param  [Array] attributes Optional HTML attributes to add to the anchor tag.
+      # @return [String]
+      #
+      def anchor_to text, url, *attributes
+        
+        # Sanitize the text and URL
+        text = Rack::Utils.escape_html text
+
+        # Get the URL from the second parameter (either a string or a hash).
+        if url.class.to_s === 'Hash'
+          # Get the URL from the hash and delete it
+          anchor_url   = url[:href].strip          
+          url.delete(anchor_url)
+          
+          # Generate the query string based on the left over values in the URL hash
+          query_string = Rack::Utils.build_query url
+          
+          # Create the full URL
+          anchor_url = anchor_url + query_string 
+         else
+          anchor_url = url
+        end
+
+        # Got attributes?
+        if !attributes or attributes.empty?
+          attributes = Hash.new
+        else
+          attributes = attributes[0]
+        end
+
+        # Check to see if we're dealing with an internal or external URL
+        if !anchor_url.include? '://' or !anchor_url.include? 'www.'
+           anchor_url = request.domain("/#{anchor_url}")
+        end
+        
+        # Add the href attribute so it gets processed
+        attributes['href'] = anchor_url
+        
+        # Add all the extra arguments
+        html_attributes = String.new
+        
+        attributes.each do |attribute, value|
+          attribute         = Rack::Utils.escape_html attribute
+          html_attributes  += "#{attribute}=\"#{value}\" "
+        end
+        
+        # Remove the trailing space
+        html_attributes = html_attributes.strip
+        
+        # Return the tag
+        return "<a #{html_attributes}>#{text}</a>"
+      end
+      
+      ##
+      # The cycle method cycles through a specified list of words. This helper can be
+      # used to generate "zebra" tables, meaning that every odd row has a different color.
+      #
+      # The amount of words you want to cycle through is completely customizable,
+      # however you should atleast have two words otherwise this method will be
+      # completely useless.
+      #
+      # @author Yorick Peterse
+      # @since  0.1
+      # @param  [Array] args All words to cycle through.
+      # @return [String]
+      #
+      def cycle *args
+        if @@cycle_counter.nil?
+          @@cycle_counter = 0
+        end
+        
+        # Check the current counter and reset it if it matches the total amount of arguments
+        if @@cycle_counter >= args.count
+          # Reset the counter
+          @@cycle_counter = 0
+        end
+        
+        # Get the element based on the current index
+        cycle_element = args[@@cycle_counter]
+        
+        # Increment the counter
+        @@cycle_counter += 1
+        
+        # Return the cycle element
+        return cycle_element
+      end
+    end
+  end
+end

data/lib/zen/language/en/zen_general.rb

@@ -0,0 +1,21 @@
+Zen::Language.translation 'zen_general' do |item|
+  
+  item.labels = {
+    :zen_version  => "Powered by Zen version #{Zen::Version}",
+    :zen_website  => "Website",
+    :zen_docs     => "Documentation",
+    :zen_github   => "GitHub Account",
+    :view_website => "View Website",
+    :logout       => "Logout",
+    :profile      => "Profile"
+  }
+  
+  item.errors = {
+    :csrf            => "The specified request can't be executed without a valid CSRF token.",
+    :not_authorized  => "You are not authorized to access the current page.",
+    :website_offline => "This website is currently offline.",
+    :no_templates    => "No templates were found for the given action.",
+    :no_theme        => "Before using Zen you'll need to specify a theme to use."
+  }
+  
+end

data/lib/zen/language/en/zen_models.rb

@@ -0,0 +1,39 @@
+##
+# Language pack that provides a translated set of messages used when validating models.
+#
+# @author Yorick Peterse
+# @since  0.1
+# 
+Zen::Language.translation 'zen_models' do |lang|
+  lang.exact_length = lambda do |length|
+    "This field is not exactly #{length} characters long."
+  end
+  
+  lang.format   = "This field's format is invalid."
+  lang.includes = lambda do |arg|
+    "This field's value is not in the range or set of #{arg.inspect}"
+  end
+
+  lang.integer      = "This field's value is not a number."
+  lang.length_range = "This field's value is either too long or too short."
+
+  lang.max_length   = lambda do |length|
+    "This field's value may not be longer than #{length} characters."
+  end
+
+  lang.min_length   = lambda do |length|
+    "This field's value may not be shorter than #{length} characters."
+  end
+  
+  lang.not_string   = lambda do |type|
+    "This field's value is not a valid #{type}."
+  end
+  
+  lang.numeric = "This field's value is not numeric."
+  lang.type    = lambda do |type|
+    "This field's value is not a #{type}"
+  end
+  
+  lang.presence = "This field's value is required."
+  lang.unique   = "This field's value is already taken."
+end

data/lib/zen/layout/admin.xhtml

@@ -0,0 +1,72 @@
+<!DOCTYPE html>
+<html lang="#{session[:settings][:language]}">
+  <head>
+    <meta charset="utf-8" />
+    
+    <!-- Load all stylesheets -->
+    #{build_css}
+    
+    <title>#{@page_title}</title>
+  </head>
+
+  <body id="admin">
+    <!--
+      Top part of the admin panel that contains the navigation menu along with a small
+      gravatar of the user.
+    -->
+    <div id="top">
+      <header class="container">
+        <!--
+          Main navigation of the backend. Navigation items may be excluded if the user
+          doesn't have the required permissions for the extension that created it.
+        -->
+        <nav id="main_nav" class="grid_12">
+          #{Zen::Package.build_menu("left")}
+          
+          <ul class="right clearfix">
+            <li>
+              <a href="/admin/users/logout">#{@zen_general_lang.labels[:logout]}</a>
+            </li>
+            <li>
+              <a href="/admin/users/edit/#{session[:user].id}">#{@zen_general_lang.labels[:profile]}</a>
+            </li>
+            <li>
+              <a href="/">#{@zen_general_lang.labels[:view_website]}</a>
+            </li>
+          </ul>
+        </nav>
+      </header>
+    </div>
+    
+    <!--
+      Main area of the admin panel. The content stretches across the entire screen and there
+      are no silly sidebars.
+    -->
+    <div id="container" class="container">
+      <div id="content" class="grid_12">
+        #{@content}
+      </div>
+    </div>
+    
+    <footer id="main_footer" class="container">
+      <div class="grid_12">
+        <p>#{@zen_general_lang.labels[:zen_version]}</p>
+        <p>
+          <a href="http://zen-cms.com/">#{@zen_general_lang.labels[:zen_website]}</a> |
+          <a href="http://zen-cms.com/documentation">#{@zen_general_lang.labels[:zen_docs]}</a> |
+          <a href="https://github.com/zen-cms/">#{@zen_general_lang.labels[:zen_github]}</a>
+        </p>
+      </div>
+    </footer>
+    
+    <script src="/admin/js/mootools/core.js"></script>
+    <script src="/admin/js/mootools/more.js"></script>
+    
+    <script>
+      Zen       = {};
+      Zen.Flash = #{flash.combined.to_json};
+    </script>
+    
+    #{build_js}
+  </body>
+</html>

data/lib/zen/layout/login.xhtml

@@ -0,0 +1,44 @@
+<!DOCTYPE html>
+<html lang="#{session[:settings][:language]}">
+  <head>
+    <meta charset="utf-8" />
+    
+    <!-- Load all stylesheets -->
+    #{build_css}
+    
+    <title>#{@page_title}</title>
+  </head>
+
+  <body id="login">
+    <!--
+      Main area of the admin panel. The content stretches across the entire screen and there
+      are no silly sidebars.
+    -->
+    <div id="container" class="container">
+      <div id="content" class="grid_12">
+        #{@content}
+      </div>
+    </div>
+    
+    <footer id="main_footer" class="container">
+      <div class="grid_12">
+        <p>#{@zen_general_lang.labels[:zen_version]}</p>
+        <p>
+          <a href="http://zen-cms.com/">#{@zen_general_lang.labels[:zen_website]}</a> |
+          <a href="http://zen-cms.com/documentation">#{@zen_general_lang.labels[:zen_docs]}</a> |
+          <a href="https://github.com/zen-cms/">#{@zen_general_lang.labels[:zen_github]}</a>
+        </p>
+      </div>
+    </footer>
+    
+    <script src="/admin/js/mootools/core.js"></script>
+    <script src="/admin/js/mootools/more.js"></script>
+    
+    <script>
+      Zen       = {};
+      Zen.Flash = #{flash.combined.to_json};
+    </script>
+    
+    #{build_js}
+  </body>
+</html>

data/lib/zen/liquid/controller_behavior.rb

@@ -0,0 +1,55 @@
+module Zen
+  module Liquid
+    ##
+    # Module that can be used to allow Liquid tags to use data that would otherwise
+    # only be available to controllers. Including this module gives your tags access to
+    # the following methods:
+    #
+    # * request
+    # * response
+    # * session
+    #
+    # @author Yorick Peterse
+    # @since  0.1
+    #
+    module ControllerBehavior
+      include ::Ramaze::Trinity
+      
+      ##
+      # Returns the session data of the current node. This is a workaround for the
+      # session() method not being available outside controllers.
+      #
+      # @author Yorick Peterse
+      # @since  0.1
+      # @return [Object]
+      # 
+      def session
+        return action.node.session
+      end
+      
+      ##
+      # Returns the request data of the current node. This is a workaround for the
+      # request() method not being available outside controllers.
+      #
+      # @author Yorick Peterse
+      # @since  0.1
+      # @return [Object]
+      # 
+      def request
+        return action.node.request
+      end
+      
+      ##
+      # Returns the response data of the current node. This is a workaround for the
+      # response() method not being available outside controllers.
+      #
+      # @author Yorick Peterse
+      # @since  0.1
+      # @return [Object]
+      # 
+      def response
+        return action.node.response
+      end
+    end
+  end
+end

data/lib/zen/liquid/general.rb

@@ -0,0 +1,69 @@
+require 'enumerator'
+
+module Zen
+  module Liquid
+    ##
+    # Module that provides several methods that can be used to ease the process of
+    # creating Liquid tags.
+    #
+    # @author Yorick Peterse
+    # @since  0.1
+    #
+    module General
+      include ::Ramaze::Helper::CGI
+      
+      ##
+      # Parses all additional data specified in the tag open block
+      # and turns it into a key/value hash. This makes it easier to
+      # use tags with key/value variables such as the following:
+      #
+      # bc. {% my_tag name="yorick" %}
+      #
+      # @author Yorick Peterse
+      # @since  0.1
+      # @param  [String] string the raw string specified after the tag name.
+      # @return [Hash]
+      #
+      def parse_key_values string
+        key_values = {}
+        
+        # Thanks to Michael Trommer (https://github.com/entropie) for coming up with
+        # this way of parsing the key/value string.
+        string.split(/["']([^"]*)["']|\s/).reject{ |s| s.empty? }.each_slice(2) do |key, val|
+          key_values[ key[0..-2].to_s ] = val
+        end
+        
+        # Returns the data in the format of {'key' => 'value'}
+        return key_values
+      end
+      
+      ##
+      # Converts the given input data to HTML using the specified markup engine.
+      #
+      # @example
+      #
+      #  markup_to_html("h2. Hello world!", :textile)
+      #
+      # @author Yorick Peterse
+      # @since  0.1
+      # @param  [String] markup The raw markup that has to be converted to HTML.
+      # @param  [Symbol] engine The markup engine to use such as Textile.
+      # @return [String] 
+      #
+      def markup_to_html markup, engine
+        engine = engine.to_sym
+        
+        case engine
+          when :textile
+            markup = RedCloth.new(markup).to_html
+          when :markdown
+            markup = RDiscount.new(markup).to_html
+          when :plain
+            markup = h(markup)  
+        end
+        
+        return markup
+      end
+    end
+  end
+end