test_bench 1.0.1.0 → 1.2.0.2

data/lib/test_bench/output/summary.rb

@@ -0,0 +1,146 @@
+module TestBench
+  module Output
+    class Summary
+      include Fixture::Output
+
+      include Writer::Dependency
+
+      def file_count
+        @file_count ||= 0
+      end
+      attr_writer :file_count
+
+      def test_count
+        @test_count ||= 0
+      end
+      attr_writer :test_count
+
+      def pass_count
+        @pass_count ||= 0
+      end
+      attr_writer :pass_count
+
+      def skip_count
+        @skip_count ||= 0
+      end
+      attr_writer :skip_count
+
+      def failure_count
+        @failure_count ||= 0
+      end
+      attr_writer :failure_count
+
+      def error_count
+        @error_count ||= 0
+      end
+      attr_writer :error_count
+
+      def elapsed_time
+        @elapsed_time ||= 0
+      end
+      attr_writer :elapsed_time
+
+      def timer
+        @timer ||= Timer::Substitute.build
+      end
+      attr_writer :timer
+
+      def errors_by_file
+        @errors_by_file ||= Hash.new do |hash, key|
+          hash[key] = []
+        end
+      end
+      attr_writer :errors_by_file
+
+      attr_accessor :current_file
+
+      def configure(writer: nil, device: nil, styling: nil)
+        Writer.configure(self, writer: writer, device: device, styling: styling)
+        Timer.configure(self)
+      end
+
+      def self.build(writer: nil, device: nil, styling: nil)
+        instance = new
+        instance.configure(writer: writer, device: device, styling: styling)
+        instance
+      end
+
+      def enter_file(file)
+        timer.start
+
+        self.current_file = file
+      end
+
+      def exit_file(_, _)
+        elapsed_time = timer.stop
+
+        self.elapsed_time += elapsed_time
+
+        self.file_count += 1
+      end
+
+      def finish_test(_, result)
+        self.test_count += 1
+
+        if result
+          self.pass_count += 1
+        else
+          self.failure_count += 1
+        end
+      end
+
+      def skip_test(_)
+        self.skip_count += 1
+      end
+
+      def error(error)
+        errors_by_file[current_file] << error
+
+        self.error_count += 1
+      end
+
+      def finish(_)
+        error_summary
+
+        session_summary
+      end
+
+      def session_summary
+        Session.(file_count: file_count, test_count: test_count, pass_count: pass_count, skip_count: skip_count, failure_count: failure_count, error_count: error_count, elapsed_time: elapsed_time, writer: writer)
+      end
+
+      def error_summary
+        return if errors_by_file.empty?
+
+        writer
+          .escape_code(:bold)
+          .escape_code(:red)
+          .text('Error Summary:')
+          .escape_code(:reset_intensity)
+          .escape_code(:reset_fg)
+          .newline
+
+        errors_by_file.each do |file, errors|
+          error_count = errors.count
+
+          writer
+            .text(error_count.to_s.rjust(4, ' '))
+            .text(": #{file}")
+            .newline
+
+          errors.each do |error|
+            writer
+              .text('      ')
+              .escape_code(:red)
+
+            PrintError.error_message(error, writer: writer)
+
+            writer.escape_code(:reset_fg)
+          end
+        end
+
+        writer.newline
+      end
+    end
+  end
+end

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/timer/substitute.rb

@@ -8,7 +8,7 @@ module TestBench
 
         class Timer < Timer
           def elapsed_time
-            @elapsed_time ||= 0
+            @elapsed_time ||= 0.0
           end
           attr_writer :elapsed_time
 

data/lib/test_bench/output/writer.rb

@@ -106,7 +106,7 @@ module TestBench
 
       def newline
         sync
-        device.puts
+        device.puts('')
         self.byte_offset += 1
         self
       end
@@ -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
@@ -65,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
@@ -74,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.1.0
+  version: 1.2.0.2
 platform: ruby
 authors:
 - Nathan Ladd
-autorequire: 
+autorequire:
 bindir: script
 cert_chain: []
-date: 2020-06-11 00:00:00.000000000 Z
+date: 2020-08-09 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.4
+signing_key:
 specification_version: 4
 summary: Principled Test Framework for Ruby
 test_files: []