decode 0.24.0 → 0.24.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8caef896e4f0541d426216be2ee041cd78ef81642b677a420d9f89f77a719ae0
-  data.tar.gz: 26c7090e233385633a99ec80f906f6cc7f429dd3eb02fe0d24a87ab9019b2931
+  metadata.gz: d6a3ca54cbbfe55c6946466efdeef71ee9b103ceb59ab27c313a9e3a4345264b
+  data.tar.gz: 00fe1c5faa769e7daa607cd46a48920ad04b4926493e1b841154d9a5f193b12a
 SHA512:
-  metadata.gz: 9b3ef91c4974a9d9cad7b5918dd885d55838c4a0d1f0eb06e2584bcde500e6bc657ef2bb11c50b6963171336153ae76a8b8d2365ed5444895906b35272e4795f
-  data.tar.gz: 4c60126b5604f42b9c8f9e1f10d47ba264d52042a0365881df2957bf77ad0faf6a2f8a9fc7e05c77c430a8376a873b606d9e5112bddee194944323247108e139
+  metadata.gz: 288e3c278877013c633055242d28c1f2097ca38576896f86d486ee56f1ef3e246af36dce75d30c9c364cd65b9d4928b875b0f7d384c485efde3b27cad8658b14
+  data.tar.gz: debf415bab150aaeb345e3013bc6d07896ccf02006e0787eef2ba73754b9c02725007df042e397bedfc02d0b7b8acc266a946535acafcc6d03bd4e069836a937

data/lib/decode/comment/tags.rb

@@ -56,7 +56,7 @@ module Decode
 						else
 							# Ignore unknown directive.
 						end
-					
+						
 					# Or it's just text:
 					else
 						yield Text.new(line)

data/lib/decode/index.rb

@@ -57,10 +57,10 @@ module Decode
 		def inspect
 			"#<#{self.class} #{@definitions.size} definition(s)>"
 		end
-
+		
 		# Generate a string representation of the index.
 		alias to_s inspect
-
+		
 		# All supported languages for this index.
 		# @attribute [Languages] The languages this index can parse.
 		attr :languages

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

@@ -56,7 +56,7 @@ module Decode
 				def nested_name
 					"class"
 				end
-
+				
 				# A singleton class is a container for other definitions.
 				# @returns [Boolean]
 				def container?

data/lib/decode/rbs/class.rb

@@ -8,13 +8,18 @@ require_relative "wrapper"
 require_relative "method"
 module Decode
 	module RBS
+		# Represents a Ruby class definition wrapper for RBS generation.
 		class Class < Wrapper
 			
+			# Initialize a new class wrapper.
+			# @parameter definition [Decode::Definition] The class definition to wrap.
 			def initialize(definition)
 				super
 				@generics = nil
 			end
 			
+			# Extract generic type parameters from the class definition.
+			# @returns [Array] The generic type parameters for this class.
 			def generics
 				@generics ||= extract_generics
 			end

data/lib/decode/rbs/generator.rb

@@ -10,7 +10,10 @@ require_relative "module"
 
 module Decode
 	module RBS
+		# Represents a generator for RBS type declarations.
 		class Generator
+			# Initialize a new RBS generator.
+			# Sets up the RBS environment for type resolution.
 			def initialize
 				# Set up RBS environment for type resolution
 				@loader = ::RBS::EnvironmentLoader.new()
@@ -23,16 +26,19 @@ module Decode
 			def generate(index, output: $stdout)
 				# Build nested RBS AST structure using a hash for proper ||= behavior
 				declarations = {}
+				roots = {}
 				
 				# Efficiently traverse the trie to find containers and their methods
 				index.trie.traverse do |lexical_path, node, descend|
 					# Process container definitions at this node
 					if node.values
-						containers = node.values.select {|definition| definition.container? && definition.public?}
+						containers = node.values.select{|definition| definition.container? && definition.public?}
 						containers.each do |definition|
 							case definition
 							when Decode::Language::Ruby::Class, Decode::Language::Ruby::Module
-								build_nested_declaration(definition, declarations, index)
+								if declaration = build_nested_declaration(definition, declarations, index)
+									roots[definition.qualified_name] ||= declaration
+								end
 							end
 						end
 					end
@@ -44,18 +50,20 @@ module Decode
 				# Write the RBS output
 				writer = ::RBS::Writer.new(out: output)
 				
-				unless declarations.empty?
-					writer.write(declarations.values)
+				unless roots.empty?
+					writer.write(roots.values)
 				end
 			end
 			
 			private
 			
-			# Build nested RBS declarations preserving the parent hierarchy
+			# Build nested RBS declarations preserving the parent hierarchy.
+			# @returns [::RBS::AST::Declarations::Class | ::RBS::AST::Declarations::Module] If the definition has no parent, returns the declaration.
+			# @returns [Nil] If the definition has a parent, adds to parent's members.
 			def build_nested_declaration(definition, declarations, index)
 				# Create the declaration for this definition using ||= to avoid duplicates
 				qualified_name = definition.qualified_name
-				declarations[qualified_name] ||= definition_to_rbs(definition, index)
+				declaration = (declarations[qualified_name] ||= definition_to_rbs(definition, index))
 				
 				# Add this declaration to its parent's members if it has a parent
 				if definition.parent
@@ -63,11 +71,13 @@ module Decode
 					parent_container = declarations[parent_qualified_name]
 					
 					# Only add if not already present
-					unless parent_container.members.any? {|member| 
-						member.respond_to?(:name) && member.name.name == definition.name.to_sym 
-					}
+					unless parent_container.members.any?{|member| member.respond_to?(:name) && member.name.name == definition.name.to_sym}
 						parent_container.members << declarations[qualified_name]
 					end
+					
+					return nil
+				else
+					return declaration
 				end
 			end
 			

data/lib/decode/rbs/method.rb

@@ -10,13 +10,18 @@ require_relative "wrapper"
 
 module Decode
 	module RBS
+		# Represents a Ruby method definition wrapper for RBS generation.
 		class Method < Wrapper
 			
+			# Initialize a new method wrapper.
+			# @parameter definition [Decode::Definition] The method definition to wrap.
 			def initialize(definition)
 				super
 				@signatures = nil
 			end
 			
+			# Extract method signatures from the method definition.
+			# @returns [Array] The extracted signatures for this method.
 			def signatures
 				@signatures ||= extract_signatures
 			end

data/lib/decode/rbs/module.rb

@@ -8,8 +8,11 @@ require_relative "wrapper"
 
 module Decode
 	module RBS
+		# Represents a Ruby module definition wrapper for RBS generation.
 		class Module < Wrapper
 			
+			# Initialize a new module wrapper.
+			# @parameter definition [Decode::Definition] The module definition to wrap.
 			def initialize(definition)
 				super
 			end

data/lib/decode/rbs.rb

@@ -9,3 +9,9 @@ require_relative "rbs/class"
 require_relative "rbs/method"
 require_relative "rbs/module"
 require_relative "rbs/generator"
+
+module Decode
+	# RBS generation functionality for Ruby type signatures.
+	module RBS
+	end
+end

data/lib/decode/trie.rb

@@ -21,10 +21,10 @@ module Decode
 			def inspect
 				"#<#{self.class} #{@children.size} children>"
 			end
-
+			
 			# Generate a string representation of the node.
 			alias to_s inspect
-
+			
 			# A mutable array of all values that terminate at this node.
 			# @attribute [Array | Nil] The values stored at this node, or nil if no values.
 			attr_accessor :values

data/lib/decode/version.rb

@@ -4,5 +4,5 @@
 # Copyright, 2020-2025, by Samuel Williams.
 
 module Decode
-	VERSION = "0.24.0"
+	VERSION = "0.24.2"
 end

data/readme.md

@@ -2,7 +2,7 @@
 
 A Ruby code analysis tool and documentation generator.
 
-[![Development Status](https://github.com/ioquatix/decode/workflows/Test/badge.svg)](https://github.com/ioquatix/decode/actions?workflow=Test)
+[![Development Status](https://github.com/socketry/decode/workflows/Test/badge.svg)](https://github.com/socketry/decode/actions?workflow=Test)
 
 ## Motivation
 
@@ -10,21 +10,21 @@ As part of my effort to build [better project documentation](https://github.com/
 
 ## Usage
 
-Please see the [project documentation](https://ioquatix.github.io/decode/) for more details.
+Please see the [project documentation](https://socketry.github.io/decode/) for more details.
 
-  - [Getting Started](https://ioquatix.github.io/decode/guides/getting-started/index) - This guide explains how to use `decode` for source code analysis.
+  - [Getting Started](https://socketry.github.io/decode/guides/getting-started/index) - This guide explains how to use `decode` for source code analysis.
 
-  - [Code Coverage](https://ioquatix.github.io/decode/guides/code-coverage/index) - This guide explains how to compute documentation code coverage.
+  - [Code Coverage](https://socketry.github.io/decode/guides/code-coverage/index) - This guide explains how to compute documentation code coverage.
 
-  - [Extract Symbols](https://ioquatix.github.io/decode/guides/extract-symbols/index) - This example demonstrates how to extract symbols using the index. An instance of <code class="language-ruby">Decode::Index</code> is used for loading symbols from source code files. These symbols are available as a flat list and as a trie structure. You can look up specific symbols using a reference using <code class="language-ruby">Decode::Index\#lookup</code>.
+  - [Extract Symbols](https://socketry.github.io/decode/guides/extract-symbols/index) - This example demonstrates how to extract symbols using the index. An instance of <code class="language-ruby">Decode::Index</code> is used for loading symbols from source code files. These symbols are available as a flat list and as a trie structure. You can look up specific symbols using a reference using <code class="language-ruby">Decode::Index\#lookup</code>.
 
 ## Releases
 
-Please see the [project releases](https://ioquatix.github.io/decode/releases/index) for all releases.
+Please see the [project releases](https://socketry.github.io/decode/releases/index) for all releases.
 
 ### v0.24.0
 
-  - [Introduce support for RBS signature generation.](https://ioquatix.github.io/decode/releases/index#introduce-support-for-rbs-signature-generation.)
+  - [Introduce support for RBS signature generation](https://socketry.github.io/decode/releases/index#introduce-support-for-rbs-signature-generation)
 
 ### v0.23.5
 

data/releases.md

@@ -2,25 +2,25 @@
 
 ## v0.24.0
 
-### Introduce support for RBS signature generation.
+### Introduce support for RBS signature generation
 
 Decode now supports generating RBS type signatures from Ruby source code, making it easier to add type annotations to existing Ruby projects. The RBS generator analyzes your Ruby code and documentation to produce type signatures that can be used with tools like Steep, TypeProf, and other RBS-compatible type checkers.
 
 To generate RBS signatures for your Ruby code, use the provided bake task:
 
 ``` bash
-# Generate RBS signatures for the current directory
-bundle exec bake decode:rbs:generate .
+-- Generate RBS signatures for the current directory
+$ bundle exec bake decode:rbs:generate .
 
-# Generate RBS signatures for a specific directory
-bundle exec bake decode:rbs:generate lib/
+-- Generate RBS signatures for a specific directory
+$ bundle exec bake decode:rbs:generate lib/
 ```
 
 The generator will output RBS declarations to stdout, which you can redirect to a file:
 
 ``` bash
-# Save RBS signatures to a file
-bundle exec bake decode:rbs:generate lib/ > sig/generated.rbs
+-- Save RBS signatures to a file
+$ bundle exec bake decode:rbs:generate lib/ > sig/generated.rbs
 ```
 
 The RBS generator produces type signatures for:

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: decode
 version: !ruby/object:Gem::Version
-  version: 0.24.0
+  version: 0.24.2
 platform: ruby
 authors:
 - Samuel Williams
@@ -145,13 +145,13 @@ files:
 - license.md
 - readme.md
 - releases.md
-homepage: https://github.com/ioquatix/decode
+homepage: https://github.com/socketry/decode
 licenses:
 - MIT
 metadata:
-  documentation_uri: https://ioquatix.github.io/decode/
-  funding_uri: https://github.com/sponsors/ioquatix/
-  source_code_uri: https://github.com/ioquatix/decode.git
+  documentation_uri: https://socketry.github.io/decode/
+  funding_uri: https://github.com/sponsors/socketry/
+  source_code_uri: https://github.com/socketry/decode.git
 rdoc_options: []
 require_paths:
 - lib