brut 0.17.0 → 0.18.0

data/mkbrut/bin/publish

@@ -1,129 +0,0 @@
-#!/usr/bin/env bash
-
-set -e
-SCRIPT_DIR=$( cd -- "$( dirname -- "${0}" )" > /dev/null 2>&1 && pwd )
-ROOT_DIR=$(realpath "$SCRIPT_DIR/..")
-
-main() {
-  detect_gem_version
-  detect_docker_platform
-  release_gem
-  build_and_maybe_push
-}
-
-log() {
-  echo "[ mkbrut/bin/publish ] ${*}"
-}
-
-usage() {
-  echo "Usage: $0"
-  echo
-  echo "    Publish Ruby Gem and Docker image"
-  echo
-}
-
-release_gem() {
-  log "Releasing Gem"
-  rake release
-  wait_for_rubygems
-}
-
-wait_for_rubygems() {
-  timeout=30
-  interval=2
-  elapsed=0
-
-  log "Waiting ${timeout} seconds for mkbrut $GEM_VERSION to be available on RubyGems"
-  while (( elapsed < timeout )); do
-    if gem list -r "mkbrut" -a | grep -q "$GEM_VERSION"; then
-      log "mkbrut $GEM_VERSION is available on RubyGems"
-      return 0
-    fi
-    sleep $interval
-    (( elapsed += interval ))
-  done
-
-  log "mkbrut $GEM_VERSION is not available on RubyGems after $timeout seconds"
-  log "Something may have gone wrong. Or, it could just be taking a while"
-  log "You can re-run this with -G to bypassing pushing to RubyGems"
-  echo 
-  log "    bin/deploy -G"
-  exit 1
-}
-
-setup_docker_buildx() {
-  local builder_name=mkbrut-builder
-
-  if ! docker buildx ls | grep -q "^$builder_name"; then
-    log "Creating Docker buildx builder: $builder_name"
-    docker buildx create --name "$builder_name" --use
-    docker buildx inspect "$builder_name" --bootstrap
-  else
-    log "Docker buildx builder $builder_name already exists"
-    docker buildx use "$builder_name"
-  fi
-}
-
-detect_gem_version() {
-
-  GEM_VERSION=$( rake -T | grep "rake install " | sed 's/^.*mkbrut-//g' | sed 's/\.gem.*$//g')
-  if [[ "$GEM_VERSION" =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
-    log "Releasing version ${GEM_VERSION}"
-  else
-    log "Version '${GEM_VERSION}' does not look like a version: X.Y.Z"
-    exit 1
-  fi
-}
-
-detect_docker_platform() {
-
-  KERNEL_NAME_FOR_ARCHITECTURE=$(docker info --format '{{.Architecture}}')
-  OSTYPE=$(docker info --format '{{.OSType}}')
-
-  case "$KERNEL_NAME_FOR_ARCHITECTURE" in
-    "aarch64")
-      DOCKER_NAME_FOR_ARCHITECTURE="arm64"
-      ;;
-    "x86_64")
-      DOCKER_NAME_FOR_ARCHITECTURE="amd64"
-      ;;
-    *)
-      log "Docker reported architecture is $KERNEL_NAME_FOR_ARCHITECTURE - hoping this works"
-      ;;
-  esac
-  HOST_PLATFORM=${OSTYPE}/${DOCKER_NAME_FOR_ARCHITECTURE}
-}
-
-build_and_maybe_push() {
-
-  # See bin/setup for another use of this page
-  local docker_credentials_source="${SCRIPT_DIR}/../dx/credentials/dockerhub.credentials"
-  setup_docker_buildx
-
-  . "${docker_credentials_source}"
-  log "Loging into DockerHub with credentials from ${docker_credentials_source}"
-  docker login --username "${DOCKERHUB_USERNAME}" --password "${DOCKERHUB_PAT}"
-
-  DOCKER_BUILD_PUSH_OR_LOAD=--push
-  DOCKER_PLATFORMS="linux/amd64,linux/arm64"
-
-  log "Building Docker image and pushing to DockerHub"
-
-  docker buildx build \
-    --platform ${DOCKER_PLATFORMS} \
-    ${DOCKER_BUILD_PUSH_OR_LOAD} \
-    --no-cache \
-    --build-arg brut_version="${GEM_VERSION}" \
-    --tag thirdtank/mkbrut:"${GEM_VERSION}" \
-    --tag thirdtank/mkbrut:latest \
-    deploy
-}
-
-for arg in "${@}"; do
-  if [ "${arg}" = "-h" ] || [ "${arg}" = "--help" ] || [ "${arg}" = "help" ]; then
-    usage
-    exit 0
-  fi
-done
-
-main

data/mkbrut/bin/rake

@@ -1,16 +0,0 @@
-#!/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__)
-
-require "rubygems"
-require "bundler/setup"
-
-load Gem.bin_path("rake", "rake")

data/mkbrut/bin/setup

@@ -1,30 +0,0 @@
-#!/usr/bin/env ruby
-
-require_relative "../../bin/bin_kit"
-require "optparse"
-require "pathname"
-require "fileutils"
-
-def setup(update_gems:)
-  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
-end
-
-
-options = {
-  update_gems: false,
-}
-OptionParser.new do |opts|
-  opts.on("--update-gems","Update gems get the latest versions consistent with Gemfile / gemspec.") do
-    options[:update_gems] = true
-  end
-end.parse!
-
-setup(**options)

data/mkbrut/deploy/.dockerignore

@@ -1,2 +0,0 @@
-# Nothing in this repo needs to be put into the Docker image
-*

data/mkbrut/deploy/Dockerfile

@@ -1,25 +0,0 @@
-FROM ruby:3.4
-
-SHELL [ "/bin/bash", "-o", "pipefail", "-c" ]
-
-ENV DEBIAN_FRONTEND=noninteractive
-RUN apt-get -y update
-
-# Update RubyGems and Bundler
-RUN echo "gem: --no-document" >> ~/.gemrc && \
-    gem update --system
-
-ARG brut_version
-RUN gem install --version ${brut_version} mkbrut
-
-ARG user_uid=10001
-ARG user_gid=10002
-
-# Create the user's group ID if it does not exist
-RUN getent group ${user_gid} || groupadd --gid ${user_gid} appgroup
-RUN useradd --uid ${user_uid} --gid ${user_gid} --create-home --home-dir /home/appuser appuser
-
-# NOT including the group here as that will place the user's environment
-# ONLY in that group and not in all the groups in which they are a part.
-USER appuser
-

data/mkbrut/dx

@@ -1 +0,0 @@
-../dx

data/mkbrut/exe/mkbrut

@@ -1,5 +0,0 @@
-#!/usr/bin/env ruby
-
-require "mkbrut"
-
-exit MKBrut::CLI.new(args: ARGV).run

data/mkbrut/lib/mkbrut/app_name.rb

@@ -1,29 +0,0 @@
-module MKBrut
-  class AppName
-    def initialize(value)
-      identifier = value.to_s
-      if identifier.empty?
-        raise MKBrut::InvalidIdentifier, "app-name is required"
-      end
-
-      if identifier.length > 63
-        raise MKBrut::InvalidIdentifier, "app-name cannot be longer than 63 characters"
-      end
-
-      if identifier.start_with?("-") || identifier.end_with?("-")
-        raise MKBrut::InvalidIdentifier, "app-name cannot start or end with a hyphen"
-      end
-
-      if identifier.match?(/[^a-zA-Z\-_]/)
-        raise MKBrut::InvalidIdentifier, "app-name can only contain letters, hyphens, and underscores"
-      end
-      if identifier.match?(/__/) || identifier.match?(/--/)
-        raise MKBrut::InvalidIdentifier, "app-name can not have repeating underscores or hyphens"
-      end
-      @identifier = identifier.to_s.gsub(/_/,"-")
-    end
-
-    def to_s = @identifier
-    alias to_str to_s
-  end
-end

data/mkbrut/lib/mkbrut/app_options.rb

@@ -1,36 +0,0 @@
-class MKBrut::AppOptions
-  attr_reader :app_name, :app_id, :prefix, :organization, :demo, :versions, :segments
-
-  def initialize(
-    app_name:,
-    app_id: nil,
-    prefix: nil,
-    dry_run: nil,
-    organization: nil,
-    demo: false,
-    versions: nil,
-    **rest
-  )
-    if app_name.nil?
-      raise ArgumentError, "app_name is required"
-    end
-
-    @app_name     =   app_name
-    @app_id       =   app_id       || MKBrut::AppId.from_app_name(@app_name)
-    @prefix       =   prefix       || MKBrut::Prefix.from_app_id(@app_id)
-    @organization =   organization || @app_id
-    @dry_run      = !!dry_run
-    @demo         = !!demo
-    @versions     =   versions
-    @segments     = rest.map { |key,value|
-      if key =~ /^segment-(.+)$/ && value
-        $1
-      else
-        nil
-      end
-    }.compact
-  end
-
-  def dry_run? = @dry_run
-  def demo?    = @demo
-end

data/mkbrut/lib/mkbrut/cli.rb

@@ -1,189 +0,0 @@
-require "optparse"
-require "pathname"
-
-module MKBrut
-  class CLI
-    def initialize(args:, out: $stdout, err: $stderr)
-      @args    = args
-      @out     = out
-      @err     = err
-    end
-
-    def run
-
-      command = if @args.first == "add-segment"
-                  @args.shift
-                  :add_segment
-                elsif @args.first == "new-app" || @args.first == "new"
-                  @args.shift
-                  :new_app
-                else
-                  :new_app
-                end
-
-      if command == :new_app
-        app_options = parse_options(@args, MKBrut::Versions.new)
-        new_app = MKBrut::App.new(
-          current_dir: Pathname.pwd.expand_path,
-          app_options:,
-          out: PrefixedIO.new(@out, "mkbrut"),
-          err: @err
-        )
-        new_app.create!
-      elsif command == :add_segment
-        add_segment_options = parse_add_segment_options(@args, MKBrut::Versions.new)
-        add_segment = MKBrut::AddSegment.new(
-          current_dir: add_segment_options.project_root,
-          add_segment_options:,
-          out: PrefixedIO.new(@out, "mkbrut"),
-          err: @err
-        )
-        add_segment.add!
-        @out.puts ""
-        @out.puts "Sidekiq has now been set up for your app. The configuration used is"
-        @out.puts "a basic one, suitable for getting started, however you know own this"
-        @out.puts "configuration.  Most of it is in these files:"
-        @out.puts ""
-        @out.puts "    app/config/sidekiq.yml"
-        @out.puts "    app/src/back_end/segments/sidekiq_segment.rb"
-        @out.puts ""
-        @out.puts "You are encouraged to verify everything is set up as follows:"
-        @out.puts ""
-        @out.puts "1. Quit dx/start, and start it back up - this will downloaded and set up ValKey/Redis"
-        @out.puts "2. Re-run bin/setup. This will install needed gems and create binstubs"
-        @out.puts "3. Run the example integration test:"
-        @out.puts ""
-        @out.puts "   bin/test e2e specs/integration/sidekiq_works.spec.rb"
-        @out.puts ""
-        @out.puts "   This will use the actual Sidekiq server, so if it passes, you should"
-        @out.puts "   all set and can start creating jobs"
-        @out.puts ""
-      else
-        raise "Unknown command #{command}"
-      end
-      0
-    rescue => e
-      @err.puts "Error: #{e.message}"
-      if ENV["BRUT_CLI_RAISE_ON_ERROR"] == "true"
-        raise
-      end
-      1
-    end
-
-    def show_help(versions)
-      @out.puts @option_parser
-      @out.puts
-      @out.puts "ARGUMENTS"
-      @out.puts
-      @out.puts "    app-name - name for your app, which will be the folder where your app's files are created"
-      @out.puts
-      @out.puts "ENVIRONMENT VARIABLES"
-      @out.puts
-      @out.puts "  BRUT_CLI_RAISE_ON_ERROR - if set to 'true', any error will raise an exception instead of printing to stderr"
-      @out.puts
-    end
-
-  private
-
-
-    def parse_options(args, versions)
-      options = {}
-      @option_parser = OptionParser.new do |opts|
-        opts.accept(MKBrut::Prefix) do |prefix|
-          MKBrut::Prefix.new(prefix)
-        end
-        opts.accept(MKBrut::AppId) do |prefix|
-          MKBrut::AppId.new(prefix)
-        end
-        opts.accept(MKBrut::Organization) do |prefix|
-          MKBrut::Organization.new(prefix)
-        end
-        opts.banner = [
-          "Usage: mkbrut [options] app-name",
-          "",
-          "    Creates a new Brut-powered app",
-          "",
-          "VERSION",
-          "",
-          "    #{MKBrut::VERSION}",
-          "",
-          "OPTIONS",
-          "",
-        ].join("\n")
-
-        opts.on("-a", "--app-id=ID", MKBrut::AppId,
-                "App identifier, which must be able to be used as a hostname or other Internet identifier. Derived from your app name, if omitted")
-
-        opts.on("-o", "--organization=ORG",MKBrut::Organization,
-                "Organization name, e.g. what you'd use for GitHub. Defaults to the app-id value")
-
-        opts.on("-e", "--prefix=PREFIX", MKBrut::Prefix,
-                "Two-character prefix for external IDs and autonomous custom elements. Derived from your app-id, if omitted.")
-
-        opts.on("--dry-run", "Only show what would happen, don't actually do anything")
-        opts.on("--[no-]demo", "Include, or not, additional files that demonstrate Brut's features (default is true for now")
-        {
-          "sidekiq" => "Use Sidekiq for background jobs",
-          "heroku" => "Use Heroku for container-based deployment",
-        }.each do |segment,description|
-          opts.on("--segment-#{segment}", description)
-        end
-        opts.on("-h", "--help", "Show this help message") do
-          show_help(versions)
-          exit
-        end
-      end
-
-      @option_parser.parse!(args, into: options)
-      if !options.key?(:demo)
-        options[:demo] = true
-      end
-
-      options[:app_name] = MKBrut::AppName.new(args.first)
-      options[:app_id] = options[:'app-id']
-      options[:dry_run] = !!options[:'dry-run']
-      MKBrut::AppOptions.new(**options, versions:)
-    end
-
-    def parse_add_segment_options(args, versions)
-      options = {}
-      @option_parser = OptionParser.new do |opts|
-        opts.banner = [
-          "Usage: mkbrut add-segment [options] segment-name",
-          "",
-          "    Adds a segment to an existing Brut-powered app",
-          "",
-          "VERSION",
-          "",
-          "    #{MKBrut::VERSION}",
-          "",
-          "OPTIONS",
-          "",
-        ].join("\n")
-
-        opts.on("-r PROJECT_ROOT_DIR", "--project-root=PROJECT_ROOT_DIR", "Path to the root of the existing Brut app (defaults to current directory)")
-        opts.on("--dry-run", "Only show what would happen, don't actually do anything")
-        opts.on("--[no-]demo", "Include, or not, additional files that demonstrate Brut's features (default is true for now")
-        opts.on("-h", "--help", "Show this help message") do
-          @out.puts @option_parser
-          @out.puts
-          @out.puts "ARGUMENTS"
-          @out.puts
-          @out.puts "    segment-name - name of the segment to add.  Known values:"
-          @out.puts "                   sidekiq - add support for Sidekiq"
-          @out.puts "                   heroku  - add support for Heroku container-based deployment"
-          @out.puts
-          @out.puts "ENVIRONMENT VARIABLES"
-          @out.puts
-          @out.puts "  BRUT_CLI_RAISE_ON_ERROR - if set to 'true', any error will raise an exception instead of printing to stderr"
-          @out.puts
-          exit
-        end
-      end
-
-      @option_parser.parse!(args, into: options)
-      options[:project_root] = Pathname.new(options[:'project-root'] || ".").expand_path
-      MKBrut::AddSegmentOptions.new(segment_name: @args[0], **options, versions:)
-    end
-  end
-end 

data/mkbrut/lib/mkbrut/erb_binding_delegate.rb

@@ -1,20 +0,0 @@
-# This exists because ERB can't working with a SimpleDelegator or
-# Delegate.
-class MKBrut::ErbBindingDelegate
-  def initialize(app_options)
-    @app_options = app_options
-  end
-
-  # Not using Delegate because it won't work with ERB binding
-  def method_missing(syn,*args,&block)
-    if args.empty? && @app_options.respond_to?(syn)
-      @app_options.send(syn)
-    else
-      super
-    end
-  end
-
-  def respond_to_missing?(syn,include_all)
-    @app_options.respond_to?(syn)
-  end
-end

data/mkbrut/lib/mkbrut/ops.rb

@@ -1,17 +0,0 @@
-module MKBrut
-  module Ops
-    autoload :BaseOp, "mkbrut/ops/base_op"
-    autoload :Mkdir, "mkbrut/ops/mkdir"
-    autoload :CopyFile, "mkbrut/ops/copy_file"
-    autoload :RenderTemplate, "mkbrut/ops/render_template"
-    autoload :SkipFile, "mkbrut/ops/skip_file"
-    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"
-    autoload :AddMethod, "mkbrut/ops/add_method"
-  end
-end

data/mkbrut/lib/mkbrut/organization.rb

@@ -1,5 +0,0 @@
-class MKBrut::Organization < MKBrut::InternetIdentifier
-  def initialize(value)
-    super(:organization, value)
-  end
-end

data/mkbrut/lib/mkbrut/segments.rb

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

data/mkbrut/lib/mkbrut/version.rb

@@ -1,3 +0,0 @@
-module MKBrut
-  VERSION = "0.17.0"
-end

data/mkbrut/lib/mkbrut.rb

@@ -1,20 +0,0 @@
-module MKBrut
-  autoload :App, "mkbrut/app"
-  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"
-  autoload :InternetIdentifier, "mkbrut/internet_identifier"
-  autoload :InvalidIdentifier, "mkbrut/invalid_identifier"
-  autoload :Ops, "mkbrut/ops"
-  autoload :Organization, "mkbrut/organization"
-  autoload :Prefix, "mkbrut/prefix"
-  autoload :Segments, "mkbrut/segments"
-  autoload :Versions, "mkbrut/versions"
-  autoload :PrefixedIO, "mkbrut/prefixed_io"
-  autoload :VERSION, "mkbrut/version"
-end

data/mkbrut/mkbrut.gemspec

@@ -1,34 +0,0 @@
-lib = File.expand_path("../lib", __FILE__)
-if !$LOAD_PATH.include?(lib)
-  $LOAD_PATH.unshift(lib)
-end
-require "mkbrut/version"
-Gem::Specification.new do |spec|
-  spec.name          = "mkbrut"
-  spec.version       = MKBrut::VERSION
-  spec.authors       = ["Dave Copeland"]
-  spec.email         = ["davec@naildrivin5.com"]
-
-  spec.summary       = "Create a new Brut App"
-  spec.description   = "mkbrut is how you go from zero to having a Brut app where you can start working."
-  spec.homepage      = "https://brutrb.com"
-  spec.bindir        = "exe"
-
-  spec.files = Dir.glob("lib/**/*.rb") +   # Gem source code
-               Dir.glob(                   # Templates used to create a new Brut app
-                 "templates/**/*",
-                 flags: File::FNM_DOTMATCH
-               ).reject {
-                 it =~ /\/\.{1,2}$/ # Pesky dotfile
-               }.reject {
-                 it =~ /\.DS_Store$/ # FML
-               } +                          
-               [
-                 "exe/mkbrut",             # executable
-               ]
-
-  spec.executables   = ["mkbrut"]
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "rake"
-end 

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

@@ -1,7 +0,0 @@
-#!/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

@@ -1,39 +0,0 @@
-#!/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/db

@@ -1,9 +0,0 @@
-#!/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/scaffold

@@ -1,9 +0,0 @@
-#!/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 / "..")
-