test_bench-output 2.1.1.3 → 3.0.0.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c05d72c3b0b2b4aedeab99af778ac2109da308eadf3006a11537132a13e2f3b
-  data.tar.gz: 6dd801c1d9d25ae6004bc86a6e1ffb09767d75573622754ab6a45b09d593389e
+  metadata.gz: 3e0f38c7295b1224d2d8e379baedbc63eca93df6072eb3c3aa57262fc199428a
+  data.tar.gz: f3b40e1d2d46219fbf937284bc24a48cc9f1572c65baf888db1f7ecbdeae9b77
 SHA512:
-  metadata.gz: abf3ad29e5cd19c4a0a4083d456fabeb0f322a14e82940ad8f8bb47bb247ed2aa0eed912374bd69324f64562906a164fa2c9419f29b3bb6f397a5124ac13c7f7
-  data.tar.gz: dc1e161175bb55ca0f82a666aa4556c4b5a3f0a6fa388db7e59dbd7afb79a2d87199ef1c4f6598f53485fa0edeb6753e8b0b5fe4116e431fa1765921604718b9
+  metadata.gz: 554435db7dfcfcd909037034b7781f9caecd142ccd655354be24ceb3d96b775303d0c149841a3b77f297bd0c56ffc39c554cb0012964174627a1cd3f113d97e2
+  data.tar.gz: 61e48708d47b1f7f32b27ecf3f1818ef3811e4b427f2766e1707b11618d751cf930a281639350f5143f0f460cc6fbbe18c99756cfd0469e0d47a64f872f3f4b8

data/lib/test_bench/output/comment_style.rb

@@ -0,0 +1,61 @@
+module TestBench
+  class Output
+    module CommentStyle
+      Error = Class.new(RuntimeError)
+
+      def self.fetch(comment_disposition)
+        comment_style = get(comment_disposition)
+
+        comment_style ||= normal
+
+        comment_style
+      end
+
+      def self.get(comment_disposition)
+        comment_style, _ = comment_styles.rassoc(comment_disposition)
+        comment_style
+      end
+
+      def self.get_disposition(comment_style)
+        comment_styles.fetch(comment_style) do
+          raise Error, "Incorrect comment style: #{comment_style.inspect}"
+        end
+      end
+
+      def self.comment_styles
+        {
+          :detect => 'detect',
+          :normal => 'normal',
+          :heading => 'heading',
+          :block => 'block',
+          :line_number => 'line_number',
+          :raw => 'raw'
+        }
+      end
+
+      def self.detect
+        :detect
+      end
+
+      def self.normal
+        :normal
+      end
+
+      def self.heading
+        :heading
+      end
+
+      def self.block
+        :block
+      end
+
+      def self.line_number
+        :line_number
+      end
+
+      def self.raw
+        :raw
+      end
+    end
+  end
+end

data/lib/test_bench/output/controls/comment_style.rb

@@ -0,0 +1,21 @@
+module TestBench
+  class Output
+    module Controls
+      module CommentStyle
+        def self.example
+          :normal
+        end
+
+        def self.disposition
+          'normal'
+        end
+
+        module Disposition
+          def self.example
+            Session::CommentDisposition.example
+          end
+        end
+      end
+    end
+  end
+end

data/lib/test_bench/output/controls/event.rb

@@ -1,7 +1,7 @@
 module TestBench
-  module Output
+  class Output
     module Controls
-      Event = Telemetry::Controls::Event
+      Event = Session::Event
     end
   end
 end

data/lib/test_bench/output/controls/events/aborted.rb

@@ -0,0 +1,9 @@
+module TestBench
+  class Output
+    module Controls
+      module Events
+        Aborted = Session::Events::Aborted
+      end
+    end
+  end
+end

data/lib/test_bench/output/controls/events/commented.rb

@@ -0,0 +1,21 @@
+module TestBench
+  class Output
+    module Controls
+      module Events
+        module Commented
+          def self.example(text: nil, style: nil)
+            style ||= self.style
+
+            disposition = Output::CommentStyle.get_disposition(style)
+
+            Session::Events::Commented.example(text:, disposition:)
+          end
+
+          def self.style
+            CommentStyle.example
+          end
+        end
+      end
+    end
+  end
+end

data/lib/test_bench/output/controls/events/context_finished.rb

@@ -0,0 +1,9 @@
+module TestBench
+  class Output
+    module Controls
+      module Events
+        ContextFinished = Session::Events::ContextFinished
+      end
+    end
+  end
+end

data/lib/test_bench/output/controls/events/context_started.rb

@@ -0,0 +1,9 @@
+module TestBench
+  class Output
+    module Controls
+      module Events
+        ContextStarted = Session::Events::ContextStarted
+      end
+    end
+  end
+end

data/lib/test_bench/output/controls/events/detailed.rb

@@ -0,0 +1,21 @@
+module TestBench
+  class Output
+    module Controls
+      module Events
+        module Detailed
+          def self.example(text: nil, style: nil)
+            style ||= self.style
+
+            disposition = Output::CommentStyle.get_disposition(style)
+
+            Session::Events::Detailed.example(text:, disposition:)
+          end
+
+          def self.style
+            CommentStyle.example
+          end
+        end
+      end
+    end
+  end
+end

data/lib/test_bench/output/controls/events/failed.rb

@@ -0,0 +1,9 @@
+module TestBench
+  class Output
+    module Controls
+      module Events
+        Failed = Session::Events::Failed
+      end
+    end
+  end
+end

data/lib/test_bench/output/controls/events/file_executed.rb

@@ -0,0 +1,9 @@
+module TestBench
+  class Output
+    module Controls
+      module Events
+        FileExecuted = Session::Events::FileExecuted
+      end
+    end
+  end
+end

data/lib/test_bench/output/controls/events/file_not_found.rb

@@ -0,0 +1,9 @@
+module TestBench
+  class Output
+    module Controls
+      module Events
+        FileNotFound = Session::Events::FileNotFound
+      end
+    end
+  end
+end

data/lib/test_bench/output/controls/events/file_queued.rb

@@ -0,0 +1,9 @@
+module TestBench
+  class Output
+    module Controls
+      module Events
+        FileQueued = Session::Events::FileQueued
+      end
+    end
+  end
+end

data/lib/test_bench/output/controls/events/skipped.rb

@@ -0,0 +1,9 @@
+module TestBench
+  class Output
+    module Controls
+      module Events
+        Skipped = Session::Events::Skipped
+      end
+    end
+  end
+end

data/lib/test_bench/output/controls/events/test_finished.rb

@@ -0,0 +1,9 @@
+module TestBench
+  class Output
+    module Controls
+      module Events
+        TestFinished = Session::Events::TestFinished
+      end
+    end
+  end
+end

data/lib/test_bench/output/controls/events/test_started.rb

@@ -0,0 +1,9 @@
+module TestBench
+  class Output
+    module Controls
+      module Events
+        TestStarted = Session::Events::TestStarted
+      end
+    end
+  end
+end

data/lib/test_bench/output/controls/random.rb

@@ -1,7 +1,7 @@
 module TestBench
-  module Output
+  class Output
     module Controls
-      Random = Telemetry::Controls::Random
+      Random = Session::Random
     end
   end
 end

data/lib/test_bench/output/controls/session.rb

@@ -0,0 +1,17 @@
+module TestBench
+  class Output
+    module Controls
+      module Session
+        Events = TestBench::Session::Controls::Events
+
+        Event = TestBench::Session::Controls::Event
+
+        Status = TestBench::Session::Controls::Status
+
+        Random = TestBench::Session::Controls::Random
+
+        CommentDisposition = TestBench::Session::Controls::CommentDisposition
+      end
+    end
+  end
+end

data/lib/test_bench/output/controls/status.rb

@@ -0,0 +1,7 @@
+module TestBench
+  class Output
+    module Controls
+      Status = Session::Status
+    end
+  end
+end

data/lib/test_bench/output/controls/style.rb

@@ -1,28 +1,36 @@
 module TestBench
-  module Output
+  class Output
     module Controls
       module Style
         def self.example
           :bold
         end
 
+        def self.code
+          '1'
+        end
+
         def self.other_example
-          :italic
+          Other.example
         end
 
-        module Unknown
+        module Other
           def self.example
-            :unknown
+            :italic
+          end
+
+          def self.code
+            '3'
           end
         end
 
         module Code
           def self.example
-            '1'
+            Style.code
           end
 
           def self.other_example
-            '3'
+            Other.code
           end
         end
       end

data/lib/test_bench/output/controls/text.rb

@@ -1,15 +1,27 @@
 module TestBench
-  module Output
+  class Output
     module Controls
       module Text
         def self.example
           "Some text"
         end
 
-        def self.random
-          suffix = Random.string
+        def self.other_example
+          "Some other text"
+        end
+
+        module NewlineTerminated
+          def self.example(lines: nil)
+            lines ||= 1
+
+            line_count = lines
+
+            lines = (1..line_count).map do |line_number|
+              "Line #{line_number}\n"
+            end
 
-          "#{example} #{suffix}"
+            lines.join
+          end
         end
       end
     end

data/lib/test_bench/output/controls.rb

@@ -1,10 +1,26 @@
-require 'test_bench/telemetry/controls'
+require 'test_bench/session/controls'
+
+require 'test_bench/output/controls/session'
 
 require 'test_bench/output/controls/random'
-require 'test_bench/output/controls/data'
-require 'test_bench/output/controls/device'
+require 'test_bench/output/controls/status'
 require 'test_bench/output/controls/text'
-require 'test_bench/output/controls/styling'
+
 require 'test_bench/output/controls/style'
-require 'test_bench/output/controls/output'
+
+require 'test_bench/output/controls/comment_style'
+
+require 'test_bench/output/controls/events/failed'
+require 'test_bench/output/controls/events/aborted'
+require 'test_bench/output/controls/events/skipped'
+require 'test_bench/output/controls/events/commented'
+require 'test_bench/output/controls/events/detailed'
+require 'test_bench/output/controls/events/test_started'
+require 'test_bench/output/controls/events/test_finished'
+require 'test_bench/output/controls/events/context_started'
+require 'test_bench/output/controls/events/context_finished'
+require 'test_bench/output/controls/events/file_queued'
+require 'test_bench/output/controls/events/file_executed'
+require 'test_bench/output/controls/events/file_not_found'
+
 require 'test_bench/output/controls/event'

data/lib/test_bench/output/detail_policy.rb

@@ -0,0 +1,44 @@
+module TestBench
+  class Output
+    module DetailPolicy
+      Error = Class.new(RuntimeError)
+
+      def self.failure
+        :failure
+      end
+
+      def self.on
+        :on
+      end
+
+      def self.off
+        :off
+      end
+
+      def self.detail?(detail_policy, result=nil)
+        result ||= Session::Result.none
+
+        case detail_policy
+        when failure
+          [
+            Session::Result.failed,
+            Session::Result.aborted
+          ].include?(result)
+
+        when on
+          true
+
+        when off
+          false
+
+        else
+          raise Error, "Incorrect detail policy: #{detail_policy.inspect}"
+        end
+      end
+
+      def self.assure_policy(detail_policy)
+        detail?(detail_policy)
+      end
+    end
+  end
+end

data/lib/test_bench/output/device/null.rb

@@ -1,8 +1,8 @@
 module TestBench
-  module Output
-    module Device
+  class Output
+    class Device
       class Null
-        def self.build
+        def self.instance
           @instance ||= new
         end
 

data/lib/test_bench/output/device/substitute.rb

@@ -1,56 +1,42 @@
 module TestBench
-  module Output
-    module Device
+  class Output
+    class Device
       module Substitute
         def self.build
           Device.new
         end
 
         class Device
-          def written_data
-            @written_data ||= String.new
+          def written_text
+            @written_text ||= String.new
           end
-          attr_writer :written_data
-
-          def flushed_data
-            @flushed_data ||= String.new
-          end
-          attr_writer :flushed_data
+          attr_writer :written_text
 
           attr_accessor :tty
-          def tty? = !!tty
-
-          def write(data)
-            bytes_written = data.bytesize
-
-            written_data << data
 
-            bytes_written
+          def tty?
+            tty ? true : false
           end
 
-          def flush
-            flushed_data << written_data
+          def set_tty
+            self.tty = true
           end
 
-          def written?(data=nil)
-            if data.nil?
-              !written_data.empty?
-            else
-              written_data == data
-            end
+          def write(text)
+            bytes_written = text.bytesize
+
+            written_text << text
+
+            bytes_written
           end
 
-          def flushed?(data=nil)
-            if data.nil?
-              !flushed_data.empty?
+          def written?(text=nil)
+            if text.nil?
+              !written_text.empty?
             else
-              flushed_data == data
+              written_text == text
             end
           end
-
-          def tty!
-            self.tty = true
-          end
         end
       end
     end

data/lib/test_bench/output/device.rb

@@ -0,0 +1,73 @@
+module TestBench
+  class Output
+    class Device
+      Error = Class.new(RuntimeError)
+
+      def raw_device
+        @raw_device ||= Substitute.build
+      end
+      attr_writer :raw_device
+
+      def self.build(target_device=nil)
+        target_device ||= Defaults.target_device
+
+        raw_device = raw_device(target_device)
+
+        instance = new
+        instance.raw_device = raw_device
+        instance
+      end
+
+      def self.configure(receiver, device: nil, attr_name: nil)
+        attr_name ||= :device
+
+        if device.instance_of?(self)
+          instance = device
+        else
+          target_device = device
+
+          instance = build(target_device)
+        end
+
+        receiver.public_send(:"#{attr_name}=", instance)
+      end
+
+      def self.raw_device(target_device)
+        case target_device
+        in :stdout
+          STDOUT
+        in :stderr
+          STDERR
+        in :null
+          Null.instance
+        in Symbol
+          raise Error, "Incorrect output device: #{target_device.inspect}"
+        else
+          target_device
+        end
+      end
+
+      def write(text)
+        raw_device.write(text)
+
+        text.bytesize
+      end
+
+      def tty?
+        raw_device.tty?
+      end
+
+      module Defaults
+        def self.target_device
+          env_target_device = ENV.fetch('TEST_BENCH_OUTPUT_DEVICE') do
+            STDOUT.sync = true
+
+            'stdout'
+          end
+
+          env_target_device.to_sym
+        end
+      end
+    end
+  end
+end

data/lib/test_bench/output/get.rb

@@ -0,0 +1,30 @@
+module TestBench
+  class Output
+    module Get
+      Error = Class.new(RuntimeError)
+
+      def self.call(substitute_session, styling: nil)
+        styling ||= false
+
+        if not substitute_session.instance_of?(Session::Substitute::Session)
+          raise Error, "Not a substitute session: #{substitute_session.inspect}"
+        end
+
+        output = Output.new
+
+        if styling
+          output.writer.set_styling
+        end
+
+        event_records = substitute_session.sink.records
+        event_records.each do |record|
+          event_data = record.event_data
+
+          output.receive(event_data)
+        end
+
+        output.writer.written_text
+      end
+    end
+  end
+end