brut 0.4.0 → 0.8.0

data/mkbrut/lib/mkbrut/segments/bare_bones.rb

@@ -0,0 +1,185 @@
+# The bare bones configuration on top of a blank Brut app.
+class MKBrut::Segments::BareBones < MKBrut::Base
+
+  def self.friendly_name = "Bare bones framing"
+
+  def initialize(app_options:, current_dir:, templates_dir:)
+    @project_root  = current_dir / app_options.app_name
+    @templates_dir = templates_dir / "segments" / "BareBones"
+    @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
+
+  def other_operations(project_root)
+    [
+      MKBrut::Ops::InsertRoute.new(
+        project_root: @project_root,
+        code: %{path "/trigger_exception", method: :get}
+      ),
+      MKBrut::Ops::InsertCodeInMethod.new(
+        file: @project_root / "app" / "src" / "app.rb",
+        class_name: "App",
+        method_name: "initialize",
+        code: %{
+Brut.container.store(
+  "trigger_exception_key",
+  String,
+  "String used to prevent anyone from triggering exceptions in TriggerExceptionHandler"
+) do
+  ENV.fetch("TRIGGER_EXCEPTION_KEY")
+end},
+      ),
+      InsertCustomElement.new(
+        project_root: @project_root,
+        element_class_name: "Example",
+      ),
+      MKBrut::Ops::InsertCodeInMethod.new(
+        file: @project_root / "app" / "src" / "front_end" / "pages" / "home_page.rb",
+        class_name: "HomePage",
+        method_name: "page_template",
+        code: %{
+#{ @erb_binding.prefix }_example(
+  transform: "upper",
+  class: [ "pos-fixed",
+           "bottom-0",
+           "left-0",
+           "w-100",
+           "ff-sans",
+           "lh-title",
+           "tracked",
+           "f-5",
+           "f-6-ns",
+           "tc",
+           "pa-3",
+           "mt-3",
+           "db", ]
+) do
+  "We Like the Web"
+end
+}
+      ),
+      InsertEndToEndTestCode.new(
+        file: @project_root / "specs" / "e2e" / "home_page.spec.rb",
+        code: %{
+    example = page.locator("#{ @erb_binding.prefix }-example")
+    # The #{ @erb_binding.prefix }-example custom element will transform
+    # the text it contains.  Since this is an end-to-end test
+    # the element should've done its thing and given us 
+    # upper-case text.
+    expect(example).to have_text("WE LIKE THE WEB") }
+      ),
+      MKBrut::Ops::AppendToFile.new(
+        file: @project_root / ".env.development",
+        content: %{
+# Key used to allow triggering an exception. This is required to prevent
+# just anyone from triggering one.
+TRIGGER_EXCEPTION_KEY=dev-trigger-exception
+}
+      ),
+      MKBrut::Ops::AppendToFile.new(
+        file: @project_root / ".env.test",
+        content: "TRIGGER_EXCEPTION_KEY=test-trigger-exception"
+      ),
+
+    ]
+  end
+  class InsertCustomElement < MKBrut::Ops::BaseOp
+    def initialize(project_root:, element_class_name:)
+      @file               = project_root / "app" / "src" / "front_end" / "js" / "index.js"
+      @element_class_name = element_class_name
+    end
+    def call
+      if dry_run?
+        puts "Would insert custom element '#{@element_class_name}' into #{@file}"
+        return
+      end
+      inserted = false
+      new_source = []
+      File.read(@file).split("\n").each do  |line|
+        regexp = /^document\.addEventListener\(\"DOMContentLoaded\"/
+        if line.match?(regexp)
+          new_source << %{import #{@element_class_name} from "./#{@element_class_name}"}
+          new_source << line
+          new_source << %{  #{@element_class_name}.define()}
+          inserted = true
+        else
+          new_source << line
+        end
+      end
+      if !inserted
+        raise "Could not find a place to insert code in '#{@file}'. Trying to find a line that matches this regular expression:\n\n#{regexp.inspect}"
+      end
+      File.open(@file, "w") do |file|
+        file.puts new_source.join("\n")
+      end
+    end
+  end
+
+  class InsertEndToEndTestCode < MKBrut::Ops::PrismParsingOp
+    def initialize(file:, code:)
+      @file = file
+      @code = code
+    end
+    def call
+      if dry_run?
+        puts "Would insert end-to-end test code into #{@file}:\n\n#{@code}\n"
+        return
+      end
+      parse_file!
+
+      found_describe = false
+      first_it_block = nil
+
+      @tree.value.statements.body.each do |top|
+        if top.is_a?(Prism::CallNode) &&
+           top.name == :describe      &&
+           top.block
+          found_describe = true
+
+          statements = top.block.body
+          if statements.respond_to?(:body)
+            statements.body.each do |statement|
+              if statement.is_a?(Prism::CallNode) &&
+                 statement.name == :it            &&
+                 statement.block
+
+                first_it_block = statement
+                break
+
+              end
+            end
+          end
+        end
+      end
+      if !first_it_block
+        if found_describe
+        raise "Could not find an 'it' block inside the first 'describe' in '#{@file}'"
+        else
+        raise "Could not find a 'describe' block in '#{@file}'"
+        end
+      end
+
+      insertion_point = first_it_block.block.location.end_offset - 3
+
+      block_line = @source.lines[first_it_block.location.start_line - 1]
+      describe_indent = block_line[/^\s*/] 
+      it_indent = describe_indent + "  "
+
+      new_source = @source.dup.insert(insertion_point, "\n#{it_indent}#{@code}\n#{describe_indent}")
+      File.open(@file, "w") do |file|
+        file.puts new_source
+      end
+    end
+  end
+
+end

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"
+  }
+
+}