ENH: Increase coverage

Author: larsoner

.coveragerc

@@ -0,0 +1,5 @@
+[run]
+branch = True
+source = codespell_lib
+include = */codespell_lib/*
+omit =

.travis.yml

@@ -27,7 +27,7 @@ before_install:
     - source venv/bin/activate
     - python --version  # just to check
     - pip install -U pip wheel  # upgrade to latest pip find 3.5 wheels; wheel to avoid errors
-    - retry pip install nose flake8 coverage codecov
+    - retry pip install nose flake8 coverage codecov chardet
     - cd $SRC_DIR
 
 install:

codespell_lib/_codespell.py

@@ -129,9 +129,9 @@ def init_chardet(self):
         try:
             from chardet.universaldetector import UniversalDetector
         except ImportError:
-            raise Exception("There's no chardet installed to import from. "
-                            "Please, install it and check your PYTHONPATH "
-                            "environment variable")
+            raise ImportError("There's no chardet installed to import from. "
+                              "Please, install it and check your PYTHONPATH "
+                              "environment variable")
 
         self.encdetector = UniversalDetector()
 
@@ -433,8 +433,7 @@ def parse_file(filename, colors, summary):
 
                 if options.write_changes and fix:
                     changed = True
-                    lines[i - 1] = re.sub(r'\b%s\b' % word,
-                                          fixword, lines[i - 1])
+                    lines[i] = re.sub(r'\b%s\b' % word, fixword, lines[i])
                     fixed_words.add(word)
                     continue
 
@@ -506,7 +505,7 @@ def main(*args):
         print('ERROR: cannot find dictionary file:\n%s' % options.dictionary,
               file=sys.stderr)
         parser.print_help()
-        sys.exit(1)
+        return 1
 
     build_dict(options.dictionary)
     colors = TermColors()
@@ -536,17 +535,9 @@ def main(*args):
 
         if os.path.isdir(filename):
             for root, dirs, files in os.walk(filename):
-                # i = 0
-                # for d in dirs:
-                #     if is_hidden(d):
-                #         del dirs[i]
-                #     else:
-                #         i += 1
                 for file_ in files:
                     fname = os.path.join(root, file_)
-                    if not os.path.isfile(fname):
-                        continue
-                    if not os.path.getsize(fname):
+                    if not os.path.isfile(fname) or not os.path.getsize(fname):
                         continue
                     if glob_match.match(root):  # skips also match directories
                         continue
@@ -561,7 +552,3 @@ def main(*args):
         print("\n-------8<-------\nSUMMARY:")
         print(summary)
     return bad_count
-
-
-if __name__ == '__main__':
-    sys.exit(main(*sys.argv))

codespell_lib/tests/test_basic.py

@@ -1,30 +1,179 @@
+# -*- coding: utf-8 -*-
+
 from __future__ import print_function
 
+import contextlib
 import os
 import os.path as op
 import sys
 import tempfile
 import warnings
 
-from nose.tools import assert_equal
+from nose.tools import assert_equal, assert_true
 
 from codespell_lib import main
 
 
 def test_basic():
     """Test some basic functionality"""
     assert_equal(main('_does_not_exist_'), 0)
-    with tempfile.NamedTemporaryFile() as f:
-        assert_equal(main(f.name,), 0)  # empty file
-        f.write('this is a test file\n'.encode('utf-8'))
+    with tempfile.NamedTemporaryFile('w') as f:
+        with CaptureStdout() as sio:
+            assert_equal(main('-D', 'foo', f.name), 1)  # missing dictionary
+        assert_true('cannot find dictionary' in sio[1])
+        assert_equal(main(f.name), 0)  # empty file
+        f.write('this is a test file\n')
         f.flush()
-        assert_equal(main(f.name,), 0)  # good
-        f.write('abandonned\n'.encode('utf-8'))
+        assert_equal(main(f.name), 0)  # good
+        f.write('abandonned\n')
         f.flush()
         assert_equal(main(f.name), 1)  # bad
-        f.write('abandonned\n'.encode('utf-8'))
+        f.write('abandonned\n')
         f.flush()
         assert_equal(main(f.name), 2)  # worse
+    with TemporaryDirectory() as d:
+        with open(op.join(d, 'bad.txt'), 'w') as f:
+            f.write('abandonned\nAbandonned\nABANDONNED\nAbAnDoNnEd')
+        assert_equal(main(d), 4)
+        with CaptureStdout() as sio:
+            assert_equal(main('-w', d), 0)
+        assert_true('FIXED:' in sio[1])
+        with open(op.join(d, 'bad.txt')) as f:
+            new_content = f.read()
+        assert_equal(main(d), 0)
+        assert_equal(new_content, 'abandoned\nAbandoned\nABANDONED\nabandoned')
+
+        with open(op.join(d, 'bad.txt'), 'w') as f:
+            f.write('abandonned abandonned\n')
+        assert_equal(main(d), 2)
+        with CaptureStdout() as sio:
+            assert_equal(main('-q', '16', '-w', d), 0)
+        assert_equal(sio[0], '')
+        assert_equal(main(d), 0)
+
+        # empty directory
+        os.mkdir(op.join(d, 'test'))
+        assert_equal(main(d), 0)
+
+        # hidden file
+        with open(op.join(d, 'test.txt'), 'w') as f:
+            f.write('abandonned\n')
+        assert_equal(main(op.join(d, 'test.txt')), 1)
+        os.rename(op.join(d, 'test.txt'), op.join(d, '.test.txt'))
+        assert_equal(main(op.join(d, '.test.txt')), 0)
+
+
+def test_interactivity():
+    """Test interaction"""
+    with tempfile.NamedTemporaryFile('w') as f:
+        assert_equal(main(f.name), 0)  # empty file
+        f.write('abandonned\n')
+        f.flush()
+        assert_equal(main('-i', '-1', f.name), 1)  # bad
+        with FakeStdin('y\n'):
+            assert_equal(main('-i', '3', f.name), 1)
+        with CaptureStdout() as sio:
+            with FakeStdin('n\n'):
+                assert_equal(main('-w', '-i', '3', f.name), 0)
+        assert_true('==>' in sio[0])
+        with CaptureStdout():
+            with FakeStdin('x\ny\n'):
+                assert_equal(main('-w', '-i', '3', f.name), 0)
+        assert_equal(main(f.name), 0)
+    with tempfile.NamedTemporaryFile('w') as f:
+        f.write('abandonned\n')
+        f.flush()
+        assert_equal(main(f.name), 1)
+        with CaptureStdout():
+            with FakeStdin(' '):  # blank input -> Y
+                assert_equal(main('-w', '-i', '3', f.name), 0)
+        assert_equal(main(f.name), 0)
+    # multiple options
+    with tempfile.NamedTemporaryFile('w') as f:
+        f.write('ackward\n')
+        f.flush()
+        assert_equal(main(f.name), 1)
+        with CaptureStdout():
+            with FakeStdin(' \n'):  # blank input -> nothing
+                assert_equal(main('-w', '-i', '3', f.name), 0)
+        assert_equal(main(f.name), 1)
+        with CaptureStdout():
+            with FakeStdin('0\n'):  # blank input -> nothing
+                assert_equal(main('-w', '-i', '3', f.name), 0)
+        assert_equal(main(f.name), 0)
+        with open(f.name, 'r') as f_read:
+            assert_equal(f_read.read(), 'awkward\n')
+        f.seek(0)
+        f.write('ackward\n')
+        f.flush()
+        assert_equal(main(f.name), 1)
+        with CaptureStdout() as sio:
+            with FakeStdin('x\n1\n'):  # blank input -> nothing
+                assert_equal(main('-w', '-i', '3', f.name), 0)
+        assert_true('a valid option' in sio[0])
+        assert_equal(main(f.name), 0)
+        with open(f.name, 'r') as f:
+            assert_equal(f.read(), 'backward\n')
+
+
+def test_summary():
+    """Test summary functionality"""
+    with tempfile.NamedTemporaryFile('w') as f:
+        with CaptureStdout() as sio:
+            main(f.name)
+        for ii in range(2):
+            assert_equal(sio[ii], '')  # no output
+        with CaptureStdout() as sio:
+            main(f.name, '--summary')
+        assert_equal(sio[1], '')  # stderr
+        assert_true('SUMMARY' in sio[0])
+        assert_equal(len(sio[0].split('\n')), 5)  # no output
+        f.write('abandonned\nabandonned')
+        f.flush()
+        with CaptureStdout() as sio:
+            main(f.name, '--summary')
+        assert_equal(sio[1], '')  # stderr
+        assert_true('SUMMARY' in sio[0])
+        assert_equal(len(sio[0].split('\n')), 7)
+        assert_true('abandonned' in sio[0].split()[-2])
+
+
+def test_exclude_file():
+    """Test exclude file functionality"""
+    with TemporaryDirectory() as d:
+        with open(op.join(d, 'bad.txt'), 'w') as f:
+            f.write('abandonned 1\nabandonned 2\n')
+        with tempfile.NamedTemporaryFile('w') as f:
+            f.write('abandonned 1\n')
+            f.flush()
+            assert_equal(main(d), 2)
+            assert_equal(main('-x', f.name, d), 1)
+
+
+def test_encoding():
+    """Test encoding handling"""
+    # Some simple Unicode things
+    with tempfile.NamedTemporaryFile('wb') as f:
+        # with CaptureStdout() as sio:
+        assert_equal(main(f.name), 0)
+        f.write(u'naïve\n'.encode('utf-8'))
+        f.flush()
+        assert_equal(main(f.name), 0)
+        assert_equal(main('-e', f.name), 0)
+        f.write(u'naieve\n'.encode('utf-8'))
+        f.flush()
+        assert_equal(main(f.name), 1)
+    # Binary file warning
+    with tempfile.NamedTemporaryFile('wb') as f:
+        assert_equal(main(f.name), 0)
+        f.write(b'\x00\x00naiive\x00\x00')
+        f.flush()
+        with CaptureStdout() as sio:
+            assert_equal(main(f.name), 0)
+        assert_true('WARNING: Binary file' in sio[1])
+        with CaptureStdout() as sio:
+            assert_equal(main('-q', '2', f.name), 0)
+        assert_equal(sio[1], '')
 
 
 def test_ignore():
@@ -114,3 +263,35 @@ def _rmtree(self, path):
             self._rmdir(path)
         except OSError:
             pass
+
+
+@contextlib.contextmanager
+def CaptureStdout():
+    if sys.version[0] == '2':
+        from StringIO import StringIO
+    else:
+        from io import StringIO
+    oldout, olderr = sys.stdout, sys.stderr
+    try:
+        out = [StringIO(), StringIO()]
+        sys.stdout, sys.stderr = out
+        yield out
+    finally:
+        sys.stdout, sys.stderr = oldout, olderr
+        out[0] = out[0].getvalue()
+        out[1] = out[1].getvalue()
+
+
+@contextlib.contextmanager
+def FakeStdin(text):
+    if sys.version[0] == '2':
+        from StringIO import StringIO
+    else:
+        from io import StringIO
+    oldin = sys.stdin
+    try:
+        in_ = StringIO(text)
+        sys.stdin = in_
+        yield
+    finally:
+        sys.stdin = oldin

setup.cfg

@@ -2,7 +2,7 @@
 with-coverage = 1
 cover-package = codespell_lib
 detailed-errors = 1
-verbose = 3
+verbosity = 2
 
 [flake8]
 exclude = build