rspec-shell-expectations 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 127a017e7189b42bb60796d4f67541565be8a18f
+  data.tar.gz: 46b7ccd1ed98f6be39cdc15f4a9bf966d13ead8b
+SHA512:
+  metadata.gz: d9e2a19a358068276dd5d873ec897330d6f1475d96896348277cee4154c3419c6138badd467b282d507c24bad2b2cf873978664150350b0097bc599bdb4389ae
+  data.tar.gz: b1fa23150c66df71f1d2aaa6b05253eb0deddfffc5203046cff84dc39b4a661d736af1cbd7167e3ad12a38949ebf3728ade0731ea6a22fc38d5d20111494c664

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.ruby-version

@@ -0,0 +1 @@
+2.1.2

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.1.0
+  - 2.0.0
+  - ruby-head
+  - jruby-head

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rspec-shell-expectations.gemspec
+gemspec
+gem 'rubocop'
+gem 'rake'
+gem 'rspec'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Matthijs Groen
+
+MIT License
+
+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,70 @@
+# Rspec::Shell::Expectations
+[![Build Status](https://travis-ci.org/matthijsgroen/rspec-shell-expectations.png?branch=master)](https://travis-ci.org/matthijsgroen/rspec-shell-expectations)
+
+Run your shell script in a mocked environment to test its behaviour
+using RSpec.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec-shell-expectations'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec-shell-expectations
+
+## Usage
+
+see specs in `spec/` folder:
+
+### Running script through stubbed env:
+
+```ruby
+  require 'English'
+
+  describe 'my shell script' do
+    include Rspec::Shell::Expectations
+
+    let(:stubbed_env) { create_stubbed_env }
+
+    it 'runs the script' do
+      stubbed_env.execute 'my-shell-script.sh'
+      expect($CHILD_STATUS.exitstatus).to eq 0
+    end
+  end
+```
+
+### Stubbing commands:
+
+```ruby
+  require 'English'
+
+  describe 'my shell script' do
+    include Rspec::Shell::Expectations
+
+    let(:stubbed_env) { create_stubbed_env }
+    before do
+      stubbed_env.stub_command('rake')
+    end
+
+    it 'runs the script' do
+      stubbed_env.execute 'my-shell-script.sh'
+      expect($CHILD_STATUS.exitstatus).to eq 0
+    end
+  end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/matthijsgroen/rspec-shell-expectations/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.verbose = false
+end
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+task default: [:rubocop, :spec]

data/bin/stub

@@ -0,0 +1 @@
+#!/usr/bin/env ruby

data/lib/rspec/shell/expectations.rb

@@ -0,0 +1,2 @@
+require 'rspec/shell/expectations/version'
+require 'rspec/shell/expectations/stubbed_env'

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

@@ -0,0 +1,35 @@
+require 'tmpdir'
+
+module Rspec
+  module Shell
+    # Define stubbed environment to set and assert expectations
+    module Expectations
+      def create_stubbed_env
+        StubbedEnv.new
+      end
+
+      # A shell environment that can manipulate behaviour
+      # of executables
+      class StubbedEnv
+        def initialize
+          @dir = Dir.mktmpdir
+          at_exit { FileUtils.remove_entry_secure @dir }
+        end
+
+        def stub_command(command)
+          FileUtils.cp('bin/stub', File.join(@dir, command))
+        end
+
+        def execute(command)
+          `#{stub_path} #{command}`
+        end
+
+        private
+
+        def stub_path
+          "PATH=#{@dir}:$PATH"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+module Rspec
+  module Shell
+    #:nodoc:
+    module Expectations
+      VERSION = '0.0.1'
+    end
+  end
+end

data/rspec-shell-expectations.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspec/shell/expectations/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rspec-shell-expectations'
+  spec.version       = Rspec::Shell::Expectations::VERSION
+  spec.authors       = ['Matthijs Groen']
+  spec.email         = ['matthijs.groen@gmail.com']
+  spec.summary       = 'Fake execution environments to TDD shell scripts'
+  spec.description   = <<-DESCRIPTION
+    Stub results of commands.
+    Assert calls and input using RSpec for your shell scripts
+  DESCRIPTION
+  spec.homepage      = ''
+  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.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '>= 1.6'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/spec/fixtures/simple_script.sh

@@ -0,0 +1 @@
+command1

data/spec/replace_shell_commands_spec.rb

@@ -0,0 +1,33 @@
+require 'English'
+require 'rspec/shell/expectations'
+
+describe 'Replace shell commands' do
+  include Rspec::Shell::Expectations
+
+  describe 'running a file with non-existing commands' do
+    it 'exits with an error' do
+      `spec/fixtures/simple_script.sh 2>&1`
+      expect($CHILD_STATUS.exitstatus).not_to eq 0
+    end
+
+    context 'with stubbed environment' do
+      let(:stubbed_env) { create_stubbed_env }
+
+      it 'exits with an error' do
+        stubbed_env.execute 'spec/fixtures/simple_script.sh 2>&1'
+        expect($CHILD_STATUS.exitstatus).not_to eq 0
+      end
+
+      context 'with a stubbed command' do
+        before do
+          stubbed_env.stub_command('command1')
+        end
+
+        it 'exits with status code 0' do
+          stubbed_env.execute 'spec/fixtures/simple_script.sh 2>&1'
+          expect($CHILD_STATUS.exitstatus).to eq 0
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: rspec-shell-expectations
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matthijs Groen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: |2
+      Stub results of commands.
+      Assert calls and input using RSpec for your shell scripts
+email:
+- matthijs.groen@gmail.com
+executables:
+- stub
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/stub
+- lib/rspec/shell/expectations.rb
+- lib/rspec/shell/expectations/stubbed_env.rb
+- lib/rspec/shell/expectations/version.rb
+- rspec-shell-expectations.gemspec
+- spec/fixtures/simple_script.sh
+- spec/replace_shell_commands_spec.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Fake execution environments to TDD shell scripts
+test_files:
+- spec/fixtures/simple_script.sh
+- spec/replace_shell_commands_spec.rb