uspec 0.2.1 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65de448e566c6f625bd228e6581a0ee78bd8811a0189e04f4588d7474201e516
-  data.tar.gz: 62ba89fc56bdd1fb21cf2709ab8441ed0ad9cbe3f5426ce1719d8c36933161d7
+  metadata.gz: 11c5e0a54306aeafdf5547c71c02c3ed64fabc60f068bff1d6d395cc1fac11b3
+  data.tar.gz: 918d6e06e01c9c0541a410d9ecc5aad0a7c7f416c0532d533f461383dfad70d4
 SHA512:
-  metadata.gz: f9353937b8b7e4b44ed2ea214fcb69ce1c0558d7774e10dedd4d071e20ad10f1fca8485e0063bacdf614d25389a9893439f4bafd0617347fd91649b85c9284d1
-  data.tar.gz: 87f381e5c1f7f715c28543f47531589ef8344266d648e729c9d6fb01d7f9bfb7a79a966b2437c7f76e8a7d995dc0d378563b819881cb8b46b92e0b5dbbccee00
+  metadata.gz: 46c2d5c8833632e28692a834c664a3947e21f8a0049133b99b409282eecaafa7d4e2ce2b6247e24bd625d8924f80634f6343c2013ce1b73789fcdd631ecd7075
+  data.tar.gz: 79fc6300bf5e09df01a0cfce23aca9514d58e571f222a0843f9e68c948a48550add600eb75fd429eefeccaeb81d48ca95cb3da2ee7f66fcb3eed3b28e962e903

data/.circleci/config.yml

@@ -0,0 +1,21 @@
+version: 2.1
+orbs:
+  ruby: circleci/ruby@0.1.2 
+
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby:2.6.3-stretch-node
+    executor: ruby/default
+    steps:
+      - checkout
+      - run:
+          name: Which bundler?
+          command: bundle -v
+      - ruby/bundle-install
+  test:
+    executor: ruby/default
+    steps:
+      - run:
+          name: Uspec tests
+          command: bundle exec uspec

data/.rubocop.yml

@@ -0,0 +1,56 @@
+# Rubocop override settings
+
+AllCops:
+  TargetRubyVersion: 2.0
+
+Metrics/LineLength:
+  Max: 120
+  Exclude:
+    - config_module.gemspec
+    - "uspec/**/*"
+
+Naming/PredicateName:
+  Enabled: false
+
+Style/PreferredHashMethods:
+  Exclude:
+    - "**/*"
+
+Style/Documentation:
+  Enabled: false
+
+Style/MethodDefParentheses:
+  Enabled: false
+
+Style/ParallelAssignment:
+  Enabled: false
+
+Style/SingleLineMethods:
+  Enabled: false
+
+Style/Alias:
+  Enabled: false
+
+Style/CaseEquality:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: false
+
+Bundler/OrderedGems:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Layout/AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+Style/EnforcedStyleForMultiline:
+  EnforcedStyle: consistent_comma
+
+Naming/RescuedExceptionsVariableName:
+  PreferredName: error

data/README.markdown

@@ -3,8 +3,9 @@ Uspec
 
 Uspec is a shiny little testing framework for your apps!
 
-[![Build Status](https://travis-ci.org/acook/uspec.png?branch=master)](https://travis-ci.org/acook/uspec)
-[![Code Climate](https://codeclimate.com/github/acook/uspec.png)](https://codeclimate.com/github/acook/uspec)
+[![Gem Version](https://img.shields.io/gem/v/uspec.svg?style=for-the-badge)](https://rubygems.org/gems/uspec/)
+[![Build Status](https://img.shields.io/circleci/build/github/acook/uspec.svg?style=for-the-badge)](https://app.circleci.com/pipelines/github/acook/uspec)
+[![Code Climate](https://img.shields.io/codeclimate/maintainability/acook/uspec.svg?style=for-the-badge)](https://codeclimate.com/github/acook/uspec)
 
 Philosophy / Why Uspec?
 -----------------------
@@ -61,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
 -----------------
@@ -77,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.
@@ -85,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
 
@@ -157,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
 
@@ -200,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
 ----------------------
 
@@ -223,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
@@ -250,4 +257,4 @@ Contributing
 Author
 ------
 
-> Anthony M. Cook 2013-2019
+> Anthony M. Cook 2013-2020

data/bin/uspec

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
 
 require_relative '../lib/uspec/cli'
-Uspec::CLI.invoke ARGV
+Uspec::CLI.new(ARGV).invoke

data/lib/uspec.rb

@@ -8,15 +8,10 @@ module Uspec
     exit 2
   end
 
+  # this method used to be how we injected the spec method
   def self.extended object
-    object.extend Uspec::DSL
+    #unless object.respond_to? :spec
+    #  object.extend Uspec::DSL
+    #end
   end
 end
-
-at_exit do
-  failures = Uspec::Stats.exit_code
-  status = $!.respond_to?(:status) ? $!.status : 0
-  errors = $!.respond_to?(:cause) && $!.cause ? 1 : 0
-  code = [failures, status, errors].max
-  exit code
-end

data/lib/uspec/cli.rb

@@ -2,29 +2,34 @@ require 'pathname'
 require_relative '../uspec'
 
 class Uspec::CLI
-  class << self
-    def usage
-      warn "uspec v#{::Uspec::VERSION} - minimalistic ruby testing framework"
-      warn "usage: #{File.basename $0} [<file_or_path>...]"
-    end
+  def initialize args
+    usage unless (args & %w[-h --help -? /? -v --version]).empty?
 
-    def run_specs paths
-      uspec_cli = self.new paths
-      uspec_cli.run_paths
-    end
+    @paths = args
+    @pwd = Pathname.pwd.freeze
+    @stats = Uspec::Stats.new
+    @dsl = Uspec::DSL.new self
+  end
+  attr :stats, :dsl
 
-    def invoke args
-      if (args & %w[-h --help -? /? -v --version]).empty? then
-        run_specs args
-      else
-        usage
-      end
-    end
+  def usage
+    warn "uspec v#{::Uspec::VERSION} - minimalistic ruby testing framework"
+    warn "usage: #{File.basename $0} [<file_or_path>...]"
+    exit 1
   end
 
-  def initialize paths
-    @paths = paths
-    @pwd = Pathname.pwd.freeze
+  def run_specs
+    run_paths
+  end
+
+  def invoke
+    run_specs
+    puts @stats.summary
+    exit exit_code
+  end
+
+  def exit_code
+    [@stats.failure.size, 255].min
   end
 
   def paths
@@ -51,7 +56,7 @@ class Uspec::CLI
       end
     elsif path.exist? then
       puts "#{path.basename path.extname}:"
-      Uspec::DSL.instance_eval(path.read, path.to_s)
+      dsl.instance_eval(path.read, path.to_s)
     else
       warn "path not found: #{path}"
     end
@@ -74,7 +79,7 @@ class Uspec::CLI
     MSG
     puts
     warn message
-    Uspec::Stats.results << Uspec::Result.new(message, error, caller)
+    stats.failure << Uspec::Result.new(message, error, caller)
   end
 
 end

data/lib/uspec/dsl.rb

@@ -1,23 +1,42 @@
 require_relative "result"
 
 module Uspec
-  module DSL
-    module_function
-    def spec description
-      terminal = Uspec::Terminal
+  class DSL
+    def initialize cli
+      @__uspec_cli = cli
+    end
 
-      print ' -- ', description
+    def __uspec_cli
+      @__uspec_cli
+    end
 
-      return print(': ' + terminal.yellow('pending') + terminal.newline) unless block_given?
+    def __uspec_stats
+      @__uspec_cli.stats
+    end
 
-      begin
-        raw_result = yield
-      rescue => raw_result
+    def spec description
+      print ' -- ', description
+
+      if block_given? then
+        begin
+          raw_result = yield
+        rescue Exception => raw_result
+        end
       end
 
       result = Result.new description, raw_result, caller
 
-      Uspec::Stats.results << result
+      unless block_given? then
+        result.pending!
+      end
+
+      if result.success?
+        __uspec_stats.success << result
+      elsif result.pending?
+        stats.pending << result
+      else
+        __uspec_stats.failure << result
+      end
 
       print ': ', result.pretty, "\n"
     rescue => error
@@ -30,7 +49,7 @@ module Uspec
       MSG
       puts
       warn message
-      Uspec::Stats.results << Uspec::Result.new(message, error, caller)
+      __uspec_stats.failure << Uspec::Result.new(message, error, caller)
     end
   end
 end

data/lib/uspec/result.rb

@@ -1,4 +1,5 @@
 require_relative "terminal"
+require "toisb"
 
 module Uspec
   class Result
@@ -8,14 +9,17 @@ module Uspec
       @spec = spec
       @raw = raw
       @source = source
+      @handler = ::TOISB.wrap raw
     end
-    attr_reader :spec, :raw, :source
+    attr_reader :spec, :raw, :source, :handler
 
     def pretty
       if raw == true then
         green raw
       elsif raw == false then
         red raw
+      elsif pending? then
+        yellow 'pending'
       elsif Exception === raw then
         [
           red('Exception'), vspace,
@@ -26,10 +30,10 @@ 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(klassinfo), inspector, newline
+          hspace, red(subklassinfo), inspector, newline
         ].join
       end
     end
@@ -41,18 +45,28 @@ module Uspec
     end
 
     def message
-      "#{red klassinfo}#{raw.message}"
+      "#{red subklassinfo}#{raw.message}"
     end
 
-    def klassinfo
-      superklass ? "#{klass} < #{superklass}: " : "#{klass}: "
+    def subklassinfo
+      "#{handler.subklassinfo}: "
     end
 
     # Attempts to inspect an object
     def inspector
-      klass && klass.public_method_defined?(:inspect) ? raw.inspect : "#<#{klass}:0x#{get_id}>"
+      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('"""')
+        ].join
+      else
+        handler.inspector!
+      end
     rescue Exception => error
-      return "#<#{klass}:0x#{get_id}>" if error.message.include? get_id
+      return handler.simple_inspector if error.message.include? handler.get_id
 
       error_file, error_line, _ = error.backtrace[4].split ?:
 
@@ -74,38 +88,20 @@ module Uspec
       MSG
     end
 
-    # Returns the class of the object if it isn't already a class
-    def klass
-      Module === raw ? raw : ancestor_klasses[1]
-    end
-
-    # Returns the superclass of the object
-    def superklass
-      ancestor_klasses[2]
-    end
-
-    # Gets the object ID of an object
-    def get_id
-      raw.__id__.to_s(16) rescue 0
-    end
-
-    # Obtain the singleton class of an object
-    def singleton
-      @singleton ||= (class << raw; self; end) rescue raw.class
+    def success?
+      raw == true
     end
 
-    def ancestor_klasses
-      @ancestor_klasses ||= ancestors.select{|a| a.is_a? Class}
+    def failure?
+      raw != true && !@pending
     end
 
-    # Collects the ancestors of an object
-    def ancestors
-      @ancestors ||= safe_send singleton, :ancestors
+    def pending?
+      !!@pending
     end
 
-    # Works around BasicObject and other objects that are missing/overwrite important methods
-    def safe_send object, method, *args, &block
-      (Module === object ? Module : Object).instance_method(method).bind(object).call(*args, &block)
+    def pending!
+      @pending = true
     end
 
     def inspect

data/lib/uspec/stats.rb

@@ -1,30 +1,36 @@
 module Uspec
   class Stats
-    class << self
-      def results?
-        !results.empty?
-      end
-
-      def results
-        @results ||= clear_results!
-      end
-
-      def clear_results!
-        @results = Array.new
-      end
+    def initialize
+      clear_results!
+    end
+    attr :success, :failure, :pending
 
-      def exit_code
-        # checking for truthy isn't good enough, it must be exactly true!
-        failures = results.count{|result| result.raw != true }
-        failures > 255 ? 255 : failures
-      end
+    def clear_results!
+      @success = Array.new
+      @failure = Array.new
+      @pending = Array.new
+    end
 
-      def inspect
-        <<-INFO
+    def inspect
+      <<-INFO
         #{super} Failures: #{exit_code}
         #{results.map{|r| r.inspect}.join "\n\t" }
-        INFO
-      end
+      INFO
+    end
+
+    def results
+      @success + @failure + @pending
+    end
+
+    def summary
+      [
+        "test summary: ",
+        Uspec::Terminal.green("#{@success.size} successful"),
+        ", ",
+        Uspec::Terminal.red("#{@failure.size} failed"),
+        ", ",
+        Uspec::Terminal.yellow("#{@pending.size} pending")
+      ].join
     end
   end
 end

data/lib/uspec/version.rb

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

data/uspec.gemspec

@@ -22,6 +22,8 @@ Gem::Specification.new do |gem|
   # technically should still work in 2.0 but some of the test suite won't pass
   gem.required_ruby_version = ">= 2.1"
 
+  gem.add_dependency "that_object_is_so_basic", "~> 0.0.5"
+
   gem.add_development_dependency "pry"
   gem.add_development_dependency "pry-doc"
 end

data/uspec/cli_spec.rb

@@ -12,19 +12,19 @@ end
 spec 'runs a path of specs' do
   output = capture do
     path = Pathname.new(__FILE__).parent.parent.join('example_specs').to_s
-    Uspec::CLI.run_specs Array(path)
+    Uspec::CLI.new(Array(path)).run_specs
   end
 
-  output.include? 'I love passing tests'
+  output.include?('I love passing tests') || output
 end
 
 spec 'runs an individual spec' do
   output = capture do
     path =  Pathname.new(__FILE__).parent.parent.join('example_specs', 'example_spec.rb').to_s
-    Uspec::CLI.run_specs Array(path)
+    Uspec::CLI.new(Array(path)).run_specs
   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

@@ -15,9 +15,31 @@ obj = TestObject.new
 
 spec "ensure BasicObject subclasses work" do
   result = Uspec::Result.new "BasicObject Subclass Result", obj, []
-  expected = "#<TestObject:"
+  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]
@@ -29,12 +51,20 @@ spec "ensure parent object of BasicObject subclasses get a useful error message"
   actual.include?(expected) || result.inspector
 end
 
-class ::InspectFail; def inspect; raise; end; end
+class ::InspectFail; def inspect; raise RuntimeError, "This error is intentional and part of the test."; end; end
 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, []
-  expected = "raises an error"
+  expected = "raises an exception"
   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

@@ -10,6 +10,16 @@ spec 'catches errors' do
   output.include? 'Exception'
 end
 
+spec 'catches even non-StandardError-subclass exceptions' do
+  output = capture do
+    spec 'not implemented error' do
+      raise ::NotImplementedError, 'test exception'
+    end
+  end
+
+  output.include? 'Exception'
+end
+
 spec 'complains when spec block returns non boolean' do
   output = capture do
     spec 'whatever' do
@@ -17,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
@@ -35,13 +45,15 @@ 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
       end
     end
 
-    puts(Uspec::Stats.inspect) unless Uspec::Stats.exit_code == expected
+    exit __uspec_cli.exit_code
   end
   actual = $?.exitstatus
 
@@ -50,11 +62,15 @@ 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
       end
     end
+
+    exit __uspec_cli.exit_code
   end
 
   $?.exitstatus == 255 || $?

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: uspec
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 1.0.1
 platform: ruby
 authors:
 - Anthony M. Cook
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-17 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
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.5
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -48,11 +62,12 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".editorconfig"
 - ".gitignore"
+- ".rubocop.yml"
 - ".ruby-gemset"
 - ".ruby-version"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.markdown

data/.travis.yml

@@ -1,31 +0,0 @@
-language: ruby
-
-rvm:
-  - 2.6.3
-  - 2.5.5
-  - 2.4.6
-  - 2.3.8
-  - 2.2.10
-  - 2.1.10
-  
-  - 2.0.0
-  - 1.9.3
-  - 1.9.2
-  - jruby-19mode
-  - ruby-head
-
-before_install:
-  - gem update bundler
-before_script:
-  - bundle exec gem list
-script: bundle exec uspec
-
-matrix:
-  allow_failures:
-    - rvm: 2.0.0
-    - rvm: 1.9.3
-    - rvm: 1.9.2
-    - rvm: ruby-head
-    - rvm: jruby-19mode
-
-sudo: false