specdown 0.1.5 → 0.1.6

data/CHANGELOG.markdown

@@ -1,5 +1,13 @@
 ## CHANGELOG
 
+## 0.1.6
+
+Command line option (-f or --format) for output format (plain|color).
+
+Command line option (-v or --version) for specdown version.
+
+Also, created an API for sandbox decoration. Send me your pull requests :-)
+
 ## 0.1.5
 
 Terminal output is now colorized, by default. To turn it off, add the following to your env.rb:
@@ -16,7 +24,7 @@ The `specdown` command now allows you to pass off directories of tests as well a
 
 The `specdown` command now accepts two options: -h and -r. 
 
-    Usage: specdown [file1 [file2 [file3....]]]
+    Usage: specdown [file|dir [file|dir [file|dir....]]]
         -r, --root SPECDOWN_DIR          defaults to ./specdown
         -h, --help                       Display this screen
 

data/README.markdown

@@ -220,6 +220,8 @@ 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.
 
+### Running specific files (or directories)
+
 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
@@ -227,12 +229,32 @@ $ specdown specdown/test.markdown
 $ specdown specdown/unit_tests
 ```
 
+### Overriding the default root directory
+
 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/
 ```
 
+### Output Format
+
+By default, `specdown` will output colorized terminal output. If you'd rather the output not be colorized, you can use the `-f terminal` switch:
+
+```sh
+$ specdown -f plain
+```
+
+The default format is `color`.
+
+You can also configure the report format in your Ruby code:
+
+```ruby
+Specdown::Config.reporter = :terminal
+```
+
+Note that this defaults to `:color_terminal`. Also, please note that command line options take precedence.
+
 ## TODO
 
 This library is still very new, but we are rapidly adding features to it. Here's what is on the immediate horizon:

data/VERSION

@@ -0,0 +1 @@
+0.1.6

data/features/command.feature

@@ -96,7 +96,6 @@ Feature: `specdown` command
      """
 
 
-  @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`
@@ -108,3 +107,14 @@ Feature: `specdown` command
         3 tests
         0 failures
       """
+
+  
+  @focus
+  Scenario: -f terminal format switch
+    Given I am in a directory with a 'specdown' folder
+    When I run `specdown -f plain`
+    Then I should not see colorized output
+    When I run `specdown`
+    Then I should see colorized output
+    When I run `specdown -f color`
+    Then I should see colorized output

data/features/reporter_factory.feature

@@ -4,16 +4,18 @@ Feature: Specdown::ReporterFactory
 
   The `Specdown::ReporterFactory` has an API that allows you to configure new decorators for reports. Use the `Specdown::ReporterFactory.decorate` method:
 
-      Specdown::ReporterFactory.decorate do |report|
+      Specdown::ReporterFactory.decorate do |reporter|
         if Specdown::Config.reporter == :color_terminal
-          report.extend MyDecoratorModule
+          reporter.extend MyDecoratorModule
         end
+
+        reporter
       end
 
   For example, if you configure specdown to output colorized terminal output (the default value for Specdown::Config.reporter, :color_terminal), then `Specdown::ReporterFactory` will mix the `Specdown::AnsiColor` decorator into your `Specdown::Reporter` instance.
 
       Specdown::Config.reporter = :color_terminal
-      Specdown::ReporterFactory.generate.ancestors.should include(Specdown::AnsiColor)
+      Specdown::ReporterFactory.generate.should be_kind_of(Specdown::AnsiColor)
 
 
   Scenario: Adding a new decorator to Specdown::ReporterFactory

data/features/sandbox_factory.feature

@@ -0,0 +1,55 @@
+Feature: Specdown::SandboxFactory
+
+  All of your tests run in a sandbox - a protected object namespace, configurable via a simple API.
+  
+  For example, let's imagine we've written an assertion library called `SimpleAssert`:
+
+      module SimpleAssert
+        def simple_assert(&block) 
+          raise "failed!" if block.call == false
+        end
+      end
+
+  We can configure Specdown to include our library in the sandbox via the `Specdown::SandboxFactory.decorate` API:
+      
+      Specdown::SandboxFactory.decorate do |sandbox|
+        sandbox.extend SimpleAssert
+      end
+
+  Now all sandboxes will respond to the `simple_assert` method. We could even make this configurable:
+
+      Specdown::SandboxFactory.decorate do |sandbox|
+        if Specdown::Config.expectations == :simple_assert
+          sandbox.extend SimpleAssert
+        end
+      end
+
+  Now you could add `Specdown::Config.expectations = :simple_assert` to your `specdown/support/env.rb` to use your own SimpleAssert library in your tests.
+
+  
+  Scenario: decorate sandbox with module 
+    
+    Given the following module:
+      """
+        module SimpleAssert
+          def simple_assert(&block) 
+            raise "failed!" if block.call == false
+          end
+        end
+      """
+
+    When I decorate the sandbox with it:
+      """
+        Specdown::SandboxFactory.decorate do |sandbox|
+          sandbox.extend SimpleAssert
+        end
+      """
+    
+    Then all sandboxes should include my module methods:
+      """
+        proc { 
+          Specdown::SandboxFactory.generate.instance_eval do
+            simple_assert { 1 == 1 }
+          end
+        }.should_not raise_exception
+      """

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

@@ -0,0 +1 @@
+Specdown::Config.reporter = :color_terminal

data/features/step_definitions/command.rb

@@ -24,6 +24,22 @@ Given /^I have a specdown directory 'specdown\/tests' containing 3 markdown file
   @directory = "features/specdown_examples/nested_directories_test/"
 end
 
+Given /^I am in a directory with a 'specdown' folder$/ do
+  @directory = "features/specdown_examples/format_switch_test/"
+end
+
 When /^I run `(.*)`$/ do |command|
   @output = `cd #{@directory} && bundle exec ruby -I ../../../lib ../../../bin/#{command}`
 end
+
+Then /^I should not see colorized output$/ do
+  raise "Oops! Output is colorized!" if colorized?(@output)
+end
+
+Then /^I should see colorized output$/ do
+  raise "Oops! Output is not colorized!" unless colorized?(@output)
+end
+
+def colorized?(output)
+  output.include? "\e[1m"
+end

data/features/step_definitions/sandbox_factory.rb

@@ -0,0 +1,11 @@
+Given /^the following module:$/ do |string|
+  eval string
+end
+
+When /^I decorate the sandbox with it:$/ do |string|
+  eval string
+end
+
+Then /^all sandboxes should include my module methods:$/ do |string|
+  eval string
+end

data/lib/specdown/command/option_parser.rb

@@ -16,10 +16,22 @@ module Specdown
           Specdown::Config.root = root
         end
 
-        opts.on '-h', '--help', 'Display this screen'  do
+        opts.on '-f', '--format plain|color', 'defaults to "color"' do |format|
+          case format
+            when 'plain' then Specdown::Config.reporter = :terminal
+            when 'color' then Specdown::Config.reporter = :color_terminal
+          end
+        end
+
+        opts.on_tail '-h', '--help', 'Display this screen'  do
           puts opts
           exit
         end
+
+        opts.on_tail "-v", "--version", "Show version" do
+          puts File.read(File.join(File.dirname(__FILE__), "../../../VERSION"))
+          exit
+        end
       end
     end
   end

data/lib/specdown/command.rb

@@ -1,8 +1,8 @@
 module Specdown
   class Command
     def execute
-      parse_options
       load_test_environment
+      parse_options
       run
     end
     

data/lib/specdown/reporter/terminal_reporter.rb

@@ -27,7 +27,8 @@ module Specdown
     end
 
     def format_stat(word, number)
-      "#{number} #{number == 1 ? word : word + "s"}"
+      plural_word = word[-2..-1] == "ss" ? "#{word}es" : "#{word}s"
+      "#{number} #{number == 1 ? word : plural_word}"
     end
   end
 end

data/lib/specdown/sandbox_decorators/default_assertion_library.rb

@@ -0,0 +1,11 @@
+Specdown::SandboxFactory.decorate do |sandbox|
+  if Specdown::Config.expectations.nil?
+    begin
+      require 'rspec/expectations'
+      sandbox.extend ::RSpec::Matchers
+    rescue LoadError => e
+      require 'test/unit/assertions'
+      sandbox.extend ::Test::Unit::Assertions 
+    end
+  end
+end

data/lib/specdown/sandbox_decorators/rspec_expectations.rb

@@ -0,0 +1,6 @@
+Specdown::SandboxFactory.decorate do |sandbox|
+  if Specdown::Config.expectations == :rspec
+    require 'rspec/expectations'
+    sandbox.extend ::RSpec::Matchers 
+  end
+end

data/lib/specdown/sandbox_decorators/test_unit_assertions.rb

@@ -0,0 +1,6 @@
+Specdown::SandboxFactory.decorate do |sandbox|
+  if Specdown::Config.expectations == :test_unit
+    require 'test/unit/assertions'
+    sandbox.extend ::Test::Unit::Assertions 
+  end
+end

data/lib/specdown/sandbox_factory.rb

@@ -4,53 +4,19 @@ module Specdown
 
     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
+        decorators.each do |decorator|
+          decorator.call sandbox
+        end
       end
     end
 
-    def default_expectations_setup
-      if rspec_installed?
-        rspec_expectations_setup 
-      else
-        test_unit_expectations_setup
-      end
+    def decorate(&block)
+      decorators << block
     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
+    private
+    def decorators
+      @decorators ||= []
     end
   end
 end

data/lib/specdown.rb

@@ -28,3 +28,6 @@ require 'specdown/runner/report_summary'
 require 'specdown/runner/exception_facade'
 require 'specdown/reporter/terminal_reporter'
 require 'specdown/reporter/color_terminal_reporter'
+require 'specdown/sandbox_decorators/default_assertion_library'
+require 'specdown/sandbox_decorators/rspec_expectations'
+require 'specdown/sandbox_decorators/test_unit_assertions'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: specdown
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 23
   prerelease: 
   segments: 
   - 0
   - 1
-  - 5
-  version: 0.1.5
+  - 6
+  version: 0.1.6
 platform: ruby
 authors: 
 - Matt Parker
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-08 00:00:00 Z
+date: 2012-01-10 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: kramdown
@@ -87,6 +87,7 @@ extra_rdoc_files:
 - CHANGELOG.markdown
 - README.markdown
 files: 
+- VERSION
 - lib/specdown/command/option_parser.rb
 - lib/specdown/command.rb
 - lib/specdown/config.rb
@@ -110,6 +111,9 @@ files:
 - lib/specdown/runner/reporter.rb
 - lib/specdown/runner/stats.rb
 - lib/specdown/runner.rb
+- lib/specdown/sandbox_decorators/default_assertion_library.rb
+- lib/specdown/sandbox_decorators/rspec_expectations.rb
+- lib/specdown/sandbox_decorators/test_unit_assertions.rb
 - lib/specdown/sandbox_factory.rb
 - lib/specdown/specdown.rb
 - lib/specdown/templates/color_summary.erb
@@ -130,6 +134,7 @@ files:
 - features/reporter.feature
 - features/reporter_factory.feature
 - features/runner.feature
+- features/sandbox_factory.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
@@ -139,6 +144,7 @@ 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/format_switch_test/specdown/env.rb
 - 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
@@ -163,6 +169,7 @@ files:
 - features/step_definitions/reporter.rb
 - features/step_definitions/reporter_factory.rb
 - features/step_definitions/runner.rb
+- features/step_definitions/sandbox_factory.rb
 - features/support/env.rb
 - features/support/hooks.rb
 homepage: http://github.com/moonmaster9000/specdown
@@ -210,6 +217,7 @@ test_files:
 - features/reporter.feature
 - features/reporter_factory.feature
 - features/runner.feature
+- features/sandbox_factory.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
@@ -219,6 +227,7 @@ 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/format_switch_test/specdown/env.rb
 - 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
@@ -243,5 +252,6 @@ test_files:
 - features/step_definitions/reporter.rb
 - features/step_definitions/reporter_factory.rb
 - features/step_definitions/runner.rb
+- features/step_definitions/sandbox_factory.rb
 - features/support/env.rb
 - features/support/hooks.rb