diff options
| author | Jesús <heckyel@hyperbola.info> | 2019-02-13 19:26:38 -0500 |
|---|---|---|
| committer | Jesús <heckyel@hyperbola.info> | 2019-02-13 19:26:38 -0500 |
| commit | 9bbe38df58720ec5a3c7684dd221c0f74d18a3c7 (patch) | |
| tree | 7e5d89e42dcd32a0501657c46bab45612adf81e4 /plugins/pelican-js/custom_js.py | |
| download | cl-9bbe38df58720ec5a3c7684dd221c0f74d18a3c7.tar.lz cl-9bbe38df58720ec5a3c7684dd221c0f74d18a3c7.tar.xz cl-9bbe38df58720ec5a3c7684dd221c0f74d18a3c7.zip | |
first commit
Diffstat (limited to 'plugins/pelican-js/custom_js.py')
| -rw-r--r-- | plugins/pelican-js/custom_js.py | 113 |
1 files changed, 113 insertions, 0 deletions
diff --git a/plugins/pelican-js/custom_js.py b/plugins/pelican-js/custom_js.py new file mode 100644 index 0000000..7ebeed9 --- /dev/null +++ b/plugins/pelican-js/custom_js.py @@ -0,0 +1,113 @@ +#!/usr/bin/env python3 +# pelican-js: embed custom JavaScript easily +# Copyright (C) 2017 Jorge Maldonado Ventura + +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. + +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. + +# You should have received a copy of the GNU General Public License +# along with this program. If not, see <http://www.gnu.org/licenses/>. + +""" +Embed JavaScript files for Pelican +================================== + +This plugin allows you to easily embed JavaScript files in the header (<head>) +or in the body (<body>) of individual articles or pages. The JavaScript files +are embedded using the <script> tag. +""" + +import os +import re +import shutil + +from pelican import signals + + +def format_js(gen, metastring, formatter): + """ + Create a list of URL-formatted script tags + Parameters + ---------- + gen: generator + Pelican Generator + metastring: string + metadata['js'] + formatter: string + String format for output. + Output + ------ + List of formatted strings + """ + metalist = metastring.replace(' ', '').split(',') + site_url = '%s' + position_regex = re.compile('(\(\w+\)$)') + + formatted_strings = [] + for i in range(len(metalist)): + pos = position_regex.search(metalist[i]).group() + format_string = formatter.format(site_url, metalist[i][:-len(pos)], pos) + formatted_strings.append(format_string) + return formatted_strings + + +def copy_resources(src, dest, file_list): + """ + Copy files from content folder to output folder + Parameters + ---------- + src: string + Content folder path + dest: string, + Output folder path + file_list: list + List of files to be transferred + Output + ------ + Copies files from content to output + """ + if not os.path.exists(dest): + os.makedirs(dest) + for file_ in file_list: + file_src = os.path.join(src, file_) + shutil.copy2(file_src, dest) + + +def add_tags(gen, metadata): + """ + It will add the JS to the article or page + """ + def replace_last(source_string, replace_what, replace_with): + head, sep, tail = source_string.rpartition(replace_what) + return head + replace_with + tail + if 'js' in metadata.keys(): + minification_string = '.min' + metadata['js'] = replace_last(metadata['js'], '.js', minification_string + '.js') + script = '<script src="{0}/vendor/{1}"></script>{2}' + metadata['js'] = format_js(gen, metadata['js'], script) + + +def move_resources(gen): + """ + Move JS files from js folder to output folder + """ + js_files = gen.get_files('js', extensions='js') + + js_dest = os.path.join(gen.output_path, 'vendor') + copy_resources(gen.path, js_dest, js_files) + + +def register(): + """ + Plugin registration + """ + signals.article_generator_context.connect(add_tags) + signals.page_generator_context.connect(add_tags) + signals.article_generator_finalized.connect(move_resources) |