specdown 0.1.1 → 0.1.2

data/CHANGELOG.markdown

@@ -1,5 +1,9 @@
 ## CHANGELOG
 
+## 0.1.2
+
+New feature added: test hooks. (see the README)
+
 ## 0.1.1 (2012/01/02)
 
 Bug fix: better report formatting for multi-markdown test suites.

data/README.markdown

@@ -160,12 +160,50 @@ 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.
 
+## Test hooks (before/after/around)
+
+You can create test hooks that run before, after, and around tests. You can create global hooks, or hooks that run only for specific specdown files.
+
+### Global hooks
+
+To create a global before hook, use the `Specdown.before` method:
+
+    Specdown.before do
+      puts "I run before every single test!"
+    end
+
+That before hook will - you guessed it - RUN BEFORE EVERY SINGLE TEST.
+
+Similary, you can run some code after every single test via the `Specdown.after` method:
+
+    Specdown.after do
+      puts "I run after every single test!"
+    end
+
+Whenever you need some code to run before _and_ after every single test, use the `Specdown.around` method:
+
+    Specdown.around do
+      puts "I run before _AND_ after every single test!"
+    end
+
+### Scoping your hooks to specific markdown files
+
+You might, at times, want hooks to run only for certain files. 
+
+You can pass filenames (or regular expressions) to the `Specdown.before`, `Specdown.after`, and `Specdown.around` methods. The hooks will then execute whenever you execute any markdown file with matching filenames.
+
+    Specdown.before "somefile.markdown", /^.*\.database.markdown$/ do
+      puts "This runs before every test within 'somefile.markdown', and
+            before every test in any markdown file whose filename ends 
+            with '.database.markdown'"
+    end
+
+
 ## TODO
 
 This library is the result of just a couple of days worth of work. 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......"
+* Better stack traces / reporting

data/bin/specdown

@@ -1,8 +1,8 @@
 #!/usr/bin/env ruby
 require 'specdown'
 
-Dir["specdown/**/*.rb"].each do |ruby_file|
-  require ruby_file
+Dir["./specdown/**/*.rb"].each do |ruby_file|
+  load ruby_file
 end
 
 Specdown::Command.new.execute

data/features/hooks.feature

@@ -0,0 +1,125 @@
+Feature: Specdown test hooks
+
+  You can create test hooks that run before, after, and around tests. You can create global hooks, or hooks that run only for specific specdown files.
+  
+  \## Global hooks
+
+  To create a global before hook, use the `Specdown.before` method:
+
+      Specdown.before do
+        puts "I run before every single test!"
+      end
+
+  That before hook will - you guessed it - RUN BEFORE EVERY SINGLE TEST.
+
+  Similary, you can run some code after every single test via the `Specdown.after` method:
+
+      Specdown.after do
+        puts "I run after every single test!"
+      end
+
+  Whenever you need some code to run before _and_ after every single test, use the `Specdown.around` method:
+
+      Specdown.around do
+        puts "I run before _AND_ after every single test!"
+      end
+
+  \### Scoping your hooks to specific markdown files
+
+  You might, at times, want hooks to run only for certain files. 
+
+  You can pass filenames (or regular expressions) to the `Specdown.before`, `Specdown.after`, and `Specdown.around` methods. The hooks will then execute whenever you execute any markdown file with matching filenames.
+
+      Specdown.before "somefile.markdown", /^.*\.database.markdown$/ do
+        puts "This runs before every test within 'somefile.markdown', and
+              before every test in any markdown file whose filename ends 
+              with '.database.markdown'"
+      end
+
+  Scenario: Before hook
+
+    Given a specdown directory with a markdown file with TWO tests
+    And an environment file with the following before hook:
+      """
+        Specdown.before do
+          puts "I run before every test!"
+        end
+      """
+    
+    When I run the specdown command for that directory
+
+    Then I should see the following output 2 times:
+      """
+        I run before every test!
+      """
+
+
+  Scenario: After hook
+
+    Given a specdown directory with a markdown file with THREE tests
+    And an environment file with the following after hook:
+      """
+        Specdown.after do
+          puts "I run after every test!"
+        end
+      """
+
+    When I run the specdown command for that directory
+
+    Then I should see the following output 3 times:
+      """
+        I run after every test!
+      """
+
+
+  Scenario: Around hook
+
+    Given a specdown directory with a markdown file with ONE test
+    And an environment file with the following around hook:
+      """
+        Specdown.around do
+          puts "I run before and after every test!"
+        end
+      """
+
+    When I run the specdown command for that directory
+
+    Then I should see the following output 2 times:
+      """
+        I run before and after every test!
+      """
+
+  @focus
+  Scenario: Scoped hooks
+    Given a specdown directory containing markdown files named "spec1.fun.markdown", "spec2.fun.markdown", and "spec3.markdown" each containing a single test
+    And an environment file with the following hooks:
+      """
+        Specdown.around /fun/ do
+          puts "I run before and after fun tests."
+        end
+
+        Specdown.before "spec3.markdown" do
+          puts "I run before tests in spec3"
+        end
+
+        Specdown.after "spec1.markdown", /spec3/ do
+          puts "I run after tests in spec1 and spec3."
+        end
+      """
+
+    When I run the specdown command for that directory
+
+    Then I should see the following output 4 times:
+      """
+        I run before and after fun tests.
+      """
+
+    And I should see the following output 1 time:
+      """
+        I run before tests in spec3
+      """
+
+    And I should see the following output 2 times:
+      """
+        I run after tests in spec1 and spec3
+      """

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

@@ -0,0 +1 @@
+Specdown::Config.expectations = :rspec

data/features/specdown_examples/after_hooks/specdown/hooks.rb

@@ -0,0 +1,3 @@
+Specdown.after do
+  puts "I run after every test!" 
+end

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

@@ -0,0 +1,21 @@
+# Specdown Example
+
+This is an example specdown file.
+
+## Child Node
+
+This section is a child node. It contains some ruby code: 
+    
+    "simple code".should_not be(nil)
+
+## First Leaf
+
+This section has a failure simulation:
+    
+    raise "specdown error simulation!"
+
+## Last Leaf
+
+This section is a leaf node. It contains some ruby code:
+    
+    1.should satisfy(&:odd?)

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

@@ -0,0 +1 @@
+Specdown::Config.expectations = :rspec

data/features/specdown_examples/around_hooks/specdown/hooks.rb

@@ -0,0 +1,3 @@
+Specdown.around do
+  puts "I run before and after every test!" 
+end

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

@@ -0,0 +1,9 @@
+# Specdown Example
+
+This is an example specdown file.
+
+## Child Node
+
+This section is a child node. It contains some ruby code: 
+    
+    "simple code".should_not be(nil)

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

@@ -0,0 +1 @@
+Specdown::Config.expectations = :rspec

data/features/specdown_examples/before_hooks/specdown/hooks.rb

@@ -0,0 +1,3 @@
+Specdown.before do
+  puts "I run before every test!" 
+end

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

@@ -0,0 +1,22 @@
+# Specdown Example
+
+This is an example specdown file.
+
+## Child Node
+
+This section is a child node. It contains some ruby code: 
+    
+    "simple code".should_not be(nil)
+
+### First Leaf
+
+This section has a failure simulation:
+    
+    raise "specdown error simulation!"
+
+## Last Leaf
+
+This section is a leaf node. It contains some ruby code:
+    
+    1.should satisfy(&:odd?)
+

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

@@ -0,0 +1 @@
+Specdown::Config.expectations = :rspec

data/features/specdown_examples/scoped_hooks/specdown/hooks.rb

@@ -0,0 +1,11 @@
+Specdown.around /fun/ do
+  puts "I run before and after fun tests."
+end
+
+Specdown.before "spec3.markdown" do
+  puts "I run before tests in spec3"
+end
+
+Specdown.after "spec1.fun.markdown", /spec3/ do
+  puts "I run after tests in spec1 and spec3."
+end

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

@@ -0,0 +1,21 @@
+# Specdown Example
+
+This is an example specdown file.
+
+## Child Node
+
+This section is a child node. It contains some ruby code: 
+    
+    "simple code".should_not be(nil)
+
+## First Leaf
+
+This section has a failure simulation:
+    
+    raise "specdown error simulation!"
+
+## Last Leaf
+
+This section is a leaf node. It contains some ruby code:
+    
+    1.should satisfy(&:odd?)

data/features/specdown_examples/scoped_hooks/specdown/spec1.fun.markdown

@@ -0,0 +1,9 @@
+# Specdown Example
+
+This is an example specdown file.
+
+## Child Node
+
+This section is a child node. It contains some ruby code: 
+    
+    "simple code".should_not be(nil)

data/features/specdown_examples/scoped_hooks/specdown/spec2.fun.markdown

@@ -0,0 +1,10 @@
+# Specdown Example
+
+This is an example specdown file.
+
+## Child Node
+
+This section is a child node. It contains some ruby code: 
+    
+    "simple code".should_not be(nil)
+

data/features/specdown_examples/scoped_hooks/specdown/spec3.markdown

@@ -0,0 +1,10 @@
+# Specdown Example
+
+This is an example specdown file.
+
+## Child Node
+
+This section is a child node. It contains some ruby code: 
+    
+    "simple code".should_not be(nil)
+

data/features/step_definitions/hooks.rb

@@ -0,0 +1,35 @@
+Given /^a specdown directory with a markdown file with TWO tests$/ do
+end
+
+Given /^an environment file with the following before hook:$/ do |string|
+  @directory = "features/specdown_examples/before_hooks"
+end
+
+When /^I run the specdown command for that directory$/ do
+  @output = `cd #{@directory} && bundle exec ruby -I ../../../lib ../../../bin/specdown`
+end
+
+Then /^I should see the following output (\d+) times?:$/ do |n, string|
+  @output.split("\n").select {|line| line.strip =~ /#{string.strip}/}.count.should == n.to_i
+end
+
+Given /^a specdown directory with a markdown file with THREE tests$/ do
+end
+
+Given /^an environment file with the following after hook:$/ do |string|
+  @directory = "features/specdown_examples/after_hooks"
+end
+
+Given /^a specdown directory with a markdown file with ONE test$/ do
+end
+
+Given /^an environment file with the following around hook:$/ do |string|
+  @directory = "features/specdown_examples/around_hooks"
+end
+
+Given /^a specdown directory containing markdown files named ".*" each containing a single test$/ do
+  @directory = "features/specdown_examples/scoped_hooks"
+end
+
+Given /^an environment file with the following hooks:$/ do |string|
+end

data/features/support/hooks.rb

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

data/lib/specdown.rb

@@ -7,6 +7,8 @@ require 'specdown/runner/report'
 require 'specdown/runner/stats'
 require 'specdown/command'
 require 'specdown/event_server'
+require 'specdown/event_handlers/before_test'
+require 'specdown/event_handlers/after_test'
 require 'specdown/event_handlers/command_complete'
 require 'specdown/event_handlers/run_complete'
 require 'specdown/event_handlers/run_started'
@@ -15,3 +17,5 @@ require 'specdown/event_handlers/test_passed'
 require 'specdown/config'
 require 'specdown/specdown'
 require 'specdown/sandbox_factory'
+require 'specdown/hooks'
+require 'specdown/hook'

data/lib/specdown/event_handlers/after_test.rb

@@ -0,0 +1,4 @@
+Specdown::EventServer.register :after_test do |runner|
+  Specdown::Hooks.matching_after_hooks(runner.file_name).map  &:call
+  Specdown::Hooks.matching_around_hooks(runner.file_name).map &:call
+end

data/lib/specdown/event_handlers/before_test.rb

@@ -0,0 +1,4 @@
+Specdown::EventServer.register :before_test do |runner|
+  Specdown::Hooks.matching_before_hooks(runner.file_name).map &:call
+  Specdown::Hooks.matching_around_hooks(runner.file_name).map &:call
+end

data/lib/specdown/hook.rb

@@ -0,0 +1,20 @@
+module Specdown
+  class Hook
+    def initialize(*filters, &callback)
+      @filters = filters
+      @callback = callback
+    end
+
+    def matches?(filename)
+      return true if @filters.empty?
+
+      @filters.any? do |filter| 
+        filter == filename || filter.match(filename)
+      end
+    end
+
+    def call
+      @callback.call
+    end
+  end
+end

data/lib/specdown/hooks.rb

@@ -0,0 +1,40 @@
+module Specdown
+  module Hooks
+    extend self
+
+    def reset!
+      @before = []
+      @after  = []
+      @around = []
+    end
+
+    def matching_before_hooks(filename)
+      filter before, filename
+    end
+
+    def matching_after_hooks(filename)
+      filter after, filename
+    end
+
+    def matching_around_hooks(filename)
+      filter around, filename
+    end
+    
+    def before
+      @before ||= []
+    end
+
+    def after
+      @after  ||= []
+    end
+
+    def around
+      @around ||= []
+    end
+
+    private
+    def filter(hooks, filename)
+      hooks.select {|hook| hook.matches? filename}
+    end
+  end
+end

data/lib/specdown/runner.rb

@@ -13,15 +13,18 @@ module Specdown
     end
 
     def run
+      EventServer.event :run_starting, self
       depth_first_search @tree.root
-      EventServer.event :run_complete
+      EventServer.event :run_complete, self
       self
     end
 
     private
     def depth_first_search(node, code=[])
       if node.children.empty?
+        EventServer.event :before_test, self
         execute_test(code + [node.code])
+        EventServer.event :after_test, self
       else
         node.children.each do |child|
           depth_first_search(child, (code + [node.code]))
@@ -37,13 +40,12 @@ module Specdown
           #{code.join("\n")}
         CODE
 
-        EventServer.event :test_passed
+        EventServer.event :test_passed, self
 
       rescue Exception => e
         @stats.exceptions << e
 
-        EventServer.event :test_failed
-
+        EventServer.event :test_failed, self
       end
     end
   end

data/lib/specdown/specdown.rb

@@ -1,7 +1,24 @@
 module Specdown
   extend self
   
+  def reset!
+    Config.reset!
+    Hooks.reset!
+  end
+
   def sandbox
     SandboxFactory.generate
   end
+
+  def before(*filters, &callback)
+    Hooks.before << Hook.new(*filters, &callback)
+  end
+
+  def after(*filters, &callback)
+    Hooks.after << Hook.new(*filters, &callback)
+  end
+
+  def around(*filters, &callback)
+    Hooks.around << Hook.new(*filters, &callback)
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: specdown
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 31
   prerelease: 
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Matt Parker
@@ -73,12 +73,16 @@ extra_rdoc_files:
 files: 
 - lib/specdown/command.rb
 - lib/specdown/config.rb
+- lib/specdown/event_handlers/after_test.rb
+- lib/specdown/event_handlers/before_test.rb
 - lib/specdown/event_handlers/command_complete.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/hook.rb
+- lib/specdown/hooks.rb
 - lib/specdown/node.rb
 - lib/specdown/parser.rb
 - lib/specdown/runner/report.rb
@@ -95,15 +99,32 @@ files:
 - features/config.feature
 - features/event_server.feature
 - features/fixtures/parser_example.markdown
+- features/hooks.feature
 - features/parser.feature
 - features/report.feature
 - features/runner.feature
+- features/specdown_examples/after_hooks/specdown/env.rb
+- features/specdown_examples/after_hooks/specdown/hooks.rb
+- features/specdown_examples/after_hooks/specdown/parser_example.markdown
+- features/specdown_examples/around_hooks/specdown/env.rb
+- features/specdown_examples/around_hooks/specdown/hooks.rb
+- features/specdown_examples/around_hooks/specdown/parser_example.markdown
+- features/specdown_examples/before_hooks/specdown/env.rb
+- features/specdown_examples/before_hooks/specdown/hooks.rb
+- features/specdown_examples/before_hooks/specdown/parser_example.markdown
 - features/specdown_examples/no_ruby/specdown/parser_example.markdown
+- features/specdown_examples/scoped_hooks/specdown/env.rb
+- features/specdown_examples/scoped_hooks/specdown/hooks.rb
+- features/specdown_examples/scoped_hooks/specdown/parser_example.markdown
+- features/specdown_examples/scoped_hooks/specdown/spec1.fun.markdown
+- features/specdown_examples/scoped_hooks/specdown/spec2.fun.markdown
+- features/specdown_examples/scoped_hooks/specdown/spec3.markdown
 - 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/hooks.rb
 - features/step_definitions/parser.rb
 - features/step_definitions/report.rb
 - features/step_definitions/runner.rb
@@ -147,15 +168,32 @@ test_files:
 - features/config.feature
 - features/event_server.feature
 - features/fixtures/parser_example.markdown
+- features/hooks.feature
 - features/parser.feature
 - features/report.feature
 - features/runner.feature
+- features/specdown_examples/after_hooks/specdown/env.rb
+- features/specdown_examples/after_hooks/specdown/hooks.rb
+- features/specdown_examples/after_hooks/specdown/parser_example.markdown
+- features/specdown_examples/around_hooks/specdown/env.rb
+- features/specdown_examples/around_hooks/specdown/hooks.rb
+- features/specdown_examples/around_hooks/specdown/parser_example.markdown
+- features/specdown_examples/before_hooks/specdown/env.rb
+- features/specdown_examples/before_hooks/specdown/hooks.rb
+- features/specdown_examples/before_hooks/specdown/parser_example.markdown
 - features/specdown_examples/no_ruby/specdown/parser_example.markdown
+- features/specdown_examples/scoped_hooks/specdown/env.rb
+- features/specdown_examples/scoped_hooks/specdown/hooks.rb
+- features/specdown_examples/scoped_hooks/specdown/parser_example.markdown
+- features/specdown_examples/scoped_hooks/specdown/spec1.fun.markdown
+- features/specdown_examples/scoped_hooks/specdown/spec2.fun.markdown
+- features/specdown_examples/scoped_hooks/specdown/spec3.markdown
 - 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/hooks.rb
 - features/step_definitions/parser.rb
 - features/step_definitions/report.rb
 - features/step_definitions/runner.rb