zen 0.2.8 → 0.3b

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

@@ -0,0 +1,52 @@
+Zen::Language::Translation.add do |trans|
+  trans.language = 'en'
+  trans.name     = 'zen_general'
+
+  trans.translate do |t|
+    t['labels.powered_by']   = 'Powered by'
+    t['labels.view_website'] = 'View website'
+    t['labels.logout']       = 'Logout'
+    t['labels.profile']      = 'Profile'
+
+    t['errors.csrf'] = 'The specified request can not be executed without a ' \
+      'valid CSRF token.'
+
+    t['errors.not_authorized']  = 'You are not authorized to access that page.'
+    t['errors.no_templates']    = 'No templates were found for the given action.'
+    t['errors.no_theme']        = 'No theme has been specified.'
+    t['errors.invalid_request'] = 'The request could not be executed as the ' \
+      'specified data is incorrect.'
+
+    t['errors.require_login'] = 'You need to be logged in in order to view ' \
+      'that page.'
+
+    t['errors.invalid_search'] = 'The specified search query is invalid.'
+
+    t['descriptions.search'] = 'Search keywords'
+
+    t['buttons.bold']    = 'Bold'
+    t['buttons.italic']  = 'Italic'
+    t['buttons.link']    = 'Link'
+    t['buttons.ul']      = 'Unordered list'
+    t['buttons.ol']      = 'Ordered list'
+    t['buttons.preview'] = 'Preview'
+    t['buttons.close']   = 'Close'
+    t['buttons.search']  = 'Search'
+
+    t['datepicker.select_a_time']   = 'Select a time'
+    t['datepicker.use_mouse_wheel'] = 'Use the mouse wheel to quickly change ' \
+      'the value'
+    t['datepicker.time_confirm_button'] = 'Ok'
+    t['datepicker.apply_range']         = 'Ok'
+    t['datepicker.cancel']              = 'Cancel'
+    t['datepicker.week']                = 'W'
+
+    t['special.boolean_hash.true']    = 'Yes'
+    t['special.boolean_hash.false']   = 'No'
+
+    t['markup.html']     = 'HTML'
+    t['markup.textile']  = 'Textile'
+    t['markup.markdown'] = 'Markdown'
+    t['markup.plain']    = 'Plain'
+  end
+end

data/lib/zen/language/en/zen_models.rb

@@ -0,0 +1,19 @@
+Zen::Language::Translation.add do |trans|
+  trans.language = 'en'
+  trans.name     = 'zen_models'
+
+  trans.translate do |t|
+    t['exact_length'] = 'This field is not exactly %s characters long.'
+    t['format']       = "This field's format is invalid."
+    t['includes']     = "This field's value is not in the range or set of %s."
+    t['integer']      = "This field's value is not an integer."
+    t['length_range'] = "This field's value is either too long or too short."
+    t['max_length']   = "This field's value may not be longer than %s characters."
+    t['min_length']   = "This field's value may not be shorter than %s characters."
+    t['not_string']   = "This field's value is not a string."
+    t['numeric']      = "This field's value is not numeric."
+    t['type']         = "This field's value is not a %s."
+    t['presence']     = "This field's value is required."
+    t['unique']       = "This field's value is already taken."
+  end
+end

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

@@ -0,0 +1,57 @@
+Zen::Language::Translation.add do |trans|
+  trans.language = 'nl'
+  trans.name     = 'zen_general'
+
+  trans.translate do |t|
+    t['labels.powered_by']   = 'Aangedreven door'
+    t['labels.view_website'] = 'Bekijk website'
+    t['labels.logout']       = 'Log uit'
+    t['labels.profile']      = 'Profiel'
+
+    t['errors.csrf'] = 'De actie kon niet worden uitgevoerd zonder een geldige ' \
+      'CSRF token.'
+
+    t['errors.not_authorized'] = 'U bent niet toegestaan om de opgevraagde ' \
+      'pagina te bekijken.'
+
+    t['errors.no_templates'] = 'Er konden geen templates worden gevonden voor ' \
+      'huidige actie.'
+
+    t['errors.no_theme']        = 'Er is geen thema ingesteld.'
+    t['errors.invalid_request'] = 'De actie kon niet worden uitgevoerd omdat ' \
+      'de data onjuist is.'
+
+    t['errors.require_login'] = 'U moet ingelogd zijn om de opgevraagde pagina ' \
+      'te kunnen bekijken.'
+
+    t['errors.invalid_search'] = 'De opgegeven zoek actie is ongeldig.'
+
+    t['descriptions.search'] = 'Zoektermen'
+
+    t['buttons.bold']    = 'Vet'
+    t['buttons.italic']  = 'Cursief'
+    t['buttons.link']    = 'Hyperlink'
+    t['buttons.ul']      = 'Ongesorteerde lijst'
+    t['buttons.ol']      = 'Gesorteerde lijst'
+    t['buttons.preview'] = 'Voorbeeld'
+    t['buttons.close']   = 'Sluiten'
+    t['buttons.search']  = 'Zoeken'
+
+    t['datepicker.select_a_time']   = 'Selecteer een tijd'
+    t['datepicker.use_mouse_wheel'] = 'Gebruik het muis wiel om een waarde te ' \
+      'selecteren'
+
+    t['datepicker.time_confirm_button'] = 'Ok'
+    t['datepicker.apply_range']         = 'Ok'
+    t['datepicker.cancel']              = 'Annuleren'
+    t['datepicker.week']                = 'W'
+
+    t['special.boolean_hash.true']  = 'Ja'
+    t['special.boolean_hash.false'] = 'Nee'
+
+    t['markup.html']     = 'HTML'
+    t['markup.markdown'] = 'Markdown'
+    t['markup.textile']  = 'Textile'
+    t['markup.plain']    = 'Platte tekst'
+  end
+end

data/lib/zen/language/nl/zen_models.rb

@@ -0,0 +1,22 @@
+Zen::Language::Translation.add do |trans|
+  trans.language = 'nl'
+  trans.name     = 'zen_models'
+
+  trans.translate do |t|
+    t['exact_length'] = 'Dit veld bevat niet exact %s karakters.'
+    t['format']       = 'Het formaat van de waarde van dit veld is onjuist.'
+    t['includes']     = 'De waarde van dit veld is niet binnen het bereik '\
+      'van %s.'
+    t['integer']      = 'De waarde van dit veld is niet numeriek.'
+    t['length_range'] = 'De waarde van dit veld is te lang of te kort.'
+    t['max_length']   = 'De waarde van dit veld mag niet langer zijn dan ' \
+      '%s karakters.'
+    t['min_length']   = 'De waarde van dit veld mag niet korter zijn dan ' \
+      '%s karakters.'
+    t['not_string']   = 'De waarde van dit veld is geen tekst.'
+    t['numeric']      = 'De waarde van dit veld is niet numeriek.'
+    t['type']         = 'De waarde van dit veld is niet het type %s.'
+    t['presence']     = 'Dit veld is vereist.'
+    t['unique']       = 'De waarde van dit veld is al in gebruik.'
+  end
+end

data/lib/zen/language/translation.rb

@@ -0,0 +1,132 @@
+module Zen
+  class Language
+    ##
+    # Class used to specify all the translations in a language file/pack. In
+    # order to add a translation you need to specify the language, the name of
+    # the collection and a bunch of strings to translate. This is done as
+    # following:
+    #
+    #     Zen::Language::Translation.add do |trans|
+    #       trans.language = 'en'
+    #       trans.name     = 'users'
+    #
+    #       trans.translate do |t|
+    #         t['titles.index'] = 'Users'
+    #       end
+    #     end
+    #
+    # For more general and expanded information see {Zen::Language}.
+    #
+    # @since 16-11-2011
+    #
+    class Translation
+      include Zen::Validation
+
+      # A regex that specifies the allowed format of language keys.
+      KEY_REGEX = /^[a-z_\.]+$/
+
+      # The name of the language this set of translations belongs to.
+      attr_reader :language
+
+      # The name of the set of translations.
+      attr_reader :name
+
+      # A block containing all the translations for the language file.
+      attr_accessor :translations
+
+      ##
+      # Adds a new translation set.
+      #
+      # @since 16-11-2011
+      # @yield Zen::Language::Translation
+      #
+      def self.add
+        trans = new
+
+        yield(trans)
+
+        trans.validate
+
+        REGISTERED[trans.language].collections[trans.name] = trans
+      end
+
+      ##
+      # Sets the language for the collection of translations.
+      #
+      # @since 16-11-2011
+      # @param [#to_s] language The language code.
+      # @raise Zen::ValidationError Raised whenever a given language is invalid.
+      #
+      def language=(language)
+        @language = language.is_a?(String) ? language : language.to_s
+      end
+
+      ##
+      # Stores the supplied block containing all translations in
+      # ``@translations``.
+      #
+      # @since 17-11-2011
+      # @param [Proc] block A block containing all calls to ``#[]=()``.
+      #
+      def translate(&block)
+        @translations = block
+      end
+
+      ##
+      # Loads the translations by invoking the block that was set using
+      # {#translate}.
+      #
+      # @since 17-11-2011
+      #
+      def load
+        @translations.call(self)
+      end
+
+      ##
+      # Sets the name of the collection of translations.
+      #
+      # @since 16-11-2011
+      # @param [#to_s] name The name of the collection.
+      #
+      def name=(name)
+        @name = name.is_a?(String) ? name : name.to_s
+      end
+
+      ##
+      # Adds a new translation by directly storing it in the cache
+      # ``Ramaze::Cache.translations``.
+      #
+      # @since 16-11-2011
+      # @param [#to_s] key The name of the language item, an example is
+      #  "titles.index".
+      # @param [#to_s] value The value of the language item.
+      #
+      def []=(key, value)
+        unless key =~ KEY_REGEX
+          raise(
+            Zen::LanguageError,
+            "The format of the language key \"#{key}\" is invalid"
+          )
+        end
+
+        Ramaze::Cache.translations.store([language, name, key].join('.'), value)
+      end
+
+      ##
+      # Validates the instance.
+      #
+      # @since 17-11-2011
+      #
+      def validate
+        validates_presence([:name, :name, :translations])
+
+        unless Zen::Language::REGISTERED.key?(language)
+          raise(
+            Zen::ValidationError,
+            "The language \"#{language}\" doesn't exist"
+          )
+        end
+      end
+    end # Translation
+  end # Language
+end # Zen

data/lib/zen/languages.rb

@@ -0,0 +1,9 @@
+Zen::Language.add do |lang|
+  lang.name  = 'en'
+  lang.title = 'English'
+end
+
+Zen::Language.add do |lang|
+  lang.name  = 'nl'
+  lang.title = 'Nederlands'
+end

data/lib/zen/layout/admin.xhtml

@@ -1,5 +1,5 @@
 <!DOCTYPE html>
-<html lang="#{plugin(:settings, :get, :language).value}">
+#{Zen::Language.html_head}
     <head>
         #{render_file(__DIR__('../view/head.xhtml'))}
     </head>
@@ -8,7 +8,7 @@
         <div id="top">
             <header class="container">
                 <nav id="main_nav" class="grid_12">
-                    #{Zen::Package.build_menu("left", extension_permissions)}
+                    #{Zen::Package.build_menu('left', session[:permissions])}
 
                     <ul class="right clearfix">
                         <li>
@@ -17,7 +17,7 @@
                             </a>
                         </li>
                         <li>
-                            <a href="/admin/users/edit/#{session[:user].id}">
+                            <a href="/admin/users/edit/#{user.id}">
                                 #{lang('zen_general.labels.profile')}
                             </a>
                         </li>

data/lib/zen/layout/login.xhtml

@@ -1,5 +1,5 @@
 <!DOCTYPE html>
-<html lang="#{plugin(:settings, :get, :language).value}">
+#{Zen::Language.html_head}
     <head>
         #{render_file(__DIR__('../view/head.xhtml'))}
     </head>

data/lib/zen/markup.rb

@@ -0,0 +1,189 @@
+module Zen
+  ##
+  # {Zen::Markup} is a module that makes it easy to convert markup from one
+  # format to another. It can be used to generate HTML using Markdown and
+  # Textile or to escape HTML using ``Ramaze::Helper::CGI``.
+  #
+  # Using this module is quite easy, simply call the ``.convert`` method of and
+  # pass the name of the markup engine you'd like to use to it along with some
+  # markup. For example, to convert Markdown to HTML you'd call the following:
+  #
+  #     html = Zen::Markup.convert(:markdown, 'Hello **world**')
+  #
+  # When converting Markdown or Textile Zen will automatically install the
+  # required gems. For Markdown RDiscount is used, for Textile RedCloth is used.
+  #
+  # You may be tempted to call the various methods directly but it is not
+  # recommended to do so. For example, you might have the following code:
+  #
+  #     # Taken from an HTML form
+  #     engine = 'markdown'
+  #     markup = '...'
+  #     html   = Zen::Markdown.send(engine, markup)
+  #
+  # This however makes it possible to do some serious damage. Consider the
+  # following:
+  #
+  #     engine = 'instance_eval'
+  #     markup = 'eval("....")'
+  #     html   = Zen::Markdown.send(engine, markup)
+  #
+  # Because of this you should use {Zen::Markup.convert} instead as this method
+  # will verify the engine name before calling the method for it.
+  #
+  # ## Adding Markup Engines
+  #
+  # Adding a new engine is relatively easy and is done in two steps. First you
+  # should add the name of your engine and it's label to
+  # {Zen::Markup::REGISTERED}. The keys of this hash should be the methods to
+  # call, teh values will be displayed in various ``<select>`` elements in the
+  # administration interface.
+  #
+  #     Zen::Markup::REGISTERED['my_markup'] = 'My Markup'
+  #
+  # In this example the label is hardcoded but it's recommended to use
+  # {Zen::Language.lang} instead.
+  #
+  # Once the engine has been added to the list you'll have to add a
+  # corresponding method. This can be done as following:
+  #
+  #     module Zen
+  #       module Markup
+  #         private
+  #
+  #         def self.my_markup(markup)
+  #
+  #         end
+  #       end
+  #     end
+  #
+  # Each markup method should be a class method and should take a single
+  # parameter. This parameter will contain the markup to convert. The return
+  # value of these methods should be the converted markup:
+  #
+  #     module Zen
+  #       module Markup
+  #         private
+  #
+  #         def self.my_markup(markup)
+  #           return markup.upcase
+  #         end
+  #       end
+  #     end
+  #
+  # @since  0.2.5
+  #
+  module Markup
+    # Hash containing all the markup engines and their names as they'll be
+    # displayed in the backend.
+    REGISTERED = {
+      'markdown' => 'zen_general.markup.markdown',
+      'textile'  => 'zen_general.markup.textile',
+      'plain'    => 'zen_general.markup.plain',
+      'html'     => 'zen_general.markup.html'
+    }
+
+    class << self
+      include ::Ramaze::Helper::CGI
+
+      ##
+      # Returns a hash containing the available markup engines and their labels
+      # for the current language.
+      #
+      # @since  15-11-2011
+      # @return [Hash]
+      #
+      def to_hash
+        hash = {}
+
+        REGISTERED.each { |k, v| hash[k] = lang(v) }
+
+        return hash
+      end
+
+      ##
+      # Converts markup using the specified markup engine.
+      #
+      # @example
+      #  Zen::Markup.conver(:markdown, 'Hello **world**')
+      #
+      # @since  0.3
+      # @param  [#to_s] engine The markup engine to use.
+      # @param  [String] markup The markup to convert.
+      # @return [String]
+      #
+      def convert(engine, markup)
+        unless REGISTERED.keys.include?(engine.to_s)
+          raise(ArgumentError, "The specified engine \"#{engine}\" is invalid")
+        end
+
+        return send(engine, markup)
+      end
+
+      private
+
+      ##
+      # Converts the Markdown markup to HTML using RDiscount.
+      #
+      # @example
+      #  Zen::Markup.markdown('Hello **world**')
+      #
+      # @since  0.2.5
+      # @param  [String] markup The Markdown string to convert to HTML.
+      # @return [String] The HTML returned by RDiscount.
+      #
+      def markdown(markup)
+        unless Kernel.const_defined?(:RDiscount)
+          Ramaze.setup(:verbose => false) do
+            gem 'rdiscount'
+          end
+        end
+
+        return RDiscount.new(markup).to_html
+      end
+
+      ##
+      # Converts Textile to HTML using RedCloth.
+      #
+      # @example
+      #  Zen::Markup.textile('Hello *world*')
+      #
+      # @since  0.2.5
+      # @param  [String] markup The Textile markup to convert to HTML.
+      # @return [String] The HTML returned by RedCloth.
+      #
+      def textile(markup)
+        unless Kernel.const_defined?(:RedCloth)
+          Ramaze.setup(:verbose => false) do
+            gem 'RedCloth', :lib => 'redcloth'
+          end
+        end
+
+        return RedCloth.new(markup).to_html
+      end
+
+      ##
+      # Escapes all HTML using Ramaze::Helper::CGI.
+      #
+      # @since  0.2.5
+      # @param  [String] markup The markup in which all HTML tags should be
+      #  escaped.
+      # @return [String] String containing the escaped HTML.
+      #
+      def plain(markup)
+        return h(markup)
+      end
+
+      ##
+      # Ignores the markup and just returns it.
+      #
+      # @since  0.2.5
+      # @param  [String] markup The markup to return.
+      # @return [String] String containing our markup.
+      #
+      def html(markup)
+        return markup
+      end
+    end # class << self
+  end # Markup
+end # Zen