formtastic 3.1.2 → 4.0.0

data/lib/formtastic/localizer.rb

@@ -1,5 +1,5 @@
 module Formtastic
-  # Implementation for looking up localized values within Formtastic using I18n, if no 
+  # Implementation for looking up localized values within Formtastic using I18n, if no
   # explicit value (like the `:label` option) is set and I18n-lookups are enabled in the
   # configuration.
   #
@@ -28,50 +28,50 @@ module Formtastic
       def get(key)
         cache[key]
       end
-    
+
       def has_key?(key)
         cache.has_key?(key)
       end
-    
+
       def set(key, result)
         cache[key] = result
       end
-    
+
       def cache
         @cache ||= {}
       end
-    
+
       def clear!
         cache.clear
       end
     end
-        
+
     attr_accessor :builder
-    
+
     def self.cache
       @cache ||= Cache.new
     end
-    
+
     def initialize(current_builder)
-      self.builder = current_builder 
+      self.builder = current_builder
     end
 
     def localize(key, value, type, options = {}) # @private
       key = value if value.is_a?(::Symbol)
-      
+
       if value.is_a?(::String)
         escape_html_entities(value)
       else
         use_i18n = value.nil? ? i18n_lookups_by_default : (value != false)
         use_cache = i18n_cache_lookups
         cache = self.class.cache
-        
+
         if use_i18n
           model_name, nested_model_name  = normalize_model_name(builder.model_name.underscore)
 
           action_name = builder.template.params[:action].to_s rescue ''
           attribute_name = key.to_s
-          
+
           # look in the cache first
           if use_cache
             cache_key = [::I18n.locale, action_name, model_name, nested_model_name, attribute_name, key, value, type, options]
@@ -86,7 +86,7 @@ module Formtastic
             i18n_path.gsub!('%{model}', model_name)
             i18n_path.gsub!('%{nested_model}', nested_model_name) unless nested_model_name.nil?
             i18n_path.gsub!('%{attribute}', attribute_name)
-            i18n_path.gsub!('..', '.')
+            i18n_path.tr!('..', '.')
             i18n_path.to_sym
           end
           defaults << ''
@@ -101,9 +101,9 @@ module Formtastic
             # This is effectively what Rails label helper does for i18n lookup
             options[:scope] = [:helpers, type]
             options[:default] = defaults
-            i18n_value = ::I18n.t(default_key, options)
+            i18n_value = ::I18n.t(default_key, **options)
           end
-          
+
           # save the result to the cache
           result = (i18n_value.is_a?(::String) && i18n_value.present?) ? escape_html_entities(i18n_value) : nil
           cache.set(cache_key, result) if use_cache
@@ -115,16 +115,14 @@ module Formtastic
     protected
 
     def normalize_model_name(name)
-      if !name =~ /\[/ && builder.respond_to?(:parent_builder) && builder.parent_builder.object_name
-        # Rails 3.1 nested builder case
-        [builder.parent_builder.object_name.to_s, name]
-      elsif name =~ /(.+)\[(.+)\]/
-        # Rails 3 (and 3.1?) nested builder case with :post rather than @post
+      if name =~ /(.+)\[(.+)\]/
+        # Nested builder case with :post rather than @post
+        # TODO: check if this is no longer required with a minimum of Rails 4.1
         [$1, $2]
       elsif builder.respond_to?(:options) && builder.options.key?(:as)
         [builder.options[:as].to_s]
       elsif builder.respond_to?(:options) && builder.options.key?(:parent_builder)
-        # Rails 3.0 nested builder work-around case, where :parent_builder is provided by f.semantic_form_for
+        # Rails 3.0+ nested builder work-around case, where :parent_builder is provided by f.semantic_form_for
         [builder.options[:parent_builder].object_name.to_s, name]
       else
         # Non-nested case
@@ -143,7 +141,7 @@ module Formtastic
     def i18n_lookups_by_default
       builder.i18n_lookups_by_default
     end
-    
+
     def i18n_cache_lookups
       builder.i18n_cache_lookups
     end

data/lib/formtastic/namespaced_class_finder.rb

@@ -29,7 +29,7 @@ module Formtastic
     end
 
     def self.use_const_defined?
-      defined?(Rails) && ::Rails.application && ::Rails.application.config.eager_load
+      defined?(Rails) && ::Rails.application && ::Rails.application.config.respond_to?(:eager_load) && ::Rails.application.config.eager_load
     end
 
     # @param namespaces [Array<Module>]

data/lib/formtastic/version.rb

@@ -1,3 +1,3 @@
 module Formtastic
-  VERSION = "3.1.2"
+  VERSION = "4.0.0"
 end

data/lib/generators/formtastic/form/form_generator.rb

@@ -75,7 +75,7 @@ module Formtastic
     # Skips Active Record Timestamps.
     def content_columns
       model.content_columns.select do |column|
-        !Formtastic::Helpers::InputsHelper::SKIPPED_COLUMNS.include? column.name.to_sym
+        !Formtastic::FormBuilder.skipped_columns.include? column.name.to_sym
       end
     end
 

data/lib/generators/formtastic/input/input_generator.rb

@@ -0,0 +1,46 @@
+module Formtastic
+
+  # Modify existing inputs, subclass them, or create your own from scratch.
+  # @example
+  # !!!shell
+  #   $ rails generate formtastic:input HatSize
+
+  # @example Define input name using underscore convention
+  # !!!shell
+  #   $ rails generate formtastic:input hat_size
+
+  # @example Override an existing input behavior
+  # !!!shell
+  #   $ rails generate formtastic:input string --extend
+
+  # @example Extend an existing input behavior
+  # !!!shell
+  #   $ rails generate formtastic:input FlexibleText --extend string
+  class InputGenerator < Rails::Generators::NamedBase
+
+    argument :name, :type => :string, :required => true, :banner => 'FILE_NAME'
+
+    source_root File.expand_path('../../../templates', __FILE__)
+
+    class_option :extend
+
+    def create
+      normalize_file_name
+      define_extension_sentence
+      template "input.rb", "app/inputs/#{name.underscore}_input.rb"
+    end
+
+    protected
+
+    def normalize_file_name
+      name.chomp!("Input")  if name.ends_with?("Input")
+      name.chomp!("_input") if name.ends_with?("_input")
+      name.chomp!("input")  if name.ends_with?("input")
+    end
+
+    def define_extension_sentence
+      @extension_sentence = "< Formtastic::Inputs::#{name.camelize}Input" if options[:extend] == "extend"
+      @extension_sentence ||= "< Formtastic::Inputs::#{options[:extend].camelize}Input" if options[:extend]
+    end
+  end
+end

data/lib/generators/templates/formtastic.rb

@@ -17,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.
@@ -33,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"
@@ -70,7 +70,7 @@
 # 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 ot symbol you pass to the
+# 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 }
@@ -85,15 +85,14 @@
 # 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 true. 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 # TODO: add link # for more information
-# NOTE: this behavior will be default from Formtastic 4.0
-Formtastic::FormBuilder.input_class_finder = Formtastic::InputClassFinder
+# 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.
@@ -101,10 +100,12 @@ Formtastic::FormBuilder.input_class_finder = Formtastic::InputClassFinder
 
 # 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 # TODO: add link # for more information
-# NOTE: this behavior will be default from Formtastic 4.0
-Formtastic::FormBuilder.action_class_finder = Formtastic::ActionClassFinder
+# 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">

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

@@ -2,7 +2,7 @@
 require 'spec_helper'
 require 'formtastic/action_class_finder'
 
-describe Formtastic::ActionClassFinder do
+RSpec.describe Formtastic::ActionClassFinder do
   include FormtasticSpecHelper
 
   it_behaves_like 'Specialized Class Finder' do

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