brut 0.15.0 → 0.16.0.pre

data/mkbrut/lib/mkbrut/ops.rb

@@ -8,6 +8,7 @@ module MKBrut
     autoload :InsertRoute, "mkbrut/ops/insert_route"
     autoload :InsertCodeInMethod, "mkbrut/ops/insert_code_in_method"
     autoload :AppendToFile, "mkbrut/ops/append_to_file"
+    autoload :InsertIntoFile, "mkbrut/ops/insert_into_file"
     autoload :PrismParsingOp, "mkbrut/ops/prism_parsing_op"
     autoload :AddI18nMessage, "mkbrut/ops/add_i18n_message"
     autoload :AddCSSImport, "mkbrut/ops/add_css_import"

data/mkbrut/lib/mkbrut/segments/bare_bones.rb

@@ -9,6 +9,14 @@ class MKBrut::Segments::BareBones < MKBrut::Base
     @erb_binding   = ErbBindingDelegate.new(app_options)
   end
 
+  def <=>(other)
+    if self.class == other.class
+      0
+    else
+      -1
+    end
+  end
+
   def add!
 
     operations = copy_files(@templates_dir, @project_root) + 

data/mkbrut/lib/mkbrut/segments/demo.rb

@@ -10,6 +10,14 @@ class MKBrut::Segments::Demo < MKBrut::Base
     @erb_binding   = ErbBindingDelegate.new(app_options)
   end
 
+  def <=>(other)
+    if self.class == other.class
+      0
+    else
+      1
+    end
+  end
+
   def add!
     operations = copy_files(@templates_dir, @project_root) + 
                  other_operations(@project_root)

data/mkbrut/lib/mkbrut/segments/heroku.rb

@@ -1,10 +1,9 @@
 class MKBrut::Segments::Heroku < MKBrut::Base
   def self.friendly_name = "Heroku-based Deployment"
 
-  def initialize(app_options:, current_dir:, templates_dir:)
-    @project_root  = current_dir / app_options.app_name
+  def initialize(project_root:, templates_dir:)
+    @project_root  = project_root
     @templates_dir = templates_dir / "segments" / "Heroku"
-    @erb_binding   = MKBrut::ErbBindingDelegate.new(app_options)
   end
 
   def add!
@@ -16,8 +15,29 @@ class MKBrut::Segments::Heroku < MKBrut::Base
     end
   end
 
+  def <=>(other)
+    if self.class == other.class
+      0
+    elsif other.class == MKBrut::Segments::Sidekiq
+      # If both herkou and sidekiq segments are activated, we want to do heroku first,
+      # since Sidekiq will need to modify it.
+      -1
+    else
+      1
+    end
+  end
+
   def other_operations
     [
+      MKBrut::Ops::InsertIntoFile.new(
+        file: @project_root / "Dockerfile.dx",
+        contents: %{
+# Installs the Heroku CLI, per Heroku docs at 
+# https://devcenter.heroku.com/articles/heroku-cli#install-with-ubuntu-debian-apt-get
+RUN curl https://cli-assets.heroku.com/install-ubuntu.sh | sh
+},
+        before_line: "# Up to now, RUN directives ran as the root user.  When using this container"
+      ),
       MKBrut::Ops::AppendToFile.new(
         file: @project_root / ".gitignore",
         content: %{

data/mkbrut/lib/mkbrut/segments/sidekiq.rb

@@ -1,3 +1,138 @@
 # Adds Sidekiq to a Brut app
-class MKBrut::Segments::Sidekiq
+class MKBrut::Segments::Sidekiq < MKBrut::Base
+  def self.friendly_name = "Use Sidekiq to Run Background Jobs"
+  def initialize(project_root:, templates_dir:)
+    @project_root  = project_root
+    @templates_dir = templates_dir / "segments" / "Sidekiq"
+  end
+
+  def add!
+    operations = copy_files(@templates_dir, @project_root) + 
+                 other_operations
+
+    operations.each do |operation|
+      operation.call
+    end
+  end
+
+  def <=>(other)
+    if self.class == other.class
+      0
+    elsif other.class == MKBrut::Segments::Heroku
+      # If both herkou and sidekiq segments are activated, we want to do heroku first,
+      # since Sidekiq will need to modify it.
+      1
+    else
+      -1
+    end
+  end
+
+  def other_operations
+    [
+      MKBrut::Ops::AppendToFile.new(
+        file: @project_root / "docker-compose.dx.yml",
+        content: %{
+  redis:
+    # Change the value to what you are using in production.
+    # If you are using actual Redis, change that here.
+    image: valkey/valkey:8.1
+},
+      ),
+      MKBrut::Ops::AppendToFile.new(
+        file: @project_root / "Procfile.development",
+        content: "sidekiq: bin/run sidekiq\n"
+      ),
+      MKBrut::Ops::AppendToFile.new(
+        file: @project_root / "Procfile.test",
+        content: "sidekiq: bin/run sidekiq\n"
+      ),
+      MKBrut::Ops::AppendToFile.new(
+        file: @project_root / "Gemfile",
+        content: "# Sidekiq is used for background jobs\ngem \"sidekiq\"\n"
+      ),
+      MKBrut::Ops::AppendToFile.new(
+        file: @project_root / ".env.development",
+        content: %{
+# URL of the Redis/ValKey to use for Sidekiq
+SIDEKIQ_REDIS_URL=redis://redis:6379/1
+# Tells Sidekiq which ENV var to use for the Redis/ValKey URL
+REDIS_PROVIDER=SIDEKIQ_REDIS_URL
+# Username for basic auth into the Sidekiq Admin UI
+SIDEKIQ_BASIC_AUTH_USER=sidekiq
+# Passsword for basic auth into the Sidekiq Admin UI
+SIDEKIQ_BASIC_AUTH_PASSWORD=password
+}
+      ),
+      MKBrut::Ops::AppendToFile.new(
+        file: @project_root / ".env.test",
+        content: %{
+SIDEKIQ_REDIS_URL=redis://redis:6379/2
+REDIS_PROVIDER=SIDEKIQ_REDIS_URL
+SIDEKIQ_BASIC_AUTH_USER=sidekiq-test
+SIDEKIQ_BASIC_AUTH_PASSWORD=password
+}
+      ),
+      MKBrut::Ops::InsertIntoFile.new(
+        file: @project_root / "bin" / "test-server",
+        before_line: "wait",
+        content: "bin/run sidekiq &\n",
+      ),
+      MKBrut::Ops::InsertIntoFile.new(
+        file: @project_root / "bin" / "setup",
+        before_line: "  log \"Installing rspec binstubs\"",
+        content: %{log "Installing sidekiq binstubs"
+  system! "bundle binstub sidekiq"
+}
+      ),
+      MKBrut::Ops::InsertIntoFile.new(
+        file: @project_root / "specs" / "spec_helper.rb",
+        before_line: "require \"brut/spec_support\"",
+        content: "require \"sidekiq/testing\""
+      ),
+      MKBrut::Ops::InsertIntoFile.new(
+        file: @project_root / "config.ru",
+        before_line: "bootstrap = Bootstrap.new.bootstrap!",
+        content: "require \"sidekiq/web\"\n"
+      ),
+      MKBrut::Ops::InsertIntoFile.new(
+        file: @project_root / "config.ru",
+        before_line: "  run bootstrap.rack_app",
+        content: %{
+  map "/sidekiq" do
+    use Rack::Auth::Basic, "Sidekiq" do |username, password|
+      [username, password] == [ENV.fetch("SIDEKIQ_BASIC_AUTH_USER"), ENV.fetch("SIDEKIQ_BASIC_AUTH_PASSWORD")]
+    end
+    run Sidekiq::Web.new
+  end
+}
+      ),
+      MKBrut::Ops::InsertCodeInMethod.new(
+        file: @project_root / "app" / "src" / "app.rb",
+        class_name: "App",
+        method_name: "initialize",
+        code: "@sidekiq_segment = SidekiqSegment.new",
+      ),
+      MKBrut::Ops::InsertCodeInMethod.new(
+        file: @project_root / "app" / "src" / "app.rb",
+        class_name: "App",
+        method_name: "boot!",
+        code: "@sidekiq_segment.boot!"
+      ),
+      MKBrut::Ops::InsertCodeInMethod.new(
+        file: project_root / "deploy" / "heroku_config.rb",
+        class_name: "HerokuConfig",
+        method_name: "additional_images",
+        class_method: true,
+        ignore_if_file_not_found: true,
+        code: %{
+{
+  "sidekiq" => {
+    cmd: "bin/run sidekiq",
+  }
+}
+        },
+        where: :end
+      ),
+    ]
+  end
 end

data/mkbrut/lib/mkbrut/segments.rb

@@ -2,7 +2,7 @@ module MKBrut
   module Segments
     autoload :BareBones, "mkbrut/segments/bare_bones"
     autoload :Demo, "mkbrut/segments/demo"
-    autoload :Sidekiq, "mkbrut/segments/demo"
+    autoload :Sidekiq, "mkbrut/segments/sidekiq"
     autoload :Heroku, "mkbrut/segments/heroku"
   end
 end

data/mkbrut/lib/mkbrut/version.rb

@@ -1,3 +1,3 @@
 module MKBrut
-  VERSION = "0.15.0"
+  VERSION = "0.16.0.pre"
 end

data/mkbrut/lib/mkbrut.rb

@@ -3,6 +3,8 @@ module MKBrut
   autoload :AppId, "mkbrut/app_id"
   autoload :AppName, "mkbrut/app_name"
   autoload :AppOptions, "mkbrut/app_options"
+  autoload :AddSegment, "mkbrut/add_segment"
+  autoload :AddSegmentOptions, "mkbrut/add_segment_options"
   autoload :Base, "mkbrut/base"
   autoload :CLI, "mkbrut/cli"
   autoload :ErbBindingDelegate, "mkbrut/erb_binding_delegate"

data/mkbrut/templates/Base/.gitignore

@@ -17,6 +17,9 @@
 
 # This could contain actual secrets and should not be checked in
 /.env.development.local
+# This could also contain actual secrets and should not be checked in - it's configuration
+# per developer, not per app
+/dx/bash_customizations.local
 
 # These are generated artifacts
 /deploy/Dockerfile.*

data/mkbrut/templates/Base/Dockerfile.dx

@@ -25,13 +25,18 @@ ENV DEBIAN_FRONTEND=noninteractive
 # These packages are needed to set up other repos to install other
 # packages and/or are useful in installing other software
 #
+# --mount=type=cache,target=/var/cache/apt means that we'll save
+# the downloaded file used to install between builds, so that if they
+# have not changed, builds will be faster.
+#
 # - ca-certificates  - needed by Postgres client
 # - curl             - needed by various installation instructions
 # - gnupg            - needed to install Docker
 # - lsb-release      - needed by Postgres install instructions
 # - rsync            - needed by Brut's build_assets command
 # - vim              - needed when we want to edit files inside container
-RUN apt-get -y clean && \
+RUN --mount=type=cache,target=/var/cache/apt \
+    apt-get -y clean && \
     apt-get -y update && \
     apt-get install --quiet --yes \
       ca-certificates \
@@ -47,7 +52,8 @@ RUN apt-get -y clean && \
 #
 #     npx playwright install-deps --dry-run chromium
 #
-RUN apt-get install -y --no-install-recommends libasound2 \
+RUN --mount=type=cache,target=/var/cache/apt \
+    apt-get install -y --no-install-recommends libasound2 \
                                                libatk-bridge2.0-0 \
                                                libatk1.0-0 \
                                                libatspi2.0-0 \
@@ -117,10 +123,6 @@ RUN echo "gem: --no-document" >> ~/.gemrc && \
     gem update --system && \
     gem install bundler
 
-# Installs the Heroku CLI, per Heroku docs at 
-# https://devcenter.heroku.com/articles/heroku-cli#install-with-ubuntu-debian-apt-get
-RUN curl https://cli-assets.heroku.com/install-ubuntu.sh | sh
-
 # Up to now, RUN directives ran as the root user.  When using this container
 # for development, we do not want to run as the root user.  On macOS, this is not 
 # a big deal, but in Linux, the root user inside this container can create files
@@ -178,28 +180,23 @@ COPY --chown=appuser:${user_gid} dx/bash_customizations.local /home/appuser/.bas
 # as belonging to.
 USER appuser
 
-# Install NodeJS, per https://nodejs.org/en/download
-#
-# Yes, this is seting up nvm just to install one version of node we will ever user in
-# here and yes, this sucks.  But it's better to use the vendor's official
-# recommendation.
-RUN curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.3/install.sh | bash && \
-    \. "$HOME/.nvm/nvm.sh" && \
-    nvm install 22 && \
-    node -v && nvm current && npm -v
-
-
+# Installs NodeJS from the official image.  This is simpler
+# than the canonical instructions which use NVM.  Inside the container, there
+# is not value to use NVM.
+COPY --from=node:22-slim /usr/local /usr/local
 
 # This arg should have the version of playwright present in the app's Gemfile.lock.
 # This is because the playright NodeJS library and the Ruby gem must have the same
 # version or things won't work right.  The value is blank because it really has to be
 # detected during `dx/build`.
 ARG PLAYWRIGHT_VERSION
+
 # Now install the version of Playwright we detected as well as Chromium. NOTE, we
 # must install Chromium, not chrome, because there is no version of Chrome for an
 # ARM-based Debian linux, which is what this Dockerfile will build on an Apple
-# Silicon Mac.
-RUN \. "$HOME/.nvm/nvm.sh" && \
-    nvm use default && \
-    npm install -g playwright@$PLAYWRIGHT_VERSION && \
+# Silicon Mac. Note that we set NPM_CONFIG_PREFIX so that the global
+# install will work for this user.
+ENV NPM_CONFIG_PREFIX=/home/appuser/.npm-global
+ENV PATH=/home/appuser/.npm-global/bin:$PATH
+RUN npm install -g playwright@$PLAYWRIGHT_VERSION && \
     npx playwright install chromium

data/mkbrut/templates/Base/Gemfile.erb

@@ -40,7 +40,7 @@ gem "pg"
 # We lock the version because it must be the same as the verison
 # of playwright in package.json.  This ensures that we can reliably
 # install the right browsers and that everything will work right.
-gem "playwright-ruby-client", "1.52.0", groups: [ :test ]
+gem "playwright-ruby-client", "1.55.0", groups: [ :test ]
 
 # Sinatra needs a webserver and puma is the best
 gem "puma"

data/mkbrut/templates/Base/bin/run

@@ -1,86 +1,126 @@
-#!/bin/sh
+#!/usr/bin/env bash
 
 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
 
+SCRIPT_DIR=$( cd -- "$( dirname -- "${0}" )" > /dev/null 2>&1 && pwd )
 PORT="${PORT:-6502}"
 RACK_ENV="${RACK_ENV:-development}"
 
 export PORT
 export RACK_ENV
 
-set -e 
+declare -A CMD_MAP
+declare -A PIDFILE_MAP
+declare -A CREATES_PIDFILE_MAP
 
-# 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"
+kill_previous() {
+  local pidfile=$1
+
+  if [[ -z "$pidfile" ]]; then
+    echo "[ $0 ] Error: no pidfile path given"
+    return 0
   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"
+  if [ -f "${pidfile}" ]; then
+    echo "[ $0 ] pidfile found"
+    pid=$(cat "${pidfile}")
+
+    if [[ -z "$pid" || ! "$pid" =~ ^[0-9]+$ ]]; then
+      echo "[ $0 ] Invalid or empty PID in $pidfile: '$pid'; removing"
+      rm -f "$pidfile"
+      return 0
+    fi
+
+    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
+    if timeout 5 tail --pid="${pid}" -f /dev/null; then
+      echo "[ $0 ] PID '${pid}' stopped. 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"
+      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"
+      fi
       exit 1
     fi
+
+  else
+    echo "[ $0 ] No pidfile-Starting up"
   fi
+}
 
-else
-  echo "[ $0 ] No pidfile-Starting up"
+dotenv_run() {
+  local env_files="${SCRIPT_DIR}/../.env.${RACK_ENV}.local,${SCRIPT_DIR}/../.env.${RACK_ENV}"
+  dotenv -f "$env_files" --ignore -- "$@"
+}
+
+
+for f in "$SCRIPT_DIR"/run.*; do
+  if [[ -f "$f" ]]; then
+    echo "[ $0 ] Sourcing $f"
+    . "$f"
+  fi
+done
+
+case $# in
+  0) name="run" ;;
+  1) name="$1" ;;
+  *) echo "Error: too many arguments ($#)." >&2; usage; exit 2 ;;
+esac
+
+if [[ ! -v CMD_MAP[$name] ]]; then
+  echo "[ $0 ] Error: unknown service '$name'." >&2
+  echo -n "[ $0 ] Known services: " >&2
+  printf "%s " "${!CMD_MAP[@]}" >&2
+  echo >&2
+  exit 1
 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
+cmd="${CMD_MAP[$name]}"
+creates_pidfile="${CREATES_PIDFILE_MAP[$name]:-false}"
+pidfile="${PIDFILE_MAP[$name]:-}"
+
+echo "[ $0 ]: Command for $name:"
+echo
+echo "          $cmd"
+echo
+
+kill_previous "$pidfile"
+
+if [[ "$creates_pidfile" == true ]]; then
+  echo "[ $0 ] Running '$cmd', which creates its own pidfile"
+  eval "dotenv_run $cmd"
+else
+  # Command wont' create a pidfile, so we will
+  if [[ -z "${pidfile:-}" ]]; then
+    echo "Error: no pidfile path configured for '$name' but creates_pidfile=false." >&2
+    exit 1
+  fi
+  echo "[ $0 ] Running '$cmd', which will not create a pidfile"
+  echo "[ $0 ] We will do that and save it to ${pidfile}"
+
+  echo "[ $0 ] Ensuring $(dirname "$pidfile") exists"
+  mkdir -p "$(dirname "$pidfile")"
+
+  eval "dotenv_run $cmd &"
+  child_pid=$!
+
+  set +e
+  echo "$child_pid" > "$pidfile"
+
+  trap 'kill -TERM "$child_pid" 2>/dev/null' TERM INT
+
+  wait "$child_pid"
+
+  echo "[ $0 ] TERM or INT received, removing ${pidfile} and exiting"
+
+  status=$?
+  rm -f "$pidfile"
+  exit "$status"
+fi

data/mkbrut/templates/Base/bin/run.run

@@ -0,0 +1,4 @@
+PIDFILE="${SCRIPT_DIR}/../tmp/pidfile"
+CMD_MAP[run]="bin/puma --port ${PORT} -C puma.config.rb --environment ${RACK_ENV} --pid ${PIDFILE}"
+PIDFILE_MAP[run]="${PIDFILE}"
+CREATES_PIDFILE_MAP[run]="true"

data/mkbrut/templates/Base/bin/setup

@@ -1,10 +1,11 @@
 #!/usr/bin/env ruby
 
-
 require "fileutils"
 require "open3"
 require "optparse"
 require "pathname"
+require "bundler"
+require "json"
 
 # This is intended to run inside the Workspace (i.e. Docker container) to
 # set up the Foundation, thus enabling development.  This script should:
@@ -21,6 +22,7 @@ require "pathname"
 #       Take care to only add code and not change what is here.
 
 def setup(update_gems:,update_node:)
+  ensure_versions_are_consistent!
   if update_gems
     log "Updating gems"
     system! "bundle update"
@@ -82,6 +84,35 @@ def setup(update_gems:,update_node:)
   help
 end
 
+def ensure_versions_are_consistent!
+  gemfile      = Bundler::Definition.build(ROOT_DIR / "Gemfile", ROOT_DIR / "Gemfile.lock", nil)
+  package_json = JSON.parse(File.read(ROOT_DIR / "package.json"))
+
+  playwright_version = nil
+  gemfile.dependencies.each do |dep|
+    if dep.name == "playwright-ruby-client"
+      if !dep.specific?
+        puts "You must specify an exact/specific version of 'playwright-ruby-client' in your Gemfile"
+        exit 1
+      end
+      playwright_version = dep.requirement.requirements.first[1]
+    end
+  end
+
+  if playwright_version
+    playwright_version_in_package_json = package_json.dig("devDependencies","playwright")
+    if !playwright_version_in_package_json
+      puts "You must have 'playwright' in the devDependencies section of your package.json"
+      exit 1
+    end
+    if playwright_version != playwright_version_in_package_json
+      puts "The version of 'playwright' in package.json (#{playwright_version_in_package_json}) does not match the version of 'playwright-ruby-client' in the Gemfile (#{playwright_version})"
+      puts "They must be exactly the same, or your end-to-end tests may behave strangely"
+      exit 1
+    end
+  end
+end
+
 def setup_dot_env_local
 
   dot_env = ROOT_DIR / ".env.development"

data/mkbrut/templates/Base/dx/bash_customizations

@@ -6,7 +6,3 @@ if [ ! -n "$PROJECT_ROOT" ]; then
 fi
 export GEM_HOME=${PROJECT_ROOT}/local-gems/gem-home
 export PATH=${PATH}:${GEM_HOME}/bin
-# This sets up the Node version so we don't have to do it before every. single.
-# shell. invocation.
-. ~/.nvm/nvm.sh
-nvm use default

data/mkbrut/templates/Base/package.json.erb

@@ -11,7 +11,7 @@
     "esbuild": "^0.20.2",
     "jsdom": "^25.0.1",
     "mocha": "^10.7.3",
-    "playwright": "1.50.1",
+    "playwright": "1.55.0",
     "typescript": "^5.8.3",
     "typescript-language-server": "^4.3.4",
     "vscode-langservers-extracted": "^4.10.0"