Merge pull request #13 from sackfield/fix-foss-3

Fix more FOSS requests

README.md

@@ -23,23 +23,30 @@ This script was made to “gameify” testing at Spotify and to continue encoura
 
 The script uses the current working directory to find files it could possibly read (such as `.m`, `.mm` and `.java` files) and performs a `git blame` on these files in order to match tests written to the developers that wrote them. 
 The owner of the method name of the test is considered the developer that wrote it.
+Note that since this script makes use of git, the file will need to be committed before it is counted. This will always look on the currently checked out branch.
 
 ## Dependencies
 
-* [python 2.7.10](https://www.python.org/downloads/release/python-2710/) (for running the script)
-* [git 2.6.1](https://git-scm.com/) (for finding the blame information for a given file)
+* [python 2.7.9](https://www.python.org/downloads/release/python-2710/) (for running the script)
+* [git 2.5.3](https://git-scm.com/) (for finding the blame information for a given file)
 
-The script should run on any operating system containing these two dependencies.
+The script should run on any operating system containing these two dependencies. The script may operate on lower python or git versions, but there is a certain of amount of buyer beware here.
 
 ## Usage
 
-1. Run the Python script from your repository:
+1. Run the Python setup.py from this repository:
 
     ```shell
-    > python testinggame.py
+    > python setup.py install
     ```
 
-2. Mention that you write most unit units of your project on every meeting (no, don’t do that).
+2. Run  the testing game script from your repository (or subdirectory):
+
+    ```shell
+    > testinggame
+    ```
+
+3. Mention that you write most unit units of your project on every meeting (no, don’t do that).
 
 
 ## Contribution

testinggame/__init__.py

@@ -73,7 +73,7 @@ def _find_xctest_tests(blame_lines, names, source, xctestsuperclasses):
     return names
 
 
-def _find_java_tests(blame_lines, names, source):
+def _find_java_tests(blame_lines, names):
     """
     Finds the number of Java test cases per user. This will find tests both
     with the @Test annotation and the standard test methods.
@@ -83,7 +83,6 @@ def _find_java_tests(blame_lines, names, source):
         blame line.
         names: The current dictionary containing the usernames as a key and the
         number of tests as a value.
-        source: A string containing the raw source code for the file.
     Returns:
         A dictionary built off the names argument containing the usernames as a
         key and the number of tests as a value.
@@ -104,7 +103,7 @@ def _find_java_tests(blame_lines, names, source):
     return names
 
 
-def _find_boost_tests(blame_lines, names, source):
+def _find_boost_tests(blame_lines, names):
     """
     Finds the number of Boost test cases per user.
 
@@ -113,7 +112,6 @@ def _find_boost_tests(blame_lines, names, source):
         blame line.
         names: The current dictionary containing the usernames as a key and the
         number of tests as a value.
-        source: A string containing the raw source code for the file.
     Returns:
         A dictionary built off the names argument containing the usernames as a
         key and the number of tests as a value.
@@ -132,7 +130,7 @@ def _find_boost_tests(blame_lines, names, source):
     return names
 
 
-def _find_nose_tests(blame_lines, names, source):
+def _find_python_tests(blame_lines, names, source):
     """
     Finds the number of python test cases per user.
 
@@ -141,7 +139,6 @@ def _find_nose_tests(blame_lines, names, source):
         blame line.
         names: The current dictionary containing the usernames as a key and the
         number of tests as a value.
-        source: A string containing the raw source code for the file.
     Returns:
         A dictionary built off the names argument containing the usernames as a
         key and the number of tests as a value.
@@ -204,16 +201,13 @@ def _find_git_status(directory, xctestsuperclasses):
                                                        xctestsuperclasses)
                         if fileextension in java_extensions:
                             names = _find_java_tests(blame_lines,
-                                                     names,
-                                                     source)
+                                                     names)
                         if fileextension in cpp_extensions:
                             names = _find_boost_tests(blame_lines,
-                                                      names,
-                                                      source)
+                                                      names)
                         if fileextension in python_extensions:
-                            names = _find_nose_tests(blame_lines,
-                                                     names,
-                                                     source)
+                            names = _find_python_tests(blame_lines,
+                                                       names)
                 except:
                     'Could not open file: ' + absfile
     return names