brut 0.18.2 → 0.19.0

data/lib/brut/cli/parsed_command_line.rb

@@ -1,4 +1,5 @@
 require "optparse"
+require "pathname"
 require "brut/framework/project_environment"
 
 # Parses the command line and makes everything parsed available as attributes.
@@ -30,7 +31,7 @@ class Brut::CLI::ParsedCommandLine
   # for `#command` may be a command that outputs an error.
   def initialize(app_command:, argv:, env:)
     brut_provided_help_requested = false
-    app_option_parser = new_option_parser do |opts|
+    app_option_parser = new_option_parser(app_command.name) do |opts|
       opts.banner = app_command.description
       app_command.accepts.each_with_index { |class_or_class_and_proc,index| accept(opts,class_or_class_and_proc,index) }
       app_command.opts.each do |option|
@@ -41,9 +42,7 @@ class Brut::CLI::ParsedCommandLine
       end
     end
 
-    options = {
-      'log-level': "error",
-    }
+    options = {}
     remaining_argv = app_option_parser.order!(argv,into: options)
 
     if remaining_argv[0] == "help"
@@ -72,7 +71,7 @@ class Brut::CLI::ParsedCommandLine
 
 
     if command != app_command
-      command_option_parser = new_option_parser do |opts|
+      command_option_parser = new_option_parser(app_command.name) do |opts|
         opts.banner = command.description
         app_command.accepts.each_with_index { |class_or_class_and_proc,index| accept(opts,class_or_class_and_proc,index) }
         command.accepts.each_with_index { |class_or_class_and_proc,index| accept(opts,class_or_class_and_proc,index) }
@@ -92,10 +91,6 @@ class Brut::CLI::ParsedCommandLine
 
     if help_command
       command = help_command
-    else
-      if remaining_argv.empty? && command.default_command
-        command = command.default_command
-      end
     end
 
     if options[:env]
@@ -105,6 +100,28 @@ class Brut::CLI::ParsedCommandLine
     @command = command
     @argv    = remaining_argv
     @options = Brut::CLI::Options.new(options)
+    if !@options.log_level?
+      if @options.verbose? || @options.debug?
+        @options[:'log-level'] = "debug"
+      elsif @options.quiet?
+        @options[:'log-level'] = "error"
+      else
+        @options[:'log-level'] = "info"
+      end
+    end
+    if !@options[:'log-file']
+      log_file_path = if env["XDG_STATE_HOME"]
+                        Pathname(env["XDG_STATE_HOME"]) / "brut"
+                      elsif env["HOME"]
+                        Pathname("#{env['HOME']}/.local/state/") / "brut"
+                      else
+                        Pathname("/tmp/") / "brut"
+                      end
+      @options[:'log-file'] = log_file_path / (app_command.name + ".log")
+    end
+    if @options[:'log-stdout'].nil?
+      @options[:'log-stdout'] = @options.verbose? || @options.debug?
+    end
   rescue => ex
     @command = if env["BRUT_DEBUG"] == "true"
       Brut::CLI::Commands::RaiseError.new(ex)
@@ -117,7 +134,7 @@ class Brut::CLI::ParsedCommandLine
 
 private
 
-  def new_option_parser(&block)
+  def new_option_parser(app_name, &block)
     OptionParser.new do |opts|
       opts.accept(Brut::Framework::ProjectEnvironment) do |value|
         Brut::Framework::ProjectEnvironment.new(value)
@@ -126,6 +143,12 @@ private
               "Project environment, e.g. test, development, production. Default depends on the command")
       opts.on("--log-level=LOG_LEVEL", [ "debug", "info", "warn", "error", "fatal" ],
               "Log level, which should be debug, info, warn, error, or fatal. Defaults to error")
+      opts.on("--verbose", "Set log level to debug, and show log messages on stdout")
+      opts.on("--debug", "Set log level to debug, and show log messages on stdout")
+      opts.on("--quiet", "Set log level to error")
+      opts.on("--log-file=FILE",
+              "Path to a file where log messages are written. Defaults to $XDG_CACHE_HOME/brut/logs/#{app_name}.log")
+      opts.on("--[no-]log-stdout", "Log messages to stdout in addition to the log file")
       block.(opts)
     end
   end

data/lib/brut/cli/runner.rb

@@ -11,18 +11,19 @@ class Brut::CLI::Runner
   # @param [IO] stdin the standard input
   # @param [Pathname] project_root root of the Brut project (i.e. where `Gemfile`, `app` et. al. are located)
   def initialize(app_command, stdout:, stderr:,stdin:, project_root:)
-    prefix = if $0 =~ /\/brut$/
-               "brut"
-             else
-               $0
-             end
+    @app_name = if $0 =~ /\/brut$/
+                  "brut #{app_command.name}"
+                else
+                  $0
+                end
     @app_command  = app_command
-    @stdout       = Brut::CLI::Output.new(io: stdout, prefix: "[ #{prefix} ] ")
-    @stderr       = Brut::CLI::Output.new(io: stderr, prefix: "[ #{prefix} ] ")
+    @stdout       = stdout
+    @stderr       = stderr
     @stdin        = stdin
     @project_root = project_root
   end
 
+
   # Run the commmand or subcommand based on the `app_command` given to the constructor and the command line
   # provided in `argv`.
   #
@@ -35,6 +36,13 @@ class Brut::CLI::Runner
 
     parsed_command_line = Brut::CLI::ParsedCommandLine.new(app_command: @app_command, argv:, env:)
 
+    logger = Brut::CLI::Logger.new(
+      app_name: @app_command.name,
+      stdout: @stdout,
+      stderr: @stderr,
+      theme: parsed_command_line.command.theme,
+    )
+
     load_unix_environment!(env, parsed_command_line)
     setup_log_level(env, parsed_command_line)
     bootstrap!(env, parsed_command_line)
@@ -46,12 +54,23 @@ class Brut::CLI::Runner
         env:,
         stdout: @stdout,
         stderr: @stderr,
-        stdin: @stdin
+        stdin: @stdin,
+        logger:
       )
       parsed_command_line.command.execute(execution_context)
     end
     execute_result.exit_status do |error_message|
+      logger.fatal(error_message)
       @stderr.puts error_message
+      if parsed_command_line.options.log_file && !parsed_command_line.options.log_stdout?
+        @stderr.puts
+        @stderr.puts "More details may be available from the log file:"
+        @stderr.puts
+        @stderr.puts "    " + parsed_command_line.options.log_file.to_s
+        @stderr.puts
+        @stderr.puts "You can also use --log-stdout to see these log messages in the terminal"
+      end
+
     end
   end
 
@@ -77,10 +96,12 @@ private
     end
     require "bundler"
     if rack_env == "production"
+      Bundler.setup(:default)
       Bundler.require(:default)
       return
     end
 
+    Bundler.setup(:default, rack_env.to_sym)
     Bundler.require(:default, rack_env.to_sym)
 
     require "dotenv"
@@ -112,6 +133,12 @@ private
 
   def bootstrap!(env, parsed_command_line)
     if env["RACK_ENV"]
+      log_level = env["LOG_LEVEL"]
+
+      if !parsed_command_line.options.verbose? && !parsed_command_line.options.debug?
+        env["LOG_LEVEL"] = "warn"
+      end
+
       require "#{@project_root}/app/bootstrap"
       bootstrap = Bootstrap.new
       if parsed_command_line.command.bootstrap?
@@ -119,6 +146,8 @@ private
       else
         bootstrap.configure_only!
       end
+
+      env["LOG_LEVEL"] = log_level
     end
   end
 end

data/lib/brut/cli/terminal.rb

@@ -0,0 +1,74 @@
+require "io/console"
+require "timeout"
+require "stringio"
+
+# Stores metdata about the current temrinal in use. This should provide any metadata
+# about the terminal that can be reliably determined. 
+class Brut::CLI::Terminal
+
+  def initialize
+    trap("WINCH") do
+      @winsize = IO.console.winsize
+    end
+  end
+
+  # Number of rows for the current terminal. Should be consistent even after a resize
+  def rows = winsize[0]
+  # Number of columns for the current terminal. Should be consistent even after a resize
+  def cols = winsize[1]
+
+  # The IO used for outputing information to the terminal. Prefer this over `STDOUT`.
+  def io    = $stdout
+
+  # The IO to use for requesting input from the user
+  def stdin = $stdin
+  
+  # Best attempt to guess the background color of the current terminal.
+  # This will not refresh if that color is changed, and its behavior will
+  # default to black if determining the color doesn't work or isn't supported.
+  def background_color
+    @bakground_color ||= begin
+                           io.write "\e]11;?\a"
+                           io.flush
+
+                           result = nil
+
+                           begin
+                             # Read the reply, which should look like:
+                             #   ESC ] 11 ; rgb:0000/0000/0000 BEL
+                             Timeout.timeout(0.1) do
+                               buf = +""
+                               loop do
+                                 ch = stdin.getch
+                                 buf << ch
+                                 break if ch == "\a" || buf.end_with?("\e\\") # BEL or ST terminator
+                               end
+                               result = buf
+                             end
+                           rescue Timeout::Error
+                             # no reply within 100ms — terminal probably doesn’t support it
+                           end
+
+                           rgb = [ 0, 0, 0 ]
+                           if result
+                             if result =~ /\e\]11;([^ \a\e]*)[\a\e\\]/
+                               color = Regexp.last_match(1)
+                               parts = color[/rgb:(.*)/, 1]&.split("/")
+                               if parts
+
+                                 rgb = parts.map { it.to_i(16) / 0xffff.to_f * 256 }.map(&:to_i)
+                               end
+                             end
+                           end
+                           rgb
+                         end
+  end
+
+
+private
+
+  def winsize
+    @winsize ||= IO.console.winsize
+  end
+
+end

data/lib/brut/cli/terminal_theme.rb

@@ -0,0 +1,131 @@
+require "lipgloss"
+class Brut::CLI::TerminalTheme
+  def initialize(terminal:)
+    @terminal = terminal
+  end
+
+  def title
+    @title ||= Lipgloss::Style.new.bold(true).foreground(white_strong)
+  end
+  def header
+    @header ||= Lipgloss::Style.new.foreground(blue_strong).bold(true)
+  end
+  def subheader
+    @subheader ||= Lipgloss::Style.new.foreground(cyan_strong).italic(true)
+  end
+  def weak
+    @weak ||= Lipgloss::Style.new.faint(true)
+  end
+  def url
+    @url ||= Lipgloss::Style.new.underline(true).bold(true)
+  end
+  def code
+    @code ||= Lipgloss::Style.new.foreground(cyan_strong).bold(true)
+  end
+  def bullet(n)
+    @bullets ||= [
+      Lipgloss::Style.new.foreground(yellow_strong).margin_right(1).margin_left(2),
+      Lipgloss::Style.new.foreground(purple_strong).margin_right(1),
+      Lipgloss::Style.new.foreground(yellow_weak).margin_right(1),
+      Lipgloss::Style.new.foreground(purple_weak).margin_right(1),
+    ]
+    @bullets[n] || none
+  end
+
+  def none
+    @none ||= Lipgloss::Style.new
+  end
+
+  def success
+    @success ||= Lipgloss::Style.new.foreground(green_weak).bold(true)
+  end
+
+  def exception
+    @exception ||= Lipgloss::Style.new.foreground(red_weak)
+  end
+
+  def error
+    @error ||= Lipgloss::Style.new.foreground(red_strong).bold(true)
+  end
+
+  def warning
+    @warning ||= Lipgloss::Style.new.foreground(yellow_strong).bold(true)
+  end
+
+  def wrap(text, first_indent: true, indent:, max_width: nil, newline: "\n")
+    max_width ||= @terminal.cols
+    text_width = [ max_width, @terminal.cols ].min - newline.length
+    lines = []
+    text.split(/\s+/).each do |word|
+      current_line = lines.last
+      if current_line.nil?
+        lines << []
+        current_line = lines.last
+      end
+      if (current_line.join(" ").length + word.length + 1) > (text_width - indent)
+        lines << [ word ]
+      else
+        current_line << word
+      end
+    end
+    prefix = " " * indent
+    lines.map.with_index { |line,index|
+      if index == 0 && !first_indent
+        line.join(" ")
+      else
+        prefix + line.join(" ")
+      end
+    }.join(newline)
+  end
+
+private
+
+  def black_weak
+    @black_weak ||= Lipgloss::AdaptiveColor.new(light: "#6e6e6e", dark: "#3a3a3a")
+  end
+  def black_strong
+    @black_strong ||= Lipgloss::AdaptiveColor.new(light: "#000000", dark: "#5a5a5a")
+  end
+  def red_weak
+    @red_weak ||= Lipgloss::AdaptiveColor.new(light: "#a31515", dark: "#d16969")
+  end
+  def red_strong
+    @red_strong ||= Lipgloss::AdaptiveColor.new(light: "#d40000", dark: "#f44747")
+  end
+  def green_weak
+    @green_weak ||= Lipgloss::AdaptiveColor.new(light: "#2b6a2b", dark: "#6a9955")
+  end
+  def green_strong
+    @green_strong ||= Lipgloss::AdaptiveColor.new(light: "#007f00", dark: "#89d185")
+  end
+  def yellow_weak
+    @yellow_weak ||= Lipgloss::AdaptiveColor.new(light: "#8a6d1d", dark: "#d7ba7d")
+  end
+  def yellow_strong
+    @yellow_strong ||= Lipgloss::AdaptiveColor.new(light: "#b58900", dark: "#ffcc66")
+  end
+  def blue_weak
+    @blue_weak ||= Lipgloss::AdaptiveColor.new(light: "#005f87", dark: "#569cd6")
+  end
+  def blue_strong
+    @blue_strong ||= Lipgloss::AdaptiveColor.new(light: "#0047ab", dark: "#4fc1ff")
+  end
+  def purple_weak
+    @purple_weak ||= Lipgloss::AdaptiveColor.new(light: "#6f42c1", dark: "#c586c0")
+  end
+  def purple_strong
+    @purple_strong ||= Lipgloss::AdaptiveColor.new(light: "#5a2ca0", dark: "#d670d6")
+  end
+  def cyan_weak
+    @cyan_weak ||= Lipgloss::AdaptiveColor.new(light: "#006f6f", dark: "#4ec9b0")
+  end
+  def cyan_strong
+    @cyan_strong ||= Lipgloss::AdaptiveColor.new(light: "#007acc", dark: "#2dd4bf")
+  end
+  def white_weak
+    @white_weak ||= Lipgloss::AdaptiveColor.new(light: "#ffffff", dark: "#cfcfcf")
+  end
+  def white_strong
+    @white_strong ||= Lipgloss::AdaptiveColor.new(light: "#f0f0f0", dark: "#ffffff")
+  end
+end

data/lib/brut/cli.rb

@@ -16,14 +16,18 @@ module Brut
     autoload(:ParsedCommandLine, "brut/cli/parsed_command_line")
     autoload(:Runner, "brut/cli/runner")
     autoload(:SystemExecError, "brut/cli/error")
+    autoload(:Terminal, "brut/cli/terminal")
+    autoload(:TerminalTheme, "brut/cli/terminal_theme")
+    autoload(:Logger, "brut/cli/logger")
 
     # Holds Brut-provided CLI apps that are set up in your project.
     module Apps
-      autoload(:DB,"brut/cli/apps/db")
-      autoload(:Test,"brut/cli/apps/test")
       autoload(:BuildAssets,"brut/cli/apps/build_assets")
+      autoload(:DB,"brut/cli/apps/db")
+      autoload(:Deploy,"brut/cli/apps/deploy")
+      autoload(:New,"brut/cli/apps/new")
       autoload(:Scaffold,"brut/cli/apps/scaffold")
-      autoload(:DeployBase,"brut/cli/apps/deploy_base")
+      autoload(:Test,"brut/cli/apps/test")
     end
   end
 end

data/lib/brut/framework/mcp.rb

@@ -358,7 +358,7 @@ private
     semantic_logger_appenders.each do |appender|
       SemanticLogger.add_appender(**appender)
     end
-    SemanticLogger["Brut"].info("Logging set up")
+    SemanticLogger[self.class].debug("Logging set up")
   end
 
   def setup_i18n
@@ -394,10 +394,10 @@ private
       "db" => "DB"
     )
     if Brut.container.auto_reload_classes?
-      SemanticLogger["Brut"].info("Auto-reloaded configured")
+      SemanticLogger[self.class].debug("Auto-reloaded configured")
       @loader.enable_reloading
     else
-      SemanticLogger["Brut"].info("Classes will not be auto-reloaded")
+      SemanticLogger[self.class].info("Classes will not be auto-reloaded")
     end
 
     @loader.setup
@@ -424,6 +424,7 @@ private
 
   def boot_otel!
     OpenTelemetry::SDK.configure do |c|
+      c.logger = SemanticLogger["OpenTelemetry"]
       c.service_name = @app.id
       if ENV["OTEL_TRACES_EXPORTER"]
         SemanticLogger[self.class].info "OTEL_TRACES_EXPORTER was set (to '#{ENV['OTEL_TRACES_EXPORTER']}'), so Brut's OTel logging is disabled"

data/lib/brut/front_end/asset_metadata.rb

@@ -5,20 +5,24 @@ class Brut::FrontEnd::AssetMetadata
 
   # @param [String] asset_metadata_file to the asset metadata file
   # @param [IO] out IO on which to write messaging
-  def initialize(asset_metadata_file:,out:$stdout)
+  def initialize(asset_metadata_file:,logger: :use_default)
     @asset_metadata_file = asset_metadata_file
-    @out = out
+    @logger = if logger == :use_default
+                SemanticLogger[self.class]
+              else
+                logger
+              end
     @asset_metadata = nil
   end
 
   def merge!(extension:,esbuild_metafile:)
-    @out.puts "Parsing metafile '#{esbuild_metafile}'"
+    @logger.debug "Parsing metafile '#{esbuild_metafile}'"
     esbuild_metafile = ESBuildMetafile.new(metafile:esbuild_metafile)
     metadata = esbuild_metafile.parse(extension:)
     begin
       self.load!
     rescue Errno::ENOENT
-      @out.puts "'#{@asset_metadata_file}' does not exist - creating it"
+      @logger.debug "'#{@asset_metadata_file}' does not exist - creating it"
       @asset_metadata = {}
     end
     existing_metadata = @asset_metadata[extension] || {}
@@ -48,7 +52,7 @@ class Brut::FrontEnd::AssetMetadata
   end
 
   def save!
-    @out.puts "Writing updated asset metadata file '#{@asset_metadata_file}'"
+    @logger.info "Writing updated asset metadata file '#{@asset_metadata_file}'"
     File.open(@asset_metadata_file,"w") do |file|
       file.puts({ "asset_metadata" => @asset_metadata }.to_json)
     end

data/lib/brut/spec_support/cli_command_support.rb

@@ -30,16 +30,22 @@ module Brut::SpecSupport::CLICommandSupport
     stdin: StringIO.new,
     stdout: StringIO.new,
     stderr: StringIO.new,
-    executor: :default
+    executor: :default,
+    logger: :default
   )
+    logger = if logger == :default
+               Brut::CLI::Logger.new(app_name: $0, stdout:, stderr:)
+             else
+               logger
+             end
     Brut::CLI::Commands::ExecutionContext.new(
       argv:,
       options: Brut::CLI::Options.new({ "log-level": "error" }.merge(options)),
-      env:,
+      env: { "NO_COLOR" => "1" }.merge(env),
       stdin:,
       stdout:,
       stderr:,
-      executor: executor == :default ? CapturingExecutor.new(out: stdout, err: stderr) : executor,
+      executor: executor == :default ? CapturingExecutor.new(out: stdout, err: stderr, logger:) : executor,
     )
   end
 end

data/lib/brut/spec_support/e2e_test_server.rb

@@ -26,8 +26,8 @@ class Brut::SpecSupport::E2ETestServer
       logger.warn "Server is already running on pid '#{@pid}'"
       return
     end
+    command = "#{@bin_dir}/test-server"
     Bundler.with_unbundled_env do
-      command = "#{@bin_dir}/test-server"
       logger.info "Starting test server via '#{command}'"
       @pid = Process.spawn(
         command,
@@ -39,7 +39,7 @@ class Brut::SpecSupport::E2ETestServer
     if is_port_open?("0.0.0.0",6503)
       logger.info "Server is listening for requests on port 6503"
     else
-      raise "Problem: server never started"
+      raise "Problem: test server never started - noting listening on port 6503 after starting with pid '#{@pid}'"
     end
   end
 
@@ -79,8 +79,8 @@ private
             sleep(0.1)
           end
         end
-      rescue Timeout::Error
       end
+    rescue Timeout::Error
       false
     end
   end

data/lib/brut/tui/script.rb

@@ -2,7 +2,7 @@ require "logger"
 require "fileutils"
 
 # A TUI script is a set of steps that are executed in order.  Steps
-# can be grouped int phases, and each step can either shell out
+# can be grouped into phases, and each step can either shell out
 # to an external command or execute Ruby code.
 #
 # You are intended to subclass this class and implement `#execute`, which can use

data/lib/brut/version.rb

@@ -1,4 +1,4 @@
 module Brut
   # @!visibility private
-  VERSION = "0.18.2"
+  VERSION = "0.19.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: brut
 version: !ruby/object:Gem::Version
-  version: 0.18.2
+  version: 0.19.0
 platform: ruby
 authors:
 - David Bryant Copeland
@@ -65,6 +65,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: lipgloss
+  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: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -493,8 +507,6 @@ files:
 - lib/brut/cli/apps/build_assets.rb
 - lib/brut/cli/apps/db.rb
 - lib/brut/cli/apps/deploy.rb
-- lib/brut/cli/apps/deploy_base.rb
-- lib/brut/cli/apps/heroku_container_based_deploy.rb
 - lib/brut/cli/apps/new.rb
 - lib/brut/cli/apps/new/add_segment.rb
 - lib/brut/cli/apps/new/add_segment_options.rb
@@ -541,10 +553,13 @@ files:
 - lib/brut/cli/error.rb
 - lib/brut/cli/execute_result.rb
 - lib/brut/cli/executor.rb
+- lib/brut/cli/logger.rb
 - lib/brut/cli/options.rb
 - lib/brut/cli/output.rb
 - lib/brut/cli/parsed_command_line.rb
 - lib/brut/cli/runner.rb
+- lib/brut/cli/terminal.rb
+- lib/brut/cli/terminal_theme.rb
 - lib/brut/factory_bot.rb
 - lib/brut/framework.rb
 - lib/brut/framework/app.rb
@@ -802,7 +817,6 @@ files:
 - templates/segments/Demo/specs/front_end/pages/guestbook_page.spec.rb
 - templates/segments/Demo/specs/front_end/pages/guestbook_page/message_component.spec.rb
 - templates/segments/Demo/specs/front_end/pages/new_guestbook_message_page.spec.rb
-- templates/segments/Heroku/bin/deploy
 - templates/segments/Heroku/deploy/Dockerfile
 - templates/segments/Heroku/deploy/docker-entrypoint
 - templates/segments/Heroku/deploy/docker_config.rb