bootstrap_form 4.2.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3eb9dd9edad01a3b8fc83d83506c4a9a19d70f849620dde77847baaaa0231b9a
-  data.tar.gz: 942e9b16f5ffe3873e49defc113255c61939e479621c25ed5846348b2bdfe304
+  metadata.gz: a510f995829dd7bbdfa67fa4eeaa73b8cb8a10a73a2d46c89aad425709caf7c2
+  data.tar.gz: 33543b5b3a9dd167ef7896e0ad55c7d86d31a54e4c19072d13e09b332bb5a872
 SHA512:
-  metadata.gz: e61107ff84b13b61270438556d0320c94a1f395b5acdb9221122ba89078c7dca3c0d96b3f2db8bc5e3c7e0cdca4eb124f0bb5944fd47be31a9a217ad6a714716
-  data.tar.gz: 55b15e5a89aa152ad0c2ca05e1bfb6fc99c15f0e1b5235ad6a0d41df0429097e775d3c006ed59e0773e9b397d2c7332fb57334bc577a47331eebff0c7dff75b8
+  metadata.gz: 4a703b03f34bb7208380b3370aab0b6444526fb4a33303f473c5b1a78c4c55639701d499c4013d437f79a240554c9da703a1698fc32fe5d91f73f69b919d080c
+  data.tar.gz: 77362e8c4c482ad19a81d63b8c4b55fe213b42e28e44dc66cd716da7106afc2e7509e43428ec135a00f652ed6112cd6fcee4af8bb2e271bb77d3cc187e441045

data/.editorconfig

@@ -0,0 +1,13 @@
+# editorconfig.org
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

data/.github/workflows/ruby.yml

@@ -0,0 +1,46 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  Lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7.2
+          bundler-cache: true
+      - name: Danger
+        if: ${{ github.event_name == 'pull_request' }}
+        run: |
+          gem install danger
+          export DANGER_GITHUB_API_TOKEN=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
+          danger
+      - name: Rubocop
+        run: bundle exec rubocop --auto-correct
+  Test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version: [ '3.0', '2.7', '2.6' ]
+        gemfile: [ '6.1', '6.0', '5.2', 'edge' ]
+        exclude:
+          - { ruby-version: '3.0', gemfile: "5.2" }
+          - { ruby-version: '2.6', gemfile: "edge" }
+    env:
+      BUNDLE_GEMFILE: gemfiles/${{ matrix.gemfile }}.gemfile
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - name: Run tests
+        run: bundle exec rake test

data/.gitignore

@@ -1,4 +1,5 @@
 .bundle/
+.idea
 log/*.log
 pkg/
 demo/db/*.sqlite3
@@ -13,7 +14,7 @@ test/gemfiles/*.lock
 Vagrantfile
 .vagrant
 
-// For the demo app.
+# For the demo app.
 
 # Ignore uploaded files in development.
 demo/storage/*
@@ -30,3 +31,17 @@ demo/node_modules
 demo/yarn-error.log
 demo/yarn-debug.log*
 demo/.yarn-integrity
+
+# For stuff that gets created if using the Dockerfile image
+.bundle/
+.cache/
+vendor/bundle
+
+# or .local/share/pry/pry_history if you need to be more exact
+.local/
+.irb_history
+.byebug_history
+# For Debian images with Bash
+.bash_history
+# For Alpine images
+.ash_history

data/.rubocop.yml

@@ -1,25 +1,37 @@
-# Taken from: https://github.com/mattbrictson/rails-template/blob/master/rubocop.yml.tt
-# Modified for demo app in `demo/` directory.
+require:
+  - rubocop-performance
+  - rubocop-rails
+
 AllCops:
   DisplayCopNames: true
   DisplayStyleGuide: true
-  TargetRubyVersion: 2.2.2
+  TargetRubyVersion: 2.5
+  NewCops: enable
   Exclude:
-    - "bin/*"
+    - bin/*
     - Capfile
     - demo/bin/*
-    - "demo/bower_components/**/*"
+    - demo/bower_components/**/*
     - demo/config/boot.rb
     - demo/config/environment.rb
     - demo/config/initializers/version.rb
     - demo/db/schema.rb
-    - "demo/node_modules/**/*"
+    - demo/node_modules/**/*
     - demo/Rakefile
-    - "demo/tmp/**/*"
-    - "demo/vendor/**/*"
+    - demo/tmp/**/*
+    - demo/vendor/**/*
     - Gemfile
+    - gemfiles/vendor/bundle/**/*
+    - vendor/bundle/**/*
     - Guardfile
     - Rakefile
+    - vendor/**/*
+
+Layout/LineLength:
+  Max: 132
+  Exclude:
+    - "demo/config/**/*"
+    - "demo/db/**/*"
 
 Layout/SpaceAroundEqualsInParameterDefault:
   EnforcedStyle: no_space
@@ -40,12 +52,6 @@ Metrics/ClassLength:
     - "demo/test/**/*"
     - "test/**/*"
 
-Metrics/LineLength:
-  Max: 132
-  Exclude:
-    - "demo/config/**/*"
-    - "demo/db/**/*"
-
 Metrics/MethodLength:
   Max: 12
   Exclude:
@@ -59,9 +65,6 @@ Naming/MemoizedInstanceVariableName:
 Naming/VariableNumber:
   Enabled: false
 
-Performance/Casecmp:
-  Enabled: false
-
 Rails:
   Enabled: true
 

data/CHANGELOG.md

@@ -12,6 +12,60 @@
 
 * Your contribution here!
 
+## [5.0.0][] (2021-11-11)
+
+### Breaking changes
+
+* Generates markup for Bootstrap 5.
+
+### New features
+
+* [#572](https://github.com/bootstrap-ruby/bootstrap_form/issues/572): Simplify the formatting of the file upload control to follow the new Bootstrap 5 styles
+* [#573](https://github.com/bootstrap-ruby/bootstrap_form/issues/573): Add support for Bootstrap 5's floating labels
+
+### Bugfixes
+
+* [#582](https://github.com/bootstrap-ruby/bootstrap_form/issues/582): Fix tests in bootstrap-5 branch, removes Rubocop offenses, and adds testing with Rails 6.1.
+
+## [5.0.0.alpha1][]
+
+### Breaking changes
+
+* [#569] Remove `role="form"` from the default generated form HTML so forms pass W3C validation. (Only a breaking change if you depended on the `form` attribute. `bootstrap_form` doesn't depend on it.)
+
+### New features
+
+* Your contribution here!
+
+### Bugfixes
+
+* [#586](https://github.com/bootstrap-ruby/bootstrap_form/pull/586): Fix Rails 6.1 tests on master - [@thimo](https://github.com/thimo).
+* [#587](https://github.com/bootstrap-ruby/bootstrap_form/pull/587): Replace `strip_heredoc` with `<<~` - [@thimo](https://github.com/thimo).
+
+## [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
+
+* [#557](https://github.com/bootstrap-ruby/bootstrap_form/pull/557): Allow prepending and appending multiple items to an input by passing an array to `prepend` and `append` options - [@donv](https://github.com/donv).
+* [#550](https://github.com/bootstrap-ruby/bootstrap_form/pull/550): Add `default_layout` so we can use it for all forms - [@duleorlovic](https://github.com/duleorlovic).
+
+### Bugfixes
+
+* Your contribution here!
+
+## [4.3.0][] (2019-09-22)
+
+### New features
+
+* [#503] Support Rails 6.0.0.
+* Small documentation changes.
+
 ## [4.2.0][] (2019-03-08)
 
 ### New features
@@ -268,7 +322,11 @@ Features:
   - Added support for bootstrap_form_tag (@baldwindavid)
 
 
-[Pending Release]: https://github.com/bootstrap-ruby/bootstrap_form/compare/v4.2.0...HEAD
+[Pending Release]: https://github.com/bootstrap-ruby/bootstrap_form/compare/v5.0.0...HEAD
+[5.0.0]: https://github.com/bootstrap-ruby/bootstrap_form/compare/v4.5.0...v5.0.0
+[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
 [4.1.0]: https://github.com/bootstrap-ruby/bootstrap_form/compare/v4.0.0...v4.1.0
 [4.0.0]: https://github.com/bootstrap-ruby/bootstrap_form/compare/v4.0.0.alpha1...v4.0.0

data/CONTRIBUTING.md

@@ -10,6 +10,11 @@ There are a number of ways you can contribute to `bootstrap_form`:
 - Add to the documentation
 - Review pull requests
 
+*Note:* If you want to work on preparing `bootstrap_form` for Bootstrap 5,
+please start from the `bootstrap-5` branch.
+If you're submitting a pull request with code or documentation,
+target the pull request to the `bootstrap-5` branch.
+
 ## Code Contributions
 
 Here's a quick guide for code contributions:
@@ -58,19 +63,77 @@ You may find the demo application useful for development and debugging.
 ### 7. Done!
 
 Somebody will shortly review your pull request and if everything is good, it will be
-merged into the master branch. Eventually the gem will be published with your changes.
+merged into the main branch. Eventually the gem will be published with your changes.
 
 ### Coding guidelines
 
 This project uses [RuboCop](https://github.com/bbatsov/rubocop) to enforce standard Ruby coding
-guidelines. Currently we run RuboCop's as described by [this post](https://tech.offgrid-electric.com/rubocop-getting-to-green-in-a-huge-rails-app-12d1ad6678eb), under the section "How to make CI pass". That means we allow certain existing RuboCop offences in the code, but prevent people from adding any new offences. So you might copy some existing code, and then discover that it doesn't pass. Please fix the new code, and if you're ambitious, fix the old code as well.
+guidelines.
 
-* Test that your contribution passes with `rake rubocop`.
-* RuboCop is also run as part of the full test suite with `bundle exec rake`.
-* Note the Travis build will fail and your PR cannot be merged if RuboCop finds offences.
+- Test that your contribution passes with `rake rubocop`.
+- RuboCop is also run as part of the full test suite with `bundle exec rake`.
+- Note the Travis build will fail and your PR cannot be merged if RuboCop finds offences.
 
 Note that most editors have plugins to run RuboCop as you type, or when you save a file. You may find it well worth your time to install and configure the RuboCop plugin for your editor. Read the [RuboCop documentation](https://rubocop.readthedocs.io/en/latest/integration_with_other_tools/).
 
+### Supported Versions of Ruby and Rails
+
+The goal of `bootstrap_form` is to support all versions of Rails currently supported for bug fixes and security issues. We do not test against versions supported for severe security issues. We test against the minimum [version of Ruby required](https://guides.rubyonrails.org/upgrading_ruby_on_rails.html#ruby-versions) for those versions of Rails.
+
+The Ruby on Rails support policy is [here](https://guides.rubyonrails.org/maintenance_policy.html).
+
+### Developing with Docker
+
+This repository includes a `Dockerfile` to build an image with the minimum `bootstrap_form`-supported Ruby environment. To build the image:
+
+```bash
+docker build --tag bootstrap_form .
+```
+
+This builds an image called `bootstrap_form`. You can change that to any tag you wish. Just make sure you use the same tag name in the `docker run` command.
+
+If you want to use a different Ruby version, or a smaller Linux distribution (although the distro may be missing tools you need):
+
+```bash
+docker build --build-arg "RUBY_VERSION=2.7" --build-arg "DISTRO=slim-buster" --tag bootstrap_form .
+```
+
+Then run the container you built with the shell, and create the bundle:
+
+```bash
+docker run --volume "$PWD:/app" --user $UID:`grep ^$USERNAME /etc/passwd | cut -d: -f4` -it bootstrap_form /bin/bash
+bundle install
+```
+
+You can run tests in the container as normal, with `rake test`.
+
+(Some of that command line is need for Linux hosts, to run the container as the current user.)
+
+### The Demo App
+
+There is a demo app in this repository. It shows some of the features of `bootstrap_form`, and provides a base on which to build ad-hoc testing, if you need it.
+
+To run the demo app, set up the database and run the server:
+
+```bash
+cd demo
+export BUNDLER_GEMFILE=../gemfiles/6.1.gemfile
+rails db:setup
+rails s -b 0.0.0.0
+```
+
+To run the demo app in the Docker container:
+
+```bash
+docker run --volume "$PWD:/app" --user $UID:`grep ^$USERNAME /etc/passwd | cut -d: -f4` -p 3000:3000 -it bootstrap_form /bin/bash
+cd demo
+export BUNDLER_GEMFILE=../gemfiles/6.1.gemfile
+rails db:setup
+rails s -b 0.0.0.0
+```
+
+To use other supported versions of Rails, change the `export BUNDLER_GEMFILE...` line to another gem file.
+
 ## Documentation Contributions
 
 Contributions to documentation are always welcome. Even fixing one typo improves the quality of `bootstrap_form`. To make a documentation contribution, follow steps 1-3 of Code Contributions, then make the documentation changes, then make the pull request (step 6 of Code Contributions).
@@ -86,11 +149,14 @@ We are an entirely volunteer project. Sometimes it's hard for people to find the
 Thanks to all the great contributors over the years: https://github.com/bootstrap-ruby/bootstrap_form/graphs/contributors
 
 ## Troubleshooting
+
 ### Models and Database Tables
+
 `bootstrap_form` needs a few models and tables to support testing. It appears that the necessary tables were created via the `demo/db/schema.rb` file. To support `rich_text_area`, Rails 6 creates some migrations. These migrations had to be run in the existing database (not an empty one) to create a new `schema.rb` that creates the `bootstrap_form` test tables, and the tables needed by Rails 6. The `schema.rb` file was checked in to GitHub, but the migrations were not.
 
 In the future, any new Rails functionality that creates tables would likely have to be prepared the same way:
-```
+
+```bash
 cd demo
 rails db:setup # create the databases from `schema.rb`
 rails db:migrate # add the new tables and create a new `schema.rb`

data/Dangerfile

@@ -44,11 +44,9 @@ end
 # ------------------------------------------------------------------------------
 # Did you remove the CHANGELOG's "Your contribution here!" line?
 # ------------------------------------------------------------------------------
-if has_changelog_changes
-  if IO.read("CHANGELOG.md").scan(/^\s*[-\*] Your contribution here/i).count < 3
-    raise(
-      "Please put the `- Your contribution here!` line back into CHANGELOG.md.",
-      sticky: false
-    )
-  end
+if has_changelog_changes && IO.read("CHANGELOG.md").scan(/^\s*[-*] Your contribution here/i).count < 3
+  raise(
+    "Please put the `- Your contribution here!` line back into CHANGELOG.md.",
+    sticky: false
+  )
 end

data/Dockerfile

@@ -0,0 +1,26 @@
+ARG DISTRO=buster
+ARG RUBY_VERSION=2.6
+
+FROM ruby:$RUBY_VERSION-$DISTRO
+
+RUN mkdir -p /app
+ENV HOME /app
+WORKDIR /app
+
+ENV GEM_HOME $HOME/vendor/bundle
+ENV BUNDLE_APP_CONFIG="$GEM_HOME"
+ENV PATH ./bin:$GEM_HOME/bin:$PATH
+RUN (echo 'docker'; echo 'docker') | passwd root
+
+# Yarn installs nodejs.
+RUN curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add - && \
+    echo "deb https://dl.yarnpkg.com/debian/ stable main" | tee /etc/apt/sources.list.d/yarn.list && \
+    apt update -y -q && \
+    apt install -y -q yarn sqlite3
+
+# Ruby now comes with bundler, but we're not using the default version yet, because we were using
+# a newer version of bundler already. Ruby 3 comes with Bundler 2.2.3. Ruby 2.7 has Bundler 2.1.2,
+# which is still behind what we were using.
+RUN gem install bundler -v 2.1.4
+
+EXPOSE 3000

data/Gemfile

@@ -1,28 +1,25 @@
 source "http://rubygems.org"
 
-gemspec
+gemspec path: __dir__
 
 # Uncomment and change rails version for testing purposes
-gem "rails", "~> 5.2.0"
-# gem "rails", "~> 6.0.0.beta1"
+# gem "rails", "~> 5.2.0"
+# gem "rails", "~> 6.0.0"
+# gem "rails", "~> 6.1.0"
+# gem "rails", git: "https://github.com/rails/rails.git"
 
 group :development do
   gem "chandler", ">= 0.7.0"
   gem "htmlbeautifier"
-  gem "rubocop", require: false
-  gem "sass-rails"
-  gem 'webpacker', '>= 4.0.0.rc.3'
+  gem "rubocop-performance", require: false
+  gem "rubocop-rails", require: false
+  gem "sassc-rails"
+  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"
-  # sqlite3 1.4.0 breaks the test suite.
-  # https://github.com/rails/rails/pull/35154
-  gem "sqlite3", "~> 1.3.6"
-  gem "timecop", "~> 0.7.1"
+  gem "sqlite3"
 end

data/OLD-README.md

@@ -415,8 +415,19 @@ Here's the output for a horizontal layout:
 You can also create a static control that isn't based on a model attribute:
 
 ```erb
-<%= f.static_control label: "Custom Static Control" value: "Content Here" %>
+<%= f.static_control :field_name, label: "Custom Static Control" value: "Content Here" %>
 ```
+
+`field_name` may be any name that isn't already used in the form. Note that you may get "unpermitted parameter" messages in your log file with this approach.
+
+You can also create the static control the following way, if you don't need to get the value of the static control as a parameter when the form is submitted:
+
+```erb
+<%= f.static_control label: "Custom Static Control" value: "Content Here", name: nil %>
+```
+
+(If you neither provide a field name nor `name: nil`, the Rails code that submits the form will give a JavaScript error.)
+
 Prior to version 4 of `bootstrap_form`, you could pass a block to the `static_control` method.
 The value of the block would be used for the content of the static "control".
 Bootstrap 4 actually creates and styles a disabled input field for static controls, so the value of the control has to be specified by the `value:` option.