brut 0.0.21 → 0.0.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13ef62dae2d2a40f20fce1aa2f5df7809fc41ae99b75b2a9aefd25423ef51fb3
-  data.tar.gz: 65b9e0b2b77a441210d0047da5c6c8f77d01d97a954d64626683d11fa7f2f1d1
+  metadata.gz: 661bfefb9cded225579d7faae56e20458a403a26e2d336c7cd6c6c7cba832b4d
+  data.tar.gz: d09d29af185d03035d0f4256bc1d42f784c3b7ad3f6f0aadb8caf3fa41464c44
 SHA512:
-  metadata.gz: 4a524485b78b02dd2fee75c540b8cef83fc1c79e8ffa6ec8b214995000c42c6e41db5dbfe8ab65fe28b3e9f08eb9edb63f9156e4208618750f3165bf548995ee
-  data.tar.gz: af71268d9598c889731db3cbff39c47d14173ae4112b4eb9e723ff917bf036da93ee4efb3bdffc7f0fc1136abc71b089ab64fe0f8e503226f61e1b0511ffa9f1
+  metadata.gz: a942224c334d13e01f869f75ec80aaa0cf46089d5d93c39ad9e297d5518d28f1487ba028e47bd9dea745503a9a34becdb458ef00c485759930a099182f3f1e47
+  data.tar.gz: 9264c21ebd224c64c73d157b54020e2cab1f0c2779d5b9df8cd34746a08aa0b62b6898941df49d53ca8ddb9b93066b7e723e9775917e3a551decbdbbe4f8000f

data/.gitignore

@@ -6,8 +6,29 @@
 # should never be checked in
 /dx/credentials
 
-# Don't know what this is for, so not checking it in.
+# Holds metadata during YARD builds. Don't need this checked in
 /.yardoc
+# Location of YARD templates, this is temporary
+/.yard
 
-# Ignore the docs for now
-/docs
+# This is where generated API docs go
+/brutrb.com/public/api
+/brutrb.com/public/brut-js/api
+/brutrb.com/public/brut-css
+# This is a cache which is not to be checked in
+/brutrb.com/.vitepress/cache
+# Staging area for production deploy of the docs
+/brutrb.com/.vitepress/dist
+
+# lots of node_modules to avoid
+/brutrb.com/node_modules
+/brut-js/node_modules
+/brut-js/docs/node_modules
+/brut-css/node_modules
+
+# This is where the bundle is built during testing for BuildJS
+/brut-js/specs/public/js
+# This is a staging area for the distributions of the .css files
+/brut-css/dist
+# This is where the CSS lives temporarily while docs are being built
+/brut-css/src/docs/brut.css

data/.nvim.lua

@@ -0,0 +1 @@
+useLSP = true

data/Dockerfile.dx

@@ -1,4 +1,4 @@
-FROM ruby:3.3
+FROM ruby:3.4
 
 SHELL [ "/bin/bash", "-o", "pipefail", "-c" ]
 
@@ -10,8 +10,8 @@ RUN apt-get -y clean && \
     apt-get -y update && \
     apt-get install --quiet --yes ca-certificates curl gnupg rsync
 
-# Install NODE per https://github.com/nodesource/distributions?tab=readme-ov-file#using-debian-as-root-nodejs-20
-RUN curl -fsSL https://deb.nodesource.com/setup_20.x -o /tmp/nodesource_setup.sh && \
+# Install NODE per https://github.com/nodesource/distributions?tab=readme-ov-file#using-debian-as-root-nodejs-22
+RUN curl -fsSL https://deb.nodesource.com/setup_22.x -o /tmp/nodesource_setup.sh && \
     bash /tmp/nodesource_setup.sh && \
     apt-get install -y nodejs
 
@@ -27,6 +27,15 @@ RUN echo "gem: --no-document" >> ~/.gemrc && \
     gem update --system && \
     gem install bundler
 
+# Need vim at all times
+ENV EDITOR=vim
+RUN apt-get install -y vim && \
+    echo "set -o vi" >> /root/.bashrc
+
+# Node's colors are hand-crafted to always look bad and render at least some text unreadable 
+# no matter what your setup. Cool.
+ENV NODE_DISABLE_COLORS=1
+
 # This entrypoint produces a nice help message and waits around for you to do
 # something with the container.
 COPY dx/show-help-in-app-container-then-wait.sh /root

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    brut (0.0.21)
+    brut (0.0.23)
       concurrent-ruby
       i18n
       irb
@@ -77,20 +77,22 @@ GEM
       rdoc (>= 4.0.0)
       reline (>= 0.4.2)
     logger (1.6.1)
+    mini_portile2 (2.8.9)
     minitest (5.25.1)
     mustermann (3.0.3)
       ruby2_keywords (~> 0.0.1)
-    nokogiri (1.16.7-aarch64-linux)
+    nokogiri (1.18.8)
+      mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
-    nokogiri (1.16.7-arm-linux)
+    nokogiri (1.18.8-aarch64-linux-gnu)
       racc (~> 1.4)
-    nokogiri (1.16.7-arm64-darwin)
+    nokogiri (1.18.8-arm-linux-gnu)
       racc (~> 1.4)
-    nokogiri (1.16.7-x86-linux)
+    nokogiri (1.18.8-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.16.7-x86_64-darwin)
+    nokogiri (1.18.8-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.16.7-x86_64-linux)
+    nokogiri (1.18.8-x86_64-linux-gnu)
       racc (~> 1.4)
     opentelemetry-api (1.4.0)
     opentelemetry-common (0.21.0)

data/README.md

@@ -48,10 +48,3 @@ 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.
 
-## Docs
-
-* See {file:doc-src/architecture.md Architecture}
-* See {file:doc-src/pages.md Pages and Components}
-* See {file:doc-src/forms.md Forms}
-* See {file:docs-src/keyword-injection.md Keyword Injection}
-* See {file:docs-src/route-hooks.md Route Hooks}

data/Rakefile

@@ -3,12 +3,15 @@ require "bundler/gem_tasks"
 require "pathname"
 
 docs_dir = (Pathname(__FILE__).dirname / "docs").expand_path.to_s
+plugins_dir = (Pathname(__FILE__).dirname / "yard-plugins" ).expand_path.relative_path_from(
+  Pathname(__FILE__).dirname
+)
 desc "Generate YARD doc"
 task :docs do
-  files = Dir["doc-src/*.md"].map { |file|
-    "--files #{file}"
+  plugins_flags = Dir["#{plugins_dir}/*.rb"].map { |f| 
+    "-e #{f}"
   }.join(" ")
-  system "bundle exec yard doc -o '#{docs_dir}' #{files} -m markdown -M rdiscount --backtrace"
+  system "bundle exec yard doc #{plugins_flags} -o '#{docs_dir}' -m markdown -M rdiscount --backtrace"
 end
 
 desc "Show YARD status"
@@ -20,4 +23,3 @@ desc "Clean up droppings"
 task :clean do
   FileUtils.rm_rf docs_dir, verbose: true
 end
-

data/bin/dev

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+require "optparse"
+require "pathname"
+require "fileutils"
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: docs [options]"
+
+  opts.on("-h", "--help", "Display this help message") do
+    puts opts
+    exit
+  end
+end.parse!
+
+dot_com_dir = (Pathname(__FILE__).dirname / ".." / "brutrb.com" ).expand_path.to_s
+FileUtils.chdir dot_com_dir do
+  system "bin/dev"
+end

data/bin/docs

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+
+require "optparse"
+require "pathname"
+require "fileutils"
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: docs [options]"
+
+  opts.on("-h", "--help", "Display this help message") do
+    puts opts
+    exit
+  end
+end.parse!
+
+public_dir = (Pathname(__FILE__).dirname / ".." / "brutrb.com" / "public" ).expand_path.to_s
+docs_dir   =  public_dir + "/api"
+brutjs_dir = (Pathname(__FILE__).dirname / ".." / "brut-js" ).expand_path.to_s
+
+system(
+  "bundle exec yard doc -o '#{docs_dir}' -m markdown -M rdiscount --backtrace"
+)
+
+FileUtils.chdir brutjs_dir do
+  system("bin/build")
+end

data/bin/setup

@@ -16,8 +16,14 @@ def setup(update_gems:,setup_credentials:)
     system! "bundle check --no-color || bundle install --no-color --quiet"
   end
 
+  log "Installing Ruby LSP"
+  system! "gem install ruby-lsp"
+
+  log "Installing JS/TS and CSS LSPs"
+  system! "npm install -g typescript typescript-language-server vscode-langservers-extracted"
+
+  project_root = Pathname($0).dirname / ".."
   if setup_credentials
-    project_root = Pathname($0).dirname / ".."
     credentials_dir = project_root / "dx" / "credentials"
     if credentials_dir.exist?
       if credentials_dir.directory?
@@ -132,6 +138,46 @@ def setup(update_gems:,setup_credentials:)
         exit 1
       end
     end
+
+    npm_credentials_dest = Pathname("/") / "root" / ".npmrc"
+    if npm_credentials_dest.exist?
+      log "NPM credentials look good"
+    else
+      log "#{npm_credentials_dest} doesn't exist - creating"
+      FileUtils.mkdir_p npm_credentials_dest.dirname
+      npm_credentials_source = credentials_dir / "npmrc"
+      if npm_credentials_source.exist?
+        log "#{npm_credentials_source} exists - copying it to #{npm_credentials_dest}"
+        FileUtils.cp npm_credentials_source,npm_credentials_dest
+      else
+        log "#{npm_credentials_source} must contain an NPM credentials file"
+        log ""
+        log "If you don't have a ~/.npmrc file on your computer, create one:"
+        log "  1. On your computer (not inside Docker), run this:"
+        log ""
+        log "     npm adduser"
+        log ""
+        log "  2. Then follow the instructions.  When it's done ~/.npmrc will have been created"
+        log ""
+        log "Copy ~/.npmrc into #{npm_credentials_source} and re-run this script"
+        exit 1
+      end
+    end
+
+    log "Setting up BrutJS"
+    FileUtils.chdir project_root / "brut-js" do
+      system! "bin/setup"
+    end
+
+    log "Setting up BrutCSS"
+    FileUtils.chdir project_root / "brut-css" 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/.nvim.lua

@@ -0,0 +1 @@
+useLSP = true

data/brut-css/README.md

@@ -0,0 +1,28 @@
+# Brut CSS - A simple utility CSS library get you started
+
+This is a utility CSS library that provides single-purpose classes you can use together to prototpye and
+design directly in your HTML or HTML-generation code.  But it is minimal.
+
+It mostly exists to be included with BrutRB to allow developers to immediately start creating usable UI or
+HTML without having to install and setup something else.  It can also be the basis of a real CSS solution
+for a real app.
+
+## Install
+
+```
+npm install brut-css
+```
+
+Then, in your CSS
+
+```css
+@import "brut-css/dist/brut.css";
+```
+
+## Usage
+
+See [the docs](https://brutrb.com/brut-css).
+
+## Development
+
+This is done as part of the main Brut dev environment.

data/brut-css/bin/build

@@ -0,0 +1,31 @@
+set -e
+
+echo "[ bin/docs ] Building brut.css"
+node src/js/build.js \
+  -m config/media-queries-all.css \
+  -p config/pseudo-classes-all.css \
+  -i src/css/index.css \
+  -o dist/brut.max.css \
+
+echo "[ bin/docs ] Removing comments and minifying brut.css"
+npx postcss --config config dist/brut.max.css -o dist/brut.css
+rm dist/brut.max.css
+
+echo "[ bin/docs ] Building brut-ns-only.css"
+node src/js/build.js \
+  -m config/media-queries-minimal.css \
+  -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
+
+echo "[ bin/docs ] Building brut-thin.css"
+node src/js/build.js \
+  -p config/pseudo-classes-all.css \
+  -i src/css/index.css \
+  -o dist/brut-thin.max.css
+echo "[ bin/docs ] Removing comments and minifying brut-thin.css"
+npx postcss --config config dist/brut-thin.max.css -o dist/brut-thin.css
+rm dist/brut-thin.max.css

data/brut-css/bin/dev

@@ -0,0 +1 @@
+npx http-server generated-docs -p 8086 -c-1

data/brut-css/bin/docs

@@ -0,0 +1,15 @@
+set -e
+
+echo "[ bin/docs ] Building brut.css and docs"
+node src/js/build.js \
+  --media-query-config       config/media-queries-all.css \
+  --pseudo-class-config      config/pseudo-classes-all.css \
+  --input                    src/css/index.css \
+  --output                   src/docs/brut.max.css \
+  --docs-dir                 ../brutrb.com/public/brut-css \
+  --path-to-brut-css-root    /brut-css \
+  --docs-template-source-dir src/docs
+
+npx postcss --config config src/docs/brut.max.css -o src/docs/brut.css
+rm src/docs/brut.max.css
+

data/brut-css/bin/setup

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+
+set -e
+
+npm install

data/brut-css/config/media-queries-all.css

@@ -0,0 +1,15 @@
+/* Not-small screens, essentially anything that is likely not a mobile device.
+ * @suffix ns
+ */
+@media screen and (min-width: 30em) {
+}
+/* Medium-sized screens.
+ * @suffix m
+ */
+@media screen and (min-width: 30em) and (max-width: 60em) {
+}
+/* Large screens.
+ * @suffix l
+ */
+@media screen and (min-width: 60em) {
+}

data/brut-css/config/media-queries-minimal.css

@@ -0,0 +1,5 @@
+/* Not-small screens, essentially anything that is likely not a mobile device.
+ * @suffix ns
+ */
+@media screen and (min-width: 30em) {
+}

data/brut-css/config/postcss.config.cjs

@@ -0,0 +1,7 @@
+module.exports = {
+  plugins: [
+    require('cssnano')({
+      preset: ['default', { discardComments: { removeAll: true } }],
+    }),
+  ],
+};

data/brut-css/config/pseudo-classes-all.css

@@ -0,0 +1,9 @@
+@brut-pseudo(hover hover true) {
+  @brut-classes-with-prefix(bg-);
+  @brut-class(tdu);
+  @brut-colors;
+}
+@brut-pseudo(disabled disabled) {
+  @brut-classes-with-prefix(bg-gray);
+  @brut-classes-with-prefix(gray-);
+}

data/brut-css/dx

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