decode 0.17.3 → 0.18.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a838fd5f42db321e8afe7627740faca8a0bce85e66016b1a9f5eac4c1b800e13
-  data.tar.gz: 2d2e88c8dfbddaf2507f8b94ef7b3678247640ff48768dd8971afe4bca32a579
+  metadata.gz: 73f08a729f4aab1c447325886ac2f07a76c3e0b12a4ac9fadd0da81343fb24fe
+  data.tar.gz: 0fa743ec70c64044f12d56b1660fd8e2d2dfb5f6aeeb7ee49fbbe8325eca724d
 SHA512:
-  metadata.gz: 2fd7f4dc09a37c14d87750e3cf12ed22f6352877a382ab6a08f8571b48d774761fa2deb6dcc7382bb43868361774816d018c086f3ae2e0b0908a89c8e9704154
-  data.tar.gz: e6b60875db3b53417736599852a9354eabbdc08503b3dda594bd364df7c98fa84702303917f27c7850054ab40d0f5c25b018a0a9919bf07a9e7d922cd8b480fb
+  metadata.gz: 65c43bcc6ead3b9ab8b67a5a203910520e81837a8654dedb86f3fd92010803e9762fc200b14cb724d4862871fc8d4f87ee39d2aee2eaa5abbe23b34b2a1cea19
+  data.tar.gz: 8aa62d064fd628fd5a8fa16dfcd6464072e7d7b271be4c81f66b504905b725aec59892ffcbf8d30835328ce7f42903a44f2ffbd437f80bdc7c6bb89cbd19952e

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
@@ -38,10 +40,12 @@ module Decode
 			@qualified_name = nil
 		end
 		
-		def to_s
+		def inspect
 			"\#<#{self.class} #{qualified_name}>"
 		end
 		
+		alias to_s inspect
+
 		# The symbol name.
 		# e.g. `:Decode`.
 		# @attribute [Symbol]
@@ -168,5 +172,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/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

@@ -69,6 +69,10 @@ module Decode
 			
 			# 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?
@@ -82,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/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.3"
+	VERSION = "0.18.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: decode
 version: !ruby/object:Gem::Version
-  version: 0.17.3
+  version: 0.18.2
 platform: ruby
 authors:
 - Samuel Williams
@@ -36,7 +36,7 @@ cert_chain:
   RAOsIl+HOBTb252nx1kIRN5hqQx272AJCbCjKx8egcUQKffFVVCI0nye09v5CK+a
   HiLJ8VOFx6w=
   -----END CERTIFICATE-----
-date: 2022-05-13 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