blackstart 0.5.0 → 0.9.0

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/{README.txt → README}

@@ -2,8 +2,9 @@ Blackstart
 
 Blackstart is a small, subdued library for automated testing in Ruby. It
 doesn't depend on anything beyond the Ruby platform and doesn't modify the
-environment beyond its conventional namespace. It's tested with a primitive
-program, not via an automated-testing library.
+environment beyond its conventional namespace. The program that tests it is
+written in primitive Ruby, with no other testing library, so it can be verified
+straightforwardly.
 
 The blackstart is a small, subdued bird that eats bugs. A black start is when
 an inactive power plant restarts by means of an independent power source rather
@@ -14,13 +15,13 @@ Here's an example of a test program that uses Blackstart:
   require "blackstart"
 
   exit Blackstart.run [
-    proc {
+    lambda {
       unless "Hello, World!" == ["He", "", "o, Wor", "d!"].join("l")
         raise "join did not work as expected"
       end
     },
 
-    proc {
+    lambda {
       unless "sample" == "simple".gsub(/i/, "a")
         raise "gsub did not work as expected"
       end
@@ -41,14 +42,29 @@ calling it in the context of a new instance of Blackstart::Scratchpad; if and
 only if this raises an error (any exception that's a kind of StandardError),
 Blackstart.run interprets it as a failed test.
 
-After each test failure, Blackstart.run sends a puts message with failure
-information to its second parameter, which is $stdout by default. The failure
-information includes a description of the test (the test object converted to a
-string) and a description of the error raised (its class, message, and
-backtrace).
+After each test failure, Blackstart.run sends a puts message to the output
+stream -- its second parameter, which is $stdout by default -- with seven
+positional arguments: (1) "FAILED TEST:", (2) the test object converted to a
+string, (3) "...ERROR:", (4) the error's class converted to a string, (5) the
+error converted to a string, (6) the error's backtrace array or an empty array
+if it has no backtrace, and (7) an empty string. With the standard output
+stream, a failure produces output resembling this:
 
-The library provides little beyond this, but it's easy to do sophisticated
-things with it. Some examples follow.
+  FAILED TEST:
+  #<Proc:0x0000000fe2e010@test.rb:4 (lambda)>
+  ...ERROR:
+  RuntimeError
+  join did not work as expected
+  test.rb:6:in `block in <main>'
+  [more backtrace lines]
+  [blank line]
+
+If a test raises a non-StandardError exception, Blackstart.run interprets it as
+a system-level event or fundamental problem: it immediately raises the
+exception and doesn't run any more tests.
+
+The library provides little beyond this, but it supports more sophisticated
+uses. Some examples follow.
 
 
 - Exiting with the appropriate status
@@ -104,8 +120,8 @@ Blackstart::Scratchpad#instance_exec. For example:
     end
   end
 
-Use this hack with care because the test proc could send instance_exec messages
-to self.
+Use this technique with care because the test proc could send instance_exec
+messages to self.
 
 
 - Building a test collection in stages
@@ -118,7 +134,7 @@ can be done straightforwardly:
   TESTS = []
 
   TESTS.concat [
-    proc {
+    lambda {
       unless "Hello, World!" == ["He", "", "o, Wor", "d!"].join("l")
         raise "join did not work as expected"
       end
@@ -126,7 +142,7 @@ can be done straightforwardly:
   ]
 
   TESTS.concat [
-    proc {
+    lambda {
       unless "sample" == "simple".gsub(/i/, "a")
         raise "gsub did not work as expected"
       end
@@ -174,3 +190,13 @@ stream is $stdout, so the default behavior is to print unadorned failure
 information to standard output. But you can specify any object as the output
 stream -- even if it's not really a stream -- allowing you to handle failure
 information however you want.
+
+
+- Running multiple tests at the same time
+
+Although Blackstart.run is written in a sequential style, it can run multiple
+tests at the same time. Blackstart.run sends an each message with a block to
+your test collection, expecting the block to be executed once for each test;
+your test collection can execute the block in multiple threads concurrently.
+For your program to work well in this mode, your tests and the output stream
+must work correctly when used from multiple threads.

data/lib/blackstart.rb

@@ -3,28 +3,6 @@
 
 module Blackstart
 
-  ##
-  # Yields to the block and returns a string describing the error raised, if
-  # any.
-  #
-  # In detail: This method yields to the block with no arguments. If that
-  # raises an error -- meaning an exception whose class is StandardError or a
-  # descendant of StandardError -- this method attempts to make and return a
-  # string describing that error; the description consists of the error's
-  # class, message, and backtrace (if any). If an exception is raised while
-  # making an error description, this method raises that exception. If
-  # yielding to the block raises a non-error exception, this method raises that
-  # exception. If yielding to the block does not raise an exception, this
-  # method returns nil.
-
-  def self.vet
-    yield
-    nil
-  rescue ::StandardError
-    # Like IO#puts, separate lines with a line feed character rather than $\.
-    ["#{$!.class}: #{$!.message}"].concat($!.backtrace || []).join "\n"
-  end
-
   ##
   # A class for tests' disposable helper objects.
 
@@ -40,36 +18,49 @@ module Blackstart
   # test object in the sequence with that test object as the first argument.
   # Each test involves creating a new scratchpad -- an instance of
   # Blackstart::Scratchpad -- and sending an instance_exec message to it with
-  # the test object as a block argument, which converts the test object to a
-  # proc via to_proc if it's not already a proc. The resulting proc is called
-  # with no arguments; the self object is set to the scratchpad. A failure is
-  # when the test (which includes any initial conversion to a proc) raises an
-  # error: an exception whose class is StandardError or a descendant of
+  # the test object as the block, which converts the test object to a proc via
+  # to_proc if it's not already a proc. The resulting proc is called with no
+  # arguments and no block; the self object is set to the scratchpad. A failure
+  # is when the test (which includes any initial conversion to a proc) raises
+  # an error: an exception whose class is StandardError or a descendant of
   # StandardError. After a failure, this method sends a puts message to the
-  # output stream, ostream, with these arguments (positional, in order): a
-  # string "FAILED TEST:"; the test object converted to a string via to_s; a
-  # string "...ERROR:"; a string combining the class, message, and backtrace of
-  # the error; and an empty string. If a test raises a non-error exception,
-  # this method immediately raises that exception. After it has run all the
-  # tests and handled any failures, this method returns false if there were
-  # failures, true otherwise. This method immediately raises any exception
-  # raised outside of a test.
+  # output stream, ostream, with no block and these arguments (positional, in
+  # order): a string "FAILED TEST:"; the test object converted to a string via
+  # to_s; a string "...ERROR:"; the error's class converted to a string via
+  # to_s; the error converted to a string via to_s; the error's backtrace or an
+  # empty array if the error signals that it has no backtrace; and an empty
+  # string. It ignores the object returned by the output stream and continues
+  # running tests. If a test raises a non-error exception, this method
+  # immediately raises that exception. If a test does not raise an exception,
+  # this method interprets it as a successful test; it ignores the object
+  # returned by the test and continues running tests. Whether the test fails
+  # or succeeds, the block sent with the each message returns nil. After it
+  # has run all the tests and handled any failures, this method returns false
+  # if there were failures, true otherwise. This method immediately raises any
+  # exception raised outside of a test.
   #
   # By default, ostream is $stdout.
 
   def self.run source, ostream = $stdout
-    success = true
+    no_failures = true
     source.each do |tst|
-      # Create the scratchpad outside the vet block so that this method will
+      # Create the scratchpad outside the begin block so that this method will
       # raise any exception that results instead of potentially treating it as
       # a test failure.
-      scratchpad = Scratchpad.new
-      if err_desc = vet { scratchpad.instance_exec(&tst) }
-        success = false
-        ostream.puts "FAILED TEST:", tst.to_s, "...ERROR:", err_desc.to_s, ""
+      scratchpad = ::Blackstart::Scratchpad.new
+      begin
+        scratchpad.instance_exec(&tst)
+      rescue ::StandardError => e
+        no_failures = false
+        ostream.puts "FAILED TEST:", tst.to_s, "...ERROR:", e.class.to_s,
+          e.to_s, e.backtrace || [], ""
       end
+      # Always return nil so that an each that's been modified to be sensitive
+      # to the block's return value can't behave differently based on the
+      # objects returned by the tests and the output stream.
+      nil
     end
-    success
+    no_failures
   end
 
 end

data/sig/blackstart.rbs

@@ -0,0 +1,17 @@
+module Blackstart
+  class Scratchpad
+  end
+
+  type test_proc = ^() [self: Scratchpad] -> void
+  interface _ConvertsToTestProc
+    def to_proc: () -> test_proc
+  end
+  type test = (test_proc | _ConvertsToTestProc) & ::_ToS
+
+  interface _OutputStream
+    def puts: (::String, ::String, ::String, ::String, ::String,
+      ::Array[::String], ::String) -> void
+  end
+
+  def self.run: (::_Each[test], ?_OutputStream) -> bool
+end

data/test/blackstart_test.rb

@@ -1,104 +1,30 @@
 # Sections that create local variables are in class definitions so that later
 # sections cannot accidentally reference those local variables.
 
+# Kernel#fail is an alias of Kernel#raise, so they do the same thing. However,
+# they are used differently in this file: Kernel#fail is used only for
+# assertions and Kernel#raise is used otherwise. Assertions always pass a
+# string argument so that a new RuntimeError is raised. Kernel#fail with no
+# arguments re-raises the current exception ($!) or, if there is none, raises a
+# new RuntimeError. This would be fine (that is, it would raise a new
+# RuntimeError) sometimes, but not always (not in a rescue clause, for
+# example). Always using Kernel#fail with a string argument makes assertions
+# consistent and avoids this subtle error.
+
+# Constant references in blocks are fully qualified because this program must
+# run correctly on a wide range of Ruby versions, including those in the 1.9.1
+# and 1.9.2 branches. Ruby 1.9.1 and 1.9.2 used constant-lookup rules in
+# certain situations that differed from those of earlier and later branches of
+# Ruby.
+
 require "blackstart"
 
 # Blackstart should be a module.
 fail "" unless Module.equal? Blackstart.class
 
-# Blackstart should say it responds to vet and run.
-fail "" unless Blackstart.respond_to? :vet
+# Blackstart should say it responds to run.
 fail "" unless Blackstart.respond_to? :run
 
-# Test Blackstart.vet:
-
-# Blackstart.vet should raise an exception if any non-block arguments are sent.
-begin
-  Blackstart.vet nil
-rescue ArgumentError
-else
-  fail ""
-end
-begin
-  Blackstart.vet(nil) {}
-rescue ArgumentError
-else
-  fail ""
-end
-
-# If yielding to the block raises an error, Blackstart.vet should return a
-# string describing that error.
-class ::Object
-  # Should return an error description when no block is given.
-  fail "" unless String.equal? Blackstart.vet.class
-
-  # Use frozen strings and backtrace arrays so that an exception will be raised
-  # if they're modified.
-
-  e_class = Class.new StandardError
-  def e_class.to_s
-    "FakeError".freeze
-  end
-
-  e_nil = e_class.new "a".freeze
-  def e_nil.backtrace
-    nil
-  end
-  error = Blackstart.vet { ::Kernel.raise e_nil }
-  fail "" unless String.equal? error.class
-  fail "" unless "FakeError: a" == error
-
-  e_empty = e_class.new "b".freeze
-  def e_empty.backtrace
-    [].freeze
-  end
-  error = Blackstart.vet { ::Kernel.raise e_empty }
-  fail "" unless String.equal? error.class
-  fail "" unless "FakeError: b" == error
-
-  e_full = e_class.new "c".freeze
-  def e_full.backtrace
-    ["d".freeze, "e".freeze].freeze
-  end
-  error = Blackstart.vet { ::Kernel.raise e_full }
-  fail "" unless String.equal? error.class
-  fail "" unless "FakeError: c\nd\ne" == error
-end
-
-# If yielding to the block raises an error and that error raises an exception
-# when queried, Blackstart.vet should raise that second exception.
-class ::Object
-  e1 = StandardError.new
-  e2_class = Class.new StandardError
-  e1.instance_variable_set :@next_exception_class, e2_class
-  def e1.message
-    ::Kernel.raise @next_exception_class
-  end
-  begin
-    Blackstart.vet { ::Kernel.raise e1 }
-  rescue e2_class
-  else
-    fail ""
-  end
-end
-
-# If yielding to the block raises a non-StandardError exception, Blackstart.vet
-# should raise it.
-class ::Object
-  non_standard_error = Class.new Exception
-  begin
-    Blackstart.vet { ::Kernel.raise non_standard_error }
-  rescue non_standard_error
-  else
-    fail ""
-  end
-end
-
-# If yielding to the block does not raise an exception, Blackstart.vet should
-# return nil. The object returned shouldn't matter.
-fail "" unless nil.equal? Blackstart.vet { nil }
-fail "" unless nil.equal? Blackstart.vet { true }
-
 # Test Blackstart::Scratchpad:
 
 # Blackstart::Scratchpad.new should return an instance of
@@ -106,6 +32,9 @@ fail "" unless nil.equal? Blackstart.vet { true }
 # class.
 fail "" unless Blackstart::Scratchpad.equal? Blackstart::Scratchpad.new.class
 
+# Blackstart::Scratchpad should not be frozen.
+fail "" if Blackstart::Scratchpad.frozen?
+
 # A new scratchpad should have no instance variables.
 fail "" unless 0 == Blackstart::Scratchpad.new.instance_variables.length
 
@@ -141,7 +70,7 @@ class ::Object
     # When there are tests but none raise exceptions, Blackstart.run should not
     # notify the output stream of any failures. The objects returned by the
     # test procs shouldn't affect Blackstart.run's behavior.
-    source = [proc {}, proc { 42 }]
+    source = [lambda {}, lambda { 42 }]
     fail "" unless true.equal? Blackstart.run(source, invalid_ostream)
     fail "" unless true.equal? Blackstart.run(source, spy_stdout)
     fail "" unless true.equal? Blackstart.run(source)
@@ -158,17 +87,19 @@ class ::Object
     def e_class.to_s
       "FakeError".freeze
     end
-    fail_prc1 = proc { ::Kernel.raise e_class, "fake message 1".freeze }
+    fail_prc1 = lambda { ::Kernel.raise e_class, "fake message 1".freeze }
     def fail_prc1.to_s
       "to_s 1".freeze
     end
     fail_prc1.freeze
-    pass_prc = proc {}.freeze
+    pass_prc = lambda {}.freeze
     fail_prc2 = Object.new # Not a Proc instance, but converts to one.
     fail_prc2.instance_variable_set :@_test_e_class, e_class
     def fail_prc2.to_proc
       e_class = @_test_e_class
-      ::Proc.new { ::Kernel.raise e_class, "fake message 2".freeze }.freeze
+      ::Kernel.lambda do
+        ::Kernel.raise e_class, "fake message 2".freeze
+      end.freeze
     end
     def fail_prc2.to_s
       "to_s 2".freeze
@@ -211,69 +142,67 @@ class ::Object
     fail "" unless false.equal? Blackstart.run(source, spy_ostream)
     fail "" unless 0 == stdout_calls.length
     fail "" unless 4 == calls.length
-    fail "" unless 5 == calls[0].length
-    fail "" unless calls[0].all? { |o| ::String.equal? o.class }
+    fail "" unless 7 == calls[0].length
     fail "" unless "FAILED TEST:" == calls[0][0]
     fail "" unless "to_s 1" == calls[0][1]
     fail "" unless "...ERROR:" == calls[0][2]
-    fail "" unless "FakeError: fake message 1\nline1\nline2" == calls[0][3]
-    fail "" unless "" == calls[0][4]
-    fail "" unless 5 == calls[1].length
-    fail "" unless calls[1].all? { |o| ::String.equal? o.class }
+    fail "" unless "FakeError" == calls[0][3]
+    fail "" unless "fake message 1" == calls[0][4]
+    fail "" unless ["line1", "line2"] == calls[0][5]
+    fail "" unless "" == calls[0][6]
+    fail "" unless 7 == calls[1].length
     fail "" unless "FAILED TEST:" == calls[1][0]
     fail "" unless "to_s 2" == calls[1][1]
     fail "" unless "...ERROR:" == calls[1][2]
-    fail "" unless "FakeError: fake message 2\nline1\nline2" == calls[1][3]
-    fail "" unless "" == calls[1][4]
-    fail "" unless 5 == calls[2].length
-    fail "" unless calls[2].all? { |o| ::String.equal? o.class }
+    fail "" unless "FakeError" == calls[1][3]
+    fail "" unless "fake message 2" == calls[1][4]
+    fail "" unless ["line1", "line2"] == calls[1][5]
+    fail "" unless "" == calls[1][6]
+    fail "" unless 7 == calls[2].length
     fail "" unless "FAILED TEST:" == calls[2][0]
     fail "" unless "to_s 3" == calls[2][1]
     fail "" unless "...ERROR:" == calls[2][2]
-    # (No need to check the error description.)
-    fail "" unless "" == calls[2][4]
-    fail "" unless 5 == calls[3].length
-    fail "" unless calls[3].all? { |o| ::String.equal? o.class }
+    # (No need to check the error details.)
+    fail "" unless "" == calls[2][6]
+    fail "" unless 7 == calls[3].length
     fail "" unless "FAILED TEST:" == calls[3][0]
     fail "" unless "to_s 4" == calls[3][1]
     fail "" unless "...ERROR:" == calls[3][2]
-    # (No need to check the error description.)
-    fail "" unless "" == calls[3][4]
+    # (No need to check the error details.)
+    fail "" unless "" == calls[3][6]
 
     # The faked standard output stream.
     stdout_calls.clear
     fail "" unless false.equal? Blackstart.run(source)
     fail "" unless 4 == stdout_calls.length
-    fail "" unless 5 == stdout_calls[0].length
-    fail "" unless stdout_calls[0].all? { |o| ::String.equal? o.class }
+    fail "" unless 7 == stdout_calls[0].length
     fail "" unless "FAILED TEST:" == stdout_calls[0][0]
     fail "" unless "to_s 1" == stdout_calls[0][1]
     fail "" unless "...ERROR:" == stdout_calls[0][2]
-    fail "" unless "FakeError: fake message 1\nline1\nline2" ==
-      stdout_calls[0][3]
-    fail "" unless "" == stdout_calls[0][4]
-    fail "" unless 5 == stdout_calls[1].length
-    fail "" unless stdout_calls[1].all? { |o| ::String.equal? o.class }
+    fail "" unless "FakeError" == stdout_calls[0][3]
+    fail "" unless "fake message 1" == stdout_calls[0][4]
+    fail "" unless ["line1", "line2"] == stdout_calls[0][5]
+    fail "" unless "" == stdout_calls[0][6]
+    fail "" unless 7 == stdout_calls[1].length
     fail "" unless "FAILED TEST:" == stdout_calls[1][0]
     fail "" unless "to_s 2" == stdout_calls[1][1]
     fail "" unless "...ERROR:" == stdout_calls[1][2]
-    fail "" unless "FakeError: fake message 2\nline1\nline2" ==
-      stdout_calls[1][3]
-    fail "" unless "" == stdout_calls[1][4]
-    fail "" unless 5 == stdout_calls[2].length
-    fail "" unless stdout_calls[2].all? { |o| ::String.equal? o.class }
+    fail "" unless "FakeError" == stdout_calls[1][3]
+    fail "" unless "fake message 2" == stdout_calls[1][4]
+    fail "" unless ["line1", "line2"] == stdout_calls[1][5]
+    fail "" unless "" == stdout_calls[1][6]
+    fail "" unless 7 == stdout_calls[2].length
     fail "" unless "FAILED TEST:" == stdout_calls[2][0]
     fail "" unless "to_s 3" == stdout_calls[2][1]
     fail "" unless "...ERROR:" == stdout_calls[2][2]
-    # (No need to check the error description.)
-    fail "" unless "" == stdout_calls[2][4]
-    fail "" unless 5 == stdout_calls[3].length
-    fail "" unless stdout_calls[3].all? { |o| ::String.equal? o.class }
+    # (No need to check the error details.)
+    fail "" unless "" == stdout_calls[2][6]
+    fail "" unless 7 == stdout_calls[3].length
     fail "" unless "FAILED TEST:" == stdout_calls[3][0]
     fail "" unless "to_s 4" == stdout_calls[3][1]
     fail "" unless "...ERROR:" == stdout_calls[3][2]
-    # (No need to check the error description.)
-    fail "" unless "" == stdout_calls[3][4]
+    # (No need to check the error details.)
+    fail "" unless "" == stdout_calls[3][6]
     stdout_calls.clear
 
     # An output stream that raises an exception when notified of a failure
@@ -281,7 +210,7 @@ class ::Object
     # tests. (In general, the only exceptions Blackstart.run should rescue are
     # StandardError exceptions raised by tests.)
     second_test_run = false
-    source = [proc { ::Kernel.raise "" }, proc { second_test_run = true }]
+    source = [lambda { ::Kernel.raise "" }, lambda { second_test_run = true }]
     begin
       Blackstart.run source, invalid_ostream
     rescue NoMethodError
@@ -297,8 +226,8 @@ class ::Object
     # raised by tests.)
     second_test_run = false
     non_standard_error = Class.new Exception
-    source = [proc { ::Kernel.raise non_standard_error },
-      proc { second_test_run = true }]
+    source = [lambda { ::Kernel.raise non_standard_error },
+      lambda { second_test_run = true }]
     begin
       Blackstart.run source, spy_stdout
     rescue non_standard_error
@@ -329,11 +258,11 @@ class ::Object
     # tests. (In general, the only exceptions Blackstart.run should rescue are
     # StandardError exceptions raised by tests.)
     second_test_run = false
-    no_desc = proc { ::Kernel.raise "" }
+    no_desc = lambda { ::Kernel.raise "" }
     def no_desc.to_s
       ::Kernel.raise ::NoMethodError
     end
-    source = [no_desc, proc { second_test_run = true }]
+    source = [no_desc, lambda { second_test_run = true }]
     begin
       Blackstart.run source, spy_stdout
     rescue NoMethodError
@@ -347,10 +276,64 @@ class ::Object
   end
 end
 
+# When a test fails with an error whose backtrace message returns nil,
+# Blackstart.run should send an empty array to the output stream in place of
+# the backtrace.
+class ::Object
+  e_class = Class.new StandardError
+  def e_class.to_s
+    "FakeError".freeze
+  end
+  e_no_bt = e_class.new "no backtrace".freeze
+  def e_no_bt.backtrace
+    nil
+  end
+
+  ostream = Object.new
+  ostream.instance_variable_set :@_test_calls, calls = []
+  def ostream.puts *args
+    @_test_calls << args
+    nil
+  end
+
+  result = Blackstart.run [lambda { ::Kernel.raise e_no_bt }], ostream
+  fail "" unless false.equal? result
+  fail "" unless 1 == calls.length
+  fail "" unless 7 == calls[0].length
+  fail "" unless "FAILED TEST:" == calls[0][0]
+  fail "" unless "...ERROR:" == calls[0][2]
+  fail "" unless "FakeError" == calls[0][3]
+  fail "" unless "no backtrace" == calls[0][4]
+  fail "" unless [] == calls[0][5]
+  fail "" unless "" == calls[0][6]
+end
+
+# When a test fails with an error that raises an exception when queried,
+# Blackstart.run should raise that exception and stop processing tests. (In
+# general, the only exceptions Blackstart.run should rescue are StandardError
+# exceptions raised by tests.)
+class ::Object
+  second_test_run = false
+  e2_class = Class.new StandardError
+  e1 = StandardError.new
+  e1.instance_variable_set :@next_exception_class, e2_class
+  def e1.to_s
+    ::Kernel.raise @next_exception_class
+  end
+  source = [lambda { ::Kernel.raise e1 }, lambda { second_test_run = true }]
+  begin
+    Blackstart.run source, nil
+  rescue e2_class
+  else
+    fail ""
+  end
+  fail "" if second_test_run
+end
+
 # Blackstart.run should run tests in order.
 class ::Object
   data = []
-  Blackstart.run [proc { data << 1 }, proc { data << 2 }], nil
+  Blackstart.run [lambda { data << 1 }, lambda { data << 2 }], nil
   fail "" unless [1, 2] == data
 end
 
@@ -371,7 +354,7 @@ class ::Object
   source = Object.new
   def source.each
     ran = false
-    yield proc { ran = true }
+    yield lambda { ran = true }
     @ran = ran
     self
   end
@@ -380,7 +363,7 @@ class ::Object
 
   source = Object.new
   def source.each
-    yield proc {}
+    yield lambda {}
     nil
   end
   fail "" unless true.equal? Blackstart.run(source, nil)
@@ -398,11 +381,30 @@ class ::Object
   fail "" unless 1 == source.instance_variable_get(:@count)
 end
 
+# The block that Blackstart.run sends with the each message should return nil
+# whether the test fails or succeeds, regardless of the objects returned by the
+# test and the output stream.
+class ::Object
+  ostream = Object.new
+  def ostream.puts(*)
+    ::Object.new
+  end
+  source = Object.new
+  def source.each
+    pass_result = yield lambda { 42 }
+    fail_result = yield lambda { ::Kernel.raise "" }
+    @results = [pass_result, fail_result]
+    self
+  end
+  fail "" unless false.equal? Blackstart.run(source, ostream)
+  fail "" unless [nil, nil] == source.instance_variable_get(:@results)
+end
+
 # When Blackstart.run calls a test proc, the self object should be a unique
 # instance of Blackstart::Scratchpad.
 class ::Object
   sp1 = sp2 = nil
-  Blackstart.run [proc { sp1 = self }, proc { sp2 = self }], nil
+  Blackstart.run [lambda { sp1 = self }, lambda { sp2 = self }], nil
   fail "" unless Blackstart::Scratchpad.equal? sp1.class
   fail "" unless Blackstart::Scratchpad.equal? sp2.class
   fail "" if sp1.equal? sp2
@@ -411,7 +413,7 @@ end
 # When Blackstart.run runs a test, the scratchpad should not be frozen.
 class ::Object
   frozen = true
-  Blackstart.run [proc { frozen = frozen? }], nil
+  Blackstart.run [lambda { frozen = frozen? }], nil
   fail "" if frozen
 end
 
@@ -433,7 +435,7 @@ class ::Object
   end
 end
 
-# The following section modifies the state of the library, so it must be run
+# The following sections modify the state of the library, so they must be run
 # after all the ordinary tests.
 
 # Blackstart.run should run each test by sending instance_exec to a scratchpad.
@@ -449,9 +451,34 @@ class Blackstart::Scratchpad
 end
 class ::Object
   result = nil
-  Blackstart.run [proc { result = [@ivar, foo()] }], nil
+  Blackstart.run [lambda { result = [@ivar, foo()] }], nil
   fail "" unless [1, 2] == result
 end
 
+# When creating a scratchpad raises an exception, Blackstart.run should raise
+# that exception and stop processing tests instead of treating it as a test
+# failure, even when the exception is a StandardError. (In general, the only
+# exceptions Blackstart.run should rescue are StandardError exceptions raised
+# by tests; this one is raised outside of a test.) This section makes creating
+# a scratchpad always raise an exception, so it must be the last section that
+# runs tests.
+class ::Object
+  second_test_run = false
+  e_class = Class.new StandardError
+  scratchpad_class = Blackstart::Scratchpad
+  scratchpad_class.instance_variable_set :@_test_e_class, e_class
+  def scratchpad_class.new(*)
+    ::Kernel.raise @_test_e_class
+  end
+  source = [lambda {}, lambda { second_test_run = true }]
+  begin
+    Blackstart.run source, nil
+  rescue e_class
+  else
+    fail ""
+  end
+  fail "" if second_test_run
+end
+
 # If this message doesn't get written, there was a problem.
 puts "Test finished: #{__FILE__}"

metadata

@@ -1,13 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: blackstart
 version: !ruby/object:Gem::Version 
-  hash: 11
-  prerelease: 
-  segments: 
-  - 0
-  - 5
-  - 0
-  version: 0.5.0
+  version: 0.9.0
 platform: ruby
 authors: 
 - Aaron Beckerman
@@ -15,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2024-12-21 00:00:00 -08:00
+date: 2026-07-02 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -28,39 +22,29 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- LICENSE.txt
-- README.txt
-- blackstart.gemspec
+- LICENSE
+- README
 - lib/blackstart.rb
+- sig/blackstart.rbs
 - test/blackstart_test.rb
 has_rdoc: true
 homepage: 
 licenses: 
-- MIT
+- Apache-2.0
 post_install_message: 
 rdoc_options: []
 
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 57
-      segments: 
-      - 1
-      - 8
-      - 7
       version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
@@ -68,6 +52,6 @@ rubyforge_project:
 rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
-summary: A small, subdued library for automated testing.
-test_files: 
-- test/blackstart_test.rb
+summary: A small, subdued library for automated testing
+test_files: []
+

data/LICENSE.txt

@@ -1,19 +0,0 @@
-Copyright (c) 2024 Aaron Beckerman
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of
-this software and associated documentation files (the "Software"), to deal in
-the Software without restriction, including without limitation the rights to
-use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
-of the Software, and to permit persons to whom the Software is furnished to do
-so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

data/blackstart.gemspec

@@ -1,11 +0,0 @@
-Gem::Specification.new do |s|
-  s.name = "blackstart"
-  s.version = "0.5.0"
-  s.authors = ["Aaron Beckerman"]
-  s.summary = "A small, subdued library for automated testing."
-  s.licenses = ["MIT"]
-  s.required_ruby_version = ">= 1.8.7"
-  s.files = ["LICENSE.txt", "README.txt", "blackstart.gemspec",
-    "lib/blackstart.rb", "test/blackstart_test.rb"]
-  s.test_files = ["test/blackstart_test.rb"]
-end