formtastic 2.0.2 → 2.1.0.beta1

data/lib/generators/templates/_form.html.haml

@@ -1,8 +1,8 @@
 = semantic_form_for @<%= singular_name %> do |f|
   = f.inputs do
-  <% attributes.each do |attribute| -%>
+  <%- attributes.each do |attribute| -%>
     = f.input :<%= attribute.name %>
-  <% end -%>
+  <%- end -%>
 
-  = f.buttons do
-    = f.commit_button
+  = f.actions do
+    = f.action :submit, :as => :input

data/lib/generators/templates/_form.html.slim

@@ -1,8 +1,8 @@
 = semantic_form_for @<%= singular_name %> do |f|
   = f.inputs do
-  <% attributes.each do |attribute| -%>
+  <%- attributes.each do |attribute| -%>
     = f.input :<%= attribute.name %>
-  <% end -%>
+  <%- end -%>
 
   = f.buttons do
     = f.commit_button

data/lib/generators/templates/formtastic.rb

@@ -68,6 +68,10 @@
 # i.e. :label => true, or :hint => true (or opposite depending on initialized value)
 # Formtastic::FormBuilder.i18n_lookups_by_default = false
 
+# Specifies the class to use for localization lookups. You can create your own
+# class and use it instead by subclassing Formtastic::Localizer (which is the default).
+# Formtastic::FormBuilder.i18n_localizer = MyOwnLocalizer
+
 # You can add custom inputs or override parts of Formtastic by subclassing Formtastic::FormBuilder and
 # specifying that class here.  Defaults to Formtastic::FormBuilder.
 # Formtastic::Helpers::FormHelper.builder = MyCustomBuilder

data/lib/locale/en.yml

@@ -5,4 +5,6 @@ en:
     :create: 'Create %{model}'
     :update: 'Update %{model}'
     :submit: 'Submit %{model}'
+    :cancel: 'Cancel %{model}'
+    :reset: 'Reset %{model}'
     :required: 'required'

data/sample/basic_inputs.html

@@ -177,6 +177,28 @@
         </li>
       </ol>
     </fieldset>
+
+    <fieldset class="actions">
+      <ol>
+        <li class="action input_action">
+          <input id="gem_submit" type="submit" value="Create Thing">
+        </li>
+      </ol>
+    </fieldset>
+
+    <fieldset class="actions">
+      <ol>
+        <li class="action button_action">
+          <button id="gem_submit" type="submit">Create Thing</button>
+        </li>
+        <li class="action button_action">
+          <button id="gem_submit" type="reset">Reset</button>
+        </li>
+        <li class="action link_action">
+          <a href="#">Cancel</button>
+        </li>
+      </ol>
+    </fieldset>
   </form>
 </body>
 </html>

data/spec/actions/button_action_spec.rb

@@ -0,0 +1,63 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe 'ButtonAction', 'when submitting' do
+
+  include FormtasticSpecHelper
+
+  before do
+    @output_buffer = ''
+    mock_everything
+    
+    concat(semantic_form_for(@new_post) do |builder|
+      concat(builder.action(:submit, :as => :button))
+    end)
+  end
+  
+  it 'should render a submit type of button' do
+    output_buffer.should have_tag('li.action.button_action button[@type="submit"]')
+  end
+
+end
+
+describe 'ButtonAction', 'when resetting' do
+
+  include FormtasticSpecHelper
+  
+  before do
+    @output_buffer = ''
+    mock_everything
+    
+    concat(semantic_form_for(@new_post) do |builder|
+      concat(builder.action(:reset, :as => :button))
+    end)
+  end
+  
+  it 'should render a reset type of button' do
+    output_buffer.should have_tag('li.action.button_action button[@type="reset"]', :text => "Reset Post")
+  end
+
+  it 'should not render a value attribute' do
+    output_buffer.should_not have_tag('li.action.button_action button[@value]')
+  end
+  
+end
+
+describe 'InputAction', 'when cancelling' do
+
+  include FormtasticSpecHelper
+  
+  before do
+    @output_buffer = ''
+    mock_everything
+  end
+  
+  it 'should raise an error' do
+    lambda { 
+      concat(semantic_form_for(@new_post) do |builder|
+        concat(builder.action(:cancel, :as => :button))
+      end)
+    }.should raise_error(Formtastic::UnsupportedMethodForAction)
+  end
+  
+end

data/spec/actions/generic_action_spec.rb

@@ -0,0 +1,484 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe 'InputAction::Base' do
+  
+  # Most basic Action class to test Base
+  class ::GenericAction
+    include ::Formtastic::Actions::Base
+    
+    def supported_methods
+      [:submit, :reset, :cancel]
+    end
+    
+    def to_html
+      wrapper do
+        builder.submit(text, button_html)
+      end
+    end
+  end
+  
+  include FormtasticSpecHelper
+
+  before do
+    @output_buffer = ''
+    mock_everything
+  end
+  
+  describe 'wrapping HTML' do
+    
+    before do
+      concat(semantic_form_for(@new_post) do |builder|
+        concat(builder.action(:submit, :as => :generic,
+          :wrapper_html => { :foo => 'bah' }
+        ))
+      end)
+    end
+    
+    it 'should add the #foo id to the li' do
+      output_buffer.should have_tag('li#post_submit_action')
+    end
+    
+    it 'should add the .action and .generic_action classes to the li' do
+      output_buffer.should have_tag('li.action.generic_action')
+    end
+
+    it 'should pass :wrapper_html HTML attributes to the wrapper' do
+      output_buffer.should have_tag('li.action.generic_action[@foo="bah"]')
+    end
+    
+    context "when a custom :id is provided" do
+      
+      before do
+        concat(semantic_form_for(@new_post) do |builder|
+          concat(builder.action(:submit, :as => :generic, 
+            :wrapper_html => { :id => 'foo_bah_bing' }
+          ))
+        end)
+      end
+      
+      it "should use the custom id" do
+        output_buffer.should have_tag('li#foo_bah_bing')
+      end
+      
+    end
+    
+    context "when a custom class is provided as a string" do 
+      
+      before do
+        concat(semantic_form_for(@new_post) do |builder|
+          concat(builder.action(:submit, :as => :generic, 
+            :wrapper_html => { :class => 'foo_bah_bing' }
+          ))
+        end)
+      end
+      
+      it "should add the custom class strng to the existing classes" do
+        output_buffer.should have_tag('li.action.generic_action.foo_bah_bing')
+      end
+      
+    end
+    
+    context "when a custom class is provided as an array" do 
+      
+      before do
+        concat(semantic_form_for(@new_post) do |builder|
+          concat(builder.action(:submit, :as => :generic, 
+            :wrapper_html => { :class => ['foo_bah_bing', 'zing_boo'] }
+          ))
+        end)
+      end
+      
+      it "should add the custom class strng to the existing classes" do
+        output_buffer.should have_tag('li.action.generic_action.foo_bah_bing.zing_boo')
+      end
+      
+    end
+    
+  end
+  
+  describe 'button HTML' do
+    
+    before do
+      concat(semantic_form_for(@new_post) do |builder|
+        concat(builder.action(:submit, :as => :generic, 
+          :button_html => { :foo => 'bah' }
+        ))
+      end)
+    end
+    
+    it 'should pass :button_html HTML attributes to the button' do
+      output_buffer.should have_tag('li.action.generic_action input[@foo="bah"]')
+    end
+    
+    it 'should respect a default_commit_button_accesskey configuration with nil' do
+      with_config :default_commit_button_accesskey, nil do
+        concat(semantic_form_for(@new_post) do |builder|
+          concat(builder.action(:submit, :as => :generic))
+        end)
+        output_buffer.should_not have_tag('li.action input[@accesskey]')
+      end
+    end
+    
+    it 'should respect a default_commit_button_accesskey configuration with a String' do
+      with_config :default_commit_button_accesskey, 's' do
+        concat(semantic_form_for(@new_post) do |builder|
+          concat(builder.action(:submit, :as => :generic))
+        end)
+        output_buffer.should have_tag('li.action input[@accesskey="s"]')
+      end
+    end
+    
+    it 'should respect an accesskey through options over configration' do
+      with_config :default_commit_button_accesskey, 's' do
+        concat(semantic_form_for(@new_post) do |builder|
+          concat(builder.action(:submit, :as => :generic, :accesskey => 'o'))
+        end)
+        output_buffer.should_not have_tag('li.action input[@accesskey="s"]')
+        output_buffer.should have_tag('li.action input[@accesskey="o"]')
+      end
+    end
+    
+  end
+    
+  describe 'labelling' do
+  
+    describe 'when used without object' do
+      
+      describe 'when explicit label is provided' do
+        it 'should render an input with the explicitly specified label' do
+          concat(semantic_form_for(:post, :url => 'http://example.com') do |builder|
+            concat(builder.action(:submit, :as => :generic, :label => "Click!"))
+            concat(builder.action(:reset,  :as => :generic, :label => "Reset!"))
+            concat(builder.action(:cancel, :as => :generic, :label => "Cancel!"))
+          end)
+          output_buffer.should have_tag('li.generic_action input[@value="Click!"]')
+          output_buffer.should have_tag('li.generic_action input[@value="Reset!"]')
+          output_buffer.should have_tag('li.generic_action input[@value="Cancel!"]')
+        end
+      end
+  
+      describe 'when no explicit label is provided' do
+        describe 'when no I18n-localized label is provided' do
+          before do
+            ::I18n.backend.store_translations :en, :formtastic => {
+              :submit => 'Submit %{model}',
+              :reset => 'Reset %{model}',
+              :cancel => 'Cancel %{model}'
+            }
+          end
+  
+          after do
+            ::I18n.backend.reload!
+          end
+  
+          it 'should render an input with default I18n-localized label (fallback)' do
+            concat(semantic_form_for(:post, :url => 'http://example.com') do |builder|
+              concat(builder.action(:submit, :as => :generic))
+              concat(builder.action(:reset, :as => :generic))
+              concat(builder.action(:cancel, :as => :generic))
+            end)
+            output_buffer.should have_tag('li.generic_action input[@value="Submit Post"]')
+            output_buffer.should have_tag('li.generic_action input[@value="Cancel Post"]')
+            output_buffer.should have_tag('li.generic_action input[@value="Reset Post"]')
+          end
+        end
+  
+       describe 'when I18n-localized label is provided' do
+         
+         before do
+           ::I18n.backend.store_translations :en,
+             :formtastic => {
+                 :actions => {
+                   :submit => 'Custom Submit',
+                   :reset => 'Custom Reset',
+                   :cancel => 'Custom Cancel'
+                  }
+               }
+         end
+  
+         after do
+           ::I18n.backend.reload!
+         end
+  
+         it 'should render an input with localized label (I18n)' do
+           with_config :i18n_lookups_by_default, true do
+             ::I18n.backend.store_translations :en,
+               :formtastic => {
+                   :actions => {
+                     :post => {
+                       :submit => 'Custom Submit %{model}',
+                       :reset => 'Custom Reset %{model}',
+                       :cancel => 'Custom Cancel %{model}'
+                      }
+                    }
+                 }
+             concat(semantic_form_for(:post, :url => 'http://example.com') do |builder|
+               concat(builder.action(:submit, :as => :generic))
+               concat(builder.action(:reset, :as => :generic))
+               concat(builder.action(:cancel, :as => :generic))
+             end)
+             output_buffer.should have_tag(%Q{li.generic_action input[@value="Custom Submit Post"]})
+             output_buffer.should have_tag(%Q{li.generic_action input[@value="Custom Reset Post"]})
+             output_buffer.should have_tag(%Q{li.generic_action input[@value="Custom Cancel Post"]})
+           end
+         end
+  
+         it 'should render an input with anoptional localized label (I18n) - if first is not set' do
+           with_config :i18n_lookups_by_default, true do
+             concat(semantic_form_for(:post, :url => 'http://example.com') do |builder|
+               concat(builder.action(:submit, :as => :generic))
+               concat(builder.action(:reset, :as => :generic))
+               concat(builder.action(:cancel, :as => :generic))
+             end)
+             output_buffer.should have_tag(%Q{li.generic_action input[@value="Custom Submit"]})
+             output_buffer.should have_tag(%Q{li.generic_action input[@value="Custom Reset"]})
+             output_buffer.should have_tag(%Q{li.generic_action input[@value="Custom Cancel"]})
+           end
+         end
+  
+       end
+      end
+    end
+  
+    describe 'when used on a new record' do
+      before do
+        @new_post.stub!(:new_record?).and_return(true)
+      end
+  
+      describe 'when explicit label is provided' do
+        it 'should render an input with the explicitly specified label' do
+          concat(semantic_form_for(@new_post) do |builder|
+            concat(builder.action(:submit, :as => :generic, :label => "Click!"))
+            concat(builder.action(:reset, :as => :generic, :label => "Reset!"))
+            concat(builder.action(:cancel, :as => :generic, :label => "Cancel!"))
+          end)
+          output_buffer.should have_tag('li.generic_action input[@value="Click!"]')
+          output_buffer.should have_tag('li.generic_action input[@value="Reset!"]')
+          output_buffer.should have_tag('li.generic_action input[@value="Cancel!"]')
+        end
+      end
+  
+      describe 'when no explicit label is provided' do
+        describe 'when no I18n-localized label is provided' do
+          before do
+            ::I18n.backend.store_translations :en, :formtastic => {
+              :create => 'Create %{model}',
+              :reset  => 'Reset %{model}',
+              :cancel => 'Cancel %{model}'
+            }
+          end
+  
+          after do
+            ::I18n.backend.reload!
+          end
+  
+          it 'should render an input with default I18n-localized label (fallback)' do
+            concat(semantic_form_for(@new_post) do |builder|
+              concat(builder.action(:submit, :as => :generic))
+              concat(builder.action(:reset,  :as => :generic))
+              concat(builder.action(:cancel,  :as => :generic))
+            end)
+            output_buffer.should have_tag('li.generic_action input[@value="Create Post"]')
+            output_buffer.should have_tag('li.generic_action input[@value="Reset Post"]')
+            output_buffer.should have_tag('li.generic_action input[@value="Cancel Post"]')
+          end
+        end
+  
+        describe 'when I18n-localized label is provided' do
+          before do
+            ::I18n.backend.store_translations :en,
+              :formtastic => {
+                  :actions => {
+                    :create => 'Custom Create',
+                    :reset => 'Custom Reset',
+                    :cancel => 'Custom Cancel'
+                   }
+                }
+          end
+  
+          after do
+            ::I18n.backend.reload!
+          end
+  
+          it 'should render an input with localized label (I18n)' do
+            with_config :i18n_lookups_by_default, true do
+              ::I18n.backend.store_translations :en,
+                :formtastic => {
+                    :actions => {
+                      :post => {
+                        :create => 'Custom Create %{model}',
+                        :reset => 'Custom Reset %{model}',
+                        :cancel => 'Custom Cancel %{model}'
+                       }
+                     }
+                  }
+              concat(semantic_form_for(@new_post) do |builder|
+                concat(builder.action(:submit, :as => :generic))
+                concat(builder.action(:reset, :as => :generic))
+                concat(builder.action(:cancel, :as => :generic))
+              end)
+              output_buffer.should have_tag(%Q{li.generic_action input[@value="Custom Create Post"]})
+              output_buffer.should have_tag(%Q{li.generic_action input[@value="Custom Reset Post"]})
+              output_buffer.should have_tag(%Q{li.generic_action input[@value="Custom Cancel Post"]})
+            end
+          end
+  
+          it 'should render an input with anoptional localized label (I18n) - if first is not set' do
+            with_config :i18n_lookups_by_default, true do
+              concat(semantic_form_for(@new_post) do |builder|
+                concat(builder.action(:submit, :as => :generic))
+                concat(builder.action(:reset, :as => :generic))
+                concat(builder.action(:cancel, :as => :generic))
+              end)
+              output_buffer.should have_tag(%Q{li.generic_action input[@value="Custom Create"]})
+              output_buffer.should have_tag(%Q{li.generic_action input[@value="Custom Reset"]})
+              output_buffer.should have_tag(%Q{li.generic_action input[@value="Custom Cancel"]})
+            end
+          end
+  
+        end
+      end
+    end
+  
+    describe 'when used on an existing record' do
+      before do
+        @new_post.stub!(:persisted?).and_return(true)
+      end
+  
+      describe 'when explicit label is provided' do
+        it 'should render an input with the explicitly specified label' do
+          concat(semantic_form_for(@new_post) do |builder|
+            concat(builder.action(:submit, :as => :generic, :label => "Click!"))
+            concat(builder.action(:reset, :as => :generic, :label => "Reset!"))
+            concat(builder.action(:cancel, :as => :generic, :label => "Cancel!"))
+          end)
+          output_buffer.should have_tag('li.generic_action input[@value="Click!"]')
+          output_buffer.should have_tag('li.generic_action input[@value="Reset!"]')
+          output_buffer.should have_tag('li.generic_action input[@value="Cancel!"]')
+        end
+      end
+  
+      describe 'when no explicit label is provided' do
+        describe 'when no I18n-localized label is provided' do
+          before do
+            ::I18n.backend.store_translations :en, :formtastic => {
+              :update => 'Save %{model}',
+              :reset => 'Reset %{model}',
+              :cancel => 'Cancel %{model}'
+            }
+          end
+  
+          after do
+            ::I18n.backend.reload!
+          end
+  
+          it 'should render an input with default I18n-localized label (fallback)' do
+            concat(semantic_form_for(@new_post) do |builder|
+              concat(builder.action(:submit, :as => :generic))
+              concat(builder.action(:reset, :as => :generic))
+              concat(builder.action(:cancel, :as => :generic))
+            end)
+            output_buffer.should have_tag('li.generic_action input[@value="Save Post"]')
+            output_buffer.should have_tag('li.generic_action input[@value="Reset Post"]')
+            output_buffer.should have_tag('li.generic_action input[@value="Cancel Post"]')
+          end
+        end
+  
+        describe 'when I18n-localized label is provided' do
+          before do
+            ::I18n.backend.reload!
+            ::I18n.backend.store_translations :en,
+              :formtastic => {
+                  :actions => {
+                    :update => 'Custom Save',
+                    :reset => 'Custom Reset',
+                    :cancel => 'Custom Cancel'
+                   }
+                }
+          end
+  
+          after do
+            ::I18n.backend.reload!
+          end
+  
+          it 'should render an input with localized label (I18n)' do
+            with_config :i18n_lookups_by_default, true do
+              ::I18n.backend.store_translations :en,
+                :formtastic => {
+                    :actions => {
+                      :post => {
+                        :update => 'Custom Save %{model}',
+                        :reset => 'Custom Reset %{model}',
+                        :cancel => 'Custom Cancel %{model}'
+                       }
+                     }
+                  }
+              concat(semantic_form_for(@new_post) do |builder|
+                concat(builder.action(:submit, :as => :generic))
+                concat(builder.action(:reset, :as => :generic))
+                concat(builder.action(:cancel, :as => :generic))
+              end)
+              output_buffer.should have_tag(%Q{li.generic_action input[@value="Custom Save Post"]})
+              output_buffer.should have_tag(%Q{li.generic_action input[@value="Custom Reset Post"]})
+              output_buffer.should have_tag(%Q{li.generic_action input[@value="Custom Cancel Post"]})
+            end
+          end
+  
+          it 'should render an input with anoptional localized label (I18n) - if first is not set' do
+            with_config :i18n_lookups_by_default, true do
+              concat(semantic_form_for(@new_post) do |builder|
+                concat(builder.action(:submit, :as => :generic))
+                concat(builder.action(:reset, :as => :generic))
+                concat(builder.action(:cancel, :as => :generic))
+              end)
+              output_buffer.should have_tag(%Q{li.generic_action input[@value="Custom Save"]})
+              output_buffer.should have_tag(%Q{li.generic_action input[@value="Custom Reset"]})
+              output_buffer.should have_tag(%Q{li.generic_action input[@value="Custom Cancel"]})
+              ::I18n.backend.store_translations :en, :formtastic => {}
+            end
+          end
+  
+        end
+      end
+    end
+  end
+
+  describe 'when the model is two words' do
+
+    before do
+      output_buffer = ''
+      class ::UserPost
+        extend ActiveModel::Naming if defined?(ActiveModel::Naming)
+        include ActiveModel::Conversion if defined?(ActiveModel::Conversion)
+    
+        def id
+        end
+    
+        def persisted?
+        end
+    
+        # Rails does crappy human_name
+        def self.human_name
+          "User post"
+        end
+      end
+      @new_user_post = ::UserPost.new
+    
+      @new_user_post.stub!(:new_record?).and_return(true)
+      concat(semantic_form_for(@new_user_post, :url => '') do |builder|
+        concat(builder.action(:submit, :as => :generic))
+        concat(builder.action(:reset, :as => :generic))
+        concat(builder.action(:cancel, :as => :generic))
+      end)
+    end
+    
+    it "should render the string as the value of the button" do
+      output_buffer.should have_tag('li input[@value="Create User post"]')
+      output_buffer.should have_tag('li input[@value="Reset User post"]')
+      output_buffer.should have_tag('li input[@value="Cancel User post"]')
+    end
+
+  end
+
+end