Add nose tests and updated README.md with test instructions and minor spell check fixes.

README.md

@@ -22,7 +22,7 @@ cheat tar
 You will be presented with a cheatsheet resembling:
 
 ```text
-# To extract an uncompressed archive: 
+# To extract an uncompressed archive:
 tar -xvf /path/to/foo.tar
 
 # To extract a .gz archive:
@@ -38,7 +38,7 @@ tar -xjvf /path/to/foo.tgz
 tar -cjvf /path/to/foo.tgz /path/to/foo/
 ```
 
-To see what cheatsheets are availble, run `cheat` with no arguments.
+To see what cheatsheets are available, run `cheat` with no arguments.
 
 Note that, while `cheat` was designed primarily for *nix system administrators,
 it is agnostic as to what content it stores. If you would like to use `cheat`
@@ -158,15 +158,24 @@ though this will likely require `sudo`.
 
 Contributing
 ============
-If you would like to contribute cheetsheets or program functionality, please
+If you would like to contribute cheatsheets or program functionality, please
 fork this repository, make your changes, and send me a pull request.
 
 
+Testing
+=======
+
+Install the required testing tools (pip install -r tests/requirements.txt) and run the nose tests command::
+
+```nosetests
+```
+
+
 Related Projects
 ================
 
 - [lucaswerkmeister/cheats][1]: An implementation of this concept in pure bash
-  that also allows not only for numerical indexing of subcomands but also
+  that also allows not only for numerical indexing of subcommands but also
   supports running commands interactively.
 
 - [jahendrie/cheat][2]: A bash-only implementation that additionally allows for
@@ -179,7 +188,7 @@ Related Projects
 
 [dotfiles]:  http://dotfiles.github.io/
 [jahendrie]: https://github.com/jahendrie
-[1]:         https://github.com/lucaswerkmeister/cheats   
+[1]:         https://github.com/lucaswerkmeister/cheats
 [2]:         https://github.com/jahendrie/cheat
 [3]:         http://errtheblog.com/posts/21-cheat
 [4]:         https://github.com/chrisallenlane/cheat/pull/77

tests/.cheats/-test-foobar

@@ -0,0 +1 @@
+binbat

tests/.cheats/-test-vim_crypted

@@ -0,0 +1 @@
+VimCrypt~01!;Tjc¹

tests/requirements.txt

@@ -0,0 +1,3 @@
+# Tester/Developer requirements.
+nose==1.3.0
+mock==1.0.1

tests/tests.py

@@ -0,0 +1,68 @@
+import os
+import sys
+
+from nose.tools import assert_equals, assert_true, assert_false, assert_raises
+from StringIO import StringIO
+from mock import patch
+
+
+class TestCheatSheets(object):
+
+    def setUp(self):
+        self.cheatpath = os.path.join(
+            os.path.dirname(__file__), '.cheats')
+        os.environ['CHEATPATH'] = self.cheatpath
+        os.environ['DEFAULT_CHEAT_DIR'] = ''
+        import imp
+        self.cheat = imp.load_source('cheat', './cheat')
+        self.cheatsheets = self.cheat.CheatSheets()
+        # Change stdout for testing.
+        # It would be preferable to make CheatSheets more testable.
+        self.out = StringIO()
+        sys.stdout = self.out
+        assert_true(self.cheatpath in self.cheatsheets.dirs)
+
+    def test_display_foobar_cheat_sheet(self):
+        # There should be a testing cheatsheet called '-test-foobar'.
+        cheatfile = '-test-foobar'
+        expected = 'binbat'
+        cheatfile_path = os.path.join(self.cheatpath, cheatfile)
+        assert_true(os.path.exists(cheatfile_path))
+        # The content of '-test-foobar' should start with 'binbat'.
+        # CheatSheets.display_sheet() may add extra "pretty" formatting, so
+        # for this test, we only care that only the first set of characters
+        # match.
+        assert_equals(None, self.cheatsheets.display_sheet(cheatfile))
+        assert_equals(expected, self.out.getvalue()[0:len(expected)])
+        assert_true(cheatfile in self.cheatsheets.sheets)
+
+    def test_display_missing_cheat_sheet_file(self):
+        cheatfile = '-test-missing_file'
+        cheatfile_path = os.path.join(self.cheatpath, cheatfile)
+        # Verify that test file is indeed missing.
+        assert_false(os.path.exists(cheatfile_path))
+        # Verify that missing cheatfile is not in our cheatsheet.sheets.
+        assert_false(cheatfile in self.cheatsheets.sheets)
+        with assert_raises(KeyError):
+            self.cheatsheets.display_sheet(cheatfile)
+
+    @patch('cheat.CheatSheets.vim_view', return_value=None)
+    def test_vim_view_call(self, vim_view):
+        cheatfile = '-test-vim_crypted'
+        cheatfile_path = os.path.join(self.cheatpath, cheatfile)
+        assert_true(os.path.exists(cheatfile_path))
+        assert_true(self.cheatsheets.is_vim_crypted(cheatfile_path))
+        assert_false(vim_view.called)
+        self.cheatsheets.display_sheet(cheatfile)
+        vim_view.assert_called_with(cheatfile_path)
+
+    def test_is_vim_crypted(self):
+        # This test file is clear text.
+        clear_cheatfile = '-test-foobar'
+        clear_cheatfile_path = os.path.join(self.cheatpath, clear_cheatfile)
+        assert_false(self.cheatsheets.is_vim_crypted(clear_cheatfile_path))
+        # This file is "Vim Encrypted" with the pass phrase "passphrase".
+        vimcrypted_cheatfile = '-test-vim_crypted'
+        vimcrypted_cheatfile_path = os.path.join(
+            self.cheatpath, vimcrypted_cheatfile)
+        assert_true(self.cheatsheets.is_vim_crypted(vimcrypted_cheatfile_path))