remarkable 3.1.8 → 3.1.9

data/lib/remarkable/dsl/callbacks.rb

@@ -1,13 +1,13 @@
-module Remarkable
-  module DSL
-    module Callbacks
-
-      def self.included(base) #:nodoc:
-        base.extend ClassMethods
-      end
-
-      module ClassMethods
-        protected
+module Remarkable
+  module DSL
+    module Callbacks
+
+      def self.included(base) #:nodoc:
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        protected
           # Class method that accepts a block or a symbol which is called after
           # initialization.
           #
@@ -18,15 +18,15 @@ module Remarkable
           #   after_initialize do
           #     # code
           #   end
-          #
-          def after_initialize(*symbols, &block)
-            if block_given?
-              @after_initialize_callbacks << block
-            else
-              @after_initialize_callbacks += symbols
-            end
-          end
-
+          #
+          def after_initialize(*symbols, &block)
+            if block_given?
+              @after_initialize_callbacks << block
+            else
+              @after_initialize_callbacks += symbols
+            end
+          end
+
           # Class method that accepts a block or a symbol which is called before
           # running assertions.
           #
@@ -37,36 +37,36 @@ module Remarkable
           #   before_assert do
           #     # code
           #   end
-          #
-          def before_assert(*symbols, &block)
-            if block_given?
-              @before_assert_callbacks << block
-            else
-              @before_assert_callbacks += symbols
-            end
-          end
-      end
-
-      def run_after_initialize_callbacks #:nodoc:
-        self.class.after_initialize_callbacks.each do |method|
-          if method.is_a?(Proc)
-            instance_eval &method
-          elsif method.is_a?(Symbol)
-            send(method)
-          end
-        end
-      end
-
-      def run_before_assert_callbacks #:nodoc:
-        self.class.before_assert_callbacks.each do |method|
-          if method.is_a?(Proc)
-            instance_eval &method
-          elsif method.is_a?(Symbol)
-            send(method)
-          end
-        end
-      end
-
-    end
-  end
-end
+          #
+          def before_assert(*symbols, &block)
+            if block_given?
+              @before_assert_callbacks << block
+            else
+              @before_assert_callbacks += symbols
+            end
+          end
+      end
+
+      def run_after_initialize_callbacks #:nodoc:
+        self.class.after_initialize_callbacks.each do |method|
+          if method.is_a?(Proc)
+            instance_eval &method
+          elsif method.is_a?(Symbol)
+            send(method)
+          end
+        end
+      end
+
+      def run_before_assert_callbacks #:nodoc:
+        self.class.before_assert_callbacks.each do |method|
+          if method.is_a?(Proc)
+            instance_eval &method
+          elsif method.is_a?(Symbol)
+            send(method)
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/remarkable/dsl/optionals.rb

@@ -1,13 +1,13 @@
-module Remarkable
+module Remarkable
   module DSL
     # This module is responsable for create optional handlers and providing macro
     # configration blocks. Consider the matcher below:
     #
-    #   class AllowValuesForMatcher < Remarkable::ActiveRecord::Base
-    #     arguments :collection => :attributes, :as => :attribute
-    #
+    #   class AllowValuesForMatcher < Remarkable::ActiveRecord::Base
+    #     arguments :collection => :attributes, :as => :attribute
+    #
     #     optional :message
-    #     optional :in, :splat => true
+    #     optional :in, :splat => true
     #     optional :allow_nil, :allow_blank, :default => true
     #   end
     #
@@ -44,31 +44,31 @@ module Remarkable
     #
     # == I18n
     #
-    # Optionals will be included in description messages if you assign them
-    # properly on your locale file. If you have a validate_uniqueness_of
-    # matcher with the following on your locale file:
-    #
-    #   description: validate uniqueness of {{attributes}}
-    #   optionals:
-    #     scope:
-    #       positive: scoped to {{inspect}}
-    #     case_sensitive:
-    #       positive: case sensitive
-    #       negative: case insensitive
-    #
-    # When invoked like below will generate the following messages:
-    #
-    #   validate_uniqueness_of :project_id, :scope => :company_id
-    #   #=> "validate uniqueness of project_id scoped to :company_id"
-    #
-    #   validate_uniqueness_of :project_id, :scope => :company_id, :case_sensitive => true
-    #   #=> "validate uniqueness of project_id scoped to :company_id and case sensitive"
-    #
-    #   validate_uniqueness_of :project_id, :scope => :company_id, :case_sensitive => false
-    #   #=> "validate uniqueness of project_id scoped to :company_id and case insensitive"
+    # Optionals will be included in description messages if you assign them
+    # properly on your locale file. If you have a validate_uniqueness_of
+    # matcher with the following on your locale file:
+    #
+    #   description: validate uniqueness of {{attributes}}
+    #   optionals:
+    #     scope:
+    #       positive: scoped to {{inspect}}
+    #     case_sensitive:
+    #       positive: case sensitive
+    #       negative: case insensitive
+    #
+    # When invoked like below will generate the following messages:
+    #
+    #   validate_uniqueness_of :project_id, :scope => :company_id
+    #   #=> "validate uniqueness of project_id scoped to :company_id"
+    #
+    #   validate_uniqueness_of :project_id, :scope => :company_id, :case_sensitive => true
+    #   #=> "validate uniqueness of project_id scoped to :company_id and case sensitive"
+    #
+    #   validate_uniqueness_of :project_id, :scope => :company_id, :case_sensitive => false
+    #   #=> "validate uniqueness of project_id scoped to :company_id and case insensitive"
     #
     # == Interpolation options
-    #
+    #
     # The default interpolation options available are "inspect" and "value". Whenever
     # you use :splat => true, it also adds a new interpolation option called {{sentence}}.
     #
@@ -87,50 +87,50 @@ module Remarkable
     #
     #      positive: scoped to {{value}}
     #      # Outputs: "validate uniqueness of project_id scoped to company_id and project_id"
-    #
-    # == Interpolation keys
+    #
+    # == Interpolation keys
     #
     # Three keys are available to be used in I18n files and control how optionals
-    # are appended to your description:
-    #
-    #   * <tt>positive</tt> - When the optional is given and it evaluates to true (everything but false and nil).
-    #   * <tt>negative</tt> - When the optional is given and it evaluates to false (false or nil).
-    #   * <tt>not_given</tt> - When the optional is not given.
-    #
-    module Optionals
-
-      OPTIONAL_KEYS = [ :positive, :negative, :not_given ]
-
-      def self.included(base) #:nodoc:
-        base.extend ClassMethods
-      end
-
-      module ClassMethods
-
-        protected
-
-          # Creates optional handlers for matchers dynamically.
-          #
-          # == Options
-          #
-          # * <tt>:default</tt> - The default value for this optional
-          # * <tt>:alias</tt>  - An alias for this optional
+    # are appended to your description:
+    #
+    #   * <tt>positive</tt> - When the optional is given and it evaluates to true (everything but false and nil).
+    #   * <tt>negative</tt> - When the optional is given and it evaluates to false (false or nil).
+    #   * <tt>not_given</tt> - When the optional is not given.
+    #
+    module Optionals
+
+      OPTIONAL_KEYS = [ :positive, :negative, :not_given ]
+
+      def self.included(base) #:nodoc:
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+
+        protected
+
+          # Creates optional handlers for matchers dynamically.
+          #
+          # == Options
+          #
+          # * <tt>:default</tt> - The default value for this optional
+          # * <tt>:alias</tt>  - An alias for this optional
           # * <tt>:splat</tt>  - Should be true if you expects multiple arguments
-          # * <tt>:block</tt>  - Tell this optional can also receive blocks
-          #
-          # == Examples
-          #
-          #   class AllowValuesForMatcher < Remarkable::ActiveRecord::Base
-          #     arguments :collection => :attributes, :as => :attribute
-          #
+          # * <tt>:block</tt>  - Tell this optional can also receive blocks
+          #
+          # == Examples
+          #
+          #   class AllowValuesForMatcher < Remarkable::ActiveRecord::Base
+          #     arguments :collection => :attributes, :as => :attribute
+          #
           #     optional :message
-          #     optional :in, :splat => true
+          #     optional :in, :splat => true
           #     optional :allow_nil, :allow_blank, :default => true
           #   end
-          #
-          def optionals(*names)
+          #
+          def optionals(*names)
             options = names.extract_options!
-
+
             @matcher_optionals += names
             default = options[:default] ? "=#{options[:default].inspect}" : nil
 
@@ -140,71 +140,71 @@ module Remarkable
               ', &block'
             else
               nil
-            end
-
+            end
+
             splat = if options[:splat]
               @matcher_optionals_splat += names
               '*'
             else
               nil
             end
-
-            names.each do |name|
-              class_eval <<-END, __FILE__, __LINE__
-                def #{name}(#{splat}value#{default}#{block})
+
+            names.each do |name|
+              class_eval <<-END, __FILE__, __LINE__
+                def #{name}(#{splat}value#{default}#{block})
                   @options ||= {}
-                  #{"@options[:#{name}] ||= []" if splat}
-                  @options[:#{name}] #{:+ if splat}= #{"block ||" if block} value
-                  self
+                  #{"@options[:#{name}] ||= []" if splat}
+                  @options[:#{name}] #{:+ if splat}= #{"block ||" if block} value
+                  self
                 end
                 def #{name}=(value)
                   @options ||= {}
-                  @options[:#{name}] = value
+                  @options[:#{name}] = value
                   self
-                end
-              END
+                end
+              END
             end
-
+
             class_eval %{
               alias :#{options[:alias]} :#{names.last}
               alias :#{options[:alias]}= :#{names.last}=
-            } if options[:alias]
-
-            # Call unique to avoid duplicate optionals.
-            @matcher_optionals.uniq!
-          end
-          alias :optional :optionals
-
-          # Instead of appending, prepend optionals to the beginning of optionals
+            } if options[:alias]
+
+            # Call unique to avoid duplicate optionals.
+            @matcher_optionals.uniq!
+          end
+          alias :optional :optionals
+
+          # Instead of appending, prepend optionals to the beginning of optionals
           # array. This is important because the optionals declaration order 
-          # changes how the description message is generated.
-          #
-          def prepend_optionals(*names)
-            current_optionals  = @matcher_optionals.dup
-            @matcher_optionals = []
-            optional(*names)
-            @matcher_optionals += current_optionals
-            @matcher_optionals.uniq!
-          end
-          alias :prepend_optional :prepend_optionals
-
-      end
-
-      # Overwrites description to support optionals. Check <tt>optional</tt> for
-      # more information.
-      #
-      def description(options={}) #:nodoc:
-        message = super(options)
-        message.strip!
-
-        optionals = self.class.matcher_optionals.map do |optional|
-          if @options.key?(optional)
+          # changes how the description message is generated.
+          #
+          def prepend_optionals(*names)
+            current_optionals  = @matcher_optionals.dup
+            @matcher_optionals = []
+            optional(*names)
+            @matcher_optionals += current_optionals
+            @matcher_optionals.uniq!
+          end
+          alias :prepend_optional :prepend_optionals
+
+      end
+
+      # Overwrites description to support optionals. Check <tt>optional</tt> for
+      # more information.
+      #
+      def description(options={}) #:nodoc:
+        message = super(options)
+        message.strip!
+
+        optionals = self.class.matcher_optionals.map do |optional|
+          if @options.key?(optional)
             value = @options[optional]
-
+
             defaults = [ (value ? :positive : :negative) ]
-            # If optional is a symbol and it's not any to any of the reserved symbols, search for it also
+            # If optional is a symbol and it's not any to any of the reserved symbols, search for it also
             defaults.unshift(value) if value.is_a?(Symbol) && !OPTIONAL_KEYS.include?(value)
-            defaults << ''
+            defaults << ''
 
             options = { :default => defaults, :inspect => value.inspect, :value => value.to_s }
 
@@ -216,12 +216,12 @@ module Remarkable
             translate_optionals_with_namespace(optional, defaults.shift, options)
           else
             translate_optionals_with_namespace(optional, :not_given, :default => '')
-          end
-        end.compact
-
-        message << ' ' << array_to_sentence(optionals)
-        message.strip!
-        message
+          end
+        end.compact
+
+        message << ' ' << array_to_sentence(optionals)
+        message.strip!
+        message
       end
 
       def translate_optionals_with_namespace(optional, key, options={}) #:nodoc:
@@ -236,8 +236,8 @@ module Remarkable
         return translation unless translation.empty?
 
         nil
-      end
-
-    end
-  end
-end
+      end
+
+    end
+  end
+end

data/lib/remarkable/i18n.rb

@@ -4,74 +4,74 @@ module Remarkable
   # Remarkable shouldn't rely on I18n default locale, because it might change
   # throughout tests. So it's Remarkable responsibility to hold its own locale
   # and send it to I18n.
-  #
-  module I18n
-
+  #
+  module I18n
+
     # Add locale files to I18n and to load path, if it exists.
     #
     # == Examples
     #
     #   Remarkable.add_locale "path/to/locale"
-    #
-    def add_locale(*locales)
-      ::I18n.backend.load_translations *locales
-      ::I18n.load_path += locales if ::I18n.respond_to?(:load_path)
-    end
-
+    #
+    def add_locale(*locales)
+      ::I18n.backend.load_translations *locales
+      ::I18n.load_path += locales if ::I18n.respond_to?(:load_path)
+    end
+
     # Set Remarkable own locale.
     #
     # == Examples
     #
     #   Remarkable.locale = :en
-    #
-    def locale=(locale)
-      @@locale = locale
-    end
-
+    #
+    def locale=(locale)
+      @@locale = locale
+    end
+
     # Get Remarkable own locale.
     #
     # == Examples
     #
     #   Remarkable.locale = :en
     #   Remarkable.locale #=> :en
-    #
-    def locale
-      @@locale
-    end
-
+    #
+    def locale
+      @@locale
+    end
+
     # Wrapper for I18n.translate
-    #
-    def translate(string, options = {})
-      ::I18n.translate string, { :locale => @@locale }.merge(options)
-    end
-    alias :t :translate
-
+    #
+    def translate(string, options = {})
+      ::I18n.translate string, { :locale => @@locale }.merge(options)
+    end
+    alias :t :translate
+
     # Wrapper for I18n.localize
-    #
-    def localize(object, options = {})
-      ::I18n.localize object, { :locale => @@locale }.merge(options)
-    end
-    alias :l :localize
-
-  end
-end
-
-# Load I18n
-RAILS_I18N = Object.const_defined?(:I18n) unless Object.const_defined?(:RAILS_I18N) # Rails >= 2.2
-
-unless RAILS_I18N
-  begin
-    require 'i18n'
-  rescue LoadError
-    require 'rubygems'
-    # TODO Move to i18n gem as soon as it gets updated
-    gem 'svenfuchs-i18n'
-    require 'i18n'
-  end
-
-  # Set default locale
-  ::I18n.default_locale = :en
-end
-
-Remarkable.extend Remarkable::I18n
-Remarkable.locale = :en
+    #
+    def localize(object, options = {})
+      ::I18n.localize object, { :locale => @@locale }.merge(options)
+    end
+    alias :l :localize
+
+  end
+end
+
+# Load I18n
+RAILS_I18N = Object.const_defined?(:I18n) unless Object.const_defined?(:RAILS_I18N) # Rails >= 2.2
+
+unless RAILS_I18N
+  begin
+    require 'i18n'
+  rescue LoadError
+    require 'rubygems'
+    # TODO Move to i18n gem as soon as it gets updated
+    gem 'svenfuchs-i18n'
+    require 'i18n'
+  end
+
+  # Set default locale
+  ::I18n.default_locale = :en
+end
+
+Remarkable.extend Remarkable::I18n
+Remarkable.locale = :en