decode 0.24.5 → 0.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 403ad9626fb4852046e983a7d5c71d1edf6d5d1ab922b8872c46f3b856303291
-  data.tar.gz: ec06989a5e4081c1c23e2f6ed39049faaf449c866370496de19a35a31c1a703a
+  metadata.gz: 01244e4f44a9916295cace389ef8ad2116277a1e5831f500d1e13d953290386a
+  data.tar.gz: e3a85a7b3c2c4d98aa8acc50026a2b515bc33db95fff2ec82c117cda0c1ded52
 SHA512:
-  metadata.gz: bc8f774f1f9ed21c1d985dc7124fbf2c5c6ea37b3502575186fcbbe6b406d0e62a6914a2c6929d72ef0ec258603b14146c71ac04e2867c3f2ed597f766dededc
-  data.tar.gz: be3291575b35ee43dc03a33a3f8e28f99ed3a792ec156d2a297a0956e00ae569217c5d8afe80f3c5f1bce1b77cc186fe317fdceda19a98d43ec72663014bebab
+  metadata.gz: 974b45b31551d81b281fe5a483a93e0b3ed07a3b6508dbd30df014b45cc2b47a51a34ae6f20454bd973ec7fe5c23393a7176c20028e6dba9a1402fb987c79eb2
+  data.tar.gz: 5028c457dc3c24d79996170725604fddffc127f96a96f8fdf5c3c4188162097538cb103be51808d125e3ed3edec786104874123197bd6e37bd8e463fcf7319b5

data/bake/decode/index.rb

@@ -22,7 +22,7 @@ def coverage(root)
 		public_definition = node.values.nil?
 		
 		node.values&.each do |definition|
-			if definition.public?
+			if definition.coverage_relevant?
 				level = path.size
 				
 				if definition.documented?

data/context/coverage.md

@@ -254,7 +254,7 @@ def coverage_percentage(root)
   
   index.trie.traverse do |path, node, descend|
     node.values&.each do |definition|
-      if definition.public?
+      if definition.coverage_relevant?
         total += 1
         documented += 1 if definition.comments&.any?
       end

data/lib/decode/definition.rb

@@ -82,6 +82,11 @@ module Decode
 			true
 		end
 		
+		# @returns [bool] If the definition should be counted in coverage metrics.
+		def coverage_relevant?
+			self.public?
+		end
+		
 		# Whether the definition has documentation.
 		# @returns [bool] True if the definition has non-empty comments.
 		def documented?

data/lib/decode/language/ruby/alias.rb

@@ -21,6 +21,12 @@ module Decode
 				
 				attr :old_name
 				
+				# Aliases don't require separate documentation as they reference existing methods.
+				# @returns [bool] Always false for aliases.
+				def coverage_relevant?
+					false
+				end
+				
 				# Generate a short form representation of the alias.
 				def short_form
 					"alias #{self.name} #{@old_name}"

data/lib/decode/language/ruby/class.rb

@@ -78,6 +78,11 @@ module Decode
 				# The long form is the same as the short form.
 				alias long_form short_form
 				
+				# Coverage is not relevant for singleton classes.
+				def coverage_relevant?
+					false
+				end
+				
 				private
 				
 				def absolute_path

data/lib/decode/version.rb

@@ -5,5 +5,5 @@
 
 module Decode
 	# @constant [String] The version of the gem.
-	VERSION = "0.24.5"
+	VERSION = "0.25.0"
 end

data/readme.md

@@ -22,6 +22,10 @@ Please see the [project documentation](https://socketry.github.io/decode/) for m
 
 Please see the [project releases](https://socketry.github.io/decode/releases/index) for all releases.
 
+### v0.25.0
+
+  - Singleton classes are not relevant for coverage, so they are now ignored by the coverage reporter.
+
 ### v0.24.4
 
   - Add support for `@constant [Type] Description.` tags.

data/releases.md

@@ -1,5 +1,9 @@
 # Releases
 
+## v0.25.0
+
+  - Singleton classes are not relevant for coverage, so they are now ignored by the coverage reporter.
+
 ## v0.24.4
 
   - Add support for `@constant [Type] Description.` tags.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: decode
 version: !ruby/object:Gem::Version
-  version: 0.24.5
+  version: 0.25.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -156,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Code analysis for documentation generation.
 test_files: []