cucumber 0.7.3 → 0.8.0

data/features/custom_formatter.feature

@@ -14,7 +14,8 @@ Feature: Custom Formatter
     Given a standard Cucumber project directory structure
     And a file named "features/f.feature" with:
       """
-      Feature: i'll use my own
+      Feature: I'll use my own
+        because I'm worth it
         Scenario: just print me
           Given this step works
       """
@@ -32,8 +33,12 @@ Feature: Custom Formatter
             @io = io
           end
 
+          def before_feature(feature)
+            @io.puts feature.short_name.upcase
+          end
+
           def scenario_name(keyword, name, file_colon_line, source_indent)
-            @io.puts "$ #{name.upcase}"
+            @io.puts "  #{name.upcase}"
           end
         end
       end
@@ -42,7 +47,8 @@ Feature: Custom Formatter
     Then STDERR should be empty
     Then it should pass with
       """
-      $ JUST PRINT ME
+      I'LL USE MY OWN
+        JUST PRINT ME
 
       """
 

data/features/json_formatter.feature

@@ -0,0 +1,281 @@
+Feature: JSON output formatter
+  In order to get results as data
+  As a developer
+  Cucumber should be able to output JSON
+
+  Background:
+    Given I am in json
+
+  Scenario: one feature, one passing scenario, one failing scenario
+    And the tmp directory is empty
+    When I run cucumber --format json --out tmp/out.json features/one_passing_one_failing.feature
+    Then STDERR should be empty
+    And it should fail with
+      """
+      """
+    And "examples/json/tmp/out.json" should match "^\{\"features\":\["
+
+  Scenario: one feature, one passing scenario, one failing scenario
+    When I run cucumber --format json_pretty features/one_passing_one_failing.feature
+    Then STDERR should be empty
+    And it should fail with JSON
+      """
+      {
+        "features": [
+          {
+            "file": "features/one_passing_one_failing.feature",
+            "name": "One passing scenario, one failing scenario",
+            "tags": [
+              "@a"
+            ],
+            "elements": [
+              {
+                "tags": [
+                  "@b"
+                ],
+                "keyword": "Scenario",
+                "name": "Passing",
+                "file_colon_line": "features/one_passing_one_failing.feature:5",
+                "steps": [
+                  {
+                    "status": "passed",
+                    "name": "Given a passing step",
+                    "file_colon_line": "features/step_definitions/steps.rb:1"
+                  }
+                ]
+              },
+              {
+                "tags": [
+                  "@c"
+                ],
+                "keyword": "Scenario",
+                "name": "Failing",
+                "file_colon_line": "features/one_passing_one_failing.feature:9",
+                "steps": [
+                  {
+                    "exception": {
+                      "class": "RuntimeError",
+                      "message": "",
+                      "backtrace": [
+                        "./features/step_definitions/steps.rb:6:in `/a failing step/'",
+                        "features/one_passing_one_failing.feature:10:in `Given a failing step'"
+                      ]
+                    },
+                    "status": "failed",
+                    "name": "Given a failing step",
+                    "file_colon_line": "features/step_definitions/steps.rb:5"
+                  }
+                ]
+              }
+            ]
+          }
+        ]
+      }
+      """
+
+  Scenario: Tables
+    When I run cucumber --format json_pretty features/tables.feature
+    Then STDERR should be empty
+    And it should fail with JSON
+      """
+      {
+        "features": [
+          {
+            "file": "features/tables.feature",
+            "name": "A scenario outline",
+            "tags": [
+
+            ],
+            "elements": [
+              {
+                "tags": [
+
+                ],
+                "keyword": "Scenario Outline",
+                "name": "",
+                "file_colon_line": "features/tables.feature:3",
+                "steps": [
+                  {
+                    "status": "skipped",
+                    "name": "Given I add <a> and <b>",
+                    "file_colon_line": "features/step_definitions/steps.rb:13"
+                  },
+                  {
+                    "status": "skipped",
+                    "name": "When I pass a table argument",
+                    "file_colon_line": "features/step_definitions/steps.rb:25",
+                    "table": [
+                      {"cells":
+                        [{"text":"foo", "status": null},
+                         {"text":"bar", "status": null}]},
+                      {"cells":
+                        [{"text": "bar", "status": null},
+                         {"text": "baz", "status": null}]}
+                    ]
+                  },
+                  {
+                     "status": "skipped",
+                     "name": "Then I the result should be <c>",
+                     "file_colon_line": "features/step_definitions/steps.rb:17"
+                  }
+                ],
+                "examples": {
+                  "name": "Examples ",
+                  "table": [
+                    {
+                      "cells": [
+                        {
+                          "text": "a",
+                          "status": "skipped_param"
+                        },
+                        {
+                          "text": "b",
+                          "status": "skipped_param"
+                        },
+                        {
+                          "text": "c",
+                          "status": "skipped_param"
+                        }
+                      ]
+                    },
+                    {
+                      "cells": [
+                        {
+                          "text": "1",
+                          "status": "passed"
+                        },
+                        {
+                          "text": "2",
+                          "status": "passed"
+                        },
+                        {
+                          "text": "3",
+                          "status": "passed"
+                        }
+                      ]
+                    },
+                    {
+                      "cells": [
+                        {
+                          "text": "2",
+                          "status": "passed"
+                        },
+                        {
+                          "text": "3",
+                          "status": "passed"
+                        },
+                        {
+                          "text": "4",
+                          "status": "failed"
+                        }
+                      ],
+                      "exception": {
+                        "class": "RSpec::Expectations::ExpectationNotMetError",
+                        "message": "expected: 4,\n     got: 5 (using ==)\nDiff:\n@@ -1,2 +1,2 @@\n-4\n+5\n",
+                        "backtrace": [
+                          "./features/step_definitions/steps.rb:18:in `/^I the result should be (\\d+)$/'",
+                          "features/tables.feature:8:in `Then I the result should be <c>'"
+                        ]
+                      }
+                    }
+                  ]
+                }
+              }
+            ]
+          }
+        ]
+      }
+      """
+
+  Scenario: pystring
+    When I run cucumber --format json_pretty features/pystring.feature
+    Then STDERR should be empty
+    And it should pass with JSON
+    """
+      {
+        "features": [
+          {
+            "file": "features/pystring.feature",
+            "name": "A py string feature",
+            "tags": [
+
+            ],
+            "elements": [
+              {
+                "tags": [
+
+                ],
+                "keyword": "Scenario",
+                "name": "",
+                "file_colon_line": "features/pystring.feature:3",
+                "steps": [
+                  {
+                    "status": "passed",
+                    "name": "Then I should see",
+                    "file_colon_line": "features/step_definitions/steps.rb:21",
+                    "py_string": "a string"
+                  }
+                ]
+              }
+            ]
+          }
+        ]
+      }
+    """
+
+  Scenario: background
+    When I run cucumber --format json_pretty features/background.feature
+    Then STDERR should be empty
+    And it should fail with JSON
+    """
+    {
+      "features": [
+        {
+          "file": "features/background.feature",
+          "name": "Feature with background",
+          "tags": [
+
+          ],
+          "background": {
+            "steps": [
+              {
+                "status": "passed",
+                "name": "Given a passing step",
+                "file_colon_line": "features/step_definitions/steps.rb:1"
+              }
+            ]
+          },
+          "elements": [
+            {
+              "tags": [
+
+              ],
+              "keyword": "Scenario",
+              "name": "",
+              "file_colon_line": "features/background.feature:6",
+              "steps": [
+                {
+                  "status": "passed",
+                  "name": "Given a passing step",
+                  "file_colon_line": "features/step_definitions/steps.rb:1"
+                },
+                {
+                  "exception": {
+                    "class": "RuntimeError",
+                    "message": "",
+                    "backtrace": [
+                      "./features/step_definitions/steps.rb:6:in `/a failing step/'",
+                      "features/background.feature:7:in `Given a failing step'"
+                    ]
+                  },
+                  "status": "failed",
+                  "name": "Given a failing step",
+                  "file_colon_line": "features/step_definitions/steps.rb:5"
+                }
+              ]
+            }
+          ]
+        }
+      ]
+    }
+    """

data/features/step_definitions/cucumber_steps.rb

@@ -84,6 +84,11 @@ Then /^the output should be$/ do |text|
   last_stdout.should == text
 end
 
+Then /^it should (fail|pass) with JSON$/ do |success, text|
+  JSON.parse(last_stdout).should == JSON.parse(text)
+  Then("it should #{success}")
+end
+
 Then /^"([^"]*)" should contain$/ do |file, text|
   strip_duration(IO.read(file)).should == text
 end
@@ -95,7 +100,7 @@ Then /^"([^"]*)" with junit duration "([^"]*)" should contain$/ do |actual_file,
   actual.should == text
 end
 
-Then /^"([^"]*)" should match "([^"]*)"$/ do |file, text|
+Then /^"([^"]*)" should match "(.+?)"$/ do |file, text|
   File.open(file, Cucumber.file_mode('r')).read.should =~ Regexp.new(text)
 end
 

data/gem_tasks/rspec.rake

@@ -2,7 +2,7 @@ begin
   require 'rspec/core/rake_task'
 
   desc "Run RSpec"
-  Rspec::Core::RakeTask.new do |t|
+  RSpec::Core::RakeTask.new do |t|
     t.rcov = ENV['RCOV']
     t.rcov_opts = %w{--exclude osx\/objc,gems\/,spec\/}
     t.verbose = true

data/lib/cucumber/ast/feature.rb

@@ -80,7 +80,7 @@ module Cucumber
 
       def short_name
         first_line = name.split(/\n/)[0]
-        if first_line =~ /#{language.keywords('feature', true)}:(.*)/
+        if first_line =~ /#{language.keywords('feature')}:(.*)/
           $1.strip
         else
           first_line

data/lib/cucumber/cli/configuration.rb

@@ -11,7 +11,7 @@ module Cucumber
 
     class Configuration
       include Constantize
-      
+
       attr_reader :options, :out_stream
 
       def initialize(out_stream = STDOUT, error_stream = STDERR)
@@ -48,10 +48,6 @@ module Cucumber
         @options[:guess]
       end
 
-      def diff_enabled?
-        @options[:diff_enabled]
-      end
-
       def drb?
         @options[:drb]
       end
@@ -85,11 +81,11 @@ module Cucumber
         files.reject! {|f| f =~ /^http/}
         files.sort
       end
-      
+
       def step_defs_to_load
         all_files_to_load.reject {|f| f =~ %r{/support/} }
       end
-      
+
       def support_to_load
         support_files = all_files_to_load.select {|f| f =~ %r{/support/} }
         env_files = support_files.select {|f| f =~ %r{/support/env\..*} }
@@ -106,14 +102,14 @@ module Cucumber
           elsif path[0..0] == '@' and # @listfile.txt
               File.file?(path[1..-1]) # listfile.txt is a file
             IO.read(path[1..-1]).split
-          else 
+          else
             path
           end
         end.flatten.uniq
         remove_excluded_files_from(potential_feature_files)
-        potential_feature_files.sort
+        potential_feature_files
       end
-      
+
       def feature_dirs
         paths.map { |f| File.directory?(f) ? f : File.dirname(f) }.uniq
       end
@@ -127,7 +123,7 @@ module Cucumber
       end
 
     private
-    
+
       def formatters(step_mother)
         # TODO: We should remove the autoformat functionality. That
         # can be done with the gherkin CLI.
@@ -181,7 +177,7 @@ module Cucumber
       def require_dirs
         feature_dirs + Dir['vendor/{gems,plugins}/*/cucumber']
       end
-      
+
     end
 
   end

data/lib/cucumber/cli/main.rb

@@ -55,8 +55,6 @@ module Cucumber
         features = step_mother.load_plain_text_features(configuration.feature_files)
         step_mother.load_code_files(configuration.step_defs_to_load)
 
-        enable_diffing
-
         tag_excess = tag_excess(features)
         configuration.options[:tag_excess] = tag_excess # Hack to make it available in console.rb - later: stick on Run instance.
 
@@ -99,12 +97,6 @@ module Cucumber
 
       private
 
-      def enable_diffing
-        if configuration.diff_enabled?
-          require 'cucumber/rspec/diffing'
-        end
-      end
-
       def trap_interrupt
         trap('INT') do
           exit!(1) if Cucumber.wants_to_quit

data/lib/cucumber/cli/options.rb

@@ -6,25 +6,28 @@ module Cucumber
   module Cli
 
     class Options
+      INDENT = ' ' * 53
       BUILTIN_FORMATS = {
-        'html'      => ['Cucumber::Formatter::Html',     'Generates a nice looking HTML report.'],
-        'pretty'    => ['Cucumber::Formatter::Pretty',   'Prints the feature as is - in colours.'],
-        'pdf'       => ['Cucumber::Formatter::Pdf',      "Generates a PDF report. You need to have the\n" +
-                                                         "#{' ' * 51}prawn gem installed. Will pick up logo from\n" +
-                                                         "#{' ' * 51}features/support/logo.png or\n" +
-                                                         "#{' ' * 51}features/support/logo.jpg if present."],
-        'progress'  => ['Cucumber::Formatter::Progress', 'Prints one character per scenario.'],
-        'rerun'     => ['Cucumber::Formatter::Rerun',    'Prints failing files with line numbers.'],
-        'usage'     => ['Cucumber::Formatter::Usage',    "Prints where step definitions are used.\n" +
-                                                         "#{' ' * 51}The slowest step definitions (with duration) are\n" +
-                                                         "#{' ' * 51}listed first. If --dry-run is used the duration\n" +
-                                                         "#{' ' * 51}is not shown, and step definitions are sorted by\n" +
-                                                         "#{' ' * 51}filename instead."],
-        'stepdefs'  => ['Cucumber::Formatter::Stepdefs', "Prints All step definitions with their locations. Same as\n" +
-                                                         "#{' ' * 51}the usage formatter, except that steps are not printed."],
-        'junit'     => ['Cucumber::Formatter::Junit',    'Generates a report similar to Ant+JUnit.'],
-        'tag_cloud' => ['Cucumber::Formatter::TagCloud', 'Prints a tag cloud of tag usage.'],
-        'debug'     => ['Cucumber::Formatter::Debug',    'For developing formatters - prints the calls made to the listeners.']
+        'html'        => ['Cucumber::Formatter::Html',        'Generates a nice looking HTML report.'],
+        'pretty'      => ['Cucumber::Formatter::Pretty',      'Prints the feature as is - in colours.'],
+        'pdf'         => ['Cucumber::Formatter::Pdf',         "Generates a PDF report. You need to have the\n" +
+                                                              "#{INDENT}prawn gem installed. Will pick up logo from\n" +
+                                                              "#{INDENT}features/support/logo.png or\n" +
+                                                              "#{INDENT}features/support/logo.jpg if present."],
+        'progress'    => ['Cucumber::Formatter::Progress',    'Prints one character per scenario.'],
+        'rerun'       => ['Cucumber::Formatter::Rerun',       'Prints failing files with line numbers.'],
+        'usage'       => ['Cucumber::Formatter::Usage',       "Prints where step definitions are used.\n" +
+                                                              "#{INDENT}The slowest step definitions (with duration) are\n" +
+                                                              "#{INDENT}listed first. If --dry-run is used the duration\n" +
+                                                              "#{INDENT}is not shown, and step definitions are sorted by\n" +
+                                                              "#{INDENT}filename instead."],
+        'stepdefs'    => ['Cucumber::Formatter::Stepdefs',    "Prints All step definitions with their locations. Same as\n" +
+                                                              "#{INDENT}the usage formatter, except that steps are not printed."],
+        'junit'       => ['Cucumber::Formatter::Junit',       'Generates a report similar to Ant+JUnit.'],
+        'json'        => ['Cucumber::Formatter::Json',        'Prints the feature as JSON'],
+        'json_pretty' => ['Cucumber::Formatter::JsonPretty',  'Prints the feature as pretty JSON'],
+        'tag_cloud'   => ['Cucumber::Formatter::TagCloud',    'Prints a tag cloud of tag usage.'],
+        'debug'       => ['Cucumber::Formatter::Debug',       'For developing formatters - prints the calls made to the listeners.']
       }
       max = BUILTIN_FORMATS.keys.map{|s| s.length}.max
       FORMAT_HELP = (BUILTIN_FORMATS.keys.sort.map do |key|
@@ -118,6 +121,7 @@ module Cucumber
             "This option can be specified multiple times.") do |v|
             @options[:require] << v
             if(Cucumber::JRUBY && File.directory?(v))
+              require 'java'
               $CLASSPATH << v
             end
           end
@@ -243,9 +247,6 @@ module Cucumber
           opts.on("-x", "--expand", "Expand Scenario Outline Tables in output.") do
             @options[:expand] = true
           end
-          opts.on("--no-diff", "Disable diff output on failing expectations.") do
-            @options[:diff_enabled] = false
-          end
           opts.on(DRB_FLAG, "Run features against a DRb server. (i.e. with the spork gem)") do
             @options[:drb] = true
           end