formtastic 3.1.3 → 5.0.0

data/spec/generators/formtastic/input/input_generator_spec.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+require 'spec_helper'
+
+require 'generators/formtastic/input/input_generator'
+
+RSpec.describe Formtastic::InputGenerator do
+  include FormtasticSpecHelper
+
+  destination File.expand_path("../../../../../tmp", __FILE__)
+
+  before do
+    prepare_destination
+  end
+
+  after do
+    FileUtils.rm_rf(File.expand_path("../../../../../tmp", __FILE__))
+  end
+
+  describe 'without file name' do
+    it 'should raise Thor::RequiredArgumentMissingError' do
+      expect { run_generator }.to raise_error(Thor::RequiredArgumentMissingError)
+    end
+  end
+
+  describe "input generator with underscore definition" do
+    before { run_generator %w(hat_size)}
+
+    describe 'generate an input in its respective folder' do
+      subject{ file('app/inputs/hat_size_input.rb')}
+      it { is_expected.to exist}
+      it { is_expected.to contain "class HatSizeInput"}
+      it { is_expected.to contain "def to_html"}
+      it { is_expected.to contain "include Formtastic::Inputs::Base"}
+      it { is_expected.not_to contain "super"}
+    end
+  end
+
+  describe "input generator with camelcase definition" do
+    before { run_generator %w(HatSize)}
+
+    describe 'generate an input in its respective folder' do
+      subject{ file('app/inputs/hat_size_input.rb')}
+      it { is_expected.to exist}
+      it { is_expected.to contain "class HatSizeInput"}
+    end
+  end
+
+  describe "input generator with camelcase Input name sufixed" do
+    before { run_generator %w(HatSizeInput)}
+
+    describe 'generate an input in its respective folder' do
+      subject{ file('app/inputs/hat_size_input.rb')}
+      it { is_expected.to exist}
+      it { is_expected.to contain "class HatSizeInput"}
+    end
+  end
+
+  describe "input generator with underscore _input name sufixed" do
+    before { run_generator %w(hat_size_input)}
+
+    describe 'generate an input in its respective folder' do
+      subject{ file('app/inputs/hat_size_input.rb')}
+      it { is_expected.to exist}
+      it { is_expected.to contain "class HatSizeInput"}
+    end
+  end
+
+  describe "input generator with underscore input name sufixed" do
+    before { run_generator %w(hat_sizeinput)}
+
+    describe 'generate an input in its respective folder' do
+      subject{ file('app/inputs/hat_size_input.rb')}
+      it { is_expected.to exist}
+      it { is_expected.to contain "class HatSizeInput"}
+    end
+  end
+
+  describe "override an existing input using extend" do
+    before { run_generator %w(string --extend)}
+
+    describe 'app/inputs/string_input.rb' do
+      subject{ file('app/inputs/string_input.rb')}
+      it { is_expected.to exist }
+      it { is_expected.to contain "class StringInput < Formtastic::Inputs::StringInput" }
+      it { is_expected.to contain "def to_html" }
+      it { is_expected.not_to contain "include Formtastic::Inputs::Base" }
+      it { is_expected.to contain "super" }
+      it { is_expected.not_to contain "def input_html_options" }
+    end
+  end
+
+  describe "extend an existing input" do
+    before { run_generator %w(FlexibleText --extend string)}
+
+    describe 'app/inputs/flexible_text_input.rb' do
+      subject{ file('app/inputs/flexible_text_input.rb')}
+      it { is_expected.to contain "class FlexibleTextInput < Formtastic::Inputs::StringInput" }
+      it { is_expected.to contain "def input_html_options" }
+      it { is_expected.not_to contain "include Formtastic::Inputs::Base" }
+      it { is_expected.not_to contain "def to_html" }
+    end
+  end
+
+  describe "provide a slashed namespace" do
+    before { run_generator %w(stuff/foo)}
+
+    describe 'app/inputs/stuff/foo_input.rb' do
+      subject{ file('app/inputs/stuff/foo_input.rb')}
+      it {is_expected.to exist}
+      it { is_expected.to contain "class Stuff::FooInput" }
+      it { is_expected.to contain "include Formtastic::Inputs::Base" }
+    end
+  end
+
+  describe "provide a camelized namespace" do
+    before { run_generator %w(Stuff::Foo)}
+
+    describe 'app/inputs/stuff/foo_input.rb' do
+      subject{ file('app/inputs/stuff/foo_input.rb')}
+      it {is_expected.to exist}
+      it { is_expected.to contain "class Stuff::FooInput" }
+      it { is_expected.to contain "include Formtastic::Inputs::Base" }
+    end
+  end
+end

data/spec/generators/formtastic/install/install_generator_spec.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 # Generators are not automatically loaded by Rails
 require 'generators/formtastic/install/install_generator'
 
-describe Formtastic::InstallGenerator do
+RSpec.describe Formtastic::InstallGenerator do
   # Tell the generator where to put its output (what it thinks of as Rails.root)
   destination File.expand_path("../../../../../tmp", __FILE__)
 
@@ -14,14 +15,14 @@ describe Formtastic::InstallGenerator do
 
     describe 'config/initializers/formtastic.rb' do
       subject { file('config/initializers/formtastic.rb') }
-      it { should exist }
-      it { should contain "#" }
+      it { is_expected.to exist }
+      it { is_expected.to contain "#" }
     end
 
     describe 'lib/templates/erb/scaffold/_form.html.erb' do
       subject { file('lib/templates/erb/scaffold/_form.html.erb') }
-      it { should exist }
-      it { should contain "<%%= semantic_form_for @<%= singular_name %> do |f| %>" }
+      it { is_expected.to exist }
+      it { is_expected.to contain "<%%= semantic_form_for @<%= singular_name %> do |f| %>" }
     end
   end
 
@@ -30,8 +31,8 @@ describe Formtastic::InstallGenerator do
 
     describe 'lib/templates/erb/scaffold/_form.html.haml' do
       subject { file('lib/templates/haml/scaffold/_form.html.haml') }
-      it { should exist }
-      it { should contain "= semantic_form_for @<%= singular_name %> do |f|" }
+      it { is_expected.to exist }
+      it { is_expected.to contain "= semantic_form_for @<%= singular_name %> do |f|" }
     end
   end
 
@@ -40,8 +41,8 @@ describe Formtastic::InstallGenerator do
 
     describe 'lib/templates/erb/scaffold/_form.html.slim' do
       subject { file('lib/templates/slim/scaffold/_form.html.slim') }
-      it { should exist }
-      it { should contain "= semantic_form_for @<%= singular_name %> do |f|" }
+      it { is_expected.to exist }
+      it { is_expected.to contain "= semantic_form_for @<%= singular_name %> do |f|" }
     end
   end
 end

data/spec/helpers/action_helper_spec.rb

@@ -1,19 +1,338 @@
-# encoding: utf-8
+# frozen_string_literal: true
 require 'spec_helper'
 
-describe 'Formtastic::FormBuilder#action' do
-  include_context 'Action Helper' # from spec/support/shared_examples.rb
+RSpec.describe 'with action class finder' do
+  include_context 'form builder'
+
+  describe 'arguments and options' do
+
+    it 'should require the first argument (the action method)' do
+      expect {
+        concat(semantic_form_for(@new_post) do |builder|
+          concat(builder.action()) # no args passed in at all
+        end)
+      }.to raise_error(ArgumentError)
+    end
+
+    describe ':as option' do
+
+      describe 'when not provided' do
+
+        it 'should default to a commit for commit' do
+          concat(semantic_form_for(:project, :url => 'http://test.host') do |builder|
+            concat(builder.action(:submit))
+          end)
+          expect(output_buffer.to_str).to have_tag('form li.action.input_action', :count => 1)
+        end
+
+        it 'should default to a button for reset' do
+          concat(semantic_form_for(:project, :url => 'http://test.host') do |builder|
+            concat(builder.action(:reset))
+          end)
+          expect(output_buffer.to_str).to have_tag('form li.action.input_action', :count => 1)
+        end
+
+        it 'should default to a link for cancel' do
+          concat(semantic_form_for(:project, :url => 'http://test.host') do |builder|
+            concat(builder.action(:cancel))
+          end)
+          expect(output_buffer.to_str).to have_tag('form li.action.link_action', :count => 1)
+        end
+      end
+
+      it 'should call the corresponding action class with .to_html' do
+        [:input, :button, :link].each do |action_style|
+          semantic_form_for(:project, :url => "http://test.host") do |builder|
+            action_instance = double('Action instance')
+            action_class = "#{action_style.to_s}_action".classify
+            action_constant = "Formtastic::Actions::#{action_class}".constantize
+
+            expect(action_constant).to receive(:new).and_return(action_instance)
+            expect(action_instance).to receive(:to_html).and_return("some HTML")
+
+            concat(builder.action(:submit, :as => action_style))
+          end
+        end
+      end
+
+    end
+
+    #describe ':label option' do
+    #
+    #  describe 'when provided' do
+    #    it 'should be passed down to the label tag' do
+    #      concat(semantic_form_for(@new_post) do |builder|
+    #        concat(builder.input(:title, :label => "Kustom"))
+    #      end)
+    #      output_buffer.should have_tag("form li label", /Kustom/)
+    #    end
+    #
+    #    it 'should not generate a label if false' do
+    #      concat(semantic_form_for(@new_post) do |builder|
+    #        concat(builder.input(:title, :label => false))
+    #      end)
+    #      output_buffer.should_not have_tag("form li label")
+    #    end
+    #
+    #    it 'should be dupped if frozen' do
+    #      concat(semantic_form_for(@new_post) do |builder|
+    #        concat(builder.input(:title, :label => "Kustom".freeze))
+    #      end)
+    #      output_buffer.should have_tag("form li label", /Kustom/)
+    #    end
+    #  end
+    #
+    #  describe 'when not provided' do
+    #    describe 'when localized label is provided' do
+    #      describe 'and object is given' do
+    #        describe 'and label_str_method not :humanize' do
+    #          it 'should render a label with localized text and not apply the label_str_method' do
+    #            with_config :label_str_method, :reverse do
+    #              @localized_label_text = 'Localized title'
+    #              @new_post.stub(:meta_description)
+    #              ::I18n.backend.store_translations :en,
+    #                :formtastic => {
+    #                  :labels => {
+    #                    :meta_description => @localized_label_text
+    #                  }
+    #                }
+    #
+    #              concat(semantic_form_for(@new_post) do |builder|
+    #                concat(builder.input(:meta_description))
+    #              end)
+    #              output_buffer.should have_tag('form li label', /Localized title/)
+    #            end
+    #          end
+    #        end
+    #      end
+    #    end
+    #
+    #    describe 'when localized label is NOT provided' do
+    #      describe 'and object is not given' do
+    #        it 'should default the humanized method name, passing it down to the label tag' do
+    #          ::I18n.backend.store_translations :en, :formtastic => {}
+    #          with_config :label_str_method, :humanize do
+    #            concat(semantic_form_for(:project, :url => 'http://test.host') do |builder|
+    #              concat(builder.input(:meta_description))
+    #            end)
+    #            output_buffer.should have_tag("form li label", /#{'meta_description'.humanize}/)
+    #          end
+    #        end
+    #      end
+    #
+    #      describe 'and object is given' do
+    #        it 'should delegate the label logic to class human attribute name and pass it down to the label tag' do
+    #          @new_post.stub(:meta_description) # a two word method name
+    #          @new_post.class.should_receive(:human_attribute_name).with('meta_description').and_return('meta_description'.humanize)
+    #
+    #          concat(semantic_form_for(@new_post) do |builder|
+    #            concat(builder.input(:meta_description))
+    #          end)
+    #          output_buffer.should have_tag("form li label", /#{'meta_description'.humanize}/)
+    #        end
+    #      end
+    #
+    #      describe 'and object is given with label_str_method set to :capitalize' do
+    #        it 'should capitalize method name, passing it down to the label tag' do
+    #          with_config :label_str_method, :capitalize do
+    #            @new_post.stub(:meta_description)
+    #
+    #            concat(semantic_form_for(@new_post) do |builder|
+    #              concat(builder.input(:meta_description))
+    #            end)
+    #            output_buffer.should have_tag("form li label", /#{'meta_description'.capitalize}/)
+    #          end
+    #        end
+    #      end
+    #    end
+    #
+    #    describe 'when localized label is provided' do
+    #      before do
+    #        @localized_label_text = 'Localized title'
+    #        @default_localized_label_text = 'Default localized title'
+    #        ::I18n.backend.store_translations :en,
+    #          :formtastic => {
+    #              :labels => {
+    #                :title => @default_localized_label_text,
+    #                :published => @default_localized_label_text,
+    #                :post => {
+    #                  :title => @localized_label_text,
+    #                  :published => @default_localized_label_text
+    #                 }
+    #               }
+    #            }
+    #      end
+    #
+    #      it 'should render a label with localized label (I18n)' do
+    #        with_config :i18n_lookups_by_default, false do
+    #          concat(semantic_form_for(@new_post) do |builder|
+    #            concat(builder.input(:title, :label => true))
+    #            concat(builder.input(:published, :as => :boolean, :label => true))
+    #          end)
+    #          output_buffer.should have_tag('form li label', Regexp.new('^' + @localized_label_text))
+    #        end
+    #      end
+    #
+    #      it 'should render a hint paragraph containing an optional localized label (I18n) if first is not set' do
+    #        with_config :i18n_lookups_by_default, false do
+    #          ::I18n.backend.store_translations :en,
+    #            :formtastic => {
+    #                :labels => {
+    #                  :post => {
+    #                    :title => nil,
+    #                    :published => nil
+    #                   }
+    #                 }
+    #              }
+    #          concat(semantic_form_for(@new_post) do |builder|
+    #            concat(builder.input(:title, :label => true))
+    #            concat(builder.input(:published, :as => :boolean, :label => true))
+    #          end)
+    #          output_buffer.should have_tag('form li label', Regexp.new('^' + @default_localized_label_text))
+    #        end
+    #      end
+    #    end
+    #  end
+    #
+    #end
+    #
+    describe ':wrapper_html option' do
+
+      describe 'when provided' do
+        it 'should be passed down to the li tag' do
+          concat(semantic_form_for(@new_post) do |builder|
+            concat(builder.action(:submit, :wrapper_html => {:id => :another_id}))
+          end)
+          expect(output_buffer.to_str).to have_tag("form li#another_id")
+        end
+
+        it 'should append given classes to li default classes' do
+          concat(semantic_form_for(@new_post) do |builder|
+            concat(builder.action(:submit, :wrapper_html => {:class => :another_class}))
+          end)
+          expect(output_buffer.to_str).to have_tag("form li.action")
+          expect(output_buffer.to_str).to have_tag("form li.input_action")
+          expect(output_buffer.to_str).to have_tag("form li.another_class")
+        end
+
+        it 'should allow classes to be an array' do
+          concat(semantic_form_for(@new_post) do |builder|
+            concat(builder.action(:submit, :wrapper_html => {:class => [ :my_class, :another_class ]}))
+          end)
+          expect(output_buffer.to_str).to have_tag("form li.action")
+          expect(output_buffer.to_str).to have_tag("form li.input_action")
+          expect(output_buffer.to_str).to have_tag("form li.my_class")
+          expect(output_buffer.to_str).to have_tag("form li.another_class")
+        end
+      end
+
+      describe 'when not provided' do
+        it 'should use default id and class' do
+          concat(semantic_form_for(@new_post) do |builder|
+            concat(builder.action(:submit))
+          end)
+          expect(output_buffer.to_str).to have_tag("form li#post_submit_action")
+          expect(output_buffer.to_str).to have_tag("form li.action")
+          expect(output_buffer.to_str).to have_tag("form li.input_action")
+        end
+      end
+
+    end
+
+  end
 
-  # TODO: remove this in Formtastic 4.0
   describe 'instantiating an action class' do
-    context 'of unknown action' do
-      it "should try to load class named as the action" do
+    context 'when a class does not exist' do
+      it "should raise an error" do
         expect {
-          semantic_form_for(@new_post) do |builder|
-            builder.action(:destroy)
-          end
-        }.to raise_error(Formtastic::UnknownActionError, 'Unable to find action destroy')
+          concat(semantic_form_for(@new_post) do |builder|
+            builder.action(:submit, :as => :non_existant)
+          end)
+        }.to raise_error(Formtastic::UnknownActionError)
       end
     end
+
+    context 'when a customized top-level class does not exist' do
+      it 'should instantiate the Formtastic action' do
+        action = double('action', :to_html => 'some HTML')
+        expect(Formtastic::Actions::ButtonAction).to receive(:new).and_return(action)
+        concat(semantic_form_for(@new_post) do |builder|
+          builder.action(:commit, :as => :button)
+        end)
+      end
+    end
+
+    describe 'when a top-level (custom) action class exists' do
+      it "should instantiate the top-level action instead of the Formtastic one" do
+        class ::ButtonAction < Formtastic::Actions::ButtonAction
+        end
+
+        action = double('action', :to_html => 'some HTML')
+        expect(Formtastic::Actions::ButtonAction).not_to receive(:new)
+        expect(::ButtonAction).to receive(:new).and_return(action)
+
+        concat(semantic_form_for(@new_post) do |builder|
+          builder.action(:commit, :as => :button)
+        end)
+      end
+    end
+
+    describe 'support for :as on each action' do
+
+      it "should raise an error when the action does not support the :as" do
+        expect {
+          concat(semantic_form_for(@new_post) do |builder|
+            concat(builder.action(:submit, :as => :link))
+          end)
+        }.to raise_error(Formtastic::UnsupportedMethodForAction)
+
+        expect {
+          concat(semantic_form_for(@new_post) do |builder|
+            concat(builder.action(:cancel, :as => :input))
+          end)
+        }.to raise_error(Formtastic::UnsupportedMethodForAction)
+
+        expect {
+          concat(semantic_form_for(@new_post) do |builder|
+            concat(builder.action(:cancel, :as => :button))
+          end)
+        }.to raise_error(Formtastic::UnsupportedMethodForAction)
+      end
+
+      it "should not raise an error when the action does not support the :as" do
+        expect {
+          concat(semantic_form_for(@new_post) do |builder|
+            concat(builder.action(:cancel, :as => :link))
+          end)
+        }.not_to raise_error
+
+        expect {
+          concat(semantic_form_for(@new_post) do |builder|
+            concat(builder.action(:submit, :as => :input))
+          end)
+        }.not_to raise_error
+
+        expect {
+          concat(semantic_form_for(@new_post) do |builder|
+            concat(builder.action(:submit, :as => :button))
+          end)
+        }.not_to raise_error
+
+        expect {
+          concat(semantic_form_for(@new_post) do |builder|
+            concat(builder.action(:reset, :as => :input))
+          end)
+        }.not_to raise_error
+
+        expect {
+          concat(semantic_form_for(@new_post) do |builder|
+            concat(builder.action(:reset, :as => :button))
+          end)
+        }.not_to raise_error
+      end
+
+    end
+
   end
+
 end