formtastic 2.1.0 → 4.0.0

data/lib/generators/templates/formtastic.rb

@@ -1,13 +1,5 @@
 # encoding: utf-8
 
-# --------------------------------------------------------------------------------------------------
-# Please note: If you're subclassing Formtastic::FormBuilder, Formtastic uses
-# class_attribute for these configuration attributes instead of the deprecated
-# class_inheritable_attribute. The behaviour is slightly different with subclasses (especially
-# around attributes with Hash or Array) values, so make sure you understand what's happening.
-# See the documentation for class_attribute in ActiveSupport for more information.
-# --------------------------------------------------------------------------------------------------
-
 # Set the default text field size when input is a string. Default is nil.
 # Formtastic::FormBuilder.default_text_field_size = 50
 
@@ -25,15 +17,15 @@
 # Defaults to true.
 # Formtastic::FormBuilder.include_blank_for_select_by_default = true
 
-# Set the string that will be appended to the labels/fieldsets which are required
+# Set the string that will be appended to the labels/fieldsets which are required.
 # It accepts string or procs and the default is a localized version of
 # '<abbr title="required">*</abbr>'. In other words, if you configure formtastic.required
 # in your locale, it will replace the abbr title properly. But if you don't want to use
-# abbr tag, you can simply give a string as below
+# abbr tag, you can simply give a string as below.
 # Formtastic::FormBuilder.required_string = "(required)"
 
-# Set the string that will be appended to the labels/fieldsets which are optional
-# Defaults to an empty string ("") and also accepts procs (see required_string above)
+# Set the string that will be appended to the labels/fieldsets which are optional.
+# Defaults to an empty string ("") and also accepts procs (see required_string above).
 # Formtastic::FormBuilder.optional_string = "(optional)"
 
 # Set the way inline errors will be displayed.
@@ -41,7 +33,7 @@
 # Formtastic::FormBuilder.inline_errors = :sentence
 # Formtastic uses the following classes as default for hints, inline_errors and error list
 
-# If you override the class here, please ensure to override it in your stylesheets as well
+# If you override the class here, please ensure to override it in your stylesheets as well.
 # Formtastic::FormBuilder.default_hint_class = "inline-hints"
 # Formtastic::FormBuilder.default_inline_error_class = "inline-errors"
 # Formtastic::FormBuilder.default_error_list_class = "errors"
@@ -57,20 +49,14 @@
 # Formtastic::FormBuilder.collection_label_methods = [
 #   "to_label", "display_name", "full_name", "name", "title", "username", "login", "value", "to_s"]
 
-# Additionally, you can customize the order for specific types of inputs.
-# This is configured on a type basis and if a type is not found it will
-# fall back to the default order as defined by #inline_order
-# Formtastic::FormBuilder.custom_inline_order[:checkbox] = [:errors, :hints, :input]
-# Formtastic::FormBuilder.custom_inline_order[:select] = [:hints, :input, :errors]
-
 # Specifies if labels/hints for input fields automatically be looked up using I18n.
 # Default value: true. Overridden for specific fields by setting value to true,
 # i.e. :label => true, or :hint => true (or opposite depending on initialized value)
 # Formtastic::FormBuilder.i18n_lookups_by_default = false
 
 # Specifies if I18n lookups of the default I18n Localizer should be cached to improve performance.
-# Defaults to false.
-# Formtastic::FormBuilder.i18n_cache_lookups = true
+# Defaults to true.
+# Formtastic::FormBuilder.i18n_cache_lookups = 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).
@@ -80,11 +66,46 @@
 # specifying that class here.  Defaults to Formtastic::FormBuilder.
 # Formtastic::Helpers::FormHelper.builder = MyCustomBuilder
 
-# You can opt-in to Formtastic's use of the HTML5 `required` attribute on `<input>`, `<select>` 
-# and `<textarea>` tags by setting this to false (defaults to true).
-# Formtastic::FormBuilder.use_required_attribute = true
+# All formtastic forms have a class that indicates that they are just that. You
+# can change it to any class you want.
+# Formtastic::Helpers::FormHelper.default_form_class = 'formtastic'
+
+# Formtastic will infer a class name from the model, array, string or symbol you pass to the
+# form builder. You can customize the way that class is presented by overriding
+# this proc.
+# Formtastic::Helpers::FormHelper.default_form_model_class_proc = proc { |model_class_name| model_class_name }
+
+# Allows to set a custom field_error_proc wrapper. By default this wrapper
+# is disabled since `formtastic` already adds an error class to the LI tag
+# containing the input.
+# Formtastic::Helpers::FormHelper.formtastic_field_error_proc = proc { |html_tag, instance_tag| html_tag }
+
+# You can opt-in to Formtastic's use of the HTML5 `required` attribute on `<input>`, `<select>`
+# and `<textarea>` tags by setting this to true (defaults to false).
+# Formtastic::FormBuilder.use_required_attribute = false
 
 # You can opt-in to new HTML5 browser validations (for things like email and url inputs) by setting
-# this to false. Doing so will add a `novalidate` attribute to the `<form>` tag.
+# this to true. Doing so will omit the `novalidate` attribute from the `<form>` tag.
 # See http://diveintohtml5.org/forms.html#validation for more info.
 # Formtastic::FormBuilder.perform_browser_validations = true
+
+# By creating custom input class finder, you can change how input classes  are looked up.
+# For example you can make it to search for TextInputFilter instead of TextInput.
+# See https://github.com/formtastic/formtastic/wiki/Custom-Class-Finders
+# Formtastic::FormBuilder.input_class_finder = Formtastic::InputClassFinder
+
+# Define custom namespaces in which to look up your Input classes. Default is
+# to look up in the global scope and in Formtastic::Inputs.
+# Formtastic::FormBuilder.input_namespaces = [ ::Object, ::MyInputsModule, ::Formtastic::Inputs ]
+
+# By creating custom action class finder, you can change how action classes are looked up.
+# For example you can make it to search for MyButtonAction instead of ButtonAction.
+# See https://github.com/formtastic/formtastic/wiki/Custom-Class-Finders
+# Formtastic::FormBuilder.action_class_finder = Formtastic::ActionClassFinder
+
+# Define custom namespaces in which to look up your Action classes. Default is
+# to look up in the global scope and in Formtastic::Actions.
+# Formtastic::FormBuilder.action_namespaces = [ ::Object, ::MyActionsModule, ::Formtastic::Actions ]
+
+# Which columns to skip when automatically rendering a form without any fields specified.
+# Formtastic::FormBuilder.skipped_columns = [:created_at, :updated_at, :created_on, :updated_on, :lock_version, :version]

data/lib/generators/templates/input.rb

@@ -0,0 +1,19 @@
+class <%= name.camelize %>Input <%= @extension_sentence %>
+  <%- if !options[:extend] -%>
+  include Formtastic::Inputs::Base
+  <%- end -%>
+
+  <%- if !options[:extend] || (options[:extend] == "extend")  -%>
+  def to_html
+    # Add your custom input definition here.
+    <%- if options[:extend] == "extend" -%>
+    super
+    <%- end -%>
+  end
+
+  <%- else -%>
+  def input_html_options
+    # Add your custom input extension here.
+  end
+  <%- end -%>
+end

data/sample/basic_inputs.html

@@ -36,7 +36,7 @@
         <li class="input url stringish optional" id="gem_url_input">
           <label class="label" for="gem_url">URL</label>
           <input id="gem_url" name="gem[url]" type="url">
-          <p class="inline-hints">Example: https://github.com/justinfrench/formtastic</p>
+          <p class="inline-hints">Example: https://github.com/formtastic/formtastic</p>
         </li>
 
         <li class="input password stringish required" id="gem_password_input">
@@ -101,7 +101,27 @@
             </ol>
           </fieldset>
         </li>
-
+        
+        <li class="input date_picker optional">
+          <label class="label" for="gem_expiry">Expiry date</label>
+          <input id="gem_expiry" name="gem[gem_expiry]" type="date" size="10" maxlength="10" min="2012-01-01" max="2012-12-31" step="1" value="2012-01-01">
+        </li>
+        
+        <li class="input datetime_picker optional">
+          <label class="label" for="gem_expiry">Expiry datetime-local</label>
+          <input id="gem_expiry" name="gem[gem_expiry]" type="datetime-local" size="16" maxlength="16" min="2012-01-01T00:00" max="2012-12-31T23:59" step="1800">
+        </li>
+        
+        <li class="input datetime_picker optional">
+          <label class="label" for="gem_expiry">Expiry datetime</label>
+          <input id="gem_expiry" name="gem[gem_expiry]" type="datetime" size="16" maxlength="16" min="2012-01-01T00:00" max="2012-12-31T23:59" step="1800">
+        </li>
+        
+        <li class="input time_picker optional">
+          <label class="label" for="gem_expiry">Expiry time</label>
+          <input id="gem_expiry" name="gem[gem_expiry]" type="time" size="5" maxlength="5" min="T00:00" max="23:59" step="60">
+        </li>
+        
         <li class="input string stringish optional autofocus" id="gem_autofocus_input">
           <label class="label" for="gem_autofocus">Autofocus</label>
           <input id="gem_autofocus" name="gem[autofocus]" type="text" value="The focus is set to this field" autofocus="autofocus">
@@ -195,7 +215,7 @@
           <button id="gem_submit" type="reset">Reset</button>
         </li>
         <li class="action link_action">
-          <a href="#">Cancel</button>
+          <a href="#">Cancel</a>
         </li>
       </ol>
     </fieldset>

data/script/integration-template.rb

@@ -0,0 +1,74 @@
+gem 'formtastic', path: '..'
+gem 'bcrypt', '~> 3.1.7'
+gem 'rails-dom-testing', group: :test
+gem 'rexml', '~> 3.2' # to compensate for missing dependency in selenium-webdriver
+
+# to speed up bundle install, reuse the bundle path
+def bundle_path
+  File.expand_path ENV.fetch('BUNDLE_PATH', 'vendor/bundle')
+end
+
+if Rails.version >= '6.2'
+    gsub_file 'Gemfile', /gem 'rails'.*/, "gem 'rails', '~> #{Rails.version}', github: 'rails/rails'"
+elsif Rails.version >= '6.1'
+    gsub_file 'Gemfile', /gem 'rails'.*/, "gem 'rails', '~> #{Rails.version}', github: 'rails/rails', branch: '6-1-stable'"
+elsif Rails.version >= '6.0'
+    gsub_file 'Gemfile', /gem 'rails'.*/, "gem 'rails', '~> #{Rails.version}', github: 'rails/rails', branch: '6-0-stable'"
+elsif Rails.version >= '5.2'
+    gsub_file 'Gemfile', /gem 'rails'.*/, "gem 'rails', '~> #{Rails.version}', github: 'rails/rails', branch: '5-2-stable'"
+end
+
+### Ensure Dummy App's Ruby version matches the current environments Ruby Version
+ruby_version = "ruby '#{RUBY_VERSION}'"
+gsub_file 'Gemfile', /ruby '\d+.\d+.\d+'/, ruby_version
+
+if bundle_install?
+  def run_bundle
+    previous_bundle_path = bundle_path
+
+    require "bundler"
+    Bundler.with_clean_env do
+      system("bundle install --jobs=3 --retry=3 --path=#{previous_bundle_path}")
+    end
+  end
+end
+
+in_root do
+  ENV['BUNDLE_GEMFILE'] = File.expand_path('Gemfile')
+end
+
+formtastic = -> do
+  generate(:scaffold, 'user name:string password:digest')
+  generate('formtastic:install')
+  generate('formtastic:form', 'user name password:password --force')
+
+  rails_command('db:migrate')
+
+  in_root do
+    inject_into_class 'app/models/user.rb', 'User', "  has_secure_password\n"
+    inject_into_file 'app/assets/stylesheets/application.css', " *= require formtastic\n", before: ' *= require_self'
+    inject_into_class 'test/controllers/users_controller_test.rb', 'UsersControllerTest', <<-RUBY
+
+    test "should show form" do
+      get edit_user_path(@user)
+
+      assert_select 'form' do
+        assert_select 'li.input.string' do
+          assert_select 'input#user_name[type=text]'
+        end
+        assert_select 'li.input.password' do
+          assert_select 'input#user_password[type=password]'
+        end
+
+        assert_select 'fieldset.actions' do
+          assert_select 'li.action.input_action' do
+            assert_select 'input[type=submit]'
+          end
+        end
+      end
+    end # test "should show form"
+    RUBY
+  end
+end
+
+after_bundle(&formtastic)

data/script/integration.sh

@@ -0,0 +1,19 @@
+#!/usr/bin/env sh
+
+set -e
+set -o verbose
+
+test_app=dummy
+
+rm -rf ${test_app}
+
+bundle exec rails new ${test_app} \
+  --template=$(dirname "$0")/integration-template.rb \
+  --skip-bootsnap \
+  --skip-javascript \
+  --skip-spring \
+  --skip-turbolinks
+
+cd ${test_app} && export BUNDLE_GEMFILE=Gemfile
+
+bundle exec rake test

data/spec/action_class_finder_spec.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+require 'spec_helper'
+require 'formtastic/action_class_finder'
+
+RSpec.describe Formtastic::ActionClassFinder do
+  include FormtasticSpecHelper
+
+  it_behaves_like 'Specialized Class Finder' do
+    let(:default) { Formtastic::Actions }
+    let(:namespaces_setting) { :action_namespaces }
+  end
+end

data/spec/actions/button_action_spec.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 require 'spec_helper'
 
-describe 'ButtonAction', 'when submitting' do
+RSpec.describe 'ButtonAction', 'when submitting' do
 
   include FormtasticSpecHelper
 
@@ -15,12 +15,12 @@ describe 'ButtonAction', 'when submitting' do
   end
   
   it 'should render a submit type of button' do
-    output_buffer.should have_tag('li.action.button_action button[@type="submit"]')
+    expect(output_buffer).to have_tag('li.action.button_action button[@type="submit"]')
   end
 
 end
 
-describe 'ButtonAction', 'when resetting' do
+RSpec.describe 'ButtonAction', 'when resetting' do
 
   include FormtasticSpecHelper
   
@@ -34,16 +34,16 @@ describe 'ButtonAction', 'when resetting' do
   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")
+    expect(output_buffer).to 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]')
+    expect(output_buffer).not_to have_tag('li.action.button_action button[@value]')
   end
   
 end
 
-describe 'InputAction', 'when cancelling' do
+RSpec.describe 'InputAction', 'when cancelling' do
 
   include FormtasticSpecHelper
   
@@ -53,11 +53,11 @@ describe 'InputAction', 'when cancelling' do
   end
   
   it 'should raise an error' do
-    lambda { 
+    expect { 
       concat(semantic_form_for(@new_post) do |builder|
         concat(builder.action(:cancel, :as => :button))
       end)
-    }.should raise_error(Formtastic::UnsupportedMethodForAction)
+    }.to raise_error(Formtastic::UnsupportedMethodForAction)
   end
   
 end