bootstrap_form 5.1.0 → 5.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75c715774dfcbad34c15dbd54c3a14da015c4e67805c0a1adfbfd36ff0f0d27b
-  data.tar.gz: f1a3c95a6cd6f2012c8062f5e3c3f8b680cb17292141443d8465625a552d1e5b
+  metadata.gz: 9bea3ab95f979a7fc02d2c2a5dff3bae3ca536c6e277a86d11361c3e3bd72e59
+  data.tar.gz: 80fa55a6cbcd89ae0b52ebc8135d8b9f38b25b321bdbe492983db46c866c1e7d
 SHA512:
-  metadata.gz: 75107dba8802198d3685161d292ae40e28e9e83acd688c7779a5bf9eade665bdad236c7f64aeac906872a9e751f77ad98a6e24bda27334a8472bb5ec11855906
-  data.tar.gz: 0c30626a9bde0725bc7ca12713bc9d9acc588832e450752a4142c3a9bc63a47aec9bbdf016a1973ea173153ae700c88f4e0be820ca75c0047ced7cd5d8daa0dc
+  metadata.gz: a97b0ddfb9afcfb847b27ea4853c4f3b99bb0c72a0366d4d1a0a3fac217f0693090c96ea03c51e3a07e66cfe3c8c4576be8618eb3b48401c6d6f326e35619fa7
+  data.tar.gz: 3d79f681187a5fa0cab604ced1919229cdbdd101cc8f91c4261a115b82fa5589c3037b8b0c6d6208ce17affe964397a8fc33a9483a82a5c74efd22c9224eb582

data/.github/workflows/ruby.yml

@@ -7,13 +7,15 @@ on:
 jobs:
   Lint:
     runs-on: ubuntu-latest
+    env:
+      BUNDLE_GEMFILE: gemfiles/6.0.gemfile
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
         with:
           fetch-depth: 0
       - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.7
+          ruby-version: 3.0.6
           bundler-cache: true
       # Disabled since it requires access not granted by GitHub Actions for PRs
       # - name: Danger
@@ -23,22 +25,21 @@ jobs:
       #   run: |
       #     bundle exec danger
       - name: Rubocop
-        run: bundle exec rubocop --auto-correct
+        run: bundle exec rubocop --autocorrect
   Test:
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
-        ruby-version: [ '3.1', '3.0', '2.7' ]
-        gemfile: [ '7.0', '6.1', '6.0', '5.2', 'edge' ]
+        ruby-version: [ '3.2', '3.1', '3.0' ]
+        gemfile: [ '7.0', '6.1', '6.0', 'edge' ]
         exclude:
+          - { ruby-version: '3.2', gemfile: "6.0" }
           - { ruby-version: '3.1', gemfile: "6.0" }
-          - { ruby-version: '3.1', gemfile: "5.2" }
-          - { ruby-version: '3.0', gemfile: "5.2" }
     env:
       BUNDLE_GEMFILE: gemfiles/${{ matrix.gemfile }}.gemfile
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
@@ -46,3 +47,15 @@ jobs:
           bundler-cache: true
       - name: Run tests
         run: bundle exec rake test
+  Demo:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          working-directory: demo
+          bundler-cache: true
+      - name: Run tests
+        working-directory: demo
+        run: bundle exec rake test:all

data/.gitignore

@@ -16,7 +16,9 @@ gemfiles/*.lock
 /.ruby-version
 Vagrantfile
 .vagrant
-.yarnrc
+**/.yarn/**/cache
+**/.yarn/install-state.gz
+**/.yarn/unplugged
 
 # For the demo app.
 
@@ -25,7 +27,7 @@ demo/storage/*
 !demo/storage/.keep
 
 demo/public/assets
-.byebug_history
+**/.byebug_history
 
 # Ignore master key for decrypting credentials and more.
 demo/config/master.key

data/.rubocop.yml

@@ -5,7 +5,8 @@ require:
 AllCops:
   DisplayCopNames: true
   DisplayStyleGuide: true
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.0
+  TargetRailsVersion: 6.0
   NewCops: enable
   Exclude:
     - bin/*

data/.yarnrc

@@ -0,0 +1,5 @@
+# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+# yarn lockfile v1
+
+
+lastUpdateCheck 1681870014941

data/CHANGELOG.md

@@ -1,12 +1,18 @@
 # Change Log
 
-## Apology
+You can find recent releases with docs in GitHub:
 
-The tooling to support our old way of doing the change log doesn't work anymore, and we don't have a better solution, so this change log has become unreliable since version 4.5.0. Please refer to the commit history if you need to debug changes.
+https://github.com/bootstrap-ruby/bootstrap_form/releases
 
+## Diffs
 
-- [Pending Release](https://github.com/bootstrap-ruby/bootstrap_form/compare/v5.1.0...HEAD)
+- [Pending Release](https://github.com/bootstrap-ruby/bootstrap_form/compare/v5.2.0...HEAD)
+- [5.2.1](https://github.com/bootstrap-ruby/bootstrap_form/compare/v5.2.0...v5.2.1)
+  [Issues](https://github.com/bootstrap-ruby/bootstrap_form/issues?q=closed%3A2023-05-20T23%3A59..2023-05-23T10%3A00)
+- [5.2.0](https://github.com/bootstrap-ruby/bootstrap_form/compare/v5.1.0...v5.2.0)
+  [Issues](https://github.com/bootstrap-ruby/bootstrap_form/issues?q=closed%3A2022-06-25T17%3A22..2023-05-20T23%3A59)
 - [5.1.0](https://github.com/bootstrap-ruby/bootstrap_form/compare/v5.0.0...v5.1.0)
+  [Issues](https://github.com/bootstrap-ruby/bootstrap_form/issues?q=closed%3A2021-11-12T05%3A58..2022-06-25T17%3A22)
 - [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)
@@ -23,6 +29,10 @@ The tooling to support our old way of doing the change log doesn't work anymore,
 - [2.5.0](https://github.com/bootstrap-ruby/bootstrap_form/compare/v2.4.0...v2.5.0)
 - [2.4.0](https://github.com/bootstrap-ruby/bootstrap_form/compare/v2.3.0...v2.4.0)
 
+## Older releases
+
+The tooling to support our old way of doing the change log doesn't work anymore, and we don't have a better solution, so this change log has become unreliable since version 4.5.0. Please refer to the commit history if you need to debug changes.
+
 ## [Pending Release][]
 
 ### Breaking changes

data/CONTRIBUTING.md

@@ -46,11 +46,11 @@ You may find the [demo application](#the-demo-application) useful for developmen
 
 ### 6. Make a pull request
 
-- If you've never made a pull request (PR) before, read this: https://help.github.com/articles/about-pull-requests/.
+- If you've never made a pull request (PR) before, read [this](https://help.github.com/articles/about-pull-requests/).
 - 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 Travis CI ran all the tests successfully, and didn't raise any issues.
 
-### 7. Done!
+### 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.
@@ -74,6 +74,59 @@ The Ruby on Rails support policy is [here](https://guides.rubyonrails.org/mainte
 
 ### Developing with Docker
 
+This repository offers experimental support support for a couple of ways to develop using Docker, if you're interested:
+
+- 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.
+
+Docker is _not_ requied 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.
+You can run a shell in a Docker container that pretty much should behave like a Debian distribution with:
+
+```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 on-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
+```
+
+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.
+
+#### Simple Dockerfile
+
 This repository includes a `Dockerfile` to build an image with the minimum `bootstrap_form`-supported Ruby environment. To build the image:
 
 ```bash
@@ -85,7 +138,7 @@ This builds an image called `bootstrap_form`. You can change that to any tag you
 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 .
+docker build --build-arg "RUBY_VERSION=3.0" --build-arg "DISTRO=slim-buster" --tag bootstrap_form .
 ```
 
 Then run the container you built with the shell, and create the bundle:
@@ -99,6 +152,12 @@ 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.)
 
+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.
+
+#### 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.
+
 ### The Demo Application
 
 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.
@@ -110,8 +169,7 @@ To run the demo app, set up the database and run the server:
 cd demo
 bundle
 rails db:setup
-yarn build --watch &
-rails s -b 0.0.0.0
+dev
 ```
 
 To run the demo app in the Docker container:
@@ -119,21 +177,32 @@ 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 BUNDLE_GEMFILE=../gemfiles/7.0.gemfile
+bundle
 rails db:setup
-yarn build --watch &
-rails s -b 0.0.0.0
+dev
 ```
 
-The app doesn't appear to find the source map, or perhaps it isn't being generated. In the Rails log you will see messages similar to:
+You'll see errors in the browser console about duplicate ids. This is expected, since the demo app has many forms with the same fields in them. Something we can fix in the future, perhaps.
 
-```bash
-ActionController::RoutingError (No route matches [GET] "/assets/application.js-c6c0edbd68f05cffd0e2495198bfbc4bf42be8a11b76eecbfade30a8036b6b87.map")
+To use other supported versions of Rails, you will need to create a `Gemfile` for the Rails version. Then, change the `export BUNDLE_GEMFILE...` line to your gem file. Finally, figure out how to include the assets.
+
+If you need to run the Rails server separately, for example, to debug the server, you _must_ run it like this:
+
+```sh
+bundle exec rails s -b 0.0.0.0
 ```
 
-But this doesn't seem to affect how the app runs.
+If you run just `rails` or even `bin/rails`, the `sprockets-rails` gem won't load and you'll either get error messages, or the assets  won't be available to the demo app. At the moment it's a mystery why. PRs to fix this are welcome.
 
-To use other supported versions of Rails, you will need to create a `Gemfile` for the Rails version. Then, change the `export BUNDLE_GEMFILE...` line to your gem file. Finally, figure out how to include the assets.
+Please try to keep the checked-in `.ruby-version` set to the oldest supported version of Ruby. You're welcome and encouraged to try the demo app with other Ruby versions. Just don't check in the `.ruby-version` to GitHub.
+
+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 .
+```
+
+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.
 
 ## Documentation Contributions
 
@@ -147,7 +216,7 @@ 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
+Thanks to all the [great contributors](https://github.com/bootstrap-ruby/bootstrap_form/graphs/contributors) over the years.
 
 ## Troubleshooting
 
@@ -162,3 +231,21 @@ cd demo
 rails db:setup # create the databases from `schema.rb`
 rails db:migrate # add the new tables and create a new `schema.rb`
 ```
+
+### RuboCop
+
+When you push a branch, RuboCop checks may fail, but locally you can't reproduce the failure. This may be because you're using a different version of RuboCop locally. When you push, the RuboCop tests use the currently available version of RuboCop. If you've been working on the branch for a while, it's likely you have a `Gemfile.lock` that specifies an older version of RuboCop.
+
+The first thing to try is to update your `Gemfile.lock` locally:
+
+```bash
+bundle update
+```
+
+Or, if you really want to minimize your work:
+
+```bash
+bundle update --conservative rubocop
+```
+
+This should enable you to reproduce the RuboCop failures locally, and then you can fix them.

data/Dangerfile

@@ -19,8 +19,8 @@ has_changelog_changes = git.modified_files.include?("CHANGELOG.md")
 # You've made changes to lib, but didn't write any tests?
 # ------------------------------------------------------------------------------
 if has_lib_changes && !has_test_changes
-  warn("There are code changes, but no corresponding tests. "\
-       "Please include tests if this PR introduces any modifications in "\
+  warn("There are code changes, but no corresponding tests. " \
+       "Please include tests if this PR introduces any modifications in " \
        "#{project_name}'s behavior.",
        sticky: false)
 end
@@ -36,8 +36,8 @@ if !has_changelog_changes && has_lib_changes
   * [##{pr_number}](#{pr_url}): #{github.pr_title} - [@#{github.pr_author}](https://github.com/#{github.pr_author}).
   ```
   MARKDOWN
-  warn("Please update CHANGELOG.md with a description of your changes. "\
-       "If this PR is not a user-facing change (e.g. just refactoring), "\
+  warn("Please update CHANGELOG.md with a description of your changes. " \
+       "If this PR is not a user-facing change (e.g. just refactoring), " \
        "you can disregard this.", sticky: false)
 end
 

data/Dockerfile

@@ -1,4 +1,4 @@
-ARG RUBY_VERSION=2.7
+ARG RUBY_VERSION=3.0
 ARG DISTRO=bullseye
 
 FROM ruby:$RUBY_VERSION-$DISTRO
@@ -13,9 +13,9 @@ 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
+# Rails wants a newer version of node that we get with the Debian distro.
+RUN curl -fsSL https://deb.nodesource.com/setup_18.x | bash - && apt-get install -y nodejs
+RUN corepack enable && corepack prepare yarn@stable --activate
+RUN apt install -y -q yarn sqlite3
 
 EXPOSE 3000

data/Gemfile

@@ -1,23 +1,7 @@
-source "http://rubygems.org"
+gems = "#{__dir__}/gemfiles/common.gemfile"
+eval File.read(gems), binding, gems # rubocop: disable Security/Eval
 
-gemspec path: __dir__
+require "#{__dir__}/lib/bootstrap_form/version"
 
-# To test with different Rails versions, use the files in `./gemfiles`
-
-group :development do
-  gem "htmlbeautifier"
-  gem "rubocop-performance", require: false
-  gem "rubocop-rails", require: false
-  gem "webpacker"
-end
-
-group :test do
-  gem "diffy"
-  gem "equivalent-xml"
-  gem "mocha"
-  gem "sqlite3"
-end
-
-group :ci do
-  gem "danger"
-end
+gem "rails", BootstrapForm::REQUIRED_RAILS_VERSION
+gem "sprockets-rails", require: "sprockets/railtie"