motr 0.0.1 → 0.0.2

data/Gemfile

@@ -7,5 +7,7 @@ gem "rspec-rails"
 gem "mocha","0.9.12"
 
 group :test do
+  gem 'fabrication', '0.9.5'
+  gem 'ffaker', '1.5.0'
   gem 'spork', '~> 0.9.0.rc'
 end

data/app/helpers/motr_helper.rb

@@ -2,6 +2,7 @@ module MotrHelper #:nodoc:
 
   include Motr::Helpers::LayoutHelpers
   include Motr::Helpers::Navigation
-  include Motr::Forms::Helpers
+  include Motr::Helpers::Elements
+  include Motr::Forms::Helpers  
   
 end

data/lib/motr.rb

@@ -7,6 +7,7 @@ module Motr
   module Helpers
     autoload :LayoutHelpers, 'motr/helpers/layout_helpers'
     autoload :Navigation,    'motr/helpers/navigation'
+    autoload :Elements,      'motr/helpers/elements'
   end
   
   module Errors

data/lib/motr/errors/motr_error.rb

@@ -1,12 +1,14 @@
-module Motr #:nodoc
-  module Errors #:nodoc
+module Motr
+  module Errors
 
     # Default parent Motr error for all custom errors. This handles the base
     # key for the translations and provides the convenience method for
     # translating the messages.
+    # 
     class MotrError < StandardError
       BASE_KEY = "motr.errors"
-      ##
+      
+      # ##
       # Translate an error message
       # @param [String] key The i18n message key
       # @param [Hash] options Options to pass to the i18n library

data/lib/motr/forms.rb

@@ -26,6 +26,27 @@ module Motr
     mattr_accessor :default_builder
     @@default_builder = Motr::Forms::Builder
     
+    # Stub out a new default_error_proc, but create the option to override it if necessary
+    mattr_accessor :field_error_proc
+    @@field_error_proc = lambda{ |html_tag, instance_tag| html_tag }
+    
+    protected
+    
+    ##
+    # 
+    # Wrapper method to override the default field_error_proc
+    # Field errors are displayed using the template defined by Motr::Forms.error_template
+    #
+    # @return [String]
+    # 
+    def self.with_custom_error_proc(&block)
+      default_proc = ::ActionView::Base.field_error_proc
+      ::ActionView::Base.field_error_proc = Motr::Forms.field_error_proc
+      yield
+    ensure
+      ::ActionView::Base.field_error_proc = default_proc
+    end
+    
   end
   
 end

data/lib/motr/forms/base.rb

@@ -2,14 +2,202 @@ module Motr
   
   module Forms
     
+    ##
+    # Base class for creating form builders
+    # 
     class Base < ActionView::Helpers::FormBuilder
       
-      def render_field_with_errors(html_tag, messages)        
+      # Access the template object
+      attr_accessor :template
+      # Tracks the order in which fields are used in the form, this allows the easy rebuilding of the submitted form
+      # data when submitted since normally the hash isn't ordered.
+      attr_accessor :field_order
+      # Tracks the field currently being "processed"
+      attr_accessor :current_field_type
+      
+            
+      # Overrides fields_for to make sure the form builder is set properly
+      def fields_for(record_or_name_or_array, *args, &block) #:nodoc:
+        opts = args.extract_options!
+        opts[:builder] ||= Motr::Forms.default_builder
+        args.push(opts)
+        Motr::Forms.with_custom_error_proc do
+          super(record_or_name_or_array, *args, &block)
+        end
+      end
+      
+            
+      protected
+      
+      ##
+      # 
+      # Checks to see if a particular attribute is required, if so, a "required" attribute is added to the field.
+      # 
+      # @param [Symbol] attribute The attribute to check against validators
+      # @return [Boolean]
+      # 
+      def attribute_required?(attribute)
+        validates_presence?(attribute) || validates_inclusion?(attribute)
+      end
+      
+      # Convenience method to use the +content_tag+ method from our template
+      # 
+      def content_tag(tag, content, options = {}, escape = true, &block) #:nodoc:
+        @template.content_tag(tag, content, options, escape, &block)
+      end
+      
+      ##
+      # Checks to see if there are errors for the particular method or attribute
+      # 
+      # @param [Symbol] method The method/attribute to check
+      # 
+      # @return [Boolean]
+      #
+      def errors_on_attribute?(method)
+        !(@object.nil? || @object.errors.empty? || !@object.errors.key?(method.to_sym) || [@object.errors[method.to_sym]].flatten.empty?)
+      end
+      
+      ##
+      # 
+      # Checks a passed validator to see if it is required
+      # 'borrowed' from Formtastic by Justin French (see https://github.com/justinfrench/formtastic)
+      # 
+      # @param [Hash] options Validator options
+      # 
+      def options_require_validation?(options)
+        
+        allow_blank = options[:allow_blank]
+        return !allow_blank unless allow_blank.nil?
+        if_condition = !options[:if].nil?
+        condition = if_condition ? options[:if] : options[:unless]
+
+        condition = if condition.respond_to?(:call)
+          condition.call(@object)
+        elsif condition.is_a?(::Symbol) && @object.respond_to?(condition)
+          @object.send(condition)
+        else
+          condition
+        end
+        if_condition ? !!condition : !condition
+      end
+      
+      ##
+      # 
+      # Wrapper method used by all form fields to customize the output
+      # 
+      # @param [Symbol] helper_method Original Rails helper method name
+      # @param [Symbol] method Object method / symbol used for the element
+      # @param [Array] args Array of original arguments passed to the helper
+      # 
+      # @return [String] Rendered HTML tag for the element
+      # 
+      def render_field_as_custom(helper_method, method, *args)
+        
+        @current_field_type = helper_method
+        
+        options = args.extract_options!
+        (@field_order ||= []) << method
+        
+        # Add an error class to the field if it has errors
+        #
+        if errors_on_attribute?(method)
+          klasses = (options.delete(:class) || "").split(" ")
+          klasses << Motr::Forms.error_class
+          options[:class] = klasses.join(" ")
+        end
+        
+        # Add a required attribute to the field if it is required
+        # Skip if false was passed as the required option
+        # 
+        options[:required] = "required" if attribute_required?(method) && options[:required].to_s != 'false'
+        options['data-validates-uniqueness'] = "true" if validates_uniqueness?(method)
+        
+        result = send(:"_super_#{helper_method}", method, *(args << options))
+        render_field_with_errors(method, result, @object.errors[method])
+        
+      end
+      
+      ##
+      # 
+      # Renders the passed +html_tag+ with the custom error_template
+      # @see Motr::Forms#error_template
+      # 
+      # @param [Symbol] method The method/attribute to check for errors
+      # @param [Object, String] html_tag Instance of an input tag or a string
+      # @param [Array] messages An array of all error messages to be added to the template
+      # 
+      def render_field_with_errors(method, html_tag, messages)
+        
+        return html_tag unless errors_on_attribute?(method)
+        
         error_class         = Motr::Forms.error_class
         message_error_class = Motr::Forms.message_error_class
         render_binding      = binding
         renderer            = ERB.new(Motr::Forms.error_template)        
+        
         renderer.result(render_binding).to_s.html_safe
+        
+      end
+      
+      ##
+      # 
+      # Compiles an array of all validators for a particular attribute
+      # @param [Symbol] attribtue The attribute to check
+      # 
+      def validators_for(attribute)
+        
+        return [] if @object.nil?
+        return [] unless @object.class.respond_to?(:validators_on)
+        
+        attribute  = attribute.to_s.sub(/_id$/, '').to_sym
+        @object.class.validators_on(attribute).uniq
+        
+      end
+      
+      ##
+      # 
+      # Convenience method to see if a particular attribute has validators
+      # @param [Symbol] attribute The attribute to check
+      # 
+      def validators_for?(attribute)
+        !validators_for(attribute).empty?
+      end
+      
+      ##
+      # 
+      # Checks for a presence validation on a particular attribute
+      # @param [Symbol] attribute The attribute to check
+      # 
+      def validates_presence?(attribute)
+        validator_of_type_exists?(validators_for(attribute), :presence)
+      end
+      
+      ##
+      # 
+      # Checks for a uniqueness validation on a particular attribute
+      # @param [Symbol] attribute The attribute to check
+      # 
+      def validates_uniqueness?(attribute)
+        validator_of_type_exists?(validators_for(attribute), :uniqueness, false)
+      end
+      
+      ##
+      # 
+      # Checks for inclusion validation on a particular attribute
+      # @param [Symbol] attribute The attribute to check
+      # 
+      def validates_inclusion?(attribute)
+        validator_of_type_exists?(validators_for(attribute), :inclusion)
+      end
+      
+      private
+      
+      def validator_of_type_exists?(validators, kind, check_options = true) #:nodoc:
+        validators.detect do |validator| 
+          exists = (validator.kind.to_s == kind.to_s)
+          next exists unless (check_options && exists) && validator.options.present?
+          options_require_validation?(validator.options)
+        end
       end
       
     end

data/lib/motr/forms/builder.rb

@@ -8,18 +8,54 @@ module Motr
     #
     class Builder < Motr::Forms::Base
       
-      # Access the template object
-      attr_accessor :template
-      # Tracks the order in which fields are used in the form, this allows the easy rebuilding of the submitted form
-      # data when submitted since normally the hash isn't ordered.
-      attr_accessor :field_order
+      # create overrides for custom rendering
+      [:email_field, :password_field, :text_field, :text_area, :url_field, ].each do |method|      
+        class_eval <<-FUNC, __FILE__, __LINE__ + 1
+          
+          alias :_super_#{method} :#{method}
+        
+          def #{method}(method_name, *args)
+            render_field_as_custom(:#{method}, method_name, *args)
+          end
+        FUNC
+      end
       
-      private
+      ##
+      # Modified label tag to support adding a 'required' asterisk to the end of the label
+      # 
+      def label(method, text = nil, options = {}, &block)
+        
+        options, text = text, nil if text.is_a?(Hash)
+        text ||= method.to_s.humanize
+        
+        options.stringify_keys!
+        klasses = (options.delete([:class]) || "").split(" ")
+        klasses << Motr::Forms.error_class if errors_on_attribute?(method)
+        options[:class] = klasses.join(" ") unless klasses.compact.empty?
+        
+        text = "#{text} <abbr title='Required'>*</abbr>".html_safe if attribute_required?(method)
+        super(method, text, options, &block)
+        
+      end
       
-      # Convenience method to use the +content_tag+ method from our template
+      ##
+      # 
+      # Creates a button tag to be used in a form instead of the default submit
+      # This makes CSS styling easier
+      # 
+      # @param [String] value The text for the button
+      # @param [Hash] options HTML options to be passed to the button
+      # @option [String] icon If included, adds an image to the button to be used as an icon
       # 
-      def content_tag(tag, content, options = {}, escape = true, &block) #:nodoc:
-        @template.content_tag(tag, content, options, escape, &block)
+      def button(value = nil, options = {})
+        
+        value, options = nil, value if value.is_a?(Hash)
+        value ||= submit_default_value
+
+        value = [image_tag(icon, :class => 'icon'), value].join(' ') if icon = options.delete(:icon)
+                
+        content_tag(:button, value.to_s.html_safe, options.reverse_merge!({ "type" => "submit", "name" => "commit" }))
+        
       end
       
     end

data/lib/motr/forms/helpers.rb

@@ -9,20 +9,26 @@ module Motr
       ##
       # 
       # Cusomizes the default form_for helper to add additional functionality
-      # (see ActionView::Helpers::FormHelper for more information)
+      # All params are the same as Rails' form_for
       # 
-      # @option options [Boolean] :validate Adds a data-validatable attribute to the form for javascript hooks
+      # @param [Mixed] record_name_or_array
+      # @param [Array] args 
+      # @param [Block] &block
       # 
-      def motr_form(record, options = {}, &block)
+      def motr_form(record_name_or_array, *args, &proc)
        
         raise ArgumentError, "Missing block" unless block_given?
         
+        options = args.extract_options!
         options.reverse_merge!(:builder => Motr::Forms.default_builder)
         options[:html] ||= {}
         options[:html].merge!('data-validatable' => true) if options.delete(:validate)
-        form_for(record, options, &block)
-                
-      end
+        
+        Motr::Forms.with_custom_error_proc do
+          form_for(record_name_or_array, *(args << options), &proc)
+        end
+        
+      end    
       
     end
     

data/lib/motr/helpers/elements.rb

@@ -0,0 +1,74 @@
+module Motr
+  module Helpers
+    ##
+    # 
+    # Generates misc html elements that aren't included in Rails core, or are custom.
+    #
+    module Elements
+      
+      ##
+      # Generates a "button" link tag. Simply a convenience method to skip adding 'class="button"' and also adds an +icon+ option
+      # @see Motr::Forms::Builder#button For form related buttons
+      # 
+      # @param [String] txt The link text
+      # @param [String] path The link href
+      # @param [Types] Name Description
+      # 
+      # @example Create a plain link.button 
+      #   button_link('Blog', '/blog') #=> <a href="/blog" class="button">Blog</a>
+      # @example Create a link.button with icon
+      #   button_link('Blog', '/blog', :icon => 'blog_image.png') #=> <a href="/blog" class="button"><img src="/images/blog_image.png" alt="Blog" /> Blog</a>
+
+      def button_link(txt, path, attrs = {}, incl_span = false)
+        image   = attrs.delete(:icon)
+        klasses = (attrs.delete(:class) || "").split(" ")
+        klasses << 'button'
+        klasses  = klasses.uniq.compact        
+        content  = ""
+        content <<  image_tag(image) unless image.nil?
+        content << (incl_span ? "<span>#{txt}</span>" : txt)
+        link_to content.html_safe, path, attrs.merge(:class => klasses.join(" "))
+      end
+      
+      ##
+      # 
+      # Convenience method for outputting all current flash messages. This allows you to avoid 
+      # using things like "if flash[:success]" and so on, which is far from DRY
+      # 
+      # @param [Hash] attrs Options to modify the html attributes and settings
+      # @option attrs [Symbol] closer Specify HTML to be appended to the message in case you want a "close" button/link. Defaults to "<span>X</span>"
+      # @option attrs [Symbol] wrapper Specify the HTML element which wraps each message. Defaults to :div
+      # 
+      # @example Output any available flash messages, appending a "closer" span
+      #   In your controller:
+      #     flash[:success] = "You did something awesome"
+      #   In your view or layout
+      #   <%= flash_messages :close => "<span>X</span>" %> #=> <div class="flash_message flash_message_success success">You did something awesome <span>X</span></div>
+      # 
+      # @example Output a message without a "close"
+      #   <%= flash_messages :close => false %> #=> <div class="flash_message flash_message_success success">You did something awesome</div>
+      #
+      #
+      def flash_messages(attrs = {})
+        
+        wrapper = attrs.delete(:wrapper) || :div
+        closer  = attrs.delete(:closer)
+        closer ||= "<span>X</span>" unless closer === false
+        klasses = (attrs.delete(:class) || "").split(" ")
+        klasses << "flash_message"  
+        content = ""    
+        
+        flash.each_key do |k|
+          klasses << "flash_message_#{k.to_s.underscore}"
+          msg_attrs = attrs.merge(:class => [k.to_s, klasses].flatten.join(' '))
+          content.concat content_tag(wrapper, "#{flash[k]} #{closer}", msg_attrs)
+        end    
+        
+        content.html_safe    
+        
+      end
+      
+    end
+    
+  end
+end

data/lib/motr/rails.rb

@@ -1,7 +1,11 @@
 module Motr
-  class Engine < ::Rails::Engine    
+  class Engine < ::Rails::Engine #:nodoc:
     config.motr = Motr    
     
+    # Add load paths straight to I18n, so engines and application can overwrite it.
+    require 'active_support/i18n'
+    I18n.load_path << File.expand_path('../../config/locales/en.yml', __FILE__)
+    
     initializer :after_initialize do
       ActionView::Base.send :default_form_builder=, Motr::Forms.default_builder
     end

data/lib/motr/version.rb

@@ -1,3 +1,3 @@
-module Motr
-  VERSION = "0.0.1"
+module Motr #:nodoc:
+  VERSION = "0.0.2".freeze
 end

metadata

@@ -2,7 +2,7 @@
 name: motr
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Brent Kirby
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-30 00:00:00 -04:00
+date: 2011-05-02 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -58,8 +58,30 @@ dependencies:
   prerelease: false
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: activemodel
+  name: fabrication
   requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.9.5
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: ffaker
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 1.5.0
+  type: :development
+  prerelease: false
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: activemodel
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -67,10 +89,10 @@ dependencies:
         version: "3.0"
   type: :runtime
   prerelease: false
-  version_requirements: *id005
+  version_requirements: *id007
 - !ruby/object:Gem::Dependency 
   name: rails
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -78,7 +100,7 @@ dependencies:
         version: "3.0"
   type: :runtime
   prerelease: false
-  version_requirements: *id006
+  version_requirements: *id008
 description: motr is a Rails engine aimed at simplifying routine development. The core motr engine includes various helpers, utilities, and modifications to rails core.
 email: 
 - dev@kurbmedia.com
@@ -97,6 +119,7 @@ files:
 - lib/motr/forms/builder.rb
 - lib/motr/forms/helpers.rb
 - lib/motr/forms.rb
+- lib/motr/helpers/elements.rb
 - lib/motr/helpers/layout_helpers.rb
 - lib/motr/helpers/navigation.rb
 - lib/motr/rails.rb
@@ -120,7 +143,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 1164898289255422466
+      hash: -1045787232198311107
       segments: 
       - 0
       version: "0"