zen 0.2.4.1 → 0.2.5

data/lib/zen/helper/common.rb

@@ -148,9 +148,7 @@ module Ramaze
       # @return [String]
       #
       def cycle(*args)
-        if @@cycle_counter.nil?
-          @@cycle_counter = 0
-        end
+        @@cycle_counter ||= 0
         
         # Check the current counter and reset it if it matches the total amount of arguments
         if @@cycle_counter >= args.count

data/lib/zen/helper/theme.rb

@@ -0,0 +1,73 @@
+require __DIR__('../error/theme_error')
+
+#:nodoc:
+module Ramaze
+  #:nodoc:
+  module Helper
+    ##
+    # Helper that provides a few methods that make certain tasks easier when creating
+    # themes and templates.
+    #
+    # @author Yorick Peterse
+    # @since  0.2.5
+    #
+    module Theme
+
+      ##
+      # Renders a partial from the current theme's partial directory. The first argument
+      # is the name of the partial (without an extension) to render. The second argument
+      # is a hash with variables that should be made available to the partial.
+      #
+      # @example
+      #  partial(:header) # => partials/header.xhtml
+      #  partial(:header, :username => "YorickPeterse")
+      #
+      # @author Yorick Peterse
+      # @since  0.2.5
+      # @param  [Symbol] file The name of the partial to render.
+      # @param  [Hash] variables A hash with variables that should be made available for
+      # the partial.
+      #
+      def partial(file, variables = {})
+        theme = ::Zen::Theme[::Zen::Settings[:theme]]
+
+        if !theme.respond_to?(:partial_dir) or theme.partial_dir.nil?
+          raise(::Zen::ThemeError, "The theme #{theme.name} has no partial directory set.")
+        end
+
+        template = "#{theme.partial_dir}/#{file}.xhtml"
+
+        if !File.exist?(template)
+          raise(::Zen::ThemeError, "The template #{template} doesn't exist.")
+        end
+
+        # All done captain!
+        render_file(template, variables)
+      end
+
+      ##
+      # Renders the 404 template for the current theme (clearing the current buffer) and
+      # sets the HTTP response code to 404. Optionally you can pass a set of variables to
+      # the 404 template by setting this method's first argument to a hash.
+      #
+      # @example
+      #  show_404
+      #  show_404(:uri => @request_uri)
+      #
+      # @author Yorick Peterse
+      # @since  0.2.5
+      # @param  [Hash] variables Hash with variables to pass to the 404 template.
+      #
+      def show_404(variables = {})
+        theme    = ::Zen::Theme[::Zen::Settings[:theme]]
+        template = "#{theme.template_dir}/404.xhtml"
+
+        # Render the template and replace the current buffer with it's output
+        template = render_file(template, variables)
+
+        respond(template, 404)
+      end
+
+    end
+  end
+end

data/lib/zen/language.rb

@@ -54,7 +54,9 @@ module Zen
   # ## Options
   #
   # * language: Small string that defines the current language (e.g. "en").
-  # * paths: Array of paths to look for a language file
+  # * paths: Array of paths to look for a language directory. Note that this should be
+  # the parent directory of the directory called "language", not the actual directory
+  # itself.
   #
   # @author Yorick Peterse
   # @since  0.2 
@@ -62,13 +64,17 @@ module Zen
   module Language
     include Ramaze::Optioned
 
+    ##
+    # Hash containing all loaded translation files.
+    #
+    # @author Yorick Peterse
+    # @since  0.2.5
+    #
+    Registered = {}
+
     options.dsl do
       o 'Small string that defines the current language (e.g. "en").', :language, 'en'
-      o 'Array of paths to look for a language file'                 , :paths   , [] 
-    end
-
-    class << self
-      attr_reader :translations
+      o 'Array of paths to look for the language files'              , :paths   , [] 
     end
     
     ##
@@ -83,10 +89,9 @@ module Zen
     # @param  [String] lang_name The name of the language file to load. 
     # 
     def self.load(lang_name)
-      @translations ||= {}
-      @translations[self.options.language.to_s] ||= {}
+      Registered[self.options.language.to_s] ||= {}
 
-      if @translations[self.options.language.to_s][lang_name.to_s]
+      if Registered[self.options.language.to_s][lang_name.to_s]
         return
       end
 
@@ -101,8 +106,8 @@ module Zen
           # would result in {'person.age' => 18}.
           translation = self.to_dotted_hash({lang_name.to_s => translation})
           
-          @translations[self.options.language.to_s] ||= {}
-          @translations[self.options.language.to_s].merge!(translation)
+          Registered[self.options.language.to_s] ||= {}
+          Registered[self.options.language.to_s].merge!(translation)
           
           # Prevents the exception from being raised
           return
@@ -112,52 +117,6 @@ module Zen
       raise(Zen::LanguageError, "No language file could be found for \"#{lang_name}\"")
     end
 
-    ##
-    # Method for retrieving the correct language item based on the given string.
-    # If you want to retrieve sub-items you can separate each level with a dot:
-    #
-    #     lang('tutorial.main.sub')
-    #
-    # This would require our YAML file to look something like the following:
-    #
-    #     ---
-    #     main:
-    #       sub: "Something!"
-    #
-    # It's important to remember that your key should always include the name of the
-    # language file since once a file is loaded it will be kept in memory to reduce
-    # disk usage.
-    #
-    # @example
-    #  lang('username')
-    #
-    # @author Yorick Peterse
-    # @since  0.2
-    # @param  [String] key The language key to select.
-    # @return [Mixed]
-    #
-    def lang(key)
-      lang          = ::Zen::Language.options.language.to_s
-      groups        = []
-      translations  = ::Zen::Language.translations
-
-      if !translations or !translations.key?(lang)
-        raise(
-          Zen::LanguageError, 
-          "No translation files have been added for the language code \"#{lang}\""
-        )
-      end
-
-      if translations[lang][key]
-        return translations[lang][key]
-      end
-      
-      raise(
-        Zen::LanguageError,
-        "The specified language item \"#{key}\" does not exist"
-      )
-    end
-
     private
 
     ##
@@ -218,5 +177,55 @@ module Zen
 
       return target
     end
+
+    #:nodoc:
+    module SingletonMethods
+      ##
+      # Method for retrieving the correct language item based on the given string.
+      # If you want to retrieve sub-items you can separate each level with a dot:
+      #
+      #     lang('tutorial.main.sub')
+      #
+      # This would require our YAML file to look something like the following:
+      #
+      #     ---
+      #     main:
+      #       sub: "Something!"
+      #
+      # It's important to remember that your key should always include the name of the
+      # language file since once a file is loaded it will be kept in memory to reduce
+      # disk usage.
+      #
+      # @example
+      #  lang('username')
+      #
+      # @author Yorick Peterse
+      # @since  0.2
+      # @param  [String] key The language key to select.
+      # @return [Mixed]
+      #
+      def lang(key)
+        lang          = ::Zen::Language.options.language.to_s
+        groups        = []
+        translations  = ::Zen::Language::Registered
+
+        if !translations or !translations.key?(lang)
+          raise(
+            Zen::LanguageError, 
+            "No translation files have been added for the language code \"#{lang}\""
+          )
+        end
+
+        if translations[lang][key]
+          return translations[lang][key]
+        end
+        
+        raise(
+          Zen::LanguageError,
+          "The specified language item \"#{key}\" does not exist"
+        )
+      end
+    end
+
   end
 end

data/lib/zen/layout/admin.xhtml

@@ -1,10 +1,10 @@
 <!DOCTYPE html>
-<html lang="#{@settings[:language]}">
+<html lang="#{::Zen::Settings[:language]}">
     <head>
         <meta charset="utf-8" />
         
         <!-- Load all stylesheets -->
-        #{build_css}
+         #{::Zen::Asset.build(:stylesheet)}
         
         <title>#{@page_title}</title>
     </head>
@@ -17,10 +17,7 @@
                 doesn't have the required permissions for the extension that created it.
                 -->
                 <nav id="main_nav" class="grid_12">
-                    #{
-                        perms = extension_permissions
-                        Zen::Package.build_menu("left", perms[0], perms[1])
-                    }
+                    #{Zen::Package.build_menu("left", extension_permissions)}
                     
                     <ul class="right clearfix">
                         <li>
@@ -43,47 +40,7 @@
             </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>#{lang('zen_general.labels.zen_version') % Zen::Version}</p>
-                <ul class="clearfix">
-                    <li>
-                        <a href="http://zen-cms.com/">
-                            #{lang('zen_general.labels.zen_website')}
-                        </a>
-                    </li>
-                    <li>
-                        <a href="http://zen-cms.com/documentation">
-                            #{lang('zen_general.labels.zen_docs')}
-                        </a>
-                    </li>
-                    <li>
-                        <a href="https://github.com/zen-cms/">
-                            #{lang('zen_general.labels.zen_github')}
-                        </a>
-                    </li>
-                </ul>
-            </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}
+        #{render_file(__DIR__('../view/main.xhtml'))}
+        #{render_file(__DIR__('../view/bottom.xhtml'))}
     </body>
 </html>

data/lib/zen/layout/login.xhtml

@@ -1,56 +1,16 @@
 <!DOCTYPE html>
-<html lang="#{@settings[:language]}">
+<html lang="#{::Zen::Settings[:language]}">
     <head>
         <meta charset="utf-8" />
         
         <!-- Load all stylesheets -->
-        #{build_css}
+        #{::Zen::Asset.build(:stylesheet)}
         
         <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>#{lang('zen_general.labels.zen_version') % Zen::Version}</p>
-                <ul class="clearfix">
-                    <li>
-                        <a href="http://zen-cms.com/">
-                            #{lang('zen_general.labels.zen_website')}
-                        </a>
-                    </li>
-                    <li>
-                        <a href="http://zen-cms.com/documentation">
-                            #{lang('zen_general.labels.zen_docs')}
-                        </a>
-                    </li>
-                    <li>
-                        <a href="https://github.com/zen-cms/">
-                            #{lang('zen_general.labels.zen_github')}
-                        </a>
-                    </li>
-                </ul>
-            </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}
+        #{render_file(__DIR__('../view/main.xhtml'))}
+        #{render_file(__DIR__('../view/bottom.xhtml'))}
     </body>
 </html>

data/lib/zen/model/methods.rb

@@ -9,7 +9,7 @@ module Sequel
     # elements using the BlueForm helper.
     #
     # @example
-    #  Sections::Models::Section.pk_hash(:name) # => {1 => 'Blog', 2 => 'General'}
+    #  Sections::Model::Section.pk_hash(:name) # => {1 => 'Blog', 2 => 'General'}
     #
     # @author Yorick Peterse
     # @param  [Symbol] column The name of the optional column to select.

data/lib/zen/model/settings.rb

@@ -1,5 +1,3 @@
-include Zen::Language
-
 Zen::Language.load('zen_models')
 
 # When passing a hash to update() or create() we'll ignore any keys that don't belong 
@@ -10,7 +8,6 @@ Sequel::Model.strict_param_setting = false
 # Load all the required plugins
 Sequel::Model.plugin :validation_helpers
 Sequel::Model.plugin :association_pks
-Sequel::Model.plugin :schema
 
 Sequel::Plugins::ValidationHelpers::DEFAULT_OPTIONS.merge!(
 {

data/lib/zen/package.rb

@@ -1,7 +1,6 @@
 require 'ramaze/gestalt'
-require __DIR__('helper/acl')
-require __DIR__('liquid/controller_behavior')
 require __DIR__('error/package_error')
+require __DIR__('package/base')
 
 #:nodoc:
 module Zen
@@ -20,16 +19,29 @@ module Zen
   #
   # When using this block you're required to set the following attributes:
   #
-  # * name: the name of the package
-  # * author: the name of the person who made the package
-  # * about: a small description of the package
-  # * url: the URL to the package's website
-  # * identifier: unique identifier for the package. The format is com.AUTHOR.NAME for
-  # extensions and com.AUTHOR.themes.NAME for themes.
-  # * directory: the root directory of the package, set this using __DIR__('path')
+  # * name: the name of the package in lowercased letters and/or numbers.
+  # * author: the name of the person who made the package.
+  # * about: a small description of the package.
+  # * url: the URL to the package's website.
+  # * directory: the root directory of the package, set this using __DIR__('path').
   # 
   # Optionally you can also specify the attribute "menu" (more on that later).
   #
+  # ## ACL
+  #
+  # Packages allow developers to register controllers for the ACL system that ships with
+  # Zen. Doing this means a user can set controller specific rules in the backend without
+  # having to write any code. In order to register a set of controllers you'll need to
+  # set the "controllers" attribute in the package block to a hash. The keys of this hash
+  # should be a human readable name of the controller and the values the full namespace
+  # of the controller as either a string or a constants:
+  #
+  #     Zen::Package.add do |pkg|
+  #       pkg.controllers = {
+  #         'Test Controller' => Test::Controller::TestController
+  #       }
+  #     end
+  #
   # ## Menu Items
   #
   # The package system easily allows modules to add navigation/sub-navigation elements
@@ -60,41 +72,43 @@ module Zen
   #
   # If your package uses it's own database tables it's best to use migrations as these make
   # it very easy to install/uninstall the extension. Migrations should be put in the root
-  # directory of your extension. For example, if your extension is in "foobar" the migrations
-  # should be located in "foobar/migrations", the lib directory in "foobar/lib", etc.
+  # directory of your extension. For example, if your extension is in "foobar" the 
+  # migrations should be located in "foobar/migrations", the lib directory in "foobar/lib", 
+  # etc.
   #
   # Migrations can be executed using the Thor task "package:migrate" or "db:migrate",
   # the latter will install all packages while the first one will only install the 
   # specified packages. For more information on these tasks execute the following command:
   #
-  #     $ thor -T
-  #
-  # ## Identifiers
-  #
-  # Package identifiers should always have the following format:
-  #
-  #     com.VENDOR.NAME
-  #
-  # For example:
-  #
-  #     com.zen.sections
+  #     $ rake -T
   #
   # @author Yorick Peterse
   # @since  0.1
-  # @attr_reader [Array] packages Array containing the instances of all packages.
   #
   module Package
-    class << self
-      attr_reader :packages
-    end
-    
     ##
-    # Adds a new package along with all it's details such as the name,
-    # author, version and so on. Extensions can be added using a simple
-    # block as following:
+    # Hash containing all the registered packages. The keys of this hash are the names
+    # of all packages and the values the instances of Zen::Package::Base.
+    #
+    # @author Yorick Peterse
+    # @since  0.2.5
+    #
+    Registered = {}
+
+    ##
+    # Array containing all controllers of all packages.
+    #
+    # @author Yorick Peterse
+    # @since  0.2.5
+    #
+    Controllers = []
+
+    ##
+    # Adds a new package along with all it's details such as the name, author, version 
+    # and so on. Extensions can be added using a simple block as following:
     #
     #     Zen::Package.add do |ext|
-    #       ext.name   = "Name"
+    #       ext.name   = "name"
     #       ext.author = "Author"
     #     end
     #
@@ -105,7 +119,6 @@ module Zen
     # * version
     # * about
     # * url
-    # * identifier
     # * directory
     #
     # You can also set "migration_dir" to a directory with all migrations. By default
@@ -116,17 +129,13 @@ module Zen
     # @yield  [package] Object containing all setters and getters for each package.
     #
     def self.add
-      package = Zen::StrictStruct.new(
-        :name, :author, :about, :url, :identifier, :directory, :menu, :migration_dir
-      ).new
-
-      required = [:name, :author, :about, :identifier, :directory]
+      package = Zen::Package::Base.new
       
       yield package
-      
-      package.validate(required) do |k|
-        raise(Zen::PackageError, "The following package key is missing: #{k}")
-      end
+
+      # Validate the package
+      package.validate
+      package.name = package.name.to_sym
 
       # Update the root but prevent duplicates
       if !Ramaze.options.roots.include?(package.directory)
@@ -138,31 +147,37 @@ module Zen
         Zen::Language.options.paths.push(package.directory)
       end
 
-      # Validate the directories
-      [:directory, :migration_dir].each do |k|
-        if package.respond_to?(k) and !package.send(k).nil?
-          if !File.exist?(package.send(k))
-            raise(PackageError, "The directory #{package.send(k)} does not exist.")
-          end
+      package.controllers.each do |name, controller|
+        controller = controller.to_s
+
+        if !Controllers.include?(controller)
+          Controllers.push(controller)
         end
       end
       
-      @packages                          = {} if @packages.nil?
-      @packages[package.identifier.to_s] = package 
+      Registered[package.name.to_sym] = package 
     end
-    
+
     ##
-    # Shortcut method that can be used to retrieve an extension or theme based on the
-    # given extension identifier.
+    # Retrieves the package for the given name.
     #
     # @author Yorick Peterse
-    # @param  [String] ident The package's identifier
-    # @return [Object]
+    # @since  0.1
     #
-    def self.[](ident)
-      @packages[ident.to_s]
+    def self.[](name)
+      name = name.to_sym
+
+      if Registered.empty?
+        raise(PackageError, "No packages have been added yet.")
+      end
+
+      if !Registered.key?(name)
+        raise(PackageError, "The package \"#{name}\" doesn't exist.")
+      end
+
+      return Registered[name]
     end
-    
+
     ##
     # Builds a navigation menu for all installed extensions.
     # Extensions can have an infinite amount of sub-navigation
@@ -170,32 +185,21 @@ module Zen
     # of which each list item can contain N sub items.
     #
     # @author Yorick Peterse
-    # @param  [String]  css_class A string of CSS classes to apply to the main UL element.
-    # @param  [Hash]    permissions Hash containing the permissions as returned by
-    # Ramaze::Helper::ACL#extension_permissions
-    # @param  [Boolean] all When set to true all elements will be displayed opposed to 
-    # only those the user is allowed to see.
+    # @param  [String] css_class A string of CSS classes to apply to the main UL element.
+    # @param  [Hash] permissions Hash containing the permissions as returned by
+    # Ramaze::Helper::ACL.extension_permissions
     # @since  0.1
     #
-    def self.build_menu(css_class = '', permissions = {}, all = false)
-      @g          = Ramaze::Gestalt.new
-      menu_items  = []
-      identifiers = []
-
-      # Build a list of all allowed extensions
-      permissions.each do |ident, rules|
-        if rules.include?(:read)
-          identifiers.push(ident)
-        end
-      end
+    def self.build_menu(css_class = '', permissions = {})
+      @g           = Ramaze::Gestalt.new
+      @permissions = permissions
+      menu_items   = []
       
-      @packages.each do |ident, ext|
+      Registered.each do |name, pkg|
         # Got a menu for us?
-        if !ext.menu.nil?
-          if identifiers.include?(ext.identifier) or all == true
-            ext.menu.each do |m|
-              menu_items.push(m)
-            end
+        if !pkg.menu.nil?
+          pkg.menu.each do |m|
+            menu_items.push(m)
           end
         end
       end
@@ -226,12 +230,26 @@ module Zen
     # @param  [Hash] menu Hash containing the navigation items (url, title, etc)
     # @since  0.1
     #
-    def self.nav_list menu
+    def self.nav_list(menu)
+      if menu[:url][0] != '/'
+        menu[:url] = '/' + menu[:url]
+      end
+
+      # Get the controller for the current item
+      controller  = Ramaze::AppMap.at('/').url_map.at(menu[:url]).to_s
+      read_access = @permissions[controller].include?(:read)
+
+      # Ignore the menu item alltogether
+      if !read_access and !menu.key?(:children)
+        return
+      end
+
       @g.li do
-        if menu[:url][0] != '/'
-          menu[:url] = '/' + menu[:url]
+        # Easy way of disabling an item and not fucking up the menu
+        if !read_access
+          menu[:url] = '#'
         end
-        
+
         @g.a :href => menu[:url], :title => menu[:title] do
           menu[:title]
         end