yard-junk 0.0.6 → 0.0.7

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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA256:
3
- metadata.gz: f972096c735aa10f1d097ba129b9df1cb395125fc0fb1ecbfa9fad45398cf370
4
- data.tar.gz: d2ced5a123314ad4871b18513b7e9f50a7cfb5c4030de060465eb3294671c792
2
+ SHA1:
3
+ metadata.gz: 1cc08ba16be8c10d61c8aef74b678626aefee885
4
+ data.tar.gz: 98b37e4329450c227f5152a23aa6e68d8dafab6e
5
5
  SHA512:
6
- metadata.gz: 50f61b3c8e59f14d500c45790c51f819ac9c58d22d947256b7f85ff30b710eacd574160df7016947e0d30a62b51b7ab59cfd9e62045aa98d222417eb3bbe7ba1
7
- data.tar.gz: 767f7cc67a380e6e530b08b9a0620800079d29f8b973061efb2110d63b830a093add85cd7de9688c749eec2f56532b462c38004c4c76f7b65ec45f94b6c6dd00
6
+ metadata.gz: 37d1bf6cebf4d86a56db9f36f1d5f9b455db62b1d8d54247487ac1978679a39d46a51ef5ea35108a0d26a0b4509c7d179869b94a1768597e47b81d9b3245c78d
7
+ data.tar.gz: 4a337f018ed00c53b68f6a60ab86e1ecc9167e0a4649cc6acd361407a16dd9c813b3443f7fef19062267d1ca005e844f7017a6246482fef248a36bf650b023c8
@@ -1,9 +1,13 @@
1
1
  # Yard-Junk changelog
2
2
 
3
+ ## 0.0.7 -- 2017-09-21
4
+
5
+ * Fix problems with links resolution for RDoc.
6
+
3
7
  ## 0.0.6 -- 2017-09-20
4
8
 
5
9
  * More robust (and more logical) colorization on text output (#25);
6
- * Fast "sanity check" for using in pre-commit hook on large codebases.
10
+ * Fast "sanity check" for using in pre-commit hook on large codebases (#24).
7
11
 
8
12
  ## 0.0.5 -- 2017-09-11
9
13
 
@@ -4,6 +4,7 @@ module YardJunk
4
4
  class Janitor
5
5
  class Resolver
6
6
  include YARD::Templates::Helpers::HtmlHelper
7
+ include YARD::Templates::Helpers::MarkupHelper
7
8
 
8
9
  # This one is copied from real YARD output
9
10
  OBJECT_MESSAGE_PATTERN = 'In file `%{file}\':%{line}: Cannot resolve link to %{name} from text: %{link}'.freeze
@@ -17,6 +18,7 @@ module YardJunk
17
18
  end
18
19
 
19
20
  def initialize(object, yard_options)
21
+ @options = yard_options
20
22
  case object
21
23
  when YARD::CodeObjects::ExtraFileObject
22
24
  init_file(object)
@@ -25,11 +27,10 @@ module YardJunk
25
27
  else
26
28
  fail "Unknown object to resolve #{object.class}"
27
29
  end
28
- @options = yard_options
29
30
  end
30
31
 
31
32
  def resolve
32
- markup_meth = "html_markup_#{options.markup}"
33
+ markup_meth = "html_markup_#{markup}"
33
34
  return unless respond_to?(markup_meth)
34
35
  send(markup_meth, @string)
35
36
  .gsub(%r{<(code|tt|pre)[^>]*>(.*?)</\1>}im, '')
@@ -44,6 +45,7 @@ module YardJunk
44
45
  @string = file.contents
45
46
  @file = file.filename
46
47
  @line = 1
48
+ @markup = markup_for_file(file.contents, file.filename)
47
49
  end
48
50
 
49
51
  def init_docstring(docstring)
@@ -51,9 +53,10 @@ module YardJunk
51
53
  @root_object = docstring.object
52
54
  @file = @root_object.file
53
55
  @line = @root_object.line
56
+ @markup = options.markup
54
57
  end
55
58
 
56
- attr_reader :options, :file, :line
59
+ attr_reader :options, :file, :line, :markup
57
60
 
58
61
  def try_resolve(link)
59
62
  name, _comment = link.tr('{}', '').split(/\s+/, 2)
@@ -71,10 +74,6 @@ module YardJunk
71
74
  end
72
75
  end
73
76
 
74
- def object
75
- @docstring.object
76
- end
77
-
78
77
  def resolve_file(name, link)
79
78
  return if options.files.any? { |f| f.name == name || f.filename == name }
80
79
  Logger.instance.register(FILE_MESSAGE_PATTERN % {file: file, line: line, name: name, link: link})
@@ -86,7 +85,12 @@ module YardJunk
86
85
  Logger.instance.register(OBJECT_MESSAGE_PATTERN % {file: file, line: line, name: name, link: link})
87
86
  end
88
87
 
89
- # required by HtmlHelper
88
+ # Used by HtmlHelper for RDoc
89
+ def object
90
+ @string.object if @string.is_a?(YARD::Docstring)
91
+ end
92
+
93
+ # Used by HtmlHelper
90
94
  def serializer
91
95
  nil
92
96
  end
@@ -6,7 +6,7 @@ module YardJunk
6
6
  # @private
7
7
  MINOR = 0
8
8
  # @private
9
- PATCH = 6
9
+ PATCH = 7
10
10
 
11
11
  # @private
12
12
  VERSION = [MINOR, MAJOR, PATCH].join('.')
metadata CHANGED
@@ -1,199 +1,199 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: yard-junk
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.6
4
+ version: 0.0.7
5
5
  platform: ruby
6
6
  authors:
7
7
  - Victor Shepelev
8
- autorequire:
8
+ autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2017-09-20 00:00:00.000000000 Z
11
+ date: 2017-09-21 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
+ name: yard
14
15
  requirement: !ruby/object:Gem::Requirement
15
16
  requirements:
16
17
  - - ">="
17
18
  - !ruby/object:Gem::Version
18
19
  version: '0'
19
- name: yard
20
- prerelease: false
21
20
  type: :runtime
21
+ prerelease: false
22
22
  version_requirements: !ruby/object:Gem::Requirement
23
23
  requirements:
24
24
  - - ">="
25
25
  - !ruby/object:Gem::Version
26
26
  version: '0'
27
27
  - !ruby/object:Gem::Dependency
28
+ name: backports
28
29
  requirement: !ruby/object:Gem::Requirement
29
30
  requirements:
30
31
  - - ">="
31
32
  - !ruby/object:Gem::Version
32
33
  version: '0'
33
- name: backports
34
- prerelease: false
35
34
  type: :runtime
35
+ prerelease: false
36
36
  version_requirements: !ruby/object:Gem::Requirement
37
37
  requirements:
38
38
  - - ">="
39
39
  - !ruby/object:Gem::Version
40
40
  version: '0'
41
41
  - !ruby/object:Gem::Dependency
42
+ name: rainbow
42
43
  requirement: !ruby/object:Gem::Requirement
43
44
  requirements:
44
45
  - - ">="
45
46
  - !ruby/object:Gem::Version
46
47
  version: '0'
47
- name: rainbow
48
- prerelease: false
49
48
  type: :runtime
49
+ prerelease: false
50
50
  version_requirements: !ruby/object:Gem::Requirement
51
51
  requirements:
52
52
  - - ">="
53
53
  - !ruby/object:Gem::Version
54
54
  version: '0'
55
55
  - !ruby/object:Gem::Dependency
56
+ name: tty-color
56
57
  requirement: !ruby/object:Gem::Requirement
57
58
  requirements:
58
59
  - - ">="
59
60
  - !ruby/object:Gem::Version
60
61
  version: '0'
61
- name: tty-color
62
- prerelease: false
63
62
  type: :runtime
63
+ prerelease: false
64
64
  version_requirements: !ruby/object:Gem::Requirement
65
65
  requirements:
66
66
  - - ">="
67
67
  - !ruby/object:Gem::Version
68
68
  version: '0'
69
69
  - !ruby/object:Gem::Dependency
70
+ name: rubocop
70
71
  requirement: !ruby/object:Gem::Requirement
71
72
  requirements:
72
73
  - - '='
73
74
  - !ruby/object:Gem::Version
74
75
  version: '0.49'
75
- name: rubocop
76
- prerelease: false
77
76
  type: :development
77
+ prerelease: false
78
78
  version_requirements: !ruby/object:Gem::Requirement
79
79
  requirements:
80
80
  - - '='
81
81
  - !ruby/object:Gem::Version
82
82
  version: '0.49'
83
83
  - !ruby/object:Gem::Dependency
84
+ name: rspec
84
85
  requirement: !ruby/object:Gem::Requirement
85
86
  requirements:
86
87
  - - ">="
87
88
  - !ruby/object:Gem::Version
88
89
  version: '3'
89
- name: rspec
90
- prerelease: false
91
90
  type: :development
91
+ prerelease: false
92
92
  version_requirements: !ruby/object:Gem::Requirement
93
93
  requirements:
94
94
  - - ">="
95
95
  - !ruby/object:Gem::Version
96
96
  version: '3'
97
97
  - !ruby/object:Gem::Dependency
98
+ name: rubocop-rspec
98
99
  requirement: !ruby/object:Gem::Requirement
99
100
  requirements:
100
101
  - - '='
101
102
  - !ruby/object:Gem::Version
102
103
  version: 1.15.1
103
- name: rubocop-rspec
104
- prerelease: false
105
104
  type: :development
105
+ prerelease: false
106
106
  version_requirements: !ruby/object:Gem::Requirement
107
107
  requirements:
108
108
  - - '='
109
109
  - !ruby/object:Gem::Version
110
110
  version: 1.15.1
111
111
  - !ruby/object:Gem::Dependency
112
+ name: rspec-its
112
113
  requirement: !ruby/object:Gem::Requirement
113
114
  requirements:
114
115
  - - "~>"
115
116
  - !ruby/object:Gem::Version
116
117
  version: '1'
117
- name: rspec-its
118
- prerelease: false
119
118
  type: :development
119
+ prerelease: false
120
120
  version_requirements: !ruby/object:Gem::Requirement
121
121
  requirements:
122
122
  - - "~>"
123
123
  - !ruby/object:Gem::Version
124
124
  version: '1'
125
125
  - !ruby/object:Gem::Dependency
126
+ name: fakefs
126
127
  requirement: !ruby/object:Gem::Requirement
127
128
  requirements:
128
129
  - - ">="
129
130
  - !ruby/object:Gem::Version
130
131
  version: '0'
131
- name: fakefs
132
- prerelease: false
133
132
  type: :development
133
+ prerelease: false
134
134
  version_requirements: !ruby/object:Gem::Requirement
135
135
  requirements:
136
136
  - - ">="
137
137
  - !ruby/object:Gem::Version
138
138
  version: '0'
139
139
  - !ruby/object:Gem::Dependency
140
+ name: simplecov
140
141
  requirement: !ruby/object:Gem::Requirement
141
142
  requirements:
142
143
  - - "~>"
143
144
  - !ruby/object:Gem::Version
144
145
  version: '0.9'
145
- name: simplecov
146
- prerelease: false
147
146
  type: :development
147
+ prerelease: false
148
148
  version_requirements: !ruby/object:Gem::Requirement
149
149
  requirements:
150
150
  - - "~>"
151
151
  - !ruby/object:Gem::Version
152
152
  version: '0.9'
153
153
  - !ruby/object:Gem::Dependency
154
+ name: rake
154
155
  requirement: !ruby/object:Gem::Requirement
155
156
  requirements:
156
157
  - - ">="
157
158
  - !ruby/object:Gem::Version
158
159
  version: '0'
159
- name: rake
160
- prerelease: false
161
160
  type: :development
161
+ prerelease: false
162
162
  version_requirements: !ruby/object:Gem::Requirement
163
163
  requirements:
164
164
  - - ">="
165
165
  - !ruby/object:Gem::Version
166
166
  version: '0'
167
167
  - !ruby/object:Gem::Dependency
168
+ name: rubygems-tasks
168
169
  requirement: !ruby/object:Gem::Requirement
169
170
  requirements:
170
171
  - - ">="
171
172
  - !ruby/object:Gem::Version
172
173
  version: '0'
173
- name: rubygems-tasks
174
- prerelease: false
175
174
  type: :development
175
+ prerelease: false
176
176
  version_requirements: !ruby/object:Gem::Requirement
177
177
  requirements:
178
178
  - - ">="
179
179
  - !ruby/object:Gem::Version
180
180
  version: '0'
181
181
  - !ruby/object:Gem::Dependency
182
+ name: yard
182
183
  requirement: !ruby/object:Gem::Requirement
183
184
  requirements:
184
185
  - - ">="
185
186
  - !ruby/object:Gem::Version
186
187
  version: '0'
187
- name: yard
188
- prerelease: false
189
188
  type: :development
189
+ prerelease: false
190
190
  version_requirements: !ruby/object:Gem::Requirement
191
191
  requirements:
192
192
  - - ">="
193
193
  - !ruby/object:Gem::Version
194
194
  version: '0'
195
- description: " YardJunk is structured logger/error validator plugin for YARD documentation\
196
- \ gem.\n"
195
+ description: " YardJunk is structured logger/error validator plugin for YARD documentation
196
+ gem.\n"
197
197
  email: zverok.offline@gmail.com
198
198
  executables:
199
199
  - yard-junk
@@ -226,7 +226,7 @@ homepage: https://github.com/zverok/junk_yard
226
226
  licenses:
227
227
  - MIT
228
228
  metadata: {}
229
- post_install_message:
229
+ post_install_message:
230
230
  rdoc_options: []
231
231
  require_paths:
232
232
  - lib
@@ -241,9 +241,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
241
241
  - !ruby/object:Gem::Version
242
242
  version: '0'
243
243
  requirements: []
244
- rubyforge_project:
245
- rubygems_version: 2.6.13
246
- signing_key:
244
+ rubyforge_project:
245
+ rubygems_version: 2.6.10
246
+ signing_key:
247
247
  specification_version: 4
248
248
  summary: Get rid of the junk in your YARD docs
249
249
  test_files: []