rspec-shell-expectations 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5e9f440ad12bd32b427963ee19bac8917d16fb35
-  data.tar.gz: 96b950d92f8a37146454dc0b4ea7b7d56e68a94c
+  metadata.gz: 21c937d11afe4208b5dcc9f5a50ede733e65bbf5
+  data.tar.gz: 42d77825f030757dae04172a2fa6c7e561d78c74
 SHA512:
-  metadata.gz: 8e1a7f3c994ca57c059da3b01506bda96c467bd305d3c9c2d33d1c0f1f035aad4d254f642f393063af0f2cea965920d1f15da60ae62ebee8cf008d15e78c635d
-  data.tar.gz: 2b44edac02c0ca132de37eb7cf56e21d7f5c2bffc8426dcb0374ddc6daf6f52ec53611951cd1eabf0919bd4999dc2a79f853f49e7269428a078478e0ff15ddbd
+  metadata.gz: 8753dc31edea97051a92de8cda82189bd8098742cb1f60f39ac3da352d9ba082e62c33bfd694bb684fee3014fdb288e51eda72f391356f0bed5aacbda93db6d1
+  data.tar.gz: 99861b40a7daefa40221c32d412edc90c4bd21494815193731758813221e0942ff2d24524d1063fc3a83bbc0d7180068dd6e8ddb01491f5c17c2edf79faf14f7

data/README.md

@@ -6,6 +6,19 @@
 Run your shell script in a mocked environment to test its behaviour
 using RSpec.
 
+## Features
+
+- Setup a fake shell environment that has preference in exucing commands
+  (highest path value)
+- Stub shell commands in this environment
+- Control multiple outputs (through STDOUT, STDERR or files)
+- Control exit status codes
+- Set different configurations based on command line arguments
+- Verify if command is called
+- Verify arguments command is called with
+- Verify STDIN
+
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -92,6 +105,8 @@ see specs in `spec/` folder:
     rake_stub.outputs('informative message', to: :stdout)
       .outputs('error message', to: :stderr)
       .outputs('log contents', to: 'logfile.log')
+      .outputs('converted result', to: ['prefix-', :arg2, '.txt'])
+    # last one creates 'prefix-foo.txt' when called as 'rake convert foo'
   end
 ```
 
@@ -124,7 +139,7 @@ see specs in `spec/` folder:
 
 ## More examples
 
-see the *features* folder
+see the *features* and *spec* folder
 
 ## Supported ruby versions
 

data/bin/stub

@@ -12,6 +12,23 @@ call_logs.open('a') do |f|
   f.puts "  stdin: #{$stdin.read.inspect}" unless STDIN.tty?
 end
 
+def interpolate_filename(elements)
+  return elements if elements.is_a? String
+  return nil unless elements.is_a? Array
+
+  elements.map do |element|
+    case element
+    when String then element
+    when Symbol then interpolate_argument(element)
+    end
+  end.join
+end
+
+def interpolate_argument(name)
+  return unless (data = /^arg(\d+)$/.match(name.to_s))
+  ARGV[data[1].to_i - 1]
+end
+
 call_configurations = Pathname.new(folder).join("#{command}_stub.yml")
 if call_configurations.exist?
   config = YAML.load call_configurations.read
@@ -32,8 +49,10 @@ if call_configurations.exist?
   (call_config[:outputs] || []).each do |data|
     $stdout.print data[:content] if data[:target] == :stdout
     $stderr.print data[:content] if data[:target] == :stderr
-    next unless data[:target].is_a? String
-    Pathname.new(data[:target]).open('w') do |f|
+
+    output_filename = interpolate_filename(data[:target])
+    next unless output_filename
+    Pathname.new(output_filename).open('w') do |f|
       f.print data[:content]
     end
   end

data/features/developer/step_definitions/general_steps.rb

@@ -14,7 +14,7 @@ Given(/^I have stubbed "(.*?)" with args as "(.*)":$/) do |command, call, table|
   # table is a Cucumber::Ast::Table
   args = table.hashes.map { |d| d['args'] }
   @stubbed_command = simulated_environment.stub_command(command)
-    .with_args(*args)
+                     .with_args(*args)
   @remembered_commands ||= {}
   @remembered_commands[call] = @stubbed_command
 end
@@ -23,7 +23,7 @@ Given(/^I have stubbed "(.*?)" with args:$/) do |command, table|
   # table is a Cucumber::Ast::Table
   args = table.hashes.map { |d| d['args'] }
   @stubbed_command = simulated_environment.stub_command(command)
-    .with_args(*args)
+                     .with_args(*args)
 end
 
 sc = /^the stubbed command/

data/lib/rspec/shell/expectations/stubbed_env.rb

@@ -13,9 +13,18 @@ module Rspec
       # A shell environment that can manipulate behaviour
       # of executables
       class StubbedEnv
+        attr_reader :dir
+
         def initialize
           @dir = Dir.mktmpdir
-          at_exit { FileUtils.remove_entry_secure @dir }
+          ENV['PATH'] = "#{@dir}:#{ENV['PATH']}"
+          at_exit { cleanup }
+        end
+
+        def cleanup
+          paths = (ENV['PATH'].split ':') - [@dir]
+          ENV['PATH'] = paths.join ':'
+          FileUtils.remove_entry_secure @dir if Pathname.new(@dir).exist?
         end
 
         def stub_command(command)

data/lib/rspec/shell/expectations/version.rb

@@ -2,7 +2,7 @@ module Rspec
   module Shell
     #:nodoc:
     module Expectations
-      VERSION = '1.1.0'
+      VERSION = '1.2.0'
     end
   end
 end

data/rspec-shell-expectations.gemspec

@@ -17,8 +17,8 @@ Gem::Specification.new do |spec|
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '>= 1.6'

data/spec/stub_output_spec.rb

@@ -65,5 +65,22 @@ describe 'Stub command output' do
       expect(o).to be_empty
       expect(Pathname.new(filename).read).to eql 'world'
     end
+
+    describe 'using passed argument as filename' do
+      let(:script) do
+        <<-SCRIPT
+          command1 input output
+        SCRIPT
+      end
+
+      let(:passed_filename) { ['hello-', :arg2, '.foo'] }
+      let(:filename) { 'hello-output.foo' }
+
+      it 'writes data to a interpolated filename' do
+        command1_stub.outputs('world', to: passed_filename)
+        subject
+        expect(Pathname.new(filename).read).to eql 'world'
+      end
+    end
   end
 end

data/spec/stubbed_env_spec.rb

@@ -0,0 +1,33 @@
+require 'English'
+require 'rspec/shell/expectations'
+
+describe 'StubbedEnv' do
+  include Rspec::Shell::Expectations
+
+  describe 'creating a stubbed env' do
+    it 'extends the PATH with the stubbed folder first' do
+      expect { create_stubbed_env }.to change { ENV['PATH'] }
+    end
+
+    it 'creates a folder to place the stubbed commands in' do
+      env = create_stubbed_env
+      expect(Pathname.new(env.dir)).to exist
+      expect(Pathname.new(env.dir)).to be_directory
+    end
+  end
+
+  describe '#cleanup' do
+    it 'restores the environment variable PATH' do
+      original_path = ENV['PATH']
+      env = create_stubbed_env
+
+      expect { env.cleanup }.to change { ENV['PATH'] }.to original_path
+    end
+
+    it 'removes the folder with stubbed commands' do
+      env = create_stubbed_env
+      env.cleanup
+      expect(Pathname.new(env.dir)).not_to exist
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-shell-expectations
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Matthijs Groen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-18 00:00:00.000000000 Z
+date: 2015-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -85,6 +85,7 @@ files:
 - spec/provide_env_vars_spec.rb
 - spec/replace_shell_commands_spec.rb
 - spec/stub_output_spec.rb
+- spec/stubbed_env_spec.rb
 homepage: ''
 licenses:
 - MIT
@@ -129,3 +130,4 @@ test_files:
 - spec/provide_env_vars_spec.rb
 - spec/replace_shell_commands_spec.rb
 - spec/stub_output_spec.rb
+- spec/stubbed_env_spec.rb