yard_ghurt 1.2.1 → 1.2.2
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
- data/.yardopts +5 -0
- data/Gemfile +11 -1
- data/README.md +150 -145
- data/Rakefile +14 -24
- data/bin/yard_ghurt +1 -3
- data/lib/yard_ghurt/anchor_links.rb +13 -51
- data/lib/yard_ghurt/gfm_fix_task.rb +31 -61
- data/lib/yard_ghurt/ghp_sync_task.rb +12 -35
- data/lib/yard_ghurt/util.rb +13 -21
- data/lib/yard_ghurt/version.rb +2 -3
- data/lib/yard_ghurt.rb +8 -16
- data/yard_ghurt.gemspec +39 -32
- metadata +13 -56
- data/CHANGELOG.md +0 -73
- data/yard/templates/default/layout/html/footer.erb +0 -5
data/yard_ghurt.gemspec
CHANGED
@@ -3,51 +3,58 @@
|
|
3
3
|
|
4
4
|
#--
|
5
5
|
# This file is part of YardGhurt.
|
6
|
-
# Copyright (c) 2019
|
6
|
+
# Copyright (c) 2019 Bradley Whited
|
7
7
|
#
|
8
8
|
# SPDX-License-Identifier: LGPL-3.0-or-later
|
9
9
|
#++
|
10
10
|
|
11
|
-
|
12
|
-
lib = File.expand_path(File.join('..','lib'),__FILE__)
|
13
|
-
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
14
|
-
|
15
|
-
require 'yard_ghurt/version'
|
11
|
+
require_relative 'lib/yard_ghurt/version'
|
16
12
|
|
17
13
|
Gem::Specification.new do |spec|
|
18
14
|
spec.name = 'yard_ghurt'
|
19
15
|
spec.version = YardGhurt::VERSION
|
20
|
-
spec.authors = ['
|
16
|
+
spec.authors = ['Bradley Whited']
|
21
17
|
spec.email = ['code@esotericpig.com']
|
22
18
|
spec.licenses = ['LGPL-3.0-or-later']
|
23
19
|
spec.homepage = 'https://github.com/esotericpig/yard_ghurt'
|
24
|
-
spec.summary = 'YARDoc GitHub Rake Tasks'
|
25
|
-
spec.description = "#{spec.summary}
|
20
|
+
spec.summary = 'YARDoc GitHub Rake Tasks.'
|
21
|
+
spec.description = "#{spec.summary} Fix GitHub Flavored Markdown (GFM) files."
|
26
22
|
|
27
23
|
spec.metadata = {
|
28
|
-
'
|
29
|
-
'
|
30
|
-
'
|
31
|
-
'
|
32
|
-
'
|
24
|
+
'rubygems_mfa_required' => 'true',
|
25
|
+
'homepage_uri' => spec.homepage,
|
26
|
+
'source_code_uri' => 'https://github.com/esotericpig/yard_ghurt',
|
27
|
+
'documentation_uri' => 'https://esotericpig.github.io/docs/yard_ghurt/yardoc/index.html',
|
28
|
+
'bug_tracker_uri' => 'https://github.com/esotericpig/yard_ghurt/issues',
|
33
29
|
}
|
34
30
|
|
35
|
-
spec.
|
36
|
-
spec.
|
37
|
-
spec.
|
38
|
-
|
39
|
-
|
40
|
-
|
41
|
-
|
42
|
-
|
43
|
-
|
44
|
-
|
45
|
-
|
46
|
-
|
47
|
-
|
48
|
-
|
49
|
-
|
50
|
-
|
51
|
-
|
52
|
-
|
31
|
+
spec.required_ruby_version = '>= 2.3'
|
32
|
+
spec.require_paths = ['lib']
|
33
|
+
spec.bindir = 'bin'
|
34
|
+
spec.executables = [spec.name]
|
35
|
+
|
36
|
+
spec.files = [
|
37
|
+
Dir.glob("{#{spec.require_paths.join(',')}}/**/*.{erb,rb}"),
|
38
|
+
Dir.glob("#{spec.bindir}/*"),
|
39
|
+
Dir.glob('{spec,test,yard}/**/*.{erb,rb}'),
|
40
|
+
%W[Gemfile #{spec.name}.gemspec Rakefile .yardopts],
|
41
|
+
%w[LICENSE.txt README.md],
|
42
|
+
].flatten
|
43
|
+
|
44
|
+
# TEST: Test using different Gem versions:
|
45
|
+
# GST=1 bundle update && bundle exec rake doc
|
46
|
+
gemspec_test = ENV.fetch('GST','').to_s.strip
|
47
|
+
yard_gemv = false
|
48
|
+
|
49
|
+
if !gemspec_test.empty?
|
50
|
+
case gemspec_test
|
51
|
+
when '1' then yard_gemv = '0.9.24'
|
52
|
+
end
|
53
|
+
|
54
|
+
puts 'Using Gem versions:'
|
55
|
+
puts " yard: #{yard_gemv.inspect}"
|
56
|
+
end
|
57
|
+
|
58
|
+
spec.add_dependency 'rake' # 13.0.3.
|
59
|
+
spec.add_dependency 'yard',yard_gemv || '>= 0' # 0.9.26, 0.9.24 (diff).
|
53
60
|
end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: yard_ghurt
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.2.
|
4
|
+
version: 1.2.2
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
|
-
-
|
8
|
-
autorequire:
|
7
|
+
- Bradley Whited
|
8
|
+
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2025-06-07 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: rake
|
@@ -38,48 +38,6 @@ dependencies:
|
|
38
38
|
- - ">="
|
39
39
|
- !ruby/object:Gem::Version
|
40
40
|
version: '0'
|
41
|
-
- !ruby/object:Gem::Dependency
|
42
|
-
name: bundler
|
43
|
-
requirement: !ruby/object:Gem::Requirement
|
44
|
-
requirements:
|
45
|
-
- - "~>"
|
46
|
-
- !ruby/object:Gem::Version
|
47
|
-
version: '2.2'
|
48
|
-
type: :development
|
49
|
-
prerelease: false
|
50
|
-
version_requirements: !ruby/object:Gem::Requirement
|
51
|
-
requirements:
|
52
|
-
- - "~>"
|
53
|
-
- !ruby/object:Gem::Version
|
54
|
-
version: '2.2'
|
55
|
-
- !ruby/object:Gem::Dependency
|
56
|
-
name: rdoc
|
57
|
-
requirement: !ruby/object:Gem::Requirement
|
58
|
-
requirements:
|
59
|
-
- - "~>"
|
60
|
-
- !ruby/object:Gem::Version
|
61
|
-
version: '6.3'
|
62
|
-
type: :development
|
63
|
-
prerelease: false
|
64
|
-
version_requirements: !ruby/object:Gem::Requirement
|
65
|
-
requirements:
|
66
|
-
- - "~>"
|
67
|
-
- !ruby/object:Gem::Version
|
68
|
-
version: '6.3'
|
69
|
-
- !ruby/object:Gem::Dependency
|
70
|
-
name: redcarpet
|
71
|
-
requirement: !ruby/object:Gem::Requirement
|
72
|
-
requirements:
|
73
|
-
- - "~>"
|
74
|
-
- !ruby/object:Gem::Version
|
75
|
-
version: '3.5'
|
76
|
-
type: :development
|
77
|
-
prerelease: false
|
78
|
-
version_requirements: !ruby/object:Gem::Requirement
|
79
|
-
requirements:
|
80
|
-
- - "~>"
|
81
|
-
- !ruby/object:Gem::Version
|
82
|
-
version: '3.5'
|
83
41
|
description: YARDoc GitHub Rake Tasks. Fix GitHub Flavored Markdown (GFM) files.
|
84
42
|
email:
|
85
43
|
- code@esotericpig.com
|
@@ -88,7 +46,7 @@ executables:
|
|
88
46
|
extensions: []
|
89
47
|
extra_rdoc_files: []
|
90
48
|
files:
|
91
|
-
-
|
49
|
+
- ".yardopts"
|
92
50
|
- Gemfile
|
93
51
|
- LICENSE.txt
|
94
52
|
- README.md
|
@@ -100,18 +58,17 @@ files:
|
|
100
58
|
- lib/yard_ghurt/ghp_sync_task.rb
|
101
59
|
- lib/yard_ghurt/util.rb
|
102
60
|
- lib/yard_ghurt/version.rb
|
103
|
-
- yard/templates/default/layout/html/footer.erb
|
104
61
|
- yard_ghurt.gemspec
|
105
62
|
homepage: https://github.com/esotericpig/yard_ghurt
|
106
63
|
licenses:
|
107
64
|
- LGPL-3.0-or-later
|
108
65
|
metadata:
|
109
|
-
|
110
|
-
changelog_uri: https://github.com/esotericpig/yard_ghurt/blob/master/CHANGELOG.md
|
111
|
-
documentation_uri: https://esotericpig.github.io/docs/yard_ghurt/yardoc/index.html
|
66
|
+
rubygems_mfa_required: 'true'
|
112
67
|
homepage_uri: https://github.com/esotericpig/yard_ghurt
|
113
68
|
source_code_uri: https://github.com/esotericpig/yard_ghurt
|
114
|
-
|
69
|
+
documentation_uri: https://esotericpig.github.io/docs/yard_ghurt/yardoc/index.html
|
70
|
+
bug_tracker_uri: https://github.com/esotericpig/yard_ghurt/issues
|
71
|
+
post_install_message:
|
115
72
|
rdoc_options: []
|
116
73
|
require_paths:
|
117
74
|
- lib
|
@@ -119,15 +76,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
119
76
|
requirements:
|
120
77
|
- - ">="
|
121
78
|
- !ruby/object:Gem::Version
|
122
|
-
version: 2.
|
79
|
+
version: '2.3'
|
123
80
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
124
81
|
requirements:
|
125
82
|
- - ">="
|
126
83
|
- !ruby/object:Gem::Version
|
127
84
|
version: '0'
|
128
85
|
requirements: []
|
129
|
-
rubygems_version: 3.
|
130
|
-
signing_key:
|
86
|
+
rubygems_version: 3.5.21
|
87
|
+
signing_key:
|
131
88
|
specification_version: 4
|
132
|
-
summary: YARDoc GitHub Rake Tasks
|
89
|
+
summary: YARDoc GitHub Rake Tasks.
|
133
90
|
test_files: []
|
data/CHANGELOG.md
DELETED
@@ -1,73 +0,0 @@
|
|
1
|
-
# Changelog | YardGhurt
|
2
|
-
|
3
|
-
All notable changes to this project will be documented in this file.
|
4
|
-
|
5
|
-
Format is based on [Keep a Changelog v1.0.0](https://keepachangelog.com/en/1.0.0/),
|
6
|
-
and this project adheres to [Semantic Versioning v2.0.0](https://semver.org/spec/v2.0.0.html).
|
7
|
-
|
8
|
-
## [[Unreleased]](https://github.com/esotericpig/yard_ghurt/compare/v1.2.1...HEAD)
|
9
|
-
-
|
10
|
-
|
11
|
-
|
12
|
-
## [v1.2.1] - 2021-06-16
|
13
|
-
### Fixed
|
14
|
-
- Fixed to work with YARD v0.9.25+
|
15
|
-
- From v0.9.25, YARD changed to use RedCarpert's method of trying to create GitHub-style anchor links. RedCarpet does NOT match GitHub's algorithm exactly, so it all got messed up. I changed the code to grab the new `id="..."` field from `<h\d+...` tags and use that as the YARD ID. I tried recreating RedCarpert's C code (`rndr_header_anchor()` in `ext/redcarpet/html.c`) but this failed miserably, so resorted to just this. All that matters is that it works!
|
16
|
-
|
17
|
-
### Changed
|
18
|
-
- Formatted code using RuboCop.
|
19
|
-
|
20
|
-
|
21
|
-
## [v1.2.0] - 2020-02-29
|
22
|
-
### Added
|
23
|
-
- bin/yard_ghurt
|
24
|
-
- For getting the GitHub/YARDoc anchor link ID from a string
|
25
|
-
- App class
|
26
|
-
- AnchorLinks.escape()
|
27
|
-
|
28
|
-
### Changed
|
29
|
-
- README to talk about bin/yard_ghurt
|
30
|
-
|
31
|
-
### Fixed
|
32
|
-
- In AnchorLinks, don't use obsolete method URI.escape()/encode()
|
33
|
-
- This outputted a lot of warnings
|
34
|
-
|
35
|
-
|
36
|
-
## [v1.1.0] - 2019-07-31
|
37
|
-
### Added
|
38
|
-
- Added environment var *dryrun* to GFMFixTask:
|
39
|
-
- rake yard_gfm_fix dryrun=true
|
40
|
-
|
41
|
-
### Changed
|
42
|
-
- Renamed GFMFixerTask to GFMFixTask
|
43
|
-
- lib/yard_ghurt/gfm_fixer_task.rb => lib/yard_ghurt/gfm_fix_task.rb
|
44
|
-
- Renamed GHPSyncerTask to GHPSyncTask
|
45
|
-
- lib/yard_ghurt/ghp_syncer_task.rb => lib/yard_ghurt/ghp_sync_task.rb
|
46
|
-
- Updated development dependency gems
|
47
|
-
|
48
|
-
|
49
|
-
## [v1.0.1] - 2019-07-28
|
50
|
-
### Changed
|
51
|
-
- Some minor comments/doc
|
52
|
-
- Refactored the Gemspec (minor)
|
53
|
-
|
54
|
-
### Fixed
|
55
|
-
- In GFMFixerTask, ignore empty lines
|
56
|
-
|
57
|
-
|
58
|
-
## [v1.0.0] - 2019-07-23
|
59
|
-
### Added
|
60
|
-
- .gitignore
|
61
|
-
- CHANGELOG.md
|
62
|
-
- Gemfile
|
63
|
-
- LICENSE.txt
|
64
|
-
- README.md
|
65
|
-
- Rakefile
|
66
|
-
- yard_ghurt.gemspec
|
67
|
-
- lib/yard_ghurt.rb
|
68
|
-
- lib/yard_ghurt/anchor_links.rb
|
69
|
-
- lib/yard_ghurt/gfm_fixer_task.rb
|
70
|
-
- lib/yard_ghurt/ghp_syncer_task.rb
|
71
|
-
- lib/yard_ghurt/util.rb
|
72
|
-
- lib/yard_ghurt/version.rb
|
73
|
-
- yard/templates/default/layout/html/footer.erb
|