yard-yaml 0.1.3 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- checksums.yaml.gz.sig +0 -0
- data/CHANGELOG.md +15 -1
- data/CONTRIBUTING.md +17 -1
- data/README.md +7 -16
- data/SECURITY.md +1 -1
- data/lib/yard/yaml/cli.rb +14 -10
- data/lib/yard/yaml/config.rb +2 -2
- data/lib/yard/yaml/converter.rb +6 -6
- data/lib/yard/yaml/discovery.rb +3 -3
- data/lib/yard/yaml/emitter.rb +3 -3
- data/lib/yard/yaml/plugin.rb +3 -3
- data/lib/yard/yaml/tag_renderer.rb +1 -1
- data/lib/yard/yaml/tags.rb +5 -5
- data/lib/yard/yaml/template_helpers.rb +1 -1
- data/lib/yard/yaml/templates.rb +2 -2
- data/lib/yard/yaml/version.rb +1 -1
- data/lib/yard/yaml.rb +5 -5
- data.tar.gz.sig +0 -0
- metadata +34 -14
- 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: f2792c605ef04e9d3805648c5c85f7fb436cc64a168a4af47a3febe99e723b62
|
|
4
|
+
data.tar.gz: 03e50525f9f51187bfbd90251d7e3fa8143d812c42b9187686c1d0bc4568075c
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 62f5b2d690534fc7b047ab6ce948ba649b0cf1855d7d81576ab9c3831fb4c0fb87ad8e68cbc52ccf95a471d34314845289c1e6bbba96c2afecd9dc5f995e1575
|
|
7
|
+
data.tar.gz: 1d9cb2f0113d6c3511a7d38cd0c52739eea0bb516e6b26d8925c130ca2da12d6c224cedcdaa42d153f15320cd1643bb92cfb256a6f5d1c004eb62f2e91c58120
|
checksums.yaml.gz.sig
CHANGED
|
Binary file
|
data/CHANGELOG.md
CHANGED
|
@@ -30,6 +30,18 @@ Please file a bug if you notice a violation of semantic versioning.
|
|
|
30
30
|
|
|
31
31
|
### Security
|
|
32
32
|
|
|
33
|
+
## [0.2.0] - 2026-06-03
|
|
34
|
+
|
|
35
|
+
- TAG: [v0.2.0][0.2.0t]
|
|
36
|
+
- COVERAGE: 94.88% -- 519/547 lines in 12 files
|
|
37
|
+
- BRANCH COVERAGE: 83.25% -- 164/197 branches in 12 files
|
|
38
|
+
- 78.38% documented
|
|
39
|
+
|
|
40
|
+
### Changed
|
|
41
|
+
|
|
42
|
+
- upgrade yaml-converter to v0.2.0
|
|
43
|
+
- upgrade version_gem to v1.1.10
|
|
44
|
+
|
|
33
45
|
## [0.1.3] - 2026-05-27
|
|
34
46
|
|
|
35
47
|
- TAG: [v0.1.3][0.1.3t]
|
|
@@ -100,7 +112,9 @@ Please file a bug if you notice a violation of semantic versioning.
|
|
|
100
112
|
|
|
101
113
|
### Security
|
|
102
114
|
|
|
103
|
-
[Unreleased]: https://github.com/galtzo-floss/yard-yaml/compare/v0.
|
|
115
|
+
[Unreleased]: https://github.com/galtzo-floss/yard-yaml/compare/v0.2.0...HEAD
|
|
116
|
+
[0.2.0]: https://github.com/galtzo-floss/yard-yaml/compare/v0.1.3...v0.2.0
|
|
117
|
+
[0.2.0t]: https://github.com/galtzo-floss/yard-yaml/releases/tag/v0.2.0
|
|
104
118
|
[0.1.3]: https://github.com/galtzo-floss/yard-yaml/compare/v0.1.2...v0.1.3
|
|
105
119
|
[0.1.3t]: https://github.com/galtzo-floss/yard-yaml/releases/tag/v0.1.3
|
|
106
120
|
[0.1.2]: https://github.com/galtzo-floss/yard-yaml/compare/v0.1.1...v0.1.2
|
data/CONTRIBUTING.md
CHANGED
|
@@ -102,13 +102,29 @@ Git hooks and commit message helpers (exe/kettle-commit-msg)
|
|
|
102
102
|
- GIT_HOOK_FOOTER_SENTINEL: Required when footer append is enabled — a unique first-line sentinel to prevent duplicates
|
|
103
103
|
- GIT_HOOK_FOOTER_APPEND_DEBUG: Extra debug output in the footer template (true/false)
|
|
104
104
|
|
|
105
|
+
Git diff driver setup
|
|
106
|
+
- Local setup writes repository `.gitattributes` entries and local Git `diff.smorg-*` command config so this checkout uses StructuredMerge semantic diffs.
|
|
107
|
+
- Global setup registers `diff.smorg-*` commands once in the user Git config; use it when you work across several StructuredMerge-enabled repositories.
|
|
108
|
+
- Include-file setup writes `.git/smorg/config` and includes it from local Git config, keeping command registrations out of the repository files.
|
|
109
|
+
- Git hosting forges generally ignore external diff drivers, so pull request views may still show raw textual diffs even when local `git diff` uses semantic drivers.
|
|
110
|
+
|
|
111
|
+
```console
|
|
112
|
+
K_JEM_TEMPLATING=true bundle exec kettle-jem install
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
Troubleshooting Git diffs
|
|
116
|
+
- Use `git diff --no-ext-diff` to compare against Git's built-in diff output.
|
|
117
|
+
- Use `git diff --no-textconv` when a textconv projection obscures the raw file bytes you need to inspect.
|
|
118
|
+
- If Git reports a missing `smorg-*` executable, rerun `bundle install` and the setup command above, then check `git config --local --get-regexp '^diff\.smorg-'`.
|
|
119
|
+
- To remove managed local entries, run `K_JEM_TEMPLATING=true bundle exec kettle-jem install --undo`; remove global command registrations with `git config --global --unset-all diff.smorg-ruby.command`.
|
|
120
|
+
|
|
105
121
|
For a quick starting point, this repository’s `mise.toml` defines the shared defaults, and `.env.local` can override them locally. Copy `.env.local.example` to `.env.local`, use `KEY=value` lines, and either activate `mise` in your shell or run commands through `mise exec -C /path/to/project -- ...`.
|
|
106
122
|
|
|
107
123
|
## Appraisals
|
|
108
124
|
|
|
109
125
|
From time to time the [appraisal2][🚎appraisal2] gemfiles in `gemfiles/` will need to be updated.
|
|
110
126
|
Generated appraisal and CI workflow floors are controlled by `ruby.test_minimum`
|
|
111
|
-
in `.kettle-jem.yml`; this project was templated with `ruby.test_minimum: 3.2.0`.
|
|
127
|
+
in `.structuredmerge/kettle-jem.yml`; this project was templated with `ruby.test_minimum: 3.2.0`.
|
|
112
128
|
That value describes the lowest Ruby version expected to run the test/development
|
|
113
129
|
toolchain, and it may be higher than the gemspec runtime floor.
|
|
114
130
|
|
data/README.md
CHANGED
|
@@ -1,17 +1,10 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
[🖼️galtzo-floss-i]: https://logos.galtzo.com/assets/images/galtzo-floss/avatar-192px.svg
|
|
4
|
-
[🖼️galtzo-floss]: https://discord.gg/3qme4XHNKN
|
|
5
|
-
[🖼️ruby-lang-i]: https://logos.galtzo.com/assets/images/ruby-lang/avatar-192px.svg
|
|
6
|
-
[🖼️ruby-lang]: https://www.ruby-lang.org/
|
|
7
|
-
[🖼️galtzo-floss-yard-yaml-i]: https://logos.galtzo.com/assets/images/galtzo-floss/yard-yaml/avatar-192px.svg
|
|
8
|
-
[🖼️galtzo-floss-yard-yaml]: https://github.com/galtzo-floss/yard-yaml
|
|
1
|
+
<a href="https://github.com/galtzo-floss/yard-yaml"><img alt="yard-yaml Logo by Aboling0, CC BY-SA 4.0" src="https://logos.galtzo.com/assets/images/galtzo-floss/yard-yaml/avatar-128px.svg" width="14%" align="right"/></a>
|
|
9
2
|
|
|
10
3
|
# 🦗 Yard::Yaml
|
|
11
4
|
|
|
12
|
-
[![Version][👽versioni]][👽version] [![GitHub tag (latest SemVer)][⛳️tag-img]][⛳️tag] [![License: MIT][📄license-img]][📄license] [![Downloads Rank][👽dl-ranki]][👽dl-rank] [![CodeCov Test Coverage][🏀codecovi]][🏀codecov] [![Coveralls Test Coverage][🏀coveralls-img]][🏀coveralls] [![QLTY Test Coverage][🏀qlty-covi]][🏀qlty-cov] [![QLTY Maintainability][🏀qlty-mnti]][🏀qlty-mnt] [![CI Heads][🚎3-hd-wfi]][🚎3-hd-wf] [![CI Runtime Dependencies @ HEAD][🚎12-crh-wfi]][🚎12-crh-wf] [![CI Current][🚎11-c-wfi]][🚎11-c-wf] [![CI Truffle Ruby][🚎9-t-wfi]][🚎9-t-wf] [![CI JRuby][🚎10-j-wfi]][🚎10-j-wf] [![Deps Locked][🚎13-🔒️-wfi]][🚎13-🔒️-wf] [![Deps Unlocked][🚎14-🔓️-wfi]][🚎14-🔓️-wf] [![CI Test Coverage][🚎2-cov-wfi]][🚎2-cov-wf] [![CI Style][🚎5-st-wfi]][🚎5-st-wf] [![
|
|
5
|
+
[![Version][👽versioni]][👽version] [![GitHub tag (latest SemVer)][⛳️tag-img]][⛳️tag] [![License: MIT][📄license-img]][📄license] [![Downloads Rank][👽dl-ranki]][👽dl-rank] [![CodeCov Test Coverage][🏀codecovi]][🏀codecov] [![Coveralls Test Coverage][🏀coveralls-img]][🏀coveralls] [![QLTY Test Coverage][🏀qlty-covi]][🏀qlty-cov] [![QLTY Maintainability][🏀qlty-mnti]][🏀qlty-mnt] [![CI Heads][🚎3-hd-wfi]][🚎3-hd-wf] [![CI Runtime Dependencies @ HEAD][🚎12-crh-wfi]][🚎12-crh-wf] [![CI Current][🚎11-c-wfi]][🚎11-c-wf] [![CI Truffle Ruby][🚎9-t-wfi]][🚎9-t-wf] [![CI JRuby][🚎10-j-wfi]][🚎10-j-wf] [![Deps Locked][🚎13-🔒️-wfi]][🚎13-🔒️-wf] [![Deps Unlocked][🚎14-🔓️-wfi]][🚎14-🔓️-wf] [![CI Test Coverage][🚎2-cov-wfi]][🚎2-cov-wf] [![CI Style][🚎5-st-wfi]][🚎5-st-wf] [![Apache SkyWalking Eyes License Compatibility Check][🚎15-🪪-wfi]][🚎15-🪪-wf]
|
|
13
6
|
|
|
14
|
-
`if ci_badges.map(&:color).detect { it != "green"}` ☝️ [let me know][
|
|
7
|
+
`if ci_badges.map(&:color).detect { it != "green"}` ☝️ [let me know][✉️discord-invite], as I may have missed the [discord notification][✉️discord-invite].
|
|
15
8
|
|
|
16
9
|
---
|
|
17
10
|
|
|
@@ -26,7 +19,7 @@ I've summarized my thoughts in [this blog post](https://dev.to/galtzo/hostile-ta
|
|
|
26
19
|
|
|
27
20
|
</details>
|
|
28
21
|
|
|
29
|
-
## 🌻 Synopsis
|
|
22
|
+
## 🌻 Synopsis <a href="https://discord.gg/3qme4XHNKN"><img alt="Galtzo FLOSS Logo by Aboling0, CC BY-SA 4.0" src="https://logos.galtzo.com/assets/images/galtzo-floss/avatar-128px.svg" width="8%" align="right"/></a> <a href="https://ruby-toolbox.com"><img alt="ruby-lang Logo, Yukihiro Matsumoto, Ruby Visual Identity Team, CC BY-SA 2.5" src="https://logos.galtzo.com/assets/images/ruby-lang/avatar-128px.svg" width="8%" align="right"/></a>
|
|
30
23
|
|
|
31
24
|
To enable the `yard-yaml` plugin add it to your Gemfile,
|
|
32
25
|
and then add the plugin to your `.yardopts` file:
|
|
@@ -67,8 +60,6 @@ not practical for the current toolchain.
|
|
|
67
60
|
|------------------------------------------------|--------------------------------------------------------|
|
|
68
61
|
| 👟 Check it out! | ✨ [github.com/appraisal-rb/appraisal2][💎appraisal2] ✨ |
|
|
69
62
|
|
|
70
|
-
|
|
71
|
-
|
|
72
63
|
### Federated DVCS
|
|
73
64
|
|
|
74
65
|
<details markdown="1">
|
|
@@ -378,6 +369,8 @@ To say "thanks!" ☝️ Join the Discord or 👇️ send money.
|
|
|
378
369
|
|
|
379
370
|
### Please give the project a star ⭐ ♥.
|
|
380
371
|
|
|
372
|
+
Many parts of this project are actively managed by a [kettle-jem](https://github.com/structuredmerge/structuredmerge-ruby/tree/main/gems/kettle-jem) smart template utilizing [StructuredMerge.org](https://structuredmerge.org) merge contracts.
|
|
373
|
+
|
|
381
374
|
Thanks for RTFM. ☺️
|
|
382
375
|
|
|
383
376
|
[⛳liberapay-img]: https://img.shields.io/liberapay/goal/pboling.svg?logo=liberapay&color=a51611&style=flat
|
|
@@ -480,8 +473,6 @@ Thanks for RTFM. ☺️
|
|
|
480
473
|
[🏀codecovi]: https://codecov.io/gh/galtzo-floss/yard-yaml/graph/badge.svg
|
|
481
474
|
[🏀coveralls]: https://coveralls.io/github/galtzo-floss/yard-yaml?branch=main
|
|
482
475
|
[🏀coveralls-img]: https://coveralls.io/repos/github/galtzo-floss/yard-yaml/badge.svg?branch=main
|
|
483
|
-
[🖐codeQL]: https://github.com/galtzo-floss/yard-yaml/security/code-scanning
|
|
484
|
-
[🖐codeQL-img]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/codeql-analysis.yml/badge.svg
|
|
485
476
|
[🚎ruby-3.2-wf]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/ruby-3.2.yml
|
|
486
477
|
[🚎ruby-3.3-wf]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/ruby-3.3.yml
|
|
487
478
|
[🚎ruby-3.4-wf]: https://github.com/galtzo-floss/yard-yaml/actions/workflows/ruby-3.4.yml
|
|
@@ -572,7 +563,7 @@ Thanks for RTFM. ☺️
|
|
|
572
563
|
| Package | yard-yaml |
|
|
573
564
|
| Description | 🦗 A YARD plugin for YAML documents |
|
|
574
565
|
| Homepage | https://github.com/galtzo-floss/yard-yaml |
|
|
575
|
-
| Source | https://github.com/galtzo-floss/yard-yaml/tree/v0.
|
|
566
|
+
| Source | https://github.com/galtzo-floss/yard-yaml/tree/v0.2.0 |
|
|
576
567
|
| License | `MIT` |
|
|
577
568
|
| Funding | https://github.com/sponsors/pboling, https://issuehunt.io/u/pboling, https://ko-fi.com/pboling, https://liberapay.com/pboling/donate, https://opencollective.com/galtzo-floss, https://patreon.com/galtzo, https://polar.sh/pboling, https://thanks.dev/u/gh/pboling, https://tidelift.com/funding/github/rubygems/yard-yaml, https://www.buymeacoffee.com/pboling |
|
|
578
569
|
<!-- kettle-jem:metadata:end -->
|
data/SECURITY.md
CHANGED
data/lib/yard/yaml/cli.rb
CHANGED
|
@@ -149,16 +149,20 @@ module Yard
|
|
|
149
149
|
low = s.strip.downcase
|
|
150
150
|
return true if %w[true yes y on 1].include?(low)
|
|
151
151
|
return false if %w[false no n off 0].include?(low)
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
152
|
+
if s.match?(/\A[+-]?\d+\z/)
|
|
153
|
+
begin
|
|
154
|
+
return Integer(s)
|
|
155
|
+
rescue
|
|
156
|
+
nil
|
|
157
|
+
end
|
|
158
|
+
end
|
|
159
|
+
if s.match?(/\A[+-]?(?:\d+\.)?\d+\z/)
|
|
160
|
+
begin
|
|
161
|
+
return Float(s)
|
|
162
|
+
rescue
|
|
163
|
+
nil
|
|
164
|
+
end
|
|
165
|
+
end
|
|
162
166
|
s
|
|
163
167
|
end
|
|
164
168
|
|
data/lib/yard/yaml/config.rb
CHANGED
|
@@ -15,13 +15,13 @@ module Yard
|
|
|
15
15
|
"*.y{a,}ml",
|
|
16
16
|
# CFF (Citation File Format) files are valid YAML; include them by default.
|
|
17
17
|
"docs/**/*.cff",
|
|
18
|
-
"*.cff"
|
|
18
|
+
"*.cff"
|
|
19
19
|
].freeze
|
|
20
20
|
|
|
21
21
|
# Default glob patterns to exclude during discovery.
|
|
22
22
|
DEFAULT_EXCLUDE = [
|
|
23
23
|
"**/_*.y{a,}ml",
|
|
24
|
-
"**/_*.cff"
|
|
24
|
+
"**/_*.cff"
|
|
25
25
|
].freeze
|
|
26
26
|
|
|
27
27
|
# Directory (under YARD output) where converted pages will be written.
|
data/lib/yard/yaml/converter.rb
CHANGED
|
@@ -82,7 +82,7 @@ module Yard
|
|
|
82
82
|
handle_error(
|
|
83
83
|
Yard::Yaml::Error.new("invalid UTF-8 bytes in file; replaced invalid sequences"),
|
|
84
84
|
strict: false,
|
|
85
|
-
context: path.to_s
|
|
85
|
+
context: path.to_s
|
|
86
86
|
)
|
|
87
87
|
content.scrub
|
|
88
88
|
rescue Errno::ENOENT => e
|
|
@@ -95,7 +95,7 @@ module Yard
|
|
|
95
95
|
return true if sample.include?("\x00")
|
|
96
96
|
return false if sample.empty?
|
|
97
97
|
|
|
98
|
-
control_bytes = sample.
|
|
98
|
+
control_bytes = sample.each_byte.count do |byte|
|
|
99
99
|
(0..8).cover?(byte) || byte == 11 || byte == 12 || (14..31).cover?(byte)
|
|
100
100
|
end
|
|
101
101
|
control_bytes.fdiv(sample.bytesize) > 0.1
|
|
@@ -111,7 +111,7 @@ module Yard
|
|
|
111
111
|
|
|
112
112
|
begin
|
|
113
113
|
normalize_result(convert_with_backend(b, yaml, opts))
|
|
114
|
-
rescue
|
|
114
|
+
rescue => e
|
|
115
115
|
handle_error(e, strict: config.strict, context: opts[:source_path] || "string")
|
|
116
116
|
empty_result
|
|
117
117
|
end
|
|
@@ -134,7 +134,7 @@ module Yard
|
|
|
134
134
|
html: markdown_to_html(markdown),
|
|
135
135
|
title: metadata["title"],
|
|
136
136
|
description: metadata["abstract"],
|
|
137
|
-
meta: metadata
|
|
137
|
+
meta: metadata
|
|
138
138
|
}
|
|
139
139
|
end
|
|
140
140
|
|
|
@@ -157,7 +157,7 @@ module Yard
|
|
|
157
157
|
def build_options(options, config)
|
|
158
158
|
safe = {
|
|
159
159
|
allow_erb: !!config.allow_erb,
|
|
160
|
-
front_matter: !!config.front_matter
|
|
160
|
+
front_matter: !!config.front_matter
|
|
161
161
|
}
|
|
162
162
|
# Merge caller-supplied options and the config's converter_options map (caller wins)
|
|
163
163
|
safe.merge(config.converter_options || {}).merge(options || {})
|
|
@@ -169,7 +169,7 @@ module Yard
|
|
|
169
169
|
html: raw[:html] || raw["html"] || "",
|
|
170
170
|
title: raw[:title] || raw["title"],
|
|
171
171
|
description: raw[:description] || raw["description"],
|
|
172
|
-
meta: raw[:meta] || raw["meta"] || {}
|
|
172
|
+
meta: raw[:meta] || raw["meta"] || {}
|
|
173
173
|
}
|
|
174
174
|
end
|
|
175
175
|
|
data/lib/yard/yaml/discovery.rb
CHANGED
|
@@ -55,12 +55,12 @@ module Yard
|
|
|
55
55
|
html: converted[:html],
|
|
56
56
|
title: converted[:title],
|
|
57
57
|
description: converted[:description],
|
|
58
|
-
meta: converted[:meta] || {}
|
|
58
|
+
meta: converted[:meta] || {}
|
|
59
59
|
}
|
|
60
60
|
rescue Yard::Yaml::Error
|
|
61
61
|
# In strict mode Converter will raise; re-raise to fail the build
|
|
62
62
|
raise
|
|
63
|
-
rescue
|
|
63
|
+
rescue => e
|
|
64
64
|
# Non-strict converter errors are already warned; skip file
|
|
65
65
|
warn_fallback("skipping #{path}: #{e.class}: #{e.message}")
|
|
66
66
|
end
|
|
@@ -100,7 +100,7 @@ module Yard
|
|
|
100
100
|
else
|
|
101
101
|
Float::INFINITY
|
|
102
102
|
end
|
|
103
|
-
rescue
|
|
103
|
+
rescue
|
|
104
104
|
Float::INFINITY
|
|
105
105
|
end
|
|
106
106
|
|
data/lib/yard/yaml/emitter.rb
CHANGED
|
@@ -158,9 +158,9 @@ module Yard
|
|
|
158
158
|
dir = File.dirname(path)
|
|
159
159
|
FileUtils.mkdir_p(dir)
|
|
160
160
|
tmp = File.join(dir, ".#{$$}.#{Time.now.to_i}.tmp")
|
|
161
|
-
File.
|
|
161
|
+
File.binwrite(tmp, content.to_s)
|
|
162
162
|
FileUtils.mv(tmp, path)
|
|
163
|
-
rescue
|
|
163
|
+
rescue => e
|
|
164
164
|
message = "write failed for #{path}: #{e.message}"
|
|
165
165
|
if strict
|
|
166
166
|
raise Yard::Yaml::Error, message
|
|
@@ -172,7 +172,7 @@ module Yard
|
|
|
172
172
|
ensure
|
|
173
173
|
begin
|
|
174
174
|
FileUtils.rm_f(tmp) if tmp && File.exist?(tmp)
|
|
175
|
-
rescue
|
|
175
|
+
rescue
|
|
176
176
|
# ignore
|
|
177
177
|
end
|
|
178
178
|
end
|
data/lib/yard/yaml/plugin.rb
CHANGED
|
@@ -30,7 +30,7 @@ module Yard
|
|
|
30
30
|
begin
|
|
31
31
|
overrides = Cli.parse(argv || [])
|
|
32
32
|
Yard::Yaml.configure(overrides) unless overrides.empty?
|
|
33
|
-
rescue
|
|
33
|
+
rescue
|
|
34
34
|
# Parsing failures should not prevent activation in Phase 3
|
|
35
35
|
end
|
|
36
36
|
|
|
@@ -41,7 +41,7 @@ module Yard
|
|
|
41
41
|
rescue Yard::Yaml::Error
|
|
42
42
|
# strict mode surfaced an error; re-raise to fail activation/build
|
|
43
43
|
raise
|
|
44
|
-
rescue
|
|
44
|
+
rescue
|
|
45
45
|
# Non-strict errors are already warned by converter/discovery
|
|
46
46
|
end
|
|
47
47
|
|
|
@@ -118,7 +118,7 @@ module Yard
|
|
|
118
118
|
|
|
119
119
|
require "shellwords"
|
|
120
120
|
Shellwords.split(File.read(".yardopts"))
|
|
121
|
-
rescue
|
|
121
|
+
rescue
|
|
122
122
|
[]
|
|
123
123
|
end
|
|
124
124
|
end
|
data/lib/yard/yaml/tags.rb
CHANGED
|
@@ -19,7 +19,7 @@ module Yard
|
|
|
19
19
|
if defined?(::Library) && ::Library.is_a?(Module)
|
|
20
20
|
begin
|
|
21
21
|
::YARD::Tags.const_set(:Library, ::Library)
|
|
22
|
-
rescue
|
|
22
|
+
rescue
|
|
23
23
|
return
|
|
24
24
|
end
|
|
25
25
|
else
|
|
@@ -30,7 +30,7 @@ module Yard
|
|
|
30
30
|
lib.define_singleton_method(:define_tag) { |*args| calls << args }
|
|
31
31
|
begin
|
|
32
32
|
::YARD::Tags.const_set(:Library, lib)
|
|
33
|
-
rescue
|
|
33
|
+
rescue
|
|
34
34
|
# if we failed to set, just return silently
|
|
35
35
|
return
|
|
36
36
|
end
|
|
@@ -39,12 +39,12 @@ module Yard
|
|
|
39
39
|
|
|
40
40
|
begin
|
|
41
41
|
::YARD::Tags::Library.define_tag("YAML", :yaml, :with_title_and_text)
|
|
42
|
-
rescue
|
|
42
|
+
rescue
|
|
43
43
|
# ignore if already defined or unavailable
|
|
44
44
|
end
|
|
45
45
|
begin
|
|
46
46
|
::YARD::Tags::Library.define_tag("YAML File", :yaml_file, :with_text)
|
|
47
|
-
rescue
|
|
47
|
+
rescue
|
|
48
48
|
# ignore if already defined or unavailable
|
|
49
49
|
end
|
|
50
50
|
end
|
|
@@ -57,6 +57,6 @@ begin
|
|
|
57
57
|
if defined?(YARD) && YARD.const_defined?(:Tags) && YARD::Tags.const_defined?(:Library)
|
|
58
58
|
Yard::Yaml::Tags.register!
|
|
59
59
|
end
|
|
60
|
-
rescue
|
|
60
|
+
rescue
|
|
61
61
|
# ignore in non-YARD or partially loaded contexts
|
|
62
62
|
end
|
|
@@ -34,7 +34,7 @@ module Yard
|
|
|
34
34
|
rescue Yard::Yaml::Error
|
|
35
35
|
# strict mode errors bubble from converter; re-raise
|
|
36
36
|
raise
|
|
37
|
-
rescue
|
|
37
|
+
rescue => e
|
|
38
38
|
# Non-strict paths should already be handled by converter; this is a last-resort guard.
|
|
39
39
|
if defined?(::Yard) && ::Yard.const_defined?(:Yaml)
|
|
40
40
|
::Yard::Yaml.warn("#{e.class}: #{e.message} while rendering #{path}")
|
data/lib/yard/yaml/templates.rb
CHANGED
|
@@ -21,7 +21,7 @@ module Yard
|
|
|
21
21
|
base = File.expand_path("../../../templates", __dir__)
|
|
22
22
|
begin
|
|
23
23
|
::YARD::Templates::Engine.register_template_path(base)
|
|
24
|
-
rescue
|
|
24
|
+
rescue
|
|
25
25
|
# ignore if engine not available or already registered
|
|
26
26
|
end
|
|
27
27
|
end
|
|
@@ -32,6 +32,6 @@ end
|
|
|
32
32
|
# Try to register immediately if YARD is present; otherwise remain inert.
|
|
33
33
|
begin
|
|
34
34
|
Yard::Yaml::Templates.register!
|
|
35
|
-
rescue
|
|
35
|
+
rescue
|
|
36
36
|
# ignore in non-YARD contexts
|
|
37
37
|
end
|
data/lib/yard/yaml/version.rb
CHANGED
data/lib/yard/yaml.rb
CHANGED
|
@@ -24,7 +24,7 @@ module Yard
|
|
|
24
24
|
|
|
25
25
|
STATE = {
|
|
26
26
|
config: nil,
|
|
27
|
-
pages: nil
|
|
27
|
+
pages: nil
|
|
28
28
|
}
|
|
29
29
|
STATE_MUTEX = Mutex.new
|
|
30
30
|
|
|
@@ -81,7 +81,7 @@ module Yard
|
|
|
81
81
|
begin
|
|
82
82
|
::YARD::Logger.instance.error("yard-yaml: #{message}")
|
|
83
83
|
return
|
|
84
|
-
rescue
|
|
84
|
+
rescue
|
|
85
85
|
# fall back
|
|
86
86
|
end
|
|
87
87
|
end
|
|
@@ -110,7 +110,7 @@ module Yard
|
|
|
110
110
|
begin
|
|
111
111
|
::YARD::Logger.instance.warn("yard-yaml: #{message}")
|
|
112
112
|
return
|
|
113
|
-
rescue
|
|
113
|
+
rescue
|
|
114
114
|
# fall back
|
|
115
115
|
end
|
|
116
116
|
end
|
|
@@ -122,7 +122,7 @@ module Yard
|
|
|
122
122
|
# Registry.store is a Hash-like; avoid raising if unavailable
|
|
123
123
|
begin
|
|
124
124
|
::YARD::Registry.store[:yard_yaml_config] = cfg
|
|
125
|
-
rescue
|
|
125
|
+
rescue
|
|
126
126
|
# ignore if registry store not ready
|
|
127
127
|
end
|
|
128
128
|
end
|
|
@@ -131,7 +131,7 @@ module Yard
|
|
|
131
131
|
return unless defined?(::YARD) && ::YARD.const_defined?(:Registry)
|
|
132
132
|
begin
|
|
133
133
|
::YARD::Registry.store[:yard_yaml_pages] = pages
|
|
134
|
-
rescue
|
|
134
|
+
rescue
|
|
135
135
|
# ignore if registry store not ready
|
|
136
136
|
end
|
|
137
137
|
end
|
data.tar.gz.sig
CHANGED
|
Binary file
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: yard-yaml
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.2.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Annibelle Boling
|
|
@@ -47,7 +47,7 @@ dependencies:
|
|
|
47
47
|
version: '1.1'
|
|
48
48
|
- - ">="
|
|
49
49
|
- !ruby/object:Gem::Version
|
|
50
|
-
version: 1.1.
|
|
50
|
+
version: 1.1.10
|
|
51
51
|
type: :runtime
|
|
52
52
|
prerelease: false
|
|
53
53
|
version_requirements: !ruby/object:Gem::Requirement
|
|
@@ -57,21 +57,21 @@ dependencies:
|
|
|
57
57
|
version: '1.1'
|
|
58
58
|
- - ">="
|
|
59
59
|
- !ruby/object:Gem::Version
|
|
60
|
-
version: 1.1.
|
|
60
|
+
version: 1.1.10
|
|
61
61
|
- !ruby/object:Gem::Dependency
|
|
62
62
|
name: yaml-converter
|
|
63
63
|
requirement: !ruby/object:Gem::Requirement
|
|
64
64
|
requirements:
|
|
65
65
|
- - "~>"
|
|
66
66
|
- !ruby/object:Gem::Version
|
|
67
|
-
version: '0.
|
|
67
|
+
version: '0.2'
|
|
68
68
|
type: :runtime
|
|
69
69
|
prerelease: false
|
|
70
70
|
version_requirements: !ruby/object:Gem::Requirement
|
|
71
71
|
requirements:
|
|
72
72
|
- - "~>"
|
|
73
73
|
- !ruby/object:Gem::Version
|
|
74
|
-
version: '0.
|
|
74
|
+
version: '0.2'
|
|
75
75
|
- !ruby/object:Gem::Dependency
|
|
76
76
|
name: kettle-dev
|
|
77
77
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -81,7 +81,7 @@ dependencies:
|
|
|
81
81
|
version: '2.0'
|
|
82
82
|
- - ">="
|
|
83
83
|
- !ruby/object:Gem::Version
|
|
84
|
-
version: 2.0.
|
|
84
|
+
version: 2.0.8
|
|
85
85
|
type: :development
|
|
86
86
|
prerelease: false
|
|
87
87
|
version_requirements: !ruby/object:Gem::Requirement
|
|
@@ -91,7 +91,7 @@ dependencies:
|
|
|
91
91
|
version: '2.0'
|
|
92
92
|
- - ">="
|
|
93
93
|
- !ruby/object:Gem::Version
|
|
94
|
-
version: 2.0.
|
|
94
|
+
version: 2.0.8
|
|
95
95
|
- !ruby/object:Gem::Dependency
|
|
96
96
|
name: bundler-audit
|
|
97
97
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -169,7 +169,7 @@ dependencies:
|
|
|
169
169
|
version: '2.0'
|
|
170
170
|
- - ">="
|
|
171
171
|
- !ruby/object:Gem::Version
|
|
172
|
-
version: 2.0.
|
|
172
|
+
version: 2.0.3
|
|
173
173
|
type: :development
|
|
174
174
|
prerelease: false
|
|
175
175
|
version_requirements: !ruby/object:Gem::Requirement
|
|
@@ -179,7 +179,27 @@ dependencies:
|
|
|
179
179
|
version: '2.0'
|
|
180
180
|
- - ">="
|
|
181
181
|
- !ruby/object:Gem::Version
|
|
182
|
-
version: 2.0.
|
|
182
|
+
version: 2.0.3
|
|
183
|
+
- !ruby/object:Gem::Dependency
|
|
184
|
+
name: turbo_tests2
|
|
185
|
+
requirement: !ruby/object:Gem::Requirement
|
|
186
|
+
requirements:
|
|
187
|
+
- - "~>"
|
|
188
|
+
- !ruby/object:Gem::Version
|
|
189
|
+
version: '3.1'
|
|
190
|
+
- - ">="
|
|
191
|
+
- !ruby/object:Gem::Version
|
|
192
|
+
version: 3.1.1
|
|
193
|
+
type: :development
|
|
194
|
+
prerelease: false
|
|
195
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
196
|
+
requirements:
|
|
197
|
+
- - "~>"
|
|
198
|
+
- !ruby/object:Gem::Version
|
|
199
|
+
version: '3.1'
|
|
200
|
+
- - ">="
|
|
201
|
+
- !ruby/object:Gem::Version
|
|
202
|
+
version: 3.1.1
|
|
183
203
|
- !ruby/object:Gem::Dependency
|
|
184
204
|
name: ruby-progressbar
|
|
185
205
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -223,7 +243,7 @@ dependencies:
|
|
|
223
243
|
version: '2.0'
|
|
224
244
|
- - ">="
|
|
225
245
|
- !ruby/object:Gem::Version
|
|
226
|
-
version: 2.0.
|
|
246
|
+
version: 2.0.1
|
|
227
247
|
type: :development
|
|
228
248
|
prerelease: false
|
|
229
249
|
version_requirements: !ruby/object:Gem::Requirement
|
|
@@ -233,7 +253,7 @@ dependencies:
|
|
|
233
253
|
version: '2.0'
|
|
234
254
|
- - ">="
|
|
235
255
|
- !ruby/object:Gem::Version
|
|
236
|
-
version: 2.0.
|
|
256
|
+
version: 2.0.1
|
|
237
257
|
description: "\U0001F997 A YARD plugin for YAML documents"
|
|
238
258
|
email:
|
|
239
259
|
- floss@galtzo.com
|
|
@@ -280,10 +300,10 @@ licenses:
|
|
|
280
300
|
- MIT
|
|
281
301
|
metadata:
|
|
282
302
|
homepage_uri: https://structuredmerge.org
|
|
283
|
-
source_code_uri: https://github.com/galtzo-floss/yard-yaml/tree/v0.
|
|
284
|
-
changelog_uri: https://github.com/galtzo-floss/yard-yaml/blob/v0.
|
|
303
|
+
source_code_uri: https://github.com/galtzo-floss/yard-yaml/tree/v0.2.0
|
|
304
|
+
changelog_uri: https://github.com/galtzo-floss/yard-yaml/blob/v0.2.0/CHANGELOG.md
|
|
285
305
|
bug_tracker_uri: https://github.com/galtzo-floss/yard-yaml/issues
|
|
286
|
-
documentation_uri: https://www.rubydoc.info/gems/yard-yaml/0.
|
|
306
|
+
documentation_uri: https://www.rubydoc.info/gems/yard-yaml/0.2.0
|
|
287
307
|
funding_uri: https://github.com/sponsors/pboling
|
|
288
308
|
wiki_uri: https://github.com/galtzo-floss/yard-yaml/wiki
|
|
289
309
|
news_uri: https://www.railsbling.com/tags/yard-yaml
|
metadata.gz.sig
CHANGED
|
Binary file
|