refs #21 -- moving things around

CHANGELOG.md

@@ -2,7 +2,8 @@
 
 ## master (unreleased)
 
-* Added a "language count" on the homepage (#43)
+* Added a "language count" on the homepage (#43).
+* Build a raw, but readable PDF for every language (#21).
 
 ## 2.3.0 (2016-09-16)
 

Makefile

@@ -6,7 +6,7 @@ help:
 	@echo ""
 
 html:
-	tox -e build
+	tox -e html
 
 clean:
 	rm -Rf build/

build.py → build_html.py

@@ -3,10 +3,10 @@
 
 This script is Public Domain.
 """
-from toolbox import Builder
+from toolbox.html import HTMLBuilder
 
 
 if __name__ == '__main__':
 
-    builder = Builder()
+    builder = HTMLBuilder()
     builder.build()

toolbox/__init__.py

@@ -1,256 +0,0 @@
-import shutil
-import os
-from string import Template
-from os.path import join, abspath, basename
-
-from cached_property import cached_property
-import markdown
-from markdown.extensions.toc import TocExtension
-from mdx_gfm import GithubFlavoredMarkdownExtension
-from shell import shell
-from slugify import slugify
-import yaml
-
-
-SOURCE_FILE_TEXT = '<p><a href="{source_file}">Link to {source_file_basename}</a></p>'  # noqa
-HTACCESS = """
-# Serving .md files as UTF-8.
-AddType 'text/plain; charset=UTF-8' md
-""".strip()
-DEFAULT_PAGE = {}
-
-
-class Builder(object):
-
-    exceptions = (
-        'build', 'static', 'templates', 'tests', 'toolbox',
-        # Warning: ignoring it to add it on the top position in the list
-        'english',
-    )
-
-    def __init__(self):
-        self.build_path = abspath('build')
-        self.languages = []
-        self.meta = {}
-
-    @cached_property
-    def static_path(self):
-        return join(self.build_path, 'static')
-
-    @cached_property
-    def version(self):
-        return shell('git describe --tags --abbrev=0').output(raw=True).strip()
-
-    @cached_property
-    def git_version(self):
-        return shell('git describe --tags').output(raw=True).strip()
-
-    @cached_property
-    def dir_list(self):
-        dir_list = [d for d in os.listdir('.') if d not in self.exceptions]
-        dir_list = filter(lambda x: os.path.isdir(x), dir_list)
-        dir_list = filter(lambda x: not x.startswith('.'), dir_list)
-        dir_list = ('english',) + tuple(dir_list)
-        return dir_list
-
-    def get_template(self, path):
-        "Transform a path into a template"
-        with open(path) as fd:
-            template_string = fd.read()
-        template = Template(template_string)
-        return template
-
-    def convert_md_source(self, source):
-        "Convert Markdown content into HTML"
-        html = markdown.markdown(
-            source,
-            extensions=[
-                GithubFlavoredMarkdownExtension(),
-                TocExtension(permalink=True, slugify=slugify)
-            ]
-        )
-        return html
-
-    def convert_md(self, filepath):
-        "Convert a Markdown file into HTML"
-        with open(filepath) as fd:
-            source = fd.read()
-        return self.convert_md_source(source)
-
-    def mkdir(self, path):
-        "Silent make directories"
-        if not os.path.isdir(path):
-            os.makedirs(path)
-
-    def write_html(self, target_filepath, body, title,
-                   prefix='', source_file=''):
-        "Write HTML page (body & title) in the target_filepath"
-        if source_file:
-            source_file_basename = basename(source_file)
-            source_file = SOURCE_FILE_TEXT.format(
-                source_file=source_file,
-                source_file_basename=source_file_basename
-            )
-        html = self.main_template.substitute(
-            body=body,
-            title=title,
-            static=prefix + 'static',
-            license=prefix + 'license.html',
-            version=self.version,
-            git_version=self.git_version,
-            source_file=source_file,
-        )
-        with open(target_filepath, 'w') as fd:
-            fd.write(html)
-
-    def get_page_title(self, directory):
-        "Extract page title form meta information"
-        if directory in self.meta:
-            meta = self.meta[directory]
-            if 'label' in meta:
-                return meta.get('label', None)
-
-    def page_update(self, language, page):
-        """
-        Update the page dict, to be shared by the individual pages & homepage.
-        """
-        page['language'] = language
-        if 'filename' not in page:
-            page['filename'] = 'the-black-hack.md'
-
-        basefile, _ = os.path.splitext(page['filename'])
-        if page['filename'] == 'the-black-hack.md':
-            page['target_filename'] = 'index'
-        else:
-            page['target_filename'] = basefile
-        page['raw_filename'] = basefile
-
-    def page_build(self, directory, page):
-        "Build individual page."
-        title = self.get_page_title(directory) or directory
-        source_filepath = join(directory, page['filename'])
-        body = self.convert_md(source_filepath)
-        target_dir = join(self.build_path, directory)
-        target_filename = page['target_filename']
-        self.mkdir(target_dir)
-        target_filepath = join(target_dir, '{}.html'.format(target_filename))
-        self.write_html(
-            target_filepath,
-            body=body,
-            title=title,
-            prefix="../",
-            source_file=page['filename'],
-        )
-        # Copy source to the target_dir
-        shutil.copyfile(source_filepath, join(target_dir, page['filename']))
-
-    def build_dir(self, directory):
-        "Build the directory"
-        mandatory_file = join(directory, 'the-black-hack.md')
-        if os.path.exists(mandatory_file):
-            self.languages.append(directory)
-            meta_language = self.meta.get(directory, {})
-            for page in meta_language.get('pages', [DEFAULT_PAGE]):
-                self.page_update(directory, page)
-                self.page_build(directory, page)
-
-    def update_meta(self, directory):
-        "Update meta information dictionary"
-        # Search for meta
-        filepath = join(directory, 'meta.yaml')
-        if os.path.exists(filepath):
-            with open(filepath) as fd:
-                content = fd.read()
-            self.meta[directory] = yaml.load(content)
-
-    def get_item_homepage(self, language, page):
-        label = page.get('label', page['raw_filename'])
-        if page['target_filename'] != 'index':
-            target = '{}.html'.format(page['target_filename'])
-        else:
-            target = ''
-        item = '* [{label}]({language}/{target})'.format(
-            label=label,
-            language=language,
-            target=target,
-        )
-
-        # Add optional author
-        author = page.get('author', None)
-        if author:
-            item = '{}, by {}'.format(item, author)
-
-        # Add optional version
-        version = page.get('version', None)
-        if version:
-            item = '{} (v{})'.format(item, version)
-
-        # Add link to source
-        item = '{item} ([source]({language}/{filename}))'.format(
-            item=item,
-            language=language,
-            filename=page['filename'],
-        )
-
-        return item
-
-    def build_homepage_text_list(self):
-        "Build the full text list for the homepage"
-        # Build text list
-        text_list = []
-        text_list.append('')
-        for language in self.languages:
-            label = language
-            meta_language = self.meta.get(language, {})
-            label = meta_language.get('label', label)
-            text_list.append('### {}'.format(label))
-            for page in meta_language.get('pages', [DEFAULT_PAGE]):
-                item = self.get_item_homepage(language, page)
-                text_list.append(item)
-
-        text_list.append('')
-        return text_list
-
-    def build_homepage(self):
-        "Build the Home page"
-        homepage_md = self.get_template('index.md')
-        text_list = self.build_homepage_text_list()
-        # Build generated body using text_list
-        body_md = homepage_md.substitute(
-            text_list='\n'.join(text_list),
-            language_count=len(self.languages),
-        )
-        body_html = self.convert_md_source(body_md)
-        # Build html page content
-        self.write_html(
-            join(self.build_path, 'index.html'),
-            body=body_html,
-            title="Home",
-        )
-
-    def build_license(self):
-        "Build License page"
-        license_html = self.convert_md('LICENSE')
-        self.write_html(
-            join(self.build_path, 'license.html'),
-            body=license_html,
-            title="Open Gaming License",
-        )
-
-    def build(self):
-        "Build main method"
-        self.mkdir(self.build_path)
-        if os.path.isdir(self.static_path):
-            shutil.rmtree(self.static_path)
-        shutil.copytree('static', self.static_path)
-        # Write an .htaccess file
-        with open(join(self.build_path, '.htaccess'), 'w') as fd:
-            fd.write(HTACCESS)
-
-        self.main_template = self.get_template(join('templates', 'base.html'))
-
-        for directory in self.dir_list:
-            self.update_meta(directory)
-            self.build_dir(directory)
-        self.build_homepage()
-        self.build_license()

toolbox/core.py

@@ -0,0 +1,85 @@
+import os
+from string import Template
+from os.path import join, abspath, basename
+
+from cached_property import cached_property
+from shell import shell
+import yaml
+
+
+SOURCE_FILE_TEXT = '<p><a href="{source_file}">Link to {source_file_basename}</a></p>'  # noqa
+
+
+class Builder(object):
+    exceptions = (
+        'build', 'static', 'templates', 'tests', 'toolbox',
+        # Warning: ignoring it to add it on the top position in the list
+        'english',
+    )
+
+    def __init__(self):
+        self.build_path = abspath('build')
+        self.languages = []
+        self.meta = {}
+
+    def mkdir(self, path):
+        "Silent make directories"
+        if not os.path.isdir(path):
+            os.makedirs(path)
+
+    @cached_property
+    def static_path(self):
+        return join(self.build_path, 'static')
+
+    @cached_property
+    def version(self):
+        return shell('git describe --tags --abbrev=0').output(raw=True).strip()
+
+    @cached_property
+    def git_version(self):
+        return shell('git describe --tags').output(raw=True).strip()
+
+    @cached_property
+    def dir_list(self):
+        dir_list = [d for d in os.listdir('.') if d not in self.exceptions]
+        dir_list = filter(lambda x: os.path.isdir(x), dir_list)
+        dir_list = filter(lambda x: not x.startswith('.'), dir_list)
+        dir_list = ('english',) + tuple(dir_list)
+        return dir_list
+
+    def get_template(self, path):
+        "Transform a path into a template"
+        with open(path) as fd:
+            template_string = fd.read()
+        template = Template(template_string)
+        return template
+
+    def update_meta(self, directory):
+        "Update meta information dictionary"
+        # Search for meta
+        filepath = join(directory, 'meta.yaml')
+        if os.path.exists(filepath):
+            with open(filepath) as fd:
+                content = fd.read()
+            self.meta[directory] = yaml.load(content)
+
+    def write_html(self, target_filepath, body, title,
+                   prefix='', source_file=''):
+        "Write HTML page (body & title) in the target_filepath"
+        if source_file:
+            source_file_basename = basename(source_file)
+            source_file = SOURCE_FILE_TEXT.format(
+                source_file=source_file,
+                source_file_basename=source_file_basename
+            )
+        html = self.main_template.substitute(
+            body=body,
+            title=title,
+            static=prefix + 'static',
+            license=prefix + 'license.html',
+            version=self.version,
+            git_version=self.git_version,
+            source_file=source_file,
+        )
+        with open(target_filepath, 'w') as fd:
+            fd.write(html)