bullet_train 1.32.0 → 1.34.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98e09fbe309f588d3d549b3b5b802490b3630fd95005f2466d860316c38ce112
-  data.tar.gz: 9cd579e00d8f4c5e8c93944590bda85ddf8511f11501bb71d5a42ad1a3024e24
+  metadata.gz: f74254bfbcc983a2ed2fbdab69dbaa872dc49a86f5a73e7b8b43e7878f2e1ae4
+  data.tar.gz: b5bbc3302df6e353bd86535087317b562bbba274e943fed5b9edf0e47cb3a62e
 SHA512:
-  metadata.gz: 70187dc9eb184db7fa8b7291297558fec0ce3411974a534fe008e7a3ab1d65af69b6c1f2569bbb77a64736ccaf79ac7cddf184d1d9833176f1e9595a33a32bb7
-  data.tar.gz: 06f616f253c27690dc07f24c9a7f5f39f0bdf7a435280c1bda3f48a6d363624642d038d08ef8f088d83c66f31399bffc1d05a1b1344bb68d4243867b03f200d5
+  metadata.gz: 544b025b243fc8f09b4e710258481715e6276e98a061f6256687aa90777ff88b15e9da2b17b29f485c49be5c78016797c7022ae9494f3503b313fa670f0b7666
+  data.tar.gz: 14c932887fdaf6c184da191f638be7b46f48cc18fd897f700a5b4c8646c804d21ad8ef4952af0c59e81349361777f8d384f1c1c7deeaaeb33d82d548b90e50d0

data/app/javascript/controllers/clipboard_controller.js

@@ -9,7 +9,7 @@ export default class extends Controller {
     document.execCommand('copy')
     this.buttonTarget.innerHTML = '<i id="copied" class="fas fa-check w-4 h-4 block text-green-600"></i>'
     setTimeout(function () {
-      document.getElementById('copied').innerHTML = '<i class="far fa-copy w-4 h-4 block text-slate-600"></i>'
+      document.getElementById('copied').innerHTML = '<i class="far fa-copy w-4 h-4 block text-base-600"></i>'
     }, 1500)
   }
 }

data/app/views/account/invitations/_form.html.erb

@@ -23,10 +23,10 @@
           <% Membership.assignable_roles.each do |role| %>
             <% if current_membership.can_manage_role?(role) %>
               <div class="flex items-top">
-                <%= fields.check_box :role_ids, {multiple: true, class: "h-4 w-4 text-primary-500 focus:ring-primary-500 border-slate-300 rounded mt-0.5"}, role.id, nil %>
+                <%= fields.check_box :role_ids, {multiple: true, class: "h-4 w-4 text-primary-500 focus:ring-primary-500 border-base-300 rounded mt-0.5"}, role.id, nil %>
                 <label for="invitation_membership_attributes_role_ids_<%= role.id %>" class="ml-2 block select-none">
                   <span><%= t('invitations.form.invite_as', role_key: t("memberships.fields.role_ids.options.#{role.key}.label")) %></span>
-                  <div class="mt-0.5 text-slate-400 font-light leading-normal">
+                  <div class="mt-0.5 text-base-400 font-light leading-normal">
                     <%= t("memberships.fields.role_ids.options.#{role.key}.description") %>
                   </div>
                 </label>

data/app/views/account/memberships/_form.html.erb

@@ -26,10 +26,10 @@
     <% Membership.assignable_roles.each do |role| %>
       <% if role.manageable_by?(current_membership.roles) %>
         <div class="flex items-top">
-          <%= form.check_box :role_ids, {multiple: true, class: "h-4 w-4 text-primary-500 focus:ring-primary-500 border-slate-300 rounded mt-0.5"}, role.id, nil %>
+          <%= form.check_box :role_ids, {multiple: true, class: "h-4 w-4 text-primary-500 focus:ring-primary-500 border-base-300 rounded mt-0.5"}, role.id, nil %>
           <label for="membership_role_ids_<%= role.id %>" class="ml-2 block select-none">
             <%= t('.grant_privileges_of', role_key: t(".fields.role_ids.options.#{role.key}.label")) %>
-            <div class="mt-0.5 text-slate-400 font-light leading-normal">
+            <div class="mt-0.5 text-base-400 font-light leading-normal">
               <%= t(".fields.role_ids.options.#{role.key}.description") %>
             </div>
           </label>

data/app/views/account/memberships/_membership.html.erb

@@ -1,7 +1,7 @@
 <tr data-id="<%= membership.id %>">
   <td class="px-6 py-4 whitespace-nowrap">
     <%= link_to [:account, membership], class: 'block flex items-center group hover:no-underline no-underline' do %>
-      <div class="flex-shrink-0 h-10 w-10">
+      <div class="shrink-0 h-10 w-10">
         <%= image_tag membership_profile_photo_url(membership), title: membership.label_string, class: 'h-10 w-10 rounded-full' %>
       </div>
 

data/app/views/account/memberships/_tombstones.html.erb

@@ -24,7 +24,7 @@
 
               <td class="px-6 py-4 whitespace-nowrap">
                 <%= link_to [:account, membership], class: 'block flex items-center group hover:no-underline no-underline' do %>
-                  <div class="flex-shrink-0 h-10 w-10">
+                  <div class="shrink-0 h-10 w-10">
                     <%= image_tag membership_profile_photo_url(membership), title: membership.label_string, class: 'h-10 w-10 rounded-full' %>
                   </div>
 

data/app/views/layouts/docs.html.erb

@@ -34,7 +34,7 @@
 
     <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@docsearch/css@3"/>
   </head>
-  <body class="<%= BulletTrain::Themes::Light.background || "bg-gradient-to-br from-secondary-200 to-primary-400 dark:from-primary-900 dark:to-primary-600" %> text-slate-700 text-sm font-normal dark:text-slate-300">
+  <body class="<%= BulletTrain::Themes::Light.background || "bg-gradient-to-br from-secondary-200 to-primary-400 dark:from-primary-900 dark:to-primary-600" %> text-base-700 text-sm font-normal dark:text-base-300">
     <div class="md:p-5">
       <div class="min-h-screen md:h-auto overflow-hidden md:rounded-lg flex shadow"
         data-controller="mobile-menu"
@@ -42,7 +42,7 @@
       >
 
         <% menu = capture do %>
-          <div class="flex items-center flex-shrink-0 p-4 bg-blue-700 md:rounded-tl-lg">
+          <div class="flex items-center shrink-0 p-4 bg-blue-700 md:rounded-tl-lg">
             <%= image_tag image_path("logo/logo.png"), class: 'h-5 w-auto mx-auto' %>
 
             <div class="lg:hidden absolute right-0">
@@ -171,6 +171,12 @@
                     <i class="fal fa-brackets-curly ti ti-view-list-alt"></i>
                   <% end %>
                 <% end %>
+
+                <%= render 'account/shared/menu/item', url: '/docs/contributing.md', label: 'Contributing' do |p| %>
+                  <% p.content_for :icon do %>
+                    <i class="fal fa-github-alt ti ti-github"></i>
+                  <% end %>
+                <% end %>
               <% end %>
 
               <%= render 'account/shared/menu/section', title: 'Accounts & Teams' do %>
@@ -353,20 +359,20 @@
             >
               <%= menu %>
             </div>
-            <div class="flex-shrink-0 w-14" aria-hidden="true"></div>
+            <div class="shrink-0 w-14" aria-hidden="true"></div>
           </div>
         </div>
 
-        <div class="hidden lg:flex lg:flex-shrink-0 overflow-y-auto bg-gradient-to-b from-primary-700 to-primary-800 dark:from-slate-800 dark:to-slate-800">
+        <div class="hidden lg:flex lg:shrink-0 overflow-y-auto bg-gradient-to-b from-primary-700 to-primary-800 dark:from-base-800 dark:to-base-800">
           <div class="w-64">
             <%= menu %>
           </div>
         </div>
 
-        <div class="flex flex-col w-0 flex-1 overflow-y-auto bg-slate-100 dark:bg-slate-800 lg:border-l dark:border-slate-500">
+        <div class="flex flex-col w-0 flex-1 overflow-y-auto bg-base-100 dark:bg-base-800 lg:border-l dark:border-base-500">
           <main class="flex-1 relative z-0 overflow-y-auto focus:outline-none" tabindex="0">
 
-            <button class="lg:hidden h-12 w-12 ml-1 flex-none inline-flex items-center justify-center rounded-md text-slate-500 hover:text-slate-900 focus:outline-none focus:ring-2 focus:ring-inset focus:ring-blue"
+            <button class="lg:hidden h-12 w-12 ml-1 flex-none inline-flex items-center justify-center rounded-md text-base-500 hover:text-base-900 focus:outline-none focus:ring-2 focus:ring-inset focus:ring-blue"
               data-action="mobile-menu#open"
             >
               <span class="sr-only">Open Application Menu</span>

data/app/views/layouts/public.html.erb

@@ -4,7 +4,7 @@
     <%= render 'shared/layouts/head' %>
   </head>
 
-  <body class="min-h-screen <%= BulletTrain::Themes::Light.background %> text-slate-700 text-sm font-normal dark:text-slate-300">
+  <body class="min-h-screen <%= BulletTrain::Themes::Light.background %> text-base-700 text-sm font-normal dark:text-base-300">
     <%= yield %>
   </body>
 </html>

data/config/locales/en/base.yml

@@ -69,6 +69,7 @@ en:
     notifications:
       not_found: not found
       all_fields_required: All of these fields are required.
+      validation_error: Please correct the errors below.
     dates:
       today: Today
       day:

data/docs/contributing.md

@@ -0,0 +1,94 @@
+# Contributing to Bullet Train
+
+To contribute to Bullet Train there are two main repos that are involved:
+
+* [The starter repo](https://github.com/bullet-train-co/bullet_train) - This is the repo that you clone to start a new Bullet Train app.
+* [The `core` repo](https://github.com/bullet-train-co/bullet_train-core) - This is where all (OK, most) of the gems live.
+
+## Linking Ruby gems
+
+When working on bug fixes or new features it can be useful to use a local copy of the `core` gems instead of the published versions.
+You can do this in either the starter repo itself, or in a "downstream app" that has been created from the starter repo.
+
+We have a convenience script in the starter repo at `bin/hack` which helps get things setup for you.
+
+`bin/hack` supports two different models of organizing your filesystem for `core` development.
+
+1.  The "nested repo approach" - If you run `bin/hack` with no arguments it will clone the `core` repo into your project at `local/bullet_train-core`.
+    It will also attempt to open that repo in your editor/IDE.
+2.  The "peer repo approach" - If you already have the `core` repo cloned you can pass the `--link` option to `bin/hack` followed by a path to `core`.
+    For instance `bin/hack --link ../bullet_train-core`.
+
+In either case `bin/hack` will modify the `Gemfile` in your project and change the lines for all of the `bullet_train*` gems to point to a local copy.
+
+Lines that start like this:
+
+```ruby
+gem "bullet_train", BULLET_TRAIN_VERSION
+```
+
+Will become this:
+
+```ruby
+gem "bullet_train", path: "../bullet_train-core/bullet_train"
+```
+
+Once that's done you can start/restart your dev server and then chnages you make within your `core` repo will be reflected in your local app.
+
+## Linking Javascript packages
+
+If you need to make changes to any of the Javascript packages from the `core` gems the process is a little bit different.
+
+We use `yalc` to handle the details of making a local package available to your local app.
+
+First you need to go into the directory for the gem/package that you're working with, then build the JS package, and make it available to local projects using `yalc push`.
+(Don't worry, you're not pushing to anywhere other than your local dev environment.)
+
+So, if you're working with the `bullet_train-fields` JS package you'd do this:
+
+```
+cd bullet_train-core/bullet_train-fields
+yarn build
+yarn yalc push
+```
+
+After pushing you should see a line in your terminal that looks something like this:
+
+```
+@bullet-train/fields@1.32.0 published in store.
+```
+
+Next you can link that package into your local app or starter repo. (You'll be bouncing between the gem directory and your app directory, so it's convenient to use two different terminal sessions for this.)
+Go into your app or starter repo directory and then use `yalc link` to connect your local package.
+
+```
+cd bullet_train
+yarn yalc link @bullet-train/fields
+```
+
+Now your local app will be running with the JS code from your local copy.
+
+As you're making changes you can test them out in your local app by building and pushing the package again.
+
+So, for this example, back in the `bullet_train-core/bullet_train-fields` directory you can run:
+
+```
+yarn build; yarn yalc push
+```
+
+Now in addition to seeing a line about the package being published to the store, you should also seem some lines about it being pushed into your local app.
+
+```
+@bullet-train/fields@1.32.0 published in store.
+Pushing @bullet-train/fields@1.32.0 in /Users/jgreen/projects/bullet-train-co/bullet_train
+Package @bullet-train/fields@1.32.0 linked ==> /Users/jgreen/projects/bullet-train-co/bullet_train/node_modules/@bullet-train/fields
+```
+
+Each time that you rebuild and re-push the package the file watcher in your project (or starter repo) should notice the change and rebuild your assets.
+
+## Managing cross-repo pull requests
+
+Sometimes a particular change will require modifications to both the starter repo and the `core` repo. In these cases you should use the same branch
+name in both repos. That will allow CI to hook them together and run tests in the right way.
+
+Happy hacking!

data/docs/field-partials.md

@@ -181,12 +181,26 @@ rails generate model Project team:references multiple_buttons:jsonb
 ## Formating `date` and `date_and_time`
 After Super Scaffolding a `date` or `date_and_time` field, you can pass a format for the object like so:
 
-```
+```erb
 <%= render 'shared/attributes/date', attribute: date_object, format: :short %>
 ```
 
 Please refer to the [Ruby on Rails documentation](https://guides.rubyonrails.org/i18n.html#adding-date-time-formats) for more information.
 
+## Setting a `language` for `code_editor` fields
+
+When rendering the `code_editor` attribute you can pass in a language to affect syntax highlighting and what not.
+
+```erb
+<%= render 'shared/fields/code_editor', method: :source, language: "ruby" %>
+```
+
+During Super Scaffolding you can pass in the language when declaring the attribute and it will be added to your form:
+
+````
+rails generate super_scaffold:field Project source:code_editor{language=ruby}
+````
+
 ## Dynamic Forms and Dependent Fields
 
 To dynamically update your forms on field changes, Bullet Train introduces two new concepts:

data/docs/index.md

@@ -24,6 +24,8 @@
  - [Test Suite](/docs/testing.md)
  - [Magic Test: Point-and-Click Test Writing](https://github.com/bullet-train-co/magic_test) <i class="ti ti-new-window ml-2"></i>
  - [Application Options](/docs/application-options.md)
+ - [Application Hash](/docs/application-hash.md)
+ - [Contributing to Bullet Train](/docs/contributing.md)
 
 ## Accounts & Teams
  - [Authentication](/docs/authentication.md)

data/docs/themes.md

@@ -1,5 +1,59 @@
 # Themes
 
+## Changing your color scheme
+
+The first thing you may want to do is to change the color scheme for your app. The place to do that is in `config/initializers/theme.rb`.
+
+There you can set a primary `color` value, as well as a `secondary_color` if you want to add some variation.
+If you don't set a `secondary_color` it will be set the same as the primary `color`.
+
+```ruby
+# The application's main color scheme.
+BulletTrain::Themes::Light.color = :green
+BulletTrain::Themes::Light.secondary_color = :red
+```
+
+Any of the [default color schemes provided by Tailwind CSS](https://v3.tailwindcss.com/docs/customizing-colors#default-color-palette) should work for the primary and secondary colors.
+
+### 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`.
+
+You can force your app to either light or dark mode by setting the `force_color_scheme_to` option in `theme.rb`.
+
+```ruby
+# 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
+```
+
+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.
+
+### Changing the background color
+
+<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: This section is likely to change soon. The following only applies to apps that are upgraded to Bullet Train `1.33.0` or later.
+  </h3>
+</div>
+
+Starting in Bullet Train version `1.33.0` we've added a way to change the `base` color, which affects the background color of many elements.
+
+To customize this you can add a block like this to `tailwind.config.js`:
+
+```javascript
+themeConfig.theme.extend.colors = ({colors}) => ({
+  base: colors.stone,
+  primary: colors.blue,
+  secondary: colors.blue,
+})
+```
+
+Here you need to include `primary` and `secondary` as well as `base`. The settings in `tailwind.config.js` will **mostly** clobber the settings
+in `theme.rb`, but not entirely. So for the best results you should make sure that those two files agree about the primary and secondary colors.
+
+## The Theme Subsystem
+
 Bullet Train has a theme subsystem designed to allow you the flexibility to either extend or completely replace the stock “Light” UI theme.
 To reduce duplication of code across themes, Bullet Train implements the following three packages:
 1. `bullet_train-themes`
@@ -132,12 +186,6 @@ 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/version.rb

@@ -1,3 +1,3 @@
 module BulletTrain
-  VERSION = "1.32.0"
+  VERSION = "1.34.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bullet_train
 version: !ruby/object:Gem::Version
-  version: 1.32.0
+  version: 1.34.0
 platform: ruby
 authors:
 - Andrew Culver
@@ -597,6 +597,7 @@ files:
 - docs/authentication.md
 - docs/billing/stripe.md
 - docs/billing/usage.md
+- docs/contributing.md
 - docs/desktop.md
 - docs/docker.md
 - docs/field-partials.md