shell_mock 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 160dfa02d4b23e67d61886aecffb53bd916f2f72
+  data.tar.gz: de591f0065dcae5483cd75d1527b9564a1d22a8a
+SHA512:
+  metadata.gz: 5e9d2edb53f6dc2f931706bf11f3ffe1e9526642e4b8d06b6e9d2355a0de8abc3860e10c3fa53746d4806943b4538529e28dcc411b4f21be4be345369538273c
+  data.tar.gz: d0d12149d6d206641407d64fc2a6dfd645f669694f7837cacac9803e320d38c98e3945bd5a36550e5a0c1a679c0ede56cb8e9977960a30a1affd31c3c5e4490d

data/.env

@@ -0,0 +1 @@
+rvm use 2.3.0

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/spec/examples.txt
+tags

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require shell_mock_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at choffman@optoro.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Chris Hoffman
+
+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,76 @@
+# ShellMock
+
+It's [webmock](http://github.com/bblimke/webmock) for shell commands. It's pretty simple. You can do things like this:
+
+```ruby
+require 'shell_mock/rspec'
+
+describe 'something' do
+  stub = ShellMock.stub_command('ls')
+
+  expect(system('ls')).to eq true
+
+  expect(stub).to have_been_called
+end
+```
+
+### More complex expectations are also supported.
+
+Called exactly once: `expect(stub).to have_been_called.once`
+
+Not called: `expect(stub).to_not have_been_called` or `expect(stub).to have_been_called.never`
+
+Called exactly `n` times: `expect(stub).to have_been_called.times(n)`
+
+Called more than `n` times: `expect(stub).to have_been_called.more_than(n)`
+
+Called fewer than `n` times: `expect(stub).to have_been_called.fewer_than(n)`
+
+`less_than` is also an alias for `fewer_than`.
+
+Right now, only exact command string matches are supported.
+
+### You can also set the output of the command invocation:
+
+```ruby
+require 'shell_mock/rspec'
+
+describe 'something' do
+  stub = ShellMock.stub_commmand('ls').and_return("\n")
+
+  expect(`ls`).to eq "\n"
+
+  expect(stub).to have_been_called.once
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'shell_mock'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install shell_mock
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/yarmiganosca/shell_mock. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

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/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "shell_mock"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/shell_mock/call_verifier.rb

@@ -0,0 +1,56 @@
+module ShellMock
+  class CallVerifier
+    def initialize
+      match_calls_when { |calls| calls.any? }
+    end
+
+    def matches?(actual)
+      @actual = actual
+
+      condition.call(actual.calls)
+    end
+
+    def failure_message
+      "#{actual.command} was expected."
+    end
+
+    def failure_message_when_negated
+      "#{actual.command} was not expected."
+    end
+
+    def once
+      times(1)
+    end
+
+    def never
+      times(0)
+    end
+
+    def times(n)
+      match_calls_when { |calls| calls.size == n }
+
+      self
+    end
+
+    def fewer_than(n)
+      match_calls_when { |calls| calls.size < n }
+
+      self
+    end
+    alias less_than fewer_than
+
+    def more_than(n)
+      match_calls_when { |calls| calls.size > n }
+
+      self
+    end
+
+    private
+
+    attr_reader :actual, :condition
+
+    def match_calls_when(&blk)
+      @condition = blk
+    end
+  end
+end

data/lib/shell_mock/command_stub.rb

@@ -0,0 +1,50 @@
+require 'shell_mock/call_verifier'
+
+module ShellMock
+  class CommandStub
+    attr_reader :command, :expected_output, :return_code
+
+    def initialize(command)
+      @command = command
+    end
+
+    def with_env(env)
+      @env = env
+
+      self
+    end
+
+    def env
+      @env || {}
+    end
+
+    def with_option(option)
+      @options = options
+
+      self
+    end
+
+    def options
+      @options || {}
+    end
+
+    def and_return(expected_output, return_code: 0)
+      @expected_output = expected_output
+      @return_code     = return_code
+
+      self
+    end
+
+    def side_effect
+      @side_effect || proc {}
+    end
+
+    def calls
+      @calls ||= []
+    end
+
+    def called_with(env, command, options)
+      calls << [env, command, options]
+    end
+  end
+end

data/lib/shell_mock/core_ext/kernel.rb

@@ -0,0 +1,41 @@
+require 'shell_mock/no_stub_specified'
+
+module Kernel
+  def __shell_mocked_system(env, command = nil, **options)
+    env, command = {}, env if command.nil?
+
+    # other arg manipulation
+
+    stub = ShellMock::StubRegistry.stub_matching(env, command, options)
+
+    if stub
+      stub.side_effect.call
+      stub.called_with(env, command, options)
+
+      return stub.return_code == 0
+    else
+      if ShellMock.let_commands_run?
+        __un_shell_mocked_system(env, command, **options)
+      else
+        raise ShellMock::NoStubSpecified.new(env, command, options)
+      end
+    end
+  end
+
+  def __shell_mocked_backtick(command)
+    stub = ShellMock::StubRegistry.stub_matching({}, command, {})
+
+    if stub
+      stub.side_effect.call
+      stub.called_with({}, command, {})
+
+      return stub.expected_output
+    else
+      if ShellMock.let_commands_run?
+        __un_shell_mocked_backtick(command)
+      else
+        raise ShellMock::NoStubSpecified.new({}, command, {})
+      end
+    end
+  end
+end

data/lib/shell_mock/no_stub_specified.rb

@@ -0,0 +1,7 @@
+module ShellMock
+  class NoStubSpecified < StandardError
+    def initialize(env, command, **options)
+      super("no stub specified for #{command}")
+    end
+  end
+end

data/lib/shell_mock/rspec/matchers.rb

@@ -0,0 +1,9 @@
+require 'shell_mock/call_verifier'
+
+module ShellMock
+  module Matchers
+    def have_been_called
+      ShellMock::CallVerifier.new
+    end
+  end
+end

data/lib/shell_mock/rspec.rb

@@ -0,0 +1,13 @@
+require 'shell_mock'
+
+require 'rspec/core'
+require 'rspec/expectations'
+
+require 'shell_mock/rspec/matchers'
+
+ShellMock.enable
+ShellMock.dont_let_commands_run
+
+RSpec.configure do |config|
+  config.include ShellMock::Matchers
+end

data/lib/shell_mock/stub_registry.rb

@@ -0,0 +1,30 @@
+module ShellMock
+  StubRegistry = Object.new
+
+  StubRegistry.instance_exec do
+    def register_command_stub(command_stub)
+      command_stubs << command_stub
+      command_stub
+    end
+
+    def stub_matching(env, command, options)
+      matching_stubs = command_stubs.select do |command_stub|
+        command_stub.env <= env &&
+          command_stub.options <= options &&
+          command_stub.command == command
+      end
+
+      matching_stubs.max_by do |command_stub|
+        [env.size, options.size]
+      end
+    end
+
+    def command_stubs
+      @command_stubs ||= []
+    end
+
+    def clear
+      @command_stubs = []
+    end
+  end
+end

data/lib/shell_mock/version.rb

@@ -0,0 +1,3 @@
+module ShellMock
+  VERSION = "0.1.0"
+end

data/lib/shell_mock.rb

@@ -0,0 +1,52 @@
+require "shell_mock/version"
+require 'shell_mock/stub_registry'
+require 'shell_mock/command_stub'
+require 'shell_mock/core_ext/kernel'
+
+module ShellMock
+  def self.stub_command(command)
+    command_stub = CommandStub.new(command)
+
+    StubRegistry.register_command_stub(command_stub)
+  end
+
+  def self.let_commands_run
+    @let_commands_run = true
+  end
+
+  def self.dont_let_commands_run
+    @let_commands_run = false
+  end
+
+  def self.let_commands_run?
+    @let_commands_run = true if @let_commands_run.nil?
+    @let_commands_run
+  end
+
+  def self.dont_let_commands_run?
+    !let_commands_run?
+  end
+
+  def self.enable
+    Kernel.module_exec do
+      if Kernel.respond_to?(:__shell_mocked_system)
+        define_method(:__un_shell_mocked_system, &method(:system).to_proc)
+        define_method(:system, &method(:__shell_mocked_system).to_proc)
+      end
+
+      if Kernel.respond_to?(:__shell_mocked_backtick)
+        define_method(:__un_shell_mocked_backtick, &method(:`).to_proc)
+        define_method(:`, &method(:__shell_mocked_backtick).to_proc)
+      end
+    end
+  end
+
+  def self.disable
+    Kernel.module_exec do
+      define_method(:system, &method(:__un_shell_mocked_system).to_proc) if Kernel.respond_to?(:__un_shell_mocked_system)
+      define_method(:`, &method(:__un_shell_mocked_backtick).to_proc)    if Kernel.respond_to?(:__un_shell_mocked_backtick)
+    end
+
+    StubRegistry.clear
+  end
+end

data/shell_mock.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'shell_mock/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "shell_mock"
+  spec.version       = ShellMock::VERSION
+  spec.authors       = ["Chris Hoffman"]
+  spec.email         = ["yarmiganosca@gmail.com"]
+
+  spec.summary       = %q{WebMock for shell commands}
+  spec.description   = spec.summary
+  spec.homepage      = "http://www.github.com/yarmiganosca/shell_mock"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'pry-byebug'
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: shell_mock
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Hoffman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: WebMock for shell commands
+email:
+- yarmiganosca@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/shell_mock.rb
+- lib/shell_mock/call_verifier.rb
+- lib/shell_mock/command_stub.rb
+- lib/shell_mock/core_ext/kernel.rb
+- lib/shell_mock/no_stub_specified.rb
+- lib/shell_mock/rspec.rb
+- lib/shell_mock/rspec/matchers.rb
+- lib/shell_mock/stub_registry.rb
+- lib/shell_mock/version.rb
+- shell_mock.gemspec
+homepage: http://www.github.com/yarmiganosca/shell_mock
+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.5.1
+signing_key: 
+specification_version: 4
+summary: WebMock for shell commands
+test_files: []