formula 0.0.5 → 0.0.6

data/README.rdoc

@@ -8,19 +8,31 @@ Formula is a Rails form generator that generates simple clean markup. The projec
   
 == Examples
 
-  <%= f.input :email %>
-  <%= f.input :password %>
+  <% formula_form_for @user do |f| %>
+    <%= f.input :email %>
+    <%= f.input :password %>
+  <% end %>
 
-  <%= f.input :email, :label => "Email:", :hint => "We promise never to bother you." %>
-  <%= f.input :password, :label => "Password:", :hint => "Must be at least six characters." %>
+  <% formula_form_for @user do |f| %>
+    <%= f.input :email, :label => "Email:", :hint => "We promise never to bother you." %>
+    <%= f.input :password, :label => "Password:", :hint => "Must be at least six characters." %>
+  <% end %>
   
-  <%= f.input :url, :class => 'grid-04' %>
-  <%= f.input :phone, :class => 'grid-04' %>
-  <%= f.input :email, :class => 'grid-04' %>
+  <% formula_form_for @company do |f|
+    <%= f.input :url, :class => 'grid-04' %>
+    <%= f.input :phone, :class => 'grid-04' %>
+    <%= f.input :email, :class => 'grid-04' %>
+  <% end %>
   
-  <%= f.input :credit_card_number, :label => 'Number:', :class => 'grid-08' %>
-  <%= f.input :credit_card_verification, :label => 'CVV:', :class => 'grid-02' %>
-  <%= f.input :credit_card_expiration, :label => 'Expiration:', :class => 'grid-02' %>
+  <% formula_form_for @user do |f| %>
+    <%= f.input :email, :label => "Email:", :class => 'grid-06 %>
+    <%= f.input :password, :label => "Password:", :class => 'grid-06' %>
+    <% formula_fields_for @user.payment do |payment_f| %>
+      <%= f.input :credit_card_number, :label => 'Number:', :class => 'grid-08' %>
+      <%= f.input :credit_card_verification, :label => 'CVV:', :class => 'grid-02' %>
+      <%= f.input :credit_card_expiration, :label => 'Expiration:', :class => 'grid-02' %>
+    <% end %>
+  <% end %>
 
 == Copyright
 

data/lib/formula.rb

@@ -6,6 +6,10 @@ module Formula
   mattr_accessor :input_class
   @@input_class = 'input'
   
+  # Default class assigned to input (<div class="association">...</div>).
+  mattr_accessor :association_class
+  @@association_class = 'association'
+  
   # Default class assigned to error (<div class="error">...</div>).
   mattr_accessor :error_class
   @@error_class = 'error'
@@ -18,6 +22,10 @@ module Formula
   mattr_accessor :input_tag
   @@input_tag = :div
   
+  # Default tag assigned to input (<div class="association">...</div>).
+   mattr_accessor :association_tag
+   @@association_tag = :div
+  
   # Default tag assigned to error (<div class="error">...</div>).
   mattr_accessor :error_tag
   @@error_tag = :div
@@ -41,42 +49,112 @@ module Formula
   class FormulaFormBuilder < ActionView::Helpers::FormBuilder
     
     
-    # Generate a suitable form input for a given method by performing introspection on the type. 
+    # Basic container generator for use with blocks.
     #
     # Options: 
     #
-    # * :as    - override the default type used (:url, :email, :phone, :password, :number, :text)
-    # * :label - override the default label used ('Name:', 'URL:', etc.)
-    # * :error - override the default error used ('invalid', 'incorrect', etc.)
-    # * :class - add custom classes to the container ('grid-04', 'grid-08', etc.)
+    # * :hint       - specify a hint to be displayed ('We promise not to spam you.', etc.)
+    # * :label      - override the default label used ('Name:', 'URL:', etc.)
+    # * :error      - override the default error used ('invalid', 'incorrect', etc.)
+    #
+    # Usage:
+    #
+    #   f.block(:name, :label => "Name:", :hint => "Please use your full name.", :container => { :class => 'fill' }) do
+    #     ...
+    #   end
+    #
+    # Equivalent:
+    #
+    #   <div class='fill'>
+    #     <%= f.label(:name, "Name:") %>
+    #     ...
+    #     <div class="hint">Please use your full name.</div>
+    #     <div class="error"></div>
+    #   </div>
     
-    def input(method, options = {})
-      options[:as]    ||= as(method, options)
-      options[:error] ||= error(method, options)
+    def block(method, options = {}, &block)
+      options[:error] ||= error(method)
             
       components = []
       
       components << self.label(method, options[:label])
       
-      case options[:as]
-        when :text     then components << self.text_area(method)
-        when :string   then components << self.text_field(method)
-        when :password then components << self.password_field(method)
-        when :url      then components << self.url_field(method)
-        when :email    then components << self.email_field(method)
-        when :phone    then components << self.phone_field(method)
-        when :number   then components << self.number_field(method)
-        when :date     then components << self.date_select(method)
-        when :time     then components << self.time_select(method)
-        when :datetime then components << self.datetime_select(method)
-      end
+      components << @template.capture(&block)
       
       components << @template.content_tag(::Formula.hint_tag, options[:hint], :class => ::Formula.hint_class) if options[:hint]
       components << @template.content_tag(::Formula.error_tag, options[:error], :class => ::Formula.error_class) if options[:error]
       
-      @template.content_tag(:div, :class => options[:class]) do
-        @template.content_tag(::Formula.input_tag, :class => ::Formula.input_class) do
-          components.join
+      @template.content_tag(:div, options[:container]) do
+        components.join
+      end
+    end
+    
+    
+    # Generate a suitable form input for a given method by performing introspection on the type. 
+    #
+    # Options: 
+    #
+    # * :as         - override the default type used (:url, :email, :phone, :password, :number, :text)
+    # * :label      - override the default label used ('Name:', 'URL:', etc.)
+    # * :error      - override the default error used ('invalid', 'incorrect', etc.)
+    # * :input      - add custom options to the input ({ :class => 'goregous' }, etc.)
+    # * :container  - add custom options to the container ({ :class => 'gorgeous' }, etc.)
+    # * :collection - 
+    #
+    # Usage:
+    #
+    #   f.input(:name)
+    #   f.input(:email)
+    #   f.input(:password_a, :label => "Password", :hint => "It's a secret!", :container => { :class => "half" })
+    #   f.input(:password_b, :label => "Password", :hint => "It's a secret!", :container => { :class => "half" })
+    #
+    # Equivalent:
+    #
+    #   <div>
+    #     <div class="input">
+    #       <%= f.label(:name)
+    #       <%= f.text_field(:name)
+    #     </div>
+    #   </div>
+    #   <div>
+    #     <div class="input">
+    #       <%= f.label(:email)
+    #       <%= f.email_field(:email)
+    #     </div>
+    #   </div>
+    #   <div class="half">
+    #     <div class="input">
+    #       <%= f.label(:password_a, "Password")
+    #       <%= f.password_field(:password_a)
+    #       <div class="hint">It's a secret!</div>
+    #     </div>
+    #   </div>
+    #   <div class="half">
+    #     <div class="input">
+    #       <%= f.label(:password_b, "Password")
+    #       <%= f.password_field(:password_b)
+    #       <div class="hint">It's a secret!</div>
+    #     </div>
+    #   </div>
+    
+    def input(method, options = {})
+      options[:as] ||= as(method)
+      
+      self.block(method, options) do
+        case options[:as]
+          when :text     then text_area(method)
+          
+          when :string   then text_field(method)
+          when :password then password_field(method)
+            
+          when :url      then url_field(method)
+          when :email    then email_field(method)
+          when :phone    then phone_field(method)
+          when :number   then number_field(method)
+            
+          when :date     then date_select(method)
+          when :time     then time_select(method)
+          when :datetime then datetime_select(method)
         end
       end
     end
@@ -92,11 +170,28 @@ module Formula
     # * :class - add custom classes to the container ('grid-04', 'grid-08', etc.)
     
     def association(method, options = {}, &block)
+      self.block(method, options) do
+      end
     end
     
     
   private
-  
+    
+    
+    # Introspection on the column to determine how to render a method. The method is used to 
+    # identify a method type (if the method corresponds to a column)
+    #
+    # Returns:
+    #
+    # * :text     - for columns of type 'text'
+    # * :string   - for columns of type 'string'
+    # * :integer  - for columns of type 'integer'
+    # * :float    - for columns of type 'float'
+    # * :decimal  - for columns of type 'decimal'
+    # * :datetime - for columns of type 'datetime'
+    # * :date     - for columns of type 'date'
+    # * :time     - for columns of type 'time'
+    # * nil       - for unkown columns
   
     def type(method)
       column = @object.column_for_attribute(method) if @object.respond_to?(:column_for_attribute)
@@ -113,11 +208,14 @@ module Formula
     # * :email    - for columns containing 'email'
     # * :phone    - for columns containing 'phone'
     # * :password - for columns containing 'password'
-    # * :number   - for integer, float, or decimal columns
-    
+    # * :number   - for integer, float or decimal columns
+    # * :datetime - for datetime or timestamp columns
+    # * :date     - for date column
+    # * :time     - for time column
+    # * :text     - for time column
     # * :string   - for all other cases
     
-    def as(method, options = {})
+    def as(method)
       type = type(method)
       
       if type == :string or type == nil
@@ -157,7 +255,7 @@ module Formula
     # * :number   - for integer, float, or decimal columns
     # * :text     - for all other cases
     
-    def error(method, options = {})
+    def error(method)
       @object.errors[method].to_sentence
     end
     
@@ -174,20 +272,59 @@ module Formula
   module FormulaFormHelper
     @@builder = ::Formula::FormulaFormBuilder
     
+    
+    # Generates a wrapper around form_for with :builder set to FormulaFormBuilder.
+    #
+    # Supports:
+    #
+    # * formula_form_for(@user)
+    #
+    # Equivalent:
+    #
+    # * form_for(@user, :builder => Formula::FormulaFormBuilder))
+    #
+    # Usage:
+    #
+    #   <% formula_form_for(@user) do |f| %>
+    #     <%= f.input :email %>
+    #     <%= f.input :password %>
+    #   <% end %>
+    
     def formula_form_for(record_or_name_or_array, *args, &proc)
        options = args.extract_options!
        options[:builder] ||= @@builder
        form_for(record_or_name_or_array, *(args << options), &proc)
     end
-     
+    
+    alias :formula_for :formula_form_for
+    
+    
+    # Generates a wrapper around fields_form with :builder set to FormulaFormBuilder.
+    #
+    # Supports:
+    #
+    # * f.formula_fields_for(@user.company)
+    # * f.fieldsula_for(@user.company)
+    #
+    # Equivalent:
+    #
+    # * f.fields_for(@user.company, :builder => Formula::FormulaFormBuilder))
+    #
+    # Usage:
+    #
+    #   <% f.formula_form_for(@user.company) do |company_f| %>
+    #     <%= company_f.input :url %>
+    #     <%= company_f.input :phone %>
+    #   <% end %>
+    
     def formula_fields_for(record_or_name_or_array, *args, &block)
       options = args.extract_options!
       options[:builder] ||= @@builder
       fields_for(record_or_name_or_array, *(args << options), &block)
     end
     
-    alias :formula_for :formula_form_for
-    alias :fieldula_for :formula_fields_for
+    alias :fieldsula_for :formula_fields_for 
+    
   end
   
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 5
-  version: 0.0.5
+  - 6
+  version: 0.0.6
 platform: ruby
 authors: 
 - Kevin Sylvestre