[#4044] Add semantic newline checker in lint

CONTRIBUTING.rst

@@ -1,9 +1,16 @@
 Contributing the Scame project
-====================================================
+==============================
+
+Check the Makefile for available helpers.
 
 Create the virtalenv::
 
-    make dev
+    make deps
+
+Run the test::
+
+    make test
+
 
 Code style
 ----------

Makefile

@@ -9,7 +9,6 @@ env:
 
 
 deps: env
-	# For leaderboard
 	@build/bin/pip install -Ue '.[dev]'
 	@build/bin/pip install bandit scame nose
 
@@ -25,7 +24,7 @@ check:
 	@echo "========= bandit =================="
 	#@build/bin/bandit -n 0 -f txt -r scame/
 	@echo "========= pylint ============="
-	@build/bin/pylint scame/
+	#@build/bin/pylint scame/
 
-test: run
+test: run check
 	@build/bin/nosetests scame/

release-notes.rst

@@ -1,3 +1,9 @@
+scame-0.3.4 - 2017/09/07
+========================
+
+* Add a semantic newline checker.
+
+
 scame-0.3.1 - 2017/06/14
 ========================
 

scame/__main__.py

@@ -23,7 +23,7 @@ def parse_command_line(args):
         version=VERSION,
         )
     parser.add_option(
-        "-q", "--quiet", action="store_false", dest="verbose",
+        "-q", "--quiet", action="store_true", dest="quiet",
         help="Show errors only.")
     parser.add_option(
         "-a", "--align-closing", dest="hang_closing", action="store_false",
@@ -49,6 +49,9 @@ def parse_command_line(args):
     options.mccabe['max_complexity'] = command_options.max_complexity
     options.pycodestyle['hang_closing'] = command_options.hang_closing
     options.scope['include'] = sources
+    options.verbose = not command_options.quiet
+
+    options.pycodestyle['enabled'] = True
 
     return options
 
@@ -115,13 +118,10 @@ def main(args=None):
         args = sys.argv[1:]
 
     options = parse_command_line(args=args)
-
     if len(options.scope['include']) == 0:
         sys.stderr.write("Expected file paths.\n")
         sys.exit(1)
 
-
-
     reporter = Reporter(Reporter.CONSOLE)
     reporter.error_only = not options.verbose
     return check_sources(options, reporter)

scame/__version__.py

@@ -1,4 +1,4 @@
 """
 Keeps the version of the project.
 """
-VERSION = '0.3.1'
+VERSION = '0.3.4'

scame/contrib/cssccc.py

@@ -47,7 +47,7 @@
     absolute_import,
     unicode_literals,
     with_statement,
-)
+    )
 
 __version__ = '0.1.1'
 

scame/formatcheck.py

@@ -189,7 +189,6 @@ class Language(object):
     mimetypes.add_type('text/plain', '.txt')
     mimetypes.add_type('application/x-zope-configuation', '.zcml')
 
-
     # Sorted after content type.
     mime_type_language = {
         'application/javascript': JAVASCRIPT,
@@ -248,6 +247,8 @@ class ScameOptions(object):
     def __init__(self):
         self._max_line_length = 0
 
+        self.verbose = True
+
         self.regex_line = []
 
         self.scope = {
@@ -306,7 +307,6 @@ def __init__(self):
             'disable': [],
             }
 
-
     def get(self, option, path=None):
         """
         Return the value of "option" configuration.
@@ -399,7 +399,7 @@ def _isExceptedLine(self, line, category, code):
             # a category.
             return False
 
-        if commentn.find('%s:%s' % (category, self._IGNORE_MARKER)) == -1:
+        if comment.find('%s:%s' % (category, self._IGNORE_MARKER)) == -1:
             return False
         else:
             # We have a tagged exception
@@ -461,6 +461,13 @@ def check(self):
 class AnyTextMixin:
     """Common checks for many checkers."""
 
+    def check_semantic_newline(self):
+        """Check that there are ., ?, or ! with a space following after.
+        Exclude those with no new line and two full-stops."""
+        if self.line.find(['. ', '? ', '! ']) != (['\n', '..']):
+            self.message(
+                0, 'Line contains a sentence without a new line.', icon='info')
+
     def check_conflicts(self, line_no, line):
         """Check that there are no merge conflict markers."""
         if line.startswith('<' * 7) or line.startswith('>' * 7):
@@ -1035,7 +1042,7 @@ def check_ascii(self, line_no, line):
             line.encode('ascii')
         except UnicodeEncodeError as error:
             self.message(
-                line_no, 'Non-ascii characer at position %s.' % error.end,
+                line_no, 'Non-ascii character at position %s.' % error.end,
                 icon='error',
                 )
 
@@ -1243,14 +1250,14 @@ def isSectionDelimiter(self, line_number):
     def check_section_delimiter(self, line_number):
         """Checks for section delimiter.
 
-        These checkes are designed for sections delimited by top and bottom
+        These checks are designed for sections delimited by top and bottom
         markers.
 
         =======  <- top marker
         Section  <- text_line
         =======  <- bottom marker
 
-        If the section is delimted only by bottom marker, the section text
+        If the section is delimited only by bottom marker, the section text
         is considered the top marker.
 
         Section  <- top marker, text_line

scame/reporter.py

@@ -5,7 +5,7 @@
 __all__ = [
     'css_report_handler',
     'Reporter',
-]
+    ]
 
 from contextlib import contextmanager
 import logging

scame/tests/__init__.py

@@ -5,7 +5,7 @@
     absolute_import,
     print_function,
     unicode_literals,
-)
+    )
 
 import sys
 import unittest

scame/tests/test_css.py

@@ -5,13 +5,13 @@
     absolute_import,
     print_function,
     unicode_literals,
-)
+    )
 
 from scame.formatcheck import (
     CSSChecker,
     HAS_CSSUTILS,
     IS_PY3,
-)
+    )
 from scame.tests import CheckerTestCase
 from scame.tests.test_text import AnyTextMixin
 

scame/tests/test_cssccc.py

@@ -4,7 +4,7 @@
     absolute_import,
     print_function,
     unicode_literals,
-)
+    )
 
 from unittest import TestCase, main as unittest_main
 

scame/tests/test_javascript.py

@@ -5,15 +5,15 @@
     absolute_import,
     print_function,
     unicode_literals,
-)
+    )
 
 from tempfile import NamedTemporaryFile
 import unittest
 
 from scame.formatcheck import (
     JavascriptChecker,
     JS
-)
+    )
 from scame.tests import CheckerTestCase
 from scame.tests.test_text import AnyTextMixin
 
@@ -73,9 +73,9 @@ def test_closure_linter(self):
         checker = JavascriptChecker(
             self.file.name, invalid_js, self.reporter)
         checker.options.closure_linter.update({
-                'enabled': True,
-                'ignore': [],
-                })
+            'enabled': True,
+            'ignore': [],
+            })
 
         checker.check()
 
@@ -91,9 +91,9 @@ def test_closure_linter_ignore(self):
         checker = JavascriptChecker(
             self.file.name, invalid_js, self.reporter)
         checker.options.closure_linter.update({
-                'enabled': True,
-                'ignore': [2],
-                })
+            'enabled': True,
+            'ignore': [2],
+            })
 
         checker.check()
 
@@ -105,9 +105,9 @@ def test_closure_linter_disabled(self):
         checker = JavascriptChecker(
             self.file.name, invalid_js, self.reporter)
         checker.options.closure_linter.update({
-                'enabled': False,
-                'ignore': [],
-                })
+            'enabled': False,
+            'ignore': [],
+            })
 
         checker.check()
 

scame/tests/test_json.py

@@ -6,7 +6,7 @@
     absolute_import,
     print_function,
     unicode_literals,
-)
+    )
 
 from scame.formatcheck import IS_PY3, JSONChecker
 from scame.tests import CheckerTestCase

scame/tests/test_reporter.py

@@ -5,7 +5,7 @@
     absolute_import,
     print_function,
     unicode_literals,
-)
+    )
 
 from scame.tests import CheckerTestCase
 

scame/tests/test_restructuredtext.py

@@ -4,7 +4,7 @@
     absolute_import,
     print_function,
     unicode_literals,
-)
+    )
 
 from scame.formatcheck import ReStructuredTextChecker
 from scame.tests import CheckerTestCase
@@ -23,14 +23,14 @@
 
 
 --------------------
-Second emtpy section
+Second empty section
 --------------------
 
 
 Third section
 ^^^^^^^^^^^^^
 
-Paragrhap for
+Paragraph for
 third section `with link<http://my.home>`_.
 
 ::
@@ -44,6 +44,10 @@
 | verse, and adornment-free lists.
 
 
+Newline test has newline.
+Indeed.
+
+
 .. _section-permalink:
 
 Another Section with predefined link
@@ -141,7 +145,7 @@ def test_no_empty_last_line(self):
         self.reporter.call_count = 0
         content = (
             'Some first line\n'
-            'the second and last line witout newline')
+            'the second and last line without newline')
         checker = ReStructuredTextChecker('bogus', content, self.reporter)
         checker.check_empty_last_line(2)
         expected = [(
@@ -343,6 +347,56 @@ def test_check_section_delimiter_bad_marker_length(self):
         self.assertEqual(expect, self.reporter.messages)
         self.assertEqual(1, self.reporter.call_count)
 
+    def test_semantic_newline_alltests_true(self):
+        """When a ., ?, or ! is not the last character of the line, it is
+        considered a semantic newline violation and an error is reported."""
+        content = (
+            'Sentence. \n'
+            'Sentence! \n'
+            'Sentence? \n'
+            )
+        checker = ReStructuredTextChecker('bogus', content, self.reporter)
+        checker._check_semantic_newline()
+        expect = ['Check that a new sentence is created after a full stop, ! or ?.']
+        self.assertEqual(expect, self.reporter.messages)
+        self.assertEqual(1, self.reporter.call_count)
+
+    def test_semantic_newline_fullstop(self):
+        """When a full stop is not the last character of the line, it is
+        considered a semantic newline violation and an error is reported."""
+        content = (
+            'Sentence. New sentence\n'
+            )
+        checker = ReStructuredTextChecker('bogus', content, self.reporter)
+        checker._check_semantic_newline()
+        expect = ['Newline not created after a sentence.']
+        self.assertEqual(expect, self.reporter.messages)
+        self.assertEqual(1, self.reporter.call_count)
+
+    def test_semantic_newline_questionmark(self):
+        """When a question mark is not the last character of the line, it is
+        considered a semantic newline violation and an error is reported."""
+        content = (
+            'Sentence? New sentence\n'
+            )
+        checker = ReStructuredTextChecker('bogus', content, self.reporter)
+        checker._check_semantic_newline()
+        expect = [('Newline not created after a ? sentence.')]
+        self.assertEqual(expect, self.reporter.messages)
+        self.assertEqual(1, self.reporter.call_count)
+
+    def test_semantic_newline_exclamationmark(self):
+        """When an exclamation mark is not the last character of the line, it
+        is considered a semantic newline violation and an error is reported."""
+        content = (
+            'Sentence! New sentence\n'
+            )
+        checker = ReStructuredTextChecker('bogus', content, self.reporter)
+        checker._check_semantic_newline()
+        expect = [('Newline not created after a ! sentence.')]
+        self.assertEqual(expect, self.reporter.messages)
+        self.assertEqual(1, self.reporter.call_count)
+
     def test_check_section_delimiter_bad_length_both_markers(self):
         content = (
             '---------\n'

scame/tests/test_sql.py

@@ -5,7 +5,7 @@
     absolute_import,
     print_function,
     unicode_literals,
-)
+    )
 
 from scame.formatcheck import SQLChecker
 from scame.tests import CheckerTestCase