zen 0.1a → 0.2

data/lib/zen/base/logger.rb

@@ -1,5 +1,6 @@
 require 'ramaze/log/rotatinginformer'
 
+#:nodoc:
 module Zen
   ##
   # The Logger class acts as a small wrapper around the RotatingInformer class provided
@@ -15,12 +16,14 @@ module Zen
     trait :format    => "[%time] %prefix  %text"
     
     ##
-    # Create a new instance of the logging class. The first parameter is the directory in which the log files 
-    # should be stored. Based on this paramater and the current mode (specified in Ramaze.options.mode) the 
-    # required directories will be created. When specifying a directory you should NOT add trailing slash.
+    # Create a new instance of the logging class. The first parameter is the directory 
+    # in which the log files should be stored. Based on this paramater and the current 
+    # mode (specified in Ramaze.options.mode) the required directories will be created. 
+    # When specifying a directory you should NOT add trailing slash.
     #
     # @example
-    #  # When running in :dev mode this will result in the log files being stored in logs/database/dev
+    #  # When running in :dev mode this will result in the log files being stored in 
+    #  # logs/database/dev
     #  Zen::Logger.new 'logs/database'
     # 
     # @author Yorick Peterse
@@ -41,7 +44,6 @@ module Zen
     
     ##
     # The write method is called whenever a log message has to be written to a file.
-    # Note that this method will only be used by webservers such as WEBRick. Sequel ignores this method.
     #
     # @author Yorick Peterse
     # @since  0.1
@@ -51,4 +53,4 @@ module Zen
       self.log(:info, message)
     end
   end
-end
+end

data/lib/zen/base/package.rb

@@ -1,17 +1,18 @@
 require 'ramaze/gestalt'
 
+#:nodoc:
 module Zen
   ##
-  # Module used for registering extensions and themes, setting their details and the whole shebang.
-  # Packages follow the same directory structure as Rubygems and can actually be installed
-  # using either Rubygems or by storing them in a custom directory. As long as you require
-  # the correct file you're good to go.
+  # Module used for registering extensions and themes, setting their details and the 
+  # whole shebang. Packages follow the same directory structure as Rubygems and can 
+  # actually be installed using either Rubygems or by storing them in a custom directory. 
+  # As long as you require the correct file you're good to go.
   #
   # Packages are added or "described" using a simple block and the add() method as following:
   #
-  # bc. Zen::Package.add do |ext|
-  #   # ....
-  # end
+  #     Zen::Package.add do |ext|
+  #       # ....
+  #     end
   #
   # When using this block you're required to set the following attributes:
   #
@@ -27,7 +28,7 @@ module Zen
   # 
   # Optionally you can also specify the attribute "menu" (more on that later).
   #
-  # h2. Menu Items
+  # ## Menu Items
   #
   # The package system easily allows modules to add navigation/sub-navigation elements
   # to the backend menu. Each extension can have an attribute named "menu", this attribute
@@ -40,20 +41,20 @@ module Zen
   # will again contain an array of hashes just like regular navigation elements.
   # For example, one could do the following:
   #
-  # @ext.menu = [{:title => "Dashboard", :url => "admin/dashboard"}]@
+  #     ext.menu = [{:title => "Dashboard", :url => "admin/dashboard"}]
   #
   # Adding a number of child elements isn't very difficult either:
   #
-  # bc. ext.menu = [{
-  #   :title    => "Dashboard", :url => "admin/dashboard",
-  #   :children => [{:title => "Child", :url => "admin/dashboard/child"}]
-  # }]
+  #     ext.menu = [{
+  #       :title    => "Dashboard", :url => "admin/dashboard",
+  #       :children => [{:title => "Child", :url => "admin/dashboard/child"}]
+  #     }]
   #
   # Once a certain number of navigation elements have been added you can generate the
   # HTML for a fully fledged navigation menu using the build_menu() method. This method
   # uses Gestalt to build the HTML and also takes care of permissions for each user/module.
   #
-  # h2. Migrations
+  # ## Migrations
   #
   # 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
@@ -61,22 +62,24 @@ module Zen
   # should be located in "foobar/migrations", the lib directory in "foobar/lib", etc.
   #
   # Migrations can be executed using the Rake task "extension:migrate" or "db:migrate",
-  # the latter will install all extensions while the first one will only install the specified
-  # extension. Migration prototypes can be generated by the Rake task
+  # the latter will install all extensions while the first one will only install the 
+  # specified extension. Migration prototypes can be generated by the Rake task
   # "proto:migration[DIRECTORY]" where DIRECTORY is the path to your migrations directory.
   #
-  # h2. Themes
+  # ## Themes
   #
   # Themes are essentially packages like the sections or comments module except that they
-  # have a few limitations and work a bit different. First of all themes can't add navigation
-  # items to the backend and second they should _always_ have the following directories:
+  # have a few limitations and work a bit different. First of all themes can't add 
+  # navigation items to the backend and second they should _always_ have the following 
+  # directories:
   #
   # * theme/lib/theme/templates
   # * theme/lib/theme/public
   #
-  # The templates directory is used to store all Liquid templates and template groups, the public
-  # directory is used for CSS files, images and so on. Themes can have migrations just
-  # like extensions which makes it relatively easy to share a theme with somebody else.
+  # The templates directory is used to store all Liquid templates and template groups, 
+  # the public directory is used for CSS files, images and so on. Themes can have 
+  # migrations just like extensions which makes it relatively easy to share a theme 
+  # with somebody else.
   #
   # @author Yorick Peterse
   # @since  0.1
@@ -85,7 +88,6 @@ module Zen
     class << self
       attr_reader :extensions
       attr_reader :themes
-      attr_accessor :classes
     end
     
     ##
@@ -93,10 +95,10 @@ module Zen
     # author, version and so on. Extensions can be added using a simple
     # block as following:
     #
-    #  Zen::Package.add do |ext|
-    #    ext.name   = "Name"
-    #    ext.author = "Author"
-    #  end
+    #     Zen::Package.add do |ext|
+    #       ext.name   = "Name"
+    #       ext.author = "Author"
+    #     end
     #
     # When adding a new extension the following setters are required:
     #
@@ -130,6 +132,11 @@ module Zen
       if !Ramaze.options.roots.include?(package.directory)
         Ramaze.options.roots.push(package.directory)
       end
+
+      # Update the language directory
+      if !Zen::Language.options.paths.include?(package.directory)
+        Zen::Language.options.paths.push(package.directory)
+      end
       
       # Themes and extensions each have a different accessor
       if package.type.to_s == 'theme'
@@ -171,7 +178,7 @@ module Zen
     # main UL element.
     # @since  0.1
     #
-    def self.build_menu css_class = ''
+    def self.build_menu(css_class = '')
       @g         = Ramaze::Gestalt.new
       menu_items = []
       
@@ -230,4 +237,4 @@ module Zen
     end
     
   end
-end
+end

data/lib/zen/base/version.rb

@@ -1,3 +1,4 @@
+#:nodoc:
 module Zen
   ##
   # Defines the current version of Zen as a string. This constant
@@ -7,5 +8,5 @@ module Zen
   # @author Yorick Peterse
   # @since  0.1
   #
-  Version = '0.1a'
+  Version = '0.2'
 end

data/lib/zen/bin/zen_binary.rb

@@ -1,6 +1,9 @@
 require 'fileutils'
+require 'ruby-extensions'
 
+#:nodoc:
 module Zen
+  #:nodoc:
   module Bin
     ##
     # Main binary class that contains a few methods that can be used
@@ -27,7 +30,7 @@ module Zen
       # @param  [String] name The name of the new application
       # @since  0.1
       #
-      def app name
+      def app(name)
         # Do we have an application name?
         if name.nil?
           abort "You need to specify a name for your application"
@@ -50,7 +53,7 @@ module Zen
 1. edit the following configuration files:
   * config/database.rb
   * config/config.rb
-2. run rake db:migrate to install all extensions and create a default user
+2. run thor db:migrate to install all extensions and create a default user
 3. have fun!"
         rescue => e
           abort "Failed to generate the application: #{e}"
@@ -59,73 +62,6 @@ module Zen
       
       # ------------------------------------------------
       
-      desc "extension [NAME]", "Creates a new Zen extension"
-      method_option :force, :type => :boolean, :aliases => "-f",
-        :desc => "Overwrites any existing directories"
-      
-      ##
-      # Creates a new Zen extension for the given name.
-      #
-      # @author Yorick Peterse
-      # @param  [String] name The name of the extension
-      # @since  0.1
-      #
-      def extension name
-        name  = name.strip.downcase.gsub(' ', '_')
-        proto = __DIR__('../../../proto/module')
-        klass = name.camel_case
-        
-        if name.nil?
-          abort "You need to specify an extension name"
-        end
-        
-        extension_path = "./#{name}"
-        
-        if File.directory?(extension_path) and !options.force?
-          abort "Extension already exists, use -f to overwrite it"
-        else
-          FileUtils.rm_rf(extension_path)
-        end
-        
-        # Rename all files and folders
-        begin
-          FileUtils.cp_r(proto, extension_path)
-          
-          lib_path = "#{extension_path}/lib/#{name}"
-          
-          # Rename the base file and directory
-          FileUtils.mv("#{extension_path}/lib/module"   , lib_path)
-          FileUtils.mv("#{extension_path}/lib/module.rb", "#{extension_path}/lib/#{name}.rb")
-          
-          # ------------------------------------------------
-          
-          controller_filename = klass.snake_case.pluralize
-          model_filename      = klass.snake_case.singularize
-          
-          # Generate the controller
-          controller = File.open("#{lib_path}/controller/controllers.rb", 'r').read
-          controller.gsub!('CONTROLLER', klass.pluralize)
-          controller.gsub!('EXTENSION' , klass.pluralize)
-          
-          FileUtils.mv("#{lib_path}/controller/controllers.rb", "#{lib_path}/controller/#{controller_filename}.rb")
-          File.open("#{lib_path}/controller/#{controller_filename}.rb", 'w').write(controller)
-          
-          # Generate the model
-          model = File.open("#{lib_path}/model/model.rb", 'r').read
-          model.gsub!('MODEL'     , klass.singularize)
-          model.gsub!('EXTENSION' , klass.pluralize)
-          
-          FileUtils.mv("#{lib_path}/model/model.rb", "#{lib_path}/model/#{model_filename}.rb")
-          File.open("#{lib_path}/model/#{model_filename}.rb", 'w').write(model)
-          
-          puts "Done! Don't forget to rename the controllers/models/etc"
-        rescue => e
-          abort "Failed to generate the extesion: #{e}"
-        end
-      end
-      
-      # ------------------------------------------------
-      
       desc "version", "Shows the current version of Zen"
       
       ##
@@ -148,7 +84,7 @@ module Zen
       # @see    Thor.help()
       # @since  0.1
       # 
-      def help task = nil, subcommand = false
+      def help(task = nil, subcommand = false)
         if task.nil?
           puts "Zen is a modular CMS written using Ramaze.
 
@@ -170,4 +106,4 @@ Project Details:
       end
     end
   end
-end
+end

data/lib/zen/controller/admin_controller.rb

@@ -1,19 +1,21 @@
+#:nodoc:
 module Zen
+  #:nodoc:
   module Controllers
     ##
     # The admin controller is a base controller that should be extended by all controllers
-    # for the backend of Zen. This controller will automatically check to see if the user is
-    # logged in and perform several other tasks such as loading all Javascript and CSS stylesheet
-    # along with our helpers and so on.
+    # for the backend of Zen. This controller will automatically check to see if the 
+    # user is logged in and perform several other tasks such as loading all Javascript 
+    # and CSS stylesheet along with our helpers and so on.
     #
-    # h2. Authentication
+    # ## Authentication
     #
-    # It's important to remember that any controller that extends this one will require the
-    # user to be logged in. The only exception for this is the login method for the Users
-    # controller, mapped to /admin/users/login. If a user isn't logged in he/she will be redirected
-    # to the login page.
+    # It's important to remember that any controller that extends this one will require 
+    # the user to be logged in. The only exception for this is the login method for the 
+    # Users controller, mapped to /admin/users/login. If a user isn't logged in he/she 
+    # will be redirected to the login page.
     #
-    # h2. Helpers
+    # ## Helpers
     #
     # The admin controller loads the following helpers:
     #
@@ -31,7 +33,7 @@ module Zen
     class AdminController < Zen::Controllers::BaseController
       layout :admin
       engine :etanni
-      helper :blue_form, :common, :breadcrumb, :user, :acl, :asset, :gravatar
+      helper :blue_form, :common, :breadcrumb, :user, :acl, :asset
       
       ##
       # The initialize method is called upon class initalization and is used to process several
@@ -44,7 +46,11 @@ module Zen
         super
         
         # Load our CSS and Javascript files
-        require_css('boilerplate', 'grid', 'layout', 'general')
+        require_css(
+          'boilerplate', 'grid', 'layout', 'general', 'forms', 'tables', 'buttons',
+          'tabs', 'notifications', 'editor'
+        )
+
         require_js('zen/tabs', 'zen/notification', 'zen/modal', 'zen/editor/base',
           'zen/editor/drivers/html', 'zen/editor/drivers/textile', 'zen/editor/drivers/markdown',
           'zen/init'
@@ -54,6 +60,20 @@ module Zen
         if request.env['SCRIPT_NAME'] != 'admin/users/' and request.env['PATH_INFO'] != '/login'
           redirect '/admin/users/login' unless logged_in?
         end
+
+        # Hash containing all available formats for input fields
+        @format_hash = {
+          'html'     => lang('zen_general.special.format_hash.html'),
+          'textile'  => lang('zen_general.special.format_hash.textile'),
+          'markdown' => lang('zen_general.special.format_hash.markdown'),
+          'plain'    => lang('zen_general.special.format_hash.plain')
+        }
+
+        @boolean_hash = {
+          true  => lang('zen_general.special.boolean_hash.true'),
+          false => lang('zen_general.special.boolean_hash.false')
+        }.invert
+
       end
     end
   end

data/lib/zen/controller/base_controller.rb

@@ -1,19 +1,23 @@
+#:nodoc:
 module Zen
+  #:nodoc:
   module Controllers
     ##
-    # The BaseController is extended by both the FrontendController and the BackendController.
-    # This controller is mostly used to set and retrieve data that's used in both the
-    # backend and the frontend.
+    # The BaseController is extended by both the FrontendController and the 
+    # BackendController. This controller is mostly used to set and retrieve data that's 
+    # used in both the backend and the frontend.
     #
     # @author Yorick Peterse
     # @since  0.1
     #
     class BaseController < Ramaze::Controller
+      include ::Zen::Language
+
       helper :csrf, :cgi
       
       ##
-      # The initialize method is called upon class initalization and is used to process several
-      # items before loading the controller(s) for the current module.
+      # The initialize method is called upon class initalization and is used to 
+      # process several items before loading the controller(s) for the current module.
       #
       # @author Yorick Peterse
       # @since  1.0
@@ -21,18 +25,14 @@ module Zen
       def initialize
         super
         
-        # The trait for the User helper has to be specified in the constructor as
-        # our user model is loaded after this class is loaded (but before it's initialized)
-        self.trait :user_model => ::Users::Models::User
-        
         # Get all settings
-        if !session[:settings]
-          session[:settings] = ::Settings::Models::Setting.get_settings
+        if !@settings
+          @settings = ::Settings::Models::Setting.get_settings
         end
         
         # Override the language
-        Zen.options.language = session[:settings][:language]
-        @zen_general_lang    = Zen::Language.load('zen_general')
+        ::Zen::Language.options.language = @settings[:language]
+        ::Zen::Language.load('zen_general')
       end
     end
   end

data/lib/zen/controller/frontend_controller.rb

@@ -1,4 +1,6 @@
+#:nodoc:
 module Zen
+  #:nodoc:
   module Controllers
     ##
     # Controller that should be extended by other controllers that can be accessed from

data/lib/zen/controller/main_controller.rb

@@ -1,4 +1,6 @@
+#:nodoc:
 module Zen
+  #:nodoc:
   module Controllers
     ##
     # The MainController controller is used to load the correct template files based
@@ -23,7 +25,6 @@ module Zen
       # @param  [Array] uri Array containing all arguments (thus the URI).
       #
       def index(*uri)
-        settings = session[:settings]
         @uri     = []
         
         # Clean the URI of nasty input
@@ -38,11 +39,11 @@ module Zen
         end
         
         # A theme is always required
-        if settings[:theme].nil?
+        if @settings[:theme].nil? or @settings[:theme].empty?
           respond(@zen_general_lang.errors[:no_theme])
         end
-        
-        theme    = ::Zen::Package[settings[:theme]]
+
+        theme    = ::Zen::Package[@settings[:theme]]
         group    = @uri[0]
         template = @uri[1]
         
@@ -65,23 +66,23 @@ module Zen
         ::Liquid::Template.file_system = ::Liquid::LocalFileSystem.new(partial_path)
         
         # Is the website down?
-        if settings[:website_enabled] == '0'
+        if @settings[:website_enabled] == '0'
           offline_path = theme_path + "/offline.liquid"
           
           if File.exist?(offline_path)
-            render_file offline_path
+            render_file(offline_path)
           else
             respond(@zen_general_lang.errors[:website_offline])
           end
         else
           # Check if the group exists
           if File.directory?(group_path) and File.exists?(template_path)
-            render_file template_path
+            render_file(template_path)
           else
             not_found = theme_path + "/404.liquid"
             
             if File.exist?(not_found)
-              render_file not_found
+              render_file(not_found)
             else
               respond(@zen_general_lang.errors[:no_templates], 404)
             end