lighthouse_garden.export.render

Complexity

Total Complexity

17

Size/Duplication

Total Lines	227
Duplicated Lines	0 %

Importance

Changes

0

8 Functions

Rating	Name	Duplication	Size	Complexity
A	generate_dashboard()	0	25	1
A	get_percentage_classification()	0	13	3
A	render_trend()	0	23	4
A	render_template()	0	11	1
B	render_items()	0	79	2
A	render_percentage_circle()	0	18	1
A	render_assets()	0	12	3
A	render_logo()	0	7	2

#!/usr/bin/env python3

Missing module docstring

# -*- coding: utf-8 -*-

import datetime
import jinja2
import os

standard import "import os" should be placed before "import jinja2"

import lighthouse_garden
from lighthouse_garden import info
from lighthouse_garden.utility import output, system
from lighthouse_garden.lighthouse import database, utility

"""
CONSTANTS
"""

This string statement has no effect and could be removed.

ASSETS_CSS = '/templates/assets/css'
ASSETS_JS = '/templates/assets/js'

TAG_CSS = 'style'
TAG_JS = 'script'


def generate_dashboard():
    """
    Generate the static html dashboard
    :return:
    """
    _now = datetime.datetime.now()
    _file = f'{system.config["export_path"]}index.html'
    output.println(f'{output.Subject.INFO} Generating dashboard {output.CliFormat.BLACK}{_file}{output.CliFormat.ENDC}')

This line is too long as per the coding-style (120/100).

    html = open(_file, "w")

    _rendered_html = render_template('index.html.j2',
                                     logo=render_logo(),
                                     date=_now.strftime("%Y-%m-%dT%H:%M:%SZ"),
                                     assets_css=render_assets(ASSETS_CSS, TAG_CSS),
                                     assets_js=render_assets(ASSETS_JS, TAG_JS),
                                     items=render_items(),
                                     title=system.config['title'],
                                     description=system.config['description'],
                                     version=info.__version__,
                                     homepage=info.__homepage__,
                                     lighthouse_version=system.config['lighthouse']['version']
                                     )
    html.write(_rendered_html)
    html.close()


def render_items():
    """
    Render the target items for the dashboard
    @ToDo: Outsource description text?
    :return:
    """
    _items = ''
    results = database.sort_by_average(
        database.get_last_results()
    )

    for result in results:
        _target = database.get_target_by_attribute(result['title'], 'title')
        _item = render_template('partials/item.html.j2',
                                title=result['title'],
                                url=result['url'],
                                last_report=result['report'],
                                identifier=_target['identifier'],
                                graph_values_y=','.join(map(str, database.get_history_by_attribute(
                                    _target, 'performance'))),
                                graph_values_x=','.join(map(str, database.get_history_by_attribute(
                                    _target, 'date'))),
                                graph_values_text=','.join(map(str, database.get_history_by_attribute(

This line is too long as per the coding-style (102/100).

                                    _target, 'report'))),
                                circle_average=render_percentage_circle(
                                    description=f'<strong>Average</strong><br/>'
                                                f'Calculates all available performance values to an average value.<br/><br/>'

This line is too long as per the coding-style (125/100).

                                                f'Maximum value: {int(result["average"]["max"])}<br/>'

This line is too long as per the coding-style (102/100).

                                                f'Minimum value: {int(result["average"]["min"])}<br/>',

This line is too long as per the coding-style (103/100).

                                    value=result['average']['value']
                                ),
                                circle_performance=render_percentage_circle(
                                    trend=render_trend(result),
                                    description=f'<strong>Performance</strong><br/>'

Using an f-string that does not have any interpolated variables

                                                f'The performance score is calculated directly from various metrics.<br/><br/>'

This line is too long as per the coding-style (127/100).

                                                f'Click here to get more information from the last report.',

This line is too long as per the coding-style (108/100).

                                    url=f'{result["report"]}#performance',
                                    title=f'Report {result["date"]}',
                                    value=result['performance']
                                ),
                                circle_accessibility=render_percentage_circle(
                                    description=f'<strong>Accessibility</strong><br/>'

Using an f-string that does not have any interpolated variables

                                                f'These checks highlight opportunities to improve the accessibility of '

This line is too long as per the coding-style (120/100).

                                                f'your web app.<br/><br/>'
                                                f'Click here to get more information from the last report.',

This line is too long as per the coding-style (108/100).

                                    value=result['accessibility'],
                                    url=f'{result["report"]}#accessibility',
                                    title=f'Report {result["date"]}',
                                    additional_class='small'
                                ),
                                circle_best_practices=render_percentage_circle(
                                    description=f'<strong>Best practices</strong><br/>'

Using an f-string that does not have any interpolated variables

                                                f'Further information about best practices.'
                                                f'See the lighthouse report for further information.<br/><br/>'

This line is too long as per the coding-style (111/100).

                                                f'Click here to get more information from the last report.',

This line is too long as per the coding-style (108/100).

                                    value=result['best-practices'],
                                    url=f'{result["report"]}#best-practices',
                                    title=f'Report {result["date"]}',
                                    additional_class='small'
                                ),
                                circle_seo=render_percentage_circle(
                                    description=f'<strong>SEO</strong><br/>'

Using an f-string that does not have any interpolated variables

                                                f'These checks ensure that your page is optimized for search engine '

This line is too long as per the coding-style (117/100).

                                                f'results ranking.<br/><br/>'
                                                f'Click here to get more information from the last report.',

This line is too long as per the coding-style (108/100).

                                    value=result['seo'],
                                    url=f'{result["report"]}#seo',
                                    title=f'Report {result["date"]}',
                                    additional_class='small'
                                ),
                                api_json=f'{utility.get_data_dir(absolute_path=False)}_{_target["identifier"]}.json',

This line is too long as per the coding-style (117/100).

                                badge_average=f'{utility.get_data_dir(absolute_path=False)}_{_target["identifier"]}.average.svg',

This line is too long as per the coding-style (129/100).

                                badge_performance=f'{utility.get_data_dir(absolute_path=False)}_{_target["identifier"]}.performance.svg',

This line is too long as per the coding-style (137/100).

                                badge_accessibility=f'{utility.get_data_dir(absolute_path=False)}_{_target["identifier"]}.accessibility.svg',

This line is too long as per the coding-style (141/100).

                                badge_best_practices=f'{utility.get_data_dir(absolute_path=False)}_{_target["identifier"]}.best-practices.svg',

This line is too long as per the coding-style (143/100).

                                badge_seo=f'{utility.get_data_dir(absolute_path=False)}_{_target["identifier"]}.seo.svg',

This line is too long as per the coding-style (121/100).

                                )
        _items += _item
    return _items


def render_percentage_circle(description, value, trend='', url='', title='', additional_class=None):

Too many arguments (6/5)

    """
    Render the percentage circle for a specific attribute
    :param description: String
    :param value: Integer
    :param trend: String
    :param url: String
    :param additional_class:
    :return:
    """
    return render_template('partials/circle.html.j2',
                           url=url,
                           title=title,
                           value=str(int(round(value))),
                           description=description,
                           color=get_percentage_classification(int(round(value))),
                           small=additional_class,
                           trend=trend
                           )


def render_trend(result):
    """
    Render the performance trend
    :param result: Dict
    :return:
    """
    _description = ''
    _class = ''
    if result['average']['trend'] == 1:
        _description = f'<strong>Performance trend</strong><br/>' \

Using an f-string that does not have any interpolated variables

                       f'Ascending trend in dependence of the last performance measurement to the average value.'

This line is too long as per the coding-style (113/100).

        _class = 'asc'
    elif result['average']['trend'] == -1:
        _description = f'<strong>Performance trend</strong><br/>' \

Using an f-string that does not have any interpolated variables

                       f'Descending trend in dependence of the last performance measurement to the average value.'

This line is too long as per the coding-style (114/100).

        _class = 'desc'

    if result['average']['trend'] == 0:

Unnecessary "else" after "return"

        return ''
    else:
        return render_template('partials/trend.html.j2',
                           description=_description,

Wrong continued indentation (add 4 spaces).

                           trend=_class

Wrong continued indentation (add 4 spaces).

                           )

Wrong continued indentation.

def get_percentage_classification(value):
    """
    Get the percentage classification by a value
    @ToDo: Make this configurable
    :param value:
    :return:
    """
    if value >= 90:

Unnecessary "elif" after "return"

        return 'green'
    elif value >= 50:
        return 'orange'
    else:
        return 'red'


def render_assets(path, tag):
    """
    Render the css/js assets
    :param path: String
    :param tag: String
    :return: String
    """
    _html = ''
    for file in os.listdir(os.path.dirname(lighthouse_garden.__file__) + path):
        with open(os.path.dirname(lighthouse_garden.__file__) + path + '/' + file, 'r') as read_file:

This line is too long as per the coding-style (101/100).

            _html += f'<!-- {file} -->\n<{tag}>\n{read_file.read()}\n</{tag}>\n'
    return _html


def render_logo():
    """
    Render the SVG logo file
    :return:
    """
    with open(os.path.dirname(lighthouse_garden.__file__) + '/templates/assets/tower.svg', 'r') as read_file:

This line is too long as per the coding-style (109/100).

        return read_file.read()


def render_template(template, **args):
    """
    Render a template with jinja2
    :param template: String Template file
    :param args: Dictionary Template arguments
    :return: String Rendered Template
    """
    _template_loader = jinja2.FileSystemLoader(searchpath=os.path.dirname(lighthouse_garden.__file__) + "/templates/")

This line is too long as per the coding-style (118/100).

    _template_environment = jinja2.Environment(loader=_template_loader)
    _template = _template_environment.get_template(template)
    return _template.render(args)