decode 0.12.0 → 0.15.1

data/lib/decode/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: decode
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.15.1
 platform: ruby
 authors:
 - Samuel Williams
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-08 00:00:00.000000000 Z
+date: 2020-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -108,31 +108,38 @@ 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
 - 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
 - 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
@@ -141,32 +148,36 @@ 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
+- 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:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.0.3
+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.

data/decode.gemspec

@@ -1,33 +0,0 @@
-
-require_relative 'lib/decode/version'
-
-Gem::Specification.new do |spec|
-	spec.name = "decode"
-	spec.version = Decode::VERSION
-	spec.authors = ["Samuel Williams"]
-	spec.email = ["samuel.williams@oriontransfer.co.nz"]
-	
-	spec.summary = "Code analysis for documentation generation."
-	spec.homepage = "https://github.com/ioquatix/decode"
-	spec.license = "MIT"
-	
-	spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
-	
-	# Specify which files should be added to the gem when it is released.
-	# The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-	spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
-		`git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(docs|test|spec|features)/}) }
-	end
-	
-	spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-	spec.require_paths = ["lib"]
-	
-	spec.add_dependency "parser"
-	
-	spec.add_development_dependency 'build-files'
-	spec.add_development_dependency 'bake-bundler'
-	spec.add_development_dependency 'utopia-project'
-	spec.add_development_dependency 'covered'
-	spec.add_development_dependency 'bundler'
-	spec.add_development_dependency 'rspec'
-end

data/gems.rb

@@ -1,3 +0,0 @@
-source "https://rubygems.org"
-
-gemspec

data/guides/extract-symbols/extract.rb

@@ -1,26 +0,0 @@
-#!/usr/bin/env ruby
-
-# This example demonstrates how to extract symbols using the index. An instance of {Decode::Index} is used for loading symbols from source code files. These symbols are available as a flat list and as a trie structure. You can look up specific symbols using a reference using {Decode::Index:lookup}.
-require_relative '../../lib/decode/index'
-
-# Firstly, construct the index:
-index = Decode::Index.new
-
-# Then, update the index by loading paths from the file system:
-paths = Dir.glob(File.expand_path("../../lib/**/*.rb", __dir__))
-index.update(paths)
-
-# Finally, you can print out the loaded symbols:
-index.symbols.each do |name, symbol|
-	puts symbol.long_form
-end
-
-# Lookup a specific symbol:
-absolute_reference = Decode::Language::Ruby.reference("Decode::Index:lookup")
-lookup_symbol = index.lookup(absolute_reference).first
-puts lookup_symbol.long_form
-
-# Lookup a method relative to that symbol:
-relative_reference = Decode::Language::Ruby.reference("trie")
-trie_attribute = index.lookup(relative_reference, relative_to: lookup_symbol).first
-puts trie_attribute.long_form