brut 0.5.0 → 0.8.0

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

@@ -0,0 +1,121 @@
+# Additional classes and configuration for a new Brut
+# app that provides a more demonstration of the features.
+class MKBrut::Segments::Demo < MKBrut::Base
+
+  def self.friendly_name = "Demo features and files"
+
+  def initialize(app_options:, current_dir:, templates_dir:)
+    @project_root  = current_dir / app_options.app_name
+    @templates_dir = templates_dir / "segments" / "Demo"
+    @erb_binding   = ErbBindingDelegate.new(app_options)
+  end
+
+  def add!
+    operations = copy_files(@templates_dir, @project_root) + 
+                 other_operations(@project_root)
+
+    operations.each do |operation|
+      operation.call
+    end
+  end
+
+private
+
+  def other_operations(project_root)
+    [
+      MKBrut::Ops::AddI18nMessage.new(
+        project_root: project_root,
+        hash: {
+          en: {
+            cv: {
+              ss: {
+                not_enough_words: "%{field} does not have enough words",
+                already_posted: "You've already posted a message. Thanks for that!",
+              },
+            },
+            pages: {
+              "NewGuestbookMessagePage": {
+                title: "New guestbook message page",
+              },
+              "GuestbookPage": {
+                title: "Guestbook page",
+              },
+            },
+            guestbook_not_saved: "Your guestbook message was not saved",
+            guestbook_saved: "Thanks for writing!",
+          },
+        }
+      ),
+      MKBrut::Ops::InsertRoute.new(
+        project_root: project_root,
+        code: %{page "/guestbook"},
+      ),
+      MKBrut::Ops::InsertRoute.new(
+        project_root: project_root,
+        code: %{form "/guestbook_message"},
+      ),
+      MKBrut::Ops::InsertRoute.new(
+        project_root: project_root,
+        code: %{page "/new_guestbook_message"},
+      ),
+      MKBrut::Ops::InsertCodeInMethod.new(
+        file: project_root / "app" / "src" / "back_end" / "data_models" / "seed" / "seed_data.rb",
+        class_name: "SeedData",
+        method_name: "seed!",
+        code: %{
+10.times do
+  create(:guestbook_message, created_at: Date.today - rand(1..100))
+end
+}
+      ),
+      MKBrut::Ops::AddCSSImport.new(
+        project_root: project_root,
+        import: "constraint-violations.css"
+      ),
+      MKBrut::Ops::AddCSSImport.new(
+        project_root: project_root,
+        import: "fonts.css"
+      ),
+      MKBrut::Ops::InsertCodeInMethod.new(
+        file: project_root / "app" / "src" / "front_end" / "pages"/ "home_page.rb",
+        class_name: "HomePage",
+        method_name: "page_template",
+        where: :start,
+        code: %{
+div(class: "w-50 mh-auto mt-4") do
+  a(href: NewGuestbookMessagePage.routing,
+    class: "db f-3 ff-sans blue-400 fw-bold tc"
+  ) do
+    "Sign The Guestbook!"
+  end
+end
+}
+      ),
+      MKBrut::Ops::AddMethod.new(
+        file: project_root / "app" / "src" / "front_end" / "support" / "app_session.rb",
+        class_name: "AppSession",
+        code: %{def signed_guestbook? = !!self.guestbook_message},
+      ),
+      MKBrut::Ops::AddMethod.new(
+        file: project_root / "app" / "src" / "front_end" / "support" / "app_session.rb",
+        class_name: "AppSession",
+        code: %{
+def guestbook_message
+  DB::GuestbookMessage.find(
+    external_id: self[:guestbook_message_external_id]
+  )
+end
+}
+      ),
+      MKBrut::Ops::AddMethod.new(
+        file: project_root / "app" / "src" / "front_end" / "support" / "app_session.rb",
+        class_name: "AppSession",
+        code: %{
+def signed_guestbook(guestbook_message)
+  self[:guestbook_message_external_id] = guestbook_message.external_id
+end
+}
+      ),
+    ]
+  end
+end

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

@@ -0,0 +1,30 @@
+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
+    @templates_dir = templates_dir / "segments" / "Heroku"
+    @erb_binding   = MKBrut::ErbBindingDelegate.new(app_options)
+  end
+
+  def add!
+    operations = copy_files(@templates_dir, @project_root) + 
+                 other_operations
+
+    operations.each do |operation|
+      operation.call
+    end
+  end
+
+  def other_operations
+    [
+      MKBrut::Ops::AppendToFile.new(
+        file: @project_root / ".gitignore",
+        content: %{
+# These are generated by bin/deploy
+deploy/Dockerfile.*
+}
+      )
+    ]
+  end
+end

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

@@ -0,0 +1,3 @@
+# Adds Sidekiq to a Brut app
+class MKBrut::Segments::Sidekiq
+end

data/mkbrut/lib/mkbrut/segments.rb

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

data/mkbrut/lib/mkbrut/version.rb

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

data/mkbrut/lib/mkbrut/versions.rb

@@ -0,0 +1,13 @@
+require "pathname"
+require "json"
+require_relative "version"
+
+class MKBrut::Versions
+  def initialize
+    @brut_version = MKBrut::VERSION
+  end
+
+  def brut_version_specifier     = "~> #{@brut_version}"
+  def brut_css_version_specifier = "~#{@brut_version}"
+  def brut_js_version_specifier  = "~#{@brut_version}"
+end

data/mkbrut/lib/mkbrut.rb

@@ -0,0 +1,18 @@
+module MKBrut
+  autoload :App, "mkbrut/app"
+  autoload :AppId, "mkbrut/app_id"
+  autoload :AppName, "mkbrut/app_name"
+  autoload :AppOptions, "mkbrut/app_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

@@ -0,0 +1,32 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+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/.dockerignore

@@ -0,0 +1,25 @@
+# Ignore git directory.
+/.git/
+/.gitignore
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore all environment files
+/.env*
+
+# Ignore all logfiles and tempfiles.
+/logs/*
+/tmp/*
+
+# The most important thing to ignore of all time
+/node_modules/
+
+# Ignore generated assets
+/app/public/*
+
+# Ignore Docker-related files
+/.dockerignore
+/Dockerfile*
+/docker-compose.*
+/deploy/docker-compose.*

data/mkbrut/templates/Base/.env.development.erb

@@ -0,0 +1,60 @@
+# Environment variables needed for running in development.  This file
+# also serves as the canonical list of ALL environment variables the app
+# must have in production.
+#
+# Each env var should be preceded by a comment explaining its purpose.
+# The env var itself can be written in one of two ways:
+#
+# * Conventionally set a value:
+#
+#   ```
+#   # the API key to interact with the OCP Widgets Service.
+#   WIDGETS_API_KEY=some-value
+#   ```
+#   Ideally, all values are set this way so that everyone is using the same
+#   value and the app just works without having to go to an external service
+#   to get a real secret for local development.
+#
+# * Indicates a local override is required:
+#
+#   ```
+#   # the API key to interact with the OCP Widgets Service.
+#   LOCAL:WIDGETS_API_KEY
+#   ```
+#
+#   In this form, bin/setup will ask the developer for the value and place
+#   it in .env.development.local.  As your app evolves and adds more
+#   environment variables, you can add them like this and `bin/setup` will
+#   see which ones are present vs missing.
+
+# Session secret used to encrypt the session
+SESSION_SECRET=<%= session_secret %>
+# URL to the database
+DATABASE_URL=postgres://postgres:postgres@postgres:5432/<%= app_id %>_development
+
+# Configures the endpoint where OTel traces are sent.
+# In dev and test, it's the otel-desktop-viewer set up in
+# docker-compose.dx.yml.  For production, consult your
+# OTel vendor's documentation.
+OTEL_EXPORTER_OTLP_ENDPOINT="http://otel-desktop-viewer:4318"
+
+# OTel exporter to use for sending traces to the endpoint. You usually
+# want otlp, however, in production, consult your vendor's documentation to be sure.
+OTEL_TRACES_EXPORTER="otlp"
+
+# OTel exporter protocol. You usually want http/protobuf, however,
+# in production, consult your vendor's documentation to be sure.
+OTEL_EXPORTER_OTLP_PROTOCOL="http/protobuf"
+
+# This controls the background thread used by the span processor.
+# I swear I had to set this to false to make stuff work, however
+# various corporate AI chatbots said it should be true for use with
+# Puma.  I'm going with my hazy memory for now.
+OTEL_RUBY_BSP_START_THREAD_ON_BOOT=false
+
+# OTel log level.  Set this to "debug" to try to figure out why OTel isn't working.
+OTEL_LOG_LEVEL=warn
+
+# If set to true, Puma will log its configuration, which is handy to understand
+# if what you think you configured actually got configured.
+PUMA_LOG_CONFIG=true

data/mkbrut/templates/Base/.env.test.erb

@@ -0,0 +1,8 @@
+SESSION_SECRET=<%= session_secret %>
+DATABASE_URL=postgres://postgres:postgres@postgres:5432/<%= app_id %>_test
+OTEL_EXPORTER_OTLP_ENDPOINT="http://otel-desktop-viewer:4318"
+OTEL_TRACES_EXPORTER="otlp"
+OTEL_EXPORTER_OTLP_PROTOCOL="http/protobuf"
+OTEL_RUBY_BSP_START_THREAD_ON_BOOT=false
+OTEL_LOG_LEVEL=warn
+PUMA_LOG_CONFIG=true

data/mkbrut/templates/Base/.gitignore

@@ -0,0 +1,31 @@
+# Never checkin tmp
+/tmp
+# This should never be checked in
+/node_modules
+# This contains generated code, so should not be checked in
+/app/public/css
+# This contains generated code, so should not be checked in
+/app/public/js
+# This contains generated code, so should not be checked in
+/app/public/static/images/
+# Don't want to check in the generated JSDocs dir
+/jsdocs
+# This is generated per environment
+/app/config/asset_metadata.json
+# Don't check in logs
+/logs
+
+# This could contain actual secrets and should not be checked in
+/.env.development.local
+
+# These are generated artifacts
+/deploy/Dockerfile.*
+/deploy/docker-compose.yml
+
+# RSpec configuration should be in one place.
+# Devs can override as needed, but this is not how
+# configuration is to be shared
+/.rspec
+
+# Gems installed locally should not be checked in
+/local-gems

data/mkbrut/templates/Base/.projections.json

@@ -0,0 +1,59 @@
+{
+  "app/src/*.rb": {
+    "alternate": "specs/{}.spec.rb",
+    "type": "source"
+  },
+  "app/src/front_end/js/*.js": {
+    "alternate": "specs/front_end/js/{}.spec.js",
+    "type": "js"
+  },
+  "specs/*.spec.rb": {
+    "alternate": "app/src/{}.rb",
+    "type": "spec"
+  },
+  "specs/front_end/js/*.spec.js": {
+    "alternate": "app/src/front_end/js/{}.js",
+    "type": "jsspec"
+  },
+  "app/src/front_end/components/*.rb": {
+    "type": "component"
+  },
+  "app/src/front_end/forms/*.rb": {
+    "type": "form"
+  },
+  "app/src/front_end/handlers/*.rb": {
+    "type": "handler"
+  },
+  "app/src/front_end/pages/*.rb": {
+    "type": "page"
+  },
+  "app/src/front_end/pages/*.html.rb": {
+    "type": "erb"
+  },
+  "app/src/back_end/data_models/db/*.rb": {
+    "type": "db"
+  },
+  "app/src/back_end/data_models/migrations/*.rb": {
+    "type": "migration"
+  },
+  "app/src/back_end/data_models/migrations/*.sql": {
+    "type": "migration"
+  },
+  "app/src/back_end/data_models/seed/*.rb": {
+    "type": "seed"
+  },
+  "app/src/back_end/domain/*.rb": {
+    "type": "domain"
+  },
+  "app/src/back_end/jobs/*.rb": {
+    "type": "job"
+  },
+  "app/src/back_end/service_wrappers/*.rb": {
+    "type": "service_wrapper"
+  },
+  "specs/factories/*.factory.rb": {
+    "type": "factory",
+    "alternate": "app/src/back_end/data_models/{}.rb"
+  }
+
+}

data/mkbrut/templates/Base/Dockerfile.dx

@@ -0,0 +1,205 @@
+# This file is heavily documented to explain what is going on and why.
+# If you are reading this, however, you now own this file and can
+# change it how you like. Just be sure you understand how it works in the
+# context of docker-compose.dx.yml and the files in dx/,
+# which are referred to as the Workspace
+#
+# This file is a set of instructions to build a Docker _image_, which is
+# then use to _start_ a _container_.
+
+# This uses a base image where Ruby is already installed. This saves
+# us from having to install Ruby ourselves.  Change this whenever you update
+# Ruby. Note that by convention, "3.4" will be whatever the latest point
+# release of Ruby 3.4 is. If you don't want that, specify an exact Ruby version here.
+# Note that this value is intended to be in sync with the tag of the image
+# found in dx/docker-compose.env
+FROM ruby:3.4
+
+# This attempts to make RUN directives fail when UNIX pipelines are involved
+SHELL [ "/bin/bash", "-o", "pipefail", "-c" ]
+
+# This tells apt-get and friends not to ask for interactive input
+# as this creates massive confusion in the context of building a Docker image.
+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
+#
+# - 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 && \
+    apt-get -y update && \
+    apt-get install --quiet --yes \
+      ca-certificates \
+      curl \
+      gnupg \
+      lsb-release \
+      rsync \
+      vim
+
+# These are dependencies needed to install Chromium via Playright.
+# You can check this list via
+#
+#     npx playwright install-deps --dry-run chromium
+#
+RUN apt-get install -y --no-install-recommends libasound2 \
+                                               libatk-bridge2.0-0 \
+                                               libatk1.0-0 \
+                                               libatspi2.0-0 \
+                                               libcairo2 \
+                                               libcups2 \
+                                               libdbus-1-3 \
+                                               libdrm2 \
+                                               libgbm1 \
+                                               libglib2.0-0 \
+                                               libnspr4 \
+                                               libnss3 \
+                                               libpango-1.0-0 \
+                                               libx11-6 \
+                                               libxcb1 \
+                                               libxcomposite1 \
+                                               libxdamage1 \
+                                               libxext6 \
+                                               libxfixes3 \
+                                               libxkbcommon0 \
+                                               libxrandr2 \
+                                               xvfb \
+                                               fonts-noto-color-emoji \
+                                               fonts-unifont \
+                                               libfontconfig1 \
+                                               libfreetype6 \
+                                               xfonts-scalable \
+                                               fonts-liberation \
+                                               fonts-ipafont-gothic \
+                                               fonts-wqy-zenhei \
+                                               fonts-tlwg-loma-otf \
+                                               fonts-freefont-ttf
+
+
+# Install Docker itself. Note that this is installed only what is needed to run
+# the Docker CLI - the docker-compose.dx.yml will connect this docker's socket
+# to the one on the host. This sets up "Docker outside Docker" and
+# is here only to build the production Docker containers and to push
+# them to a repository. This is not intended to run containers from
+# inside this one.
+RUN install -m 0755 -d /etc/apt/keyrings && \
+    curl -fsSL https://download.docker.com/linux/debian/gpg | gpg --dearmor -o /etc/apt/keyrings/docker.gpg && \
+    chmod a+r /etc/apt/keyrings/docker.gpg  && \
+    echo \
+      "deb [arch="$(dpkg --print-architecture)" signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/debian \
+      "$(. /etc/os-release && echo "$VERSION_CODENAME")" stable" | \
+      tee /etc/apt/sources.list.d/docker.list > /dev/null && \
+    apt-get update --quiet --yes && \
+    apt-get install --quiet --yes docker-ce \
+                       docker-ce-cli \
+                       containerd.io \
+                       docker-buildx-plugin \
+                       docker-compose-plugin
+
+
+# Install Postgres Client, per https://www.postgresql.org/download/linux/debian/
+# Note that ca-certificates and curl are installed above
+#
+# Also note that the version here should match the version set up in
+# docker-compose.dx.yml
+RUN sh -c 'echo "deb http://apt.postgresql.org/pub/repos/apt $(lsb_release -cs)-pgdg main" > /etc/apt/sources.list.d/pgdg.list' && \
+    wget --quiet -O - https://www.postgresql.org/media/keys/ACCC4CF8.asc | apt-key add - && \
+    apt-get update && \
+    apt-get -y install postgresql-client-16
+
+# Update RubyGems and Bundler, setting RubyGems not to generate
+# documentation as that is slow and you likely won't use it.
+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
+# as the root user on your computer. You don't want that.
+
+# What is tricky is that we ultimately want the non-root user here
+# to have the same UID and same groups as your user on your host/computer.
+# And, we want that user to be able to run Docker commands.
+
+# First, set up some build args that `dx/build` will override with the actual values.
+# The reason these all have values is that Docker will not fail if they are omitted,
+# but it will behave strangely.
+#
+# Their user id, which ideally is overridden to match your user id on the host
+ARG user_uid=10001
+
+# Their group id, which ideally is overridden to match your group id on the host
+ARG user_gid=10002
+
+# The group id that can access /var/run/docker.sock on the host.
+# If this isn't mapped properly, no docker-out-of-docker commands will work
+ARG docker_gid=10003
+
+# This can be blank if the OS is such that the user inside the container can access
+# /var/run/docker.sock simply from being in docker_gid.  If this is not
+# the case (as on macOS), it is not only sad, but we must add the group
+# 0 (root) to the groups our new user is in.
+ARG sadly_user_must_be_added_to_root=
+
+# Create the user's group ID if it does not exist
+RUN getent group ${user_gid} || groupadd --gid ${user_gid} appgroup
+
+# Create the docker group id if it does not exist
+RUN getent group ${docker_gid} || groupadd --gid ${docker_gid} hostdocker
+
+# Create the user and set up their shell.
+# Note that we put bash_customizations in both .profile and .bashrc
+# to increase the chances they are used when running bash in various configurations
+RUN useradd --uid ${user_uid} --gid ${user_gid} --groups ${sadly_user_must_be_added_to_root}${docker_gid} --create-home --home-dir /home/appuser appuser && \
+    echo ". ~/.bash_customizations" >> /home/appuser/.profile && \
+    echo ". ~/.bash_customizations.local" >> /home/appuser/.profile && \
+    echo ". ~/.bash_customizations" >> /home/appuser/.bashrc && \
+    echo ". ~/.bash_customizations.local" >> /home/appuser/.bashrc
+
+# Now we must grant ownership to the new user over various files they will need to
+# run or use
+COPY --chown=appuser:${user_gid} dx/show-help-in-app-container-then-wait.sh /home/appuser
+COPY --chown=appuser:${user_gid} dx/bash_customizations /home/appuser/.bash_customizations
+COPY --chown=appuser:${user_gid} dx/bash_customizations.local /home/appuser/.bash_customizations.local
+
+# This switches to the new user, meaniung all subsequent RUN directives will
+# be run as this user.  The USER directive allows changing both the user
+# and the current group. We are omitting the group part of that because
+# to include would exclude the user from all other groups we just set them up
+# 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
+
+
+
+# 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 && \
+    npx playwright install chromium