stub_shell 0.0.1

data/.gitignore

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

data/.rspec

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

data/.rvmrc

@@ -0,0 +1 @@
+rvm use "ruby-1.9.3-p0@betamax" --create

data/.travis.yml

@@ -0,0 +1,8 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - rbx-2.0
+  - jruby
+  - ruby-head
+  - ree

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) Stack Builders inc.
+
+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,34 @@
+# StubShell [![Build Status](https://secure.travis-ci.org/stackbuilders/stub_shell.png)](http://travis-ci.org/stackbuilders/stub_shell)
+
+## Installation
+
+    gem install stub_shell
+
+## Configuration
+
+    require 'stub_shell'
+
+    RSpec.configure do |config|
+      config.include StubShell::TestHelpers
+    end
+
+## Usage
+
+    it ... do
+      stub_shell do
+        command "ls /tmp/foobar" do
+          stdout "hey there"
+        end
+      end
+    end
+
+## Contribute
+
+1. [Fork](http://help.github.com/forking/) stub_shell
+2. Create a topic branch - `git checkout -b my_branch`
+3. Push to your branch - `git push origin my_branch`
+4. Create a [Pull Request](http://help.github.com/pull-requests/) from your branch
+
+## License
+
+See LICENSE

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/fake_process.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+exit $1

data/lib/stub_shell/command.rb

@@ -0,0 +1,44 @@
+module StubShell
+  class Command  
+    attr_reader :context, :result, :match
+
+    def initialize match, context, &block
+      @match    = match
+      @context = context
+      @result  = Result.new
+
+      instance_eval &block
+    end
+
+    def stub_shell &block
+      raise ArgumentError, "stub_shell has already been defined for #{self}" if @stub_shell
+      @stub_shell = Shell.new(self.context, &block)
+    end
+
+    def matches? input_string
+      case match
+      when String
+        input_string == match
+      when Regexp
+        !!(match.match input_string)
+      end
+    end
+    
+    def current_context
+      @stub_shell
+    end
+
+    def stdout output
+      result.stdout = output
+    end
+
+    def stderr output
+      result.stderr = output
+    end
+
+    def exitstatus code
+      result.exitstatus = code
+    end  
+  end
+end
+

data/lib/stub_shell/result.rb

@@ -0,0 +1,10 @@
+module StubShell
+  class Result
+    attr_accessor :stdout, :stderr, :exitstatus
+
+    def initialize
+      @exitstatus = 0
+    end
+  end
+end
+

data/lib/stub_shell/shell.rb

@@ -0,0 +1,39 @@
+module StubShell
+  class Shell
+    attr_reader :parent_context
+
+    def initialize parent_context = nil, &block
+      @parent_context  = parent_context
+      @commands        = [ ]
+
+      instance_eval &block
+    end
+
+    def command name, &block
+      @commands << Command.new(name, self, &block)
+    end
+
+    # Resolves the requested command and returns the command definition and
+    # the context from which to execute the next command.
+    def execute command_string
+      resolved_command = resolve(command_string)
+      [resolved_command, resolved_command.current_context || self]
+    end
+
+    protected
+
+    # Look in current context and recursively through any available parent contexts to
+    # find definition of command. An Exception is raised if no implementation of command
+    # is found.
+    def resolve command_string
+      if detected_command = @commands.detect{|cmd| cmd.matches? command_string }
+        detected_command
+      elsif parent_context
+        parent_context.resolve(command_string)
+      else
+        raise "Command #{command_string} could not be resolved from the current context."
+      end
+    end  
+  end
+end
+

data/lib/stub_shell/test_helpers.rb

@@ -0,0 +1,7 @@
+module StubShell
+  module TestHelpers
+    def stub_shell &block
+      StubShell.current_context = StubShell::Shell.new &block
+    end
+  end
+end

data/lib/stub_shell/version.rb

@@ -0,0 +1,3 @@
+module StubShell
+  VERSION = "0.0.1"
+end

data/lib/stub_shell.rb

@@ -0,0 +1,26 @@
+module StubShell  
+  class << self
+    attr_accessor :current_context
+  end
+  
+  self.current_context = nil
+end
+
+require 'stub_shell/result'
+require 'stub_shell/command'
+require 'stub_shell/shell'
+require 'stub_shell/test_helpers'
+
+def run_command cmd
+  command, StubShell.current_context = StubShell.current_context.execute(cmd)
+  Kernel.send(:`, "#{File.join(File.dirname(__FILE__), '..', 'bin', 'fake_process.sh')} '#{command.result.exitstatus}'")
+  command
+end
+
+def `(cmd)
+  run_command(cmd).result.stdout
+end
+
+def system(cmd)
+  run_command(cmd).result.exitstatus == 0
+end

data/spec/acceptance/stub_shell_spec.rb

@@ -0,0 +1,107 @@
+require 'spec_helper'
+
+describe StubShell do
+  describe "stubbing a command with backquote" do
+    it "should set the correct value for STDOUT" do
+      stub_shell do
+        command "ls /tmp/foobar" do
+          stdout "hey there"
+        end
+      end
+      
+      `ls /tmp/foobar`.should == 'hey there'
+    end
+    
+    it "should have an exitstatus of 0 by default" do      
+      stub_shell do
+        command "ls /tmp/foobar" do
+          stdout "hey there"
+        end
+      end
+      
+      `ls /tmp/foobar`
+      $?.exitstatus.should == 0
+    end
+    
+    it "should allow the user to set a non-zero exit status" do
+      stub_shell do
+        command "ls /tmp/foobar" do
+          stdout "hey there"
+          exitstatus 1
+        end
+      end
+      
+      `ls /tmp/foobar`
+      $?.exitstatus.should == 1
+    end
+  end  
+  
+  describe "using a shell context after the shell state has been mutated" do
+    it "should use the return value from the nested context" do
+      stub_shell do
+        command 'ls /tmp/foobar' do
+          stdout 'yes, foobar exists'
+        end
+
+        command "rm /tmp/foobar" do
+          stderr 1
+
+          stub_shell do
+            command 'ls /tmp/foobar' do
+              stdout 'the file no longer exists'
+            end
+          end
+        end
+      end
+
+      `ls /tmp/foobar`.should == 'yes, foobar exists'
+      `rm /tmp/foobar`
+      `ls /tmp/foobar`.should == 'the file no longer exists'
+    end
+    
+    it "should find commands defined in a more general context even when some state has been mutated" do
+      stub_shell do
+        command 'ls /tmp/myfile' do
+          stdout 'yes, your file exists'
+        end
+
+        command "rm /tmp/foobar" do
+          stderr 1
+
+          stub_shell do
+            command 'ls /tmp/foobar' do
+              stdout 'the file no longer exists'
+            end
+          end
+        end
+      end
+
+      `rm /tmp/foobar`
+      `ls /tmp/myfile`.should == 'yes, your file exists'
+    end
+  end
+  
+  describe "with Kernel#system" do
+    it "should return true if the command succeeds (ie., has an exitstatus of 0)" do
+      stub_shell { command('ls /tmp/stuff') { exitstatus 0 } }
+      system('ls /tmp/stuff').should be_true
+    end
+    
+    it "should return true if the command succeeds (ie., has a non-zero exit status)" do
+      stub_shell { command('ls /tmp/stuff') { exitstatus 1 } }
+      system('ls /tmp/stuff').should be_false
+    end
+  end
+  
+  describe "with a command having a regular expression" do
+    it "should match a command matching the regular expression" do
+      stub_shell do
+        command /ls .*/ do
+          stdout 'yes, your file exists'
+        end
+      end
+      
+      `ls /tmp/heythere`.should == 'yes, your file exists'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'bundler/setup'
+
+require 'simplecov'
+SimpleCov.start
+
+require 'stub_shell'
+
+RSpec.configure do |config|
+  config.include StubShell::TestHelpers
+end

data/stub_shell.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "stub_shell/version"
+
+Gem::Specification.new do |s|
+  s.name        = "stub_shell"
+  s.version     = StubShell::VERSION
+  s.authors     = ["Justin Leitgeb", "itsmeduncan"]
+  s.email       = ["justin@stackbuilders.com", "itsmeduncan@gmail.com"]
+  s.homepage    = "http://github.com/stackbuilders/stub_shell"
+  s.summary     = %q{Stub results of shell commands for test purposes}
+  s.description = %q{Stubs a set of shell commands and their return values using the backquote operator.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- spec/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency 'rake', '~> 0.9.2.2'
+  s.add_development_dependency 'rspec', '~> 2.8.0'
+  s.add_development_dependency 'simplecov', '~> 0.5.4'
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: stub_shell
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Justin Leitgeb
+- itsmeduncan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70158647692840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+  type: :development
+  prerelease: false
+  version_requirements: *70158647692840
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70158647692280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *70158647692280
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70158647691760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.4
+  type: :development
+  prerelease: false
+  version_requirements: *70158647691760
+description: Stubs a set of shell commands and their return values using the backquote
+  operator.
+email:
+- justin@stackbuilders.com
+- itsmeduncan@gmail.com
+executables:
+- fake_process.sh
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.markdown
+- Rakefile
+- bin/fake_process.sh
+- lib/stub_shell.rb
+- lib/stub_shell/command.rb
+- lib/stub_shell/result.rb
+- lib/stub_shell/shell.rb
+- lib/stub_shell/test_helpers.rb
+- lib/stub_shell/version.rb
+- spec/acceptance/stub_shell_spec.rb
+- spec/spec_helper.rb
+- stub_shell.gemspec
+homepage: http://github.com/stackbuilders/stub_shell
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Stub results of shell commands for test purposes
+test_files:
+- spec/acceptance/stub_shell_spec.rb
+- spec/spec_helper.rb