cuke-test 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 jarrett
+
+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.markdown

@@ -0,0 +1,74 @@
+CukeTest
+=========
+
+It can be useful to package commonly-used Cucumber steps as a gem. And every gem needs tests, right? Enter CukeTest.
+
+CukeTest helps you test individual Cucumber steps with RSpec, verifying that they pass and fail under the right conditions.
+
+Installation
+============
+
+    sudo gem install cuke-test
+
+Usage
+=====
+
+Suppose you've packaged your Cucumber steps into a gem, and the file structure looks like this:
+
+    my-cuke-steps
+      lib
+        my-cuke-steps
+          steps.rb
+      spec
+        steps_spec.rb
+
+You want to test your custom Cucumber steps in `steps_spec.rb`. Here's how:
+
+    describe 'My Cuke Steps' do
+      before :all do
+        CukeTest.config.features_path = File.expand_path(File.dirname(__FILE__)) + '/features'
+      end
+      
+      it 'passes when the expectation is met' do
+        # Run an entire feature file
+        feature('success.feature').should pass_cuke
+        # Run just one scenario in a feature file
+        scenario('some_successes_and_some_failures.feature', 'successful scenario').should pass_cuke
+      end
+      
+      it 'fails when the expectation is not met' do
+        feature('failure.feature').should fail_cuke('Text of failing step')
+      end
+    end
+
+Now you need to create the feature files against which the above tests will be run. Put them in `spec/features`. Your new file structure should look like this:
+
+    my-cuke-steps
+      lib
+        my-cuke-steps
+          steps.rb
+      spec
+        steps_spec.rb
+        features
+          failure.feature
+          some_successes_and_some_failures.feature
+          success.feature
+
+The last thing you need to do is tell your specs where to find your custom steps. (Otherwise, the steps you're testing will be undefined.) Fortunately, Cucumber automatically loads `.rb` files in the `features` directory. So we just need to require our step library from a new file within `features`:
+
+    # in spec/features/steps.rb
+    require File.expand_path(File.dirname(__FILE__)) + '../../lib/my-cuke-steps/steps.rb')
+
+That's about it for the basic setup. If you're developing a gem where your custom matchers require other code from the same gem (e.g. custom matchers), you'll need to modify `spec/features/steps.rb`:
+
+    # in spec/features/steps.rb
+    require File.expand_path(File.dirname(__FILE__)) + '../../lib/my-cuke-steps/steps.rb')
+    $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
+    require 'your_gem_name'
+
+You have to do this even if you require the gem files from within your specs, because CukeTest spawns a new process for Cucumber. (The spawned process will not inherit the `require` statements from your spec.)
+
+Copyright
+=========
+
+Copyright (c) 2010 Jarrett Colby. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+
+begin
+	require 'jeweler'
+	Jeweler::Tasks.new do |gem|
+		gem.name = "cuke-test"
+		gem.summary = %Q{Testing for custom Cucumber steps}
+		gem.description = %Q{Packaging some Cucumber steps as a gem? Test them with Cuke Test.}
+		gem.email = "jarrett@uchicago.edu"
+		gem.homepage = "http://github.com/jarrett/cuke-test"
+		gem.authors = ["jarrett"]
+		gem.add_dependency "rspec", ">= 1.3.0"
+		gem.add_dependency "cucumber", ">= 0.6.3"
+		# gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+	end
+	Jeweler::GemcutterTasks.new
+rescue LoadError
+	puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+	spec.libs << 'lib' << 'spec'
+	spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+	spec.libs << 'lib' << 'spec'
+	spec.pattern = 'spec/**/*_spec.rb'
+	spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+	version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+	rdoc.rdoc_dir = 'rdoc'
+	rdoc.title = "cuke-test #{version}"
+	rdoc.rdoc_files.include('README*')
+	rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/cuke-test.gemspec

@@ -0,0 +1,69 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{cuke-test}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["jarrett"]
+  s.date = %q{2010-03-14}
+  s.description = %q{Packaging some Cucumber steps as a gem? Test them with Cuke Test.}
+  s.email = %q{jarrett@uchicago.edu}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "cuke-test.gemspec",
+     "lib/cuke-test.rb",
+     "lib/cuke-test/config.rb",
+     "lib/cuke-test/cucumber_matchers.rb",
+     "lib/cuke-test/helpers.rb",
+     "spec/cuke-test_spec.rb",
+     "spec/features/failure.feature",
+     "spec/features/failure_on_wrong_step.feature",
+     "spec/features/require_mock_steps.rb",
+     "spec/features/success.feature",
+     "spec/features/success_and_failure.feature",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/step_definitions/mock_steps.rb"
+  ]
+  s.homepage = %q{http://github.com/jarrett/cuke-test}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Testing for custom Cucumber steps}
+  s.test_files = [
+    "spec/cuke-test_spec.rb",
+     "spec/features/require_mock_steps.rb",
+     "spec/spec_helper.rb",
+     "spec/step_definitions/mock_steps.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rspec>, [">= 1.3.0"])
+      s.add_runtime_dependency(%q<cucumber>, [">= 0.6.3"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.3.0"])
+      s.add_dependency(%q<cucumber>, [">= 0.6.3"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.3.0"])
+    s.add_dependency(%q<cucumber>, [">= 0.6.3"])
+  end
+end
+

data/lib/cuke-test.rb

@@ -0,0 +1,14 @@
+require 'cucumber'
+require 'ostruct'
+require 'cuke-test/config'
+require 'cuke-test/cucumber_matchers'
+require 'cuke-test/helpers'
+
+module CukeTest
+	def self.included(base)
+		base.instance_eval do
+			include ::CukeTest::CucumberMatchers
+			include ::CukeTest::Helpers
+		end
+	end
+end

data/lib/cuke-test/config.rb

@@ -0,0 +1,7 @@
+module CukeTest
+	def self.config
+		@config ||= OpenStruct.new
+		yield @config if block_given?
+		@config
+	end
+end

data/lib/cuke-test/cucumber_matchers.rb

@@ -0,0 +1,62 @@
+module CukeTest
+	module CucumberMatchers
+		class PassCuke
+			def matches?(target)
+				@target = target
+				!!target.match(/[0-9]+ scenarios? \([0-9]+ passed\)/)
+			end
+			
+			def failure_message
+				message('to pass')
+			end
+			
+			def negative_failure_message
+				message('not to pass')
+			end
+			
+			private
+			
+			def message(infinitive)
+				"Expected Cucumber scenario(s) #{infinitive}. Cucumber output:\n\n" + @target
+			end
+		end
+		
+		def pass_cuke
+			PassCuke.new
+		end
+		
+		class FailCuke
+			def initialize(step = nil)
+				@step = step
+			end
+			
+			def matches?(target)
+				@target = target
+				target.match(/[0-9]+ scenarios? \([0-9]+ failed(, [0-9]+ passed)?\)/) and
+					(@step.nil? or target.match(/in `#{@step}'/))
+			end
+			
+			def failure_message
+				message('to fail')
+			end
+			
+			def negative_failure_message
+				message('not to fail')
+			end
+			
+			private
+			
+			def message(infinitive)
+				"Expected Cucumber scenario(s) #{infinitive}#{step_message}. Cucumber output:\n\n" + @target
+			end
+			
+			def step_message
+				@step ? %Q{ on step "#{@step}"} : nil
+			end
+		end
+		
+		def fail_cuke(step = nil)
+			FailCuke.new(step)
+		end
+	end
+end

data/lib/cuke-test/helpers.rb

@@ -0,0 +1,24 @@
+module CukeTest
+	module Helpers
+		# Runs the feature file (and optionally just one scenario therein) through Cucumber.
+		# Returns Cucumber's output as a string.
+		def feature(feature_file, scenario = nil)
+			out = StringIO.new
+			errors = StringIO.new
+			if features_path = CukeTest.config.features_path
+				feature_file = File.join(features_path, feature_file)
+			end
+			cli_args = [feature_file, '--no-color']
+			if scenario
+				cli_args += ['--name', '"' + scenario + '"']
+			end
+			`cucumber #{cli_args.join(' ')}` # This works
+		end
+		
+		# Runs the one scenario in the feature file through Cucumber.
+		# Returns Cucumber's output as a string.
+		def scenario(feature_file, scenario)
+			feature(feature_file, scenario)
+		end
+	end
+end

data/spec/cuke-test_spec.rb

@@ -0,0 +1,72 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe CukeTest do
+	include CukeTest
+	
+	def spec_dir
+		File.expand_path(File.dirname(__FILE__))
+	end
+	
+	def features_path(filename)
+		File.join(spec_dir, 'features', filename)
+	end
+	
+	describe '#feature and #pass_cuke' do
+		it 'matches a passing feature' do
+			feature(features_path('success.feature')).should pass_cuke
+		end
+		
+		it 'does not match a failing feature' do
+			feature(features_path('failure.feature')).should_not pass_cuke
+		end
+	end
+	
+	describe '#feature and #fail_cuke' do
+		it 'matches a failing feature' do
+			feature(features_path('failure.feature')).should fail_cuke('And the test fails')
+		end
+		
+		it 'does not match a passing feature' do
+			feature(features_path('success.feature')).should_not fail_cuke
+		end
+		
+		it 'does not match a feature that fails on the wrong step' do
+			feature(features_path('failure_on_wrong_step.feature')).should_not fail_cuke('And the test fails')
+		end
+	end
+	
+	describe '#scenario and #pass_cuke' do
+		it 'matches a passing scenario' do
+			scenario(features_path('success_and_failure.feature'), 'success').should pass_cuke
+		end
+		
+		it 'does not match a failing scenario' do
+			scenario(features_path('success_and_failure.feature'), 'failure').should_not pass_cuke
+		end
+	end
+	
+	describe '#scenario and #fail_cuke' do
+		it 'matches a failing scenario' do
+			scenario(features_path('success_and_failure.feature'), 'failure').should fail_cuke('And the test fails')
+		end
+		
+		it 'does not match a passing scenario' do
+			scenario(features_path('success_and_failure.feature'), 'success').should_not fail_cuke
+		end
+		
+		it 'does not match a scenario that fails on the wrong step' do
+			scenario(features_path('success_and_failure.feature'), 'failure on wrong step').should_not fail_cuke('And the test fails')
+		end
+	end
+	
+	describe '.config' do
+		it 'can set the features path' do
+			CukeTest.config.features_path = File.join(File.expand_path(File.dirname(__FILE__)), 'features')
+			feature('success.feature').should pass_cuke
+		end
+	end
+	
+	it 'can handle Cucumber args with spaces' do
+		scenario(features_path('success_and_failure.feature'), 'failure on wrong step').should fail_cuke('And the test fails on the wrong step')
+	end
+end

data/spec/features/failure.feature

@@ -0,0 +1,4 @@
+Feature: failure
+  Scenario: failure
+    Given nothing happens
+    And the test fails

data/spec/features/failure_on_wrong_step.feature

@@ -0,0 +1,4 @@
+Feature: failure on wrong step
+  Scenario: failure on wrong step
+    Given nothing happens
+    And the test fails on the wrong step

data/spec/features/require_mock_steps.rb

@@ -0,0 +1,3 @@
+# Why put the steps in a different file and require it from here? Because this is the approach
+# that authors of step libraries will have to take, so we must verify that it works.
+require File.join(File.expand_path(File.dirname(__FILE__)), '..', 'step_definitions', 'mock_steps.rb')

data/spec/features/success.feature

@@ -0,0 +1,3 @@
+Feature: success
+  Scenario: success
+    Given the test passes

data/spec/features/success_and_failure.feature

@@ -0,0 +1,11 @@
+Feature: success and failure
+  Scenario: success
+    Given the test passes
+  
+  Scenario: failure
+    Given nothing happens
+    And the test fails
+  
+  Scenario: failure on wrong step
+    Given nothing happens
+    And the test fails on the wrong step

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'cuke-test'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

data/spec/step_definitions/mock_steps.rb

@@ -0,0 +1,13 @@
+# Required by spec/features/require_mock_steps.rb
+
+Given /^nothing happens$/ do; end
+
+Given /^the test passes$/ do; end
+
+Given /^the test fails$/ do
+	flunk('The test failed!')
+end
+
+Given /^the test fails on the wrong step$/ do
+	flunk('The test failed on the wrong step!!')
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification 
+name: cuke-test
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- jarrett
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-14 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 6
+        - 3
+        version: 0.6.3
+  type: :runtime
+  version_requirements: *id002
+description: Packaging some Cucumber steps as a gem? Test them with Cuke Test.
+email: jarrett@uchicago.edu
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- cuke-test.gemspec
+- lib/cuke-test.rb
+- lib/cuke-test/config.rb
+- lib/cuke-test/cucumber_matchers.rb
+- lib/cuke-test/helpers.rb
+- spec/cuke-test_spec.rb
+- spec/features/failure.feature
+- spec/features/failure_on_wrong_step.feature
+- spec/features/require_mock_steps.rb
+- spec/features/success.feature
+- spec/features/success_and_failure.feature
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/step_definitions/mock_steps.rb
+has_rdoc: true
+homepage: http://github.com/jarrett/cuke-test
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Testing for custom Cucumber steps
+test_files: 
+- spec/cuke-test_spec.rb
+- spec/features/require_mock_steps.rb
+- spec/spec_helper.rb
+- spec/step_definitions/mock_steps.rb