formtastic 5.0.0 → 6.0.0.alpha

data/lib/formtastic/inputs/base/aria.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+module Formtastic
+  module Inputs
+    module Base
+      module Aria
+
+        def error_aria_attributes
+          return {} unless builder.semantic_errors_link_to_inputs
+          return {} unless errors?
+
+          {
+            'aria-describedby': describedby,
+            'aria-invalid': options.dig(:input_html, :'aria-invalid') || 'true'
+          }
+        end
+
+        def describedby
+          describedby = options.dig(:input_html, :'aria-describedby') || ''
+          describedby += ' ' unless describedby.empty?
+          describedby += "#{method}_error"
+        end
+
+      end
+    end
+  end
+end

data/lib/formtastic/inputs/base/collections.rb

@@ -53,7 +53,7 @@ module Formtastic
 
           # Return if we have an Array of strings, integers or arrays
           return raw_collection if (raw_collection.instance_of?(Array) || raw_collection.instance_of?(Range)) &&
-                               ([Array, String].include?(raw_collection.first.class) || raw_collection.first.is_a?(Integer)) &&
+                               ([Array, String, Symbol].include?(raw_collection.first.class) || raw_collection.first.is_a?(Integer)) &&
                                !(options.include?(:member_label) || options.include?(:member_value))
 
           raw_collection.map { |o| [send_or_call(label_method, o), send_or_call(value_method, o)] }

data/lib/formtastic/inputs/base/errors.rb

@@ -10,7 +10,7 @@ module Formtastic
         
         def error_sentence_html
           error_class = builder.default_inline_error_class
-          template.content_tag(:p, errors.to_sentence, :class => error_class)
+          template.content_tag(:p, errors.to_sentence, id: "#{method}_error", :class => error_class)
         end
                 
         def error_list_html

data/lib/formtastic/inputs/base/html.rb

@@ -25,7 +25,7 @@ module Formtastic
             :required => required_attribute?,
             :autofocus => autofocus?,
             :readonly => readonly?
-          }.merge(options[:input_html] || {})
+          }.merge(options[:input_html] || {}).merge(error_aria_attributes)
         end
 
         def dom_id

data/lib/formtastic/inputs/base/labelling.rb

@@ -14,7 +14,7 @@ module Formtastic
           {
             :for => input_html_options[:id],
             :class => ['label'],
-          }
+          }.merge(options[:label_html] || {})
         end
         
         def label_text

data/lib/formtastic/inputs/base/validations.rb

@@ -57,7 +57,8 @@ module Formtastic
             validation.kind == :length
           end
           if validation
-            validation.options[:maximum] || (validation.options[:within].present? ? validation.options[:within].max : nil)
+            option_value(validation.options[:maximum], object) ||
+              (validation.options[:within].present? ? option_value(validation.options[:within], object).max : nil)
           else
             nil
           end
@@ -145,8 +146,8 @@ module Formtastic
                 validator.options[:allow_blank] != true
               when :length
                 validator.options[:allow_blank] != true &&
-                validator.options[:minimum].to_i > 0 ||
-                validator.options[:within].try(:first).to_i > 0
+                option_value(validator.options[:minimum], object).to_i > 0 ||
+                option_value(validator.options[:within], object).try(:first).to_i > 0
               else
                 false
               end
@@ -183,7 +184,22 @@ module Formtastic
         end
 
         def column_limit
-          column.limit if column? && column.respond_to?(:limit)
+          return unless column?
+          return unless column.respond_to?(:limit)
+
+          limit = column.limit # already in characters for string, text, etc
+
+          if column.type == :integer && column.limit.is_a?(Integer)
+            return {
+              1 => 3, # 8 bit
+              2 => 5, # 16 bit
+              3 => 7, # 24 bit
+              4 => 10, # 32 bit
+              8 => 19, # 64 bit
+            }[limit] || nil
+          end
+
+          return limit
         end
 
         def limit
@@ -208,16 +224,24 @@ module Formtastic
 
         private
 
-        # Loosely based on
-        # https://github.com/rails/rails/blob/459e7cf62252558bbf65f582a230562ab1a76c5e/activemodel/lib/active_model/validations/numericality.rb#L65-L70
+        # Implements `ActiveModel::Validations::ResolveValue`, introduced by Rails 7.1.
+        # https://github.com/rails/rails/blob/v7.1.0/activemodel/lib/active_model/validations/resolve_value.rb
         def option_value(option, object)
           case option
           when Symbol
             object.send(option)
           when Proc
-            option.call(object)
+            if option.arity == 0
+              option.call
+            else
+              option.call(object)
+            end
           else
-            option
+            if option.respond_to?(:call)
+              option.call(object)
+            else
+              option
+            end
           end
         end
       end

data/lib/formtastic/inputs/base.rb

@@ -22,7 +22,7 @@ module Formtastic
       # Usefull for deprecating options.
       def warn_and_correct_option!(old_option_name, new_option_name)
         if options.key?(old_option_name)
-          Deprecation.warn("The :#{old_option_name} option is deprecated in favour of :#{new_option_name} and will be removed from Formtastic in the next version", caller(6))
+          Deprecation.warn("The :#{old_option_name} option is deprecated in favour of :#{new_option_name} and will be removed from Formtastic in the next version", caller_locations(6))
           options[new_option_name] = options.delete(old_option_name)
         end
       end
@@ -30,7 +30,7 @@ module Formtastic
       # Usefull for deprecating options.
       def warn_deprecated_option!(old_option_name, instructions)
         if options.key?(old_option_name)
-          Deprecation.warn("The :#{old_option_name} option is deprecated in favour of `#{instructions}`. :#{old_option_name} will be removed in the next version", caller(6))
+          Deprecation.warn("The :#{old_option_name} option is deprecated in favour of `#{instructions}`. :#{old_option_name} will be removed in the next version", caller_locations(6))
         end
       end
 
@@ -59,6 +59,7 @@ module Formtastic
       autoload :Timeish
       autoload :Validations
       autoload :Wrapping
+      autoload :Aria
 
       include Html
       include Options
@@ -71,6 +72,7 @@ module Formtastic
       include Associations
       include Labelling
       include Wrapping
+      include Aria
 
     end
   end

data/lib/formtastic/inputs/country_input.rb

@@ -5,13 +5,10 @@ module Formtastic
     # Rails doesn't come with a `country_select` helper by default any more, so you'll need to do
     # one of the following:
     #
-    # * install the [country_select](https://github.com/stefanpenner/country_select) gem
+    # * install the [country_select](https://github.com/countries/country_select) gem
     # * install any other country_select plugin that behaves in a similar way
     # * roll your own `country_select` helper with the same args and options as the Rails one
     #
-    # Formtastic supports both 1.x and 2.x of stefanpenner/country_select, but if you're upgrading
-    # from 1.x, they behave quite differently, so please see their [upgrade instructions](https://github.com/stefanpenner/country_select/blob/master/UPGRADING.md).
-    #
     # By default, Formtastic includes a handful of English-speaking countries as "priority
     # countries", which can be set in the `priority_countries` configuration array in the
     # formtastic.rb initializer to suit your market and user base (see README for more info on
@@ -71,12 +68,18 @@ module Formtastic
       CountrySelectPluginMissing = Class.new(StandardError)
 
       def to_html
-        raise CountrySelectPluginMissing, "To use the :country input, please install a country_select plugin, like this one: https://github.com/stefanpenner/country_select" unless builder.respond_to?(:country_select)
+        raise CountrySelectPluginMissing, "To use the :country input, please install a country_select plugin, like this one: https://github.com/countries/country_select" unless builder.respond_to?(:country_select)
         input_wrapping do
           label_html <<
-          builder.country_select(method, priority_countries, input_options, input_html_options)
+          builder.country_select(method, input_options_including_priorities, input_html_options)
         end
       end
+
+      def input_options_including_priorities
+        return input_options unless priority_countries
+
+        input_options.merge(:priority_countries => priority_countries)
+      end
       
       def priority_countries
         options[:priority_countries] || builder.priority_countries

data/lib/formtastic/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Formtastic
-  VERSION = "5.0.0"
+  VERSION = "6.0.0.alpha"
 end

data/lib/formtastic.rb

@@ -1,6 +1,4 @@
-# encoding: utf-8
 # frozen_string_literal: true
-require 'formtastic/engine' if defined?(::Rails)
 
 module Formtastic
   extend ActiveSupport::Autoload
@@ -42,3 +40,9 @@ module Formtastic
   end
 
 end
+
+if defined?(::Rails)
+  ActiveSupport.on_load(:action_view) do
+    include Formtastic::Helpers::FormHelper
+  end
+end

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

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 module Formtastic
   # Generates a Formtastic form partial based on an existing model. It will not overwrite existing
@@ -33,7 +32,7 @@ module Formtastic
     class_option :copy, :type => :boolean, :default => false, :group => :formtastic,
     :desc => 'Copy the generated code the clipboard instead of generating a partial file."'
 
-    class_option :controller, :type => :string, :default => false, :group => :formtastic,
+    class_option :controller, :type => :string, :default => nil, :group => :formtastic,
     :desc => 'Generate for custom controller/view path - in case model and controller namespace is different, i.e. "admin/posts"'
 
     def create_or_show
@@ -43,7 +42,7 @@ module Formtastic
 
       if options[:copy]
         template = File.read("#{self.class.source_root}/_form.html.#{engine}")
-        erb = ERB.new(template, nil, '-')
+        erb = ERB.new(template, trim_mode: '-')
         generated_code = erb.result(binding).strip rescue nil
         puts "The following code has been copied to the clipboard, just paste it in your views:" if save_to_clipboard(generated_code)
         puts generated_code || "Error: Nothing generated. Does the model exist?"

data/lib/generators/formtastic/install/install_generator.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 module Formtastic

data/lib/generators/formtastic/stylesheets/stylesheets_generator.rb

@@ -0,0 +1,15 @@
+module Formtastic
+  # Copies a stylesheet into to app/assets/stylesheets/formtastic.css
+  #
+  # @example
+  # !!!shell
+  #   $ rails generate formtastic:stylesheets
+  class StylesheetsGenerator < Rails::Generators::Base
+    source_root File.expand_path("../../../templates", __FILE__)
+
+    desc "Copies Formtastic example stylesheet into your app"
+    def copy_files
+      copy_file "formtastic.css", "app/assets/stylesheets/formtastic.css"
+    end
+  end
+end

data/{app/assets/stylesheets → lib/generators/templates}/formtastic.css

@@ -4,8 +4,8 @@ It's *strongly* suggested that you don't modify this file.  Instead, load a new
 this one in your layouts (eg formtastic_changes.css) and override the styles to suit your needs.
 This will allow you to update formtastic.css with new releases without clobbering your own changes.
 
-This stylesheet forms part of the Formtastic Rails Plugin
-(c) 2008-2011 Justin French
+This stylesheet forms part of the Formtastic Rails gem
+(c) Justin French
 
 --------------------------------------------------------------------------------------------------*/
 
@@ -84,13 +84,13 @@ This stylesheet forms part of the Formtastic Rails Plugin
 
 /* BUTTONS & ACTIONS
 --------------------------------------------------------------------------------------------------*/
-.formtastic .buttons, 
+.formtastic .buttons,
 .formtastic .actions {
   overflow:hidden; /* clear containing floats */
   padding-left:25%;
 }
 
-.formtastic .button, 
+.formtastic .button,
 .formtastic .action {
   float:left;
   padding-right:0.5em;

data/lib/generators/templates/formtastic.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 # Set the default text field size when input is a string. Default is nil.
@@ -110,3 +109,10 @@
 
 # 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]
+
+# You can opt-in to accessibility features for the `semantic_errors` helper by setting
+# this to true. Doing so will render the attributes in the error summary list
+# as `<li> <a>` links to the inputs that have errors. the inline error sentence's id is added to
+# the errored input's aria-describedby. This ensures that the errored input is read out with
+# the inline error sentence's error explanation, aria-invalid is set to true for errored inputs
+# Formtastic::FormBuilder.semantic_errors_link_to_inputs = true

data/script/integration-template.rb

@@ -1,20 +1,21 @@
 # frozen_string_literal: true
 gem 'formtastic', path: '..'
-gem 'bcrypt', '~> 3.1.7'
+gem 'bcrypt'
 gem 'rails-dom-testing', group: :test
-gem 'rexml', '~> 3.2' # to compensate for missing dependency in selenium-webdriver
+
+gem 'minitest', '~> 5.27' # TODO: Remove this line when the Rails version used for integration tests will include rails/rails#56202
 
 # 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'"
+if Rails.version >= '8.1'
+  gsub_file 'Gemfile', /gem "rails".*/, %(gem "rails", "~> #{Rails.version}", github: "rails/rails", branch: "8-1-stable")
+elsif Rails.version >= '8.0'
+  gsub_file 'Gemfile', /gem "rails".*/, %(gem "rails", "~> #{Rails.version}", github: "rails/rails", branch: "8-0-stable")
+elsif Rails.version >= '7.2'
+  gsub_file 'Gemfile', /gem "rails".*/, %(gem "rails", "~> #{Rails.version}", github: "rails/rails", branch: "7-2-stable")
 end
 
 ### Ensure Dummy App's Ruby version matches the current environments Ruby Version
@@ -26,8 +27,9 @@ if bundle_install?
     previous_bundle_path = bundle_path
 
     require "bundler"
-    Bundler.with_clean_env do
-      system("bundle install --jobs=3 --retry=3 --path=#{previous_bundle_path}")
+    Bundler.with_original_env do
+      system("bundle config set path '#{previous_bundle_path}'")
+      system("bundle install --jobs=3 --retry=3")
     end
   end
 end
@@ -40,12 +42,13 @@ formtastic = -> do
   generate(:scaffold, 'user name:string password:digest')
   generate('formtastic:install')
   generate('formtastic:form', 'user name password --force')
+  generate('formtastic:stylesheets')
 
   rails_command('db:migrate')
+  rails_command('assets:precompile')
 
   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

data/script/integration.sh

@@ -4,16 +4,29 @@ set -e
 set -o verbose
 
 test_app=dummy
-
 rm -rf ${test_app}
 
-bundle exec rails new ${test_app} \
+export RAILS_INTEGRATION_VERSION="8.1.2"
+gem install rails -v ${RAILS_INTEGRATION_VERSION}
+rails -v
+
+rails new ${test_app} \
   --template=$(dirname "$0")/integration-template.rb \
   --skip-bootsnap \
+  --skip-brakeman \
+  --skip-bundler-audit \
+  --skip-ci \
+  --skip-git \
   --skip-javascript \
+  --skip-jbuilder \
+  --skip-kamal \
+  --skip-rubocop \
+  --skip-solid \
   --skip-spring \
-  --skip-turbolinks
+  --skip-thruster
 
-cd ${test_app} && export BUNDLE_GEMFILE=Gemfile
+cd ${test_app}
 
+bundle add formtastic --path=../formtastic
+bundle install
 bundle exec rake test

data/spec/action_class_finder_spec.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 require 'spec_helper'
 require 'formtastic/action_class_finder'

data/spec/actions/button_action_spec.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 require 'spec_helper'
 

data/spec/actions/generic_action_spec.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 require 'spec_helper'
 

data/spec/actions/input_action_spec.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 require 'spec_helper'
 

data/spec/actions/link_action_spec.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 require 'spec_helper'
 

data/spec/builder/custom_builder_spec.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 require 'spec_helper'
 

data/spec/builder/error_proc_spec.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 require 'spec_helper'
 

data/spec/builder/semantic_fields_for_spec.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 require 'spec_helper'
 
@@ -112,7 +111,6 @@ RSpec.describe 'Formtastic::FormBuilder#fields_for' do
       end)
       expect(output_buffer.to_str).to match(/oh noes/)
     end
-
   end
 
   context "when I rendered my own hidden id input" do
@@ -140,4 +138,76 @@ RSpec.describe 'Formtastic::FormBuilder#fields_for' do
     end
   end
 
+  context "when FormBuilder.semantic_errors_link_to_inputs is true" do
+    before do
+      Formtastic::FormBuilder.semantic_errors_link_to_inputs = true
+    end
+
+    after do
+      Formtastic::FormBuilder.semantic_errors_link_to_inputs = false
+    end
+
+    context "when there are errors" do
+      before do
+        @errors = double('errors')
+        allow(@errors).to receive(:[]).with(errors_matcher(:login)).and_return(['oh noes'])
+        allow(@errors).to receive(:[]).with(errors_matcher(:name)).and_return([])
+        allow(@bob).to receive(:errors).and_return(@errors)
+
+        concat(semantic_form_for(@new_post, :namespace => 'context2') do |builder|
+          concat(builder.semantic_fields_for(@bob) do |nested_builder|
+            concat(nested_builder.inputs(:login, :name))
+          end)
+        end)
+      end
+
+      it 'should render errors on the nested inputs with default aria attributes' do
+        expect(output_buffer.to_str).to include('aria-invalid="true"')
+        expect(output_buffer.to_str).to \
+          have_tag 'input#context2_post_author_login[aria-describedby="login_error"]', \
+          count: 1
+      end
+
+      it 'should preserve developer-set aria attributes' do
+        concat(semantic_form_for(@new_post, :namespace => 'context2') do |builder|
+          concat(builder.semantic_fields_for(@bob) do |nested_builder|
+            concat(nested_builder.input(:login, input_html: { 'aria-describedby': 'hint_for_email_field', 'aria-invalid': 'false' } ))
+          end)
+        end)
+
+        expect(output_buffer.to_str).to \
+          have_tag 'input#context2_post_author_login[aria-describedby="hint_for_email_field login_error"]', \
+          count: 1
+        expect(output_buffer.to_str).to \
+          have_tag 'input#context2_post_author_login[aria-invalid="false"]', \
+          count: 1
+      end
+    end
+
+    context "when there are no errors" do
+      before do
+        concat(semantic_form_for(@new_post, :namespace => 'context2') do |builder|
+          concat(builder.semantic_fields_for(@bob) do |nested_builder|
+            concat(nested_builder.input(:login))
+          end)
+        end)
+      end
+
+      it 'should not aria attributes on nested inputs' do
+        expect(output_buffer.to_str).not_to include('aria-invalid')
+        expect(output_buffer.to_str).not_to include('aria-describedby')
+      end
+
+      it 'should render aria attributes I set' do
+        concat(semantic_form_for(@new_post, :namespace => 'context2') do |builder|
+          concat(builder.semantic_fields_for(@bob) do |nested_builder|
+            concat(nested_builder.input(:login, input_html: { 'aria-describedby': 'hint_for_email_field', 'aria-invalid': 'false' } ))
+          end)
+        end)
+
+        expect(output_buffer.to_str).to include('aria-describedby="hint_for_email_field"')
+        expect(output_buffer.to_str).to include('aria-invalid="false"')
+      end
+    end
+  end
 end

data/spec/fast_spec_helper.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 $LOAD_PATH << 'lib/formtastic'
 require 'active_support/all'

data/spec/generators/formtastic/stylesheets/stylesheets_generator_spec.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+require 'spec_helper'
+
+# Generators are not automatically loaded by Rails
+require 'generators/formtastic/stylesheets/stylesheets_generator'
+
+RSpec.describe Formtastic::StylesheetsGenerator do
+  # Tell the generator where to put its output (what it thinks of as Rails.root)
+  destination File.expand_path("../../../../../tmp", __FILE__)
+
+  before { prepare_destination }
+
+  describe 'no arguments' do
+    before { run_generator  }
+
+    describe 'app/assets/stylesheets/formtastic.css' do
+      subject { file('app/assets/stylesheets/formtastic.css') }
+      it { is_expected.to exist }
+      it { is_expected.to contain ".formtastic" }
+    end
+  end
+end

data/spec/helpers/actions_helper_spec.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 require 'spec_helper'
 

data/spec/helpers/form_helper_spec.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 require 'spec_helper'
 

data/spec/helpers/input_helper_spec.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 require 'spec_helper'
 
@@ -492,6 +491,7 @@ RSpec.describe 'with input class finder' do
         it 'should default to :datetime_select for :datetime and :timestamp column types' do
           expect(default_input_type(:datetime)).to eq(:datetime_select)
           expect(default_input_type(:timestamp)).to eq(:datetime_select)
+          expect(default_input_type(:timestamptz)).to eq(:datetime_select)
         end
 
         it 'should default to :time_select for :time column types' do
@@ -731,6 +731,17 @@ RSpec.describe 'with input class finder' do
 
     end
 
+    describe ':label_method option' do
+      it "should allow label_html to add custom attributes" do
+        concat(semantic_form_for(@new_post) do |builder|
+          concat(builder.input(:title, :label_html => { :data => { :tooltip => 'Great Tooltip' } }))
+        end)
+        aggregate_failures do
+          expect(output_buffer.to_str).to have_tag('form li label[data-tooltip="Great Tooltip"]')
+        end
+      end
+    end
+
     describe ':hint option' do
 
       describe 'when provided' do

data/spec/helpers/inputs_helper_spec.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 require 'spec_helper'
 

data/spec/helpers/reflection_helper_spec.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 require 'spec_helper'