decode 0.10.1 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 550e3f090191dd16e7977c43c25124af8f491b723164b140abcda0d9a0cb697c
-  data.tar.gz: 662df9a115c165cdf69bd5de2e1dbe2f89af968209a9202955dd37399ecadf3b
+  metadata.gz: 07f79e45df5df94f23f1f47cc1a25d750da2d23b35223fec16424cfcb29151b9
+  data.tar.gz: e95e753098856a90efa1c0c92abae58f7b47f8105549aa4fd40e8d6cda1b0e18
 SHA512:
-  metadata.gz: cda2284be27c82918e3f9a7bb3e3c597ff5ef2f57c89d8d25eff14d65407ee3d379b7863688942de4186f026aee5ae35134bfb175d0cf0d1da4df80bc06b3355
-  data.tar.gz: 28731d765443e79141d0f23b3543f8665ac69a7f52830ae3462540d7e64924cc9764e614fa9b7b25f274c7be9fc38a02024fb756d16bb5c53b095cf283292147
+  metadata.gz: '0538b3e5f1bc385726957c7ae3e1227706e007ffedf14b3d49794551804403d7f97762b070d6bccba75690dea05d366212826584c80dfada4617902f7a6f4f74'
+  data.tar.gz: 66bc9443f5615e2e64ab8d4bc294940642cc89f34f22914d9232099b0cff5d453c36a744aec024954c9f9d57582cd4a8d50588851abeee7de5d7ed811557b0e3

data/bake/decode/index.rb

@@ -0,0 +1,27 @@
+
+# Process the given source root and report on comment coverage.
+# @param root [String] The root path to index.
+def coverage(root)
+	require 'build/files/glob'
+	require 'decode/index'
+	
+	paths = Build::Files::Path.expand(root).glob("**/*")
+	
+	index = Decode::Index.new
+	index.update(paths)
+	
+	total = 0
+	documented = 0
+	
+	index.definitions.each do |name, definition|
+		total += 1
+		
+		if comments = definition.comments
+			documented += 1
+		else
+			$stderr.puts "#{name}"
+		end
+	end
+	
+	$stderr.puts "#{documented}/#{total} definitions have documentation."
+end

data/lib/decode/index.rb

@@ -52,14 +52,15 @@ module Decode
 		# @param paths [Array(String)] The source file paths.
 		def update(paths)
 			paths.each do |path|
-				source = Source.new(path)
-				@sources[path] = Source.new(path)
-				
-				source.definitions do |symbol|
-					# $stderr.puts "Adding #{symbol.qualified_name} to #{symbol.lexical_path.join(' -> ')}"
+				if source = Source.for?(path)
+					@sources[path] = source
 					
-					@definitions[symbol.qualified_name] = symbol
-					@trie.insert(symbol.path, symbol)
+					source.definitions do |symbol|
+						# $stderr.puts "Adding #{symbol.qualified_name} to #{symbol.lexical_path.join(' -> ')}"
+						
+						@definitions[symbol.qualified_name] = symbol
+						@trie.insert(symbol.path, symbol)
+					end
 				end
 			end
 		end

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

@@ -24,21 +24,23 @@ module Decode
 			# An Ruby-specific reference which can be resolved to zero or more definitions.
 			class Reference
 				# Initialize the reference.
-				# @param value [String] The string value of the reference.
-				def initialize(value)
-					@value = value
+				# @param text [String] The text text of the reference.
+				def initialize(text)
+					@text = text
 					
 					@lexical_path = nil
 					@path = nil
 				end
 				
+				attr :text
+				
 				# Whether the reference starts at the base of the lexical tree.
 				def absolute?
-					@value.start_with?('::')
+					@text.start_with?('::')
 				end
 				
 				def lexical_path
-					@lexical_path ||= @value.scan(/(::|\.|#|:)?([^:.#]+)/)
+					@lexical_path ||= @text.scan(/(::|\.|#|:)?([^:.#]+)/)
 				end
 				
 				def best(definitions)

data/lib/decode/language.rb

@@ -24,10 +24,23 @@ module Decode
 	# Language specific parsers and definitions.
 	module Language
 		def self.detect(path)
-			case File.extname(path)
-			when '.rb', '.ru'
+			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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: decode
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.11.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-07 00:00:00.000000000 Z
+date: 2020-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -119,6 +119,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - README.md
+- bake/decode/index.rb
 - decode.gemspec
 - gems.rb
 - guides/extract-symbols/extract.rb