brut 0.5.0 → 0.9.0

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

@@ -51,7 +51,7 @@ class Brut::CLI::Apps::Scaffold < Brut::CLI::App
       files_to_test_files.each do |source,destination|
         result = Prism.parse_file(source.to_s)
         if !result
-          raise "For some reason Prism did not parse #{source.to_s}"
+          raise "For some reason Prism did not parse #{source}"
         end
         classes = find_classes(result.value).map { |(module_nodes,class_node)|
           (module_nodes.map(&:constant_path).map(&:full_name).map(&:to_s) + [class_node.constant_path.full_name.to_s]).compact.join("::")

data/lib/brut/cli/options.rb

@@ -74,4 +74,8 @@ class Brut::CLI::Options
       value
     end
   end
+  def respond_to_missing?(sym, include_private = false)
+    # XXX: Maybe this should not
+    true
+  end
 end

data/lib/brut/factory_bot.rb

@@ -7,7 +7,7 @@ class Brut::FactoryBot
   def setup!
     Faker::Config.locale = :en
     FactoryBot.definition_file_paths = [
-      Brut.container.app_specs_dir / "factories"
+      Brut.container.app_specs_dir / "factories",
     ]
     FactoryBot.define do
       to_create { |instance| instance.save }

data/lib/brut/framework/app.rb

@@ -89,7 +89,7 @@ class Brut::Framework::App
       raise ArgumentError, "Your error handler block may only accept exception: and http_status_code: as required keyword parameters.  The following parameters were found:\n  #{messages.join("\n  ")}"
     end
     if @error_blocks[condition]
-      raise ArgumentError, "You have already configured error handling for condition '#{condition.to_s}'"
+      raise ArgumentError, "You have already configured error handling for condition '#{condition}'"
     end
     @error_blocks[condition] = block
   end

data/lib/brut/framework/config.rb

@@ -319,6 +319,17 @@ class Brut::Framework::Config
         allow_app_override: true,
       )
 
+      c.store(
+        "csrf_protector",
+        Brut::FrontEnd::CsrfProtector,
+        "Object to allow custom logic related to CSRF protection",
+        allow_app_override: true
+      ) do
+        Brut::FrontEnd::CsrfProtector.new
+      end
+
+
+
       c.store(
         "semantic_logger_appenders",
         { Hash => "if only one appender is needed", Array => "to configure multiple appenders" },

data/lib/brut/framework/mcp.rb

@@ -131,9 +131,9 @@ class Brut::Framework::MCP
             exception: ex)
         rescue => ex2
           $stderr.puts "While handling an error recording an exception, we get another error from SemanticLogger." + [
-            [ :original_exception,  exception,  ].join(": "),
-            [ :exception_from_recording_exception,  ex, ].join(": "),
-            [ :exception_from_semantic_logger,  ex2 ].join(": "),
+            [ :original_exception,                  exception  ].join(": "),
+            [ :exception_from_recording_exception,  ex ].join(": "),
+            [ :exception_from_semantic_logger,      ex2 ].join(": "),
 
           ].join(", ")
         end
@@ -174,7 +174,7 @@ class Brut::Framework::MCP
     end
 
     message = if Brut.container.project_env.development?
-                "Form submission did not include an authenticity token. All forms must include one. To add one, use the `form_tag` helper, or include Brut::FrontEnd::Components::Inputs::CsrfToken somewhere inside your <form> tag"
+                "Form submission did not include an authenticity token. All forms must include one. To add one, use the `Brut::FrontEnd::Components::FormTag` component, or include Brut::FrontEnd::Components::Inputs::CsrfToken somewhere inside your <form> tag"
               else
                 "Forbidden"
               end
@@ -186,10 +186,15 @@ class Brut::Framework::MCP
         Rack::Protection::AuthenticityToken,
         [
           {
-            allow_if: ->(env) { env["brut.owned_path"] },
+            allow_if: ->(env) { 
+              brut_owned_path = env["brut.owned_path"] 
+              app_allowed = Brut.container.csrf_protector.tap {|_| puts _.class.name }.allowed?(env)
+
+              brut_owned_path || app_allowed
+            },
             message: message,
-          }
-        ]
+          },
+        ],
       ],
     ]
     if Brut.container.auto_reload_classes?
@@ -275,7 +280,7 @@ class Brut::Framework::MCP
             in TrueClass
               nil
             else
-              raise NoMatchingPatternError, "Result from #{method} hook #{klass}'s #{method} method was a #{result.class} (#{result.to_s} as a string), which cannot be used to understand the response to generate. Return nil or true if processing should proceed"
+              raise NoMatchingPatternError, "Result from #{method} hook #{klass}'s #{method} method was a #{result.class} (#{result} as a string), which cannot be used to understand the response to generate. Return nil or true if processing should proceed"
             end
           end
         end

data/lib/brut/front_end/components/form_tag.rb

@@ -36,10 +36,10 @@ class Brut::FrontEnd::Components::FormTag < Brut::FrontEnd::Component
         form_class = form_class.class
       end
       if html_attributes[:action]
-        raise ArgumentError, "You cannot specify both for: (#{form_class}) and and action: (#{html_attributes[:action]}) to a form_tag"
+        raise ArgumentError, "You cannot specify both for: (#{form_class}) and and action: (#{html_attributes[:action]}) to #{self.class}"
       end
       if html_attributes[:method]
-        raise ArgumentError, "You cannot specify both for: (#{form_class}) and and method: (#{html_attributes[:method]}) to a form_tag"
+        raise ArgumentError, "You cannot specify both for: (#{form_class}) and and method: (#{html_attributes[:method]}) to #{self.class}"
       end
       begin
         route = Brut.container.routing.route(form_class)

data/lib/brut/front_end/csrf_protector.rb

@@ -0,0 +1,30 @@
+# Base for custom logic around CSRF protection.  Brut configures `Rack::Protection::AuthenticityToken` for all requests, and
+# this happens early in the request.  The idea is that no real POST should be missing a CSRF token.  That said, there are times
+# when it must be skipped, such as for webhooks.  In that case, you can extend this class and configure it via
+# `Brut.container.override("csrf_protector", YourCustomCsrfProtector.new)` in your `App` class' initializer.
+#
+# @example
+#   class CsrfProtector < Brut::FrontEnd::CsrfProtector
+#     def allowed?(env)
+#       !!env["PATH_INFO"].to_s.match?(/^\/webhooks\//)
+#     end
+#   end
+#   # Then, in app.rb
+#   class App < Brut::Framework::App
+#     def id           = "some-id"
+#     def organization = "some-org"
+#   
+#     def initialize
+#       Brut.container.override("csrf_protector") do
+#         CsrfProtector.new
+#       end
+#       
+#       # ...
+#
+class Brut::FrontEnd::CsrfProtector
+
+  # Return true if the request should be allowed without a CSRF token. This implementation returns false.
+  def allowed?(env)
+    false
+  end
+end

data/lib/brut/front_end/form.rb

@@ -73,7 +73,7 @@ class Brut::FrontEnd::Form
                  }
                else
                  [
-                   input_definition.make_input(value:, index: nil)
+                   input_definition.make_input(value:, index: nil),
                  ]
                end
 
@@ -109,7 +109,7 @@ class Brut::FrontEnd::Form
   # @return [Brut::FrontEnd::Forms::Input]
   def inputs(input_name)
     @inputs.fetch(input_name.to_s)
-  rescue KeyError => ex
+  rescue KeyError
     raise Brut::Framework::Errors::Bug, "Form does not define the input '#{input_name}'. You must add this to your form. Found these inputs: #{@inputs.keys.join(', ')}"
   end
 
@@ -164,8 +164,8 @@ class Brut::FrontEnd::Form
                   true
                 end
               },
-              index
-            ]
+              index,
+           ],
           ]
         end
       }.compact

data/lib/brut/front_end/page.rb

@@ -86,7 +86,7 @@ private
     layout_class = Module.const_get(
       layout_class = RichString.new([
         self.layout,
-        "layout"
+        "layout",
       ].join("_")).camelize
     )
     Brut.container.instrumentation.add_prefixed_attributes("brut", layout_class: layout_class)

data/lib/brut/front_end/routing.rb

@@ -276,7 +276,7 @@ private
       }
       part_names[-1] += suffix
       begin
-        part_names.inject(Module) { |mod,path_element|
+        part_names.reduce(Module) { |mod,path_element|
           mod.const_get(path_element,mod == Module)
         }
       rescue NameError => ex

data/lib/brut/front_end.rb

@@ -9,6 +9,7 @@ module Brut::FrontEnd
   autoload(:AssetPathResolver, "brut/front_end/asset_path_resolver")
   autoload(:Component, "brut/front_end/component")
   autoload(:Components, "brut/front_end/component")
+  autoload(:CsrfProtector, "brut/front_end/csrf_protector")
   autoload(:Download, "brut/front_end/download")
   autoload(:Flash, "brut/front_end/flash")
   autoload(:Form, "brut/front_end/form")

data/lib/brut/i18n/base_methods.rb

@@ -211,7 +211,7 @@ module Brut::I18n::BaseMethods
       block_contents = safe(capture(&block))
       interpolated_values[:block] = block_contents
     end
-    t_direct(keys_to_check,**interpolated_values.merge(key_given: key))
+    t_direct(keys_to_check,**interpolated_values, key_given: key)
   rescue I18n::MissingInterpolationArgument => ex
     if ex.key.to_s == "block"
       raise ArgumentError,"One of the keys #{key.join(", ")} contained a %{block} interpolation value: '#{ex.string}'. This means you must yield a block to `t`"

data/lib/brut/instrumentation/logger_span_exporter.rb

@@ -58,7 +58,7 @@ private
       (span.events || []).each do |event|
         event_message = (" " * (indent + 2)) + "event:#{event.name}"
         event_params = {
-          timing: ((event.timestamp - previous_timestamp)/1_000.0).to_i/1_000.0
+          timing: ((event.timestamp - previous_timestamp)/1_000.0).to_i/1_000.0,
         }.merge(event.attributes).merge(synthetic_attributes)
         SemanticLogger[self.class].info(event_message,event_params)
         previous_timestamp = event.timestamp

data/lib/brut/junk_drawer.rb

@@ -96,7 +96,9 @@ class RichString
       }.
       join.gsub("-","_").
       gsub(/[_]+/,"_").
-      gsub(/^_+/,"").
+      split(/::/).
+      map { |it| it.gsub(/^_+/,"") }.
+      join("/").
       gsub(/_+$/,"")
     )
   end

data/lib/brut/rubocop_config.rb

@@ -0,0 +1,123 @@
+require "pathname"
+require "yaml"
+# Not here:
+#  - prevent use of postfix conditonals entirely
+module Brut
+  IM_NOT_CALLING_THEM_COPS = {
+    "Gemspec/AddRuntimeDependency" => true,
+    "Lint/AmbiguousAssignment" => true,
+    "Lint/AmbiguousOperator" => true,
+    "Lint/AmbiguousOperatorPrecedence" => true,
+    "Lint/AmbiguousRange" => true,
+    "Lint/AmbiguousRegexpLiteral" => true,
+    "Lint/DuplicateCaseCondition" => true,
+    "Lint/DuplicateElsifCondition" => true,
+    "Lint/Loop" => true,
+    "Lint/RedundantSplatExpansion" => true,
+    "Lint/RedundantStringCoercion" => true,
+    "Lint/RedundantTypeConversion" => true,
+    "Lint/ToJSON" => true,
+    "Style/ColonMethodDefinition" => true,
+    "Style/DefWithParentheses" => true,
+    "Style/InvertibleUnlessCondition" => true,
+    "Style/KeywordArgumentsMerging" => true,
+    "Style/MethodDefParentheses" => true,
+    "Style/MissingRespondToMissing" => true,
+    "Style/MultilineTernaryOperator" => true,
+    "Style/NegatedUnless" => true,
+    "Style/NestedTernaryOperator" => true,
+    "Style/PreferredHashMethods" => true,
+    "Style/UnlessElse" => true,
+    "Style/UnlessLogicalOperators" => true,
+    "Layout/DotPosition" => {
+      "EnforcedStyle" =>  "trailing",
+    },
+    "Lint/AssignmentInCondition" => {
+      "AllowSafeAssignment" =>  "false",
+    },
+    "Style/ClassMethodsDefinitions" => {
+      "EnforcedStyle" =>  "def_self",
+    },
+    "Style/CollectionMethods" => {
+      "PreferredMethods" => {
+        "find" => "detect",
+        "collect" => "map",
+        "find_all" => "select",
+        "member?" => "include?",
+      },
+    },
+    "Style/EndlessMethod" => {
+      "EnforcedStyle" =>  "allow_single_line",
+    },
+    "Style/For" => {
+      "EnforcedStyle" =>  "each",
+    },
+    "Style/YodaCondition" => {
+      "EnforcedStyle" =>  "forbid_for_all_comparison_operators",
+    },
+    "Style/DisableSyntax" => {
+      "DisableSyntax" => [
+        "unless",
+        "and_or_not",
+        "until",
+      ],
+    },
+    "Style/TrailingCommaInArrayLiteral" => {
+      "EnforcedStyleForMultiline" => "consistent_comma",
+    },
+    "Style/TrailingCommaInHashLiteral" => {
+      "EnforcedStyleForMultiline" => "consistent_comma",
+    },
+    # Documented, but nonexistent
+    #"Style/ItBlockParameter" => {
+    #  "EnforcedStyle" => "allow_single_line",
+    #},
+  }
+  PREAMBLE = {
+    "inherit_mode" => {
+      "merge" => [ "Exclude" ],
+    },
+    "plugins" => [
+      "rubocop-disable_syntax",
+    ],
+    "AllCops" => {
+      "DisabledByDefault" => true,
+      "TargetRubyVersion" => RUBY_VERSION.split(".")[0..1].join("."),
+      "SuggestExtensions" => false,
+      "Exclude" => [
+        "local-gems/**/*",
+        "**/local-gems/**/*",
+        "node_modules/**/*",
+        "**/node_modules/**/*",
+      ],
+    },
+  }
+  class RubocopConfig
+    def create_ridiculous_yaml
+      if !ARGV[0]
+        raise "You must supply the file where the config will be written"
+      end
+      filename = Pathname(ARGV[0])
+      my_big_yaml_hash_of_doom = {}.merge(PREAMBLE)
+      IM_NOT_CALLING_THEM_COPS.each do |not_a_cop, config|
+        body = case config
+               when Hash
+                 config
+               when Array
+                 config
+               when true
+                 {}
+               else
+                 raise "#{config.class}/#{config} is not handled by this contraption"
+               end
+        body["Enabled"] = true
+        my_big_yaml_hash_of_doom[not_a_cop] = body
+      end
+      File.open(filename,"w") do |file|
+        file.puts "# This file is generated! DO NOT EDIT (not that you'd want to - it's YAML!)"
+        file.puts "# The configuration is canonically stored in lib/brut/rubocop_config.rb"
+        file.puts my_big_yaml_hash_of_doom.to_yaml
+      end
+    end
+  end
+end

data/lib/brut/spec_support/component_support.rb

@@ -51,9 +51,6 @@ module Brut::SpecSupport::ComponentSupport
   #   result = generate_and_parse(HeaderComponent.new(title: "Hello!")
   #   expect(result.e!("h1").text).to eq("Hello!")
   #
-  # @example Using context
-  #   result = generate_and_parse(TableRow.new([ "one", "two" ]), context: "tbody")
-  #
   # @param [Brut::FrontEnd::Component] component the component instance you wish to generate. This should be set up to simulate the test
   # you are running.
   # @yield if the component requires or accepts a yielded block, this is how you do that in the test.

data/lib/brut/spec_support/rspec_setup.rb

@@ -100,10 +100,10 @@ class Brut::SpecSupport::RSpecSetup
       if needs_request_context
         session = {
           "session_id" => "test-session-id",
-          "csrf" => "test-csrf-token"
+          "csrf" => "test-csrf-token",
         }
         env = {
-          "rack.session" => session
+          "rack.session" => session,
         }
         app_session = Brut.container.session_class.new(rack_session: session)
         request_context = Brut::FrontEnd::RequestContext.new(

data/lib/brut/version.rb

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

data/mkbrut/.gitignore

@@ -0,0 +1,16 @@
+# AI droppings
+/.cursor
+# Local gem cache
+/local-gems
+# Forever banned from ringside
+/node_modules
+
+# Local developer credentials - should not be checked in!
+/dx/credentials
+/dx/build.args
+
+# Bundler uses this for locally-built gems.
+/pkg
+
+# From hell’s heart I stab at thee; for hate’s sake I spit my last breath at thee.
+.DS_Store

data/mkbrut/CODE_OF_CONDUCT.txt

@@ -0,0 +1,100 @@
+Contributor Covenant Code of Conduct
+
+Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+Our Standards
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others’ private information, such as a physical or email address,
+without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+professional setting
+
+Enforcement Responsibilities
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+Scope
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+Enforcement
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+abuse@thirdtank.com
+
+All complaints will be reviewed and investigated promptly and fairly.
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+Enforcement Guidelines
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+1. Correction
+Community Impact: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+Consequence: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+2. Warning
+Community Impact: A violation through a single incident or series of
+actions.
+Consequence: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+3. Temporary Ban
+Community Impact: A serious violation of community standards, including
+sustained inappropriate behavior.
+Consequence: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+4. Permanent Ban
+Community Impact: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+Consequence: A permanent ban from any sort of public interaction within the
+community.
+Attribution
+This Code of Conduct is adapted from the Contributor Covenant,
+version 2.1, available at
+https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.
+Community Impact Guidelines were inspired by
+Mozilla’s code of conduct enforcement ladder.
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.
+

data/mkbrut/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/mkbrut/Gemfile.lock

@@ -0,0 +1,19 @@
+PATH
+  remote: .
+  specs:
+    mkbrut (0.9.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (13.3.0)
+
+PLATFORMS
+  aarch64-linux
+
+DEPENDENCIES
+  mkbrut!
+  rake
+
+BUNDLED WITH
+   2.7.1