Add 'includes' helper

Closes #6
Closes #8

CHANGELOG.md

@@ -1,6 +1,7 @@
 # 2.1 (beta)
 
 - Added support for matching identity via `expect(actual).is_(expected)`.
+- Added `includes` helper as an alias of `contains`.
 
 # 2.0 (2020-02-06)
 

docs/checks.md

@@ -14,8 +14,8 @@ expect(42) > 0
 # Contents
 
 ```python
-expect("Hello, world!").contains("world")
-expect("Hello, world!").excludes("foobar")  # or does_not_contain
+expect("Hello, world!").contains("world")  # or 'includes'
+expect("Hello, world!").excludes("foobar")  # or 'does_not_contain'
 expect("Hello, world!").icontains("hello")
 expect("Hello, world!").iexcludes("FOOBAR")
 ```

expecter/__init__.py

@@ -175,6 +175,23 @@ def icontains(self, other):
 
         assert expected in actual, msg
 
+    def includes(self, other):
+        """Same as ``contains`` but with alternate phrasing."""
+        __tracebackhide__ = _hidetraceback()  # pylint: disable=unused-variable
+
+        if isinstance(self._actual, str) and '\n' in self._actual:
+            msg = "Given text:\n\n%s\n\nExpected to include %s but didn't" % (
+                self._actual.strip(),
+                repr(other),
+            )
+        else:
+            msg = "Expected %s to include %s but it didn't" % (
+                repr(self._actual),
+                repr(other),
+            )
+
+        assert other in self._actual, msg
+
     def does_not_contain(self, other):
         """Opposite of ``contains``."""
         __tracebackhide__ = _hidetraceback()  # pylint: disable=unused-variable

pyproject.toml

@@ -1,7 +1,7 @@
 [tool.poetry]
 
 name = "pytest-expecter"
-version = "2.1b1"
+version = "2.1b2"
 description = "Better testing with expecter and pytest."
 
 license = "BSD"
@@ -20,6 +20,7 @@ classifiers = [
     "Environment :: Plugins",
     "Framework :: Pytest",
     "Intended Audience :: Developers",
+    "License :: OSI Approved :: BSD License",
     "Operating System :: OS Independent",
     "Programming Language :: Python",
     "Programming Language :: Python :: 3.6",

tests/test_comparison.py

@@ -7,37 +7,6 @@
 
 
 def describe_expect():
-    def it_can_expect_equality():
-        expect(2) == 1 + 1
-
-        def _fails():
-            expect(1) == 2
-
-        with pytest.raises(AssertionError):
-            _fails()
-        assert fail_msg(_fails) == 'Expected 2 but got 1'
-
-    def it_can_compare_bytes():
-        null = bytes((0,))
-        expect(null) == null
-        data = bytes(range(9, 32))
-
-        def _fails():
-            expect(data) == data + null
-
-        with pytest.raises(AssertionError):
-            _fails()
-
-    def it_can_expect_inequality():
-        expect(1) != 2
-
-        def _fails():
-            expect(1) != 1
-
-        with pytest.raises(AssertionError):
-            _fails()
-        assert fail_msg(_fails) == 'Expected anything except 1 but got it'
-
     def it_can_expect_less_than():
         expect(1) < 2
 

tests/test_containment.py → tests/test_contents.py

@@ -29,6 +29,16 @@ def _fails():
             "Expected 'fooBar' to contain 'Qux' (ignoring case) but it didn't"
         )
 
+    def it_can_expect_inclusion():
+        expect([1]).includes(1)
+
+        def _fails():
+            expect([2]).includes(1)
+
+        with pytest.raises(AssertionError):
+            _fails()
+        assert fail_msg(_fails) == ("Expected [2] to include 1 but it didn't")
+
     def it_can_expect_non_containment():
         expect([1]).does_not_contain(0)
 

tests/test_equality.py

@@ -0,0 +1,39 @@
+# pylint: disable=unused-variable,expression-not-assigned
+
+import pytest
+
+from expecter import expect
+from tests.utils import fail_msg
+
+
+def describe_expect():
+    def it_can_expect_equality():
+        expect(2) == 1 + 1
+
+        def _fails():
+            expect(1) == 2
+
+        with pytest.raises(AssertionError):
+            _fails()
+        assert fail_msg(_fails) == 'Expected 2 but got 1'
+
+    def it_can_compare_bytes():
+        null = bytes((0,))
+        expect(null) == null
+        data = bytes(range(9, 32))
+
+        def _fails():
+            expect(data) == data + null
+
+        with pytest.raises(AssertionError):
+            _fails()
+
+    def it_can_expect_inequality():
+        expect(1) != 2
+
+        def _fails():
+            expect(1) != 1
+
+        with pytest.raises(AssertionError):
+            _fails()
+        assert fail_msg(_fails) == 'Expected anything except 1 but got it'

tests/test_exceptions.py

@@ -1,6 +1,6 @@
 # pylint: disable=unused-variable,expression-not-assigned
 
-from nose.tools import assert_raises
+import pytest
 
 from expecter import expect
 from tests.utils import fail_msg
@@ -16,7 +16,9 @@ def _expects_raise_but_doesnt_get_it():
             with expect.raises(KeyError):
                 pass
 
-        assert_raises(AssertionError, _expects_raise_but_doesnt_get_it)
+        with pytest.raises(AssertionError):
+            _expects_raise_but_doesnt_get_it()
+
         assert fail_msg(_expects_raise_but_doesnt_get_it) == (
             'Expected an exception of type KeyError but got none'
         )
@@ -26,7 +28,8 @@ def _expects_key_error_but_gets_value_error():
             with expect.raises(KeyError):
                 raise ValueError
 
-        assert_raises(ValueError, _expects_key_error_but_gets_value_error)
+        with pytest.raises(ValueError):
+            _expects_key_error_but_gets_value_error()
 
     def it_can_expect_any_exception():
         with expect.raises():
@@ -41,7 +44,8 @@ def _fails():
             with expect.raises(ValueError, 'my message'):
                 raise ValueError('wrong message')
 
-        assert_raises(AssertionError, _fails)
+        with pytest.raises(AssertionError):
+            _fails()
         assert fail_msg(_fails) == (
             "Expected ValueError('my message') but got ValueError('wrong message')"
         )