aruba-doubles 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in aruba-doubles.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Björn Albers
+
+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,45 @@
+Double command line applications in your Cucumber features
+
+## Motivation
+
+Let's say you develop a command line application ([BDD](http://en.wikipedia.org/wiki/Behavior_Driven_Development)-style with [Cucumber](http://cukes.info/) and [Aruba](https://github.com/cucumber/aruba)) which itself relys on other CLI stuff that makes testing harder (i.e. it calls under certain conditions `kill_a_random_cat` or `launch_nukes`... Don't do that in your tests!).
+Stubbing and mocking in your Cucumber features is usually not recommended (in order to test "the full stack"), but in some cases it could make your life easier (Your cat will thank you later.)
+Aruba-Double lets you stub out those evil commands in your scenarios by injecting temporary doubles in your system (it will hijack your PATH during tests).
+
+(Note: This little Gem isn't an official part of Aruba but it works as a complement, so they'll play hopefully nicely together.)
+
+## Usage
+
+If you have a `Gemfile`, add `aruba-doubles`. Otherwise, install it like this:
+
+    gem install aruba-doubles
+
+Then, `require` the library in one of your ruby files under `features/support` (e.g. `env.rb`)
+
+    require 'aruba-doubles/cucumber'
+
+Take a peek at `features/*.feature` for some examples and look in `lib/aruba-doubles/cucumber.rb` for all step definitions.
+
+## Caveats
+
+Aruba-Double won't work, if your command...
+
+* calls other commands with absolute path, i.e. `/usr/local/kill_a_random_cat`
+* defines its own PATH
+* calls build-in commands from your shell like `echo` (but who want to stub that)
+
+Also note that doubles will be created as scripts in temporary directories on your filesystem, which might slow down your tests.
+
+## Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.  Note: the existing tests may fail
+* Commit, do not mess with Rakefile, gemspec or History.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2011 Björn Albers. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "--format pretty"
+end
+
+task :default => :features

data/aruba-doubles.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name        = 'aruba-doubles'
+  s.version     = '0.0.1'
+  s.authors     = ["Björn Albers"]
+  s.email       = ["bjoernalbers@googlemail.com"]
+  s.description = 'Double command line applications in your Cucumber features'
+  s.summary     = "#{s.name}-#{s.version}"
+  s.homepage    = 'https://github.com/bjoernalbers/aruba-doubles'
+
+  s.add_dependency 'cucumber', '>= 1.0.2'
+  
+  s.add_development_dependency 'aruba', '>= 0.4.6'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/features/double_cli_apps.feature

@@ -0,0 +1,87 @@
+Feature: Double command line applications
+
+	In order to double command line applications
+	As a developer using Cucumber
+	I want to use the "double of" steps
+
+	Scenario: Double default behaviour
+		Given a double of "ls"
+		When I run `ls -la`
+		Then the exit status should be 0
+		And the stdout should contain exactly:
+			"""
+			"""			
+		And the stderr should contain exactly:
+			"""
+			"""
+
+	Scenario: Double with stdout
+		Given a double of "ls" with stdout:
+			"""
+			hello, world.
+			"""
+		When I successfully run `ls -la`
+		Then the stdout should contain exactly:
+			"""
+			hello, world.
+			
+			"""
+		And the stderr should contain exactly:
+			"""
+			"""
+
+	 Scenario: Double with stderr
+	 	Given a double of "ls" with stderr:
+	 		"""
+	 		error: something crashed!
+	 		"""
+	 	When I successfully run `ls -la`
+	 	And the stdout should contain exactly:
+	 		"""
+	 		"""
+	 	Then the stderr should contain exactly:
+	 		"""
+	 		error: something crashed!
+   
+	 		"""
+
+	Scenario: Double with exit status
+		Given a double of "ls" with exit status 255
+		When I run `ls -la`
+		Then the exit status should be 255
+		And the stdout should contain exactly:
+			"""
+			"""			
+		And the stderr should contain exactly:
+			"""
+			"""
+
+	Scenario: Double with exit status and stdout
+		Given a double of "ls" with exit status 255 and stdout:
+			"""
+			hello, world.
+			"""
+		When I run `ls -la`
+		Then the exit status should be 255
+		And the stdout should contain exactly:
+			"""
+			hello, world.
+			
+			"""			
+		And the stderr should contain exactly:
+			"""
+			"""
+
+	@repeat_arguments
+	Scenario: Double with repeating arguments
+		Given a double of "ls"
+		When I run `ls -la`
+		Then the stdout should contain exactly:
+			"""
+			ls -la
+			
+			"""
+		And the stderr should contain exactly:
+			"""
+			"""
+

data/features/support/env.rb

@@ -0,0 +1,2 @@
+require 'aruba/cucumber'
+require 'aruba-doubles/cucumber'

data/lib/aruba-doubles/api.rb

@@ -0,0 +1,33 @@
+module ArubaDoubles
+  module Api
+    def doubles_dir
+      @doubles_dir ||= Dir.mktmpdir
+    end
+    
+    def patch_original_path
+      @__aruba_doubles_original_path = (ENV['PATH'] || '').split(File::PATH_SEPARATOR)
+      ENV['PATH'] = ([doubles_dir] + @__aruba_doubles_original_path).join(File::PATH_SEPARATOR)
+    end
+
+    def restore_original_path
+      ENV['PATH'] = @__aruba_doubles_original_path.join(File::PATH_SEPARATOR)
+    end
+
+    def create_double(filename, options = {})
+      double = File.expand_path(filename, doubles_dir)
+      File.open(double, 'w') do |f|
+        f.puts "#!/usr/bin/env ruby"
+        f.puts "# Doubled command line application by aruba-double"
+        f.puts "puts ([File.basename(__FILE__)] + ARGV).join(' ')" if @repeat_arguments
+        f.puts "puts \"#{options[:stdout]}\"" if options[:stdout]
+        f.puts "warn \"#{options[:stderr]}\"" if options[:stderr]
+        f.puts "exit(#{options[:exit_status]})" if options[:exit_status]
+      end
+      FileUtils.chmod(0755, double)
+    end
+    
+    def remove_doubles
+      FileUtils.rm_r(doubles_dir) if File.directory?(doubles_dir)
+    end
+  end
+end

data/lib/aruba-doubles/cucumber.rb

@@ -0,0 +1,32 @@
+require 'aruba-doubles/api'
+
+World(ArubaDoubles::Api)
+
+Before do
+  patch_original_path
+end
+
+After do
+  restore_original_path
+  remove_doubles
+end
+
+Before('@repeat_arguments') do
+  @repeat_arguments = true
+end
+
+Given /^a double of "([^"]*)"$/ do |file|
+  create_double(file)
+end
+
+Given /^a double of "([^"]*)" with (stdout|stderr):$/ do |file, stdout_stderr, output|
+  create_double(file, stdout_stderr.to_sym => output)
+end
+
+Given /^a double of "([^"]*)" with exit status (\d+)$/ do |file, exit|
+  create_double(file, :exit_status => exit.to_i)
+end
+
+Given /^a double of "([^"]*)" with exit status (\d+) and (stdout|stderr):$/ do |file, exit, stdout_stderr, output|
+  create_double(file, :exit_status => exit.to_i, stdout_stderr.to_sym => output)
+end

data/lib/aruba-doubles.rb

@@ -0,0 +1 @@
+# Load nothing - just keep the file here to keep bundler happy.

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification 
+name: aruba-doubles
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- "Bj\xC3\xB6rn Albers"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-10-14 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 1
+        - 0
+        - 2
+        version: 1.0.2
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: aruba
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        - 4
+        - 6
+        version: 0.4.6
+  type: :development
+  version_requirements: *id002
+description: Double command line applications in your Cucumber features
+email: 
+- bjoernalbers@googlemail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- aruba-doubles.gemspec
+- features/double_cli_apps.feature
+- features/support/env.rb
+- lib/aruba-doubles.rb
+- lib/aruba-doubles/api.rb
+- lib/aruba-doubles/cucumber.rb
+homepage: https://github.com/bjoernalbers/aruba-doubles
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.8
+signing_key: 
+specification_version: 3
+summary: aruba-doubles-0.0.1
+test_files: 
+- features/double_cli_apps.feature
+- features/support/env.rb