bullet_train 1.0.45 → 1.0.48

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 041e2b16ba7fe195c4622eca9f52ba3f2ece36e2ca4990e81091dcd7dce77f67
-  data.tar.gz: 4343cfb1d33be84c52dd412e335d15928ad13afb9d8a95eddbc41b751452c335
+  metadata.gz: f97118eaaa7253406852b09625acb890ba8d2653e0266628795bde576044eec5
+  data.tar.gz: 47688fa0493151a13a4b5060efd32703c9bc9bfa5a4f13052519c6afb6a864a6
 SHA512:
-  metadata.gz: fa1d5423f1a3b3ab31ac94b2c75b6d298b9c0fb670f70178a2aec8e8638e9adaf07d3e8c77a2bb0e99edcc79961407058cbf0807a7972fbc50c08e008312de45
-  data.tar.gz: 7875607106a2cb2932a30a537717ac947e62121709a0389c2144be1f4c39366dbd799d5286d2548f8d2b513136992e1b526f5a66782eea4aebea0137ce2c3c9f
+  metadata.gz: 5c750045603680f1d1ffcff0bbc7ffb1e3d334ca6e280f2d4332c2d5270ae94228d0f230876f63223d5aeeca146b5678a8b6fb9ed6b0656b3fecb7b5a751f54e
+  data.tar.gz: 15a90ab25fa884ae6004423c6469d2dd974f08da0c88eae230cbd4e60bfb3c64af1011ff02c2bf6bfe1a732518324c8c55cb0898a10f88ca25e0c9e2059a21a8

data/README.md

@@ -13,12 +13,12 @@ gem "bullet_train"
 
 And then execute:
 ```bash
-$ bundle
+bundle
 ```
 
 Or install it yourself as:
 ```bash
-$ gem install bullet_train
+gem install bullet_train
 ```
 
 ## Contributing

data/app/helpers/account/locale_helper.rb

@@ -46,7 +46,7 @@ module Account::LocaleHelper
           begin
             super(key + "💣", options.except(:default))
           rescue I18n::MissingTranslationData => exception
-            full_key = exception.message.rpartition(" ").last.gsub("💣", "")
+            full_key = exception.message.rpartition(" ").last.delete("💣")
           end
         end
       end
@@ -75,7 +75,7 @@ module Account::LocaleHelper
       end
     end
 
-    return result
+    result
   end
 
   # like 't', but if the key isn't found, it returns nil.

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

@@ -2,7 +2,7 @@ module CurrentAttributes::Base
   extend ActiveSupport::Concern
 
   included do
-    attribute :user, :team, :membership, :ability
+    attribute :user, :team, :membership, :ability, :context
 
     resets do
       Time.zone = nil

data/app/models/invitation.rb

@@ -1,5 +1,5 @@
 class Invitation < ApplicationRecord
-  include Invitations::Core
+  include Invitations::Base
   # 🚅 add concerns above.
 
   # 🚅 add belongs_to associations above.

data/app/models/membership.rb

@@ -1,5 +1,5 @@
 class Membership < ApplicationRecord
-  include Memberships::Core
+  include Memberships::Base
   # 🚅 add concerns above.
 
   # 🚅 add belongs_to associations above.

data/app/models/team.rb

@@ -1,6 +1,6 @@
 class Team < ApplicationRecord
-  include Teams::Core
-  include Webhooks::Outgoing::TeamSupport
+  include Teams::Base
+  # include Webhooks::Outgoing::TeamSupport
   # 🚅 add concerns above.
 
   # 🚅 add belongs_to associations above.

data/app/models/user.rb

@@ -1,5 +1,5 @@
 class User < ApplicationRecord
-  include Users::Core
+  include Users::Base
   # 🚅 add concerns above.
 
   # 🚅 add belongs_to associations above.

data/docs/authentication.md

@@ -5,8 +5,8 @@ Bullet Train uses [Devise](https://github.com/heartcombo/devise) for authenticat
 Bullet Train registers its own slightly customized registration and session controllers for Devise. If you want to customize them further, you can simply eject those controllers from the framework and override them locally, like so:
 
 ```
-$ bin/resolve RegistrationsController --eject --open
-$ bin/resolve SessionsController --eject --open
+bin/resolve RegistrationsController --eject --open
+bin/resolve SessionsController --eject --open
 ```
 
 ## Customizing Views

data/docs/getting-started.md

@@ -11,45 +11,45 @@ If you're using Bullet Train for the first time, begin by learning these five im
 1. Use `rails g model` to create and `bin/super-scaffold` to scaffold a new model:
 
     ```
-    $ rails g model Project team:references name:string
-    $ bin/super-scaffold crud Project Team name:text_field
+    rails g model Project team:references name:string
+    bin/super-scaffold crud Project Team name:text_field
     ```
 
-    In this example, `Team` refers to the immediate parent of the `Project` resource. For more details, just run `bin/super-scaffold` or [read the documentation](https://github.com/bullet-train-co/bullet_train-base/blob/main/docs/super-scaffolding.md).
+    In this example, `Team` refers to the immediate parent of the `Project` resource. For more details, just run `bin/super-scaffold` or [read the documentation](/docs/super-scaffolding.md).
 
 2. Use `rails g migration` and `bin/super-scaffold` to add a new field to a model you've already scaffolded:
 
     ```
-    $ rails g migration add_description_to_projects description:text
-    $ bin/super-scaffold crud-field Project description:trix_editor
+    rails g migration add_description_to_projects description:text
+    bin/super-scaffold crud-field Project description:trix_editor
     ```
 
-    These first two points about Super Scaffolding are just the tip of the iceberg, so be sure to circle around and [read the full documentation](https://github.com/bullet-train-co/bullet_train-base/blob/main/docs/super-scaffolding.md).
+    These first two points about Super Scaffolding are just the tip of the iceberg, so be sure to circle around and [read the full documentation](/docs/super-scaffolding.md).
 
 3. Figure out which ERB views are powering something you see in the UI by:
 
     - Right clicking the element.
     - Selecting "Inspect Element".
-    - Looking for the `<!--XRAY START ...-->` comment above the element you've selected.
+    - Looking for the `<!-- BEGIN ... -->` comment above the element you've selected.
 
 4. Figure out the full I18N translation key of any string on the page by adding `?show_locales=true` to the URL.
 
 5. Use `bin/resolve` to figure out where framework or theme things are coming from and eject them if you need to customize something locally:
 
     ```
-    $ bin/resolve Users::Base
-    $ bin/resolve en.account.teams.show.header --open
-    $ bin/resolve shared/box --open --eject
+    bin/resolve Users::Base
+    bin/resolve en.account.teams.show.header --open
+    bin/resolve shared/box --open --eject
     ```
 
     Also, for inputs that can't be provided on the shell, there's an interactive mode where you can paste them:
 
     ```
-    $ bin/resolve --interactive --eject --open
+    bin/resolve --interactive --eject --open
     ```
 
     And then paste any input, e.g.:
 
     ```
-    <!--XRAY START 73 /Users/andrewculver/.rbenv/versions/3.1.1/lib/ruby/gems/3.1.0/gems/bullet_train-themes-light-1.0.10/app/views/themes/light/commentary/_box.html.erb-->
+    <!-- BEGIN /Users/andrewculver/.rbenv/versions/3.1.1/lib/ruby/gems/3.1.0/gems/bullet_train-themes-light-1.0.10/app/views/themes/light/commentary/_box.html.erb -->
     ```

data/docs/indirection.md

@@ -27,20 +27,18 @@ Even in vanilla Rails development, when you're looking at a view file, the path
 `bin/resolve` makes it easy to figure out where where a partial is being served from:
 
 ```
-$ bin/resolve shared/box
+bin/resolve shared/box
 ```
 
-### Exposing Rendered Views with Xray
+### Exposing Rendered Views with Annotated Views
 
-> TODO Is this still true in Rails 7? Does it not do something like this by default now?
-
-If you're looking at a rendered view in the browser, it can be hard to know which file to open in order to make a change. To help, Bullet Train includes [Xray](https://github.com/brentd/xray-rails) by default, so you can right click on any element you see, select "Inspect Element", and you'll see comments in the HTML source telling you which file is powering a particular portion of the view, like this:
+If you're looking at a rendered view in the browser, it can be hard to know which file to open in order to make a change. To help, Bullet Train enables `config.action_view.annotate_rendered_view_with_filenames` by default, so you can right click on any element you see, select "Inspect Element", and you'll see comments in the HTML source telling you which file is powering a particular portion of the view, like this:
 
 ```
-<!--XRAY START 90 /Users/andrewculver/.rbenv/versions/3.1.1/lib/ruby/gems/3.1.0/gems/bullet_train-themes-light-1.0.10/app/views/themes/light/workflow/_box.html.erb-->
+<!-- BEGIN /Users/andrewculver/.rbenv/versions/3.1.1/lib/ruby/gems/3.1.0/gems/bullet_train-themes-light-1.0.10/app/views/themes/light/workflow/_box.html.erb -->
 ```
 
-Note that in the example above, the view in question isn't actually coming from the application repository. Instead, it's being included from the `bullet_train-themes-light` package. For instructions on how to customize it, see [Overriding the Framework](/docs/override).
+Note that in the example above, the view in question isn't actually coming from the application repository. Instead, it's being included from the `bullet_train-themes-light` package. For instructions on how to customize it, see [Overriding Framework Defaults](/docs/overriding.md).
 
 ### Drilling Down on Translation Keys
 
@@ -59,5 +57,5 @@ You can also log all the translation key for anything being rendered to the cons
 Once you have the full I18N translation key, you can use `bin/resolve` to figure out which package and file it's coming from. At that point, if you need to customize it, you can also use the `--eject` option to copy the  the framework for customization in your local application:
 
 ```
-$ bin/resolve en.account.onboarding.user_details.edit.header --eject --open
+bin/resolve en.account.onboarding.user_details.edit.header --eject --open
 ```

data/docs/namespacing.md

@@ -7,5 +7,5 @@ Bullet Train comes preconfigured with an `Account` and controller and view names
 In Bullet Train applications with [multiple team types](/docs/teams.md), you may find it helpful to introduce additional controller and view namespaces to represent and organize user interfaces and experiences for certain team types that vary substantially from the `Account` namespace default. In Super Scaffolding, you can specify a namespace other than `Account` with the `--namespace` option, for example:
 
 ```
-$ bin/super-scaffold crud Event Team name:text_field --namespace=customers
+bin/super-scaffold crud Event Team name:text_field --namespace=customers
 ```

data/docs/overriding.md

@@ -12,7 +12,7 @@ For this reason, common points of extension like framework-provided models and c
 
 ```
 class User < ApplicationRecord
-  include Users::Core
+  include Users::Base
 
   # ...
 end

data/lib/bullet_train/resolver.rb

@@ -1,4 +1,4 @@
-require 'io/wait'
+require "io/wait"
 
 module BulletTrain
   class Resolver
@@ -13,28 +13,26 @@ module BulletTrain
       source_file = calculate_source_file_details
 
       if source_file[:absolute_path]
+        puts ""
         if source_file[:package_name].present?
-          puts ""
           puts "Absolute path:".green
           puts "  #{source_file[:absolute_path]}".green
           puts ""
           puts "Package name:".green
           puts "  #{source_file[:package_name]}".green
-          puts ""
         else
-          puts ""
           puts "Project path:".green
           puts "  #{source_file[:project_path]}".green
           puts ""
           puts "Note: If this file was previously ejected from a package, we can no longer see which package it came from. However, it should say at the top of the file where it was ejected from.".yellow
-          puts ""
         end
+        puts ""
 
         if interactive && !eject
           puts "\nWould you like to eject the file into the local project? (y/n)\n"
           input = $stdin.gets
           $stdin.getc while $stdin.ready?
-          if input.first.downcase == 'y'
+          if input.first.downcase == "y"
             eject = true
           end
         end
@@ -46,7 +44,7 @@ module BulletTrain
             else
               `mkdir -p #{source_file[:project_path].split("/")[0...-1].join("/")}`
               puts "Ejecting `#{source_file[:absolute_path]}` to `#{source_file[:project_path]}`".green
-              File.open("#{source_file[:project_path]}", "w+") do |file|
+              File.open((source_file[:project_path]).to_s, "w+") do |file|
                 case source_file[:project_path].split(".").last
                 when "rb", "yml"
                   file.puts "# Ejected from `#{source_file[:package_name]}`.\n\n"
@@ -69,13 +67,13 @@ module BulletTrain
           puts "\nWould you like to open `#{source_file[:absolute_path]}`? (y/n)\n"
           input = $stdin.gets
           $stdin.getc while $stdin.ready?
-          if input.first.downcase == 'y'
+          if input.first.downcase == "y"
             open = true
           end
         end
 
         if open
-          path = source_file[:package_name] ? source_file[:absolute_path] : "#{source_file[:project_path]}"
+          path = source_file[:package_name] ? source_file[:absolute_path] : (source_file[:project_path]).to_s
           puts "Opening `#{path}`.\n".green
           exec "open #{path}"
         end
@@ -121,25 +119,21 @@ module BulletTrain
     end
 
     def class_path
-      begin
-        @needle.constantize
-        return Object.const_source_location(@needle).first
-      rescue NameError => _
-        return false
-      end
+      @needle.constantize
+      Object.const_source_location(@needle).first
+    rescue NameError => _
+      false
     end
 
     def partial_path
-      begin
-        xray_path = ApplicationController.render(template: "bullet_train/partial_resolver", layout: nil, assigns: {needle: @needle}).lines[1].chomp
-        if xray_path.match(/<!--XRAY START \d+ (.*)-->/)
-          return $1
-        else
-          raise "It looks like Xray-rails isn't properly enabled?"
-        end
-      rescue ActionView::Template::Error => _
-        return nil
+      annotated_path = ApplicationController.render(template: "bullet_train/partial_resolver", layout: nil, assigns: {needle: @needle}).lines[1].chomp
+      if annotated_path =~ /<!-- BEGIN (.*) -->/
+        $1
+      else
+        raise "It looks like `config.action_view.annotate_rendered_view_with_filenames` isn't enabled?"
       end
+    rescue ActionView::Template::Error => _
+      nil
     end
 
     def file_path
@@ -149,7 +143,7 @@ module BulletTrain
 
     def locale_path
       # This is a complete list of translation files provided by this app or any linked Bullet Train packages.
-      (["#{Rails.root.to_s}/config/locales"] + `find ./tmp/gems/*`.lines.map(&:strip).map { |link| File.readlink(link) + "/config/locales" }).each do |locale_source|
+      (["#{Rails.root}/config/locales"] + `find ./tmp/gems/*`.lines.map(&:strip).map { |link| File.readlink(link) + "/config/locales" }).each do |locale_source|
         if File.exist?(locale_source)
           `find -L #{locale_source} | grep ".yml"`.lines.map(&:strip).each do |file_path|
             yaml = YAML.load_file(file_path, aliases: true)
@@ -161,7 +155,7 @@ module BulletTrain
         end
       end
 
-      return nil
+      nil
     end
   end
 end

data/lib/bullet_train/version.rb

@@ -1,3 +1,3 @@
 module BulletTrain
-  VERSION = "1.0.45"
+  VERSION = "1.0.48"
 end

data/lib/tasks/bullet_train_tasks.rake

@@ -1,13 +1,13 @@
-require 'io/wait'
+require "io/wait"
 
 namespace :bt do
   desc "Symlink registered gems in `./tmp/gems` so their views, etc. can be inspected by Tailwind CSS."
-  task :link => :environment do
-    if Dir.exists?("tmp/gems")
+  task link: :environment do
+    if Dir.exist?("tmp/gems")
       puts "Removing previously linked gems."
       `rm -f tmp/gems/*`
     else
-      if File.exists?("tmp/gems")
+      if File.exist?("tmp/gems")
         raise "A file named `tmp/gems` already exists? It has to be removed before we can create the required directory."
       end
 
@@ -42,8 +42,8 @@ namespace :bullet_train do
       input = $stdin.gets.strip
       $stdin.getc while $stdin.ready?
 
-      # Extract absolute paths from XRAY comments.
-      if input.match(/<!--XRAY START \d+ (.*)-->/)
+      # Extract absolute paths from annotated views.
+      if input =~ /<!-- BEGIN (.*) -->/
         input = $1
       end
 
@@ -53,7 +53,7 @@ namespace :bullet_train do
     if ARGV.first.present?
       BulletTrain::Resolver.new(ARGV.first).run(eject: ARGV.include?("--eject"), open: ARGV.include?("--open"), force: ARGV.include?("--force"), interactive: ARGV.include?("--interactive"))
     else
-      $stderr.puts "\n🚅 Usage: `bin/resolve [path, partial, or URL] (--eject) (--open)`\n".blue
+      warn "\n🚅 Usage: `bin/resolve [path, partial, or URL] (--eject) (--open)`\n".blue
     end
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: bullet_train
 version: !ruby/object:Gem::Version
-  version: 1.0.45
+  version: 1.0.48
 platform: ruby
 authors:
 - Andrew Culver
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-26 00:00:00.000000000 Z
+date: 2022-04-07 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -240,14 +254,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.0.0.pre8
+        version: 5.0.0.pre9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.0.0.pre8
+        version: 5.0.0.pre9
 - !ruby/object:Gem::Dependency
   name: hiredis
   requirement: !ruby/object:Gem::Requirement