brut 0.0.1 → 0.0.2

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

@@ -8,13 +8,13 @@ class Brut::CLI::Apps::BuildAssets < Brut::CLI::App
   requires_project_env
   default_command :all
   configure_only!
+  opts.on("--[no-]clean", "If set, any old files from previous runs are deleted. If omitted, is false in production and true otherwise")
 
   class All < Brut::CLI::Command
     description "Build all assets"
-    opts.on("--[no-]clean","If set the metadata file used to map the files to their hashed values is deleted before assets are built")
 
     def execute
-      if options.clean?(default: true)
+      if global_options.clean?(default: global_options.env != "production")
         asset_metadata_file = Brut.container.asset_metadata_file
         out.puts "Removing #{asset_metadata_file}"
         FileUtils.rm_f(asset_metadata_file)
@@ -40,7 +40,6 @@ This is to ensure that any images your code references will end up in the public
 
   class CSS < Brut::CLI::Command
     description "Builds a single CSS file suitable for sending to the browser"
-    opts.on("--clean","If set, any .css files hanging around from a prevous build are deleted. Not recommended in production environments")
 
     detailed_description %{
       This produces a hashed file in every environment, in order to keep environments consistent and reduce differences.  If your CSS file references images, fonts, or other assets via url() or other CSS functions, those files will be hashed and copied into the output directory where CSS is served.
@@ -54,7 +53,7 @@ This is to ensure that any images your code references will end up in the public
       esbuild_metafile    = Brut.container.tmp_dir / "build-css-meta.json"
       asset_metadata_file = Brut.container.asset_metadata_file
 
-      if options.clean?
+      if global_options.clean?(default: global_options.env != "production")
         out.puts "Cleaning old CSS files from #{Brut.container.css_bundle_output_dir}"
         Dir[Brut.container.css_bundle_output_dir / "*.*"].each do |file|
           if File.file?(file)
@@ -80,7 +79,6 @@ This is to ensure that any images your code references will end up in the public
   end
   class JS < Brut::CLI::Command
     description "Builds and bundles JavaScript destined for the browser"
-    opts.on("--clean","If set, any .js files hanging around from a prevous build are deleted. Not recommended in production environments")
     opts.on("--output-file=FILE","Bundle to create that will be sent to the browser, relative to the JS public folder. Default is app.js")
     opts.on("--source-file=FILE","Entry point used to create the bundle, relative to the source JS folder. Default is index.js")
 
@@ -91,7 +89,7 @@ This is to ensure that any images your code references will end up in the public
       asset_metadata_file = Brut.container.asset_metadata_file
 
       name_with_hash_regexp = /app\/public\/(?<path>.+)\/(?<name>.+)\-(?<hash>.+)\.js/
-      if options.clean?
+      if global_options.clean?(default: global_options.env != "production")
         out.puts "Cleaning old JS files from #{Brut.container.js_bundle_output_dir}"
         Dir[Brut.container.js_bundle_output_dir / "*.*"].each do |file|
           if File.file?(file)

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

@@ -32,7 +32,7 @@ class Brut::CLI::Apps::DB < Brut::CLI::App
       Dir["#{seeds_dir}/*.rb"].each do |file|
         require file
       end
-      seed_data = Brut::Backend::SeedData.new
+      seed_data = Brut::BackEnd::SeedData.new
       seed_data.setup!
       seed_data.load_seeds!
       0
@@ -43,7 +43,6 @@ class Brut::CLI::Apps::DB < Brut::CLI::App
 
   class Rebuild < Brut::CLI::Command
     description "Drop, re-create, and run migrations, effecitvely rebuilding the entire database"
-    opts.on("--[no-]seeds","Load seed data after applying migrations")
 
     requires_project_env default: "development"
 
@@ -63,11 +62,7 @@ class Brut::CLI::Apps::DB < Brut::CLI::App
     end
 
     def execute
-      result = delegate_to_commands(Drop, Create, Migrate)
-      if result.ok? && options.seeds?
-        result = delegate_to_command(Seed)
-      end
-      result
+      delegate_to_commands(Drop, Create, Migrate)
     end
   end
 

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

@@ -1,3 +1,4 @@
+require "prism"
 require "brut/cli"
 
 class Brut::CLI::Apps::Scaffold < Brut::CLI::App
@@ -5,12 +6,13 @@ class Brut::CLI::Apps::Scaffold < Brut::CLI::App
   opts.on("--overwrite", "If set, any files that exists already will be overwritten by new scaffolds")
   opts.on("--dry-run", "If set, no files are changed. You will see output of what would happen without this flag")
 
+
   def before_execute
     ENV["RACK_ENV"] = "development"
   end
 
   class Test < Brut::CLI::Command
-    description "Create a test for a given file in the app"
+    description "Create the shell of a unit test based on an existing source file"
     args "source_file_paths..."
     def execute
       if args.empty?
@@ -67,7 +69,7 @@ end}
         }
 
         if global_options.dry_run?
-          puts code
+          out.puts code
         else
           FileUtils.mkdir_p destination.dirname
           File.open(destination,"w") do |file|
@@ -100,17 +102,97 @@ end}
       end
       classes
     end
+  end
+
+  class E2ETest < Brut::CLI::Command
+    description "Create the shell of an end-to-end test"
+    args "test_name"
+    def self.command_name = "test:e2e"
+
+    opts.on("--path PATH","Path within the e2e tests to create the file")
+    def execute
+      if args.empty?
+        err.puts "'#{self.class.command_name}' requires a name"
+        return 1
+      end
+      test_name = args.join(" ").gsub(/\"/,"'")
+      test_file_name = args.join("_").gsub(/\W/,"_").gsub(/__+/,"_").downcase + ".spec.rb"
+      test_file_dir = Brut.container.e2e_specs_dir
+      if !options.path.nil?
+        test_file_dir = test_file_dir / options.path
+      end
+
+      path_to_test_file = test_file_dir / test_file_name
+
+      verb         = "Created"
+      dry_run_verb = "create"
+
+      if path_to_test_file.exist?
+        if global_options.overwrite?
+          verb         = "Overwrote"
+          dry_run_verb = "overwrite"
+        else
+          err.puts "#{path_to_test_file.relative_path_from(Brut.container.project_root)} exists. Use --overwrite to replace it"
+          return 1
+        end
+      end
+
+
+        code = %{require "spec_helper"
+
+RSpec.describe "#{test_name}" do
+  it "should have tests" do
+    page.goto("/")
+    expect(page).to be_page_for(page_class_here)
+  end
+end}
+      if global_options.dry_run?
+        out.puts "Will #{dry_run_verb} #{path_to_test_file.relative_path_from(Brut.container.project_root)} with this code:"
+        out.puts_no_prefix
+        out.puts_no_prefix code
+      else
+        FileUtils.mkdir_p test_file_dir
+        File.open(path_to_test_file,"w") do |file|
+          file.puts code
+        end
+        out.puts "#{verb} #{path_to_test_file.relative_path_from(Brut.container.project_root)}"
+      end
+      0
+    end
 
+  private
+
+    def find_classes(ast,current_modules = [])
+      classes = []
+      if ast.nil?
+        return classes
+      end
+      new_module = nil
+      if ast.kind_of?(Prism::ClassNode)
+        classes << [ current_modules, ast ]
+        new_module = ast
+      elsif ast.kind_of?(Prism::ModuleNode)
+        new_module = ast
+      end
+      ast.child_nodes.each do |child|
+        new_current_modules = current_modules + [ new_module ]
+        result = find_classes(child, new_current_modules.compact)
+        classes = classes + result
+      end
+      classes
+    end
   end
+
   class Component < Brut::CLI::Command
     description "Create a new component, template, and associated test"
+    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"
     opts.on("--page","If set, this component is for a specific page and won't go with the other components")
     args "ComponentName"
     def execute
       if args.length != 1
         raise "component requires exactly one argument, got #{args.length}"
       end
-      class_name = RichString.new(args[0])
+      class_name = RichString.new(args[0]).capitalize(:first_only)
       if class_name.to_s !~ /Component$/
         class_name = RichString.new(class_name.to_s + "Component")
       end
@@ -153,9 +235,9 @@ end}
       end
 
       if global_options.dry_run?
-        puts "FileUtils.mkdir_p #{source_path.dirname}"
-        puts "FileUtils.mkdir_p #{html_source_path.dirname}"
-        puts "FileUtils.mkdir_p #{spec_path.dirname}"
+        out.puts "FileUtils.mkdir_p #{source_path.dirname}"
+        out.puts "FileUtils.mkdir_p #{html_source_path.dirname}"
+        out.puts "FileUtils.mkdir_p #{spec_path.dirname}"
       else
         FileUtils.mkdir_p source_path.dirname
         FileUtils.mkdir_p html_source_path.dirname
@@ -186,6 +268,293 @@ end}
       0
     end
   end
+  class Page < Brut::CLI::Command
+    class Route < Brut::FrontEnd::Routing::PageRoute
+      def initialize(path_template)
+        path_template = "/#{path_template}".gsub(/\/\//,"/")
+        super(path_template)
+      end
+      def locate_handler_class(suffix,preposition, on_missing: :raise)
+        begin
+          super(suffix,preposition,on_missing: :raise).name.split(/::/)
+        rescue Brut::Framework::Errors::NoClassForPath => ex
+          class_name_path = ex.class_name_path
+          ex.class_name_path
+        end
+      end
+    end
+    description "Create a new page, template, and associated test"
+    args "page_route"
+    def execute
+      if args.length != 1
+        raise "page requires exactly one argument, got #{args.length}"
+      end
+      route = Route.new(args[0])
+
+      page_class_name    = RichString.from_string(route.handler_class.join("::"))
+      page_relative_path = page_class_name.underscorized
+
+      pages_src_dir    = Brut.container.pages_src_dir
+      pages_specs_dir  = Brut.container.pages_specs_dir
+      i18n_locales_dir = Brut.container.i18n_locales_dir
+
+      page_source_path     = Pathname( (pages_src_dir   / page_relative_path).to_s + ".rb" )
+      template_source_path = Pathname( (pages_src_dir   / page_relative_path).to_s + ".html.erb" )
+      page_spec_path       = Pathname( (pages_specs_dir / page_relative_path).to_s + ".spec.rb" )
+      app_path             = Pathname( Brut.container.app_src_dir / "app.rb" )
+      app_translations     = Pathname(  i18n_locales_dir / "en" / "2_app.rb")
+
+      exists = [
+        page_source_path,
+        template_source_path,
+        page_spec_path,
+      ].select(&:exist?)
+
+      if exists.any? && !global_options.overwrite?
+        exists.each do |path|
+          err.puts "'#{path.relative_path_from(Brut.container.project_root)}' exists already"
+        end
+        err.puts "Re-run with --overwrite to overwrite these files"
+        return 1
+      end
+
+      FileUtils.mkdir_p page_source_path.dirname,     noop: global_options.dry_run?
+      FileUtils.mkdir_p template_source_path.dirname, noop: global_options.dry_run?
+      FileUtils.mkdir_p page_spec_path.dirname,       noop: global_options.dry_run?
+
+      route_code = "page \"#{route.path_template}\""
+
+      initializer_params = route.path_params
+      initializer_params_code = if initializer_params.empty?
+                                  ""
+                                else
+                                  "(" + initializer_params.map { "#{it}:" }.join(", ") + ")"
+                                end
+
+      page_class_code = %{class #{page_class_name} < AppPage
+  def initialize#{initializer_params_code} # add needed arguments here
+  end
+end}
+      template_code = %{<h1>#{page_class_name} is ready!</h1>}
+      page_spec_code = %{require "spec_helper"
+
+RSpec.describe #{page_class_name} do
+  it "should have tests" do
+    expect(true).to eq(false)
+  end
+end}
+
+      title = RichString.new(page_class_name).underscorized.humanized.to_s.capitalize
+      translations_code = "       \"#{page_class_name}\": {\n         title: \"#{title}\",\n       \},"
+
+      if global_options.dry_run?
+        out.puts app_path.relative_path_from(Brut.container.project_root)
+        out.puts "will contain:\n\n#{route_code}\n\n"
+        out.puts page_source_path.relative_path_from(Brut.container.project_root)
+        out.puts "will contain:\n\n#{page_class_code}\n\n"
+        out.puts template_source_path.relative_path_from(Brut.container.project_root)
+        out.puts "will contain:\n\n#{template_code}\n\n"
+        out.puts page_spec_path.relative_path_from(Brut.container.project_root)
+        out.puts "will contain:\n\n#{page_spec_code}\n\n"
+        out.puts app_translations.relative_path_from(Brut.container.project_root)
+        out.puts "will contain:\n\n#{translations_code}\n\n"
+      else
+
+        File.open(page_source_path,"w")     { it.puts page_class_code }
+        File.open(template_source_path,"w") { it.puts template_code }
+        File.open(page_spec_path,"w")       { it.puts page_spec_code }
+
+        existing_translations = File.read(app_translations).split(/\n/)
+        inserted_translation = false
+        File.open(app_translations,"w") do |file|
+          existing_translations.each do |line|
+            if line =~ /^    pages:\s*{/
+              file.puts line
+              file.puts translations_code
+              inserted_translation = true
+            else
+              file.puts line
+            end
+          end
+        end
+        if !inserted_translation
+          err.puts "WARNING: Could not find a place to insert the translation for this page's title"
+          err.puts "         The page may not render properly the first time you load it"
+        end
+
+        routes_editor = RoutesEditor.new(app_path:,out:)
+        routes_editor.add_route!(route_code:)
+
+        if !routes_editor.found_routes?
+          out.puts "Could not find routes declaration in #{app_path.relative_path_from(Brut.container.project_root)}"
+          out.puts "Please add this to wherever you have defined your routes:\n\n#{route_code}\n\n"
+        elsif routes_editor.routes_existed?
+          out.puts "Routes declaration in #{app_path.relative_path_from(Brut.container.project_root)} contained the route defition already"
+          out.puts "Please make sure everything is correct.  Here is the defintion that was not inserted:\n\n#{route_code}"
+        end
+      end
+      out.puts "Page source is in        #{page_source_path.relative_path_from(Brut.container.project_root)}"
+      out.puts "Page HTML template is in #{template_source_path.relative_path_from(Brut.container.project_root)}"
+      out.puts "Page test is in          #{page_spec_path.relative_path_from(Brut.container.project_root)}"
+      out.puts "Added title to           #{app_translations.relative_path_from(Brut.container.project_root)}"
+      out.puts "Added route to           #{app_path.relative_path_from(Brut.container.project_root)}"
+      0
+    end
+  end
+  class Action < Brut::CLI::Command
+    class Route < Brut::FrontEnd::Routing::FormRoute
+      def initialize(path_template)
+        path_template = "/#{path_template}".gsub(/\/\//,"/")
+        super(path_template)
+      end
+      def locate_handler_class(suffix,preposition, on_missing: :raise)
+        begin
+          super(suffix,preposition,on_missing: :raise).name.split(/::/)
+        rescue Brut::Framework::Errors::NoClassForPath => ex
+          class_name_path = ex.class_name_path
+          ex.class_name_path
+        end
+      end
+    end
+    description "Create a handler for an action"
+    args "action_route"
+    opts.on "--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"
+    def execute(form: false)
+      if args.length != 1
+        raise "#{self.class.command_name} requires exactly one argument, got #{args.length}"
+      end
+      route = Route.new(args[0])
+
+      form_class_name    = RichString.from_string(route.form_class.join("::"))
+      handler_class_name = RichString.from_string(route.handler_class.join("::"))
+
+      relative_path         = form_class_name.underscorized
+      handler_relative_path = handler_class_name.underscorized
+
+      forms_src_dir      = Brut.container.forms_src_dir
+      handlers_src_dir   = Brut.container.handlers_src_dir
+      handlers_specs_dir = Brut.container.handlers_specs_dir
+
+      form_source_path    = Pathname( (forms_src_dir      / relative_path).to_s + ".rb" )
+      handler_source_path = Pathname( (handlers_src_dir   / handler_relative_path).to_s + ".rb" )
+      handler_spec_path   = Pathname( (handlers_specs_dir / handler_relative_path).to_s + ".spec.rb" )
+      app_path            = Pathname( Brut.container.app_src_dir / "app.rb" )
+
+      paths_to_check = [
+        handler_source_path,
+        handler_spec_path,
+      ]
+      if form
+        paths_to_check << form_source_path
+      end
+
+      exists = paths_to_check.select(&:exist?)
+
+      if exists.any? && !global_options.overwrite?
+        exists.each do |path|
+          err.puts "'#{path.relative_path_from(Brut.container.project_root)}' exists already"
+        end
+        err.puts "Re-run with global option --overwrite to overwrite these files"
+        return 1
+      end
+
+      if form
+        FileUtils.mkdir_p form_source_path.dirname, noop: global_options.dry_run?
+      end
+      FileUtils.mkdir_p handler_source_path.dirname, noop: global_options.dry_run?
+      FileUtils.mkdir_p handler_spec_path.dirname,   noop: global_options.dry_run?
+
+      form_code = %{class #{form_class_name} < AppForm
+  input :some_field, minlength: 3
+end}
+      handle_method_code = if form
+                             'raise "You need to implement your Handler\#{form.class.input_definitions.length < 2 ? " and likely your Form as well" : ""}"'
+                           else
+                             raise "You need to implement your Handler"
+                           end
+      handler_code = begin
+                       handle_params = []
+                       if form
+                         handle_params << :form
+                       end
+                       handle_params += route.path_params
+                       handle_params_code = handle_params.map { "#{it}:" }.join(", ")
+        %{class #{handler_class_name} < AppHandler
+  def handle(#{handle_params_code}) # add other args here as needed
+    #{handle_method_code}
+  end
+end}
+                     end
+
+      spec_code = %{require "spec_helper"
+
+RSpec.describe #{handler_class_name} do
+  subject(:handler) { described_class.new }
+  describe "#handle!" do
+    it "needs tests" do
+      expect(true).to eq(false)
+    end
+  end
+end}
+
+      route_code = if form
+                     "form \"#{route.path_template}\""
+                   elsif options.http_method.nil?
+                     "action \"#{route.path_template}\""
+                   else
+                     "path \"#{route.path_template}\", method: :#{options.http_method.downcase}"
+                   end
+
+      if global_options.dry_run?
+        out.puts app_path.relative_path_from(Brut.container.project_root)
+        out.puts "will contain:\n\n#{route_code}\n\n"
+        if form
+          out.puts form_source_path.relative_path_from(Brut.container.project_root)
+          out.puts "will contain:\n\n#{form_code}\n\n"
+        end
+        out.puts handler_source_path.relative_path_from(Brut.container.project_root)
+        out.puts "will contain:\n\n#{handler_code}\n\n"
+        out.puts handler_spec_path.relative_path_from(Brut.container.project_root)
+        out.puts "will contain:\n\n#{spec_code}\n\n"
+      else
+        class_name_length = [ form_class_name.length, handler_class_name.length, "Spec".length ].max
+        printf_string = "%-#{class_name_length}s in %s\n"
+        out.puts "\n\n"
+        if form
+          out.printf printf_string,form_class_name,form_source_path.relative_path_from(Brut.container.project_root)
+        end
+        out.printf printf_string,handler_class_name, handler_source_path.relative_path_from(Brut.container.project_root)
+        out.printf printf_string,"Spec", handler_spec_path.relative_path_from(Brut.container.project_root)
+
+        routes_editor = RoutesEditor.new(app_path:,out:)
+        routes_editor.add_route!(route_code:)
+
+        if form
+          File.open(form_source_path,"w") { it.puts form_code }
+        end
+        File.open(handler_source_path,"w") { it.puts handler_code }
+        File.open(handler_spec_path,"w") { it.puts spec_code }
+        if !routes_editor.found_routes?
+          out.puts "Could not find routes declaration in #{app_path.relative_path_from(Brut.container.project_root)}"
+          out.puts "Please add this to wherever you have defined your routes:\n\n#{route_code}\n\n"
+        elsif routes_editor.routes_existed?
+          out.puts "Routes declaration in #{app_path.relative_path_from(Brut.container.project_root)} contained the route defition already"
+          out.puts "Please make sure everything is correct.  Here is the defintion that was not inserted:\n\n#{route_code}"
+        end
+      end
+      0
+    end
+  end
+
+  class Form < Action
+    description "Create a form and handler"
+    args "form_route"
+
+    def execute
+      super(form:true)
+    end
+  end
+
   class CustomElementTest < Brut::CLI::Command
     description "Create a test for a custom element in your app"
     args "path_to_js_files..."
@@ -214,7 +583,7 @@ end}
 
       if existing_files.any? && !global_options.overwrite?
         relative_paths = existing_files.map { |_,pathname| pathname.relative_path_from(Brut.container.project_root) }
-        err.puts "Some files to be generated already exist. Set --overwrite to overwrite them:"
+        err.puts "Some files to be generated already exist. Set global option --overwrite to overwrite them:"
         relative_paths.each do |file|
           err.puts file
         end
@@ -253,4 +622,41 @@ describe("#{description}", () => {
       0
     end
   end
+
+  class RoutesEditor
+    def initialize(app_path:,out:)
+      @app_path       = app_path
+      @out            = out
+      @found_routes   = false
+      @routes_existed = false
+    end
+
+    def found_routes?   = @found_routes
+    def routes_existed? = @routes_existed
+
+    def add_route!(route_code:)
+      app_contents = File.read(@app_path).split(/\n/)
+      File.open(@app_path,"w") do |file|
+        in_routes = false
+        app_contents.each do |line|
+          if line =~ /^  routes do\s*$/
+            in_routes = true
+          end
+          if in_routes && line.include?(route_code)
+            @routes_existed = true
+          end
+          if in_routes && line =~ /^  end\s*$/
+            if !@routes_existed
+              @out.puts "Inserted route into #{@app_path.relative_path_from(Brut.container.project_root)}"
+              file.puts "    #{route_code}"
+            end
+            @found_routes = true
+            in_routes = false
+          end
+          file.puts line
+        end
+      end
+    end
+  end
 end
+

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

@@ -15,6 +15,7 @@ class Brut::CLI::Apps::Test < Brut::CLI::App
     opts.on("--[no-]rebuild-after", "If true, test database is rebuilt after tests are run (default false)")
     opts.on("--seed SEED", "Set the random seed to allow duplicating a test run")
     args "specs_to_run..."
+    env_var("LOGGER_LEVEL_FOR_TESTS",purpose: "Can be set to debug, info, warn, error, or fatal to control logging during tests. Defaults to 'warn' to avoid verbose test output")
 
     def rspec_command
       parts = [
@@ -64,6 +65,10 @@ class Brut::CLI::Apps::Test < Brut::CLI::App
     opts.on("--[no-]rebuild-after", "If true, test database is rebuilt after tests are run (default true)")
     opts.on("--seed SEED", "Set the random seed to allow duplicating a test run")
     args "specs_to_run..."
+    env_var("E2E_RECORD_VIDEOS",purpose: "If set to 'true', videos of each test run are saved in `./tmp/e2e-videos`")
+    env_var("E2E_SLOW_MO",purpose: "If set to, will attempt to slow operations down by this many milliseconds")
+    env_var("E2E_TIMEOUT_MS",purpose: "ms to wait for any browser activity before failing the test. And here you didn't think you'd get away without using sleep in browse-based tests?")
+    env_var("LOGGER_LEVEL_FOR_TESTS",purpose: "Can be set to debug, info, warn, error, or fatal to control logging during tests. Defaults to 'warn' to avoid verbose test output")
 
     def rspec_cli_args = "--tag e2e"
     def rebuild_by_default?       = true
@@ -76,7 +81,15 @@ class Brut::CLI::Apps::Test < Brut::CLI::App
       if options.build_assets?
         system!({ "RACK_ENV" => "test" }, "bin/build-assets")
       end
-      system!({ "NODE_DISABLE_COLORS" => "1" },"npx mocha #{Brut.container.js_specs_dir} --no-color --extension 'spec.js' --recursive")
+      begin
+        system!({ "NODE_DISABLE_COLORS" => "1" },"npx mocha #{Brut.container.js_specs_dir} --no-color --extension 'spec.js' --recursive")
+      rescue Brut::CLI::SystemExecError => ex
+        if ex.exit_status == 1
+          out.puts "mocha exited 1 - assuming this is because there are no test files and that this is intentional"
+        else
+          raise ex
+        end
+      end
       0
     end
   end