brut 0.16.0 → 0.18.0

data/lib/brut/tui/terminal_theme.rb

@@ -0,0 +1,144 @@
+# A terminal theme is a set of semantic styles for the terminal that
+# map to actual colors or styles based on the terminal's metadata or
+# the user's preferences or both.
+#
+# This class is coupled to the behavior of ANSI escape
+# codes in the terminal, in that they aren't markup, but more
+# like drawing with a pen.
+
+# That said, this class' API does abstract from the codes
+# themselves and creates a semantic layer, for example
+# the definition of "succes" or "weak".
+
+# For subclass implementors, there are various private
+# methods that do encapsulate the ANSI escape codes, and these
+# can be used or overridden.
+#
+# This particular implementation avoids the use of black or white, and uses
+# the normal ANSI colors.  This should, in theory, work with any terminal
+# theme where all colors are legible on the chosen background.
+class Brut::TUI::TerminalTheme
+
+  def self.based_on_background(terminal)
+    if dark_background?(terminal)
+      Brut::TUI::Themes::Dark.new
+    else
+      Brut::TUI::Themes::Light.new
+    end
+  end
+
+  def self.dark_background?(terminal)
+    r, g, b = terminal.background_color.map { it / 255.0 }
+    luminance = (0.21 * r) + (0.72 * g) + (0.07 * b)
+
+    return luminance < 0.5  
+  end
+
+  # Returns a string with its markup turned into escape codes.
+  # Note that due to the way ANSI escape codes work, the state
+  # of the terminal may not be in the same state you found it.
+  #
+  # This method tries to turn features on and off (e.g. after a bold
+  # string, the codes to turn off bold are applied), but if a subclass
+  # mixes colors and styles, any text output after this one may
+  # not look like the text before it.
+  def with_markup(string, text: :normal, reset: true)
+    result = +""
+    regular_text_code = if self.respond_to?(text)
+                          send(text)
+                        else
+                          self.normal
+                        end
+    result << regular_text_code
+    Brut::TUI::MarkupString.from_string(string).parse do |directive, value|
+      case directive
+      in :start
+        case value
+        in :bold
+          result << bold
+        in :strike
+          result << strike
+        in :code
+          result << code
+        in :weak
+          result << weak
+        end
+      in :stop
+        case value
+        in :bold
+          result << bold_off
+        in :strike
+          result << strike_off
+        in :code
+          result << code_off
+        in :weak
+          result << weak_off
+        end
+        if regular_text_code != normal
+          result << regular_text_code
+        end
+      in :text
+        result << value
+      end
+    end
+    if reset
+      result << self.reset
+    end
+    result
+  end
+
+  def success = bold + bright_green
+  def error   = bold + bright_red
+  def warning = bold + yellow
+
+  def bold     = esc("1")
+  def bold_off = normal
+
+  def bright     = esc("1")
+  def bright_off = normal
+
+  def italic     = esc("3")
+  def italic_off = esc("23")
+
+  def strike     = esc("9")
+  def strike_off = esc("29")
+
+  def weak     = esc("2")
+  def weak_off = normal
+
+  def code     = underline
+  def code_off = underline_off
+
+  def normal = esc("22")
+
+  def reset = esc("0")
+
+  def heading = bold + underline + bright_blue
+
+private
+
+  def underline     = esc("4")
+  def underline_off = esc("24")
+
+  def black   = esc("30")
+  def red     = esc("31")
+  def green   = esc("32")
+  def yellow  = esc("33")
+  def blue    = esc("34")
+  def magenta = esc("35")
+  def cyan    = esc("36")
+  def white   = esc("37")
+
+  def bright_black   = esc("90")
+  def bright_red     = esc("91")
+  def bright_green   = esc("92")
+  def bright_yellow  = esc("93")
+  def bright_blue    = esc("94")
+  def bright_magenta = esc("95")
+  def bright_cyan    = esc("96")
+  def bright_white   = esc("97")
+
+  def esc(code)
+    "\e[#{code}m"
+  end
+end

data/lib/brut/tui/themes/dark.rb

@@ -0,0 +1,14 @@
+# A theme designed to work on a dark background terminal.
+class Brut::TUI::Themes::Dark < Brut::TUI::TerminalTheme
+  def black         = esc("38;2;96;96;96")
+  def bright_black  = esc("38;2;128;128;128")
+  def white         = esc("38;2;233;233;233")
+  def bright_white  = esc("38;2;255;255;255")
+  def yellow        = esc("38;2;191;191;0")
+  def bright_yellow = esc("38;2;255;255;0")
+  def normal        = super + white
+  def code          = esc("38;2;0;255;0")
+  def code_off      = normal
+  def bright        = bright_white
+  def bright_off    = normal
+end

data/lib/brut/tui/themes/light.rb

@@ -0,0 +1,17 @@
+# A theme designed to work on a white background terminal.
+class Brut::TUI::Themes::Light < Brut::TUI::TerminalTheme
+  def black         = esc("38;2;0;0;0")
+  def bright_black  = esc("38;2;64;64;64")
+  def bright_white  = esc("38;2;128;128;128")
+  def white         = esc("38;2;191;191;191")
+  def yellow        = esc("38;2;191;191;0")
+  def bright_yellow = esc("38;2;255;255;0")
+  def normal        = super + black
+  def code          = esc("38;2;0;128;0")
+  def code_off      = normal
+  def green         = esc("38;2;25;105;0")
+  def bright_green  = esc("38;2;34;155;0")
+  def bright        = bright_blue
+  def bright_off    = normal
+end
+

data/lib/brut/tui/themes/none.rb

@@ -0,0 +1,9 @@
+# A theme without any ANSI styling at all.  This is suitable
+# for showing to a user who does not want any colors or styles, but
+# still wants to see output in a somewhat conventional way.
+class Brut::TUI::Themes::None < Brut::TUI::TerminalTheme
+  def esc(*) = ""
+end
+
+
+

data/lib/brut/tui/themes.rb

@@ -0,0 +1,5 @@
+module Brut::TUI::Themes
+  autoload(:Light , "brut/tui/themes/light")
+  autoload(:Dark  , "brut/tui/themes/dark")
+  autoload(:None  , "brut/tui/themes/none")
+end

data/lib/brut/tui.rb

@@ -0,0 +1,15 @@
+module Brut
+  # Brut provides a basic API for creating rich text user interfaces. Currently, Brut
+  # provides {Brut::TUI::Script} to create more user-friendly scripts like `bin/setup` or
+  # `bin/ci`.
+  module TUI
+    autoload(:EventLoop, "brut/tui/event_loop")
+    autoload(:Events, "brut/tui/events")
+    autoload(:AnsiEscapeCode, "brut/tui/ansi_escape_code")
+    autoload(:Script, "brut/tui/script")
+    autoload(:Terminal, "brut/tui/terminal")
+    autoload(:TerminalTheme, "brut/tui/terminal_theme")
+    autoload(:Themes, "brut/tui/themes")
+    autoload(:MarkupString, "brut/tui/markup_string")
+  end
+end

data/lib/brut/version.rb

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

data/lib/brut.rb

@@ -16,5 +16,6 @@ module Brut
   autoload(:Instrumentation,"brut/instrumentation")
   autoload(:SinatraHelpers, "brut/sinatra_helpers")
   # DO NOT autoload(:CLI) - that is intended to be require-able on its own
+  # DO NOT autoload(:TUI) - that is intended to be require-able on its own
 end
 require "sequel/plugins"

data/templates/Base/.env.development.local

@@ -0,0 +1,2 @@
+# Place developer-specific overrides of .env.development in here, 
+# e.g. API keys needed for local dev. DO NOT CHECK INTO VERSION CONTROL

data/templates/Base/bin/ci

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+
+require "optparse"
+require "pathname"
+
+require "brut/tui"
+
+ROOT_DIR = ((Pathname(__dir__) / ".." ).expand_path)
+
+class CIScript < Brut::TUI::Script
+  def execute
+    phase "Preparing environment" do
+      step "Building Assets",
+           exec: "brut build-assets"
+    end
+
+    phase "Running tests" do
+      step "Running non E2E tests",
+           exec: "brut test run --rebuild",
+           stdout: true
+
+      step "Running JS tests",
+           exec: "brut test js",
+           stdout: true
+
+      step "Running E2E tests",
+           exec: "brut test e2e --rebuild --rebuild-after",
+           stdout: true
+    end
+
+    phase "Performing code and security audits" do
+      step "Analyzing Ruby gems for security vulnerabilities",
+           exec: "bundle exec bundle audit check --update"
+
+      step "Checking to see that all classes have tests",
+           exec: "brut test audit "
+    end
+    done "All quality and auditing checks complete"
+  end
+end
+
+exit CIScript.new(root_dir: ROOT_DIR).run!

data/{mkbrut/templates → templates}/Base/bin/release

@@ -17,9 +17,9 @@ done
 
 echo "[ bin/release ] started"
 echo "[ bin/release ] Creating DB if needed"
-BRUT_CLI_RAISE_ON_ERROR=true bundle exec ./bin/db create --env=production
+BRUT_CLI_RAISE_ON_ERROR=true bundle exec brut db create --env=production
 echo "[ bin/release ] Migrating DB if needed"
-BRUT_CLI_RAISE_ON_ERROR=true bundle exec ./bin/db migrate --env=production
+BRUT_CLI_RAISE_ON_ERROR=true bundle exec burt db migrate --env=production
 
 # Add additional commands here as needed
 

data/templates/Base/bin/setup

@@ -0,0 +1,174 @@
+#!/usr/bin/env ruby
+
+require "optparse"
+require "pathname"
+
+begin
+  require "brut"
+  require "brut/tui"
+rescue LoadError
+  if ARGV.include?("--no-bundle-install")
+    raise
+  end
+  puts "Brut is not yet installed - Running `bundle install` to install it"
+  if system "bundle install --no-color"
+    puts "Bundle installed, re-running"
+    args = ARGV.dup
+    args << "--no-bundle-install"
+    exec $0, *args
+  else
+    $stderr.puts "bundle install failed - something is more deeply wrong."
+    $stderr.puts "try running `bundle install` from the command line and re-run this if it works."
+    exit 1
+  end
+end
+
+ROOT_DIR = ((Pathname(__dir__) / ".." ).expand_path)
+
+class SetupScript < Brut::TUI::Script
+  def execute
+    phase "Installing dependencies" do
+      step "Installing gems", exec: "bundle check --no-color || bundle install --no-color --quiet"
+
+      step "Installing puma binstubs",    exec: "bundle binstub puma"
+      step "Installing rspec binstubs",   exec: "bundle binstub rspec-core"
+
+      # https://github.com/ddollar/foreman/wiki/Don't-Bundle-Foreman
+      step "Installing foreman", exec: "gem install foreman"
+
+      step "Installing Ruby LSP", exec: "gem install ruby-lsp"
+
+      step "Installing Node Modules", exec: "npm install"
+
+      step "Re-installing playwright/chromium _if needed_", exec: "node_modules/.bin/playwright install chromium"
+    end
+
+    phase "Setting up local development configuration" do
+
+      dot_env = ROOT_DIR / ".env.development"
+      if !File.exist?(dot_env)
+        raise "Problem: '#{dot_env}' does not exist"
+      end
+
+      dot_env_need_local = {}
+      step "Parsing #{filename(dot_env)} for required local overrides" do
+        previous_comment = ""
+        File.read(dot_env).split(/\n/).each do |line|
+          if line =~ /^#(.*)$/
+            previous_comment << line
+          elsif line =~ /^LOCAL:([^=]+)$/
+            dot_env_need_local[$1] = previous_comment
+            previous_comment = ""
+          elsif line =~ /^([^=])+/
+            previous_comment = ""
+          end
+        end
+      end
+      dot_env_local = ROOT_DIR / ".env.development.local"
+      local_contents = step "Ensuring #{filename(dot_env_local)} exists" do
+        if !File.exist?(dot_env_local)
+          notify "Creating #{filename(dot_env_local)}"
+          FileUtils.touch dot_env_local
+        end
+        local_contents = File.read(dot_env_local).split(/\n/).map { |line|
+          if line =~ /^([^=]+)=(.*)$/
+            var = $1
+            val = $2
+            if dot_env_need_local[var] && val.to_s != ""
+              notify "Value for '#{var}' is good"
+              dot_env_need_local.delete(var)
+            end
+          end
+          line
+        }.compact
+      end
+
+      if dot_env_need_local.any?
+        step "Need local values" do
+          dot_env_need_local.each do |var,comment|
+            notify "A value is needed locally for '#{var}'"
+            notify ""
+            notify comment
+            notify ""
+            notify "Enter the value below and hit Return"
+            value = gets
+            local_contents << "#{var}=#{value}"
+            notify "Got it, thanks"
+          end
+        end
+      end
+
+      step "Updating #{filename(dot_env_local)}" do
+        File.open(dot_env_local,"w") do |file|
+          local_contents.each do |line|
+            file.puts line
+          end
+        end
+      end
+
+
+      step "Checking that #{filename(dot_env_local)} is being ignored" do
+        gitignore = ROOT_DIR / ".gitignore"
+        if File.exist?(gitignore)
+          lines = File.read(gitignore).split(/\n/)
+          if lines.include?("/#{dot_env_local.basename}")
+            success "#{filename(dot_env_local)} is properly being ignored"
+          else
+            notify "Adding #{filename(dot_env_local)} to .gitignore"
+            lines << ""
+            lines << "# This contains actual secrets and should not be checked in"
+            lines << "/#{dot_env_local.basename}"
+            File.open(gitignore,"w") do |file|
+              lines.each do |line|
+                file.puts line
+              end
+            end
+          end
+        else
+          warning "No #{gitignore}, so make sure you DO NOT CHECK #{filename(dot_env_local)} IN!!!"
+        end
+      end
+    end
+    phase "Setting up databases" do
+
+      step "Re-creating development database", exec: "brut db rebuild --env=development"
+      step "Re-creating test database",        exec: "brut db rebuild --env=test"
+
+      step "Loading seed data into the development database",
+        exec: "brut db seed --env=development"
+    end
+    done "Setup complete - Run `bin/setup help` to see useful commands"
+  end
+end
+
+def show_help
+  puts "Useful commands:"
+  puts ""
+  puts "  bin/run"
+  puts "     # run app locally"
+  puts ""
+  puts "  bin/ci"
+  puts "     # runs all tests and checks as CI would"
+  puts ""
+  puts "  bin/setup help"
+  puts "     # show this help"
+  puts ""
+end
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: bin/setup [help]"
+  opts.on("--no-bundle-install", "Do not attempt to run bundle install if Brut is missing") do
+  end
+  opts.on("-h", "--help", "Show help") do
+    puts opts
+    puts
+    show_help
+    exit
+  end
+end.parse!
+
+if ARGV[0] == "help"
+  show_help
+else
+  exit SetupScript.new(root_dir: ROOT_DIR, ansi: (ENV["NO_COLOR"] || "").empty? ).run!
+end

data/{mkbrut/templates → templates}/Base/bin/watch-and-build-assets

@@ -31,7 +31,7 @@ done
 
 asset_type=$1
 watch_dir="app/src/front_end/${asset_type}/**/*"
-build_command="bin/build-assets ${asset_type}"
+build_command="brut build-assets ${asset_type}"
 
 export SHELL # chokidar needs this for reasons unknown to me
 exec npx chokidar --initial --polling --command "${build_command}" "${watch_dir}"

data/{mkbrut/templates → templates}/Base/dx/docker-compose.env.erb

@@ -5,7 +5,7 @@
 # your app. The recommended format is ORG/REPO:TAG
 #
 # The ORG and REPO are based on the values used
-# with mkbrut.  TAG is set to mimic the value
+# with brut.  TAG is set to mimic the value
 # in the FROM directive of the Dockerfile.
 # This will allow you to upgrade Ruby and run both
 # versions more easily.

data/{mkbrut/templates → templates}/segments/Demo/app/src/front_end/css/fonts.css

@@ -1,7 +1,7 @@
 /* Example of font-management. */
 @font-face {
   font-family: "Monaspace Xenon";
-  /** url is relative to this file. When bin/build-assets runs,
+  /** url is relative to this file. When brut build-assets runs,
    * esbuild will see this and modify it to work with the bundle
    * that is ultimately produced */
   src: url("../fonts/monaspace-xenon.ttf") format("truetype");

data/{mkbrut/templates → templates}/segments/Heroku/deploy/Dockerfile

@@ -14,7 +14,7 @@
 #     the app work or to pre-generate assets is set up here as well.
 #     You are advised to make that setup identical.
 #
-# You can test this locally but using the `--plaform` flag to `bin/deploy deploy`
+# You can test this locally but using the `--platform` flag to `brut deploy deploy`
 # and running a container locally.  You'll need all infrastructure available
 # but it can be done to test things before you deploy. If you need to.
 
@@ -103,7 +103,7 @@ RUN npm clean-install --no-audit --no-fund --verbose
 COPY . .
 
 # Build all assets
-RUN bin/build-assets && \
+RUN brut build-assets && \
     rm -rf node_modules
 
 # We are now switching back to building the image that will be deployed.

data/templates/segments/Heroku/deploy/docker_config.rb

@@ -0,0 +1,30 @@
+# This contains settings for your production Docker setup.
+# You own and maintain this file.  It is `require`d by brut deploy docker
+class DockerConfig
+
+  # Can return a Docker platform is your deployment platform is not
+  # linux/amd64. Note that --platform will override this value.
+  def platform = nil
+
+  # Return a Hash of additional images to run, beyond "web" and "release".
+  #
+  # The format of this Hash is:
+  #
+  # {
+  #   *image name* => {
+  #     cmd: *command line for Dockerfile RUN directive*,
+  #   }
+  # }
+  #
+  # For example, if you have the Sidekiq segment installed, `bin/run sidekiq`
+  # runs Sidekiq, so you would return this hash:
+  #
+  # {
+  #   "sidekiq" => {
+  #     cmd: "bin/run sidekiq",
+  #   }
+  # }
+  #
+  def additional_images
+  end
+end