Merge pull request #1 from gregmalcolm/master

merge the head

Author: alexsedova

.travis.yml

@@ -4,6 +4,8 @@ python:
     - 2.7
     - 3.2
     - 3.3
+    - 3.4
+    - 3.5
 
 script:
     - PYTHON_VER=`python -c 'import sys; print(sys.version_info[0])'`

README.rst

@@ -63,7 +63,7 @@ You can download Python from here:
     http://www.python.org/download
 
 After installing Python make sure the folder containing the python executable
-is in the system path. In other words, you need to be able to be able to run
+is in the system path. In other words, you need to be able to run
 Python from a command console. With Python 2 it will be called `python`
 or `python.exe` depending on the operating system. For Python 3 it will either
 be `python3` or for windows it will be `python.exe`.
@@ -124,6 +124,37 @@ fire up the command line, recreate the scenario and run queries:
 
 .. image:: http://i442.photobucket.com/albums/qq150/gregmalcolm/DebuggingPython.png
 
+Sniffer Support
+---------------
+
+Sniffer allows you to run the tests continuously. If you modify any files files
+in the koans directory, it will rerun the tests.
+
+To set this up, you need to install sniffer::
+
+    $ pip install sniffer
+
+You should also run one of these libraries depending on your system. This will
+automatically trigger sniffer when a file changes, otherwise sniffer will have
+to poll to see if the files have changed.
+
+On Linux::
+
+    $ pip install pyinotify
+
+On Windows::
+
+    $ pip install pywin32
+
+On Mac OS X::
+
+    $ pip install MacFSEvents
+
+Once it is set up, you just run::
+
+    $ sniffer
+
+Just modify one of the koans files and you'll see that the tests are triggered automatically. Sniffer is controlled by `scent.py`
 
 Getting the Most From the Koans
 -------------------------------

python2/_runner_tests.py

@@ -7,14 +7,20 @@
 from runner.runner_tests.test_mountain import TestMountain
 from runner.runner_tests.test_sensei import TestSensei
 from runner.runner_tests.test_helper import TestHelper
+from runner.runner_tests.test_path_to_enlightenment import TestFilterKoanNames
+from runner.runner_tests.test_path_to_enlightenment import TestKoansSuite
+
 
 def suite():
     suite = unittest.TestSuite()
     suite.addTests(unittest.TestLoader().loadTestsFromTestCase(TestMountain))
     suite.addTests(unittest.TestLoader().loadTestsFromTestCase(TestSensei))
     suite.addTests(unittest.TestLoader().loadTestsFromTestCase(TestHelper))
+    suite.addTests(unittest.TestLoader().loadTestsFromTestCase(TestFilterKoanNames))
+    suite.addTests(unittest.TestLoader().loadTestsFromTestCase(TestKoansSuite))
     return suite
 
+
 if __name__ == '__main__':
     res = unittest.TextTestRunner(verbosity=2).run(suite())
     sys.exit(not res.wasSuccessful())

python2/koans.txt

@@ -0,0 +1,41 @@
+# Lines starting with # are ignored.
+koans.about_asserts.AboutAsserts
+koans.about_strings.AboutStrings
+koans.about_none.AboutNone
+koans.about_lists.AboutLists
+koans.about_list_assignments.AboutListAssignments
+koans.about_dictionaries.AboutDictionaries
+koans.about_string_manipulation.AboutStringManipulation
+koans.about_tuples.AboutTuples
+koans.about_methods.AboutMethods
+koans.about_control_statements.AboutControlStatements
+koans.about_true_and_false.AboutTrueAndFalse
+koans.about_sets.AboutSets
+koans.about_triangle_project.AboutTriangleProject
+koans.about_exceptions.AboutExceptions
+koans.about_triangle_project2.AboutTriangleProject2
+koans.about_iteration.AboutIteration
+koans.about_comprehension.AboutComprehension
+koans.about_generators.AboutGenerators
+koans.about_lambdas.AboutLambdas
+koans.about_scoring_project.AboutScoringProject
+koans.about_classes.AboutClasses
+koans.about_new_style_classes.AboutNewStyleClasses
+koans.about_with_statements.AboutWithStatements
+koans.about_monkey_patching.AboutMonkeyPatching
+koans.about_dice_project.AboutDiceProject
+koans.about_method_bindings.AboutMethodBindings
+koans.about_decorating_with_functions.AboutDecoratingWithFunctions
+koans.about_decorating_with_classes.AboutDecoratingWithClasses
+koans.about_inheritance.AboutInheritance
+koans.about_multiple_inheritance.AboutMultipleInheritance
+koans.about_scope.AboutScope
+koans.about_modules.AboutModules
+koans.about_packages.AboutPackages
+koans.about_class_attributes.AboutClassAttributes
+koans.about_attribute_access.AboutAttributeAccess
+koans.about_deleting_objects.AboutDeletingObjects
+koans.about_proxy_object_project.AboutProxyObjectProject
+koans.about_proxy_object_project.TelevisionTest
+koans.about_extra_credit.AboutExtraCredit
+koans.about_regex.AboutRegex

python2/koans/about_asserts.py

@@ -15,13 +15,13 @@ def test_assert_truth(self):
         #
         #   http://bit.ly/about_asserts
 
-        self.assertTrue(False)  # This should be true
+        self.assertTrue(False)  # This should be True
 
     def test_assert_with_message(self):
         """
         Enlightenment may be more easily achieved with appropriate messages.
         """
-        self.assertTrue(False, "This should be true -- Please fix this")
+        self.assertTrue(False, "This should be True -- Please fix this")
 
     def test_fill_in_values(self):
         """
@@ -62,17 +62,17 @@ def test_that_sometimes_we_need_to_know_the_class_type(self):
 
         # Sometimes we will ask you what the class type of an object is.
         #
-        # For example, contemplate the text string "naval". What is its class type?
+        # For example, contemplate the text string "navel". What is its class type?
         # The koans runner will include this feedback for this koan:
         #
         #   AssertionError: '-=> FILL ME IN! <=-' != <type 'str'>
         #
-        # So "naval".__class__ is equal to <type 'str'>? No not quite. This
+        # So "navel".__class__ is equal to <type 'str'>? No not quite. This
         # is just what it displays. The answer is simply str.
         #
         # See for yourself:
 
-        self.assertEqual(__, "naval".__class__) # It's str, not <type 'str'>
+        self.assertEqual(__, "navel".__class__) # It's str, not <type 'str'>
 
         # Need an illustration? More reading can be found here:
         #

python2/koans/about_attribute_access.py

@@ -105,10 +105,6 @@ def __init__(self):
             self.no_of_getattribute_calls = 0
 
         def __getattribute__(self, attr_name):
-            #Uncomment for debugging info:
-            #print 'Debug __getattribute__(' + type(self).__name__ + \
-            #    "." + attr_name + ") dict=" + str(self.__dict__)
-
             # We need something that is outside the scope of this class:
             global stack_depth
             stack_depth += 1

python2/koans/about_comprehension.py

@@ -50,7 +50,7 @@ def test_creating_a_set_with_set_comprehension(self):
 
     def test_creating_a_dictionary_with_dictionary_comprehension(self):
         dict_of_weapons = {'first': 'fear', 'second': 'surprise',
-                           'third':'ruthless efficiency', 'forth':'fanatical devotion',
+                           'third':'ruthless efficiency', 'fourth':'fanatical devotion',
                            'fifth': None}
 
         dict_comprehension = { k.upper(): weapon for k, weapon in dict_of_weapons.iteritems() if weapon}

python2/koans/about_control_statements.py

@@ -18,11 +18,11 @@ def test_if_then_statements(self):
         if True:
             result = 'true value'
         self.assertEqual(__, result)
-        
+
     def test_if_then_elif_else_statements(self):
         if False:
             result = 'first value'
-        elif True: 
+        elif True:
             result = 'true value'
         else:
             result = 'default value'
@@ -66,7 +66,7 @@ def test_for_statement_with_tuples(self):
             ("Lancelot", "Blue"),
             ("Galahad", "I don't know!"),
             ("Robin", "Blue! I mean Green!"),
-            ("Arthur", "Is that an African Swallow or Amazonian Swallow?")
+            ("Arthur", "Is that an African Swallow or European Swallow?")
         ]
         result = []
         for knight, answer in round_table:

python2/koans/about_generators.py

@@ -43,8 +43,8 @@ def test_generator_expressions_are_a_one_shot_deal(self):
         attempt1 = list(dynamite)
         attempt2 = list(dynamite)
 
-        self.assertEqual(__, list(attempt1))
-        self.assertEqual(__, list(attempt2))
+        self.assertEqual(__, attempt1)
+        self.assertEqual(__, attempt2)
 
     # ------------------------------------------------------------------
 
@@ -60,7 +60,7 @@ def test_generator_method_will_yield_values_during_iteration(self):
             result.append(item)
         self.assertEqual(__, result)
 
-    def test_coroutines_can_take_arguments(self):
+    def test_generators_can_be_manually_iterated_and_closed(self):
         result = self.simple_generator_method()
         self.assertEqual(__, next(result))
         self.assertEqual(__, next(result))
@@ -91,12 +91,12 @@ def test_generator_keeps_track_of_local_variables(self):
 
     # ------------------------------------------------------------------
 
-    def generator_with_coroutine(self):
+    def coroutine(self):
         result = yield
         yield result
 
-    def test_generators_can_take_coroutines(self):
-        generator = self.generator_with_coroutine()
+    def test_generators_can_act_as_coroutines(self):
+        generator = self.coroutine()
 
         # THINK ABOUT IT:
         # Why is this line necessary?
@@ -108,7 +108,7 @@ def test_generators_can_take_coroutines(self):
         self.assertEqual(__, generator.send(1 + 2))
 
     def test_before_sending_a_value_to_a_generator_next_must_be_called(self):
-        generator = self.generator_with_coroutine()
+        generator = self.coroutine()
 
         try:
             generator.send(1 + 2)

python2/koans/about_lists.py

@@ -58,6 +58,7 @@ def test_lists_and_ranges(self):
         self.assertEqual(__, range(5, 9))
 
     def test_ranges_with_steps(self):
+        self.assertEqual(__, range(5, 3, -1))
         self.assertEqual(__, range(0, 8, 2))
         self.assertEqual(__, range(1, 8, 3))
         self.assertEqual(__, range(5, -7, -4))

python2/koans/about_modules.py

@@ -60,8 +60,11 @@ def test_private_attributes_are_still_accessible_in_modules(self):
         # module level attribute hiding doesn't affect class attributes
         # (unless the class itself is hidden).
 
-    def test_a_modules_XallX_statement_limits_what_wildcards_will_match(self):
-        """Examine results of from local_module_with_all_defined import *"""
+    def test_a_module_can_limit_wildcard_imports(self):
+        """
+        Examine results of:
+            from local_module_with_all_defined import *
+        """
 
         # 'Goat' is on the __all__ list
         goat = Goat()

python2/koans/about_new_style_classes.py

@@ -7,14 +7,18 @@
 class AboutNewStyleClasses(Koan):
     class OldStyleClass:
         "An old style class"
-        # Original class style have been phased out in Python 3.
+        # Original style classes from Python 2.1 and earlier, also known as
+        # "classic classes", have been phased out in Python 3.
 
     class NewStyleClass(object):
         "A new style class"
-        # Introduced in Python 2.2
+        # Introduced in Python 2.2 to unify types and classes.
+        #
+        # If you want to learn more, see:
+        # https://www.python.org/download/releases/2.2.3/descrintro/
         #
         # Aside from this set of tests, Python Koans sticks exclusively to this
-        # kind of class
+        # kind of class.
         pass
 
     def test_new_style_classes_inherit_from_object_base_class(self):
@@ -46,7 +50,7 @@ def test_old_style_classes_have_type_but_no_class_attribute(self):
 
     def test_new_style_classes_have_same_class_as_type(self):
         new_style = self.NewStyleClass()
-        self.assertEqual(__, self.NewStyleClass.__class__)
+        self.assertEqual(__, self.NewStyleClass.__class__.__name__)
         self.assertEqual(
             __,
             type(self.NewStyleClass) == self.NewStyleClass.__class__)

python2/koans/about_packages.py

@@ -53,7 +53,7 @@ def test_use_absolute_imports_to_import_upper_level_modules(self):
 
         self.assertEqual(__, contemplate_koans.__name__)
 
-        # contemplate_koans.py is the root module in this package because its
+        # contemplate_koans.py is the root module in this package because it's
         # the first python module called in koans.
         #
         # If contemplate_koans.py was based in a_package_folder that would be

python2/koans/about_triangle_project2.py

@@ -11,9 +11,15 @@ class AboutTriangleProject2(Koan):
     # The first assignment did not talk about how to handle errors.
     # Let's handle that part now.
     def test_illegal_triangles_throw_exceptions(self):
-        # Calls triangle(0, 0, 0)
+        # In the code below, each line calls the specfied method with the arguments passed to it.
+        # E.g. this line:
+        #   self.assertRaises(TriangleError, triangle, 0, 0, 0)
+        # calls triangle(0, 0, 0)
+        
+        # All sides should be greater than 0
         self.assertRaises(TriangleError, triangle, 0, 0, 0)
-
         self.assertRaises(TriangleError, triangle, 3, 4, -5)
+
+        # The sum of any two sides should be greater than the third one
         self.assertRaises(TriangleError, triangle, 1, 1, 3)
         self.assertRaises(TriangleError, triangle, 2, 5, 2)

python2/koans/about_true_and_false.py

@@ -34,7 +34,8 @@ def test_blank_strings_are_treated_as_false(self):
 
     def test_everything_else_is_treated_as_true(self):
         self.assertEqual(__, self.truth_value(1))
-        self.assertEqual(__, self.truth_value(1,))
+        self.assertEqual(__, self.truth_value([0]))
+        self.assertEqual(__, self.truth_value((0,)))
         self.assertEqual(
             __,
             self.truth_value("Python is named after Monty Python"))

python2/run.bat

@@ -8,6 +8,9 @@ REM Set this to your python folder:
 SET PYTHON_PATH=C:\Python27
 
 set SCRIPT=
+
+:loop
+
 REM Hunt around for python
 IF EXIST "python.exe" (
   SET SCRIPT=%RUN_KOANS%
@@ -32,4 +35,11 @@ IF NOT "" == "%SCRIPT%" (
   echo   python.exe contemplate_koans.py
   pause
 )
+
+Set /p  keepgoing="Test again? Y or N - "
+if "%keepgoing%" == "y" (
+	goto loop
+	)
+
+
 :end

python2/runner/mountain.py

@@ -8,16 +8,17 @@
 from sensei import Sensei
 from writeln_decorator import WritelnDecorator
 
+
 class Mountain:
     def __init__(self):
         self.stream = WritelnDecorator(sys.stdout)
         self.tests = path_to_enlightenment.koans()
         self.lesson = Sensei(self.stream)
 
     def walk_the_path(self, args=None):
-        "Run the koans tests with a custom runner output."
+        """Run the koans tests with a custom runner output."""
 
-        if args and len(args) >=2:
+        if args and len(args) >= 2:
             args.pop(0)
             test_names = ["koans." + test_name for test_name in args]
             self.tests = unittest.TestLoader().loadTestsFromNames(test_names)