zen 0.2.7 → 0.2.8

data/lib/zen/bin/create.rb

@@ -0,0 +1,94 @@
+require 'fileutils'
+
+#:nodoc:
+module Zen
+  #:nodoc:
+  module Bin
+    ##
+    # Command that can be used to create a new application prototype.
+    #
+    # @author Yorick Peterse
+    # @since  0.2.8
+    #
+    class Create
+      # The description of this command.
+      Description = 'Creates a new application prototype.'
+
+      # The banner of this application.
+      Banner = <<-TXT.strip
+Creates a new application prototype and saves it in the given path.
+
+Usage:
+  zen create [NAME] [OPTIONS]
+
+Example:
+  zen create blog
+      TXT
+
+      # Hash containing options that can be overwritten via the command line.
+      Options = {
+        :force => false
+      }
+
+      ##
+      # Creates a new instance of the class and specifies all the options.
+      #
+      # @author Yorick Peterse
+      # @since  0.2.8
+      #
+      def initialize
+        @stop    = false
+        @options = OptionParser.new do |opt|
+          opt.banner         = Banner
+          opt.summary_indent = '  '
+
+          opt.separator "\nOptions:\n"
+
+          opt.on('-h', '--help', 'Shows this help message') do
+            puts @options
+
+            @stop = true
+          end
+
+          opt.on('-f', '--force', 'Overwrites existing directories') do
+            Options[:force] = true
+          end
+        end
+      end
+
+      ##
+      # Executes the command based on the specified command line arguments.
+      #
+      # @author Yorick Peterse
+      # @since  0.2.8
+      # @param  [Array] argv An array containing all the additional options that
+      # were specified in the command line.
+      #
+      def run(argv = [])
+        @options.parse!(argv)
+
+        app = argv.delete_at(0)
+
+        return if @stop === true
+        return puts @options if app.nil?
+
+        proto = __DIR__('../../../proto/app')
+
+        if File.directory?(app) and Options[:force] === false
+          return $stderr.puts "The application #{app} already exists, use -f " \
+            + "to overwrite it."
+        else
+          FileUtils.rm_rf(app)
+        end
+
+        # Copy the prototype
+        begin
+          FileUtils.cp_r(proto, app)
+          puts "The application has been generated and saved in #{app}"
+        rescue => e
+          return $stderr.puts "Failed to generate the application: #{e.message}"
+        end
+      end
+    end # App
+  end # Bin
+end # Zen

data/lib/zen/bin/runner.rb

@@ -0,0 +1,118 @@
+# Load all commands
+require __DIR__('create')
+
+#:nodoc:
+module Zen
+  #:nodoc:
+  module Bin
+    ##
+    # Module used to set various global options for the command line utility and
+    # run a command based on the specified parameters.
+    #
+    # @author Yorick Peterse
+    # @since  0.2.8
+    #
+    module Runner
+      # Hash containing all the available commands and their class names.
+      Commands = {
+        :create => Zen::Bin::Create
+      }
+
+      # The banner of this command.
+      Banner = <<-TXT.strip
+Zen is a modular CMS written on top of the awesome Ramaze framework.
+
+Usage:
+  zen [COMMAND] [OPTIONS]
+
+Example:
+  zen create blog
+      TXT
+
+      ##
+      # Runs a command based on the command line arguments or a specified array
+      # to use instead of ARGV.
+      #
+      # @author Yorick Peterse
+      # @since  0.2.8
+      # @param  [Array] argv An array containing command line arguments.
+      #
+      def self.run(argv=ARGV)
+        stop = false
+        op   = OptionParser.new do |opt|
+          opt.banner         = Banner
+          opt.summary_indent = '  '
+
+          opt.separator "\nCommands:\n  #{commands_info.join("\n  ")}"
+          opt.separator "\nOptions:\n"
+
+          # Define the available options
+          opt.on('-v', '--version', 'Shows the version of Zen') do
+            puts Zen::Version
+
+            stop = true
+          end
+
+          opt.on('-h', '--help', 'Shows this help message') do
+            puts op
+
+            stop = true
+          end
+        end
+
+        # Parse it
+        op.order!(argv)
+
+        # exit() doesn't work for specs.
+        return if stop === true
+        return puts op if !argv[0]
+
+        # Run the command if it exists
+        cmd = argv.delete_at(0).to_sym
+
+        if Commands.key?(cmd)
+          cmd = Commands[cmd].new
+          cmd.run(argv)
+        else
+          return $stderr.puts "The specified command is invalid"
+        end
+      end
+
+      ##
+      # Generates an array of "rows" where each row contains the name and
+      # description of a command. The descriptions of all commands are aligned
+      # based on the length of the longest command name.
+      #
+      # This method has been ported from Ramaze.
+      #
+      # @author Yorick Peterse
+      # @since  23-07-2011
+      # @return [Array]
+      #
+      def self.commands_info
+        cmds    = []
+        longest = Commands.map { |name, klass| name.to_s }.sort[0].size
+
+        Commands.each do |name, klass|
+          name = name.to_s
+          desc = ''
+
+          # Try to extract the command description
+          if klass.respond_to?(:const_defined?) \
+          and klass.const_defined?(:Description)
+            desc = klass.const_get(:Description)
+          end
+
+          # Align the description based on the length of the name
+          while name.size <= longest do
+            name += ' '
+          end
+
+          cmds.push(["#{name}    #{desc}"])
+        end
+
+        return cmds
+      end
+    end # Runner
+  end # Bin
+end # Zen

data/lib/zen/controller/admin_controller.rb

@@ -3,17 +3,18 @@ module Zen
   #:nodoc:
   module Controller
     ##
-    # 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.
+    # 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.
     #
     # ## 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.
     #
     # @author Yorick Peterse
     # @since  0.1
@@ -21,29 +22,35 @@ module Zen
     class AdminController < Zen::Controller::BaseController
       layout :admin
       engine :etanni
-      helper :blue_form, :common, :breadcrumb, :user, :acl, :message
+      helper :blue_form_vendor, :breadcrumb, :user, :acl, :message, :paginate
+
+      # Configure the pagination
+      trait :paginate => {
+        :limit => 20,
+        :var   => 'page'
+      }
 
       ##
-      # The initialize method is called upon class initalization and is used to process several
-      # items before loading the controller(s) for the current extension.
+      # The initialize method is called upon class initalization and is used to
+      # process several items before loading the controller(s) for the current
+      # extension.
       #
       # @author Yorick Peterse
       # @since  1.0
       #
       def initialize
         super
-                
-        # Only allow users to access admin/users/login when they aren't logged in
-        if request.env['SCRIPT_NAME'] != 'admin/users/' and request.env['PATH_INFO'] != '/login'
-          redirect '/admin/users/login' unless logged_in?
-        end
 
-        @boolean_hash = {
-          true  => lang('zen_general.special.boolean_hash.true'),
-          false => lang('zen_general.special.boolean_hash.false')
-        }.invert
+        # Only allow users to access admin/users/login when they aren't logged
+        # in
+        if request.env['SCRIPT_NAME'] != 'admin/users/' \
+        and request.env['PATH_INFO']  != '/login' \
+        and !logged_in?
+          message(:error, lang('zen_general.errors.require_login'))
+          redirect('/admin/users/login')
+        end
       end
- 
+
       ##
       # Shortcut for Zen::Asset.stylesheet.
       #
@@ -52,9 +59,7 @@ module Zen
       # @since  0.2.5
       #
       def self.stylesheet(files, options = {})
-        options = {
-          :controller => self
-        }.merge(options)
+        options = {:controller => self}.merge(options)
 
         ::Zen::Asset.stylesheet(files, options)
       end
@@ -67,26 +72,37 @@ module Zen
       # @since  0.2.5
       #
       def self.javascript(files, options = {})
-        options = {
-          :controller => self
-        }.merge(options)
+        options = {:controller => self}.merge(options)
 
         ::Zen::Asset.javascript(files, options)
       end
 
-      # Load all stylesheets globally
+      # Load all default stylesheets
       stylesheet(
         [
-          'zen/reset', 'zen/grid', 'zen/layout', 'zen/general', 'zen/forms', 'zen/tables', 
-          'zen/buttons', 'zen/messages'
-        ], 
+          'zen/reset',
+          'zen/grid',
+          'zen/layout',
+          'zen/general',
+          'zen/forms',
+          'zen/tables',
+          'zen/buttons',
+          'zen/messages'
+        ],
         :global => true
       )
 
-      # Load all global javascript files
+      # Load all default javascript files
       javascript(
-        ['mootools/core', 'mootools/more', 'zen/core', 'zen/init'], :global => true
+        [
+          'vendor/mootools/core',
+          'vendor/mootools/more',
+          'zen/lib/asset',
+          'zen/lib/html_table',
+          'zen/index'
+        ],
+        :global => true
       )
-    end
-  end
-end
+    end # AdminController
+  end # Controller
+end # Zen

data/lib/zen/controller/base_controller.rb

@@ -4,8 +4,8 @@ module Zen
   module Controller
     ##
     # 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.
+    # 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
@@ -14,6 +14,6 @@ module Zen
       include ::Zen::Language
 
       helper :csrf, :cgi
-    end
-  end
-end
+    end # BaseController
+  end # Controller
+end # Zen

data/lib/zen/controller/frontend_controller.rb

@@ -3,9 +3,9 @@ module Zen
   #:nodoc:
   module Controller
     ##
-    # Controller that should be extended by other controllers that can be accessed from
-    # the web without having to log in. Frontend controllers don't have a layout and
-    # use the Liquid template engine for all views.
+    # Controller that should be extended by other controllers that can be
+    # accessed from the web without having to log in. Frontend controllers don't
+    # have a layout and use the Liquid template engine for all views.
     #
     # @author Yorick Peterse
     # @since  0.1
@@ -13,7 +13,7 @@ module Zen
     class FrontendController < Zen::Controller::BaseController
       engine :etanni
       layout :none
-      helper :theme, :common
-    end
-  end
-end
+      helper :theme
+    end # FrontendController
+  end # Controller
+end # Zen

data/lib/zen/controller/main_controller.rb

@@ -3,9 +3,9 @@ module Zen
   #:nodoc:
   module Controller
     ##
-    # The MainController controller is used to load the correct template files based
-    # on the current URI. If no section is specified the default section will be retrieved
-    # from the settings table.
+    # The MainController controller is used to load the correct template files 
+    # based on the current URI. If no section is specified the default section 
+    # will be retrieved from the settings table.
     #
     # @author Yorick Peterse
     # @since  0.1
@@ -15,9 +15,9 @@ module Zen
       
       ##
       # The index method acts as a catch-all method. Based on the requested URI
-      # the correct template group/file will be loaded. If no templates are found
-      # a 404 template will be loaded. If that's not found either a default error
-      # will be shown.
+      # the correct template group/file will be loaded. If no templates are 
+      # found a 404 template will be loaded. If that's not found either a 
+      # default error will be shown.
       #
       # @author Yorick Peterse
       # @since  0.1
@@ -31,7 +31,9 @@ module Zen
         uri.each { |v| @request_uri.push(h(v)) }
         
         if !@request_uri[0] or @request_uri[0].empty?
-          @request_uri[0] = plugin(:settings, :get, :default_section).value
+          section         = plugin(:settings, :get, :default_section).value
+          section         = ::Sections::Model::Section[section].slug
+          @request_uri[0] = section
         end
         
         if !@request_uri[1] or @request_uri[1].empty?
@@ -65,6 +67,6 @@ module Zen
           end
         end
       end
-    end
-  end
-end
+    end # MainController
+  end # Controller
+end # Zen

data/lib/zen/controller/preview.rb

@@ -3,11 +3,12 @@ module Zen
   #:nodoc
   module Controller
     ##
-    # Controller that can be used to render a block of markup based on the POST data. This
-    # controller is useful for generating previews when using the text editor for example.
+    # Controller that can be used to render a block of markup based on the POST 
+    # data. This controller is useful for generating previews when using the 
+    # text editor for example.
     #
-    # In order to render a preview you'll have to send a POST request with the following
-    # data in it:
+    # In order to render a preview you'll have to send a POST request with the 
+    # following data in it:
     #
     # * engine: The markup engine to use (Markdown, Textile, etc).
     # * markup: The markup to convert to HTML.
@@ -18,9 +19,9 @@ module Zen
     #     engine: "markdown"
     #     markup: "Hello **world**!"
     #
-    # The return data is an HTTP status code and the HTML as the body. The HTTP status
-    # code will be 200 whenever the data was converted and or 400 in case of an error
-    # (e.g. an incorrect markup engine was specified).
+    # The return data is an HTTP status code and the HTML as the body. The HTTP 
+    # status code will be 200 whenever the data was converted and or 400 in case 
+    # of an error (e.g. an incorrect markup engine was specified).
     #
     # @author Yorick Peterse
     # @since  0.2.6
@@ -40,11 +41,14 @@ module Zen
         end
 
         begin
-          respond(plugin(:markup, request.params['engine'], request.params['markup']), 200)
+          respond(
+            plugin(:markup, request.params['engine'], request.params['markup']), 
+            200
+          )
         rescue
           respond(lang('zen_general.errors.invalid_request'), 400)
         end
       end
-    end
-  end
-end
+    end # Preview
+  end # Controller
+end # Zen