tst 0.0.2 → 0.0.3

data/README.md

@@ -184,7 +184,7 @@ Just looking in the 'lib' directories:
 - test/unit: 6313
 - rspec: 5460
 - minitest: 1210
-- tst: 220
+- tst: 190
 
-The core of tst's testing engine is really just 122 lines (see 'tst.rb'). The
-other 98 is IO/reporting code.
+The core of tst's testing engine is really just 91 lines (see 'tst.rb'). The
+other 99 is IO/reporting code.

data/lib/tst.rb

@@ -1,17 +1,12 @@
 require 'tst/reporters'
 
-# Tst
 module Tst
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 
-  # ### Failure ###
-  #
   # An error class that carries data about test failures.
   class Failure < StandardError
     attr_reader :message, :expected, :actual
 
-    # Takes the `message`, `expected`, and `actual` parameters
-    # and stuffs them into instance variables.
     def initialize(message, expected, actual)
       @message = message
       @expected = expected
@@ -20,48 +15,23 @@ module Tst
     end
   end
 
-  # ### Assertions ###
-  #
-  # Defines a few `assert` methods for use in tests.
-  #
-  # If you'd like to define your own assertion methods,
-  # open up the module and do so:
-  #
-  #     module Tst::Assertions
-  #       def assert_seven(actual)
-  #         # return without raising to pass
-  #         return if actual == 7
-  #
-  #         # raise a Tst::Failure to fail
-  #         raise Tst::Failure.new('Not 7', 7, actual)
-  #       end
-  #     end
-  #
-  # Because `Assertions` is included into `Test`, your
-  # new methods will be available in `tst` blocks.
+  # Assertions available in `tst` blocks.
   module Assertions
-    # *assert*, the lie detector.
-    #
-    # It fails if `value` is `false` or `nil`. Succeeds otherwise.
+
+    # Fails if `value` is `false` or `nil`. Succeeds otherwise.
     def assert(value)
       return if value
       raise Failure.new("Failure: Truthiness", "not false or nil", value)
     end
 
-    # *assert_equal*, the egalitarian.
-    #
     # Fails unless it's arguments are equal (with `==`).
     def assert_equal(expected, actual)
       return if expected == actual
       raise Failure.new("Equality Failure", expected, actual)
     end
 
-    # *assert_raises*, the pessimist.
-    #
     # Succeeds if it catches an error AND that error is
-    # a `kind_of?` the `expected` error.
-    #
-    # Fails otherwise.
+    # a `kind_of?` the `expected` error. Fails otherwise.
     def assert_raises(expected=StandardError)
       begin
         yield
@@ -73,55 +43,25 @@ module Tst
     end
   end
 
-  # ### Test ###
-  #
-  # An instance of test is basically only responsible for providing
-  # a scope within which to run a block.
-  #
-  # It includes the Assertions module so that the assertions
-  # methods are available to you inside your tests.
-  class Test
-    include Assertions
-
-    attr_reader :name
-
-    def initialize(name, &block)
-      @name = name
-      @block = block
-    end
-
-    def run
-      instance_eval &@block
-    end
-  end
-
   # Set up some constants to represent test outcomes.
   SUCCEEDED = :success
   FAILED = :failure
   RAISED = :exception
 
-  # ### Result ###
-  #
-  # A tidy little place to store test result information.
-  # The values should be self-explanatory.
+  # A little value object containing test result data
   Result = Struct.new(:name, :status, :elapsed, :exception)
 
-
-  # ### Results ###
-  #
   # A collection class that keeps track of test results.
   class Results
     attr_reader :count, :elapsed, :results
 
-    # It starts out with everything zeroed out.
     def initialize
       @count = 0
       @elapsed = 0
       @results = []
     end
 
-    # Collects incoming `result`s and updates `count` and `elapsed`
-    # to reflect the new `result`.
+    # Collects a test result.
     def <<(result)
       @count += 1
       @elapsed += result.elapsed
@@ -134,38 +74,31 @@ module Tst
     def exceptions; results.select { |r| r.status == RAISED } end
   end
 
-  # ### Runner ###
-  #
-  # Collects and runs your tests.
+  # Runs test files in a fresh scope. It's not perfectly isolated, since
+  # requires can still add to the global scope, but it's good enough.
   class Runner
-    attr_reader :tests, :results, :reporter
 
-    # A new Runner accepts a Reporter instance, which it delegates
-    # to for displaying results. It defaults to the plain reporter.
-    #
-    # Look at 'lib/tst/reporters.rb' for more information on reporters.
-    def initialize(reporter=nil)
-      @tests = []
-      @results = Results.new
-      @reporter = reporter || Reporters::Plain.new
-    end
+    # Gets us access to the assertions in our `tst` blocks.
+    include Assertions
 
-    # Collects incoming tests.
-    def <<(test)
-      tests << test
+    def initialize(file, reporter, results)
+      @__reporter = reporter
+      @__results = results
+      __run_tests(file)
     end
 
-    # Runs all the tests it has and then hands control
-    # over to `reporter` to tell you about it.
-    def run!
-      tests.each { |test| run_test(test) }
-      reporter.summarize(results)
+    # Runs the tests by `instance-eval`-ing the test file.
+    def __run_tests(file)
+      instance_eval(File.read(file), File.expand_path(file), 1)
     end
 
-    # The actual machinery for running a test.
-    def run_test(test)
+    # The `tst` methods itself.
+    # Takes a `name` and a block.
+    # Runs the block.
+    # Records the result.
+    def tst(name, &block)
       start = Time.now
-      test.run
+      block.call
       status = SUCCEEDED
     rescue Failure => exception
       status = FAILED
@@ -173,95 +106,36 @@ module Tst
       status = RAISED
     ensure
       elapsed = Time.now - start
-      record(test.name, status, elapsed, exception)
+      __record(name, status, elapsed, exception)
     end
 
-    # Adds a result to `results` and calls the `success`,
-    # `failure`, or `exception` method on `reporter` so
-    # it can show you your results as they come in.
-    def record(name, status, elapsed, exception=nil)
+    def __record(name, status, elapsed, exception=nil)
       result = Result.new(name, status, elapsed, exception)
-      results << result
-      reporter.send(status, result)
+      @__results << result
+      @__reporter.send(status, result)
     end
   end
 
-  # ### FileRunner ###
+  # The main entry point.
   #
-  # A little wrapper class (around a Runner) to allow
-  # for easily running tests that are in files.
-  class FileRunner
-    attr_reader :runner
-
-    # Runs the tests in the files represented by `glob`.
-    #
-    # `glob`: is any string that `Dir.glob` knows how to handle.
-    #
-    # Accepts the following options:
-    #   `:reporter`:   any object that responds_to the reporter
-    #                  interface
-    #                  (see 'lib/tst/reporters.rb' for details)
-    #
-    #   `:load_paths`: an Array of directories to be added to
-    #                  the load path before running the tests.
-    #
-    # Note that `run` makes a new Runner each time it's called,
-    # allowing it to be called several times on the same
-    # FileRunner instance while still doing the right thing.
-    def run(glob, options={})
-      @runner = Runner.new options[:reporter]
-      load_files(glob, options[:load_paths] || [])
-      runner.run!
-    end
-
-    # Collects incoming tests and hands them off to the `runner`.
-    def <<(test)
-      runner << test
-    end
-
-    # Modifies the load path if necessary and loads all the
-    # test files.
-    def load_files(glob, load_paths)
-      load_paths.each { |path| $:.unshift(path) }
-      Dir[glob].each { |file| load(file, true) }
-    end
-  end
-
-  # Module-level accessor to a FileRunner instance.
-  def self.file_runner
-    @file_runner ||= FileRunner.new
-  end
-
-  # Hands a test off to `file_runner`. This is called by
-  # the top-level `tst` method (i.e., the one you use to
-  # write your tests with).
-  def self.add_test(name, &block)
-    file_runner << Test.new(name, &block)
-  end
-
-  # The module-level API entry point.
-  #
-  # An example from Tst's own Rakefile:
+  # glob - a String defining which test files to run.
+  #        Passed through to Dir[].
   #
-  #     task :test do
-  #       Tst.run 'test/*.rb',
-  #         :load_paths => ['.', 'lib'],
-  #         :reporter => Tst::Reporters::Pretty.new
-  #     end
+  # Accepted options:
+  #   :load_paths - an Array of directories to add to the load path.
+  #   :reporter   - a reporter instance (see 'lib/tst/reporters.rb'
+  #                 for docs on reporters)
   def self.run(glob, options={})
-    file_runner.run(glob, options)
+    options = default_options.merge(options)
+    $:.unshift(*options[:load_paths])
+    results = Results.new
+    reporter = options[:reporter]
+    Dir[glob].each { |file| Runner.new(file, reporter, results) }
+    reporter.summarize(results)
   end
-end
 
-# The `tst` method.
-#
-# Acts as proxy to `Tst.add_test`. This is the method you
-# actually call as a consumer of the library.
-#
-#     tst "the answer is correct" do
-#       answer = Answer.new
-#       assert_equal 42, answer
-#     end
-def tst(name=nil, &block)
-  Tst.add_test(name, &block)
+  # The default options for `run`.
+  def self.default_options
+    { :reporter => Reporters::Plain.new, :load_paths => [] }
+  end
 end

data/lib/tst/reporters/plain.rb

@@ -15,6 +15,7 @@ module Tst
         @results = results
         summary = ["\n"] + failures + exceptions + conclusion
         summary.each { |line| io.puts(line) }
+        nil
       end
 
       def failures
@@ -62,12 +63,9 @@ module Tst
       end
 
       def conclusion
-        [ "#{elapsed}: #{passed}, #{failed}, #{raised}." ]
+        [ "#{passed}, #{failed}, #{raised} in %.6fs" % results.elapsed ]
       end
 
-      def elapsed
-        "Ran %d tests in %.6fs" % [results.count, results.elapsed]
-      end
       def passed; "#{results.successes.count} passed"  end
       def failed; "#{results.failures.count} failed"   end
       def raised; "#{results.exceptions.count} raised" end
@@ -76,7 +74,7 @@ module Tst
         backtrace.reject do |line|
           line =~ BACKTRACE_FILTER
         end.map do |line|
-          line.gsub("#{Dir.pwd}/", "")
+          line.gsub("#{Dir.pwd}/", "").gsub(/:in.*$/, '')
         end
       end
 

data/test/plain_reporter.rb

@@ -11,46 +11,58 @@ end
 
 tst_runner_output "test/fixtures/success.rb", <<-end
 .
-Ran 1 tests in X.XXXs: 1 passed, 0 failed, 0 raised.
+1 passed, 0 failed, 0 raised in X.XXXs
 end
 
 tst_runner_output "test/fixtures/failure.rb", <<-end
 F
-F1: Failure: Truthiness - \"one failing test\"
-  exp: \"not false or nil\"
+F1: Failure: Truthiness - "one failing test"
+  exp: "not false or nil"
   got: false
-* test/fixtures/failure.rb:2:in `block in <top (required)>'
-* test/plain_reporter.rb:7:in `block in tst_runner_output'
+* test/fixtures/failure.rb:2
+* test/fixtures/failure.rb:1
+* test/plain_reporter.rb:7
+* test/plain_reporter.rb:4
+* test/plain_reporter.rb:17
 
-Ran 1 tests in X.XXXs: 0 passed, 1 failed, 0 raised.
+0 passed, 1 failed, 0 raised in X.XXXs
 end
 
 tst_runner_output "test/fixtures/exception.rb", <<-end
 E
-E1: #<RuntimeError: I'm a teapot> - \"one 'exceptional' test\"
-* test/fixtures/exception.rb:2:in `block in <top (required)>'
-* test/plain_reporter.rb:7:in `block in tst_runner_output'
+E1: #<RuntimeError: I'm a teapot> - "one 'exceptional' test"
+* test/fixtures/exception.rb:2
+* test/fixtures/exception.rb:1
+* test/plain_reporter.rb:7
+* test/plain_reporter.rb:4
+* test/plain_reporter.rb:31
 
-Ran 1 tests in X.XXXs: 0 passed, 0 failed, 1 raised.
+0 passed, 0 failed, 1 raised in X.XXXs
 end
 
 tst_runner_output "test/fixtures/{exception,success,failure}.rb", <<-end
 E.F
-F1: Failure: Truthiness - \"one failing test\"
-  exp: \"not false or nil\"
+F1: Failure: Truthiness - "one failing test"
+  exp: "not false or nil"
   got: false
-* test/fixtures/failure.rb:2:in `block in <top (required)>'
-* test/plain_reporter.rb:7:in `block in tst_runner_output'
+* test/fixtures/failure.rb:2
+* test/fixtures/failure.rb:1
+* test/plain_reporter.rb:7
+* test/plain_reporter.rb:4
+* test/plain_reporter.rb:43
 
-E1: #<RuntimeError: I'm a teapot> - \"one 'exceptional' test\"
-* test/fixtures/exception.rb:2:in `block in <top (required)>'
-* test/plain_reporter.rb:7:in `block in tst_runner_output'
+E1: #<RuntimeError: I'm a teapot> - "one 'exceptional' test"
+* test/fixtures/exception.rb:2
+* test/fixtures/exception.rb:1
+* test/plain_reporter.rb:7
+* test/plain_reporter.rb:4
+* test/plain_reporter.rb:43
 
-Ran 3 tests in X.XXXs: 1 passed, 1 failed, 1 raised.
+1 passed, 1 failed, 1 raised in X.XXXs
 end
 
 tst_runner_output "test/fixtures/does_not_exist.rb", <<-end
 
-Ran 0 tests in X.XXXs: 0 passed, 0 failed, 0 raised.
+0 passed, 0 failed, 0 raised in X.XXXs
 end
 

data/test/test.rb

@@ -1,23 +1,5 @@
-# One nice thing is that each test gets a fresh scope,
-# which helps mitigate state leakage...
-tst "tests don't have access to top-level instance variables" do
-  @outside = "I'm outside"
+def hello; 'hello' end
 
-  Tst::Test.new "instance variable" do
-    @outside = "I'm inside, muahahaha!"
-  end.run
-
-  assert_equal "I'm outside", @outside
-end
-
-# ... but ruby block scope can be a bitch.
-tst "for better or for worse, local variables are fair game" do
-  outside = "I'm outside"
-
-  Tst::Test.new "local variable" do
-    outside = "I'm inside, muahahaha!"
-  end.run
-
-  assert_equal "I'm inside, muahahaha!", outside
+tst "access to methods defined in the file" do
+  assert_equal 'hello', hello
 end
-

data/test/test2.rb

@@ -0,0 +1,5 @@
+tst "no access to methods defined in other files" do
+  assert_raises NameError do
+    hello # defined in test.rb
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tst
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-26 00:00:00.000000000 Z
+date: 2012-08-27 00:00:00.000000000 Z
 dependencies: []
 description: A small testing library that tries not to do too much.
 email: satchmorun@gmail.com
@@ -32,6 +32,7 @@ files:
 - test/fixtures/success.rb
 - test/plain_reporter.rb
 - test/test.rb
+- test/test2.rb
 homepage: http://github.com/satchmorun/tst
 licenses:
 - MIT
@@ -64,3 +65,4 @@ test_files:
 - test/fixtures/success.rb
 - test/plain_reporter.rb
 - test/test.rb
+- test/test2.rb