shell_mock 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b82fb0b1848c54881355c530fcf8fa4f22d292a4
-  data.tar.gz: cf94368b1e001a8f7ecc80a10ff1b0ff94655cc7
+  metadata.gz: b5d26902e2b08b891fd639c5d2c9d8fcfb91fdbf
+  data.tar.gz: 134fb6f92164e23d0f32383b697b048d2c499548
 SHA512:
-  metadata.gz: e1e789a08c56339d8356d97d585bf405754582ad03a4c574f10873a05eb63951bd6ba867e725bb795a034cb096b19a6fd467d70cf9a760062462295c3dc1eb63
-  data.tar.gz: 07bc5c7aa946c4a34d932c61812d970da5cfb31cfea5bf35aca899b965011290a2e13a2fce010677354bf89cb51a2bc98241b2362ab4f70341af5aff2695140b
+  metadata.gz: 3d4062f5eb6a898e2521db636c2ac5f91d5290c76bab7f67256f3a5f77e595c5005909a85b6b8edb6541b91a26f5b882bca7e102c3f6db619d5a41e31341b309
+  data.tar.gz: 2b25642dfe523d750bc3bda8a828b102d4340012fe5c23d96d38f11e7aa9d71643abde1adc9f9bd53ff8146d7c6a9df6250e7a59b06abec1043da6f82af3301c

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 * add `with_side_effect(&blk)` for specifying desired side effects
 
+## RELEASE 0.3.1
+
+* FIX: ``Kernel.` ``, `Kernel.exec`, and `Kernel.system` are now all supported as well. This is useful to testing thor suites that shell out, because thor (for reasons passing understanding) redefines `#exec`, so we have to resort to `Kernel.exec`.
+
 ## RELEASE 0.3.0
 
 * FEATURE: you can now stub & mock `Kernel#exec`.

data/README.md

@@ -14,6 +14,8 @@ describe 'something' do
 end
 ```
 
+Currently, `` ` ``, `exec`, and `system` are supported. Nothing in the `Open3` standard library module is currently supported.
+
 ### More complex expectations are also supported.
 
 Called exactly once: `expect(stub).to have_been_called.once`

data/lib/shell_mock/command_stub.rb

@@ -2,10 +2,13 @@ require 'shell_mock/call_verifier'
 
 module ShellMock
   class CommandStub
-    attr_reader :command, :expected_output, :exitstatus
+    attr_reader :command, :expected_output, :exitstatus, :env, :options, :side_effect
 
     def initialize(command)
-      @command = command
+      @command     = command
+      @env         = {}
+      @options     = {}
+      @side_effect = proc {}
     end
 
     def with_env(env)
@@ -14,20 +17,12 @@ module ShellMock
       self
     end
 
-    def env
-      @env || {}
-    end
-
     def with_option(option)
       @options = options
 
       self
     end
 
-    def options
-      @options || {}
-    end
-
     def and_return(expected_output)
       @expected_output = expected_output
       @exitstatus ||= 0
@@ -41,10 +36,6 @@ module ShellMock
       self
     end
 
-    def side_effect
-      @side_effect || proc {}
-    end
-
     def calls
       @calls ||= []
     end

data/lib/shell_mock/core_ext/module.rb

@@ -0,0 +1,5 @@
+Module.class_exec do
+  def eigenclass
+    @eigenclass ||= class << self; self; end
+  end
+end

data/lib/shell_mock/{core_ext/kernel.rb → monkey_patch.rb}

@@ -1,7 +1,47 @@
 require 'shell_mock/no_stub_specified'
 
-module Kernel
-  def __shell_mocked_system(env, command = nil, **options)
+module ShellMock
+  class MonkeyPatch
+    attr_reader :original, :alias_for_original
+
+    def initialize(original_name, interpolable_name = original_name, &block)
+      @original           = original_name
+      @alias_for_original = "__un_shell_mocked_#{interpolable_name}"
+      @replacement        = "__shell_mocked_#{interpolable_name}"
+      @block              = block
+    end
+
+    def to_proc
+      @block.to_proc
+    end
+
+    def enable_for(class_or_module)
+      class_or_module.send(:alias_method, alias_for_original, original)
+
+      begin
+        class_or_module.send(:remove_method, original) # for warnings
+      rescue NameError
+      end
+
+      class_or_module.send(:define_method, original, &to_proc)
+    end
+
+    def disable_for(class_or_module)
+      begin
+        class_or_module.send(:remove_method, original) # for warnings
+      rescue NameError
+      end
+
+      class_or_module.send(:alias_method, original, alias_for_original)
+
+      begin
+        class_or_module.send(:remove_method, alias_for_original)
+      rescue NameError
+      end
+    end
+  end
+
+  SystemMonkeyPatch = MonkeyPatch.new(:system) do |env, command = nil, **options|
     env, command = {}, env if command.nil?
 
     # other arg manipulation
@@ -10,8 +50,8 @@ module Kernel
 
     if stub
       stub.side_effect.call
-      `exit #{stub.exitstatus}`
       stub.called_with(env, command, options)
+      __un_shell_mocked_backtick("exit #{stub.exitstatus}")
 
       return stub.exitstatus == 0
     else
@@ -27,7 +67,7 @@ module Kernel
   # have very similar if not identical method signatures. I'm not sure
   # whether extracting the commonalities would be worth it or just
   # confuse.
-  def __shell_mocked_exec(env, command = nil, **options)
+  ExecMonkeyPatch = MonkeyPatch.new(:exec) do |env, command = nil, **options|
     env, command = {}, env if command.nil?
 
     # other arg manipulation
@@ -36,10 +76,9 @@ module Kernel
 
     if stub
       stub.side_effect.call
-      `exit #{stub.exitstatus}`
       stub.called_with(env, command, options)
 
-      return stub.exitstatus == 0
+      exit stub.exitstatus
     else
       if ShellMock.let_commands_run?
         __un_shell_mocked_exec(env, command, **options)
@@ -49,12 +88,12 @@ module Kernel
     end
   end
 
-  def __shell_mocked_backtick(command)
+  BacktickMonkeyPatch = MonkeyPatch.new(:`, :backtick) do |command|
     stub = ShellMock::StubRegistry.stub_matching({}, command, {})
 
     if stub
       stub.side_effect.call
-      `exit #{stub.exitstatus}`
+      __un_shell_mocked_backtick("exit #{stub.exitstatus}")
       stub.called_with({}, command, {})
 
       return stub.expected_output

data/lib/shell_mock/rspec.rb

@@ -5,9 +5,6 @@ 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/version.rb

@@ -1,3 +1,3 @@
 module ShellMock
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/lib/shell_mock.rb

@@ -1,7 +1,8 @@
 require "shell_mock/version"
 require 'shell_mock/stub_registry'
 require 'shell_mock/command_stub'
-require 'shell_mock/core_ext/kernel'
+require 'shell_mock/monkey_patch'
+require 'shell_mock/core_ext/module'
 
 module ShellMock
   def self.stub_command(command)
@@ -28,35 +29,22 @@ module ShellMock
   end
 
   def self.enable
-    Kernel.module_exec do
-      ShellMock.alias_specifications.each do |spec|
-        if respond_to?(spec.replacement)
-          define_method(spec.alias_for_original, &method(spec.original).to_proc)
-          define_method(spec.original,           &method(spec.replacement).to_proc)
-        end
-      end
+    ShellMock.monkey_patches.each do |patch|
+      patch.enable_for(Kernel.eigenclass) unless Kernel.respond_to?(patch.alias_for_original, true)
+      patch.enable_for(Kernel)            unless Object.new.respond_to?(patch.alias_for_original, true)
     end
   end
 
   def self.disable
-    Kernel.module_exec do
-      ShellMock.alias_specifications.each do |spec|
-        if respond_to?(spec.alias_for_original)
-          define_method(spec.original, &method(spec.alias_for_original).to_proc)
-        end
-      end
+    ShellMock.monkey_patches.each do |patch|
+      patch.disable_for(Kernel.eigenclass) if Kernel.respond_to?(patch.alias_for_original, true)
+      patch.disable_for(Kernel)            if Object.new.respond_to?(patch.alias_for_original, true)
     end
 
     StubRegistry.clear
   end
 
-  AliasSpecification = Struct.new(:original, :alias_for_original, :replacement)
-
-  def self.alias_specifications
-    [
-      AliasSpecification.new(:system, :__un_shell_mocked_system,   :__shell_mocked_system),
-      AliasSpecification.new(:exec,   :__un_shell_mocked_exec,     :__shell_mocked_exec),
-      AliasSpecification.new(:`,      :__un_shell_mocked_backtick, :__shell_mocked_backtick),
-    ]
+  def self.monkey_patches
+    [SystemMonkeyPatch, ExecMonkeyPatch, BacktickMonkeyPatch]
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shell_mock
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Chris Hoffman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-06 00:00:00.000000000 Z
+date: 2017-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -116,7 +116,8 @@ files:
 - 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/core_ext/module.rb
+- lib/shell_mock/monkey_patch.rb
 - lib/shell_mock/no_stub_specified.rb
 - lib/shell_mock/rspec.rb
 - lib/shell_mock/rspec/matchers.rb