Rename Rule.skip_collecting_required_phrases

pombredanne · pombredanne · commit 8e16712d1b18 · 2024-10-08T21:43:19.000+02:00
Renamed to skip_for_required_phrase_generation.
This skips a tagged rule for is_required_phrase rule gen and for
required_phrase rule text update with is_required_phrase rules.

Signed-off-by: Philippe Ombredanne &lt;pombredanne@nexb.com&gt;
diff --git a/etc/scripts/licenses/report_license_rules.py b/etc/scripts/licenses/report_license_rules.py
@@ -63,7 +63,7 @@
     "is_license_intro",
     "is_license_clue",
     "is_required_phrase",
-    "skip_collecting_required_phrases",
+    "skip_for_required_phrase_generation",
     "is_deprecated",
     "has_unknown",
     "only_known_words",
diff --git a/src/licensedcode/data/rules/apache-2.0_1103.RULE b/src/licensedcode/data/rules/apache-2.0_1103.RULE
@@ -8,7 +8,7 @@ ignorable_authors:
     - Giuseppe Scrivano
 ignorable_urls:
     - https://github.com/opencontainers/runc/issues/2144#issuecomment-543116397
-skip_collecting_required_phrases: yes
+skip_for_required_phrase_generation: yes
 ---
 
 // Although ebpf.c is {{originally licensed under LGPL-3.0-or-later}}, the author (Giuseppe Scrivano)
diff --git a/src/licensedcode/data/rules/bsd-new_1110.RULE b/src/licensedcode/data/rules/bsd-new_1110.RULE
@@ -1,7 +1,7 @@
 ---
 license_expression: bsd-new
 is_license_text: yes
-skip_collecting_required_phrases: yes
+skip_for_required_phrase_generation: yes
 ---
 
 {{Source Code License
diff --git a/src/licensedcode/data/rules/bsd-new_1112.RULE b/src/licensedcode/data/rules/bsd-new_1112.RULE
@@ -1,7 +1,7 @@
 ---
 license_expression: bsd-new
 is_license_text: yes
-skip_collecting_required_phrases: yes
+skip_for_required_phrase_generation: yes
 ---
 
 Software {{License
diff --git a/src/licensedcode/data/rules/bsd-new_1284.RULE b/src/licensedcode/data/rules/bsd-new_1284.RULE
@@ -1,7 +1,7 @@
 ---
 license_expression: bsd-new
 is_license_reference: yes
-is_required_phrases: yes
+is_required_phrase: yes
 ignorable_urls:
     - https://go.dev/LICENSE
 ---
diff --git a/src/licensedcode/data/rules/bsd-new_1372.RULE b/src/licensedcode/data/rules/bsd-new_1372.RULE
@@ -2,7 +2,7 @@
 license_expression: bsd-new
 is_license_text: yes
 minimum_coverage: 90
-skip_collecting_required_phrases: yes
+skip_for_required_phrase_generation: yes
 ---
 
 {{Simplified BSD License }}
diff --git a/src/licensedcode/data/rules/bsd-new_185.RULE b/src/licensedcode/data/rules/bsd-new_185.RULE
@@ -1,7 +1,7 @@
 ---
 license_expression: bsd-new
 is_license_notice: yes
-skip_collecting_required_phrases: yes
+skip_for_required_phrase_generation: yes
 relevance: 100
 referenced_filenames:
     - COPYING
diff --git a/src/licensedcode/data/rules/bsd-new_413.RULE b/src/licensedcode/data/rules/bsd-new_413.RULE
@@ -1,7 +1,7 @@
 ---
 license_expression: bsd-new
 is_license_text: yes
-skip_collecting_required_phrases: yes
+skip_for_required_phrase_generation: yes
 minimum_coverage: 90
 ---
 
diff --git a/src/licensedcode/data/rules/bsd-new_687.RULE b/src/licensedcode/data/rules/bsd-new_687.RULE
@@ -3,7 +3,7 @@ license_expression: bsd-new
 is_license_text: yes
 relevance: 100
 minimum_coverage: 80
-skip_collecting_required_phrases: yes
+skip_for_required_phrase_generation: yes
 ---
 
 {{license
diff --git a/src/licensedcode/data/rules/gpl-1.0-plus_565.RULE b/src/licensedcode/data/rules/gpl-1.0-plus_565.RULE
@@ -4,7 +4,7 @@ is_license_reference: yes
 is_continuous: yes
 relevance: 100
 notes: Seen in ebpf in github.com/cilium/ebpf/ and may be accessing GPL-only kernel symbols
-skip_collecting_required_phrases: yes
+skip_for_required_phrase_generation: yes
 ---
 
 {{ License:      internal.NewStringPointer("GPL")}}
diff --git a/src/licensedcode/data/rules/gpl-2.0-plus_1129.RULE b/src/licensedcode/data/rules/gpl-2.0-plus_1129.RULE
@@ -1,7 +1,7 @@
 ---
 license_expression: gpl-2.0-plus
 is_license_notice: yes
-skip_collecting_required_phrases: yes
+skip_for_required_phrase_generation: yes
 ---
 
 Some of the code in this project {{was originally LGPL v2.1 (or later)
diff --git a/src/licensedcode/data/rules/lgpl-2.1-plus_499.RULE b/src/licensedcode/data/rules/lgpl-2.1-plus_499.RULE
@@ -2,7 +2,7 @@
 license_expression: lgpl-2.1-plus
 is_license_notice: yes
 relevance: 99
-skip_collecting_required_phrases: yes
+skip_for_required_phrase_generation: yes
 ---
 
 NOTE: Only {{certain parts}} of the ScummVM project are {{under the GNU LGPL.}}
diff --git a/src/licensedcode/data/rules/mit_1312.RULE b/src/licensedcode/data/rules/mit_1312.RULE
@@ -2,7 +2,7 @@
 license_expression: mit
 is_license_notice: yes
 relevance: 100
-skip_collecting_required_phrases: yes
+skip_for_required_phrase_generation: yes
 referenced_filenames:
     - LICENSE.RFL
 ---
diff --git a/src/licensedcode/data/rules/mpl-1.0_15.RULE b/src/licensedcode/data/rules/mpl-1.0_15.RULE
@@ -1,7 +1,7 @@
 ---
 license_expression: mpl-1.0
 is_license_reference: yes
-skip_collecting_required_phrases: yes
+skip_for_required_phrase_generation: yes
 relevance: 99
 notes: this could be MPL 1.1 or 2.0. The 1.0 and up allow upgrade to newer versions So 1.0 this
     is always correct
diff --git a/src/licensedcode/models.py b/src/licensedcode/models.py
@@ -1439,7 +1439,7 @@ class BasicRule:
             'will be a false positive and misleading.')
     )
 
-    skip_collecting_required_phrases = attr.ib(
+    skip_for_required_phrase_generation = attr.ib(
         default=False,
         repr=False,
         metadata=dict(
@@ -1945,7 +1945,7 @@ def validate(self, licensing=None, thorough=False):
             if (self.is_license_clue or self.is_license_intro) and self.is_required_phrase:
                 yield 'License intro/clue rules cannot be required phrase rules'
 
-            if self.is_required_phrase and self.skip_collecting_required_phrases:
+            if self.is_required_phrase and self.skip_for_required_phrase_generation:
                 yield 'We can skip collecting required phrases only in non required phrase rules'
 
             if not all(check_is_list_of_strings(i) for i in ignorables):
@@ -2080,7 +2080,7 @@ def to_reference(self):
         data['is_license_intro'] = self.is_license_intro
         data['is_license_clue'] = self.is_license_clue
         data['is_required_phrase'] = self.is_required_phrase
-        data['skip_collecting_required_phrases'] = self.skip_collecting_required_phrases
+        data['skip_for_required_phrase_generation'] = self.skip_for_required_phrase_generation
         data['is_continuous'] = self.is_continuous
         data['is_builtin'] = self.is_builtin
         data['is_from_license'] = self.is_from_license
@@ -2114,7 +2114,7 @@ def to_dict(self, include_text=False):
         flags = self.license_flag_names + (
             'is_false_positive',
             'is_required_phrase',
-            'skip_collecting_required_phrases',
+            'skip_for_required_phrase_generation',
             'is_continuous',
             'is_deprecated'
         )
@@ -2400,7 +2400,7 @@ def load(self, rule_file, with_checks=True):
         self.is_false_positive = data.get('is_false_positive', False)
 
         self.is_required_phrase = data.get('is_required_phrase', False)
-        self.skip_collecting_required_phrases = data.get('skip_collecting_required_phrases', False)
+        self.skip_for_required_phrase_generation = data.get('skip_for_required_phrase_generation', False)
         self.source = data.get('source')
 
         relevance = as_int(float(data.get('relevance') or 0))
diff --git a/tests/formattedcode/data/common/manifests-expected.yaml b/tests/formattedcode/data/common/manifests-expected.yaml
@@ -1602,7 +1602,7 @@ license_rule_references:
     is_license_intro: no
     is_license_clue: no
     is_required_phrase: no
-    skip_collecting_required_phrases: no
+    skip_for_required_phrase_generation: no
     is_continuous: no
     is_builtin: yes
     is_from_license: no
@@ -1629,7 +1629,7 @@ license_rule_references:
     is_license_intro: no
     is_license_clue: no
     is_required_phrase: no
-    skip_collecting_required_phrases: no
+    skip_for_required_phrase_generation: no
     is_continuous: no
     is_builtin: yes
     is_from_license: no
@@ -1656,7 +1656,7 @@ license_rule_references:
     is_license_intro: no
     is_license_clue: no
     is_required_phrase: no
-    skip_collecting_required_phrases: no
+    skip_for_required_phrase_generation: no
     is_continuous: no
     is_builtin: yes
     is_from_license: no
@@ -1684,7 +1684,7 @@ license_rule_references:
     is_license_intro: no
     is_license_clue: no
     is_required_phrase: no
-    skip_collecting_required_phrases: no
+    skip_for_required_phrase_generation: no
     is_continuous: no
     is_builtin: yes
     is_from_license: no
@@ -1712,7 +1712,7 @@ license_rule_references:
     is_license_intro: no
     is_license_clue: no
     is_required_phrase: no
-    skip_collecting_required_phrases: no
+    skip_for_required_phrase_generation: no
     is_continuous: no
     is_builtin: yes
     is_from_license: no
@@ -1739,7 +1739,7 @@ license_rule_references:
     is_license_intro: no
     is_license_clue: no
     is_required_phrase: no
-    skip_collecting_required_phrases: no
+    skip_for_required_phrase_generation: no
     is_continuous: no
     is_builtin: yes
     is_from_license: no
@@ -1778,7 +1778,7 @@ license_rule_references:
     is_license_intro: no
     is_license_clue: no
     is_required_phrase: no
-    skip_collecting_required_phrases: no
+    skip_for_required_phrase_generation: no
     is_continuous: no
     is_builtin: yes
     is_from_license: no
@@ -1805,7 +1805,7 @@ license_rule_references:
     is_license_intro: yes
     is_license_clue: no
     is_required_phrase: no
-    skip_collecting_required_phrases: no
+    skip_for_required_phrase_generation: no
     is_continuous: no
     is_builtin: yes
     is_from_license: no
@@ -1835,7 +1835,7 @@ license_rule_references:
     is_license_intro: no
     is_license_clue: no
     is_required_phrase: yes
-    skip_collecting_required_phrases: no
+    skip_for_required_phrase_generation: no
     is_continuous: no
     is_builtin: yes
     is_from_license: no
@@ -1862,7 +1862,7 @@ license_rule_references:
     is_license_intro: no
     is_license_clue: no
     is_required_phrase: no
-    skip_collecting_required_phrases: no
+    skip_for_required_phrase_generation: no
     is_continuous: no
     is_builtin: yes
     is_from_license: no
@@ -1889,7 +1889,7 @@ license_rule_references:
     is_license_intro: no
     is_license_clue: no
     is_required_phrase: no
-    skip_collecting_required_phrases: no
+    skip_for_required_phrase_generation: no
     is_continuous: no
     is_builtin: yes
     is_from_license: no
@@ -1916,7 +1916,7 @@ license_rule_references:
     is_license_intro: no
     is_license_clue: no
     is_required_phrase: no
-    skip_collecting_required_phrases: no
+    skip_for_required_phrase_generation: no
     is_continuous: no
     is_builtin: yes
     is_from_license: no
diff --git a/tests/formattedcode/data/yaml/package-and-licenses-expected.yaml b/tests/formattedcode/data/yaml/package-and-licenses-expected.yaml
@@ -627,7 +627,7 @@ license_rule_references:
     is_license_intro: no
     is_license_clue: no
     is_required_phrase: no
-    skip_collecting_required_phrases: no
+    skip_for_required_phrase_generation: no
     is_continuous: no
     is_builtin: yes
     is_from_license: yes
@@ -857,7 +857,7 @@ license_rule_references:
     is_license_intro: no
     is_license_clue: no
     is_required_phrase: no
-    skip_collecting_required_phrases: no
+    skip_for_required_phrase_generation: no
     is_continuous: no
     is_builtin: yes
     is_from_license: no
@@ -884,7 +884,7 @@ license_rule_references:
     is_license_intro: no
     is_license_clue: no
     is_required_phrase: no
-    skip_collecting_required_phrases: no
+    skip_for_required_phrase_generation: no
     is_continuous: no
     is_builtin: yes
     is_from_license: no
@@ -911,7 +911,7 @@ license_rule_references:
     is_license_intro: no
     is_license_clue: no
     is_required_phrase: no
-    skip_collecting_required_phrases: no
+    skip_for_required_phrase_generation: no
     is_continuous: yes
     is_builtin: yes
     is_from_license: no
@@ -938,7 +938,7 @@ license_rule_references:
     is_license_intro: no
     is_license_clue: no
     is_required_phrase: no
-    skip_collecting_required_phrases: no
+    skip_for_required_phrase_generation: no
     is_continuous: no
     is_builtin: yes
     is_from_license: yes
@@ -983,7 +983,7 @@ license_rule_references:
     is_license_intro: no
     is_license_clue: no
     is_required_phrase: no
-    skip_collecting_required_phrases: no
+    skip_for_required_phrase_generation: no
     is_continuous: no
     is_builtin: yes
     is_from_license: no
diff --git a/tests/licensedcode/data/additional_licenses/additional_license_combined_test.expected.json b/tests/licensedcode/data/additional_licenses/additional_license_combined_test.expected.json
@@ -271,7 +271,7 @@
       "is_license_intro": false,
       "is_license_clue": false,
       "is_required_phrase": false,
-      "skip_collecting_required_phrases": false,
+      "skip_for_required_phrase_generation": false,
       "is_continuous": false,
       "is_builtin": true,
       "is_from_license": false,
@@ -300,7 +300,7 @@
       "is_license_intro": false,
       "is_license_clue": false,
       "is_required_phrase": false,
-      "skip_collecting_required_phrases": false,
+      "skip_for_required_phrase_generation": false,
       "is_continuous": false,
       "is_builtin": false,
       "is_from_license": true,
@@ -329,7 +329,7 @@
       "is_license_intro": false,
       "is_license_clue": false,
       "is_required_phrase": false,
-      "skip_collecting_required_phrases": false,
+      "skip_for_required_phrase_generation": false,
       "is_continuous": false,
       "is_builtin": false,
       "is_from_license": true,
@@ -358,7 +358,7 @@
       "is_license_intro": false,
       "is_license_clue": false,
       "is_required_phrase": false,
-      "skip_collecting_required_phrases": false,
+      "skip_for_required_phrase_generation": false,
       "is_continuous": false,
       "is_builtin": false,
       "is_from_license": true,
@@ -387,7 +387,7 @@
       "is_license_intro": false,
       "is_license_clue": false,
       "is_required_phrase": false,
-      "skip_collecting_required_phrases": false,
+      "skip_for_required_phrase_generation": false,
       "is_continuous": false,
       "is_builtin": false,
       "is_from_license": true,
diff --git a/tests/licensedcode/data/additional_licenses/additional_license_directory_test.expected.json b/tests/licensedcode/data/additional_licenses/additional_license_directory_test.expected.json
@@ -118,7 +118,7 @@
       "is_license_intro": false,
       "is_license_clue": false,
       "is_required_phrase": false,
-      "skip_collecting_required_phrases": false,
+      "skip_for_required_phrase_generation": false,
       "is_continuous": false,
       "is_builtin": false,
       "is_from_license": true,
@@ -147,7 +147,7 @@
       "is_license_intro": false,
       "is_license_clue": false,
       "is_required_phrase": false,
-      "skip_collecting_required_phrases": false,
+      "skip_for_required_phrase_generation": false,
       "is_continuous": false,
       "is_builtin": false,
       "is_from_license": true,
diff --git a/tests/licensedcode/data/additional_licenses/additional_license_plugin_test.expected.json b/tests/licensedcode/data/additional_licenses/additional_license_plugin_test.expected.json
diff --git a/tests/licensedcode/data/licenses_reference_reporting/license-reference-works-with-clues.expected.json b/tests/licensedcode/data/licenses_reference_reporting/license-reference-works-with-clues.expected.json
diff --git a/tests/licensedcode/data/licenses_reference_reporting/scan-matched-text-with-reference.expected.json b/tests/licensedcode/data/licenses_reference_reporting/scan-matched-text-with-reference.expected.json
diff --git a/tests/licensedcode/data/licenses_reference_reporting/scan-with-reference.expected.json b/tests/licensedcode/data/licenses_reference_reporting/scan-with-reference.expected.json
diff --git a/tests/licensedcode/data/plugin_license/clues/woodstox.expected.json b/tests/licensedcode/data/plugin_license/clues/woodstox.expected.json
diff --git a/tests/licensedcode/data/plugin_license/license-expression/scan.expected.json b/tests/licensedcode/data/plugin_license/license-expression/scan.expected.json
diff --git a/tests/licensedcode/data/plugin_license/license-expression/spdx-expressions.expected.json b/tests/licensedcode/data/plugin_license/license-expression/spdx-expressions.expected.json
