zen 0.1a → 0.2

data/lib/zen/helper/acl.rb

@@ -1,4 +1,6 @@
+#:nodoc:
 module Ramaze
+  #:nodoc:
   module Helper
     ##
     # This helper provides an easy way of working with the ACL system that
@@ -10,7 +12,8 @@ module Ramaze
     # "extension_identifier" in your classes. Once this trait have been set you
     # can use the "user_authorized?" method to verify the permissions of the current user.
     # The first parameter is an array of required permissions,
-    # the second a boolean that indicates if either all or just a single permission must be set.
+    # the second a boolean that indicates if either all or just a single permission must 
+    # be set.
     #
     # For more information about the ACL system you should read the documentation
     # in the ACL controller, Users::Controllers::AccessRules().

data/lib/zen/helper/asset.rb

@@ -1,6 +1,8 @@
 require 'ramaze/gestalt'
 
+#:nodoc:
 module Ramaze
+  #:nodoc:
   module Helper
     ##
     # The Asset helper can be used to load Javascript and CSS files without
@@ -9,7 +11,7 @@ module Ramaze
     # require_* method. For example, if we want to require a CSS file named
     # "reset" we'd do the following:
     #
-    # bc. register_css :reset
+    #     register_css('reset')
     #
     # Once you have your files required you can build the HTML by either calling
     # build_css or build_js.
@@ -29,7 +31,7 @@ module Ramaze
       # @param  [Symbol] files Paths to the CSS files to require.
       # @since  0.1
       #
-      def require_css *files
+      def require_css(*files)
         if @css.nil?
           @css = []
         end
@@ -50,7 +52,7 @@ module Ramaze
       # @param  [Symbol] files Paths to the Javascript files to require.
       # @since  0.1
       #
-      def require_js *files
+      def require_js(*files)
         if @js.nil?
           @js = []
         end

data/lib/zen/helper/breadcrumb.rb

@@ -1,4 +1,6 @@
+#:nodoc:
 module Ramaze
+  #:nodoc:
   module Helper
     ##
     # Helper that can be used to quickly generate breadcrumbs without having
@@ -6,12 +8,12 @@ module Ramaze
     # In order to create a set of breadcrumbs we first need to call the set_breadcrumbs
     # method:
     #
-    # bc. set_breadcrumbs segment1, segment2, segment3, etc
+    #     set_breadcrumbs(segment1, segment2, segment3, etc)
     #
     # Each argument will be a segment of the breadcrumbs, separated by a custom character.
     # Retrieving the breadcrumbs is super easy:
     #
-    # bc. get_breadcrumbs
+    #     get_breadcrumbs
     #
     # This will generate the correct HTML and return it, all you have to do is output it.
     #
@@ -27,20 +29,20 @@ module Ramaze
       # @example
       #  set_breadcrumbs "Articles", "Edit"
       #
-      # Note that you'll have to manually specify anchor tags, this method won't automatically
-      # generate URLs.
+      # Note that you'll have to manually specify anchor tags, this method won't 
+      # automatically generate URLs.
       # 
       # @author Yorick Peterse
       # @param  [Array] args Array of segments for the breadcrumbs.
       # @since  0.1
       #
-      def set_breadcrumbs *args
+      def set_breadcrumbs(*args)
         @breadcrumbs = args
       end
       
       ##
-      # Retrieves all breacrumbs and separates them either by "»" or a custom element
-      # set as the first argument of this method.
+      # Retrieves all breacrumbs and separates them either by "»" or a custom 
+      # element set as the first argument of this method.
       #
       # @example
       #  get_breadcrumbs # => "Articles » Edit"
@@ -52,7 +54,7 @@ module Ramaze
       # @param  [String] separator The HTML character to use for separating each segment.
       # @return [String]
       # 
-      def get_breadcrumbs separator = "»"
+      def get_breadcrumbs(separator = "»")
         if !@breadcrumbs or @breadcrumbs.empty?
           return
         end

data/lib/zen/helper/common.rb

@@ -1,4 +1,6 @@
+#:nodoc:
 module Ramaze
+  #:nodoc:
   module Helper
     ##
     # Helper that contains several common methods for which creating their
@@ -17,14 +19,15 @@ module Ramaze
       # @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  [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
+      def notification(type, title, message, image = nil, sticky = false)
         if image.nil?
           image = "/admin/images/icons/large/#{type.to_s}.png"
         end
@@ -54,10 +57,15 @@ module Ramaze
       #
       # @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' 
+      #  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'
+      #  anchor_to('Dashboard', 'dashboard')
       #
       # @author Yorick Peterse
       # @since  0.1
@@ -69,19 +77,20 @@ module Ramaze
       # @param  [Array] attributes Optional HTML attributes to add to the anchor tag.
       # @return [String]
       #
-      def anchor_to text, url, *attributes
+      def anchor_to(text, url, *attributes)
         
         # Sanitize the text and URL
-        text = Rack::Utils.escape_html text
+        text = Rack::Utils.escape_html(text)
+        url  = url.to_s
 
         # Get the URL from the second parameter (either a string or a hash).
-        if url.class.to_s === 'Hash'
+        if url.class === 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
+          query_string = Rack::Utils.build_query(url)
           
           # Create the full URL
           anchor_url = anchor_url + query_string 
@@ -91,14 +100,20 @@ module Ramaze
 
         # Got attributes?
         if !attributes or attributes.empty?
-          attributes = Hash.new
+          attributes = {}
         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}")
+          if anchor_url[0] == '/'
+            prefix = ''
+          else
+            prefix = '/'
+          end
+
+          anchor_url = request.domain("#{prefix}#{anchor_url}")
         end
         
         # Add the href attribute so it gets processed
@@ -132,7 +147,7 @@ module Ramaze
       # @param  [Array] args All words to cycle through.
       # @return [String]
       #
-      def cycle *args
+      def cycle(*args)
         if @@cycle_counter.nil?
           @@cycle_counter = 0
         end

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

@@ -0,0 +1,31 @@
+---
+labels:
+  zen_version  : 'Powered by Zen version %s'
+  zen_website  : 'Website'
+  zen_docs     : 'Documentation'
+  zen_github   : 'GitHub Account'
+  view_website : 'View Website'
+  logout       : 'Logout'
+  profile      : 'Profile'
+
+errors:
+  csrf            : 'The specified request can not 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        : 'No theme has been specified.'
+
+special:
+  format_hash:
+    html      : 'HTML'
+    textile   : 'Textile'
+    markdown  : 'Markdown'
+    plain     : 'Plain'
+
+  boolean_hash:
+    'true'    : 'Yes'
+    'false'   : 'No'
+
+  language_hash:
+    en  : 'English'
+

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

@@ -0,0 +1,13 @@
+---
+exact_length : 'This field is not exactly %s characters long.'
+format       : "This field's format is invalid."
+includes     : "This field's value is not in the range or set of %s."
+integer      : "This field's value is not an integer."
+length_range : "This field's value is either too long or too short."
+max_length   : "This field's value may not be longer than %s characters."
+min_length   : "This field's value may not be shorter than %s characters."
+not_string   : "This field's value is not a string."
+numeric      : "This field's value is not numeric."
+type         : "This field's value is not a %s."
+presence     : "This field's value is required."
+unique       : "This field's value is already taken."

data/lib/zen/layout/admin.xhtml

@@ -1,72 +1,80 @@
 <!DOCTYPE html>
-<html lang="#{session[:settings][:language]}">
-  <head>
-    <meta charset="utf-8" />
-    
-    <!-- Load all stylesheets -->
-    #{build_css}
-    
-    <title>#{@page_title}</title>
-  </head>
+<html lang="#{@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">
+    <body id="admin">
+        <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">
+                                #{lang('zen_general.labels.logout')}
+                            </a>
+                        </li>
+                        <li>
+                            <a href="/admin/users/edit/#{session[:user].id}">
+                                #{lang('zen_general.labels.profile')}
+                            </a>
+                        </li>
+                        <li>
+                            <a href="/">
+                                #{lang('zen_general.labels.view_website')}
+                            </a>
+                        </li>
+                    </ul>
+                </nav>
+            </header>
+        </div>
+        
         <!--
-          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.
+        Main area of the admin panel. The content stretches across the entire screen and there
+        are no silly sidebars.
         -->
-        <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>
+        <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>#{lang('zen_general.labels.zen_version') % Zen::Version}</p>
+                <p>
+                    <a href="http://zen-cms.com/">
+                        #{lang('zen_general.labels.zen_website')}
+                    </a> |
+                    <a href="http://zen-cms.com/documentation">
+                        #{lang('zen_general.labels.zen_docs')}
+                    </a> |
+                    <a href="https://github.com/zen-cms/">
+                        #{lang('zen_general.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

@@ -1,44 +1,50 @@
 <!DOCTYPE html>
-<html lang="#{session[:settings][:language]}">
-  <head>
-    <meta charset="utf-8" />
-    
-    <!-- Load all stylesheets -->
-    #{build_css}
-    
-    <title>#{@page_title}</title>
-  </head>
+<html lang="#{@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>
+    <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>#{lang('zen_general.labels.zen_version') % Zen::Version}</p>
+                <p>
+                    <a href="http://zen-cms.com/">
+                        #{lang('zen_general.labels.zen_website')}
+                    </a> |
+                    <a href="http://zen-cms.com/documentation">
+                        #{lang('zen_general.labels.zen_docs')}
+                    </a> |
+                    <a href="https://github.com/zen-cms/">
+                        #{lang('zen_general.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>