uspec 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14e2539758227d31271ce1e3cf534b0edb491cb685f62ab7c16a7fbc711caf88
-  data.tar.gz: 638daabf4483e4ca6a34b480030f896078dd49bb4286afee24830f3395ed3563
+  metadata.gz: f5ebd02acebff5a7d7ffa72dfe23a30b6ef1789acffb41b540758d1cf4d1f083
+  data.tar.gz: ffbc0c4e20c8a4c4376e0ba059ecedc9e8f1589ada86a31998a6b628b1d30df9
 SHA512:
-  metadata.gz: 22747fc9d720163116d69d3f8fa8ba7ad15df46f37dcc3138b93b1eab3a07f1fe765a01b8a1d6ef7ec3cb094c60adbefa39813098841d50a23b62291ac4b9116
-  data.tar.gz: ca54684feb09cdd6b4fc4370b0dc492fd13dfb20ef32c5255329b7a7744ca1b799fce6afc7f8fa039f5658b473334ee06124b908d5a8f113f8a6c035efbcb7a2
+  metadata.gz: aecd905b5420be09dca096a188180e98b6af4514e82d58d3e510500d33899e21034ba143bb77de0536e2f00b126e4635478ecc48f7f6b2b2fa7a6c614d3f3e42
+  data.tar.gz: 98990be1d95c445bb8791b3fc11acefc4fc90013ae533b884db4829ad4e965695d58c1788bdc250fe9181a5eb30956b6f17f7c4afa75732e9a71e565f3f90fb7

data/README.markdown

@@ -69,7 +69,7 @@ Output
 
 Uspec's output is in beautiful ANSI technicolor, with red for failures, green for successes, and yellow for pending specs.
 
-![Screenshot!](https://i.imgur.com/Baqggck.png)
+![uspec examples](https://github.com/acook/uspec/assets/71984/0ceb4319-e671-4159-88d6-6319ebf6cbd3)
 
 A brief explanation of `uspec`'s output to show you what it can do!
 

data/example_specs/example_spec.rb

@@ -1,21 +1,20 @@
 require_relative 'spec_helper'
 
-spec 'I love passing tests' do
+spec 'I love passing tests! Passing tests return `true`' do
   true
 end
 
 spec "This is an idea, but I haven't written the test yet"
 
-spec 'Failing tests display a red' do
+spec 'This is a failing test. Failing tests return `false`' do
   false
 end
 
-spec 'Inspects non-boolean value that the spec block returns' do
+spec 'Non-boolean values are shown in detail' do
   'non-boolean value'
 end
 
-spec 'Displays informative exceptions' do
+spec 'Exceptions are handled and displayed' do
   class ExampleError < RuntimeError; end
-  raise ExampleError
+  raise ExampleError, "an example error for demonstration"
 end
-

data/lib/uspec/cli.rb

@@ -3,8 +3,6 @@ require_relative '../uspec'
 
 class Uspec::CLI
   def initialize args
-    usage unless (args & %w[-h --help -? /? -v --version]).empty?
-
     @paths = args
     @pwd = Pathname.pwd.freeze
     @stats = Uspec::Stats.new
@@ -15,6 +13,9 @@ class Uspec::CLI
   def usage
     warn "uspec v#{::Uspec::VERSION} - minimalistic ruby testing framework"
     warn "usage: #{File.basename $0} [<file_or_path>...]"
+    warn ""
+    warn "\t\t--full_backtrace\tshow full backtrace"
+    warn "\t\t--\t\t\tstop checking paths for options (good if a path begins with a dash)"
     exit 1
   end
 
@@ -23,6 +24,7 @@ class Uspec::CLI
   end
 
   def invoke
+    parse_options @paths
     run_specs
     die!
   end
@@ -61,23 +63,42 @@ class Uspec::CLI
   end
 
   def run_paths
+    check_options = true
+
     paths.each do |path|
       run @pwd.join path
     end
   end
 
   def run path
-    spec = nil
+    p, line = path.to_s.split(?:)
+    path = Pathname.new p
+
     if path.directory? then
       Pathname.glob(path.join('**', '**_spec.rb')).each do |spec|
         run spec
       end
     elsif path.exist? then
       puts "#{path.basename path.extname}:"
-      harness.file_eval path
+      harness.file_eval path, line
     else
       warn "path not found: #{path}"
     end
   end
 
+  def parse_options args
+    args.each_with_index do |arg, i|
+      if arg == '--' then
+        return args
+      elsif arg == '--full_backtrace' then
+        Uspec::Errors.full_backtrace!
+        args.delete_at i
+      elsif !(args & %w[-h --help -? /? -v --version]).empty?
+        usage
+      elsif arg[0] == ?- then
+        warn "unknown option: #{arg}"
+        args.delete_at i
+      end
+    end
+  end
 end

data/lib/uspec/define.rb

@@ -6,7 +6,7 @@ module Uspec
     end
 
     def spec description, &block
-      @__uspec_harness.spec_eval description, &block
+      @__uspec_harness.spec_eval description, caller, &block
     end
   end
 end

data/lib/uspec/errors.rb

@@ -0,0 +1,177 @@
+require_relative "terminal"
+
+module Uspec
+  module Errors
+    module_function
+
+    extend Uspec::Terminal
+
+    MSG_USPEC_BUG_URL = "https://github.com/acook/uspec/issues/new"
+    MSG_IF_USPEC_BUG  = "If you think this is a bug in Uspec please report it: #{MSG_USPEC_BUG_URL}"
+    TRACE_EXCLUDE_PATTERN = /#{Uspec.libpath.join 'lib'}|#{Uspec.libpath.join 'bin'}/
+
+    def handle_file_error error, path, cli = nil
+      error_info = error_context error
+
+      message = <<~MSG
+        Uspec encountered an error when loading a test file.
+        This is probably a typo in the test file or the file it is testing.
+
+        Error occured when loading test file `#{path}`.
+        #{error_info}
+      MSG
+
+      handle_error message, error, cli
+    end
+
+    def handle_internal_error error, cli = nil
+      error_info = error_context error, skip_internal: false
+
+      message = <<~MSG
+        Uspec encountered an internal error!
+
+        #{error_info}
+      MSG
+
+      handle_error message, error, cli
+    end
+
+    def handle_error message, error, cli
+      result = Uspec::Result.new(message, error, true)
+
+      puts
+      warn error_format error, message, leading_newline: false
+
+      cli.handle_interrupt! result.raw if cli
+      result
+    end
+
+    def msg_spec_error error, desc
+      error_info = error_context error
+
+      info = <<~MSG
+        Error occured when evaluating spec `#{desc}`.
+        #{error_info}
+      MSG
+      body = error_format error, info, first_line_indent: false
+
+      message = <<~MSG
+        #{red 'Exception'}
+        #{body}
+      MSG
+
+      message
+    end
+
+    def msg_spec_value error
+      error_info = white bt_format(bt_get error).chomp
+
+      message = <<~MSG
+        #{error.message}
+        #{error_info}
+      MSG
+
+      error_format error, message, header: false
+    end
+
+    def msg_source_error error, desc, cli = nil
+      error_info = error_context error
+
+      message = <<~MSG
+        Uspec detected a bug in your source code!
+
+        Calling #inspect on an object will recusively call #inspect on its instance variables and contents.
+        If one of those contained objects does not have an #inspect method you will see this message.
+        You will also get this message if your #inspect method or one of its callees raises an exception.
+        This is most likely to happen with BasicObject and its subclasses.
+
+        Error occured when evaluating spec `#{desc}`.
+        #{error_info}
+      MSG
+
+      error_format error, message, first_line_indent: false
+    end
+
+    def error_context error, skip_internal: true
+      bt = bt_get error
+      error_line = bt.first.split(?:)
+      [
+        error_origin(*error_line),
+        white(bt_format(bt, skip_internal)),
+        MSG_IF_USPEC_BUG
+      ].join ?\n
+    end
+
+    def bt_get error
+      error.backtrace || caller[3..-1]
+    end
+
+    def error_origin error_file, error_line, *_
+      "The origin of the error may be in file `#{error_file}` on line ##{error_line}."
+    end
+
+    def error_format error, message, first_line_indent: true, leading_newline: true, header: true
+      h = ""
+
+      if header then
+        h << newline if leading_newline
+        h << hspace if first_line_indent
+        h << error_header(error)
+        h << vspace
+      end
+
+      error_indent(error, h + message)
+    end
+
+    def error_indent error, message
+      a = message.split(newline)
+      a << ""
+      a.join("#{newline}#{hspace}")
+    end
+
+    def error_header error
+      "#{red subklassinfo error}#{error.message}"
+    end
+
+    def subklassinfo obj
+      "#{::TOISB.wrap(obj).subklassinfo}: "
+    end
+
+    def bt_format bt, skip_internal = true
+      skip_internal = skip_internal && !full_backtrace?
+      bt_indent bt_clean(bt, skip_internal)
+    end
+
+    def bt_indent bt
+      "#{newline}#{hspace}" + bt.join("#{newline}#{hspace}") + newline if bt
+    end
+
+    def bt_clean bt, skip_internal = true
+      bt.inject(Array.new) do |t, line|
+        next t if skip_internal && line.match(TRACE_EXCLUDE_PATTERN)
+        t << bt_rewrite_caller(line)
+      end if bt
+    end
+
+    def bt_rewrite_caller line
+      return line if full_backtrace?
+      if line.match TRACE_EXCLUDE_PATTERN then
+        line
+      else
+        line.sub /file_eval/, 'spec_block'
+      end
+    end
+
+    def full_backtrace?
+      @full_backtrace
+    end
+
+    def full_backtrace!
+      @full_backtrace = true
+    end
+
+    def clean_backtrace!
+      @full_backtrace = false
+    end
+  end
+end

data/lib/uspec/harness.rb

@@ -14,36 +14,19 @@ module Uspec
       cli.stats
     end
 
-    def file_eval path
+    def file_eval path, line
+      @path = path
+      @line = line
       define.instance_eval(path.read, path.to_s)
     rescue Exception => error
-      if SignalException === error || SystemExit === error then
-        exit 3
-      end
-
-      error_file, error_line, _ = error.backtrace.first.split ?:
-
-      message = <<-MSG
-        #{error.class} : #{error.message}
-
-        Uspec encountered an error when loading a test file.
-        This is probably a typo in the test file or the file it is testing.
-
-        If you think this is a bug in Uspec please report it: https://github.com/acook/uspec/issues/new
-
-        Error occured when loading test file `#{spec || path}`.
-        The origin of the error may be in file `#{error_file}` on line ##{error_line}.
-
-  \t#{error.backtrace[0,3].join "\n\t"}
-      MSG
-      puts
-      warn message
-      stats << Uspec::Result.new(message, error, true)
-
-      cli.handle_interrupt! error
+      raise error if SystemExit === error
+      result = Uspec::Errors.handle_file_error error, path, cli
+      stats << result if result
     end
 
-    def spec_eval description, &block
+    def spec_eval description, source, &block
+      return if @line && !source.first.include?("#{@path}:#{@line}")
+
       ex = nil
       state = 0
       print ' -- ', description
@@ -67,24 +50,19 @@ module Uspec
         result.pending!
       end
 
-      stats << result
-
       print ': ', result.pretty, "\n"
     rescue => error
-      state = 5
-      message = <<-MSG
-        #{error.class} : #{error.message}
-
-        Uspec encountered an internal error, please report this bug: https://github.com/acook/uspec/issues/new
-
-\t#{error.backtrace.join "\n\t"}
-      MSG
-      puts
-      warn message
-      stats << Uspec::Result.new(message, error, true)
+      result = Uspec::Errors.handle_internal_error error, cli
     ensure
-      cli.handle_interrupt! result.raw
+      stats << result if result
+      cli.handle_interrupt! result ? result.raw : raw_result
       return [state, error, result, raw_result]
     end
+
+    def inspect
+      <<~MSG.chomp
+        <#{self.class}##{self.object_id} @cli=#{@cli ? '<...>' : @cli} @define=#{@define ? '<...>' : @define}>
+      MSG
+    end
   end
 end

data/lib/uspec/result.rb

@@ -6,7 +6,6 @@ module Uspec
     include Terminal
 
     PREFIX = "#{Uspec::Terminal.newline}#{Uspec::Terminal.yellow}>\t#{Uspec::Terminal.normal}"
-    TRACE_EXCLUDE_PATTERN = /#{Uspec.libpath.join 'lib'}|#{Uspec.libpath.join 'bin'}/
 
     def initialize spec, raw, ex
       @spec = spec
@@ -26,55 +25,14 @@ module Uspec
       elsif pending? then
         yellow 'pending'
       elsif ex == true then
-        [
-          red('Exception'), vspace,
-          hspace, 'Spec encountered an Exception ', newline,
-          hspace, 'in spec at ', source.first, vspace,
-          hspace, message, vspace,
-          white(trace)
-        ].join
+        Uspec::Errors.msg_spec_error raw, desc
       else
-        [
-          red('Failed'), vspace,
-          hspace, 'Spec did not return a boolean value ', newline,
-          hspace, 'in spec at ', source.first, vspace,
-          hspace, red(subklassinfo), inspector, (Class === raw ? ' Class' : ''), newline
-        ].join
+        nonboolean
       end
     end
 
-    def trace
-      @backtrace ||= indent_bt clean_bt(raw.backtrace, !full_backtrace)
-    end
-
     def source
-      @source ||= clean_bt @caller
-    end
-
-    def indent_bt bt
-      bt.inject(String.new) do |text, line|
-        text << "#{hspace}#{line}#{newline}"
-      end if bt
-    end
-
-    def clean_bt bt, skip_internal = true
-      bt.inject(Array.new) do |t, line|
-        next t if skip_internal && line.match(TRACE_EXCLUDE_PATTERN)
-        t << rewrite_bt_caller(line)
-      end if bt
-    end
-
-    def rewrite_bt_caller line
-      return line if full_backtrace
-      if line.match TRACE_EXCLUDE_PATTERN then
-        line
-      else
-        line.sub /file_eval/, 'spec_block'
-      end
-    end
-
-    def message
-      "#{red subklassinfo}#{raw.message}"
+      @source ||= Uspec::Errors.bt_clean @caller
     end
 
     def subklassinfo
@@ -91,6 +49,16 @@ module Uspec
       end
     end
 
+    def nonboolean
+      [
+        red('Failed'), vspace,
+        hspace, 'Spec did not return a boolean value ', newline,
+        hspace, 'in spec at ', source.first, vspace,
+        hspace, red(subklassinfo), inspector, (Class === raw ? ' Class' : ''), newline
+      ].join
+
+    end
+
     # Attempts to inspect an object
     def inspector
       if String === raw && raw.include?(?\n) then
@@ -99,35 +67,17 @@ module Uspec
           raw.split(newline).unshift(newline).join(PREFIX), normal, newline,
         ].join
       elsif Exception === raw then
-        [
-          raw.message, vspace,
-          white(trace),
-          normal, newline,
-      ].join
+        Uspec::Errors.msg_spec_value raw
       else
         handler.inspector!
       end
     rescue Exception => error
       return handler.simple_inspector if error.message.include? handler.get_id
 
-      error_file, error_line, _ = error.backtrace[4].split ?:
-
-      <<-MSG
-
-      #{error.class} : #{error.message}
-
-      Uspec detected a bug in your source code!
-      Calling #inspect on an object will recusively call #inspect on its instance variables and contents.
-      If one of those contained objects does not have an #inspect method you will see this message.
-      You will also get this message if your #inspect method or one of its callees raises an exception.
-      This is most likely to happen with BasicObject and its subclasses.
-
-      If you think this is a bug in Uspec please report it: https://github.com/acook/uspec/issues/new
-
-      Error may have occured in test `#{desc}` in file `#{error_file}` on line ##{error_line}.
-
-\t#{error.backtrace.join "\n\t"}
-      MSG
+      [
+        red('Unable to Inspect Object'), newline,
+        Uspec::Errors.msg_source_error(error, desc),
+      ].join
     end
 
     def success?

data/lib/uspec/version.rb

@@ -1,3 +1,3 @@
 module Uspec
-  VERSION = '1.4.0'
+  VERSION = '1.5.0'
 end

data/lib/uspec.rb

@@ -17,6 +17,7 @@ module Uspec
 end
 
 require_relative 'uspec/version'
+require_relative 'uspec/errors'
 require_relative 'uspec/harness'
 require_relative 'uspec/define'
 require_relative 'uspec/stats'

data/uspec/cli_spec.rb

@@ -1,14 +1,5 @@
 require_relative 'uspec_helper'
 
-def new_cli path  = '.'
-  Uspec::CLI.new(Array(path))
-end
-
-def run_specs path
-  new_cli(path).run_specs
-end
-
-
 spec 'shows usage' do
   output = capture do
     exec 'bin/uspec -h'
@@ -25,7 +16,7 @@ spec 'runs a path of specs' do
   output.include?('I love passing tests') || output
 end
 
-spec 'runs an individual spec' do
+spec 'runs an individual file' do
   output = outstr do
     run_specs exdir.join('example_spec.rb').to_s
   end
@@ -33,6 +24,14 @@ spec 'runs an individual spec' do
   output.include?('I love passing tests') || output
 end
 
+spec 'runs an individual spec' do
+  output = outstr do
+    run_specs exdir.join('example_spec.rb:13').to_s
+  end
+
+  !output.include?('I love passing tests') && output.include?('non-boolean') || output
+end
+
 spec 'broken requires in test files count as test failures' do
   output, status = Open3.capture2e "#{root}/bin/uspec #{testdir.join('broken_require_spec')}"
 

data/uspec/dsl_spec.rb

@@ -4,7 +4,7 @@ spec 'catches errors' do
   cli = new_cli
 
   output = outstr do
-    cli.harness.define.spec 'exception' do
+    cli.harness.define.spec 'exception spec' do
       raise 'test exception'
     end
   end

data/uspec/errors_spec.rb

@@ -0,0 +1,37 @@
+require_relative "uspec_helper"
+
+spec 'file errors are captured' do
+  cli = new_cli
+
+  output = outstr do
+    cli.harness.file_eval testdir.join('broken_require_spec'), nil
+  end
+
+  output.include?('Uspec encountered an error when loading') || output
+end
+
+spec 'internal errors are captured' do
+  cli = new_cli
+
+  output = outstr do
+   cli.harness.spec_eval BasicObject.new, BasicObject.new do
+      raise 'block error'
+    end
+  end
+
+  output.include?('Uspec encountered an internal error') || output
+end
+
+spec 'source errors are captured' do
+  bo = BasicObject.new
+  def bo.inspect
+    invalid_for_source_error
+  end
+
+  a = [ bo ]
+
+  result = Uspec::Result.new "source error result", a, true
+  output = result.inspector
+
+  output.include?('Uspec detected a bug in your source') || output
+end

data/uspec/result_spec.rb

@@ -103,8 +103,12 @@ spec "handles raised exceptions without backtraces" do
 end
 
 spec "doesn't show 'run' for spec file in stack trace" do
+  Uspec::Errors.clean_backtrace!
+
   result = Uspec::Result.new "No Run Exception Trace Result", exception_value, true
   expected = /uspec.*run/
   actual =  result.pretty
+
+  Uspec::Errors.full_backtrace!
   !actual.match?(expected) || result.pretty
 end

data/uspec/test_specs/error_value_spec

@@ -0,0 +1,8 @@
+class ErrorValue < StandardError
+end
+
+spec "error value spec" do
+  raise ErrorValue, "A test exception!"
+rescue ErrorValue => err
+  return err
+end

data/uspec/test_specs/internal_error_spec

@@ -0,0 +1,3 @@
+spec BasicObject.new do
+  raise 'block error'
+end

data/uspec/test_specs/source_error_spec

@@ -0,0 +1,8 @@
+spec "this spec will create a source error due to a broken inspect method" do
+  bo = BasicObject.new
+  def bo.inspect
+    invalid_for_source_error
+  end
+
+  [ bo ]
+end

data/uspec/uspec_helper.rb

@@ -9,6 +9,8 @@ require 'stringio'
 require_relative '../lib/uspec'
 extend Uspec
 
+Uspec::Errors.full_backtrace!
+
 def capture
   readme, writeme = IO.pipe
   pid = fork do
@@ -59,3 +61,11 @@ end
 def testdir
   specdir.join('test_specs')
 end
+
+def new_cli path  = '.'
+  Uspec::CLI.new(Array(path))
+end
+
+def run_specs path
+  new_cli(path).run_specs
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uspec
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Anthony M. Cook
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-24 00:00:00.000000000 Z
+date: 2024-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: that_object_is_so_basic
@@ -50,6 +50,7 @@ files:
 - lib/uspec.rb
 - lib/uspec/cli.rb
 - lib/uspec/define.rb
+- lib/uspec/errors.rb
 - lib/uspec/harness.rb
 - lib/uspec/result.rb
 - lib/uspec/spec.rb
@@ -59,16 +60,20 @@ files:
 - uspec.gemspec
 - uspec/cli_spec.rb
 - uspec/dsl_spec.rb
+- uspec/errors_spec.rb
 - uspec/result_spec.rb
 - uspec/stats_spec.rb
 - uspec/test_specs/break_spec
 - uspec/test_specs/broken_require_spec
+- uspec/test_specs/error_value_spec
+- uspec/test_specs/internal_error_spec
 - uspec/test_specs/ivar_spec
 - uspec/test_specs/kill_this_script.sh
 - uspec/test_specs/kill_this_spec
 - uspec/test_specs/method_spec
 - uspec/test_specs/pending_spec
 - uspec/test_specs/return_spec
+- uspec/test_specs/source_error_spec
 - uspec/test_specs/value_spec
 - uspec/uspec_helper.rb
 - uspec/uspec_spec.rb