logo

cljws filter

← Back to Filter List

cljws


Parse clojure code into sections based on whitespace and try to guess a useful name for each section by looking for def, defn, deftest or a comment.

Aliases for this filter

  • cljws

Converts from file formats:

  • .*

To file formats:

  • .*

Available settings:

SettingDescriptionDefault
add-new-filesBoolean or list of extensions/patterns to match.False
added-in-versionDexy version when this filter was first available.1.0.1
additional-doc-filtersFilters to apply to additional documents created as side effects.{}
additional-doc-settingsSettings to apply to additional documents created as side effects.{}
data-typeAlias of custom data class to use to store filter output.sectioned
examplesTemplates which should be used as examples for this filter.[]
exclude-add-new-filesList of patterns to skip even if they match add-new-files.[]
exclude-new-files-from-dirList of directories to skip when adding new files.[]
extFile extension to output.None
extension-mapDictionary mapping input extensions to default output extensions.None
helpHelpstring for plugin.Parse clojure code into sections based on whitespace and try to guess a useful name for each section by looking for def, defn, deftest or a comment.
input-extensionsList of extensions which this filter can accept as input.['.*']
keep-originalsWhether, if additional-doc-filters are specified, the original unmodified docs should also be added.False
mkdirA directory which should be created in working dir.None
mkdirsA list of directories which should be created in working dir.[]
name-regexList of regular expressions including a match group representing the name of the section. Will be tried in order.['\\(def ([a-z\\-\\?]+)', '\\(defn ([a-z\\-\\?]+)', '\\(defn- ([a-z\\-\\?]+)', '\\(defn= ([a-z\\-\\?]+)', '\\(deftest ([a-z\\-\\?]+)']
nodocWhether filter should be excluded from documentation.False
outputWhether to output results of this filter by default by reporters such as 'output' or 'website'.False
output-extensionsList of extensions which this filter can produce as output.['.*']
override-workspace-exclude-filtersIf True, document will be populated to other workspaces ignoring workspace-exclude-filters.False
preserve-prior-data-classWhether output data class should be set to match the input data class.False
require-outputShould dexy raise an exception if no output is produced by this filter?True
tagsTags which describe the filter.[]
variablesA dictionary of variable names and values to make available to this filter.{}
varsA dictionary of variable names and values to make available to this filter.{}
workspace-exclude-filtersFilters whose output should be excluded from workspace.['pyg']
workspace-includesIf set to a list of filenames or extensions, only these will be populated to working dir.None
Filter Source Code
class ClojureWhitespaceFilter(DexyFilter):
    """
    Parse clojure code into sections based on whitespace and try to guess a
    useful name for each section by looking for def, defn, deftest or a
    comment.
    """
    aliases = ['cljws']
    _settings = {
            'added-in-version' : '1.0.1',
            'data-type' : 'sectioned',
            'name-regex' : (
                """List of regular expressions including a match group
                representing the name of the section. Will be tried in
                order.""",
                [
                    "\(def ([a-z\-\?]+)",
                    "\(defn ([a-z\-\?]+)",
                    "\(defn- ([a-z\-\?]+)",
                    "\(defn= ([a-z\-\?]+)",
                    "\(deftest ([a-z\-\?]+)",
                ])
            }

    def process(self):
        input_text = str(self.input_data)
        for i, section in enumerate(input_text.split("\n\n")):
            section_name = self.parse_section_name(section)
            if section_name:
                self.output_data[section_name] = section
            else:
                self.output_data["%s" % (i+1)] = section

        self.output_data.save()

    def parse_section_name(self, section_text):
        """
        Parse a section name out of the section text.
        """
        if not section_text:
            return

        for line in section_text.splitlines():
            firstline = line
            if not line.strip().startswith(';'):
                break

        for regex in self.setting('name-regex'):
            m = re.match(regex, firstline)
            if m:
                return m.groups()[0]

Content © 2020 Dr. Ana Nelson | Site Design © Copyright 2011 Andre Gagnon | All Rights Reserved.