added Detector.filth_cls. closes #13

Author: Dean Malmgren

docs/changelog.rst

@@ -11,6 +11,11 @@ latest changes in development for next release
 
 .. THANKS FOR CONTRIBUTING; MENTION WHAT YOU DID IN THIS SECTION HERE!
 
+1.0.2
+-----
+
+* minor change to force ``Detector.filth_cls`` to exist (`#13`_)
+
 1.0.1
 -----
 
@@ -66,3 +71,4 @@ latest changes in development for next release
 .. _#10: https://github.com/datascopeanalytics/scrubadub/issues/10
 .. _#11: https://github.com/datascopeanalytics/scrubadub/issues/11
 .. _#12: https://github.com/datascopeanalytics/scrubadub/issues/12
+.. _#13: https://github.com/datascopeanalytics/scrubadub/issues/13

scrubadub/__init__.py

@@ -4,7 +4,7 @@
 from . import filth
 from . import detectors
 
-__version__ = VERSION = "1.0.1"
+__version__ = VERSION = "1.0.2"
 
 
 def clean(text, cls=None, **kwargs):

scrubadub/detectors/base.py

@@ -1,16 +1,17 @@
 import re
 
 from .. import exceptions
-from ..filth import RegexFilth
+from ..filth import Filth, RegexFilth
 
 
 class Detector(object):
+    filth_cls = None
+
     def iter_filth(self, text):
         raise NotImplementedError('must be overridden by base classes')
 
 
 class RegexDetector(Detector):
-    filth_cls = RegexFilth
 
     def iter_filth(self, text):
         if not issubclass(self.filth_cls, RegexFilth):

scrubadub/detectors/phone.py

@@ -14,6 +14,7 @@ class PhoneDetector(Detector):
     ``"US"``). Specify ``None`` to only consider numbers with a leading
     ``+`` to be considered.
     """
+    filth_cls = PhoneFilth
     region = 'US'
 
     def iter_filth(self, text):

tests/test_detector.py

@@ -1,5 +1,6 @@
 import unittest
 
+import scrubadub
 from scrubadub.detectors.base import RegexDetector
 from scrubadub.filth.base import Filth
 from scrubadub.exceptions import UnexpectedFilth
@@ -21,3 +22,10 @@ class MyDetector(RegexDetector):
         with self.assertRaises(UnexpectedFilth):
             for filth in detector.iter_filth(text):
                 pass
+
+    def test_detector_filth_cls(self):
+        """Detector.filth_cls should always exist"""
+        for name, detector_cls in scrubadub.detectors.types.iteritems():
+            self.assertTrue(getattr(detector_cls, 'filth_cls', False),
+                '%s does not have a filth_cls set' % detector_cls
+            )