Skip to content

Commit

Permalink
Making line-length checking optional for lessons.
Browse files Browse the repository at this point in the history 
1.  Modify `read_markdown` to return list of (index, line, line_length).
2.  Modify `lesson_check.py` to make line-length checking optional.
  • Loading branch information
Greg Wilson committed Jun 22, 2016
1 parent a733e2a commit 2a53ed7
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 23 deletions.
46 changes: 25 additions & 21 deletions bin/lesson_check.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,10 @@ def parse_args():
"""Parse command-line arguments."""

parser = OptionParser()
parser.add_option('-l', '--linelen',
default=False,
dest='line_len',
help='Check line lengths')
parser.add_option('-p', '--parser',
default=None,
dest='parser',
Expand Down Expand Up @@ -127,7 +131,9 @@ def check_config(args):


def read_all_markdown(args, source_dir):
"""Read source files, returning {path : {'metadta':yaml, 'text':text, 'doc':doc}}."""
"""Read source files, returning
{path : {'metadata':yaml, 'metadata_len':N, 'text':text, 'lines':[(i, line, len)], 'doc':doc}}
"""

all_dirs = [os.path.join(source_dir, d) for d in SOURCE_DIRS]
all_patterns = [os.path.join(d, '*.md') for d in all_dirs]
Expand Down Expand Up @@ -192,7 +198,7 @@ def require(condition, message):
class CheckBase(object):
"""Base class for checking Markdown files."""

def __init__(self, args, filename, metadata, metadata_len, text, doc):
def __init__(self, args, filename, metadata, metadata_len, text, lines, doc):
"""Cache arguments for checking."""

super(CheckBase, self).__init__()
Expand All @@ -202,6 +208,7 @@ def __init__(self, args, filename, metadata, metadata_len, text, doc):
self.metadata = metadata
self.metadata_len = metadata_len
self.text = text
self.lines = lines
self.doc = doc

self.layout = None
Expand Down Expand Up @@ -230,15 +237,12 @@ def check_metadata(self):
def check_text(self):
"""Check the raw text of the lesson body."""

offset = 0
if self.metadata_len is not None:
offset = self.metadata_len
lines = [(offset+i+1, l, len(l)) for (i, l) in enumerate(self.text.split('\n'))]
over = [i for (i, l, n) in lines if (n > MAX_LINE_LEN) and (not l.startswith('!'))]
self.reporter.check(not over,
self.filename,
'Line(s) are too long: {0}',
', '.join([str(i) for i in over]))
if self.args.line_len:
over = [i for (i, l, n) in self.lines if (n > MAX_LINE_LEN) and (not l.startswith('!'))]
self.reporter.check(not over,
self.filename,
'Line(s) are too long: {0}',
', '.join([str(i) for i in over]))


def check_blockquote_classes(self):
Expand Down Expand Up @@ -315,8 +319,8 @@ def get_loc(self, node):
class CheckNonJekyll(CheckBase):
"""Check a file that isn't translated by Jekyll."""

def __init__(self, args, filename, metadata, metadata_len, text, doc):
super(CheckNonJekyll, self).__init__(args, filename, metadata, metadata_len, text, doc)
def __init__(self, args, filename, metadata, metadata_len, text, lines, doc):
super(CheckNonJekyll, self).__init__(args, filename, metadata, metadata_len, text, lines, doc)


def check_metadata(self):
Expand All @@ -328,16 +332,16 @@ def check_metadata(self):
class CheckIndex(CheckBase):
"""Check the main index page."""

def __init__(self, args, filename, metadata, metadata_len, text, doc):
super(CheckIndex, self).__init__(args, filename, metadata, metadata_len, text, doc)
def __init__(self, args, filename, metadata, metadata_len, text, lines, doc):
super(CheckIndex, self).__init__(args, filename, metadata, metadata_len, text, lines, doc)
self.layout = 'lesson'


class CheckEpisode(CheckBase):
"""Check an episode page."""

def __init__(self, args, filename, metadata, metadata_len, text, doc):
super(CheckEpisode, self).__init__(args, filename, metadata, metadata_len, text, doc)
def __init__(self, args, filename, metadata, metadata_len, text, lines, doc):
super(CheckEpisode, self).__init__(args, filename, metadata, metadata_len, text, lines, doc)

def check_metadata(self):
super(CheckEpisode, self).check_metadata()
Expand All @@ -352,16 +356,16 @@ def check_metadata(self):
class CheckReference(CheckBase):
"""Check the reference page."""

def __init__(self, args, filename, metadata, metadata_len, text, doc):
super(CheckReference, self).__init__(args, filename, metadata, metadata_len, text, doc)
def __init__(self, args, filename, metadata, metadata_len, text, lines, doc):
super(CheckReference, self).__init__(args, filename, metadata, metadata_len, text, lines, doc)
self.layout = 'reference'


class CheckGeneric(CheckBase):
"""Check a generic page."""

def __init__(self, args, filename, metadata, metadata_len, text, doc):
super(CheckGeneric, self).__init__(args, filename, metadata, metadata_len, text, doc)
def __init__(self, args, filename, metadata, metadata_len, text, lines, doc):
super(CheckGeneric, self).__init__(args, filename, metadata, metadata_len, text, lines, doc)
self.layout = 'page'


Expand Down
13 changes: 11 additions & 2 deletions bin/util.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,10 @@ def report(self, stream=sys.stdout):


def read_markdown(parser, path):
"""Get YAML and AST for Markdown file, returning {'metadata':yaml, 'text': text, 'doc':doc}."""
"""
Get YAML and AST for Markdown file, returning
{'metadata':yaml, 'metadata_len':N, 'text':text, 'lines':[(i, line, len)], 'doc':doc}.
"""

# Split and extract YAML (if present).
metadata = None
Expand All @@ -68,10 +71,15 @@ def read_markdown(parser, path):
try:
metadata = yaml.load(pieces[1])
except yaml.YAMLError as e:
raise ValueError('Unable to parse YAML header in {0}:\n{1}'.format(path, e))
print('Unable to parse YAML header in {0}:\n{1}'.format(path, e))
sys.exit(1)
metadata_len = pieces[1].count('\n')
body = pieces[2]

# Split into lines.
offset = 0 if metadata_len is None else metadata_len
lines = [(offset+i+1, l, len(l)) for (i, l) in enumerate(body.split('\n'))]

# Parse Markdown.
cmd = 'ruby {0}'.format(parser)
p = Popen(cmd, shell=True, stdin=PIPE, stdout=PIPE, close_fds=True, universal_newlines=True)
Expand All @@ -82,5 +90,6 @@ def read_markdown(parser, path):
'metadata': metadata,
'metadata_len': metadata_len,
'text': body,
'lines': lines,
'doc': doc
}

0 comments on commit 2a53ed7

Please sign in to comment.