zen 0.3 → 0.4

data/lib/zen/helper/locale.rb

@@ -4,6 +4,25 @@ module Ramaze
     # Helper that can be used to display various variables based on the user's
     # locale and settings.
     #
+    # ## Working With Dates
+    #
+    # This module includes two separate methods that can be used for working
+    # with dates. The method {Ramaze::Helper::Locale#date_format} can be used to
+    # return the raw date format for the currently logged in user, the method
+    # {Ramaze::Helper::Locale#format_date} can be used to format an object that
+    # responds to ``#strftime()``. It is highly recommended to use the latter
+    # method whenever you display dates in order for them to be consistent.
+    #
+    # Usage of the format_date method is very simple, all you need to do is pass
+    # it an object that as mentioned above responds to ``#strftime()``:
+    #
+    #     format_date(Time.now) # => "23-02-2012 19:08:59"
+    #
+    # To use this method in Etanni templates you'll have to wrap it in the
+    # correct template tags:
+    #
+    #     #{format_date(Time.now)}
+    #
     # @since  0.3
     #
     module Locale

data/lib/zen/helper/search.rb

@@ -44,7 +44,7 @@ module Ramaze
         begin
           return yield(request.params['query'])
         rescue => e
-          Ramaze::Log.error(e.inspect)
+          Ramaze::Log.error(e)
           message(:error, lang('zen_general.errors.invalid_search'))
           redirect_referrer(::Sections::Controller::Sections.r(:index))
         end

data/lib/zen/helper/stacked_aspect.rb

@@ -1,7 +1,7 @@
 module Ramaze
   module Helper
     ##
-    # StackedAspect is a helper similar to {Innate::Helper::Aspect} but allows
+    # StackedAspect is a helper similar to Innate::Helper::Aspect but allows
     # calls to methods such as ``before_all`` to stack on top of each other
     # instead of overwriting previously defined ones.
     #
@@ -65,22 +65,6 @@ module Ramaze
         return aop
       end
 
-      ##
-      # Shows a warning to inform the developer that the aspect name is already
-      # in use.
-      #
-      # @since 06-11-2011
-      # @param [#to_s] name The name of the aspect.
-      #
-      def self.aspect_warn(name)
-        file, line = caller[1].split(':')
-
-        Ramaze::Log.warn(
-          "The aspect name \"#{name}\" is already in use, it was redefined " \
-            "in #{file} on line #{line}"
-        )
-      end
-
       ##
       # Calls a certain AOP action for the specified position and method name.
       #
@@ -156,13 +140,7 @@ module Ramaze
         # @param [Proc] block The block to execute.
         #
         def stacked_before_all(name, &block)
-          name = name.to_sym
-
-          if !STACKED_AOP[self][:before_all].key?(name)
-            STACKED_AOP[self][:before_all][name] = block
-          else
-            StackedAspect.aspect_warn(name)
-          end
+          STACKED_AOP[self][:before_all][name.to_sym] = block
         end
 
         ##
@@ -185,13 +163,9 @@ module Ramaze
 
           methods.each do |m|
             m = m.to_sym
-            STACKED_AOP[self][:before][m] ||= {}
 
-            if !STACKED_AOP[self][:before][m].key?(name)
-              STACKED_AOP[self][:before][m][name] = block
-            else
-              StackedAspect.aspect_warn(name)
-            end
+            STACKED_AOP[self][:before][m]     ||= {}
+            STACKED_AOP[self][:before][m][name] = block
           end
         end
 
@@ -202,13 +176,7 @@ module Ramaze
         # @see   Ramaze::Helper::StackedAspect::ClassMethods#stacked_before_all
         #
         def stacked_after_all(name, &block)
-          name = name.to_sym
-
-          if !STACKED_AOP[self][:after_all].key?(name)
-            STACKED_AOP[self][:after_all][name] = block
-          else
-            StackedAspect.aspect_warn(name)
-          end
+          STACKED_AOP[self][:after_all][name.to_sym] = block
         end
 
         ##
@@ -222,13 +190,9 @@ module Ramaze
 
           methods.each do |m|
             m = m.to_sym
-            STACKED_AOP[self][:after][m] ||= {}
 
-            if !STACKED_AOP[self][:after][m].key?(name)
-              STACKED_AOP[self][:after][m][name] = block
-            else
-              StackedAspect.aspect_warn(name)
-            end
+            STACKED_AOP[self][:after][m]     ||= {}
+            STACKED_AOP[self][:after][m][name] = block
           end
         end
 

data/lib/zen/helper/theme.rb

@@ -28,14 +28,14 @@ module Ramaze
         theme = get_setting(:theme).value
         theme = Zen::Theme[theme]
 
-        if !theme.respond_to?(:partial_dir) or theme.partial_dir.nil?
+        if !theme.respond_to?(:partials) or theme.partials.nil?
           raise(
             ::Zen::ThemeError,
             "The theme #{theme.name} has no partial directory set."
           )
         end
 
-        template = File.join(theme.partial_dir, "#{file}.xhtml")
+        template = File.join(theme.partials, "#{file}.xhtml")
 
         if !File.exist?(template)
           raise(::Zen::ThemeError, "The template #{template} doesn't exist.")
@@ -60,7 +60,7 @@ module Ramaze
       #
       def show_404(variables = {})
         theme    = ::Zen::Theme[get_setting(:theme).value]
-        template = File.join(theme.template_dir, '404.xhtml')
+        template = File.join(theme.templates, '404.xhtml')
         template = render_file(template, variables)
 
         respond(template, 404)

data/lib/zen/language.rb

@@ -309,21 +309,16 @@ module Zen
       end
 
       ##
-      # Builds an HTML opening tag with the lang and rtl attributes set for the
-      # currently used language.
+      # Returns a string containing the text direction if the current language
+      # is an rtl language.
       #
       # @since  14-11-2011
       # @return [String]
       #
-      def html_head
-        curr = Zen::Language.current
-        head = "<html lang=\"#{curr.name}\""
-
-        if curr.rtl == true
-          header += ' dir="rtl"'
+      def html_text_direction
+        if Zen::Language.current.rtl == true
+          return 'dir="rtl"'
         end
-
-        return head + '>'
       end
     end # class << self
 

data/lib/zen/language/translation.rb

@@ -23,7 +23,7 @@ module Zen
       include Zen::Validation
 
       # A regex that specifies the allowed format of language keys.
-      KEY_REGEX = /^[a-z_\.]+$/
+      KEY_REGEX = /^[0-9a-z_\.]+$/
 
       # The name of the language this set of translations belongs to.
       attr_reader :language

data/lib/zen/layout/admin.xhtml

@@ -1,37 +1,53 @@
 <!DOCTYPE html>
-#{Zen::Language.html_head}
+<html #{Zen::Language.html_text_direction} id="admin" class="#{browser_name}">
     <head>
         #{render_file(__DIR__('../view/head.xhtml'))}
     </head>
 
-    <body id="admin">
-        <div id="top">
-            <header class="container">
-                <nav id="main_nav" class="grid_12">
-                    #{Zen::Package.build_menu('left', session[:permissions])}
+    <body>
+        #{display_messages}
 
-                    <ul class="right clearfix">
-                        <li>
-                            <a href="/admin/users/logout">
-                                #{lang('zen_general.labels.logout')}
-                            </a>
-                        </li>
-                        <li>
-                            <a href="/admin/users/edit/#{user.id}">
-                                #{lang('zen_general.labels.profile')}
-                            </a>
-                        </li>
-                        <li>
-                            <a href="/">
-                                #{lang('zen_general.labels.view_website')}
-                            </a>
-                        </li>
-                    </ul>
-                </nav>
+        <aside id="sidebar" role="complementary">
+            <header>
+                <h1>
+                    <a href="/admin">
+                        #{get_setting(:website_name).value || 'Zen'}
+                    </a>
+                </h1>
             </header>
+
+            <nav id="user_navigation" role="navigation">
+                <ul>
+                    <li>
+                        <a href="/">
+                            #{lang('zen_general.labels.view_website')}
+                        </a>
+                    </li>
+                    <li>
+                        #{Users::Controller::Users.a(
+                          lang('zen_general.labels.profile'),
+                          :edit,
+                          user.id
+                        )}
+                    </li>
+                    <li>
+                        #{Users::Controller::Users.a(
+                          lang('zen_general.labels.logout'),
+                          :logout
+                        )}
+                    </li>
+                </ul>
+            </nav>
+
+            <nav id="admin_navigation" role="navigation">
+                #{Zen::Package.build_menu(nil, session[:permissions])}
+            </nav>
+        </aside>
+
+        <div id="main" role="main">
+            #{@content}
         </div>
 
-        #{render_file(__DIR__('../view/main.xhtml'))}
         #{render_file(__DIR__('../view/bottom.xhtml'))}
     </body>
 </html>

data/lib/zen/layout/login.xhtml

@@ -1,11 +1,16 @@
 <!DOCTYPE html>
-#{Zen::Language.html_head}
+<html #{Zen::Language.html_text_direction} id="login" class="#{browser_name}">
     <head>
         #{render_file(__DIR__('../view/head.xhtml'))}
     </head>
 
-    <body id="login">
-        #{render_file(__DIR__('../view/main.xhtml'))}
+    <body>
+        #{display_messages}
+
+        <div id="main" role="main">
+            #{@content}
+        </div>
+
         #{render_file(__DIR__('../view/bottom.xhtml'))}
     </body>
 </html>

data/lib/zen/migrator.rb

@@ -0,0 +1,54 @@
+module Zen
+  ##
+  # Small wrapper around Sequel::Migrator to fix various issues and make it a
+  # bit easier to log data.
+  #
+  # @since 07-01-2012
+  #
+  module Migrator
+    ##
+    # Runs a set of migrations and logs the actions.
+    #
+    # @since 07-01-2012
+    # @see   Sequel::Migrator.run
+    # @param [String] name The name of the package/theme/etc to migrate.
+    # @param [String] dir The directory containing the migrations.
+    # @param [String] table The name of the table to store the migrations in.
+    # @param [NilClass|Fixnum] target The target version to migrate to.
+    #
+    def self.run(name, dir, table, target = nil)
+      # Sequel 3.31.0 changed the way altering tables works, this causes some
+      # annoying issues to occur when using foreign keys in SQLite3. This can be
+      # fixed by turning off foreign keys while running the migrations.
+      #
+      # See this pastie for an example of this issue: http://pastie.org/3140474
+      if Zen.database.database_type == :sqlite
+        Ramaze::Log.debug('Turning off foreign keys for SQLite3')
+        Zen.database.execute('PRAGMA foreign_keys = OFF;')
+      end
+
+      Sequel::Migrator.run(
+        Zen.database,
+        dir,
+        :table  => table,
+        :target => target
+      )
+
+      if target.nil?
+        Ramaze::Log.info("Migrated #{name} to the latest version")
+      else
+        Ramaze::Log.info("Migrated #{name} to version #{target}")
+      end
+
+      if target == 0
+        Ramaze::Log.info("Dropping table #{table}")
+        Zen.database.drop_table(table)
+      end
+
+      if Zen.database.database_type == :sqlite
+        Ramaze::Log.debug('Turning foreign keys on again')
+        Zen.database.execute('PRAGMA foreign_keys = ON;')
+      end
+    end
+  end # Migrator
+end # Zen

data/lib/zen/model/helper.rb

@@ -28,6 +28,25 @@ module Zen
         into.extend(ClassMethods)
       end
 
+      ##
+      # Sanitizes the given fields.
+      #
+      # @example
+      #  sanitize_fields([:name, :description])
+      #
+      # @since 03-01-2012
+      # @param [Array] fields An array containing all the fields to sanitize.
+      # @param [TrueClass|FalseClass] clean_html When set to true Loofah will be
+      #  used to get rid of nasty HTML.
+      #
+      def sanitize_fields(fields, clean_html = false)
+        fields.each do |field|
+          got = send(field)
+
+          send("#{field}=", Zen::Security.sanitize(got, clean_html)) unless got.nil?
+        end
+      end
+
       # The methods in this module will be added as class methods to the
       # including class.
       module ClassMethods
@@ -53,7 +72,7 @@ module Zen
         # @return [Hash|Sequel::SQL::BooleanExpression]
         #
         def search_column(column, value)
-          if NoRegexpSupport.include?(Zen.database.adapter_scheme)
+          if NoRegexpSupport.include?(Zen.database.database_type)
             return column.like("%#{value}%")
           else
             return {column => /#{value}/i}

data/lib/zen/model/init.rb

@@ -1,5 +1,7 @@
 Zen::Language.load('zen_models')
 
+Sequel::Model.strict_param_setting = false
+
 Sequel::Model.plugin(:validation_helpers)
 Sequel::Model.plugin(:association_pks)
 

data/lib/zen/model/plugin/events.rb

@@ -0,0 +1,158 @@
+module Sequel
+  module Plugins
+    ##
+    # Plugin for Sequel that acts as a bridge between Sequel hooks and events
+    # fired by {Zen::Event}. Based on the specified options it creates events
+    # for the following Sequel hooks:
+    #
+    # * before_create
+    # * after_create
+    # * before_update
+    # * after_update
+    # * before_destroy
+    # * after_destroy
+    #
+    # For example, to add the Zen event "before_new_post" and have it called by
+    # the Sequel hook "before_create" you'd do the following:
+    #
+    #  class Posts < Sequel::Model
+    #    plugin :events, :before_create => :before_new_post
+    #  end
+    #
+    # Each event will receive an instance of the model. This means that you're
+    # free to modify the model in your events as long as you take into account
+    # that other events might do the same:
+    #
+    #     Zen::Event.listen(:before_new_post) do |post|
+    #       post.title = 'a'
+    #     end
+    #
+    # Events don't have to return the modified object as objects are assigned by
+    # reference.
+    #
+    # @since 05-02-2012
+    #
+    module Events
+      ##
+      # Configures the plugin for a single model.
+      #
+      # @since 06-02-2012
+      # @param [Class] model The model for which to enable the plugin.
+      # @param [Hash] options A hash containing the Sequel hook names and the
+      #  Zen events to fire.
+      # @option options [Symbol] :before_create The name of the event to call in
+      #  the before_create hook.
+      # @option options [Symbol] :after_create The name of the event to call in
+      #  the after_create hook.
+      # @option options [Symbol] :before_update The name of the event to call in
+      #  the before_update hook.
+      # @option options [Symbol] :after_update The name of the event to call in
+      #  the after_update hook.
+      # @option options [Symbol] :before_destroy The name of the event to call
+      #  in the before_destroy hook.
+      # @option options [Symbol] :after_destroy The name of the event to call in
+      #  the after_destroy hook.
+      #
+      def self.configure(model, options = {})
+        model.events = options
+      end
+
+      ##
+      # Module containing the methods and attributes to make available on class
+      # level.
+      #
+      # @since 06-02-2012
+      #
+      module ClassMethods
+        # Hash containing all the Sequel hooks and the corresponding Zen events.
+        attr_accessor :events
+      end
+
+      ##
+      # Module containing the methods and attributes to make available on
+      # instance leve.
+      #
+      # @since 06-02-2012
+      #
+      module InstanceMethods
+        ##
+        # Hook executed before creating a new object.
+        #
+        # @since 06-02-2012
+        #
+        def before_create
+          if self.class.events and self.class.events.key?(:before_create)
+            Zen::Event.call(self.class.events[:before_create], self)
+          end
+
+          super
+        end
+
+        ##
+        # Hook executed after creating a new object.
+        #
+        # @since 06-02-2012
+        #
+        def after_create
+          super
+
+          if self.class.events and self.class.events.key?(:after_create)
+            Zen::Event.call(self.class.events[:after_create], self)
+          end
+        end
+
+        ##
+        # Hook executed before updating an existing object.
+        #
+        # @since 06-02-2012
+        #
+        def before_update
+          if self.class.events and self.class.events.key?(:before_update)
+            Zen::Event.call(self.class.events[:before_update], self)
+          end
+
+          super
+        end
+
+        ##
+        # Hook executed after updating an existing object.
+        #
+        # @since 06-02-2012
+        #
+        def after_update
+          super
+
+          if self.class.events and self.class.events.key?(:after_update)
+            Zen::Event.call(self.class.events[:after_update], self)
+          end
+        end
+
+        ##
+        # Hook executed before removing an existing object.
+        #
+        # @since 06-02-2012
+        #
+        def before_destroy
+          if self.class.events and self.class.events.key?(:before_destroy)
+            Zen::Event.call(self.class.events[:before_destroy], self)
+          end
+
+          super
+        end
+
+        ##
+        # Hook executed after removing an existing object.
+        #
+        # @since 06-02-2012
+        #
+        def after_destroy
+          super
+
+          if self.class.events and self.class.events.key?(:after_destroy)
+            Zen::Event.call(self.class.events[:after_destroy], self)
+          end
+        end
+      end # InstanceMethods
+    end # Events
+  end # Plugins
+end # Sequel