zen 0.2.7 → 0.2.8

data/lib/zen/helper/breadcrumb.rb

@@ -5,33 +5,34 @@ module Ramaze
     ##
     # Helper that can be used to quickly generate breadcrumbs without having
     # to manually write the HTML separators and formatting the output correctly.
-    # In order to create a set of breadcrumbs we first need to call the set_breadcrumbs
-    # method:
+    # In order to create a set of breadcrumbs we first need to call the
+    # set_breadcrumbs method:
     #
     #     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:
+    # Each argument will be a segment of the breadcrumbs, separated by a custom
+    # character. Retrieving the breadcrumbs is super easy:
     #
     #     get_breadcrumbs
     #
-    # This will generate the correct HTML and return it, all you have to do is output it.
+    # This will generate the correct HTML and return it, all you have to do is
+    # output it.
     #
     # @author Yorick Peterse
     # @since  0.1
     #
     module Breadcrumb
       @breadcrumbs = []
-      
+
       ##
       # Appends each element to the list of breadcrumb segments.
       #
       # @example
       #  set_breadcrumbs "Articles", "Edit"
       #
-      # Note that you'll have to manually specify anchor tags, this method won't 
+      # 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
@@ -39,10 +40,10 @@ module Ramaze
       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"
@@ -51,23 +52,26 @@ module Ramaze
       #  get_breadcrumbs ">" # => "Articles > Edit"
       #
       # @author Yorick Peterse
-      # @param  [String] separator The HTML character to use for separating each segment.
+      # @param  [String] separator The HTML character to use for separating each
+      # segment.
       # @return [String]
-      # 
+      #
       def get_breadcrumbs(separator = "»")
         if !@breadcrumbs or @breadcrumbs.empty?
           return
         end
-        
+
         html      = ''
         separator = " #{separator} "
-        
+
         @breadcrumbs.each do |segment|
           html += segment + separator
         end
-        
+
+        @breadcrumbs = nil
+
         return html.chomp(separator)
       end
-    end
-  end
-end
+    end # Breadcrumb
+  end # Helper
+end # Ramaze

data/lib/zen/helper/message.rb

@@ -5,9 +5,9 @@ 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:
+    # 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

data/lib/zen/helper/theme.rb

@@ -5,17 +5,18 @@ module Ramaze
   #:nodoc:
   module Helper
     ##
-    # Helper that provides a few methods that make certain tasks easier when creating
-    # themes and templates.
+    # 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.
+      # 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
@@ -24,18 +25,21 @@ module Ramaze
       # @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.
+      # @param  [Hash] variables A hash with variables that should be made
+      # available for the partial.
       #
       def partial(file, variables = {})
         theme = plugin(:settings, :get, :theme).value
         theme = Zen::Theme[theme]
 
         if !theme.respond_to?(:partial_dir) or theme.partial_dir.nil?
-          raise(::Zen::ThemeError, "The theme #{theme.name} has no partial directory set.")
+          raise(
+            ::Zen::ThemeError,
+            "The theme #{theme.name} has no partial directory set."
+          )
         end
 
-        template = "#{theme.partial_dir}/#{file}.xhtml"
+        template = File.join(theme.partial_dir, "#{file}.xhtml")
 
         if !File.exist?(template)
           raise(::Zen::ThemeError, "The template #{template} doesn't exist.")
@@ -46,9 +50,10 @@ module Ramaze
       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.
+      # 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
@@ -60,7 +65,7 @@ module Ramaze
       #
       def show_404(variables = {})
         theme    = ::Zen::Theme[plugin(:settings, :get, :theme).value]
-        template = "#{theme.template_dir}/404.xhtml"
+        template = File.join(theme.template_dir, '404.xhtml')
 
         # Render the template and replace the current buffer with it's output
         template = render_file(template, variables)

data/lib/zen/language.rb

@@ -3,37 +3,39 @@ require __DIR__('error/language_error')
 #:nodoc:
 module Zen
   ##
-  # The language module is used for writing and using text translations. Translations are
-  # stored in a simple YAML file inside a directory called "language" followed by a directory
-  # who's name matches the language code for which it's translations should be used.
-  # Say we wanted to translate "Login" and "Register" into different languages our YAML
-  # file would look like the following:
+  # The language module is used for writing and using text translations.
+  # Translations are stored in a simple YAML file inside a directory called
+  # "language" followed by a directory who's name matches the language code for
+  # which it's translations should be used. Say we wanted to translate "Login"
+  # and "Register" into different languages our YAML file would look like the
+  # following:
   #
   #     ---
   #     login: "Login"
   #     register: "Register"
   #
-  # If we save this file under parent_directory/language/en/tutorial.yml we could then
-  # load that file as following:
+  # If we save this file under parent_directory/language/en/tutorial.yml we
+  # could then load that file as following:
   #
   #     Zen::Language.load('tutorial')
   #
   # ## Loading Translations
   #
-  # The load() method will look for a YAML file of which the name matches the given string
-  # and can be found in the directory for the current language. This means that if we were
-  # to switch our language without creating a translation file for that language we wouldn't
-  # be able to use it (makes sense right?).
+  # The load() method will look for a YAML file of which the name matches the
+  # given string and can be found in the directory for the current language.
+  # This means that if we were to switch our language without creating a
+  # translation file for that language we wouldn't be able to use it
+  # (makes sense right?).
   #
-  # Once your translation file is in place and it's loaded it can be used using the lang()
-  # method. Example:
+  # Once your translation file is in place and it's loaded it can be used using
+  # the lang() method. Example:
   #
   #     lang('tutorial.login') # => "Login"
   #
   # ## Directory Structure
   #
-  # As mentioned earlier language files are saved in a certain directory. The structure
-  # of this directory looks like the following:
+  # As mentioned earlier language files are saved in a certain directory. The
+  # structure of this directory looks like the following:
   #
   #     parent directory
   #       |
@@ -43,20 +45,21 @@ module Zen
   #             |
   #             |__ filename.yml
   #
-  # When loading a language file this module will loop through a certain number of paths.
-  # The array containing all base directories to loop through can be updated as following:
+  # When loading a language file this module will loop through a certain number
+  # of paths. The array containing all base directories to loop through can be
+  # updated as following:
   #
   #     Zen::Language.options.paths.push('/path/to/directory')
   #
-  # It's important that you _don't_ add a /language segment to the path, this will be done
-  # automatically.
+  # It's important that you _don't_ add a /language segment to the path, this
+  # will be done automatically.
   #
   # ## Options
   #
   # * language: Small string that defines the current language (e.g. "en").
-  # * 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.
+  # * 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
@@ -68,20 +71,13 @@ module Zen
       include Innate::Trinity
     end
 
-    ##
-    # Hash containing all loaded translation files.
-    #
-    # @author Yorick Peterse
-    # @since  0.2.5
-    #
-    Registered = {}
+    # Hash containing all the translations.
+    Translations = {}
+
+    # Hash containing all the loaded language files for a language.
+    Loaded = {}
 
-    ##
     # Hash containing all the available languages.
-    #
-    # @author Yorick Peterse
-    # @since  0.2.6
-    #
     Languages = {
       'en' => 'English',
       'nl' => 'Nederlands'
@@ -93,8 +89,9 @@ module Zen
     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.
+    # 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.
     #
     # Note that this method will load the language pack for *all* languages.
     #
@@ -106,15 +103,17 @@ module Zen
     # @param  [String] lang_name The name of the language file to load.
     #
     def self.load(lang_name)
+      lang_name  = lang_name.to_s
       file_found = false
 
       Languages.each do |language, label|
-        Registered[language] ||= {}
+        Loaded[language]       ||= []
+        Translations[language] ||= {}
 
         # Abort of the file has already been loaded
-        if Registered[language][lang_name]
+        if Loaded.key?(language) and Loaded[language].include?(lang_name)
           file_found = true
-          next
+          break
         end
 
         self.options.paths.each do |path|
@@ -125,25 +124,30 @@ module Zen
             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}.
+            Loaded[language].push(lang_name)
+
+            # 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)
+            Translations[language].merge!(translation)
           end
         end
       end
 
       if file_found === false
-        raise(Zen::LanguageError, "No language file could be found for \"#{lang_name}\"")
+        raise(
+          Zen::LanguageError,
+          "No language file could be found for \"#{lang_name}\""
+        )
       end
     end
 
     private
 
     ##
-    # Method that takes a hash or an array and converts it to a dot-based hash. For example,
-    # the following hash:
+    # Method that takes a hash or an array and converts it to a dot-based hash.
+    # For example, the following hash:
     #
     #     {:name => 'Name', :location => {:street => 'Street', :address => 'Address'}}
     #
@@ -170,8 +174,8 @@ module Zen
     # @param  [Hash/Array] source The hash or array to conver to a dot-based hash.
     # @param  [Hash] target The hash to store the new key/values in.
     # @param  [String] namespace The namespace for the key (e.g. "user.location").
-    # @return [Hash] The converted hash where the keys are dot-based strings instead of
-    # regular strings/symbols with sub hashes.
+    # @return [Hash] The converted hash where the keys are dot-based strings
+    # instead of regular strings/symbols with sub hashes.
     #
     def self.to_dotted_hash(source, target = {}, namespace = nil)
       if namespace and !namespace.nil?
@@ -180,12 +184,11 @@ module Zen
         prefix = ""
       end
 
-      case source
-      when Hash
+      if source.class == Hash
         source.each do |k, v|
           self.to_dotted_hash(v, target, "#{prefix}#{k}")
         end
-      when Array
+      elsif source.class == Array
         source.each_with_index do |v, i|
           self.to_dotted_hash(v, target, "#{prefix}#{i}")
         end
@@ -203,8 +206,9 @@ module Zen
     #: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:
+      # 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')
       #
@@ -214,9 +218,9 @@ module Zen
       #     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.
+      # 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')
@@ -224,8 +228,8 @@ 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.
+      # @param  [String] lang The language for which to retrieve the key,
+      # overwrites the language set in the session.
       # @return [Mixed]
       #
       def lang(key, lang = nil)
@@ -238,7 +242,7 @@ module Zen
         end
 
         groups       = []
-        translations = ::Zen::Language::Registered
+        translations = ::Zen::Language::Translations
 
         if !translations or !translations.key?(lang)
           raise(

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

@@ -1,9 +1,6 @@
 ---
 labels:
-  zen_version  : 'Powered by Zen version %s'
-  zen_website  : 'Website'
-  zen_docs     : 'Documentation'
-  zen_github   : 'GitHub Account'
+  powered_by   : 'Powered by'
   view_website : 'View Website'
   logout       : 'Logout'
   profile      : 'Profile'
@@ -14,6 +11,7 @@ errors:
   no_templates    : 'No templates were found for the given action.'
   no_theme        : 'No theme has been specified.'
   invalid_request : 'The request could not be executed as the specified data is incorrect.'
+  require_login   : 'You need to be logged in in order to view this page.'
 
 special:
   format_hash:

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

@@ -1,9 +1,6 @@
 ---
 labels:
-  zen_version : 'Deze website draait op Zen versie %s'
-  zen_website : 'Website'
-  zen_docs    : 'Documentatie'
-  zen_github  : 'GitHub account'
+  powered_by  : 'Aangedreven door'
   view_website: 'Bekijk website'
   logout      : 'Uitloggen'
   profile     : 'Profiel'
@@ -14,6 +11,7 @@ errors:
   no_templates   : 'Er konden geen sjablonen worden gevonden voor de huidige actie.'
   no_theme       : 'Er is geen thema ingesteld.'
   invalid_request: 'De actie kon niet worden uitgevoerd omdat de data onjuist is.'
+  require_login  : 'U moet ingelogd zijn om deze pagina te kunnen bekijken.'
 
 special:
   format_hash: