1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
|
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.
def test_creates_directory
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.
With FakeFS:
def test_creates_directory
Library.add "directory"
assert File.directory?("directory")
end
Woot.
Usage
-----
require 'fakefs'
# That's it.
Don't Fake the FS Immediately
-----------------------------
require 'fakefs/safe'
FakeFS.activate!
# your code
FakeFS.deactivate!
# or
FakeFS do
# your code
end
Rails
-----
If you are using fakefs in a rails project with bundler, you'll probably want to specify the following in your Gemfile:
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:
require 'fakefs/spec_helpers'
describe "my spec" do
include FakeFS::SpecHelpers
end
See `lib/fakefs/spec_helpers.rb` for more info.
How is this different than MockFS?
----------------------------------
FakeFS provides a test suite and works with symlinks. It's also strictly a
test-time dependency: your actual library does not need to use or know about
FakeFS.
Caveats
-------
FakeFS internally uses the `Pathname` and `FileUtils` constants. If you use
these in your app, be certain you're properly requiring them and not counting
on FakeFS' own require.
Speed?
------
<http://gist.github.com/156091>
Installation
------------
### [Gemcutter](http://gemcutter.org/)
$ gem install fakefs
### [Rip](http://hellorip.com)
$ rip install git://github.com/defunkt/fakefs.git
Contributing
------------
Once you've made your great commits:
1. [Fork][0] FakeFS
2. Create a topic branch - `git checkout -b my_branch`
3. Push to your branch - `git push origin my_branch`
4. Create an [Issue][1] with a link to your branch
5. That's it!
Meta
----
* Code: `git clone git://github.com/defunkt/fakefs.git`
* Home: <http://github.com/defunkt/fakefs>
* Docs: <http://defunkt.github.com/fakefs>
* Bugs: <http://github.com/defunkt/fakefs/issues>
* List: <http://groups.google.com/group/fakefs>
* Test: <http://runcoderun.com/defunkt/fakefs>
* Gems: <http://gemcutter.org/gems/fakefs>
[0]: http://help.github.com/forking/
[1]: http://github.com/defunkt/fakefs/issues
|
