brut 0.10.0 → 0.12.0

data/specs/brut/instrumentation/methods.spec.rb

@@ -0,0 +1,399 @@
+require "spec_helper"
+
+RSpec.describe Brut::Instrumentation::Methods do
+  describe "#instrument" do
+    it "instruments only those methods specified" do
+      mock_container = double("Brut::Framework::Container")
+      instrumentation = instance_double(Brut::Instrumentation::OpenTelemetry)
+      allow(Brut).to receive(:container).and_return(mock_container)
+      allow(mock_container).to receive(:instrumentation).and_return(instrumentation)
+      allow(instrumentation).to receive(:span).and_yield(double("span that should not be used"))
+
+      class_to_instrument = Class.new do
+        include Brut::Instrumentation::Methods
+
+        def save
+          @save_called = true
+        end
+
+        def search
+          @search_called = true
+        end
+
+        def self.name # since this is an anonymous class, need some name to show up
+          "TestClass"
+        end
+
+        private
+
+        def delete
+          @delete_called = true
+        end
+
+        instrument :save, :delete
+      end
+      object = class_to_instrument.new
+
+      object.save
+      object.search
+      object.send(:delete)
+
+      expect(object.instance_variable_get(:@save_called)).to   eq(true)
+      expect(object.instance_variable_get(:@search_called)).to eq(true)
+      expect(object.instance_variable_get(:@delete_called)).to eq(true)
+      expect(instrumentation).to have_received(:span).with(
+        "TestClass#save",
+        attributes: {
+          "brut.class" => "TestClass",
+          "brut.method" => "save",
+        }
+      )
+      expect(instrumentation).to have_received(:span).with(
+        "TestClass#delete",
+        attributes: {
+          "brut.class" => "TestClass",
+          "brut.method" => "delete",
+        }
+      )
+      expect(instrumentation).not_to have_received(:span).with(
+        /\#search/,
+        attributes: kind_of(Hash)
+      )
+    end
+    it "works when called on a method definition" do
+      mock_container = double("Brut::Framework::Container")
+      instrumentation = instance_double(Brut::Instrumentation::OpenTelemetry)
+      allow(Brut).to receive(:container).and_return(mock_container)
+      allow(mock_container).to receive(:instrumentation).and_return(instrumentation)
+      allow(instrumentation).to receive(:span).and_yield(double("span that should not be used"))
+
+      class_to_instrument = Class.new do
+        include Brut::Instrumentation::Methods
+
+        instrument def save
+          @save_called = true
+        end
+
+        def search
+          @search_called = true
+        end
+
+        def self.name # since this is an anonymous class, need some name to show up
+          "TestClass"
+        end
+
+        private
+
+        instrument def delete
+          @delete_called = true
+        end
+      end
+      object = class_to_instrument.new
+
+      object.save
+      object.search
+      object.send(:delete)
+
+      expect(object.instance_variable_get(:@save_called)).to   eq(true)
+      expect(object.instance_variable_get(:@search_called)).to eq(true)
+      expect(object.instance_variable_get(:@delete_called)).to eq(true)
+      expect(instrumentation).to have_received(:span).with(
+        "TestClass#save",
+        attributes: {
+          "brut.class" => "TestClass",
+          "brut.method" => "save",
+        }
+      )
+      expect(instrumentation).to have_received(:span).with(
+        "TestClass#delete",
+        attributes: {
+          "brut.class" => "TestClass",
+          "brut.method" => "delete",
+        }
+      )
+      expect(instrumentation).not_to have_received(:span).with(
+        /\#search/,
+        attributes: kind_of(Hash)
+      )
+    end
+
+    it "calling it twice raises an error" do
+      expect {
+        Class.new do
+          include Brut::Instrumentation::Methods
+
+          def save
+            @save_called = true
+          end
+
+          def self.name # since this is an anonymous class, need some name to show up
+            "TestClass"
+          end
+
+          instrument :save
+          instrument :save
+        end
+      }.to raise_error(ArgumentError, /already instrumented/)
+    end
+
+    it "instrumenting a nonexistent method raises an error" do
+      expect {
+        Class.new do
+          include Brut::Instrumentation::Methods
+
+          def save
+            @save_called = true
+          end
+
+          def self.name # since this is an anonymous class, need some name to show up
+            "TestClass"
+          end
+
+          instrument :foo
+        end
+      }.to raise_error(ArgumentError)
+    end
+  end
+  describe "#instrument_all" do
+    it "instruments all methods" do
+      mock_container = double("Brut::Framework::Container")
+      instrumentation = instance_double(Brut::Instrumentation::OpenTelemetry)
+      allow(Brut).to receive(:container).and_return(mock_container)
+      allow(mock_container).to receive(:instrumentation).and_return(instrumentation)
+      allow(instrumentation).to receive(:span).and_yield(double("span that should not be used"))
+
+      class_to_instrument = Class.new do
+        include Brut::Instrumentation::Methods
+
+        def save
+          @save_called = true
+        end
+
+        def search
+          @search_called = true
+        end
+
+        def self.name # since this is an anonymous class, need some name to show up
+          "TestClass"
+        end
+
+        private
+
+        def delete
+          @delete_called = true
+        end
+
+        instrument_all
+      end
+      object = class_to_instrument.new
+
+      object.save
+      object.search
+      object.send(:delete)
+
+      expect(object.instance_variable_get(:@save_called)).to   eq(true)
+      expect(object.instance_variable_get(:@search_called)).to eq(true)
+      expect(object.instance_variable_get(:@delete_called)).to eq(true)
+      expect(instrumentation).to have_received(:span).with(
+        "TestClass#save",
+        attributes: {
+          "brut.class" => "TestClass",
+          "brut.method" => "save",
+        }
+      )
+      expect(instrumentation).to have_received(:span).with(
+        "TestClass#delete",
+        attributes: {
+          "brut.class" => "TestClass",
+          "brut.method" => "delete",
+        }
+      )
+      expect(instrumentation).to have_received(:span).with(
+        "TestClass#search",
+        attributes: {
+          "brut.class" => "TestClass",
+          "brut.method" => "search",
+        }
+      )
+    end
+    it "instruments all methods defined after it is called" do
+      mock_container = double("Brut::Framework::Container")
+      instrumentation = instance_double(Brut::Instrumentation::OpenTelemetry)
+      allow(Brut).to receive(:container).and_return(mock_container)
+      allow(mock_container).to receive(:instrumentation).and_return(instrumentation)
+      allow(instrumentation).to receive(:span).and_yield(double("span that should not be used"))
+
+      class_to_instrument = Class.new do
+        include Brut::Instrumentation::Methods
+        instrument_all
+
+        def save
+          @save_called = true
+        end
+
+        def search
+          @search_called = true
+        end
+
+        def self.name # since this is an anonymous class, need some name to show up
+          "TestClass"
+        end
+
+        private
+
+        def delete
+          @delete_called = true
+        end
+      end
+      object = class_to_instrument.new
+
+      object.save
+      object.search
+      object.send(:delete)
+
+      expect(object.instance_variable_get(:@save_called)).to   eq(true)
+      expect(object.instance_variable_get(:@search_called)).to eq(true)
+      expect(object.instance_variable_get(:@delete_called)).to eq(true)
+      expect(instrumentation).to have_received(:span).with(
+        "TestClass#save",
+        attributes: {
+          "brut.class" => "TestClass",
+          "brut.method" => "save",
+        }
+      )
+      expect(instrumentation).to have_received(:span).with(
+        "TestClass#delete",
+        attributes: {
+          "brut.class" => "TestClass",
+          "brut.method" => "delete",
+        }
+      )
+      expect(instrumentation).to have_received(:span).with(
+        "TestClass#search",
+        attributes: {
+          "brut.class" => "TestClass",
+          "brut.method" => "search",
+        }
+      )
+    end
+  end
+  describe "#instrument_public" do
+    it "instruments only public methods" do
+      mock_container = double("Brut::Framework::Container")
+      instrumentation = instance_double(Brut::Instrumentation::OpenTelemetry)
+      allow(Brut).to receive(:container).and_return(mock_container)
+      allow(mock_container).to receive(:instrumentation).and_return(instrumentation)
+      allow(instrumentation).to receive(:span).and_yield(double("span that should not be used"))
+
+      class_to_instrument = Class.new do
+        include Brut::Instrumentation::Methods
+
+        def save
+          @save_called = true
+        end
+
+        def search
+          @search_called = true
+        end
+
+        def self.name # since this is an anonymous class, need some name to show up
+          "TestClass"
+        end
+
+        private
+
+        def delete
+          @delete_called = true
+        end
+
+        instrument_public
+
+      end
+      object = class_to_instrument.new
+
+      object.save
+      object.search
+      object.send(:delete)
+
+      expect(object.instance_variable_get(:@save_called)).to   eq(true)
+      expect(object.instance_variable_get(:@search_called)).to eq(true)
+      expect(object.instance_variable_get(:@delete_called)).to eq(true)
+      expect(instrumentation).to have_received(:span).with(
+        "TestClass#save",
+        attributes: {
+          "brut.class" => "TestClass",
+          "brut.method" => "save",
+        }
+      )
+      expect(instrumentation).to have_received(:span).with(
+        "TestClass#search",
+        attributes: {
+          "brut.class" => "TestClass",
+          "brut.method" => "search",
+        }
+      )
+      expect(instrumentation).not_to have_received(:span).with(
+        "TestClass#delete",
+        attributes: kind_of(Hash)
+      )
+    end
+    it "instruments only public methods defined after it is called" do
+      mock_container = double("Brut::Framework::Container")
+      instrumentation = instance_double(Brut::Instrumentation::OpenTelemetry)
+      allow(Brut).to receive(:container).and_return(mock_container)
+      allow(mock_container).to receive(:instrumentation).and_return(instrumentation)
+      allow(instrumentation).to receive(:span).and_yield(double("span that should not be used"))
+
+      class_to_instrument = Class.new do
+        include Brut::Instrumentation::Methods
+        instrument_public
+
+        def save
+          @save_called = true
+        end
+
+        def search
+          @search_called = true
+        end
+
+        def self.name # since this is an anonymous class, need some name to show up
+          "TestClass"
+        end
+
+        private
+
+        def delete
+          @delete_called = true
+        end
+
+      end
+      object = class_to_instrument.new
+
+      object.save
+      object.search
+      object.send(:delete)
+
+      expect(object.instance_variable_get(:@save_called)).to   eq(true)
+      expect(object.instance_variable_get(:@search_called)).to eq(true)
+      expect(object.instance_variable_get(:@delete_called)).to eq(true)
+      expect(instrumentation).to have_received(:span).with(
+        "TestClass#save",
+        attributes: {
+          "brut.class" => "TestClass",
+          "brut.method" => "save",
+        }
+      )
+      expect(instrumentation).to have_received(:span).with(
+        "TestClass#search",
+        attributes: {
+          "brut.class" => "TestClass",
+          "brut.method" => "search",
+        }
+      )
+      expect(instrumentation).not_to have_received(:span).with(
+        "TestClass#delete",
+        attributes: kind_of(Hash)
+      )
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: brut
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.12.0
 platform: ruby
 authors:
 - David Bryant Copeland
@@ -669,6 +669,11 @@ files:
 - brutrb.com/images/overview.png
 - brutrb.com/images/spa.dot
 - brutrb.com/images/spa.png
+- brutrb.com/images/tutorial/02-confirmation-dialog-browser-element-styled.png
+- brutrb.com/images/tutorial/02-confirmation-dialog-browser-element.png
+- brutrb.com/images/tutorial/02-confirmation-dialog-browser.png
+- brutrb.com/images/tutorial/02-confirmation-flow.graffle
+- brutrb.com/images/tutorial/02-confirmation-flow.png
 - brutrb.com/images/tutorial/basic-form-with-violations.png
 - brutrb.com/images/tutorial/basic-form.png
 - brutrb.com/images/tutorial/initial-home-page.png
@@ -710,6 +715,8 @@ files:
 - brutrb.com/seed-data.md
 - brutrb.com/space-time-continuum.md
 - brutrb.com/tutorial.md
+- brutrb.com/tutorials/01-intro.md
+- brutrb.com/tutorials/02-dialog.md
 - brutrb.com/unit-tests.md
 - brutrb.com/why.md
 - docker-compose.dx.yml
@@ -802,6 +809,7 @@ files:
 - docs/api/Brut/FrontEnd/Components/I18nTranslations.html
 - docs/api/Brut/FrontEnd/Components/Input.html
 - docs/api/Brut/FrontEnd/Components/Inputs.html
+- docs/api/Brut/FrontEnd/Components/Inputs/ButtonTag.html
 - docs/api/Brut/FrontEnd/Components/Inputs/CsrfToken.html
 - docs/api/Brut/FrontEnd/Components/Inputs/InputTag.html
 - docs/api/Brut/FrontEnd/Components/Inputs/RadioButton.html
@@ -816,6 +824,8 @@ files:
 - docs/api/Brut/FrontEnd/Flash.html
 - docs/api/Brut/FrontEnd/Form.html
 - docs/api/Brut/FrontEnd/Forms.html
+- docs/api/Brut/FrontEnd/Forms/Button.html
+- docs/api/Brut/FrontEnd/Forms/ButtonInputDefinition.html
 - docs/api/Brut/FrontEnd/Forms/ConstraintViolation.html
 - docs/api/Brut/FrontEnd/Forms/Input.html
 - docs/api/Brut/FrontEnd/Forms/Input/Color.html
@@ -878,6 +888,8 @@ files:
 - docs/api/Brut/I18n/HTTPAcceptLanguage/AlwaysEnglish.html
 - docs/api/Brut/Instrumentation.html
 - docs/api/Brut/Instrumentation/LoggerSpanExporter.html
+- docs/api/Brut/Instrumentation/Methods.html
+- docs/api/Brut/Instrumentation/Methods/ClassMethods.html
 - docs/api/Brut/Instrumentation/OpenTelemetry.html
 - docs/api/Brut/Instrumentation/OpenTelemetry/NormalizedAttributes.html
 - docs/api/Brut/Instrumentation/OpenTelemetry/Span.html
@@ -941,6 +953,10 @@ files:
 - docs/api/method_list.html
 - docs/api/top-level-namespace.html
 - docs/assets.html
+- docs/assets/02-confirmation-dialog-browser-element-styled.3NEGM20-.png
+- docs/assets/02-confirmation-dialog-browser-element.DPsf0xUW.png
+- docs/assets/02-confirmation-dialog-browser.DH8ALFO4.png
+- docs/assets/02-confirmation-flow.D9gZ0S5U.png
 - docs/assets/DevEnvironment.DaFcVfwP.png
 - docs/assets/LogoStop.Gb3tDhL1.png
 - docs/assets/OverviewMetro.DUS-5fUZ.png
@@ -948,7 +964,7 @@ files:
 - docs/assets/adrs.md.BxjHi9-8.lean.js
 - docs/assets/ai.md.Cy9GWnER.js
 - docs/assets/ai.md.Cy9GWnER.lean.js
-- docs/assets/app.vjGWMSnJ.js
+- docs/assets/app.V2GOcOrg.js
 - docs/assets/assets.md.7C3HWkga.js
 - docs/assets/assets.md.7C3HWkga.lean.js
 - docs/assets/basic-form-with-violations.Cv6Y9-Q_.png
@@ -957,16 +973,16 @@ files:
 - 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.Dn1xGMv_.js
-- docs/assets/chunks/VPLocalSearchBox.C-ymMW2k.js
+- docs/assets/chunks/@localSearchIndexroot.3Lsq4QTb.js
+- docs/assets/chunks/VPLocalSearchBox.CZTadcAy.js
 - docs/assets/chunks/framework.1L-BeKqY.js
-- docs/assets/chunks/theme.pJUosGlI.js
+- docs/assets/chunks/theme.FeuYNxyp.js
 - docs/assets/cli.md.CjsktgFz.js
 - docs/assets/cli.md.CjsktgFz.lean.js
-- docs/assets/components.md.B543a3Lm.js
-- docs/assets/components.md.B543a3Lm.lean.js
-- docs/assets/configuration.md.-foE_iVv.js
-- docs/assets/configuration.md.-foE_iVv.lean.js
+- docs/assets/components.md.f4cdTyvV.js
+- docs/assets/components.md.f4cdTyvV.lean.js
+- docs/assets/configuration.md.Bs4-rxnS.js
+- docs/assets/configuration.md.Bs4-rxnS.lean.js
 - docs/assets/css.md.CltvJqAa.js
 - docs/assets/css.md.CltvJqAa.lean.js
 - docs/assets/custom-element-tests.md.B_rbta32.js
@@ -990,12 +1006,12 @@ files:
 - docs/assets/features.md.DPFXsy0z.lean.js
 - docs/assets/flash-and-session.md.nPvUpnUx.js
 - docs/assets/flash-and-session.md.nPvUpnUx.lean.js
-- docs/assets/form-constraints.md.DK5adCgM.js
-- docs/assets/form-constraints.md.DK5adCgM.lean.js
-- docs/assets/forms.md.D5-2rgHh.js
-- docs/assets/forms.md.D5-2rgHh.lean.js
-- docs/assets/getting-started.md.Cd4XSZb_.js
-- docs/assets/getting-started.md.Cd4XSZb_.lean.js
+- docs/assets/form-constraints.md.KTv5cdR4.js
+- docs/assets/form-constraints.md.KTv5cdR4.lean.js
+- docs/assets/forms.md.Sys-XxVf.js
+- docs/assets/forms.md.Sys-XxVf.lean.js
+- docs/assets/getting-started.md.CFIW0bcE.js
+- docs/assets/getting-started.md.CFIW0bcE.lean.js
 - docs/assets/handlers.md.h84MMB1R.js
 - docs/assets/handlers.md.h84MMB1R.lean.js
 - docs/assets/hooks.md.Jmb5VOLA.js
@@ -1005,8 +1021,8 @@ files:
 - docs/assets/index.md.Bn9e0sRJ.js
 - docs/assets/index.md.Bn9e0sRJ.lean.js
 - docs/assets/initial-home-page.DNIaYmgP.png
-- docs/assets/instrumentation.md.BgcaGVYH.js
-- docs/assets/instrumentation.md.BgcaGVYH.lean.js
+- docs/assets/instrumentation.md._lNSriEZ.js
+- docs/assets/instrumentation.md._lNSriEZ.lean.js
 - docs/assets/javascript.md.DzrMxUmI.js
 - docs/assets/javascript.md.DzrMxUmI.lean.js
 - docs/assets/jobs.md.S-2amAYp.js
@@ -1029,12 +1045,14 @@ files:
 - docs/assets/pages.md.B7Hc-i6H.lean.js
 - docs/assets/recipes_alternate-layouts.md.BwEytl59.js
 - docs/assets/recipes_alternate-layouts.md.BwEytl59.lean.js
-- docs/assets/recipes_authentication.md.Dzvi_g69.js
-- docs/assets/recipes_authentication.md.Dzvi_g69.lean.js
+- docs/assets/recipes_authentication.md.BAISoxmN.js
+- docs/assets/recipes_authentication.md.BAISoxmN.lean.js
 - docs/assets/recipes_blank-layouts.md.fyAUJyJR.js
 - docs/assets/recipes_blank-layouts.md.fyAUJyJR.lean.js
 - docs/assets/recipes_custom-flash.md.CrQbI5eH.js
 - docs/assets/recipes_custom-flash.md.CrQbI5eH.lean.js
+- docs/assets/recipes_form-errors.md.Bv5RCKqH.js
+- docs/assets/recipes_form-errors.md.Bv5RCKqH.lean.js
 - docs/assets/recipes_indexed-forms.md.CstYyOSo.js
 - docs/assets/recipes_indexed-forms.md.CstYyOSo.lean.js
 - docs/assets/recipes_migrations.md.CTcnWDJF.js
@@ -1057,8 +1075,12 @@ files:
 - docs/assets/styled-form-with-violations.Bv_sa9tg.png
 - docs/assets/styled-home-page-with-posts.Dd4kG89D.png
 - docs/assets/styled-home-page.BzdI7dWz.png
-- docs/assets/tutorial.md.C4zR5XPG.js
-- docs/assets/tutorial.md.C4zR5XPG.lean.js
+- docs/assets/tutorial.md.BM40jnoq.js
+- docs/assets/tutorial.md.BM40jnoq.lean.js
+- docs/assets/tutorials_01-intro.md.B4sUBY3X.js
+- docs/assets/tutorials_01-intro.md.B4sUBY3X.lean.js
+- docs/assets/tutorials_02-dialog.md.QTFeHdiA.js
+- docs/assets/tutorials_02-dialog.md.QTFeHdiA.lean.js
 - docs/assets/unit-tests.md.DUGrnLj5.js
 - docs/assets/unit-tests.md.DUGrnLj5.lean.js
 - docs/assets/welcome-to-brut.VSWzl17-.png
@@ -1194,6 +1216,7 @@ files:
 - docs/recipes/authentication.html
 - docs/recipes/blank-layouts.html
 - docs/recipes/custom-flash.html
+- docs/recipes/form-errors.html
 - docs/recipes/indexed-forms.html
 - docs/recipes/migrations.html
 - docs/recipes/text-field-component.html
@@ -1203,6 +1226,8 @@ files:
 - docs/seed-data.html
 - docs/space-time-continuum.html
 - docs/tutorial.html
+- docs/tutorials/01-intro.html
+- docs/tutorials/02-dialog.html
 - docs/unit-tests.html
 - docs/vp-icons.css
 - docs/why.html
@@ -1265,6 +1290,7 @@ files:
 - lib/brut/front_end/components/form_tag.rb
 - lib/brut/front_end/components/i18n_translations.rb
 - lib/brut/front_end/components/input.rb
+- lib/brut/front_end/components/inputs/button_tag.rb
 - lib/brut/front_end/components/inputs/csrf_token.rb
 - lib/brut/front_end/components/inputs/input_tag.rb
 - lib/brut/front_end/components/inputs/radio_button.rb
@@ -1278,6 +1304,8 @@ files:
 - lib/brut/front_end/download.rb
 - lib/brut/front_end/flash.rb
 - lib/brut/front_end/form.rb
+- lib/brut/front_end/forms/button.rb
+- lib/brut/front_end/forms/button_input_definition.rb
 - lib/brut/front_end/forms/constraint_violation.rb
 - lib/brut/front_end/forms/input.rb
 - lib/brut/front_end/forms/input_declarations.rb
@@ -1324,6 +1352,7 @@ files:
 - lib/brut/i18n/http_accept_language.rb
 - lib/brut/instrumentation.rb
 - lib/brut/instrumentation/logger_span_exporter.rb
+- lib/brut/instrumentation/methods.rb
 - lib/brut/instrumentation/open_telemetry.rb
 - lib/brut/junk_drawer.rb
 - lib/brut/rubocop_config.rb
@@ -1518,6 +1547,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/instrumentation/methods.spec.rb
 - specs/brut/junk_drawer.spec.rb
 - specs/spec_helper.rb
 - specs/support.rb