Merge pull request #165 from chrisallenlane/no-autocomplete

Resolves #160

CONTRIBUTING.md

@@ -0,0 +1,9 @@
+Contributing
+============
+If you would like to contribute cheetsheets or program functionality, please
+fork this repository, make your changes, and send me a pull request.
+
+Python code show follow the standards laid out by [PEP 8][].
+
+
+[PEP 8]: http://legacy.python.org/dev/peps/pep-0008/ 

README.md

@@ -104,6 +104,13 @@ enable this feature, set a `CHEATCOLORS` environment variable:
 
     export CHEATCOLORS=true
 
+### Enabling Command-line Autocompletion ###
+The `cheat/autocompletion` directory contains scripts to enable command-line
+autocompletion for various shells. To activate autocompletion, simply copy the
+appropriate script to the appropriate path on your system. (The "appropriate
+path" will vary on a per-platform basis, so this documentation shall not
+speculate as to where that may be.)
+
 
 Related Projects
 ----------------

bin/cheat

@@ -38,7 +38,7 @@ from docopt import docopt
 
 if __name__ == '__main__':
     # parse the command-line options
-    options = docopt(__doc__, version='cheat 2.0.3')
+    options = docopt(__doc__, version='cheat 2.0.6')
 
     # list directories
     if options['--directories']:

cheat/sheets.py

@@ -2,6 +2,12 @@ from cheat import cheatsheets
 from cheat.utils import *
 import os
 
+# @kludge: it breaks the functional paradigm to a degree, but declaring this
+# var here (versus within get()) gives us a "poor man's" memoization on the
+# call to get(). This, in turn, spares us from having to call out to the
+# filesystem more than once.
+cheats = {}
+
 
 def default_path():
     """ Returns the default cheatsheet path """
@@ -35,10 +41,15 @@ def default_path():
     return default_sheets_dir
 
 
-# @todo: memoize result
 def get():
     """ Assembles a dictionary of cheatsheets as name => file-path """
-    cheats = {}
+
+    # if we've already reached out to the filesystem, just return the result
+    # from memory
+    if cheats:
+        return cheats
+
+    # otherwise, scan the filesystem
     for cheat_dir in reversed(paths()):
         cheats.update(
             dict([

cheat/utils.py

@@ -23,7 +23,7 @@ def colorize(sheet_content):
 
 def die(message):
     """ Prints a message to stderr and then terminates """
-    warn (message)
+    warn(message)
     exit(1)
 
 

setup.py

@@ -1,18 +1,9 @@
 from distutils.core import setup
 import os
 
-data = [
-       ('/usr/share/zsh/site-functions', ['cheat/autocompletion/_cheat.zsh']),
-       ('/etc/bash_completion.d'       , ['cheat/autocompletion/cheat.bash']),
-       ('/usr/share/fish/completions'  , ['cheat/autocompletion/cheat.fish'])
-       ]
-
-if os.name == 'nt':
-    data = []
-
 setup(
     name         = 'cheat',
-    version      = '2.0.3',
+    version      = '2.0.6',
     author       = 'Chris Lane',
     author_email = 'chris@chris-allen-lane.com',
     license      = 'GPL3',
@@ -29,8 +20,7 @@ setup(
     package_data = {
         'cheat.cheatsheets': [f for f in os.listdir('cheat/cheatsheets') if '.' not in f]
     },
-    scripts      = ['bin/cheat'],
-    data_files   = data,
+    scripts          = ['bin/cheat'],
     install_requires = [
         'docopt >= 0.6.1',
         'pygments >= 1.6.0',