fakecmd 0.0.1 → 0.0.2

data/README.md

@@ -1,7 +1,112 @@
 fakecmd
 =======
 
-Fakes system commands. Intended for use in tests. Inspired by
-[FakeFS](http://github.com/defunkt/fakefs).
+* [Homepage](http://github.com/blom/fakecmd)
+* [Documentation](http://rdoc.info/github/blom/fakecmd)
 
-Undocumented and undone.
+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.
+
+Originally inspired by [FakeFS](http://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
+----------------
+
+    module Users
+      def self.count
+        c = %x(users).split.size
+        c if $?.exitstatus == 0
+      end
+    end
+
+    class UsersTest < Test::Unit::TestCase
+      def setup
+        FakeCmd.clear!
+      end
+
+      def test_count_success
+        FakeCmd.add :users, 0, "a b c"
+        assert_equal 3, FakeCmd { Users.count }
+        assert_equal 0, $?.exitstatus
+      end
+
+      def test_count_failure
+        FakeCmd.add :users, 1
+        assert_nil FakeCmd { Users.count }
+        assert_equal 1, $?.exitstatus
+      end
+    end

data/lib/fakecmd.rb

@@ -5,16 +5,21 @@ module FakeCmd
   module_function
   @@enabled = false
 
-  def on!
-    unless @@enabled
-      Kernel.class_eval do
-        alias_method :fakecmd_backquote, :`
-        def `(cmd)
-          FakeCmd.process_command(cmd)
-        end
-      end
-      @@enabled = true
-    end
+  def add(cmd, status = 0, output = "", &block)
+    cmd = cmd.to_s if cmd.is_a?(Symbol)
+    commands << {
+      :regexp => Regexp.new(cmd),
+      :output => block ? block.call : output,
+      :status => status
+    }
+  end
+
+  def clear!
+    commands.clear
+  end
+
+  def commands
+    @_commands ||= Set.new
   end
 
   def off!
@@ -27,12 +32,16 @@ module FakeCmd
     end
   end
 
-  def clear!
-    commands.clear
-  end
-
-  def commands
-    @_commands ||= Set.new
+  def on!
+    unless @@enabled
+      Kernel.class_eval do
+        alias_method :fakecmd_backquote, :`
+        def `(cmd)
+          FakeCmd.process_command(cmd)
+        end
+      end
+      @@enabled = true
+    end
   end
 
   def process_command(cmd)
@@ -44,15 +53,6 @@ module FakeCmd
     end
     system ""
   end
-
-  def add(cmd, status = 0, output = "", &block)
-    cmd = cmd.to_s if cmd.is_a?(Symbol)
-    commands << {
-      :regexp => Regexp.new(cmd),
-      :output => block ? block.call : output,
-      :status => status
-    }
-  end
 end
 
 def FakeCmd

data/lib/fakecmd/version.rb

@@ -1,8 +1,8 @@
 module FakeCmd
   module VERSION
-    const_defined?(:MAJOR) || MAJOR = 0
-    const_defined?(:MINOR) || MINOR = 0
-    const_defined?(:PATCH) || PATCH = 1
+    MAJOR = 0
+    MINOR = 0
+    PATCH = 2
 
     def self.to_s
       [MAJOR, MINOR, PATCH] * "."

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: fakecmd
 version: !ruby/object:Gem::Version 
-  hash: 29
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - "\xC3\x98rjan Blom"
@@ -15,79 +14,74 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-27 00:00:00 +02:00
+date: 2010-11-06 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  name: bluecloth
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
-  requirement: *id001
   type: :development
-  name: bluecloth
   prerelease: false
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  name: mg
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
-  requirement: *id002
   type: :development
-  name: mg
   prerelease: false
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  name: rcov
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
-  requirement: *id003
   type: :development
-  name: rcov
   prerelease: false
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  name: rspec
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
-        - 0
-        version: "0"
-  requirement: *id004
+        - 2
+        version: "2"
   type: :development
-  name: rspec
   prerelease: false
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  name: yard
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
-  requirement: *id005
   type: :development
-  name: yard
   prerelease: false
+  version_requirements: *id005
 description: Fakes system commands. Intended for use in tests.
 email: blom@blom.tv
 executables: []
@@ -115,7 +109,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: 2149922095191616200
       segments: 
       - 0
       version: "0"
@@ -124,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: 2149922095191616200
       segments: 
       - 0
       version: "0"