brut 0.5.0 → 0.8.0

data/mkbrut/templates/Base/app/src/front_end/pages/home_page.rb

@@ -0,0 +1,62 @@
+class HomePage < AppPage
+  def page_template
+    # The duplication and excessive class sizes here are to
+    # make it easier for you to remove this when you start working
+    # on your app.  There are pros and cons to how this code
+    # is written, so don't take this is as a directive on how to
+    # build your app. You do you!
+    img(src: "/static/images/LogoPylon.png",
+        class: "dn db-ns pos-fixed top-0 left-0 h-100vh w-auto z-2")
+  
+    header(class: "flex flex-column items-center justify-center h-100vh") do
+      div(class: "flex flex-column flex-row-ns items-center justify-center gap-3") do
+        img(src: "/static/images/LogoTransit.png", class: "h-5")
+        div do
+          h1(class: "ff-sans ma-0 lh-title f-5 tc tl-ns flex flex-column flex-row-ns items-center gap-2") do
+            plain("Welcome to Brut")
+          end
+          h2(class: "ff-sans ma-0 lh-title f-3 fw-normal tc tl-ns") do
+            plain("v")
+            plain(Gem.loaded_specs["brut"].version.to_s)
+          end
+
+        end
+      end
+          nav(class: [ "ff-sans",
+                       "flex",
+                       "flex-column",
+                       "flex-row-ns",
+                       "items-center",
+                       "justify-start",
+                       "gap-3",
+                       "mt-3",
+          ]) do
+            a(href: "https://brutrb.com",
+              target: "_blank",
+              class: "f-3 red-300 tdu tdn-ns hover-tdu-ns"
+             ) do
+               code { "brutrb.com" }
+             end
+             span(role: "separator", class: "dn di-ns f-3 red-300") do
+                raw(safe "&#x2299;")
+             end
+             a(href: "https://brutrb.com/api/index.html",
+               target: "_blank",
+               class: "f-3 red-300 tdu tdn-ns hover-tdu-ns"
+              ) do
+                "API Docs"
+              end
+              span(role: "separator", class: "dn di-ns f-3 red-300") do
+                raw(safe "&#x2299;")
+              end
+              a(href: "http://localhost:6504",
+                target: "_blank",
+                class: "f-3 red-300 tdu tdn-ns hover-tdu-ns"
+               ) do
+                 "Local OpenTelemetry"
+               end
+          end
+    end
+    
+  end
+end

data/mkbrut/templates/Base/app/src/front_end/support/app_session.rb

@@ -0,0 +1,6 @@
+# Reprensetation of the session your app uses.
+# This is intended to provide a rich API
+# to whatever is in the sesion, so your app
+# is not dealing with a Hash of Whatever.
+class AppSession < Brut::FrontEnd::Session
+end

data/mkbrut/templates/Base/app/src/front_end/svgs/README.md

@@ -0,0 +1,5 @@
+The SVG here is public domain, as documented here:
+
+https://commons.wikimedia.org/wiki/File:Comment_button.svg
+
+

data/mkbrut/templates/Base/app/src/front_end/svgs/comment-button.svg

@@ -0,0 +1,59 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+   xmlns:dc="http://purl.org/dc/elements/1.1/"
+   xmlns:cc="http://creativecommons.org/ns#"
+   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+   xmlns:svg="http://www.w3.org/2000/svg"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   aria-label="Comment"
+   class="_8-yf5 "
+   fill="#262626"
+   height="24"
+   viewBox="0 0 48 48"
+   width="24"
+   version="1.1"
+   id="svg22"
+   sodipodi:docname="comment button.svg"
+   inkscape:version="0.92.4 (5da689c313, 2019-01-14)">
+  <metadata
+     id="metadata28">
+    <rdf:RDF>
+      <cc:Work
+         rdf:about="">
+        <dc:format>image/svg+xml</dc:format>
+        <dc:type
+           rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
+        <dc:title></dc:title>
+      </cc:Work>
+    </rdf:RDF>
+  </metadata>
+  <defs
+     id="defs26" />
+  <sodipodi:namedview
+     pagecolor="#ffffff"
+     bordercolor="#666666"
+     borderopacity="1"
+     objecttolerance="10"
+     gridtolerance="10"
+     guidetolerance="10"
+     inkscape:pageopacity="0"
+     inkscape:pageshadow="2"
+     inkscape:window-width="1920"
+     inkscape:window-height="1001"
+     id="namedview24"
+     showgrid="false"
+     inkscape:zoom="23.805928"
+     inkscape:cx="12.634482"
+     inkscape:cy="10.463496"
+     inkscape:window-x="-9"
+     inkscape:window-y="-9"
+     inkscape:window-maximized="1"
+     inkscape:current-layer="svg22" />
+  <path
+     d="M47.5 46.1l-2.8-11c1.8-3.3 2.8-7.1 2.8-11.1C47.5 11 37 .5 24 .5S.5 11 .5 24 11 47.5 24 47.5c4 0 7.8-1 11.1-2.8l11 2.8c.8.2 1.6-.6 1.4-1.4zm-3-22.1c0 4-1 7-2.6 10-.2.4-.3.9-.2 1.4l2.1 8.4-8.3-2.1c-.5-.1-1-.1-1.4.2-1.8 1-5.2 2.6-10 2.6-11.4 0-20.6-9.2-20.6-20.5S12.7 3.5 24 3.5 44.5 12.7 44.5 24z"
+     id="path20"
+     clip-rule="evenodd"
+     fill-rule="evenodd" />
+</svg>

data/mkbrut/templates/Base/bin/README.md.erb

@@ -0,0 +1,5 @@
+# Foundation Scripts
+
+`bin/` is where scripts for maintaining the app go.  This includes scripts managed by Brut as well as any scripts you may create for yourself.
+
+

data/mkbrut/templates/Base/bin/build-assets

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler"
+Bundler.require
+require "pathname"
+require "brut/cli/apps/build_assets"
+exit Brut::CLI.app(Brut::CLI::Apps::BuildAssets,project_root: Pathname($0).dirname / "..")

data/mkbrut/templates/Base/bin/ci

@@ -0,0 +1,39 @@
+#!/usr/bin/env bash
+
+set -e
+
+usage() {
+  echo "Usage: $0"
+  echo
+  echo "    Run all tests and quality checks, as if on a CI server"
+  echo
+}
+
+for arg in "$@"; do
+  if [ "${arg}" = "-h" ] || [ "${arg}" = "--help" ] || [ "${arg}" = "help" ]; then
+    usage
+    exit 0
+  fi
+done
+
+
+echo "[ bin/ci ] Building Assets"
+bin/build-assets
+
+echo "[ bin/ci ] Running non E2E tests"
+bin/test run --rebuild
+
+echo "[ bin/ci ] Running JS tests"
+bin/test js
+
+echo "[ bin/ci ] Running E2E tests"
+bin/test e2e --rebuild --rebuild-after
+
+echo "[ bin/ci ] Analyzing Ruby gems for"
+echo "[ bin/ci ] security vulnerabilities"
+bundle exec bundle audit check --update
+
+echo "[ bin/ci ] Checking to see that all classes have tests"
+bin/test audit --ignore app/src/front_end/components/custom_element_registration.rb 
+
+echo "[ bin/ci ] Done"

data/mkbrut/templates/Base/bin/console

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+
+require "optparse"
+
+option_parser = OptionParser.new do |opts|
+  opts.banner = "Usage: bin/console [options]\n\n    Get an IRB session with your app loaded in the development RACK_ENV\n\nOPTIONS"
+
+  opts.on("-h", "--help", "Display this help message") do
+    puts opts
+    exit
+  end
+end
+option_parser.parse!
+if ARGV[0] == "help"
+  puts option_parser
+  exit
+end
+
+ENV["RACK_ENV"] = "development"
+if ENV["LOG_LEVEL"].to_s == ""
+  ENV["LOG_LEVEL"] = "warn"
+end
+require "pathname"
+require "dotenv"
+
+project_root = Pathname(__dir__) / ".."
+Dotenv.load(project_root / ".env.development.local",
+            project_root / ".env.development")
+require_relative project_root / "app" / "bootstrap"
+Bootstrap.new.bootstrap!
+binding.irb

data/mkbrut/templates/Base/bin/db

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require "bundler"
+Bundler.require
+require "pathname"
+require "brut/cli/apps/db"
+
+exit Brut::CLI.app(Brut::CLI::Apps::DB,project_root: Pathname($0).dirname / "..")
+

data/mkbrut/templates/Base/bin/dbconsole

@@ -0,0 +1,51 @@
+#!/usr/bin/env bash
+
+set -e 
+SCRIPT_DIR=$( cd -- "$( dirname -- "${0}" )" > /dev/null 2>&1 && pwd )
+
+usage() {
+  echo "Usage: $0 -e env"
+  echo
+  echo "    Get a PostgreSQL console for the specified environment"
+  echo
+  echo "OPTIONS"
+  echo
+  echo "    env - 'test' or 'development' (default is 'development')"
+}
+for arg in "${@}"; do
+  if [ "${arg}" = "-h" ] || [ "${arg}" = "--help" ] || [ "${arg}" = "help" ]; then
+    usage
+    exit 0
+  fi
+done
+
+RACK_ENV=development
+while getopts ":e:" opt "${@}"; do
+  case ${opt} in
+    e )
+      RACK_ENV="${OPTARG}"
+      ;;
+    \? )
+      echo "[ $0 ] Unknown option: ${opt}"
+      usage
+      exit 1
+      ;;
+    : )
+      echo "[ $0 ] Invalid option: ${opt}"
+      exit 0
+      usage
+      ;;
+  esac
+done
+shift $((OPTIND -1))
+ENV_FILE="${SCRIPT_DIR}"/../".env.${RACK_ENV}"
+
+if [ -e "${ENV_FILE}" ]; then
+  database_url=$(grep DATABASE_URL "${ENV_FILE}" | sed 's/^[^=]*=//g')
+  psql "${database_url}"
+else
+  echo "[ $0 ] error: '${RACK_ENV}' is not a valid environment"
+  echo
+  usage
+  exit 1
+fi

data/mkbrut/templates/Base/bin/dev

@@ -0,0 +1,25 @@
+#!/bin/bash
+
+set -e 
+SCRIPT_DIR=$( cd -- "$( dirname -- "${0}" )" > /dev/null 2>&1 && pwd )
+ROOT_DIR="${SCRIPT_DIR}/.."
+
+usage() {
+  echo "Usage: $0"
+  echo
+  echo "    Run the app for local development, with asset and code reloading"
+  echo
+}
+
+for arg in "$@"; do
+  if [ "${arg}" = "-h" ] || [ "${arg}" = "--help" ] || [ "${arg}" = "help" ]; then
+    usage
+    exit 0
+  fi
+done
+
+RACK_ENV="development"
+export RACK_ENV
+"${SCRIPT_DIR}"/build-assets
+foreman start --procfile "${ROOT_DIR}/Procfile.${RACK_ENV}" --root "${ROOT_DIR}"
+

data/mkbrut/templates/Base/bin/release

@@ -0,0 +1,26 @@
+#!/bin/sh
+set -e
+
+usage() {
+  echo "Usage: $0"
+  echo
+  echo "    Run tasks on production after code is avaiable, but before deployment"
+  echo
+}
+
+for arg in "$@"; do
+  if [ "${arg}" = "-h" ] || [ "${arg}" = "--help" ] || [ "${arg}" = "help" ]; then
+    usage
+    exit 0
+  fi
+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
+echo "[ bin/release ] Migrating DB if needed"
+BRUT_CLI_RAISE_ON_ERROR=true bundle exec ./bin/db migrate --env=production
+
+# Add additional commands here as needed
+
+echo "[ bin/release ] DONE"

data/mkbrut/templates/Base/bin/run

@@ -0,0 +1,86 @@
+#!/bin/sh
+
+set -e 
+SCRIPT_DIR=$( cd -- "$( dirname -- "${0}" )" > /dev/null 2>&1 && pwd )
+
+usage() {
+  echo "Usage: $0"
+  echo
+  echo "    Run the app in the given RACK_ENV."
+  echo "    You likely want to use bin/dev instead of this command."
+  echo
+  echo "ENVIRONMENT VARIABLES"
+  echo
+  echo "   PORT     - The port to run the app on. Default is 6502"
+  echo "   RACK_ENV - The Rack environment to use. Default is development"
+  echo
+}
+
+for arg in "$@"; do
+  if [ "${arg}" = "-h" ] || [ "${arg}" = "--help" ] || [ "${arg}" = "help" ]; then
+    usage
+    exit 0
+  fi
+done
+
+PORT="${PORT:-6502}"
+RACK_ENV="${RACK_ENV:-development}"
+
+export PORT
+export RACK_ENV
+
+set -e 
+
+# Everything here is trying its best to prevent more than
+# one server from running, as this is extremely confusing.
+# Note that the puma invocation at the bottom
+# of this script uses the pidfile concept.
+if [ -f tmp/pidfile ]; then
+  echo "[ $0 ] pidfile found"
+  pid=$(cat tmp/pidfile)
+
+  # First, try to gracefully stop the server with kill
+  if ps -p "${pid}" > /dev/null; then
+    echo "[ $0 ] Attempting to kill PID '${pid}'"
+    kill "${pid}"
+  else
+    echo "[ $0 ] PID '${pid}' no longer running"
+  fi
+
+  # Now, wait 5 seconds to see if it stopped
+  if timeout 5 tail --pid="${pid}" -f /dev/null; then
+    echo "[ $0 ] PID '${pid}' stopped. Restarting server"
+  else
+    # if it has not stopeed, use kill -9 which should work.
+    # But, like all things computer, it's not guaranteed.
+    echo "[ $0 ] PID '${pid}' has not stopped. Trying kill -9"
+    kill -9 "${pid}"
+    if timeout 1 tail --pid="${pid}" -f /dev/null; then
+      echo "[ $0 ] PID '${pid}' killed. Restarting server"
+    else
+      echo "[ $0 ] PID '${pid}' still running. Something seriously wrong"
+      echo "[ $0 ] You may need to stop all Docker containers and restart them"
+      exit 1
+    fi
+  fi
+
+else
+  echo "[ $0 ] No pidfile-Starting up"
+fi
+
+# Run puma in a UNIX environment provided by dotenv.
+#
+# A few things to note:
+#
+# * dotenv is OK if -f is given non-existent files. That's why this works
+#   in production where there are no .env files.
+# * the `--` marks the end of dotenv's options and the start of the command
+#   to run. That's why the flags given to puma are not interpreted by dotenv
+#   as flags for itself.
+dotenv \
+  -f "${SCRIPT_DIR}/../.env.${RACK_ENV}.local,${SCRIPT_DIR}/../.env.${RACK_ENV}" \
+  --ignore \
+  -- \
+  bin/puma \
+    -C puma.config.rb \
+    --pid tmp/pidfile

data/mkbrut/templates/Base/bin/scaffold

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require "bundler"
+Bundler.require
+require "pathname"
+
+require "brut/cli/apps/scaffold"
+exit Brut::CLI.app(Brut::CLI::Apps::Scaffold,project_root: Pathname($0).dirname / "..")
+

data/mkbrut/templates/Base/bin/setup

@@ -0,0 +1,256 @@
+#!/usr/bin/env ruby
+
+
+require "fileutils"
+require "open3"
+require "optparse"
+require "pathname"
+
+# This is intended to run inside the Workspace (i.e. Docker container) to
+# set up the Foundation, thus enabling development.  This script should:
+#
+# a) Rely only on Ruby and its standard library, since it runs
+#    before any gems are installed
+# b) Be idempotent, with the ability to run in a CI server
+# c) Be organized with the setup method first, as this is the main chunk
+#    of logic, with all other supporting methods following
+#
+# NOTE: It is not clear yet how Brut will manage this file for you, especially
+#       given that you will need to add to it based on your own setup needs.
+#
+#       Take care to only add code and not change what is here.
+
+def setup(update_gems:,update_node:)
+  if update_gems
+    log "Updating gems"
+    system! "bundle update"
+  else
+    log "Installing gems"
+    # Only do bundle install if the much-faster
+    # bundle check indicates we need to
+    system! "bundle check --no-color || bundle install --no-color --quiet"
+  end
+
+  log "Installing puma binstubs"
+  system! "bundle binstub puma"
+
+  log "Installing rspec binstubs"
+  system! "bundle binstub rspec-core"
+
+  # https://github.com/ddollar/foreman/wiki/Don't-Bundle-Foreman
+  log "Installing foreman"
+  system! "gem install foreman"
+
+  # Installs Shopify's LSP. You can remove this if you don't want that,
+  # but this is here to show where to do it vs requiring you to read
+  # documentation.
+  log "Installing Ruby LSP"
+  system! "gem install ruby-lsp"
+
+  if update_node
+    log "Updating Node Modules"
+    system! "npm --no-color --no-progress update"
+  else
+    log "Installing Node Modules"
+    system! "npm --no-color --no-progress install"
+  end
+
+  # In theory, this was installed when the Workspace was setup, but
+  # it doesn't alwaysd work propertly, so this ensures
+  # Chromium is set up.  See comments in Dockerfile.dx as to why
+  # Chromium and not Chrome.
+  log "Re-installing playwright/chromium if needed"
+  system! "node_modules/.bin/playwright install chromium"
+
+  log "Ensuring tmp dir exists"
+  system! "mkdir -p tmp"
+
+  setup_dot_env_local
+
+  log "Setting up databases"
+
+  log "Re-creating development database"
+  system! "bin/db rebuild --env=development"
+
+  log "Re-creating test database"
+  system! "bin/db rebuild --env=test"
+
+  log "Loading seed data into the development database"
+  system! "bin/db seed --env=development"
+
+  log "All set up."
+  help
+end
+
+def setup_dot_env_local() 
+
+  dot_env = ROOT_DIR / ".env.development"
+  if !File.exist?(dot_env)
+    raise "Problem: '#{dot_env}' does not exist"
+  end
+
+  log "Checking #{dot_env} for required local environment variables"
+  previous_comment = ""
+  dot_env_need_local = {}
+  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
+
+  dot_env_local = ROOT_DIR / ".env.development.local"
+  log "Ensuring '#{dot_env_local}' exists"
+  if !File.exist?(dot_env_local)
+    log "Creating '#{dot_env_local}'"
+    FileUtils.touch dot_env_local
+  end
+
+  log "Checking #{dot_env_local} for values for required local environment variables"
+  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 != ""
+        log "Value for '#{var}' is good"
+        dot_env_need_local.delete(var)
+      end
+    end
+    line
+  }.compact
+
+  dot_env_need_local.each do |var,comment|
+    log "A value is needed locally for '#{var}'"
+    log ""
+    log comment
+    log ""
+    puts "Enter the value below and hit Return"
+    value = gets
+    local_contents << "#{var}=#{value}"
+    log "Got it, thanks"
+  end
+
+  log "Updating '#{dot_env_local}'"
+  File.open(dot_env_local,"w") do |file|
+    local_contents.each do |line|
+      file.puts line
+    end
+  end
+
+  log "Checking that #{dot_env_local} is being ignored"
+  gitignore = ROOT_DIR / ".gitignore"
+  if File.exist?(gitignore)
+    lines = File.read(gitignore).split(/\n/)
+    if lines.include?("/#{dot_env_local.basename}")
+      log "It's there!"
+    else
+      log "It's missing. Adding..."
+      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
+    log "No #{gitignore}, so make sure you DO NOT CHECK #{dot_env_local} IN!!!"
+  end
+end
+
+# We don't want the setup method to have to do all this error
+# checking, and we also want to explicitly log what we are
+# executing. Thus, we use this method instead of Kernel#system
+def system!(*args)
+  if ENV["BRUT_BIN_KIT_DEBUG"] == "true"
+    log "Executing #{args}"
+    out,err,status = Open3.capture3(*args)
+    if status.success?
+      log "#{args} succeeded"
+    else
+      log "#{args} failed"
+      log "STDOUT:"
+      $stdout.puts out
+      log "STDERR:"
+      $stderr.puts err
+      abort
+    end
+  else
+    log "Executing #{args}"
+    if system(*args)
+      log "#{args} succeeded"
+    else
+      log "#{args} failed"
+      abort
+    end
+  end
+end
+
+# It's helpful to know what messages came from this
+# script, so we'll use log instead of `puts`
+def log(message)
+  puts "[ #{$0} ] #{message}"
+end
+
+ROOT_DIR = ((Pathname(__dir__) / ".." ).expand_path)
+
+def help(option_parser=nil)
+  if option_parser
+    puts option_parser
+    puts
+    puts "OTHER USEFUL COMMANDS"
+  else
+    puts
+    puts "USEFUL COMMANDS"
+  end
+  puts ""
+  puts "  bin/dev"
+  puts "     # run app locally, rebuilding and reloading as needed"
+  puts ""
+  puts "  bin/ci"
+  puts "     # runs all tests and checks as CI would"
+  puts ""
+  puts "  bin/console"
+  puts "     # get an IRB console with the app loaded"
+  puts ""
+  puts "  bin/db"
+  puts "     # interact with the DB for migrations, information, etc"
+  puts ""
+  puts "  bin/dbconsole"
+  puts "     # get a PSQL session to the database"
+  puts ""
+  puts "  bin/scaffold"
+  puts "     # Create various structures in your app, like pages or forms"
+  puts ""
+  puts "  bin/setup help"
+  puts "     # show this help"
+  puts ""
+end
+
+options = {
+  update_gems: false,
+  update_node: false,
+}
+option_parser = OptionParser.new do |opts|
+  opts.banner = "Usage: bin/setup [options]\n\n    Set up the Foundation, allowing for development and testing of the app\n\nOPTIONS\n"
+  opts.on("--update[=TYPE]","Update gems or modules to get the latest versions consistent with Gemfile or package.json. TYPE can be 'all', 'gems', or 'node'. If TYPE is omitted, 'all' is assumed.") do |value|
+    options[:update_gems] = value.nil? || value == "gems"
+    options[:update_node] = value.nil? || value == "node"
+  end
+  opts.on("-h", "--help", "Display this help message") do
+    help(opts)
+    exit
+  end
+end
+option_parser.parse!
+
+if ARGV[0] == "help"
+  help(option_parser)
+else
+  setup(**options)
+end