uspec 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11c5e0a54306aeafdf5547c71c02c3ed64fabc60f068bff1d6d395cc1fac11b3
-  data.tar.gz: 918d6e06e01c9c0541a410d9ecc5aad0a7c7f416c0532d533f461383dfad70d4
+  metadata.gz: 8d937f702b24f432fa7a241bd2fdd4f01a6119f6da79f98f1efd3e5f726cba22
+  data.tar.gz: 297733864622a5a0032918a9c6d83bac21e90df4b141c5898e7309a248cb1982
 SHA512:
-  metadata.gz: 46c2d5c8833632e28692a834c664a3947e21f8a0049133b99b409282eecaafa7d4e2ce2b6247e24bd625d8924f80634f6343c2013ce1b73789fcdd631ecd7075
-  data.tar.gz: 79fc6300bf5e09df01a0cfce23aca9514d58e571f222a0843f9e68c948a48550add600eb75fd429eefeccaeb81d48ca95cb3da2ee7f66fcb3eed3b28e962e903
+  metadata.gz: e6bb5da0e65a04f60292ee4b74184e02081571eaf942c915eb239a9b98b7bb9f420d7a4da0b2fbacb9f370fb0769b2336deee1686fe250c5793953fe7ba8ed41
+  data.tar.gz: 6c1a3721ed8a8d41bc65583812a9abafeacf251dba910867b3567addb412c646237f64c68971a0cbc87e38f0abdaaeb8b652139c9f0b8a412e92dfae9c4e5609

data/.circleci/config.yml

@@ -1,21 +1,23 @@
 version: 2.1
 orbs:
-  ruby: circleci/ruby@0.1.2 
+  ruby: circleci/ruby@2.0.0
 
 jobs:
   build:
     docker:
-      - image: circleci/ruby:2.6.3-stretch-node
-    executor: ruby/default
+      - image: cimg/ruby:3.1.2
+
+    working_directory: ~/repo
+
     steps:
       - checkout
       - run:
-          name: Which bundler?
-          command: bundle -v
-      - ruby/bundle-install
-  test:
-    executor: ruby/default
-    steps:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      # run tests!
       - run:
-          name: Uspec tests
-          command: bundle exec uspec
+          name: run tests
+          command:
+            bundle exec uspec

data/.gitignore

@@ -15,3 +15,6 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+
+tags
+TAGS

data/.ruby-version

@@ -1 +1 @@
-2.3.7
+3.3.0

data/README.markdown

@@ -24,7 +24,7 @@ This also means *no monkey patching* core classes!
 Uspec's output is in beautiful ansi technicolor,
 with red for failures, green for successes, and yellow for pending specs. Here's a screenshot:
 
-![Screenshot!](http://i.imgur.com/M2F5YvO.png)
+![Screenshot!](https://i.imgur.com/Baqggck.png)
 
 Uspec is tiny, painless, and easy to use. Download it and give it a try!
 
@@ -90,7 +90,7 @@ A brief explanation of `uspec`'s output to show you what it can do!
 
 ### Success
 
-If a spec passes:
+If a spec passes (returns true):
 
 ```
  -- AwesomeMcCoolname.generate creates a cool name: true
@@ -98,7 +98,7 @@ If a spec passes:
 
 ### Failure
 
-If a spec fails:
+If a spec fails (returns false):
 
 ```
  -- AwesomeMcCoolname.generate creates a cool name: false
@@ -106,13 +106,13 @@ If a spec fails:
 
 ### Exception
 
-If the spec throws an error:
+If the spec encounters an error (raises an Exception):
 
 ```
  -- AwesomeMcCoolname.generate creates a cool name: Exception
 
     Encountered an Exception while running spec
-    at uspec/awesome_mc_coolname_spec.rb:3: in `<main>'
+    in spec at uspec/awesome_mc_coolname_spec.rb:3: in `<main>'
 
     RuntimeError < StandardError: 'wtf'
 
@@ -130,13 +130,13 @@ spec 'AwesomeMcCoolname.generate creates a cool name' do
 end
 ```
 
-Then Uspec will let you know:
+Then Uspec will let you know so you can debug it:
 
 ```ruby
- -- AwesomeMcCoolname.generate creates a badass name: Unknown Result
+ -- AwesomeMcCoolname.generate creates a badass name: Failed
 
     Spec did not return a boolean value
-    at uspec/awesome_mc_coolname_spec.rb:6: in `<main>'
+    in spec at uspec/awesome_mc_coolname_spec.rb:6: in `<main>'
 
     Integer < Numeric: 5
 ```
@@ -206,45 +206,6 @@ Mocks, Spies, Stubs, and More!
 
 Since `uspec` is a very straight forward testing utility it is easy to use any of the standard Ruby mocking frameworks with it. However, the [Impasta gem](https://github.com/acook/impasta) was made specifically for simple but comprehensive mocking, stubbing, and spying.
 
-Assertions & Debugging
-----------------------
-
-You can also use `uspec` to track assertions in an application or any object you want. Every spec block you use will be tracked and recorded. It's really no problem at all to do.
-
-You can load Uspec's features directly into a class and use its DSL:
-
-```ruby
-require 'uspec'
-
-class MyFoo
-  extend Uspec::DSL
-
-  def assert
-    spec 'foo is valid' do
-      false
-    end
-  end
-end
-
-MyFoo.new.assert
-```
-
-Assertions will be displayed as they occur, success or failure along with any informative output.
-If there are any specs that fail, when your application exits its error code will equal the number of failures.
-
-```
-$ ruby foo.rb
- -- foo is valid: false
-$ echo $?
-1
-```
-
-Uspec is just Ruby
-------------------
-
-If for some reason you don't want to use the `uspec` command, you can `require 'uspec'` and `extend Uspec::DSL`.
-From there you can just run the file with ruby: `ruby my_test_spec.rb`
-
 Contributing
 ------------
 
@@ -257,4 +218,4 @@ Contributing
 Author
 ------
 
-> Anthony M. Cook 2013-2020
+> Anthony M. Cook 2013-2021

data/lib/uspec/dsl.rb

@@ -2,6 +2,10 @@ require_relative "result"
 
 module Uspec
   class DSL
+    USPEC_CLI_BLOCK = -> { @__uspec_dsl.__uspec_cli }
+    USPEC_STAT_BLOCK = -> { @__uspec_dsl.__uspec_cli.stats }
+    USPEC_SPEC_BLOCK = ->(description, &block) { @__uspec_dsl.spec description, &block }
+
     def initialize cli
       @__uspec_cli = cli
     end
@@ -14,32 +18,49 @@ module Uspec
       @__uspec_cli.stats
     end
 
-    def spec description
+    def __uspec_eval block
+      o = Object.new
+      o.define_singleton_method :__uspec_stats, USPEC_STAT_BLOCK
+      o.define_singleton_method :__uspec_cli, USPEC_CLI_BLOCK
+      o.instance_variable_set :@__uspec_cli, @__uspec_cli
+      o.instance_variable_set :@__uspec_dsl, self
+      o.define_singleton_method :spec, USPEC_SPEC_BLOCK
+      o.define_singleton_method :spec_block, &block
+      o.spec_block
+    end
+
+    def spec description, &block
+      state = 0
       print ' -- ', description
 
-      if block_given? then
+      if block then
         begin
-          raw_result = yield
+          state = 1
+          raw_result = __uspec_eval block
+          state = 2
         rescue Exception => raw_result
+          state = 3
         end
       end
 
       result = Result.new description, raw_result, caller
 
-      unless block_given? then
+      unless block then
+        state = 4
         result.pending!
       end
 
       if result.success?
         __uspec_stats.success << result
       elsif result.pending?
-        stats.pending << result
+        __uspec_stats.pending << result
       else
         __uspec_stats.failure << result
       end
 
       print ': ', result.pretty, "\n"
     rescue => error
+      state = 5
       message = <<-MSG
         #{error.class} : #{error.message}
 
@@ -50,6 +71,8 @@ module Uspec
       puts
       warn message
       __uspec_stats.failure << Uspec::Result.new(message, error, caller)
+    ensure
+      return [state, error, result, raw_result]
     end
   end
 end

data/lib/uspec/result.rb

@@ -5,6 +5,8 @@ module Uspec
   class Result
     include Terminal
 
+    PREFIX = "#{Terminal.newline}#{Terminal.yellow}>\t#{Terminal.normal}"
+
     def initialize spec, raw, source
       @spec = spec
       @raw = raw
@@ -33,7 +35,7 @@ module Uspec
           red('Failed'), vspace,
           hspace, 'Spec did not return a boolean value ', newline,
           hspace, 'in spec at ', source.first, vspace,
-          hspace, red(subklassinfo), inspector, newline
+          hspace, red(subklassinfo), inspector, (Class === raw ? ' Class' : ''), newline
         ].join
       end
     end
@@ -56,11 +58,9 @@ module Uspec
     def inspector
       if String === raw && raw.include?(?\n) then
         # if object is a multiline string, display it unescaped
+
         [
-          vspace,
-          hspace, yellow('"""'), newline,
-          raw, normal, newline,
-          hspace, yellow('"""')
+          raw.split(newline).unshift(newline).join(PREFIX), normal, newline,
         ].join
       else
         handler.inspector!

data/lib/uspec/version.rb

@@ -1,3 +1,3 @@
 module Uspec
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 end

data/uspec/cli_spec.rb

@@ -1,5 +1,4 @@
 require_relative 'uspec_helper'
-require 'open3'
 
 spec 'shows usage' do
   output = capture do
@@ -9,6 +8,8 @@ spec 'shows usage' do
   output.include? 'usage'
 end
 
+spec 'pending test doesn\'t crash'
+
 spec 'runs a path of specs' do
   output = capture do
     path = Pathname.new(__FILE__).parent.parent.join('example_specs').to_s

data/uspec/jump_spec.rb

@@ -0,0 +1,21 @@
+require_relative "uspec_helper"
+
+spec 'when return used in spec, capture it as an error' do
+  path =  Pathname.new(__FILE__).parent.join('test_specs', 'return_spec')
+
+  output = capture do
+    exec "bin/uspec #{path}"
+  end
+
+  output.include?('Invalid return') || output.include?('Spec did not return a boolean value') || output
+end
+
+spec 'when break used in spec, capture it as an error' do
+  path =  Pathname.new(__FILE__).parent.join('test_specs', 'break_spec')
+
+  output = capture do
+    exec "bin/uspec #{path}"
+  end
+
+  output.include?('Invalid break') || output.include?('Spec did not return a boolean value') || output
+end

data/uspec/result_spec.rb

@@ -13,7 +13,7 @@ end
 class ::TestObject < BasicObject; end
 obj = TestObject.new
 
-spec "ensure BasicObject subclasses work" do
+spec "ensure BasicObject subclass instances work" do
   result = Uspec::Result.new "BasicObject Subclass Result", obj, []
   expected = "#<BasicObject/TestObject:"
   actual =  result.pretty
@@ -22,7 +22,7 @@ end
 
 spec "display basic info about Object" do
   result = Uspec::Result.new "Object Result", Object.new, []
-  expected = "Object < BasicObject"
+  expected = "Object < BasicObject: \e[0m#<Object:"
   actual =  result.pretty
   actual.include?(expected) || result.pretty
 end
@@ -36,8 +36,7 @@ end
 
 spec "display basic info about Array class" do
   result = Uspec::Result.new "Array Class Result", Array, []
-  #expected = "Class < ???" # TODO: Make classes display nicer in TOISB
-  expected = "#<Class:Object> < #<Class:BasicObject>: \e[0mArray"
+  expected = "Class < Module: \e[0mArray Class"
   actual =  result.pretty
   actual.include?(expected) || result.pretty
 end
@@ -62,9 +61,9 @@ spec "display a useful error message when a user-defined inspect method fails" d
 end
 
 spec "display strings more like their actual contents" do
-  expected = "this string:\nshould display \e[42;2mproperly"
-  result = Uspec::Result.new "Inspect Fail Result", expected, []
+  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, []
   actual =  result.pretty
-  actual.include?(expected) || result.inspector
+  actual.match?(expected) || result.inspector
 end
-

data/uspec/test_specs/break_spec

@@ -0,0 +1,3 @@
+spec "break spec" do
+  break 12345
+end

data/uspec/test_specs/pending_spec

@@ -0,0 +1,6 @@
+
+require_relative "../uspec_helper"
+
+spec "why is this broken??"
+
+

data/uspec/test_specs/return_spec

@@ -0,0 +1,3 @@
+spec "return spec" do
+  return 12345
+end

data/uspec/test_specs/value_spec

@@ -0,0 +1,3 @@
+spec 'non-boolean value spec' do
+  "abcdef"
+end

data/uspec/uspec_helper.rb

@@ -1,3 +1,5 @@
+require 'pry'
+
 require_relative '../lib/uspec'
 extend Uspec
 
@@ -17,4 +19,3 @@ def capture
 
   output
 end
-

data/uspec/uspec_spec.rb

@@ -7,7 +7,7 @@ spec 'catches errors' do
     end
   end
 
-  output.include? 'Exception'
+  output.include?('Exception') || output
 end
 
 spec 'catches even non-StandardError-subclass exceptions' do
@@ -17,7 +17,7 @@ spec 'catches even non-StandardError-subclass exceptions' do
     end
   end
 
-  output.include? 'Exception'
+  output.include?('Exception') || output
 end
 
 spec 'complains when spec block returns non boolean' do
@@ -27,7 +27,7 @@ spec 'complains when spec block returns non boolean' do
     end
   end
 
-  output.include? 'Failed'
+  output.include?('Failed') || output
 end
 
 spec 'marks test as pending when no block supplied' do
@@ -35,7 +35,7 @@ spec 'marks test as pending when no block supplied' do
     spec 'pending test'
   end
 
-  output.include? 'pending'
+  output.include?('pending') || output
 end
 
 spec 'should not define DSL methods on arbitrary objects' do
@@ -57,11 +57,11 @@ spec 'exit code is the number of failures' do
   end
   actual = $?.exitstatus
 
-  actual == expected || puts("", output) || $?
+  actual == expected || output
 end
 
-spec 'if more than 255 failures, exit status is 255' do
-  capture do
+spec 'when more than 255 failures, exit status is 255' do
+  output = capture do
     __uspec_stats.clear_results! # because we're forking, we will have a copy of the current results
 
     500.times do
@@ -73,5 +73,5 @@ spec 'if more than 255 failures, exit status is 255' do
     exit __uspec_cli.exit_code
   end
 
-  $?.exitstatus == 255 || $?
+  $?.exitstatus == 255 || [$?, output]
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uspec
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Anthony M. Cook
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-25 00:00:00.000000000 Z
+date: 2024-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: that_object_is_so_basic
@@ -84,15 +84,20 @@ files:
 - lib/uspec/version.rb
 - uspec.gemspec
 - uspec/cli_spec.rb
+- uspec/jump_spec.rb
 - uspec/result_spec.rb
+- uspec/test_specs/break_spec
 - uspec/test_specs/broken_require_spec
+- uspec/test_specs/pending_spec
+- uspec/test_specs/return_spec
+- uspec/test_specs/value_spec
 - uspec/uspec_helper.rb
 - uspec/uspec_spec.rb
 homepage: http://github.com/acook/uspec#readme
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -107,8 +112,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
-signing_key: 
+rubygems_version: 3.5.3
+signing_key:
 specification_version: 4
 summary: a shiny little spec framework for your apps!
 test_files: []