specdown 0.0.1 → 0.1.0

data/CHANGELOG.markdown

@@ -0,0 +1,11 @@
+## CHANGELOG
+
+## 0.1.0 (2012/01/01)
+
+Better Sandboxing of tests, with support for configuring the expectation/assertion framework (RSpec Expectations and Test::Unit asserstions supported)
+
+See the "Setting up your test environment" section in the README for more information (https://github.com/moonmaster9000/specdown/blob/ccd9aea13173d582241ca39e6f4f10d50fab4490/README.markdown).
+
+## 0.0.1 (2011/12/30)
+
+First release! Barely passable! :-)

data/README.markdown

@@ -1 +1,171 @@
-This library has not yet been implemented. See SPEC.markdown for info about what it might become.
+# specdown
+
+Write your README in markdown, and execute it with specdown. 
+
+## Why?
+
+Simply put, `specdown` takes README DRIVEN DEVELOPMENT one step further by making your markdown executable.
+
+If you don't know what README DRIVEN DEVELOPMENT IS, checkout Tom Preston Werner's blog post ["README Driven Development"](http://tom.preston-werner.com/2010/08/23/readme-driven-development.html)
+
+## CAVEAT
+
+This library has just been released. It has only a few features, but expect those to grow rapidly over the coming weeks. Follow this repo to stay up to date on the latest changes, or better yet, fork and implement some needed features (see the TODO list at the end of this README).
+
+## Installation
+
+Right now, specdown only support's Ruby. Next, I'll write a javascript implementation. Then, I don't know what language. Regardless, the goal is that you could use specdown with any programming language you desire.
+
+To install the `specdown` ruby gem, simply:
+
+    $ gem install specdown
+
+It comes with a `specdown` command. Try running it. Doesn't matter where.
+
+## Usage
+
+Let's write a simple test in markdown, and execute it with specdown. Create a "specdown" directory, then save the following text into a file inside of it. I'll assume you're calling it "example.markdown":
+
+```markdown
+# Our first test!
+
+This is our very first test. It's going to blow your mind.
+
+    raise "WTF?" unless 1 == 1
+```
+
+Ok, if you've been following along, then `ls -R` should return the following directory structure:
+
+    $ ls -R
+      
+      specdown/
+        example.markdown
+
+Great. Now run the `specdown` command:
+
+    $ specdown
+
+        .
+
+        1 markdown
+        1 test
+        0 failures
+
+Booya!
+
+### How does it work?
+
+`specdown` loads any "markdown" files it can find inside the "specdown" directory, parses them into trees, then performs exhaustive depth-first searches on the trees to execute the code.
+
+Let's update our README to help illustrate this:
+
+```markdown
+# Our first test!
+
+This is our very first test. It's going to blow your mind.
+
+    raise "WTF?" unless 1 == 1
+
+## A Subsection
+
+In this section, we're going to create a variable.
+
+    name = "moonmaster9000"
+
+### A sub subsection
+
+In this subsection, we have access to anything created or within scope in parent sections:
+
+    raise "name not in scope" if !defined? name
+
+## Another Subsection
+
+In this subsection, we don't have access to the "name" variable. Think of your markdown as a tree.
+
+    raise "name in scope" if defined? name
+```
+
+Read through that. I'm giving you some important scoping hints in it. 
+
+Save it, run it.
+
+    $ specdown
+
+        ..
+        
+        1 markdown
+        2 tests
+        0 failures
+
+Notice how the headers in your markdown form a tree?
+
+                #Our first test!
+                    /    \
+                   /      \
+                  /        \
+                 /          \
+                /            \
+               /              \
+              /                \
+      ##A Subection       ##Another Subsection
+            /
+           /
+          /
+    ###A sub subsection
+
+Specdown turned that tree into two tests. The first test (#Our first test! --> ##A Subsection --> ###A sub subsection):
+
+```ruby
+raise "WTF?" unless 1 == 1
+name = "moonmaster9000"
+raise "name not in scope" if !defined? name
+```
+
+Here's what the second test looked like (#Our first test! --> ##Another Subsection)
+
+```ruby
+raise "WTF?" unless 1 == 1
+raise "name in scope" if defined? name
+```
+
+## Setting up your test environment
+
+Similar to the cucumber testing framework: If you put a ruby file somewhere inside your "specdown" directory, `specdown` will find it and load it.
+
+### Configuring the Expectation / Assertion framework
+
+As of version 0.1.0, `specdown` supports both RSpec expectations and Test::Unit assertions. 
+
+Specdown will default to RSpec expectations, but if it can't find the "rspec" gem installed on your system, it will fall back to Test::Unit assertions.
+
+You can also configure `Specdown` manually to use RSpec expectations or Test::Unit assertions. 
+
+#### RSpec expectations
+
+Create a "support" directory inside your specdown directory, and add an `env.rb` file containing the following Ruby code:
+
+```ruby
+Specdown::Config.expectations = :rspec
+```
+
+You can now use [RSpec expectations](https://www.relishapp.com/rspec/rspec-expectations) in your tests. 
+
+#### Using Test::Unit::Assertions
+
+Create a "specdown/support/env.rb" file in your app, then add the following to it:
+
+```ruby
+Specdown::Config.expectations = :test_unit
+```
+
+You can now use [Test::Unit::Assertions](http://www.ruby-doc.org/stdlib-1.9.3/libdoc/test/unit/rdoc/Test/Unit/Assertions.html) inside your tests.
+
+## TODO
+
+This library is the result of about 8 hours worth of work so far :-) It's a basic minimum viable product, but there are tons of features I want to implement. Here's what's on my immediate horizon:
+
+* Better stack traces / reporting
+* Test hooks (before/after/around)
+* Run a single test
+* color code the terminal output
+* offer the option of outputing the actual markdown while it executes, instead of "..F....FF......"

data/features/command.feature

@@ -18,76 +18,79 @@ Feature: `specdown` command
     
     Given I have a specdown directory containing a single markdown file:
       """
-      # Specdown Example
+        # Specdown Example
 
-      This is an example specdown file.
+        This is an example specdown file.
 
-      ## Child Node
+        ## Child Node
 
-      This section is a child node. It contains some ruby code: 
-          
-          "simple code".should_not == nil
+        This section is a child node. It contains some ruby code: 
+            
+            "simple code".should_not be(nil)
 
-      ### First Leaf
+        ### First Leaf
 
-      This section has a failure simulation:
-          
-          raise "specdown error simulation!"
+        This section has a failure simulation:
+            
+            raise "specdown error simulation!"
 
-      ## Last Leaf
+        ## Last Leaf
 
-      This section is a leaf node. It contains some ruby code:
-          
-          1.should == 1
+        This section is a leaf node. It contains some ruby code:
+            
+            1.should satisfy(&:odd?)
       """
 
     When I run `specdown` with no arguments
     Then I should see the following output:
       """
+        F.
+
         1 markdown
         2 tests
-        2 failures
+        1 failure
 
-        undefined method `should_not' for "simple code":String
-        undefined method `should' for 1:Fixnum
+        specdown error simulation
       """
 
   Scenario: `specdown` with no arguments, and a specdown directory containing a single ruby file and a single markdown file
     Given I have a specdown directory containing a markdown file:
       """
-      # Specdown Example
+        # Specdown Example
 
-      This is an example specdown file.
+        This is an example specdown file.
 
-      ## Child Node
+        ## Child Node
 
-      This section is a child node. It contains some ruby code: 
-          
-          "simple code".should_not == nil
+        This section is a child node. It contains some ruby code: 
+            
+            "simple code".should_not be(nil)
 
-      ### First Leaf
+        ### First Leaf
 
-      This section has a failure simulation:
-          
-          raise "specdown error simulation!"
+        This section has a failure simulation:
+            
+            raise "specdown error simulation!"
 
-      ## Last Leaf
+        ## Last Leaf
 
-      This section is a leaf node. It contains some ruby code:
-          
-          1.should == 1
+        This section is a leaf node. It contains some ruby code:
+            
+            1.should satisfy(&:odd?)
       """
     And a single ruby file:
       """
-      require 'rubygems'
-      require 'rspec/expectations'
+        Specdown::Config.expectations = :test_unit
       """
     When I run `specdown` with no arguments
     Then I should see the following output:
       """
+        FF
+
         1 markdown
         2 tests
-        1 failure
+        2 failures
 
-        specdown error simulation!
+        In parser_example.markdown: <NoMethodError> undefined method `be'
+        In parser_example.markdown: <NoMethodError> undefined method `satisfy'
      """

data/features/config.feature

@@ -0,0 +1,96 @@
+Feature: Specdown::Config
+
+  You can use a simple Ruby API to configure specdown.
+
+  Note that at any point, you can reset your Specdown::Config to defaults using the `reset!` method:
+      
+      Specdown::Config.reset!
+      Specdown::Config.expectations.should be(nil)
+
+  \## Assertion/Expectation framework
+
+  All of your tests will run within a protected sandbox namespace. If rspec is installed and available, then Specdown will make rspec `should` expectations and matchers availble to your tests. If not, then it will fall back to Test::Unit assertions.
+
+  \### Rspec Expectations
+
+  If you want to explicitly configure `Specdown` to use rspec's expectations, you can use the `expectations` accessor:
+
+      Specdown::Config.expectations = :rspec
+
+  Now, if you instantiate a new sandbox, then rspec's "should" matchers should be available within it:
+
+      Specdown.sandbox.new.instance_eval do
+        1.should_not be(nil)
+      end
+
+  \### Test::Unit assertions
+
+  If you want to explicitly configure `Specdown` to use Test::Unit assertions, set the `expectations` accessor on `Specdown::Config` to `:test_unit`:
+
+      Specdown::Config.expectations = :test_unit
+
+  Now you'll have access to all of the `assert_*` methods within your tests:
+
+      Specdown.sandbox.new.instance_eval do
+        assert_equal 1, 1
+      end 
+
+
+  Scenario: Reset the Specdown::Config
+
+    Given I have configured Specdown:
+      """
+        Specdown::Config.expectations = :rspec
+      """
+
+    When I reset Specdown:
+      """
+        Specdown::Config.reset!
+      """
+
+    Then my specdown configuration should return to it's defaults:
+      """
+        Specdown::Config.expectations.should be(nil)
+      """
+
+
+  Scenario: Default to Rspec expectations
+
+    Given I have rspec installed
+    Then Specdown should provide rspec expectations and matchers within the sandbox by default:
+      """
+        Specdown.sandbox.instance_eval do
+          1.should_not be(nil)
+        end
+      """
+
+  Scenario: Manually configure RSpec expectations
+    Given I have manually configured Specdown to use Rspec expectations:
+      """
+        Specdown::Config.expectations = :rspec
+      """
+
+    Then Specdown should provide rspec expectations and matchers within the sandbox:
+      """
+        Specdown.sandbox.instance_eval do
+          1.should_not be(nil)
+        end
+      """
+
+  Scenario: Manually configure Test::Unit assertions
+    Given I have manually configured Specdown to use Test::Unit assertions:
+      """
+        Specdown::Config.expectations = :test_unit
+      """
+
+    Then Specdown should provide Test::Unit assertions within the sandbox:
+      """
+        Specdown.sandbox.instance_eval do
+          assert_equal 1, 1
+        end
+      """
+
+
+
+
+

data/features/event_server.feature

@@ -0,0 +1,39 @@
+Feature: Specdown::EventServer
+
+  The Specdown::EventServer receives events and triggers callbacks.
+
+  For example, to send an event to the EventServer, simply give the event a name, then pass any number of arguments after that:
+
+      Specdown::EventServer.event "test passed"
+
+  You can also register callbacks for events using the `register` method:
+      
+      Specdown::EventServer.register "test passed" do
+        print "."
+      end
+
+  
+  Scenario: Submitting an event triggers all registered callbacks for that event
+      
+    Given a USA population of zero:
+      """
+        @usa_population   = 0
+      """
+    And a world population of 10:
+      """
+        @world_population = 10
+      """
+    And I register callbacks to increment both whenever someone is born:
+      """
+        Specdown::EventServer.register("birth") {|num_births| @usa_population += num_births   }
+        Specdown::EventServer.register("birth") {|num_births| @world_population += num_births }
+      """
+    When I create a "birth" event:
+      """
+        Specdown::EventServer.event "birth", 3
+      """
+    Then both the USA population and the World population should increase:
+      """
+        @usa_population.should == 3
+        @world_population.should == 13
+      """

data/features/fixtures/parser_example.markdown

@@ -6,7 +6,7 @@ This is an example specdown file.
 
 This section is a child node. It contains some ruby code: 
     
-    "simple code".should_not == nil
+    "simple code".should_not be(nil)
 
 ### First Leaf
 
@@ -18,4 +18,4 @@ This section has a failure simulation:
 
 This section is a leaf node. It contains some ruby code:
     
-    1.should == 1
+    1.should satisfy(&:odd?)

data/features/parser.feature

@@ -6,27 +6,27 @@ Feature: Specdown Parser
 
       readme = <<-README
       
-      \# Specdown Example
+        \# Specdown Example
 
-      This is an example specdown file.
+        This is an example specdown file.
 
-      \## Child Node
+        \## Child Node
 
-      This section is a child node. It contains some ruby code: 
-          
-          "simple code".should_not == nil
+        This section is a child node. It contains some ruby code: 
+            
+            "simple code".should_not be(nil)
 
-      \### First Leaf
+        \### First Leaf
 
-      This section has a failure simulation:
-          
-          raise "specdown error simulation!"
+        This section has a failure simulation:
+            
+            raise "specdown error simulation!"
 
-      \## Last Leaf
+        \## Last Leaf
 
-      This section is a leaf node. It contains some ruby code:
-          
-          1.should == 1
+        This section is a leaf node. It contains some ruby code:
+            
+            1.should satisfy(&:odd?)
        README
 
   As you can see, this forms a tree, with "# Specdown Example" at the root of the tree, and "## Leaf 1" and "## Leaf 2" as the children / leafs. 
@@ -55,27 +55,27 @@ Feature: Specdown Parser
 
     Given the following specdown example file:
       """
-      # Specdown Example
+        # Specdown Example
 
-      This is an example specdown file.
+        This is an example specdown file.
 
-      ## Child Node
+        ## Child Node
 
-      This section is a child node. It contains some ruby code: 
-          
-          "simple code".should_not == nil
+        This section is a child node. It contains some ruby code: 
+            
+            "simple code".should_not be(nil)
 
-      ### First Leaf
+        ### First Leaf
 
-      This section has a failure simulation:
-          
-          raise "specdown error simulation!"
+        This section has a failure simulation:
+            
+            raise "specdown error simulation!"
 
-      ## Last Leaf
+        ## Last Leaf
 
-      This section is a leaf node. It contains some ruby code:
-          
-          1.should == 1
+        This section is a leaf node. It contains some ruby code:
+            
+            1.should satisfy(&:odd?)
       """
 
     When I parse it into a tree:
@@ -98,11 +98,11 @@ Feature: Specdown Parser
         last_leaf = @tree.root.children.last
         
         child_node.name.should  == "Child Node"
-        child_node.code.should  == '"simple code".should_not == nil'
+        child_node.code.should  == '"simple code".should_not be(nil)'
 
         first_leaf.name.should  == "First Leaf"
         first_leaf.code.should  == 'raise "specdown error simulation!"'
         
         last_leaf.name.should   == "Last Leaf"
-        last_leaf.code.should   == "1.should == 1" 
+        last_leaf.code.should   == "1.should satisfy(&:odd?)" 
       """

data/features/runner.feature

@@ -2,7 +2,7 @@ Feature: Runner
 
   The `Specdown::Runner` class accepts a markdown parse tree, and runs the tests found within.
 
-  Imagine we start with this markdown file:
+  Imagine we start with this markdown file (saved at "specdown.markdown"):
 
       \# Specdown Example
 
@@ -26,16 +26,12 @@ Feature: Runner
           
           1.should == 1
   
-  We then parse it into a Specdown::Tree:
-      
-      parse_tree = Specdown::Parser.parse File.read("/path/to/markdown")
-  
-  We can now generate a new `Specdown::Runner` instance and run the tests:
+  We can generate a `Specdown::Runner` instance and run the tests in our markdown by simply passing the filename on instantiation:
 
-      runner = Specdown::Runner.new(parse_tree)
+      runner = Specdown::Runner.new "specdown.markdown"
       runner.run
 
-  While running, it will print results to STDOUT like "F." 
+  While running, it will emit events during the processing to the Specdown::EventServer. This enables all kinds of functionality, like printing the progress of the tests.
 
   We can access statistics about the run programatically:
       
@@ -46,7 +42,7 @@ Feature: Runner
 
   Scenario: Running tests
 
-    Given the following specdown example file:
+    Given the following specdown example file located at 'features/fixtures/parser_example.markdown':
       """
       # Specdown Example
 
@@ -71,14 +67,9 @@ Feature: Runner
           1.should == 1
       """
 
-    When I parse it into a tree:
-      """
-        @tree = Specdown::Parser.parse @readme
-      """
-    
-    And I generate a `Specdown::Runner` instance from it:
+    When I generate a `Specdown::Runner` instance from it:
       """
-        @runner = Specdown::Runner.new @tree
+        @runner = Specdown::Runner.new "features/fixtures/parser_example.markdown"
       """
 
     Then I should be able to run the tests:
@@ -88,8 +79,9 @@ Feature: Runner
     
     And I should be able to access the report data programatically:
       """
-      @runner.stats.tests                   #==> 2
-      @runner.stats.failures                #==> 1
-      @runner.stats.successes               #==> 1
-      @runner.stats.exceptions.map(&:to_s)  #==> ['(eval):3:in `execute_test': specdown error simulation!']
+      @runner.file_name.should == 'parser_example.markdown'
+      @runner.stats.tests.should == 2
+      @runner.stats.failures.should == 1
+      @runner.stats.successes.should == 1
+      @runner.stats.exceptions.map(&:to_s).should == ["specdown error simulation!"]
       """

data/features/specdown_examples/no_ruby/specdown/parser_example.markdown

@@ -6,7 +6,7 @@ This is an example specdown file.
 
 This section is a child node. It contains some ruby code: 
     
-    "simple code".should_not == nil
+    "simple code".should_not be(nil)
 
 ### First Leaf
 
@@ -18,4 +18,5 @@ This section has a failure simulation:
 
 This section is a leaf node. It contains some ruby code:
     
-    1.should == 1
+    1.should satisfy(&:odd?)
+

data/features/specdown_examples/with_ruby/specdown/env.rb

@@ -1,2 +1 @@
-require 'rubygems'
-require 'rspec/expectations'
+Specdown::Config.expectations = :test_unit

data/features/specdown_examples/with_ruby/specdown/parser_example.markdown

@@ -6,7 +6,7 @@ This is an example specdown file.
 
 This section is a child node. It contains some ruby code: 
     
-    "simple code".should_not == nil
+    "simple code".should_not be(nil)
 
 ### First Leaf
 
@@ -18,4 +18,5 @@ This section has a failure simulation:
 
 This section is a leaf node. It contains some ruby code:
     
-    1.should == 1
+    1.should satisfy(&:odd?)
+

data/features/step_definitions/config.rb

@@ -0,0 +1,34 @@
+Given /^I have configured Specdown:$/ do |string|
+  eval string
+end
+
+When /^I reset Specdown:$/ do |string|
+  eval string
+end
+
+Then /^my specdown configuration should return to it's defaults:$/ do |string|
+  eval string
+end
+
+Given /^I have rspec installed$/ do
+end
+
+Then /^Specdown should provide rspec expectations and matchers within the sandbox by default:$/ do |string|
+  eval string
+end
+
+Given /^I have manually configured Specdown to use Rspec expectations:$/ do |string|
+  eval string
+end
+
+Then /^Specdown should provide rspec expectations and matchers within the sandbox:$/ do |string|
+  eval string
+end
+
+Given /^I have manually configured Specdown to use Test::Unit assertions:$/ do |string|
+  eval string
+end
+
+Then /^Specdown should provide Test::Unit assertions within the sandbox:$/ do |string|
+  eval string
+end

data/features/step_definitions/event_server.rb

@@ -0,0 +1,19 @@
+Given /^a USA population of zero:$/ do |string|
+  eval string
+end
+
+Given /^a world population of .*:$/ do |string|
+  eval string
+end
+
+Given /^I register callbacks to increment both whenever someone is born:$/ do |string|
+  eval string
+end
+
+When /^I create a ".*" event:$/ do |string|
+  eval string
+end
+
+Then /^both the USA population and the World population should increase:$/ do |string|
+  eval string
+end

data/features/step_definitions/parser.rb

@@ -1,4 +1,4 @@
-Given /^the following specdown example file:$/ do |string|
+Given /^the following specdown example file.*:$/ do |string|
   @readme = File.read "features/fixtures/parser_example.markdown"
 end
 

data/features/support/env.rb

@@ -1,4 +1,3 @@
 $LOAD_PATH.unshift './lib'
 require 'specdown'
 require 'rspec/expectations'
-require 'rspec/matchers'

data/features/support/hooks.rb

@@ -0,0 +1,3 @@
+Before do
+  Specdown::Config.reset!
+end

data/lib/specdown/command.rb

@@ -11,14 +11,7 @@ module Specdown
     
     private
     def run
-      @results =
-        @markdowns.map {|markdown| 
-          Parser.parse(File.read(markdown))
-        }.map {|tree| 
-          Runner.new(tree)
-        }.map {|runner|
-          runner.run
-        }.collect &:stats
+      @results = @markdowns.map {|markdown| Runner.new(markdown).run.stats}
     end
 
     def report

data/lib/specdown/config.rb

@@ -0,0 +1,11 @@
+module Specdown
+  module Config
+    extend self
+
+    attr_accessor :expectations
+
+    def reset!
+      self.expectations = nil
+    end
+  end
+end

data/lib/specdown/event_handlers/run_complete.rb

@@ -0,0 +1,3 @@
+Specdown::EventServer.register :run_complete do
+  puts "\n\n"
+end

data/lib/specdown/event_handlers/test_failed.rb

@@ -0,0 +1,3 @@
+Specdown::EventServer.register :test_failed do
+  print "F"
+end

data/lib/specdown/event_handlers/test_passed.rb

@@ -0,0 +1,3 @@
+Specdown::EventServer.register :test_passed do
+  print "."
+end

data/lib/specdown/event_server.rb

@@ -0,0 +1,19 @@
+module Specdown
+  module EventServer
+    extend self
+
+    def event(event_name, *args)
+      callbacks[event_name].map {|callback| callback.call *args} if callbacks[event_name] 
+    end
+
+    def register(event_name, &callback)
+      callbacks[event_name] ||= []
+      callbacks[event_name] << callback
+    end
+
+    private
+    def callbacks
+      @callbacks ||= {}
+    end
+  end
+end

data/lib/specdown/parser.rb

@@ -53,6 +53,7 @@ module Specdown
       until parsed_elements.empty? || (
         parsed_elements.first.type == :header && parsed_elements.first.options[:level] == 1
       )
+        parsed_elements.shift
       end
     end
   end

data/lib/specdown/runner/report.rb

@@ -34,7 +34,16 @@ module Specdown
     end
    
     def exceptions
-      @stats.collect(&:exceptions).flatten.map {|e| [e.to_s, e.backtrace].join "\n"}
+      formatted_exceptions = []
+      @stats.each do |stat|
+        formatted_exceptions << stat.exceptions.map do |e| 
+          [
+            (stat.runner ? "In #{stat.runner.file_name}: " : "") + "<#{e.class}> #{e}", 
+            e.backtrace
+          ].join "\n"
+        end
+      end
+      formatted_exceptions.flatten
     end
   end
 end

data/lib/specdown/runner/stats.rb

@@ -1,8 +1,10 @@
 module Specdown
   class Stats
     attr_accessor :tests, :exceptions
+    attr_reader :runner
 
-    def initialize
+    def initialize(source_runner=nil)
+      @runner = source_runner
       @tests = 0
       @exceptions = []
     end

data/lib/specdown/runner.rb

@@ -1,15 +1,20 @@
 module Specdown
   class Runner
-    attr_reader :stats
+    attr_reader :stats, :file_path
 
-    def initialize(tree)
-      @tree   = tree
-      @stats  = Stats.new
+    def initialize(file_path)
+      @file_path = file_path
+      @tree   = Parser.parse File.read(file_path)
+      @stats  = Stats.new self
+    end
+
+    def file_name
+      File.basename @file_path
     end
 
     def run
       depth_first_search @tree.root
-      puts "\n\n"
+      EventServer.event :run_complete
       self
     end
 
@@ -28,16 +33,17 @@ module Specdown
       @stats.tests += 1
       
       begin
-        Sandbox.new.instance_eval do
-          eval code.join("\n")
-        end
+        Specdown.sandbox.instance_eval <<-CODE, file_name
+          #{code.join("\n")}
+        CODE
 
-        print '.'
+        EventServer.event :test_passed
 
       rescue Exception => e
         @stats.exceptions << e
 
-        print 'F'
+        EventServer.event :test_failed
+
       end
     end
   end

data/lib/specdown/sandbox_factory.rb

@@ -0,0 +1,56 @@
+module Specdown
+  module SandboxFactory
+    extend self
+
+    def generate
+      Module.new {}.tap do |sandbox|
+        setup_expectation_library.call(sandbox)
+      end 
+    end
+
+    private
+    def setup_expectation_library
+      expectation_library_setups[Config.expectations] 
+    end
+    
+    def expectation_library_setups
+      Hash.new(default_expectations_setup).tap do |setups|
+        setups[:rspec]     = rspec_expectations_setup
+        setups[:test_unit] = test_unit_expectations_setup
+      end
+    end
+
+    def rspec_installed?
+      require_rspec
+    end
+
+    def require_rspec
+      begin
+        require('rspec/expectations')
+        true
+      rescue LoadError
+        false
+      end
+    end
+
+    def default_expectations_setup
+      if rspec_installed?
+        rspec_expectations_setup 
+      else
+        test_unit_expectations_setup
+      end
+    end
+
+    def rspec_expectations_setup
+      require_rspec
+      proc {|sandbox| sandbox.extend ::RSpec::Matchers}
+    end
+
+    def test_unit_expectations_setup
+      proc do |sandbox|
+        require 'test/unit/assertions'
+        sandbox.extend ::Test::Unit::Assertions
+      end
+    end
+  end
+end

data/lib/specdown/specdown.rb

@@ -0,0 +1,7 @@
+module Specdown
+  extend self
+  
+  def sandbox
+    SandboxFactory.generate
+  end
+end

data/lib/specdown.rb

@@ -2,8 +2,15 @@ require 'kramdown'
 require 'specdown/parser'
 require 'specdown/node'
 require 'specdown/tree'
-require 'specdown/sandbox'
 require 'specdown/runner'
 require 'specdown/runner/report'
 require 'specdown/runner/stats'
 require 'specdown/command'
+require 'specdown/event_server'
+require 'specdown/event_handlers/run_complete'
+require 'specdown/event_handlers/run_started'
+require 'specdown/event_handlers/test_failed'
+require 'specdown/event_handlers/test_passed'
+require 'specdown/config'
+require 'specdown/specdown'
+require 'specdown/sandbox_factory'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: specdown
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
-  - 0
   - 1
-  version: 0.0.1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Matt Parker
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-30 00:00:00 Z
+date: 2012-01-01 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: kramdown
@@ -68,22 +68,31 @@ executables:
 extensions: []
 
 extra_rdoc_files: 
+- CHANGELOG.markdown
 - README.markdown
-- SPEC.markdown
 files: 
 - lib/specdown/command.rb
+- lib/specdown/config.rb
+- lib/specdown/event_handlers/run_complete.rb
+- lib/specdown/event_handlers/run_started.rb
+- lib/specdown/event_handlers/test_failed.rb
+- lib/specdown/event_handlers/test_passed.rb
+- lib/specdown/event_server.rb
 - lib/specdown/node.rb
 - lib/specdown/parser.rb
 - lib/specdown/runner/report.rb
 - lib/specdown/runner/stats.rb
 - lib/specdown/runner.rb
-- lib/specdown/sandbox.rb
+- lib/specdown/sandbox_factory.rb
+- lib/specdown/specdown.rb
 - lib/specdown/tree.rb
 - lib/specdown.rb
 - bin/specdown
+- CHANGELOG.markdown
 - README.markdown
-- SPEC.markdown
 - features/command.feature
+- features/config.feature
+- features/event_server.feature
 - features/fixtures/parser_example.markdown
 - features/parser.feature
 - features/report.feature
@@ -92,10 +101,13 @@ files:
 - features/specdown_examples/with_ruby/specdown/env.rb
 - features/specdown_examples/with_ruby/specdown/parser_example.markdown
 - features/step_definitions/command.rb
+- features/step_definitions/config.rb
+- features/step_definitions/event_server.rb
 - features/step_definitions/parser.rb
 - features/step_definitions/report.rb
 - features/step_definitions/runner.rb
 - features/support/env.rb
+- features/support/hooks.rb
 homepage: http://github.com/moonmaster9000/specdown
 licenses: []
 
@@ -131,6 +143,8 @@ specification_version: 3
 summary: Write your specs as if they were a README, then EXECUTE them.
 test_files: 
 - features/command.feature
+- features/config.feature
+- features/event_server.feature
 - features/fixtures/parser_example.markdown
 - features/parser.feature
 - features/report.feature
@@ -139,7 +153,10 @@ test_files:
 - features/specdown_examples/with_ruby/specdown/env.rb
 - features/specdown_examples/with_ruby/specdown/parser_example.markdown
 - features/step_definitions/command.rb
+- features/step_definitions/config.rb
+- features/step_definitions/event_server.rb
 - features/step_definitions/parser.rb
 - features/step_definitions/report.rb
 - features/step_definitions/runner.rb
 - features/support/env.rb
+- features/support/hooks.rb

data/SPEC.markdown

@@ -1,122 +0,0 @@
-# specdown
-
-Write your README in markdown, and execute it with specdown. Documentation == Specification == WINNING
-
-## Why?
-
-I love README DRIVEN DEVELOPMENT. I love the free-form nature of writing a README. I dislike the process of copying and transforming my README into cucumber. Gherkin works well for many types of requirements, but I dislike turning readable, natural prose into "Given/When/Then" Gherkin. I dislike turning my readable prose into RSpec even more.
-
-## How?
-
-Writing your tests with specdown is as simple as writing a README. I'll show you. 
-
-Let's imagine we're writing a README for a silly little ruby library called "Todo":
-
-    # Todo
-
-    A simple library for managing your todo list. 
-
-    ## Usage
-
-    Go into `irb`, then `require 'todo'`. Type `Todo.List` to see your current to do list:
-
-        Todo.List #==> []
-
-    If at any point, you want to completely reset your Todo.List, simply call `Todo!`:
-        
-        Todo!
-        Todo.List.should be_empty
-
-    ### Adding/Removing
-
-    Now, add an item to your to-do list by calling it as if it were a method on the `Todo` object:
-
-        Todo.shop_for_groceries
-    
-    This added the item to your `Todo.List`:
-
-        Todo.List.should == [:shop_for_groceries]
-
-    You can remove an item from your todo list by adding an exclamation point onto the end of it:
-        Todo.shop_for_groceries!
-        Todo.List.should be_empty
-    
-
-    ### Bulk operations
-
-    You can also perform bulk operations on your `Todo.List`:
-      
-        Todo.edit! do 
-          shop
-          dry_cleaning!
-          shave!
-          walk_dogs
-        end
-
-    The items "dry_cleaning" and "shave" were removed from your `Todo.List`, and the items "shop" and "walk_dogs" were added to your Todo.List.
-
-        Todo.List.should == [
-          :shop,
-          :walk_dogs
-        ]
-
-Let's call this file "README.markdown", and place it inside a "specdown/" directory:
-
-    $ ls -r
-      specdown/
-        README.markdown
-
-We can execute this markdown with specdown by simply the `specdown` command. If you'd like to have some code run before the markdown is executed, put it in a ruby file inside a "specdown" directory:
-
-    $ cat > specdown/support.rb
-      
-      $LOAD_PATH.unshift './lib'
-      require 'rspec/expectations' # for using "should" matchers in the README
-      require 'todo'
-
-## Trees and Leafs
-
-In the README that we wrote for `Todo`, we actually wrote two tests, or scenarios. 
-
-`specdown` creates a tree out of our markdown. In our case, the tree for our `Todo` README looks like this:
-
-
-                  #Todo
-                    |
-                  ##Usage
-                  /    \
-                 /      \
-                /        \
-               /          \
-              /            \
-             /              \
-            /                \
-    ###Adding/Removing       ###Bulk Operations
-
-`specdown` will then walk the path from the root to every leaf node in the tree, executing any code it finds along the way.
-
-Thus, the first "test" will look like this:
-
-    Todo.List #==> []
-    Todo!
-    Todo.List.should be_empty
-    Todo.shop_for_groceries
-    Todo.List.should == [:shop_for_groceries]
-    Todo.shop_for_groceries!
-    Todo.List.should be_empty
-
-The second "test" looks like this:
-
-    Todo.List
-    Todo!
-    Todo.List.should be_empty
-    Todo.edit! do 
-      shop
-      dry_cleaning!
-      shave!
-      walk_dogs
-    end
-    Todo.List.should == [
-      :shop,
-      :walk_dogs
-    ]

data/lib/specdown/sandbox.rb

@@ -1,4 +0,0 @@
-module Specdown
-  class Sandbox
-  end
-end