bullet_train 1.2.9 → 1.2.11

data/docs/themes.md

@@ -1,6 +1,6 @@
 # Themes
 
-Bullet Train has a theme subsystem designed to allow you the flexibility to either extend or completely replace the stock “Light” UI template.
+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`
 2. `bullet_train-themes-tailwind_css`
@@ -10,12 +10,16 @@ This is where all of Bullet Train's standard views are contained.
 
 ## Adding a New Theme (ejecting standard views)
 
-If you want to add a new theme, you can use the following command. This will copy all of the standard views from `bullet_train-themes-light` to `app/views/themes/` and configure your application to use the new theme. For example, let's make a new theme called "foo":
-`> rake bullet_train:themes:light:eject[foo]`
+If you want to add a new theme, you can use the following command. For example, let's make a new theme called "foo":
+```
+> rake bullet_train:themes:light:eject[foo]
+```
+
+This will copy all of the standard views from `bullet_train-themes-light` to `app/views/themes/` and configure your application to use the new theme.
 
 After running this command, you will see that a few other files are edited to use this new theme. Whenever switching a theme, you will need to make the same changes to make sure your application is running with the theme of your choice.
 
-You can also pass an annotated path to a view after running `bin/resolve` to eject individual views to your application.
+You can also pass an annotated path to a view after running `bin/resolve --interactive` to eject individual views to your application.
 
 ## Theme Component Usage
 
@@ -25,21 +29,24 @@ To use a theme component, simply include it from "within" `shared` like so:
 <%= render 'shared/fields/text_field', method: :text_field_value %>
 ```
 
-We say "within" because while a `shared` view partial directory does exist, the referenced `shared/fields/_text_field.html.erb` doesn't actually exist within it. Instead, the theme engine picks up on `shared` and also works its way through the theme directories to find the appropriate match.
+We say "within" because while a `shared` view partial directory does exist, the referenced `shared/fields/_text_field.html.erb` doesn't actually exist within it. Instead, the theme engine picks up on `shared` and then works its way through the theme directories to find the appropriate match.
 
 ### Dealing with Indirection
 
 This small piece of indirection buys us an incredible amount of power in building and extending themes, but as with any indirection, it could potentially come at the cost of developer experience. That's why Bullet Train includes additional tools for smoothing over this experience. Be sure to read the section on [dealing with indirection](./indirection.md).
 
-## Theme Configuration
+## Restoring Theme Configuration
 
-Your application will automatically be configured to use your new theme whenever you run the eject command. Run `> rake bullet_train:themes:light:install` to re-install the standard light theme.
+Your application will automatically be configured to use your new theme whenever you run the eject command. You can run the below command to re-install the standard light theme.
+```
+> rake bullet_train:themes:light:install
+``` 
 
 ## Additional Guidance and Principles
 
 ### Should you extend or replace?
 
-For most development projects, the likely best path for customizing the UI is to extend “Light” or another complete Bullet Train theme. It’s difficult to convey how many hours have gone into making the Bullet Train themes complete and coherent from end to end. Every type of field partial, all the third-party libraries, all the responsiveness scenarios, etc. It’s taken many hours and many invoices.
+For most development projects, the likely best path for customizing the UI is to extend “Light” or another complete Bullet Train theme. It’s difficult to convey how many hours have gone into making the Bullet Train themes complete and coherent from end to end. Every type of field partial, all the third-party libraries, all the responsiveness scenarios, etc. It has taken many hours of expert time.
 
 Extending an existing theme is like retaining an option on shipping. By extending a theme that is already complete, you allow yourself to say “enough is enough” at a certain point and just living with some inherited defaults in exchange for shipping your product sooner. You can always do more UI work later, but it doesn’t look unpolished now!
 
@@ -63,11 +70,11 @@ On the other hand, if you decide to try to build a theme from the ground up, you
 <% end %>
 ```
 
-This allows the theme engine to resolve which theme in the inheritance chain to include the `box` partial from. For example:
+This allows the theme engine to resolve which theme in the inheritance chain will include the `box` partial. For example:
 
- - It might come from the “Light” theme today, but if you switch to the “Bold” theme later, it’ll can start pulling it from there.
+ - It might come from the “Light” theme today, but if you switch to the “Bold” theme later, it’ll start pulling it from there.
  - If you start extending “Light”, you can override its `box` implementation and your application will pick up the new customized version from your theme automatically.
- - If (hypothetically) `box` became generalized and move into the parent “Tailwind CSS” theme, your application would pick it up from the appropriate place.
+ - If (hypothetically) `box` becomes generalized and moves into the parent “Tailwind CSS” theme, your application would pick it up from the appropriate place.
 
 ### Let your designer name their theme.
 

data/docs/tunneling.md

@@ -4,14 +4,14 @@ Before your application can take advantage of features that depend on incoming w
 
 ## Use a Paid Plan
 
-You should specifically sign up for a paid account. Although ngrok offers a free plan, their $25/month paid plan will allow you to reserve a custom subdomain for reuse each time you spin up your tunnel. This is a critical productivity improvement, because in practice you'll end up configuring your tunnel URL in a bunch of different places like `config/application.yml` but also in external systems like when you [configure payment providers to deliver webhooks to you](docs/billing/stripe.md).
+You should specifically sign up for a paid account. Although ngrok offers a free plan, their $25/month paid plan will allow you to reserve a custom subdomain for reuse each time you spin up your tunnel. This is a critical productivity improvement, because in practice you'll end up configuring your tunnel URL in a bunch of different places like `config/application.yml` but also in external systems like when you [configure payment providers to deliver webhooks to you](/docs/billing/stripe.md).
 
 ## Usage
 
 Once you have ngrok installed, you can start your tunnel like so, replacing `YOUR-SUBDOMAIN` with whatever subdomain you reserved in your ngrok account:
 
 ```
-ngrok http 3000 -subdomain=YOUR-SUBDOMAIN
+ngrok http 3000 --subdomain=YOUR-SUBDOMAIN
 ```
 
 ## Updating Your Configuration

data/docs/upgrades.md

@@ -43,7 +43,7 @@ git checkout -b updating-starter-repo
 git merge starter-repo/main
 ```
 
-It's quite possible you'll get some merge conflicts at this point. No big deal! Just go through and resolve them like you would if you were integrating code from another developer on your team. We tend to comment our code heavily, but if you have any questions about the code you're trying to understand, let us know on Slack!
+It's quite possible you'll get some merge conflicts at this point. No big deal! Just go through and resolve them like you would if you were integrating code from another developer on your team. We tend to comment our code heavily, but if you have any questions about the code you're trying to understand, let us know on Discord!
 
 ```
 git diff
@@ -55,6 +55,7 @@ git commit -m "Upgrading Bullet Train."
 
 ```
 rails test
+rails test:system
 ```
 
 ### 6. Merge into `main` and delete the branch.

data/lib/bullet_train/configuration.rb

@@ -0,0 +1,15 @@
+module BulletTrain
+  class Configuration
+    attr_accessor :strong_passwords
+
+    @default = Configuration.new
+
+    def initialize
+      self.strong_passwords = true
+    end
+
+    class << self
+      attr_reader :default
+    end
+  end
+end

data/lib/bullet_train/engine.rb

@@ -1,3 +1,18 @@
+begin
+  # We hoist the Devise engine, so its app/views directory is always after ours in a Rails app's view_paths.
+  #
+  # This is a quirk of how Rails engines compose, since engines `prepend_view_path` with their views:
+  # https://github.com/rails/rails/blob/9f141a423d551f7f421f54d1372e65ef6ed1f0be/railties/lib/rails/engine.rb#L606
+  #
+  # If users put devise after bullet_train in their Gemfile, Bundler requires the gems in that order,
+  # and devise's `prepend_view_path` would be called last, thus being prepended ahead of BulletTrain when Rails looks up views.
+  #
+  # Note: if this breaks down in the future, we may want to look into config.railties_order.
+  require "devise"
+rescue LoadError
+  # Devise isn't in the Gemfile, and we don't have any other load order dependencies.
+end
+
 module BulletTrain
   class Engine < ::Rails::Engine
   end

data/lib/bullet_train/version.rb

@@ -1,3 +1,3 @@
 module BulletTrain
-  VERSION = "1.2.9"
+  VERSION = "1.2.11"
 end

data/lib/bullet_train.rb

@@ -1,6 +1,7 @@
 require "bullet_train/version"
 require "bullet_train/engine"
 require "bullet_train/resolver"
+require "bullet_train/configuration"
 
 require "bullet_train/fields"
 require "bullet_train/roles"
@@ -12,6 +13,7 @@ require "colorizer"
 require "bullet_train/core_ext/string_emoji_helper"
 
 require "devise"
+require "xxhash"
 # require "devise-two-factor"
 # require "rqrcode"
 require "cancancan"
@@ -37,6 +39,14 @@ module BulletTrain
   mattr_accessor :linked_gems, default: ["bullet_train"]
   mattr_accessor :parent_class, default: "Team"
   mattr_accessor :base_class, default: "ApplicationRecord"
+
+  def self.configure
+    if block_given?
+      yield(BulletTrain::Configuration.default)
+    else
+      BulletTrain::Configuration.default
+    end
+  end
 end
 
 def default_url_options_from_base_url
@@ -106,7 +116,7 @@ def cloudinary_enabled?
 end
 
 def two_factor_authentication_enabled?
-  ENV["TWO_FACTOR_ENCRYPTION_KEY"].present?
+  Rails.application.credentials.active_record_encryption&.primary_key.present?
 end
 
 # Don't redefine this if an application redefines it locally.

data/lib/colorizer.rb

@@ -11,7 +11,7 @@ module Colorizer
   end
 
   def colorize_similarly(object, saturation, lightness)
-    rnd = ((object.hash * 7) % 100) * 0.01
+    rnd = ((XXhash.xxh64(object) * 7) % 100) * 0.01
     hsl_to_rgb(rnd, saturation, lightness)
   end
 

data/lib/tasks/bullet_train_tasks.rake

@@ -118,16 +118,22 @@ namespace :bullet_train do
           when "--link", "--reset"
             set_core_gems(process[:flag], framework_packages)
             stream "bundle install"
-          when "--watch-js"
-            set_npm_packages(process[:flag], framework_packages)
-
-            puts "Proceeding to reset your Bullet Train npm packages according to your root directory's `package.json`.".yellow
-            puts "If you press `Ctrl + C` before the process completely exits, just run `bin/hack --clean-js`".yellow
-            set_npm_packages("--clean-js", framework_packages)
-            break
-          when "--clean-js"
-            set_npm_packages(process[:flag], framework_packages)
-            break
+          when "--watch-js", "--clean-js"
+            package_name = process[:values].pop
+            framework_package = framework_packages.select { |k, v| k.to_s == package_name }
+            if framework_package.empty?
+              puts "Sorry, we couldn't find the package you're looking for.".red
+              puts ""
+
+              npm_packages = framework_packages.select { |name, details| details[:npm].present? }
+              puts "Please enter one of the following package names when running `bin/hack --watch-js` or `bin/hack --clean-js`:"
+              npm_packages.each_with_index do |package, idx|
+                puts "#{idx + 1}. #{package.first}"
+              end
+              exit 1
+            end
+
+            set_npm_package(process[:flag], framework_package)
           end
         end
 
@@ -194,16 +200,13 @@ namespace :bullet_train do
     `#{ENV["IDE"] || "code"} local/bullet_train-core`
     puts ""
 
-    puts "Bullet Train has a few npm packages, so we will and install those now.".blue
-    puts "We will also watch for any changes in your JavaScript files and recompile as we go.".blue
+    puts "Bullet Train has a few npm packages, but we can only watch one at a time, so we will watch the `bullet_train` package.".blue
+    puts "Any changes in your JavaScript files in this package will be recompiled as we go.".blue
+    puts "Run `bin/hack --watch-js` to see which other npm packages you can watch.".blue
     puts "When you're done, you can hit <Control + C> and we'll clean all off this up.".blue
     puts ""
-    set_npm_packages("--watch-js", framework_packages)
-
-    # Clean up the npm packages after the developer enters `Ctrl + C`.
-    puts "Cleaning up npm packages...".blue
-    puts "If you cancel out of this process early, just run `bin/hack --clean-js` to revert to your original npm packages.".blue
-    set_npm_packages("--clean-js", framework_packages)
+    bt_package = framework_packages.select { |k, v| k == :bullet_train }
+    set_npm_package("--watch-js", bt_package)
 
     puts ""
     puts "OK, here's a list of things this script still doesn't do you for you:".yellow
@@ -215,15 +218,18 @@ namespace :bullet_train do
   def set_core_gems(flag, framework_packages)
     packages = framework_packages.keys
     gemfile_lines = File.readlines("./Gemfile")
-    new_lines = gemfile_lines.map do |line|
-      packages.each do |package|
+
+    packages.each do |package|
+      original_path = "gem \"#{package}\""
+      local_path = "gem \"#{package}\", path: \"local/bullet_train-core/#{package}\""
+      match_found = false
+
+      new_lines = gemfile_lines.map do |line|
         if line.match?(/"#{package}"/)
-          original_path = "gem \"#{package}\""
-          local_path = "gem \"#{package}\", path: \"local/bullet_train-core/#{package}\""
+          match_found = true
 
-          case flag
-          when "--link"
-            if `cat Gemfile | grep "gem \\\"#{package}\\\", path: \\\"local/#{package}\\\""`.chomp.present?
+          if flag == "--link"
+            if `cat Gemfile | grep "gem \\\"#{package}\\\", path: \\\"local/bullet_train-core/#{package}\\\""`.chomp.present?
               puts "#{package} is already linked to a checked out copy in `local` in the `Gemfile`.".green
             elsif `cat Gemfile | grep "gem \\\"#{package}\\\","`.chomp.present?
               puts "#{package} already has some sort of alternative source configured in the `Gemfile`.".yellow
@@ -232,47 +238,52 @@ namespace :bullet_train do
               puts "#{package} is directly present in the `Gemfile`, so we'll update that line.".green
               line.gsub!(original_path, local_path)
             end
-            break
-          when "--reset"
+          elsif flag == "--reset"
             line.gsub!(local_path, original_path)
             puts "Resetting '#{package}' package in the Gemfile...".blue
-            break
           end
         end
+        line
       end
-      line
-    end
-
-    File.write("./Gemfile", new_lines.join)
-  end
 
-  def set_npm_packages(flag, framework_packages)
-    packages = framework_packages.select { |k, v| v[:npm].present? }.compact
+      # Add/Remove any packages that aren't primarily in the Gemfile.
+      if flag == "--link"
+        unless match_found
+          puts "Could not find #{package}. Adding to the end of the Gemfile.".blue
+          new_lines << "#{local_path}\n"
+        end
+      elsif flag == "--reset"
+        gem_regexp = /bullet_train-[a-z|A-Z_-]+/
+        while new_lines.last.match?(gem_regexp)
+          puts "Removing #{new_lines.last.scan(gem_regexp).first} from the Gemfile.".yellow
+          new_lines.pop
+        end
+      end
 
-    if flag == "--watch-js"
-      puts "Make sure your server is running before proceeding. When you're ready, press <Enter>".blue
-      $stdin.gets.strip
+      gemfile_lines = new_lines
+    end
 
-      puts "Linking npm packages...".blue
-      puts ""
+    File.write("./Gemfile", gemfile_lines.join)
+  end
 
-      yarn_watch_command = []
-      packages.each do |package_name, details|
-        puts "Linking JavaScript for #{package_name}".blue
-        stream "cd local/bullet_train-core/#{package_name} && yarn install && npm_config_yes=true && npx yalc link && cd ../../.. && npm_config_yes=true npx yalc link \"#{details[:npm]}\""
-        puts "#{package_name} has been linked.".blue
+  def set_npm_package(flag, package)
+    package.each do |name, details|
+      if flag == "--watch-js"
+        puts "Make sure your server is running before proceeding. When you're ready, press <Enter>".blue
+        $stdin.gets.strip
+
+        puts "Linking JavaScript for #{name}".blue
+        stream "cd local/bullet_train-core/#{name} && yarn install && npm_config_yes=true && npx yalc link && cd ../../.. && npm_config_yes=true npx yalc link \"#{details[:npm]}\""
+        puts "#{name} has been linked.".blue
+        puts "Preparing to watch changes.".blue
+        stream "yarn --cwd local/bullet_train-core/#{name} watch"
+
+        # Provide a help message after the developer kills the process with `Ctrl + C`.
+        puts "Run `bin/hack --clean-js #{name}` to revert to using the original npm package in your application.".blue
+      elsif flag == "--clean-js"
+        puts "Going back to using original `#{name}` npm package in application.".blue
         puts ""
-        yarn_watch_command << "yarn --cwd local/bullet_train-core/#{package_name} watch"
-      end
-
-      # We use `&` to run the processes in parallel.
-      puts "Preparing to watch changes".blue
-      stream yarn_watch_command.join(" & ")
-    elsif flag == "--clean-js"
-      puts "Resetting packages to their original path".blue
-      puts ""
 
-      packages.each do |package_name, details|
         system "yarn yalc remove #{details[:npm]}"
         system "yarn add #{details[:npm]}"
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bullet_train
 version: !ruby/object:Gem::Version
-  version: 1.2.9
+  version: 1.2.11
 platform: ruby
 authors:
 - Andrew Culver
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-28 00:00:00.000000000 Z
+date: 2023-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: standard
@@ -150,6 +150,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: xxhash
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: cancancan
   requirement: !ruby/object:Gem::Requirement
@@ -486,6 +500,8 @@ files:
 - app/javascript/controllers/bulk_action_form_controller.js
 - app/javascript/controllers/bulk_actions_controller.js
 - app/javascript/controllers/clipboard_controller.js
+- app/javascript/controllers/connection_workflow_controller.js
+- app/javascript/controllers/desktop_menu_controller.js
 - app/javascript/controllers/form_controller.js
 - app/javascript/controllers/index.js
 - app/javascript/controllers/mobile_menu_controller.js
@@ -493,6 +509,7 @@ files:
 - app/javascript/controllers/text_toggle_controller.js
 - app/javascript/electron/index.js
 - app/javascript/index.js
+- app/javascript/support/turn.js
 - app/mailers/concerns/mailers/base.rb
 - app/mailers/devise_mailer.rb
 - app/mailers/user_mailer.rb
@@ -513,11 +530,8 @@ files:
 - app/models/users.rb
 - app/views/account/invitations/_breadcrumbs.html.erb
 - app/views/account/invitations/_form.html.erb
-- app/views/account/invitations/_invitation.json.jbuilder
-- app/views/account/invitations/index.json.jbuilder
 - app/views/account/invitations/new.html.erb
 - app/views/account/invitations/show.html.erb
-- app/views/account/invitations/show.json.jbuilder
 - app/views/account/memberships/_breadcrumbs.html.erb
 - app/views/account/memberships/_fields.html.erb
 - app/views/account/memberships/_form.html.erb
@@ -536,15 +550,13 @@ files:
 - app/views/account/teams/_index.html.erb
 - app/views/account/teams/_menu_item.html.erb
 - app/views/account/teams/_team.html.erb
-- app/views/account/teams/_team.json.jbuilder
 - app/views/account/teams/edit.html.erb
 - app/views/account/teams/index.html.erb
-- app/views/account/teams/index.json.jbuilder
 - app/views/account/teams/new.html.erb
 - app/views/account/teams/show.html.erb
-- app/views/account/teams/show.json.jbuilder
 - app/views/account/two_factors/create.js.erb
 - app/views/account/two_factors/destroy.js.erb
+- app/views/account/two_factors/verify.js.erb
 - app/views/account/users/_breadcrumbs.html.erb
 - app/views/account/users/_fields.html.erb
 - app/views/account/users/_form.html.erb
@@ -664,6 +676,7 @@ files:
 - docs/webhooks/outgoing.md
 - docs/zapier.md
 - lib/bullet_train.rb
+- lib/bullet_train/configuration.rb
 - lib/bullet_train/core_ext/string_emoji_helper.rb
 - lib/bullet_train/engine.rb
 - lib/bullet_train/resolver.rb
@@ -696,7 +709,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: Bullet Train

data/app/views/account/invitations/_invitation.json.jbuilder

@@ -1,7 +0,0 @@
-json.extract! invitation,
-  :id,
-  :email,
-  # 🚅 super scaffolding will insert new fields above this line.
-  :created_at,
-  :updated_at
-json.url account_invitation_url(invitation, format: :json)

data/app/views/account/invitations/index.json.jbuilder

@@ -1 +0,0 @@
-json.array! @invitations, partial: "invitations/invitation", as: :invitation

data/app/views/account/invitations/show.json.jbuilder

@@ -1 +0,0 @@
-json.partial! "invitations/invitation", invitation: @invitation

data/app/views/account/teams/_team.json.jbuilder

@@ -1,9 +0,0 @@
-json.extract! team,
-  :id,
-  :name,
-  :time_zone,
-  :locale,
-  # 🚅 super scaffolding will insert new fields above this line.
-  :created_at,
-  :updated_at
-json.url account_team_url(team, format: :json)

data/app/views/account/teams/index.json.jbuilder

@@ -1 +0,0 @@
-json.array! @teams, partial: "teams/team", as: :team

data/app/views/account/teams/show.json.jbuilder

@@ -1 +0,0 @@
-json.partial! "teams/team", team: @team