brut 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0a674e5f292d833626132e6cb0d634eb7432a5f814cfdde37456980c5066ace
-  data.tar.gz: dfe06bd16d1af502fc42512c1eb9c6500d2f13e3355587e705bb3e0f314f59be
+  metadata.gz: 7702194ca39391fce02e749d6050ff7ac0856739d4e635a562d01284eb8d2d95
+  data.tar.gz: b7581e5a3ae897eae7acfb200e8a40c36092992305db27f25e319807d6986882
 SHA512:
-  metadata.gz: d6c1dae45c7e5f30b6e01ff4add890fbc3bbe1581c2363fa872a627d040f1dbe08a99e2d07c1f56e15d4f542cb506fa5a3e1f4d4ce4f0e15accba0ae3976b2fb
-  data.tar.gz: bcdf28454960102dfc70dc7a2b74f52ab7b661a83cd6050473a3de28628c636fd02cb476b44c3ab7000d64500b494682780cd1f60b4d5da5f0747652d33917f9
+  metadata.gz: d8cb683694e8a4b1f1d35226d3cc0f60d3b4c6200c81f89a330f4efb74e359a8f31ebee40b2ad9b8264188b960bee505634092417b0e48fa8b71825d7bf01810
+  data.tar.gz: d5ab249e7cdb783a9698af017c8c550910b39863c26842357c422e70716e5ce940ba6150d43e621faa60b9fdeffd578d765479ad2168403c5a2e863c427e8bfe

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    brut (0.0.3)
+    brut (0.0.5)
       concurrent-ruby
       i18n
       irb

data/bin/bin_kit.rb

@@ -2,6 +2,18 @@ require "pathname"
 require "fileutils"
 require "open3"
 
+def capture!(*args)
+  log "Executing #{args} and capturing results"
+  out,err,status = Open3.capture3(*args)
+  if status.success?
+    return [out,err]
+  else
+    $STDERR.puts out
+    $STDERR.puts err
+    log "#{args} failed"
+    abort
+  end
+end
 # We don't want the setup method to have to do all this error
 # checking, and we also want to explicitly log what we are
 # executing. Thus, we use this method instead of Kernel#system

data/bin/setup

@@ -65,8 +65,17 @@ def setup(update_gems:,setup_credentials:)
       x = gets
     end
 
-    log "Adding your SSH key to ssh-agent - you must provide your passphrase"
-    system! "ssh-add #{key_file}"
+    log "Checking if ssh-agent has your SSH key"
+    out,_err = capture!("ssh-keygen -lf #{key_file}")
+    sha256 = out.split(/SHA256:/)[1].split(/\s+/)[0]
+    command = "ssh-add -l | grep #{sha256} > /dev/null"
+    log "Running '#{command}' to check"
+    if system(command)
+      log "SSH Key is in ssh agent"
+    else
+      log "Adding your SSH key to ssh-agent - you must provide your passphrase"
+      system! "ssh-add #{key_file}"
+    end
 
     known_hosts_dest = Pathname("/") / "root" / ".ssh" / "known_hosts"
     if known_hosts_dest.exist?

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

@@ -470,7 +470,7 @@ 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"
+                             'raise "You need to implement your Handler"'
                            end
       handler_code = begin
                        handle_params = []

data/lib/brut/front_end/component.rb

@@ -197,9 +197,10 @@ class Brut::FrontEnd::Component
     # @param timestamp [Time] the timestamp to format/render. Mutually exclusive with `date`.
     # @param date [Date] the date to format/render. Mutually exclusive with `timestamp`.
     # @param component_options [Hash] keyword arguments to pass to {Brut::FrontEnd::Components::Time#initialize}
-    def time_tag(timestamp:nil,date:nil, **component_options)
+    # @yield See {Brut::FrontEnd::Components::Time#initialize}
+    def time_tag(timestamp:nil,date:nil, **component_options, &contents)
       args = component_options.merge(timestamp:,date:)
-      component(Brut::FrontEnd::Components::Time.new(**args))
+      component(Brut::FrontEnd::Components::Time.new(**args,&contents))
     end
 
     # Render the {Brut::FrontEnd::Components::ConstraintViolations} component for the given form's input.
@@ -215,7 +216,7 @@ class Brut::FrontEnd::Component
     end
 
     # Create an HTML input tag for the given input of a form.  This is a convieniece method
-    # that calls {Brut::FrontEnd::Components::Input::TextField.for_form_input}.
+    # that calls {Brut::FrontEnd::Components::Inputs::TextField.for_form_input}.
     def input_tag(form:, input_name:, index: nil, **html_attributes)
       component(Brut::FrontEnd::Components::Inputs::TextField.for_form_input(form:,input_name:,index:,html_attributes:))
     end

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

@@ -11,6 +11,9 @@ class Brut::FrontEnd::Components::Time < Brut::FrontEnd::Component
   # @param attribute_format [Symbol] the I18n format key fragment to use to locate the strftime format for formatting *the `datetime` attribute* of the HTML element that this component renders. Generally, you want to leave this as the default of `:iso_8601`, however if you need to change it, you can.  This value is appeneded to `"time.formats."` to form the complete key. `skip_year_if_same` is not used for this value.
   # @param only_contains_class [Hash] exists because `class` is a reserved word
   # @option only_contains_class [String] :class the value to use for the `class` attribute.
+  # @yield No parameters given. This is expected to return markup to appear inside the `<form>` element. If provided, this component
+  # will still render the `datetime` attribute, but not the inside.  This is useful if you have a customized date or time display that
+  # you would like to be accessible.  If omitted, the tag's contents will be the formated date or timestamp.
   def initialize(
     timestamp: nil,
     date: nil,
@@ -18,7 +21,8 @@ class Brut::FrontEnd::Components::Time < Brut::FrontEnd::Component
     skip_year_if_same: true,
     skip_dow_if_not_this_week: true,
     attribute_format: :iso_8601,
-    **only_contains_class
+    **only_contains_class,
+    &contents
   )
     require_exactly_one!(timestamp:,date:)
 
@@ -65,6 +69,7 @@ class Brut::FrontEnd::Components::Time < Brut::FrontEnd::Component
     @format           = found_format.to_sym
     @attribute_format = attribute_format.to_sym
     @class_attribute  = only_contains_class[:class] || ""
+    @contents         = contents
   end
 
   def render(clock:)
@@ -77,7 +82,11 @@ class Brut::FrontEnd::Components::Time < Brut::FrontEnd::Component
     datetime_attribute = ::I18n.l(adjusted_value,format: @attribute_format)
 
     html_tag(:time, class: @class_attribute, datetime: datetime_attribute) do
-      ::I18n.l(adjusted_value,format: @format)
+      if @contents
+        @contents.()
+      else
+        ::I18n.l(adjusted_value,format: @format)
+      end
     end
   end
 

data/lib/brut/front_end/templates/locator.rb

@@ -41,7 +41,7 @@ class Brut::FrontEnd::Templates::Locator
   # @param [String] base_name the base name of a file that is expected to have a template.  This is searched relative to the paths
   # provided to the constructor, so it may have nested paths
   # @return [String] path to the template for the given `base_name`
-  # @raises StandardError if zero or more than one templates are found
+  # @raise StandardError if zero or more than one templates are found
   def locate(base_name)
     paths_to_try = @paths.map { |path|
       path / "#{base_name}.#{@extension}"

data/lib/brut/i18n/base_methods.rb

@@ -31,6 +31,8 @@ module Brut::I18n::BaseMethods
   #               is a `Brut::FrontEnd::Page` or is a page component.  It's `page_name` will be used to create
   #               a key based on the value of `page:`: `pages.«page_name».«page: value»`.
   #               if `component:` is included, the behavior is the same but for `component` instead of `page`.
+  #               Note that if the page– or component–specific key is not found, this will check
+  #               `general.«page: value»`.
   # @option interpolated_values [Numeric] count Special interpolation to control pluralization.
   #
   # @raise [I18n::MissingTranslation] if no translation is found
@@ -66,6 +68,9 @@ module Brut::I18n::BaseMethods
   # @example Using page:
   #   # in your translations file
   #   en: {
+  #     general: {
+  #       new_widget: "Make a New Widget",
+  #     },
   #     pages: {
   #       HomePage: {
   #         new_widget: "Create new Widget"
@@ -79,6 +84,8 @@ module Brut::I18n::BaseMethods
   #   t(page: :new_widget) # => Create new Widget
   #   # in your code for WidgetsPage
   #   t(page: :new_widget) # => Create New
+  #   # in your code for SomeOtherEPage
+  #   t(page: :new_widget) # => Make a New Widget
   #
   # @example Using page: with an array
   #   # in your translations file
@@ -104,13 +111,17 @@ module Brut::I18n::BaseMethods
         raise ArgumentError, "You may only specify page or component, not both"
       end
 
+      subkey = nil
       if page
-        key = ["pages.#{self.page_name}.#{Array(page).join('.')}"]
+        subkey = Array(page).join(".")
+        key = ["pages.#{self.page_name}.#{subkey}"]
       elsif component
-        key = ["components.#{self.component_name}.#{Array(component).join('.')}"]
+        subkey = Array(component).join(".")
+        key = ["components.#{self.component_name}.#{subkey}"]
       else
         raise ArgumentError, "If you omit an explicit key, you must specify page or component"
       end
+      key << "general.#{subkey}"
     else
       key = Array(key).join('.')
       key = [key,"general.#{key}"]

data/lib/brut/junk_drawer.rb

@@ -8,7 +8,7 @@ class Clock
   #
   # @param [TZInfo::Timezone] tzinfo_timezone if present, this is the timezone of the clock.
   # @param [Time] now if omitted, uses `Time.now` when asked the current time. Otherwises, uses this value, as a `Time` for
-  # now.  Don't do this unless you are testing.
+  #               now.  Don't do this unless you are testing.
   def initialize(tzinfo_timezone, now: nil)
     if tzinfo_timezone
       @timezone = tzinfo_timezone

data/lib/brut/spec_support/clock_support.rb

@@ -1,5 +1,10 @@
+# Convienience methods for creating clocks needed in tests
 module Brut::SpecSupport::ClockSupport
+  # Return a real lock in UTC
   def real_clock = Clock.new(TZInfo::Timezone.get("UTC"))
+  # Return a clock whose value for now is `now`
+  #
+  # @param [String] now a string containing the value you want for {Clock#now} to return.
   def clock_at(now:)
     Clock.new(TZInfo::Timezone.get("UTC"), now: Time.parse(now))
   end

data/lib/brut/spec_support/component_support.rb

@@ -2,6 +2,8 @@ require_relative "flash_support"
 require_relative "session_support"
 require_relative "clock_support"
 require_relative "enhanced_node"
+
+# Convienience methods for writing tests of components or pages.
 module Brut::SpecSupport::ComponentSupport
   include Brut::SpecSupport::FlashSupport
   include Brut::SpecSupport::SessionSupport
@@ -66,10 +68,12 @@ module Brut::SpecSupport::ComponentSupport
     Brut::SpecSupport::EnhancedNode.new(nokogiri_node)
   end
 
+  # @!visibility private
   def routing_for(klass,**args)
     Brut.container.routing.uri(klass,**args)
   end
 
+  # Escape HTML using the same code Brut uses for rendering templates.
   def escape_html(...)
     Brut::FrontEnd::Templates::EscapableFilter.escape_html(...)
   end

data/lib/brut/spec_support/enhanced_node.rb

@@ -1,5 +1,7 @@
 require "delegate"
 
+# A delegator to a Nokogiri Node that provides convienience methods
+# for navigating the DOM inside a test.
 class Brut::SpecSupport::EnhancedNode < SimpleDelegator
   include RSpec::Matchers
 

data/lib/brut/spec_support/flash_support.rb

@@ -1,6 +1,11 @@
+# Convienience methods for using a Flash inside tests.
 module Brut::SpecSupport::FlashSupport
+  # Create a normal empty flash, using the app's configured class.
   def empty_flash = Brut.container.flash_class.new
 
+  # Create a flash using the app's configured class that contains the given hash as its values.
+  #
+  # @param [Hash] hash Values to include in the Flash.
   def flash_from(hash)
     Brut.container.flash_class.from_h(messages: hash)
   end

data/lib/brut/spec_support/general_support.rb

@@ -1,9 +1,16 @@
+# Convienience methods included in all tests.
 module Brut::SpecSupport::GeneralSupport
   def self.included(mod)
     mod.extend(ClassMethods)
   end
 
   module ClassMethods
+    # To pass bin/test audit with a class whose implementation is trivial, call this inside the RSpec `describe` block. This is better
+    # than an empty test as it makes it more explicit that you believe the implementation is trivial enough to not require a test. You
+    # can also set an expiration for this thinking.
+    #
+    # @param [Time|String] check_again_at if given, this will cause the test to fail after the given date/time.  If passed as a
+    #                                     string, `Date.parse` is used to convert it to a `Time`.
     def implementation_is_trivial(check_again_at: nil)
       check_again_at = if check_again_at.nil?
                          nil
@@ -20,6 +27,11 @@ module Brut::SpecSupport::GeneralSupport
         end
       end
     end
+
+    # Used when a class' implmentation is covered by other tests. This is better than omitting the test or having a blank one, as it
+    # makes it explicit that some other test covers this class' behavior.
+    #
+    # @param [String] description An explanation of what other tests cover this class' implementation.
     def implementation_is_covered_by_other_tests(description)
       it "has no tests because the implementation is sufficiently covered by other tests: #{description}" do
         expect(true).to eq(true)

data/lib/brut/spec_support/handler_support.rb

@@ -1,6 +1,8 @@
 require_relative "flash_support"
 require_relative "clock_support"
 require_relative "session_support"
+
+# Convienience methods for testing handlers.
 module Brut::SpecSupport::HandlerSupport
   include Brut::SpecSupport::FlashSupport
   include Brut::SpecSupport::ClockSupport

data/lib/brut/spec_support/matcher.rb

@@ -1,3 +1,4 @@
+# Holds custom matchers useful in various tests.
 module Brut::SpecSupport::Matchers
 end
 require_relative "matchers/be_a_bug"

data/lib/brut/spec_support/session_support.rb

@@ -1,3 +1,5 @@
+# Convienience methods for creating sessions inside a test.
 module Brut::SpecSupport::SessionSupport
+  # Create an empty session, using the class configured by the app
   def empty_session = Brut.container.session_class.new(rack_session: {})
 end

data/lib/brut/version.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: brut
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - David Bryant Copeland
 bindir: exe
 cert_chain: []
-date: 2025-02-19 00:00:00.000000000 Z
+date: 2025-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: irb