decode 0.17.2 → 0.18.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7d6009f4ff23fb9cceecfe8d661848867bfd1528f31fa99a45aa52f7fb5d4f8
-  data.tar.gz: d9ddb59b516d3b8306ff6dc6dddbc1263c9761e1ae4a2cf187040442f6865299
+  metadata.gz: 6161432dca8cff543a44aa7077863081acc65e2c30ae5a71a6cee66c8c0ff1fa
+  data.tar.gz: 6881ade662a2414f923631ff5e34a90c4df6adf7501f9b973fad2a74fc231f74
 SHA512:
-  metadata.gz: 592f7031ec864569dad6001f919e65990cea614278ad12f3479491df39a422b4c0a3f9f7dcc197b6c03d113fee8438e6606b1a624343ac0ae4ea76f36a43a792
-  data.tar.gz: 561e6b926e5b3ab9ef258b0fe915d4758f64514f1512a6f5f2b155327e601bf10022a819d7b307ffa4e31a8884d7635fdc5fd40606deb6f5c775835cd0b6f423
+  metadata.gz: 4f3b92e010e0d756e1462702efaef891f148ac804f2aaf9c3df4cd9f5e8a2fc5957c68fe2a9013bef25643805ff30c9c4501c66d2580d43026f5a4fe025ee277
+  data.tar.gz: 4bfbb2545dba5f1921c5a222bbd7fddb895a7fe29418b5280573a26a82814dee387b3377bfe6738d493059735d7a7ae444a51e3b0a8f0106166aa706b9cc2697

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,10 +61,18 @@ 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.
 			class Singleton < Definition
+				def nested_name
+					"::class"
+				end
+
 				# A singleton class is a container for other definitions.
 				# @returns [Boolean]
 				def container?
@@ -74,14 +86,40 @@ module Decode
 				end
 				
 				# The short form of the class.
-				# e.g. `class << (self)`.
+				# e.g. `class << self`.
 				def short_form
 					"class << #{@name}"
 				end
 				
 				# The long form is the same as the short form.
 				alias long_form short_form
+
+				def path_name
+					[:class]
+				end
+
+				# The lexical scope as an array of names.
+				# e.g. `[:Decode, :Definition]`
+				# @returns [Array]
+				def path
+					if @path
+						# Cached version:
+						@path
+					else
+						@path = [*self.absolute_path, *self.path_name]
+					end
+				end
+
+				private
+
+				def absolute_path
+					if @parent
+						@parent.path
+					else
+						@name.to_s.split('::').map(&:to_sym)
+					end
+				end
 			end
 		end
 	end
-end
+end

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,17 +37,22 @@ 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

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)
@@ -109,16 +119,18 @@ module Decode
 							walk_definitions(children, comments, definition, &block)
 						end
 					when :sclass
-						definition = Singleton.new(
-							node, node.children[0],
-							comments: extract_comments_for(node, comments),
-							parent: parent, language: @language
-						)
-						
-						yield definition
-						
-						if children = node.children[1]
-							walk_definitions(children, comments, definition, &block)
+						if name = singleton_name_for(node.children[0])
+							definition = Singleton.new(
+								node, name,
+								comments: extract_comments_for(node, comments),
+								parent: parent, language: @language
+							)
+							
+							yield definition
+							
+							if children = node.children[1]
+								walk_definitions(children, comments, definition, &block)
+							end
 						end
 					when :def
 						definition = Method.new(
@@ -219,6 +231,15 @@ module Decode
 					end
 				end
 				
+				def singleton_name_for(node)
+					case node.type
+					when :const
+						nested_name_for(node)
+					when :self
+						:'self'
+					end
+				end
+
 				KIND_ATTRIBUTE = /\A
 					(@(?<kind>attribute)\s+(?<value>.*?))|
 					(@define\s+(?<kind>)\s+(?<value>.*?))
@@ -253,8 +274,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.2"
+	VERSION = "0.18.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: decode
 version: !ruby/object:Gem::Version
-  version: 0.17.2
+  version: 0.18.1
 platform: ruby
 authors:
 - Samuel Williams
@@ -36,7 +36,7 @@ cert_chain:
   RAOsIl+HOBTb252nx1kIRN5hqQx272AJCbCjKx8egcUQKffFVVCI0nye09v5CK+a
   HiLJ8VOFx6w=
   -----END CERTIFICATE-----
-date: 2021-12-16 00:00:00.000000000 Z
+date: 2022-07-08 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.2.32
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Code analysis for documentation generation.