metanorma-utils 2.0.10 → 2.0.12
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/utils/log.rb +59 -2
- data/lib/utils/version.rb +1 -1
- data/metanorma-utils.gemspec +0 -1
- metadata +2 -16
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 0c1e1dcd39f422719231a463baad92a7cfb2774836497b5b862c9baa1bf457f1
|
|
4
|
+
data.tar.gz: a665005b573ead115c5304f1ddaa675070dd73b5563e120046610133fa3f2690
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 35ab1ff450498d18369cb240313c830347a8d90dee2c6a690341901ddc6bf00f64fe2797501df48777d0858b5ee409ee91d1a98842048bcd56de07807749625c
|
|
7
|
+
data.tar.gz: 15e6daaa1c5c2a8db6ae670d0f045465f65fa001e24632592515b31ca71cd4149eb1f03082272df45104b333f64bff7172518ae8ed4781ef0e6bf9d91faffedc
|
data/lib/utils/log.rb
CHANGED
|
@@ -4,16 +4,27 @@ require_relative "log_html"
|
|
|
4
4
|
module Metanorma
|
|
5
5
|
module Utils
|
|
6
6
|
class Log
|
|
7
|
-
attr_accessor :suppress_log
|
|
7
|
+
attr_accessor :suppress_log, :suppression
|
|
8
8
|
|
|
9
9
|
# messages: hash of message IDs to {error, severity, category}
|
|
10
10
|
# severity: 0: abort; 1: serious; 2: not serious; 3: info only
|
|
11
|
+
#
|
|
12
|
+
# suppression: optional object answering
|
|
13
|
+
# action_for(id:, message:, category:, severity:, location:)
|
|
14
|
+
# returning nil or { action: :off | :reclassify | :exclude | :allow,
|
|
15
|
+
# reason: String, severity: Integer } (severity for :reclassify).
|
|
16
|
+
# :off, :exclude and :allow route to the suppressed store (audited,
|
|
17
|
+
# never silently dropped); :reclassify overrides the entry's
|
|
18
|
+
# severity before any severity-based decision. Declarative
|
|
19
|
+
# validation suppression, metanorma-standoc#1369.
|
|
11
20
|
def initialize(messages = {})
|
|
12
21
|
@log = {}
|
|
22
|
+
@suppressed_messages = []
|
|
23
|
+
@suppression = nil
|
|
13
24
|
@c = HTMLEntities.new
|
|
14
25
|
@mapid = {}
|
|
15
26
|
@suppress_log = { severity: 4, category: [], error_ids: [],
|
|
16
|
-
locations: [] }
|
|
27
|
+
error_regexes: [], locations: [] }
|
|
17
28
|
@msg = messages.each_value do |v|
|
|
18
29
|
v[:error] = v[:error]
|
|
19
30
|
.encode("UTF-8", invalid: :replace, undef: :replace)
|
|
@@ -49,12 +60,51 @@ module Metanorma
|
|
|
49
60
|
def add(id, loc, display: true, params: [])
|
|
50
61
|
m = add_prep(id) or return
|
|
51
62
|
msg = create_entry(loc, m[:error], m[:severity], id, params)
|
|
63
|
+
return if suppressed_message?(msg[:error])
|
|
64
|
+
|
|
65
|
+
# ::Hash: Metanorma::Utils::Hash shadows the core constant here
|
|
66
|
+
case (action = suppression_action(msg, m, id, loc))
|
|
67
|
+
when ::Hash
|
|
68
|
+
case action[:action]
|
|
69
|
+
when :off, :exclude, :allow
|
|
70
|
+
record_suppressed(msg, action)
|
|
71
|
+
return
|
|
72
|
+
when :reclassify
|
|
73
|
+
# Reclassification precedes every severity-based decision, so a
|
|
74
|
+
# severity-0 (abort) entry reclassified away never aborts, and
|
|
75
|
+
# the active log carries the configured severity.
|
|
76
|
+
msg[:severity] = action[:severity]
|
|
77
|
+
end
|
|
78
|
+
end
|
|
79
|
+
|
|
52
80
|
@log[m[:category]] << msg
|
|
53
81
|
loc = loc.nil? ? "" : "(#{current_location(loc)[0]}): "
|
|
54
82
|
suppress_display?(m[:category], loc, msg, display) or
|
|
55
83
|
warn "#{m[:category]}: #{loc}#{msg[:error]}"
|
|
56
84
|
end
|
|
57
85
|
|
|
86
|
+
# Entries suppressed by the suppression hook: normal message shape,
|
|
87
|
+
# plus the suppression reason and the severity before suppression.
|
|
88
|
+
# The store is per-instance, like @log.
|
|
89
|
+
attr_reader :suppressed_messages
|
|
90
|
+
|
|
91
|
+
def suppressed?
|
|
92
|
+
!@suppressed_messages.empty?
|
|
93
|
+
end
|
|
94
|
+
|
|
95
|
+
# internal, but left public: this class has no private surface and
|
|
96
|
+
# flavors re-open it
|
|
97
|
+
def suppression_action(msg, m, id, loc)
|
|
98
|
+
@suppression&.action_for(id: id.to_s, message: msg[:error],
|
|
99
|
+
category: m[:category],
|
|
100
|
+
severity: msg[:severity], location: loc)
|
|
101
|
+
end
|
|
102
|
+
|
|
103
|
+
def record_suppressed(msg, action)
|
|
104
|
+
@suppressed_messages << msg.merge(suppressed_by: action[:reason],
|
|
105
|
+
original_severity: msg[:severity])
|
|
106
|
+
end
|
|
107
|
+
|
|
58
108
|
def abort_messages
|
|
59
109
|
@log.values.each_with_object([]) do |v, m|
|
|
60
110
|
v.each do |e|
|
|
@@ -79,6 +129,13 @@ module Metanorma
|
|
|
79
129
|
@suppress_log[:error_ids].include?(id.to_s)
|
|
80
130
|
end
|
|
81
131
|
|
|
132
|
+
# Message-text suppressions (`log-filter-error-regex`): drop entries
|
|
133
|
+
# whose interpolated message matches any pattern, without suppressing
|
|
134
|
+
# the other messages sharing the same code.
|
|
135
|
+
def suppressed_message?(text)
|
|
136
|
+
Array(@suppress_log[:error_regexes]).any? { |re| re.match?(text) }
|
|
137
|
+
end
|
|
138
|
+
|
|
82
139
|
def suppress_display?(category, _loc, _msg, display)
|
|
83
140
|
["Metanorma XML Syntax", "Relaton"].include?(category) ||
|
|
84
141
|
!display
|
data/lib/utils/version.rb
CHANGED
data/metanorma-utils.gemspec
CHANGED
|
@@ -37,7 +37,6 @@ Gem::Specification.new do |spec|
|
|
|
37
37
|
|
|
38
38
|
spec.add_development_dependency "bundler"
|
|
39
39
|
spec.add_development_dependency "debug"
|
|
40
|
-
spec.add_development_dependency "equivalent-xml", "~> 0.6"
|
|
41
40
|
spec.add_development_dependency "guard", "~> 2.14"
|
|
42
41
|
spec.add_development_dependency "guard-rspec", "~> 4.7"
|
|
43
42
|
spec.add_development_dependency "rake", "~> 13.0"
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: metanorma-utils
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 2.0.
|
|
4
|
+
version: 2.0.12
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Ribose Inc.
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2026-
|
|
11
|
+
date: 2026-11-12 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: asciidoctor
|
|
@@ -150,20 +150,6 @@ dependencies:
|
|
|
150
150
|
- - ">="
|
|
151
151
|
- !ruby/object:Gem::Version
|
|
152
152
|
version: '0'
|
|
153
|
-
- !ruby/object:Gem::Dependency
|
|
154
|
-
name: equivalent-xml
|
|
155
|
-
requirement: !ruby/object:Gem::Requirement
|
|
156
|
-
requirements:
|
|
157
|
-
- - "~>"
|
|
158
|
-
- !ruby/object:Gem::Version
|
|
159
|
-
version: '0.6'
|
|
160
|
-
type: :development
|
|
161
|
-
prerelease: false
|
|
162
|
-
version_requirements: !ruby/object:Gem::Requirement
|
|
163
|
-
requirements:
|
|
164
|
-
- - "~>"
|
|
165
|
-
- !ruby/object:Gem::Version
|
|
166
|
-
version: '0.6'
|
|
167
153
|
- !ruby/object:Gem::Dependency
|
|
168
154
|
name: guard
|
|
169
155
|
requirement: !ruby/object:Gem::Requirement
|