cuke4php 0.9.0

data/.document

@@ -0,0 +1,3 @@
+bin/*
+features/**/*.feature
+LICENSE

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+group :development do
+  gem 'bundler', '~> 1.0'
+  gem 'jeweler'
+end
+
+gem 'cucumber'

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010-2011 Kevin Olbrich, Alessandro Dal Grande
+
+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/README.md

@@ -0,0 +1,54 @@
+cuke4php
+========
+
+This project implements the cucumber wire protocol for PHP projects.
+Information about the wire protocol: http://wiki.github.com/aslakhellesoy/cucumber/wire-protocol
+
+Using this protocol it is possible to directly interact with PHP code at any level without the need for a web server.  To accomplish this, when cucumber is running against a directory containing feature files and it cannot resolve a particular step definition, it will ask a known wire server (as defined in a .wire file) to interpret and run those steps.
+
+Install
+-------
+To install Cuke4Php, follow these steps:
+
+* clone
+* install dependencies with bundler
+* run rake build
+* install gem under pkg/ folder
+
+Usage
+-----
+* run 'cuke4php path/to/features' from the command line
+* make sure your cucumber features has a 'Cuke4Php.wire' file containing the appropriate information (copy the one in cuke4php/features/step_definitions)
+* you can write both Ruby and PHP steps
+* you should load phpunit from a file in step_definitions/support/
+
+Roadmap
+-------
+
+### bin/cuke4php
+
+* support an option like 'cuke4php --init' which will generate the directory structure and support files necessary to use cuke4php with a php project.
+* autodetect an available port and then use it to run the cuke4php server pass this on to cucumber by setting an environment variable (requires a modification to cucumber)
+
+### Rakefile
+
+* once the patch for erb templating in .wire files is released, we should set a minimum version for it
+
+Dependencies
+------------
+* PHPUnit >= 3.0 (see http://www.phpunit.de/)
+
+Goals
+-----
+This project utilizes PHPUnit because it has a robust set of assertions, has good mocking, and is widely used.  This will facilitate adoption by developers who are already familiar with it.
+
+This project was developed against the 5.2.x versions of PHP, to ensure compatibility with older PHP projects.
+
+Support
+-------
+	Support for this project was provided by iContact, inc.  (http://www.icontact.com)
+
+Contributors
+------------
+	Kevin Olbrich, Ph.D. (kevin.olbrich+cuke4php@gmail.com)
+	Alessandro Dal Grande (aledelgrande@gmail.com)

data/Rakefile

@@ -0,0 +1,75 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "cuke4php"
+    gem.summary = %Q{Implementation of the Cucumber wire protocol for PHP projects}
+    gem.description = %Q{Using this protocol it is possible to directly interact with PHP code at any level without the need for a web server.  To accomplish this, when cucumber is running against a directory containing feature files and it cannot resolve a particular step definition, it will ask a known wire server (as defined in a .wire file) to interpret and run those steps.}
+    gem.authors = ["Kevin Olbrich", "Alessandro Dal Grande"]
+    gem.email = ["kevin.olbrich+cuke4php@gmail.com", "aledalgrande@gmail.com"]
+    gem.homepage = "http://github.com/olbrich/cuke4php"
+    gem.executables = 'cuke4php'
+    gem.add_dependency('cucumber')
+    # TODO: once the patch for erb templating in the .wire files is released, we should set a minimum version for it
+    gem.add_development_dependency('bundler')
+    gem.add_development_dependency('jeweler')
+    gem.files.exclude 'phpdoc'
+    gem.has_rdoc = false
+    gem.requirements << "PHP 5.2+"
+    gem.requirements << "PHPUnit 3.0+"
+    gem.post_install_message =<<eos
+********************************************************************************
+
+  Please install PHPUnit >= 3.0 if you've not already done it!
+  
+  Add PEAR channels:
+  pear channel-discover pear.phpunit.de
+  pear channel-discover components.ez.no
+  pear channel-discover pear.symfony-project.com
+  
+  Install PHPUnit:
+  pear install phpunit/PHPUnit
+
+********************************************************************************
+eos
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'cucumber/rake/task'
+#Cucumber::Rake::Task.new(:features)
+
+task :default => [:features, :phpunit]
+
+namespace :server do
+  
+    desc "start cuke4php server"
+    task :start do
+      sh "#{File.dirname(__FILE__)}/php_bin/cuke4php #{ARGV.first ? ARGV.first : 'features'} &"
+    end
+    
+    desc "stop cuke4php server"
+    task :stop do
+      sh "echo 'quit' | nc #{ENV['SERVER'] || 'localhost'} #{ENV['PORT'] || 16816}"
+    end
+end
+
+desc "Run Cucumber features for Cuke4php"
+task :features do
+  sh "bin/cuke4php -p #{ENV['PROFILE'] || 'default'} features"
+end
+
+desc "Generate PhpDocs -- requires PhpDocumentor"
+task :phpdoc do
+  sh "rm -rf phpdoc/"
+  sh "phpdoc -f *.php -d ./lib -t phpdoc/ --title Cuke4Php -dn Cuke4Php -dc Cuke4Php -it @one,@two,@wire"
+end
+
+desc "Run PHPUnit tests"
+task :phpunit do
+  sh "phpunit tests"
+end

data/VERSION

@@ -0,0 +1 @@
+0.9.0

data/bin/cuke4php

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+# TODO: support an option like 'cuke4php --init' which will generate the directory structure and support files necessary to use cuke4php with a php project.
+
+# TODO: autodetect an available port and then use it to run the cuke4php server pass this on to cucumber by setting an environment variable (requires a modification to cucumber)
+# see https://github.com/olbrich/cucumber/commit/0c11d206e08e8d5647e03bf78be93723d59529ef
+
+# Note that changing the port number currently requires updating the Cuke4Php.wire file in your project's step_definitions
+# or cucumber will look for the cuke4php server on the wrong port.
+CUKE4PHP_PORT=ENV['CUKE4PHP_PORT'] || 16816
+
+server = fork do
+  exec "#{File.dirname(__FILE__)}/../php_bin/cuke4php_server -p #{CUKE4PHP_PORT} #{ARGV.last ? ARGV.last : 'features'}"  
+end
+#Process.detach(pid)
+sleep 1
+cucumber = fork do
+  exec "CUKE4PHP_PORT=#{CUKE4PHP_PORT} && cucumber #{ARGV.join(' ')}" #"; echo 'quit' | nc localhost #{CUKE4PHP_PORT}"
+end
+pid, status = Process.wait2(cucumber,0)
+Process.kill("TERM",server)
+exit status.exitstatus

data/cucumber.yml

@@ -0,0 +1 @@
+default: --format pretty

data/cuke4php.gemspec

@@ -0,0 +1,92 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{cuke4php}
+  s.version = "0.9.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kevin Olbrich", "Alessandro Dal Grande"]
+  s.date = %q{2011-01-27}
+  s.default_executable = %q{cuke4php}
+  s.description = %q{Using this protocol it is possible to directly interact with PHP code at any level without the need for a web server.  To accomplish this, when cucumber is running against a directory containing feature files and it cannot resolve a particular step definition, it will ask a known wire server (as defined in a .wire file) to interpret and run those steps.}
+  s.email = ["kevin.olbrich+cuke4php@gmail.com", "aledalgrande@gmail.com"]
+  s.executables = ["cuke4php"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "LICENSE",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "bin/cuke4php",
+    "cucumber.yml",
+    "cuke4php.gemspec",
+    "features/Cuke4Php.feature",
+    "features/step_definitions/Cuke4Php.wire",
+    "features/step_definitions/TestSteps.php",
+    "features/step_definitions/WireSteps.php",
+    "features/support/Env.php",
+    "lib/Cucumber.php",
+    "lib/CucumberScenario.php",
+    "lib/CucumberSteps.php",
+    "lib/Cuke4Php.php",
+    "php_bin/cuke4php_server",
+    "tests/lib/CucumberScenarioTest.php",
+    "tests/lib/Cuke4PhpTest.php"
+  ]
+  s.homepage = %q{http://github.com/olbrich/cuke4php}
+  s.post_install_message = %q{********************************************************************************
+
+  Please install PHPUnit >= 3.0 if you've not already done it!
+  
+  Add PEAR channels:
+  pear channel-discover pear.phpunit.de
+  pear channel-discover components.ez.no
+  pear channel-discover pear.symfony-project.com
+  
+  Install PHPUnit:
+  pear install phpunit/PHPUnit
+
+********************************************************************************
+}
+  s.require_paths = ["lib"]
+  s.requirements = ["PHP 5.2+", "PHPUnit 3.0+"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Implementation of the Cucumber wire protocol for PHP projects}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<cucumber>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_runtime_dependency(%q<cucumber>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+    else
+      s.add_dependency(%q<cucumber>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<cucumber>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<cucumber>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<cucumber>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+  end
+end
+

data/features/Cuke4Php.feature

@@ -0,0 +1,42 @@
+@wire
+Feature: Interact with the Cuke4Php server
+    As a tester
+    I want to run step definitions in PHP
+    So that I can execute steps in PHP
+
+Scenario: Cuke4Php runs the steps
+    Given some setup
+    When I take an action
+    Then something happens
+    And an undefined step with a "param"
+    And a step with a "parameter" and the following table:
+        | column 1 | data |
+        | apples   | 10   |
+        | oranges  | 20   |
+    And a step with a multiline string:
+      """
+      Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus pulvinar,
+      est at molestie placerat, risus lectus dictum nulla, id blandit nunc metus at
+      ligula. Nam purus quam, consectetur ut pulvinar eu, elementum quis nibh. Curabitur
+      pellentesque sapien ut dolor commodo ultricies. Sed auctor convallis nunc, et
+      dapibus leo ullamcorper scelerisque. Vivamus nisi diam, vestibulum eget consequat
+      et, fringilla vitae ipsum. Nam et nisl est. Cras ac iaculis nisl. Quisque
+      condimentum tristique tellus, vitae fringilla nulla dictum vel. Proin varius congue
+      libero id facilisis. Etiam scelerisque mauris sit amet sem imperdiet a laoreet tellus
+      scelerisque. Curabitur vulputate congue malesuada. Aenean tempus viverra arcu, quis
+      posuere velit facilisis at. Sed nec rutrum turpis. Nunc mattis magna in ante tincidunt
+      fermentum. Donec dapibus porta ipsum, eget porttitor magna viverra vitae. Quisque suscipit,
+      metus sit amet placerat interdum, enim turpis imperdiet turpis, in placerat felis
+      orci at sem. Suspendisse sagittis, neque quis sodales ornare, dui purus posuere
+      lectus, id feugiat nunc lectus ac lectus.
+      """
+
+Scenario Outline: run several steps many times
+    Given I <verb> the <noun>
+    Then It should be <adjective>
+
+    Examples:
+    | verb       | noun      | adjective |
+    | shoot      | messenger | dead      |
+    | understand | meaning   | clear     |
+

data/features/step_definitions/Cuke4Php.wire

@@ -0,0 +1,4 @@
+host: localhost
+port: 16816
+invoke:
+    timeout: 0.1

data/features/step_definitions/TestSteps.php

@@ -0,0 +1,88 @@
+<?php
+/**
+ * @package Cuke4Php
+ */
+ 
+/**
+ * @package Cuke4Php
+ */ 
+class TestSteps extends CucumberSteps {
+
+    /**
+     * Given /^successful$/
+     **/
+    public function stepSuccessful() {}
+
+    /**
+     * Given /^incomplete$/
+     */
+    public function stepIncomplete() {
+        self::markTestIncomplete('incomplete');
+    }
+
+    /**
+     * Given /^skipped$/
+     */
+    public function stepSkipped() {
+        self::markTestSkipped('skipped');
+    }
+
+    /**
+     * Given /^pending$/
+     */
+    public function stepPending() {
+        self::markPending('pending');
+    }
+
+    /**
+     * Given /^a failed expectation$/
+     */
+    public function stepFailed() {
+        self::assertEquals(true, false);
+    }
+
+    /**
+     * Given /^an exception is thrown$/
+     */
+    public function stepException() {
+        throw new TestException('Exception');
+    }
+
+    /**
+     * Given /^"arg1" not equal to "arg2"$/
+     */
+    public function stepNotEqual($arg1,$arg2) {
+        self::assertTrue($arg1 !== $arg2);
+    }
+		
+		/**
+		 * @one
+		 */
+		public function afterWithOneTag() {
+			
+		}
+		
+		/**
+		 * 
+		 */
+		public function afterWithNoTags() {
+			
+		}
+		
+		/**
+		 * @one
+		 */
+		public function beforeWithOneTag() {
+			
+		}
+		
+		/**
+		 * 
+		 */
+		public function beforeWithNoTags() {
+			
+		}
+
+}
+
+?>

data/features/step_definitions/WireSteps.php

@@ -0,0 +1,87 @@
+<?php
+/**
+ * @package Cuke4Php
+ */
+/**
+ * @package Cuke4Php
+ */ 
+class WireSteps extends CucumberSteps {
+
+    /**
+     * @wire
+     */
+    function beforeWire() {
+        $this->aGlobals['before'] = 'beforeWire';
+    }
+
+    function beforeAll() {
+
+    }
+
+    /**
+     * Given /^some setup$/
+     **/
+    public function stepSomeSetup() {
+        
+    }
+
+    /**
+     * When /^I take an action$/
+     **/
+    public function stepITakeAnAction() {
+    }
+
+    /**
+     * Then /^something happens$/
+     **/
+    public function stepSomethingHappens() {
+    }
+
+    /**
+     * Then /^an undefined step with a "([^"]*)"$/
+     **/
+    public function stepAnUndefinedStepWithAParameter($arg1) {
+        self::assertEquals('param', $arg1);
+    }
+
+    /**
+     * Then /^a step with a "([^"]*)" and the following table\:$/
+     **/
+    public function stepAStepWithAParameterAndTheFollowingTable($arg1, $table) {
+    }
+
+    /**
+     * Given /^I shoot the messenger$/
+     **/
+    public function stepIShootTheMessenger() {
+    }
+
+    /**
+     * Then /^It should be dead$/
+     **/
+    public function stepItShouldBeDead() {
+    }
+
+    /**
+     * Given /^I understand the meaning$/
+     **/
+    public function stepIUnderstandTheMeaning() {
+    }
+
+    /**
+     * Then /^It should be clear$/
+     **/
+    public function stepItShouldBeClear() {
+    }
+
+    /**
+     * Then /^a step with a multiline string\:$/
+     **/
+    public function stepAStepWithAMultilineString($sString) {
+
+    }
+
+
+}
+
+?>

data/features/support/Env.php

@@ -0,0 +1,13 @@
+<?php
+/**
+ * @package Cuke4Php
+ */
+ 
+/**
+ * load the PHPUnit framework, try to load the new version first
+ * then the older one.
+ */ 
+	@include_once "PHPUnit/Autoload.php";	
+	@include_once "PHPUnit/Framework.php";
+
+?>

data/lib/Cucumber.php

@@ -0,0 +1,14 @@
+<?php
+
+/**
+ * @package Cuke4Php
+ */
+
+/**
+ * load all php files in this directory
+ */
+foreach (glob(dirname(__FILE__) . "/*.php") as $sFilename) {
+    require_once $sFilename;
+}
+
+?>

data/lib/CucumberScenario.php

@@ -0,0 +1,122 @@
+<?php
+/**
+ * @package Cuke4Php
+ */
+
+/**
+ * load dependencies
+ */
+require_once "CucumberSteps.php";
+
+/**
+ * class CucumberScenario
+ * Defines a Cucumber Scenario
+ * @package Cuke4Php
+ */
+class CucumberScenario {
+
+    // provide a place we can store data
+    public $aGlobals = array();
+
+    // the world holds the definitions for the before, after, and step definitions
+    private $aWorld;
+
+    static private $oMock;
+
+    /**
+     * @param array $_aWorld
+     * @return void
+     */
+    function __construct($_aWorld = array()) {
+        $this->aWorld = $_aWorld;
+    }
+
+    /**
+     * @static
+     * @param  $aWorld
+     * @return CucumberScenario
+     */
+    static function getInstance($aWorld) {
+        if (self::$oMock) {
+            return self::$oMock;
+        } else {
+            return new CucumberScenario($aWorld);
+        }
+    }
+
+    /**
+     * @static
+     * @param  $oMock
+     * @return void
+     */
+    static function setInstance($oMock) {
+        self::$oMock = $oMock;
+    }
+
+    /**
+     * @param  $aTags
+     * @return array
+     * invokes all the before hooks defined that either have no tags or tags corresponding to this scenario's tags
+     */
+    function invokeBeforeHooks($aTags) {
+        foreach ($this->aWorld['before'] as $aBeforeHook) {
+			if (array_key_exists('tags', $aBeforeHook))
+            	if (count($aBeforeHook['tags']) == 0 || count(array_intersect($aTags, $aBeforeHook['tags'])) > 0) {
+                    $oStep = CucumberSteps::getInstance($aBeforeHook['class'], $this->aGlobals);
+                    $oResult = $oStep->invoke($aBeforeHook['method']);
+                    if ($oResult === false) {
+                        return array('failure');
+                    }
+            	}
+        }
+        return array('success');
+    }
+
+    /**
+     * @param  $aTags
+     * @return array
+     * invoke all after hooks defined that either have no tags, or tags that match the tags of the current scenario
+     */
+    function invokeAfterHooks($aTags) {
+        foreach ($this->aWorld['after'] as $aAfterHook) {
+			if (array_key_exists('tags', $aAfterHook))
+	            if (count($aAfterHook['tags']) == 0 || count(array_intersect($aTags, $aAfterHook['tags'])) > 0) {
+	                $oStep = CucumberSteps::getInstance($aAfterHook['class'], $this->aGlobals);
+	                $oResult = $oStep->invoke($aAfterHook['method']);
+	                if ($oResult === false) {
+	                    return array('failure');
+	                }
+	            }
+        }
+        return array('success');
+    }
+
+    /**
+     * @param  $iStepId
+     * @param  $aArgs
+     * @return mixed
+     *
+     * Invokes a step.  Steps can use PHPUnit assertions and will
+     * mark themselves as pending if the self::markTestIncomplete() or self:markTestSkipped()
+     * functions are called.  Failed expectations are returned as messages while all other
+     * Exceptions are reported back as exceptions.
+     */
+    function invoke($iStepId, $aArgs) {
+        $aStep = $this->aWorld['steps'][$iStepId];
+        $oStep = new $aStep['class']($this->aGlobals);
+        try {
+            call_user_func_array(array($oStep, $aStep['method']),$aArgs);
+        } catch (PHPUnit_Framework_IncompleteTestError $e) {
+            return array('pending',$e->getMessage());
+        } catch (PHPUnit_Framework_SkippedTestError $e) {
+            return array('pending',$e->getMessage());
+        } catch (PHPUnit_Framework_ExpectationFailedException $e) {
+            return array('fail', array('message' => $e->getMessage()));
+        } catch (Exception $e) {
+            return array('fail', array('exception' => $e->__toString()));            
+        }
+        return array('success');
+    }
+
+}
+?>