multiple renderers now possible

Author: holgi

development.ini

@@ -19,7 +19,6 @@ pyramid.includes =
 # debugtoolbar.hosts = 127.0.0.1 ::1
 
 pyragit.repository_path = %(here)s
-pyragit.markdown_extension = .md
 
 ###
 # wsgi server configuration

pyragit/__init__.py

@@ -13,7 +13,7 @@ def main(global_config, **settings):
     config = Configurator(settings=settings)
     config.include('pyramid_jinja2')
     config.include('pyragit.resources')
-    config.include('pyragit.markdown')
+    config.include('pyragit.markup')
     config.add_static_view('static', 'static', cache_max_age=3600)
     config.scan()
 

pyragit/markdown.py

@@ -0,0 +1,41 @@
+''' setup of the markup renderers '''
+
+import mistune
+import re
+
+from mistune_contrib import highlight
+
+
+class HighlightRenderer(highlight.HighlightMixin, mistune.Renderer):
+    ''' Markdown renderer with syntax highlighting'''
+    pass
+
+
+def render_text(content):
+    ''' a simple renderer for text documents: replace new lines with <br> '''
+    return '<br>'.join(content.splitlines())
+
+
+def includeme(config):
+    '''
+    configures the rendering engines and attaches them to the request
+
+    Activate this setup using ``config.include('pyragit.markdown')``.
+    '''
+    md_renderer = HighlightRenderer(inlinestyles=False, linenos=False)
+    render_markdown = mistune.Markdown(renderer=md_renderer)
+    
+    renderer_dict = {
+        '.md': render_markdown,
+        '.txt': render_text
+    }
+
+    def get_markup_renderer(filename):
+        name, dot, ext = filename.rpartition('.')
+        complete_extension = dot + ext
+        return renderer_dict.get(complete_extension, None)
+        
+    config.add_request_method(
+        lambda request, filename: get_markup_renderer(filename),
+        'get_markup_renderer'
+        )

pyragit/markup.py

@@ -2,6 +2,7 @@
 
 
 import pygit2
+import functools
 
 from datetime import datetime
 from pathlib import Path
@@ -11,41 +12,35 @@
 class BaseResource:
     ''' base class for all resources '''
 
-    def __init__(self, name, parent, tree_entry, request):
-        self.__name__ = name
+    def __init__(self, tree_entry, parent):
+        self.__name__ = tree_entry.name
         self.__parent__ = parent
         self.pygit2_tree_entry = tree_entry
-        self.request = request
-        self._pygit2_object = None
-        self._last_commit = None
+        self.request = parent.request
 
     @property
+    @functools.lru_cache(maxsize=128)
     def pygit2_object(self):
         ''' lazy loading of the pygit2 object '''
-        if self._pygit2_object is None:
-            oid = self.pygit2_tree_entry.oid
-            self._pygit2_object = self.request.repository[oid]
-        return self._pygit2_object
+        oid = self.pygit2_tree_entry.oid
+        return self.request.repository[oid]
 
     @property
     def type(self):
         ''' returns the type of the resource, either 'tree' or 'blob' '''
-        if self.__name__ is None:
-            # Root has no name, but is a Folder
-            return 'tree'
-        return self.pygit2_tree_entry.type
+        # Root has no tree entry, but is a Folder
+        return 'tree' if self.__name__ is None else self.pygit2_tree_entry.type
 
     @property
+    @functools.lru_cache(maxsize=128)
     def last_commit(self):
         ''' get the last commit of the resource 
         
         from https://stackoverflow.com/questions/13293052/pygit2-blob-history
-        '''
-        if self._last_commit:
-            return self._last_commit
-            
+        ''' 
         # loops through all the commits
         last_oid = None
+        last_commit = None
         repo = self.request.repository
         for commit in repo.walk(repo.head.target, pygit2.GIT_SORT_TIME):
 
@@ -56,14 +51,14 @@ def last_commit(self):
                 oid = self.pygit2_tree_entry.oid
                 has_changed = (oid != last_oid and last_oid)
                 if has_changed:
-                    return self._last_commit                
+                    return last_commit
                 last_oid = oid
             else:
                 last_oid = None
 
-            self._last_commit = commit
+            last_commit = commit
 
-        return self._last_commit
+        return last_commit
 
     @property
     def author(self):
@@ -77,41 +72,39 @@ def date(self):
 class Folder(BaseResource):
     ''' Resource representing a git tree (like a folder in a file system) '''
 
+    @property
+    @functools.lru_cache(maxsize=128)
+    def index(self):
+        ''' get the markup index file of the folder or None '''
+        blobs = (e for e in self.pygit2_object if e.type=='blob')
+        index_files = (e for e in blobs if e.name.lower().startswith('index.'))
+        for entry in index_files:
+            renderer = self.request.get_markup_renderer(entry.name)
+            if renderer:
+                return Markup(entry, self, renderer)
+        return None
+    
     def __getitem__(self, key):
         ''' Dict like access to child resources '''
 
         # hidden files (starting with a dot) are forbidden to access
         if key.startswith('.'):
             raise KeyError
 
-        # try to directly access a tree entry, 
-        # only blob (binary file) and trees (folders) are allowed
-        try:
-            tree_entry = self.pygit2_object[key]
-            if tree_entry.type == 'blob':
-                return File(key, self, tree_entry, self.request)
-            elif tree_entry.type == 'tree':
-                return Folder(key, self, tree_entry, self.request)
-        except KeyError:
-            pass
+        tree_entry = self.pygit2_object[key]
+        if tree_entry.type == 'tree':
+            return Folder(tree_entry, self)
+            
+        if tree_entry.type != 'blob':
+            # non file entry, might be a git note object
+            # or something else
+            raise KeyError
 
-        # look for a text-file, that should be rendered
-        markdown = self._search_markdown_file(key)
-        if markdown:
-            return markdown         
-       
-        # nothing found, raise Error
-        raise KeyError
-    
-    def _search_markdown_file(self, name):
-        ''' look for a  markdown file '''
-        markdown_file = name + self.request.markdown_extension
-        blobs = (e for e in self.pygit2_object if e.type=='blob')
-        for entry in blobs:
-            if entry.name.lower() == markdown_file.lower():
-                return Markdown(name, self, entry, self.request)
-        return None
-    
+        renderer = self.request.get_markup_renderer(key)
+        if renderer is None:
+            return File(tree_entry, self)    
+        else:
+            return Markup(tree_entry, self, renderer)
 
     def __iter__(self):
         ''' iterate over renderable child resources '''
@@ -121,30 +114,38 @@ def __iter__(self):
         # first list the folders
         trees = (e for e in ordered if e.type=='tree')
         for entry in trees:
-            yield Folder(entry.name, self, entry, self.request)
-        # then list the markdown files
-        md_ext = self.request.markdown_extension
+            yield Folder(entry, self)
+        # then list the markup files
         blobs = (e for e in ordered if e.type=='blob')
-        texts = (e for e in blobs if e.name.endswith(md_ext))
-        for entry in texts:
-            name = entry.name[:-len(md_ext)]
-            if name != 'index':
-                yield Markdown(name, self, entry, self.request)                
-    
-    @property
-    def index(self):
-        ''' get the markdown index file of the folder or None '''
-        return self._search_markdown_file('index')
+        # except the index file used
+        index_name = self.index.__name__ if self.index else None
+        non_index = (e for e in blobs if e.name != index_name)
+        for entry in non_index:
+            renderer = self.request.get_markup_renderer(entry.name)
+            if renderer:
+                yield Markup(entry, self, renderer)
 
 
 class Root(Folder):
     ''' the root resource for traversal '''
 
     def __init__(self, request):
-        super().__init__(None, None, None, request)        
-        head = request.repository.head
-        self._last_commit = head.peel()
-        self._pygit2_object = self._last_commit.tree
+        self.__name__ = None
+        self.__parent__ = None
+        self.request = request   
+    
+    @property
+    def pygit2_object(self):
+        ''' lazy loading of the pygit2 object not required on root resource'''
+        return self.last_commit.tree
+        
+    @property
+    def last_commit(self):
+        ''' get the last commit of the resource 
+        
+        On the root resource, this is only a simple lookup
+        ''' 
+        return self.request.repository.head.peel()
 
 
 class File(BaseResource):
@@ -161,13 +162,21 @@ def size(self):
         return self.pygit2_object.size
 
 
-class Markdown(BaseResource):
-    ''' Resource for a Markdown file that could be rendered '''
+class Markup(BaseResource):
+    ''' Resource for a markup file that could be rendered '''
+    
+    def __init__(self, tree_entry, parent, rendering_func):
+        super().__init__(tree_entry, parent)
+        self.renderer = rendering_func
 
     @property
     def text(self):
         ''' access the text content of the file '''
         return self.pygit2_object.data.decode('utf-8')
+        
+    def render(self):
+        ''' returned the rendered representation of the markup file'''
+        return self.renderer(self.text)
 
 
 
@@ -191,16 +200,5 @@ def includeme(config):
         reify=True
         )
 
-    markdown_extension = settings.get('pyragit.markdown_extension', None)
-    if markdown_extension is None:
-        raise ConfigurationError('Markdown Extension not set')
-
-    # make request.markdown_extension available for use in Pyramid
-    config.add_request_method(
-        lambda r: markdown_extension,
-        'markdown_extension',
-        reify=True
-        )
-
     # set the root factory for traverssal
     config.set_root_factory(Root)

pyragit/resources.py

@@ -2,7 +2,7 @@
 
 {% block text %}
     {% if context.index %}
-        {{ request.render_markdown(context.index.text)|safe }}
+        {{ context.index.render()|safe }}
     {% else %}
         <h1> Crivens ! </h1>
         <p>

pyragit/templates/folder.jinja2

@@ -10,17 +10,10 @@
         {% endif %}
         {% for resource in folder %}
             <li class="nav-item">
-                {% if resource.__name__ == context.__name__ %}
-                    <a class="nav-link active" href="{{request.resource_path(resource)}}">
-                        <span class="pyragit-resource-type">&gt;</span>
-                        {{resource.__name__}}
-                    </a>
-                {% else %}
-                    <a class="nav-link" href="{{request.resource_path(resource)}}">
-                        <span class="pyragit-resource-type">{{'d' if resource.type == 'tree' else 'f'}}</span>
-                        {{resource.__name__}}{{'/' if resource.type == 'tree'}}
-                    </a>
-                {% endif %}
+                <a class="nav-link" href="{{request.resource_path(resource)}}">
+                <span class="pyragit-resource-type">{% if resource.__name__ == context.__name__ %}&gt;{% elif resource.type == 'tree'%}d{% else %}f{% endif %}</span>
+                {{resource.__name__}}{{'/' if resource.type == 'tree'}}
+                </a>
             </li>
         {% endfor %}
     </ul>

pyragit/templates/layout.jinja2

@@ -1,7 +1,7 @@
 {% extends "layout.jinja2" %}
 
 {% block text %}
-    {{ request.render_markdown(context.text)|safe }}
+    {{ context.render()|safe }}
 {% endblock text %}
 
 {% block explore %}

pyragit/templates/markdown.jinja2 renamed to pyragit/templates/markup.jinja2

@@ -17,11 +17,11 @@ def folder(context, request):
 
 
 @view_config(
-    context='pyragit.resources.Markdown', 
-    renderer='templates/markdown.jinja2'
+    context='pyragit.resources.Markup', 
+    renderer='templates/markup.jinja2'
     )
 def markdown(context, request):
-    ''' renders a Markdown context '''
+    ''' renders a markup context '''
     return { }