1670324907

Build Type

github

Committed by GitHub

Commit Message

Merge e4506c1d0 into d2705d432

Pull Request Pull Request #436: refactor: clean up and move stuff to blender.py

Run Details

513 of 547 branches covered (93.78%)

Branch coverage included in aggregate %.

124 of 125 new or added lines in 15 files covered. (99.2%)

2 existing lines in 1 file now uncovered.

1928 of 1973 relevant lines covered (97.72%)

4.86 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

96.25

/src/nitpick/plugins/json.py

"""JSON files."""
import json
from itertools import chain
from typing import Iterator, Optional, Type

from loguru import logger

from nitpick import fields
from nitpick.blender import BaseDoc, DictBlender, JsonDoc, unflatten
from nitpick.plugins import hookimpl
from nitpick.plugins.base import NitpickPlugin
from nitpick.plugins.info import FileInfo
from nitpick.schemas import BaseNitpickSchema
from nitpick.violations import Fuss, SharedViolations, ViolationEnum

KEY_CONTAINS_KEYS = "contains_keys"
KEY_CONTAINS_JSON = "contains_json"
VALUE_PLACEHOLDER = "<some value here>"


class JsonFileSchema(BaseNitpickSchema):
    """Validation schema for any JSON file added to the style."""

    contains_keys = fields.List(fields.NonEmptyString)
    contains_json = fields.Dict(fields.NonEmptyString, fields.JsonString)


class JsonPlugin(NitpickPlugin):
    """Enforce configurations and autofix JSON files.

    Add the configurations for the file name you wish to check.
    Style example: :ref:`the default config for package.json <example-package-json>`.
    """

    validation_schema = JsonFileSchema
    identify_tags = {"json"}
    violation_base_code = 340
    fixable = True

    def enforce_rules(self) -> Iterator[Fuss]:
        """Enforce rules for missing keys and JSON content."""
        actual = JsonDoc(path=self.file_path)
        blender: Optional[DictBlender] = DictBlender(actual.as_object, extend_lists=False) if self.autofix else None

        comparison = actual.compare_with_flatten(self.expected_dict_from_contains_keys())
        if comparison.missing:
            yield from self.report(SharedViolations.MISSING_VALUES, blender, comparison.missing)

        comparison = actual.compare_with_flatten(self.expected_dict_from_contains_json())
        if comparison.has_changes:
            yield from chain(
                self.report(SharedViolations.DIFFERENT_VALUES, blender, comparison.diff),
                self.report(SharedViolations.MISSING_VALUES, blender, comparison.missing),
            )

        if self.autofix and self.dirty and blender:
            self.file_path.write_text(JsonDoc(obj=blender.mix()).reformatted)

    def expected_dict_from_contains_keys(self):
        """Expected dict created from "contains_keys" values."""
        return unflatten({key: VALUE_PLACEHOLDER for key in set(self.expected_config.get(KEY_CONTAINS_KEYS) or [])})

    def expected_dict_from_contains_json(self):
        """Expected dict created from "contains_json" values."""
        expected_config = {}
        # TODO: accept key as a jmespath expression, value is valid JSON
        for key, json_string in (self.expected_config.get(KEY_CONTAINS_JSON) or {}).items():
            try:
                expected_config[key] = json.loads(json_string)
            except json.JSONDecodeError as err:
                # This should not happen, because the style was already validated before.
                # Maybe the NIP??? code was disabled by the user?
                logger.error(f"{err} on {KEY_CONTAINS_JSON} while checking {self.file_path}")
                continue
        return expected_config

    def report(self, violation: ViolationEnum, blender: Optional[DictBlender], change: Optional[BaseDoc]):
        """Report a violation while optionally modifying the JSON dict."""
        if not change:
            return
        if blender:
            blender.add(change.as_object)
            self.dirty = True
        yield self.reporter.make_fuss(violation, change.reformatted, prefix="", fixed=self.autofix)

    @property
    def initial_contents(self) -> str:
        """Suggest the initial content for this missing file."""
        suggestion = DictBlender(self.expected_dict_from_contains_keys())
        suggestion.add(self.expected_dict_from_contains_json())
        return self.write_initial_contents(JsonDoc, suggestion.mix())


@hookimpl
def plugin_class() -> Type["NitpickPlugin"]:
    """Handle JSON files."""
    return JsonPlugin


@hookimpl
def can_handle(info: FileInfo) -> Optional[Type["NitpickPlugin"]]:
    """Handle JSON files."""
    if JsonPlugin.identify_tags & info.tags:
        return JsonPlugin
    return None

1	"""JSON files."""
2	import json	5✔
3	from itertools import chain	5✔
4	from typing import Iterator, Optional, Type	5✔
5
6	from loguru import logger	5✔
7
8	from nitpick import fields	5✔
9	from nitpick.blender import BaseDoc, DictBlender, JsonDoc, unflatten	5✔
10	from nitpick.plugins import hookimpl	5✔
11	from nitpick.plugins.base import NitpickPlugin	5✔
12	from nitpick.plugins.info import FileInfo	5✔
13	from nitpick.schemas import BaseNitpickSchema	5✔
14	from nitpick.violations import Fuss, SharedViolations, ViolationEnum	5✔
15
16	KEY_CONTAINS_KEYS = "contains_keys"	5✔
17	KEY_CONTAINS_JSON = "contains_json"	5✔
18	VALUE_PLACEHOLDER = "<some value here>"	5✔
19
20
21	class JsonFileSchema(BaseNitpickSchema):	5✔
22	"""Validation schema for any JSON file added to the style."""
23
24	contains_keys = fields.List(fields.NonEmptyString)	5✔
25	contains_json = fields.Dict(fields.NonEmptyString, fields.JsonString)	5✔
26
27
28	class JsonPlugin(NitpickPlugin):	5✔
29	"""Enforce configurations and autofix JSON files.
30
31	Add the configurations for the file name you wish to check.
32	Style example: :ref:`the default config for package.json <example-package-json>`.
33	"""
34
35	validation_schema = JsonFileSchema	5✔
36	identify_tags = {"json"}	5✔
37	violation_base_code = 340	5✔
38	fixable = True	5✔
39
40	def enforce_rules(self) -> Iterator[Fuss]:	5✔
41	"""Enforce rules for missing keys and JSON content."""
42	actual = JsonDoc(path=self.file_path)	5✔
43	blender: Optional[DictBlender] = DictBlender(actual.as_object, extend_lists=False) if self.autofix else None	5✔
44
45	comparison = actual.compare_with_flatten(self.expected_dict_from_contains_keys())	5✔
46	if comparison.missing:	5✔
47	yield from self.report(SharedViolations.MISSING_VALUES, blender, comparison.missing)	5✔
48
49	comparison = actual.compare_with_flatten(self.expected_dict_from_contains_json())	5✔
50	if comparison.has_changes:	5✔
51	yield from chain(	5✔
52	self.report(SharedViolations.DIFFERENT_VALUES, blender, comparison.diff),
53	self.report(SharedViolations.MISSING_VALUES, blender, comparison.missing),
54	)
55
56	if self.autofix and self.dirty and blender:	5✔
57	self.file_path.write_text(JsonDoc(obj=blender.mix()).reformatted)	5✔
58
59	def expected_dict_from_contains_keys(self):	5✔
60	"""Expected dict created from "contains_keys" values."""
61	return unflatten({key: VALUE_PLACEHOLDER for key in set(self.expected_config.get(KEY_CONTAINS_KEYS) or [])})	5✔
62
63	def expected_dict_from_contains_json(self):	5✔
64	"""Expected dict created from "contains_json" values."""
65	expected_config = {}	5✔
66	# TODO: accept key as a jmespath expression, value is valid JSON
67	for key, json_string in (self.expected_config.get(KEY_CONTAINS_JSON) or {}).items():	5✔
68	try:	5✔
69	expected_config[key] = json.loads(json_string)	5✔
UNCOV 70	except json.JSONDecodeError as err:	×
71	# This should not happen, because the style was already validated before.
72	# Maybe the NIP??? code was disabled by the user?
73	logger.error(f"{err} on {KEY_CONTAINS_JSON} while checking {self.file_path}")	×
UNCOV 74	continue	×
75	return expected_config	5✔
76
77	def report(self, violation: ViolationEnum, blender: Optional[DictBlender], change: Optional[BaseDoc]):	5✔
78	"""Report a violation while optionally modifying the JSON dict."""
79	if not change:	5✔
80	return	5✔
81	if blender:	5✔
82	blender.add(change.as_object)	5✔
83	self.dirty = True	5✔
84	yield self.reporter.make_fuss(violation, change.reformatted, prefix="", fixed=self.autofix)	5✔
85
86	@property	5✔
87	def initial_contents(self) -> str:	5✔
88	"""Suggest the initial content for this missing file."""
89	suggestion = DictBlender(self.expected_dict_from_contains_keys())	5✔
90	suggestion.add(self.expected_dict_from_contains_json())	5✔
91	return self.write_initial_contents(JsonDoc, suggestion.mix())	5✔
92
93
94	@hookimpl	5✔
95	def plugin_class() -> Type["NitpickPlugin"]:	5✔
96	"""Handle JSON files."""
97	return JsonPlugin	5✔
98
99
100	@hookimpl	5✔
101	def can_handle(info: FileInfo) -> Optional[Type["NitpickPlugin"]]:	5✔
102	"""Handle JSON files."""
103	if JsonPlugin.identify_tags & info.tags:	5✔
104	return JsonPlugin	5✔
105	return None	5✔

andreoliwa / nitpick / 1670324907

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous