bootstrap_form 4.4.0 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e064911f3a679f4ecf322d6e3e240b35cf1f33e73908d3bf3494a71a3013781
-  data.tar.gz: 044b4a8d8dd6c046f88b45ddd6fb83ed9d619fd6e2872fbd1eb32c84fda50f71
+  metadata.gz: d9c9c11dc8a15ead08e2e5060d5c003933c82630d7124692a9e6dae838d34dde
+  data.tar.gz: dfd08f5247ebb273aa6696ef09c023d294c3fde7ec936f1e7721b81bc735dd3a
 SHA512:
-  metadata.gz: ec13235058d63f5ff4a12991660d10acff7b7576954e3a103d38592cd90a6ee0a8431c93eeb33878d7a228e432bbf590ff248d60445cfacbca278efc73d5fc52
-  data.tar.gz: 2b3c704fa1981633bbaaa04dc543d72e9a1e3d535f8d56852752fb9eef65ea4d75089971e073defb193119f80c8cc13a3708a8ac603bcdef0edc8946f2a95958
+  metadata.gz: 4b84c600054f7987edbf2774ac4603ed7b0c2c6f13ef4e6a6cb3f84c716d680b5ba8bbb14b9263831d3b9e2d1cea75128aab657cbf48e0110c1f0141df96d2c3
+  data.tar.gz: b0b64178a6158c444021ed3818fa02921aff33a6dc1bd299448b72387ee7e4ec19ffa017af1ac4a5e2fe42a952338870c1ec793d64c7bc098a1fa2b31d86f6a2

data/.rubocop.yml

@@ -5,7 +5,7 @@ require: rubocop-rails
 AllCops:
   DisplayCopNames: true
   DisplayStyleGuide: true
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.5
   Exclude:
     - "bin/*"
     - Capfile

data/.travis.yml

@@ -1,35 +1,28 @@
 language: ruby
 rvm:
-  - 2.7
+  - 2.7.1
   - 2.6.5
   - 2.5.7
-  - 2.4.9
 gemfile:
-  - gemfiles/5.0.gemfile
-  - gemfiles/5.1.gemfile
-  - gemfiles/5.2.gemfile
   - gemfiles/6.0.gemfile
+  - gemfiles/5.2.gemfile
 cache:
   bundler: true
 script:
   - bundle exec rake test
 
 matrix:
-  exclude:
-    - rvm: 2.4.9
-      gemfile: gemfiles/6.0.gemfile
-
   include:
     # Bleeding edge Ruby
     - rvm: ruby-head
-      gemfile: gemfiles/6.0.gemfile
+      gemfile: gemfiles/edge.gemfile
 
     # Next version of Rails
-    - rvm: 2.5.7
+    - rvm: 2.7.1
       gemfile: gemfiles/edge.gemfile
 
     # Running one job to execute DANGER bot and linting
-    - rvm: 2.5.7
+    - rvm: 2.7.1
       gemfile: gemfiles/6.0.gemfile
       script:
         - gem install danger
@@ -38,5 +31,5 @@ matrix:
 
   allow_failures:
     - rvm: ruby-head
-    - rvm: 2.5.7
+    - rvm: 2.7.1
       gemfile: gemfiles/edge.gemfile

data/CHANGELOG.md

@@ -12,6 +12,12 @@
 
 * Your contribution here!
 
+## [4.5.0][] (2020-04-29)
+
+### New features
+
+* [#562](https://github.com/bootstrap-ruby/bootstrap_form/pull/562): Allow to configure default form attributes - [@sharshenov](https://github.com/sharshenov).
+
 ## [4.4.0][] (2020-03-08)
 
 ### New features
@@ -286,7 +292,8 @@ Features:
   - Added support for bootstrap_form_tag (@baldwindavid)
 
 
-[Pending Release]: https://github.com/bootstrap-ruby/bootstrap_form/compare/v4.4.0...HEAD
+[Pending Release]: https://github.com/bootstrap-ruby/bootstrap_form/compare/v4.5.0...HEAD
+[4.5.0]: https://github.com/bootstrap-ruby/bootstrap_form/compare/v4.4.0...v4.5.0
 [4.4.0]: https://github.com/bootstrap-ruby/bootstrap_form/compare/v4.3.0...v4.4.0
 [4.3.0]: https://github.com/bootstrap-ruby/bootstrap_form/compare/v4.2.0...v4.3.0
 [4.2.0]: https://github.com/bootstrap-ruby/bootstrap_form/compare/v4.1.0...v4.2.0

data/Gemfile

@@ -5,22 +5,20 @@ gemspec
 # Uncomment and change rails version for testing purposes
 # gem "rails", "~> 5.2.0"
 gem "rails", "~> 6.0.0"
+# gem "rails", git: "https://github.com/rails/rails.git"
 
 group :development do
   gem "chandler", ">= 0.7.0"
   gem "htmlbeautifier"
   gem "rubocop-rails", require: false
   gem "sassc-rails"
-  gem "webpacker", ">= 4.0.0.rc.3"
+  gem "webpacker"
 end
 
 group :test do
   # can relax version requirement for Rails 5.2.beta3+
-  gem "minitest", "~> 5.10.3"
-
   gem "diffy"
   gem "equivalent-xml"
   gem "mocha"
   gem "sqlite3"
-  gem "timecop", "~> 0.7.1"
 end

data/README.md

@@ -31,8 +31,8 @@ Some other nice things that `bootstrap_form` does for you are:
 
 `bootstrap_form` supports at a minimum the currently supported versions of Ruby and Rails:
 
-* Ruby 2.4+
-* Rails 5.0+ (Rails 5.1+ for `bootstrap_form_with`)
+* Ruby 2.5+
+* Rails 5.2+
 * Bootstrap 4.0+
 
 ## Installation
@@ -107,7 +107,7 @@ If your form is not backed by a model, use the `bootstrap_form_tag`. Usage of th
 <% end %>
 ```
 
-### bootstrap_form_with (Rails 5.1+)
+### bootstrap_form_with
 
 Note that `form_with` in Rails 5.1 does not add IDs to form elements and labels by default, which are both important to Bootstrap markup. This behaviour is corrected in Rails 5.2.
 
@@ -150,6 +150,26 @@ in `form_with`.
 
 `form_with` has some important differences compared to `form_for` and `form_tag`, and these differences apply to `bootstrap_form_with`. A good summary of the differences can be found at: https://m.patrikonrails.com/rails-5-1s-form-with-vs-old-form-helpers-3a5f72a8c78a, or in the [Rails documentation](api.rubyonrails.org).
 
+
+## Configuration
+
+`bootstrap_form` can be used out-of-the-box without any configuration. However, `bootstrap_form` does have an optional configuration file at `config/initializers/bootstrap_form.rb` for setting options that affect all generated forms in an application.
+
+The current configuration options are:
+
+| Option | Default value | Description |
+|---------------------------|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `default_form_attributes` | `{role: "form"}` | version [2.2.0](https://github.com/bootstrap-ruby/bootstrap_form/blob/master/CHANGELOG.md#220-2014-09-16) added a role="form" attribute to all forms.   The W3C validator will raise a **warning** on forms with a role="form" attribute.   Set this option to `{}` to make forms be W3C compliant. |
+
+
+Example:
+```ruby
+# config/initializers/bootstrap_form.rb
+BootstrapForm.configure do |c|
+  c.default_form_attributes = {} # to make forms W3C compliant
+end
+```
+
 ## Form Helpers
 
 `bootstrap_form` provides its own version of the following Rails form helpers:

data/RELEASING.md

@@ -6,7 +6,7 @@ Follow these steps to release a new version of bootstrap_form to rubygems.org.
 
 * You must have commit rights to the bootstrap_form repository.
 * You must have push rights for the bootstrap_form gem on rubygems.org.
-* You must be using Ruby >= 2.4.
+* You must be using Ruby >= 2.5.
 * Your GitHub credentials must be available to Chandler via `~/.netrc` or an environment variable, [as explained here](https://github.com/mattbrictson/chandler#2-configure-credentials).
 
 ## How to release

data/bootstrap_form.gemspec

@@ -15,6 +15,8 @@ Gem::Specification.new do |s|
                   "easy to create beautiful-looking forms using Bootstrap 4"
   s.license     = "MIT"
 
+  s.post_install_message = "Default form attribute role=\"form\" will be dropped in 5.0.0"
+
   s.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test)/})
   end
@@ -22,8 +24,8 @@ Gem::Specification.new do |s|
   s.bindir        = "exe"
   s.require_paths = ["lib"]
 
-  s.required_ruby_version = ">= 2.3"
+  s.required_ruby_version = ">= 2.5"
 
-  s.add_dependency("actionpack", ">= 5.0")
-  s.add_dependency("activemodel", ">= 5.0")
+  s.add_dependency("actionpack", ">= 5.2")
+  s.add_dependency("activemodel", ">= 5.2")
 end

data/demo/config/environments/development.rb

@@ -16,7 +16,7 @@ Rails.application.configure do
 
   # Enable/disable caching. By default caching is disabled.
   # Run rails dev:cache to toggle caching.
-  if Rails.root.join("tmp/caching-dev.txt").exist?
+  if Rails.root.join("tmp", "caching-dev.txt").exist?
     config.action_controller.perform_caching = true
 
     config.cache_store = :memory_store

data/lib/bootstrap_form.rb

@@ -13,6 +13,7 @@ module BootstrapForm
   extend ActiveSupport::Autoload
 
   eager_autoload do
+    autoload :Configuration
     autoload :FormBuilder
     autoload :FormGroupBuilder
     autoload :FormGroup
@@ -21,11 +22,21 @@ module BootstrapForm
     autoload :Helpers
   end
 
-  def self.eager_load!
-    super
-    BootstrapForm::Components.eager_load!
-    BootstrapForm::Helpers.eager_load!
-    BootstrapForm::Inputs.eager_load!
+  class << self
+    def eager_load!
+      super
+      BootstrapForm::Components.eager_load!
+      BootstrapForm::Helpers.eager_load!
+      BootstrapForm::Inputs.eager_load!
+    end
+
+    def config
+      @config ||= BootstrapForm::Configuration.new
+    end
+
+    def configure
+      yield config
+    end
   end
 
   mattr_accessor :field_error_proc

data/lib/bootstrap_form/action_view_extensions/form_helper.rb

@@ -29,7 +29,7 @@ module BootstrapForm
         options.reverse_merge!(builder: BootstrapForm::FormBuilder)
 
         with_bootstrap_form_field_error_proc do
-          form_with(options, &block)
+          form_with(**options, &block)
         end
       end
 

data/lib/bootstrap_form/configuration.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module BootstrapForm
+  class Configuration
+    def default_form_attributes=(attributes)
+      case attributes
+      when nil
+        @default_form_attributes = {}
+      when Hash
+        @default_form_attributes = attributes
+      else
+        raise ArgumentError, "Unsupported default_form_attributes #{attributes.inspect}"
+      end
+    end
+
+    def default_form_attributes
+      return @default_form_attributes if defined? @default_form_attributes
+
+      # TODO: Return blank hash ({}) in 5.0.0. Role "form" for form tags is redundant and makes W3C to raise a warning.
+      { role: "form" }
+    end
+  end
+end

data/lib/bootstrap_form/form_builder.rb

@@ -58,14 +58,14 @@ module BootstrapForm
                          options[:inline_errors] != false
                        end
       @acts_like_form_tag = options[:acts_like_form_tag]
-      add_form_role_and_form_inline options
+      add_default_form_attributes_and_form_inline options
       super
     end
     # rubocop:enable Metrics/AbcSize
 
-    def add_form_role_and_form_inline(options)
+    def add_default_form_attributes_and_form_inline(options)
       options[:html] ||= {}
-      options[:html][:role] ||= "form"
+      options[:html].reverse_merge!(BootstrapForm.config.default_form_attributes)
 
       return unless options[:layout] == :inline
 

data/lib/bootstrap_form/version.rb

@@ -1,3 +1,3 @@
 module BootstrapForm
-  VERSION = "4.4.0".freeze
+  VERSION = "4.5.0".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bootstrap_form
 version: !ruby/object:Gem::Version
-  version: 4.4.0
+  version: 4.5.0
 platform: ruby
 authors:
 - Stephen Potenza
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-08 00:00:00.000000000 Z
+date: 2020-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -17,28 +17,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
 description: bootstrap_form is a rails form builder that makes it super easy to create
   beautiful-looking forms using Bootstrap 4
 email:
@@ -125,8 +125,6 @@ files:
 - demo/public/favicon.ico
 - demo/test/fixtures/action_text/rich_texts.yml
 - demo/yarn.lock
-- gemfiles/5.0.gemfile
-- gemfiles/5.1.gemfile
 - gemfiles/5.2.gemfile
 - gemfiles/6.0.gemfile
 - gemfiles/edge.gemfile
@@ -137,6 +135,7 @@ files:
 - lib/bootstrap_form/components/labels.rb
 - lib/bootstrap_form/components/layout.rb
 - lib/bootstrap_form/components/validation.rb
+- lib/bootstrap_form/configuration.rb
 - lib/bootstrap_form/engine.rb
 - lib/bootstrap_form/form_builder.rb
 - lib/bootstrap_form/form_group.rb
@@ -181,7 +180,7 @@ homepage: https://github.com/bootstrap-ruby/bootstrap_form
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: Default form attribute role="form" will be dropped in 5.0.0
 rdoc_options: []
 require_paths:
 - lib
@@ -189,7 +188,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/gemfiles/5.0.gemfile

@@ -1,18 +0,0 @@
-source "http://rubygems.org"
-
-gemspec path: "../"
-
-gem "rails", "~> 5.0.0"
-
-group :development do
-  gem "rubocop-rails", require: false
-end
-
-group :test do
-  gem "diffy"
-  gem "equivalent-xml"
-  gem "minitest", "~> 5.10.3"
-  gem "mocha"
-  gem "sqlite3", "~> 1.3.6"
-  gem "timecop", "~> 0.7.1"
-end

data/gemfiles/5.1.gemfile

@@ -1,17 +0,0 @@
-source "http://rubygems.org"
-
-gemspec path: "../"
-
-gem "rails", "~> 5.1.0"
-
-group :development do
-  gem "rubocop-rails", require: false
-end
-
-group :test do
-  gem "diffy"
-  gem "equivalent-xml"
-  gem "mocha"
-  gem "sqlite3", "~> 1.4"
-  gem "timecop", "~> 0.7.1"
-end