zen 0.4.2 → 0.4.3

data/lib/zen/helper/stacked_aspect.rb

@@ -37,7 +37,7 @@ module Ramaze
     # In this example both methods (``validate_ip`` and ``validate_user``) would
     # be executed before calling ``#index()``.
     #
-    # @since 06-11-2011
+    # @since 2011-11-06
     #
     module StackedAspect
       # Hash that will contain all the STACKED_AOP actions.
@@ -46,7 +46,7 @@ module Ramaze
       ##
       # Called whenever this module is included into a class.
       #
-      # @since 06-11-2011
+      # @since 2011-11-06
       # @param [Class] into The class that included this module.
       #
       def self.included(into)
@@ -68,7 +68,7 @@ module Ramaze
       ##
       # Calls a certain AOP action for the specified position and method name.
       #
-      # @since 06-11-2011
+      # @since 2011-11-06
       # @param [Symbol] position The position of the AOP action (e.g. :after).
       # @param [String] name The name of the method for which to call the
       #  action.
@@ -118,7 +118,7 @@ module Ramaze
       ##
       # Module who's methods become available as class methods.
       #
-      # @since 06-11-2011
+      # @since 2011-11-06
       #
       module ClassMethods
         include Traited
@@ -135,7 +135,7 @@ module Ramaze
         #    validate_username
         #  end
         #
-        # @since 06-11-2011
+        # @since 2011-11-06
         # @param [#to_sym] name The unique name of the block.
         # @param [Proc] block The block to execute.
         #
@@ -153,7 +153,7 @@ module Ramaze
         #    validate_ip
         #  end
         #
-        # @since 06-11-2011
+        # @since 2011-11-06
         # @param [#to_sym] name A unique name for the block.
         # @param [Array] methods An array of methods for which to run the block.
         # @param [Proc] block The block to run.
@@ -172,7 +172,7 @@ module Ramaze
         ##
         # Runs a block after all the actions in a controller.
         #
-        # @since 06-11-2011
+        # @since 2011-11-06
         # @see   Ramaze::Helper::StackedAspect::ClassMethods#stacked_before_all
         #
         def stacked_after_all(name, &block)
@@ -182,7 +182,7 @@ module Ramaze
         ##
         # Runs a block after a specific list of methods.
         #
-        # @since 06-11-2011
+        # @since 2011-11-06
         # @see   Ramaze::Helper::StackedAspect::ClassMethods#stacked_before
         #
         def stacked_after(name, names, &block)
@@ -199,7 +199,7 @@ module Ramaze
         ##
         # Wraps the block around the list of methods.
         #
-        # @since 06-11-2011
+        # @since 2011-11-06
         # @see   Ramaze::Helper::StackedAspect::ClassMethods#stacked_before
         # @see   Ramaze::Helper::StackedAspect::ClassMethods#stacked_after
         #

data/lib/zen/html_diff.rb

@@ -0,0 +1,151 @@
+module Zen
+  ##
+  # Module for generating HTML diffs using Diff::LCS and a custom callback
+  # class. See {Zen::HTMLDiff.diff} and {Zen::HTMLDiff::Callback} for more
+  # information on the usage and the returned HTML.
+  #
+  # @since 2012-05-02
+  #
+  module HTMLDiff
+    ##
+    # Gets the difference between the two given strings and returns a string
+    # containing these differences formatted using HTML.
+    #
+    # @example
+    #  old  = 'hello world'
+    #  new  = 'Hello, world!'
+    #  diff = Zen::HTMLDiff.diff(old, new)
+    #
+    #  puts diff # => "<div class=\"diff\">...</div>"
+    #
+    # @since  2012-05-02
+    # @param  [String] old The old version of the string.
+    # @param  [String] new The new version of the string.
+    # @return [String]
+    #
+    def self.diff(old, new)
+      callback = Callback.new
+
+      old = old.join("\n") if old.is_a?(Array)
+      new = new.join("\n") if new.is_a?(Array)
+
+      Diff::LCS.traverse_sequences(
+        old.to_s.split(/\r\n|\n/),
+        new.to_s.split(/\r\n|\n/),
+        callback
+      )
+
+      return callback.to_s
+    end
+
+    ##
+    # Callback class for Diff::LCS that is used to format a diff using HTML. An
+    # example of the resulting markup is the following:
+    #
+    #     <div class="diff">
+    #         <table>
+    #             <tbody>
+    #                 <tr>
+    #                     <td class="line">1</td>
+    #                     <td class="line"></td>
+    #                     <td class="line del">-Hello world</td>
+    #                 </tr>
+    #                 <tr>
+    #                     <td class="line"></td>
+    #                     <td class="line">1</td>
+    #                     <td class="line ins">+Hello World</td>
+    #                 </tr>
+    #             </tbody>
+    #         </table>
+    #     </div>
+    #
+    # Example usage:
+    #
+    #     old      = '...'
+    #     new      = '...'
+    #     callback Zen::HTMLDiff::Callback.new
+    #
+    #     Diff::LCS.traverse_sequence(old, new, callback)
+    #
+    #     puts callback # => "<div class=...>"
+    #
+    # @since 2012-05-02
+    #
+    class Callback
+      ##
+      # Creates a new instance of the callback class.
+      #
+      # @since 2012-05-02
+      #
+      def initialize
+        @output = ''
+      end
+
+      ##
+      # Called when there's a line in A but not in B.
+      #
+      # @since 2012-05-02
+      # @param [Diff::LCS::ContextChange] change
+      #
+      def discard_a(change)
+        @output << %Q{
+        <tr>
+            <td class="line_number">#{change.old_position + 1}</td>
+            <td class="line_number"></td>
+            <td class="line del">-#{change.old_element}</td>
+        </tr>
+        }
+      end
+
+      ##
+      # Called when there's a line in B but not in A.
+      #
+      # @since 2012-05-02
+      # @param [Diff::LCS::ContextChange] change
+      #
+      def discard_b(change)
+        @output << %Q{
+        <tr>
+            <td class="line_number"></td>
+            <td class="line_number">#{change.new_position + 1}</td>
+            <td class="line ins">+#{change.new_element}</td>
+        </tr>
+        }
+      end
+
+      ##
+      # Called when both lines are identical.
+      #
+      # @since 2012-05-02
+      # @param [Diff::LCS::ContextChange] change
+      #
+      def match(change)
+        @output << %Q{
+        <tr>
+            <td class="line_number">#{change.old_position + 1}</td>
+            <td class="line_number">#{change.new_position + 1}</td>
+            <td class="line"> #{change.old_element}</td>
+        </tr>
+        }
+      end
+
+      ##
+      # Returns the full HTML for the diff.
+      #
+      # @since  2012-05-02
+      # @return [String]
+      #
+      def to_s
+        return %Q{
+        <div class="diff">
+            <table class="no_sort">
+                <tbody>
+                    #{@output}
+                </tbody>
+            </table>
+        </div>
+        }
+      end
+    end # Callback
+  end # HTMLDiff
+end # Zen

data/lib/zen/language.rb

@@ -178,6 +178,7 @@ module Zen
   #
   # <div class="note todo">
   #     <p>
+  #         <strong>Note:</strong>
   #         This can't be stressed enough: always load language files using the
   #         post_start event.
   #     </p>
@@ -206,6 +207,7 @@ module Zen
   #
   # <div class="note todo">
   #     <p>
+  #         <strong>Note:</strong>
   #         Because language files aren't loaded until Zen.start is called you
   #         should never use or rely on translations before the application has
   #         started. Most of the core code works around this by loading
@@ -263,7 +265,7 @@ module Zen
       #    lang.rtl   = true
       #  end
       #
-      # @since 14-11-2011
+      # @since 2011-11-14
       # @yield Zen::Language
       #
       def add
@@ -362,7 +364,7 @@ module Zen
       # Returns a hash where the keys are the language codes and the values the
       # titles.
       #
-      # @since  14-11-2011
+      # @since  2011-11-14
       # @return [Hash]
       #
       def to_hash
@@ -377,7 +379,7 @@ module Zen
       # Returns a string containing the text direction if the current language
       # is an rtl language.
       #
-      # @since  14-11-2011
+      # @since  2011-11-14
       # @return [String]
       #
       def html_text_direction
@@ -390,7 +392,7 @@ module Zen
     ##
     # Creates a new instance of the class.
     #
-    # @since 14-11-2011
+    # @since 2011-11-14
     #
     def initialize
       @loaded      = []
@@ -400,7 +402,7 @@ module Zen
     ##
     # Sets the name of the language and converts it to a string.
     #
-    # @since 14-11-2011
+    # @since 2011-11-14
     # @param [#to_s] name The name of the language.
     #
     def name=(name)
@@ -411,7 +413,7 @@ module Zen
     # Returns a boolean that indicates whether or not the language reads from
     # right to left.
     #
-    # @since  14-11-2011
+    # @since  2011-11-14
     # @return [TrueClass|FalseClass]
     #
     def rtl
@@ -421,7 +423,7 @@ module Zen
     ##
     # Validates the current instance using {Zen::Validation}.
     #
-    # @since 14-11-2011
+    # @since 2011-11-14
     #
     def validate
       validates_presence([:name, :title])

data/lib/zen/language/translation.rb

@@ -17,7 +17,7 @@ module Zen
     #
     # For more general and expanded information see {Zen::Language}.
     #
-    # @since 16-11-2011
+    # @since 2011-11-16
     #
     class Translation
       include Zen::Validation
@@ -37,7 +37,7 @@ module Zen
       ##
       # Adds a new translation set.
       #
-      # @since 16-11-2011
+      # @since 2011-11-16
       # @yield Zen::Language::Translation
       #
       def self.add
@@ -53,7 +53,7 @@ module Zen
       ##
       # Sets the language for the collection of translations.
       #
-      # @since 16-11-2011
+      # @since 2011-11-16
       # @param [#to_s] language The language code.
       # @raise Zen::ValidationError Raised whenever a given language is invalid.
       #
@@ -65,7 +65,7 @@ module Zen
       # Stores the supplied block containing all translations in
       # ``@translations``.
       #
-      # @since 17-11-2011
+      # @since 2011-11-17
       # @param [Proc] block A block containing all calls to ``#[]=()``.
       #
       def translate(&block)
@@ -76,7 +76,7 @@ module Zen
       # Loads the translations by invoking the block that was set using
       # {#translate}.
       #
-      # @since 17-11-2011
+      # @since 2011-11-17
       #
       def load
         @translations.call(self)
@@ -85,7 +85,7 @@ module Zen
       ##
       # Sets the name of the collection of translations.
       #
-      # @since 16-11-2011
+      # @since 2011-11-16
       # @param [#to_s] name The name of the collection.
       #
       def name=(name)
@@ -96,7 +96,7 @@ module Zen
       # Adds a new translation by directly storing it in the cache
       # ``Ramaze::Cache.translations``.
       #
-      # @since 16-11-2011
+      # @since 2011-11-16
       # @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.
@@ -115,7 +115,7 @@ module Zen
       ##
       # Validates the instance.
       #
-      # @since 17-11-2011
+      # @since 2011-11-17
       #
       def validate
         validates_presence([:name, :name, :translations])

data/lib/zen/markup.rb

@@ -97,7 +97,7 @@ module Zen
       # Returns a hash containing the available markup engines and their labels
       # for the current language.
       #
-      # @since  15-11-2011
+      # @since  2011-11-15
       # @return [Hash]
       #
       def to_hash

data/lib/zen/migrator.rb

@@ -3,13 +3,13 @@ module Zen
   # Small wrapper around Sequel::Migrator to fix various issues and make it a
   # bit easier to log data.
   #
-  # @since 07-01-2012
+  # @since 2012-01-07
   #
   module Migrator
     ##
     # Runs a set of migrations and logs the actions.
     #
-    # @since 07-01-2012
+    # @since 2012-01-07
     # @see   Sequel::Migrator.run
     # @param [String] name The name of the package/theme/etc to migrate.
     # @param [String] dir The directory containing the migrations.

data/lib/zen/model/helper.rb

@@ -11,7 +11,7 @@ module Zen
     #
     # See the individual methods in this module for more information.
     #
-    # @since  16-10-2011
+    # @since  2011-10-16
     #
     module Helper
       # Array containing the database adapters that don't support regular
@@ -22,7 +22,7 @@ module Zen
       # Extends the including class with the methods in the {ClassMethods}
       # module.
       #
-      # @since  16-10-2011
+      # @since  2011-10-16
       #
       def self.included(into)
         into.extend(ClassMethods)
@@ -34,7 +34,7 @@ module Zen
       # @example
       #  sanitize_fields([:name, :description])
       #
-      # @since 03-01-2012
+      # @since 2012-01-03
       # @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.
@@ -66,7 +66,7 @@ module Zen
         # @example Using a DBMS that does not support the use of a regex
         #  search_column(:name, 'ruby \d+') # => #<Sequel::SQL::BooleanExpression ....>
         #
-        # @since  16-10-2011
+        # @since  2011-10-16
         # @param  [Symbol] column The column to use in the statement.
         # @param  [String] value The value for the statement.
         # @return [Hash|Sequel::SQL::BooleanExpression]

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

@@ -5,12 +5,12 @@ module Sequel
     # 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
+    # * 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:
@@ -30,13 +30,13 @@ module Sequel
     # Events don't have to return the modified object as objects are assigned by
     # reference.
     #
-    # @since 05-02-2012
+    # @since 2012-02-05
     #
     module Events
       ##
       # Configures the plugin for a single model.
       #
-      # @since 06-02-2012
+      # @since 2012-02-06
       # @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.
@@ -61,7 +61,7 @@ module Sequel
       # Module containing the methods and attributes to make available on class
       # level.
       #
-      # @since 06-02-2012
+      # @since 2012-02-06
       #
       module ClassMethods
         # Hash containing all the Sequel hooks and the corresponding Zen events.
@@ -72,13 +72,13 @@ module Sequel
       # Module containing the methods and attributes to make available on
       # instance level.
       #
-      # @since 06-02-2012
+      # @since 2012-02-06
       #
       module InstanceMethods
         ##
         # Hook executed before creating a new object.
         #
-        # @since 06-02-2012
+        # @since 2012-02-06
         #
         def before_create
           if self.class.events and self.class.events.key?(:before_create)
@@ -91,7 +91,7 @@ module Sequel
         ##
         # Hook executed after creating a new object.
         #
-        # @since 06-02-2012
+        # @since 2012-02-06
         #
         def after_create
           super
@@ -104,7 +104,7 @@ module Sequel
         ##
         # Hook executed before updating an existing object.
         #
-        # @since 06-02-2012
+        # @since 2012-02-06
         #
         def before_update
           if self.class.events and self.class.events.key?(:before_update)
@@ -117,7 +117,7 @@ module Sequel
         ##
         # Hook executed after updating an existing object.
         #
-        # @since 06-02-2012
+        # @since 2012-02-06
         #
         def after_update
           super
@@ -130,7 +130,7 @@ module Sequel
         ##
         # Hook executed before removing an existing object.
         #
-        # @since 06-02-2012
+        # @since 2012-02-06
         #
         def before_destroy
           if self.class.events and self.class.events.key?(:before_destroy)
@@ -143,7 +143,7 @@ module Sequel
         ##
         # Hook executed after removing an existing object.
         #
-        # @since 06-02-2012
+        # @since 2012-02-06
         #
         def after_destroy
           super