aruba-doubles 0.0.1 → 0.0.2

data/README.md

@@ -1,12 +1,12 @@
-Double command line applications in your Cucumber features
+Stub command line applications with Cucumber
 
 ## 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).
+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_the_cat`... Don't do that in your tests!).
+Mocking and stubbing with Cucumber is usually [not recommended](https://github.com/cucumber/cucumber/wiki/Mocking-and-Stubbing-with-Cucumber) and tricky because we have do do it across processes but in some cases it could make your life easier (Your cat will thank you later.)
+Aruba-Double lets you fake those evil CLI applications by injecting temporary doubles in your system 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.)
+(Note: This little Gem isn't an official part of Aruba but it works as a complement, so they'll play nice together.)
 
 ## Usage
 
@@ -18,13 +18,23 @@ Then, `require` the library in one of your ruby files under `features/support` (
 
     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.
+Here is an example:
+
+		Scenario: Something went wrong
+			Given a double of "kill_the_cat" with exit status 255 and stderr:
+				"""
+				ERROR: You don't even have a cat!
+				"""
+			When I run `my_fancy_new_script`
+			Then ...
+
+Take a peek at `features/*.feature` for further examples and at `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`
+* calls other commands with absolute path, i.e. `/usr/local/kill_the_cat`
 * defines its own PATH
 * calls build-in commands from your shell like `echo` (but who want to stub that)
 

data/aruba-doubles.gemspec

@@ -2,10 +2,10 @@
 
 Gem::Specification.new do |s|
   s.name        = 'aruba-doubles'
-  s.version     = '0.0.1'
+  s.version     = '0.0.2'
   s.authors     = ["Björn Albers"]
   s.email       = ["bjoernalbers@googlemail.com"]
-  s.description = 'Double command line applications in your Cucumber features'
+  s.description = 'Stub command line applications with Cucumber'
   s.summary     = "#{s.name}-#{s.version}"
   s.homepage    = 'https://github.com/bjoernalbers/aruba-doubles'
 

data/features/environment-friendly.feature

@@ -0,0 +1,23 @@
+Feature: Environment-friendly
+
+	In order to not mess up my system or tests
+	As a developer using Cucumber
+	I want Aruba-Doubles to behave environment-friendly
+
+	Scenario: Create doubles directory only when necessary
+		When I run `ls`
+		Then the doubles directory should not exist
+
+	Scenario: Patch the original path only once
+		Given a double of "ls"
+		And a double of "ls"
+		Then the path should include 1 doubles directory
+
+	Scenario: Create doubles directory...
+		Given a double of "ls"
+		When I keep the doubles directory in mind
+	
+	Scenario: ...and check that it was deleted
+		Then the previous doubles directory should not exist
+
+		

data/features/step_definitions/dev_steps.rb

@@ -0,0 +1,17 @@
+Then /^the doubles directory should not exist$/ do
+  @doubles_dir.should be_nil
+end
+
+Then /^the path should include (\d+) doubles directory$/ do |count|
+  ENV['PATH'].split(File::PATH_SEPARATOR).count(@doubles_dir).should eql(count.to_i)
+end
+
+When /^I keep the doubles directory in mind$/ do
+  @@previous_doubles_dir = @doubles_dir
+end
+
+Then /^the previous doubles directory should not exist$/ do
+  File.should_not be_exist(@@previous_doubles_dir)
+end
+
+

data/lib/aruba-doubles/api.rb

@@ -1,23 +1,38 @@
 module ArubaDoubles
   module Api
-    def doubles_dir
-      @doubles_dir ||= Dir.mktmpdir
+    def doubled?
+      !@doubles_dir.nil?
     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)
+    def create_double(file, options = {})
+      unless doubled?
+        create_doubles_dir
+        patch_original_path
+      end
+      write_double(file, options)
+    end
+    
+    def remove_doubles
+      restore_original_path
+      remove_doubles_dir
     end
 
-    def restore_original_path
-      ENV['PATH'] = @__aruba_doubles_original_path.join(File::PATH_SEPARATOR)
+  private
+
+    def create_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 create_double(filename, options = {})
-      double = File.expand_path(filename, doubles_dir)
+    def write_double(file, options = {})
+      double = File.expand_path(file, @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 "# Doubled command line application by aruba-doubles"
         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]
@@ -25,9 +40,13 @@ module ArubaDoubles
       end
       FileUtils.chmod(0755, double)
     end
-    
-    def remove_doubles
-      FileUtils.rm_r(doubles_dir) if File.directory?(doubles_dir)
+
+    def restore_original_path
+      ENV['PATH'] = @__aruba_doubles_original_path.join(File::PATH_SEPARATOR) unless doubled?
+    end
+
+    def remove_doubles_dir
+      FileUtils.rm_r(@doubles_dir) unless @doubles_dir.nil?
     end
   end
 end

data/lib/aruba-doubles/cucumber.rb

@@ -1,20 +1,8 @@
+require 'aruba-doubles/hooks'
 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

data/lib/aruba-doubles/hooks.rb

@@ -0,0 +1,7 @@
+After do
+  remove_doubles if doubled?
+end
+
+Before('@repeat_arguments') do
+  @repeat_arguments = true
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: aruba-doubles
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - "Bj\xC3\xB6rn Albers"
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-14 00:00:00 Z
+date: 2011-10-17 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: cucumber
@@ -49,7 +49,7 @@ dependencies:
         version: 0.4.6
   type: :development
   version_requirements: *id002
-description: Double command line applications in your Cucumber features
+description: Stub command line applications with Cucumber
 email: 
 - bjoernalbers@googlemail.com
 executables: []
@@ -66,10 +66,13 @@ files:
 - Rakefile
 - aruba-doubles.gemspec
 - features/double_cli_apps.feature
+- features/environment-friendly.feature
+- features/step_definitions/dev_steps.rb
 - features/support/env.rb
 - lib/aruba-doubles.rb
 - lib/aruba-doubles/api.rb
 - lib/aruba-doubles/cucumber.rb
+- lib/aruba-doubles/hooks.rb
 homepage: https://github.com/bjoernalbers/aruba-doubles
 licenses: []
 
@@ -102,7 +105,9 @@ rubyforge_project:
 rubygems_version: 1.8.8
 signing_key: 
 specification_version: 3
-summary: aruba-doubles-0.0.1
+summary: aruba-doubles-0.0.2
 test_files: 
 - features/double_cli_apps.feature
+- features/environment-friendly.feature
+- features/step_definitions/dev_steps.rb
 - features/support/env.rb