form_cutter 1.0.1 → 1.0.2

data/README.rdoc

@@ -1,11 +1,11 @@
 == FormCutter
 
-The default rails form builder is great but it is so tedious to change the html that goes around it.
-This gem wraps *your* html around the form elements.  So all you have to do is this:
+The default rails form builder is great but it is so tedious to change the HTML that goes around it.
+This gem wraps *your* HTML around the form elements.  So all you have to do is this:
 
   <%= f.text_field :name %>
 
-And add your html template in <tt>app/views/forms/text_field.html.erb</tt> like this:
+And add your HTML form helper template in <tt>app/views/forms/text_field.html.erb</tt> like this:
   
   <div class="forms">
     <%= label(object_name, method, label_name) %><em><%= required %></em><br/>
@@ -35,32 +35,44 @@ Use the form builders normally, except don't add any markup (unless you want to)
     <fieldset>
       <%= f.text_field :title %>
       <%= f.text_area :body %>
-      <%= f.select :section, choices %>
-      <%= f.radio_button :am_fm %>
+      <%= f.select :section, ['choices'] %>
+      <%= f.radio_button :am_fm, ['radio'] %>
       <%= f.check_box :terms_and_conditions %>
+      <%= f.date_select :dob %>
+      <%= f.time_select :check_in_time %>
+      <%= f.datetime_select :updated_at %>
     </fieldset>
     <div class="buttons">
-      <%= f.sumbit 'Save' %>
+      <%= f.submit 'Save' %>
     </div>
   <% end %>
 
-The form builders will now wrap all form helper methods with *your* html.
+The form builders will now wrap all form helper methods with *your* HTML.
 
 You're done.
 
 === Customization
 
-There will always be an exception to the rule.  So there are 2 ways to change the html wrapper.
+There will always be an exception to the rule.  So there are 2 ways to change the form helper HTML wrapper.
 1. Like a resource - by creating a directory inside forms/, <tt>app/views/forms/blog/</tt>.
 2. Passing the :template option - either false or the '<tt>path/to/template</tt>'.
 
-It will render the first erb template that it finds.  If you use <tt><%= f.text_field :title, :template => 'custom' %></tt> for the @blog model, it looks in this order:
+==== The :template option
+
+The :template option is useful if you have a field or group of fields that don't work with your normal templates.
+There's always one.  This option tells the renderer to look for a specific HTML erb file or to look in a specific
+folder, if a file by that name doesn't exist.  Below is the order in which files will be found and rendered.
+
+It will render the first erb template that it finds.
+For instance in this case of <tt><%= f.text_field :title, :template => 'custom' %></tt> for the @blog model,
+it looks in this order:
+
 * forms/blog/custom.html.erb
 * forms/custom.html.erb
 * forms/custom/title.html.erb
 * forms/custom/text_field.html.erb
 * forms/custom/default.html.erb
-* forms/title.html.erb
+* forms/blog/title.html.erb
 * forms/blog/text_field.html.erb
 * forms/text_field.html.erb
 * forms/default.html.erb
@@ -73,8 +85,17 @@ This will search in app/views/reports/ instead of app/views/forms/.
 
   <%= f.text_field(:title, :report => true) %>
 
+In an admin or business data entry setting, this is useful to quickly get a "photocopy" of the completed form.
+
+  <%= form_for(@post, :template => true) do |form| %>
+    <%= render 'form' %>
+  <% end %>
+
+The :template or :report optons can be passed to <tt>form_for</tt> or <tt>fields_for</tt> and it will be applied to
+all helper methods within.
+
 ==== Other options
-You can pass any options to the helper methods.  These will become availble in the.
+You can pass any options to the helper methods.  These will become availble in the helper templates.
 
   <%= f.text_field(:title, :hint => 'This is a field hint', :anything => 'anything you want') %>
 
@@ -85,6 +106,10 @@ Will give you:
   
   <%= options[:anything] %>
   => 'anything you want'
+  
+note: in the anything case, the option will be added to the HTML output.
+  
+  <input type="text" anything="anything you want">
 
 FormCutter has several configuration values. You can read and change them in the initializer created by FormCutter, so if you haven't executed the command below yet, please do:
 

data/lib/form_cutter/action_view_extensions/form_helper.rb

@@ -9,7 +9,7 @@ module FormCutter
               raise template_error if !template?(options) || caller.first.include?("/app/views/"+base_template_path(options))
               render(:template => template_file(object_name, method, options, '#{helper_method_name}'), :locals => locals(object_name, method, '#{helper_method_name}', options))
             rescue ActionView::MissingTemplate
-              super
+              super(object_name, method, clean_options(options))
             end
           end
         METHOD
@@ -20,7 +20,7 @@ module FormCutter
           raise template_error if !template?(options) || caller.first.include?("/app/views/"+base_template_path(options))
           render(:template => template_file(object_name, method, options, :check_box), :locals => locals(object_name, method, :check_box, options))
         rescue ActionView::MissingTemplate
-          super
+          super(object_name, method, clean_options(options), checked_value, unchecked_value)
         end
       end
       
@@ -29,22 +29,33 @@ module FormCutter
           raise template_error if !template?(options) || caller.first.include?("/app/views/"+base_template_path(options))
           render(:template => template_file(object_name, method, options, :radio_button), :locals => locals(object_name, method, :radio_button, options))
         rescue ActionView::MissingTemplate
-          super
+          super(object_name, method, tag_value, clean_options(options))
         end
       end
       
+      ([:date_select, :time_select, :datetime_select]).each do |helper_method_name|
+        module_eval <<-METHOD, __FILE__, __LINE__ + 1
+          def #{helper_method_name}(object_name, method, options = {}, html_options = {})
+            begin
+              raise template_error if !template?(options) || caller.first.include?("/app/views/"+base_template_path(options))
+              render(:template => template_file(object_name, method, options, '#{helper_method_name}'), :locals => locals(object_name, method, '#{helper_method_name}', options, html_options))
+            rescue ActionView::MissingTemplate
+              super(object_name, method, clean_options(options), html_options = {})
+            end
+          end
+        METHOD
+      end
+      
     private
       
       def locals(object_name, method, helper_method_name, options, content = nil)
+        options[:hint] = (options[:hint] || '').html_safe
+        options[:label_name] = (options[:label] || '').html_safe
         options[:required] = options[:object].class.validators_on(method).map(&:class).include? ActiveModel::Validations::PresenceValidator if options[:required].nil?
-        options[:required] = (options[:required] == true) ? I18n.t(:"form_cutter.required.mark", :default => '*') : ''
+        options[:required] = options[:required] ? I18n.t(:"form_cutter.required.mark", :default => '*') : ''
         
-        locals = { :object => options[:object], :object_name => object_name, :method => method, :helper_method_name => helper_method_name, :options => options }
-        locals.merge!({:hint => (options.delete(:hint) || '').html_safe})
-        locals.merge!({:label_name => options.delete(:label)})
-        locals.merge!({:report => options.delete(:report)})
-        locals.merge!({:required => options.delete(:required)})
-        locals.merge!({:template => options.delete(:template)})
+        locals = { :object => options[:object], :object_name => object_name, :method => method, :helper_method_name => helper_method_name, :options => options }.merge(options)
+        options = clean_options(options)
         locals
       end
       
@@ -61,7 +72,7 @@ module FormCutter
           [path, template, method.to_s].join('/'),         # forms/custom/title.html.erb
           [path, template, helper_method_name].join('/'),  # forms/custom/text_field.html.erb
           [path, template, 'default'].join('/'),           # forms/custom/default.html.erb
-          [path, resource, method.to_s].join('/'),         # forms/title.html.erb
+          [path, resource, method.to_s].join('/'),         # forms/blog/title.html.erb
           [path, resource, helper_method_name].join('/'),  # forms/blog/text_field.html.erb
           [path, helper_method_name].join('/'),            # forms/text_field.html.erb
           [path, 'default'].join('/')                      # forms/default.html.erb
@@ -72,12 +83,16 @@ module FormCutter
         report?(options) ? FormCutter.reports_path : FormCutter.forms_path
       end
       
+      def clean_options(options)
+        options.delete_if { |k, v| [:hint, :label, :label_name, :report, :required, :template].include?(k) }
+      end
+      
       def report?(options)
         options[:report]
       end
       
       def template?(options)
-        !(options[:template] == false)
+        !(options[:template] === false)
       end
       
       def template_error

data/lib/form_cutter/version.rb

@@ -1,3 +1,3 @@
 module FormCutter
-  VERSION = "1.0.1".freeze
+  VERSION = "1.0.2".freeze
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 0
-  - 1
-  version: 1.0.1
+  - 2
+  version: 1.0.2
 platform: ruby
 authors: 
 - Benjamin Lewis
@@ -14,11 +14,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-23 00:00:00 +10:30
+date: 2010-10-26 00:00:00 +10:30
 default_executable: 
 dependencies: []
 
-description: Lets you wrap your form helper methods is custom html
+description: Lets you wrap your form helper methods in custom html
 email: 23inhouse@gmail.com
 executables: []