aslakhellesoy-cucumber 0.0.1 → 0.1.1

data/License.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2008 FIXME full name
+Copyright (c) 2008 Aslak Hellesøy
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Manifest.txt

@@ -1,21 +1,33 @@
 History.txt
 License.txt
 Manifest.txt
-README.txt
+README.textile
 Rakefile
+TODO.txt
 bin/cucumber
 config/hoe.rb
 config/requirements.rb
-examples/Rakefile
-examples/pure_ruby/addition.rb
-examples/pure_ruby/steps/addition_steps.rb
-examples/simple/addition.story
-examples/simple/division.story
-examples/simple/steps/addition_steps.rb
-examples/simple_norwegian/steg/matte_steg.rb.rb
-examples/simple_norwegian/summering.story
-examples/web/run_stories.story
-examples/web/steps/stories_steps.rb
+examples/calculator/Rakefile
+examples/calculator/features/addition.feature
+examples/calculator/features/division.feature
+examples/calculator/features/steps/addition_steps.rb
+examples/calculator/lib/calculator.rb
+examples/java/README.textile
+examples/java/Rakefile
+examples/java/features/hello.feature
+examples/java/features/steps/hello_steps.rb
+examples/java/features/steps/tree_steps.rb
+examples/java/features/tree.feature
+examples/java/src/cucumber/demo/Hello.java
+examples/pure_ruby/Rakefile
+examples/pure_ruby/features/addition.rb
+examples/pure_ruby/features/steps/addition_steps.rb
+examples/simple_norwegian/Rakefile
+examples/simple_norwegian/features/steps/matte_steg.rb.rb
+examples/simple_norwegian/features/summering.feature
+examples/web/Rakefile
+examples/web/features/search.feature
+examples/web/features/steps/stories_steps.rb
 gem_tasks/deployment.rake
 gem_tasks/environment.rake
 gem_tasks/fix_cr_lf.rake
@@ -32,22 +44,24 @@ lib/cucumber/formatters/ansicolor.rb
 lib/cucumber/formatters/html_formatter.rb
 lib/cucumber/formatters/pretty_formatter.rb
 lib/cucumber/formatters/progress_formatter.rb
-lib/cucumber/parser/languages.yml
-lib/cucumber/parser/nodes.rb
-lib/cucumber/parser/story_parser.rb
-lib/cucumber/parser/story_parser.treetop.erb
-lib/cucumber/parser/story_parser_en.rb
-lib/cucumber/parser/story_parser_fr.rb
-lib/cucumber/parser/story_parser_no.rb
-lib/cucumber/parser/story_parser_pt.rb
-lib/cucumber/parser/top_down_visitor.rb
+lib/cucumber/languages.yml
 lib/cucumber/rails/world.rb
 lib/cucumber/rake/task.rb
-lib/cucumber/ruby_tree.rb
-lib/cucumber/ruby_tree/nodes.rb
 lib/cucumber/step_methods.rb
 lib/cucumber/step_mother.rb
 lib/cucumber/tree.rb
+lib/cucumber/tree/feature.rb
+lib/cucumber/tree/features.rb
+lib/cucumber/tree/scenario.rb
+lib/cucumber/tree/step.rb
+lib/cucumber/tree/table.rb
+lib/cucumber/tree/top_down_visitor.rb
+lib/cucumber/treetop_parser/feature.treetop.erb
+lib/cucumber/treetop_parser/feature_en.rb
+lib/cucumber/treetop_parser/feature_fr.rb
+lib/cucumber/treetop_parser/feature_no.rb
+lib/cucumber/treetop_parser/feature_parser.rb
+lib/cucumber/treetop_parser/feature_pt.rb
 lib/cucumber/version.rb
 script/console
 script/console.cmd
@@ -61,9 +75,9 @@ setup.rb
 spec/cucumber/core_ext/string_spec.rb
 spec/cucumber/executor_spec.rb
 spec/cucumber/formatters/ansicolor_spec.rb
+spec/cucumber/formatters/features.html
 spec/cucumber/formatters/html_formatter_spec.rb
-spec/cucumber/formatters/stories.html
-spec/cucumber/sell_cucumbers.story
+spec/cucumber/sell_cucumbers.feature
 spec/spec.opts
 spec/spec_helper.rb
 website/index.html

data/README.textile

@@ -0,0 +1,31 @@
+h1. Cucumber
+
+"Cucumber":http://github.com/aslakhellesoy/cucumber is a tool that can execute documentation written in plain text. Cucumber targets non technical domain experts as well as
+programmers and QA people. Cucumber itself is written in Ruby, but it can be used to "test" code written in Ruby, Java 
+(or web applications written in any language). When "IronRuby":http://www.ironruby.net/ matures it can be used to "test"
+.NET code too.
+
+While Cucumber can be thought of as a "testing" tool, most people use it to support "BDD":http://behaviour-driven.org/, so
+the "tests" are typically the first thing that gets written, and the production code is then written outside-in, to make
+the test pass.
+
+h2. Installation
+
+After you have installed Ruby or JRuby - install Cucumber with the following commands:
+
+Ruby:
+<pre><code>gem sources --add http://gems.github.com/ 
+gem install aslakhellesoy-cucumber
+</code></pre>
+
+JRuby:
+<pre><code>jruby -S gem sources --add http://gems.github.com/ 
+jruby -S gem install aslakhellesoy-cucumber
+</code></pre>
+
+h2. Getting started
+
+I haven't written a tutorial yet. Take a look at the "examples":http://github.com/aslakhellesoy/cucumber/tree/master/examples.
+Each example directory has a Rakefile, and you can run the features with
+
+<pre><code>rake features</code></pre>

data/TODO.txt

@@ -0,0 +1,30 @@
+== FEATURES/PROBLEMS:
+
+* Run examples with:
+** ruby -Ilib bin/cucumber examples/simple --require examples/simple/steps
+** ruby -Ilib bin/cucumber examples/web --require examples/web/steps
+
+* TODO: OK Refactor: Extract explicit node classes with RDoc (for better API doc)
+* TODO: OK Get rid of the compile method. Compile the parser in Rake.
+* TODO: OK Make grammar support \r\n, \r and \n (Add some fixture features for that) 
+* TODO: OK Make grammar support indentation
+* TODO: OK Make grammar be totally relaxed about narrative
+* TODO: OK Add a yaml file for different languages
+* TODO: OK Custom nodes for the syntax tree
+* TODO: OK Actually execute the features
+* TODO: Make rake run specs by default
+* TODO: OK Make it work with pure ruby regexen
+* TODO: Make it work with string steps
+* TODO: bin/cucumber --require [dir|file|glob]* --language no --format [file]*
+* TODO: OK Pending steps shold print a block of code that can be pasted into code
+* TODO: cucumber --where "Some text from a step" that prints "__FILE__:__LINE__ (STEP PATTERN)" 
+* TODO: Customisable trace output (like javascriptlint)
+* TODO: Experiment: Make $variables become @variables
+* TODO: GivenScenario
+* TODO: OK PureRuby
+  * Make two trees include accept mixin
+* TODO: Call steps from steps
+* TODO: i18n in ruby too
+* TODO: Don't load any treetop files if no .feature files are found
+* TODO: Summary prints execution time
+* TODO: --nocolor option

data/config/hoe.rb

@@ -2,11 +2,10 @@ require 'cucumber/version'
 
 AUTHOR = 'Aslak Hellesøy'  # can also be an array of Authors
 EMAIL = "aslak.hellesoy@gmail.com"
-DESCRIPTION = "Executable user stories"
+DESCRIPTION = "Executable Feature scenarios"
 GEM_NAME = 'cucumber' # what ppl will type to install your gem
-RUBYFORGE_PROJECT = 'cucumber' # The unix name for your project
-HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
-DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+HOMEPATH = "http://github.com/aslakhellesoy/cucumber"
+RUBYFORGE_PROJECT = nil
 
 @config_file = "~/.rubyforge/user-config.yml"
 @config = nil
@@ -32,7 +31,7 @@ REV = nil
 # UNCOMMENT IF REQUIRED: 
 # REV = YAML.load(`svn info`)['Revision']
 VERS = Cucumber::VERSION::STRING + (REV ? ".#{REV}" : "")
-RDOC_OPTS = ['--quiet', '--title', 'cucumber documentation',
+RDOC_OPTS = ['--quiet', '--title', 'Cucumber documentation',
     "--opname", "index.html",
     "--line-numbers", 
     "--main", "README",
@@ -53,12 +52,12 @@ $hoe = Hoe.new(GEM_NAME, VERS) do |p|
   p.summary = DESCRIPTION
   p.url = HOMEPATH
   p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
-  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store', '**/*.class', '**/*.jar']  #An array of file patterns to delete on clean.
   
   # == Optional
   p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
   #p.extra_deps = []     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
-  p.extra_deps = [ ['term-ansicolor', '>= 1.0.3'], ['treetop', '>= 1.2.4'] ]
+  p.extra_deps = [ ['term-ansicolor', '>= 1.0.3'], ['treetop', '>= 1.2.4'], ['rspec', '>= 1.1.4'], ['diff-lcs', '>= 1.1.2'] ]
 
   #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
   

data/examples/java/README.textile

@@ -0,0 +1,52 @@
+h1. Using Cucumber with Java
+
+This directory contains code to demonstrate how Cucumber can be used to develop Java code.
+You need JRuby 1.1.3 or higher installed and JRuby's bin directory on your PATH.
+
+h2. Installing required gems
+
+jruby -S gem install aslakhellesoy-cucumber
+jruby -S gem install diff-lcs
+
+h2. Running the scenarios
+
+Open a shell in this directory (java) and execute the following command:
+
+<pre><code>
+jruby -S rake features
+</code></pre>
+
+This will compile the java code and package it in a jar file, and then run Cucumber against
+that code.
+
+There is a deliberate error. See if you can fix it!
+
+h2. Background and Credits
+
+Cucumber is a rewrite of RSpec's "Story runner", which was originally written by Dan North. Dan's original
+implementation required that stories be written in Ruby. Shortly after, David Chelimsky added 
+"plain text":http://blog.davidchelimsky.net/articles/2007/10/21/story-runner-in-plain-english support.
+
+This brought executable stories a little closer to non-technical users, which is one of the target audiences
+for this kind of tool.
+
+However, the RSpec Story runner has several shortcomings which is rather common for tools that move into new territory.
+Some of the biggest problems with it are:
+
+* Hard to get started with. A special "all.rb" file must be written before it can be used.
+* No out of the box Rake support, which puts a lot of people off.
+* No i18n, so if you want to write stories in a different language than English you're out of luck.
+* Poor error reporting. No way to know on what line a plain text story failed during execution or parsing.
+* Limited colouring of output.
+* No simple way to execute only one scenario.
+* No command line tool to run stories.
+
+While all of this could have been fixed in the existing codebase, I figured it would be easier to do a rewrite from scratch.
+I also had some ideas for extensions of the story grammar, so I decided to use "Treetop":http://treetop.rubyforge.org/
+and base it on a proper "grammar":http://github.com/aslakhellesoy/cucumber/tree/master/lib/cucumber/treetop_parser/feature.treetop.erb
+
+Cucumber addresses all of the shortcomings of RSpec's Story runner. If the community likes it, we'll consider phasing out
+the RSpec story runner.
+
+The term "Feature" has been adopted in favour of "Story" because I believe it is a more appropriate term. A feature's scenarios
+typically increases over time - fed by several user stories.

data/examples/java/Rakefile

@@ -0,0 +1,12 @@
+$:.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "--format pretty"
+end
+
+task :features => :compile
+
+task :compile do
+  sh "javac src/cucumber/demo/Hello.java && jar cf src/cucumber_demo.jar -C src cucumber/demo/Hello.class"
+end

data/examples/java/features/hello.feature

@@ -0,0 +1,11 @@
+Feature: Hello
+  In order to have more friends
+  I want to say hello
+
+  Scenario: Personal greeting
+    Given my name is Aslak
+    When I greet David
+    Then he should hear Hi, David. I'm Aslak.
+    And I should remember David as a friend
+    And I should get David's phone number
+

data/examples/java/features/steps/hello_steps.rb

@@ -0,0 +1,25 @@
+require 'spec' # so we can call .should
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../src') # so the jar is found
+require 'cucumber_demo' # puts the jar on the classpath
+include_class 'cucumber.demo.Hello'
+
+Given /my name is (\w+)/ do |name|
+  @hello = Hello.new # A java object
+  @name = name
+end
+
+When /I greet (.*)/ do |someone|
+  @greeting = @hello.greet(someone, @name)
+end
+
+Then /he should hear (.*)\./ do |message|
+  @greeting.should == message
+end
+
+Then /I should remember (\w+) as a friend/ do |name|
+  @hello.friend?(name).should == true
+end
+
+Then /I should get (\w+)'s phone number/ do |name|
+  @hello.getPhoneNumber(name).should_not == nil
+end

data/examples/java/features/steps/tree_steps.rb

@@ -0,0 +1,14 @@
+require 'spec'
+include_class 'java.util.TreeSet'
+
+Given /I have an empty set/ do
+  @set = TreeSet.new  
+end
+
+When /I add (\w+)/ do |s|
+  @set.add(s)
+end
+
+Then /the contents should be (.*)/ do |s|
+  @set.to_a.join(" ").should == s
+end

data/examples/java/features/tree.feature

@@ -0,0 +1,9 @@
+Feature: Tree
+  In order to have more robust Java software
+  I want to use Cucumber against Java classes
+
+  Scenario: Use java.util.TreeSet
+    Given I have an empty set
+    When I add hello
+    And I add world
+    Then the contents should be hello world

data/examples/java/src/cucumber/demo/Hello.java

@@ -0,0 +1,15 @@
+package cucumber.demo;
+
+public class Hello {
+    public String greet(String who, String from) {
+        return "Hi, " + who + ". I'm " + from;
+    }
+    
+    public boolean isFriend(String who) {
+        return true;
+    }
+    
+    public String getPhoneNumber(String who) {
+        return "99999";
+    }
+}

data/examples/pure_ruby/Rakefile

@@ -0,0 +1,6 @@
+$:.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new do |t|
+  t.cucumber_opts = "--format pretty"
+end

data/examples/pure_ruby/features/addition.rb

@@ -0,0 +1,23 @@
+require 'cucumber/cli' # Needed in order to run the feature with ruby
+
+Feature %|Addition
+  As a math idiot 
+  I want to be told the sum of two numbers
+  So that I don't make silly mistakes| do
+
+  Scenario "Add two numbers" do
+    Given "I have entered 50 into the calculator"
+    And "I have entered 70 into the calculator"
+    When "I add"
+    Then "the result should be 120 on the screen"
+    And "the result class should be Float"
+  end
+  
+  Table do |t|
+    t   | "input_1" | "input_2" | "output" | "class"  | t
+    # This is kind of dumb - but it illustrates how scenarios can be "generated" in code.
+    10.times do |n|
+      t | n         | n*2       | n*3      | Fixnum   | t
+    end
+  end
+end

data/examples/simple_norwegian/Rakefile

@@ -0,0 +1,6 @@
+$:.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new do |t|
+  t.cucumber_opts = "--format pretty --language no"
+end

data/examples/simple_norwegian/{summering.story → features/summering.feature}

@@ -1,4 +1,4 @@
-Historie: Addition
+Egenskap: Summering
   Som en matteidiot 
   Vil jeg bli fortalt summen av to tall
   Slik at jeg ikke gjør dumme feil
@@ -8,3 +8,6 @@ Historie: Addition
     Og at jeg har tastet inn 7
     Når jeg summerer
     Så skal resultatet være 12
+
+    |a|b|s|
+    |2|3|5|

data/examples/web/Rakefile

@@ -0,0 +1,6 @@
+$:.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new do |t|
+  t.cucumber_opts = "--format pretty"
+end

data/examples/web/features/search.feature

@@ -0,0 +1,9 @@
+Feature: Search
+  As an information seeker
+  I want to find more information
+  So that I can learn more
+
+  Scenario: Find what I'm looking for
+    Given I am on the Google search page
+    When I search for "rspec"
+    Then I should see a link to "RSpec-1.1.4: Overview":http://rspec.info/

data/examples/web/features/steps/stories_steps.rb

@@ -0,0 +1,51 @@
+require 'spec'
+
+case PLATFORM
+when /darwin/
+  require 'safariwatir'
+  Browser = Watir::Safari
+when /win32|mingw/
+  require 'watir'
+  Browser = Watir::IE
+when /java/
+  require 'celerity'
+  Browser = Celerity::Browser
+else
+  raise "This platform is not supported (#{PLATFORM})"
+end
+
+class GoogleSearch
+  def initialize(b)
+    @b = b
+  end
+  
+  def goto
+    @b.goto 'http://www.google.com/'
+  end
+  
+  def search(text)
+    @b.text_field(:name, 'q').set(text)
+    @b.button(:name, 'btnG').click
+  end
+end
+
+Before do
+  @b = Browser.new
+end
+
+After do
+  @b.close
+end
+
+Given 'I am on the Google search page' do
+  @page = GoogleSearch.new(@b)
+  @page.goto
+end
+
+When /I search for "(.*)"/ do |query|
+  @page.search(query)
+end
+
+Then /I should see a link to "(.*)":(.*)/ do |text, url|
+  @b.link(:url, url).text.should == text
+end