decode 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 353e9f1529672844e406beb0587827a8a5a4e045506511019c1adf91ebf22a42
-  data.tar.gz: 88ef4f1965c4a95c0ddff8aa3857083e7854eb5c1b2dcbef02c3c1d92749d4b6
+  metadata.gz: d285f0566ed8682b02da2b41c0d1e56d4fd45a47ed26e4d4f4ec5a274dbbca45
+  data.tar.gz: 41baab474d5c16ea408ded0fded49479dbbe62649044e142f65b536c6a805e52
 SHA512:
-  metadata.gz: c386399350a839bd1e53e5398d725a7a14a311fd3af8c946e27bb2b472e1859b30e36bd3286e56c03b5956078705ea2b099ed002dfbaf22b169f8cc729fadc2f
-  data.tar.gz: e0e20aa3755863f3ad67c1317be7451c141ef783e90cb5f69fde7a5c91ab6992ad522cb11cf9988e91de95ca2d1d1e852b3cb4ba767023356f3c7dd6cb6534de
+  metadata.gz: 474044bd964488c5a9003b502c982374d1fca23a00a04a07191b95e86e463ff0c39a54fdb5362ed2dee626538a60e50a07697d3d2cccff3bcc312829f470e535
+  data.tar.gz: 9ad91167fc2f1c6dddfca9e35d4773237125b9433b49163ee35541899efe01a003f719c8b2bb3eac469efe35c7d505a70d8b3a70a87d1ae804dabef41d1784d3

data/lib/decode/index.rb

@@ -21,11 +21,15 @@
 require_relative 'source'
 require_relative 'trie'
 
+require_relative 'languages'
+
 module Decode
 	# A list of definitions organised for quick lookup and lexical enumeration.
 	class Index
 		# Initialize an empty index.
-		def initialize
+		def initialize(languages = Languages.all)
+			@languages = languages
+			
 			@sources = {}
 			@definitions = {}
 			
@@ -33,6 +37,10 @@ module Decode
 			@trie = Trie.new
 		end
 		
+		# All supported languages for this index.
+		# @attr [Languages]
+		attr :languages
+		
 		# All source files that have been parsed.
 		# @attr [Array(Source)]
 		attr :sources
@@ -52,7 +60,7 @@ module Decode
 		# @param paths [Array(String)] The source file paths.
 		def update(paths)
 			paths.each do |path|
-				if source = Source.for?(path)
+				if source = @languages.source_for(path)
 					@sources[path] = source
 					
 					source.definitions do |symbol|

data/lib/decode/language/generic.rb

@@ -0,0 +1,51 @@
+# 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 'reference'
+
+module Decode
+	module Language
+		# The Ruby language.
+		class Generic
+			def initialize(name)
+				@name = name
+			end
+			
+			attr :name
+			
+			# Generate a generic reference.
+			def reference_for(identifier)
+				Reference.new(identifier, self)
+			end
+			
+			# Parse the input yielding definitions.
+			# @block `{|definition| ...}`
+			# @yield definition [Definition]
+			def definitions_for(input, &block)
+			end
+			
+			# Parse the input yielding interleaved comments and code segments.
+			# @block `{|segment| ...}`
+			# @yield segment [Segment]
+			def segments_for(input, &block)
+			end
+		end
+	end
+end

data/lib/decode/language/reference.rb

@@ -0,0 +1,78 @@
+# 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.
+
+module Decode
+	module Language
+		# An reference which can be resolved to zero or more definitions.
+		class Reference
+			# Initialize the reference.
+			# @param identifier [String] The identifier part of the reference.
+			def initialize(identifier, language)
+				@identifier = identifier
+				@language = language
+				
+				@lexical_path = nil
+				@path = nil
+			end
+			
+			# The identifier part of the reference.
+			# @attr [String]
+			attr :identifier
+			
+			# The language associated with this reference.
+			attr :language
+			
+			# Whether the reference starts at the base of the lexical tree.
+			def absolute?
+				!self.relative?
+			end
+			
+			def relative?
+				prefix, name = self.lexical_path.first
+				
+				return prefix.nil?
+			end
+			
+			def split(identifier)
+				identifier.scan(/(\W+)?(\w+)/)
+			end
+			
+			def lexical_path
+				@lexical_path ||= self.split(@identifier)
+			end
+			
+			def best(definitions)
+				prefix, name = lexical_path.last
+				
+				definitions.select do |definition|
+					definition.language == @language && (
+						prefix.nil? || definition.start_with?(prefix)
+					)
+				end
+			end
+			
+			# The lexical path of the reference.
+			# @return [Array(String)]
+			def path
+				@path ||= self.lexical_path.map{|_, name| name.to_sym}
+			end
+		end
+	end
+end

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

@@ -18,47 +18,15 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
+require_relative '../reference'
+
 module Decode
 	module Language
 		module Ruby
 			# An Ruby-specific reference which can be resolved to zero or more definitions.
-			class Reference
-				# Initialize the reference.
-				# @param text [String] The text text of the reference.
-				def initialize(text)
-					@text = text
-					
-					@lexical_path = nil
-					@path = nil
-				end
-				
-				def language
-					Ruby
-				end
-				
-				attr :text
-				
-				# Whether the reference starts at the base of the lexical tree.
-				def absolute?
-					@text.start_with?('::')
-				end
-				
-				def lexical_path
-					@lexical_path ||= @text.scan(/(::|\.|#|:)?([^:.#]+)/)
-				end
-				
-				def best(definitions)
-					prefix, name = lexical_path.last
-					
-					definitions.select do |definition|
-						prefix.nil? || definition.start_with?(prefix)
-					end
-				end
-				
-				# The lexical path of the reference.
-				# @return [Array(String)]
-				def path
-					@path ||= self.lexical_path.map{|_, name| name.to_sym}
+			class Reference < Language::Reference
+				def split(text)
+					text.scan(/(::|\.|#|:)?([^:.#]+)/)
 				end
 			end
 		end

data/lib/decode/language/ruby.rb

@@ -31,9 +31,17 @@ module Decode
 				"ruby"
 			end
 			
+			def self.names
+				[self.name]
+			end
+			
+			def self.extensions
+				['.rb', '.ru']
+			end
+			
 			# Generate a language-specific reference.
-			def self.reference(value)
-				Reference.new(value)
+			def self.reference_for(identifier)
+				Reference.new(identifier, self)
 			end
 			
 			# Parse the input yielding definitions.

data/lib/decode/language.rb

@@ -18,29 +18,11 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
+require_relative 'language/generic'
 require_relative 'language/ruby'
 
 module Decode
 	# Language specific parsers and definitions.
 	module Language
-		def self.detect(path)
-			case path
-			when /\.(rb|ru)\z/
-				return Language::Ruby
-			end
-		end
-		
-		REFERENCE = /\A(?<language>\.[a-z]+)?\s+(?<text>.*?)\z/
-		
-		# A language agnostic reference:
-		# e.g. `.rb MyModule::MyClass`
-		#
-		def self.reference(string, language = nil)
-			if match = REFERENCE.match(string)
-				language = self.detect(match[:language]) || language
-				
-				return language.reference(match[:text])
-			end
-		end
 	end
 end

data/lib/decode/languages.rb

@@ -0,0 +1,92 @@
+# 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 'language/generic'
+require_relative 'language/ruby'
+
+module Decode
+	# A context for looking up languages based on file extension or name.
+	class Languages
+		def self.all
+			self.new.tap do |languages|
+				languages.add(Language::Ruby)
+			end
+		end
+		
+		def initialize
+			@named = {}
+			@extensions = {}
+		end
+		
+		def freeze
+			return unless frozen?
+			
+			@named.freeze
+			@extensions.freeze
+			
+			super
+		end
+		
+		def add(language)
+			language.names.each do |name|
+				@named[name] = language
+			end
+			
+			language.extensions.each do |extension|
+				@extensions[extension] = language
+			end
+		end
+		
+		def fetch(name)
+			@named.fetch(name) do
+				unless @named.frozen?
+					@named[name] = Language::Generic.new(name)
+				end
+			end
+		end
+		
+		def source_for(path)
+			extension = File.extname(path)
+			
+			if language = @extensions[extension]
+				Source.new(path, language)
+			end
+		end
+		
+		REFERENCE = /\A(?<name>[a-z]+)?\s+(?<identifier>.*?)\z/
+		
+		# Parse a language agnostic reference:
+		# e.g. `ruby MyModule::MyClass`
+		#
+		def parse_reference(text, default_language: nil)
+			if match = REFERENCE.match(text)
+				language = self.fetch(match[:name]) || default_language
+				
+				return language.reference_for(match[:identifier])
+			elsif default_language
+				return default_language.reference_for(text)
+			end
+		end
+		
+		def reference_for(name, identifier)
+			self.fetch(name).reference_for(identifier)
+		end
+	end
+end

data/lib/decode/source.rb

@@ -22,15 +22,9 @@ require_relative 'language'
 
 module Decode
 	class Source
-		def self.for?(path)
-			if language = Language.detect(path)
-				self.new(path, language)
-			end
-		end
-		
-		def initialize(path, language = nil)
+		def initialize(path, language)
 			@path = path
-			@language = language || Language.detect(path)
+			@language = language
 		end
 		
 		attr :path

data/lib/decode/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: decode
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -128,6 +128,8 @@ files:
 - lib/decode/documentation.rb
 - lib/decode/index.rb
 - lib/decode/language.rb
+- lib/decode/language/generic.rb
+- lib/decode/language/reference.rb
 - lib/decode/language/ruby.rb
 - lib/decode/language/ruby/attribute.rb
 - lib/decode/language/ruby/block.rb
@@ -141,6 +143,7 @@ files:
 - lib/decode/language/ruby/parser.rb
 - lib/decode/language/ruby/reference.rb
 - lib/decode/language/ruby/segment.rb
+- lib/decode/languages.rb
 - lib/decode/scope.rb
 - lib/decode/segment.rb
 - lib/decode/source.rb