brut 0.21.0.pre.1 → 0.21.0.pre.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 465fa110056a12dd5c33e2fac0754dfbba25c5928f23e4fb08f3f5976cf9a384
-  data.tar.gz: 3c6598da1ce0bf9e2655c56fb4edce22293a90d98cfef9cab855df210e5964fb
+  metadata.gz: e7d83ff98517963f25fc7bda801f0525203a946b11a69c7c95ea18a7790d74a8
+  data.tar.gz: b11d1fd32f24dd4a5b654541a1c4f26f4039d8b2a1f2dc804eb1dcf255ef4df1
 SHA512:
-  metadata.gz: 183335e5d4fc53b5d30ac5eb1c783bad929b782860d2de117ece54e1ac26e96f52466bfd36e8fc26d6e7209a1a88c8337e08a1c3cc30091ed5687baad063c137
-  data.tar.gz: 4c744e3e2d7f8c6e02d6ed6f3f0192af1184fea1aa4ccc66e068a68bade6ed0a4abf03b2a8a2562991dd39b1e4cad840bd3e28251ef0ab48c7cb8c6bc1cba100
+  metadata.gz: 91af7b2b9ee3bf7b5aff57c0f656c050b4a89d8aebd1e38e9413aadd8d1d6378454a295c93134e8b5b24d9277ecfdd8c6ae296d5f08fceb7993b22191324972b
+  data.tar.gz: e2b3a79d3b2de5963bdf2fb9e8a6f6ec50afc105d79f0ba24669bd9174aa9aad1ec6579d940e4d4f2bd39f6d292f1f00ad760857cb9ca1ef323caac2d7ddf7b6

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

@@ -247,6 +247,14 @@ class Brut::CLI::Apps::DB < Brut::CLI::Commands::BaseCommand
         execution_context.logger.without_stderr,
         self
       )
+      database_description = if Brut.container.project_env.production?
+                               "production database"
+                             else
+                               Brut.container.database_url
+                             end
+      puts theme.header.render("🏗 Applying migrations to #{database_description}")
+
+
       Sequel::Migrator.run(Brut.container.sequel_db_handle,migrations_dir)
       puts theme.success.render("✅ All migrations have been applied")
       0
@@ -263,12 +271,7 @@ class Brut::CLI::Apps::DB < Brut::CLI::Commands::BaseCommand
       ].join(" ")
       1
     rescue Sequel::DatabaseError => ex
-      #if ex.cause.kind_of?(PG::UndefinedTable)
-      #  # ignoring - we are running migrations which will address this
-      #  0
-      #else
-        raise ex
-      #end
+      raise ex
     end
   end
 
@@ -276,15 +279,24 @@ class Brut::CLI::Apps::DB < Brut::CLI::Commands::BaseCommand
     def description = "Drop, re-create, and run migrations, effecitvely rebuilding the entire database"
     def default_rack_env = "development"
     def bootstrap? = false
-    def initialize
-      super([
+    def opts = [
+      [ "--seed", "Load seed data after rebuild" ]
+    ]
+    def commands(execution_context)
+      default_commands = [
         Drop.new,
         Create.new,
         Migrate.new,
-      ])
+      ]
+      if execution_context.options.seed?
+        default_commands + [ Seed.new ]
+      else
+        default_commands
+      end
     end
   end
 
+  # XXX
 
   class Seed < Brut::CLI::Commands::BaseCommand
     def description = "Load seed data into the database"
@@ -310,7 +322,7 @@ class Brut::CLI::Apps::DB < Brut::CLI::Commands::BaseCommand
       puts theme.exception.render("  #{ex}".strip)
       puts [
         theme.error.render("You can re-load it using"),
-        theme.code.render("brut db rebuild && brut db seed"),
+        theme.code.render("brut db rebuild --seed"),
       ].join(" ")
       1
     end

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

@@ -9,11 +9,8 @@ class Brut::CLI::Apps::Deploy < Brut::CLI::Commands::BaseCommand
   autoload :GitChecks,    "brut/cli/apps/deploy/git_checks"
 
   def name = "deploy"
-
   def description = "Deploy your Brut-powered app to production"
 
-  def default_rack_env = nil
-
   class Docker < Brut::CLI::Commands::BaseCommand
     def description = "Build one docker image to use for all commands in production"
     def opts = [
@@ -47,10 +44,7 @@ class Brut::CLI::Apps::Deploy < Brut::CLI::Commands::BaseCommand
         end
         version = ""
         git_guess = %{git rev-parse HEAD}
-        system!(git_guess) do |output|
-          version << output
-        end
-        version = version.strip.chomp
+        version = capture!(git_guess).strip.chomp
         if version == ""
           fatal "Attempt to use git via command '#{git_guess}' to figure out the version failed"
           return 1
@@ -66,12 +60,12 @@ class Brut::CLI::Apps::Deploy < Brut::CLI::Commands::BaseCommand
         dockerfile = Brut.container.project_root / "deploy" / "Dockerfile"
         FileUtils.chdir Brut.container.project_root do
           command = %{docker build --build-arg app_git_sha1=#{version} --file #{dockerfile} --platform #{config.platform} --tag #{image_name} . 2>&1}
-          system!(command)
+          system!(command, output: :stream)
         end
         if options.build_only?
           puts "Not pushing image"
         else
-          system!("docker image push #{image_name}")
+          system!("docker image push #{image_name}", output: :stream)
         end
 
         0
@@ -99,6 +93,7 @@ class Brut::CLI::Apps::Deploy < Brut::CLI::Commands::BaseCommand
         end
       end
     end
+    def default_rack_env = "development"
     def description = "Deploy to Heroku using container-based deployment"
     def opts = [
       [ "--build-only", "Only generate Dockerfiles and build images, do not deploy" ],
@@ -139,10 +134,7 @@ class Brut::CLI::Apps::Deploy < Brut::CLI::Commands::BaseCommand
         config = AppDeployConfig.new
         version = ""
         git_guess = %{git rev-parse HEAD}
-        system!(git_guess) do |output|
-          version << output
-        end
-        version = version.strip.chomp
+        version = capture!(git_guess).strip.chomp
         if version == ""
           fatal "Attempt to use git via command '#{git_guess}' to figure out the version failed"
           return 1
@@ -161,14 +153,14 @@ class Brut::CLI::Apps::Deploy < Brut::CLI::Commands::BaseCommand
                            "--push"
                          end
           command = %{docker buildx build --provenance=false --build-arg app_git_sha1=#{version} --file #{process_dockerfile_path} --platform #{config.platform} #{push_or_load} --tag #{image_name} . 2>&1}
-          system!(command)
+          system!(command, output: :stream)
           names << process_description.name
         end
         deploy_command = "heroku container:release #{names.sort.join(' ')} -a #{Brut.container.app_id}"
         if options.build_only?
           puts "Not deploying"
         else
-          system!(deploy_command)
+          system!(deploy_command, output: :stream)
         end
 
         0
@@ -178,9 +170,12 @@ class Brut::CLI::Apps::Deploy < Brut::CLI::Commands::BaseCommand
       end
     end
   end
-  module DockerCompose
+  class DockerCompose < Brut::CLI::Commands::BaseCommand
+    def default_rack_env = "development"
+    def description = "Manage a docker-compose.yml file to be consistent with your deploy config"
     class Check < Brut::CLI::Commands::BaseCommand
       def description = "Check if the existing docker-compose.yml is consistent with the deploy config"
+      def default_rack_env = "development"
       def run
         docker_compose_path = Brut.container.project_root / "deploy" / "docker-compose.yml"
         if !docker_compose_path.exist?
@@ -265,6 +260,7 @@ class Brut::CLI::Apps::Deploy < Brut::CLI::Commands::BaseCommand
     end
     class Generate < Brut::CLI::Commands::BaseCommand
       def description = "Generate or update the existing docker-compose.yml based on current deploy config"
+      def default_rack_env = "development"
       def run
         docker_compose_path = Brut.container.project_root / "deploy" / "docker-compose.yml"
         deploy_config_path = Brut.container.project_root / "deploy" / "deploy_config.rb"

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

@@ -84,6 +84,8 @@ class Brut::CLI::Apps::New::App < Brut::CLI::Commands::BaseCommand
     ],
   ]
 
+  def default_rack_env = nil
+
   def run
 
     app_name = argv[0]
@@ -262,6 +264,7 @@ class Brut::CLI::Apps::New::App < Brut::CLI::Commands::BaseCommand
 
   class Segment < Brut::CLI::Commands::BaseCommand
     def description = "Add a segement to your app to provide additional pre-configured functionality"
+    def default_rack_env = nil
 
     def args_description = "segment_name"
     

data/lib/brut/cli/apps/new/segments/docker_deploy.rb

@@ -8,8 +8,7 @@ class Brut::CLI::Apps::New::Segments::DockerDeploy < Brut::CLI::Apps::New::Base
   end
 
   def add!
-    operations = copy_files(@templates_dir, @project_root) + 
-                 other_operations
+    operations = copy_files(@templates_dir, @project_root)
 
     operations.each do |operation|
       operation.call

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

@@ -50,20 +50,26 @@ Runs all non end-to-end tests for the app, or runs a subset of non-end-to-end te
     def rebuild_after_by_default? = false
 
     def run
-      if options.rebuild?(default: rebuild_by_default?)
-        puts "Rebuilding test database schema"
-        Bundler.with_unbundled_env do
-          system! "brut db rebuild --env=test"
-        end
-      end
+      rebuild_db(before_or_after: :before)
       run_tests
-      if options.rebuild_after?(default: rebuild_after_by_default?)
-        puts "Re-Rebuilding test database schema"
+      rebuild_db(before_or_after: :after)
+      0
+    end
+
+    def rebuild_db(before_or_after:)
+      option, default, verb = if before_or_after == :before
+                          [ :rebuild?, :rebuild_by_default?, "Rebuilding" ]
+                        elsif before_or_after == :after
+                          [ :rebuild_after?, :rebuild_after_by_default?, "Re-rebuilding" ]
+                        else
+                          bug!("before_or_after must be :before or :after")
+                        end
+      if options.send(option, default: self.send(default))
+        puts "#{verb} testing datbase"
         Bundler.with_unbundled_env do
           system! "brut db rebuild --env=test"
         end
       end
-      0
     end
 
   private
@@ -100,9 +106,8 @@ Runs all non end-to-end tests for the app, or runs a subset of non-end-to-end te
 Runs all end-to-end tests for the app, or runs a subset of end-to-end tests using RSpec-style syntax. This will run bin/test-server first, so if that fails for some reason, no tests are run.
     }
 
-  private
-
-    def run_tests
+    def run
+      rebuild_db(before_or_after: :before)
       require "brut/spec_support/e2e_test_server"
       test_server = Brut::SpecSupport::E2ETestServer.new(
         bin_dir: Brut.container.project_root / "bin",
@@ -110,12 +115,15 @@ Runs all end-to-end tests for the app, or runs a subset of end-to-end tests usin
       )
       begin
         test_server.start
-        super
+        run_tests
       ensure
         test_server.stop
+        rebuild_db(before_or_after: :after)
       end
+      0
     end
   end
+
   class Js < Brut::CLI::Commands::BaseCommand
     def default_rack_env = "development"
     def description = "Run JavaScript unit tests"
@@ -130,7 +138,7 @@ Runs all end-to-end tests for the app, or runs a subset of end-to-end tests usin
       options.set_default(:"build-assets", true)
       if options.build_assets?
         Bundler.with_unbundled_env do
-          system!({ "RACK_ENV" => "test" }, "brut build-assets all")
+          system!("brut build-assets all --env=test")
         end
       end
       execution_context.executor.system!({ "NODE_DISABLE_COLORS" => "1" },"npx mocha #{Brut.container.js_specs_dir} --no-color --extension 'spec.js' --recursive")

data/lib/brut/cli/commands/base_command.rb

@@ -46,18 +46,20 @@ class Brut::CLI::Commands::BaseCommand
   def bootstrap? = false
 
   # The default `RACK_ENV` to use for this command.  This value is used when no `RACK_ENV` is present in the UNIX environment
-  # and when `--env` has not been used on the command line. Do note that setting this in an app or parent command does
-  # not translate to the subcommands.
+  # and when `--env` has not been used on the command line. This only applies to the command where
+  # the method is defined and its subclasses. It **does not** apply to subcommands of this command.
+  #
+  # The default value is 'development', mostly because a default of `nil` produces a strange error
+  # message if your intention was to load Brut configuration.
   #
   # @return [String|nil] If nil, Brut configuration will not be loaded and the command will run more or less as if it were a plain
   #         Ruby script.  If a `String`, this value will be set as the `RACK_ENV` if it's not been otherwise specified.
-  def default_rack_env = nil
+  def default_rack_env = "development"
 
   # @return [String] description of this command for use in help output
   def description = ""
 
-  # Returns a more detaile description of the command. This can includes paragraphs which will be maintained, however
-  # any additional formatting is not rendered or used.
+  # Returns a more detaile description of the command. This can includes paragraphs (which will be maintained in the output), however any additional formatting is not rendered or used.
   def detailed_description = nil
 
   # @return [String] description of the arguments this command accepts. Used for documentation only.
@@ -136,19 +138,35 @@ private
   # @!visibility public
   def argv = self.execution_context.argv
 
-  # Convienience methods to defer to `Brut::CLI::Commands::ExecutionContext`'s `Brut::CLI::Executor#system!`.
-  # @!visibility public
-  def system!(*args,&block)
+  # Wraps `system!`, but captures the output and returns it
+  def capture!(*args)
     output = ""
-    block ||= ->(output_chunk) {
+    capture = ->(output_chunk) {
       output << output_chunk
     }
+    system!( *args, output: capture)
+    output
+  end
+
+  # Convienience methods to defer to `Brut::CLI::Commands::ExecutionContext`'s `Brut::CLI::Executor#system!`.
+  # @!visibility public
+  def system!(*args,output: :log)
+    command_output = ""
+    block = if output == :log
+              block ||= ->(output_chunk) {
+                command_output << output_chunk
+              }
+            elsif output.kind_of?(Proc)
+              block = output
+            else
+              nil
+            end
     begin
       self.execution_context.executor.system!(*args,&block)
     ensure
-      if output.length > 0
+      if command_output.length > 0
         progname = args.detect { it.kind_of?(String) }.split(" ")
-        output.lines.each do |line|
+        command_output.lines.each do |line|
           self.execution_context.logger.add(Logger::INFO, line.chomp, progname)
         end
       end

data/lib/brut/cli/commands/compound_command.rb

@@ -5,8 +5,12 @@ class Brut::CLI::Commands::CompoundCommand < Brut::CLI::Commands::BaseCommand
   # Create the compound command with the given list of commands.  Note that these
   # commands will be executed with *this* commands `Brut::CLI::Commands::ExecutionContext`, so these commands
   # should all be able to work with whatever command line arguments and `argv` would be provided.
-  def initialize(commands)
-    @commands = commands
+  #
+  # @param [Array<Brut::CLI::Commands::BaseCommand>|nil] The list of commands to run when
+  #        this command is executed.  If nil, it is assumed you have overriden `commands` to
+  #        provide the list dynamically.
+  def initialize(commands=nil)
+    @commands = commands || []
   end
 
   # Overrides the parent class to call each command in order. Note that if you subclass this class, **`run` is
@@ -14,7 +18,7 @@ class Brut::CLI::Commands::CompoundCommand < Brut::CLI::Commands::BaseCommand
   # methods on the passed `execution_context`.  Methods like `puts`, `system!`, and `options` **will not work** here
   # since they assume an ivar named `@execution_context` has been set.
   def execute(execution_context)
-    @commands.each do |command|
+    commands(execution_context).each do |command|
       execute_result = Brut::CLI::ExecuteResult.new do
         delegate_to_command(command,execution_context)
       end
@@ -24,4 +28,16 @@ class Brut::CLI::Commands::CompoundCommand < Brut::CLI::Commands::BaseCommand
     end
     0
   end
+
+  # Protocol for which commands to run. You can override this to dynamically set which
+  # commands are run based on the parsed command line. Note that you must call
+  # methods like `puts` or `system!` **on the passed `execution_context`**. Do not
+  # call them directly.
+  #
+  # @param [Brut::CLI::ExecutionContext] execution_context the execution context for this
+  #        command. You can use this to examine e.g. CLI options to determine which commands
+  #        to return.
+  #
+  # @return [Array<Brut::CLI::Commands::BaseCommand>]
+  def commands(execution_context) = @commands
 end

data/lib/brut/cli/commands/help.rb

@@ -1,5 +1,6 @@
 class Brut::CLI::Commands::Help < Brut::CLI::Commands::BaseCommand
   def description = "Get help for the app or a command"
+  def default_rack_env = nil
   attr_accessor :option_parser
 
   def initialize(command,option_parser)

data/lib/brut/cli/commands/help_in_markdown.rb

@@ -1,5 +1,6 @@
 class Brut::CLI::Commands::HelpInMarkdown < Brut::CLI::Commands::BaseCommand
   def description = "Get help for the app or a command, in Markdown"
+  def default_rack_env = "development"
   attr_accessor :option_parser
 
   def initialize(command,option_parser)

data/lib/brut/cli/parsed_command_line.rb

@@ -106,13 +106,7 @@ class Brut::CLI::ParsedCommandLine
     @argv    = remaining_argv
     @options = Brut::CLI::Options.new(options)
     if !@options.log_level?
-      if @options.verbose? || @options.debug?
-        @options[:'log-level'] = "debug"
-      elsif @options.quiet?
-        @options[:'log-level'] = "error"
-      else
-        @options[:'log-level'] = "info"
-      end
+      @options[:'log-level'] = "info"
     end
     if !@options[:'log-file']
       log_file_path = if env["XDG_STATE_HOME"]
@@ -128,9 +122,6 @@ class Brut::CLI::ParsedCommandLine
     else
       @options[:'log-file'] = Pathname(@options[:'log-file'])
     end
-    if @options[:'log-stdout'].nil?
-      @options[:'log-stdout'] = @options.verbose? || @options.debug?
-    end
   rescue => ex
     @command = if env["BRUT_DEBUG"] == "true"
       Brut::CLI::Commands::RaiseError.new(ex)
@@ -152,8 +143,6 @@ private
               "Project environment, e.g. test, development, production. Default depends on the command")
       opts.on("--log-level=LOG_LEVEL", [ "debug", "info", "warn", "error", "fatal" ],
               "Log level, which should be debug, info, warn, error, or fatal. Defaults to error")
-      opts.on("--debug", "--verbose", "Set log level to debug, and show log messages on stdout")
-      opts.on("--quiet", "Set log level to error")
       opts.on("--log-file=FILE",
               "Path to a file where log messages are written. Defaults to $XDG_CACHE_HOME/brut/logs/#{app_name}.log")
       opts.on("--[no-]log-stdout", "Log messages to stdout in addition to the log file")

data/lib/brut/cli/runner.rb

@@ -77,17 +77,13 @@ class Brut::CLI::Runner
 private
 
   def load_unix_environment!(env, parsed_command_line)
-    if env["RACK_ENV"]
-      if parsed_command_line.project_environment
-        @stderr.puts "RACK_ENV is set in the environment, which supercedes the command line, --env ignored"
-      end
-    else
-      env["RACK_ENV"] = if parsed_command_line.project_environment
-                          parsed_command_line.project_environment.to_s
-                        else
-                          parsed_command_line.command.default_rack_env
-                        end
-    end
+    env["RACK_ENV"] = if parsed_command_line.project_environment
+                        parsed_command_line.project_environment.to_s
+                      elsif env["RACK_ENV"]
+                        env["RACK_ENV"]
+                      else
+                        parsed_command_line.command.default_rack_env
+                      end
 
     rack_env = RichString.from_string(env["RACK_ENV"])
 
@@ -135,9 +131,9 @@ private
     if env["RACK_ENV"]
       log_level = env["LOG_LEVEL"]
 
-      if !parsed_command_line.options.verbose? && !parsed_command_line.options.debug?
-        env["LOG_LEVEL"] = "warn"
-      end
+      # Prevent lots of stuff from logging just
+      # because it was required
+      env["LOG_LEVEL"] = "warn"
 
       require "#{@project_root}/app/bootstrap"
       bootstrap = Bootstrap.new
@@ -147,6 +143,7 @@ private
         bootstrap.configure_only!
       end
 
+      # restore the log level
       env["LOG_LEVEL"] = log_level
     end
   end

data/lib/brut/spec_support/cli_command_support.rb

@@ -24,12 +24,19 @@ module Brut::SpecSupport::CLICommandSupport
                   args
                 end
       @commands_executed << command
-      if @on_commands[command]
-        if @on_commands[command][:raise_error]
+      on_command = @on_commands.select { |it,_|
+        it == command || it.match?(command)
+      }.map { |_,it| it }.first
+      if on_command
+        if on_command[:raise_error]
           raise Brut::CLI::SystemExecError.new(command,1)
-        elsif @on_commands[command][:output]
-          output = @on_commands[command][:output]
-          yield(output)
+        elsif on_command[:output]
+          output = on_command[:output]
+          if block_given?
+            yield(output)
+          else
+            @out.puts output
+          end
         end
       end
       nil

data/lib/brut/version.rb

@@ -1,4 +1,4 @@
 module Brut
   # @!visibility private
-  VERSION = "0.21.0.pre.1"
+  VERSION = "0.21.0.pre.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: brut
 version: !ruby/object:Gem::Version
-  version: 0.21.0.pre.1
+  version: 0.21.0.pre.3
 platform: ruby
 authors:
 - David Bryant Copeland