decode 0.13.0 → 0.15.2

data/lib/decode/syntax/match.rb

@@ -0,0 +1,53 @@
+# 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 Syntax
+		class Match
+			def initialize(range)
+				@range = range
+			end
+			
+			attr :range
+			
+			def apply(source)
+				return source[range]
+			end
+			
+			def <=> other
+				@range.min <=> other.range.min
+			end
+			
+			def offset
+				@range.min
+			end
+			
+			def size
+				@range.size
+			end
+			
+			def apply(output, rewriter)
+				output << rewriter.text_for(@range)
+				
+				return self.size
+			end
+		end
+	end
+end

data/lib/decode/syntax/rewriter.rb

@@ -0,0 +1,70 @@
+# 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 Syntax
+		class Rewriter
+			def initialize(text)
+				@text = text
+				@matches = []
+			end
+			
+			attr :text
+			
+			attr :matches
+			
+			def << match
+				@matches << match
+			end
+			
+			# Returns a chunk of raw text with no formatting.
+			def text_for(range)
+				@text[range]
+			end
+			
+			def apply(output = [])
+				offset = 0
+				
+				@matches.sort.each do |match|
+					if match.offset > offset
+						output << text_for(offset...match.offset)
+						
+						offset = match.offset
+					elsif match.offset < offset
+						# Match intersects last output buffer.
+						next
+					end
+					
+					offset += match.apply(output, self)
+				end
+				
+				if offset < @text.size
+					output << text_for(offset...@text.size)
+				end
+				
+				return output
+			end
+			
+			def link_to(definition, text)
+				"[#{text}]"
+			end
+		end
+	end
+end

data/lib/decode/trie.rb

@@ -31,17 +31,17 @@ module Decode
 			end
 			
 			# A mutable array of all values that terminate at this node.
-			# @attr [Array]
+			# @attribute [Array]
 			attr_accessor :values
 			
 			# A hash table of all children nodes, indexed by name.
-			# @attr [Hash(String, Node)]
+			# @attribute [Hash(String, Node)]
 			attr :children
 			
 			# Look up a lexical path starting at this node.
 			#
-			# @param path [Array(String)] The path to resolve.
-			# @return [Node | Nil]
+			# @parameter path [Array(String)] The path to resolve.
+			# @returns [Node | Nil]
 			def lookup(path, index = 0)
 				if index < path.size
 					if child = @children[path[index]]
@@ -55,9 +55,9 @@ module Decode
 			# Traverse the trie from this node.
 			# Invoke `descend.call` to traverse the children of the current node.
 			#
-			# @param path [Array(String)] The current lexical path.
+			# @parameter path [Array(String)] The current lexical path.
 			#
-			# @block `{|path, node, descend| descend.call}`
+			# @block {|path, node, descend| descend.call}
 			# @yield path [Array(String)] The current lexical path.
 			# @yield node [Node] The current node which is being traversed.
 			# @yield descend [Proc] The recursive method for traversing children.
@@ -76,12 +76,12 @@ module Decode
 		end
 		
 		# The root of the trie.
-		# @attr [Node]
+		# @attribute [Node]
 		attr :root
 		
 		# Insert the specified value at the given path into the trie.
-		# @param path [Array(String)] The lexical path where the value will be inserted.
-		# @param value [Object] The value to insert.
+		# @parameter path [Array(String)] The lexical path where the value will be inserted.
+		# @parameter value [Object] The value to insert.
 		def insert(path, value)
 			node = @root
 			
@@ -94,15 +94,15 @@ module Decode
 		
 		# Lookup the values at the specified path.
 		#
-		# @param path [Array(String)] The lexical path which contains the values.
-		# @return [Array(Object) | Nil] The values that existed (or not) at the specified path.
+		# @parameter path [Array(String)] The lexical path which contains the values.
+		# @returns [Array(Object) | Nil] The values that existed (or not) at the specified path.
 		def lookup(path)
 			@root.lookup(path)
 		end
 		
 		# Enumerate all lexical scopes under the specified path.
 		#
-		# @block `{|path, values| ...}`
+		# @block {|path, values| ...}
 		# @yield path [Array(String)] The lexical path.
 		# @yield values [Array(Object)] The values that exist at the given path.
 		def each(path = [], &block)
@@ -116,7 +116,7 @@ module Decode
 		end
 		
 		# Traverse the trie.
-		# See {Node:traverse} for details.
+		# See {Node#traverse} for details.
 		def traverse(path = [], &block)
 			if node = @root.lookup(path)
 				node.traverse(&block)

data/lib/decode/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: decode
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.15.2
 platform: ruby
 authors:
 - Samuel Williams
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-08 00:00:00.000000000 Z
+date: 2020-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -38,34 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bake-bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: utopia-project
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: covered
   requirement: !ruby/object:Gem::Requirement
@@ -108,22 +80,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - samuel.williams@oriontransfer.co.nz
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/development.yml"
-- ".gitignore"
-- ".rspec"
-- README.md
 - bake/decode/index.rb
-- decode.gemspec
-- gems.rb
-- guides/extract-symbols/extract.rb
 - lib/decode.rb
+- lib/decode/comment/attribute.rb
+- lib/decode/comment/node.rb
+- lib/decode/comment/parameter.rb
+- lib/decode/comment/pragma.rb
+- lib/decode/comment/raises.rb
+- lib/decode/comment/returns.rb
+- lib/decode/comment/tag.rb
+- lib/decode/comment/tags.rb
+- lib/decode/comment/text.rb
+- lib/decode/comment/throws.rb
+- lib/decode/comment/yields.rb
 - lib/decode/definition.rb
 - lib/decode/documentation.rb
 - lib/decode/index.rb
@@ -135,6 +111,7 @@ files:
 - lib/decode/language/ruby/block.rb
 - lib/decode/language/ruby/call.rb
 - lib/decode/language/ruby/class.rb
+- lib/decode/language/ruby/code.rb
 - lib/decode/language/ruby/constant.rb
 - lib/decode/language/ruby/definition.rb
 - lib/decode/language/ruby/function.rb
@@ -147,21 +124,24 @@ files:
 - lib/decode/scope.rb
 - lib/decode/segment.rb
 - lib/decode/source.rb
+- lib/decode/syntax/link.rb
+- lib/decode/syntax/match.rb
+- lib/decode/syntax/rewriter.rb
 - lib/decode/trie.rb
 - lib/decode/version.rb
 homepage: https://github.com/ioquatix/decode
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -169,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Code analysis for documentation generation.
 test_files: []

data/.github/workflows/development.yml

@@ -1,50 +0,0 @@
-name: Development
-
-on: [push, pull_request]
-
-jobs:
-  test:
-    runs-on: ${{matrix.os}}-latest
-    continue-on-error: ${{matrix.experimental}}
-    
-    strategy:
-      matrix:
-        os:
-          - ubuntu
-        
-        ruby:
-          - 2.5
-          - 2.6
-          - 2.7
-        
-        experimental: [false]
-        env: [""]
-        
-        include:
-          - os: ubuntu
-            ruby: truffleruby
-            experimental: true
-          - os: ubuntu
-            ruby: jruby
-            experimental: true
-          - os: ubuntu
-            ruby: head
-            experimental: true
-          - os: ubuntu
-            ruby: 2.6
-            experimental: false
-            env: COVERAGE=PartialSummary,Coveralls
-    
-    steps:
-    - uses: actions/checkout@v1
-    - uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{matrix.ruby}}
-    
-    - name: Install dependencies
-      run: ${{matrix.env}} bundle install
-    
-    - name: Run tests
-      timeout-minutes: 5
-      run: |
-        ${{matrix.env}} bundle exec rspec

data/.gitignore

@@ -1,13 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-/gems.locked
-
-# rspec failure tracking
-.rspec_status

data/.rspec

@@ -1,2 +0,0 @@
---format documentation
---require spec_helper

data/README.md

@@ -1,47 +0,0 @@
-# Decode
-
-A Ruby code analysis tool and documentation generator.
-
-[![Development](https://github.com/ioquatix/decode/workflows/Development/badge.svg)](https://github.com/ioquatix/decode/actions?workflow=Development)
-
-## Motivation
-
-As part of my effort to build [better project documentation](https://github.com/socketry/utopia-project), I needed a better code analysis tool. While less featured than some of the more mature alternatives, this library focuses on the needs of documentation generation, including speed, cross-referencing and (eventually) multi-language support.
-
-## Usage
-
-Please see the <a href="https://ioquatix.github.io/decode/">project documentation</a> or run it locally using `bake utopia:project:serve`.
-
-## Contributing
-
-We welcome contributions to this project.
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
-
-## License
-
-Released under the MIT license.
-
-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.