shell_mock 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c6fffa51532c59b133e8176343ab0fb1d6ca8b5
-  data.tar.gz: 71450c650b0e65096422bb2a7f467516bf810846
+  metadata.gz: 147a2390f3f6299b3da3a3e548347c97b6915d6d
+  data.tar.gz: 85433c788c0479b762fe5542030d729ddf0922e8
 SHA512:
-  metadata.gz: 92aae540345018da0abd3b68d0704f56f0e8e9aa1bdf8ecabae9cc051fb1606a7874c6dc007ac0c368ef971974997550593feb42e03e5bd25bdbd51711187a31
-  data.tar.gz: 2d2d7ac3b2c6a3542ab48e16d16e3b9a36d7e6ddcfc35c369c26e61b984bf1e652ec29f98cebb3ff4df4594653e8aff1fa97bff4c61a549346a05ec6d51450db
+  metadata.gz: 86cfdd6bb159d3731cba1759484c677269e5fd1beb3d48813451712847f90b328cb875eb104d4778811b283a164b96b84f30542fb6abadf049b9252ddb4b7c13
+  data.tar.gz: 3a6807143e3a613d86444b9cecca1c7636ba2246f80e6b64d736a1be514983f2ecbb2b9dc12180f781deb9d7c1a4d5fbf4c253e2a1290124eaee2d100bdfda7a

data/CHANGELOG.md

@@ -4,15 +4,25 @@
 * `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.7.0
+
+* FEATURE: `#to_output` is an alias of `#and_output`
+* FEATURE: `#to_return` is an alias of `#and_return`
+* FEATURE: `#to_exit` is an alias of `#and_exit`
+* FEATURE: `#to_succeed` is an alias of `#and_succeed`
+* FEATURE: `#to_fail` is an alias of `#and_fail`
+* DEPRECATION: `#and_output` is deprecated and will be removed in 1.0.0. Use `#to_output` instead.
+* DEPRECATION: `#and_return` is deprecated and will be removed in 1.0.0. Use `#to_return` instead.
+* DEPRECATION: `#and_exit` is deprecated and will be removed in 1.0.0. Use `#to_exit` instead.
+* DEPRECATION: `#and_succeed` is deprecated and will be removed in 1.0.0. Use `#to_succeed` instead.
+* DEPRECATION: `#and_fail` is deprecated and will be removed in 1.0.0. Use `#to_fail` instead.
+
 ## RELEASE 0.6.0
 
 * FEATURE: use `#and_succeed` to set an invocation's exit status to 0

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in shell_mock.gemspec
 gemspec
+
+gem 'coveralls', require: false

data/README.adoc

@@ -15,8 +15,9 @@ ifdef::env-github[]
 :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]]
+image:https://badge.fury.io/rb/shell_mock.svg["Gem Version", link="https://badge.fury.io/rb/shell_mock"]
+image:https://travis-ci.org/yarmiganosca/shell_mock.svg?branch=master["Build Status", link="https://travis-ci.org/yarmiganosca/shell_mock"]
+image:https://coveralls.io/repos/github/yarmiganosca/shell_mock/badge.svg?branch=master["Test Coverage", link="https://coveralls.io/github/yarmiganosca/shell_mock?branch=master"]
 
 toc::[]
 
@@ -37,7 +38,7 @@ RSpec.describe "shelling out to run 'ls'" do
   it "works"
     system('ls') # <3>
 
-    expect(stub).to have_been_called # <4>
+    expect(stub).to have_run # <4>
   end
 end
 ----
@@ -60,29 +61,29 @@ NOTE: ShellMock always matches as strictly as possible, so if you stubbed both `
 
 === Setting the behavior of the command invocation:
 
-Have the mock command invocation write to stdout: `ShellMock.stub_command('ls').and_output("\n")`
+Have the mock command invocation write to stdout: `ShellMock.stub_command('ls').to_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: `ShellMock.stub_command('ls').to_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 `0`: `ShellMock.stub_command('ls').to_succeed`
 
-Set the mock command invocation's exit status to `1`: `ShellMock.stub_command('ls').and_fail`
+Set the mock command invocation's exit status to `1`: `ShellMock.stub_command('ls').to_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`.
+If you want to both write to stdout and set the exit code (a common pair), `ShellMock.stub_command('ls').to_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`
+Called exactly once: `expect(stub).to have_run.once`
 
-Not called: `expect(stub).to have_been_called.never`
+Not called: `expect(stub).to have_run.never`
 
-Not called (using RSpec expectation negation): `expect(stub).to_not have_been_called`
+Not called (using RSpec expectation negation): `expect(stub).to_not have_run`
 
-Called exactly `n` times: `expect(stub).to have_been_called.times(n)`
+Called exactly `n` times: `expect(stub).to have_run.times(n)`
 
-Called more than `n` times: `expect(stub).to have_been_called.more_than(n)`
+Called more than `n` times: `expect(stub).to have_run.more_than(n)`
 
-Called fewer than `n` times: `expect(stub).to have_been_called.fewer_than(n)`
+Called fewer than `n` times: `expect(stub).to have_run.fewer_than(n)`
 
 `less_than` can be used as an alias for `fewer_than`
 

data/lib/shell_mock/command_stub.rb

@@ -1,4 +1,5 @@
 require 'shell_mock/stub_registry'
+require 'shell_mock/core_ext/module'
 
 module ShellMock
   class CommandStub
@@ -12,8 +13,8 @@ module ShellMock
 
       with_env({})
       with_options({})
-      and_output(nil)
-      and_succeed
+      to_output(nil)
+      to_succeed
     end
 
     def with_env(env)
@@ -28,31 +29,41 @@ module ShellMock
       self
     end
 
-    def and_output(output)
+    def to_output(output)
       @output = output
 
       self
     end
+    alias and_output to_output
+    deprecate :and_output, :to_output, "1.0.0"
 
-    def and_return(output)
+    def to_return(output)
       self.
-        and_output(output).
-        and_exit(0)
+        to_output(output).
+        to_exit(0)
     end
+    alias and_return to_return
+    deprecate :and_return, :to_return, "1.0.0"
 
-    def and_exit(exitstatus)
+    def to_exit(exitstatus)
       @exitstatus = exitstatus
 
       self
     end
+    alias and_exit to_exit
+    deprecate :and_exit, :to_exit, "1.0.0"
 
-    def and_succeed
-      and_exit(0)
+    def to_succeed
+      to_exit(0)
     end
+    alias and_succeed to_succeed
+    deprecate :and_succeed, :to_succeed, "1.0.0"
 
-    def and_fail
-      and_exit(1)
+    def to_fail
+      to_exit(1)
     end
+    alias and_fail to_fail
+    deprecate :and_fail, :to_fail, "1.0.0"
 
     def runs
       @runs ||= 0

data/lib/shell_mock/core_ext/module.rb

@@ -2,4 +2,14 @@ Module.class_exec do
   def eigenclass
     @eigenclass ||= class << self; self; end
   end
+
+  def deprecate(name, replacement, version)
+    old_name = :"#{name}_without_deprecation"
+    alias_method old_name, name
+
+    define_method(name) do |*args, &blk|
+      warn "ShellMock: ##{name} is deprecated and will be removed by #{version}. Please use #{replacement} instead."
+      send old_name, *args, &blk
+    end
+  end
 end

data/lib/shell_mock/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shell_mock
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Chris Hoffman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-10 00:00:00.000000000 Z
+date: 2018-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -115,7 +115,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".env"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"

data/.env

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