shell_mock 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b756c372c9477ca0a21a3894fb4d07c35e87c14e
-  data.tar.gz: 565cb68f40d84a3f2d97ccaa50cad9aa41f16eb1
+  metadata.gz: 7c6fffa51532c59b133e8176343ab0fb1d6ca8b5
+  data.tar.gz: 71450c650b0e65096422bb2a7f467516bf810846
 SHA512:
-  metadata.gz: 40cf06dcafcc3e976cedac4a59623a1d47fc4c4f90f437a149d90f26ef62a3b200b6a342273bdd96036070107fa031d234a34a6fc56b457c9b0be99645257383
-  data.tar.gz: 9cdd1c5d0e1a1d8630aa03506493b2e847ad142fe47b4a56bfd5623522b1e8268369e045ea55fa9518f596b77a002730d3e50b5dc4e1d7597848b4a5e87baf5c
+  metadata.gz: 92aae540345018da0abd3b68d0704f56f0e8e9aa1bdf8ecabae9cc051fb1606a7874c6dc007ac0c368ef971974997550593feb42e03e5bd25bdbd51711187a31
+  data.tar.gz: 2d2d7ac3b2c6a3542ab48e16d16e3b9a36d7e6ddcfc35c369c26e61b984bf1e652ec29f98cebb3ff4df4594653e8aff1fa97bff4c61a549346a05ec6d51450db

data/CHANGELOG.md

@@ -1,11 +1,23 @@
 ## ROADMAP 1.0.0
 
+* `IOPopenMonkeyPatch`
+* `PTYSpawnMonkeyPatch`
+* `OpenMonkeyPatch`
+* should `SpawnMonkeyPatch` be 2 patches (`KernelSpawnMonkeyPatch` and `ProcessSpawnMonkeyPatch`)?
 * convert `CommandStub#and_exit` to `CommandStub#will_exit`
 * convert `CommandStub#and_output` to `CommandStub#will_output`
 * convert `CommandStub#and_return` to `CommandStub#will_return`
 * add `CommandStub#will_cause(&blk)` for specifying desired side effects
 * add `CommandStub#will_stdout(str)` & `CommandStub#will_stderr(str)`. these will work differently for backtick than it will for system & exec.
+* ADD YARD DOCUMENTATION TO METHODS
 * maybe add `CommandStub#with_stdin(str)` for `spawn`?
+* maybe adding the ability to specify the order in which commands output to stdout vs. stderr (like, a sequence of outputs) would be useful? would definitely be fun to build, not sure how useful it would be though.
+
+## RELEASE 0.6.0
+
+* FEATURE: use `#and_succeed` to set an invocation's exit status to 0
+* FEATURE: use `#and_fail` to set an invocation's exit status to 1
+* FIX: `ShellMock.disable` now resets the `let_commands_run` flag, preventing that from carrying between tests
 
 ## RELEASE 0.5.0
 

data/README.adoc

@@ -0,0 +1,142 @@
+= ShellMock
+:ext-relative: .adoc
+:source-highlighter: coderay
+:sectanchors:
+:linkattrs:
+:icons: font
+:toc: macro
+:toc-title:
+:toclevels: 3
+ifdef::env-github[]
+:tip-caption: :bulb:
+:note-caption: :information_source:
+:important-caption: :heavy_exclamation_mark:
+:caution-caption: :fire:
+:warning-caption: :warning:
+endif::[]
+
+http://badge.fury.io/rb/shell_mock[image:https://badge.fury.io/rb/shell_mock.png[Gem Version]]
+http://travis-ci.org/yarmiganosca/shell_mock[image:https://secure.travis-ci.org/yarmiganosca/shell_mock.png[Build Status]]
+
+toc::[]
+
+== What is ShellMock?
+
+It's http://github.com/bblimke/webmock[webmock, target="_blank"] for shell commands. It's pretty simple. You can do things like this:
+
+[source,ruby]
+----
+require 'shell_mock/rspec'
+
+RSpec.describe "shelling out to run 'ls'" do
+  before { ShellMock.enable } # <1>
+  after  { ShellMock.disable }
+
+  let(:stub) { ShellMock.stub_command('ls') } # <2>
+
+  it "works"
+    system('ls') # <3>
+
+    expect(stub).to have_been_called # <4>
+  end
+end
+----
+<1> enables ShellMock's monkey patches during the test
+<2> creates a command stub that will match the command `"ls"` (by default it will exit `0` and have no output)
+<3> shells out to run `"ls"` (in this case using `Kernel#system`)
+<4> correctly expects that our command stub for `"ls"` will have recorded an invocation
+
+== Using ShellMock
+
+=== You can narrow what invocations are matched to your command stub:
+
+Match env vars as well as the command: `ShellMock.stub_command('ls').with_env({'FOO' => 'bar'})`
+
+Provide a more complete invocation: `ShellMock.stub_command('ls $HOME')`
+
+Shelling out to run `"ls"` won't match this command stub, but shelling out to run `"ls $HOME"` will.
+
+NOTE: ShellMock always matches as strictly as possible, so if you stubbed both `"ls"` and `"ls $HOME"`, invocations of `"ls $HOME'` will only ever match against the `"ls $HOME"` stub and never the `"ls"` stub.
+
+=== Setting the behavior of the command invocation:
+
+Have the mock command invocation write to stdout: `ShellMock.stub_command('ls').and_output("\n")`
+
+Set the mock command invocation's exit status: `ShellMock.stub_command('ls').and_exit(2)`
+
+Set the mock command invocation's exit status to `0`: `ShellMock.stub_command('ls').and_succeed`
+
+Set the mock command invocation's exit status to `1`: `ShellMock.stub_command('ls').and_fail`
+
+If you want to both write to stdout and set the exit code (a common pair), `ShellMock.stub_command('ls').and_return("\n")` will both have the command invocation write the passed string to stdout, and will set the mock command invocation's exit status to `0`.
+
+=== Specifying the expected number of command invocations:
+
+Called exactly once: `expect(stub).to have_been_called.once`
+
+Not called: `expect(stub).to have_been_called.never`
+
+Not called (using RSpec expectation negation): `expect(stub).to_not have_been_called`
+
+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` can be used as an alias for `fewer_than`
+
+== Limitations
+
+Currently, only exact string matches of the stubbed command string are supported. Basic regex support or more complex matching for arguments and flags may be added later.
+
+ShellMock supports stubbing these ways of shelling out in Ruby:
+
+* https://ruby-doc.org/core/Kernel.html#method-i-60[`Kernel#``, window="_blank"] (aka "backticks")
+* https://ruby-doc.org/docs/ruby-doc-bundle/Manual/man-1.4/syntax.html#command[`%x` command literal, window="_blank"] (which delegates to backticks)
+* https://ruby-doc.org/core/Kernel.html#method-i-system[`Kernel#system`, window="_blank"]
+* https://ruby-doc.org/core/Kernel.html#method-i-exec[`Kernel#exec`, window="_blank"]
+* https://ruby-doc.org/core/Kernel.html#method-i-spawn[`Kernel#spawn`, window="_blank"]
+* https://ruby-doc.org/core/Process.html#method-c-spawn[`Process.spawn`, window="_blank"]
+* https://ruby-doc.org/stdlib/libdoc/open3/rdoc/Open3.html[the `Open3` module, window="_blank"] (since all its methods use `spawn`)
+
+ShellMock currently *DOES NOT* support stubbing these ways of shelling out in Ruby (but will):
+
+* https://ruby-doc.org/core/IO.html#method-c-popen[`IO.popen`, window="_blank"]
+* https://ruby-doc.org/stdlib/libdoc/pty/rdoc/PTY.html#method-c-spawn[`PTY.spawn`, window="_blank"]
+* https://devver.wordpress.com/2009/07/13/a-dozen-or-so-ways-to-start-sub-processes-in-ruby-part-2/[passing a string that starts with `"|"`, window="_blank"] to https://ruby-doc.org/core/Kernel.html#method-i-open[`Kernel#open`, window="_blank"]
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+[source,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 https://rubygems.org[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 http://contributor-covenant.org[Contributor Covenant] code of conduct.
+
+== License
+
+The gem is available as open source under the terms of the http://opensource.org/licenses/MIT[MIT License].

data/lib/shell_mock/backtick_monkey_patch.rb

@@ -16,7 +16,7 @@ module ShellMock
       stub = StubRegistry.stub_matching({}, command, {})
 
       if stub
-        stub.called_with({}, command, {})
+        stub.ran
 
         stub.side_effect.call
 

data/lib/shell_mock/command_stub.rb

@@ -1,4 +1,3 @@
-require 'shell_mock/call_verifier'
 require 'shell_mock/stub_registry'
 
 module ShellMock
@@ -7,12 +6,14 @@ module ShellMock
 
     def initialize(command)
       @command     = command
-      @env         = {}
-      @options     = {}
       @side_effect = proc {}
-      @exitstatus  = 0
 
       @reader, @writer = IO.pipe
+
+      with_env({})
+      with_options({})
+      and_output(nil)
+      and_succeed
     end
 
     def with_env(env)
@@ -45,40 +46,43 @@ module ShellMock
       self
     end
 
-    def calls
-      @calls ||= 0
-
-      marshaled_signatures.each do |marshaled_signature|
-        @calls += 1
-      end
-
-      @calls
+    def and_succeed
+      and_exit(0)
     end
 
-    def called_with(env, command, options)
-      writer.puts("called\n")
+    def and_fail
+      and_exit(1)
     end
 
-    def to_oneliner
-      "echo '#{output}' && exit #{exitstatus}"
-    end
-
-    private
-
-    attr_reader :reader, :writer
-
-    def marshaled_signatures
-      messages = ""
+    def runs
+      @runs ||= 0
 
       loop do
         begin
-          messages += reader.read_nonblock(1)
+          reader.read_nonblock(1)
+          @runs += 1
         rescue IO::WaitReadable
           break
         end
       end
 
-      messages.split("\n")
+      @runs
     end
+
+    def ran
+      writer.write("R")
+    end
+
+    def to_oneliner
+      if output
+        "echo '#{output}' && exit #{exitstatus}"
+      else
+        "exit #{exitstatus}"
+      end
+    end
+
+    private
+
+    attr_reader :reader, :writer
   end
 end

data/lib/shell_mock/exec_monkey_patch.rb

@@ -16,7 +16,7 @@ module ShellMock
       stub = StubRegistry.stub_matching(env, command, options)
 
       if stub
-        stub.called_with(env, command, options)
+        stub.ran
 
         stub.side_effect.call
 

data/lib/shell_mock/rspec/matchers.rb

@@ -1,9 +1,11 @@
-require 'shell_mock/call_verifier'
+require 'shell_mock/run_verifier'
 
 module ShellMock
   module Matchers
-    def have_been_called
-      ShellMock::CallVerifier.new
+    def have_run
+      ShellMock::RunVerifier.new
     end
+    alias have_been_called have_run
+    alias have_ran have_run
   end
 end

data/lib/shell_mock/rspec.rb

@@ -1,5 +1,3 @@
-require 'shell_mock'
-
 require 'rspec/core'
 require 'rspec/expectations'
 

data/lib/shell_mock/{call_verifier.rb → run_verifier.rb}

@@ -1,24 +1,24 @@
 module ShellMock
-  class CallVerifier
+  class RunVerifier
     def initialize
       more_than(0)
     end
 
     def times(n)
-      match_calls_when { |calls| calls == n }
+      match_runs_when { |runs| runs == n }
 
       self
     end
 
     def fewer_than(n)
-      match_calls_when { |calls| calls < n }
+      match_runs_when { |runs| runs < n }
 
       self
     end
     alias less_than fewer_than
 
     def more_than(n)
-      match_calls_when { |calls| calls > n }
+      match_runs_when { |runs| runs > n }
 
       self
     end
@@ -34,7 +34,7 @@ module ShellMock
     def matches?(command_stub)
       @command_stub = command_stub
 
-      condition.call(command_stub.calls)
+      condition.call(command_stub.runs)
     end
 
     def failure_message
@@ -49,7 +49,7 @@ module ShellMock
 
     attr_reader :command_stub, :condition
 
-    def match_calls_when(&blk)
+    def match_runs_when(&blk)
       @condition = blk
     end
   end

data/lib/shell_mock/spawn_monkey_patch.rb

@@ -16,7 +16,7 @@ module ShellMock
       stub = StubRegistry.stub_matching(env, command, options)
 
       if stub
-        stub.called_with(env, command, options)
+        stub.ran
 
         stub.side_effect.call
 

data/lib/shell_mock/system_monkey_patch.rb

@@ -16,7 +16,7 @@ module ShellMock
       stub = StubRegistry.stub_matching(env, command, options)
 
       if stub
-        stub.called_with(env, command, options)
+        stub.ran
 
         stub.side_effect.call
 

data/lib/shell_mock/version.rb

@@ -1,3 +1,3 @@
 module ShellMock
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

data/lib/shell_mock.rb

@@ -3,6 +3,7 @@ require 'shell_mock/stub_registry'
 require 'shell_mock/command_stub'
 require 'shell_mock/monkey_patches'
 require 'shell_mock/core_ext/module'
+require 'shell_mock/rspec'
 
 module ShellMock
   def self.stub_command(command)
@@ -42,7 +43,8 @@ module ShellMock
 
     StubRegistry.clear
 
-    @enabled = false
+    @enabled          = false
+    @let_commands_run = nil
 
     true
   end

data/shell_mock.gemspec

@@ -25,4 +25,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'pry-byebug'
   spec.add_development_dependency "structured_changelog", "~> 0.8"
+  spec.add_development_dependency "asciidoctor"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shell_mock
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Chris Hoffman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-24 00:00:00.000000000 Z
+date: 2018-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: asciidoctor
+  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
@@ -109,13 +123,12 @@ files:
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
-- README.md
+- README.adoc
 - Rakefile
 - bin/console
 - bin/setup
 - lib/shell_mock.rb
 - lib/shell_mock/backtick_monkey_patch.rb
-- lib/shell_mock/call_verifier.rb
 - lib/shell_mock/command_stub.rb
 - lib/shell_mock/core_ext/module.rb
 - lib/shell_mock/exec_monkey_patch.rb
@@ -124,6 +137,7 @@ files:
 - lib/shell_mock/no_stub_specified.rb
 - lib/shell_mock/rspec.rb
 - lib/shell_mock/rspec/matchers.rb
+- lib/shell_mock/run_verifier.rb
 - lib/shell_mock/spawn_monkey_patch.rb
 - lib/shell_mock/stub_registry.rb
 - lib/shell_mock/system_monkey_patch.rb

data/README.md

@@ -1,107 +0,0 @@
-# ShellMock
-[![Gem Version](https://badge.fury.io/rb/shell_mock.png)](http://badge.fury.io/rb/shell_mock)
-[![Build Status](https://secure.travis-ci.org/yarmiganosca/shell_mock.png)](http://travis-ci.org/yarmiganosca/shell_mock)
-
-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'
-
-RSpec.describe "shelling out to run 'ls'" do
-  before { ShellMock.enable }
-  after  { ShellMock.disable }
-
-  let(:stub) { ShellMock.stub_command('ls') }
-
-  it "works"
-    expect(system('ls')).to eq true
-
-    expect(stub).to have_been_called
-  end
-end
-```
-
-This:
-1. enables ShellMock's monkey patches during the test
-2. creates a command stub that will match the command `"ls"` (by default it will exit `0` and have no output)
-3. shells out to run `"ls"` (in this case using `Kernel#system`)
-4. correctly expects that our command stub for `"ls"` will have recorded an invocation
-
-### You can narrow what invocations are matched to your command stub:
-
-**Match env vars as well as the command:** `ShellMock.stub_command('ls').with_env({'FOO' => 'bar'})`
-
-**Provide a more complete invocation:** `ShellMock.stub_command('ls $HOME')`
-
-Shelling out to run `"ls"` won't match this command stub, but shelling out to run `"ls $HOME"` will. ShellMock always matches as strictly as possible, so if you stubbed `"ls"` and `"ls $HOME"`, invocations of `"ls $HOME'` would only ever match against the latter.
-
-### Setting the behavior of the command invocation:
-
-**Have the mock command invocation write to stdout:** `ShellMock.stub_command('ls').and_output("\n")`
-
-**Set the mock command invocation's exit status:** `ShellMock.stub_command('ls').and_exit(2)`
-
-If you want to both write to stdout and set the exit code (a common pair), `ShellMock.stub_command('ls').and_return("\n")` will both have the command invocation write the passed string to stdout, and will set the mock command invocation's exit status to `0`.
-
-### Specifying the expected number of command invocations:
-
-**Called exactly once:** `expect(stub).to have_been_called.once`
-
-**Not called:** `expect(stub).to have_been_called.never`
-
-**Not called (using RSpec expectation negation):** `expect(stub).to_not have_been_called`
-
-**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` can be used as an alias for `fewer_than`
-## Limitations
-
-Currently, only exact string matches of the stubbed command string are supported. Basic regex support or more complex matching for arguments and flags may be added later.
-
-ShellMock supports stubbing these ways of shelling out in Ruby:
-* [`` Kernel#` ``](https://ruby-doc.org/core/Kernel.html#method-i-60) (aka "backticks")
-* [`%x` command literal](https://ruby-doc.org/docs/ruby-doc-bundle/Manual/man-1.4/syntax.html#command) (which delegates to backticks)
-* [`Kernel#system`](https://ruby-doc.org/core/Kernel.html#method-i-system)
-* [`Kernel#exec`](https://ruby-doc.org/core/Kernel.html#method-i-exec)
-* [`Kernel#spawn`](https://ruby-doc.org/core/Kernel.html#method-i-spawn)
-* [`Process.spawn`](https://ruby-doc.org/core/Process.html#method-c-spawn)
-* [the `Open3` module](https://ruby-doc.org/stdlib/libdoc/open3/rdoc/Open3.html) (since all its methods use `spawn`)
-
-ShellMock currently DOES NOT support stubbing these ways of shelling out in Ruby (but will):
-* [`IO.popen`](https://ruby-doc.org/core/IO.html#method-c-popen)
-* [`PTY.spawn`](https://ruby-doc.org/stdlib/libdoc/pty/rdoc/PTY.html#method-c-spawn)
-* [passing a string that starts with `"|"`](https://devver.wordpress.com/2009/07/13/a-dozen-or-so-ways-to-start-sub-processes-in-ruby-part-2/) to [`Kernel#open`](https://ruby-doc.org/core/Kernel.html#method-i-open)
-
-## 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).