bullet_train 1.0.28 → 1.0.31

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9a2cb019fbf151b922e19e9ad2aec5f84ac7fd50045bd23d2ba94478c86a0dc
-  data.tar.gz: e63d7bb9128c48f49ee9e7b388c490173569624c2aaeb35d0c7a8d72d54c5abd
+  metadata.gz: 2967f0b80a95786b9a7e0816284db63ed4b149a644b1c050df1904a56df7947f
+  data.tar.gz: 92ac669e6fb6091e32772a8281207b35bb034a4481649971c4682e74486734dd
 SHA512:
-  metadata.gz: cbfa5d7e78cb1d62ad68966763a1c8d654c2ca6d080a3ad7a3d6e1126d0b46a44d96dcfeac454e368b5d58388dc2c5ab7f3d41122b8c03acb004e1447c2aced6
-  data.tar.gz: 73abfc993caaf2fbc71fccace9925bf8e897e35db76d4ef9c5cfe50495db45b33fecc924866da25a5b410e70d0a0f100da7f5a3f515cb4d681e2db68a60b1260
+  metadata.gz: 63ade82241aab3d3ca9267e8217ef604bde7f1142b25e63b21d1a95c93b0fa914ec51ee0f869c9b1080500e5b15a79317eefe369c91edd8db81dedf01bd37d46
+  data.tar.gz: c241470aa225ea03179125b2ac640ef34a8958058e2ae5457d3b1ca37de560d05808b15568b6bee2755e5fb6a44ef9b3fcc135b7160e5c77a797e6ccea76c07d

data/app/helpers/account/locale_helper.rb

@@ -35,11 +35,43 @@ module Account::LocaleHelper
   end
 
   def t(key, options = {})
+    # When bundled Ruby gems provide a lot of translations, it can be difficult to figure out which strings in the
+    # application are coming from where. To help with this, you can add `?debug=true` to any URL and we'll output
+    # any rendered strings and their translation keys on the console.
+    unless Rails.env.production?
+      if params[:log_locales] || params[:show_locales]
+        # Often times we're only receiving partial keys like `.section`, so this is a crazy hack to trick I18n.t into
+        # telling us what the full key ended up being.
+        begin
+          super(key + "💣", options.except(:default))
+        rescue I18n::MissingTranslationData => exception
+          full_key = exception.message.rpartition(" ").last.gsub("💣", "")
+        end
+      end
+    end
+
     if account_controller?
-      # give preference to the options they've passed in.
+      # Give preference to the options they've passed in.
       options = models_locales(@child_object, @parent_object).merge(options)
     end
-    super(key, options)
+
+    result = super(key, options)
+
+    unless Rails.env.production?
+      if params[:log_locales]
+        if result == options[:default]
+          puts "🌐 #{full_key}: Not found? Result matched default: \"#{result}\"".yellow
+        else
+          puts "🌐 #{full_key}: \"#{result}\"".green
+        end
+      end
+
+      if params[:show_locales]
+        return full_key
+      end
+    end
+
+    return result
   end
 
   # like 't', but if the key isn't found, it returns nil.

data/app/views/bullet_train/partial_resolver.html.erb

@@ -0,0 +1,2 @@
+<%= render @needle do |p| %>
+<% end %>

data/app/views/devise/sessions/new.html.erb

@@ -1,5 +1,3 @@
-
-
 <%= render 'account/shared/workflow/box' do |p| %>
   <% p.content_for :title, t('devise.headers.sign_in') %>
   <% p.content_for :body do %>

data/config/locales/en/base.yml

@@ -30,7 +30,12 @@
 # available at https://guides.rubyonrails.org/i18n.html.
 
 en:
-
+  bullet_train:
+    name: Bullet Train
+    tagline: The Ruby on Rails SaaS Template
+    description: Bullet Train is a Ruby on Rails SaaS-in-a-Box that saves developers weeks of effort.
+    keywords: bullet train ruby on rails saas template starter kit
+    support_email: ask@bullettrain.co
   global:
     or: Or
     more: More

data/lib/bullet_train/resolver.rb

@@ -0,0 +1,167 @@
+require 'io/wait'
+
+module BulletTrain
+  class Resolver
+    include I18n::Backend::Flatten
+
+    def initialize(needle)
+      @needle = needle
+    end
+
+    def run(eject: false, open: false, force: false, interactive: false)
+      # Try to figure out what kind of thing they're trying to look up.
+      source_file = calculate_source_file_details
+
+      if source_file[:absolute_path]
+        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
+
+        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'
+            eject = true
+          end
+        end
+
+        if eject
+          if source_file[:package_name]
+            if File.exist?(source_file[:project_path]) && !force
+              return puts "Can't eject! `#{source_file[:project_path]}` already exists!\n".red
+            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|
+                case source_file[:project_path].split(".").last
+                when "rb", "yml"
+                  file.puts "# Ejected from `#{source_file[:package_name]}`.\n\n"
+                when "erb"
+                  file.puts "<% # Ejected from `#{source_file[:package_name]}`. %>\n\n"
+                end
+              end
+              `cat #{source_file[:absolute_path]} >> #{source_file[:project_path]}`.strip
+            end
+
+            # Just in case they try to open the file, open it from the new location.
+            source_file[:absolute_path] = source_file[:project_path]
+          else
+            puts "This file is already in the local project directory. Skipping ejection.".yellow
+            puts ""
+          end
+        end
+
+        if interactive && !open
+          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'
+            open = true
+          end
+        end
+
+        if open
+          path = source_file[:package_name] ? source_file[:absolute_path] : "#{source_file[:project_path]}"
+          puts "Opening `#{path}`.\n".green
+          exec "open #{path}"
+        end
+      else
+        puts "Couldn't resolve `#{@needle}`.".red
+      end
+    end
+
+    def calculate_source_file_details
+      result = {
+        absolute_path: nil,
+        project_path: nil,
+        package_name: nil,
+      }
+
+      result[:absolute_path] = class_path || partial_path || locale_path || file_path
+
+      if result[:absolute_path]
+        base_path = "bullet_train" + result[:absolute_path].split("/bullet_train").last
+
+        # Try to calculate which package the file is from, and what it's path is within that project.
+        ["app", "config", "lib"].each do |directory|
+          regex = /\/#{directory}\//
+          if base_path.match?(regex)
+            project_path = "./#{directory}/#{base_path.rpartition(regex).last}"
+            package_name = base_path.rpartition(regex).first.split("/").last
+            # If the "package name" is actually just the local project directory.
+            if package_name == `pwd`.chomp.split("/").last
+              package_name = nil
+            end
+
+            result[:project_path] = project_path
+            result[:package_name] = package_name
+          end
+        end
+      end
+
+      result
+    end
+
+    def url?
+      @needle.match?(/https?:\/\//)
+    end
+
+    def class_path
+      begin
+        @needle.constantize
+        return Object.const_source_location(@needle).first
+      rescue NameError => _
+        return false
+      end
+    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
+      end
+    end
+
+    def file_path
+      # We don't have to do anything here... the absolute path is what we're passed, and we just pass it back.
+      @needle
+    end
+
+    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|
+        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)
+            translations = flatten_translations(nil, yaml, nil, false)
+            if translations[@needle.to_sym].present?
+              return file_path
+            end
+          end
+        end
+      end
+
+      return nil
+    end
+  end
+end

data/lib/bullet_train/version.rb

@@ -1,3 +1,3 @@
 module BulletTrain
-  VERSION = "1.0.28"
+  VERSION = "1.0.31"
 end

data/lib/bullet_train.rb

@@ -1,5 +1,6 @@
 require "bullet_train/version"
 require "bullet_train/engine"
+require "bullet_train/resolver"
 
 require "bullet_train/fields"
 require "bullet_train/roles"

data/lib/tasks/bullet_train_tasks.rake

@@ -1,3 +1,5 @@
+require 'io/wait'
+
 namespace :bullet_train do
   desc "Symlink registered gems in `./tmp/gems` so their views, etc. can be inspected by Tailwind CSS."
   task :link_gems => :environment do
@@ -19,8 +21,37 @@ namespace :bullet_train do
       target = `bundle show #{linked_gem}`.chomp
       if target.present?
         puts "Linking '#{linked_gem}' to '#{target}'."
-        puts `ln -s #{target} tmp/gems/#{linked_gem}`
+        `ln -s #{target} tmp/gems/#{linked_gem}`
+      end
+    end
+  end
+
+  desc "Figure out where something is coming from."
+  task :resolve, [:all_options] => :environment do |t, arguments|
+    ARGV.pop while ARGV.any?
+
+    arguments[:all_options]&.split&.each do |argument|
+      ARGV.push(argument)
+    end
+
+    if ARGV.include?("--interactive")
+      puts "\nOK, paste what you've got for us and hit <Return>!\n".blue
+
+      input = $stdin.gets.strip
+      $stdin.getc while $stdin.ready?
+
+      # Extract absolute paths from XRAY comments.
+      if input.match(/<!--XRAY START \d+ (.*)-->/)
+        input = $1
       end
+
+      ARGV.unshift input.strip
+    end
+
+    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
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bullet_train
 version: !ruby/object:Gem::Version
-  version: 1.0.28
+  version: 1.0.31
 platform: ruby
 authors:
 - Andrew Culver
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-04 00:00:00.000000000 Z
+date: 2022-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -450,6 +450,7 @@ files:
 - app/views/account/users/_form.html.erb
 - app/views/account/users/edit.html.erb
 - app/views/account/users/show.html.erb
+- app/views/bullet_train/partial_resolver.html.erb
 - app/views/devise/confirmations/new.html.erb
 - app/views/devise/mailer/confirmation_instructions.html.erb
 - app/views/devise/mailer/password_change.html.erb
@@ -522,6 +523,7 @@ files:
 - db/migrate/20211027002944_add_doorkeeper_application_to_users.rb
 - lib/bullet_train.rb
 - lib/bullet_train/engine.rb
+- lib/bullet_train/resolver.rb
 - lib/bullet_train/version.rb
 - lib/colorizer.rb
 - lib/string/emoji.rb