brut 0.1.0 → 0.2.0

data/lib/brut/front_end/components/inputs/select_tag_with_options.rb

@@ -72,8 +72,8 @@ class Brut::FrontEnd::Components::Inputs::SelectTagWithOptions < Brut::FrontEnd:
       option = options.detect { |option|
         input_value == option.send(@value_attribute)
       }
-      if option.nil?
-        raise ArgumentError, "selected_value #{input_value} was not the value for #{value_attribute} on any of the options: #{options.map { |option| option.send(value_attribute) }.join(', ')}"
+      if option.nil? && option.to_s.strip != ""
+        raise ArgumentError, "selected_value #{input_value}/#{input_value.class} was not the value for #{value_attribute} on any of the options: #{options.map { |option| option.send(value_attribute) }.join(', ')}"
       end
       @selected_value = option.send(@value_attribute)
     end

data/lib/brut/junk_drawer.rb

@@ -51,29 +51,64 @@ class Clock
 end
 
 # A wrapper around a string to avoid adding a ton of methods to `String`.
+#
+# This may not survive to 1.0 - use at your own risk.
 class RichString
+  # Create a RichString, return `nil` instead for blank strings or nil
+  # @param [String|nil] string the string to convert.
+  # @param [true|false] blank_is_nil if true, a blank string or nil is considered
+  #        nil and nil is returned.
+  # @return [RichString|nil] a RichString containing the string or nil if the 
+  #         string is blank or nil, accounting for `blank_is_nil:`
   def self.from_string(string,blank_is_nil:true)
+    if string.nil?
+        return nil
+    end
     if string.to_s.strip == "" && blank_is_nil
       return nil
     end
     self.new(string)
   end
+
+  # Create a RichString. This calls `to_s` on its argument.
+  #
+  # @param [String|Object] string the string to wrap. `to_s` is called, so be sure
+  #        that's what you want.
   def initialize(string)
     @string = string.to_s
   end
 
+  # Return a snake_case version of the string.  This will convert dashes to
+  # underscores, and use A-Z to know where to insert underscores.  Repeated
+  # underscores are coalesced into one, and there will be no leading or trailing
+  # underscores in the string.
+  # @visibility private
   def underscorized
-    return self unless /[A-Z-]|::/.match?(@string)
-    word = @string.gsub("::", "/")
-    word.gsub!(/(?<=[A-Z])(?=[A-Z][a-z])|(?<=[a-z\d])(?=[A-Z])/, "_")
-    word.tr!("-", "_")
-    word.downcase!
-    RichString.new(word)
+    RichString.new(
+      self.to_s.split(/([A-Z])/).
+      select { it.length > 0 }.
+      map { |part|
+        if part == part.upcase
+          "_#{part.downcase}"
+        else
+          part
+        end
+      }.
+      join.gsub("-","_").
+      gsub(/[_]+/,"_").
+      gsub(/^_+/,"").
+      gsub(/_+$/,"")
+    )
   end
 
+  # Turn a string into CamelCase by captializing any
+  # letter that is preceded by an underscore or dash.
+  # @visibility private
   def camelize
-    @string.to_s.split(/[_-]/).map { |part|
-      RichString.new(part).capitalize(:first_only).to_s
+    @string.to_s.split(/[_-]/).select {
+      it.strip.length > 0
+    }.map {
+      RichString.new(it).capitalize(:first_only).to_s
     }.join("")
   end
 
@@ -85,6 +120,7 @@ class RichString
   #
   # @param [Array] options options suitable for Ruby's built-in `String#capitalize` method
   # @return [RichString] a new string where the wrapped string has been capitalized
+  # @visibility private
   def capitalize(*options)
     if options.include?(:first_only)
       options.delete(:first_only)
@@ -94,6 +130,9 @@ class RichString
     end
   end
 
+  # Takes a snake_case_or-kebab-case-string and returns it with the underscores
+  # and dashes replaced with spaces.
+  # @visibility private
   def humanized
     RichString.new(@string.tr("_-"," "))
   end
@@ -102,7 +141,7 @@ class RichString
   def to_str = self.to_s
   def length = to_s.length
 
-  def to_s_or_nil = @string.empty? ? nil : self.to_s
+  def to_s_or_nil = @string.to_s.strip.empty? ? nil : self.to_s
 
   def ==(other)
     if other.kind_of?(RichString)

data/lib/brut/version.rb

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

data/specs/brut/junk_drawer.spec.rb

@@ -0,0 +1,75 @@
+require "spec_helper"
+
+RSpec.describe "RichString" do
+  describe ".from_string" do
+    context "nil" do
+      it "returns nil when blank_is_nil is true" do
+        expect(RichString.from_string(nil)).to eq(nil)
+      end
+      it "returns nil when blank_is_nil is false" do
+        expect(RichString.from_string(nil, blank_is_nil: false)).to eq(nil)
+      end
+    end
+    context "empty string" do
+      it "returns nil when blank_is_nil is true" do
+        expect(RichString.from_string("     ")).to eq(nil)
+      end
+      it "returns the string when blank_is_nil is false" do
+        expect(RichString.from_string("     ", blank_is_nil: false)).to eq("     ")
+      end
+    end
+    context "non-empty string" do
+      it "returns a RichString containing the string" do
+        rich_string = RichString.from_string(" foo    ")
+        expect(rich_string.to_str).to eq(" foo    ")
+      end
+    end
+  end
+  describe "#underscorized" do
+    it "returns self if there's nothing to convert" do
+      rich_string = RichString.new("alreadydone")
+      expect(rich_string.underscorized).to eq(rich_string)
+    end
+    it "splits up CamelCase, turns - into _ and downcases everything" do
+      rich_string = RichString.new("DashBoardPage")
+      expect(rich_string.underscorized.to_s).to eq("dash_board_page")
+    end
+    it "handles weird situations" do
+      rich_string = RichString.new("Dash--BoardHTMLPage---")
+      expect(rich_string.underscorized.to_s).to eq("dash_board_h_t_m_l_page")
+    end
+  end
+  describe "#camelize" do
+    it "splits on _ and -, captializes each part and joins them" do
+      expect(RichString.new("a-normal-base-case").camelize).to eq("ANormalBaseCase")
+      expect(RichString.new("an__odd-_-----_one").camelize).to eq("AnOddOne")
+      expect(RichString.new("Somewhat-Close").camelize).to eq("SomewhatClose")
+      expect(RichString.new("AlreadyDone").camelize).to eq("AlreadyDone")
+    end
+  end
+  describe "#capitalize" do
+    context "first_only" do
+      it "capitalizes the first letter, but does not affect the case of remaining letters" do
+        expect(RichString.new("this is a String").capitalize(:first_only).to_s).to eq("This is a String")
+      end
+    end
+    context "no first_only" do
+      it "behaves as Ruby's stdlib does, which is to capitalize the first letter and downcase the rest" do
+        expect(RichString.new("this is a String").capitalize.to_s).to eq("This is a string")
+      end
+    end
+  end
+  describe "#humanized" do
+    it "replaces - and _ with spaces" do
+      expect(RichString.new("this-is-a-string").humanized).to eq("this is a string")
+    end
+  end
+  describe "#to_s_or_nil" do
+    it "returns nil if the string is empty" do
+      expect(RichString.new("   ").to_s_or_nil).to eq(nil)
+    end
+    it "returns the string if the string is not empty" do
+      expect(RichString.new(" foo ").to_s_or_nil).to eq(" foo ")
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: brut
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - David Bryant Copeland
@@ -581,6 +581,7 @@ files:
 - brutrb.com/.vitepress/theme/custom.css
 - brutrb.com/.vitepress/theme/index.js
 - brutrb.com/.vitepress/theme/style.css
+- brutrb.com/adrs.md
 - brutrb.com/ai.md
 - brutrb.com/assets.md
 - brutrb.com/bin/build
@@ -610,6 +611,8 @@ files:
 - brutrb.com/handlers.md
 - brutrb.com/hooks.md
 - brutrb.com/i18n.md
+- brutrb.com/images/DevEnvironment.graffle
+- brutrb.com/images/DevEnvironment.png
 - brutrb.com/images/LogoPylon.png
 - brutrb.com/images/LogoSquare.png
 - brutrb.com/images/LogoStop.png
@@ -621,8 +624,6 @@ files:
 - brutrb.com/images/dev-env-overview.png
 - brutrb.com/images/dev-env-protocol.dot
 - brutrb.com/images/dev-env-protocol.png
-- brutrb.com/images/logo-300.png
-- brutrb.com/images/logo.png
 - brutrb.com/images/overview.graffle
 - brutrb.com/images/overview.png
 - brutrb.com/images/spa.dot
@@ -638,7 +639,6 @@ files:
 - brutrb.com/lsp.md
 - brutrb.com/markdown-examples.md
 - brutrb.com/middleware.md
-- brutrb.com/not-released.md
 - brutrb.com/overview.md
 - brutrb.com/package-lock.json
 - brutrb.com/package.json
@@ -651,6 +651,7 @@ files:
 - brutrb.com/recipes/custom-flash.md
 - brutrb.com/recipes/indexed-forms.md
 - brutrb.com/recipes/text-field-component.md
+- brutrb.com/roadmap.md
 - brutrb.com/routes.md
 - brutrb.com/security.md
 - brutrb.com/seed-data.md
@@ -663,6 +664,7 @@ files:
 - docs/404.html
 - docs/CNAME
 - docs/SocialImage.png
+- docs/adrs.html
 - docs/ai.html
 - docs/api/Brut.html
 - docs/api/Brut/BackEnd.html
@@ -882,27 +884,30 @@ files:
 - docs/api/method_list.html
 - docs/api/top-level-namespace.html
 - docs/assets.html
+- docs/assets/DevEnvironment.DaFcVfwP.png
 - docs/assets/LogoStop.Gb3tDhL1.png
 - docs/assets/OverviewMetro.DUS-5fUZ.png
+- docs/assets/adrs.md.JRxZ5uYE.js
+- docs/assets/adrs.md.JRxZ5uYE.lean.js
 - docs/assets/ai.md.Cy9GWnER.js
 - docs/assets/ai.md.Cy9GWnER.lean.js
-- docs/assets/app.ClaS47Ru.js
+- docs/assets/app.Dm3x-DQc.js
 - docs/assets/assets.md.7C3HWkga.js
 - docs/assets/assets.md.7C3HWkga.lean.js
 - docs/assets/brut-js.md.B4GYxQVw.js
 - docs/assets/brut-js.md.B4GYxQVw.lean.js
 - docs/assets/business-logic.md.BY4hGy0m.js
 - docs/assets/business-logic.md.BY4hGy0m.lean.js
-- docs/assets/chunks/@localSearchIndexroot.Biqy1A4t.js
-- docs/assets/chunks/VPLocalSearchBox.DtgDfde2.js
+- docs/assets/chunks/@localSearchIndexroot.BqRrkR00.js
+- docs/assets/chunks/VPLocalSearchBox.DL6bnqee.js
 - docs/assets/chunks/framework.1L-BeKqY.js
-- docs/assets/chunks/theme.B45bvibT.js
+- docs/assets/chunks/theme.BXdlf6e8.js
 - docs/assets/cli.md.CjsktgFz.js
 - docs/assets/cli.md.CjsktgFz.lean.js
-- docs/assets/components.md.DatoNgFo.js
-- docs/assets/components.md.DatoNgFo.lean.js
-- docs/assets/configuration.md.DeyhpqEx.js
-- docs/assets/configuration.md.DeyhpqEx.lean.js
+- docs/assets/components.md.Pg_Lo35G.js
+- docs/assets/components.md.Pg_Lo35G.lean.js
+- docs/assets/configuration.md.BfeGnEci.js
+- docs/assets/configuration.md.BfeGnEci.lean.js
 - docs/assets/css.md.CltvJqAa.js
 - docs/assets/css.md.CltvJqAa.lean.js
 - docs/assets/custom-element-tests.md.B_rbta32.js
@@ -913,14 +918,13 @@ files:
 - docs/assets/database-schema.md.CSYk6E6v.lean.js
 - docs/assets/deployment.md.BLseERGV.js
 - docs/assets/deployment.md.BLseERGV.lean.js
-- docs/assets/dev-env-overview.Gj7NWM8-.png
 - docs/assets/dev-env-protocol.DysDAtnz.png
-- docs/assets/dev-environment.md.BroAOLhF.js
-- docs/assets/dev-environment.md.BroAOLhF.lean.js
+- docs/assets/dev-environment.md.Dy6EldaM.js
+- docs/assets/dev-environment.md.Dy6EldaM.lean.js
 - docs/assets/dir-structure.md.CWir1pic.js
 - docs/assets/dir-structure.md.CWir1pic.lean.js
-- docs/assets/doc-conventions.md.BzmSrTEW.js
-- docs/assets/doc-conventions.md.BzmSrTEW.lean.js
+- docs/assets/doc-conventions.md.DOkAuXlt.js
+- docs/assets/doc-conventions.md.DOkAuXlt.lean.js
 - docs/assets/end-to-end-tests.md.DzqRpZ43.js
 - docs/assets/end-to-end-tests.md.DzqRpZ43.lean.js
 - docs/assets/features.md.DPFXsy0z.js
@@ -929,18 +933,18 @@ files:
 - docs/assets/flash-and-session.md.nPvUpnUx.lean.js
 - docs/assets/form-constraints.md.x5tNpTTI.js
 - docs/assets/form-constraints.md.x5tNpTTI.lean.js
-- docs/assets/forms.md.C2Dizvzq.js
-- docs/assets/forms.md.C2Dizvzq.lean.js
-- docs/assets/getting-started.md.C93e0odB.js
-- docs/assets/getting-started.md.C93e0odB.lean.js
+- docs/assets/forms.md.BQZlCwvi.js
+- docs/assets/forms.md.BQZlCwvi.lean.js
+- docs/assets/getting-started.md.BcXnNuD6.js
+- docs/assets/getting-started.md.BcXnNuD6.lean.js
 - docs/assets/handlers.md.Chyri6KA.js
 - docs/assets/handlers.md.Chyri6KA.lean.js
 - docs/assets/hooks.md.Jmb5VOLA.js
 - docs/assets/hooks.md.Jmb5VOLA.lean.js
 - docs/assets/i18n.md.xQhiGo1G.js
 - docs/assets/i18n.md.xQhiGo1G.lean.js
-- docs/assets/index.md.CAMqGBJE.js
-- docs/assets/index.md.CAMqGBJE.lean.js
+- docs/assets/index.md.Bn9e0sRJ.js
+- docs/assets/index.md.Bn9e0sRJ.lean.js
 - docs/assets/instrumentation.md.BgcaGVYH.js
 - docs/assets/instrumentation.md.BgcaGVYH.lean.js
 - docs/assets/javascript.md.DzrMxUmI.js
@@ -957,10 +961,8 @@ files:
 - docs/assets/markdown-examples.md.CCFEQO44.lean.js
 - docs/assets/middleware.md.Czz_UlJN.js
 - docs/assets/middleware.md.Czz_UlJN.lean.js
-- docs/assets/not-released.md.BBy28McC.js
-- docs/assets/not-released.md.BBy28McC.lean.js
-- docs/assets/overview.md.Bdq4qt3L.js
-- docs/assets/overview.md.Bdq4qt3L.lean.js
+- docs/assets/overview.md.iMnwLO4x.js
+- docs/assets/overview.md.iMnwLO4x.lean.js
 - docs/assets/pages.md.B7Hc-i6H.js
 - docs/assets/pages.md.B7Hc-i6H.lean.js
 - docs/assets/recipes_alternate-layouts.md.BwEytl59.js
@@ -975,6 +977,8 @@ files:
 - docs/assets/recipes_indexed-forms.md.CstYyOSo.lean.js
 - docs/assets/recipes_text-field-component.md.H4wLAK0Z.js
 - docs/assets/recipes_text-field-component.md.H4wLAK0Z.lean.js
+- docs/assets/roadmap.md.C6PRi0DX.js
+- docs/assets/roadmap.md.C6PRi0DX.lean.js
 - docs/assets/routes.md.B8kfUPHU.js
 - docs/assets/routes.md.B8kfUPHU.lean.js
 - docs/assets/security.md.C0G_AZR-.js
@@ -984,9 +988,9 @@ files:
 - docs/assets/spa.qejUdp-5.png
 - docs/assets/space-time-continuum.md.xl44xDos.js
 - docs/assets/space-time-continuum.md.xl44xDos.lean.js
-- docs/assets/style.prAgp4yQ.css
-- docs/assets/tutorial.md.a4a0eVOy.js
-- docs/assets/tutorial.md.a4a0eVOy.lean.js
+- docs/assets/style.B1z60PPQ.css
+- docs/assets/tutorial.md.BYXj4cOu.js
+- docs/assets/tutorial.md.BYXj4cOu.lean.js
 - docs/assets/unit-tests.md.DUGrnLj5.js
 - docs/assets/unit-tests.md.DUGrnLj5.lean.js
 - docs/assets/why.md.C-hk5xgJ.js
@@ -1115,7 +1119,6 @@ files:
 - docs/lsp.html
 - docs/markdown-examples.html
 - docs/middleware.html
-- docs/not-released.html
 - docs/overview.html
 - docs/pages.html
 - docs/recipes/alternate-layouts.html
@@ -1124,6 +1127,7 @@ files:
 - docs/recipes/custom-flash.html
 - docs/recipes/indexed-forms.html
 - docs/recipes/text-field-component.html
+- docs/roadmap.html
 - docs/routes.html
 - docs/security.html
 - docs/seed-data.html
@@ -1285,6 +1289,7 @@ files:
 - specs/brut/front_end/forms/input.spec.rb
 - specs/brut/front_end/forms/radio_button_group_input.spec.rb
 - specs/brut/front_end/forms/select_input.spec.rb
+- specs/brut/junk_drawer.spec.rb
 - specs/spec_helper.rb
 - specs/support.rb
 - specs/support/matchers.rb

data/brutrb.com/not-released.md

@@ -1,5 +0,0 @@
-# Brut is Not Released Software
-
-> [!WARNING]
-> Brut is not considered released.  It is still in development and some of what is in this doc
-> site is inaccurate.