brut 0.0.1

data/bin/bin_kit.rb

@@ -0,0 +1,39 @@
+require "pathname"
+require "fileutils"
+require "open3"
+
+# 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)

data/bin/rake

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/setup

@@ -0,0 +1,145 @@
+#!/usr/bin/env ruby
+
+require_relative "bin_kit"
+require "optparse"
+require "pathname"
+require "fileutils"
+
+def setup(update_gems:,setup_credentials:)
+  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
+
+  if setup_credentials
+    project_root = Pathname($0).dirname / ".."
+    credentials_dir = project_root / "dx" / "credentials"
+    if credentials_dir.exist?
+      if credentials_dir.directory?
+        log "#{credentials_dir} exists"
+      else
+        log "#{credentials_dir} is not a directory - please delete it or move it elsewhere and re-run this script"
+        exit 1
+      end
+    else
+      log "#{credentials_dir} doesn't exist - creating"
+      FileUtils.mkdir_p credentials_dir
+    end
+
+    # https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent?platform=linux
+    key_file = credentials_dir / "id_ed25519"
+
+    if key_file.exist?
+      log "#{key_file} exists already"
+    else
+      git_config_command = "git config --get user.email"
+      email = `#{git_config_command}`.chomp
+      if !$?.success?
+        log "Could not determine your email via #{git_config_command} - is your git set up properly?"
+        exit 1
+      end
+      log "Creating your key in #{key_file} using email #{email}."
+      log "You will be prompted for a passphrase, which you are encouraged to provide"
+      system! "ssh-keygen -t ed25519 -C #{email} -f \"#{key_file}\""
+      log ""
+      log "You must now add this to your GitHub profile in order to perform Git commands"
+      log ""
+      log "The key you just generated has a public key that should be available on your computer at"
+      log ""
+      log "   #{key_file.relative_path_from(project_root)}.pub"
+      log ""
+      log "Copy its contents and head to:"
+      log ""
+      log "   https://github.com/settings/keys"
+      log ""
+      log "Click 'New SSH key' and paste your key in, giving it a name like 'Brut Dev Env'"
+      log ""
+      log "(if this doesn't look right, check https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account)"
+      log ""
+      log "Hit return when done"
+      x = gets
+    end
+
+    log "Adding your SSH key to ssh-agent - you must provide your passphrase"
+    system! "ssh-add #{key_file}"
+
+    known_hosts_dest = Pathname("/") / "root" / ".ssh" / "known_hosts"
+    if known_hosts_dest.exist?
+      log "#{known_hosts_dest} exists, your ssh key should work with GitHub"
+    else
+      log "#{known_hosts_dest} does not exist"
+      known_hosts_source = credentials_dir / "known_hosts"
+      if known_hosts_source.exist?
+        log "#{known_hosts_source} exists - copying it to #{known_hosts_dest}"
+        FileUtils.mkdir_p known_hosts_dest.dirname
+        FileUtils.chmod(0700,known_hosts_dest.dirname)
+        FileUtils.cp known_hosts_source, known_hosts_dest
+        FileUtils.chmod(0600,known_hosts_dest)
+      else
+        log "#{known_hosts_source} also does not exist. To create it, we'll connect to github.com"
+        log "NOTE: it will show you a fingerprint to verify authenticity. You should check it against:"
+        log ""
+        log "    https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/githubs-ssh-key-fingerprints"
+        log ""
+        log "       and proceed ONLY if the values match"
+        log ""
+        system("ssh -T git@github.com") # NOT system! because this may exit nonzero but still have succeeded
+        if $?.exitstatus == 255
+          log "SOMETHING MAY HAVE GONE WRONG!"
+        end
+        if known_hosts_dest.exist?
+          log "Copying #{known_hosts_dest} back to #{known_hosts_source} to use in the future"
+          FileUtils.cp known_hosts_dest,known_hosts_source
+        else
+          log "For some reason #{known_hosts_dest} was not created.  Future ssh commands may ask you to verify GitHub's fingerprint"
+        end
+      end
+    end
+    log "Your ssh key looks good"
+
+    gem_credentials_dest = Pathname("/") / "root" / ".gem" / "credentials"
+    if gem_credentials_dest.exist?
+      log "Gem credentials look good"
+    else
+      log "#{gem_credentials_dest} doesn't exist - creating"
+      FileUtils.mkdir_p gem_credentials_dest.dirname
+      gem_credentials_source = credentials_dir / "rubygems.credentials"
+      if gem_credentials_source.exist?
+        log "#{gem_credentials_source} exists - copying it to #{gem_credentials_dest}"
+        FileUtils.cp gem_credentials_source,gem_credentials_dest
+      else
+        log "#{gem_credentials_source} must contain a RubyGems credentials file"
+        log ""
+        log "Follow the instructions here:"
+        log ""
+        log "   https://guides.rubygems.org/api-key-scopes/#creating-from-gem-cli"
+        log ""
+        log "Then copy ~/.gem/credentials into #{gem_credentials_source} and re-run this script"
+        exit 1
+      end
+    end
+  else
+    log "Not setting up GitHub or RubyGems credentials. You won't be able to push the gem"
+  end
+end
+
+
+options = {
+  update_gems: false,
+  setup_credentials: true,
+}
+OptionParser.new do |opts|
+  opts.on("--update-gems","Update gems get the latest versions consistent with Gemfile / gemspec.") do
+    options[:update_gems] = true
+  end
+  opts.on("--no-credentials","If set, no GitHub or RubyGems credentials are required, but you can't push gems") do
+    options[:setup_credentials] = false
+  end
+end.parse!
+
+setup(**options)

data/brut.gemspec

@@ -0,0 +1,60 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "brut/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "brut"
+  spec.version       = Brut::VERSION
+  spec.authors       = ["David Bryant Copeland"]
+  spec.email         = ["davec@thirdtank.com"]
+
+  spec.summary       = %q{NOT YET RELEASED - Web Framework Built around Ruby, Web Standards, Simplicity, and Object-Orientation}
+  spec.description   = %q{NOT YET RELEASED - An opinionated web framework build on web standards}
+  spec.homepage      = "https://naildrivin5.com"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://naildrivin5.com"
+    spec.metadata["changelog_uri"] = "https://naildrivin5.com"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "dotenv"
+  spec.add_runtime_dependency "ostruct" # squelch some warning - this is not used
+  spec.add_runtime_dependency "factory_bot"
+  spec.add_runtime_dependency "faker"
+  spec.add_runtime_dependency "i18n"
+  spec.add_runtime_dependency "nokogiri"
+  spec.add_runtime_dependency "prism"
+  spec.add_runtime_dependency "rack-protection"
+  spec.add_runtime_dependency "rackup"
+  spec.add_runtime_dependency "rexml"
+  spec.add_runtime_dependency "semantic_logger"
+  spec.add_runtime_dependency "sequel"
+  spec.add_runtime_dependency "sinatra"
+  spec.add_runtime_dependency "temple"
+  spec.add_runtime_dependency "tilt"
+  spec.add_runtime_dependency "tzinfo"
+  spec.add_runtime_dependency "tzinfo-data"
+  spec.add_runtime_dependency "zeitwerk"
+
+  spec.add_development_dependency "activesupport"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+end

data/docker-compose.dx.yml

@@ -0,0 +1,16 @@
+services:
+  app:
+    image: ${IMAGE}
+    pull_policy: "missing"
+    init: true
+    volumes:
+      - type: bind
+        source: "./"
+        target: "/root/work"
+        consistency: "consistent"
+      - type: bind
+        source: ${GIT_CONFIG}
+        target: "/root/.gitconfig"
+    entrypoint: /root/show-help-in-app-container-then-wait.sh
+    working_dir: /root/work
+

data/dx/build

@@ -0,0 +1,26 @@
+#!/bin/bash
+
+set -e
+
+SCRIPT_DIR=$( cd -- "$( dirname -- "${0}" )" > /dev/null 2>&1 && pwd )
+
+. "${SCRIPT_DIR}/dx.sh.lib"
+
+require_command "docker"
+load_docker_compose_env
+
+usage_on_help "Builds the Docker image based on the Dockerfile" "" "build.pre" "build.post" "${@}"
+
+exec_hook_if_exists "build.pre" Dockerfile.dx "${IMAGE}"
+
+docker build \
+  --file Dockerfile.dx \
+  --tag "${IMAGE}" \
+  ./
+
+exec_hook_if_exists "build.post" Dockerfile.dx "${IMAGE}"
+
+log "🌈" "Your Docker image has been built tagged '${IMAGE}'"
+log "🔄" "You can now run dx/start to start it up, though you may need to stop it first with Ctrl-C"
+
+# vim: ft=bash

data/dx/docker-compose.env

@@ -0,0 +1,22 @@
+# IMAGE is the name of the image to be built for running
+# your app. The recommended format is ORG/REPO:TAG
+#
+#   ORG - your org on GitHub or DockerHub
+#   REPO - the name of the repo on GitHub or the app name
+#   TAG - a version identifier. Recommend you avoid latest as this is confusing
+IMAGE=thirdtank/brut-dev:ruby-3.3
+
+# This is used to tell docker compose what the name
+# of your project is for the purpose of naming
+# containers. It can be anything and is mostly 
+# used for pruning containers via bin/prune
+PROJECT_NAME=brut-dev
+
+# Use this to override the service name for your
+# app in docker-compose.dx.yml
+DEFAULT_SERVICE=app
+
+# Path to the git configuration to use
+GIT_CONFIG=~/.gitconfig
+
+# vim: ft=bash

data/dx/dx.sh.lib

@@ -0,0 +1,24 @@
+# shellcheck shell=bash
+
+. "${SCRIPT_DIR}/setupkit.sh.lib"
+
+require_command "realpath"
+require_command "cat"
+
+ENV_FILE=$(realpath "${SCRIPT_DIR}")/docker-compose.env
+
+load_docker_compose_env() {
+  . "${ENV_FILE}"
+}
+
+exec_hook_if_exists() {
+  script_name=$1
+  shift
+  if [ -x "${SCRIPT_DIR}"/"${script_name}" ]; then
+    log "🪝" "${script_name} exists - executing"
+    "${SCRIPT_DIR}"/"${script_name}" "${@}"
+  else
+    debug "${script_name} does not exist"
+  fi
+}
+# vim: ft=bash

data/dx/exec

@@ -0,0 +1,58 @@
+#!/bin/bash
+
+set -e
+
+SCRIPT_DIR=$( cd -- "$( dirname -- "${0}" )" > /dev/null 2>&1 && pwd )
+
+. "${SCRIPT_DIR}/dx.sh.lib"
+
+require_command "docker"
+load_docker_compose_env
+
+usage_description="Execute a command inside the app's container with ssh-agent active."
+usage_args="[-s service] [-A] command"
+usage_pre="exec.pre"
+usage_on_help "${usage_description}" "${usage_args}" "${usage_pre}" "" "${@}"
+
+SERVICE="${SERVICE_NAME:-${DEFAULT_SERVICE}}"
+SSH_AGENT="ssh-agent "
+while getopts "s:A" opt "${@}"; do
+  case ${opt} in
+    s )
+      SERVICE="${OPTARG}"
+      ;;
+    A )
+      SSH_AGENT="" 
+      ;;
+    \? )
+      log "🛑" "Unknown option: ${opt}"
+      usage "${description}" "${usage_args}" "${usage_pre}"
+      ;;
+    : )
+      log "🛑" "Invalid option: ${opt} requires an argument"
+      usage "${description}" "${usage_args}" "${usage_pre}"
+      ;;
+  esac
+done
+shift $((OPTIND -1))
+
+if [ $# -eq 0 ]; then
+  log "🛑" "You must provide a command e.g. bash or ls -l"
+  usage "${description}" "${usage_args}" "${usage_pre}"
+fi
+
+
+exec_hook_if_exists "exec.pre"
+
+log "🚂" "Running '${*}' inside container with service name '${SERVICE}'"
+
+docker \
+  compose \
+    --file docker-compose.dx.yaml \
+    --project-name "${PROJECT_NAME}" \
+    --env-file "${ENV_FILE}" \
+  exec \
+    "${SERVICE}" \
+    ${SSH_AGENT} "${@}"
+
+# vim: ft=bash

data/dx/prune

@@ -0,0 +1,19 @@
+#!/bin/bash
+
+set -e
+
+SCRIPT_DIR=$( cd -- "$( dirname -- "${0}" )" > /dev/null 2>&1 && pwd )
+
+. "${SCRIPT_DIR}/dx.sh.lib"
+require_command "docker"
+load_docker_compose_env
+
+usage_on_help "Prune containers for this repo" "" "" "" "${@}"
+
+for container_id in $(docker container ls -a -f "name=^${PROJECT_NAME}-.*-1$" --format="{{.ID}}"); do
+  log "🗑" "Removing container with id '${container_id}'"
+  docker container rm "${container_id}"
+done
+echo "🧼" "Containers removed"
+
+# vim: ft=bash

data/dx/setupkit.sh.lib

@@ -0,0 +1,144 @@
+# shellcheck shell=bash
+
+fatal() {
+  remainder=${*:2}
+  if [ -z "$remainder" ]; then
+    log "🛑" "${@}"
+  else
+    log "${@}"
+  fi
+  exit 1
+}
+
+log() {
+  emoji=$1
+  remainder=${*:2}
+  if [ -z "${NO_EMOJI}" ]; then
+    echo "[ ${0} ] ${*}"
+  else
+    # if remainder is empty that means no emoji was passed
+    if [ -z "$remainder" ]; then
+      echo "[ ${0} ] ${*}"
+    else # emoji was passed, but we ignore it
+      echo "[ ${0} ] ${remainder}"
+    fi
+  fi
+}
+
+debug() {
+  message=$1
+  if [ -z "${DOCKBOX_DEBUG}" ]; then
+    return
+  fi
+  log "🐛" "${message}"
+}
+
+usage() {
+  description=$1
+  arg_names=$2
+  pre_hook=$3
+  post_hook=$4
+  echo "usage: ${0} [-h] ${arg_names}"
+  if [ -n "${description}" ]; then
+    echo
+    echo "DESCRIPTION"
+    echo "    ${description}"
+  fi
+  if [ -n "${pre_hook}" ] || [ -n "${post_hook}" ]; then
+    echo
+    echo "HOOKS"
+    if [ -n "${pre_hook}" ]; then
+      echo "    ${pre_hook} - if present, called before the main action"
+    fi
+    if [ -n "${post_hook}" ]; then
+      echo "    ${post_hook} - if present, called after the main action"
+    fi
+  fi
+  exit 0
+}
+
+usage_on_help() {
+  description=$1
+  arg_names=$2
+  pre_hook=$3
+  post_hook=$4
+  # These are the args passed to the invocation so this
+  # function can determine if the user requested help
+  cli_args=( "${@:5}" ) 
+
+  for arg in "${cli_args[@]}"; do
+    if [ "${arg}" = "-h" ] || [ "${arg}" = "--help" ]; then
+      usage "${description}" "${arg_names}" "${pre_hook}" "${post_hook}"
+    fi
+  done
+}
+
+# Read user input into the variable 'INPUT'
+#
+# Args:
+#
+# [1] - an emoji to use for messages
+# [2] - the message explaining what input is being requested
+# [3] - a default value to use if no value is provided
+#
+# Respects NO_EMOJI when outputing messages to the user
+user_input() {
+  emoji=$1
+  message=$2
+  default=$3
+  prompt=$4
+
+  if [ -z "$message" ]; then
+    echo "user_input requires a message"
+    exit 1
+  fi
+
+  INPUT=
+
+  if [ -z "${prompt}" ]; then
+    prompt=$(log "${emoji}" "Value: ")
+    if [ -n "${default}" ]; then
+      prompt=$(log "${emoji}" "Value (or hit return to use '${default}'): ")
+    fi
+  fi
+
+  while [ -z "${INPUT}" ]; do
+
+    log "$emoji" "$message"
+    read -r -p "${prompt}" INPUT
+    if [ -z "$INPUT" ]; then
+      INPUT=$default
+    fi
+    if [ -z "$INPUT" ]; then
+      log "😶", "You must provide a value"
+    fi
+  done
+}
+
+user_confirm() {
+  user_input "$1" "$2" "$3" "y/n> "
+}
+
+require_not_exist() {
+  file=$1
+  message=$2
+  if [ -e "${file}" ]; then
+    fatal "$message"
+  fi
+}
+require_exist() {
+  file=$1
+  message=$2
+  if [ ! -e "${file}" ]; then
+    fatal "$message"
+  fi
+}
+
+require_command() {
+  command_name=$1
+  if ! command -v "${command_name}" >/dev/null 2>&1; then
+    fatal "Command '${command_name}' not found - it is required for this script to run"
+  fi
+}
+
+# vim: ft=bash

data/dx/show-help-in-app-container-then-wait.sh

@@ -0,0 +1,38 @@
+#!/bin/bash
+
+set -e
+
+# Ideally, the message below is shown after everything starts up. We can't
+# achieve this using healtchecks because the interval for a healtcheck is
+# also an initial delay, and we don't really want to do healthchecks on 
+# our DB or Redis every 2 seconds.  So, we sleep just a bit to let
+# the other containers start up and vomit out their output first.
+sleep 2
+# Output some helpful messaging when invoking `dx/start` (which itself is
+# a convenience script for `docker compose up`.
+#
+# Adding this to work around the mild inconvenience of the `app` container's
+# entrypoint generating no output.
+#
+cat <<-'PROMPT'
+
+
+
+ 🎉  Dev Environment Initialized! 🎉
+
+ ℹ️   To use this environment, open a new terminal and run
+
+     dx/exec bash
+
+ 🕹  Use `ctrl-c` to exit.
+
+
+
+PROMPT
+
+# Using `sleep infinity` instead of `tail -f /dev/null`. This may be a 
+# performance improvement based on the conversation on a semi-related
+# StackOverflow page.
+#
+# @see https://stackoverflow.com/a/41655546
+sleep infinity

data/dx/start

@@ -0,0 +1,30 @@
+#!/bin/bash
+
+set -e
+
+SCRIPT_DIR=$( cd -- "$( dirname -- "${0}" )" > /dev/null 2>&1 && pwd )
+
+. "${SCRIPT_DIR}/dx.sh.lib"
+require_command "docker"
+load_docker_compose_env
+
+usage_on_help "Starts all services, including a container in which to run your app" "" "" "" "${@}"
+
+log "🚀" "Starting docker-compose.dx.yml"
+
+BUILD=--build
+if [ "${1}" == "--no-build" ]; then
+    BUILD=
+fi
+
+docker \
+  compose \
+    --file docker-compose.dx.yml \
+    --project-name "${PROJECT_NAME}" \
+    --env-file "${ENV_FILE}" \
+  up \
+    "${BUILD}" \
+    --timestamps \
+    --force-recreate
+
+# vim: ft=bash

data/dx/stop

@@ -0,0 +1,23 @@
+#!/bin/bash
+
+set -e
+
+SCRIPT_DIR=$( cd -- "$( dirname -- "${0}" )" > /dev/null 2>&1 && pwd )
+
+. "${SCRIPT_DIR}/dx.sh.lib"
+require_command "docker"
+load_docker_compose_env
+
+usage_on_help "Stops all services, the container in which to run your app and removes any volumes" "" "" "" "${@}"
+
+log "🚀" "Stopping docker-compose.dx.yml"
+
+docker \
+  compose \
+    --file docker-compose.dx.yml \
+    --project-name "${PROJECT_NAME}" \
+    --env-file "${ENV_FILE}" \
+  down \
+    --volumes
+
+# vim: ft=bash

data/lib/brut/back_end/action.rb

@@ -0,0 +1,3 @@
+class Brut::BackEnd::Action
+  include SemanticLogger::Loggable
+end