uspec 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37c36554e93d2f086beaa00114b033946c8d7fd059ad2436b08677321087e522
-  data.tar.gz: 7b3fad4db3c6b602a338d29d98ffdfeb35b8a1f7bdf254595cb336900a623e0d
+  metadata.gz: 641541f23b26b9c14b11950c55f9161aa89142aa41b8627a9f2dcbe54ac11584
+  data.tar.gz: a02353485421133ac4fa3eb639a7942992152faee3db2f484da4da56917014d6
 SHA512:
-  metadata.gz: 79f67326d2973ecf2a29868d9630cfae54d1cbd0f8f69458d2794e695b85a40db2876331b71a14a648235e7f0b5581a93249d0b4bfa8c8acfab899112655f4ae
-  data.tar.gz: 8b4c7102bdfd0093b01c8a23bb8afd0fb098b74411d3aa9172a0c2515186456a9a925db16d51fe653a9955f1353b075b5cce5886e89df80da3ecde1a349f3b5d
+  metadata.gz: 1776508a0bc6ca4da5e90167072244305b9994b407d75fce53048bda6cad1a439adee75ecb0ddf534728f6ab6ad268a44588013a57f225df74f38a0e1c85a5c8
+  data.tar.gz: 1b39cb64033e21f466ee0a8edaea706e20589f92b3cbae80eb41e624c3dca9f24f1c376f277a7c5061f8b5d20608ea49cf1de71b9014409d4d5bc28b6d1ad702

data/README.markdown

@@ -62,12 +62,12 @@ Or install it directly with:
 Quickstart
 ----------
 
-0. Create a `spec` (or `uspec`) directory to keep your specs in.
+0. Create a `uspec` directory to keep your specs in.
 1. Name your specs ending with `_spec.rb`.
 2. Write some specs in Ruby using the `spec` method (example above).
 2. Use the included `uspec` executable to run your specs.
 
-**Hint:** A lot of people also put `require_relative 'spec_helper'` in their tests for shared code between tests.
+**Hint:** A lot of people also put `require_relative 'spec_helper'` at the top of their test files for sharing code between tests.
 
 Commandline Usage
 -----------------
@@ -78,7 +78,7 @@ uspec - minimalistic ruby testing framework
 usage: uspec [<file_or_path>...]
 ```
 
-- Without arguments the `uspec` command will automatially look for `spec` and `uspec` directories and load any `*_spec.rb` files inside them.
+- Without arguments the `uspec` command will automatially look for a `uspec` directory and load any `*_spec.rb` files inside them.
 - You can also pass in arbitrary files and it will attempt to run them as specs.
 - If you pass in directories `uspec` will scan for and run any specs inside them.
 - Uspec will return the number of failures as its status code to the commandline, 0 if none.
@@ -86,7 +86,7 @@ usage: uspec [<file_or_path>...]
 Output
 ------
 
-Wonder what Uspec looks like?
+A brief explanation of `uspec`'s output to show you what it can do!
 
 ### Success
 
@@ -158,7 +158,7 @@ When you run the test Uspec will helpfully display:
 Tips & Tricks
 -------------
 
-Because there's no matchers and only one method there's no reference documentation to look at, so here are some ideas to get you going!
+Because there's no matchers and only one method there's no need for specialized reference documentation, but here are some ideas to get you going!
 
 ### String matching
 
@@ -201,6 +201,11 @@ If there's no error, then Uspec will see the result of the method call (whatever
 If the wrong Exception is raised, then because of reraising (by just calling `raise` without parameters),
 Ruby will dutifully pass along the error for Uspec to display.
 
+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
 ----------------------
 
@@ -224,7 +229,8 @@ end
 MyFoo.new.assert
 ```
 
-If there are any specs that fail, your application will exit with an error code equal to the number of failures.
+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
@@ -251,4 +257,4 @@ Contributing
 Author
 ------
 
-> Anthony M. Cook 2013-2019
+> Anthony M. Cook 2013-2020

data/lib/uspec/result.rb

@@ -28,7 +28,7 @@ module Uspec
         ].join
       else
         [
-          red('Unknown Result'), vspace,
+          red('Failed'), vspace,
           hspace, 'Spec did not return a boolean value ', newline,
           hspace, 'in spec at ', source.first, vspace,
           hspace, red(subklassinfo), inspector, newline
@@ -52,7 +52,17 @@ module Uspec
 
     # Attempts to inspect an object
     def inspector
-      handler.inspector!
+      if String === raw && raw.include?(?\n) then
+        # if object is a multiline string, display it escaped and unescaped
+        [
+          handler.inspector!, vspace,
+          hspace, yellow('"""'), newline,
+          raw, normal, newline,
+          hspace, yellow('"""')
+        ].join
+      else
+        handler.inspector!
+      end
     rescue Exception => error
       return handler.simple_inspector if error.message.include? handler.get_id
 

data/lib/uspec/version.rb

@@ -1,3 +1,3 @@
 module Uspec
-  VERSION = '0.2.3'
+  VERSION = '0.3.0'
 end

data/uspec/cli_spec.rb

@@ -15,7 +15,7 @@ spec 'runs a path of specs' do
     Uspec::CLI.run_specs Array(path)
   end
 
-  output.include? 'I love passing tests'
+  output.include?('I love passing tests') || output
 end
 
 spec 'runs an individual spec' do
@@ -24,7 +24,7 @@ spec 'runs an individual spec' do
     Uspec::CLI.run_specs Array(path)
   end
 
-  output.include? 'I love passing tests'
+  output.include?('I love passing tests') || output
 end
 
 spec 'broken requires in test files count as test failures' do

data/uspec/result_spec.rb

@@ -17,7 +17,29 @@ spec "ensure BasicObject subclasses work" do
   result = Uspec::Result.new "BasicObject Subclass Result", obj, []
   expected = "#<BasicObject/TestObject:"
   actual =  result.pretty
-  actual.include?(expected) || result.inspector
+  actual.include?(expected) || result.pretty
+end
+
+spec "display basic info about Object" do
+  result = Uspec::Result.new "Object Result", Object.new, []
+  expected = "Object < BasicObject"
+  actual =  result.pretty
+  actual.include?(expected) || result.pretty
+end
+
+spec "display basic info about Array" do
+  result = Uspec::Result.new "Array Result", [], []
+  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, []
+  #expected = "Class < ???" # TODO: Make classes display nicer in TOISB
+  expected = "#<Class:Object> < #<Class:BasicObject>: \e[0mArray"
+  actual =  result.pretty
+  actual.include?(expected) || result.pretty
 end
 
 parent = [obj]
@@ -38,3 +60,11 @@ spec "display a useful error message when a user-defined inspect method fails" d
   actual =  result.pretty
   actual.include?(expected) || result.inspector
 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, []
+  actual =  result.pretty
+  actual.include?(expected) || result.inspector
+end
+

data/uspec/uspec_spec.rb

@@ -27,7 +27,7 @@ spec 'complains when spec block returns non boolean' do
     end
   end
 
-  output.include? 'Unknown Result'
+  output.include? 'Failed'
 end
 
 spec 'marks test as pending when no block supplied' do
@@ -45,6 +45,8 @@ end
 spec 'exit code is the number of failures' do
   expected = 50
   output = capture do
+    Uspec::Stats.clear_results! # because we're forking, we will have a copy of the current results
+
     expected.times do |count|
       spec "fail ##{count + 1}" do
         false
@@ -60,6 +62,8 @@ end
 
 spec 'if more than 255 failures, exit status is 255' do
   capture do
+    Uspec::Stats.clear_results! # because we're forking, we will have a copy of the current results
+
     500.times do
       spec 'fail' do
         false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uspec
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Anthony M. Cook
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-19 00:00:00.000000000 Z
+date: 2021-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: that_object_is_so_basic