test_bench 1.0.0.0 → 1.2.0.0

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

@@ -0,0 +1,94 @@
+module TestBench
+  module Output
+    class Summary
+      module Session
+        def self.call(file_count: nil, test_count: nil, pass_count: nil, skip_count: nil, failure_count: nil, error_count: nil, elapsed_time: nil, writer: nil)
+          file_count ||= 0
+          test_count ||= 0
+          pass_count ||= 0
+          skip_count ||= 0
+          failure_count ||= 0
+          error_count ||= 0
+          elapsed_time ||= 0
+          writer ||= Writer.build
+
+          failed = error_count > 0
+
+          if elapsed_time.nonzero?
+            tests_per_second = test_count / elapsed_time
+          end
+
+          if failed
+            writer.escape_code(:red)
+          end
+
+          writer
+            .text("Finished running #{numeric_label(file_count, 'file')}")
+            .newline
+            .text("Ran %s in %.3fs (%.1f tests/second)" % [
+              numeric_label(test_count, 'test'),
+              elapsed_time,
+              tests_per_second || 0])
+            .newline
+
+          if pass_count.nonzero? && !failed
+            writer
+              .escape_code(:green)
+              .text("#{pass_count} passed")
+              .escape_code(:reset_fg)
+          else
+            writer.text("#{pass_count} passed")
+          end
+
+          writer.text(", ")
+
+          if skip_count.nonzero? && !failed
+            writer
+              .escape_code(:yellow)
+              .text("#{skip_count} skipped")
+              .escape_code(:reset_fg)
+          else
+            writer.text("#{skip_count} skipped")
+          end
+
+          writer.text(", ")
+
+          if failure_count.nonzero?
+            writer
+              .escape_code(:bold)
+              .text("#{failure_count} failed")
+              .escape_code(:reset_intensity)
+          else
+            writer.text("0 failed")
+          end
+
+          writer.text(", ")
+
+          if failed
+            writer
+              .escape_code(:bold)
+              .text(numeric_label(error_count, 'total error'))
+              .escape_code(:reset_intensity)
+              .escape_code(:reset_fg)
+          else
+            writer.text("0 total errors")
+          end
+
+          2.times do
+            writer.newline
+          end
+        end
+
+        def self.numeric_label(number, label, plural_text=nil)
+          plural_text ||= 's'
+
+          if number == 1
+            "#{number} #{label}"
+          else
+            "#{number} #{label}#{plural_text}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/test_bench/output/writer.rb

@@ -130,7 +130,7 @@ module TestBench
       end
 
       def self.styling?(device, styling_setting=nil)
-        styling_setting ||= Defaults.styling_setting
+        styling_setting ||= Defaults.styling
 
         assure_styling_setting(styling_setting)
 
@@ -177,7 +177,7 @@ module TestBench
           $stdout
         end
 
-        def self.styling_setting
+        def self.styling
           styling = ::ENV['TEST_BENCH_OUTPUT_STYLING']
 
           if styling.nil?

data/lib/test_bench/run.rb

@@ -3,14 +3,14 @@ module TestBench
     Error = Class.new(RuntimeError)
 
     def session
-      @session ||= Session::Substitute.build
+      @session ||= Fixture::Session::Substitute.build
     end
     attr_writer :session
 
-    def exclude_file_pattern
-      @exclude_file_pattern ||= Defaults.exclude_file_pattern
+    def exclude_pattern
+      @exclude_pattern ||= Defaults.exclude_pattern
     end
-    attr_writer :exclude_file_pattern
+    attr_writer :exclude_pattern
 
     attr_reader :paths
 
@@ -18,14 +18,14 @@ module TestBench
       @paths = Array(paths)
     end
 
-    def self.build(*paths, exclude_file_pattern: nil, session: nil, output: nil)
+    def self.build(*paths, exclude: nil, session: nil, output: nil)
       session ||= TestBench.session
 
       instance = new(*paths)
 
-      instance.exclude_file_pattern = exclude_file_pattern unless exclude_file_pattern.nil?
+      instance.exclude_pattern = exclude unless exclude.nil?
 
-      Session.configure(instance, session: session)
+      Fixture::Session.configure(instance, session: session)
       instance.session.output = output unless output.nil?
 
       instance
@@ -80,7 +80,7 @@ module TestBench
       glob_pattern = File.join(path, '**/*.rb')
 
       Dir[glob_pattern].sort.each do |path|
-        next if exclude_file_pattern.match?(path)
+        next if exclude_pattern.match?(path)
 
         file(path)
       end
@@ -91,7 +91,7 @@ module TestBench
     end
 
     module Defaults
-      def self.exclude_file_pattern
+      def self.exclude_pattern
         pattern = ENV.fetch('TEST_BENCH_EXCLUDE_FILE_PATTERN') do
           '_init.rb$'
         end

data/lib/test_bench/test_bench.rb

@@ -2,7 +2,9 @@ module TestBench
   def self.session
     @session ||= build_session.tap do |session|
       at_exit do
-        exit 1 if session.failed?
+        exit_code = exit_code(session)
+
+        exit(exit_code) unless exit_code.zero?
       end
     end
   end
@@ -37,6 +39,14 @@ module TestBench
     end
   end
 
+  def self.context(title=nil, session: nil, &block)
+    evaluate(session: session) do
+      context(title) do
+        instance_exec(&block)
+      end
+    end
+  end
+
   def self.fixture(session=nil, receiver: nil)
     session ||= self.session
     receiver ||= Object.new
@@ -57,7 +67,7 @@ module TestBench
   end
 
   def self.session_error_policy(abort_on_error=nil)
-    abort_on_error = Session::Defaults.abort_on_error if abort_on_error.nil?
+    abort_on_error = Defaults.abort_on_error if abort_on_error.nil?
 
     if abort_on_error
       :abort
@@ -66,11 +76,29 @@ module TestBench
     end
   end
 
+  def self.exit_code(session, fail_deactivated_tests: nil)
+    if fail_deactivated_tests.nil?
+      fail_deactivated_tests = Defaults.fail_deactivated_tests
+    end
+
+    if session.failed?
+      1
+    elsif session.skip?
+      fail_deactivated_tests ? 2 : 0
+    else
+      0
+    end
+  end
+
   Session = Fixture::Session
 
-  module Session::Defaults
+  module Defaults
     def self.abort_on_error
       Environment::Boolean.fetch('TEST_BENCH_ABORT_ON_ERROR', false)
     end
+
+    def self.fail_deactivated_tests
+      Environment::Boolean.fetch('TEST_BENCH_FAIL_DEACTIVATED_TESTS', true)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test_bench
 version: !ruby/object:Gem::Version
-  version: 1.0.0.0
+  version: 1.2.0.0
 platform: ruby
 authors:
 - Nathan Ladd
-autorequire: 
+autorequire:
 bindir: script
 cert_chain: []
-date: 2020-06-09 00:00:00.000000000 Z
+date: 2020-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test_bench-fixture
@@ -38,7 +38,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email: nathanladd+github@gmail.com
 executables:
 - bench
@@ -55,12 +55,16 @@ files:
 - lib/test_bench/controls/directory.rb
 - lib/test_bench/controls/error.rb
 - lib/test_bench/controls/fixture.rb
+- lib/test_bench/controls/output/batch_data.rb
+- lib/test_bench/controls/output/detail_setting.rb
 - lib/test_bench/controls/output/escape_code.rb
+- lib/test_bench/controls/output/exercise.rb
+- lib/test_bench/controls/output/log_level.rb
 - lib/test_bench/controls/output/newline_character.rb
 - lib/test_bench/controls/output/print_error.rb
 - lib/test_bench/controls/output/styling.rb
 - lib/test_bench/controls/output/summary/error.rb
-- lib/test_bench/controls/output/summary/run.rb
+- lib/test_bench/controls/output/summary/session.rb
 - lib/test_bench/controls/path.rb
 - lib/test_bench/controls/pattern.rb
 - lib/test_bench/controls/result.rb
@@ -71,16 +75,13 @@ files:
 - lib/test_bench/fixtures.rb
 - lib/test_bench/fixtures/configure_receiver.rb
 - lib/test_bench/output.rb
-- lib/test_bench/output/build.rb
-- lib/test_bench/output/levels/debug.rb
-- lib/test_bench/output/levels/failure.rb
-- lib/test_bench/output/levels/none.rb
-- lib/test_bench/output/levels/pass.rb
-- lib/test_bench/output/levels/summary.rb
+- lib/test_bench/output/batch_data.rb
+- lib/test_bench/output/buffer.rb
+- lib/test_bench/output/log.rb
 - lib/test_bench/output/print_error.rb
-- lib/test_bench/output/summary/error.rb
-- lib/test_bench/output/summary/run.rb
-- lib/test_bench/output/summary/run/print.rb
+- lib/test_bench/output/raw.rb
+- lib/test_bench/output/summary.rb
+- lib/test_bench/output/summary/session.rb
 - lib/test_bench/output/timer.rb
 - lib/test_bench/output/timer/substitute.rb
 - lib/test_bench/output/writer.rb
@@ -95,7 +96,7 @@ homepage: https://github.com/test-bench/test-bench
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -110,8 +111,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.3
+signing_key:
 specification_version: 4
 summary: Principled Test Framework for Ruby
 test_files: []

data/lib/test_bench/controls/output/summary/run.rb

@@ -1,59 +0,0 @@
-module TestBench
-  module Controls
-    module Output
-      module Summary
-        module Run
-          def self.example(writer: nil, timer: nil)
-            run_summary = Example.new
-            run_summary.writer = writer unless writer.nil?
-            run_summary.timer = timer unless timer.nil?
-            run_summary
-          end
-
-          class Example
-            include TestBench::Fixture::Output
-            include TestBench::Output::Summary::Run
-
-            TestBench::Fixture::Output.instance_methods.each do |method|
-              define_method(method) do |*|
-              end
-            end
-          end
-
-          module Text
-            def self.example
-              <<~TEXT
-              Finished running 0 files
-              Ran 0 tests in 0.000s (0.0 tests/second)
-              0 passed, 0 skipped, 0 failed, 0 total errors
-
-              TEXT
-            end
-
-            module Pass
-              def self.example
-                <<~TEXT
-                Finished running 1 file
-                Ran 1 test in 0.000s (0.0 tests/second)
-                1 passed, 0 skipped, 0 failed, 0 total errors
-
-                TEXT
-              end
-            end
-
-            module Failure
-              def self.example
-                <<~TEXT
-                Finished running 1 file
-                Ran 1 test in 0.000s (0.0 tests/second)
-                0 passed, 0 skipped, 1 failed, 1 total error
-
-                TEXT
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/test_bench/output/build.rb

@@ -1,57 +0,0 @@
-module TestBench
-  module Output
-    module Build
-      Error = Class.new(RuntimeError)
-
-      def self.call(level: nil, **args)
-        level ||= Defaults.level
-
-        level_setting = level
-
-        cls = level_class(level_setting)
-
-        cls.build(**args)
-      end
-
-      def self.level_class(level_setting)
-        assure_level(level_setting)
-
-        levels.fetch(level_setting)
-      end
-
-      def self.levels
-        {
-          :none => Levels::None,
-          :summary => Levels::Summary,
-          :failure => Levels::Failure,
-          :pass => Levels::Pass,
-          :debug => Levels::Debug
-        }
-      end
-
-      def self.level_settings
-        levels.keys
-      end
-
-      def self.assure_level(level_setting)
-        unless level_settings.include?(level_setting)
-          raise Error, "Unknown output level #{level_setting.inspect} (Valid levels: #{level_settings.map(&:inspect) * ', '})"
-        end
-      end
-
-      module Defaults
-        def self.level
-          verbose = Environment::Boolean.fetch('VERBOSE')
-
-          if verbose.nil?
-            level_text = ENV.fetch('TEST_BENCH_OUTPUT_LEVEL', 'pass')
-
-            level_text.to_sym
-          else
-            :debug
-          end
-        end
-      end
-    end
-  end
-end

data/lib/test_bench/output/levels/debug.rb

@@ -1,229 +0,0 @@
-module TestBench
-  module Output
-    module Levels
-      class Debug
-        include TestBench::Fixture::Output
-
-        include Writer::Dependency
-
-        include PrintError
-
-        include Output::Summary::Error
-        include Output::Summary::Run
-
-        def previous_byte_offset
-          @previous_byte_offset ||= 0
-        end
-        attr_writer :previous_byte_offset
-
-        def self.build(omit_backtrace_pattern: nil, reverse_backtraces: nil, writer: nil, styling: nil, device: nil)
-          instance = new
-
-          instance.omit_backtrace_pattern = omit_backtrace_pattern unless omit_backtrace_pattern.nil?
-          instance.reverse_backtraces = reverse_backtraces unless reverse_backtraces.nil?
-
-          Writer.configure(instance, writer: writer, styling: styling, device: device)
-          Timer.configure(instance)
-
-          instance
-        end
-
-        def comment(text)
-          writer
-            .indent
-            .text(text)
-            .newline
-        end
-
-        def error(error)
-          print_error(error)
-        end
-
-        def finish_test(title, result)
-          writer.decrease_indentation
-
-          fg_color = result ? :green : :red
-
-          writer.indent
-
-          writer
-            .escape_code(fg_color)
-            .text("Finished test")
-
-          unless title.nil?
-            writer
-              .text(' ')
-              .escape_code(:bold)
-              .text(title.inspect)
-              .escape_code(:reset_intensity)
-          end
-
-          writer
-            .text(" (Result: #{result ? 'pass' : 'failure'})")
-            .escape_code(:reset_fg)
-            .newline
-        end
-
-        def skip_test(title)
-          writer.indent
-
-          writer
-            .escape_code(:yellow)
-            .text("Skipped test")
-
-          unless title.nil?
-            writer
-              .text(' ')
-              .escape_code(:bold)
-              .text(title.inspect)
-              .escape_code(:reset_intensity)
-          end
-
-          writer
-            .escape_code(:reset_fg)
-            .newline
-        end
-
-        def start_test(title)
-          if title.nil?
-            text = "Starting test"
-          else
-            text = "Starting test #{title.inspect}"
-          end
-
-          writer
-            .indent
-            .escape_code(:cyan)
-            .text(text)
-            .escape_code(:reset_fg)
-            .newline
-
-          writer.increase_indentation
-        end
-
-        def enter_context(title)
-          return if title.nil?
-
-          writer
-            .indent
-            .escape_code(:green)
-            .text(title)
-            .escape_code(:reset_fg)
-            .newline
-
-          writer.increase_indentation
-        end
-
-        def exit_context(title, result)
-          return if title.nil?
-
-          writer.decrease_indentation
-
-          fg_color = result ? :green : :red
-
-          text = "Finished context #{title.inspect} (Result: #{result ? 'pass' : 'failure'})"
-
-          writer
-            .indent
-            .escape_code(:faint)
-            .escape_code(:italic)
-            .escape_code(fg_color)
-            .text(text)
-            .escape_code(:reset_fg)
-            .escape_code(:reset_italic)
-            .escape_code(:reset_intensity)
-            .newline
-
-          writer.newline if writer.indentation_depth.zero?
-        end
-
-        def skip_context(title)
-          return if title.nil?
-
-          writer
-            .indent
-            .escape_code(:yellow)
-            .text(title)
-            .escape_code(:reset_fg)
-            .newline
-
-          writer.newline if writer.indentation_depth.zero?
-        end
-
-        def start_fixture(fixture)
-          fixture_class = fixture.class.inspect
-
-          writer
-            .indent
-            .escape_code(:blue)
-            .text("Starting fixture (Fixture: #{fixture_class})")
-            .escape_code(:reset_fg)
-            .newline
-
-          writer.increase_indentation
-        end
-
-        def finish_fixture(fixture, result)
-          fixture_class = fixture.class.inspect
-
-          writer.decrease_indentation
-
-          writer
-            .indent
-            .escape_code(:magenta)
-            .text("Finished fixture (Fixture: #{fixture_class}, Result: #{result ? 'pass' : 'failure'})")
-            .escape_code(:reset_fg)
-            .newline
-
-          writer.newline if writer.indentation_depth.zero?
-        end
-
-        def enter_file(file)
-          text = "Running #{file}"
-
-          writer.text(text).newline
-
-          self.previous_byte_offset = writer.byte_offset
-        end
-
-        def exit_file(file, _)
-          unless writer.byte_offset > previous_byte_offset
-            writer
-              .escape_code(:faint)
-              .text("(Nothing written)")
-              .escape_code(:reset_intensity)
-              .newline
-
-            writer.newline
-          end
-        end
-
-        def enter_assert_block(caller_location)
-          text = "Entered assert block (Caller Location: #{caller_location})"
-
-          writer
-            .indent
-            .escape_code(:blue)
-            .text(text)
-            .escape_code(:reset_fg)
-            .newline
-
-          writer.increase_indentation
-        end
-
-        def exit_assert_block(caller_location, result)
-          writer.decrease_indentation
-
-          text = "Exited assert block (Caller Location: #{caller_location}, Result: #{result ? 'pass' : 'failure'})"
-
-          writer
-            .indent
-            .escape_code(:cyan)
-            .text(text)
-            .escape_code(:reset_fg)
-            .newline
-        end
-      end
-    end
-  end
-end