mkbrut 0.4.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 984d9109d176ad8c71c73dcba0ca912ac355ac5c824916467c458c0c6f8258a9
-  data.tar.gz: add21e575b83c2c556c03bfe3e23e060d2b0fbfa88ee74f8984fa624f5914400
+  metadata.gz: 635f737ab220cbf181b23c3852d8d1683a6b1d0cc2d2cefe496105d3495966e5
+  data.tar.gz: 21ee357eb30e0b5626c43af73d0b438b4dfd9378dcaa908289931b17ac4dcbdf
 SHA512:
-  metadata.gz: 3df7e5b66d93762bc76b7c42191db13a79bd6492a789818420789ba3c937131066c90d56490efe774acdede15cab28c805bc572c77cd3a5de7dcdcc4476c8b61
-  data.tar.gz: 2ecf2985b10b22face53190218b33e1cbbeda2dad1d308050a15eebbd354e5013bfaf877cdc71b4da43d3cb2d1fab1f73c548820bc4087aaf19c14ab30bc34b1
+  metadata.gz: df92f5935742d37a62ff9688ba37c6ea28f4c85aa23933ab64aeb6502bdd57e8f1fb481e28c8841702b05e4d2f13d3d0cae754615b8776279709b5ea0c706307
+  data.tar.gz: 1691f7280eab746527652a60d032119c138e1e241637c1bb74d2062ae09a4af59437dbb4cc237ce1f48aca69772f7de63444e0d9aeb625d37fefe9fe71eb0cb2

data/lib/mkbrut/segments/demo.rb

@@ -28,7 +28,7 @@ private
         hash: {
           en: {
             cv: {
-              be: {
+              ss: {
                 not_enough_words: "%{field} does not have enough words",
                 already_posted: "You've already posted a message. Thanks for that!",
               },
@@ -72,6 +72,10 @@ end
         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",

data/lib/mkbrut/version.rb

@@ -1,3 +1,3 @@
 module MKBrut
-  VERSION = "0.4.2"
+  VERSION = "0.6.0"
 end

data/package.json

@@ -5,7 +5,7 @@
   "author": "Irrelevant",
   "license": "Irrelevant",
   "devDependencies": {
-    "brut-css": "^0.0.1",
-    "brut-js": "^0.0.21"
+    "brut-css": "~0.0.1",
+    "brut-js": "~0.0.21"
   }
 }

data/templates/Base/Procfile.development

@@ -1,4 +1,5 @@
-web:     PORT=6502 bin/run
-css:               bin/watch-and-build-assets css
-js:                bin/watch-and-build-assets js
-images:            bin/watch-and-build-assets images
+web:             PORT=6502 bin/run
+css:                       bin/watch-and-build-assets css
+js:                        bin/watch-and-build-assets js
+images:                    bin/watch-and-build-assets images
+startup_message: PORT=6502 bin/startup-message

data/templates/Base/app/config/i18n/en/1_defaults.rb

@@ -88,7 +88,7 @@
     },
     cv: { # short for "constraint violations" to avoid having to type that out
       this_field: "This field",
-      fe: { # short for "front-end", again to not have to type it out
+      cs: { # short for "client-side", again to not have to type it out
             # These keys use camel-case because that is how the browser defines
             # these values, based on ValidityState
         badInput: "%{field} is the wrong type of data",
@@ -102,7 +102,7 @@
         valueMissing: "%{field} is required",
         general: "Form is invalid",
       },
-      be: { # short for "back-end", again not to have to type it out
+      ss: { # short for "server-side", again not to have to type it out
             # These are snake case, which is idiomatic for Ruby.  The values
             # here are all based on DataObjectValidator's behavior
         required: "%{field} is required",

data/templates/Base/app/config/i18n/en/2_app.rb

@@ -2,11 +2,11 @@
 {
   # en: must be the first entry, thus indicating this is the EN translations
   en: {
-    cv: { # short for "constraint violations" to avoid having to type that out
-      be: { # short for "back-end", again not to have to type it out
-        email_taken: "This email has been taken",
+    cv: {
+      cs: {
       },
-      fe: { # short for "front-end", again not to have type it out
+      ss: {
+        email_taken: "This email has been taken",
       },
     },
     pages: { # Page-specific messages - this key is relied-upon by Brut to exist

data/templates/Base/app/src/front_end/css/index.css

@@ -1,3 +1,2 @@
 @import "brut-css/dist/brut.css";
 @import "svgs.css";
-@import "fonts.css";

data/templates/Base/app/src/front_end/layouts/default_layout.rb.erb

@@ -38,9 +38,9 @@ class DefaultLayout < Brut::FrontEnd::Layout
         PageIdentifier(@page_name)
 
         # Brut::FrontEnd::Components::I18nTranslations, which includes
-        # translations starting with cv.fe for use with client-side
+        # translations starting with cv.cs for use with client-side
         # constraint violation messaging.
-        I18nTranslations("cv.fe")
+        I18nTranslations("cv.cs")
         # Brut::FrontEnd::Components::I18nTranslations, which includes
         # translations for cv.this_field, which is used with client-side
         # constraint violation messaging.
@@ -58,17 +58,14 @@ class DefaultLayout < Brut::FrontEnd::Layout
           )
         )
       end
-      body do
+      # Adds the page's name as a class name. You can use this for
+      # CSS if needed.
+      body(class: @page_name) do
         # Render the <brut-tracing> element, which will send
         # OpenTelemetry traces back to the server to be joined up with
         # the server's traces.
         brut_tracing url: "/__brut/instrumentation", show_warnings: true
-        # Create <main> with a class named for the page. This will
-        # allow you to use CSS nested selectors to style this page
-        # only, if that is your CSS strategy.
-        main class: @page_name do
-          yield # Contents of the page are inserted here
-        end
+        yield # Contents of the page are inserted here
       end
     end
   end

data/templates/Base/bin/startup-message

@@ -0,0 +1,65 @@
+#!/usr/bin/env ruby
+
+require "pathname"
+require "yaml"
+require "optparse"
+
+option_parser = OptionParser.new do |opts|
+  opts.banner = "Usage: bin/startup-message\n\n    Outputs a message about where the dev server is running\n\nENVIRONMENT VARIABLES\n\n    PORT - the port configured for bin/run"
+end
+option_parser.parse!
+
+docker_compose_file = Pathname.new(__FILE__).dirname / ".." / "docker-compose.dx.yml"
+
+port_config = nil
+error       = nil
+
+if docker_compose_file.exist?
+  docker_compose = YAML.load_file(docker_compose_file)
+
+  docker_port = begin
+                  ENV.fetch("PORT")
+                rescue KeyError
+                  $stderr.puts "ERROR: The PORT environment variable is not set."
+                  $stderr.puts "       Please set it to the port your app is running on."
+                  exit 1
+                end
+
+  ports_config = docker_compose.dig("services", "app", "ports")
+  error = nil
+  if ports_config
+    port_config = ports_config.detect { |port_mapping|
+      host_port, container_port = port_mapping.split(":")
+      container_port.to_s == docker_port
+    }
+    if !port_config
+      error = "#{docker_compose_file} does not expose the port #{docker_port} for the 'app' service."
+    end
+  else
+    error = "#{docker_compose_file} does not contain a 'ports' section for the 'app' service."
+  end
+else
+  error = "#{docker_compose_file} does not exist. This is assumed to be in placefor your dev environment"
+end
+if !error
+  sleep 2 # allow all other initial output from bin/dev to happen first
+
+  host_port = port_config.split(":")[0]
+
+  url = "http://localhost:#{host_port}"
+
+  $stdout.puts "Your app is now running at"
+  $stdout.puts
+  $stdout.puts "  #{url}"
+  $stdout.puts
+  $stdout.flush # ensure this output happens immediately
+else
+  $stderr.puts "WARN: #{$0} could not figure out what port the app is exposed on"
+  $stderr.puts
+  $stderr.puts "      #{error}"
+  $stderr.puts
+  $stderr.puts "      This won't stop your app from running, but it does mean"
+  $stderr.puts "      there is some issue with your dev environment"
+  $stderr.flush # ensure this error output happens immediately
+end
+sleep

data/templates/segments/Demo/app/src/front_end/handlers/guestbook_message_handler.rb

@@ -9,7 +9,7 @@ class GuestbookMessageHandler < AppHandler
     # If client-side constraint violation checking was skipped,
     # but there ARE such violations, the form will be able to check
     # that server-side and return true for #constraint_violations?
-    if !@form.constraint_violations?
+    if @form.valid?
       save_message
     end
 

data/templates/segments/Demo/specs/e2e/guest_message.spec.rb

@@ -21,10 +21,10 @@ RSpec.describe "You can leave a guestbook message" do
     this_field = t("cv.this_field")
 
     expect(name_error_message).to    have_text(
-      t("cv.fe.valueMissing", field: this_field)
+      t("cv.cs.valueMissing", field: this_field)
     )
     expect(message_error_message).to have_text(
-      t("cv.fe.valueMissing", field: this_field)
+      t("cv.cs.valueMissing", field: this_field)
     )
 
     name_field    = page.locator("form input[name='name']")
@@ -39,7 +39,7 @@ RSpec.describe "You can leave a guestbook message" do
     flash = page.locator("[role='alert']")
     expect(flash).to have_text(t(:guestbook_not_saved))
     expect(message_error_message).to have_text(
-      t("cv.be.not_enough_words", field: this_field)
+      t("cv.ss.not_enough_words", field: this_field)
     )
 
     message_field.fill("OK, fine, this site is awesome!")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mkbrut
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.6.0
 platform: ruby
 authors:
 - Dave Copeland
@@ -100,14 +100,12 @@ files:
 - templates/Base/app/src/app.rb.erb
 - templates/Base/app/src/back_end/data_models/app_data_model.rb
 - templates/Base/app/src/back_end/data_models/db.rb
-- templates/Base/app/src/back_end/data_models/migrations/00000000000000_citext.rb
+- templates/Base/app/src/back_end/data_models/migrations/20240101130000_citext.rb
 - templates/Base/app/src/back_end/data_models/seed/seed_data.rb
 - templates/Base/app/src/front_end/components/app_component.rb
 - templates/Base/app/src/front_end/components/custom_element_registration.rb.erb
-- templates/Base/app/src/front_end/css/fonts.css
 - templates/Base/app/src/front_end/css/index.css
 - templates/Base/app/src/front_end/css/svgs.css
-- templates/Base/app/src/front_end/fonts/monaspace-xenon.ttf
 - templates/Base/app/src/front_end/forms/app_form.rb
 - templates/Base/app/src/front_end/handlers/app_handler.rb
 - templates/Base/app/src/front_end/images/LogoPylon.png
@@ -137,6 +135,7 @@ files:
 - templates/Base/bin/run
 - templates/Base/bin/scaffold
 - templates/Base/bin/setup
+- templates/Base/bin/startup-message
 - templates/Base/bin/test
 - templates/Base/bin/test-server
 - templates/Base/bin/watch-and-build-assets
@@ -169,6 +168,8 @@ files:
 - templates/segments/Demo/app/src/back_end/data_models/migrations/20250628194124_guestbook.rb
 - templates/segments/Demo/app/src/front_end/components/flash_component.rb
 - templates/segments/Demo/app/src/front_end/css/constraint-violations.css
+- templates/segments/Demo/app/src/front_end/css/fonts.css
+- templates/segments/Demo/app/src/front_end/fonts/monaspace-xenon.ttf
 - templates/segments/Demo/app/src/front_end/forms/guestbook_message_form.rb
 - templates/segments/Demo/app/src/front_end/handlers/guestbook_message_handler.rb
 - templates/segments/Demo/app/src/front_end/pages/guestbook_page.rb