decode 0.21.2 → 0.22.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- checksums.yaml.gz.sig +0 -0
- data/bake/decode/index.rb +11 -14
- data/lib/decode/comment/attribute.rb +1 -1
- data/lib/decode/comment/node.rb +1 -1
- data/lib/decode/comment/option.rb +17 -0
- data/lib/decode/comment/parameter.rb +1 -1
- data/lib/decode/comment/pragma.rb +1 -1
- data/lib/decode/comment/raises.rb +1 -1
- data/lib/decode/comment/returns.rb +1 -1
- data/lib/decode/comment/tag.rb +1 -1
- data/lib/decode/comment/tags.rb +1 -1
- data/lib/decode/comment/text.rb +1 -1
- data/lib/decode/comment/throws.rb +1 -1
- data/lib/decode/comment/yields.rb +1 -1
- data/lib/decode/definition.rb +1 -1
- data/lib/decode/documentation.rb +2 -1
- data/lib/decode/index.rb +1 -1
- data/lib/decode/language/generic.rb +2 -2
- data/lib/decode/language/reference.rb +1 -1
- data/lib/decode/language/ruby/attribute.rb +1 -1
- data/lib/decode/language/ruby/block.rb +1 -1
- data/lib/decode/language/ruby/call.rb +1 -1
- data/lib/decode/language/ruby/class.rb +1 -1
- data/lib/decode/language/ruby/code.rb +1 -1
- data/lib/decode/language/ruby/constant.rb +1 -1
- data/lib/decode/language/ruby/definition.rb +1 -1
- data/lib/decode/language/ruby/function.rb +1 -1
- data/lib/decode/language/ruby/generic.rb +1 -1
- data/lib/decode/language/ruby/method.rb +1 -1
- data/lib/decode/language/ruby/module.rb +1 -1
- data/lib/decode/language/ruby/parser.rb +1 -1
- data/lib/decode/language/ruby/reference.rb +1 -1
- data/lib/decode/language/ruby/segment.rb +1 -1
- data/lib/decode/language/ruby.rb +1 -1
- data/lib/decode/language.rb +1 -1
- data/lib/decode/languages.rb +1 -1
- data/lib/decode/location.rb +1 -1
- data/lib/decode/scope.rb +1 -1
- data/lib/decode/segment.rb +1 -1
- data/lib/decode/source.rb +1 -1
- data/lib/decode/syntax/link.rb +1 -1
- data/lib/decode/syntax/match.rb +1 -1
- data/lib/decode/syntax/rewriter.rb +1 -1
- data/lib/decode/trie.rb +1 -1
- data/lib/decode/version.rb +2 -2
- data/lib/decode.rb +5 -1
- data/license.md +1 -1
- data/readme.md +13 -5
- data.tar.gz.sig +0 -0
- metadata +7 -4
- metadata.gz.sig +0 -0
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: dd0b7516d4dffc4eeb854093c5fe7b05776dcee117eeeecafe86c5b1c8309b3c
|
|
4
|
+
data.tar.gz: 92080e0cfe0e151f1cd5093414b4cd9deef5bcc30aa50e0abd4bc49d1e0fd2b5
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: b88d0a989f34575cbd8a2aa141769e2f5426c4f6b6639925458bd18fac6f873c525c3391bb17a78feb72daf3570a85899a1160f832ff1a60f1604ef08523938b
|
|
7
|
+
data.tar.gz: 415dc8eb4f66d3832f7790522b605a7ef32eae6528b1da7c91f6e54770f01f39397d87196b3c3770b27eb3634883bd148f5bd4165c9fe55e3494c7ae4b727a8d
|
checksums.yaml.gz.sig
CHANGED
|
Binary file
|
data/bake/decode/index.rb
CHANGED
|
@@ -1,16 +1,19 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
3
|
# Released under the MIT License.
|
|
4
|
-
# Copyright, 2020, by Samuel Williams.
|
|
4
|
+
# Copyright, 2020-2024, by Samuel Williams.
|
|
5
|
+
|
|
6
|
+
def initialize(...)
|
|
7
|
+
super
|
|
8
|
+
|
|
9
|
+
require 'decode/index'
|
|
10
|
+
require 'set'
|
|
11
|
+
end
|
|
5
12
|
|
|
6
13
|
# Process the given source root and report on comment coverage.
|
|
7
14
|
# @parameter root [String] The root path to index.
|
|
8
15
|
def coverage(root)
|
|
9
|
-
|
|
10
|
-
require 'decode/index'
|
|
11
|
-
require 'set'
|
|
12
|
-
|
|
13
|
-
paths = Build::Files::Path.expand(root).glob("**/*")
|
|
16
|
+
paths = Dir.glob(File.join(root, "**/*"))
|
|
14
17
|
|
|
15
18
|
index = Decode::Index.new
|
|
16
19
|
index.update(paths)
|
|
@@ -61,10 +64,7 @@ end
|
|
|
61
64
|
# Process the given source root and report on symbols.
|
|
62
65
|
# @parameter root [String] The root path to index.
|
|
63
66
|
def symbols(root)
|
|
64
|
-
|
|
65
|
-
require 'decode/index'
|
|
66
|
-
|
|
67
|
-
paths = Build::Files::Path.expand(root).glob("**/*")
|
|
67
|
+
paths = Dir.glob(File.join(root, "**/*"))
|
|
68
68
|
|
|
69
69
|
index = Decode::Index.new
|
|
70
70
|
index.update(paths)
|
|
@@ -84,10 +84,7 @@ end
|
|
|
84
84
|
# Print documentation for all definitions.
|
|
85
85
|
# @parameter root [String] The root path to index.
|
|
86
86
|
def documentation(root)
|
|
87
|
-
|
|
88
|
-
require 'decode/index'
|
|
89
|
-
|
|
90
|
-
paths = Build::Files::Path.expand(root).glob("**/*")
|
|
87
|
+
paths = Dir.glob(File.join(root, "**/*"))
|
|
91
88
|
|
|
92
89
|
index = Decode::Index.new
|
|
93
90
|
index.update(paths)
|
data/lib/decode/comment/node.rb
CHANGED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# Released under the MIT License.
|
|
4
|
+
# Copyright, 2024, by Samuel Williams.
|
|
5
|
+
|
|
6
|
+
require_relative 'parameter'
|
|
7
|
+
|
|
8
|
+
module Decode
|
|
9
|
+
module Comment
|
|
10
|
+
# Describes a method option (keyword argument).
|
|
11
|
+
#
|
|
12
|
+
# - `@option :cached [Boolean] Whether to cache the value.`
|
|
13
|
+
#
|
|
14
|
+
class Option < Parameter
|
|
15
|
+
end
|
|
16
|
+
end
|
|
17
|
+
end
|
data/lib/decode/comment/tag.rb
CHANGED
data/lib/decode/comment/tags.rb
CHANGED
data/lib/decode/comment/text.rb
CHANGED
data/lib/decode/definition.rb
CHANGED
data/lib/decode/documentation.rb
CHANGED
|
@@ -1,13 +1,14 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
3
|
# Released under the MIT License.
|
|
4
|
-
# Copyright, 2020-
|
|
4
|
+
# Copyright, 2020-2024, by Samuel Williams.
|
|
5
5
|
|
|
6
6
|
require_relative 'comment/node'
|
|
7
7
|
|
|
8
8
|
require_relative 'comment/tags'
|
|
9
9
|
require_relative 'comment/attribute'
|
|
10
10
|
require_relative 'comment/parameter'
|
|
11
|
+
require_relative 'comment/option'
|
|
11
12
|
require_relative 'comment/pragma'
|
|
12
13
|
require_relative 'comment/raises'
|
|
13
14
|
require_relative 'comment/returns'
|
data/lib/decode/index.rb
CHANGED
|
@@ -1,20 +1,20 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
3
|
# Released under the MIT License.
|
|
4
|
-
# Copyright, 2020-
|
|
4
|
+
# Copyright, 2020-2024, by Samuel Williams.
|
|
5
5
|
|
|
6
6
|
require_relative 'reference'
|
|
7
7
|
require_relative '../documentation'
|
|
8
8
|
|
|
9
9
|
module Decode
|
|
10
10
|
module Language
|
|
11
|
-
# The Ruby language.
|
|
12
11
|
class Generic
|
|
13
12
|
EXTENSIONS = []
|
|
14
13
|
|
|
15
14
|
TAGS = Comment::Tags.build do |tags|
|
|
16
15
|
tags['attribute'] = Comment::Attribute
|
|
17
16
|
tags['parameter'] = Comment::Parameter
|
|
17
|
+
tags['option'] = Comment::Option
|
|
18
18
|
tags['yields'] = Comment::Yields
|
|
19
19
|
tags['returns'] = Comment::Returns
|
|
20
20
|
tags['raises'] = Comment::Raises
|
data/lib/decode/language/ruby.rb
CHANGED
data/lib/decode/language.rb
CHANGED
data/lib/decode/languages.rb
CHANGED
data/lib/decode/location.rb
CHANGED
data/lib/decode/scope.rb
CHANGED
data/lib/decode/segment.rb
CHANGED
data/lib/decode/source.rb
CHANGED
data/lib/decode/syntax/link.rb
CHANGED
data/lib/decode/syntax/match.rb
CHANGED
data/lib/decode/trie.rb
CHANGED
data/lib/decode/version.rb
CHANGED
data/lib/decode.rb
CHANGED
|
@@ -1,7 +1,11 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
3
|
# Released under the MIT License.
|
|
4
|
-
# Copyright, 2020, by Samuel Williams.
|
|
4
|
+
# Copyright, 2020-2024, by Samuel Williams.
|
|
5
5
|
|
|
6
6
|
require_relative "decode/version"
|
|
7
7
|
require_relative "decode/index"
|
|
8
|
+
|
|
9
|
+
# @namespace
|
|
10
|
+
module Decode
|
|
11
|
+
end
|
data/license.md
CHANGED
data/readme.md
CHANGED
|
@@ -16,8 +16,16 @@ Please see the [project documentation](https://ioquatix.github.io/decode/).
|
|
|
16
16
|
|
|
17
17
|
We welcome contributions to this project.
|
|
18
18
|
|
|
19
|
-
1. Fork it
|
|
20
|
-
2. Create your feature branch (`git checkout -b my-new-feature`)
|
|
21
|
-
3. Commit your changes (`git commit -am 'Add some feature'`)
|
|
22
|
-
4. Push to the branch (`git push origin my-new-feature`)
|
|
23
|
-
5. Create new Pull Request
|
|
19
|
+
1. Fork it.
|
|
20
|
+
2. Create your feature branch (`git checkout -b my-new-feature`).
|
|
21
|
+
3. Commit your changes (`git commit -am 'Add some feature'`).
|
|
22
|
+
4. Push to the branch (`git push origin my-new-feature`).
|
|
23
|
+
5. Create new Pull Request.
|
|
24
|
+
|
|
25
|
+
### Developer Certificate of Origin
|
|
26
|
+
|
|
27
|
+
In order to protect users of this project, we require all contributors to comply with the [Developer Certificate of Origin](https://developercertificate.org/). This ensures that all contributions are properly licensed and attributed.
|
|
28
|
+
|
|
29
|
+
### Community Guidelines
|
|
30
|
+
|
|
31
|
+
This project is best served by a collaborative and respectful environment. Treat each other professionally, respect differing viewpoints, and engage constructively. Harassment, discrimination, or harmful behavior is not tolerated. Communicate clearly, listen actively, and support one another. If any issues arise, please inform the project maintainers.
|
data.tar.gz.sig
CHANGED
|
Binary file
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: decode
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.22.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Samuel Williams
|
|
@@ -37,7 +37,7 @@ cert_chain:
|
|
|
37
37
|
Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
|
|
38
38
|
voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
|
|
39
39
|
-----END CERTIFICATE-----
|
|
40
|
-
date: 2024-
|
|
40
|
+
date: 2024-08-17 00:00:00.000000000 Z
|
|
41
41
|
dependencies:
|
|
42
42
|
- !ruby/object:Gem::Dependency
|
|
43
43
|
name: parser
|
|
@@ -63,6 +63,7 @@ files:
|
|
|
63
63
|
- lib/decode.rb
|
|
64
64
|
- lib/decode/comment/attribute.rb
|
|
65
65
|
- lib/decode/comment/node.rb
|
|
66
|
+
- lib/decode/comment/option.rb
|
|
66
67
|
- lib/decode/comment/parameter.rb
|
|
67
68
|
- lib/decode/comment/pragma.rb
|
|
68
69
|
- lib/decode/comment/raises.rb
|
|
@@ -109,7 +110,9 @@ homepage: https://github.com/ioquatix/decode
|
|
|
109
110
|
licenses:
|
|
110
111
|
- MIT
|
|
111
112
|
metadata:
|
|
113
|
+
documentation_uri: https://ioquatix.github.io/decode/
|
|
112
114
|
funding_uri: https://github.com/sponsors/ioquatix/
|
|
115
|
+
source_code_uri: https://github.com/ioquatix/decode.git
|
|
113
116
|
post_install_message:
|
|
114
117
|
rdoc_options: []
|
|
115
118
|
require_paths:
|
|
@@ -118,14 +121,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
|
118
121
|
requirements:
|
|
119
122
|
- - ">="
|
|
120
123
|
- !ruby/object:Gem::Version
|
|
121
|
-
version: '
|
|
124
|
+
version: '3.1'
|
|
122
125
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
123
126
|
requirements:
|
|
124
127
|
- - ">="
|
|
125
128
|
- !ruby/object:Gem::Version
|
|
126
129
|
version: '0'
|
|
127
130
|
requirements: []
|
|
128
|
-
rubygems_version: 3.5.
|
|
131
|
+
rubygems_version: 3.5.11
|
|
129
132
|
signing_key:
|
|
130
133
|
specification_version: 4
|
|
131
134
|
summary: Code analysis for documentation generation.
|
metadata.gz.sig
CHANGED
|
Binary file
|