chore(rules): rename Rule -> PullRequestRule

Change-Id: Idce0ce73e8132d2837a7ac2a652379964fff0ef6
Mergifyio · Aug 16, 2021 · 6fcb7ca · 6fcb7ca
1 parent 0953caa
commit 6fcb7ca
Showing 3 changed files with 14 additions and 13 deletions.
diff --git a/mergify_engine/engine/commands_runner.py b/mergify_engine/engine/commands_runner.py
@@ -146,7 +146,9 @@ async def run_command(
     report = await command.action.run(
         ctxt,
         rules.EvaluatedRule(
-            rules.Rule("", None, conditions.PullRequestRuleConditions([]), {}, False)
+            rules.PullRequestRule(
+                "", None, conditions.PullRequestRuleConditions([]), {}, False
+            )
         ),
     )
 

diff --git a/mergify_engine/rules/__init__.py b/mergify_engine/rules/__init__.py
@@ -38,9 +38,8 @@ class DisabledDict(typing.TypedDict):
     reason: str
 
 
-# TODO(sileht): rename me PullRequestRule ?
 @dataclasses.dataclass
-class Rule:
+class PullRequestRule:
     name: str
     disabled: typing.Union[DisabledDict, None]
     conditions: conditions.PullRequestRuleConditions
@@ -57,11 +56,11 @@ class T_from_dict(T_from_dict_required, total=False):
         hidden: bool
 
     @classmethod
-    def from_dict(cls, d: T_from_dict) -> "Rule":
+    def from_dict(cls, d: T_from_dict) -> "PullRequestRule":
         return cls(**d)
 
 
-EvaluatedRule = typing.NewType("EvaluatedRule", Rule)
+EvaluatedRule = typing.NewType("EvaluatedRule", PullRequestRule)
 
 
 class QueueConfig(typing.TypedDict):
@@ -117,7 +116,7 @@ async def get_pull_request_rule(
         return queue_rules_evaluator.matching_rules[0]
 
 
-T_Rule = typing.TypeVar("T_Rule", Rule, QueueRule)
+T_Rule = typing.TypeVar("T_Rule", PullRequestRule, QueueRule)
 T_EvaluatedRule = typing.TypeVar("T_EvaluatedRule", EvaluatedRule, EvaluatedQueueRule)
 
 
@@ -214,13 +213,13 @@ async def create(
         return self
 
 
-RulesEvaluator = GenericRulesEvaluator[Rule, EvaluatedRule]
+RulesEvaluator = GenericRulesEvaluator[PullRequestRule, EvaluatedRule]
 QueuesRulesEvaluator = GenericRulesEvaluator[QueueRule, EvaluatedQueueRule]
 
 
 @dataclasses.dataclass
 class PullRequestRules:
-    rules: typing.List[Rule]
+    rules: typing.List[PullRequestRule]
 
     def __post_init__(self):
         # NOTE(sileht): Make sure each rule has a unique name because they are
@@ -246,7 +245,7 @@ async def get_pull_request_rule(self, ctxt: context.Context) -> RulesEvaluator:
         for rule in self.rules:
             if not rule.actions:
                 runtime_rules.append(
-                    Rule(
+                    PullRequestRule(
                         name=rule.name,
                         disabled=rule.disabled,
                         conditions=rule.conditions.copy(),
@@ -273,7 +272,7 @@ async def get_pull_request_rule(self, ctxt: context.Context) -> RulesEvaluator:
                 depends_on_conditions = await conditions.get_depends_on_conditions(ctxt)
                 if branch_protection_conditions or depends_on_conditions:
                     runtime_rules.append(
-                        Rule(
+                        PullRequestRule(
                             name=rule.name,
                             disabled=rule.disabled,
                             conditions=conditions.PullRequestRuleConditions(
@@ -290,7 +289,7 @@ async def get_pull_request_rule(self, ctxt: context.Context) -> RulesEvaluator:
 
             if actions_without_special_rules:
                 runtime_rules.append(
-                    Rule(
+                    PullRequestRule(
                         name=rule.name,
                         disabled=rule.disabled,
                         conditions=rule.conditions.copy(),
@@ -420,7 +419,7 @@ def get_pull_request_rules_schema(partial_validation: bool = False) -> voluptuou
                         partial_validation
                     ),
                 },
-                voluptuous.Coerce(Rule.from_dict),
+                voluptuous.Coerce(PullRequestRule.from_dict),
             ),
         ],
         voluptuous.Coerce(PullRequestRules),

diff --git a/mergify_engine/tests/unit/rules/test_rules.py b/mergify_engine/tests/unit/rules/test_rules.py
@@ -1031,7 +1031,7 @@ async def client_items(url, *args, **kwargs):
     # Empty conditions
     pull_request_rules = rules.PullRequestRules(
         [
-            rules.Rule(
+            rules.PullRequestRule(
                 name="default",
                 disabled=None,
                 conditions=conditions.PullRequestRuleConditions([]),