uspec 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 659b5228eb82a76f457af1da9a275cfdcc5914f03d40083fdca08f79c8b1fac6
-  data.tar.gz: d89c4ee71c95dc202adf14110a140f9f4d667698f0e8b443a884226b6881e57d
+  metadata.gz: b9c8a47af991d099f6804066c5ef9e2d8ac0c4cca8023a919354bc247ee3d901
+  data.tar.gz: 14e4c49e40bf1a2cf19553b41c27107c7d13f110978dad55d951242a2e86fcc6
 SHA512:
-  metadata.gz: 021b318bd832f4c5f290db67bca30a05e8e545fcc9b633506ab63ce2dc55cf53389885bc42d956e007f76d44245817aaa915f35f940b514eca43cbde32cc0c2a
-  data.tar.gz: 44f6373981caa474dbb6df5f48f9fcf38c9fc3d59f680e6198940f758c098f4157ce30dc6ad13294cb3bca99c7f659ca60395d5760b11830905144368ef5a8b0
+  metadata.gz: b1781f78237157872c0ad40f5c009a4dbed94b78049973feb164f49ea3c042dbcc022ec80d423ee5d69a0d0ca3f0d48dfe4e81a227848500a3af1466c15e015e
+  data.tar.gz: 3ecaada229d7bc0ee4a0c3d473654c5544863c11dd390cde47e8e08d25205a5bfe8175de8b96a1a4f93aa9b499b119d702bc8f4723a1aa371b5b134e1af7d371

data/Gemfile

@@ -2,3 +2,10 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in uspec.gemspec
 gemspec
+
+unless ENV['CI'] then
+  gem 'pry'
+  gem 'pry-doc'
+  gem 'pry-theme'
+  gem 'pry-coolline'
+end

data/lib/uspec/cli.rb

@@ -24,14 +24,32 @@ class Uspec::CLI
 
   def invoke
     run_specs
-    puts @stats.summary
-    exit exit_code
+    die!
   end
 
   def exit_code
     [@stats.failure.size, 255].min
   end
 
+  def handle_interrupt! type = Interrupt
+    if SignalException === type || SystemExit === type then
+      if type === Module then
+        err = type
+        msg = "signal"
+      else
+        err = type.class
+        msg = type.message
+      end
+      puts "Uspec received #{err} #{msg} - exiting!"
+      die!
+    end
+  end
+
+  def die!
+    puts @stats.summary
+    exit exit_code
+  end
+
   def paths
     if @paths.empty? then
       ['spec', 'uspec', 'test'].each do |path|
@@ -62,6 +80,10 @@ class Uspec::CLI
     end
   rescue Exception => error
 
+    if SignalException === error || SystemExit === error then
+      exit 3
+    end
+
     error_file, error_line, _ = error.backtrace.first.split ?:
 
     message = <<-MSG
@@ -80,6 +102,8 @@ class Uspec::CLI
     puts
     warn message
     stats.failure << Uspec::Result.new(message, error, caller)
+
+    dsl.__uspec_cli.handle_interrupt! error
   end
 
 end

data/lib/uspec/dsl.rb

@@ -1,10 +1,8 @@
 require_relative "result"
+require_relative "spec"
 
 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
@@ -18,25 +16,6 @@ module Uspec
       @__uspec_cli.stats
     end
 
-    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
-      self.instance_variables.each do |name|
-        o.instance_variable_set(name, self.instance_variable_get(name)) unless name.to_s.include? '@__uspec'
-      end
-      self.methods(false).each do |name|
-        o.define_singleton_method name do |*args, &block|
-          @__uspec_dsl.send name, *args, &block
-        end unless name.to_s.include? '__uspec'
-      end
-      o.spec_block
-    end
-
     def spec description, &block
       state = 0
       print ' -- ', description
@@ -44,7 +23,7 @@ module Uspec
       if block then
         begin
           state = 1
-          raw_result = __uspec_eval block
+          raw_result = ::Uspec::Spec.new(self, description, &block).__uspec_block
           state = 2
         rescue Exception => raw_result
           state = 3
@@ -80,6 +59,7 @@ module Uspec
       warn message
       __uspec_stats.failure << Uspec::Result.new(message, error, caller)
     ensure
+      __uspec_cli.handle_interrupt! result.raw
       return [state, error, result, raw_result]
     end
   end

data/lib/uspec/spec.rb

@@ -0,0 +1,33 @@
+require_relative "result"
+
+module Uspec
+  class Spec
+
+    def initialize dsl, description, &block
+      @__uspec_description = description
+      @__uspec_dsl = dsl
+
+      dsl.instance_variables.each do |name|
+        self.instance_variable_set(name, @__uspec_dsl.instance_variable_get(name)) unless name.to_s.include? '@__uspec'
+      end
+
+      dsl.methods(false).each do |name|
+        self.define_singleton_method name do |*args, &block|
+          @__uspec_dsl.send name, *args, &block
+        end unless name.to_s.include? '__uspec'
+      end
+
+      if block then
+      self.define_singleton_method :__uspec_block, &block
+      else
+        self.define_singleton_method :__uspec_block do
+          raise "Uspec: No block provided for `#{@__uspec_description}`"
+        end
+      end
+    end
+
+    def spec description, &block
+      @__uspec_dsl.spec description, &block
+    end
+  end
+end

data/lib/uspec/stats.rb

@@ -11,13 +11,6 @@ module Uspec
       @pending = Array.new
     end
 
-    def inspect
-      <<-INFO
-        #{super} Failures: #{exit_code}
-        #{results.map{|r| r.inspect}.join "\n\t" }
-      INFO
-    end
-
     def results
       @success + @failure + @pending
     end

data/lib/uspec/version.rb

@@ -1,3 +1,3 @@
 module Uspec
-  VERSION = '1.1.2'
+  VERSION = '1.2.0'
 end

data/uspec/cli_spec.rb

@@ -8,8 +8,6 @@ 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
@@ -47,3 +45,37 @@ spec 'displays information about test file with broken require' do
 
   output.include?('cannot load such file') || output
 end
+
+spec 'exit code is the number of failures' do
+  expected = 50
+  output = capture do
+    @__uspec_dsl.__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
+
+    exit @__uspec_dsl.__uspec_cli.exit_code
+  end
+  actual = $?.exitstatus
+
+  actual == expected || output
+end
+
+spec 'when more than 255 failures, exit status is 255' do
+  output = capture do
+    @__uspec_dsl.__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_dsl.__uspec_cli.exit_code
+  end
+
+  $?.exitstatus == 255 || [$?, output]
+end

data/uspec/dsl_spec.rb

@@ -1,5 +1,88 @@
 require_relative "uspec_helper"
 
+spec 'catches errors' do
+  output = capture do
+    spec 'exception' do
+      raise 'test exception'
+    end
+  end
+
+  output.include?('Exception') || output
+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') || output
+end
+
+spec 'Uspec exits when sent a termination signal' do
+  path =  Pathname.new(__FILE__).parent.join('test_specs', 'kill_this_spec')
+
+  stdin, allout, thread = Open3.popen2e "uspec/test_specs/kill_this_script.sh \"#{path}\""
+  stdin.close
+  output = allout.read
+
+  begin
+    Process.waitpid(thread.pid)
+  rescue Errno::ECHILD
+    nil
+  end
+
+  summary_match = output.match(/0.*successful.*,.*1.*failed.*,.*0.*pending/)
+  no_copy_match = output.match(/2.{0,5}pending/) # previous versions continued after "exiting"
+
+  (!!summary_match && !no_copy_match) || output
+end
+
+spec 'complains when spec block returns non boolean' do
+  output = capture do
+    spec 'whatever' do
+      "string"
+    end
+  end
+
+  output.include?('Failed') || output
+end
+
+spec 'marks test as pending when no block supplied' do
+  path =  Pathname.new(__FILE__).parent.join('test_specs', 'pending_spec')
+
+  output = capture do
+    exec "bin/uspec #{path}"
+  end
+
+  output.include?('1 pending') || output
+end
+
+spec 'should not define DSL methods on arbitrary objects' do
+  !(Array.respond_to? :spec)
+end
+
+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
+
 spec 'when instance variables are defined in the DSL instance, they are available in the spec body' do
   path =  Pathname.new(__FILE__).parent.join('test_specs', 'ivar_spec')
 

data/uspec/stats_spec.rb

@@ -0,0 +1,12 @@
+require_relative 'uspec_helper'
+
+spec 'stats can be inspected' do
+  actual = @__uspec_dsl.__uspec_stats.inspect
+  actual.include?("failure") || actual
+end
+
+spec 'stats inspect does not have any stray whitespace' do
+  output = @__uspec_dsl.__uspec_stats.inspect
+  match = output.match(/  |\n/)
+  match == nil
+end

data/uspec/test_specs/kill_this_script.sh

@@ -0,0 +1,27 @@
+#!/usr/bin/env sh
+
+command_exists() { command -v "$1" 1>&- 2>&-; }
+
+THISDIR="$(realpath "$(dirname "$0")")"
+ROOTDIR="$(realpath "$THISDIR/../..")"
+
+path="$1"
+name="$(basename "$path")"
+
+if ! [ -f "$path" ]; then
+  echo "file not found: $path"
+  exit 255
+fi
+
+mkdir -v -p tmp
+if command_exists bundle; then
+  bundle exec "$ROOTDIR/bin/uspec" "$path" > "tmp/$name.output" 2>&1 &
+else
+  "$ROOTDIR/bin/uspec" "$path" > "tmp/$name.output" 2>&1 &
+fi
+
+pid=$!
+sleep 1
+kill $pid
+cat "tmp/$name.output"
+rm -v "tmp/$name.output"

data/uspec/test_specs/kill_this_spec

@@ -0,0 +1,8 @@
+spec 'nap time, i sure hope no one kills me in my sleep' do
+  sleep 10
+  true
+end
+
+spec 'how did we get here?'
+
+spec 'something probably went wrong'

data/uspec/test_specs/pending_spec

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

data/uspec/uspec_helper.rb

@@ -1,4 +1,9 @@
-require 'pry'
+begin
+  require 'pry'
+rescue LoadError => err
+  nil
+end
+require 'open3'
 
 require_relative '../lib/uspec'
 extend Uspec

data/uspec/uspec_spec.rb

@@ -1,77 +1 @@
 require_relative 'uspec_helper'
-
-spec 'catches errors' do
-  output = capture do
-    spec 'exception' do
-      raise 'test exception'
-    end
-  end
-
-  output.include?('Exception') || output
-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') || output
-end
-
-spec 'complains when spec block returns non boolean' do
-  output = capture do
-    spec 'whatever' do
-      "string"
-    end
-  end
-
-  output.include?('Failed') || output
-end
-
-spec 'marks test as pending when no block supplied' do
-  output = capture do
-    spec 'pending test'
-  end
-
-  output.include?('pending') || output
-end
-
-spec 'should not define DSL methods on arbitrary objects' do
-  !(Array.respond_to? :spec)
-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
-
-    exit __uspec_cli.exit_code
-  end
-  actual = $?.exitstatus
-
-  actual == expected || output
-end
-
-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
-      spec 'fail' do
-        false
-      end
-    end
-
-    exit __uspec_cli.exit_code
-  end
-
-  $?.exitstatus == 255 || [$?, output]
-end

data/uspec.gemspec

@@ -22,8 +22,5 @@ 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"
+  gem.add_dependency "that_object_is_so_basic", ">= 0.0.5"
 end

metadata

@@ -1,57 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: uspec
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
 platform: ruby
 authors:
 - Anthony M. Cook
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-20 00:00:00.000000000 Z
+date: 2024-02-22 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
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry-doc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.5
 description: Uspec is a shiny little spec framework for your apps! Unlike other testing
   frameworks there's no need for matchers, there can only be one assertion per test,
   and you never have to worry that your tests lack assertions.
@@ -79,17 +51,20 @@ files:
 - lib/uspec/cli.rb
 - lib/uspec/dsl.rb
 - lib/uspec/result.rb
+- lib/uspec/spec.rb
 - lib/uspec/stats.rb
 - lib/uspec/terminal.rb
 - lib/uspec/version.rb
 - uspec.gemspec
 - uspec/cli_spec.rb
 - uspec/dsl_spec.rb
-- uspec/jump_spec.rb
 - uspec/result_spec.rb
+- uspec/stats_spec.rb
 - uspec/test_specs/break_spec
 - uspec/test_specs/broken_require_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

data/uspec/jump_spec.rb

@@ -1,21 +0,0 @@
-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