uspec 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d17e77cb5065265172f613c90f9edfb022c217386b56d34af6858b078ba406d8
-  data.tar.gz: 1c77be04e49ca61e243d7c35aa84c9de56dac3ae8f099ba351f6efa5d9a5ca38
+  metadata.gz: 14e2539758227d31271ce1e3cf534b0edb491cb685f62ab7c16a7fbc711caf88
+  data.tar.gz: 638daabf4483e4ca6a34b480030f896078dd49bb4286afee24830f3395ed3563
 SHA512:
-  metadata.gz: cf99ec58c05e076e9060b7ac71271e5fcdfd8ab44e03810b41a1ac2a67a4921777dca4ed2a5c27637f071b20fabb0262118b4a7214448b63ea8193450dc663b6
-  data.tar.gz: eb1c4de66aef1dfef542774fd18b9484bf26778bfe5651c0594fc6cd543472003c32484048435a41d9baacdf3695376fcb1e25fd659ff36183072ddb44eafb41
+  metadata.gz: 22747fc9d720163116d69d3f8fa8ba7ad15df46f37dcc3138b93b1eab3a07f1fe765a01b8a1d6ef7ec3cb094c60adbefa39813098841d50a23b62291ac4b9116
+  data.tar.gz: ca54684feb09cdd6b4fc4370b0dc492fd13dfb20ef32c5255329b7a7744ca1b799fce6afc7f8fa039f5658b473334ee06124b908d5a8f113f8a6c035efbcb7a2

data/example_specs/spec_helper.rb

@@ -1,10 +1,3 @@
 require 'bundler/setup'
 
 Bundler.require :development, :test
-
-require 'uspec'
-
-Dir.chdir File.dirname(__FILE__)
-
-extend Uspec
-

data/lib/uspec/cli.rb

@@ -74,36 +74,10 @@ class Uspec::CLI
       end
     elsif path.exist? then
       puts "#{path.basename path.extname}:"
-      harness.define.instance_eval(path.read, path.to_s)
+      harness.file_eval path
     else
       warn "path not found: #{path}"
     end
-  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, caller)
-
-    handle_interrupt! error
   end
 
 end

data/lib/uspec/harness.rb

@@ -14,21 +14,53 @@ module Uspec
       cli.stats
     end
 
+    def file_eval path
+      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
+    end
+
     def spec_eval description, &block
+      ex = nil
       state = 0
       print ' -- ', description
 
       if block then
         begin
           state = 1
-          raw_result = Uspec::Spec.new(self, description, &block).__uspec_block
+          spec = Uspec::Spec.new(self, description, &block)
+          raw_result = spec.__uspec_block
           state = 2
         rescue Exception => raw_result
           state = 3
+          ex = true
         end
       end
 
-      result = Uspec::Result.new description, raw_result, caller
+      result = Uspec::Result.new spec, raw_result, ex
 
       unless block then
         state = 4
@@ -49,7 +81,7 @@ module Uspec
       MSG
       puts
       warn message
-      stats << Uspec::Result.new(message, error, caller)
+      stats << Uspec::Result.new(message, error, true)
     ensure
       cli.handle_interrupt! result.raw
       return [state, error, result, raw_result]

data/lib/uspec/result.rb

@@ -6,14 +6,17 @@ 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, source
+    def initialize spec, raw, ex
       @spec = spec
       @raw = raw
-      @source = source
+      @ex = ex
       @handler = ::TOISB.wrap raw
+      @full_backtrace = false
+      @caller = caller
     end
-    attr_reader :spec, :raw, :source, :handler
+    attr_reader :spec, :raw, :ex, :handler, :full_backtrace
 
     def pretty
       if raw == true then
@@ -22,7 +25,7 @@ module Uspec
         red raw
       elsif pending? then
         yellow 'pending'
-      elsif Exception === raw then
+      elsif ex == true then
         [
           red('Exception'), vspace,
           hspace, 'Spec encountered an Exception ', newline,
@@ -41,8 +44,32 @@ module Uspec
     end
 
     def trace
-      raw.backtrace.inject(String.new) do |text, line|
+      @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
 
@@ -54,14 +81,29 @@ module Uspec
       "#{handler.subklassinfo}: "
     end
 
+    def desc
+      if String === spec then
+        spec
+      elsif Uspec::Spec === spec then
+        spec.instance_variable_get :@__uspec_description
+      else
+        spec.inspect
+      end
+    end
+
     # Attempts to inspect an object
     def inspector
       if String === raw && raw.include?(?\n) then
         # if object is a multiline string, display it unescaped
-
         [
           raw.split(newline).unshift(newline).join(PREFIX), normal, newline,
         ].join
+      elsif Exception === raw then
+        [
+          raw.message, vspace,
+          white(trace),
+          normal, newline,
+      ].join
       else
         handler.inspector!
       end
@@ -82,7 +124,7 @@ module Uspec
 
       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 `#{spec}` in file `#{error_file}` on line ##{error_line}.
+      Error may have occured in test `#{desc}` in file `#{error_file}` on line ##{error_line}.
 
 \t#{error.backtrace.join "\n\t"}
       MSG
@@ -105,7 +147,7 @@ module Uspec
     end
 
     def inspect
-      "#{self.class} for `#{spec}` -> #{pretty}"
+      "#{self.class} for `#{desc}` -> #{pretty}"
     end
   end
 end

data/lib/uspec/spec.rb

@@ -5,6 +5,7 @@ module Uspec
 
     def initialize harness, description, &block
       @__uspec_description = description
+      @__uspec_block = block
       @__uspec_harness = harness
       ns = harness.define
 

data/lib/uspec/version.rb

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

data/lib/uspec.rb

@@ -1,8 +1,3 @@
-require_relative 'uspec/version'
-require_relative 'uspec/harness'
-require_relative 'uspec/define'
-require_relative 'uspec/stats'
-
 module Uspec
   def self.included object
     warn 'Use extend instead of include.'
@@ -15,4 +10,13 @@ module Uspec
     #  object.extend Uspec::DSL
     #end
   end
+
+  def self.libpath
+    Pathname.new(__FILE__).dirname.dirname
+  end
 end
+
+require_relative 'uspec/version'
+require_relative 'uspec/harness'
+require_relative 'uspec/define'
+require_relative 'uspec/stats'

data/uspec/result_spec.rb

@@ -3,7 +3,7 @@ require_relative "uspec_helper"
 bo = BasicObject.new
 
 spec "#pretty doesn't die when given a BasicObject" do
-  result = Uspec::Result.new "BasicObject Result", bo, []
+  result = Uspec::Result.new "BasicObject Result", bo, nil
   expected = "#<BasicObject:"
   actual = result.pretty
   actual.include?(expected) || actual
@@ -14,28 +14,28 @@ class ::TestObject < BasicObject; end
 obj = TestObject.new
 
 spec "ensure BasicObject subclass instances work" do
-  result = Uspec::Result.new "BasicObject Subclass Result", obj, []
+  result = Uspec::Result.new "BasicObject Subclass Result", obj, nil
   expected = "#<BasicObject/TestObject:"
   actual =  result.pretty
   actual.include?(expected) || result.pretty
 end
 
 spec "display basic info about Object" do
-  result = Uspec::Result.new "Object Result", Object.new, []
+  result = Uspec::Result.new "Object Result", Object.new, nil
   expected = "Object < BasicObject: \e[0m#<Object:"
   actual =  result.pretty
   actual.include?(expected) || result.pretty
 end
 
 spec "display basic info about Array" do
-  result = Uspec::Result.new "Array Result", [], []
+  result = Uspec::Result.new "Array Result", [], nil
   expected = "Array < Object"
   actual =  result.pretty
   actual.include?(expected) || result.pretty
 end
 
 spec "display basic info about Array class" do
-  result = Uspec::Result.new "Array Class Result", Array, []
+  result = Uspec::Result.new "Array Class Result", Array, nil
   expected = "Class < Module: \e[0mArray Class"
   actual =  result.pretty
   actual.include?(expected) || result.pretty
@@ -44,7 +44,7 @@ end
 parent = [obj]
 
 spec "ensure parent object of BasicObject subclasses get a useful error message" do
-  result = Uspec::Result.new "BasicObject Parent Result", parent, []
+  result = Uspec::Result.new "BasicObject Parent Result", parent, nil
   expected = "BasicObject and its subclasses"
   actual =  result.pretty
   actual.include?(expected) || result.inspector
@@ -54,7 +54,7 @@ class ::InspectFail; def inspect; raise RuntimeError, "This error is intentional
 inspect_fail = InspectFail.new
 
 spec "display a useful error message when a user-defined inspect method fails" do
-  result = Uspec::Result.new "Inspect Fail Result", inspect_fail, []
+  result = Uspec::Result.new "Inspect Fail Result", inspect_fail, nil
   expected = "raises an exception"
   actual =  result.pretty
   actual.include?(expected) || result.inspector
@@ -63,7 +63,48 @@ end
 spec "display strings more like their actual contents" do
   string = "this string:\nshould display \e\[42;2mproperly"
   expected = /this string:\n.*should display \e\[42;2mproperly/
-  result = Uspec::Result.new "Inspect Fail Result", string, []
+  result = Uspec::Result.new "Inspect Fail Result", string, nil
   actual =  result.pretty
   actual.match?(expected) || result.inspector
 end
+
+def exception_value
+  raise "A test exception!"
+rescue => err
+  return err
+end
+
+spec "handles exception values" do
+  result = Uspec::Result.new "Exception Value Result", exception_value, nil
+  expected = "RuntimeError < StandardError: \e[0mA test exception!"
+  actual =  result.pretty
+  actual.include?(expected) || result.pretty
+end
+
+spec "handles exception values including backtraces" do
+  result = Uspec::Result.new "Exception Value Result", exception_value, nil
+  expected = "exception_value"
+  actual =  result.pretty
+  actual.include?(expected) || result.pretty
+end
+
+spec "handles raised exceptions" do
+  result = Uspec::Result.new "Exception Raised Result", exception_value, true
+  expected = "RuntimeError < StandardError: \e[0mA test exception!"
+  actual =  result.pretty
+  actual.include?(expected) || result.pretty
+end
+
+spec "handles raised exceptions without backtraces" do
+  result = Uspec::Result.new "Exception Raised Result", Exception.new, true
+  expected = "Exception < Object: \e[0mException"
+  actual =  result.pretty
+  actual.include?(expected) || result.pretty
+end
+
+spec "doesn't show 'run' for spec file in stack trace" do
+  result = Uspec::Result.new "No Run Exception Trace Result", exception_value, true
+  expected = /uspec.*run/
+  actual =  result.pretty
+  !actual.match?(expected) || result.pretty
+end

data/uspec/stats_spec.rb

@@ -1,12 +1,19 @@
 require_relative 'uspec_helper'
 
+def stats_object
+  Uspec::Stats.new
+end
+
 spec 'stats can be inspected' do
+  # this is a regression test
+  # the issue it covers occured because of a refactor where stats had a custom inspect method
+  # stats no longer has a custom inspect method, but this makes sure that nothing breaks
   actual = @__uspec_harness.stats.inspect
   actual.include?("failure") || actual
 end
 
 spec 'stats inspect does not have any stray whitespace' do
-  output = @__uspec_harness.stats.inspect
+  output = stats_object.inspect
   match = output.match /(.*(?:  |\n))/m
   match == nil || match
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uspec
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Anthony M. Cook
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-23 00:00:00.000000000 Z
+date: 2024-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: that_object_is_so_basic