asciidoctor-csd 0.4.0 → 0.4.1
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/.rubocop.tb.yml +650 -0
- data/Gemfile.lock +70 -3
- data/README.adoc +15 -4
- data/asciidoctor-csd.gemspec +1 -0
- data/lib/asciidoctor/csd/converter.rb +2 -2
- data/lib/asciidoctor/csd/version.rb +1 -1
- data/lib/metanorma/csd/processor.rb +10 -6
- metadata +18 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 2b195d80ff9a038c4b152eee7e14a9436601a6ba50ad4c1917d69849059ced97
|
4
|
+
data.tar.gz: 6436c26ae33623be891fa24d11478ac8c6b526e4348b740e321dee116beae343
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 2327343432e0536660ed7252d409a6870d8b54223060efd8f166d13c07bb56cd41740617ac096337e20a8090d7c317c7687ff8fc7b2b1b8aee5d1406d28140df
|
7
|
+
data.tar.gz: 571beea46ed252bdc4187f465df96a13d29a18248690a1c553ea9b2c230201d68ceb9215841e0b95206d2abcec794a51e06b534f4bb13a952a6368ecef5ee4d2
|
data/.rubocop.tb.yml
ADDED
@@ -0,0 +1,650 @@
|
|
1
|
+
AllCops:
|
2
|
+
Exclude:
|
3
|
+
- db/schema.rb
|
4
|
+
|
5
|
+
Naming/AccessorMethodName:
|
6
|
+
Description: Check the naming of accessor methods for get_/set_.
|
7
|
+
Enabled: false
|
8
|
+
|
9
|
+
Style/Alias:
|
10
|
+
Description: 'Use alias_method instead of alias.'
|
11
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#alias-method'
|
12
|
+
Enabled: false
|
13
|
+
|
14
|
+
Style/ArrayJoin:
|
15
|
+
Description: 'Use Array#join instead of Array#*.'
|
16
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#array-join'
|
17
|
+
Enabled: false
|
18
|
+
|
19
|
+
Style/AsciiComments:
|
20
|
+
Description: 'Use only ascii symbols in comments.'
|
21
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#english-comments'
|
22
|
+
Enabled: false
|
23
|
+
|
24
|
+
Naming/AsciiIdentifiers:
|
25
|
+
Description: 'Use only ascii symbols in identifiers.'
|
26
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#english-identifiers'
|
27
|
+
Enabled: false
|
28
|
+
|
29
|
+
Style/Attr:
|
30
|
+
Description: 'Checks for uses of Module#attr.'
|
31
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#attr'
|
32
|
+
Enabled: false
|
33
|
+
|
34
|
+
Metrics/BlockNesting:
|
35
|
+
Description: 'Avoid excessive block nesting'
|
36
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#three-is-the-number-thou-shalt-count'
|
37
|
+
Enabled: false
|
38
|
+
|
39
|
+
Style/CaseEquality:
|
40
|
+
Description: 'Avoid explicit use of the case equality operator(===).'
|
41
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-case-equality'
|
42
|
+
Enabled: false
|
43
|
+
|
44
|
+
Style/CharacterLiteral:
|
45
|
+
Description: 'Checks for uses of character literals.'
|
46
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-character-literals'
|
47
|
+
Enabled: false
|
48
|
+
|
49
|
+
Style/ClassAndModuleChildren:
|
50
|
+
Description: 'Checks style of children classes and modules.'
|
51
|
+
Enabled: true
|
52
|
+
EnforcedStyle: nested
|
53
|
+
|
54
|
+
Metrics/ClassLength:
|
55
|
+
Description: 'Avoid classes longer than 100 lines of code.'
|
56
|
+
Enabled: false
|
57
|
+
|
58
|
+
Metrics/ModuleLength:
|
59
|
+
Description: 'Avoid modules longer than 100 lines of code.'
|
60
|
+
Enabled: false
|
61
|
+
|
62
|
+
Style/ClassVars:
|
63
|
+
Description: 'Avoid the use of class variables.'
|
64
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-class-vars'
|
65
|
+
Enabled: false
|
66
|
+
|
67
|
+
Style/CollectionMethods:
|
68
|
+
Enabled: true
|
69
|
+
PreferredMethods:
|
70
|
+
find: detect
|
71
|
+
inject: reduce
|
72
|
+
collect: map
|
73
|
+
find_all: select
|
74
|
+
|
75
|
+
Style/ColonMethodCall:
|
76
|
+
Description: 'Do not use :: for method call.'
|
77
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#double-colons'
|
78
|
+
Enabled: false
|
79
|
+
|
80
|
+
Style/CommentAnnotation:
|
81
|
+
Description: >-
|
82
|
+
Checks formatting of special comments
|
83
|
+
(TODO, FIXME, OPTIMIZE, HACK, REVIEW).
|
84
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#annotate-keywords'
|
85
|
+
Enabled: false
|
86
|
+
|
87
|
+
Metrics/AbcSize:
|
88
|
+
Description: >-
|
89
|
+
A calculated magnitude based on number of assignments,
|
90
|
+
branches, and conditions.
|
91
|
+
Enabled: false
|
92
|
+
|
93
|
+
Metrics/BlockLength:
|
94
|
+
CountComments: true # count full line comments?
|
95
|
+
Max: 25
|
96
|
+
ExcludedMethods: []
|
97
|
+
Exclude:
|
98
|
+
- "spec/**/*"
|
99
|
+
|
100
|
+
Metrics/CyclomaticComplexity:
|
101
|
+
Description: >-
|
102
|
+
A complexity metric that is strongly correlated to the number
|
103
|
+
of test cases needed to validate a method.
|
104
|
+
Enabled: false
|
105
|
+
|
106
|
+
Rails/Delegate:
|
107
|
+
Description: 'Prefer delegate method for delegations.'
|
108
|
+
Enabled: false
|
109
|
+
|
110
|
+
Style/PreferredHashMethods:
|
111
|
+
Description: 'Checks use of `has_key?` and `has_value?` Hash methods.'
|
112
|
+
StyleGuide: '#hash-key'
|
113
|
+
Enabled: false
|
114
|
+
|
115
|
+
Style/Documentation:
|
116
|
+
Description: 'Document classes and non-namespace modules.'
|
117
|
+
Enabled: false
|
118
|
+
|
119
|
+
Style/DoubleNegation:
|
120
|
+
Description: 'Checks for uses of double negation (!!).'
|
121
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-bang-bang'
|
122
|
+
Enabled: false
|
123
|
+
|
124
|
+
Style/EachWithObject:
|
125
|
+
Description: 'Prefer `each_with_object` over `inject` or `reduce`.'
|
126
|
+
Enabled: false
|
127
|
+
|
128
|
+
Style/EmptyLiteral:
|
129
|
+
Description: 'Prefer literals to Array.new/Hash.new/String.new.'
|
130
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#literal-array-hash'
|
131
|
+
Enabled: false
|
132
|
+
|
133
|
+
# Checks whether the source file has a utf-8 encoding comment or not
|
134
|
+
# AutoCorrectEncodingComment must match the regex
|
135
|
+
# /#.*coding\s?[:=]\s?(?:UTF|utf)-8/
|
136
|
+
Style/Encoding:
|
137
|
+
Enabled: false
|
138
|
+
|
139
|
+
Style/EvenOdd:
|
140
|
+
Description: 'Favor the use of Fixnum#even? && Fixnum#odd?'
|
141
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#predicate-methods'
|
142
|
+
Enabled: false
|
143
|
+
|
144
|
+
Naming/FileName:
|
145
|
+
Description: 'Use snake_case for source file names.'
|
146
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#snake-case-files'
|
147
|
+
Enabled: false
|
148
|
+
|
149
|
+
Style/FrozenStringLiteralComment:
|
150
|
+
Description: >-
|
151
|
+
Add the frozen_string_literal comment to the top of files
|
152
|
+
to help transition from Ruby 2.3.0 to Ruby 3.0.
|
153
|
+
Enabled: false
|
154
|
+
|
155
|
+
Style/FlipFlop:
|
156
|
+
Description: 'Checks for flip flops'
|
157
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-flip-flops'
|
158
|
+
Enabled: false
|
159
|
+
|
160
|
+
Style/FormatString:
|
161
|
+
Description: 'Enforce the use of Kernel#sprintf, Kernel#format or String#%.'
|
162
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#sprintf'
|
163
|
+
Enabled: false
|
164
|
+
|
165
|
+
Style/GlobalVars:
|
166
|
+
Description: 'Do not introduce global variables.'
|
167
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#instance-vars'
|
168
|
+
Reference: 'http://www.zenspider.com/Languages/Ruby/QuickRef.html'
|
169
|
+
Enabled: false
|
170
|
+
|
171
|
+
Style/GuardClause:
|
172
|
+
Description: 'Check for conditionals that can be replaced with guard clauses'
|
173
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-nested-conditionals'
|
174
|
+
Enabled: false
|
175
|
+
|
176
|
+
Style/IfUnlessModifier:
|
177
|
+
Description: >-
|
178
|
+
Favor modifier if/unless usage when you have a
|
179
|
+
single-line body.
|
180
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#if-as-a-modifier'
|
181
|
+
Enabled: false
|
182
|
+
|
183
|
+
Style/IfWithSemicolon:
|
184
|
+
Description: 'Do not use if x; .... Use the ternary operator instead.'
|
185
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-semicolon-ifs'
|
186
|
+
Enabled: false
|
187
|
+
|
188
|
+
Style/InlineComment:
|
189
|
+
Description: 'Avoid inline comments.'
|
190
|
+
Enabled: false
|
191
|
+
|
192
|
+
Style/Lambda:
|
193
|
+
Description: 'Use the new lambda literal syntax for single-line blocks.'
|
194
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#lambda-multi-line'
|
195
|
+
Enabled: false
|
196
|
+
|
197
|
+
Style/LambdaCall:
|
198
|
+
Description: 'Use lambda.call(...) instead of lambda.(...).'
|
199
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#proc-call'
|
200
|
+
Enabled: false
|
201
|
+
|
202
|
+
Style/LineEndConcatenation:
|
203
|
+
Description: >-
|
204
|
+
Use \ instead of + or << to concatenate two string literals at
|
205
|
+
line end.
|
206
|
+
Enabled: false
|
207
|
+
|
208
|
+
Metrics/LineLength:
|
209
|
+
Description: 'Limit lines to 80 characters.'
|
210
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#80-character-limits'
|
211
|
+
Max: 80
|
212
|
+
|
213
|
+
Metrics/MethodLength:
|
214
|
+
Description: 'Avoid methods longer than 10 lines of code.'
|
215
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#short-methods'
|
216
|
+
Enabled: false
|
217
|
+
|
218
|
+
Style/ModuleFunction:
|
219
|
+
Description: 'Checks for usage of `extend self` in modules.'
|
220
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#module-function'
|
221
|
+
Enabled: false
|
222
|
+
|
223
|
+
Style/MultilineBlockChain:
|
224
|
+
Description: 'Avoid multi-line chains of blocks.'
|
225
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#single-line-blocks'
|
226
|
+
Enabled: false
|
227
|
+
|
228
|
+
Style/NegatedIf:
|
229
|
+
Description: >-
|
230
|
+
Favor unless over if for negative conditions
|
231
|
+
(or control flow or).
|
232
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#unless-for-negatives'
|
233
|
+
Enabled: false
|
234
|
+
|
235
|
+
Style/NegatedWhile:
|
236
|
+
Description: 'Favor until over while for negative conditions.'
|
237
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#until-for-negatives'
|
238
|
+
Enabled: false
|
239
|
+
|
240
|
+
Style/Next:
|
241
|
+
Description: 'Use `next` to skip iteration instead of a condition at the end.'
|
242
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-nested-conditionals'
|
243
|
+
Enabled: false
|
244
|
+
|
245
|
+
Style/NilComparison:
|
246
|
+
Description: 'Prefer x.nil? to x == nil.'
|
247
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#predicate-methods'
|
248
|
+
Enabled: false
|
249
|
+
|
250
|
+
Style/Not:
|
251
|
+
Description: 'Use ! instead of not.'
|
252
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#bang-not-not'
|
253
|
+
Enabled: false
|
254
|
+
|
255
|
+
Style/NumericLiterals:
|
256
|
+
Description: >-
|
257
|
+
Add underscores to large numeric literals to improve their
|
258
|
+
readability.
|
259
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#underscores-in-numerics'
|
260
|
+
Enabled: false
|
261
|
+
|
262
|
+
Style/OneLineConditional:
|
263
|
+
Description: >-
|
264
|
+
Favor the ternary operator(?:) over
|
265
|
+
if/then/else/end constructs.
|
266
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#ternary-operator'
|
267
|
+
Enabled: false
|
268
|
+
|
269
|
+
Naming/BinaryOperatorParameterName:
|
270
|
+
Description: 'When defining binary operators, name the argument other.'
|
271
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#other-arg'
|
272
|
+
Enabled: false
|
273
|
+
|
274
|
+
Metrics/ParameterLists:
|
275
|
+
Description: 'Avoid parameter lists longer than three or four parameters.'
|
276
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#too-many-params'
|
277
|
+
Enabled: false
|
278
|
+
|
279
|
+
Style/PercentLiteralDelimiters:
|
280
|
+
Description: 'Use `%`-literal delimiters consistently'
|
281
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#percent-literal-braces'
|
282
|
+
Enabled: false
|
283
|
+
|
284
|
+
Style/PerlBackrefs:
|
285
|
+
Description: 'Avoid Perl-style regex back references.'
|
286
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-perl-regexp-last-matchers'
|
287
|
+
Enabled: false
|
288
|
+
|
289
|
+
Naming/PredicateName:
|
290
|
+
Description: 'Check the names of predicate methods.'
|
291
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#bool-methods-qmark'
|
292
|
+
NamePrefixBlacklist:
|
293
|
+
- is_
|
294
|
+
Exclude:
|
295
|
+
- spec/**/*
|
296
|
+
|
297
|
+
Style/Proc:
|
298
|
+
Description: 'Use proc instead of Proc.new.'
|
299
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#proc'
|
300
|
+
Enabled: false
|
301
|
+
|
302
|
+
Style/RaiseArgs:
|
303
|
+
Description: 'Checks the arguments passed to raise/fail.'
|
304
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#exception-class-messages'
|
305
|
+
Enabled: false
|
306
|
+
|
307
|
+
Style/RegexpLiteral:
|
308
|
+
Description: 'Use / or %r around regular expressions.'
|
309
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#percent-r'
|
310
|
+
Enabled: false
|
311
|
+
|
312
|
+
Style/SelfAssignment:
|
313
|
+
Description: >-
|
314
|
+
Checks for places where self-assignment shorthand should have
|
315
|
+
been used.
|
316
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#self-assignment'
|
317
|
+
Enabled: false
|
318
|
+
|
319
|
+
Style/SingleLineBlockParams:
|
320
|
+
Description: 'Enforces the names of some block params.'
|
321
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#reduce-blocks'
|
322
|
+
Enabled: false
|
323
|
+
|
324
|
+
Style/SingleLineMethods:
|
325
|
+
Description: 'Avoid single-line methods.'
|
326
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-single-line-methods'
|
327
|
+
Enabled: false
|
328
|
+
|
329
|
+
Style/SignalException:
|
330
|
+
Description: 'Checks for proper usage of fail and raise.'
|
331
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#fail-method'
|
332
|
+
Enabled: false
|
333
|
+
|
334
|
+
Style/SpecialGlobalVars:
|
335
|
+
Description: 'Avoid Perl-style global variables.'
|
336
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-cryptic-perlisms'
|
337
|
+
Enabled: false
|
338
|
+
|
339
|
+
Style/StringLiterals:
|
340
|
+
Description: 'Checks if uses of quotes match the configured preference.'
|
341
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#consistent-string-literals'
|
342
|
+
EnforcedStyle: double_quotes
|
343
|
+
Enabled: true
|
344
|
+
|
345
|
+
Style/TrailingCommaInArguments:
|
346
|
+
Description: 'Checks for trailing comma in argument lists.'
|
347
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
|
348
|
+
EnforcedStyleForMultiline: comma
|
349
|
+
SupportedStylesForMultiline:
|
350
|
+
- comma
|
351
|
+
- consistent_comma
|
352
|
+
- no_comma
|
353
|
+
Enabled: true
|
354
|
+
|
355
|
+
Style/TrailingCommaInArrayLiteral:
|
356
|
+
Description: 'Checks for trailing comma in array literals.'
|
357
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
|
358
|
+
EnforcedStyleForMultiline: comma
|
359
|
+
SupportedStylesForMultiline:
|
360
|
+
- comma
|
361
|
+
- consistent_comma
|
362
|
+
- no_comma
|
363
|
+
Enabled: true
|
364
|
+
|
365
|
+
Style/TrailingCommaInHashLiteral:
|
366
|
+
Description: 'Checks for trailing comma in hash literals.'
|
367
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
|
368
|
+
EnforcedStyleForMultiline: comma
|
369
|
+
SupportedStylesForMultiline:
|
370
|
+
- comma
|
371
|
+
- consistent_comma
|
372
|
+
- no_comma
|
373
|
+
Enabled: true
|
374
|
+
|
375
|
+
Style/TrivialAccessors:
|
376
|
+
Description: 'Prefer attr_* methods to trivial readers/writers.'
|
377
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#attr_family'
|
378
|
+
Enabled: false
|
379
|
+
|
380
|
+
Style/VariableInterpolation:
|
381
|
+
Description: >-
|
382
|
+
Don't interpolate global, instance and class variables
|
383
|
+
directly in strings.
|
384
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#curlies-interpolate'
|
385
|
+
Enabled: false
|
386
|
+
|
387
|
+
Style/WhenThen:
|
388
|
+
Description: 'Use when x then ... for one-line cases.'
|
389
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#one-line-cases'
|
390
|
+
Enabled: false
|
391
|
+
|
392
|
+
Style/WhileUntilModifier:
|
393
|
+
Description: >-
|
394
|
+
Favor modifier while/until usage when you have a
|
395
|
+
single-line body.
|
396
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#while-as-a-modifier'
|
397
|
+
Enabled: false
|
398
|
+
|
399
|
+
Style/WordArray:
|
400
|
+
Description: 'Use %w or %W for arrays of words.'
|
401
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#percent-w'
|
402
|
+
Enabled: false
|
403
|
+
|
404
|
+
# Layout
|
405
|
+
|
406
|
+
Layout/AlignParameters:
|
407
|
+
Description: 'Here we check if the parameters on a multi-line method call or definition are aligned.'
|
408
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-double-indent'
|
409
|
+
Enabled: false
|
410
|
+
|
411
|
+
Layout/ConditionPosition:
|
412
|
+
Description: >-
|
413
|
+
Checks for condition placed in a confusing position relative to
|
414
|
+
the keyword.
|
415
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#same-line-condition'
|
416
|
+
Enabled: false
|
417
|
+
|
418
|
+
Layout/DotPosition:
|
419
|
+
Description: 'Checks the position of the dot in multi-line method calls.'
|
420
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#consistent-multi-line-chains'
|
421
|
+
EnforcedStyle: trailing
|
422
|
+
|
423
|
+
Layout/ExtraSpacing:
|
424
|
+
Description: 'Do not use unnecessary spacing.'
|
425
|
+
Enabled: true
|
426
|
+
|
427
|
+
Layout/MultilineOperationIndentation:
|
428
|
+
Description: >-
|
429
|
+
Checks indentation of binary operations that span more than
|
430
|
+
one line.
|
431
|
+
Enabled: true
|
432
|
+
EnforcedStyle: indented
|
433
|
+
|
434
|
+
Layout/MultilineMethodCallIndentation:
|
435
|
+
Description: >-
|
436
|
+
Checks indentation of method calls with the dot operator
|
437
|
+
that span more than one line.
|
438
|
+
Enabled: true
|
439
|
+
EnforcedStyle: indented
|
440
|
+
|
441
|
+
Layout/InitialIndentation:
|
442
|
+
Description: >-
|
443
|
+
Checks the indentation of the first non-blank non-comment line in a file.
|
444
|
+
Enabled: false
|
445
|
+
|
446
|
+
# Lint
|
447
|
+
|
448
|
+
Lint/AmbiguousOperator:
|
449
|
+
Description: >-
|
450
|
+
Checks for ambiguous operators in the first argument of a
|
451
|
+
method invocation without parentheses.
|
452
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#parens-as-args'
|
453
|
+
Enabled: false
|
454
|
+
|
455
|
+
Lint/AmbiguousRegexpLiteral:
|
456
|
+
Description: >-
|
457
|
+
Checks for ambiguous regexp literals in the first argument of
|
458
|
+
a method invocation without parenthesis.
|
459
|
+
Enabled: false
|
460
|
+
|
461
|
+
Lint/AssignmentInCondition:
|
462
|
+
Description: "Don't use assignment in conditions."
|
463
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#safe-assignment-in-condition'
|
464
|
+
Enabled: false
|
465
|
+
|
466
|
+
Lint/CircularArgumentReference:
|
467
|
+
Description: "Don't refer to the keyword argument in the default value."
|
468
|
+
Enabled: false
|
469
|
+
|
470
|
+
Lint/DeprecatedClassMethods:
|
471
|
+
Description: 'Check for deprecated class method calls.'
|
472
|
+
Enabled: false
|
473
|
+
|
474
|
+
Lint/DuplicatedKey:
|
475
|
+
Description: 'Check for duplicate keys in hash literals.'
|
476
|
+
Enabled: false
|
477
|
+
|
478
|
+
Lint/EachWithObjectArgument:
|
479
|
+
Description: 'Check for immutable argument given to each_with_object.'
|
480
|
+
Enabled: false
|
481
|
+
|
482
|
+
Lint/ElseLayout:
|
483
|
+
Description: 'Check for odd code arrangement in an else block.'
|
484
|
+
Enabled: false
|
485
|
+
|
486
|
+
Lint/FormatParameterMismatch:
|
487
|
+
Description: 'The number of parameters to format/sprint must match the fields.'
|
488
|
+
Enabled: false
|
489
|
+
|
490
|
+
Lint/HandleExceptions:
|
491
|
+
Description: "Don't suppress exception."
|
492
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#dont-hide-exceptions'
|
493
|
+
Enabled: false
|
494
|
+
|
495
|
+
Lint/LiteralAsCondition:
|
496
|
+
Description: 'Checks of literals used in conditions.'
|
497
|
+
Enabled: false
|
498
|
+
|
499
|
+
Lint/LiteralInInterpolation:
|
500
|
+
Description: 'Checks for literals used in interpolation.'
|
501
|
+
Enabled: false
|
502
|
+
|
503
|
+
Lint/Loop:
|
504
|
+
Description: >-
|
505
|
+
Use Kernel#loop with break rather than begin/end/until or
|
506
|
+
begin/end/while for post-loop tests.
|
507
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#loop-with-break'
|
508
|
+
Enabled: false
|
509
|
+
|
510
|
+
Lint/NestedMethodDefinition:
|
511
|
+
Description: 'Do not use nested method definitions.'
|
512
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-nested-methods'
|
513
|
+
Enabled: false
|
514
|
+
|
515
|
+
Lint/NonLocalExitFromIterator:
|
516
|
+
Description: 'Do not use return in iterator to cause non-local exit.'
|
517
|
+
Enabled: false
|
518
|
+
|
519
|
+
Lint/ParenthesesAsGroupedExpression:
|
520
|
+
Description: >-
|
521
|
+
Checks for method calls with a space before the opening
|
522
|
+
parenthesis.
|
523
|
+
StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#parens-no-spaces'
|
524
|
+
Enabled: false
|
525
|
+
|
526
|
+
Lint/RequireParentheses:
|
527
|
+
Description: >-
|
528
|
+
Use parentheses in the method call to avoid confusion
|
529
|
+
about precedence.
|
530
|
+
Enabled: false
|
531
|
+
|
532
|
+
Lint/UnderscorePrefixedVariableName:
|
533
|
+
Description: 'Do not use prefix `_` for a variable that is used.'
|
534
|
+
Enabled: false
|
535
|
+
|
536
|
+
Lint/UnneededCopDisableDirective:
|
537
|
+
Description: >-
|
538
|
+
Checks for rubocop:disable comments that can be removed.
|
539
|
+
Note: this cop is not disabled when disabling all cops.
|
540
|
+
It must be explicitly disabled.
|
541
|
+
Enabled: false
|
542
|
+
|
543
|
+
Lint/Void:
|
544
|
+
Description: 'Possible use of operator/literal/variable in void context.'
|
545
|
+
Enabled: false
|
546
|
+
|
547
|
+
# Performance
|
548
|
+
|
549
|
+
Performance/CaseWhenSplat:
|
550
|
+
Description: >-
|
551
|
+
Place `when` conditions that use splat at the end
|
552
|
+
of the list of `when` branches.
|
553
|
+
Enabled: false
|
554
|
+
|
555
|
+
Performance/Count:
|
556
|
+
Description: >-
|
557
|
+
Use `count` instead of `select...size`, `reject...size`,
|
558
|
+
`select...count`, `reject...count`, `select...length`,
|
559
|
+
and `reject...length`.
|
560
|
+
Enabled: false
|
561
|
+
|
562
|
+
Performance/Detect:
|
563
|
+
Description: >-
|
564
|
+
Use `detect` instead of `select.first`, `find_all.first`,
|
565
|
+
`select.last`, and `find_all.last`.
|
566
|
+
Reference: 'https://github.com/JuanitoFatas/fast-ruby#enumerabledetect-vs-enumerableselectfirst-code'
|
567
|
+
Enabled: false
|
568
|
+
|
569
|
+
Performance/FlatMap:
|
570
|
+
Description: >-
|
571
|
+
Use `Enumerable#flat_map`
|
572
|
+
instead of `Enumerable#map...Array#flatten(1)`
|
573
|
+
or `Enumberable#collect..Array#flatten(1)`
|
574
|
+
Reference: 'https://github.com/JuanitoFatas/fast-ruby#enumerablemaparrayflatten-vs-enumerableflat_map-code'
|
575
|
+
Enabled: false
|
576
|
+
|
577
|
+
Performance/ReverseEach:
|
578
|
+
Description: 'Use `reverse_each` instead of `reverse.each`.'
|
579
|
+
Reference: 'https://github.com/JuanitoFatas/fast-ruby#enumerablereverseeach-vs-enumerablereverse_each-code'
|
580
|
+
Enabled: false
|
581
|
+
|
582
|
+
Performance/Sample:
|
583
|
+
Description: >-
|
584
|
+
Use `sample` instead of `shuffle.first`,
|
585
|
+
`shuffle.last`, and `shuffle[Fixnum]`.
|
586
|
+
Reference: 'https://github.com/JuanitoFatas/fast-ruby#arrayshufflefirst-vs-arraysample-code'
|
587
|
+
Enabled: false
|
588
|
+
|
589
|
+
Performance/Size:
|
590
|
+
Description: >-
|
591
|
+
Use `size` instead of `count` for counting
|
592
|
+
the number of elements in `Array` and `Hash`.
|
593
|
+
Reference: 'https://github.com/JuanitoFatas/fast-ruby#arraycount-vs-arraysize-code'
|
594
|
+
Enabled: false
|
595
|
+
|
596
|
+
Performance/StringReplacement:
|
597
|
+
Description: >-
|
598
|
+
Use `tr` instead of `gsub` when you are replacing the same
|
599
|
+
number of characters. Use `delete` instead of `gsub` when
|
600
|
+
you are deleting characters.
|
601
|
+
Reference: 'https://github.com/JuanitoFatas/fast-ruby#stringgsub-vs-stringtr-code'
|
602
|
+
Enabled: false
|
603
|
+
|
604
|
+
# Rails
|
605
|
+
|
606
|
+
Rails/ActionFilter:
|
607
|
+
Description: 'Enforces consistent use of action filter methods.'
|
608
|
+
Enabled: false
|
609
|
+
|
610
|
+
Rails/Date:
|
611
|
+
Description: >-
|
612
|
+
Checks the correct usage of date aware methods,
|
613
|
+
such as Date.today, Date.current etc.
|
614
|
+
Enabled: false
|
615
|
+
|
616
|
+
Rails/FindBy:
|
617
|
+
Description: 'Prefer find_by over where.first.'
|
618
|
+
Enabled: false
|
619
|
+
|
620
|
+
Rails/FindEach:
|
621
|
+
Description: 'Prefer all.find_each over all.find.'
|
622
|
+
Enabled: false
|
623
|
+
|
624
|
+
Rails/HasAndBelongsToMany:
|
625
|
+
Description: 'Prefer has_many :through to has_and_belongs_to_many.'
|
626
|
+
Enabled: false
|
627
|
+
|
628
|
+
Rails/Output:
|
629
|
+
Description: 'Checks for calls to puts, print, etc.'
|
630
|
+
Enabled: false
|
631
|
+
|
632
|
+
Rails/ReadWriteAttribute:
|
633
|
+
Description: >-
|
634
|
+
Checks for read_attribute(:attr) and
|
635
|
+
write_attribute(:attr, val).
|
636
|
+
Enabled: false
|
637
|
+
|
638
|
+
Rails/ScopeArgs:
|
639
|
+
Description: 'Checks the arguments of ActiveRecord scopes.'
|
640
|
+
Enabled: false
|
641
|
+
|
642
|
+
Rails/TimeZone:
|
643
|
+
Description: 'Checks the correct usage of time zone aware methods.'
|
644
|
+
StyleGuide: 'https://github.com/bbatsov/rails-style-guide#time'
|
645
|
+
Reference: 'http://danilenko.org/2012/7/6/rails_timezones'
|
646
|
+
Enabled: false
|
647
|
+
|
648
|
+
Rails/Validation:
|
649
|
+
Description: 'Use validates :attribute, hash of validations.'
|
650
|
+
Enabled: false
|
data/Gemfile.lock
CHANGED
@@ -12,15 +12,66 @@ GEM
|
|
12
12
|
httpclient (~> 2.8, >= 2.8.3)
|
13
13
|
json (>= 1.5.1)
|
14
14
|
asciidoctor (1.5.7.1)
|
15
|
-
asciidoctor-
|
15
|
+
asciidoctor-csand (0.3.0)
|
16
|
+
asciidoctor (~> 1.5.7)
|
17
|
+
asciidoctor-iso (>= 0.9.0)
|
18
|
+
asciimath
|
19
|
+
htmlentities (~> 4.3.4)
|
20
|
+
image_size
|
21
|
+
isodoc (>= 0.8.0)
|
22
|
+
mime-types
|
23
|
+
nokogiri
|
24
|
+
ruby-jing
|
25
|
+
ruby-xslt
|
26
|
+
thread_safe
|
27
|
+
uuidtools
|
28
|
+
asciidoctor-gb (0.3.0)
|
29
|
+
asciidoctor-iso (>= 0.9.0)
|
30
|
+
isodoc (>= 0.8.0)
|
31
|
+
twitter_cldr
|
32
|
+
asciidoctor-iso (0.9.1)
|
16
33
|
asciidoctor (~> 1.5.7)
|
17
34
|
iso-bib-item (~> 0.1.6)
|
18
35
|
isobib (~> 0.1.6)
|
19
36
|
isodoc (>= 0.8)
|
20
37
|
ruby-jing
|
38
|
+
asciidoctor-m3d (0.3.1)
|
39
|
+
asciidoctor (~> 1.5.7)
|
40
|
+
asciidoctor-iso (>= 0.9.0)
|
41
|
+
asciimath
|
42
|
+
htmlentities (~> 4.3.4)
|
43
|
+
image_size
|
44
|
+
isodoc (>= 0.8.0)
|
45
|
+
mime-types
|
46
|
+
nokogiri
|
47
|
+
ruby-jing
|
48
|
+
ruby-xslt
|
49
|
+
thread_safe
|
50
|
+
uuidtools
|
51
|
+
asciidoctor-rfc (0.9.0)
|
52
|
+
asciidoctor (~> 1.5.7)
|
53
|
+
htmlentities (~> 4.3.4)
|
54
|
+
nokogiri
|
55
|
+
ruby-jing
|
56
|
+
thread_safe
|
57
|
+
asciidoctor-rsd (0.3.1)
|
58
|
+
asciidoctor (~> 1.5.7)
|
59
|
+
asciidoctor-iso (>= 0.8.0)
|
60
|
+
asciimath
|
61
|
+
htmlentities (~> 4.3.4)
|
62
|
+
image_size
|
63
|
+
isodoc (>= 0.7.0)
|
64
|
+
mime-types
|
65
|
+
nokogiri
|
66
|
+
ruby-jing
|
67
|
+
ruby-xslt
|
68
|
+
thread_safe
|
69
|
+
uuidtools
|
21
70
|
asciimath (1.0.4)
|
22
71
|
ast (2.4.0)
|
23
72
|
byebug (9.1.0)
|
73
|
+
camertron-eprun (1.1.1)
|
74
|
+
cldr-plurals-runtime-rb (1.0.1)
|
24
75
|
coderay (1.1.2)
|
25
76
|
diff-lcs (1.3)
|
26
77
|
docile (1.3.1)
|
@@ -55,11 +106,11 @@ GEM
|
|
55
106
|
htmlentities (4.3.4)
|
56
107
|
httpclient (2.8.3)
|
57
108
|
image_size (2.0.0)
|
58
|
-
iso-bib-item (0.1.
|
109
|
+
iso-bib-item (0.1.8)
|
59
110
|
duplicate
|
60
111
|
isoics (~> 0.1.6)
|
61
112
|
nokogiri
|
62
|
-
isobib (0.1.
|
113
|
+
isobib (0.1.7)
|
63
114
|
algoliasearch
|
64
115
|
iso-bib-item (~> 0.1.2)
|
65
116
|
isodoc (0.8)
|
@@ -84,6 +135,15 @@ GEM
|
|
84
135
|
rb-inotify (~> 0.9, >= 0.9.7)
|
85
136
|
ruby_dep (~> 1.2)
|
86
137
|
lumberjack (1.0.13)
|
138
|
+
metanorma (0.2.2)
|
139
|
+
asciidoctor-csand (>= 0.3.0)
|
140
|
+
asciidoctor-csd (>= 0.4.0)
|
141
|
+
asciidoctor-gb (>= 0.3.0)
|
142
|
+
asciidoctor-iso (>= 0.9.0)
|
143
|
+
asciidoctor-m3d (>= 0.3.1)
|
144
|
+
asciidoctor-rfc (>= 0.9.0)
|
145
|
+
asciidoctor-rsd (>= 0.3.0)
|
146
|
+
isodoc (>= 0.8.0)
|
87
147
|
method_source (0.9.0)
|
88
148
|
mime-types (3.1)
|
89
149
|
mime-types-data (~> 3.2015)
|
@@ -149,6 +209,12 @@ GEM
|
|
149
209
|
thor (0.20.0)
|
150
210
|
thread_safe (0.3.6)
|
151
211
|
timecop (0.9.1)
|
212
|
+
twitter_cldr (4.4.3)
|
213
|
+
camertron-eprun
|
214
|
+
cldr-plurals-runtime-rb (~> 1.0)
|
215
|
+
tzinfo
|
216
|
+
tzinfo (1.2.5)
|
217
|
+
thread_safe (~> 0.1)
|
152
218
|
unicode-display_width (1.4.0)
|
153
219
|
uuidtools (2.1.5)
|
154
220
|
|
@@ -162,6 +228,7 @@ DEPENDENCIES
|
|
162
228
|
equivalent-xml (~> 0.6)
|
163
229
|
guard (~> 2.14)
|
164
230
|
guard-rspec (~> 4.7)
|
231
|
+
metanorma
|
165
232
|
rake (~> 12.0)
|
166
233
|
rspec (~> 3.6)
|
167
234
|
rubocop (~> 0.50)
|
data/README.adoc
CHANGED
@@ -18,7 +18,7 @@ for guidance, including https://github.com/riboseinc/asciidoctor-iso/wiki/Guidan
|
|
18
18
|
The following outputs are generated.
|
19
19
|
|
20
20
|
* (Optional) An HTML preview generated directly from the Asciidoctor document,
|
21
|
-
using native
|
21
|
+
using native Asciidoc formatting.
|
22
22
|
** http://asciimath.org[AsciiMathML] is to be used for mathematical formatting.
|
23
23
|
The gem uses the https://github.com/asciidoctor/asciimath[Ruby AsciiMath parser],
|
24
24
|
which is syntactically stricter than the common MathJax processor;
|
@@ -28,17 +28,21 @@ expressions.
|
|
28
28
|
International Standards.
|
29
29
|
* The XML representation is processed in turn to generate the following outputs
|
30
30
|
as end deliverable CSD standard drafts.
|
31
|
-
** HTML
|
31
|
+
** HTML
|
32
32
|
** PDF
|
33
33
|
|
34
34
|
This AsciiDoc syntax for writing CSD standards is hereby named "AsciiCSD".
|
35
35
|
|
36
36
|
== Usage
|
37
37
|
|
38
|
+
The preferred way to invoke this gem is via the `metanorma` script:
|
39
|
+
|
38
40
|
[source,console]
|
39
41
|
----
|
40
|
-
$
|
41
|
-
$
|
42
|
+
$ metanorma --type csd a.adoc # output HTML and PDF
|
43
|
+
$ metanorma --type csd --extensions html a.adoc # output just HTML
|
44
|
+
$ metanorma --type csd --extensions pdf a.adoc # output just PDF
|
45
|
+
$ metanorma --type csd --extensions xml a.adoc # output CSD XML
|
42
46
|
----
|
43
47
|
|
44
48
|
The gem translates the document into CSD XML format, and then
|
@@ -49,6 +53,13 @@ document.
|
|
49
53
|
|
50
54
|
The gem then converts the XML into HTML and PDF.
|
51
55
|
|
56
|
+
The gem can also be invoked directly within asciidoctor, though this is deprecated:
|
57
|
+
|
58
|
+
[source,console]
|
59
|
+
----
|
60
|
+
$ asciidoctor -b csd -r 'asciidoctor-csd' a.adoc
|
61
|
+
----
|
62
|
+
|
52
63
|
=== Installation
|
53
64
|
|
54
65
|
If you are using a Mac, the https://github.com/riboseinc/metanorma-macos-setup
|
data/asciidoctor-csd.gemspec
CHANGED
@@ -76,8 +76,8 @@ module Asciidoctor
|
|
76
76
|
result << noko { |ixml| front node, ixml }
|
77
77
|
result << noko { |ixml| middle node, ixml }
|
78
78
|
result << "</csd-standard>"
|
79
|
-
save_cache_biblio(@
|
80
|
-
save_cache_biblio(@
|
79
|
+
save_cache_biblio(@bibdb, true)
|
80
|
+
save_cache_biblio(@local_bibdb, false)
|
81
81
|
result = textcleanup(result.flatten * "\n")
|
82
82
|
ret1 = cleanup(Nokogiri::XML(result))
|
83
83
|
validate(ret1)
|
@@ -17,6 +17,10 @@ module Metanorma
|
|
17
17
|
}
|
18
18
|
end
|
19
19
|
|
20
|
+
def version
|
21
|
+
"Asciidoctor::Csd #{Asciidoctor::Csd::VERSION}"
|
22
|
+
end
|
23
|
+
|
20
24
|
def input_to_isodoc(file)
|
21
25
|
Metanorma::Input::Asciidoc.new.process(file, @asciidoctor_backend)
|
22
26
|
end
|
@@ -29,14 +33,14 @@ module Metanorma
|
|
29
33
|
require 'tempfile'
|
30
34
|
# Tempfile.open("#{outname}.html") do |tmp|
|
31
35
|
outname_html = outname + ".html"
|
32
|
-
|
33
|
-
|
34
|
-
|
35
|
-
|
36
|
-
|
36
|
+
IsoDoc::Csd::HtmlConvert.new(options).convert(outname_html, isodoc_node)
|
37
|
+
puts outname_html
|
38
|
+
system "cat #{outname_html}"
|
39
|
+
Metanorma::Output::Pdf.new.convert(outname_html, outname)
|
40
|
+
end
|
37
41
|
|
38
42
|
end
|
39
43
|
|
40
44
|
end
|
41
45
|
end
|
42
|
-
end
|
46
|
+
end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: asciidoctor-csd
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.4.
|
4
|
+
version: 0.4.1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Ribose Inc.
|
8
8
|
autorequire:
|
9
9
|
bindir: exe
|
10
10
|
cert_chain: []
|
11
|
-
date: 2018-
|
11
|
+
date: 2018-07-02 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: asciidoctor-iso
|
@@ -178,6 +178,20 @@ dependencies:
|
|
178
178
|
- - "~>"
|
179
179
|
- !ruby/object:Gem::Version
|
180
180
|
version: '0.9'
|
181
|
+
- !ruby/object:Gem::Dependency
|
182
|
+
name: metanorma
|
183
|
+
requirement: !ruby/object:Gem::Requirement
|
184
|
+
requirements:
|
185
|
+
- - ">="
|
186
|
+
- !ruby/object:Gem::Version
|
187
|
+
version: '0'
|
188
|
+
type: :development
|
189
|
+
prerelease: false
|
190
|
+
version_requirements: !ruby/object:Gem::Requirement
|
191
|
+
requirements:
|
192
|
+
- - ">="
|
193
|
+
- !ruby/object:Gem::Version
|
194
|
+
version: '0'
|
181
195
|
description: |
|
182
196
|
asciidoctor-csd lets you write CSD in AsciiDoc syntax.
|
183
197
|
|
@@ -189,6 +203,7 @@ extensions: []
|
|
189
203
|
extra_rdoc_files: []
|
190
204
|
files:
|
191
205
|
- ".gitignore"
|
206
|
+
- ".rubocop.tb.yml"
|
192
207
|
- ".travis.yml"
|
193
208
|
- CODE_OF_CONDUCT.md
|
194
209
|
- Gemfile
|
@@ -241,7 +256,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
241
256
|
version: '0'
|
242
257
|
requirements: []
|
243
258
|
rubyforge_project:
|
244
|
-
rubygems_version: 2.7.
|
259
|
+
rubygems_version: 2.7.6
|
245
260
|
signing_key:
|
246
261
|
specification_version: 4
|
247
262
|
summary: asciidoctor-csd lets you write CSD in AsciiDoc.
|