brut 0.16.0 → 0.17.0

data/specs/brut/tui/events/event_bus.spec.rb

@@ -0,0 +1,141 @@
+require "spec_helper"
+require "brut/tui"
+require_relative "test_event"
+
+RSpec.describe Brut::TUI::Events::EventBus do
+  class OtherTestEvent < Brut::TUI::Events::BaseEvent
+    def self.handler_method_name
+      :on_other_test_event
+    end
+  end
+
+  class SubscriberToTestEvent
+    def notified = @notified
+    def notified_method = @notified_method
+    def on_test_event(event)
+      @notified = event
+      @notified_method = :on_test_event
+    end
+  end
+  class SubscriberToAnyEventOnly
+    def notified = @notified
+    def notified_method = @notified_method
+    def on_any_event(event)
+      @notified = event
+      @notified_method = :on_any_event
+    end
+  end
+  class SubscriberToTestEventAndAnyEvent
+    def notified = @notified
+    def notified_method = @notified_method
+    def on_test_event(event)
+      @notified = event
+      @notified_method = :on_test_event
+    end
+    def on_any_event(event)
+      @notified = event
+      @notified_method = :on_any_event
+    end
+  end
+
+  class RaisesErrorInTestEvent
+    def on_test_event(event)
+      raise "Error in on_test_event"
+    end
+  end
+
+  class RaisesErrorInAnyEvent
+    def on_any_event(event)
+      raise "Error in on_any_event"
+    end
+  end
+
+  subject(:event_bus) { described_class.new }
+
+  describe "#subscribe" do
+    context "subscriber implements the handler method" do
+      it "is notified" do
+        subscriber = SubscriberToTestEvent.new
+        event_bus.subscribe(SpecSupport::TestEvent, subscriber)
+        event = SpecSupport::TestEvent.new
+
+        errors = event_bus.notify(event)
+
+        expect(errors).to                     eq([])
+        expect(subscriber.notified).to        eq(event)
+        expect(subscriber.notified_method).to eq(:on_test_event)
+      end
+    end
+    context "subscriber does not implement the handler method" do
+      it "is raises when subscribing" do
+        subscriber = SubscriberToAnyEventOnly.new
+        expect {
+          event_bus.subscribe(SpecSupport::TestEvent, subscriber)
+        }.to raise_error(ArgumentError, /does not implement handler method/)
+      end
+    end
+  end
+  describe "#subscribe_to_all" do
+    context "subscriber implements the handler method" do
+      it "is notified via that method" do
+        subscriber = SubscriberToTestEventAndAnyEvent.new
+        event_bus.subscribe_to_all(subscriber)
+        event = SpecSupport::TestEvent.new
+
+        errors = event_bus.notify(event)
+
+        expect(errors).to                     eq([])
+        expect(subscriber.notified).to        eq(event)
+        expect(subscriber.notified_method).to eq(:on_test_event)
+      end
+    end
+    context "subscriber does not implement the handler method" do
+      context "subscriber implements on_any_event" do
+        it "calls on_any_event when notified" do
+          subscriber = SubscriberToAnyEventOnly.new
+          event_bus.subscribe_to_all(subscriber)
+          event = SpecSupport::TestEvent.new
+
+          errors = event_bus.notify(event)
+
+          expect(errors).to                     eq([])
+          expect(subscriber.notified).to        eq(event)
+          expect(subscriber.notified_method).to eq(:on_any_event)
+        end
+      end
+      context "subscriber does not implement on_any_event" do
+        it "nothing happens" do
+          subscriber = SubscriberToTestEvent.new
+          event_bus.subscribe_to_all(subscriber)
+          event = OtherTestEvent.new
+
+          errors = event_bus.notify(event)
+
+          expect(errors).to                     eq([])
+          expect(subscriber.notified).to        eq(nil)
+          expect(subscriber.notified_method).to eq(nil)
+        end
+      end
+    end
+  end
+  describe "#notify" do
+
+    # some of this method's behavior is covered by the tests above
+    
+    context "when subscribers raise errors" do
+      it "returns them as an array" do
+        event_bus.subscribe(SpecSupport::TestEvent, RaisesErrorInTestEvent.new)
+        event_bus.subscribe_to_all(RaisesErrorInAnyEvent.new)
+        event_bus.subscribe_to_all(SubscriberToAnyEventOnly.new)
+
+        event = SpecSupport::TestEvent.new
+
+        errors = event_bus.notify(event)
+
+        expect(errors.length).to         eq(2)
+        expect(errors.map(&:message)).to include("Error in on_test_event")
+        expect(errors.map(&:message)).to include("Error in on_any_event")
+      end
+    end
+  end
+end

data/specs/brut/tui/events/exception.spec.rb

@@ -0,0 +1,19 @@
+require "spec_helper"
+require "brut/tui"
+
+RSpec.describe Brut::TUI::Events::Exception do
+
+  describe ":#exit?" do
+    it "is true" do
+      event = described_class.new(StandardError.new("Test exception"))
+      expect(event.exit?).to eq(true)
+    end
+  end
+  describe ":#drain_then_exit?" do
+    it "is false" do
+      event = described_class.new(StandardError.new("Test exception"))
+      expect(event.drain_then_exit?).to eq(false)
+    end
+  end
+
+end

data/specs/brut/tui/events/test_event.rb

@@ -0,0 +1,5 @@
+module SpecSupport
+  class TestEvent < Brut::TUI::Events::BaseEvent
+    def self.handler_method_name = :on_test_event
+  end
+end

data/specs/spec_helper.rb

@@ -1,7 +1,11 @@
 require "brut"
+require "confidence_check/for_rspec"
+
 require_relative "support"
 
 RSpec.configure do |config|
+  config.include ConfidenceCheck::ForRSpec
+
   config.expect_with :rspec do |expectations|
     expectations.include_chain_clauses_in_custom_matcher_descriptions = true
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: brut
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - David Bryant Copeland
@@ -247,6 +247,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: unicode-display_width
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -275,6 +289,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: confidence-check
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -923,6 +951,44 @@ files:
 - docs/api/Brut/SpecSupport/RSpecSetup.html
 - docs/api/Brut/SpecSupport/RSpecSetup/OptionalSidekiqSupport.html
 - docs/api/Brut/SpecSupport/SessionSupport.html
+- docs/api/Brut/TUI.html
+- docs/api/Brut/TUI/AnsiEscapeCode.html
+- docs/api/Brut/TUI/AnsiEscapeCode/Mod.html
+- docs/api/Brut/TUI/EventLoop.html
+- docs/api/Brut/TUI/EventLoop/Deque.html
+- docs/api/Brut/TUI/Events.html
+- docs/api/Brut/TUI/Events/BaseEvent.html
+- docs/api/Brut/TUI/Events/EventBus.html
+- docs/api/Brut/TUI/Events/EventLoopStarted.html
+- docs/api/Brut/TUI/Events/Exception.html
+- docs/api/Brut/TUI/Events/Tick.html
+- docs/api/Brut/TUI/MarkupString.html
+- docs/api/Brut/TUI/Script.html
+- docs/api/Brut/TUI/Script/BlockStep.html
+- docs/api/Brut/TUI/Script/Events.html
+- docs/api/Brut/TUI/Script/Events/CommandExecutionFailed.html
+- docs/api/Brut/TUI/Script/Events/CommandExecutionSucceeded.html
+- docs/api/Brut/TUI/Script/Events/CommandStdErr.html
+- docs/api/Brut/TUI/Script/Events/CommandStdOut.html
+- docs/api/Brut/TUI/Script/Events/ExecutingCommand.html
+- docs/api/Brut/TUI/Script/Events/Message.html
+- docs/api/Brut/TUI/Script/Events/PhaseCompleted.html
+- docs/api/Brut/TUI/Script/Events/PhaseStarted.html
+- docs/api/Brut/TUI/Script/Events/ScriptCompleted.html
+- docs/api/Brut/TUI/Script/Events/ScriptStarted.html
+- docs/api/Brut/TUI/Script/Events/StepCompleted.html
+- docs/api/Brut/TUI/Script/Events/StepStarted.html
+- docs/api/Brut/TUI/Script/ExecStep.html
+- docs/api/Brut/TUI/Script/ExecStep/ProcessStatusFailed.html
+- docs/api/Brut/TUI/Script/LoggingSubscriber.html
+- docs/api/Brut/TUI/Script/PutsSubscriber.html
+- docs/api/Brut/TUI/Script/Step.html
+- docs/api/Brut/TUI/Terminal.html
+- docs/api/Brut/TUI/TerminalTheme.html
+- docs/api/Brut/TUI/Themes.html
+- docs/api/Brut/TUI/Themes/Dark.html
+- docs/api/Brut/TUI/Themes/Light.html
+- docs/api/Brut/TUI/Themes/None.html
 - docs/api/Clock.html
 - docs/api/ModuleName.html
 - docs/api/RichString.html
@@ -939,6 +1005,7 @@ files:
 - docs/api/Sequel/Plugins/ExternalId/InstanceMethods.html
 - docs/api/Sequel/Plugins/FindBang.html
 - docs/api/Sequel/Plugins/FindBang/ClassMethods.html
+- docs/api/SpecSupport/Matchers/BeABug.html
 - docs/api/_index.html
 - docs/api/class_list.html
 - docs/api/css/common.css
@@ -965,7 +1032,7 @@ files:
 - docs/assets/adrs.md.YglbWtQe.lean.js
 - docs/assets/ai.md.ChLnvDAX.js
 - docs/assets/ai.md.ChLnvDAX.lean.js
-- docs/assets/app.CovevI7X.js
+- docs/assets/app.B8jAEB7R.js
 - docs/assets/assets.md.BEF6Oz6K.js
 - docs/assets/assets.md.BEF6Oz6K.lean.js
 - docs/assets/basic-form-with-violations.Cv6Y9-Q_.png
@@ -974,16 +1041,16 @@ files:
 - docs/assets/brut-js.md.BMz0X1Rz.lean.js
 - docs/assets/business-logic.md.DbuaOYGU.js
 - docs/assets/business-logic.md.DbuaOYGU.lean.js
-- docs/assets/chunks/@localSearchIndexroot.BiNc3tFI.js
-- docs/assets/chunks/VPLocalSearchBox.CrvLAvKW.js
+- docs/assets/chunks/@localSearchIndexroot.DJ8mocCj.js
+- docs/assets/chunks/VPLocalSearchBox.gF-Po_fz.js
 - docs/assets/chunks/framework.C4nOkCZI.js
-- docs/assets/chunks/theme.BAi5_yQI.js
+- docs/assets/chunks/theme.BjPAOJkz.js
 - docs/assets/cli.md.DDMar_51.js
 - docs/assets/cli.md.DDMar_51.lean.js
-- docs/assets/components.md.9sqJ27Oc.js
-- docs/assets/components.md.9sqJ27Oc.lean.js
-- docs/assets/configuration.md.Cb_oAR8Z.js
-- docs/assets/configuration.md.Cb_oAR8Z.lean.js
+- docs/assets/components.md.Ber8UBM0.js
+- docs/assets/components.md.Ber8UBM0.lean.js
+- docs/assets/configuration.md.DrJ6YVoZ.js
+- docs/assets/configuration.md.DrJ6YVoZ.lean.js
 - docs/assets/css.md.K5rOCOQY.js
 - docs/assets/css.md.K5rOCOQY.lean.js
 - docs/assets/custom-element-tests.md.DiLe-eFw.js
@@ -1009,10 +1076,10 @@ files:
 - docs/assets/flash-and-session.md.CUsMxoNl.lean.js
 - docs/assets/form-constraints.md.KlfXSKm2.js
 - docs/assets/form-constraints.md.KlfXSKm2.lean.js
-- docs/assets/forms.md.BdpYpNIk.js
-- docs/assets/forms.md.BdpYpNIk.lean.js
-- docs/assets/getting-started.md.CKpNGvno.js
-- docs/assets/getting-started.md.CKpNGvno.lean.js
+- docs/assets/forms.md.RK0zkhm0.js
+- docs/assets/forms.md.RK0zkhm0.lean.js
+- docs/assets/getting-started.md.CGJ44juQ.js
+- docs/assets/getting-started.md.CGJ44juQ.lean.js
 - docs/assets/handlers.md.C5tUwmmo.js
 - docs/assets/handlers.md.C5tUwmmo.lean.js
 - docs/assets/hooks.md.CoiYCKRc.js
@@ -1080,14 +1147,15 @@ files:
 - docs/assets/tutorial.md.BX6f6l00.lean.js
 - docs/assets/tutorials_01-intro.md.CzZ3kpF_.js
 - docs/assets/tutorials_01-intro.md.CzZ3kpF_.lean.js
-- docs/assets/tutorials_02-dialog.md.Z_DOF2mU.js
-- docs/assets/tutorials_02-dialog.md.Z_DOF2mU.lean.js
+- docs/assets/tutorials_02-dialog.md.DE5WfCXI.js
+- docs/assets/tutorials_02-dialog.md.DE5WfCXI.lean.js
 - docs/assets/unit-tests.md.vDsdBbO_.js
 - docs/assets/unit-tests.md.vDsdBbO_.lean.js
 - docs/assets/welcome-to-brut.VSWzl17-.png
 - docs/assets/why.md.4WpxdrQ2.js
 - docs/assets/why.md.4WpxdrQ2.lean.js
 - docs/assets/workspace-protocol.C0gXsoDb.png
+- docs/brut-css/brut.css
 - docs/brut-css/brut.max.css
 - docs/brut-css/classes/appearances.html
 - docs/brut-css/classes/background-colors.html
@@ -1383,6 +1451,41 @@ files:
 - lib/brut/spec_support/matchers/have_returned_rack_response.rb
 - lib/brut/spec_support/rspec_setup.rb
 - lib/brut/spec_support/session_support.rb
+- lib/brut/tui.rb
+- lib/brut/tui/ansi_escape_code.rb
+- lib/brut/tui/event_loop.rb
+- lib/brut/tui/events.rb
+- lib/brut/tui/events/base_event.rb
+- lib/brut/tui/events/event_bus.rb
+- lib/brut/tui/events/event_loop_started.rb
+- lib/brut/tui/events/exception.rb
+- lib/brut/tui/events/tick.rb
+- lib/brut/tui/markup_string.rb
+- lib/brut/tui/script.rb
+- lib/brut/tui/script/block_step.rb
+- lib/brut/tui/script/events.rb
+- lib/brut/tui/script/events/command_execution_failed.rb
+- lib/brut/tui/script/events/command_execution_succeeded.rb
+- lib/brut/tui/script/events/command_std_err.rb
+- lib/brut/tui/script/events/command_std_out.rb
+- lib/brut/tui/script/events/executing_command.rb
+- lib/brut/tui/script/events/message.rb
+- lib/brut/tui/script/events/phase_completed.rb
+- lib/brut/tui/script/events/phase_started.rb
+- lib/brut/tui/script/events/script_completed.rb
+- lib/brut/tui/script/events/script_started.rb
+- lib/brut/tui/script/events/step_completed.rb
+- lib/brut/tui/script/events/step_started.rb
+- lib/brut/tui/script/exec_step.rb
+- lib/brut/tui/script/logging_subscriber.rb
+- lib/brut/tui/script/puts_subscriber.rb
+- lib/brut/tui/script/step.rb
+- lib/brut/tui/terminal.rb
+- lib/brut/tui/terminal_theme.rb
+- lib/brut/tui/themes.rb
+- lib/brut/tui/themes/dark.rb
+- lib/brut/tui/themes/light.rb
+- lib/brut/tui/themes/none.rb
 - lib/brut/version.rb
 - lib/sequel/extensions/brut_instrumentation.rb
 - lib/sequel/extensions/brut_migrations.rb
@@ -1565,6 +1668,12 @@ files:
 - specs/brut/front_end/forms/select_input.spec.rb
 - specs/brut/instrumentation/methods.spec.rb
 - specs/brut/junk_drawer.spec.rb
+- specs/brut/tui/ansi_escape_code.spec.rb
+- specs/brut/tui/event_loop.spec.rb
+- specs/brut/tui/events/base_event.spec.rb
+- specs/brut/tui/events/event_bus.spec.rb
+- specs/brut/tui/events/exception.spec.rb
+- specs/brut/tui/events/test_event.rb
 - specs/spec_helper.rb
 - specs/support.rb
 - specs/support/matchers.rb