Merge pull request faif#144 from yarikoptic/master

ENH+BF: fix up of some tests/docs to pass with python2.7, testing on travis, consistent shebanging,

Author: faif

.travis.yml

@@ -0,0 +1,33 @@
+# vim ft=yaml
+# travis-ci.org definition for python-patterns build
+language: python
+
+sudo: false
+
+python:
+  - "2.7"
+  - "3.3"
+  - "3.4"
+  - "3.5"
+# Disabled for now since cause more pain than gain
+#  - "pypy"
+#  - "pypy3"
+
+cache:
+  - pip
+
+install:
+  - travis_retry pip install -q coveralls codecov
+  - pip install flake8  # eventually worth
+
+script:
+  # Run tests
+  - PYTHONPATH=. nosetests -s -v --with-doctest --with-cov --cover-package . --logging-level=INFO -v .
+  # Actually run all the scripts, contributing to coverage
+  - ./run_all.sh
+  # for now failure in flaking is ignored
+  - flake8 *py || echo "PEP8 the code"
+
+after_success:
+  - coveralls
+  - codecov

3-tier.py

@@ -19,8 +19,7 @@ def __get__(self, obj, klas):
 class BusinessLogic(object):
     """ Business logic holding data store instances """
 
-    def __init__(self, data):
-        self.data = data
+    data = Data()
 
     def product_list(self):
         return self.data['products'].keys()
@@ -32,8 +31,8 @@ def product_information(self, product):
 class Ui(object):
     """ UI interaction class """
 
-    def __init__(self, logic):
-        self.business_logic = logic
+    def __init__(self):
+        self.business_logic = BusinessLogic()
 
     def get_product_list(self):
         print('PRODUCT LIST:')
@@ -54,9 +53,7 @@ def get_product_information(self, product):
 
 
 def main():
-    data = Data()
-    logic = BusinessLogic(data)
-    ui = Ui(logic)
+    ui = Ui()
     ui.get_product_list()
     ui.get_product_information('cheese')
     ui.get_product_information('eggs')
@@ -72,7 +69,7 @@ def main():
 # cheese
 # eggs
 # milk
-#
+# 
 # (Fetching from Data Store)
 # PRODUCT INFORMATION:
 # Name: Cheese, Price: 2.00, Quantity: 10

adapter.py

@@ -46,8 +46,10 @@ class Adapter(object):
     >>> objects = []
     >>> dog = Dog()
     >>> print(dog.__dict__)
+    {'name': 'Dog'}
     >>> objects.append(Adapter(dog, make_noise=dog.bark))
     >>> print(objects[0].original_dict())
+    {'name': 'Dog'}
     >>> cat = Cat()
     >>> objects.append(Adapter(cat, make_noise=cat.meow))
     >>> human = Human()

chain.py

@@ -57,7 +57,7 @@ def delegate(self, requests):
 def coroutine(func):
     def start(*args, **kwargs):
         cr = func(*args, **kwargs)
-        cr.next()
+        next(cr)
         return cr
     return start
 

chaining_method.py

@@ -1,6 +1,8 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
+from __future__ import print_function
+
 class Person(object):
 
     def __init__(self, name, action):

command.py

@@ -2,7 +2,7 @@
 # -*- coding: utf-8 -*-
 
 import os
-
+from os.path import lexists
 
 class MoveFileCommand(object):
 
@@ -28,13 +28,23 @@ def main():
     command_stack.append(MoveFileCommand('foo.txt', 'bar.txt'))
     command_stack.append(MoveFileCommand('bar.txt', 'baz.txt'))
 
-    # they can be executed later on
-    for cmd in command_stack:
-        cmd.execute()
-
-    # and can also be undone at will
-    for cmd in reversed(command_stack):
-        cmd.undo()
+    # verify that none of the target files exist
+    assert(not lexists("foo.txt"))
+    assert(not lexists("bar.txt"))
+    assert(not lexists("baz.txt"))
+    try:
+        with open("foo.txt", "w"):  # Creating the file
+            pass
+
+        # they can be executed later on
+        for cmd in command_stack:
+            cmd.execute()
+
+        # and can also be undone at will
+        for cmd in reversed(command_stack):
+            cmd.undo()
+    finally:
+        os.unlink("foo.txt")
 
 if __name__ == "__main__":
     main()

decorator.py

@@ -1,3 +1,4 @@
+#!/usr/bin/env python
 """https://docs.python.org/2/library/functools.html#functools.wraps"""
 """https://stackoverflow.com/questions/739654/how-can-i-make-a-chain-of-function-decorators-in-python/739665#739665"""
 

delegation_pattern.py

@@ -3,7 +3,7 @@
 
 import time
 
-SLEEP = 0.5
+SLEEP = 0.1
 
 
 # Complex Parts

facade.py

@@ -74,6 +74,11 @@ def __init__(self, *args, **kwargs):
 
 
 if __name__ == '__main__':
+    import sys
+    if sys.version_info[0] > 2:
+        sys.stderr.write("!!! This example is compatible only with Python 2 ATM !!!\n")
+        raise SystemExit(0)
+
     # comment __new__ and uncomment __init__ to see the difference
     c1 = Card('9', 'h')
     c2 = Card('9', 'h')

flyweight.py

@@ -18,17 +18,17 @@ def talk(self):
         print("Proxy checking for Sales Manager availability")
         if self.busy == 'No':
             self.sales = SalesManager()
-            time.sleep(2)
+            time.sleep(0.1)
             self.sales.talk()
         else:
-            time.sleep(2)
+            time.sleep(0.1)
             print("Sales Manager is busy")
 
 
 class NoTalkProxy(Proxy):
     def talk(self):
         print("Proxy checking for Sales Manager availability")
-        time.sleep(2)
+        time.sleep(0.1)
         print("This Sales Manager will not talk to you whether he/she is busy or not")
 
 

proxy.py

@@ -0,0 +1,22 @@
+#!/bin/bash
+#
+# Little helper to run all the scripts, under python coverage if coverage is available
+#
+
+set -eu
+failed=""
+
+if which coverage > /dev/null; then
+    COVERAGE="`which coverage` run -a"
+else
+    COVERAGE=''
+fi
+for f in [^_]*py; do
+    python $COVERAGE $f || failed+=" $f"
+    echo "I: done $f. Exit code $?"
+done;
+
+if [ ! -z "$failed" ]; then
+    echo "Failed: $failed";
+    exit 1
+fi

run_all.sh

@@ -1,3 +1,4 @@
+#!/usr/bin/env python
 """Implementation of the state pattern"""
 
 # http://ginstrom.com/scribbles/2007/10/08/design-patterns-python-style/

state.py

@@ -1,3 +1,4 @@
+#!/usr/bin/env python
 # http://stackoverflow.com/questions/963965/how-is-this-strategy-pattern
 # -written-in-python-the-sample-in-wikipedia
 """

strategy.py

@@ -9,7 +9,10 @@
 else:
     import unittest
 
-from unittest.mock import patch
+try:
+    from unittest.mock import patch
+except ImportError:
+    from mock import patch
 
 
 class TestPetShop(unittest.TestCase):

test_abstract_factory.py

@@ -1,3 +1,4 @@
+#!/usr/bin/env python
 from adapter import Dog, Cat, Human, Car, Adapter
 import sys
 

test_adapter.py

@@ -1,3 +1,4 @@
+#!/usr/bin/env python
 from borg import Borg, YourBorg
 import sys
 

test_borg.py

@@ -4,12 +4,16 @@
 from bridge import DrawingAPI1, DrawingAPI2, CircleShape
 from sys import version_info
 
-if version_info < (2, 7):
+if version_info < (2, 7):  # pragma: no cover
     import unittest2 as unittest
 else:
     import unittest
 
-from unittest.mock import patch
+try:
+    from unittest.mock import patch
+except ImportError:
+    from mock import patch
+
 
 class BridgeTest(unittest.TestCase):
 

test_bridge.py

@@ -1,3 +1,4 @@
+#!/usr/bin/env python
 from command import MoveFileCommand
 import os, shutil, subprocess, sys
 

test_command.py

@@ -4,7 +4,7 @@
 from flyweight import Card
 from sys import version_info
 
-if version_info < (2, 7):
+if version_info < (2, 7):  # pragma: no cover
     import unittest2 as unittest
 else:
     import unittest

test_flyweight.py

@@ -1,13 +1,17 @@
+#!/usr/bin/env python
 from hsm import HierachicalStateMachine, UnsupportedMessageType,\
     UnsupportedState, UnsupportedTransition, Active, Standby, Suspect, Failed
 from sys import version_info
 
-if version_info < (2, 7):
+if version_info < (2, 7):  # pragma: no cover
     import unittest2 as unittest
 else:
     import unittest
 
-from unittest.mock import patch
+try:
+    from unittest.mock import patch
+except ImportError:
+    from mock import patch
 
 
 class HsmMethodTest(unittest.TestCase):
@@ -74,18 +78,18 @@ def test_given_standby_on_message_fault_trigger_shall_set_suspect(cls):
     def test_given_standby_on_message_diagnostics_failed_shall_raise_exception_and_keep_in_state(cls):
         with cls.assertRaises(UnsupportedTransition) as context:
             cls.hsm.on_message('diagnostics failed')
-            cls.assertEqual(isinstance(cls.hsm._current_state, Standby), True)
+        cls.assertEqual(isinstance(cls.hsm._current_state, Standby), True)
 
     def test_given_standby_on_message_diagnostics_passed_shall_raise_exception_and_keep_in_state(cls):
         with cls.assertRaises(UnsupportedTransition) as context:
             cls.hsm.on_message('diagnostics passed')
-            cls.assertEqual(isinstance(cls.hsm._current_state, Standby), True)
+        cls.assertEqual(isinstance(cls.hsm._current_state, Standby), True)
 
     def test_given_standby_on_message_operator_inservice_shall_raise_exception_and_keep_in_state(cls):
         with cls.assertRaises(UnsupportedTransition) as context:
             cls.hsm.on_message('operator inservice')
-            cls.assertEqual(isinstance(cls.hsm._current_state, Standby), True)
+        cls.assertEqual(isinstance(cls.hsm._current_state, Standby), True)
 
 
 if __name__ == "__main__":
-    unittest.main()
+    unittest.main()

test_hsm.py

@@ -7,11 +7,14 @@
 
 if sys.version_info < (2, 7):
     import unittest2 as unittest
-
 else:
     import unittest
 
-from unittest.mock import patch
+try:
+    from unittest.mock import patch
+except ImportError:
+    from mock import patch
+
 
 class TestSubject(unittest.TestCase):