aslakhellesoy-cucumber 0.1.5 → 0.1.9

data/README.txt

@@ -0,0 +1,41 @@
+= Cucumber
+
+* http://github.com/aslakhellesoy/cucumber
+
+== DESCRIPTION:
+
+Cucumber executes plain text documentation of code against that code.
+Documentation: http://github.com/aslakhellesoy/cucumber/wikis/home
+
+== REQUIREMENTS:
+
+* FIX (list of requirements)
+
+== INSTALL:
+
+* gem install cucumber
+
+== LICENSE:
+
+(The MIT License)
+
+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
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,9 @@
+ENV['NODOT'] = 'true' # We don't want class diagrams in RDoc
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['gem_tasks/**/*.rake'].each { |rake| load rake }
+
+# Hoe gives us :default => :test, but we don't have Test::Unit tests.
+Rake::Task[:default].clear_prerequisites
+task :default => [:spec, :features]

data/TODO.txt

@@ -0,0 +1,26 @@
+== FEATURES/PROBLEMS:
+
+* 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: OK 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: OK 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/bin/cucumber

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+$:.unshift(File.dirname(__FILE__) + '/../lib') unless $:.include?(File.dirname(__FILE__) + '/../lib')
+require 'cucumber/cli'
+Cucumber::CLI.execute

data/config/hoe.rb

@@ -0,0 +1,69 @@
+require 'cucumber/version'
+
+AUTHOR = 'Aslak Hellesøy'  # can also be an array of Authors
+EMAIL = "aslak.hellesoy@gmail.com"
+DESCRIPTION = "Executable Feature scenarios"
+GEM_NAME = 'cucumber' # what ppl will type to install your gem
+HOMEPATH = "http://github.com/aslakhellesoy/cucumber"
+RUBYFORGE_PROJECT = 'rspec'
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "aslak_hellesoy"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = YAML.load(`svn info`)['Revision']
+VERS = Cucumber::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'Cucumber documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README.textile",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+    @extra_deps
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  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'], ['rspec', '>= 1.1.5'], ['diff-lcs', '>= 1.1.2'] ]
+
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  
+end
+
+CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+$hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+$hoe.rsync_args = '-av --delete --ignore-errors'

data/config/requirements.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))

data/cucumber.yml

@@ -0,0 +1 @@
+default: --format progress features

data/examples/calculator_ruby_features/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/calculator_ruby_features/features/addition.rb

@@ -0,0 +1,23 @@
+require 'cucumber/cli' # Needed in order to run the feature with ruby
+
+Feature %|Addition
+  In order to avoid silly mistakes
+  As a math idiot 
+  I want to be told the sum of two numbers| 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/calculator_ruby_features/features/step_definitons/calculator_steps.rb

@@ -0,0 +1,43 @@
+require 'spec'
+
+class Calculator
+  def push(n)
+    @args ||= []
+    @args << n
+  end
+  
+  def add
+    @args.inject(0){|n,sum| sum+=n}
+  end
+
+  def divide
+    @args[0].to_f / @args[1].to_f
+  end
+end
+
+Before do
+  @calc = Calculator.new
+end
+
+After do
+end
+
+Given /I have entered (\d+) into the calculator/ do |n|
+  @calc.push n.to_i
+end
+
+When 'I add' do
+  @result = @calc.add
+end
+
+When 'I divide' do
+  @result = @calc.divide
+end
+
+Then /the result should be (\d*) on the screen/ do |result|
+  @result.should == result.to_i
+end
+
+Then /the result class should be (\w*)/ do |class_name|
+  @result.class.name.should == class_name
+end

data/examples/cs/README.textile

@@ -0,0 +1,22 @@
+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!

data/examples/cs/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 "csc /target:library /out:Cucumber.Demo.dll src\\Hello.cs"
+end

data/examples/cs/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/cs/features/step_definitons/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 'dotnet'
+loadLibrary 'Cucumber.Demo'
+
+Given /my name is (\w+)/ do |name|
+  @hello = Hello.new # A .net 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.isFriend(name).should == true
+end
+
+Then /I should get (\w+)'s phone number/ do |name|
+  @hello.getPhoneNumber(name).should_not == nil
+end

data/examples/cs/features/step_definitons/tree_steps.rb

@@ -0,0 +1,14 @@
+require 'spec'
+require 'dotnet'
+
+Given /I have an empty set/ do
+  @set = System.Collections.ArrayList.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/cs/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/cs/src/Hello.cs

@@ -0,0 +1,18 @@
+using System;
+
+namespace Cucumber.Demo {
+	public class Hello {
+    public string Greet(string who, string from) {
+        return "Hi, " + who + ". I'm " + from;
+    }
+   
+    public bool IsFriend(string who) {
+        return true;
+    }
+   
+    public string GetPhoneNumber(string who) {
+       	return "99999";
+//throw new Exception("My phone is secret!");
+    }
+	}
+}

data/examples/dos_line_endings/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/dos_line_endings/features/dos_line_endings.feature

@@ -0,0 +1,9 @@
+Feature: DOS line endings
+  In order to have less bug reports
+  As a windows developer
+  I want to write features with DOS line endigs
+
+  Scenario: Just lots of DOS
+    Given I am on DOS
+    And Any version of Windows is really just DOS
+    Then Windows still sucks

data/examples/i18n/README.textile

@@ -0,0 +1,18 @@
+h1. Internationalisation (i18n) examples
+
+Under this directory you'll find examples of Cucumber features written in
+many of the natural languages Cucumber supports. 
+
+For a full list of what languages Cucumber supports - run <pre>cucumber --help</pre>
+
+h2. Running all the examples
+
+Open a shell in this directory and run
+
+<pre>rake i18n</pre>
+
+h2. Running examples for a specific language
+
+Open a shell in the directory for the specific language and run
+
+<pre>rake features</pre>

data/examples/i18n/Rakefile

@@ -0,0 +1,16 @@
+desc 'Run features for all languages'
+task :i18n do
+  dir = File.dirname(__FILE__)
+  Dir["#{dir}/*"].each do |f|
+    if File.directory?(f)
+      lang = f[dir.length+1..-1]
+      Dir.chdir(f) do
+        rake("features")
+      end
+    end
+  end
+end
+
+def rake(args)
+  ruby(File.join(Gem.bindir, 'rake'), args)
+end

data/examples/i18n/ar/Rakefile

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

data/examples/i18n/ar/features/addition.feature

@@ -0,0 +1,17 @@
+خاصية: الجمع
+  من اجل تجنب الأخطاء السخيفة
+  كشخص غبي في الرياضيات
+  اريد معرفة ناتج جمع عددين
+
+  سيناريو: جمع عددين
+    بفرض كتابة ٥٠ في الآلة الحاسبة
+    و كتابة ٧٠ في الآلة الحاسبة
+    متى يتم الضغط على جمع
+    اذاً يظهر ١٢ على الشاشة
+    و الناتج يجب ان يكون Fixnum
+
+  امثلة اكثر:
+    | input_1 | input_2 | button | output | class  |
+    | 20      | 30      | جمع    | 50     | Fixnum |
+    | 2       | 5       | جمع    | 7      | Fixnum |
+    | 0       | 40      | جمع    | 40     | Fixnum |