fakefs 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0f8537aa4162b3719ec77e1473ff51f15534088c
-  data.tar.gz: e07735c800c2d357a4bccea0192f8f1f5d811de8
+  metadata.gz: ed6afbd6cc78d88527ac85b6bb0017a737a29b32
+  data.tar.gz: 79904ccdd7d7974cbda597ff28d986fda601ef83
 SHA512:
-  metadata.gz: adbcc925b19c3ab19b319dab7e8d08d54d17c39524452b8824202e21000c66d75d9f9abe5b9f0a18fa2add08ea3ef547e0b6add273ae60154047f83117147503
-  data.tar.gz: e81a430d7ecdd264a8e9b72f522786849622b5a4aedcacfa06a2f020fd91062ab3b2b6a63fdb19c67038a633374d6cc79b6656b88edf6650e369af607416a529
+  metadata.gz: 72ba95d6739f30d35cb24735b20f94d919875bfe1576e43e51a868b7458e15e1978f52578f0ff4cb6b14c8da4b5a3d790577f8c6b70e0bb76998021156bb82ce
+  data.tar.gz: 7fd93d529856d687558b60dc12b0a03056691b88673ca373f688615c0eee27b6a9fc71e0b7231d71c8dceb57542f852803cc055e54f0cc9243aa2557202d8812

data/README.markdown

@@ -1,49 +1,64 @@
 FakeFS [![build status](https://secure.travis-ci.org/defunkt/fakefs.svg?branch=master)](https://secure.travis-ci.org/defunkt/fakefs)
 ======
 
-Mocha is great. But when your library is all about manipulating the
-filesystem, you really want to test the behavior and not the implementation.
-
-If you're mocking and stubbing every call to FileUtils or File, you're
-tightly coupling your tests with the implementation.
+Mocking calls to FileUtils or File means tightly coupling tests with the implementation.
 
 ``` ruby
-def test_creates_directory
+it "creates a directory" do
   FileUtils.expects(:mkdir).with("directory").once
   Library.add "directory"
 end
 ```
 
-The above test will break if we decide to use `mkdir_p` in our code. Refactoring
-code shouldn't necessitate refactoring tests.
+The above test will break if `mkdir_p` is used instead. 
+Refactoring code should not necessitate refactoring tests.
+
+A better approach is to use a temp directory if you are working with relative directories.
+
+```Ruby
+require 'tmpdir'
+
+it "creates a directory" do
+  Dir.mktmpdir do |dir|
+    Dir.chdir dir do
+      Library.add "directory"
+      assert File.directory?("directory")
+    end
+  end
+end
+```
 
-With FakeFS:
+But if you are working with absolute directories or do not want to use temporary directories, use FakeFS instead:
 
 ``` ruby
-def test_creates_directory
-  Library.add "directory"
-  assert File.directory?("directory")
+it "creates a directory" do
+  FakeFS do
+    Library.add "directory"
+    assert File.directory?("directory")
+  end
 end
 ```
 
-Woot.
+Installation
+------------
 
+```Bash
+gem install fakefs
+```
 
 Usage
 -----
 
+To fake out the FS:
+
 ``` ruby
 require 'fakefs'
-
-# That's it.
 ```
 
-Don't Fake the FS Immediately
------------------------------
+Temporarily faking the FS
+-------------------------
 
 ``` ruby
-gem "fakefs", :require => "fakefs/safe"
-
 require 'fakefs/safe'
 
 FakeFS.activate!
@@ -59,19 +74,16 @@ end
 Rails
 -----
 
-If you are using fakefs in a rails project with bundler, you'll probably want
-to specify the following in your Gemfile:
+In rails projects, add this to your Gemfile:
 
 ``` ruby
-gem "fakefs", :require => "fakefs/safe"
+gem "fakefs", require: "fakefs/safe"
 ```
 
-
 RSpec
 -----
 
-The above approach works with RSpec as well. In addition you may include
-FakeFS::SpecHelpers to turn FakeFS on and off in a given example group:
+Include FakeFS::SpecHelpers to turn FakeFS on and off in an example group:
 
 ``` ruby
 require 'fakefs/spec_helpers'
@@ -93,16 +105,14 @@ yourself on the equivalent FakeFS classes. For example,
 A fake version can be provided as follows:
 
 ``` ruby
-module FakeFS
-  class File
-    def content_type
-      'fake/file'
-    end
+FakeFS::File.class_eval do
+  def content_type
+    'fake/file'
   end
 end
 ```
 
-How is this different than MockFS?
+How is this different than [MockFS](http://mockfs.rubyforge.org/) ?
 ----------------------------------
 
 FakeFS provides a test suite and works with symlinks. It's also strictly a
@@ -133,14 +143,6 @@ Speed?
 <http://gist.github.com/156091>
 
 
-Installation
-------------
-
-### [RubyGems](https://rubygems.org/)
-
-    $ gem install fakefs
-
-
 Contributing
 ------------
 

data/lib/fakefs/file.rb

@@ -35,6 +35,10 @@ module FakeFS
       RealFile.join(parts)
     end
 
+    def self.path(file)
+      RealFile.path(file)
+    end
+
     def self.exist?(path)
       if File.symlink?(path)
         referent = File.expand_path(File.readlink(path), File.dirname(path))

data/lib/fakefs/version.rb

@@ -1,7 +1,7 @@
 module FakeFS
   # Version module
   module Version
-    VERSION = '0.8.0'
+    VERSION = '0.8.1'
 
     def self.to_s
       VERSION

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fakefs
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Chris Wanstrath
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-03 00:00:00.000000000 Z
+date: 2016-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler