Skip to content
Permalink
Browse files
Move tagcloud plugin out of core (getnikola/nikola#1696)
Signed-off-by: Chris Warrick <kwpolska@gmail.com>
  • Loading branch information
Kwpolska committed Sep 8, 2018
1 parent bfdcec9 commit cd690bba75eb96355fb4af66e825022efbeae8d2
Showing with 98 additions and 0 deletions.
  1. +9 −0 v8/tagcloud/README.md
  2. +12 −0 v8/tagcloud/tagcloud.plugin
  3. +77 −0 v8/tagcloud/tagcloud.py
@@ -0,0 +1,9 @@
This plugin generates data in JSON format, for use by tag clouds. This used to be in core before v8 as an optional feature.

The data is a dictionary. Keys are tags, values are lists of dictionaries that contain: `title` (in default
language), `date` (m/d/Y), `isodate` (ISO 8601) and `url` (in default lang).

Data is saved into `output/assets/js/tag_cloud_data.json`. Sample:

```json
{"blog": [1, "/categories/blog/", {"posts": [{"date": "03/30/2012", "isodate": "2012-03-30T23:00:00-03:00", "title": "Welcome to Nikola", "url": "/posts/welcome-to-nikola/"}]}]}```
@@ -0,0 +1,12 @@
[Core]
name = render_tag_cloud
module = tagcloud

[Documentation]
author = Roberto Alsina
version = 1.0
website = https://getnikola.com/
description = Render a tag cloud data file.

[Nikola]
PluginCategory = Task
@@ -0,0 +1,77 @@
# -*- coding: utf-8 -*-

# Copyright © 2012-2018 Roberto Alsina and others.

# Permission is hereby granted, free of charge, to any
# person obtaining a copy of this software and associated
# documentation files (the "Software"), to deal in the
# Software without restriction, including without limitation
# the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the
# Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice
# shall be included in all copies or substantial portions of
# the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
# PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
# OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
# OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
# OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

"""Render a tag cloud data file."""

import json
import os

from nikola.plugin_categories import Task
from nikola import utils


class RenderTagCloud(Task):
"""Render a tag cloud data file."""

name = "render_tag_cloud"

def gen_tasks(self):
"""Render the tag cloud."""
self.site.scan_posts()
yield self.group_task()

# Tag cloud json file
tag_cloud_data = {}
for tag, posts in self.site.posts_per_tag.items():
if tag in self.site.config['HIDDEN_TAGS']:
continue
tag_posts = dict(posts=[{'title': post.meta[post.default_lang]['title'],
'date': post.date.strftime('%m/%d/%Y'),
'isodate': post.date.isoformat(),
'url': post.permalink(post.default_lang)}
for post in reversed(sorted(self.site.timeline, key=lambda post: post.date))
if tag in post.alltags])
tag_cloud_data[tag] = [len(posts), self.site.link(
'tag', tag, self.site.config['DEFAULT_LANG']), tag_posts]
output_name = os.path.join(self.site.config['OUTPUT_FOLDER'],
'assets', 'js', 'tag_cloud_data.json')

def write_tag_data(data):
"""Write tag data into JSON file, for use in tag clouds."""
utils.makedirs(os.path.dirname(output_name))
with open(output_name, 'w+') as fd:
json.dump(data, fd, sort_keys=True)

task = {
'basename': str(self.name),
'name': str(output_name)
}

task['uptodate'] = [utils.config_changed(tag_cloud_data, 'nikola.plugins.task.tags:tagdata')]
task['targets'] = [output_name]
task['actions'] = [(write_tag_data, [tag_cloud_data])]
task['clean'] = True
yield utils.apply_filters(task, self.site.config['FILTERS'])

0 comments on commit cd690bb

Please sign in to comment.