yard 0.9.25 → 0.9.28
Sign up to get free protection for your applications and to get access to all the features.
Potentially problematic release.
This version of yard might be problematic. Click here for more details.
- checksums.yaml +4 -4
- data/.dockerignore +0 -0
- data/.gitattributes +4 -0
- data/.github/FUNDING.yml +3 -0
- data/.github/ISSUE_TEMPLATE.md +6 -6
- data/.github/PULL_REQUEST_TEMPLATE.md +5 -5
- data/.github/workflows/ci.yml +10 -10
- data/.github/workflows/gem.yml +19 -0
- data/.gitignore +0 -0
- data/.rspec +0 -0
- data/.rubocop.yml +0 -0
- data/.yardopts +0 -0
- data/.yardopts_guide +0 -0
- data/.yardopts_i18n +0 -0
- data/CHANGELOG.md +40 -8
- data/CONTRIBUTING.md +2 -2
- data/Gemfile +5 -3
- data/LICENSE +1 -1
- data/README.md +1 -1
- data/Rakefile +0 -3
- data/lib/yard/cli/stats.rb +4 -1
- data/lib/yard/cli/yardoc.rb +4 -2
- data/lib/yard/code_objects/method_object.rb +1 -1
- data/lib/yard/config.rb +5 -1
- data/lib/yard/handlers/c/base.rb +164 -164
- data/lib/yard/handlers/ruby/method_handler.rb +2 -2
- data/lib/yard/handlers/ruby/mixin_handler.rb +7 -2
- data/lib/yard/handlers/ruby/module_function_handler.rb +15 -3
- data/lib/yard/parser/ruby/ast_node.rb +9 -2
- data/lib/yard/parser/ruby/ruby_parser.rb +1 -1
- data/lib/yard/parser/source_parser.rb +1 -1
- data/lib/yard/server/commands/base.rb +2 -2
- data/lib/yard/server/commands/library_command.rb +1 -1
- data/lib/yard/tags/directives.rb +10 -1
- data/lib/yard/templates/helpers/html_helper.rb +5 -2
- data/lib/yard/templates/helpers/markup_helper.rb +2 -1
- data/lib/yard/templates/helpers/method_helper.rb +3 -1
- data/lib/yard/templates/section.rb +1 -3
- data/lib/yard/templates/template.rb +3 -1
- data/lib/yard/version.rb +1 -1
- data/lib/yard.rb +6 -0
- data/samus.json +15 -46
- data/tasks/prepare_tag.rake +45 -0
- data/templates/default/fulldoc/html/css/style.css +1 -0
- data/templates/default/layout/html/footer.erb +1 -1
- data/yard.gemspec +2 -1
- metadata +21 -4
- data/.travis.yml +0 -52
data/samus.json
CHANGED
@@ -2,7 +2,9 @@
|
|
2
2
|
"actions": [
|
3
3
|
{
|
4
4
|
"action": "fs-sedfiles",
|
5
|
-
"files": [
|
5
|
+
"files": [
|
6
|
+
"lib/*/version.rb"
|
7
|
+
],
|
6
8
|
"arguments": {
|
7
9
|
"search": "VERSION = ['\"](.+?)['\"]",
|
8
10
|
"replace": "VERSION = '$version'"
|
@@ -10,23 +12,31 @@
|
|
10
12
|
},
|
11
13
|
{
|
12
14
|
"action": "chmod-files",
|
13
|
-
"files": [
|
15
|
+
"files": [
|
16
|
+
"**/*,644",
|
17
|
+
"bin/*,755"
|
18
|
+
]
|
14
19
|
},
|
15
20
|
{
|
16
21
|
"action": "changelog-rotate",
|
17
|
-
"files": [
|
22
|
+
"files": [
|
23
|
+
"CHANGELOG.md"
|
24
|
+
],
|
18
25
|
"arguments": {
|
19
26
|
"title_format": "$version - %B %-d$day_nth, %Y"
|
20
27
|
}
|
21
28
|
},
|
22
29
|
{
|
23
30
|
"action": "git-commit",
|
24
|
-
"files": [
|
31
|
+
"files": [
|
32
|
+
"CHANGELOG.md",
|
33
|
+
"lib/*/version.rb"
|
34
|
+
]
|
25
35
|
},
|
26
36
|
{
|
27
37
|
"action": "git-merge",
|
28
38
|
"arguments": {
|
29
|
-
"branch": "
|
39
|
+
"branch": "main"
|
30
40
|
}
|
31
41
|
},
|
32
42
|
{
|
@@ -34,47 +44,6 @@
|
|
34
44
|
},
|
35
45
|
{
|
36
46
|
"action": "rake-task"
|
37
|
-
},
|
38
|
-
{
|
39
|
-
"action": "archive-git-full",
|
40
|
-
"files": ["git.tgz"],
|
41
|
-
"publish": [
|
42
|
-
{
|
43
|
-
"action": "git-push",
|
44
|
-
"credentials": "lsegal.github.ssh",
|
45
|
-
"arguments": {
|
46
|
-
"remotes": "origin",
|
47
|
-
"refs": "master v$version"
|
48
|
-
}
|
49
|
-
}
|
50
|
-
]
|
51
|
-
},
|
52
|
-
{
|
53
|
-
"action": "gem-build",
|
54
|
-
"files": ["*.gemspec"],
|
55
|
-
"publish": [
|
56
|
-
{
|
57
|
-
"action": "gem-push",
|
58
|
-
"files": ["*.gem"],
|
59
|
-
"credentials": "lsegal.rubygems"
|
60
|
-
}
|
61
|
-
]
|
62
|
-
},
|
63
|
-
{
|
64
|
-
"action": "changelog-parse",
|
65
|
-
"files": ["CHANGELOG.md"],
|
66
|
-
"publish": [
|
67
|
-
{
|
68
|
-
"action": "github-release",
|
69
|
-
"credentials": "lsegal.github",
|
70
|
-
"files": [],
|
71
|
-
"arguments": {
|
72
|
-
"repository": "lsegal/yard",
|
73
|
-
"tag": "v$version",
|
74
|
-
"changelog": "CHANGELOG.md"
|
75
|
-
}
|
76
|
-
}
|
77
|
-
]
|
78
47
|
}
|
79
48
|
]
|
80
49
|
}
|
@@ -0,0 +1,45 @@
|
|
1
|
+
require 'json'
|
2
|
+
require 'tempfile'
|
3
|
+
|
4
|
+
namespace :release do
|
5
|
+
desc 'Updates repository and tags VERSION=X.Y.Z'
|
6
|
+
task :tag do
|
7
|
+
restore_file = Tempfile.new
|
8
|
+
restore_file.close
|
9
|
+
at_exit { restore_file.unlink }
|
10
|
+
|
11
|
+
version = ENV['VERSION']
|
12
|
+
build_path = File.expand_path(File.join(`gem which samus`.strip, '..', '..', 'commands', 'build'))
|
13
|
+
samus_contents = File.read(File.join(__dir__, '..', 'samus.json'))
|
14
|
+
samus_json = JSON.parse(samus_contents.gsub('$version', version))
|
15
|
+
|
16
|
+
samus_json['actions'].each do |action|
|
17
|
+
env = {
|
18
|
+
'_VERSION' => version,
|
19
|
+
'__ORIG_BRANCH' => `git rev-parse --abbrev-ref HEAD`.strip,
|
20
|
+
'__RESTORE_FILE' => restore_file.path,
|
21
|
+
}
|
22
|
+
(action['arguments'] || {}).each {|k, v| env["_#{k.upcase}"] = v }
|
23
|
+
cmd = [File.join(build_path, action['action']), *action['files']]
|
24
|
+
puts "[C] #{action['action']} #{(action['files'] || []).join(' ')}"
|
25
|
+
output = ""
|
26
|
+
IO.popen(env, cmd) {|io| output = io.read }
|
27
|
+
status = $?
|
28
|
+
unless status.success?
|
29
|
+
puts "[F] Last command failed with: #{status.to_i}"
|
30
|
+
puts output
|
31
|
+
exit(status.to_i)
|
32
|
+
end
|
33
|
+
end
|
34
|
+
|
35
|
+
puts ""
|
36
|
+
puts "Tag v#{version} created. To publish, type the following:"
|
37
|
+
puts ""
|
38
|
+
puts " bundle exec rake release:push VERSION=#{version}"
|
39
|
+
end
|
40
|
+
|
41
|
+
desc 'Pushes the main branch and tag for VERSION=X.Y.Z'
|
42
|
+
task :push do
|
43
|
+
sh "git push main v#{ENV['VERSION']}"
|
44
|
+
end
|
45
|
+
end
|
@@ -1,5 +1,5 @@
|
|
1
1
|
<div id="footer">
|
2
2
|
Generated on <%= Time.now.strftime("%c") %> by
|
3
|
-
<a href="
|
3
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
4
4
|
<%= YARD::VERSION %> (ruby-<%= RUBY_VERSION %>).
|
5
5
|
</div>
|
data/yard.gemspec
CHANGED
@@ -11,7 +11,6 @@ Gem::Specification.new do |s|
|
|
11
11
|
custom Ruby constructs such as custom class level definitions.
|
12
12
|
eof
|
13
13
|
s.version = YARD::VERSION
|
14
|
-
s.date = Time.now.strftime('%Y-%m-%d')
|
15
14
|
s.author = "Loren Segal"
|
16
15
|
s.email = "lsegal@soen.ca"
|
17
16
|
s.homepage = "http://yardoc.org"
|
@@ -21,4 +20,6 @@ Gem::Specification.new do |s|
|
|
21
20
|
s.executables = ['yard', 'yardoc', 'yri']
|
22
21
|
s.license = 'MIT' if s.respond_to?(:license=)
|
23
22
|
s.metadata['yard.run'] = 'yri'
|
23
|
+
|
24
|
+
s.add_runtime_dependency 'webrick', '~> 1.7.0'
|
24
25
|
end
|
metadata
CHANGED
@@ -1,15 +1,29 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: yard
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.9.
|
4
|
+
version: 0.9.28
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Loren Segal
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
12
|
-
dependencies:
|
11
|
+
date: 2022-06-01 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: webrick
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: 1.7.0
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: 1.7.0
|
13
27
|
description: |2
|
14
28
|
YARD is a documentation generation tool for the Ruby programming language.
|
15
29
|
It enables the user to generate consistent, usable documentation that can be
|
@@ -24,13 +38,15 @@ extensions: []
|
|
24
38
|
extra_rdoc_files: []
|
25
39
|
files:
|
26
40
|
- ".dockerignore"
|
41
|
+
- ".gitattributes"
|
42
|
+
- ".github/FUNDING.yml"
|
27
43
|
- ".github/ISSUE_TEMPLATE.md"
|
28
44
|
- ".github/PULL_REQUEST_TEMPLATE.md"
|
29
45
|
- ".github/workflows/ci.yml"
|
46
|
+
- ".github/workflows/gem.yml"
|
30
47
|
- ".gitignore"
|
31
48
|
- ".rspec"
|
32
49
|
- ".rubocop.yml"
|
33
|
-
- ".travis.yml"
|
34
50
|
- ".yardopts"
|
35
51
|
- ".yardopts_guide"
|
36
52
|
- ".yardopts_i18n"
|
@@ -296,6 +312,7 @@ files:
|
|
296
312
|
- lib/yard/version.rb
|
297
313
|
- po/ja.po
|
298
314
|
- samus.json
|
315
|
+
- tasks/prepare_tag.rake
|
299
316
|
- tasks/update_error_map.rake
|
300
317
|
- templates/default/class/dot/setup.rb
|
301
318
|
- templates/default/class/dot/superklass.erb
|
data/.travis.yml
DELETED
@@ -1,52 +0,0 @@
|
|
1
|
-
# Enables Travis to use their new container-based infrastructure
|
2
|
-
sudo: false
|
3
|
-
|
4
|
-
# Build for Ruby
|
5
|
-
language: ruby
|
6
|
-
|
7
|
-
# Enables caching for bundler
|
8
|
-
cache: bundler
|
9
|
-
|
10
|
-
# Specify which ruby versions you wish to run your tests on, each version will be used
|
11
|
-
rvm:
|
12
|
-
- "2.0"
|
13
|
-
- "2.1"
|
14
|
-
- "2.2"
|
15
|
-
- "2.3"
|
16
|
-
- "2.4"
|
17
|
-
- "2.5"
|
18
|
-
- "2.6"
|
19
|
-
- "2.7"
|
20
|
-
# - ruby-head
|
21
|
-
# - jruby
|
22
|
-
|
23
|
-
# Define how to run your tests (defaults to `bundle exec rake` or `rake` depending on whether you have a `Gemfile`)
|
24
|
-
script: "bundle exec rake"
|
25
|
-
|
26
|
-
# Define tasks to be completed before and after tests run . Will allow folding of content on frontend
|
27
|
-
#before_script:
|
28
|
-
# - command_1
|
29
|
-
# - command_2
|
30
|
-
#
|
31
|
-
#after_script:
|
32
|
-
# - command_1
|
33
|
-
# - command_2
|
34
|
-
|
35
|
-
# Specify an ENV variable to run before: 'bundle install' and 'rake' (or your defined 'script')
|
36
|
-
env:
|
37
|
-
- CI=1
|
38
|
-
|
39
|
-
# Specify the recipients for email notification
|
40
|
-
#notifications:
|
41
|
-
# recipients:
|
42
|
-
# - email-address-1
|
43
|
-
# - email-address-2
|
44
|
-
|
45
|
-
# Disable email notifications
|
46
|
-
#notifications:
|
47
|
-
# disabled: true
|
48
|
-
|
49
|
-
# notifications:
|
50
|
-
# webhooks:
|
51
|
-
# urls:
|
52
|
-
# - https://webhooks.gitter.im/e/c6dbb9323007dfcf81df
|