fakecmd 0.0.2 → 0.0.3

data/README.md

@@ -1,90 +1,20 @@
 fakecmd
 =======
 
-* [Homepage](http://github.com/blom/fakecmd)
-* [Documentation](http://rdoc.info/github/blom/fakecmd)
+[![Build Status](https://travis-ci.org/blom/fakecmd.png)](https://travis-ci.org/blom/fakecmd)
+[![Gem Version](https://badge.fury.io/rb/fakecmd.png)](http://badge.fury.io/rb/fakecmd)
 
-Fakes system commands. Intended for use in tests. If your code relies heavily
-on system commands and verifies their exit status, you may not want to rely on
-the OS to be able to run your tests. That's the basic idea.
+* [Homepage](https://github.com/blom/fakecmd)
+* [Documentation](http://rubydoc.info/gems/fakecmd)
 
-Originally inspired by [FakeFS](http://github.com/defunkt/fakefs).
+Fakes system commands. Intended for use in tests. If your code relies on system
+commands and perhaps verifies their exit status, you may not want to rely on
+the OS to be able to run your tests. Especially so if these commands have side
+effects or take a long time to run. Originally inspired by
+[FakeFS](https://github.com/defunkt/fakefs).
 
-Installation
-------------
-
-    gem install fakecmd
-
-Usage
------
-
-### Require
-
-    require "fakecmd"
-
-### Add some commands
-
-    FakeCmd.add "bar", 0, "pork"
-    FakeCmd.add :foo,  1, "chop"
-    FakeCmd.add /hat/, 2, "good"
-
-*Command*, *exit status*, and *output*.
-
-#### Everything is a regular expression internally
-
-    "hi"
-    :hi
-    /hi/
-
-All equal.
-
-### Enable
-
-Faking only happens between `on!` and `off!`, or in a block.
-
-#### `on!` and `off!`
-
-    FakeCmd.on!
-    # ...
-    FakeCmd.off!
-
-#### Block
-
-    FakeCmd do
-      # ...
-    end
-
-### Run
-
-#### Using the examples above
-
-    `bar mitzva`   # => "pork"
-    $?.exitstatus  # => 0
-
-    %x(fool)       # => "chop"
-    $?.exitstatus  # => 1
-
-    %x(nice hat)   # => "good"
-    $?.exitstatus  # => 2
-
-#### No match
-
-    `nope`        # => false
-    $?.exitstatus # => 127
-
-### Which calls are faked
-
-    ``
-    %x
-
-For now.
-
-### Clear the collection
-
-    FakeCmd.clear!
-
-A simple example
-----------------
+Example
+-------
 
     module Users
       def self.count
@@ -110,3 +40,28 @@ A simple example
         assert_equal 1, $?.exitstatus
       end
     end
+
+* `FakeCmd.clear!` clears the current collection of faked commands, if any.
+
+* `FakeCmd.add :users, 0, "a b c"` fakes the `users` command, defines its exit
+  status to be 0, and its output to be `a b c`. `:users` could have been a
+  string or regular expression as well; internally, everything is a regular
+  expression.
+
+* `FakeCmd { Users.count }` calls `Users.count` in the faked environment. You
+  can also use `FakeCmd.on!` and `FakeCmd.off!` to turn it on and off,
+  respectively. No system command using the backtick or `%x` notation will be
+  executed in the block or between `.on!` and `.off!`. `system ""` will be
+  executed if the command is not found in the collection.
+
+* `$?.exitstatus` reflects the exit status given to `.add`.
+
+Keep in mind that only the following calls will be faked:
+
+    ``
+    %x
+
+Installation
+------------
+
+    gem install fakecmd

data/lib/fakecmd.rb

@@ -3,7 +3,6 @@ require File.expand_path("../fakecmd/version", __FILE__)
 
 module FakeCmd
   module_function
-  @@enabled = false
 
   def add(cmd, status = 0, output = "", &block)
     cmd = cmd.to_s if cmd.is_a?(Symbol)
@@ -22,25 +21,29 @@ module FakeCmd
     @_commands ||= Set.new
   end
 
+  def on?
+    Kernel.private_methods.map(&:to_sym).include?(:fakecmd_backquote)
+  end
+
   def off!
-    if @@enabled
+    if on?
       Kernel.class_eval do
         alias_method :`, :fakecmd_backquote
         remove_method :fakecmd_backquote
       end
-      !@@enabled = false
+      true
     end
   end
 
   def on!
-    unless @@enabled
+    unless on?
       Kernel.class_eval do
         alias_method :fakecmd_backquote, :`
         def `(cmd)
           FakeCmd.process_command(cmd)
         end
       end
-      @@enabled = true
+      true
     end
   end
 

data/lib/fakecmd/version.rb

@@ -2,7 +2,7 @@ module FakeCmd
   module VERSION
     MAJOR = 0
     MINOR = 0
-    PATCH = 2
+    PATCH = 3
 
     def self.to_s
       [MAJOR, MINOR, PATCH] * "."

metadata

@@ -1,133 +1,129 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: fakecmd
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 2
-  version: 0.0.2
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
 platform: ruby
-authors: 
-- "\xC3\x98rjan Blom"
+authors:
+- Ørjan Blom
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-11-06 00:00:00 +01:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: bluecloth
-  requirement: &id001 !ruby/object:Gem::Requirement 
+date: 2013-04-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: mg
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rcov
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2'
   type: :development
   prerelease: false
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: rspec
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        version: "2"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: yard
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id005
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Fakes system commands. Intended for use in tests.
 email: blom@blom.tv
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - LICENSE
 - README.md
 - lib/fakecmd/version.rb
 - lib/fakecmd.rb
-has_rdoc: true
-homepage: http://github.com/blom/fakecmd
+homepage: https://github.com/blom/fakecmd
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 2149922095191616200
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 2149922095191616200
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Fakes system commands.
 test_files: []
-
+has_rdoc: