test_bench 1.0.1.0 → 1.2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06f16583f7c46772e6214ffaa5eddf6b7a043302470f25e6ece21dbd8f490dd2
-  data.tar.gz: acbaa308888055c2cede7652cb740540316a39f7fab6fd8ff54b67c27e2b3bcc
+  metadata.gz: e3b488668e7e9d65b4a0ec2adbabb94b9a1cf8e4a29d9e4b1c90b5b3c867fd59
+  data.tar.gz: 9d4034e73a32b4d694197a1f3ee6a89c9c7843288cdf23934e9aeea4e4136ce8
 SHA512:
-  metadata.gz: fd539a8778999d1333ab2fa5cc8efec5cfce01e69e6f70a21ecd4fcdd60385be5dbdaf9eaa67bdd26c4f2f06196c4737d26a58168c5b8dc6c030bdaf361d5a42
-  data.tar.gz: 4cf6d0358dbe940108001097ef0759e4070e3ab23d5ee7f1bcb6b339ae42e8c669c092c5db59348d37615dfe88b35effb38655e1d9449a33566846a030ef28d0
+  metadata.gz: 2b49bf38f0ed60504849c6e726fdcbf372d8700b459b1357d967ea472ae76f9ce0ff06c2eef60f0ce438843e5a540c431c80ab9ecc44f6a2f4de18179056e3b0
+  data.tar.gz: 770d4bf06d1048be6d031a11ce2040f16275296d731f01052dac9ded7632c587424b7af317c94c3b55acbcc1988e9ff93045724fb88c3307aa2614504bc09f8d

data/lib/test_bench.rb

@@ -1,4 +1,6 @@
-require 'optionparser'
+unless RUBY_ENGINE == 'mruby'
+  require 'optionparser'
+end
 
 require 'test_bench/fixture'
 
@@ -14,17 +16,17 @@ require 'test_bench/output/timer/substitute'
 
 require 'test_bench/output/print_error'
 
-require 'test_bench/output/summary/run/print'
-require 'test_bench/output/summary/run'
-require 'test_bench/output/summary/error'
+require 'test_bench/output/summary'
+require 'test_bench/output/summary/session'
 
-require 'test_bench/output/levels/none'
-require 'test_bench/output/levels/summary'
-require 'test_bench/output/levels/failure'
-require 'test_bench/output/levels/debug'
-require 'test_bench/output/levels/pass'
+require 'test_bench/output/batch_data'
+
+require 'test_bench/output/raw'
+
+require 'test_bench/output/buffer'
+
+require 'test_bench/output/log'
 
-require 'test_bench/output/build'
 require 'test_bench/output'
 
 require 'test_bench/test_bench'

data/lib/test_bench/cli.rb

@@ -1,6 +1,6 @@
 module TestBench
   module CLI
-    def self.call(tests_directory=nil, **runner_args)
+    def self.call(tests_directory=nil, exclude_file_pattern: nil)
       tests_directory ||= Defaults.tests_directory
 
       path_arguments = ParseArguments.()
@@ -11,7 +11,7 @@ module TestBench
         warn "$stdin is a pipe, but no data was written to it; no test files will be run"
       end
 
-      Run.(**runner_args) do |run|
+      Run.(exclude: exclude_file_pattern) do |run|
         if read_stdin
           until $stdin.eof?
             path = $stdin.gets.chomp

data/lib/test_bench/cli/parse_arguments.rb

@@ -48,25 +48,37 @@ module TestBench
           parser.on('-h', '--help', "Print this help message and exit successfully") do
             output_device.puts(parser.help)
 
-            exit(true)
+            raise SystemExit.new(0)
           end
 
           parser.on('-V', '--version', "Print version and exit successfully") do
-            output_device.puts <<~TEXT
-            test-bench (#{self.class.program_name}) version #{self.class.version}
-            TEXT
+            output_device.puts <<TEXT
+test-bench (#{self.class.program_name}) version #{self.class.version}
+TEXT
 
-            exit(true)
+            raise SystemExit.new(0)
           end
 
           parser.separator('')
           parser.separator("Configuration Options")
 
-          parser.on('-a', '--[no-]abort-on-error', %{Exit immediately after any test failure or error (Default: #{Session::Defaults.abort_on_error ? 'on' : 'off'})}) do |abort_on_error|
+          parser.on('-a', '--[no-]abort-on-error', %{Exit immediately after any test failure or error (Default: #{TestBench::Defaults.abort_on_error ? 'on' : 'off'})}) do |abort_on_error|
             env['TEST_BENCH_ABORT_ON_ERROR'] = abort_on_error ? 'on' : 'off'
           end
 
-          parser.on('-x', '--[no-]exclude PATTERN', %{Do not execute test files matching PATTERN (Default: #{Run::Defaults.exclude_file_pattern.inspect})}) do |pattern_text|
+          parser.on('-d', '--[no-]detail [DETAIL]', %{Always show (or hide) details (Default: #{Output::Raw::Defaults.detail})}) do |detail|
+            if detail.nil?
+              detail = 'on'
+            elsif detail == true
+              detail = 'on'
+            elsif detail == false
+              detail = 'off'
+            end
+
+            env['TEST_BENCH_DETAIL'] = detail
+          end
+
+          parser.on('-x', '--[no-]exclude PATTERN', %{Do not execute test files matching PATTERN (Default: #{Run::Defaults.exclude_pattern.inspect})}) do |pattern_text|
             if pattern_text == false
               pattern_text = self.none_pattern
             end
@@ -76,6 +88,14 @@ module TestBench
             env['TEST_BENCH_EXCLUDE_FILE_PATTERN'] = pattern_text
           end
 
+          parser.on('-l', '--log-level LEVEL', %{Set the internal logging level to LEVEL (Default: #{Output::Log::Defaults.level})}) do |level_text|
+            level = level_text.to_sym
+
+            Fixture::Output::Log.assure_level(level)
+
+            env['TEST_BENCH_LOG_LEVEL'] = level_text
+          end
+
           parser.on('-o', '--[no-]omit-backtrace PATTERN', %{Omit backtrace frames matching PATTERN (Default: #{Output::PrintError::Defaults.omit_backtrace_pattern.inspect})}) do |pattern_text|
             if pattern_text == false
               pattern_text = self.none_pattern
@@ -86,25 +106,17 @@ module TestBench
             env['TEST_BENCH_OMIT_BACKTRACE_PATTERN'] = pattern_text
           end
 
-          parser.on('-l', '--output-level [none|summary|failure|pass|debug]', %{Sets output level (Default: #{Output::Build::Defaults.level})}) do |level_text|
-            level = level_text.to_sym
-
-            Output::Build.assure_level(level)
-
-            env['TEST_BENCH_OUTPUT_LEVEL'] = level_text
-          end
-
-          parser.on('-s', '--output-styling [on|off|detect]', %{Render output coloring and font styling escape codes (Default: #{Output::Writer::Defaults.styling_setting})}) do |styling_text|
+          parser.on('-s', '--output-styling [on|off|detect]', %{Render output coloring and font styling escape codes (Default: #{Output::Writer::Defaults.styling})}) do |styling_text|
             styling_text ||= 'on'
 
-            styling_setting = styling_text.to_sym
+            styling = styling_text.to_sym
 
-            Output::Writer.assure_styling_setting(styling_setting)
+            Output::Writer.assure_styling_setting(styling)
 
             env['TEST_BENCH_OUTPUT_STYLING'] = styling_text
           end
 
-          parser.on('-p', '--[no-]permit-deactivated-tests', %{Do not fail the test run if there are deactivated tests or contexts, e.g. _test or _context (Default: #{!DeactivationVariants::Defaults.fail_session ? 'on' : 'off'})}) do |permit_deactivated_tests|
+          parser.on('-p', '--[no-]permit-deactivated-tests', %{Do not fail the test run if there are deactivated tests or contexts, e.g. _test or _context (Default: #{!TestBench::Defaults.fail_deactivated_tests ? 'on' : 'off'})}) do |permit_deactivated_tests|
             env['TEST_BENCH_FAIL_DEACTIVATED_TESTS'] = !permit_deactivated_tests ? 'on' : 'off'
           end
 
@@ -112,32 +124,33 @@ module TestBench
             env['TEST_BENCH_REVERSE_BACKTRACES'] = reverse_backtraces ? 'on' : 'off'
           end
 
-          parser.separator(<<~TEXT)
-
-          Paths to test files (and directories containing test files) can be given after any command line arguments or via STDIN (or both).
-          If no paths are given, a default path (#{Defaults.tests_directory}) is scanned for test files.
+          parser.on('-v', '--[no-]verbose', %{Increase output verbosity (Default: #{Output::Raw::Defaults.verbose ? 'on' : 'off'})}) do |verbose|
+            env['TEST_BENCH_VERBOSE'] = verbose ? 'on' : 'off'
+          end
 
-          The following environment variables can also control execution:
+          parser.separator(<<TEXT)
 
-          #{parser.summary_indent}TEST_BENCH_ABORT_ON_ERROR          Same as -a or --abort-on-error
-          #{parser.summary_indent}TEST_BENCH_EXCLUDE_FILE_PATTERN    Same as -x or --exclude-file-pattern
-          #{parser.summary_indent}TEST_BENCH_OMIT_BACKTRACE_PATTERN  Same as -o or --omit-backtrace-pattern
-          #{parser.summary_indent}TEST_BENCH_OUTPUT_LEVEL            Same as -l or --output-level
-          #{parser.summary_indent}TEST_BENCH_OUTPUT_STYLING          Same as -s or --output-styling
-          #{parser.summary_indent}TEST_BENCH_FAIL_DEACTIVATED_TESTS  Opposite of -p or --permit-deactivated-tests
-          #{parser.summary_indent}TEST_BENCH_REVERSE_BACKTRACES      Same as -r or --reverse-backtraces
+Paths to test files (and directories containing test files) can be given after any command line arguments or via STDIN (or both).
+If no paths are given, a default path (#{Defaults.tests_directory}) is scanned for test files.
 
-          TEXT
+The following environment variables can also control execution:
 
-          parser.separator(<<~TEXT)
-          Finally, the VERBOSE environment variable can set the output level to debug. If given, VERBOSE will take precedence over TEST_BENCH_OUTPUT_STYLING.
+#{parser.summary_indent}TEST_BENCH_ABORT_ON_ERROR          Same as -a or --abort-on-error
+#{parser.summary_indent}TEST_BENCH_DETAIL                  Same as -d or --detail
+#{parser.summary_indent}TEST_BENCH_EXCLUDE_FILE_PATTERN    Same as -x or --exclude-file-pattern
+#{parser.summary_indent}TEST_BENCH_LOG_LEVEL               Same as -l or --log-level
+#{parser.summary_indent}TEST_BENCH_OMIT_BACKTRACE_PATTERN  Same as -o or --omit-backtrace-pattern
+#{parser.summary_indent}TEST_BENCH_OUTPUT_STYLING          Same as -s or --output-styling
+#{parser.summary_indent}TEST_BENCH_FAIL_DEACTIVATED_TESTS  Opposite of -p or --permit-deactivated-tests
+#{parser.summary_indent}TEST_BENCH_REVERSE_BACKTRACES      Same as -r or --reverse-backtraces
+#{parser.summary_indent}TEST_BENCH_VERBOSE                 Same as -v or --reverse-backtraces
 
-          TEXT
+TEXT
         end
       end
 
       def assure_pattern(pattern_text)
-        Regexp.new(pattern_text)
+        Regexp.new(pattern_text.to_s)
       rescue RegexpError
         raise Error, "Invalid regular expression pattern (Pattern: #{pattern_text.inspect})"
       end
@@ -151,7 +164,7 @@ module TestBench
       end
 
       def self.version
-        if defined?(Gem)
+        if Object.const_defined?(:Gem)
           spec = Gem.loaded_specs['test_bench']
         end
 

data/lib/test_bench/controls.rb

@@ -1,4 +1,6 @@
-require 'securerandom'
+unless RUBY_ENGINE == 'mruby'
+  require 'securerandom'
+end
 
 require 'test_bench/fixture/controls'
 
@@ -18,5 +20,9 @@ require 'test_bench/controls/output/escape_code'
 require 'test_bench/controls/output/newline_character'
 require 'test_bench/controls/output/styling'
 require 'test_bench/controls/output/print_error'
-require 'test_bench/controls/output/summary/run'
+require 'test_bench/controls/output/exercise'
+require 'test_bench/controls/output/summary/session'
 require 'test_bench/controls/output/summary/error'
+require 'test_bench/controls/output/batch_data'
+require 'test_bench/controls/output/detail_setting'
+require 'test_bench/controls/output/log_level'

data/lib/test_bench/controls/error.rb

@@ -11,11 +11,11 @@ module TestBench
 
           error = Error.example(message)
 
-          <<~TEXT
-          #{indent}#{error.backtrace[0]}: #{error.message} (#{error.class.name})
-          \t#{indent}from #{error.backtrace[1]}
-          \t#{indent}from #{error.backtrace[2]}
-          TEXT
+          <<TEXT
+#{indent}#{error.backtrace[0]}: #{error.message} (#{error.class.name})
+\t#{indent}from #{error.backtrace[1]}
+\t#{indent}from #{error.backtrace[2]}
+TEXT
         end
 
         module Assertion
@@ -24,9 +24,9 @@ module TestBench
 
             assertion_failure = TestBench::Fixture::AssertionFailure.build(caller_location)
 
-            <<~TEXT
-            #{assertion_failure.backtrace[0]}: #{assertion_failure.message} (#{assertion_failure.class.name})
-            TEXT
+            <<TEXT
+#{assertion_failure.backtrace[0]}: #{assertion_failure.message} (#{assertion_failure.class.name})
+TEXT
           end
         end
       end

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

@@ -0,0 +1,52 @@
+module TestBench
+  module Controls
+    module Output
+      module BatchData
+        def self.example(result: nil, depth: nil)
+          result = self.result if result.nil?
+          depth ||= self.depth
+
+          TestBench::Output::BatchData.new(result, depth)
+        end
+
+        def self.result
+          Pass.result
+        end
+
+        def self.depth
+          1
+        end
+
+        module Pass
+          def self.example(depth: nil)
+            BatchData.example(result: result, depth: depth)
+          end
+
+          def self.result
+            Result::Pass.example
+          end
+        end
+
+        module Failure
+          def self.example(depth: nil)
+            BatchData.example(result: result, depth: depth)
+          end
+
+          def self.result
+            Result::Failure.example
+          end
+        end
+
+        module Toplevel
+          def self.example(result: nil)
+            BatchData.example(depth: depth, result: result)
+          end
+
+          def self.depth
+            0
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+module TestBench
+  module Controls
+    module Output
+      module DetailSetting
+        def self.example
+          failure
+        end
+
+        def self.failure
+          :failure
+        end
+
+        def self.on
+          :on
+        end
+
+        def self.off
+          :off
+        end
+
+        module Invalid
+          def self.example
+            :not_a_detail_setting
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+module TestBench
+  module Controls
+    module Output
+      Exercise = TestBench::Fixture::Controls::Output::Exercise
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+module TestBench
+  module Controls
+    module Output
+      LogLevel = TestBench::Fixture::Controls::Output::Log::Level
+    end
+  end
+end

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

@@ -3,7 +3,12 @@ module TestBench
     module Output
       module NewlineCharacter
         def self.example
-          StringIO.new.tap(&:puts).string
+          str = String.new
+
+          string_io = StringIO.new(str)
+          string_io.puts('')
+
+          str
         end
       end
     end

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

@@ -3,30 +3,14 @@ module TestBench
     module Output
       module Summary
         module Error
-          def self.example(writer: nil)
-            error_summary = Example.new
-            error_summary.writer = writer unless writer.nil?
-            error_summary
-          end
-
-          class Example
-            include TestBench::Fixture::Output
-            include TestBench::Output::Summary::Error
-
-            TestBench::Fixture::Output.instance_methods.each do |method|
-              define_method(method) do |*|
-              end
-            end
-          end
-
           module Text
             def self.example
-              <<~TEXT
-                Error Summary:
-                   1: #{file}
-                      #{error.backtrace[0]}: #{error} (#{error.class})
+              <<TEXT
+Error Summary:
+   1: #{file}
+      #{error.backtrace[0]}: #{error} (#{error.class})
 
-              TEXT
+TEXT
             end
 
             def self.file

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

@@ -0,0 +1,20 @@
+module TestBench
+  module Controls
+    module Output
+      module Summary
+        module Session
+          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
+          end
+        end
+      end
+    end
+  end
+end

data/lib/test_bench/controls/pattern.rb

@@ -1,8 +1,12 @@
 module TestBench
   module Controls
     module Pattern
-      def self.example
-        /#{text}/
+      def self.example(text=nil)
+        text ||= self.text
+
+        escaped_text = Regexp.escape(text)
+
+        Regexp.new(escaped_text)
       end
 
       def self.text