decode 0.24.5 → 0.24.6
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
- checksums.yaml.gz.sig +0 -0
- data/bake/decode/index.rb +1 -1
- data/context/coverage.md +1 -1
- data/lib/decode/definition.rb +5 -0
- data/lib/decode/language/ruby/alias.rb +6 -0
- data/lib/decode/version.rb +1 -1
- data.tar.gz.sig +0 -0
- metadata +2 -2
- metadata.gz.sig +0 -0
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 91c5a87fbfc1bcd6967d833aebc9dc5a60286b4c1037041e24ef46f69461f2af
|
4
|
+
data.tar.gz: 35ee291f1b2ca2d61b06b64c2ed6112789fb70515379a0fb82384c9d8c4a34cd
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 83069393060cd00d008a6ba267a719af5fb0cf3e31426814da9bab6a0e668dd025877fd7008d1185dcfb87810318c82c02d60f297558f6c17025c3e9c2080e5d
|
7
|
+
data.tar.gz: 29962ee76526d90a7661b8b1afb3f606d1abde809987bd0d62d4d3b0cf2282121089bfe645686c8e2e70c05a6b69ddfcfb4d1bde26b4806b9679cdd8d99a43b6
|
checksums.yaml.gz.sig
CHANGED
Binary file
|
data/bake/decode/index.rb
CHANGED
data/context/coverage.md
CHANGED
@@ -254,7 +254,7 @@ def coverage_percentage(root)
|
|
254
254
|
|
255
255
|
index.trie.traverse do |path, node, descend|
|
256
256
|
node.values&.each do |definition|
|
257
|
-
if definition.
|
257
|
+
if definition.coverage_relevant?
|
258
258
|
total += 1
|
259
259
|
documented += 1 if definition.comments&.any?
|
260
260
|
end
|
data/lib/decode/definition.rb
CHANGED
@@ -82,6 +82,11 @@ module Decode
|
|
82
82
|
true
|
83
83
|
end
|
84
84
|
|
85
|
+
# @returns [bool] If the definition should be counted in coverage metrics.
|
86
|
+
def coverage_relevant?
|
87
|
+
self.public?
|
88
|
+
end
|
89
|
+
|
85
90
|
# Whether the definition has documentation.
|
86
91
|
# @returns [bool] True if the definition has non-empty comments.
|
87
92
|
def documented?
|
@@ -21,6 +21,12 @@ module Decode
|
|
21
21
|
|
22
22
|
attr :old_name
|
23
23
|
|
24
|
+
# Aliases don't require separate documentation as they reference existing methods.
|
25
|
+
# @returns [bool] Always false for aliases.
|
26
|
+
def coverage_relevant?
|
27
|
+
false
|
28
|
+
end
|
29
|
+
|
24
30
|
# Generate a short form representation of the alias.
|
25
31
|
def short_form
|
26
32
|
"alias #{self.name} #{@old_name}"
|
data/lib/decode/version.rb
CHANGED
data.tar.gz.sig
CHANGED
Binary file
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: decode
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.24.
|
4
|
+
version: 0.24.6
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Samuel Williams
|
@@ -156,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
156
156
|
- !ruby/object:Gem::Version
|
157
157
|
version: '0'
|
158
158
|
requirements: []
|
159
|
-
rubygems_version: 3.6.
|
159
|
+
rubygems_version: 3.6.9
|
160
160
|
specification_version: 4
|
161
161
|
summary: Code analysis for documentation generation.
|
162
162
|
test_files: []
|
metadata.gz.sig
CHANGED
Binary file
|