specdown 0.3.0 → 0.4.0.beta.1

data/features/parser.feature

@@ -171,7 +171,6 @@ Feature: Specdown Parser
       """
 
 
-  @focus
   Scenario: Multiple code blocks in a section should join together with newlines
 
     Given the following specdown example file containing multiple executable codeblocks in a single section:
@@ -198,3 +197,72 @@ Feature: Specdown Parser
       """
         @tree.root.code.should == "hi = 'hello'\nputs hi"
       """
+
+  @focus
+  Scenario: Code blocks + Undefined Implicit Specs
+
+    Given the following README:
+      """
+      @readme = <<-README.undent
+        # Specdown Example
+
+        **This is an implicit spec.**
+
+        This text has two implicit specs: **one** and **two**.
+
+        ```ruby
+        hi = "explicit spec"
+        ```
+      README
+      """
+
+    When I parse it into a tree:
+      """
+        @tree = Specdown::Parser.parse @readme
+      """
+
+    Then the root node should include the explicit code:
+      """
+        @tree.root.code.should == %{hi = "explicit spec"}
+      """ 
+      
+    And the root node should include the undefined implicit specs:
+      """
+        @tree.root.undefined_implicits.should == ["This is an implicit spec.", "one", "two"]
+      """
+
+  @focus
+  Scenario: Code blocks + Defined Implicit Specs
+
+    Given the following README:
+      """
+      @readme = <<-README.undent
+        # Specdown Example
+
+        **This is an implicit spec.**
+
+        ```ruby
+        hi = "explicit spec"
+        ```
+      README
+      """
+
+    And the following implicit specs:
+      """
+        @implicits = <<-SPECDOWN.undent
+          This is an implicit spec.
+          -----------------------------
+
+              puts "howdy"
+        SPECDOWN
+      """
+
+    When I parse it into a tree:
+      """
+        @tree = Specdown::Parser.parse @readme, Specdown::ImplicitParser.parse(@implicits)
+      """
+
+    Then the code block and the implicit spec should be joined together:
+      """
+        @tree.root.code.should == %{puts "howdy"\nhi = "explicit spec"}
+      """

data/features/pending_specs.feature

@@ -0,0 +1,49 @@
+Feature: Pending specs
+
+  You can mark a spec as pending by using the "pending" method.
+
+  For example, consider the following markdown file:
+
+      Example of Pending Specification
+      -----------------------------------
+
+      This spec is pending.
+
+          pending
+ 
+ 
+  If you ran this with specdown, you'd receive the following output:
+
+
+      P
+
+      1 markdown
+      1 test
+      1 pending
+      0 successes
+      0 failures
+
+
+  Scenario: Pending specification
+
+    Given the following markdown with a pending spec:
+      """
+      # Example of Pending Specification
+
+      This spec is pending.
+      
+      ```ruby
+      pending
+      ```
+      """
+
+   Then the `specdown` command should return the following output:
+      """
+      P
+
+      1 markdown
+      1 test
+      1 pending
+      0 successes
+      0 failures
+      """

data/features/report_summary.feature

@@ -12,7 +12,7 @@ Feature: Specdown::ReportSummary
   
   Scenario: A Specdown::Reporter instantiated with a single stats object
 
-    Given the following specdown example file located at 'features/fixtures/parser_example.markdown':
+    Given the following specdown example file:
       """
       # Specdown Example
 

data/features/specdown_examples/complete_implicit/specdown/implicit.specdown

@@ -0,0 +1,4 @@
+An implicit spec.
+--------------------------
+
+    raise "oops!" unless 1 == 1 

data/features/specdown_examples/complete_implicit/specdown/test.markdown

@@ -0,0 +1,3 @@
+# Heading
+
+**An implicit spec.**

data/features/specdown_examples/no_implicit/specdown/test.markdown

@@ -0,0 +1,3 @@
+# Heading
+
+**An implicit spec.**

data/features/specdown_examples/pending_implicit/specdown/implicit.specdown

@@ -0,0 +1,4 @@
+An implicit spec.
+--------------------------
+
+    pending

data/features/specdown_examples/pending_implicit/specdown/test.markdown

@@ -0,0 +1,3 @@
+# Heading
+
+**An implicit spec.**

data/features/specdown_examples/pending_specs/specdown/test.markdown

@@ -0,0 +1,7 @@
+# Example of Pending Specification
+
+This spec is pending.
+
+```ruby
+pending
+```

data/features/step_definitions/command.rb

@@ -3,9 +3,7 @@ When /^I run `specdown` from the command line in a directory that contains no 's
 end
 
 Then /^I should see the following output:$/ do |string|
-  string.split("\n").each do |line|
-    @output.should include(line.strip)
-  end
+  ensure_included! string, @output
 end
 
 Given /^I have a specdown directory containing a (?:single )?markdown file:$/ do |string|
@@ -106,6 +104,12 @@ Given /^`specdown \-\-format=condensed`$/ do
   ensure_condensed! bundle_exec!("specdown --format=condensed")
 end
 
+def ensure_included!(desired, actual)
+  desired.split("\n").each do |line|
+    actual.should include(line.strip)
+  end
+end
+
 def ensure_condensed!(output)
   output.strip.should_not be_empty
   output.should match(/^[^\. ]+\.markdown: .*$/)

data/features/step_definitions/implicit_parser.rb

@@ -0,0 +1,19 @@
+Given /^the following implicit specification:$/ do |string|
+  eval string
+end
+
+When /^I parse it with the implicit parser:$/ do |string|
+  eval string
+end
+
+Then /^I should receive a hash lookup of implicit definitions:$/ do |string|
+  eval string
+end
+
+Given /^two implicit specification strings:$/ do |string|
+  eval string
+end
+
+When /^I pass both off to the Specdown::ImplicitParser:$/ do |string|
+  eval string
+end

data/features/step_definitions/implicit_specs.rb

@@ -0,0 +1,18 @@
+Given /^a markdown file with an implicit spec:$/ do |string|
+end
+
+Given /^no implicit specification$/ do
+  @directory = "features/specdown_examples/no_implicit/"
+end
+
+When /^I run the `specdown` command$/ do
+  @output = bundle_exec! "specdown"
+end
+
+Given /^a specdown file with a pending specification:$/ do |string|
+  @directory = "features/specdown_examples/pending_implicit/"
+end
+
+Given /^a specdown file with a complete specification:$/ do |string|
+  @directory = "features/specdown_examples/complete_implicit/"
+end

data/features/step_definitions/parser.rb

@@ -10,6 +10,30 @@ Given /^the following specdown example file containing multiple executable codeb
   @readme = File.read "features/fixtures/multiple_codeblocks_per_section_example.markdown"
 end
 
+Given /^the following specdown example file containing both codeblocks and implicit specs:$/ do |string|
+  @readme = File.read "features/fixtures/codeblocks_and_implicits.markdown"
+end
+
+Given /^the following README:$/ do |string|
+  eval string
+end
+
+Then /^the root node should include the explicit code:$/ do |string|
+  eval string
+end
+
+Then /^the root node should include the undefined implicit specs:$/ do |string|
+  eval string
+end
+
+Given /^the following implicit specs:$/ do |string|
+  eval string
+end
+
+Then /^the code block and the implicit spec should be joined together:$/ do |string|
+  eval string
+end
+
 When /^I parse it into a tree:$/ do |string|
   eval string
 end

data/features/step_definitions/pending_specs.rb

@@ -0,0 +1,7 @@
+Given /^the following markdown with a pending spec:$/ do |string|
+  @directory = "features/specdown_examples/pending_specs/"
+end
+
+Then /^the `specdown` command should return the following output:$/ do |string|
+  ensure_included! string, bundle_exec!("specdown") 
+end

data/features/support/env.rb

@@ -1,3 +1,9 @@
 $LOAD_PATH.unshift './lib'
 require 'specdown'
 require 'rspec/expectations'
+
+class String
+  def undent
+    gsub(/^.{#{slice(/^ +/).length}}/, '')
+  end
+end

data/lib/specdown.rb

@@ -3,6 +3,7 @@ require 'term/ansicolor'
 require 'erb'
 require 'optparse'
 require 'specdown/parser'
+require 'specdown/implicit_parser'
 require 'specdown/node'
 require 'specdown/tree'
 require 'specdown/runner'
@@ -17,6 +18,10 @@ 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/event_handlers/test_pending'
+require 'specdown/event_handlers/test_undefined'
+require 'specdown/pending'
+require 'specdown/pending_exception'
 require 'specdown/config'
 require 'specdown/specdown'
 require 'specdown/sandbox_factory'
@@ -31,3 +36,4 @@ require 'specdown/reporters/text_reporter'
 require 'specdown/sandbox_decorators/default_assertion_library'
 require 'specdown/sandbox_decorators/rspec_expectations'
 require 'specdown/sandbox_decorators/test_unit_assertions'
+require 'specdown/sandbox_decorators/pending'

data/lib/specdown/config.rb

@@ -9,7 +9,7 @@ module Specdown
     attr_accessor :format
 
     def format
-      @format ||= :short
+      @format ||= :condensed
     end
 
     def reporter
@@ -35,6 +35,12 @@ module Specdown
       @tests ||= find_tests_in root
     end
 
+    def implicit_specs
+      return @implicit_specs if @implicit_specs
+      implicit_spec_files = find_implicit_specs_in(root).map {|file| File.read(file)}
+      @implicit_specs = Specdown::ImplicitParser.parse *implicit_spec_files
+    end
+
     def tests=(test_files)
       unless test_files.empty?
         @tests = test_files
@@ -66,6 +72,11 @@ module Specdown
       Dir["#{directory}/**/*.markdown"] + Dir["#{directory}/**/*.md"]
     end
 
+    def find_implicit_specs_in(directory)
+      directory = strip_trailing_slash directory
+      Dir["#{directory}/**/*.specdown"]
+    end
+
     def strip_trailing_slash(string)
       if string[-1..-1] == "/"
         string[0...-1]

data/lib/specdown/event_handlers/test_pending.rb

@@ -0,0 +1,3 @@
+Specdown::EventServer.register :test_pending do
+  Specdown.reporter.print_pending nil
+end

data/lib/specdown/event_handlers/test_undefined.rb

@@ -0,0 +1,3 @@
+Specdown::EventServer.register :test_undefined do |test|
+  Specdown.reporter.print_undefined nil
+end

data/lib/specdown/implicit_parser.rb

@@ -0,0 +1,47 @@
+module Specdown
+  class ImplicitParser
+    def self.parse(*implicit_specifications)
+      self.new(*implicit_specifications).parse
+    end
+
+    def initialize(*implicit_specifications)
+      @specs = implicit_specifications
+      @lookups = {}
+    end
+
+    def parse
+      @specs.each do |spec|
+        kramdown = Kramdown::Document.new spec, :input => "GithubMarkdown"
+        build_lookup kramdown.root.children
+      end
+
+      @lookups
+    end
+
+    private
+    def build_lookup(parsed_elements)
+      scan_for_header parsed_elements
+      consume_section parsed_elements until parsed_elements.empty? 
+    end
+
+    def consume_section(parsed_elements)
+      key = parsed_elements.shift.options[:raw_text]
+      value = ""
+
+      while !parsed_elements.empty? && parsed_elements.first.type != :header
+        element        = parsed_elements.shift
+        value          += "\n" + element.value.to_s.strip if element.type == :codeblock && ([nil, "ruby", ""].include? element.options["language"])
+      end
+
+      @lookups[key] = value.strip
+    end
+
+    def scan_for_header(parsed_elements)
+      until parsed_elements.empty? || (
+        parsed_elements.first.type == :header
+      )
+        parsed_elements.shift
+      end
+    end
+  end
+end

data/lib/specdown/node.rb

@@ -1,11 +1,12 @@
 module Specdown
   class Node
-    attr_accessor :name, :code, :contents, :children, :parent
+    attr_accessor :name, :code, :undefined_implicits, :contents, :children, :parent
 
     def initialize
       @code = ''
       @contents = ''
       @children = []
+      @undefined_implicits = []
     end
 
     def code

data/lib/specdown/parser.rb

@@ -1,15 +1,22 @@
 module Specdown
-  module Parser
-    extend self
+  class Parser
+    def self.parse(readme, lookups={})
+      self.new(readme, lookups).parse
+    end
+
+    def initialize(readme, lookups={})
+      @readme   = readme
+      @lookups  = lookups
+    end
 
-    def parse(readme)
-      kramdown = Kramdown::Document.new readme, :input => "GithubMarkdown"
+    def parse
+      kramdown = Kramdown::Document.new @readme, :input => "GithubMarkdown"
       build_tree kramdown.root.children
     end
 
     private
     def build_tree(parsed_elements)
-      tree = Tree.new
+      tree = Specdown::Tree.new
       scan_for_root_node parsed_elements
       tree.root = consume_section parsed_elements unless parsed_elements.empty?
       consume_children parsed_elements, tree.root unless parsed_elements.empty?
@@ -43,7 +50,22 @@ module Specdown
 
       while !parsed_elements.empty? && parsed_elements.first.type != :header
         element        = parsed_elements.shift
-        node.code     += "\n" + element.value.to_s.strip if element.type == :codeblock && element.options["language"] == "ruby"
+
+        if element.type == :codeblock && element.options["language"] == "ruby"
+          node.code += "\n" + element.value.to_s.strip 
+
+        elsif has_implicits?(element)
+          gather_implicit_keys(element).each do |key|
+            value = @lookups[key]
+
+            if value
+              node.code += "\n" + value
+            else
+              node.undefined_implicits << key
+            end
+          end
+        end
+
         node.contents += element.value.to_s + element.children.map(&:value).join
       end
       node
@@ -56,5 +78,17 @@ module Specdown
         parsed_elements.shift
       end
     end
+
+    def has_implicits?(element)
+      element.type == :strong || element.children.map {|child| has_implicits?(child) }.any?
+    end
+
+    def gather_implicit_keys(element)
+      if element.type == :strong
+        [element.children.map(&:value).compact.join(" ")]
+      else
+        element.children.map {|child| gather_implicit_keys(child)}.flatten
+      end
+    end
   end
 end