add: eighth step, format plain

Author: ZLOI27

gendiff/gendiff.py

@@ -3,7 +3,8 @@
 import yaml
 
 from gendiff.cli import parse_args
-from gendiff.views import make_str_from_list
+from gendiff.views.plain import format_output_plain
+from gendiff.views.stylish import format_output_stylish
 
 
 def read_file(path: str):
@@ -25,57 +26,56 @@ def read_file(path: str):
         return None
 
 
-def sort_list(items: list):
-    def sort_by_rule(item: dict) -> tuple:
-        """The sign -> digit for correctly sort items with the same key."""
-        sign_order = {'-': 0, '+': 1, ' ': 2}
-        return (item['key'], sign_order[item['sign']])
-    items.sort(key=sort_by_rule)
-    return items
-
-
-def get_list_of_dict(data1, data2) -> list:
+def get_diff(data1, data2) -> list:
     if data1 == data2:
         return data1
-    result = [
-        {
-            'key': key,
-            'sign': ' ',
-            'value': get_list_of_dict(value, data2[key])
-        }
-        if key in data2 and (
-            (value == data2[key]) or
-            (value != data2[key]) and
-            (isinstance(value, dict) and isinstance(data2[key], dict))
-        )
-        else {
-            'key': key,
-            'sign': '-',
-            'value': value
-        }
-        for key, value in data1.items()
-    ]
-    result.extend([
-        {
-            'key': key,
-            'sign': '+',
-            'value': value
-        }
-        for key, value in data2.items()
-        if (
-            (key not in data1) or
-            (key in data1 and value != data1[key]) and
-            (not isinstance(value, dict) or not isinstance(data2[key], dict))
-        )
-    ])
-    return sort_list(result)
+    diff = []
+    keys = sorted(set(data1.keys()) | set(data2.keys()))
+    for key in keys:
+        if key not in data2:
+            diff.append({
+                'key': key,
+                'status': 'removed',
+                'value': data1[key],
+            })
+        elif key not in data1:
+            diff.append({
+                'key': key,
+                'status': 'added',
+                'value': data2[key],
+            })
+        elif data1[key] == data2[key]:
+            diff.append({
+                'key': key,
+                'status': 'unchanged',
+                'value': data1[key],
+            })
+        elif isinstance(data1[key], dict) and isinstance(data2[key], dict):
+            diff.append({
+                'key': key,
+                'status': 'nested',
+                'value': get_diff(data1[key], data2[key]),
+            })
+        else:
+            diff.append({
+                'key': key,
+                'status': 'changed',
+                'value': data1[key],
+                'new_value': data2[key],
+            })
+            
+    diff.sort(key=lambda item: item['key'])
+    return diff
 
 
 def generate_diff(path1, path2, format_name='stylish') -> str:
     dict_data1 = read_file(path1)
     dict_data2 = read_file(path2)
-    sorted_list_of_dict = get_list_of_dict(dict_data1, dict_data2)
-    return make_str_from_list(sorted_list_of_dict, format_name)
+    sorted_diff = get_diff(dict_data1, dict_data2)
+    if format_name == 'stylish':
+        return format_output_stylish(sorted_diff)
+    elif format_name == 'plain':
+        return format_output_plain(sorted_diff)
 
 
 def main() -> None:

gendiff/views.py

@@ -0,0 +1,5 @@
+from gendiff.views.stylish import format_output_stylish
+
+__all__ = [
+    'format_output_stylish'
+]

gendiff/views/__init__.py

@@ -0,0 +1,42 @@
+import json
+
+
+def get_value(value):
+    if isinstance(value, (dict, list)):
+        value = "[complex value]"
+    elif isinstance(value, str):
+        value = f"'{value}'"
+    else:
+        value = json.dumps(value)
+    return value
+
+
+def format_output_plain(diff: list, accum=None, result=None):
+    if result is None:
+        result = []
+    if accum is None:
+        accum = ["Property '"]
+    for item in diff:
+        value = get_value(item['value'])
+
+        match item['status']:
+            case 'unchanged':
+                continue
+            case 'nested':
+                accum.append(f"{item['key']}.")
+                format_output_plain(item['value'], accum, result)
+            case 'removed':
+                accum.append(f"{item['key']}' was removed")
+                result.append(''.join(accum))
+            case 'added':
+                accum.append(f"{item['key']}' was added with value: {value}")
+                result.append(''.join(accum))
+            case 'changed':
+                new_value = get_value(item['new_value'])
+                accum.append(
+                    f"{item['key']}' was updated. From {value} to {new_value}"
+                )
+                result.append(''.join(accum))
+        accum.pop()
+    
+    return '\n'.join(result)

gendiff/views/plain.py

@@ -0,0 +1,69 @@
+import json
+
+
+def make_str_from_dict(items: dict, indent=0) -> str:
+    indent_str = ' ' * indent
+    list_of_str = ['{']
+    for key, value in items.items():
+        if not isinstance(key, str):
+            key = json.dumps(key)
+            
+        if isinstance(value, dict):
+            value = make_str_from_dict(value, indent + 4)
+
+        if not isinstance(value, str):
+            value = json.dumps(value)
+
+        list_of_str.append(f"{indent_str}    {key}: {value}")
+    list_of_str.append(f"{indent_str}}}")
+    return '\n'.join(list_of_str)
+
+
+def get_key(item_key):
+    if isinstance(item_key, str):
+        key = item_key
+    else:
+        key = json.dumps(item_key)
+    return key
+
+
+def get_value(value, status, indent):
+    if status == 'nested':
+        result = format_output_stylish(value, indent + 4)
+    elif isinstance(value, dict):
+        result = make_str_from_dict(value, indent + 4)
+    elif isinstance(value, str):
+        result = value
+    else:
+        result = json.dumps(value)
+    return result
+
+
+def format_output_stylish(diff: list, indent=0) -> str:
+    """
+    Type checking for the output of strings without quotes,
+    and for the correct output of True, False in the form of true, false.
+    Doesn't matter for .yaml.
+    """
+    indent_str = ' ' * indent
+    sign = {
+        'removed': '-',
+        'added': '+',
+        'unchanged': ' ',
+        'nested': ' ',
+        'changed': '-',
+    }
+    list_of_str = ['{']
+    for item in diff:
+        status = item['status']
+        key = get_key(item['key'])
+        value = get_value(item['value'], status, indent)
+        list_of_str.append(f"{indent_str}  {sign[status]} {key}: {value}")
+        if status == 'changed':
+            new_value = get_value(item['new_value'], status, indent)
+            list_of_str.append(
+                f"{indent_str}  {sign['added']} {key}: {new_value}"
+            )
+            
+    list_of_str.append(f"{indent_str}}}")
+    return '\n'.join(list_of_str)

gendiff/views/stylish.py

@@ -0,0 +1,11 @@
+Property 'common.follow' was added with value: false
+Property 'common.setting2' was removed
+Property 'common.setting3' was updated. From true to null
+Property 'common.setting4' was added with value: 'blah blah'
+Property 'common.setting5' was added with value: [complex value]
+Property 'common.setting6.doge.wow' was updated. From '' to 'so much'
+Property 'common.setting6.ops' was added with value: 'vops'
+Property 'group1.baz' was updated. From 'bas' to 'bars'
+Property 'group1.nest' was updated. From [complex value] to 'str'
+Property 'group2' was removed
+Property 'group3' was added with value: [complex value]