brut 0.19.2 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 765659b6fbd1258a4b5615cfea8e7d273fbebd4336ceb6518367bc5ad329bcb8
-  data.tar.gz: 35777088ab7cc473a3ef5459087349846586798154e9f699e52b3b5be22c64db
+  metadata.gz: afeada7e0616e77f5a11b4e975a94ee7affeaa66664c1f619c4e52de6db2426f
+  data.tar.gz: 520765f71bb41275569fed4d481e75ff64b3df28f0a3b3bccf12bf53e3aa223b
 SHA512:
-  metadata.gz: 946899aa325e088a414c88e63b6bd58c7278380e90929f886905b9cd100c2a98d672d570a036e0edf66953719dccb4b6bd1dd5525f885fcc2421ea82da142ece
-  data.tar.gz: 9bfe8cef4bd6e4effbca418ab446796fed352999f21b404d6904ec5ccd048bff9ed18de6f9fd47e8d45ad7045b73bf782375ca7bed13a1022d2af0e1e976bde5
+  metadata.gz: d68ff2c363e86ef216bb8c81b88360e51e643496d1b6e602db0bd969a298e8b880a68f26d5e177ba172fc707cbc880fdd998b2dd1caf6ed0ac21f83fb61ef547
+  data.tar.gz: f94608a8a377bb58ebcf61e4cc172c5215558c9c374e580ab95d7997c2bdae01e5460299a39a1cbcd10e98b72ee3f0a64f6b2a71bbd75e7ca30dd7fa3508d85f

data/lib/brut/cli/apps/db.rb

@@ -51,20 +51,20 @@ class Brut::CLI::Apps::DB < Brut::CLI::Commands::BaseCommand
       rows = [
         [
           "Database Server",
-          server_up ? theme.success.render("✅ UP") : theme.error.render("❌ DOWN")
+          server_up ? theme.success.render("✅ UP") : theme.error.render("❌ DOWN"),
         ],
       ]
       if server_up
         rows << [
           "Database #{theme.code.render(database_name)}",
-          database_exists ? theme.success.render("✅ Exists") : theme.error.render("❌ DOES NOT EXIST")
+          database_exists ? theme.success.render("✅ Exists") : theme.error.render("❌ DOES NOT EXIST"),
         ]
       end
       if database_exists
         if migration_files.empty? && migrations_run.empty?
           rows << [
             "Migrations",
-            "✅ NO MIGRATION FILES TO RUN"
+            "✅ NO MIGRATION FILES TO RUN",
           ]
         else
           migration_files.each do |filename|

data/lib/brut/cli/apps/deploy.rb

@@ -19,8 +19,16 @@ class Brut::CLI::Apps::Deploy < Brut::CLI::Commands::BaseCommand
     def default_rack_env = "development"
 
     def run
+      options.set_default(:deploy, true)
+      puts "Logging in to Heroku Container Registry"
+      command = %{heroku container:login}
+      system!(command)
       execute_result = Brut::CLI::ExecuteResult.new do
-        delegate_to_command(Brut::CLI::Apps::Deploy::Build.new)
+        delegate_to_command(
+          Brut::CLI::Apps::Deploy::Build.new(
+            push: options.deploy? ? "registry.heroku.com/#{Brut.container.app_id}/%{name}": false
+          )
+        )
       end
       if execute_result.failed?
         puts theme.error.render("Build failed.")
@@ -28,47 +36,17 @@ class Brut::CLI::Apps::Deploy < Brut::CLI::Commands::BaseCommand
           puts theme.error.render("Error message from build: #{error_message}")
         end
       end
-      options.set_default(:deploy, true)
-      version = ""
-      git_guess = %{git rev-parse HEAD}
-      system!(git_guess) do |output|
-        version << output
-      end
-      version.strip!.chomp!
-      if version == ""
-        error "Attempt to use git via command '#{git_guess}' to figure out the version failed"
-        return 1
-      end
-      short_version = version[0..7]
+      names = []
       app_docker_files = AppDockerImages.new(
         project_root: Brut.container.project_root,
         organization: Brut.container.app_organization,
         app_id: Brut.container.app_id,
-        short_version:
+        short_version: "NA"
       )
-      names = []
-      puts "Logging in to Heroku Container Registry"
-      command = %{heroku container:login}
-      system!(command)
-      app_docker_files.each do |name:, image_name:|
-        heroku_image_name = "registry.heroku.com/#{Brut.container.app_id}/#{name}"
-        puts "Tagging '#{image_name}' with '#{heroku_image_name}' for Heroku"
-        command = %{docker tag #{image_name} #{heroku_image_name}}
-        system!(command)
-        begin
-          puts "Pushing '#{heroku_image_name}'"
-          command = %{docker push #{heroku_image_name}}
-          system!(command)
-        rescue Brut::CLI::SystemExecError => ex
-          error "Failed to push image '#{heroku_image_name}' to Heroku"
-          if options.log_level != "debug"
-            error "Could be you must re-authenticate to Heroku."
-            error "Try re-running with --log-level=debug to see more details"
-          end
-          return 1
-        end
+      app_docker_files.each do |name:, cmd:, dockerfile:|
         names << name
       end
+
       deploy_command = "heroku container:release #{names.join(' ')} -a #{Brut.container.app_id}"
       if options.deploy?
         puts "Deploying images to Heroku"
@@ -142,7 +120,13 @@ class Brut::CLI::Apps::Deploy < Brut::CLI::Commands::BaseCommand
     def description      = Docker.new.description
     def opts             = Docker.new.opts
     def default_rack_env = Docker.new.default_rack_env
-    def run              = delegate_to_command(Docker.new)
+
+    def initialize(push: false)
+      @push = push
+    end
+    def run
+      delegate_to_command(Docker.new(push: @push))
+    end
 
     def commands = []
 
@@ -155,6 +139,10 @@ class Brut::CLI::Apps::Deploy < Brut::CLI::Commands::BaseCommand
       ]
       def default_rack_env = "development"
 
+      def initialize(push: false)
+        @push = push
+      end
+
       def run
         if !options.skip_checks?
           execute_result = Brut::CLI::ExecuteResult.new do
@@ -177,8 +165,6 @@ class Brut::CLI::Apps::Deploy < Brut::CLI::Commands::BaseCommand
           error "Attempt to use git via command '#{git_guess}' to figure out the version failed"
           return 1
         end
-        short_version = version[0..7]
-
         short_version = version[0..7]
         app_docker_files = AppDockerImages.new(
           project_root: Brut.container.project_root,
@@ -219,12 +205,16 @@ class Brut::CLI::Apps::Deploy < Brut::CLI::Commands::BaseCommand
           puts
           rows = []
           items = []
+          push_or_load = @push ? "--push" : "--load"
           app_docker_files.each do |name:, image_name:, dockerfile:|
+            if @push && @push.kind_of?(String)
+              image_name = @push % { name: name }
+            end
             rows << [ name, theme.code.render(image_name) ]
-            command = %{docker build --build-arg app_git_sha1=#{version} --file #{Brut.container.project_root}/#{dockerfile} --platform #{options.platform} --tag #{image_name} . 2>&1}
+            command = %{docker buildx build --provenance=false --build-arg app_git_sha1=#{version} --file #{Brut.container.project_root}/#{dockerfile} --platform #{options.platform} #{push_or_load} --tag #{image_name} . 2>&1}
             items << theme.code.render(theme.wrap(command, first_indent: false, indent: 7, newline: " \\\n"))
             if !options.dry_run?
-              puts theme.subheader.render("Building '#{name}' image")
+              puts theme.subheader.render("Building #{@push ? 'and pushing' : '' } '#{name}' image")
               system!(command)
             end
           end

data/lib/brut/cli/apps/new/app.rb

@@ -53,12 +53,12 @@ class Brut::CLI::Apps::New::App < Brut::CLI::Commands::BaseCommand
     [ 
       "--app-id=ID",
       Brut::CLI::Apps::New::AppId,
-      "App identifier, which must be able to be used as a hostname or other Internet identifier. Derived from your app name, if omitted"
+      "App identifier, which must be able to be used as a hostname or other Internet identifier. Derived from your app name, if omitted",
     ],
     [
       "--organization=ORG",
       Brut::CLI::Apps::New::Organization,
-      "Organization name, e.g. what you'd use for GitHub. Defaults to the app-id value"
+      "Organization name, e.g. what you'd use for GitHub. Defaults to the app-id value",
     ],
     [
       "--[no-]interactive",
@@ -67,7 +67,7 @@ class Brut::CLI::Apps::New::App < Brut::CLI::Commands::BaseCommand
     [
       "--prefix=PREFIX",
       Brut::CLI::Apps::New::Prefix,
-      "Two-character prefix for external IDs and autonomous custom elements. Derived from your app-id, if omitted."
+      "Two-character prefix for external IDs and autonomous custom elements. Derived from your app-id, if omitted.",
     ],
     [ 
       "--segments=SEGMENTS",
@@ -76,11 +76,11 @@ class Brut::CLI::Apps::New::App < Brut::CLI::Commands::BaseCommand
     ],
     [ 
       "--dry-run",
-      "Only show what would happen, don't actually do anything"
+      "Only show what would happen, don't actually do anything",
     ],
     [
       "--[no-]demo",
-      "Include, or not, additional files that demonstrate Brut's features (default is true for now)"
+      "Include, or not, additional files that demonstrate Brut's features (default is true for now)",
     ],
   ]
 
@@ -272,7 +272,7 @@ class Brut::CLI::Apps::New::App < Brut::CLI::Commands::BaseCommand
       ],
       [ 
         "--dry-run",
-        "Only show what would happen, don't actually do anything"
+        "Only show what would happen, don't actually do anything",
       ],
     ]
 

data/lib/brut/cli/apps/scaffold.rb

@@ -4,6 +4,10 @@ require "brut/cli"
 class Brut::CLI::Apps::Scaffold < Brut::CLI::Commands::BaseCommand
   def description = "Create scaffolds of various files to help develop more quckly"
 
+  def commands
+    super - [ Brut::CLI::Apps::Scaffold::BaseCommand ]
+  end
+
   class BaseCommand < Brut::CLI::Commands::BaseCommand
     def bootstrap? = false
     def default_rack_env = "development"
@@ -111,7 +115,7 @@ end}
     def args_description = "test_name"
     def name = "e2e_test"
 
-    def opts = [
+    def opts = super + [
       ["--path PATH","Path within the e2e tests to create the file"],
     ]
 
@@ -193,7 +197,7 @@ end}
     def args_description = "ComponentName"
     def detailed_description = "New components go in the `components/` folder of your app, however using --page will create a 'page private' component.  To do that, the component name must be an inner class of an existing page, for example HomePage::Welcome. This component goes in a sub-folder inside the `pages/` area of your app"
 
-    def opts = [
+    def opts = super + [
       [ "--page","If set, this component is for a specific page and won't go with the other components"],
     ]
 
@@ -384,7 +388,7 @@ end}
           error "         The page may not render properly the first time you load it"
         end
 
-        routes_editor = RoutesEditor.new(app_path:,out:)
+        routes_editor = RoutesEditor.new(app_path:,stdout: execution_context.stdout)
         routes_editor.add_route!(route_code:)
 
         if !routes_editor.found_routes?
@@ -419,7 +423,7 @@ end}
     end
     def description = "Create a handler for an action"
     def args_description = "action_route"
-    def opts = [
+    def opts = super + [
       [ "--http-method=METHOD", "If present, the action will be a path available on the given route and this HTTP method. If omitted, this will create an action available via POST" ],
     ]
 
@@ -528,7 +532,7 @@ end}
         execution_context.stdout.printf printf_string,handler_class_name, handler_source_path.relative_path_from(Brut.container.project_root)
         execution_context.stdout.printf printf_string,"Spec", handler_spec_path.relative_path_from(Brut.container.project_root)
 
-        routes_editor = RoutesEditor.new(app_path:,out:)
+        routes_editor = RoutesEditor.new(app_path:,stdout: execution_context.stdout)
         routes_editor.add_route!(route_code:)
 
         if form
@@ -703,9 +707,9 @@ end
   end
 
   class RoutesEditor
-    def initialize(app_path:,out:)
+    def initialize(app_path:,stdout:)
       @app_path       = app_path
-      @out            = out
+      @stdout         = stdout
       @found_routes   = false
       @routes_existed = false
     end
@@ -726,7 +730,7 @@ end
           end
           if in_routes && line =~ /^  end\s*$/
             if !@routes_existed
-              @out.puts "Inserted route into #{@app_path.relative_path_from(Brut.container.project_root)}"
+              @stdout.puts "Inserted route into #{@app_path.relative_path_from(Brut.container.project_root)}"
               file.puts "    #{route_code}"
             end
             @found_routes = true

data/lib/brut/cli/logger.rb

@@ -1,5 +1,6 @@
 require "logger"
 require "fileutils"
+require "pathname"
 require "delegate"
 
 class Brut::CLI::Logger < SimpleDelegator
@@ -58,9 +59,9 @@ class Brut::CLI::Logger < SimpleDelegator
   end
 
   def log_file=(log_file)
-    @log_file = log_file
     if log_file
-      log_dir = log_file.dirname
+      @log_file = Pathname(log_file)
+      log_dir = @log_file.dirname
       if !log_dir.exist?
         FileUtils.mkdir_p(log_dir)
       end
@@ -69,6 +70,8 @@ class Brut::CLI::Logger < SimpleDelegator
       if @logger.level == ::Logger::DEBUG
         @stdout.puts "Logging to file #{@log_file}"
       end
+    else
+      @log_file = nil
     end
   end
 

data/lib/brut/cli/parsed_command_line.rb

@@ -112,12 +112,16 @@ class Brut::CLI::ParsedCommandLine
     if !@options[:'log-file']
       log_file_path = if env["XDG_STATE_HOME"]
                         Pathname(env["XDG_STATE_HOME"]) / "brut"
-                      elsif env["HOME"]
+                      elsif env["HOME"] && File.writable?(env["HOME"])
                         Pathname("#{env['HOME']}/.local/state/") / "brut"
                       else
-                        Pathname("/tmp/") / "brut"
+                        nil
                       end
-      @options[:'log-file'] = log_file_path / (app_command.name + ".log")
+      if log_file_path
+        @options[:'log-file'] = log_file_path / (app_command.name + ".log")
+      end
+    else
+      @options[:'log-file'] = Pathname(@options[:'log-file'])
     end
     if @options[:'log-stdout'].nil?
       @options[:'log-stdout'] = @options.verbose? || @options.debug?

data/lib/brut/front_end/handler.rb

@@ -23,7 +23,8 @@ module Brut::FrontEnd
     include Brut::FrontEnd::HandlingResults
     include Brut::Framework::Errors
 
-    # You must implement this to accept whatever parameters you need. See {Brut::FrontEnd::RequestContext} for how that works.
+    # You must implement this to perform whatever action your handler must perform.  Any information from the request would've been given to your initializer. See {Brut::FrontEnd::RequestContext} for how that works.
+    #
     # The type of the return value determines what will happen:
     #
     # * Instance of `URI` - browser will redirect to this URI. Typically, you would do this by calling {Brut::FrontEnd::HandlingResults#redirect_to}.
@@ -39,7 +40,7 @@ module Brut::FrontEnd
       abstract_method!
     end
 
-    # Override this to performa any checks before {#handle} is called.  This should
+    # Override this to perform any checks before {#handle} is called.  This should
     # return `nil` if {#handle} should proceed to be called. Generally, you don't need to override
     # this as {#handle} can include the logic.  Where this is useful is to share cross-cutting logic
     # across other handlers.
@@ -48,8 +49,7 @@ module Brut::FrontEnd
     #         {#handle} for what each return value means.
     def before_handle = nil
 
-    # Called by Brut to handle the request. Do not override this. If your handler responds to `before_handle` that is called with the
-    # same args as you have defined for {#handle}. If `before_handle` returns anything other than `nil`, that value is returned and
+    # Called by Brut to handle the request. Do not override this. If `before_handle` returns anything other than `nil`, that value is returned and
     # should be one of the values documented in {#handle}.  If `before_handle` returns `nil`, {#handle} is called and whatever it
     # returns is returned here.
     def handle!(**args)

data/lib/brut/rubocop_config.rb

@@ -46,9 +46,9 @@ module Brut
         "member?" => "include?",
       },
     },
-    "Style/EndlessMethod" => {
-      "EnforcedStyle" =>  "allow_single_line",
-    },
+    #"Style/EndlessMethod" => {
+    #  "EnforcedStyle" =>  "allow_single_line",
+    #},
     "Style/For" => {
       "EnforcedStyle" =>  "each",
     },

data/lib/brut/spec_support/matchers/have_constraint_violation.rb

@@ -47,6 +47,9 @@ class Brut::SpecSupport::Matchers::HaveConstraintViolation
     if !form.kind_of?(Brut::FrontEnd::Form)
       raise "#{self.class} only works with forms, not #{form.class}"
     end
+    if field.to_s == ""
+      raise "field is required"
+    end
     @form  = form
     @field = field.to_s
     @key   = key.to_s

data/lib/brut/tui/script/exec_step.rb

@@ -29,7 +29,7 @@ class Brut::TUI::Script::ExecStep < Brut::TUI::Script::Step
       command: @command,
       strip_ansi: false,
       stdout: @stdout,
-      stderr: @stderr
+      stderr: @stderr,
     })
   end
   def run!

data/lib/brut/version.rb

@@ -1,4 +1,4 @@
 module Brut
   # @!visibility private
-  VERSION = "0.19.2"
+  VERSION = "0.20.0"
 end

data/templates/Base/app/src/back_end/data_models/db/README.md

@@ -0,0 +1,8 @@
+Data Models go here. Create them with `brut scaffold db_model`
+
+```ruby
+# db/widget.rb
+class DB::Widget < AppDataModel
+end
+```
+

data/templates/Base/dx/bash_customizations.local

@@ -1,8 +1,5 @@
 # Insert developer-specifilc Bash customizations here.
-# This file is not checked into version control, so you
-# are safe to export EDITOR=vim and avoid any guff from 
-# co-workers.
-
+# This file is not checked into version control
 # Sets up a multi-line prompt since the working directory
 # may be very deep.  Customize or change at your leisure.
 PS1='\[\e[35m\]docker-container\[\e[0m\] - \[\e[37m\]\w\n\[\e[0m\]> '

data/templates/Base/specs/spec_helper.rb

@@ -1,4 +1,7 @@
+require "dotenv"
 ENV["RACK_ENV"] = "test"
+Dotenv.load(".env.test.local", ".env.test")
+
 require_relative "../app/bootstrap"
 Bootstrap.new.bootstrap!
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: brut
 version: !ruby/object:Gem::Version
-  version: 0.19.2
+  version: 0.20.0
 platform: ruby
 authors:
 - David Bryant Copeland
@@ -719,7 +719,6 @@ files:
 - lib/sequel/plugins/find_bang.rb
 - templates/Base/.dockerignore
 - templates/Base/.env.development.erb
-- templates/Base/.env.development.local
 - templates/Base/.env.test.erb
 - templates/Base/.gitignore
 - templates/Base/.projections.json
@@ -736,6 +735,7 @@ 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/db/README.md
 - 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
@@ -851,7 +851,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.2
+rubygems_version: 4.0.8
 specification_version: 4
 summary: Web Framework Built around Ruby, Web Standards, Simplicity, and Object-Orientation
 test_files: []

data/templates/Base/.env.development.local

@@ -1,2 +0,0 @@
-# Place developer-specific overrides of .env.development in here, 
-# e.g. API keys needed for local dev. DO NOT CHECK INTO VERSION CONTROL