specdown 0.1.3 → 0.1.4

data/CHANGELOG.markdown

@@ -1,6 +1,12 @@
 ## CHANGELOG
 
-## 0.1.3
+## 0.1.4
+
+The `specdown` command now allows you to pass off directories of tests as well as individual tests.
+
+    specdown specdown/subdir/ specdown/test1.md specdown/subdir2/*.markdown
+
+## 0.1.3 (2012/01/02)
 
 The `specdown` command now accepts two options: -h and -r. 
 
@@ -8,7 +14,7 @@ The `specdown` command now accepts two options: -h and -r.
         -r, --root SPECDOWN_DIR          defaults to ./specdown
         -h, --help                       Display this screen
 
-## 0.1.2
+## 0.1.2 (2012/01/02)
 
 New feature added: test hooks. (see the README)
 

data/README.markdown

@@ -10,7 +10,7 @@ If you don't know what README DRIVEN DEVELOPMENT IS, checkout Tom Preston Werner
 
 ## 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).
+This library is very new. It has only a few features, but it's growing rapidly. 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
 
@@ -206,11 +206,29 @@ Specdown.before "somefile.markdown", /^.*\.database.markdown$/ do
 end
 ```
 
+## specdown command line
+
+You can run `specdown -h` at the command line to get USAGE and options.
+
+If you run `specdown` without any arguments, specdown will look for a "specdown" directory inside your current working directory, then search for any markdown files inside of it, and also load any ruby files inside of it.
+
+If you want to run just a single file or a set of files, or a directory of files, simply pass them on the command line:
+
+```sh
+$ specdown specdown/test.markdown
+$ specdown specdown/unit_tests
+```
+
+You can use the `-r` flag to specify the root of the specdown directory (it defaults to "specdown/"). 
+
+```sh
+$ specdown test.markdown -r specdown_environment/
+```
+
 ## 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:
+This library is still very new, but we are rapidly adding features to it. Here's what is on the immediate horizon:
 
-* Choose which files to run
 * 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,4 +1,4 @@
 #!/usr/bin/env ruby
 require 'specdown'
-
+STDOUT.sync = true
 Specdown::Command.new.execute

data/features/command.feature

@@ -94,3 +94,17 @@ Feature: `specdown` command
         In parser_example.markdown: <NoMethodError> undefined method `be'
         In parser_example.markdown: <NoMethodError> undefined method `satisfy'
      """
+
+
+  @focus
+  Scenario: `specdown` command invoked with a directory
+    Given I have a specdown directory 'specdown/tests' containing 3 markdown files, each with 1 passing test
+    When I run `specdown specdown/tests`
+    Then I should see the following output:
+      """
+        ...
+
+        3 markdowns
+        3 tests
+        0 failures
+      """

data/features/report.feature

@@ -1,16 +1,40 @@
 Feature: Report
   
-  Specdown comes with a generic reporting class. If you provide it with a runner's Specdown::Stats object (or an array of Specdown::Stats objects), then it will generate a report for you. 
+  Specdown comes with a generic reporting class. If you provide it with a runner (or an array of runners), then it will generate a report for you. 
 
-  For example, suppose we have the following Specdown::Stats instance:
+  
+  For example, suppose we have the following markdown file:
+      
+      \# 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 == nil
+
+      \### First Leaf
+
+      This section has a failure simulation:
+          
+          raise "specdown error simulation!"
+
+      \## Last Leaf
 
-      stats = Specdown::Stats.new
-      stats.tests = 3
-      stats.exceptions = [StandardError.new("error simulation")]
+      This section is a leaf node. It contains some ruby code:
+          
+          1.should == 1
+  
+  If we create a Specdown::Runner instance from it and run it:
+
+      runner = Specdown::Runner.new("/features/fixtures/parser_example.markdown")
+      runner.run
 
   We could then pass it off to our reporter class and receive the following report:
 
-      Specdown::Report.new(stats).generate.should == %{
+      Specdown::Report.new(runner).generate.should == %{
           1 markdown
           3 tests
           2 successes
@@ -21,37 +45,46 @@ Feature: Report
 
   
   Scenario: A Specdown::Report instantiated with a single stats object
-    
-    Given the following Specdown::Stats instance:
-      """
-        @stats        = Specdown::Stats.new
-        @stats.tests  = 3
-        @stats.exceptions << StandardError.new("error simulation")
-      """
 
-    Then `Specdown::Report.new(@stats).generate` should include the following output:
+    Given the following specdown example file located at 'features/fixtures/parser_example.markdown':
       """
-        1 markdown
-        3 tests
-        1 failure
+      # Specdown Example
 
-        error simulation
-      """
+      This is an example specdown file.
 
-  Scenario: A Specdown::Report instantiated with an array of stats
+      ## Child Node
 
-    Given the following of Specdown::Stats instances:
-      """
-        @results = [
-          Specdown::Stats.new.tap {|s| s.tests = 3 },
-          Specdown::Stats.new.tap {|s| s.tests = 1; s.exceptions << StandardError.new("error simulation") }
-        ]
+      This section is a child node. It contains some ruby code: 
+          
+          "simple code".should_not == 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 == 1
       """
     
-    Then `Specdown::Report.new(@results).generate` should include the following output:
+    And the following runner:
       """
-        2 markdowns
-        4 tests
+        @runner = Specdown::Runner.new("features/fixtures/parser_example.markdown")
+      """
+
+    When I run the tests in the runner:
+      """
+        @runner.run
+      """
+
+    Then `Specdown::Report.new(@runner).generate` should include the following output:
+      """
+        1 markdown
+        2 tests
         1 failure
 
         error simulation

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

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

data/features/specdown_examples/nested_directories_test/specdown/tests/1.markdown

@@ -0,0 +1,3 @@
+# Specdown Example
+
+This is an example specdown file.

data/features/specdown_examples/nested_directories_test/specdown/tests/2.markdown

@@ -0,0 +1,3 @@
+# Specdown Example
+
+This is an example specdown file.

data/features/specdown_examples/nested_directories_test/specdown/tests/3.markdown

@@ -0,0 +1,3 @@
+# Specdown Example
+
+This is an example specdown file.

data/features/step_definitions/command.rb

@@ -4,7 +4,7 @@ end
 
 Then /^I should see the following output:$/ do |string|
   string.split("\n").each do |line|
-    @output.include?(line.strip).should be(true)
+    @output.should include(line.strip)
   end
 end
 
@@ -19,3 +19,11 @@ end
 Given /^a single ruby file:$/ do |string|
   @directory = "features/specdown_examples/with_ruby/"
 end
+
+Given /^I have a specdown directory 'specdown\/tests' containing 3 markdown files, each with 1 passing test$/ do
+  @directory = "features/specdown_examples/nested_directories_test/"
+end
+
+When /^I run `(.*)`$/ do |command|
+  @output = `cd #{@directory} && bundle exec ruby -I ../../../lib ../../../bin/#{command}`
+end

data/features/step_definitions/report.rb

@@ -1,4 +1,8 @@
-Given /^the following Specdown::Stats instance:$/ do |string|
+Given /^the following runner:$/ do |string|
+  eval string
+end
+
+When /^I run the tests in the runner:$/ do |string|
   eval string
 end
 

data/lib/specdown/command/option_parser.rb

@@ -10,7 +10,7 @@ module Specdown
     private
     def parser
       ::OptionParser.new do |opts|
-        opts.banner = "Usage: specdown [file1 [file2 [file3....]]]"
+        opts.banner = "Usage: specdown -h | specdown [FILE|DIR]+ [-r]"
 
         opts.on '-r', '--root SPECDOWN_DIR', 'defaults to ./specdown' do |root|
           Specdown::Config.root = root

data/lib/specdown/command.rb

@@ -18,8 +18,16 @@ module Specdown
     end
 
     def run
-      @results = Specdown::Config.tests.map {|markdown| Runner.new(markdown).run.stats}
-      Specdown::EventServer.event :command_complete, @results
+      @results = []
+      
+      Kernel.at_exit do
+        Specdown::EventServer.event :command_complete, @results
+      end
+      
+      Specdown::Config.tests.each do |markdown| 
+        @results << Runner.new(markdown)
+        @results.last.run
+      end
     end
   end
 end

data/lib/specdown/config.rb

@@ -6,39 +6,59 @@ module Specdown
     attr_accessor :tests
     attr_accessor :root
     
-    def test_environment_files
-      unless @test_environment_files
-        @test_environment_files = Dir["#{root}/**/*.rb"]
-        unless root[0..0] == "/"
-          @test_environment_files.map! {|file| File.join Dir.pwd, file}
-        end
-      end
-
-      @test_environment_files
+    def reset!
+      self.expectations = nil
     end
-    
+
     def root
       @root ||= "specdown"
     end
 
     def root=(new_root)
-      if new_root[-1..-1] == "/"
-        @root = new_root[0...-1]
-      else
-        @root = new_root
-      end
+      @root = strip_trailing_slash new_root
     end
 
     def tests
-      @tests ||= Dir["#{root}/**/*.markdown"] + Dir["#{root}/**/*.md"]
+      @tests ||= find_tests_in root
     end
 
     def tests=(test_files)
-      @tests = test_files unless test_files.empty?
+      unless test_files.empty?
+        @tests = test_files
+
+        @tests.map! do |test_dir|
+          if File.directory? test_dir
+            find_tests_in test_dir
+          else
+            test_dir
+          end
+        end.flatten!
+      end
     end
+    
+    def test_environment_files
+      unless @test_environment_files
+        @test_environment_files = Dir["#{root}/**/*.rb"]
+        unless root[0..0] == "/"
+          @test_environment_files.map! {|file| File.join Dir.pwd, file}
+        end
+      end
 
-    def reset!
-      self.expectations = nil
+      @test_environment_files
+    end
+
+    private
+    def find_tests_in(directory)
+      directory = strip_trailing_slash directory
+      Dir["#{directory}/**/*.markdown"] + Dir["#{directory}/**/*.md"]
+    end
+
+    def strip_trailing_slash(string)
+      if string[-1..-1] == "/"
+        string[0...-1]
+      else
+        string
+      end
     end
   end
 end

data/lib/specdown/runner/report.rb

@@ -1,11 +1,8 @@
 module Specdown
   class Report
-    def initialize(stats)
-      if stats.kind_of? Array
-        @stats = stats
-      else
-        @stats = [stats]
-      end
+    def initialize(runners)
+      runners = [runners] unless runners.respond_to?(:map)
+      @stats = runners.map &:stats
     end
     
     def generate

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: specdown
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 19
   prerelease: 
   segments: 
   - 0
   - 1
-  - 3
-  version: 0.1.3
+  - 4
+  version: 0.1.4
 platform: ruby
 authors: 
 - Matt Parker
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-02 00:00:00 Z
+date: 2012-01-04 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: kramdown
@@ -113,6 +113,10 @@ files:
 - 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/nested_directories_test/specdown/env.rb
+- features/specdown_examples/nested_directories_test/specdown/tests/1.markdown
+- features/specdown_examples/nested_directories_test/specdown/tests/2.markdown
+- features/specdown_examples/nested_directories_test/specdown/tests/3.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
@@ -182,6 +186,10 @@ test_files:
 - 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/nested_directories_test/specdown/env.rb
+- features/specdown_examples/nested_directories_test/specdown/tests/1.markdown
+- features/specdown_examples/nested_directories_test/specdown/tests/2.markdown
+- features/specdown_examples/nested_directories_test/specdown/tests/3.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