bootstrap_form 5.3.2 → 5.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7186ebccc43337fd8f78a3ced57a26654daf865e57493b10e29259057030830e
-  data.tar.gz: af0ee29e7b0fdcfb277d218038a68157fce0de44273f07921d8edcc7fd496166
+  metadata.gz: f83f141afb358e5297da435acb97a61de05d38ba70493ce820a0679f002eab41
+  data.tar.gz: edf0410f0a0239f36c0ea4a779e235cc5ee494a2efa2d9ecda2875222c1ba1fe
 SHA512:
-  metadata.gz: 8e77aebaaf5728eb933a3f57d492d10745a8867543e87f30e77e5ec922a3fe61783d6a769f1217eebee921782506b44c2e91d76a0bc71dc9e10f896be0f33dfc
-  data.tar.gz: bc6fde236ec6cdebd0c54633828caea0b7f578ffa8669d2d6e9b9fc9b2abce4f89fa20f5d0be5de6c96c05faee23f2459619b0b5585ec9e0d3545a607ac99e9d
+  metadata.gz: 714e076f29f7067163d28e28e373db2adb41da65d60ee41b90cdabbdd0516d337ed8353e06fad10b86138d6fcd0bc2a14ea21cf6370ef2b74e8a56e2d93052d5
+  data.tar.gz: edf5fa822ad030d78df3a4c7b2f702406e34d956f9a8c02c0ac034fa94589fda0d0ef2a8ff2755a5fecdb15d5c9cdf27e5fdd189d2bf9d91625189681dfcd00e

data/.github/workflows/ruby.yml

@@ -31,8 +31,8 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby-version: [ '3.2', '3.1', '3.0' ]
-        gemfile: [ '7.0', '6.1', 'edge' ]
+        ruby-version: [ '3.2', '3.1', '3.0', 'ruby-head' ]
+        gemfile: [ '7.1', '7.0', '6.1', 'edge' ]
     env:
       BUNDLE_GEMFILE: gemfiles/${{ matrix.gemfile }}.gemfile
     steps:

data/.gitignore

@@ -1,8 +1,14 @@
-.bundle/
+.npm/_update-notifier-last-checked
+.npm/_cacache/
+.npm/_logs/
+.npm/_npx
+
 .idea
 log/*.log
 pkg/
 demo/db/*.sqlite3
+demo/db/*.sqlite3-shm
+demo/db/*.sqlite3-wal
 demo/doc/screenshots/**/*.diff.png
 demo/log/*.log
 demo/tmp/

data/.rubocop.yml

@@ -45,6 +45,7 @@ Metrics/AbcSize:
 
 Metrics/BlockLength:
   Exclude:
+    - "lib/bootstrap_form/inputs/base.rb"
     - "demo/config/**/*"
     - "demo/test/**/*"
     - "test/**/*"

data/.yarnrc

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

data/CHANGELOG.md

@@ -6,6 +6,8 @@ https://github.com/bootstrap-ruby/bootstrap_form/releases
 
 ## Diffs
 
+- [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)
   [Closed issues](https://github.com/bootstrap-ruby/bootstrap_form/issues?q=closed%3A2023-09-15T15%3A00..2023-09-15T21%3A00)
 - [5.3.1](https://github.com/bootstrap-ruby/bootstrap_form/compare/v5.3.0...v5.3.1)

data/CONTRIBUTING.md

@@ -85,13 +85,20 @@ 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.
+
+First, build the image for whatever version of Ruby you need (typically either the earliest supported version or the latest):
+
+```bash
+RUBY_VERSION=3.2 docker-compose build
+```
+
 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`.)
+(`--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.
 
@@ -123,7 +130,27 @@ services:
 
 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.
+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:
+
+```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. 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.
 
 #### Simple Dockerfile
 

data/Dockerfile

@@ -3,6 +3,8 @@ ARG DISTRO=bullseye
 
 FROM ruby:$RUBY_VERSION-$DISTRO
 
+ARG NODE_MAJOR=18
+
 RUN mkdir -p /app
 ENV HOME /app
 WORKDIR /app
@@ -12,10 +14,9 @@ ENV BUNDLE_APP_CONFIG="$GEM_HOME"
 ENV PATH ./bin:$GEM_HOME/bin:$PATH
 RUN (echo 'docker'; echo 'docker') | passwd root
 
-# Yarn installs nodejs.
-# 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
+# Rails wants a newer version of node than we get with the Debian distro.
+RUN curl -fsSL https://deb.nodesource.com/setup_$NODE_MAJOR.x | bash - && apt-get install -y nodejs
 RUN corepack enable && corepack prepare yarn@stable --activate
-RUN apt install -y -q yarn sqlite3
+RUN apt install -y -q sqlite3
 
 EXPOSE 3000

data/README.md

@@ -31,7 +31,7 @@ Some other nice things that `bootstrap_form` does for you are:
 
 ## Installation
 
-Install Bootstrap 5. There are many ways to do this, depending on the asset pipeline you're using in your Rails application. One way is to use the gem that works with Sprockets. To do so, in a brand new Rails 7.0 application created _without_ the `--webpacker` option, add the `bootstrap` gem to your `Gemfile`:
+Install Bootstrap 5. There are many ways to do this, depending on the asset pipeline you're using in your Rails application. One way is to use the gem that works with Sprockets. To do so, in a brand new Rails 7.0+ application created _without_ the `--webpacker` option, add the `bootstrap` gem to your `Gemfile`:
 
 ```ruby
 gem "bootstrap", "~> 5.0"
@@ -42,7 +42,7 @@ And follow the remaining instructions in the [official bootstrap installation gu
 Add the `bootstrap_form` gem to your `Gemfile`:
 
 ```ruby
-gem "bootstrap_form", "~> 5.3"
+gem "bootstrap_form", "~> 5.4"
 ```
 
 Then:
@@ -1064,7 +1064,7 @@ will be rendered as:
       </div>
     </div>
   </trix-toolbar>
-  <trix-editor aria-label="Life story" class="trix-content form-control" contenteditable="" data-blob-url-template="http://test.host/rails/active_storage/blobs/redirect/:signed_id/:filename" data-direct-upload-url="http://test.host/rails/active_storage/direct_uploads" id="user_life_story" input="user_life_story_trix_input_user" role="textbox" toolbar="trix-toolbar-1" trix-id="1">
+  <trix-editor aria-label="Life story" class="trix-content form-control" contenteditable="" data-blob-url-template="http://shell:3001/rails/active_storage/blobs/redirect/:signed_id/:filename" data-direct-upload-url="http://shell:3001/rails/active_storage/direct_uploads" id="user_life_story" input="user_life_story_trix_input_user" role="textbox" toolbar="trix-toolbar-1" trix-id="1">
   </trix-editor>
 </div>
 ```
@@ -1693,7 +1693,7 @@ Generated HTML:
 <form accept-charset="UTF-8" action="/address" class="new_address" id="new_address_1" method="post">
   <div class="mb-3">
     <label class="form-label required" for="address_user_id">User</label>
-    <select class="form-select" id="address_user_id" name="address[user_id]">
+    <select class="form-select" id="address_user_id" name="address[user_id]" required="required">
       <option value="">Select a value</option>
       <option value="">steve@example.com</option>
     </select>
@@ -1726,10 +1726,10 @@ Fields can be disabled using the standard Rails form helper option.
 ```erb
 <%= bootstrap_form_for @user do |f| %>
   <div class="row g-3">
-    <div class="col-auto"><%= f.email_field :email, disabled: true %></div>
-    <div class="col-auto"><%= f.password_field :password, disabled: true %></div>
-    <div class="col-auto"><%= f.text_area :comments, disabled: true %></div>
-    <div class="col-auto"><%= f.text_field :status, disabled: true %></div>
+    <div class="col-auto"><%= f.email_field :email, disabled: true, size: 18 %></div>
+    <div class="col-auto"><%= f.password_field :password, disabled: true, size: 18 %></div>
+    <div class="col-auto"><%= f.text_area :comments, disabled: true, rows: 2, cols: 18 %></div>
+    <div class="col-auto"><%= f.text_field :status, disabled: true, size: 18 %></div>
     <div class="col-auto"><%= f.number_field :misc, label: "Number", disabled: true %></div>
     <div class="col-auto"><%= f.radio_button :preferences, 1, disabled: true %></div>
     <div class="col-auto"><%= f.check_box :terms, disabled: true %></div>
@@ -1748,26 +1748,26 @@ Generated HTML:
     <div class="col-auto">
       <div class="mb-3">
         <label class="form-label required" for="user_email">Email</label>
-        <input class="form-control" disabled id="user_email" name="user[email]" required="required" type="email" value="steve@example.com">
+        <input class="form-control" disabled id="user_email" name="user[email]" required="required" size="18" type="email" value="steve@example.com">
       </div>
     </div>
     <div class="col-auto">
       <div class="mb-3">
         <label class="form-label" for="user_password">Password</label>
-        <input class="form-control" disabled id="user_password" name="user[password]" type="password">
+        <input class="form-control" disabled id="user_password" name="user[password]" size="18" type="password">
       </div>
     </div>
     <div class="col-auto">
       <div class="mb-3">
         <label class="form-label" for="user_comments">Comments</label>
-        <textarea class="form-control" disabled id="user_comments" name="user[comments]">
+        <textarea class="form-control" cols="18" disabled id="user_comments" name="user[comments]" rows="2">
 </textarea>
       </div>
     </div>
     <div class="col-auto">
       <div class="mb-3">
         <label class="form-label" for="user_status">Status</label>
-        <input class="form-control" disabled id="user_status" name="user[status]" type="text">
+        <input class="form-control" disabled id="user_status" name="user[status]" size="18" type="text">
       </div>
     </div>
     <div class="col-auto">

data/RELEASING.md

@@ -14,13 +14,13 @@ Follow these steps to release a new version of bootstrap_form to rubygems.org.
 2. Update the version in `./lib/bootstrap_form/version.rb`.
 3. Make sure that you have all the gems necessary for testing and releasing.
 
-       BUNDLE_GEMFILE=gemfiles/7.0.gemfile bundle update
+       BUNDLE_GEMFILE=gemfiles/7.1.gemfile bundle update
 
 4. **Ensure the tests are passing by running the tests**
 
    (There should be no errors or warnings.)
 
-       BUNDLE_GEMFILE=gemfiles/7.0.gemfile bundle exec rake test
+       BUNDLE_GEMFILE=gemfiles/7.1.gemfile bundle exec rake test
 
 5. **Ensure the demo tests are passing by running**
 
@@ -29,6 +29,8 @@ Follow these steps to release a new version of bootstrap_form to rubygems.org.
        bundle exec rake test:all
        cd -
 
+   (You will have failures unless you're running on a Mac configured so the screenshots will be identical. This is something that we're hoping to fix.)
+
 6. Update the GitHub diff links at the beginning of `CHANGELOG.md` (The pattern should be obvious when you look at them).
 7. Update the installation instructions in `README.md` to use the new version.
 8. Commit the CHANGELOG and version changes in a single commit; the message should be "Preparing vX.Y.Z" where `X.Y.Z` is the version being released.

data/docker-compose-system-test.yml

@@ -0,0 +1,45 @@
+version: '3.3'
+
+services:
+  app: &app
+    build:
+      context: .
+      args:
+        NODE_MAJOR: "12"
+        YARN_VERSION: "1.22.4"
+        RUBY_VERSION: ${RUBY_VERSION}
+    image: bootstrap-form:latest-$RUBY_VERSION
+    tmpfs:
+      - /tmp
+
+  shell:
+    <<: *app
+    stdin_open: true
+    tty: true
+    volumes:
+      - .:/app:cached
+    environment:
+      - SSH_AUTH_SOCK=/ssh-agent
+      - NODE_ENV=development
+      - BOOTSNAP_CACHE_DIR=/usr/local/bundle/_bootsnap
+      - WEB_CONCURRENCY=1
+      - HISTFILE=/app/.bash_history
+      - SELENIUM_HOST=selenium
+      - SELENIUM_PORT=4444
+      - TEST_APP_HOST=shell
+      - TEST_APP_PORT=3001
+    ports:
+      - "3001:3001"
+    command: /bin/bash
+
+  selenium:
+    image: selenium/standalone-chrome:118.0
+    logging:
+      driver: none
+    stdin_open: true
+    tty: true
+    environment:
+      - LANG=en_CA.UTF-8
+    ports:
+      - '4444:4444'
+      - '5900:5900'

data/docker-compose.yml

@@ -5,8 +5,7 @@ services:
     build:
       context: .
       args:
-        NODE_MAJOR: "12"
-        YARN_VERSION: "1.22.4"
+        NODE_MAJOR: "18"
         RUBY_VERSION: ${RUBY_VERSION}
     image: bootstrap-form:latest-$RUBY_VERSION
     tmpfs:
@@ -23,7 +22,6 @@ services:
       - NODE_ENV=development
       - RAILS_ENV=${RAILS_ENV:-development}
       - BOOTSNAP_CACHE_DIR=/usr/local/bundle/_bootsnap
-      - WEBPACKER_DEV_SERVER_HOST=webpacker
       - WEB_CONCURRENCY=1
       - HISTFILE=/app/.bash_history
     ports:

data/gemfiles/7.1.gemfile

@@ -0,0 +1,5 @@
+gems = "#{__dir__}/common.gemfile"
+eval File.read(gems), binding, gems # rubocop: disable Security/Eval
+
+gem "rails", "~> 7.1.0"
+gem "sprockets-rails", require: "sprockets/railtie"

data/lib/bootstrap_form/components/labels.rb

@@ -43,10 +43,11 @@ module BootstrapForm
       end
 
       def label_text(name, options)
+        label = options[:text] || object&.class&.try(:human_attribute_name, name)&.html_safe # rubocop:disable Rails/OutputSafety
         if label_errors && error?(name)
-          (options[:text] || object.class.human_attribute_name(name)).to_s + " #{get_error_messages(name)}"
+          (" ".html_safe + get_error_messages(name)).prepend(label)
         else
-          options[:text] || object&.class.try(:human_attribute_name, name)
+          label
         end
       end
     end

data/lib/bootstrap_form/components/validation.rb

@@ -82,7 +82,7 @@ module BootstrapForm
           end
         end
 
-        object.errors[name].join(", ")
+        safe_join(object.errors[name], ", ")
       end
       # rubocop:enable Metrics/AbcSize
     end

data/lib/bootstrap_form/form_builder.rb

@@ -45,6 +45,8 @@ module BootstrapForm
     include BootstrapForm::Inputs::UrlField
     include BootstrapForm::Inputs::WeekField
 
+    include ActionView::Helpers::OutputSafetyHelper
+
     delegate :content_tag, :capture, :concat, :tag, to: :@template
 
     def initialize(object_name, object, template, options)
@@ -66,8 +68,8 @@ module BootstrapForm
       return unless options[:layout] == :inline
 
       options[:html][:class] =
-        ([*options[:html][:class]&.split(/\s+/)] + %w[row row-cols-auto g-3 align-items-center])
-        .compact.uniq.join(" ")
+        safe_join(([*options[:html][:class]&.split(/\s+/)] + %w[row row-cols-auto g-3 align-items-center])
+        .compact.uniq, " ")
     end
 
     def fields_for_with_bootstrap(record_name, record_object=nil, fields_options={}, &block)

data/lib/bootstrap_form/form_group_builder.rb

@@ -91,7 +91,7 @@ module BootstrapForm
       css_options = html_options || options
       # Add control_class; allow it to be overridden by :control_class option
       control_classes = css_options.delete(:control_class) { control_class }
-      css_options[:class] = [control_classes, css_options[:class]].compact.join(" ")
+      css_options[:class] = safe_join([control_classes, css_options[:class]].compact, " ")
       css_options[:class] << " is-invalid" if error?(method)
       css_options[:placeholder] = form_group_placeholder(options, method) if options[:label_as_placeholder]
       css_options

data/lib/bootstrap_form/helpers/bootstrap.rb

@@ -1,6 +1,8 @@
 module BootstrapForm
   module Helpers
     module Bootstrap
+      include ActionView::Helpers::OutputSafetyHelper
+
       def alert_message(title, options={})
         css = options[:class] || "alert alert-danger"
         return unless object.respond_to?(:errors) && object.errors.full_messages.any?
@@ -31,11 +33,12 @@ module BootstrapForm
         custom_class = options[:custom_class] || false
 
         tag.div class: custom_class || "invalid-feedback" do
-          if hide_attribute_name
-            object.errors[name].join(", ")
-          else
-            object.errors.full_messages_for(name).join(", ")
-          end
+          errors = if hide_attribute_name
+                     object.errors[name]
+                   else
+                     object.errors.full_messages_for(name)
+                   end
+          safe_join(errors, ", ")
         end
       end
 
@@ -93,7 +96,7 @@ module BootstrapForm
         tags = [*options[key]].map do |item|
           input_group_content(item)
         end
-        ActiveSupport::SafeBuffer.new(tags.join)
+        safe_join(tags)
       end
     end
   end

data/lib/bootstrap_form/inputs/base.rb

@@ -31,9 +31,16 @@ module BootstrapForm
           bootstrap_alias field_name
         end
 
+        # Creates the methods *_without_bootstrap and *_with_bootstrap.
+        #
+        # If your application did not include the rails gem for one of the dsl
+        # methods, then a name error is raised and suppressed. This can happen
+        # if your application does not include the actiontext dependency due to
+        # `rich_text_area` not being defined.
         def bootstrap_alias(field_name)
           alias_method "#{field_name}_without_bootstrap".to_sym, field_name
           alias_method field_name, "#{field_name}_with_bootstrap".to_sym
+        rescue NameError # rubocop:disable Lint/SuppressedException
         end
       end
 

data/lib/bootstrap_form/inputs/rich_text_area.rb

@@ -10,7 +10,7 @@ module BootstrapForm
         def rich_text_area_with_bootstrap(name, options={})
           form_group_builder(name, options) do
             prepend_and_append_input(name, options) do
-              options[:class] = ["trix-content", options[:class]].compact.join(" ")
+              options[:class] = safe_join(["trix-content", options[:class]].compact, " ")
               rich_text_area_without_bootstrap(name, options)
             end
           end

data/lib/bootstrap_form/version.rb

@@ -1,4 +1,4 @@
 module BootstrapForm
-  VERSION = "5.3.2".freeze
+  VERSION = "5.4.0".freeze
   REQUIRED_RAILS_VERSION = ">= 6.1".freeze
 end

data/lib/bootstrap_form.rb

@@ -1,9 +1,13 @@
-# NOTE: The rich_text_area and rich_text_area_tag helpers are defined in a file with a different
-# name and not in the usual autoload-reachable way.
+# NOTE: The rich_text_area and rich_text_area_tag helpers are defined in a file
+# with a different name and not in the usual autoload-reachable way.
 # The following line is definitely need to make `bootstrap_form` work.
-if Rails::VERSION::STRING > "6"
+# rubocop:disable Lint/SuppressedException
+begin
   require "#{Gem::Specification.find_by_name('actiontext').gem_dir}/app/helpers/action_text/tag_helper"
+rescue Gem::MissingSpecError
 end
+# rubocop:enable Lint/SuppressedException
+
 require "action_view"
 require "action_pack"
 require "bootstrap_form/action_view_extensions/form_helper"

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: bootstrap_form
 version: !ruby/object:Gem::Version
-  version: 5.3.2
+  version: 5.4.0
 platform: ruby
 authors:
 - Stephen Potenza
 - Carlos Lopes
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-09-15 00:00:00.000000000 Z
+date: 2023-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -68,9 +68,11 @@ files:
 - UPGRADE-5.0.md
 - app/assets/stylesheets/rails_bootstrap_forms.css
 - bootstrap_form.gemspec
+- docker-compose-system-test.yml
 - docker-compose.yml
 - gemfiles/6.1.gemfile
 - gemfiles/7.0.gemfile
+- gemfiles/7.1.gemfile
 - gemfiles/common.gemfile
 - gemfiles/edge.gemfile
 - lib/bootstrap_form.rb
@@ -128,7 +130,7 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -143,8 +145,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key:
+rubygems_version: 3.4.1
+signing_key: 
 specification_version: 4
 summary: Rails form builder that makes it easy to style forms using Bootstrap 5
 test_files: []