micro_test 0.1.0 → 0.1.1

data/Gemfile

@@ -0,0 +1,4 @@
+source :rubygems
+
+gem "slop"
+gem "pry"

data/Gemfile.lock

@@ -0,0 +1,17 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    coderay (1.0.7)
+    method_source (0.8)
+    pry (0.9.10)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.3.1)
+    slop (3.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pry
+  slop

data/README.md

@@ -1,40 +1,77 @@
 # MicroTest
 
-### Testing should be simple.
+## Ruby's no-nonsense testing framework
 
-Testing frameworks never seem to resist the slippery slope of feature creep and eventually become an end unto themselves.
-MiniTest is a step in the right direction, but still feels bigger than it should.
+[View the product page for prettier docs.](http://hopsoft.github.com/micro_test/)
 
-#### MicroTest is an experiment to see just how simple a testing "framework" can be.
+Testing frameworks often lose their focus and become an end unto themselves.
+MicroTest avoids this pitfall with a relentless focus on simplicity.
 
-## Features
+### Testing should be simple
 
-* __Opinionated & small__ - _only 100 lines of code_
-* __Only one assert method: `assert`__ - _since this is the heart of testing_
-* __Tests run in random order__ - _to prevent the bad practice of run order depenencies_
-* __Plays nice with others__ - _easy to introduce to an existing codebase_
+Here's what MicroTest brings to the table.
 
-## Install
+* __Simplicity__
+  A tiny API with only 4 methods. You'll be up and running faster than ever before.
+* __Only 1 Assert Method__
+  Forget the copious expections and assert methods from other frameworks and start focusing on what really matters.
+* __Small Footprint__
+  Weighs in around 140 lines of code. Less code means less to learn and less that can go wrong.
+* __Plays Nice__
+  Runs side by side with other test frameworks which makes it easy to integrate into existing projects.
+* __Random Run Order__
+  Prevents the bad practice of run order dependencies by running tests in random order.
+* __Customizable
+  Output__ Customize test output with pluggable formatters, or give back by writing your own.
+
+## Quick Start
+
+1. Install
 
 ```bash
-gem install micro_test
+$ gem install micro_test
+```
+
+2. Write a test
+
+```ruby
+require 'micro_test'
+class MyTest < MicroTest::Test
+  test "some assumption" do
+    assert true
+  end
+end
+```
+
+3. Run tests
+
+```bash
+$ mt
 ```
 
-## API
+## The interface
 
-* Tests should subclass `MicroTest::Test`
-* Define tests with `test "description" do ...`
-* Setup with `before [:all|:each] do ...`
-* Teardown with `after [:all|:each] do ...`
-* Assert statements with `assert [statement]`
-* Run tests from the terminal with `$ mt`
-* Run tests from Ruby with `MicroTest::Runner.run`
+* `MicroTest::Test` Superclass for all tests.
+* `test(desc, &block)` Defines a test method.
+  * `desc` - a description of what is being tested
+  * `&block` - a block of code which defines the test
 
-That's all there is to learn.
+* `assert(value)` Verifies the truthiness of a value.
+  * `value` - the value to assert
 
-## Examples
+* `before(what, &block)` A callback that runs before the specified 'what'.
+  * `what` - indicates the callback type
+    * `:all` - runs before all tests in the class
+    * `:each` - runse before each test in the class
+  * `&block` - the block of code to execute
 
-Define a test.
+* `after(what, &block)` A callback that runs after the specified 'what'.
+  * `what` - indicates the callback type
+    * `:all` - runs after all tests in the class
+    * `:each` - runse after each test in the class
+  * `&block` - the block of code to execute
+
+## Example
 
 ```ruby
 # /example/test/math_test.rb
@@ -80,24 +117,9 @@ class MathTest < MicroTest::Test
 end
 ```
 
-Run all tests in the "test" directory _(relative to the current directory)_.
+Run tests.
 
 ```bash
 $ mt
-```
-
-Run all tests in a directory.
-
-```bash
 $ mt /example/test
-```
-
-Run all tests in a file.
-
-```bash
 $ mt /example/test/math_test.rb
-```
-
-Test output.
-
-![MicroTest output](http://hopsoft.github.com/micro_test/images/micro_test.png)

data/bin/mt

@@ -1,28 +1,44 @@
 #!/usr/bin/env ruby
-
+require "slop"
+require "pry"
 require File.expand_path(File.join(File.dirname(__FILE__), "..", "lib", "micro_test"))
 
-path = ARGV[0].to_s.strip
-path = File.join(Dir.pwd, "test") if path.empty?
-
-if path == "-h" || path == "--help"
-  puts "Runs MicroTest on the provided path."
-  puts "Usage:"
-  puts "  $mt /path/to/test_file_or_dir"
-  exit
+opts = Slop.parse(:strict => true, :help => true) do
+  banner "mt [options]"
+  on :p, :path, "The path to the test directory or file.", :argument => true
+  on :f, :formatter, "The name of the formatter to use.", :argument => true
+  on :pry, "Starts a pry session when tests fail or have errors."
 end
 
+exit if opts[:help]
+
+path = opts[:path] || "test"
 path = File.join(Dir.pwd, path) unless path =~ /^\//
 unless File.exist?(path)
   puts "#{path} not found."
   puts "Please check the path and try again."
   exit
 end
-
-if File.directory?(path)
-  Dir[File.join(path, "**", "*.rb")].each { |p| require p }
-else
+if path =~ /\.rb$/
   require path
+else
+  Dir[File.join(path, "**", "*.rb")].each { |p| require p }
+end
+
+formatter_name = opts[:formatter] || "default"
+formatter_path = File.expand_path(File.join(File.dirname(__FILE__), "..", "lib", "formatters", formatter_name + ".rb"))
+unless File.exist?(formatter_path)
+  puts "#{formatter_path} not found."
+  puts "Please check the formatter name and try again."
+  exit
+end
+begin
+  require File.expand_path(File.join(File.dirname(__FILE__), "..", "lib", "formatters", formatter_name))
+  formatter = MicroTest.const_get("Formatter").new
+rescue Exception => ex
+  puts "Failed to load the formatter."
+  puts ex.message
+  exit
 end
 
-MicroTest::Runner.run
+MicroTest::Runner.run formatter, :pry => !!opts[:pry]

data/lib/{micro_test/formatter.rb → formatters/default.rb}

@@ -1,5 +1,6 @@
 module MicroTest
   class Formatter
+
     def initialize
       @total = 0
       @passed = 0
@@ -18,13 +19,19 @@ module MicroTest
       @total += 1
       info[:passed] ? @passed += 1 : @failed += 1
       print "- #{info[:name]} "
-      info[:asserts].each do |assert|
-        if assert[:pass]
-          puts green(:PASS)
+      if info[:passed]
+        puts green(:PASS)
+      else
+        if info[:error]
+          puts "#{red :ERROR} #{red info[:error].message}"
+          puts "  #{red info[:error].backtrace[0]}"
         else
           puts red(:FAIL)
-          puts "  #{red assert[:line]}"
-          puts "  #{red assert[:path]}:#{yellow assert[:line_num]}"
+          info[:asserts].each do |assert|
+            next if assert[:passed]
+            puts "  #{red assert[:line]}"
+            puts "  #{red assert[:path]}:#{yellow assert[:line_num]}"
+          end
         end
       end
     end

data/lib/micro_test/runner.rb

@@ -1,5 +1,3 @@
-require File.expand_path(File.join(File.dirname(__FILE__), "formatter"))
-
 module MicroTest
   module Runner
     class << self
@@ -8,10 +6,6 @@ module MicroTest
         send event, arg
       end
 
-      def formatter
-        @formatter ||= MicroTest::Formatter.new
-      end
-
       def add_test_class(klass)
         test_classes << klass
       end
@@ -22,7 +16,7 @@ module MicroTest
 
       def file(path)
         @files ||= {}
-        @files[path] ||= File.open(path, "r").readlines.map { |l| l.gsub(/\n/, "") }
+        @files[path] ||= File.read(path).split("\n")
       end
 
       def file_info(callstack_entry)
@@ -40,11 +34,10 @@ module MicroTest
 
       def assert(value)
         @failed ||= !value
-        @asserts << file_info(caller[6]).merge(:pass => value)
+        @asserts << file_info(caller[6]).merge(:passed => value)
       end
 
-      def run(f=nil)
-        @formatter = f
+      def run(formatter, opts={})
         formatter.header
 
         test_classes.shuffle.each do |test_class|
@@ -55,8 +48,14 @@ module MicroTest
             @failed = false
             @asserts = []
             test_class.invoke :before, :each
-            test_class.tests[desc].call
-            formatter.test(:name => desc, :passed => !@failed, :asserts => @asserts)
+            begin
+              test_class.tests[desc].call
+            rescue Exception => e
+              @failed = true
+              error = e
+            end
+            test_class.tests[desc].pry if @failed && opts[:pry]
+            formatter.test :name => desc, :passed => !@failed, :asserts => @asserts, :error => error
             test_class.invoke :after, :each
           end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: micro_test
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,42 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-27 00:00:00.000000000 Z
-dependencies: []
-description: ! '    A tiny testing framework.
-
-'
+date: 2012-10-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! "    Testing frameworks often lose their focus and become an end unto
+  themselves.\n    MicroTest avoids this pitfall with a relentless focus on simplicity.\n"
 email:
 - natehop@gmail.com
 executables:
@@ -21,11 +52,13 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/micro_test/formatter.rb
+- lib/formatters/default.rb
 - lib/micro_test/runner.rb
 - lib/micro_test/test.rb
 - lib/micro_test.rb
 - bin/mt
+- Gemfile
+- Gemfile.lock
 - README.md
 homepage: http://hopsoft.github.com/micro_test/
 licenses:
@@ -51,5 +84,5 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: A tiny testing framework.
+summary: Ruby's no-nonsense testing framework.
 test_files: []