bullet_train 1.30.1 → 1.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9f6244b94a762526cb882b252268da769b8a57128a9c14146e8f59f02b4458b
-  data.tar.gz: 77aaadf410ce7bdc6fe99f84e3683e537b0c7699e57186f0f0729d23e42b1978
+  metadata.gz: a7631610acdb95b0ad1120d15ac17d0194a53c70848cda583712dc36366364ea
+  data.tar.gz: c8fc83f427e8c53ca328585a7ca20ad63a5aed2680b493196d27bcda72800074
 SHA512:
-  metadata.gz: b28b0737f177702aea10af4e93180458d5ae7b7b731d5f7925042287ee376872b99b0a9816457d52c0eecd7e8e99d4fae962466104c004db30c92c49517f9eab
-  data.tar.gz: 609d5613617adb5819c61c2fe076126f1cff5a53074e254de6a622dcde0133c6ea1248ec3c0284acfa9e515fadcf4f05478058336066b8eab461e8487c4680da
+  metadata.gz: 9ad2b1f45b90d6c30287f54cad955ee76a712f25a617a43391c7e092f20a09464c9577ee637a8e5875457a7d92492828e3fecf0044fc016aa0237724ac7cbd6c
+  data.tar.gz: 8cfc6f818ab40c612d7c5b4e5828c3df9628d70050be6e7493acd7c3656e490870cac2577f17e66d96f591e0430a37bbfc19ba57401b03b183a443a8c2fd1cc3

data/app/controllers/concerns/documentation_support.rb

@@ -1,15 +1,11 @@
 module DocumentationSupport
   extend ActiveSupport::Concern
 
-  BULLET_TRAIN_BASE_PATH = `bundle show bullet_train`.chomp
+  BULLET_TRAIN_BASE_PATH = Gem::Specification.find_by_name("bullet_train").gem_dir
 
   def docs
     target = params[:page].presence || "index"
 
-    # TODO For some reason this didn't work on Heroku.
-    # all_paths = ([Rails.root.to_s] + `bundle show --paths`.lines.map(&:chomp))
-    # @path = all_paths.map { |path| path + "/docs/#{target}.md" }.detect { |path| File.exist?(path) }
-
     @path = "#{BULLET_TRAIN_BASE_PATH}/docs/#{target}.md"
 
     render :docs, layout: "docs"

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

@@ -4,6 +4,7 @@ module Users::Base
   included do
     extend Devise::Models
     attr_accessor :profile_photo_removal
+    attr_accessor :color_scheme_preference # not stored, per-device
 
     if two_factor_authentication_enabled?
       devise :two_factor_authenticatable, :two_factor_backupable

data/app/views/account/users/_color_form.html.erb

@@ -0,0 +1,9 @@
+<%= form_for [:account, @user], html: {id: dom_id(@user, :details), class: 'form'} do |form| %>
+  <% with_field_settings form: form do %>
+    <div class="sm:col-span-2"
+         data-controller="fields--color-scheme-preference"
+         data-action="color-scheme:changed@window->fields--color-scheme-preference#updateRadioButtons input->fields--color-scheme-preference#updateColorSchemePreference">
+         <%= render 'shared/fields/buttons', method: :color_scheme_preference %>
+    </div>
+  <% end %>
+<% end %>

data/app/views/account/users/edit.html.erb

@@ -12,6 +12,13 @@
           <% box.body.render "account/users/form", user: @user %>
         <% end %>
 
+        <% unless BulletTrain::Themes::Light.force_color_scheme_to.presence %>
+          <%= render 'account/shared/box', divider: true do |box| %>
+            <% box.t title: '.preferences.header', description: '.preferences.description' %>
+            <% box.body.render "account/users/color_form", user: @user %>
+          <% end %>
+        <% end %>
+
         <% if two_factor_authentication_enabled? %>
           <div id="two-factor">
             <%= render partial: "devise/registrations/two_factor" %>

data/config/locales/en/users.en.yml

@@ -11,6 +11,9 @@ en:
       profile:
         header: Update Your Profile
         description: You can update the way your name is displayed and your time zone.
+      preferences:
+        header: Update Your Preferences
+        description: You can update the way this app looks on your current device.
       email_and_password:
         header: Update Your Email Address & Password
         description: When you change these credentials we'll email you a confirmation.
@@ -101,6 +104,17 @@ en:
         api_title: *locale
         api_description: *locale
         help: By default the interface language will adjust based on each team's language setting, but you can set a global personal preference for your account here.
+      color_scheme_preference:
+        _: &color_scheme_preference Appearance
+        label: *color_scheme_preference
+        heading: *color_scheme_preference
+        api_title: *color_scheme_preference
+        api_description: *color_scheme_preference
+        options:
+          light: Always Light
+          dark: Always Dark
+          system: Same as System
+        help: This only changes the appearance of this device.
       # 🚅 super scaffolding will insert new fields above this line.
       created_at:
         _: &created_at Signed Up At

data/docs/field-partials.md

@@ -198,6 +198,10 @@ These concepts are currently used by the `address_field` to dynamically update t
 
 [Read more about Dynamic Forms and Dependent Fields](/docs/field-partials/dynamic-forms-dependent-fields.md)
 
+## Color Scheme Awareness in Custom Fields
+
+If you're creating custom field partials that need to respond to light/dark mode changes (e.g., for initializing third-party libraries with theme support), see [Responding to Color Scheme Changes](/docs/javascript.md#responding-to-color-scheme-changes) in the JavaScript documentation. The `code_editor` field partial provides a working example of this pattern.
+
 ## Additional Field Partials Documentation
  - [`address_field`](/docs/field-partials/address-field.md)
  - [`buttons`](/docs/field-partials/buttons.md)

data/docs/javascript.md

@@ -79,3 +79,52 @@ If you experience slow Turbo interactions, check for script tags in the body of
 <script src="third-party-tracker.js" defer></script>
 </head>
 ```
+
+## Responding to Color Scheme Changes
+
+Bullet Train's theme system includes a color scheme preference system that manages light/dark mode switching. When the color scheme changes (either through user preference or system settings), a `color-scheme:changed` event is dispatched on the window.
+
+### Accessing the Current Color Scheme
+
+The color scheme preference is available globally via `window.colorScheme`:
+
+```javascript
+// Get the current color scheme ('light' or 'dark')
+const current = window.colorScheme.current
+
+// Check if dark mode is active
+const isDark = window.colorScheme.current === 'dark'
+
+// Get the user's preference ('light', 'dark', or 'system')
+const preference = window.colorScheme.preference
+```
+
+If you want your custom theme to be always light, or always dark, set the following property in your project's `config/initializers/theme.rb` file:
+
+```rb
+# Force the color scheme to :light or :dark.
+# Defaults to nil, which offers users the ability to choose their preference in Account Details.
+BulletTrain::Themes::Light.force_color_scheme_to = :light
+```
+
+### Listening for Color Scheme Changes
+
+To respond to color scheme changes in your Stimulus controllers, listen for the `color-scheme:changed` event on the window:
+
+```erb
+<div data-controller="my-custom-controller"
+     data-action="color-scheme:changed@window->my-custom-controller#updateComponentTheme">
+  <!-- Your content -->
+</div>
+```
+
+In your Stimulus controller:
+
+```javascript
+export default class extends Controller {
+  updateComponentTheme() {
+    const isDark = window.colorScheme.current === 'dark'
+    // Apply dark or light theme to your component
+  }
+}
+```

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

@@ -306,4 +306,4 @@ See [`account/users_helper` in BT core repo](https://github.com/bullet-train-co/
 
 ### For ejecting a theme partial and modifying it
 
-We recommend firing up a Bullet Train project and using its `bin/resolve` (see docs on [Indirection](indirection)) to get a copy of the partial field locally to modify.
+We recommend firing up a Bullet Train project and using its `bin/resolve` (see docs on [Indirection](/docs/indirection)) to get a copy of the partial field locally to modify.

data/docs/themes.md

@@ -132,6 +132,12 @@ This allows the theme engine to resolve which theme in the inheritance chain wil
 
 You're going to have to call your theme something and there are practical reasons to not call it something generic. If you're pursuing a heavily customized design, consider allowing the designer or designers who are creating the look-and-feel of your application to name their own masterpiece. Giving it a distinct name will really help differentiate things when you're ready to start introducing additional facets to your application or a totally new look-and-feel down the road.
 
+## Dark and Light Mode
+
+Bullet Train themes include support for both dark and light color schemes. Users can toggle between dark mode, light mode, or system preference in their Account Details (accessible from the user menu). This preference is per-device and stored in the browser's `LocalStorage`.
+
+If you're building custom components that need to respond to color scheme changes, see [Responding to Color Scheme Changes](/docs/javascript.md#responding-to-color-scheme-changes) in the JavaScript documentation.
+
 ## Additional Themes Documentation
 
 * [Installing Bullet Train Themes on Other Rails Projects](/docs/themes/on-other-rails-projects.md)

data/lib/bullet_train/resolver.rb

@@ -65,7 +65,7 @@ module BulletTrain
 
               # Look for showcase preview.
               file_name = source_file[:absolute_path].split("/").last
-              showcase_partials = Dir.glob(`bundle show bullet_train-themes-light`.chomp + "/app/views/showcase/**/*.html.erb")
+              showcase_partials = Dir.glob(Gem::Specification.find_by_name("bullet_train-themes-light").gem_dir + "/app/views/showcase/**/*.html.erb")
               showcase_preview = showcase_partials.find { |partial| partial.split("/").last == file_name }
               if showcase_preview
                 puts "Ejecting showcase preview for #{source_file[:relative_path]}"
@@ -191,11 +191,11 @@ module BulletTrain
           # If it's a full path, we need to make sure we're getting it from the right package.
           _, partial_view_package, partial_path_without_package = @needle.partition(/(bullet_train-core\/)?bullet_train[a-z|\-._0-9]*/)
 
-          # Pop off `bullet_train-core` and the gem's version so we can call `bundle show` correctly.
+          # Pop off `bullet_train-core` and the gem's version so we can call `Gem::Specification.find_by_name` correctly.
           partial_view_package.gsub!("bullet_train-core/", "")
           partial_view_package.gsub!(/[-|.0-9]*$/, "") if partial_view_package.match?(/[-|.0-9]*$/)
 
-          local_package_path = `bundle show #{partial_view_package}`.chomp
+          local_package_path = Gem::Specification.find_by_name(partial_view_package).gem_dir
           return local_package_path + partial_path_without_package
         else
           puts "You passed the absolute path for a partial literal, but we couldn't find the package name in the string:".red
@@ -223,7 +223,7 @@ module BulletTrain
         # If the developer enters a partial that is in bullet_train-base like devise/shared/oauth or devise/shared/links,
         # it will return a string starting with app/ so we simply point them to the file in this repository.
         if annotated_path.match?(/^<!-- BEGIN app/) && !ejected_theme?
-          gem_path = `bundle show bullet_train`.chomp
+          gem_path = Gem::Specification.find_by_name("bullet_train").gem_dir
           "#{gem_path}/#{$1}"
         else
           $1
@@ -283,7 +283,7 @@ module BulletTrain
         absolute_file_path
       else
         # Search for the file in its respective gem. Fall back to the `light` theme if no gem is available.
-        gem_path = [`bundle show bullet_train-themes-#{current_theme}`, `bundle show bullet_train-themes-light`].map(&:chomp).find(&:present?)
+        gem_path = [Gem::Specification.find_by_name("bullet_train-themes-#{current_theme}").gem_dir, Gem::Specification.find_by_name("bullet_train-themes-light").gem_dir].map(&:chomp).find(&:present?)
         return nil unless gem_path
 
         # At this point we can be more generic since we're inside the gem.

data/lib/bullet_train/version.rb

@@ -1,3 +1,3 @@
 module BulletTrain
-  VERSION = "1.30.1"
+  VERSION = "1.31.0"
 end

data/lib/tasks/bullet_train_tasks.rake

@@ -55,7 +55,7 @@ namespace :bullet_train do
       gem_names = I18n.t("framework_packages").map { |key, value| key.to_s }
       gem_names.each do |gem|
         puts "Searching for locales in #{gem}...".blue
-        gem_path = `bundle show #{gem}`.chomp
+        gem_path = Gem::Specification.find_by_name(gem).gem_dir
         gem_with_version = gem_path.split("/").last
         locales = Dir.glob("#{gem_path}/**/config/locales/**/*.yml").reject { |path| path.match?("dummy") }
         next if locales.empty?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bullet_train
 version: !ruby/object:Gem::Version
-  version: 1.30.1
+  version: 1.31.0
 platform: ruby
 authors:
 - Andrew Culver
@@ -500,6 +500,7 @@ files:
 - app/views/account/two_factors/destroy.html.erb
 - app/views/account/two_factors/verify.html.erb
 - app/views/account/users/_breadcrumbs.html.erb
+- app/views/account/users/_color_form.html.erb
 - app/views/account/users/_fields.html.erb
 - app/views/account/users/_form.html.erb
 - app/views/account/users/_oauth.html.erb