brut 0.5.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ddbdd2db5bb6ea9013486bc8ad279affec3d3a824d05ebbd8c4b4933a1c5468
-  data.tar.gz: 823232c021e8c3d5477bc5655fefe6b51c54efcfcc73ca2ad0cab535964a23f1
+  metadata.gz: add23c2780a2ba1fe444b067c50d3451d9b28cd1bacbed9e1ab1693963bcbd03
+  data.tar.gz: 4f44397c6688843f6d4c9f61121879fd711dfcec5b1b024f6a8be038cc84be54
 SHA512:
-  metadata.gz: 152283ed984e5c7c8cd8faebdc5efbb24867efbe9a18a02a6896ab28654cc9b2b5fa39fe1ac9a13a6d477bd34ec3cb42a96034492d317f5355eb9e4434825395
-  data.tar.gz: 52b69e78ad33ceb908bb6617960a33022f36df621b5d9f3da327a167600cd0c9dbc1902d90d86ec0bdfbef400fa3fded9261b4980feb2dd4264d5c87afb7535f
+  metadata.gz: 787f519b6c620c4586af3f53932fdbc6ded220766d36295ae9220d51d795a7c3498438cb6ad89051061731be95ab8c448d4d6c7519d97490e14ff433e954d747
+  data.tar.gz: b76f693147690b5370f8db06747e6d73f3b9cffae625edaabdb0f3469806bbc2b2966d55aacc101c70e3e7c767690c4f1f8052a61677d90a26ec59753392fea8

data/.gitignore

@@ -38,3 +38,7 @@
 
 # Gems are installed here for LSP convienience
 /local-gems
+
+# All I want in life is for every single instance of this file
+# to be placed in hell, and waiting for Alan Dye when he arrives.
+.DS_Store

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Brut CHANGELOG
 
+## v0.8.0 - July 23, 2025
+
+* Moved `mkbrut` into this repo
+* Unify versioning for Brut, `mkbrut`, BrutJS, and BrutCSS
+* Unify all workspace workflow scripts (see README.md)
+* Minor doc updates to remove references to non-existent `form_tag`
+
 ## v0.5.0 - July 21, 2025
 
 * **New helper** `entity` for creating HTML entities without needing `raw(safe(...))`

data/Dockerfile.dx

@@ -4,6 +4,25 @@ SHELL [ "/bin/bash", "-o", "pipefail", "-c" ]
 
 ENV DEBIAN_FRONTEND=noninteractive
 
+# 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 is only to run stuff like docker build and docker push.
+# It's NOT intended to run docker containers 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
+
+
 # These packages are needed to set up other repos to install other
 # packages and/or are useful in installing other software
 RUN apt-get -y clean && \

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    brut (0.5.0)
+    brut (0.8.0)
       concurrent-ruby
       i18n
       irb

data/README.md

@@ -69,3 +69,22 @@ with your editor, but all commands are run inside Docker, which should be more c
 
    The `--no-credentials` means that you will not be able to push to GitHub or RubyGems from within the Docker container. This ability is only needed by maintainers to push new versions of the gem. You can push to GitHub from your computer.
 
+### Conventions in MonoRepo
+
+This repo contains all five main parts of Brut:
+
+* BrutRB, the Ruby web framework (in this directory, code in `lib`)
+* BrutJS, the JS library with custom elements (in `brut-js/`)
+* BrutCSS, the CSS library (in `brut-css/`)
+* `mkbrut`, the CLI to create new Brut apps (in `mkbrut/`)
+* `brutrb.com`, the website, powered by VitePress (in `brutrb.com`)
+
+Each repo must conform to the *Workspace Protocol*, which are scripts in `bin/` that perform certain tasks:
+
+* `bin/setup` - performs any setup
+* `bin/docs` - builds all documentation, placing it where `brutrb.com` can find it.
+* `bin/build` - builds deployable artifacts, if needed
+* `bin/ci` - runs all tests, if applicable
+
+The primary `bin` scripts at the root work for both BrutRB, the web framework, and recurse into the other directories to perform their
+actions as well.

data/bin/build

@@ -0,0 +1,86 @@
+#!/usr/bin/env ruby
+
+require "optparse"
+require "pathname"
+require "fileutils"
+require "json"
+require_relative "bin_kit"
+
+def main
+
+  brutjs_dir  = (Pathname(__FILE__).dirname / ".." / "brut-js" ).expand_path.to_s
+  brutcss_dir = (Pathname(__FILE__).dirname / ".." / "brut-css" ).expand_path.to_s
+  mkbrut_dir  = (Pathname(__FILE__).dirname / ".." / "mkbrut" ).expand_path.to_s
+
+  require_relative "../lib/brut/version"
+  require_relative "#{mkbrut_dir}/lib/mkbrut/version"
+
+  brut_js_package_json  = JSON.parse(File.read("#{brutjs_dir}/package.json"))
+  brut_css_package_json = JSON.parse(File.read("#{brutcss_dir}/package.json"))
+
+  brut_version     = Brut::VERSION.strip
+  brut_js_version  = brut_js_package_json["version"].strip
+  brut_css_version = brut_css_package_json["version"].strip
+  mkbrut_version   = MKBrut::VERSION.strip
+
+  if [ brut_version, brut_js_version, brut_css_version, mkbrut_version ].uniq.size != 1
+    log "Some versions are mismatched!  All versions should be the same to build and release"
+    puts
+    log sprintf("BrutRb:  %10s from lib/brut/version.rb", brut_version)
+    log sprintf("BrutJS:  %10s from brut-js/package.json", brut_js_version)
+    log sprintf("BrutCSS: %10s from brut-css/package.json", brut_css_version)
+    log sprintf("mkbrut:  %10s from mkbrut/lib/mkbrut/version.rb", mkbrut_version)
+    exit 1
+  else
+    log "Building v#{brut_version} of all artifacts"
+  end
+
+  log "Building brut gem"
+  system!("bin/rake build")
+
+  log "Building brut-js"
+  FileUtils.chdir brutjs_dir do
+    system!("bin/build")
+  end
+
+  log "Building brut-css"
+  FileUtils.chdir brutcss_dir do
+    system!("bin/build")
+  end
+
+  log "Building mkbrut"
+  FileUtils.chdir mkbrut_dir do
+    system!("bin/build")
+  end
+end
+
+options = {
+  repo_check: true,
+}
+OptionParser.new do |opts|
+  opts.banner = "Usage: build [options]\n\n    Builds deployable artifacts\n\nOPTIONS"
+
+  opts.on("-h", "--help", "Display this help message") do
+    puts opts
+    exit
+  end
+  opts.on("--skip-repo-check", "If set, allows you to proceed without a clean Git repo. Note that this may cause gems not to build properly") do
+    options[:repo_check] = false
+  end
+end.parse!
+
+def require_clean_repo!
+  out, err = capture!("git status --porcelain")
+  if out.to_s.strip != ""
+    log out
+    log err
+    log "Your git repository is not clean. Please commit or stash your changes before running this script."
+    exit 1
+  end
+end
+
+if options[:repo_check]
+  require_clean_repo!
+end
+main
+

data/bin/ci

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+
+require "optparse"
+require "pathname"
+require "fileutils"
+require_relative "bin_kit"
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: ci [options]\n\n    Runs all tests/QA in all repos\n\nOPTIONS\n\n"
+
+  opts.on("-h", "--help", "Display this help message") do
+    puts opts
+    puts
+    exit
+  end
+end.parse!
+
+brutjs_dir  = (Pathname(__FILE__).dirname / ".." / "brut-js" ).expand_path.to_s
+brutcss_dir = (Pathname(__FILE__).dirname / ".." / "brut-css" ).expand_path.to_s
+mkbrut_dir  = (Pathname(__FILE__).dirname / ".." / "mkbrut" ).expand_path.to_s
+
+log "Running BrutRB tests"
+system!("bin/rspec")
+
+log "Running brut-js tests"
+FileUtils.chdir brutjs_dir do
+  system!("bin/ci")
+end
+log "Running brut-css tests"
+FileUtils.chdir brutcss_dir do
+  system!("bin/ci")
+end
+log "Running mkbrut tests"
+FileUtils.chdir mkbrut_dir do
+  system!("bin/ci")
+end

data/bin/docs

@@ -3,26 +3,38 @@
 require "optparse"
 require "pathname"
 require "fileutils"
+require_relative "bin_kit"
+
+options = {
+  dotcom: true,
+}
 
-options = {}
 OptionParser.new do |opts|
-  opts.banner = "Usage: docs [options]"
+  opts.banner = "Usage: docs [options]\n\n    Generates all documentation for the project\n\nOPTIONS\n\n"
 
   opts.on("-h", "--help", "Display this help message") do
     puts opts
+    puts
     exit
   end
+  opts.on("--[no-]dotcom", "Deploy (or not), brutrb.com to the docs/ directory (default #{options[:dotcom]})") do |value|
+    options[:dotcom] = value
+  end
 end.parse!
 
-public_dir = (Pathname(__FILE__).dirname / ".." / "brutrb.com" / "public" ).expand_path
-docs_dir   =  public_dir / "api"
-brutjs_dir = (Pathname(__FILE__).dirname / ".." / "brut-js" ).expand_path.to_s
+dotcom_dir  = (Pathname(__FILE__).dirname / ".." / "brutrb.com" ).expand_path
+public_dir  = (dotcom_dir / "public" ).expand_path
+docs_dir    =  public_dir / "api"
+brutjs_dir  = (Pathname(__FILE__).dirname / ".." / "brut-js" ).expand_path.to_s
+brutcss_dir = (Pathname(__FILE__).dirname / ".." / "brut-css" ).expand_path.to_s
+mkbrut_dir  = (Pathname(__FILE__).dirname / ".." / "mkbrut" ).expand_path.to_s
 
-system(
-  "bundle exec yard doc -o '#{docs_dir}' -m markdown -M rdiscount --backtrace"
+system!(
+  "bundle exec yard doc -o '#{docs_dir}' --no-progress -m markdown -M rdiscount --backtrace",
 )
 
-puts "Hacking CSS"
+log "Hacking CSS"
+
 [
   docs_dir /  "css" / "style.css",
   docs_dir /  "css" / "full_list.css"
@@ -44,6 +56,24 @@ puts "Hacking CSS"
   end
 end
 
+log "Generating brut-js docs"
 FileUtils.chdir brutjs_dir do
-  system("bin/build")
+  system!("bin/docs")
+end
+log "Generating brut-css docs"
+FileUtils.chdir brutcss_dir do
+  system!("bin/docs")
+end
+log "Generating mkbrut docs"
+FileUtils.chdir mkbrut_dir do
+  system!("bin/docs")
+end
+
+if options[:dotcom]
+  log "Deploying brutrb.com to docs/"
+  FileUtils.chdir dotcom_dir do
+    system!("bin/deploy")
+  end
+else
+  log "Skipping brutrb.com deployment"
 end

data/bin/publish

@@ -0,0 +1,61 @@
+#!/usr/bin/env ruby
+
+require "optparse"
+require "pathname"
+require "fileutils"
+require "json"
+require_relative "bin_kit"
+
+def main
+
+  log "Building artifacts"
+  system!("bin/build")
+
+  brutjs_dir  = (Pathname(__FILE__).dirname / ".." / "brut-js" ).expand_path.to_s
+  brutcss_dir = (Pathname(__FILE__).dirname / ".." / "brut-css" ).expand_path.to_s
+  mkbrut_dir  = (Pathname(__FILE__).dirname / ".." / "mkbrut" ).expand_path.to_s
+
+  log "Pushing brut"
+  system!("bin/rake release")
+
+  log "Pushing brujt-js"
+  FileUtils.chdir brutjs_dir do
+    system!("bin/publish")
+  end
+
+  log "Pushing brut-css"
+  FileUtils.chdir brutcss_dir do
+    system!("bin/publish")
+  end
+
+  log "Building mkbrut"
+  FileUtils.chdir mkbrut_dir do
+    system!("bin/publish")
+  end
+end
+
+options = {
+  repo_check: true,
+}
+OptionParser.new do |opts|
+  opts.banner = "Usage: publish [options]\n\n    Builds and publishes all artifacts\n\nOPTIONS"
+
+  opts.on("-h", "--help", "Display this help message") do
+    puts opts
+    exit
+  end
+end.parse!
+
+def require_clean_repo!
+  out, err = capture!("git status --porcelain")
+  if out.to_s.strip != ""
+    log out
+    log err
+    log "Your git repository is not clean. Please commit or stash your changes before running this script."
+    exit 1
+  end
+end
+
+require_clean_repo!
+main
+

data/bin/setup

@@ -174,10 +174,16 @@ def setup(update_gems:,setup_credentials:)
       system! "bin/setup"
     end
 
+    log "Setting up mkbrut"
+    FileUtils.chdir project_root / "mkbrut" do
+      system! "bin/setup"
+    end
+
     log "Setting up brutrb.com"
     FileUtils.chdir project_root / "brutrb.com" do
       system! "bin/setup"
     end
+
   else
     log "Not setting up GitHub or RubyGems credentials. You won't be able to push the gem"
   end

data/brut-css/bin/build

@@ -1,5 +1,23 @@
+#!/usr/bin/env bash
 set -e
 
+SCRIPT_DIR=$( cd -- "$( dirname -- "${0}" )" > /dev/null 2>&1 && pwd )
+ROOT_DIR=$(realpath "$SCRIPT_DIR/..")
+
+usage() {
+  echo "Usage: $0"
+  echo
+  echo "    Build CSS for distribution"
+  echo
+}
+
+for arg in "$@"; do
+  if [ "${arg}" = "-h" ] || [ "${arg}" = "--help" ] || [ "${arg}" = "help" ]; then
+    usage
+    exit 0
+  fi
+done
+
 echo "[ bin/docs ] Building brut.css"
 node src/js/build.js \
   -m config/media-queries-all.css \
@@ -17,6 +35,7 @@ node src/js/build.js \
   -p config/pseudo-classes-all.css \
   -i src/css/index.css \
   -o dist/brut-ns-only.max.css
+
 echo "[ bin/docs ] Removing comments and minifying brut-ns-only.css"
 npx postcss --config config dist/brut-ns-only.max.css -o dist/brut-ns-only.css
 rm dist/brut-ns-only.max.css

data/brut-css/bin/ci

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+
+set -e
+SCRIPT_DIR=$( cd -- "$( dirname -- "${0}" )" > /dev/null 2>&1 && pwd )
+ROOT_DIR=$(realpath "$SCRIPT_DIR/..")
+
+usage() {
+  echo "Usage: $0"
+  echo
+  echo "    No-op to comply with workspace protocol"
+  echo
+}
+
+for arg in "$@"; do
+  if [ "${arg}" = "-h" ] || [ "${arg}" = "--help" ] || [ "${arg}" = "help" ]; then
+    usage
+    exit 0
+  fi
+done

data/brut-css/bin/docs

@@ -1,5 +1,24 @@
+#!/usr/bin/env bash
+
 set -e
 
+SCRIPT_DIR=$( cd -- "$( dirname -- "${0}" )" > /dev/null 2>&1 && pwd )
+ROOT_DIR=$(realpath "$SCRIPT_DIR/..")
+
+usage() {
+  echo "Usage: $0"
+  echo
+  echo "    Build CSS docs into the brutrb.com location"
+  echo
+}
+
+for arg in "$@"; do
+  if [ "${arg}" = "-h" ] || [ "${arg}" = "--help" ] || [ "${arg}" = "help" ]; then
+    usage
+    exit 0
+  fi
+done
+
 echo "[ bin/docs ] Building brut.css and docs"
 node src/js/build.js \
   --media-query-config       config/media-queries-all.css \

data/brut-css/bin/publish

@@ -0,0 +1,21 @@
+#!/usr/bin/env bash
+
+set -e
+SCRIPT_DIR=$( cd -- "$( dirname -- "${0}" )" > /dev/null 2>&1 && pwd )
+ROOT_DIR=$(realpath "$SCRIPT_DIR/..")
+
+usage() {
+  echo "Usage: $0"
+  echo
+  echo "    Publish node module"
+  echo
+}
+
+for arg in "$@"; do
+  if [ "${arg}" = "-h" ] || [ "${arg}" = "--help" ] || [ "${arg}" = "help" ]; then
+    usage
+    exit 0
+  fi
+done
+
+npm publish brut-css

data/brut-css/bin/setup

@@ -2,4 +2,5 @@
 
 set -e
 
+echo "[ brut-css/bin/setup ] Setting up BrutCSS"
 npm install

data/brut-css/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "brut-css",
-  "version": "0.5.0",
+  "version": "0.8.0",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "brut-css",
-      "version": "0.5.0",
+      "version": "0.8.0",
       "license": "Hippocratic-2.1",
       "devDependencies": {
         "comment-parser": "^1.4.1",

data/brut-css/package.json

@@ -1,6 +1,6 @@
 {
   "name": "brut-css",
-  "version": "0.5.0",
+  "version": "0.8.0",
   "description": "Utility CSS Library for Full Stack Developers",
   "keywords": [
     "css"

data/brut-js/bin/build

@@ -1,10 +1,19 @@
 #!/usr/bin/env bash
 
 set -e
-SCRIPT_DIR=$(dirname "$0")
+SCRIPT_DIR=$( cd -- "$( dirname -- "${0}" )" > /dev/null 2>&1 && pwd )
 ROOT_DIR=$(realpath "$SCRIPT_DIR/..")
-cd ${ROOT_DIR}/docs
-npx jsdoc --configure   ${ROOT_DIR}/docs/jsdoc.config.json \
-          --readme      ${ROOT_DIR}/README.md \
-          --destination ${ROOT_DIR}/../brutrb.com/public/brut-js/api \
-          --recurse     ${ROOT_DIR}/src/
+
+usage() {
+  echo "Usage: $0"
+  echo
+  echo "    No-op to comply with workspace protocol"
+  echo
+}
+
+for arg in "$@"; do
+  if [ "${arg}" = "-h" ] || [ "${arg}" = "--help" ] || [ "${arg}" = "help" ]; then
+    usage
+    exit 0
+  fi
+done

data/brut-js/bin/docs

@@ -0,0 +1,25 @@
+#!/usr/bin/env bash
+
+set -e
+SCRIPT_DIR=$( cd -- "$( dirname -- "${0}" )" > /dev/null 2>&1 && pwd )
+ROOT_DIR=$(realpath "$SCRIPT_DIR/..")
+
+usage() {
+  echo "Usage: $0"
+  echo
+  echo "    Build JSDoc into the brutrb.com location"
+  echo
+}
+
+for arg in "$@"; do
+  if [ "${arg}" = "-h" ] || [ "${arg}" = "--help" ] || [ "${arg}" = "help" ]; then
+    usage
+    exit 0
+  fi
+done
+
+cd ${ROOT_DIR}/docs
+npx jsdoc --configure   ${ROOT_DIR}/docs/jsdoc.config.json \
+          --readme      ${ROOT_DIR}/README.md \
+          --destination ${ROOT_DIR}/../brutrb.com/public/brut-js/api \
+          --recurse     ${ROOT_DIR}/src/

data/brut-js/bin/publish

@@ -0,0 +1,21 @@
+#!/usr/bin/env bash
+
+set -e
+SCRIPT_DIR=$( cd -- "$( dirname -- "${0}" )" > /dev/null 2>&1 && pwd )
+ROOT_DIR=$(realpath "$SCRIPT_DIR/..")
+
+usage() {
+  echo "Usage: $0"
+  echo
+  echo "    Publish node module"
+  echo
+}
+
+for arg in "$@"; do
+  if [ "${arg}" = "-h" ] || [ "${arg}" = "--help" ] || [ "${arg}" = "help" ]; then
+    usage
+    exit 0
+  fi
+done
+
+npm publish brut-js

data/brut-js/bin/setup

@@ -2,4 +2,5 @@
 
 set -e
 
+echo "[ brut-js/bin/setup ] Setting up BrutJS"
 npm install

data/brut-js/dx

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

data/brut-js/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "brut-js",
-  "version": "0.5.0",
+  "version": "0.8.0",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "brut-js",
-      "version": "0.5.0",
+      "version": "0.8.0",
       "license": "Hippocratic-2.1",
       "devDependencies": {
         "esbuild": "^0.24.0",

data/brut-js/package.json

@@ -1,6 +1,6 @@
 {
   "name": "brut-js",
-  "version": "0.5.0",
+  "version": "0.8.0",
   "type": "module",
   "keywords": [ "WebComponents", "Custom Elements" ],
   "bugs": {

data/brut.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   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.summary       = %q{Web Framework Built around Ruby, Web Standards, Simplicity, and Object-Orientation}
+  spec.description   = %q{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'

data/brutrb.com/bin/setup

@@ -2,4 +2,5 @@
 
 set -e
 
+echo "[ brutrb.com/bin/setup ] Setting up BrutJS"
 npm install

data/brutrb.com/getting-started.md

@@ -11,6 +11,7 @@ The simplest way to use `mkbrut` is to use an existing [Docker image](https://hu
 docker run \
        -v "$PWD":"$PWD" \
        -w "$PWD" \
+       -u $(id -u):$(id -g) \
        -it \
        thirdtank/mkbrut \
        mkbrut my-new-app
@@ -34,6 +35,7 @@ For now:
 docker run \
        -v "$PWD":"$PWD" \
        -w "$PWD" \
+       -u $(id -u):$(id -g) \
        -it \
        thirdtank/mkbrut \
        mkbrut my-new-app
@@ -55,6 +57,7 @@ To create your app without the demo components:
 docker run \
        -v "$PWD":"$PWD" \
        -w "$PWD" \
+       -u $(id -u):$(id -g) \
        -it \
        thirdtank/mkbrut \
        mkbrut my-new-app --no-demo