decode 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 813979836080a611db0650430359874b554250326fc391d453405b01a6137fc5
-  data.tar.gz: a0335e5e13a888f0b19a06f3010063bf840be1cf399134e37d112dcdba98dd9b
+  metadata.gz: fd42fdf97af9b39dd08a24eb01bf8e165f5f5b5af934024789d14e68d007d68b
+  data.tar.gz: dd47038eaacad07b6a00a28cd7942ccf397fbee3f86245277658bbc8988e3189
 SHA512:
-  metadata.gz: f155904d306e546b857cca49e8ef25590de20253febff28f82a390ee6dd09e5bd412a5966578f4cf419848bc7282a34c64d1b8c98ce9ce28f6a92a821c46b298
-  data.tar.gz: 3e65b213a410b83b48dc30e1a89f49f5a013b0eeb414bd41d91510d9069921b95f7bfb74195b011ab42c1c7dc6c8ddb53935f40bdf97d068e2c3d8a79b07f5b1
+  metadata.gz: 39d1157dab86e1200394f89e19b8996f974ce62fee7843cebe1b9a4f9637cdf68629d91d431f2be7af77697443fefed8ad80b60b9297e284ca4ad65c42355990
+  data.tar.gz: 1385928ab0ec53208ddaffb9acceb2c2da1bd976ecea650291564e30b0d7191aded0f2d2b6946815a16f48534602f3ac365ed0c143e831bdb052704907bc2eb1

data/lib/decode/definition.rb

@@ -18,22 +18,87 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require_relative 'symbol'
-
 module Decode
 	# A symbol with attached documentation.
-	class Definition < Symbol
-		def initialize(kind, name, comments, **options)
-			super(kind, name, **options)
+	class Definition
+		# Initialize the symbol.
+		# @param name [Symbol] The name of the definition.
+		# @param parent [Symbol] The parent lexical scope.
+		# @param language [Language] The language in which the symbol is defined in.
+		# @param comments [Array(String)] The comments associated with the definition.
+		def initialize(name, parent: nil, language: parent.language, comments: nil)
+			@name = name
 			
 			@comments = comments
+			@language = language
+			@parent = parent
+			
+			@path = nil
+			@qualified_name = nil
 			@documentation = nil
 		end
 		
+		def to_s
+			"\#<#{self.class} #{qualified_name}>"
+		end
+		
+		# The symbol name.
+		# e.g. `:Decode`.
+		attr :name
+		
+		# The parent symbol, defining lexical scope.
+		attr :parent
+		
+		# The language the symbol is defined within.
+		attr :language
+		
 		# The comment lines which directly preceeded the definition.
 		# @attr [Array(String)]
 		attr :comments
 		
+		# The qualified name is an absolute name which includes any and all namespacing.
+		# @return [String]
+		def qualified_name
+			@qualified_name ||= begin
+				if @parent
+					@parent.qualified_name + self.nested_name
+				else
+					@name.to_s
+				end
+			end
+		end
+		
+		# The name of this definition plus the nesting prefix.
+		# @return [String]
+		def nested_name
+			"::#{@name}"
+		end
+		
+		def start_with?(prefix)
+			self.nested_name.start_with?(prefix)
+		end
+		
+		def convert(kind)
+			raise ArgumentError, "Unable to convert #{self} into #{kind}!"
+		end
+		
+		# The lexical scope which is an array of lexical {Key} instances as generated by {key}.
+		# @return [Array]
+		def path
+			if @path
+				# Cached version:
+				@path
+			elsif @parent
+				# Merge with parent:
+				@path = [*@parent.path, @name]
+			else
+				# At top:
+				@path = [@name]
+			end
+		end
+		
+		alias lexical_path path
+		
 		# A short form of the definition.
 		# e.g. `def short_form`.
 		#

data/lib/decode/index.rb

@@ -22,12 +22,12 @@ require_relative 'source'
 require_relative 'trie'
 
 module Decode
-	# A list of symbols organised for quick lookup and lexical enumeration.
+	# A list of definitions organised for quick lookup and lexical enumeration.
 	class Index
 		# Initialize an empty index.
 		def initialize
 			@sources = {}
-			@symbols = {}
+			@definitions = {}
 			
 			# This is essentially a prefix tree:
 			@trie = Trie.new
@@ -37,17 +37,17 @@ module Decode
 		# @attr [Array(Source)]
 		attr :sources
 		
-		# All symbols which have been parsed.
+		# All definitions which have been parsed.
 		# @attr [Array(Symbol)]
-		attr :symbols
+		attr :definitions
 		
-		# A (prefix) trie of lexically scoped symbols.
+		# A (prefix) trie of lexically scoped definitions.
 		# @attr [Trie]
 		
 		attr :trie
 		
 		# Updates the index by parsing the specified files.
-		# All extracted symbols are merged into the existing index.
+		# All extracted definitions are merged into the existing index.
 		#
 		# @param paths [Array(String)] The source file paths.
 		def update(paths)
@@ -55,23 +55,24 @@ module Decode
 				source = Source.new(path)
 				@sources[path] = Source.new(path)
 				
-				source.symbols do |symbol|
-					@symbols[symbol.qualified_name] = symbol
+				source.definitions do |symbol|
+					# $stderr.puts "Adding #{symbol.qualified_name} to #{symbol.lexical_path.join(' -> ')}"
 					
-					@trie.insert(symbol.lexical_path, symbol)
+					@definitions[symbol.qualified_name] = symbol
+					@trie.insert(symbol.path, symbol)
 				end
 			end
 		end
 		
-		# Lookup the specified reference and return matching symbols.
+		# Lookup the specified reference and return matching definitions.
 		#
 		# @param reference [Reference] The reference to match.
-		# @param relative_to [Symbol] Lookup the reference relative to the scope of this symbol.
+		# @param relative_to [Definition] Lookup the reference relative to the scope of this definition.
 		def lookup(reference, relative_to: nil)
 			if reference.absolute? || relative_to.nil?
 				lexical_path = []
 			else
-				lexical_path = relative_to.lexical_path
+				lexical_path = relative_to.path
 			end
 			
 			path = reference.path
@@ -81,11 +82,7 @@ module Decode
 				
 				if node.children[path.first]
 					if target = node.lookup(path)
-						if reference.kind
-							return target.values.select{|symbol| symbol.kind == reference.kind}
-						else
-							return target.values
-						end
+						return reference.best(target.values)
 					else
 						return nil
 					end

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

@@ -25,16 +25,23 @@ module Decode
 		module Ruby
 			# A Ruby-specific attribute.
 			class Attribute < Definition
-				# The keyword that defined the attribute.
-				# @return [String]
-				def keyword
-					@node.children[1]
-				end
-				
 				# The short form of the attribute.
 				# e.g. `attr :value`.
 				def short_form
-					"#{self.keyword} #{@name.inspect}"
+					case @node.type
+					when :block
+						"#{@name} { ... }"
+					else
+						@node.location.expression.source
+					end
+				end
+				
+				def long_form
+					if @node.location.line == @node.location.last_line
+						@node.location.expression.source
+					else
+						short_form
+					end
 				end
 			end
 		end

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

@@ -0,0 +1,72 @@
+# Copyright, 2020, 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.
+
+require_relative 'definition'
+
+module Decode
+	module Language
+		module Ruby
+			# A Ruby-specific block which might carry other definitions.
+			class Block < Definition
+				# A block can sometimes be a container for other definitions.
+				def container?
+					true
+				end
+				
+				def nested_name
+					".#{name}"
+				end
+				
+				# The short form of the block.
+				# e.g. `foo`.
+				def short_form
+					@name.to_s
+				end
+				
+				# The long form of the block.
+				# e.g. `foo(:bar)`.
+				def long_form
+					if @node.location.line == @node.location.last_line
+						@node.location.expression.source
+					else
+						@node.children[0].location.expression.source
+					end
+				end
+				
+				# The fully qualified name of the block.
+				# e.g. `::Barnyard::foo`.
+				def qualified_form
+					self.qualified_name
+				end
+				
+				def convert(kind)
+					case kind
+					when :attr
+						Attribute.new(@node, @name,
+							comments: @comments, parent: @parent, language: @language
+						)
+					else
+						super
+					end
+				end
+			end
+		end
+	end
+end

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

@@ -0,0 +1,57 @@
+# Copyright, 2020, 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.
+
+require_relative 'definition'
+
+module Decode
+	module Language
+		module Ruby
+			# A Ruby-specific block which might carry other definitions.
+			class Call < Definition
+				# A block can sometimes be a container for other definitions.
+				def container?
+					false
+				end
+				
+				# The short form of the class.
+				# e.g. `foo`.
+				def short_form
+					@name.to_s
+				end
+				
+				# The long form of the class.
+				# e.g. `foo(:bar)`.
+				def long_form
+					if @node.location.line == @node.location.last_line
+						@node.location.expression.source
+					else
+						self.short_form
+					end
+				end
+				
+				# The fully qualified name of the block.
+				# e.g. `class ::Barnyard::Dog`.
+				def qualified_form
+					self.qualified_name
+				end
+			end
+		end
+	end
+end

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

@@ -30,6 +30,10 @@ module Decode
 					true
 				end
 				
+				def nested_name
+					"::#{name}"
+				end
+				
 				# The short form of the class.
 				# e.g. `class Animal`.
 				def short_form

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

@@ -31,6 +31,10 @@ module Decode
 					@node.location.name.source
 				end
 				
+				def nested_name
+					"::#{@name}"
+				end
+				
 				# The long form of the constant.
 				# e.g. `NAME = "Alice"`.
 				def long_form

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

@@ -26,12 +26,16 @@ module Decode
 			# A Ruby-specific definition.
 			class Definition < Decode::Definition
 				# Initialize the definition from the syntax tree node.
-				def initialize(kind, name, comments, node, **options)
-					super(kind, name, comments, **options)
+				def initialize(node, *arguments, **options)
+					super(*arguments, **options)
 					
 					@node = node
 				end
 				
+				def nested_name
+					"\##{@name}"
+				end
+				
 				# The parser syntax tree node.
 				attr :node
 				

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

@@ -25,6 +25,10 @@ module Decode
 		module Ruby
 			# A Ruby-specific function.
 			class Function < Method
+				def nested_name
+					".#{@name}"
+				end
+				
 				# The node which contains the function arguments.
 				def arguments_node
 					if node = @node.children[2]

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

@@ -51,6 +51,17 @@ module Decode
 						self.short_form
 					end
 				end
+				
+				def convert(kind)
+					case kind
+					when :attr
+						Attribute.new(@node, @name,
+							comments: @comments, parent: @parent, language: @language
+						)
+					else
+						super
+					end
+				end
 			end
 		end
 	end

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

@@ -30,6 +30,10 @@ module Decode
 					true
 				end
 				
+				def nested_name
+					"::#{name}"
+				end
+				
 				# The short form of the module.
 				# e.g. `module Barnyard`.
 				def short_form

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

@@ -20,7 +20,11 @@
 
 require 'parser/current'
 
+require_relative '../../scope'
+
 require_relative 'attribute'
+require_relative 'block'
+require_relative 'call'
 require_relative 'class'
 require_relative 'constant'
 require_relative 'function'
@@ -34,12 +38,12 @@ module Decode
 		module Ruby
 			# The Ruby source code parser.
 			class Parser
-				# Extract symbols from the given input file.
-				def symbols_for(input, &block)
+				# Extract definitions from the given input file.
+				def definitions_for(input, &block)
 					top, comments = ::Parser::CurrentRuby.parse_with_comments(input.read)
 					
 					if top
-						walk_symbols(top, comments, &block)
+						walk_definitions(top, comments, &block)
 					end
 				end
 				
@@ -69,68 +73,69 @@ module Decode
 				end
 				
 				# Walk over the syntax tree and extract relevant definitions with their associated comments.
-				def walk_symbols(node, comments, parent = nil, &block)
+				def walk_definitions(node, comments, parent = nil, &block)
 					case node.type
 					when :begin
 						node.children.each do |child|
-							walk_symbols(child, comments, parent, &block)
+							walk_definitions(child, comments, parent, &block)
 						end
 					when :module
 						definition = Module.new(
-							:module, node.children[0].children[1],
-							extract_comments_for(node, comments), node,
-							parent: parent, language: Ruby
+							node, node.children[0].children[1],
+							comments: extract_comments_for(node, comments),
+							parent: parent,
+							language: Ruby
 						)
 						
 						yield definition
 						
 						if children = node.children[1]
-							walk_symbols(children, comments, definition, &block)
+							walk_definitions(children, comments, definition, &block)
 						end
 					when :class
 						definition = Class.new(
-							:class, node.children[0].children[1],
-							extract_comments_for(node, comments), node,
+							node, node.children[0].children[1],
+							comments: extract_comments_for(node, comments),
 							parent: parent, language: Ruby
 						)
 						
 						yield definition
 						
 						if children = node.children[2]
-							walk_symbols(children, comments, definition, &block)
+							walk_definitions(children, comments, definition, &block)
 						end
 					when :sclass
 						definition = Singleton.new(
-							:class, node.children[0],
-							extract_comments_for(node, comments), node,
+							node, node.children[0],
+							comments: extract_comments_for(node, comments),
 							parent: parent, language: Ruby
 						)
 						
 						yield definition
 						
 						if children = node.children[1]
-							walk_symbols(children, comments, definition, &block)
+							walk_definitions(children, comments, definition, &block)
 						end
 					when :def
 						definition = Method.new(
-							:def, node.children[0],
-							extract_comments_for(node, comments), node,
+							node, node.children[0],
+							comments: extract_comments_for(node, comments),
 							parent: parent, language: Ruby
 						)
 						
 						yield definition
 					when :defs
 						definition = Function.new(
-							:defs, node.children[1],
-							extract_comments_for(node, comments), node,
+							node, node.children[1],
+							comments: extract_comments_for(node, comments),
 							parent: parent, language: Ruby
 						)
 						
 						yield definition
 					when :casgn
 						definition = Constant.new(
-							:constant, node.children[1],
-							extract_comments_for(node, comments), node,
+							node, node.children[1],
+							comments: extract_comments_for(node, comments),
 							parent: parent, language: Ruby
 						)
 						
@@ -140,21 +145,98 @@ module Decode
 						case name
 						when :attr, :attr_reader, :attr_writer, :attr_accessor
 							definition = Attribute.new(
-								:def, name_for(node.children[2]),
-								extract_comments_for(node, comments), node,
+								node, name_for(node.children[2]),
+								comments: extract_comments_for(node, comments),
 								parent: parent, language: Ruby
 							)
 							
 							yield definition
+						else
+							extracted_comments = extract_comments_for(node, comments)
+							if kind = kind_for(node, extracted_comments)
+								definition = Call.new(
+									node, name_for(node, extracted_comments),
+									comments: extracted_comments,
+									parent: parent, language: Ruby
+								)
+								
+								yield definition
+							end
+						end
+					when :block
+						extracted_comments = extract_comments_for(node, comments)
+						
+						if name = name_for(node, extracted_comments)
+							definition = Block.new(
+								node, name,
+								comments: extracted_comments,
+								parent: scope_for(extracted_comments, parent, &block),
+								language: Ruby
+							)
+							
+							if kind = kind_for(node, extracted_comments)
+								definition = definition.convert(kind)
+							end
+							
+							yield definition
+							
+							if children = node.children[2]
+								walk_definitions(children, comments, definition, &block)
+							end
 						end
 					end
 				end
 				
-				def name_for(node)
+				NAME_ATTRIBUTE = /\A@name\s+(?<value>.*?)\Z/
+				
+				def name_for(node, comments = nil)
+					comments&.each do |comment|
+						if match = comment.match(NAME_ATTRIBUTE)
+							return match[:value].to_sym
+						end
+					end
+					
 					case node.type
 					when :sym
 						return node.children[0]
+					when :send
+						return node.children[1]
+					when :block
+						return node.children[0].children[1]
+					end
+				end
+				
+				KIND_ATTRIBUTE = /\A
+					(@(?<kind>attr)\s+(?<value>.*?))|
+					(@define\s+(?<kind>)\s+(?<value>.*?))
+				\Z/x
+				
+				def kind_for(node, comments = nil)
+					comments&.each do |comment|
+						if match = comment.match(KIND_ATTRIBUTE)
+							return match[:kind].to_sym
+						end
 					end
+					
+					return nil
+				end
+				
+				SCOPE_ATTRIBUTE = /\A
+					(@scope\s+(?<names>.*?))
+				\Z/x
+				
+				def scope_for(comments, parent = nil, &block)
+					comments&.each do |comment|
+						if match = comment.match(SCOPE_ATTRIBUTE)
+							return match[:names].split(/\s+/).map(&:to_sym).inject(nil) do |memo, name|
+								scope = Scope.new(name, parent: memo, language: Ruby)
+								yield scope
+								scope
+							end
+						end
+					end
+					
+					return parent
 				end
 				
 				# Extract segments from the given input file.

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

@@ -21,20 +21,15 @@
 module Decode
 	module Language
 		module Ruby
-			# An Ruby-specific reference which can be resolved to zero or more symbols.
+			# An Ruby-specific reference which can be resolved to zero or more definitions.
 			class Reference
-				KIND =  {
-					':' => :def,
-					'.' => :defs,
-				}.freeze
-				
 				# Initialize the reference.
 				# @param value [String] The string value of the reference.
 				def initialize(value)
 					@value = value
 					
+					@lexical_path = nil
 					@path = nil
-					@kind = nil
 				end
 				
 				# Whether the reference starts at the base of the lexical tree.
@@ -42,40 +37,22 @@ module Decode
 					@value.start_with?('::')
 				end
 				
-				METHOD = /\A(?<scope>.*?)?(?<kind>:|\.)(?<name>.+?)\z/
+				def lexical_path
+					@lexical_path ||= @value.scan(/(::|\.|#|:)?([^:.#]+)/)
+				end
 				
-				# The lexical path of the reference.
-				# @return [Array(String)]
-				def path
-					if @path.nil?
-						@path = @value.split(/::/)
-						
-						if last = @path.pop
-							if match = last.match(METHOD)
-								@kind = KIND[match[:kind]]
-								
-								if scope = match[:scope]
-									@path << scope
-								end
-								
-								@path << match[:name]
-							else
-								@path << last
-							end
-						end
-						
-						@path = @path.map(&:to_sym)
-						@path.freeze
-					end
+				def best(definitions)
+					prefix, name = lexical_path.last
 					
-					return @path
+					definitions.select do |definition|
+						prefix.nil? || definition.start_with?(prefix)
+					end
 				end
 				
-				# The kind of symbol to match.
-				def kind
-					self.path
-					
-					return @kind
+				# The lexical path of the reference.
+				# @return [Array(String)]
+				def path
+					@path ||= self.lexical_path.map{|_, name| name.to_sym}
 				end
 			end
 		end

data/lib/decode/language/ruby.rb

@@ -31,42 +31,16 @@ module Decode
 				"ruby"
 			end
 			
-			# The symbol which is used to separate the specified definition from the parent scope.
-			PREFIX = {
-				class: '::',
-				module: '::',
-				def: ':',
-				constant: '::',
-				defs: '.',
-			}.freeze
-			
-			# Generate a language-specific fully qualified name.
-			def self.join(symbols, absolute = true)
-				buffer = String.new
-				
-				symbols.each do |symbol|
-					if absolute == false
-						absolute = true
-					else
-						buffer << PREFIX[symbol.kind]
-					end
-					
-					buffer << symbol.name.to_s
-				end
-				
-				return buffer
-			end
-			
 			# Generate a language-specific reference.
 			def self.reference(value)
 				Reference.new(value)
 			end
 			
-			# Parse the input yielding symbols.
+			# Parse the input yielding definitions.
 			# @block `{|definition| ...}`
 			# @yield definition [Definition]
-			def self.symbols_for(input, &block)
-				Parser.new.symbols_for(input, &block)
+			def self.definitions_for(input, &block)
+				Parser.new.definitions_for(input, &block)
 			end
 			
 			# Parse the input yielding interleaved comments and code segments.

data/lib/decode/language.rb

@@ -21,7 +21,7 @@
 require_relative 'language/ruby'
 
 module Decode
-	# Language specific parsers and symbols.
+	# Language specific parsers and definitions.
 	module Language
 		def self.detect(path)
 			case File.extname(path)

data/lib/decode/scope.rb

@@ -0,0 +1,34 @@
+# Copyright, 2020, 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.
+
+require_relative 'definition'
+
+module Decode
+	# An abstract namespace for nesting definitions.
+	class Scope < Definition
+		def short_form
+			@name
+		end
+		
+		def container?
+			true
+		end
+	end
+end

data/lib/decode/source.rb

@@ -41,11 +41,11 @@ module Decode
 			File.open(@path, &block)
 		end
 		
-		def symbols(&block)
-			return to_enum(:symbols) unless block_given?
+		def definitions(&block)
+			return to_enum(:definitions) unless block_given?
 			
 			self.open do |file|
-				@language.symbols_for(file, &block)
+				@language.definitions_for(file, &block)
 			end
 		end
 		

data/lib/decode/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: decode
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-05 00:00:00.000000000 Z
+date: 2020-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -129,6 +129,8 @@ files:
 - lib/decode/language.rb
 - lib/decode/language/ruby.rb
 - lib/decode/language/ruby/attribute.rb
+- lib/decode/language/ruby/block.rb
+- lib/decode/language/ruby/call.rb
 - lib/decode/language/ruby/class.rb
 - lib/decode/language/ruby/constant.rb
 - lib/decode/language/ruby/definition.rb
@@ -138,9 +140,9 @@ files:
 - lib/decode/language/ruby/parser.rb
 - lib/decode/language/ruby/reference.rb
 - lib/decode/language/ruby/segment.rb
+- lib/decode/scope.rb
 - lib/decode/segment.rb
 - lib/decode/source.rb
-- lib/decode/symbol.rb
 - lib/decode/trie.rb
 - lib/decode/version.rb
 homepage: https://github.com/ioquatix/decode

data/lib/decode/symbol.rb

@@ -1,90 +0,0 @@
-# Copyright, 2020, 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.
-
-require_relative 'documentation'
-
-module Decode
-	# A language agnostic lexical scope.
-	Key = Struct.new(:kind, :name)
-	
-	# A named element which represents some significant element of some kind in a computer program.
-	class Symbol
-		# Initialize the symbol.
-		# @param kind [Symbol] The kind of symbol.
-		# @param name [Symbol] The name of the symbol.
-		# @param parent [Symbol] The parent lexical scope.
-		# @param language [Language] The language in which the symbol is defined in.
-		def initialize(kind, name, parent: nil, language: parent.language)
-			@kind = kind
-			@name = name
-			@parent = parent
-			@language = language
-			
-			@path = nil
-			@qualified_name = nil
-		end
-		
-		# A symbol-specific key which represents the lexical scope.
-		# @return [Key]
-		def key
-			Key.new(@kind, @name)
-		end
-		
-		def inspect
-			"\#<#{self.class} #{@kind} #{qualified_name}>"
-		end
-		
-		# The kind of symbol.
-		# e.g. `:module`.
-		attr :kind
-		
-		# The symbol name.
-		# e.g. `:Decode`.
-		attr :name
-		
-		# The parent symbol, defining lexical scope.
-		attr :parent
-		
-		# The language the symbol is defined within.
-		attr :language
-		
-		# The qualified name is an absolute name which includes any and all namespacing.
-		def qualified_name
-			@qualified_name ||= @language.join(self.path).freeze
-		end
-		
-		# The lexical scope which is an array of lexical {Key} instances as generated by {key}.
-		# @return [Array]
-		def path
-			if @path
-				@path
-			elsif @parent
-				@path = [*@parent.path, self.key]
-			else
-				@path = [self.key]
-			end
-		end
-		
-		# The lexical path, only taking into account the symbol names.
-		def lexical_path
-			self.path.map(&:name)
-		end
-	end
-end