Skip to content

[#4044] Add semantic newline checker in lint #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
hcs0 wants to merge 10 commits into
base: master
Choose a base branch
from
Open

[#4044] Add semantic newline checker in lint #7

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
797ac80
Initial commit with new tests based on feedback
Aug 23, 2017
24c7424
Fix docstrings
Aug 23, 2017
fd6e712
Some cleanups.
adiroiban Aug 31, 2017
133044a
Add version details
Sep 7, 2017
a903fe4
Add test to encompass all
Sep 7, 2017
031b4ad
Update release versions
Sep 7, 2017
75252ec
Refactor regex semantic line checker.
adiroiban Sep 12, 2017
cd9554a
Fix own code to pass newline rst checker.
adiroiban Sep 12, 2017
4a3f949
Fix other tests.
adiroiban Sep 12, 2017
3fad50a
Merge branch 'master' into 4044-semantic-newline-checker
Nov 1, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions release-notes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
scame-0.3.4 - 2017/09/07
========================

* Add a semantic newline checker.


scame-0.3.1 - 2017/06/14
========================

Expand Down
2 changes: 1 addition & 1 deletion scame/__version__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""
Keeps the version of the project.
"""
VERSION = '0.3.1'
VERSION = '0.3.4'

@adiroiban adiroiban Sep 7, 2017

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that this should be 0.4.0 as is add a new feature... 0.3.X is for bugfixes

59 changes: 17 additions & 42 deletions scame/tests/test_restructuredtext.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,6 @@
| verse, and adornment-free lists.


Newline test! No newline.
Newline test? No newline.
Newline test. No newline.
Newline test has newline.
Indeed.

Expand Down Expand Up @@ -350,29 +347,31 @@ 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_fullstop(self):
"""When a full stop is not the last character of the line, it is
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. New sentence\n'
'Sentence. \n'

@adiroiban adiroiban Sep 12, 2017

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this test is wrong...as it will trigger the "trailing newspaces" checker

'Sentence! \n'
'Sentence? \n'
)
checker = ReStructuredTextChecker('bogus', content, self.reporter)
checker.check_semantic_newline()
expect = ['Newline not created after a sentence.']
checker._check_semantic_newline()

@adiroiban adiroiban Sep 12, 2017

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why the call with underline?

expect = ['Check that a new sentence is created after a full stop, ! or ?.']

@adiroiban adiroiban Sep 12, 2017

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the expected value is wrong. it should repot a tuple of line number and error message

self.assertEqual(expect, self.reporter.messages)
self.assertEqual(1, self.reporter.call_count)

def test_semantic_newline_fullstop_true(self):
"""When a full stop is the last character from the line and follows the
semantic newline rule, an error is not reported."""
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. \n'
'New sentence.'
'Sentence. New sentence\n'
)
checker = ReStructuredTextChecker('bogus', content, self.reporter)
checker.check_semantic_newline()
self.assertEqual([], self.reporter.messages)
self.assertEqual(0, self.reporter.call_count)
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
Expand All @@ -381,47 +380,23 @@ def test_semantic_newline_questionmark(self):
'Sentence? New sentence\n'
)
checker = ReStructuredTextChecker('bogus', content, self.reporter)
checker.check_semantic_newline()
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_true(self):
"""When a question mark is the last character from the line and follows
semantic newline rule, an error is not reported."""
content = (
'Sentence? \n'
'New sentence\n'
)
checker = ReStructuredTextChecker('bogus', content, self.reporter)
checker.check_semantic_newline()
self.assertEqual([], self.reporter.messages)
self.assertEqual(0, 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()
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_true(self):
"""When an exclamation mark is the last character from the line and
follows the semantic newline rule, an error is not reported."""
content = (
'Sentence! \n'
'New sentence\n'
)
checker = ReStructuredTextChecker('bogus', content, self.reporter)
checker.check_semantic_newline()
self.assertEqual([], self.reporter.messages)
self.assertEqual(0, self.reporter.call_count)

def test_check_section_delimiter_bad_length_both_markers(self):
content = (
'---------\n'
Expand Down