decode 0.19.0 → 0.20.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2f65c84b60030a9ea35d172094ef5e5dade644f5b3c5182272e561e4888ca39
-  data.tar.gz: c33ef119078aa7f63162dae206f15db5ae0ba8a04487f8d56f57142205cb71fa
+  metadata.gz: cad37ec3456d7b6edc9bcfa36c28b4f05c83ba978fed9a1989d0c0daba8b12c9
+  data.tar.gz: 559c5b61c73b58f420591361502c76f81e168c74e1c425dfcb2a89bf4766c9d9
 SHA512:
-  metadata.gz: 509ee339eaf27970f49e9aad9ca1771878e5d4999ea8f37703a62bc7c73c7eff6a1d1ff9afd5a699068763b4251d0037f454bc99fa12f3df19a59da6d867979f
-  data.tar.gz: fdea851ce3257fe97362935d1b08f6cf704a69478444c7dcef9367ac486724dd5a66595b6dddd1a44b7df98de09c7b18a7b719efa8d04ebd0b1be126cecf349b
+  metadata.gz: b1e7915cb517d46bc9372734244045bffe3bd32acaae6bd7cb3f4dd7eaef9240faf74b63bff4249a7d7fc7a7ab2623aff4178d41eb0a4875f735fcd724ff6fd2
+  data.tar.gz: a79d14e85375ecf5a7aa3a961ee42033bb3381b9f057472a7126b2dbde8be2cf2fd3d2eab0bd55a371e03f3085f2ed6bf3525c0b047284dd996a6b68c8756a20

data/bake/decode/index.rb

@@ -29,3 +29,49 @@ def coverage(root)
 	
 	$stderr.puts "#{documented}/#{total} definitions have documentation."
 end
+
+# Process the given source root and report on symbols.
+# @parameter root [String] The root path to index.
+def symbols(root)
+	require 'build/files/glob'
+	require 'decode/index'
+	
+	paths = Build::Files::Path.expand(root).glob("**/*")
+	
+	index = Decode::Index.new
+	index.update(paths)
+	
+	index.trie.traverse do |path, node, descend|
+		level = path.size
+		puts "#{"  " * level}#{path.inspect} -> #{node.values.inspect}"
+		
+		if path.any?
+			puts "#{"  " * level}#{path.join("::")}"
+		end
+		
+		descend.call
+	end
+end
+
+# Print documentation for all definitions.
+# @parameter root [String] The root path to index.
+def documentation(root)
+	require 'build/files/glob'
+	require 'decode/index'
+	
+	paths = Build::Files::Path.expand(root).glob("**/*")
+	
+	index = Decode::Index.new
+	index.update(paths)
+	
+	index.definitions.each do |name, definition|
+		comments = definition.comments
+		
+		if comments
+			puts "## `#{name}`"
+			puts
+			puts comments
+			puts
+		end
+	end
+end

data/lib/decode/comment/node.rb

@@ -47,7 +47,7 @@ module Decode
 				end
 			end
 			
-			# Any lines of text associated wtih this node.
+			# Any lines of text associated with this node.
 			# @returns [Array(String) | Nil] The lines of text.
 			def text
 				if text = self.extract_text
@@ -55,8 +55,7 @@ module Decode
 				end
 			end
 			
-			# Traverse the tags from this node using {each}.
-			# Invoke `descend.call(child)` to recursively traverse the specified child.
+			# Traverse the tags from this node using {each}. Invoke `descend.call(child)` to recursively traverse the specified child.
 			#
 			# @yields {|node, descend| descend.call}
 			# 	@parameter node [Node] The current node which is being traversed.

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

@@ -74,10 +74,6 @@ module Decode
 				# Walk over the syntax tree and extract relevant definitions with their associated comments.
 				def walk_definitions(node, comments, parent = nil, &block)
 					case node.type
-					when :begin
-						node.children.each do |child|
-							walk_definitions(child, comments, parent, &block)
-						end
 					when :module
 						definition = Module.new(
 							node, nested_name_for(node.children[0]),
@@ -126,10 +122,13 @@ module Decode
 						
 						yield definition
 					when :defs
+						extracted_comments = extract_comments_for(node, comments)
+						
 						definition = Function.new(
 							node, node.children[1],
-							comments: extract_comments_for(node, comments),
-							parent: parent, language: @language
+							comments: extracted_comments,
+							parent: scope_for(extracted_comments, parent, &block),
+							language: @language
 						)
 						
 						yield definition
@@ -186,6 +185,12 @@ module Decode
 								walk_definitions(children, comments, definition, &block)
 							end
 						end
+					else
+						node.children.each do |child|
+							if child.is_a?(::Parser::AST::Node)
+								walk_definitions(child, comments, parent, &block) if child
+							end
+						end
 					end
 				end
 				

data/lib/decode/version.rb

@@ -4,5 +4,5 @@
 # Copyright, 2020-2022, by Samuel Williams.
 
 module Decode
-	VERSION = "0.19.0"
+	VERSION = "0.20.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: decode
 version: !ruby/object:Gem::Version
-  version: 0.19.0
+  version: 0.20.1
 platform: ruby
 authors:
 - Samuel Williams
@@ -37,7 +37,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2023-05-26 00:00:00.000000000 Z
+date: 2023-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -125,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.7
+rubygems_version: 3.4.22
 signing_key:
 specification_version: 4
 summary: Code analysis for documentation generation.