bootstrap_form 5.4.0 → 5.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f83f141afb358e5297da435acb97a61de05d38ba70493ce820a0679f002eab41
-  data.tar.gz: edf0410f0a0239f36c0ea4a779e235cc5ee494a2efa2d9ecda2875222c1ba1fe
+  metadata.gz: f1627869d85826ca2fb85c7b4257cf66cd26adc270fabe10bc05246b248eb26a
+  data.tar.gz: 2e5ec700c4c51b92aafe31633e92470318f7377740ba2da7e9f7738197c8ffe3
 SHA512:
-  metadata.gz: 714e076f29f7067163d28e28e373db2adb41da65d60ee41b90cdabbdd0516d337ed8353e06fad10b86138d6fcd0bc2a14ea21cf6370ef2b74e8a56e2d93052d5
-  data.tar.gz: edf5fa822ad030d78df3a4c7b2f702406e34d956f9a8c02c0ac034fa94589fda0d0ef2a8ff2755a5fecdb15d5c9cdf27e5fdd189d2bf9d91625189681dfcd00e
+  metadata.gz: d3f8a72059cee34fd75e6998f47662efd59f59c47cad3e998dea936a85ea8e38f059f37dc89794ebabc324c6e86ad7f8d50458c60db5b3a94f28d18dbdfa965a
+  data.tar.gz: 7207758b1628e88675c151ffc4d59256a37cc484d27ac7ee000eca6f2b32365cc2daf48c6541867c24757fdde7bff72911390dda25d070516ceb72c3dbc6beb7

data/.devcontainer.json

@@ -0,0 +1,38 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/docker-existing-docker-compose
+{
+	"name": "bootstrap_form",
+
+	// Update the 'dockerComposeFile' list if you have more compose files or use different names.
+	"dockerComposeFile": ["compose.yml", "compose.override.yml"],
+
+	// The 'service' property is the name of the service for the container that VS Code should
+	// use. Update this value and .devcontainer/docker-compose.yml to the real service name.
+	"service": "web",
+
+	// The optional 'workspaceFolder' property is the path VS Code should open by default when
+	// connected. This is typically a file mount in .devcontainer/docker-compose.yml
+	"workspaceFolder": "/app",
+	// "workspaceFolder": "/workspaces/${localWorkspaceFolderBasename}"
+
+	// Features to add to the dev container. More info: https://containers.dev/features.
+	// "features": {},
+
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// Uncomment the next line if you want start specific services in your Docker Compose config.
+	// "runServices": [],
+
+	// Uncomment the next line if you want to keep your containers running after VS Code shuts down.
+	"shutdownAction": "none"
+
+	// Uncomment the next line to run commands after the container is created.
+	// "postCreateCommand": "cat /etc/os-release",
+
+	// Configure tool-specific properties.
+	// "customizations": {},
+
+	// Uncomment to connect as an existing user other than the container default. More info: https://aka.ms/dev-containers-non-root.
+	// "remoteUser": "reid"
+}

data/.github/workflows/ruby.yml

@@ -3,19 +3,20 @@ name: Ruby
 on:
   push:
   pull_request:
+  workflow_dispatch:
 
 jobs:
   Lint:
     runs-on: ubuntu-latest
     env:
-      BUNDLE_GEMFILE: gemfiles/6.1.gemfile
+      BUNDLE_GEMFILE: gemfiles/7.2.gemfile
     steps:
       - uses: actions/checkout@v3
         with:
           fetch-depth: 0
       - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.0.6
+          ruby-version: 3.2.9
           bundler-cache: true
       # Disabled since it requires access not granted by GitHub Actions for PRs
       # - name: Danger
@@ -31,8 +32,8 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby-version: [ '3.2', '3.1', '3.0', 'ruby-head' ]
-        gemfile: [ '7.1', '7.0', '6.1', 'edge' ]
+        ruby-version: [ '3.4', '3.3', '3.2', 'ruby-head' ]
+        gemfile: [ '8.1', '8.0', '7.2', 'edge' ]
     env:
       BUNDLE_GEMFILE: gemfiles/${{ matrix.gemfile }}.gemfile
     steps:
@@ -53,6 +54,12 @@ jobs:
         with:
           working-directory: demo
           bundler-cache: true
+          ruby-version: 3.4.2
       - name: Run tests
         working-directory: demo
         run: bundle exec rake test:all
+      # - name: Commit changed screenshots and other files
+      #   if: failure()
+      #   working-directory: demo
+      #   run: bundle exec rake commit
+

data/.gitignore

@@ -4,14 +4,22 @@
 .npm/_npx
 
 .idea
-log/*.log
-pkg/
+/doc/
+/log/*.log
+/pkg/
+/tmp/
+
 demo/db/*.sqlite3
 demo/db/*.sqlite3-shm
 demo/db/*.sqlite3-wal
 demo/doc/screenshots/**/*.diff.png
+demo/doc/screenshots/**/*.base.png
 demo/log/*.log
+demo/storage
 demo/tmp/
+
+test/dummy/
+
 *.gem
 .rbenv-gemsets
 *.swp
@@ -27,10 +35,6 @@ Vagrantfile
 
 # For the demo app.
 
-# Ignore uploaded files in development.
-demo/storage/*
-!demo/storage/.keep
-
 demo/public/assets
 **/.byebug_history
 
@@ -47,13 +51,14 @@ demo/.yarn-integrity
 demo/vendor/bundle
 
 # For stuff that gets created if using the Dockerfile image
-.bundle/
+/.bundle/
 .cache/
 vendor/bundle
 
 # or .local/share/pry/pry_history if you need to be more exact
 .local/
 .irb_history
+.rdbg_history
 .byebug_history
 # For Debian images with Bash
 .bash_history
@@ -61,4 +66,12 @@ vendor/bundle
 .ash_history
 .sqlite_history
 
+compose.override.yml
 docker-compose.override.yml
+
+.vscode-server/
+.dotnet/
+.gnupg/
+.ssh/
+.gitconfig
+.gk/

data/.rubocop.yml

@@ -1,12 +1,12 @@
-require:
+plugins:
   - rubocop-performance
   - rubocop-rails
 
 AllCops:
   DisplayCopNames: true
   DisplayStyleGuide: true
-  TargetRubyVersion: 3.0
-  TargetRailsVersion: 6.1
+  TargetRubyVersion: 3.2
+  TargetRailsVersion: 7.1
   NewCops: enable
   Exclude:
     - bin/*
@@ -39,9 +39,7 @@ Layout/SpaceAroundEqualsInParameterDefault:
 
 Metrics/AbcSize:
   Max: 18
-  Exclude:
-    - "demo/test/**/*"
-    - "test/**/*"
+  Enabled: false
 
 Metrics/BlockLength:
   Exclude:

data/.yarnrc

@@ -2,4 +2,4 @@
 # yarn lockfile v1
 
 
-lastUpdateCheck 1698606246341
+lastUpdateCheck 1761786460258

data/CHANGELOG.md

@@ -6,6 +6,8 @@ https://github.com/bootstrap-ruby/bootstrap_form/releases
 
 ## Diffs
 
+- [5.5.0](https://github.com/bootstrap-ruby/bootstrap_form/compare/v5.4.0...v5.5.0)
+  [Closed issues](https://github.com/bootstrap-ruby/bootstrap_form/issues?q=closed%3A2023-10-30T00A00..2025-10-30T00)
 - [5.4.0](https://github.com/bootstrap-ruby/bootstrap_form/compare/v5.3.2...v5.4.0)
   [Closed issues](https://github.com/bootstrap-ruby/bootstrap_form/issues?q=closed%3A2023-09-15T21%3A00..2023-10-30T00)
 - [5.3.2](https://github.com/bootstrap-ruby/bootstrap_form/compare/v5.3.1...v5.3.2)
@@ -57,6 +59,7 @@ The tooling to support our old way of doing the change log doesn't work anymore,
 * [#573](https://github.com/bootstrap-ruby/bootstrap_form/issues/573): Add support for Bootstrap 5's floating labels
 
 * [#215](https://github.com/bootstrap-ruby/bootstrap_form/issues/215): Add `include_hidden` option to `check_box`
+
 ### 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.

data/CONTRIBUTING.md

@@ -50,140 +50,65 @@ You may find the [demo application](#the-demo-application) useful for developmen
 - If your PR fixes an issues, be sure to put "Fixes #nnn" in the description of the PR (where `nnn` is the issue number). Github will automatically close the issue when the PR is merged.
 - When the PR is submitted, check if GitHub Actions ran all the tests successfully, and didn't raise any issues.
 
-### 7. Done
-
-Somebody will shortly review your pull request and if everything is good, it will be
-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.
-
-- 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/).
+When you create or update a pull request, GitHub automatically runs tests that generate the screenshots in the [`README.md`](/README.md). If any of the screenshots change, GitHub will add an additional commit to your branch, with the updated screenshots.
 
-### 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 offers experimental support support for a couple of ways to develop using Docker, if you're interested:
+Normally, the screenshots should _not_ change. If the screenshots changed, please review them _carefully_. Some clear reasons why you would want to keep the changed screenshots:
 
-- Using `docker-compose`. This way is less tested, and is an attempt to make the Docker container a more complete environment where you can conveniently develop and release the gem.
-- Using just a simple Dockerfile. This way works for simple testing, but doesn't make it easy to release the gem, among other things.
+- Your PR was fixing behaviour that was wrong in the screenshot.
+- You added new examples in the documentation, so there are new screenshots.
+- A change to the images used by GitHub in their actions changes the behaviour of Chrome, although if you think it's this you should probably prepare a separate PR that _only_ updates the screenshots, so it's clear what the change is and why we're making the change.
 
-Docker is _not_ required to work on this gem.
-
-#### Using `docker-compose`
-
-The `docker-compose` approach should link to enough of your networking configuration that you can release the gem.
-However, you have to do some of the configuration yourself, because it's dependent on your host operating system.
-
-First, build the image for whatever version of Ruby you need (typically either the earliest supported version or the latest):
+Unless you have one of the above reasons, or you have a good explanation for why the screenshots have changed with your PR, you need to get rid of the changed screenshots (i.e. revert the last commit) and fix your PR so the screenshots don't change. (The reason you should revert the commit with the screenshots is so that the next time you push, GitHub will compare against the original screenshots, not the ones changed by your previous push.) Here's how to get rid of the changed screenshots:
 
 ```bash
-RUBY_VERSION=3.2 docker-compose build
+git pull # to bring the additional commit to your local branch.
+git revert HEAD # to remove the changes.
 ```
 
-You can run a shell in a Docker container that pretty much should behave like a Debian distribution with:
+Then fix the code and push your branch again.
 
-```bash
-docker-compose run --service-ports shell
-```
-
-(`--service-ports` exposes port 3000 so you can browse to the demo app on `localhost:3000`. If you just want to run a one-off command, or run the test suite, leave off the `--service-ports`.)
-
-The following instructions work for an Ubuntu host, and will probably work for other common Linux distributions.
-
-Add a `docker-compose.override.yml` in the local directory, that looks like this:
-
-```docker-compose.yml
-version: '3.3'
-
-# https://blog.giovannidemizio.eu/2021/05/24/how-to-set-user-and-group-in-docker-compose/
-
-services:
-  shell:
-    # You have to set the user and group for this process, because you're going to be
-    # creating all kinds of files from inside the container, that need to persist
-    # outside the container.
-    # Change `1000:1000` to the user and default group of your laptop user.
-    user: 1000:1000
-    volumes:
-      - /etc/passwd:/etc/passwd:ro
-      - ~/.gem/credentials:/app/.gem/credentials:ro
-      # $HOME here is your host computer's `~`, e.g. `/home/reid`.
-      # `ssh` explicitly looks for its config in the home directory from `/etc/passwd`,
-      # so the target for this has to look like your home directory on the host.
-      - ~/.ssh:${HOME}/.ssh:ro
-      - ${SSH_AUTH_SOCK}:/ssh-agent
-    environment:
-      - SSH_AUTH_SOCK=/ssh-agent
-```
+If the change was intended, a comment in the PR explaing why the change is expected would be very much appreciated. More than appreciated. It will avoid us having to ask you for an explanation.
 
-You may have to change the `1000:1000` to the user and group IDs of your laptop. You may also have to change the `version` parameter to match the version of the `docker-compose.yml` file.
-
-Adapting the above `docker-compose.override.yml` for MacOS should be relatively straight-forward. Windows users, I'm afraid you're on your own. If you figure this out, a PR documenting how to do it would be most welcome.
-
-The above doesn't allow you to run the system tests. To keep the image small, it doesn't include Chrome or any other browser.
-
-There is an experimental `docker-compose-system-test.yml` file, that runs the `bootstrap_forms` docker container along with an off-the-shelf Selenium container. To start this configuration:
-
-```bash
-RUBY_VERSION=3.2 docker-compose -f docker-compose-system-test.yml -f docker-compose.override.yml up&
-RUBY_VERSION=3.2 docker-compose -f docker-compose-system-test.yml -f docker-compose.override.yml exec shell /bin/bash
-```
-
-(Sometimes, on shutdown, the Rails server PID file isn't removed, and so the above will fail. `rm demo/tmp/pids/server.pid` will fix it.)
-
-Once in the shell:
+You can run the tests that generate the screenshots locally, but unless your environment is very much like the GitHub CI environment -- Ubuntu running Chrome with default fonts -- all the screenshots will be reported as having changed. To generate the screenshots:
 
 ```bash
 cd demo
-bundle exec rails test:system
+bundle exec rails test:all # or test:system
 ```
 
-Note that this system test approach is highly experimental and has some rough edges. The docker compose file and/or steps to run system tests may change. The tests currently fail, because the files with which they're being compared were generated on a Mac, but the Docker containers are running Linux.
+The [Docker development environment](#developing-with-docker) appears to generate screenshots that are the same as what GitHub generates.
 
-#### Simple Dockerfile
+Finally, maintainers may sometimes push changes directly to `main` or use other workflows to update the code. If pushing to `main` generates a commit for screenshot changes, please consider reverting your change immediately by executing the above `pull` and `revert` and another `push`, for the sanity of users who are using the edge (`main` branch) version of the gem. At any rate, review the changes promptly and use your judgement.
 
-This repository includes a `Dockerfile` to build an image with the minimum `bootstrap_form`-supported Ruby environment. To build the image:
+### 7. Done
 
-```bash
-docker build --tag bootstrap_form .
-```
+Somebody will shortly review your pull request and if everything is good, it will be
+merged into the main branch. Eventually the gem will be published with your changes.
 
-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.
+### Coding guidelines
 
-If you want to use a different Ruby version, or a smaller Linux distribution (although the distro may be missing tools you need):
+This project uses [RuboCop](https://github.com/bbatsov/rubocop) to enforce standard Ruby coding
+guidelines.
 
-```bash
-docker build --build-arg "RUBY_VERSION=3.0" --build-arg "DISTRO=slim-buster" --tag bootstrap_form .
-```
+- 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/).
 
-Then run the container you built with the shell, and create the bundle:
+### Supported Versions of Ruby and Rails
 
-```bash
-docker run --volume "$PWD:/app" --user $UID:`grep ^$USERNAME /etc/passwd | cut -d: -f4` -it bootstrap_form /bin/bash
-bundle install
-```
+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.
 
-You can run tests in the container as normal, with `rake test`.
+The Ruby on Rails support policy is [here](https://guides.rubyonrails.org/maintenance_policy.html).
 
-(Some of that command line is need for Linux hosts, to run the container as the current user.)
+### Developing with Docker
 
-One of the disadvantages of this approach is that you can't release the gem from here, because the Docker container doesn't have access to your SSH credentials, or the right user name, or perhaps other things needed to release a gem. But for simple testing, it works.
+This repository offers experimental support for development using Docker. Docker is _not_ required to do development work on this gem.
 
-#### Troubleshooting Docker
+One advantage of the Docker environment is that it allows you to generate and compare the screenshots with the expected screenshots in the repo. It also allows you to develop in an environment that is isolated from your own computer's set-up, so there's less risk of breaking other things you might be doing with your computer.
 
-- With the above configuration, the gems are kept in `vendor/bundle` on your hosts, which is `$GEM_HOME` or `/app/vendor/bundle` in the running Docker container. If you're having permission problems when switching versions of Ruby or Rails, you can try `sudo rm -rf vendor/bundle` on the host, then run `BUNDLE_GEMFILES=gemfiles/7.0.gemfile bundle update` in the Docker container to re-install all the gems with the right permissions.
+If you're intested in trying the Docker approach, read the [documentation](DOCKER.md).
 
 ### The Demo Application
 
@@ -226,7 +151,7 @@ Please try to keep the checked-in `.ruby-version` set to the oldest supported ve
 For the record, the demo app is set up as if the Rails app had been created with:
 
 ```sh
-rails new --skip-hotwire -d sqlite --edge -j esbuild -c bootstrap .
+rails new -d sqlite --edge -j esbuild -c bootstrap .
 ```
 
 This means it's using `esbuild` to pre-process the JavaScript and (S)CSS, and that it's using [`jsbunding-rails`](https://github.com/rails/jsbundling-rails) and [`cssbundling-rails`](https://github.com/rails/cssbundling-rails) to put the assets in `app/assets/builds`, before the Sprockets assets pipeline serves them in development, or pre-compiles them in production.

data/DOCKER.md

@@ -0,0 +1,95 @@
+# Working With Docker
+
+This repository offers experimental support support for developing using Docker, if you're interested. Docker is _not_ required to work on this gem.
+
+The `docker compose` approach should link to enough of your networking configuration that you can release the gem.
+However, you have to do some of the configuration yourself, because it's dependent on your host operating system.
+
+## Set-Up
+
+Put your personal and OS-specific configuration in a `compose.override.yml` file.
+
+The following instructions work for an Ubuntu host, and will probably work for other common Linux distributions. Add a `compose.override.yml` in the local directory, that looks like this:
+
+```compose.override.yml
+# https://blog.giovannidemizio.eu/2021/05/24/how-to-set-user-and-group-in-docker compose/
+
+services:
+  web:
+    # You have to set the user and group for this process, because you're going to be
+    # creating all kinds of files from inside the container, that need to persist
+    # outside the container.
+    # Change `1000:1000` to the user and default group of your laptop user.
+    user: 1000:1000
+    volumes:
+      - /etc/passwd:/etc/passwd:ro
+      - ~/.gem/credentials:/app/.gem/credentials:ro
+      # $HOME here is your host computer's `~`, e.g. `/home/reid`.
+      # `ssh` explicitly looks for its config in the home directory from `/etc/passwd`,
+      # so the target for this has to look like your home directory on the host.
+      - ~/.ssh:${HOME}/.ssh:ro
+      - ${SSH_AUTH_SOCK}:/ssh-agent
+    environment:
+      - SSH_AUTH_SOCK=/ssh-agent
+```
+
+You may have to change the `1000:1000` to the user and group IDs of your laptop. You may also have to change the `version` parameter to match the version of the `docker compose.yml` file.
+
+Adapting the above `compose.override.yml` for MacOS should be relatively straight-forward. Windows users, I'm afraid you're on your own. If you figure this out, a PR documenting how to do it would be most welcome.
+
+## Running
+
+Start the containers:
+
+```bash
+docker compose up -d
+```
+
+You may need to install or update the gems:
+
+```bash
+docker compose exec web bundle install
+```
+
+To get a shell in the container:
+
+```bash
+docker compose exec web /bin/bash
+```
+
+Once in the shell, run tests:
+
+```bash
+bundle exec rake test
+```
+
+Run the demo app and browse to it:
+
+```bash
+cd demo
+bin/dev
+```
+
+On the host, not the Docker container, get the port number(s) you can use in the browser to access the test app running in the Docker container:
+
+```bash
+docker compose port web 3001 | cut -d: -f 2 # Browser
+docker compose port web 7900 | cut -d: -f 2 # To watch the browser execute system tests.
+```
+
+Browse to `localhost:<port number from above>`.
+
+Run system tests:
+
+```bash
+cd demo
+bundle exec rails test:system
+```
+
+Note that this system test approach is highly experimental and has some rough edges. The docker compose file and/or steps to run system tests may change.
+
+## Troubleshooting Docker
+
+- With the above configuration, the gems are kept in `vendor/bundle` on your hosts, which is `$GEM_HOME` or `/app/vendor/bundle` in the running Docker container. If you're having permission problems when switching versions of Ruby or Rails, you can try `sudo rm -rf vendor/bundle` on the host, then run `BUNDLE_GEMFILES=gemfiles/7.0.gemfile bundle update` in the Docker container to re-install all the gems with the right permissions.
+- Sometimes, on shutdown, the Rails server PID file isn't removed, and so the above will fail. `rm demo/tmp/pids/server.pid` will fix it.
+

data/Gemfile

@@ -3,5 +3,9 @@ eval File.read(gems), binding, gems # rubocop: disable Security/Eval
 
 require "#{__dir__}/lib/bootstrap_form/version"
 
+gem "bigdecimal" if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("3.4.0")
+gem "drb" if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("3.4.0")
+gem "mutex_m" if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("3.4.0")
 gem "rails", BootstrapForm::REQUIRED_RAILS_VERSION
-gem "sprockets-rails", require: "sprockets/railtie"
+gem "propshaft"
+gem "sqlite3"