decode 0.17.1 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e93383d44bf331fbbe47bf804d1f59331de0437d9adbe725ba9a9182510842ef
-  data.tar.gz: 48e8dc949ea4ea603da59bfde63e42040b6fe3df448064fd0107fa2d8fd2d99a
+  metadata.gz: 07565b4d2600fe3cd6552192f8faae065fbd728e98f51008863326a1b4f7f743
+  data.tar.gz: a16e3cf053d0ac25c9e0f2e596832dabf44f027edf0ad509ed7eb20559d685e5
 SHA512:
-  metadata.gz: 9b74c5d5c31cc1f8b0bc0dbc3a9e00ab2d8862763d009acfbb7734ae330138d264ddd06cb6ae2efa23ce907d1f7af330ef5e43475e828bdfaca32c9cc87c87a7
-  data.tar.gz: 3d1c155aa5cb886fe536d6e15ab04e3a955b59be026b223a8ae064ae175e635293f3dc12dd292eb0a15622f371d0c4687e3ef62534bba34fa8e092f616ae4b35
+  metadata.gz: a1e7ccf9434ddd07c98ce94e64741f30af06698b9841935b99ecc0f7e5027aa76a8ce97778bade6cdaf25853f03d7ec8d2372715bd328ada2b844b4daf68c2a5
+  data.tar.gz: 69d195150f777b3484de296ef8d093e6531856bbc111d3d75e58d806478ecb84506223f5e5372656c06df28e8e1e326817f287dcc680c9055e7286b58fd9a2d2

data/lib/decode/definition.rb

@@ -18,6 +18,8 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
+require_relative 'location'
+
 module Decode
 	# A symbol with attached documentation.
 	class Definition
@@ -97,13 +99,17 @@ module Decode
 				@path
 			elsif @parent
 				# Merge with parent:
-				@path = [*@parent.path, @name].freeze
+				@path = [*@parent.path, *path_name].freeze
 			else
 				# At top:
-				@path = [@name].freeze
+				@path = path_name.freeze
 			end
 		end
 		
+		def path_name
+			[@name]
+		end
+		
 		alias lexical_path path
 		
 		# A short form of the definition.
@@ -164,5 +170,12 @@ module Decode
 				@documentation ||= Documentation.new(@comments, @language)
 			end
 		end
+		
+		# The location of the definition.
+		#
+		# @returns [Location | Nil] A {Location} instance if this definition has a location.
+		def location
+			nil
+		end
 	end
 end

data/lib/decode/index.rb

@@ -51,7 +51,6 @@ module Decode
 		
 		# A (prefix) trie of lexically scoped definitions.
 		# @attribute [Trie]
-		
 		attr :trie
 		
 		# Updates the index by parsing the specified files.

data/lib/decode/language/generic.rb

@@ -70,25 +70,25 @@ module Decode
 			end
 			
 			# Parse the input yielding definitions.
-			# @parameter input [File] The input file which contains the source code.
+			# @parameter source [Source] The input source file which contains the source code.
 			# @yields {|definition| ...} Receives the definitions extracted from the source code.
 			# 	@parameter definition [Definition] The source code definition including methods, classes, etc.
 			# @returns [Enumerator(Segment)] If no block given.
-			def definitions_for(input, &block)
+			def definitions_for(source, &block)
 				if parser = self.parser
-					parser.definitions_for(input, &block)
+					parser.definitions_for(source, &block)
 				end
 			end
 			
 			# Parse the input yielding segments.
 			# Segments are constructed from a block of top level comments followed by a block of code.
-			# @parameter input [File] The input file which contains the source code.
+			# @parameter source [Source] The input source file which contains the source code.
 			# @yields {|segment| ...}
 			# 	@parameter segment [Segment]
 			# @returns [Enumerator(Segment)] If no block given.
-			def segments_for(input, &block)
+			def segments_for(source, &block)
 				if parser = self.parser
-					parser.segments_for(input, &block)
+					parser.segments_for(source, &block)
 				end
 			end
 		end

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

@@ -37,18 +37,22 @@ module Decode
 				# The short form of the class.
 				# e.g. `class Animal`.
 				def short_form
-					"class #{@name}"
+					"class #{path_name.last}"
 				end
 				
 				# The long form of the class.
 				# e.g. `class Dog < Animal`.
 				def long_form
-					if super_node = @node.children[1]
-						@node.location.keyword.join(
-							super_node.location.expression
-						).source
+					if super_class = self.super_class
+						"#{qualified_form} < #{super_class}"
 					else
-						self.short_form
+						qualified_form
+					end
+				end
+				
+				def super_class
+					if super_node = @node.children[1]
+						super_node.location.expression.source
 					end
 				end
 				
@@ -57,6 +61,10 @@ module Decode
 				def qualified_form
 					"class #{self.qualified_name}"
 				end
+				
+				def path_name
+					@name.to_s.split('::').map(&:to_sym)
+				end
 			end
 			
 			# A Ruby-specific singleton class.

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

@@ -59,7 +59,13 @@ module Decode
 						return lines.join
 					end
 				end
+				
+				def location
+					expression = @node.location.expression
+					
+					Location.new(expression.source_buffer.name, expression.line)
+				end
 			end
 		end
 	end
-end
+end

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

@@ -37,18 +37,23 @@ module Decode
 				# The short form of the module.
 				# e.g. `module Barnyard`.
 				def short_form
-					"module #{@name}"
+					"module #{path_name.last}"
 				end
 				
-				# The long form is the same as the short form.
-				alias long_form short_form
+				def long_form
+					qualified_form
+				end
 				
 				# The fully qualified name of the class.
 				# e.g. `module ::Barnyard::Dog`.
 				def qualified_form
 					"module #{self.qualified_name}"
 				end
+				
+				def path_name
+					@name.to_s.split('::').map(&:to_sym)
+				end
 			end
 		end
 	end
-end
+end

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

@@ -42,9 +42,19 @@ module Decode
 					@language = language
 				end
 				
+				# Parse the given source object, can be a string or a Source instance.
+				# @parameter source [String | Source] The source to parse.
+				private def parse_source(source)
+					if source.is_a?(Source)
+						::Parser::CurrentRuby.parse_with_comments(source.read, source.path)
+					else
+						::Parser::CurrentRuby.parse_with_comments(source)
+					end
+				end
+				
 				# Extract definitions from the given input file.
-				def definitions_for(input, &block)
-					top, comments = ::Parser::CurrentRuby.parse_with_comments(input)
+				def definitions_for(source, &block)
+					top, comments = self.parse_source(source)
 					
 					if top
 						walk_definitions(top, comments, &block)
@@ -85,7 +95,7 @@ module Decode
 						end
 					when :module
 						definition = Module.new(
-							node, node.children[0].children[1],
+							node, nested_name_for(node.children[0]),
 							comments: extract_comments_for(node, comments),
 							parent: parent,
 							language: @language
@@ -98,7 +108,7 @@ module Decode
 						end
 					when :class
 						definition = Class.new(
-							node, class_name_for(node.children[0]),
+							node, nested_name_for(node.children[0]),
 							comments: extract_comments_for(node, comments),
 							parent: parent, language: @language
 						)
@@ -211,9 +221,9 @@ module Decode
 					end
 				end
 				
-				def class_name_for(node)
+				def nested_name_for(node)
 					if prefix = node.children[0]
-						"#{class_name_for(prefix)}::#{node.children[1]}"
+						"#{nested_name_for(prefix)}::#{node.children[1]}".to_sym
 					else
 						node.children[1]
 					end
@@ -253,8 +263,8 @@ module Decode
 				end
 				
 				# Extract segments from the given input file.
-				def segments_for(input, &block)
-					top, comments = ::Parser::CurrentRuby.parse_with_comments(input)
+				def segments_for(source, &block)
+					top, comments = self.parse_source(source)
 					
 					# We delete any leading comments:
 					line = 0

data/lib/decode/location.rb

@@ -0,0 +1,27 @@
+# Copyright, 2022, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+module Decode
+	class Location < Struct.new(:path, :line)
+		def to_s
+			"#{path}:#{line}"
+		end
+	end
+end

data/lib/decode/source.rb

@@ -50,7 +50,7 @@ module Decode
 		def definitions(&block)
 			return to_enum(:definitions) unless block_given?
 			
-			@language.definitions_for(self.read, &block)
+			@language.definitions_for(self, &block)
 		end
 		
 		# Open the source file and read all segments.
@@ -60,7 +60,7 @@ module Decode
 		def segments(&block)
 			return to_enum(:segments) unless block_given?
 			
-			@language.segments_for(self.read, &block)
+			@language.segments_for(self, &block)
 		end
 		
 		def code(index = nil, relative_to: nil)

data/lib/decode/version.rb

@@ -19,5 +19,5 @@
 # THE SOFTWARE.
 
 module Decode
-	VERSION = "0.17.1"
+	VERSION = "0.18.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: decode
 version: !ruby/object:Gem::Version
-  version: 0.17.1
+  version: 0.18.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -36,7 +36,7 @@ cert_chain:
   RAOsIl+HOBTb252nx1kIRN5hqQx272AJCbCjKx8egcUQKffFVVCI0nye09v5CK+a
   HiLJ8VOFx6w=
   -----END CERTIFICATE-----
-date: 2021-10-08 00:00:00.000000000 Z
+date: 2022-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -149,6 +149,7 @@ files:
 - lib/decode/language/ruby/reference.rb
 - lib/decode/language/ruby/segment.rb
 - lib/decode/languages.rb
+- lib/decode/location.rb
 - lib/decode/scope.rb
 - lib/decode/segment.rb
 - lib/decode/source.rb
@@ -177,7 +178,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Code analysis for documentation generation.