renamed checkSumRecursive to checksum_recursively and changed main's …

…docstring for better

peon/peon.py

@@ -50,20 +50,20 @@ def _get_checksum_from_dir(dirpath, pattern):
     return result
 
 
-def checkSumRecursive(directory, pattern='*.py'):
+def checksum_recursively(directory, pattern):
     result = 0
     for dirpath, dirs, files in os.walk(directory):
         result += _get_checksum_from_dir(dirpath, pattern)
     return result
 
 
-def something_has_changed(dir, pattern='*.py'):
+def something_has_changed(dir, pattern):
     global _checksum
     global _pattern
     if _pattern != pattern:
         _pattern = pattern
-        _checksum = checkSumRecursive(dir, _pattern)
-    new_checksum = checkSumRecursive(dir, _pattern)
+        _checksum = checksum_recursively(dir, _pattern)
+    new_checksum = checksum_recursively(dir, _pattern)
     if new_checksum != _checksum:
         _checksum = new_checksum
         return True
@@ -72,9 +72,10 @@ def something_has_changed(dir, pattern='*.py'):
 
 def main():
     '''
-    Watch for changes in all files indicated by a glob pattern,
-    by default it looks for '*.py'.
-    If something has changes, run a given command or nosetests.
+    Watch for changes in files that match the pattern in a directory.
+    Default dir is '.' and default pattern is '*.py'.
+    Whenever a change to any matched file in directory happens, peon runs
+    the command specified or nosetests by default
     '''
     parser = optparse.OptionParser()
     parser.add_option('-d', '--dir', default='.', dest='directory',

tests/checksum_spec.py

@@ -1,7 +1,7 @@
 import os
 import unittest
 from base import env, TEST_OUTPUT_DIR
-from peon import checkSumRecursive
+from peon import checksum_recursively
 from should_dsl import *
 
 
@@ -12,9 +12,9 @@ def setUp(self):
 
     def should_find_python_files_in_dir(self):
         env.writefile('lol.py', 'lol')
-        first_checksum = checkSumRecursive(TEST_OUTPUT_DIR)
+        first_checksum = checksum_recursively(TEST_OUTPUT_DIR, pattern='*.py')
         env.writefile('lol.py', 'lol\nlol again')
-        second_checksum = checkSumRecursive(TEST_OUTPUT_DIR)
+        second_checksum = checksum_recursively(TEST_OUTPUT_DIR, pattern='*.py')
 
         first_checksum |should_be.less_than| second_checksum
 
@@ -23,23 +23,23 @@ def should_find_python_files_in_subdirs(self):
         env.mkdir('foo/bar')
         foo_path = os.path.join(TEST_OUTPUT_DIR, 'foo')
         env.writefile('foo/bar/lol.py', 'lol')
-        first_checksum = checkSumRecursive(foo_path)
+        first_checksum = checksum_recursively(foo_path, pattern='*.py')
         env.writefile('foo/bar/lol.py', 'lol\nlol again')
-        second_checksum = checkSumRecursive(foo_path)
+        second_checksum = checksum_recursively(foo_path, pattern='*.py')
 
         first_checksum |should_be.less_than| second_checksum
 
     def should_find_files_by_pattern_matching(self):
         env.writefile('lol.foo', 'lol')
-        first_checksum = checkSumRecursive(TEST_OUTPUT_DIR, pattern='*.foo')
+        first_checksum = checksum_recursively(TEST_OUTPUT_DIR, pattern='*.foo')
         env.writefile('lol.foo', 'lol\nlol again')
-        second_checksum = checkSumRecursive(TEST_OUTPUT_DIR, pattern='*.foo')
+        second_checksum = checksum_recursively(TEST_OUTPUT_DIR, pattern='*.foo')
 
         first_checksum |should_be.less_than| second_checksum
 
     def should_find_files_by_relative_paths(self):
         env.writefile('lol.foo', 'lol')
-        first_checksum = checkSumRecursive('tests/test-output', pattern='*.foo')
+        first_checksum = checksum_recursively('tests/test-output', pattern='*.foo')
         env.writefile('lol.foo', 'lol\nlol again')
-        second_checksum = checkSumRecursive(TEST_OUTPUT_DIR, pattern='*.foo')
+        second_checksum = checksum_recursively(TEST_OUTPUT_DIR, pattern='*.foo')