zen 0.2.5 → 0.2.6

data/lib/zen/asset.rb

@@ -37,7 +37,7 @@ module Zen
   #
   # ## Building Assets
   #
-  # Building assets shouldn't be required as Zen already does this but if you happen to 
+  # Building assets shouldn't be required as Zen already does this but if you happen to
   # need it you can build the files as following:
   #
   #     Zen::Asset.build(:stylesheet)
@@ -45,8 +45,8 @@ module Zen
   #
   # ## Controller Usage
   #
-  # While this module can be called by any other piece of code the class 
-  # Zen::Controller::AdminController provides shortcuts to Zen::Asset.javascript and 
+  # While this module can be called by any other piece of code the class
+  # Zen::Controller::AdminController provides shortcuts to Zen::Asset.javascript and
   # Zen::Asset.stylesheet. These shortcuts work identical but are defined as class methods
   # and thus can be used inside your class declaration:
   #
@@ -137,7 +137,7 @@ module Zen
     # @option options [TrueClass] :global When set to true all the specified stylesheets
     # will be loaded globally rather than just for the current action.
     # @option options [String/Symbol] controller The name of the controller for which
-    # the specified files should be loaded. 
+    # the specified files should be loaded.
     #
     def self.stylesheet(files, options = {})
       options = {
@@ -163,7 +163,7 @@ module Zen
     # @since  0.2.5
     # @param  [Symbol] type The type of assets to build.
     # @return [String] The HTML tags for all the assets.
-    # 
+    #
     def self.build(type)
       type       = type.to_sym
       attrs      = {}
@@ -253,6 +253,5 @@ module Zen
         end
       end
     end
-
-  end
-end
+  end # Asset
+end # Zen

data/lib/zen/bin/app.rb

@@ -7,7 +7,6 @@ require 'fileutils'
 # @since  0.2.5
 # 
 command :app do |cmd|
-
   # Set a few details of the command
   cmd.syntax      = '$ zen app [NAME]'
   cmd.description = 'Creates a new application powered by Zen.'
@@ -38,5 +37,4 @@ command :app do |cmd|
       abort "Failed to generate the application: #{e.message}"
     end
   end
-
 end

data/lib/zen/controller/admin_controller.rb

@@ -21,7 +21,7 @@ module Zen
     class AdminController < Zen::Controller::BaseController
       layout :admin
       engine :etanni
-      helper :blue_form, :common, :breadcrumb, :user, :acl
+      helper :blue_form, :common, :breadcrumb, :user, :acl, :message
 
       ##
       # The initialize method is called upon class initalization and is used to process several
@@ -77,21 +77,16 @@ module Zen
       # Load all stylesheets globally
       stylesheet(
         [
-          'reset', 'grid', 'layout', 'general', 'forms', 'tables', 'buttons', 
-          'notifications'
+          'zen/reset', 'zen/grid', 'zen/layout', 'zen/general', 'zen/forms', 'zen/tables', 
+          'zen/buttons', 'zen/messages'
         ], 
         :global => true
       )
 
       # Load all global javascript files
       javascript(
-        [
-          'mootools/core', 'mootools/more', 'vendor/yepnope', 'zen/notification', 
-          'zen/init', 
-        ],
-        :global => true
+        ['mootools/core', 'mootools/more', 'zen/core', 'zen/init'], :global => true
       )
-
     end
   end
 end

data/lib/zen/controller/base_controller.rb

@@ -14,31 +14,6 @@ module Zen
       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.
-      #
-      # @author Yorick Peterse
-      # @since  1.0
-      #
-      def initialize
-        super
-
-        # Store the settings data if this is the first time we're loading the controller
-        if ::Zen::Settings.empty?
-          ::Settings::Model::Setting.get_settings.each do |k, v|
-            ::Zen::Settings[k] = v
-          end
-        end
-
-        # Override the language
-        if ::Zen::Settings[:language] != ::Zen::Language.options.language
-          # Reload the language pack
-          ::Zen::Language.options.language = ::Zen::Settings[:language]
-          ::Zen::Language.load('zen_general')
-        end
-      end
     end
   end
 end

data/lib/zen/controller/main_controller.rb

@@ -31,7 +31,7 @@ module Zen
         uri.each { |v| @request_uri.push(h(v)) }
         
         if !@request_uri[0] or @request_uri[0].empty?
-          @request_uri[0] = ::Zen::Settings[:default_section]
+          @request_uri[0] = ::Zen.settings[:default_section]
         end
         
         if !@request_uri[1] or @request_uri[1].empty?
@@ -39,11 +39,11 @@ module Zen
         end
         
         # A theme is always required
-        if ::Zen::Settings[:theme].nil? or ::Zen::Settings[:theme].empty?
+        if ::Zen.settings[:theme].nil? or ::Zen.settings[:theme].empty?
           respond(lang('zen_general.errors.no_theme'))
         end
 
-        theme    = ::Zen::Theme[::Zen::Settings[:theme]]
+        theme    = ::Zen::Theme[::Zen.settings[:theme]]
         group    = @request_uri[0]
         template = @request_uri[1]
         
@@ -53,7 +53,7 @@ module Zen
         template_path = File.join(theme_path, group, "#{template}.xhtml")
         
         # Is the website down?
-        if ::Zen::Settings[:website_enabled] == '0'
+        if ::Zen.settings[:website_enabled] == '0'
           offline_path = File.join(theme_path, 'offline.xhtml')
           
           if File.exist?(offline_path)
@@ -69,7 +69,7 @@ module Zen
             not_found = File.join(theme_path, '404.xhtml')
             
             if File.exist?(not_found)
-              render_file(not_found)
+              respond(render_file(not_found), 404)
             else
               respond(lang('zen_general.errors.no_templates'), 404)
             end

data/lib/zen/controller/preview.rb

@@ -0,0 +1,50 @@
+#:nodoc
+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.
+    #
+    # 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.
+    #
+    # An example of such a request would look like the following:
+    #
+    #     POST /admin/preview
+    #     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).
+    #
+    # @author Yorick Peterse
+    # @since  0.2.6
+    #
+    class Preview < Zen::Controller::AdminController
+      map '/admin/preview'
+
+      ##
+      # Converts the markup set in the POST data and returns the HTML.
+      #
+      # @author Yorick Peterse
+      # @since  0.2.6
+      #
+      def index
+        if !request.params['engine'] or !request.params['markup']
+          respond(lang('zen_general.errors.invalid_request'), 400)
+        end
+
+        begin
+          respond(plugin(:markup, request.params['engine'], request.params['markup']), 200)
+        rescue
+          respond(lang('zen_general.errors.invalid_request'), 400)
+        end
+      end
+    end
+  end
+end

data/lib/zen/helper/common.rb

@@ -9,42 +9,11 @@ module Ramaze
     # @author Yorick Peterse
     # @since  0.1
     #
-    module Common
+    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.
+      # Generate an anchor tag similar as to how Ramaze does it with the
+      # Ramaze::Controller.a() method. 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
@@ -78,7 +47,6 @@ module Ramaze
       # @return [String]
       #
       def anchor_to(text, url, *attributes)
-        
         # Sanitize the text and URL
         text = Rack::Utils.escape_html(text)
         url  = url.to_s
@@ -133,38 +101,6 @@ module Ramaze
         # 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)
-        @@cycle_counter ||= 0
-        
-        # 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/helper/message.rb

@@ -0,0 +1,82 @@
+require 'ramaze/gestalt'
+
+#:nodoc:
+module Ramaze
+  #:nodoc:
+  module Helper
+    ##
+    # The Mesage helper is a Ruby implementation of the Codeigniter library "Message"
+    # (located here: https://github.com/isset/codeigniter-message). This helper was taken
+    # from another project of mine which can be found here:
+    # https://github.com/yorickpeterse/stumpert/
+    #
+    # ## Usage
+    #
+    # Basic usage is as following:
+    #
+    #     message(:error, "Bummer, something went wrong!")
+    #
+    # In your layout you'd do the following:
+    #
+    #     display_messages
+    #
+    # This will create and return the HTML for all the messages.
+    #
+    # @author Yorick Peterse
+    # @since  26-05-2011
+    #
+    module Message
+      ##
+      # Adds a new message to the list for the given type.
+      #
+      # @author Yorick Peterse
+      # @since  26-05-2011
+      # @param  [Symbol/String] type The type of message to store (e.g. "error").
+      # @param  [String] message The message to display.
+      #
+      def message(type, message)
+        if type.respond_to?(:to_sym)
+          type = type.to_sym
+        end
+
+        flash[:messages]       ||= {}
+        flash[:messages][type] ||= []
+        flash[:messages][type].push(message)
+      end
+
+      ##
+      # Renders all the messages for the specified types.
+      #
+      # @author Yorick Peterse
+      # @since  26-05-2011
+      # @param  [Array] types Array containing all the messages to render.
+      #
+      def display_messages(types = [:info, :error, :success])
+        gestalt = ::Ramaze::Gestalt.new
+
+        return if flash[:messages].nil?
+        
+        gestalt.div(:id => 'message_container', :class => 'container') do
+          # Render each individual group
+          types.each do |type|
+            if type.respond_to?(:to_sym)
+              type = type.to_sym
+            end
+
+            if flash[:messages].key?(type)
+              gestalt.div(:class => "message #{type}") do
+                # Render all the messages
+                flash[:messages][type].each_with_index do |message, index|
+                  flash[:messages][type].delete_at(index)
+                  gestalt.p { message }
+                end
+              end
+            end
+          end
+        end
+
+        return gestalt.to_s
+      end
+    end # Message
+  end # Helper
+end # Ramaze

data/lib/zen/helper/theme.rb

@@ -29,7 +29,7 @@ module Ramaze
       # the partial.
       #
       def partial(file, variables = {})
-        theme = ::Zen::Theme[::Zen::Settings[:theme]]
+        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.")
@@ -59,7 +59,7 @@ module Ramaze
       # @param  [Hash] variables Hash with variables to pass to the 404 template.
       #
       def show_404(variables = {})
-        theme    = ::Zen::Theme[::Zen::Settings[:theme]]
+        theme    = ::Zen::Theme[::Zen.settings[:theme]]
         template = "#{theme.template_dir}/404.xhtml"
 
         # Render the template and replace the current buffer with it's output

data/lib/zen/language.rb

@@ -59,11 +59,15 @@ module Zen
   # itself.
   #
   # @author Yorick Peterse
-  # @since  0.2 
+  # @since  0.2
   #
   module Language
     include Ramaze::Optioned
 
+    class << self
+      include Innate::Trinity
+    end
+
     ##
     # Hash containing all loaded translation files.
     #
@@ -72,49 +76,67 @@ module Zen
     #
     Registered = {}
 
+    ##
+    # Hash containing all the available languages.
+    #
+    # @author Yorick Peterse
+    # @since  0.2.6
+    #
+    Languages = {
+      'en' => 'English',
+      'nl' => 'Nederlands'
+    }
+
     options.dsl do
       o 'Small string that defines the current language (e.g. "en").', :language, 'en'
-      o 'Array of paths to look for the language files'              , :paths   , [] 
+      o 'Array of paths to look for the language files'              , :paths   , []
     end
-    
+
     ##
     # Tries to load a language file for the given name. If no language files were found
-    # based on the name and the current language an exception will be raised. 
+    # based on the name and the current language an exception will be raised.
+    #
+    # Note that this method will load the language pack for *all* languages.
     #
     # @example
     #  Zen::Language.load('user')
     #
     # @author Yorick Peterse
     # @since  0.1
-    # @param  [String] lang_name The name of the language file to load. 
-    # 
+    # @param  [String] lang_name The name of the language file to load.
+    #
     def self.load(lang_name)
-      Registered[self.options.language.to_s] ||= {}
+      file_found = false
 
-      if Registered[self.options.language.to_s][lang_name.to_s]
-        return
-      end
+      Languages.each do |language, label|
+        Registered[language] ||= {}
 
-      self.options.paths.each do |path|
-        path += "/language/#{self.options.language}/#{lang_name}.yml"
-
-        # Load the file and save it
-        if File.exist?(path)
-          translation = YAML.load_file(path)
-
-          # Conver the hash to a dot based hash. This means that {:person => {:age => 18}}
-          # would result in {'person.age' => 18}.
-          translation = self.to_dotted_hash({lang_name.to_s => translation})
-          
-          Registered[self.options.language.to_s] ||= {}
-          Registered[self.options.language.to_s].merge!(translation)
-          
-          # Prevents the exception from being raised
-          return
-        end        
+        # Abort of the file has already been loaded
+        if Registered[language][lang_name]
+          file_found = true
+          next
+        end
+
+        self.options.paths.each do |path|
+          path += "/language/#{language}/#{lang_name}.yml"
+
+          # Load the file and save it
+          if File.exist?(path)
+            file_found  = true
+            translation = YAML.load_file(path)
+
+            # Conver the hash to a dot based hash. This means that {:person => {:age => 18}}
+            # would result in {'person.age' => 18}.
+            translation = self.to_dotted_hash({lang_name.to_s => translation})
+
+            Registered[language].merge!(translation)
+          end
+        end
       end
 
-      raise(Zen::LanguageError, "No language file could be found for \"#{lang_name}\"")
+      if file_found === false
+        raise(Zen::LanguageError, "No language file could be found for \"#{lang_name}\"")
+      end
     end
 
     private
@@ -165,7 +187,7 @@ module Zen
         end
       when Array
         source.each_with_index do |v, i|
-          self.to_dotted_hash(v, target, "#{prefix}#{i}") 
+          self.to_dotted_hash(v, target, "#{prefix}#{i}")
         end
       else
         if !namespace.nil?
@@ -202,16 +224,25 @@ module Zen
       # @author Yorick Peterse
       # @since  0.2
       # @param  [String] key The language key to select.
+      # @param  [String] lang The language for which to retrieve the key, overwrites the
+      # language set in the session.
       # @return [Mixed]
       #
-      def lang(key)
-        lang          = ::Zen::Language.options.language.to_s
-        groups        = []
-        translations  = ::Zen::Language::Registered
+      def lang(key, lang = nil)
+        if lang.nil?
+          begin
+            lang = action.node.session[:user].language
+          rescue
+            lang = ::Zen::Language.options.language
+          end
+        end
+
+        groups       = []
+        translations = ::Zen::Language::Registered
 
         if !translations or !translations.key?(lang)
           raise(
-            Zen::LanguageError, 
+            Zen::LanguageError,
             "No translation files have been added for the language code \"#{lang}\""
           )
         end
@@ -219,13 +250,12 @@ module Zen
         if translations[lang][key]
           return translations[lang][key]
         end
-        
+
         raise(
           Zen::LanguageError,
           "The specified language item \"#{key}\" does not exist"
         )
       end
     end
-
-  end
-end
+  end # Language
+end # Zen