decode 0.15.2 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e996212bd910f20ac9875edc81588dc35294a4b33069e64b2bda61e754be1a9
-  data.tar.gz: f8e78b386f4f2a9cf25267c0d62d90985f50ae8842520f478ed7766044cd6d35
+  metadata.gz: 46261946c303174f919739a47b679548956f72cac96129fc3a3244c45e20e5f9
+  data.tar.gz: 4a42af06139fb8fcfeb0acfa827e3f7750c0615bdf1fab3da307fc542d3955b0
 SHA512:
-  metadata.gz: 7dbaf3a9f15060fb40f718271c235a01bec1488954030e3130cd78d56e7f6fc42494c47c757617707bdf0c43714fc365bd69a22493e9e95f6c9265c6b2a91b0a
-  data.tar.gz: d0f80917980849a694ade904566a1c89cebd76db7ca5d5267e311f221cf5295ddc9dad8a511b9146bbaeb194050c33a00fa8c03f875904a400a2b9b00f014df4
+  metadata.gz: 781d7182b8ab6cfbfd6cace3a8afb19bf2ccad79693e3cba410cd85806c003c71f07386255af6f321403a75d5675d230b0c2d0a2881c7f3f519740e89b1908d6
+  data.tar.gz: bdf5446b31e7439a058d1459318ff0fbbab5de576df0ca2ead53d7b2d2ab320265745984389cc66fcdef87ae7cce8e3f08c936bcdbf2edacf0f6d70b5690fa6d

data/lib/decode/comment/node.rb

@@ -54,6 +54,14 @@ module Decode
 				end
 			end
 			
+			def filter(klass)
+				return to_enum(:filter, klass) unless block_given?
+				
+				@children&.each do |child|
+					yield child if child.is_a?(klass)
+				end
+			end
+			
 			# Any lines of text associated wtih this node.
 			# @returns [Array(String) | Nil] The lines of text.
 			def text

data/lib/decode/comment/pragma.rb

@@ -30,13 +30,15 @@ module Decode
 		# - `@asynchronous This method may yield.`
 		#
 		class Pragma < Tag
-			PATTERN = /\A(?<details>.*?)?\Z/
+			def self.parse(directive, text, lines, tags, level = 0)
+				self.build(directive, text)
+			end
 			
-			def self.build(directive, match)
+			def self.build(directive, text)
 				node = self.new(directive)
 				
-				if details = match[:details]
-					node.add(Text.new(details))
+				if text
+					node.add(Text.new(text))
 				end
 				
 				return node

data/lib/decode/comment/tag.rb

@@ -23,8 +23,12 @@ require_relative 'node'
 module Decode
 	module Comment
 		class Tag < Node
+			def self.match(text)
+				self::PATTERN.match(text)
+			end
+			
 			def self.parse(directive, text, lines, tags, level = 0)
-				if match = self::PATTERN.match(text)
+				if match = self.match(text)
 					node = self.build(directive, match)
 					
 					tags.parse(lines, level + 1) do |child|

data/lib/decode/definition.rb

@@ -29,13 +29,13 @@ module Decode
 		def initialize(name, parent: nil, language: parent.language, comments: nil)
 			@name = name
 			
-			@comments = comments
-			@language = language
 			@parent = parent
+			@language = language
+			
+			@comments = comments
 			
 			@path = nil
 			@qualified_name = nil
-			@documentation = nil
 		end
 		
 		def to_s

data/lib/decode/documentation.rb

@@ -20,6 +20,7 @@
 
 require_relative 'comment/node'
 
+require_relative 'comment/tags'
 require_relative 'comment/attribute'
 require_relative 'comment/parameter'
 require_relative 'comment/pragma'

data/lib/decode/language/generic.rb

@@ -19,32 +19,77 @@
 # THE SOFTWARE.
 
 require_relative 'reference'
+require_relative '../documentation'
 
 module Decode
 	module Language
 		# The Ruby language.
 		class Generic
-			def initialize(name)
+			EXTENSIONS = []
+			
+			TAGS = Comment::Tags.build do |tags|
+				tags['attribute'] = Comment::Attribute
+				tags['parameter'] = Comment::Parameter
+				tags['yields'] = Comment::Yields
+				tags['returns'] = Comment::Returns
+				tags['raises'] = Comment::Raises
+				tags['throws'] = Comment::Throws
+				
+				tags['deprecated'] = Comment::Pragma
+				
+				tags['asynchronous'] = Comment::Pragma
+				
+				tags['public'] = Comment::Pragma
+				tags['private'] = Comment::Pragma
+			end
+			
+			def initialize(name, extensions: self.class::EXTENSIONS, tags: self.class::TAGS)
 				@name = name
+				@extensions = extensions
+				@tags = tags
 			end
 			
 			attr :name
 			
-			# Generate a generic reference.
+			def names
+				[@name]
+			end
+			
+			attr :extensions
+			
+			attr :tags
+			
+			# Generate a language-specific reference.
+			# @parameter identifier [String] A valid identifier.
 			def reference_for(identifier)
 				Reference.new(identifier, self)
 			end
 			
+			def parser
+				nil
+			end
+			
 			# Parse the input yielding definitions.
-			# @block {|definition| ... }
-			# @yield definition [Definition]
+			# @parameter input [File] The input 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)
+				if parser = self.parser
+					parser.definitions_for(input, &block)
+				end
 			end
 			
-			# Parse the input yielding interleaved comments and code segments.
-			# @block {|segment| ... }
-			# @yield segment [Segment]
+			# 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.
+			# @yields {|segment| ...}
+			# 	@parameter segment [Segment]
+			# @returns [Enumerator(Segment)] If no block given.
 			def segments_for(input, &block)
+				if parser = self.parser
+					parser.segments_for(input, &block)
+				end
 			end
 		end
 	end

data/lib/decode/language/ruby.rb

@@ -18,78 +18,14 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require_relative 'ruby/reference'
-require_relative 'ruby/parser'
-require_relative 'ruby/code'
-
-require_relative '../comment/tags'
-require_relative '../comment/parameter'
-require_relative '../comment/yields'
-require_relative '../comment/returns'
+require_relative 'ruby/generic'
 
 module Decode
 	module Language
 		# An interface for extracting information from Ruby source code.
 		module Ruby
-			# The canoical name of the language for use in output formatting.
-			# e.g. source code highlighting.
-			def self.name
-				"ruby"
-			end
-			
-			def self.names
-				[self.name]
-			end
-			
-			def self.extensions
-				['.rb', '.ru']
-			end
-			
-			TAGS = Comment::Tags.build do |tags|
-				tags['attribute'] = Comment::Attribute
-				tags['parameter'] = Comment::Parameter
-				tags['yields'] = Comment::Yields
-				tags['returns'] = Comment::Returns
-				tags['raises'] = Comment::Raises
-				tags['throws'] = Comment::Throws
-				
-				tags['reentrant'] = Comment::Pragma
-				tags['deprecated'] = Comment::Pragma
-				tags['blocking'] = Comment::Pragma
-				tags['asynchronous'] = Comment::Pragma
-			end
-			
-			def self.tags
-				TAGS
-			end
-			
-			# Generate a language-specific reference.
-			# @parameter identifier [String] A valid identifier.
-			def self.reference_for(identifier)
-				Reference.new(identifier, self)
-			end
-			
-			# Parse the input yielding definitions.
-			# @parameter input [File] The input 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 self.definitions_for(input, &block)
-				Parser.new.definitions_for(input, &block)
-			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.
-			# @yields {|segment| ...}
-			# 	@parameter segment [Segment]
-			# @returns [Enumerator(Segment)] If no block given.
-			def self.segments_for(input, &block)
-				Parser.new.segments_for(input, &block)
-			end
-			
-			def self.code_for(text, index, relative_to: nil)
-				Code.new(text, index, relative_to: relative_to, language: self)
+			def self.new
+				Generic.new("ruby")
 			end
 		end
 	end

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

@@ -51,10 +51,10 @@ module Decode
 					if lines.count == 1
 						return lines.first
 					else
-						indentation = expression.source_line[/\A\s+/]
-						
-						# Remove all the indentation:
-						lines.each{|line| line.sub!(indentation, '')}
+						if indentation = expression.source_line[/\A\s+/]
+							# Remove all the indentation:
+							lines.each{|line| line.sub!(indentation, '')}
+						end
 						
 						return lines.join
 					end

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

@@ -0,0 +1,48 @@
+# 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'
+require_relative 'parser'
+require_relative 'code'
+
+module Decode
+	module Language
+		module Ruby
+			# The Ruby language.
+			class Generic < Language::Generic
+				EXTENSIONS = ['.rb', '.ru']
+				
+				def parser
+					@parser ||= Parser.new(self)
+				end
+				
+				# Generate a language-specific reference.
+				# @parameter identifier [String] A valid identifier.
+				def reference_for(identifier)
+					Reference.new(identifier, self)
+				end
+				
+				def code_for(text, index, relative_to: nil)
+					Code.new(text, index, relative_to: relative_to, language: self)
+				end
+			end
+		end
+	end
+end

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

@@ -38,6 +38,10 @@ module Decode
 		module Ruby
 			# The Ruby source code parser.
 			class Parser
+				def initialize(language)
+					@language = language
+				end
+				
 				# Extract definitions from the given input file.
 				def definitions_for(input, &block)
 					top, comments = ::Parser::CurrentRuby.parse_with_comments(input)
@@ -84,7 +88,7 @@ module Decode
 							node, node.children[0].children[1],
 							comments: extract_comments_for(node, comments),
 							parent: parent,
-							language: Ruby
+							language: @language
 						)
 						
 						yield definition
@@ -96,7 +100,7 @@ module Decode
 						definition = Class.new(
 							node, node.children[0].children[1],
 							comments: extract_comments_for(node, comments),
-							parent: parent, language: Ruby
+							parent: parent, language: @language
 						)
 						
 						yield definition
@@ -108,7 +112,7 @@ module Decode
 						definition = Singleton.new(
 							node, node.children[0],
 							comments: extract_comments_for(node, comments),
-							parent: parent, language: Ruby
+							parent: parent, language: @language
 						)
 						
 						yield definition
@@ -120,7 +124,7 @@ module Decode
 						definition = Method.new(
 							node, node.children[0],
 							comments: extract_comments_for(node, comments),
-							parent: parent, language: Ruby
+							parent: parent, language: @language
 						)
 						
 						yield definition
@@ -128,7 +132,7 @@ module Decode
 						definition = Function.new(
 							node, node.children[1],
 							comments: extract_comments_for(node, comments),
-							parent: parent, language: Ruby
+							parent: parent, language: @language
 						)
 						
 						yield definition
@@ -136,18 +140,19 @@ module Decode
 						definition = Constant.new(
 							node, node.children[1],
 							comments: extract_comments_for(node, comments),
-							parent: parent, language: Ruby
+							parent: parent, language: @language
 						)
 						
 						yield definition
 					when :send
 						name = node.children[1]
+						
 						case name
 						when :attr, :attr_reader, :attr_writer, :attr_accessor
 							definition = Attribute.new(
 								node, name_for(node.children[2]),
 								comments: extract_comments_for(node, comments),
-								parent: parent, language: Ruby
+								parent: parent, language: @language
 							)
 							
 							yield definition
@@ -157,7 +162,7 @@ module Decode
 								definition = Call.new(
 									node, name_for(node, extracted_comments),
 									comments: extracted_comments,
-									parent: parent, language: Ruby
+									parent: parent, language: @language
 								)
 								
 								yield definition
@@ -171,7 +176,7 @@ module Decode
 								node, name,
 								comments: extracted_comments,
 								parent: scope_for(extracted_comments, parent, &block),
-								language: Ruby
+								language: @language
 							)
 							
 							if kind = kind_for(node, extracted_comments)
@@ -229,7 +234,7 @@ module Decode
 					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)
+								scope = Scope.new(name, parent: memo, language: @language)
 								yield scope
 								scope
 							end
@@ -268,11 +273,11 @@ module Decode
 							if segment.nil?
 								segment = Segment.new(
 									extract_comments_for(child, comments),
-									Ruby,	child
+									@language,	child
 								)
 							elsif next_comments = extract_comments_for(child, comments)
 								yield segment if segment
-								segment = Segment.new(next_comments, Ruby, child)
+								segment = Segment.new(next_comments, @language, child)
 							else
 								segment.expand(child)
 							end
@@ -283,7 +288,7 @@ module Decode
 						# One top level segment:
 						segment = Segment.new(
 							extract_comments_for(node, comments),
-							Ruby,	node
+							@language, node
 						)
 						
 						yield segment

data/lib/decode/languages.rb

@@ -26,7 +26,7 @@ module Decode
 	class Languages
 		def self.all
 			self.new.tap do |languages|
-				languages.add(Language::Ruby)
+				languages.add(Language::Ruby.new)
 			end
 		end
 		

data/lib/decode/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: decode
 version: !ruby/object:Gem::Version
-  version: 0.15.2
+  version: 0.17.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-07 00:00:00.000000000 Z
+date: 2021-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: covered
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: covered
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -82,7 +82,6 @@ dependencies:
         version: '0'
 description:
 email:
-- samuel.williams@oriontransfer.co.nz
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -115,6 +114,7 @@ files:
 - lib/decode/language/ruby/constant.rb
 - lib/decode/language/ruby/definition.rb
 - lib/decode/language/ruby/function.rb
+- lib/decode/language/ruby/generic.rb
 - lib/decode/language/ruby/method.rb
 - lib/decode/language/ruby/module.rb
 - lib/decode/language/ruby/parser.rb
@@ -132,14 +132,15 @@ files:
 homepage: https://github.com/ioquatix/decode
 licenses:
 - MIT
-metadata: {}
+metadata:
+  funding_uri: https://github.com/sponsors/ioquatix/
 post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
       version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
@@ -148,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Code analysis for documentation generation.