bullet_train 1.6.37 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c92b0540ab3f8b4d802153c04206d3c336576736a7b0ee0ad8389a56e846f7ba
-  data.tar.gz: 0c7efe34eb03bfc7444289c19ee91e9c4bf58ce8edc055fcbed9fc9c6a6bb281
+  metadata.gz: 14aab23772dad18189bc7ab18b5783c1a60e3de377241afded6bf91227096e22
+  data.tar.gz: 25dbcfe76b7f90ff2faaa31012b1c7c0b928d52718c6df4d1e6259cf9a10afc4
 SHA512:
-  metadata.gz: b1de6904f14df8d8b82fb0fbd35cdee546761dd883399558afebd192acf1e2321ad471b84768c4f9f983892de391589977fa1d6ed85c2ec5f6f272d34c06629c
-  data.tar.gz: f41788425410870ece98bd34d0d1df829f2c979edd717696357209f1dcf4e2a7a4b1e3e923bd8a1667390f82f1cfcede5e34ff89ae51f9892bd91842656924b2
+  metadata.gz: 014e04acc10bb9189420961de989644cd63918a09cc05f4937bad6f6b5a51691b86fd1e67770a603f26f58602d7776754eb7e74743e67ecdf519dbfc243a2d31
+  data.tar.gz: 05e6237879b28eca4dd01c3d1269b073d2cee3ed7204cf296950b815186d8a0248342936b10d3376167b4ff87d9d75862eaff5ea98c84319045cf1ba5a4ec0e7

data/app/controllers/concerns/account/users/controller_base.rb

@@ -31,7 +31,7 @@ module Account::Users::ControllerBase
   # TODO: We're keeping this method for backward compatibility in case someone in a downstream app
   # might be using it. At some point in the future (unclear exactly when) we should remove it.
   def updating_password?
-    ActiveSupport::Deprecation.warn(
+    ActiveSupport::Deprecation.new.warn(
       "#updating_password? is deprecated. " \
       "Use #updating_password_or_email? instead."
     )

data/app/helpers/account/users_helper.rb

@@ -81,7 +81,7 @@ module Account::UsersHelper
     end
 
     if cloudinary_enabled?
-      resource.send("#{photo_method}_id".to_sym)
+      resource.send(:"#{photo_method}_id")
     elsif resource.send(photo_method).attached?
       url_for(resource.send(photo_method))
     end

data/app/models/concerns/records/base.rb

@@ -52,7 +52,7 @@ module Records::Base
   # identify them.
   def label_string
     if (label_attribute = self.class.label_attribute)
-      send("#{label_attribute}_was")
+      send(:"#{label_attribute}_was")
     else
       self.class.name.underscore.split("/").last.titleize
     end

data/docs/field-partials/buttons.md

@@ -38,7 +38,7 @@ You can allow multiple buttons to be selected using the `multiple` option, like
 
 ```erb
 <%= render 'shared/fields/buttons', form: form, method: :category_ids,
-  options: Category.all.map { |category| [category.id, category.label_string] }, multiple: true %>
+  options: Category.all.map { |category| [category.id, category.label_string] }, options: {multiple: true} %>
 ```
 
 ## Dynamically Updating Form Fields
@@ -48,4 +48,4 @@ If you'd like to:
 * modify other fields based on the value of your `buttons` field, or
 * modify your `buttons` field based on the value of other fields
 
-See [Dynamic Forms and Dependent Fields](/docs/field-partials/dynamic-forms-dependent-fields.md).
+See [Dynamic Forms and Dependent Fields](/docs/field-partials/dynamic-forms-dependent-fields.md).

data/docs/field-partials/options.md

@@ -0,0 +1,54 @@
+# Field Partial Options
+Most field partials have a native Rails form helper working underneath. To see what options you can pass to a partial, check the API for the form helper you want to edit.
+
+In addition, Bullet Train provides framework-specific options which you can pass as `other_options` to further customize your fields.
+
+## General `other_options` Types
+Some partials have specific types of `other_options` available for only that partial. However, the following `other_options` are available for all field partials, and you can pass them to a field partial like this.
+
+```erb
+<%= render 'shared/fields/text_field' method: :attribute_name, other_options: {help: "Custom help text"} %>
+```
+
+| Key | Description |
+|-----|-------------|
+| `:help` | Pass a String to display help text |
+| `:error` | Pass a String to write a custom error and outline the field in red |
+| `:required` | Pass a Boolean to make this field required or not |
+| `:label` | Pass a String to display a custom label |
+| `:hide_label` | Pass a Boolean to hide the label |
+| `:hide_custom_error` | Highlight the erroneous field in red, but hide the error message set in `:error` |
+| `:icon` | Add a custom icon as an HTML class (i.e. - `ti ti-tablet`)|
+
+## `other_options` for Specific Field Partials
+| Partial Name | Option            | Description
+|--------------|-------------------|-----------------| 
+| `password_field` | `:show_strength_indicator`* | Shows how strong the password is via a Stimulus controller with the colors red, yellow, and green. |
+| `super_select` | Refer to the [super_select documentation](/docs/field-partials/super-select.md) | Super Select fields have different kinds of options which are covered in another page. |
+
+
+*Currently, you must pass `:show_strength_indicator` to `options`, not `other_options`. This will change in a later version.
+
+## Field Partial Form Helpers
+
+Most of the field partials have a native Rails form helper working underneath. Please use `bin/resolve` if you want to look at the source code for the partial (i.e. - `bin/resolve shared/fields/text_field`).
+
+| Partial Name | Rails Form Helper |
+|--------------|-------------------|
+| `address_field` | [select](https://api.rubyonrails.org/classes/ActionView/Helpers/FormBuilder.html#method-i-select) |
+| `boolean` | [radio_button](https://api.rubyonrails.org/classes/ActionView/Helpers/FormBuilder.html#method-i-radio_button) |
+| `buttons` | [radio_button](https://api.rubyonrails.org/classes/ActionView/Helpers/FormBuilder.html#method-i-radio_button) ([check_box](https://api.rubyonrails.org/classes/ActionView/Helpers/FormBuilder.html#method-i-check_box) when `options[:multiple]` is `true`) |
+| `image` | [file_field](https://api.rubyonrails.org/classes/ActionView/Helpers/FormHelper.html#method-i-file_field) when using ActiveStorage (No Rails form helper is called when using Cloudinary) |
+| `color_picker` | [hidden_field](https://api.rubyonrails.org/classes/ActionView/Helpers/FormHelper.html#method-i-hidden_field) (Currently cannot edit this field) |
+| `date_and_time_field` | [text_field](https://api.rubyonrails.org/classes/ActionView/Helpers/FormHelper.html#method-i-text_field) |
+| `date_field` | [text_field](https://api.rubyonrails.org/classes/ActionView/Helpers/FormHelper.html#method-i-text_field) |
+| `email_field` | [email_field](https://api.rubyonrails.org/classes/ActionView/Helpers/FormHelper.html#method-i-email_field) |
+| `emoji_field` | [hidden_field](https://api.rubyonrails.org/classes/ActionView/Helpers/FormHelper.html#method-i-hidden_field) (Currently cannot edit this field) |
+| `options` | [radio_button](https://api.rubyonrails.org/classes/ActionView/Helpers/FormBuilder.html#method-i-radio_button) ([check_box](https://api.rubyonrails.org/classes/ActionView/Helpers/FormBuilder.html#method-i-check_box) when `options[:multiple]` is `true`) |
+| `password_field` | [password_field](https://api.rubyonrails.org/classes/ActionView/Helpers/FormHelper.html#method-i-password_field) |
+| `phone_field` | [text_field](https://api.rubyonrails.org/classes/ActionView/Helpers/FormHelper.html#method-i-text_field) |
+| `super_select` | [select](https://api.rubyonrails.org/classes/ActionView/Helpers/FormBuilder.html#method-i-select) |
+| `text_area` | [text_area](https://api.rubyonrails.org/classes/ActionView/Helpers/FormHelper.html#method-i-text_area) |
+| `text_field` | [text_field](https://api.rubyonrails.org/classes/ActionView/Helpers/FormHelper.html#method-i-text_field) |
+| `number_field` | [number_field](https://api.rubyonrails.org/classes/ActionView/Helpers/FormHelper.html#method-i-number_field) |
+| `trix_editor` | [rich_text_editor](https://api.rubyonrails.org/classes/ActionView/Helpers/FormHelper.html#method-i-rich_text_area) |

data/docs/field-partials.md

@@ -46,9 +46,21 @@ The 1:1 relationship between these field partials and their underlying Rails for
 
 Individual field partials might have additional options available based on the underlying Rails form field helper. Links to the documentation for individual form field partials are listed at the end of this page.
 
+## `options` vs. `html_options`
+
+Most of the native form helpers use `options` to define html attributes like so:
+
+```ruby
+def text_field(object, method, options = {})
+  ...
+end
+```
+
+However, the `super_select` partial uses `html_options` to define them. This is the same as the native Rails [select form helper](https://api.rubyonrails.org/classes/ActionView/Helpers/FormBuilder.html#method-i-select). Each field partial has its own set of arguments that can be passed to it depending on the underlying form helper, so please refer to the [field partial options](/docs/field-partials/options.md) documentation for more details.
+
 ## `options` vs. `other_options`
 
-Because Bullet Train field partials have more responsibilities than the underlying Rails form field helpers, there are also additional options for things like hiding labels, displaying specific error messages, etc. For these options, we pass them separately as `other_options`. This keeps them separate from the options in `options` that will be passed directly to the underlying Rails form field helper.
+Because Bullet Train field partials have more responsibilities than the underlying Rails form field helpers, there are also additional options for things like hiding labels, displaying specific error messages, and more. For these options, we pass them separately as `other_options`. This keeps them separate from the options in `options` that will be passed directly to the underlying Rails form field helper.
 
 For example, to suppress a label on any field, we can use the `hide_label` option like so:
 
@@ -56,6 +68,8 @@ For example, to suppress a label on any field, we can use the `hide_label` optio
 <%= render 'shared/fields/text_field', form: form, method: :text_field_value, other_options: {hide_label: true} %>
 ```
 
+Please refer to the [field partial options](/docs/field-partials/options.md) documentation for more details.
+
 ### Globally-Available `other_options` Options
 
 | Key | Value Type | Description |

data/docs/themes/on-jumpstart-pro-projects.md

@@ -264,6 +264,16 @@ In `package.json`, replace the `build` and `build:css` entries under `scripts` w
 "build:css": "bin/link; THEME=\"light\" tailwindcss --postcss --minify -c ./tailwind.config.js -i ./app/assets/stylesheets/application.tailwind.css -o ./app/assets/builds/application.tailwind.css",
 ```
 
+### Define `current_theme` helper
+
+In your `app/helpers/application_helper.rb`, define:
+
+```
+def current_theme
+  :light
+end
+```
+
 ### Add `stylesheet_link_tag` to `<head>`
 
 Make sure you have the following three lines in your `<head>`, which should be defined in `app/views/layouts/application.html.erb`:
@@ -418,13 +428,11 @@ Add the following classes to your `html` tag for your layout:
 
 If you'd like to create your own theme but would still like to build on top of `:light`, you'll need to have both gems installed and you'll be able to switch the current theme this way.
 
-Define `current_theme` in `app/helpers/application_helper.rb`
+Change the `current_theme` value in `app/helpers/application_helper.rb`
 
 ```
-module ApplicationHelper
-  def current_theme
-    :light
-  end
+def current_theme
+  :super_custom_theme
 end
 ```
 

data/docs/themes/on-other-rails-projects.md

@@ -94,6 +94,16 @@ Remove or comment out the following line from `esbuild.config.js`:
 "intl-tel-input-utils": path.join(process.cwd(), "app/javascript/intl-tel-input-utils.js"),
 ```
 
+### Define `current_theme` helper
+
+In your `app/helpers/application_helper.rb`, define:
+
+```
+def current_theme
+  :light
+end
+```
+
 ### Add `stylesheet_link_tag` to `<head>`
 
 Make sure you have the following three lines in your `<head>`, which should be defined in `app/views/layouts/application.html.erb`:
@@ -231,13 +241,11 @@ Add the following classes to your `html` tag for your layout:
 
 If you'd like to create your own theme but would still like to build on top of `:light`, you'll need to have both gems installed and you'll be able to switch the current theme this way.
 
-Define `current_theme` in `app/helpers/application_helper.rb`
+Change the `current_theme` value in `app/helpers/application_helper.rb`
 
 ```
-module ApplicationHelper
-  def current_theme
-    :light
-  end
+def current_theme
+  :super_custom_theme
 end
 ```
 

data/docs/upgrades.md

@@ -2,7 +2,7 @@
 
 <div class="rounded-md border bg-amber-100 border-amber-200 py-4 px-5 mb-3 not-prose">
   <h3 class="text-sm text-amber-800 font-light mb-2">
-    Note: These ugrade steps have recently changed.
+    Note: These upgrade steps have recently changed.
   </h3>
   <p class="text-sm text-amber-800 font-light mb-2">
     These instructions assume that you're doing a stepwise upgrade on an app that's already on version <code>1.4.0</code> or later.

data/lib/bullet_train/version.rb

@@ -1,3 +1,3 @@
 module BulletTrain
-  VERSION = "1.6.37"
+  VERSION = "1.7.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bullet_train
 version: !ruby/object:Gem::Version
-  version: 1.6.37
+  version: 1.7.0
 platform: ruby
 authors:
 - Andrew Culver
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-03-11 00:00:00.000000000 Z
+date: 2024-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: standard
@@ -730,6 +730,7 @@ files:
 - docs/field-partials/date-related-fields.md
 - docs/field-partials/dynamic-forms-dependent-fields.md
 - docs/field-partials/file-field.md
+- docs/field-partials/options.md
 - docs/field-partials/super-select.md
 - docs/font-awesome-pro.md
 - docs/getting-started.md