Merge pull request #20 from bcdev/forman-reduce_code_duplications

Reduce code duplications

Author: forman

CHANGES.md

@@ -2,6 +2,18 @@
 
 ## Version 0.3.0 (in development)
 
+- Fixed problem where referring to values in modules via 
+  the form `"<module>:<attr>"` raised. #21
+
+- Introduced factory method `new_plugin` which simplifies
+  creating plugin objects.
+
+- Refactored out new common mixin class `Operation`
+  which reduces amount of code and simplifies testing
+  of operation classes `Rule`, `Processor`, `Formatter`.
+
+- Improved overall test coverage.
+
 
 ## Version 0.2.0 (14.01.2025)
 

docs/api.md

@@ -10,9 +10,10 @@ This chapter provides a plain reference for the XRLint Python API.
   dataset:
   [new_linter()][xrlint.linter.new_linter] factory function and the
   [Linter][xrlint.linter.Linter] class.
-- The `plugin` module provides plugin related classes:
-  [Plugin][xrlint.plugin.Plugin] and its 
-  metadata [PluginMeta][xrlint.plugin.PluginMeta].
+- The `plugin` module provides plugin related components:
+  A factory [new_plugin][xrlint.plugin.new_plugin] to create instances of
+  the [Plugin][xrlint.plugin.Plugin] class that comprises 
+  plugin metadata represented by [PluginMeta][xrlint.plugin.PluginMeta].
 - The `config` module provides classes that represent 
   configuration information and provide related functionality:
   [Config][xrlint.config.Config] and [ConfigList][xrlint.config.ConfigList].
@@ -51,6 +52,12 @@ Note:
 
 ::: xrlint.linter.Linter
 
+::: xrlint.plugin.new_plugin
+
+::: xrlint.plugin.Plugin
+
+::: xrlint.plugin.PluginMeta
+
 ::: xrlint.config.Config
 
 ::: xrlint.config.ConfigList
@@ -79,10 +86,6 @@ Note:
 
 ::: xrlint.node.AttrNode
 
-::: xrlint.plugin.Plugin
-
-::: xrlint.plugin.PluginMeta
-
 ::: xrlint.processor.define_processor
 
 ::: xrlint.processor.Processor

environment.yml

@@ -1,4 +1,4 @@
-name: xrlint-310
+name: xrlint
 channels:
   - conda-forge
 dependencies:

examples/plugin_config.py

@@ -5,14 +5,14 @@
 
 from xrlint.config import Config
 from xrlint.node import DatasetNode
-from xrlint.plugin import Plugin
-from xrlint.plugin import PluginMeta
+from xrlint.plugin import new_plugin
 from xrlint.rule import RuleContext
 from xrlint.rule import RuleOp
 
 
-plugin = Plugin(
-    meta=PluginMeta(name="hello-plugin", version="1.0.0"),
+plugin = new_plugin(
+    name="hello-plugin",
+    version="1.0.0",
     configs={
         # "configs" entries must be `Config` objects!
         "recommended": Config.from_value(

tests/formatters/helpers.py

@@ -1,7 +1,6 @@
 from xrlint.config import Config
 from xrlint.formatter import FormatterContext
-from xrlint.plugin import Plugin
-from xrlint.plugin import PluginMeta
+from xrlint.plugin import new_plugin
 from xrlint.result import Message, ResultStats
 from xrlint.result import Result
 from xrlint.rule import RuleOp
@@ -28,7 +27,7 @@ def get_context(max_warnings: int = -1) -> FormatterContext:
 
 def get_test_results():
 
-    plugin = Plugin(meta=PluginMeta(name="test"))
+    plugin = new_plugin(name="test")
 
     @plugin.define_rule(
         "rule-1", description="Haha", docs_url="https://rules.com/haha.html"

tests/formatters/test_markdown.py

@@ -10,7 +10,6 @@ def test_import_formatters(self):
             {
                 "html",
                 "json",
-                "markdown",
                 "simple",
             },
             set(registry.keys()),

tests/test_formatters.py

@@ -7,8 +7,7 @@
 from xrlint.constants import CORE_PLUGIN_NAME
 from xrlint.linter import Linter
 from xrlint.linter import new_linter
-from xrlint.plugin import Plugin
-from xrlint.plugin import PluginMeta
+from xrlint.plugin import new_plugin
 from xrlint.node import (
     AttrsNode,
     AttrNode,
@@ -62,7 +61,7 @@ class LinterVerifyTest(TestCase):
 
     def setUp(self):
 
-        plugin = Plugin(meta=PluginMeta(name="test"))
+        plugin = new_plugin(name="test")
 
         @plugin.define_rule("no-space-in-attr-name")
         class AttrVer(RuleOp):