review 4.0.0 → 5.1.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.github/workflows/ruby-tex.yml +31 -0
- data/.github/workflows/ruby-win.yml +45 -0
- data/.github/workflows/ruby.yml +27 -0
- data/.rubocop.yml +141 -38
- data/Dockerfile +21 -5
- data/NEWS.ja.md +338 -1
- data/NEWS.md +339 -2
- data/README.md +11 -7
- data/Rakefile +7 -2
- data/appveyor.yml +0 -20
- data/bin/review +2 -4
- data/bin/review-catalog-converter +4 -4
- data/bin/review-check +8 -12
- data/bin/review-checkdep +2 -5
- data/bin/review-compile +11 -20
- data/bin/review-epub2html +1 -4
- data/bin/review-epubmaker +3 -4
- data/bin/review-idgxmlmaker +1 -3
- data/bin/review-index +5 -86
- data/bin/review-init +1 -4
- data/bin/review-pdfmaker +1 -3
- data/bin/review-preproc +3 -5
- data/bin/review-textmaker +1 -3
- data/bin/review-update +1 -4
- data/bin/review-validate +5 -5
- data/bin/review-vol +5 -82
- data/bin/review-webmaker +1 -3
- data/doc/config.yml.sample +55 -12
- data/doc/config.yml.sample-simple +4 -3
- data/doc/format.ja.md +119 -17
- data/doc/format.md +106 -17
- data/doc/makeindex.ja.md +2 -2
- data/doc/pdfmaker.ja.md +42 -0
- data/doc/pdfmaker.md +41 -0
- data/doc/quickstart.ja.md +55 -25
- data/doc/quickstart.md +47 -17
- data/lib/review.rb +1 -1
- data/lib/review/book.rb +2 -2
- data/lib/review/book/base.rb +69 -30
- data/lib/review/book/bib.rb +21 -0
- data/lib/review/book/book_unit.rb +158 -0
- data/lib/review/book/chapter.rb +33 -26
- data/lib/review/book/index.rb +39 -206
- data/lib/review/book/index/item.rb +8 -2
- data/lib/review/book/page_metric.rb +7 -7
- data/lib/review/book/part.rb +26 -11
- data/lib/review/book/volume.rb +5 -5
- data/lib/review/builder.rb +124 -27
- data/lib/review/call_hook.rb +20 -0
- data/lib/review/catalog.rb +3 -2
- data/lib/review/compiler.rb +197 -91
- data/lib/review/configure.rb +95 -9
- data/lib/review/converter.rb +1 -1
- data/lib/review/epub2html.rb +6 -1
- data/lib/review/epubmaker.rb +116 -117
- data/lib/review/epubmaker/content.rb +113 -0
- data/lib/review/epubmaker/epubcommon.rb +372 -0
- data/lib/review/epubmaker/epubv2.rb +178 -0
- data/lib/review/epubmaker/epubv3.rb +231 -0
- data/lib/review/epubmaker/producer.rb +168 -0
- data/lib/review/epubmaker/reviewheaderlistener.rb +12 -2
- data/lib/review/epubmaker/zip_exporter.rb +84 -0
- data/lib/review/exception.rb +6 -0
- data/lib/review/extentions/string.rb +0 -4
- data/lib/review/htmlbuilder.rb +132 -87
- data/lib/review/htmlutils.rb +8 -11
- data/lib/review/i18n.rb +2 -1
- data/lib/review/idgxmlbuilder.rb +156 -76
- data/lib/review/idgxmlmaker.rb +22 -18
- data/lib/review/img_math.rb +245 -0
- data/lib/review/index_builder.rb +654 -0
- data/lib/review/init.rb +17 -18
- data/lib/review/latexbox.rb +58 -0
- data/lib/review/latexbuilder.rb +173 -43
- data/lib/review/latexutils.rb +9 -1
- data/lib/review/lineinput.rb +112 -2
- data/lib/review/logger.rb +42 -3
- data/lib/review/makerhelper.rb +12 -187
- data/lib/review/markdownbuilder.rb +51 -2
- data/lib/review/pdfmaker.rb +78 -73
- data/lib/review/plaintextbuilder.rb +98 -14
- data/lib/review/preprocessor.rb +18 -12
- data/lib/review/rstbuilder.rb +28 -9
- data/lib/review/sec_counter.rb +14 -0
- data/lib/review/template.rb +6 -0
- data/lib/review/textmaker.rb +21 -19
- data/lib/review/textutils.rb +3 -12
- data/lib/review/tocprinter.rb +242 -97
- data/lib/review/topbuilder.rb +91 -24
- data/lib/review/update.rb +12 -13
- data/lib/review/version.rb +1 -1
- data/lib/review/volumeprinter.rb +97 -0
- data/lib/review/webmaker.rb +34 -33
- data/lib/review/webtocprinter.rb +39 -35
- data/lib/review/yamlloader.rb +2 -1
- data/review.gemspec +5 -3
- data/samples/sample-book/src/.gitignore +1 -0
- data/samples/sample-book/src/config-ebook.yml +4 -0
- data/samples/sample-book/src/config-epub2.yml +1 -1
- data/samples/sample-book/src/config-jlreq-ebook.yml +4 -0
- data/samples/sample-book/src/config.yml +3 -3
- data/samples/sample-book/src/lib/tasks/review.rake +26 -6
- data/samples/syntax-book/Gemfile +1 -1
- data/samples/syntax-book/ch01.re +3 -1
- data/samples/syntax-book/ch02.re +28 -21
- data/samples/syntax-book/ch03.re +1 -1
- data/samples/syntax-book/config-jlreq-lualatex.yml +4 -0
- data/samples/syntax-book/config-print.yml +3 -0
- data/samples/syntax-book/config.yml +1 -1
- data/samples/syntax-book/images/img3-2.png +0 -0
- data/samples/syntax-book/lib/tasks/review.rake +23 -8
- data/templates/html/_colophon.html.erb +23 -0
- data/templates/html/_colophon_history.html.erb +9 -0
- data/templates/html/_cover.html.erb +10 -0
- data/templates/html/_part_body.html.erb +6 -0
- data/templates/html/_titlepage.html.erb +20 -0
- data/templates/html/layout-html5.html.erb +6 -0
- data/templates/html/layout-xhtml1.html.erb +6 -0
- data/templates/latex/config.erb +41 -29
- data/templates/latex/review-jlreq/README.md +3 -1
- data/templates/latex/review-jlreq/review-base.sty +47 -22
- data/templates/latex/review-jlreq/review-jlreq.cls +25 -24
- data/templates/latex/review-jlreq/review-style.sty +6 -1
- data/templates/latex/review-jlreq/review-tcbox.sty +348 -0
- data/templates/latex/review-jlreq/reviewmacro.sty +5 -0
- data/templates/latex/review-jsbook/README.md +7 -5
- data/templates/latex/review-jsbook/review-base.sty +47 -21
- data/templates/latex/review-jsbook/review-jsbook.cls +12 -2
- data/templates/latex/review-jsbook/review-style.sty +6 -1
- data/templates/latex/review-jsbook/review-tcbox.sty +348 -0
- data/templates/latex/review-jsbook/reviewmacro.sty +5 -0
- data/templates/opf/epubv2.opf.erb +7 -7
- data/templates/opf/epubv3.opf.erb +7 -7
- data/templates/opf/opf_manifest_epubv2.opf.erb +10 -0
- data/templates/opf/opf_manifest_epubv3.opf.erb +10 -0
- data/templates/opf/opf_metainfo_epubv2.opf.erb +17 -0
- data/templates/opf/opf_metainfo_epubv3.opf.erb +49 -0
- data/templates/opf/opf_tocx_epubv2.opf.erb +9 -0
- data/templates/opf/opf_tocx_epubv3.opf.erb +17 -0
- data/templates/web/html/layout-html5.html.erb +9 -8
- data/templates/web/html/layout-xhtml1.html.erb +6 -0
- data/test/assets/header_listener.html +35 -0
- data/test/assets/img_math/img1.png +0 -0
- data/test/assets/img_math/img2.png +0 -0
- data/test/assets/img_math/img3.png +0 -0
- data/test/assets/syntax_book_index_detail.txt +58 -0
- data/test/assets/test_template.tex +12 -9
- data/test/assets/test_template_backmatter.tex +12 -9
- data/test/book_test_helper.rb +11 -5
- data/test/run_test.rb +1 -1
- data/test/test_book.rb +62 -63
- data/test/test_book_chapter.rb +99 -56
- data/test/test_book_part.rb +3 -3
- data/test/test_builder.rb +24 -15
- data/test/test_catalog.rb +1 -0
- data/test/test_catalog_converter_cmd.rb +1 -1
- data/test/test_converter.rb +1 -0
- data/test/test_epub3maker.rb +170 -126
- data/test/test_epubmaker.rb +249 -129
- data/test/test_epubmaker_cmd.rb +14 -7
- data/test/test_helper.rb +23 -11
- data/test/test_htmlbuilder.rb +956 -76
- data/test/test_htmlutils.rb +0 -12
- data/test/test_i18n.rb +33 -33
- data/test/test_idgxmlbuilder.rb +568 -10
- data/test/test_idgxmlmaker_cmd.rb +50 -0
- data/test/test_image_finder.rb +52 -70
- data/test/test_img_math.rb +111 -0
- data/test/test_index.rb +62 -52
- data/test/test_indexbuilder.rb +52 -0
- data/test/test_latexbuilder.rb +1056 -30
- data/test/test_latexbuilder_v2.rb +52 -12
- data/test/test_lineinput.rb +20 -93
- data/test/test_logger.rb +7 -7
- data/test/test_makerhelper.rb +0 -12
- data/test/test_markdownbuilder.rb +32 -0
- data/test/test_pdfmaker.rb +100 -11
- data/test/test_pdfmaker_cmd.rb +101 -7
- data/test/test_plaintextbuilder.rb +531 -25
- data/test/test_review_ext.rb +2 -1
- data/test/test_reviewheaderlistener.rb +49 -0
- data/test/test_rstbuilder.rb +25 -1
- data/test/test_sec_counter.rb +156 -0
- data/test/test_template.rb +12 -2
- data/test/test_textmaker_cmd.rb +58 -0
- data/test/test_tocprinter.rb +46 -0
- data/test/test_topbuilder.rb +365 -10
- data/test/test_update.rb +44 -44
- data/test/test_webtocprinter.rb +75 -43
- data/test/test_zip_exporter.rb +5 -6
- data/vendor/gentombow/LICENSE +1 -1
- data/vendor/gentombow/Makefile +0 -1
- data/vendor/gentombow/bounddvi-en.pdf +0 -0
- data/vendor/gentombow/bounddvi-en.tex +1 -0
- data/vendor/gentombow/bounddvi.pdf +0 -0
- data/vendor/gentombow/bounddvi.sty +30 -7
- data/vendor/gentombow/bounddvi.tex +1 -0
- data/vendor/gentombow/create_archive.sh +1 -0
- data/vendor/gentombow/gentombow-ja.pdf +0 -0
- data/vendor/gentombow/gentombow-ja.tex +9 -0
- data/vendor/gentombow/gentombow.pdf +0 -0
- data/vendor/gentombow/gentombow.sty +32 -10
- data/vendor/gentombow/gentombow.tex +8 -0
- data/vendor/gentombow/tests/gentombow-01-pdfx.tex +8 -0
- data/vendor/gentombow/tests/gentombow-02-pdfx.tex +8 -0
- data/vendor/jsclasses/LICENSE +1 -1
- data/vendor/jsclasses/Makefile +3 -2
- data/vendor/jsclasses/create_archive.sh +5 -5
- data/vendor/jsclasses/jis/Makefile +3 -2
- data/vendor/jsclasses/jis/jsarticle.cls +74 -31
- data/vendor/jsclasses/jis/jsbook.cls +74 -31
- data/vendor/jsclasses/jis/jsclasses.dtx +176 -36
- data/vendor/jsclasses/jis/jsclasses.ins +15 -5
- data/vendor/jsclasses/jis/jslogo.dtx +4 -4
- data/vendor/jsclasses/jis/jslogo.ins +9 -0
- data/vendor/jsclasses/jis/jslogo.sty +4 -16
- data/vendor/jsclasses/jis/jspf.cls +73 -30
- data/vendor/jsclasses/jis/jsreport.cls +74 -31
- data/vendor/jsclasses/jis/jsverb.ins +9 -0
- data/vendor/jsclasses/jis/jsverb.sty +1 -13
- data/vendor/jsclasses/jis/kiyou.cls +74 -31
- data/vendor/jsclasses/jis/minijs.sty +65 -22
- data/vendor/jsclasses/jis/okumacro.dtx +4 -5
- data/vendor/jsclasses/jis/okumacro.ins +9 -0
- data/vendor/jsclasses/jis/okumacro.sty +4 -17
- data/vendor/jsclasses/jis/okuverb.ins +9 -0
- data/vendor/jsclasses/jis/okuverb.sty +1 -13
- data/vendor/jsclasses/jis/winjis.sty +23 -19
- data/vendor/jsclasses/jsarticle.cls +74 -31
- data/vendor/jsclasses/jsbook.cls +74 -31
- data/vendor/jsclasses/jsclasses.dtx +176 -36
- data/vendor/jsclasses/jsclasses.ins +15 -5
- data/vendor/jsclasses/jsclasses.pdf +0 -0
- data/vendor/jsclasses/jslogo.dtx +4 -4
- data/vendor/jsclasses/jslogo.ins +9 -0
- data/vendor/jsclasses/jslogo.pdf +0 -0
- data/vendor/jsclasses/jslogo.sty +4 -16
- data/vendor/jsclasses/jspf.cls +73 -30
- data/vendor/jsclasses/jsreport.cls +74 -31
- data/vendor/jsclasses/jsverb.ins +9 -0
- data/vendor/jsclasses/jsverb.pdf +0 -0
- data/vendor/jsclasses/jsverb.sty +1 -13
- data/vendor/jsclasses/kiyou.cls +74 -31
- data/vendor/jsclasses/minijs.sty +68 -22
- data/vendor/jsclasses/okumacro.dtx +4 -5
- data/vendor/jsclasses/okumacro.ins +9 -0
- data/vendor/jsclasses/okumacro.pdf +0 -0
- data/vendor/jsclasses/okumacro.sty +4 -17
- data/vendor/jsclasses/okuverb.ins +9 -0
- data/vendor/jsclasses/okuverb.pdf +0 -0
- data/vendor/jsclasses/okuverb.sty +1 -13
- data/vendor/jsclasses/tests/relfont.tex +10 -0
- data/vendor/jsclasses/winjis.sty +23 -19
- metadata +109 -20
- data/.rubocop_todo.yml +0 -7
- data/lib/epubmaker.rb +0 -23
- data/lib/epubmaker/content.rb +0 -110
- data/lib/epubmaker/epubcommon.rb +0 -441
- data/lib/epubmaker/epubv2.rb +0 -143
- data/lib/epubmaker/epubv3.rb +0 -233
- data/lib/epubmaker/producer.rb +0 -375
- data/lib/epubmaker/zip_exporter.rb +0 -81
- data/lib/lineinput.rb +0 -155
- data/lib/review/book/compilable.rb +0 -178
- data/lib/review/tocparser.rb +0 -271
- data/samples/syntax-book/review-ext.rb +0 -14
- data/test/test_tocparser.rb +0 -25
data/lib/review/preprocessor.rb
CHANGED
@@ -115,7 +115,7 @@ module ReVIEW
|
|
115
115
|
|
116
116
|
when /\A\s*\z/ # empty line
|
117
117
|
@f.puts
|
118
|
-
else
|
118
|
+
else # rubocop:disable Lint/DuplicateBranch
|
119
119
|
@f.print line
|
120
120
|
end
|
121
121
|
end
|
@@ -195,7 +195,8 @@ module ReVIEW
|
|
195
195
|
op = m[1]
|
196
196
|
args = m[2].split(/,\s*/)
|
197
197
|
opts = parse_optargs(m[3])
|
198
|
-
return if argc == 0
|
198
|
+
return if (argc == 0) && args.empty?
|
199
|
+
|
199
200
|
if argc == -1
|
200
201
|
# Any number of arguments are allowed.
|
201
202
|
elsif args.size != argc
|
@@ -212,6 +213,7 @@ module ReVIEW
|
|
212
213
|
|
213
214
|
def parse_optargs(str)
|
214
215
|
return nil unless str
|
216
|
+
|
215
217
|
table = {}
|
216
218
|
str.split(/,\s*/).each do |a|
|
217
219
|
name, spec = a.split('=', 2)
|
@@ -222,11 +224,14 @@ module ReVIEW
|
|
222
224
|
|
223
225
|
def optarg_value(spec)
|
224
226
|
case spec
|
225
|
-
when 'true'
|
226
|
-
|
227
|
-
when '
|
228
|
-
|
229
|
-
when
|
227
|
+
when 'true' # [name=true], [name]
|
228
|
+
true
|
229
|
+
when 'false' # [name=false]
|
230
|
+
false
|
231
|
+
when 'nil' # [name=nil]
|
232
|
+
nil
|
233
|
+
when /^\d+$/ # [name=8]
|
234
|
+
$&.to_i
|
230
235
|
else # [name=val]
|
231
236
|
spec
|
232
237
|
end
|
@@ -261,7 +266,7 @@ module ReVIEW
|
|
261
266
|
end
|
262
267
|
|
263
268
|
def evaluate(path, chunk)
|
264
|
-
outputs = get_output("ruby #{path}", false).split(
|
269
|
+
outputs = get_output("ruby #{path}", false).split("\n").map(&:strip)
|
265
270
|
chunk.map do |line|
|
266
271
|
if /\# \$\d+/ =~ line.string
|
267
272
|
# map result into source.
|
@@ -284,7 +289,7 @@ module ReVIEW
|
|
284
289
|
err = stderr.readlines
|
285
290
|
end
|
286
291
|
end
|
287
|
-
if err
|
292
|
+
if err && !err.empty?
|
288
293
|
$stderr.puts '[unexpected stderr message]'
|
289
294
|
err.each { |line| $stderr.print line }
|
290
295
|
error 'get_output: got unexpected output'
|
@@ -355,14 +360,14 @@ module ReVIEW
|
|
355
360
|
|
356
361
|
def parse_git_blob(g_obj)
|
357
362
|
IO.popen('git show ' + g_obj.sub(/\Agit\|/, ''), 'r') do |f|
|
358
|
-
init_errorutils
|
363
|
+
init_errorutils(f)
|
359
364
|
return _parse_file(f)
|
360
365
|
end
|
361
366
|
end
|
362
367
|
|
363
368
|
def parse_file(fname)
|
364
369
|
File.open(fname, 'rt:BOM|utf-8') do |f|
|
365
|
-
init_errorutils
|
370
|
+
init_errorutils(f)
|
366
371
|
return _parse_file(f)
|
367
372
|
end
|
368
373
|
end
|
@@ -426,7 +431,8 @@ module ReVIEW
|
|
426
431
|
curr.each_value { |list| list.push(Line.new(nil, line)) }
|
427
432
|
|
428
433
|
else
|
429
|
-
next if yacchack
|
434
|
+
next if yacchack && (line.strip == ';')
|
435
|
+
|
430
436
|
line = canonical(line)
|
431
437
|
curr.each_value { |list| list.push(Line.new(lineno, line)) }
|
432
438
|
lineno += 1
|
data/lib/review/rstbuilder.rb
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
# Copyright (c) 2008-
|
1
|
+
# Copyright (c) 2008-2020 Minero Aoki, Kenshi Muto
|
2
2
|
# 2002-2006 Minero Aoki
|
3
3
|
#
|
4
4
|
# This program is free software.
|
@@ -67,13 +67,13 @@ module ReVIEW
|
|
67
67
|
end
|
68
68
|
private :builder_init_file
|
69
69
|
|
70
|
-
def print(s)
|
70
|
+
def print(*s)
|
71
71
|
@blank_seen = false
|
72
72
|
super
|
73
73
|
end
|
74
74
|
private :print
|
75
75
|
|
76
|
-
def puts(s)
|
76
|
+
def puts(*s)
|
77
77
|
@blank_seen = false
|
78
78
|
super
|
79
79
|
end
|
@@ -86,7 +86,7 @@ module ReVIEW
|
|
86
86
|
private :blank
|
87
87
|
|
88
88
|
def result
|
89
|
-
@output.string
|
89
|
+
solve_nest(@output.string)
|
90
90
|
end
|
91
91
|
|
92
92
|
def headline(level, label, caption)
|
@@ -97,7 +97,7 @@ module ReVIEW
|
|
97
97
|
end
|
98
98
|
p = '='
|
99
99
|
case level
|
100
|
-
when 1
|
100
|
+
when 1
|
101
101
|
unless label
|
102
102
|
puts ".. _#{@chapter.name}:"
|
103
103
|
blank
|
@@ -155,7 +155,7 @@ module ReVIEW
|
|
155
155
|
|
156
156
|
def dd(lines)
|
157
157
|
split_paragraph(lines).each do |paragraph|
|
158
|
-
puts " #{paragraph.
|
158
|
+
puts " #{paragraph.delete("\n")}"
|
159
159
|
end
|
160
160
|
end
|
161
161
|
|
@@ -373,8 +373,9 @@ module ReVIEW
|
|
373
373
|
|
374
374
|
def compile_kw(word, alt)
|
375
375
|
if alt
|
376
|
-
|
377
|
-
else
|
376
|
+
" **#{word}(#{alt.strip})** "
|
377
|
+
else
|
378
|
+
" **#{word}** "
|
378
379
|
end
|
379
380
|
end
|
380
381
|
|
@@ -582,6 +583,24 @@ module ReVIEW
|
|
582
583
|
base_parablock('centering', lines, nil)
|
583
584
|
end
|
584
585
|
|
586
|
+
CAPTION_TITLES.each do |name|
|
587
|
+
class_eval %Q(
|
588
|
+
def #{name}_begin(caption = nil)
|
589
|
+
check_nested_minicolumn
|
590
|
+
@doc_status[:minicolumn] = '#{name}'
|
591
|
+
puts ".. #{name}::"
|
592
|
+
blank
|
593
|
+
puts " " + compile_inline(caption).to_s unless caption.nil?
|
594
|
+
print " "
|
595
|
+
end
|
596
|
+
|
597
|
+
def #{name}_end
|
598
|
+
blank
|
599
|
+
@doc_status[:minicolumn] = nil
|
600
|
+
end
|
601
|
+
), __FILE__, __LINE__ - 14
|
602
|
+
end
|
603
|
+
|
585
604
|
def note(lines, caption = nil)
|
586
605
|
base_parablock('note', lines, caption)
|
587
606
|
end
|
@@ -705,7 +724,7 @@ module ReVIEW
|
|
705
724
|
str
|
706
725
|
end
|
707
726
|
|
708
|
-
def inline_chap(id)
|
727
|
+
def inline_chap(id) # rubocop:disable Lint/UselessMethodDefinition
|
709
728
|
super
|
710
729
|
end
|
711
730
|
|
data/lib/review/sec_counter.rb
CHANGED
@@ -37,11 +37,25 @@ module ReVIEW
|
|
37
37
|
str
|
38
38
|
end
|
39
39
|
|
40
|
+
def number_list
|
41
|
+
buf = @counter.dup
|
42
|
+
while buf.present?
|
43
|
+
if buf.last == 0
|
44
|
+
buf.pop
|
45
|
+
else
|
46
|
+
return buf
|
47
|
+
end
|
48
|
+
end
|
49
|
+
|
50
|
+
buf
|
51
|
+
end
|
52
|
+
|
40
53
|
def prefix(level, secnolevel)
|
41
54
|
return nil if @chapter.number.blank?
|
42
55
|
|
43
56
|
if level == 1
|
44
57
|
return nil unless secnolevel >= 1
|
58
|
+
|
45
59
|
if @chapter.is_a?(ReVIEW::Book::Part)
|
46
60
|
num = @chapter.number
|
47
61
|
"#{I18n.t('part', num)}#{I18n.t('chapter_postfix')}"
|
data/lib/review/template.rb
CHANGED
@@ -10,8 +10,14 @@ module ReVIEW
|
|
10
10
|
self.new(filename, mode)
|
11
11
|
end
|
12
12
|
|
13
|
+
def self.generate(path:, binding:, mode: 1, template_dir: ReVIEW::Template::TEMPLATE_DIR)
|
14
|
+
template_file = File.expand_path(path, template_dir)
|
15
|
+
self.new(template_file, mode).result(binding)
|
16
|
+
end
|
17
|
+
|
13
18
|
def initialize(filename = nil, mode = nil)
|
14
19
|
return unless filename
|
20
|
+
|
15
21
|
content = File.read(filename)
|
16
22
|
@erb = ERB.new(content, nil, mode)
|
17
23
|
end
|
data/lib/review/textmaker.rb
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
# Copyright (c) 2018-
|
1
|
+
# Copyright (c) 2018-2021 Kenshi Muto
|
2
2
|
#
|
3
3
|
# This program is free software.
|
4
4
|
# You can distribute or modify this program under the terms of
|
@@ -16,6 +16,7 @@ require 'review/yamlloader'
|
|
16
16
|
require 'review/topbuilder'
|
17
17
|
require 'review/version'
|
18
18
|
require 'review/makerhelper'
|
19
|
+
require 'review/img_math'
|
19
20
|
|
20
21
|
module ReVIEW
|
21
22
|
class TEXTMaker
|
@@ -27,6 +28,7 @@ module ReVIEW
|
|
27
28
|
@basedir = nil
|
28
29
|
@logger = ReVIEW.logger
|
29
30
|
@plaintext = nil
|
31
|
+
@img_math = nil
|
30
32
|
end
|
31
33
|
|
32
34
|
def error(msg)
|
@@ -45,10 +47,12 @@ module ReVIEW
|
|
45
47
|
def parse_opts(args)
|
46
48
|
cmd_config = {}
|
47
49
|
opts = OptionParser.new
|
50
|
+
@buildonly = nil
|
48
51
|
|
49
52
|
opts.banner = 'Usage: review-textmaker [-n] configfile'
|
50
53
|
opts.version = ReVIEW::VERSION
|
51
54
|
opts.on('-n', 'No decoration.') { @plaintext = true }
|
55
|
+
opts.on('-y', '--only file1,file2,...', 'Build only specified files.') { |v| @buildonly = v.split(/\s*,\s*/).map { |m| m.strip.sub(/\.re\Z/, '') } }
|
52
56
|
opts.on('--help', 'Prints this message and quit.') do
|
53
57
|
puts opts.help
|
54
58
|
exit 0
|
@@ -68,36 +72,31 @@ module ReVIEW
|
|
68
72
|
end
|
69
73
|
|
70
74
|
def remove_old_files(path)
|
71
|
-
cleanup_mathimg
|
75
|
+
@img_math.cleanup_mathimg
|
72
76
|
FileUtils.rm_rf(path)
|
73
77
|
end
|
74
78
|
|
75
79
|
def execute(*args)
|
76
|
-
@config = ReVIEW::Configure.values
|
77
|
-
@config.maker = 'textmaker'
|
78
80
|
cmd_config, yamlfile = parse_opts(args)
|
79
81
|
error "#{yamlfile} not found." unless File.exist?(yamlfile)
|
80
82
|
|
81
|
-
|
82
|
-
|
83
|
-
|
84
|
-
|
85
|
-
error "yaml error #{e.message}"
|
86
|
-
end
|
83
|
+
@config = ReVIEW::Configure.create(maker: 'textmaker',
|
84
|
+
yamlfile: yamlfile,
|
85
|
+
config: cmd_config)
|
86
|
+
@img_math = ReVIEW::ImgMath.new(@config, path_name: '_review_math_text')
|
87
87
|
|
88
|
-
# YAML configs will be overridden by command line options.
|
89
|
-
@config.deep_merge!(cmd_config)
|
90
88
|
I18n.setup(@config['language'])
|
91
89
|
begin
|
92
90
|
generate_text_files(yamlfile)
|
91
|
+
@logger.success("built #{build_path}")
|
93
92
|
rescue ApplicationError => e
|
94
93
|
raise if @config['debug']
|
94
|
+
|
95
95
|
error(e.message)
|
96
96
|
end
|
97
97
|
|
98
|
-
|
99
|
-
|
100
|
-
make_math_images(math_dir)
|
98
|
+
if @config['math_format'] == 'imgmath'
|
99
|
+
@img_math.make_math_images
|
101
100
|
end
|
102
101
|
end
|
103
102
|
|
@@ -107,8 +106,7 @@ module ReVIEW
|
|
107
106
|
remove_old_files(@path)
|
108
107
|
Dir.mkdir(@path)
|
109
108
|
|
110
|
-
@book = ReVIEW::Book.
|
111
|
-
@book.config = @config
|
109
|
+
@book = ReVIEW::Book::Base.new(@basedir, config: @config)
|
112
110
|
|
113
111
|
build_body(@path, yamlfile)
|
114
112
|
end
|
@@ -117,9 +115,9 @@ module ReVIEW
|
|
117
115
|
base_path = Pathname.new(@basedir)
|
118
116
|
builder = nil
|
119
117
|
if @plaintext
|
120
|
-
builder = ReVIEW::PLAINTEXTBuilder.new
|
118
|
+
builder = ReVIEW::PLAINTEXTBuilder.new(img_math: @img_math)
|
121
119
|
else
|
122
|
-
builder = ReVIEW::TOPBuilder.new
|
120
|
+
builder = ReVIEW::TOPBuilder.new(img_math: @img_math)
|
123
121
|
end
|
124
122
|
@converter = ReVIEW::Converter.new(@book, builder)
|
125
123
|
@book.parts.each do |part|
|
@@ -154,6 +152,10 @@ module ReVIEW
|
|
154
152
|
filename = Pathname.new(chap.path).relative_path_from(base_path).to_s
|
155
153
|
end
|
156
154
|
id = File.basename(filename).sub(/\.re\Z/, '')
|
155
|
+
if @buildonly && !@buildonly.include?(id)
|
156
|
+
warn "skip #{id}.re"
|
157
|
+
return
|
158
|
+
end
|
157
159
|
|
158
160
|
textfile = "#{id}.txt"
|
159
161
|
|
data/lib/review/textutils.rb
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
# Copyright (c) 2008-
|
1
|
+
# Copyright (c) 2008-2020 Minero Aoki, Kenshi Muto, Masayoshi Takahashi,
|
2
2
|
# KADO Masanori
|
3
3
|
# 2002-2007 Minero Aoki
|
4
4
|
#
|
@@ -51,6 +51,7 @@ module ReVIEW
|
|
51
51
|
if tail.nil? || head.nil?
|
52
52
|
return nil
|
53
53
|
end
|
54
|
+
|
54
55
|
space = true
|
55
56
|
# rule 2
|
56
57
|
if %i[F W H].include?(Unicode::Eaw.property(tail)) &&
|
@@ -86,6 +87,7 @@ module ReVIEW
|
|
86
87
|
unless @book.config['join_lines_by_lang']
|
87
88
|
return lines.join
|
88
89
|
end
|
90
|
+
|
89
91
|
lazy = true
|
90
92
|
lang = 'ja'
|
91
93
|
0.upto(lines.size - 2) do |n|
|
@@ -96,17 +98,6 @@ module ReVIEW
|
|
96
98
|
lines.join
|
97
99
|
end
|
98
100
|
|
99
|
-
def defer_math_image(str, path, key)
|
100
|
-
# for Re:VIEW >3
|
101
|
-
File.open(File.join(File.dirname(path), '__IMGMATH_BODY__.tex'), 'a+') do |f|
|
102
|
-
f.puts str
|
103
|
-
f.puts '\\clearpage'
|
104
|
-
end
|
105
|
-
File.open(File.join(File.dirname(path), '__IMGMATH_BODY__.map'), 'a+') do |f|
|
106
|
-
f.puts key
|
107
|
-
end
|
108
|
-
end
|
109
|
-
|
110
101
|
private
|
111
102
|
|
112
103
|
# remove elements at the back of `lines` if element is empty string
|
data/lib/review/tocprinter.rb
CHANGED
@@ -1,148 +1,293 @@
|
|
1
|
-
# Copyright (c) 2008-
|
2
|
-
#
|
1
|
+
# Copyright (c) 2008-2021 Minero Aoki, Kenshi Muto
|
2
|
+
# 1999-2007 Minero Aoki
|
3
3
|
#
|
4
4
|
# This program is free software.
|
5
5
|
# You can distribute or modify this program under the terms of
|
6
6
|
# the GNU LGPL, Lesser General Public License version 2.1.
|
7
|
-
# For details of LGPL, see the file "COPYING".
|
7
|
+
# For details of the GNU LGPL, see the file "COPYING".
|
8
8
|
#
|
9
9
|
|
10
|
-
require 'review/
|
11
|
-
require 'review/
|
10
|
+
require 'review/book'
|
11
|
+
require 'review/version'
|
12
|
+
require 'optparse'
|
13
|
+
require 'review/plaintextbuilder'
|
12
14
|
|
13
15
|
module ReVIEW
|
14
|
-
class
|
15
|
-
def
|
16
|
-
|
16
|
+
class PLAINTEXTTocBuilder < PLAINTEXTBuilder
|
17
|
+
def headline(level, label, caption)
|
18
|
+
if @chapter.is_a?(ReVIEW::Book::Part)
|
19
|
+
print "\x01H0\x01" # XXX: don't modify level value. level value will be handled in sec_counter#prefix()
|
20
|
+
else
|
21
|
+
print "\x01H#{level}\x01"
|
22
|
+
end
|
23
|
+
# embed header information for tocparser
|
24
|
+
super(level, label, caption)
|
17
25
|
end
|
18
26
|
|
19
|
-
def
|
20
|
-
|
21
|
-
|
22
|
-
|
27
|
+
def base_block(type, lines, caption = nil)
|
28
|
+
puts "\x01STARTLIST\x01"
|
29
|
+
super(type, lines, caption)
|
30
|
+
puts "\x01ENDLIST\x01"
|
23
31
|
end
|
24
32
|
|
25
|
-
def
|
26
|
-
|
33
|
+
def blank
|
34
|
+
@blank_seen = true
|
27
35
|
end
|
36
|
+
end
|
28
37
|
|
29
|
-
|
30
|
-
|
38
|
+
class TOCPrinter
|
39
|
+
class Counter
|
40
|
+
def initialize(name: nil, level: nil, headline: nil, lines: nil, chars: nil, list_lines: nil, text_lines: nil, part: nil)
|
41
|
+
@name = name
|
42
|
+
@level = level
|
43
|
+
@headline = headline
|
44
|
+
@lines = lines
|
45
|
+
@chars = chars
|
46
|
+
@list_lines = list_lines
|
47
|
+
@text_lines = text_lines
|
48
|
+
@part = part
|
49
|
+
end
|
50
|
+
|
51
|
+
attr_accessor :name, :level, :headline, :lines, :chars, :list_lines, :text_lines, :part
|
31
52
|
end
|
32
53
|
|
33
|
-
def
|
34
|
-
|
35
|
-
print_node(1, chap_node)
|
36
|
-
print_children(chap_node)
|
54
|
+
def self.execute(*args)
|
55
|
+
new.execute(*args)
|
37
56
|
end
|
38
57
|
|
39
|
-
def
|
40
|
-
|
58
|
+
def initialize
|
59
|
+
@logger = ReVIEW.logger
|
60
|
+
@yamlfile = 'config.yml'
|
61
|
+
@upper = 4
|
62
|
+
@indent = true
|
63
|
+
@buildonly = nil
|
64
|
+
@detail = nil
|
65
|
+
@calc_char_width = nil
|
41
66
|
end
|
42
|
-
end
|
43
67
|
|
44
|
-
|
45
|
-
private
|
68
|
+
attr_accessor :calc_char_width
|
46
69
|
|
47
|
-
def
|
48
|
-
|
49
|
-
|
50
|
-
|
51
|
-
|
52
|
-
|
70
|
+
def execute(*args)
|
71
|
+
parse_options(args)
|
72
|
+
@config = ReVIEW::Configure.create(yamlfile: @yamlfile)
|
73
|
+
@book = ReVIEW::Book::Base.new('.', config: @config)
|
74
|
+
unless File.readable?(@yamlfile)
|
75
|
+
@logger.error("No such fiile or can't open #{@yamlfile}.")
|
76
|
+
exit 1
|
77
|
+
end
|
78
|
+
I18n.setup(@config['language'])
|
79
|
+
|
80
|
+
if @detail
|
81
|
+
begin
|
82
|
+
require 'unicode/eaw'
|
83
|
+
@calc_char_width = true
|
84
|
+
rescue LoadError
|
85
|
+
@logger.warn('not found unicode/eaw library. page volume may be unreliable.')
|
86
|
+
@calc_char_width = nil
|
53
87
|
end
|
54
88
|
end
|
89
|
+
|
90
|
+
print_result(build_result_array)
|
55
91
|
end
|
56
92
|
|
57
|
-
def
|
58
|
-
|
59
|
-
|
60
|
-
@
|
61
|
-
|
62
|
-
|
63
|
-
|
64
|
-
|
65
|
-
|
66
|
-
|
67
|
-
|
93
|
+
def build_result_array
|
94
|
+
result_array = []
|
95
|
+
begin
|
96
|
+
@book.parts.each do |part|
|
97
|
+
if part.name.present? && (@buildonly.nil? || @buildonly.include?(part.name))
|
98
|
+
result_array.push(Counter.new(part: 'start'))
|
99
|
+
if part.file?
|
100
|
+
content = build_chap(part)
|
101
|
+
result_array.concat(parse_contents(part.name, @upper, content))
|
102
|
+
else
|
103
|
+
title = part.format_number + I18n.t('chapter_postfix') + part.title
|
104
|
+
result_array.push(
|
105
|
+
Counter.new(name: '', lines: 1, chars: title.size, list_lines: 0, text_lines: 1),
|
106
|
+
Counter.new(level: 0, headline: title, lines: 1, chars: title.size, list_lines: 0, text_lines: 1)
|
107
|
+
)
|
108
|
+
end
|
109
|
+
end
|
110
|
+
|
111
|
+
part.chapters.each do |chap|
|
112
|
+
if @buildonly.nil? || @buildonly.include?(chap.name)
|
113
|
+
content = build_chap(chap)
|
114
|
+
result_array.concat(parse_contents(chap.name, @upper, content))
|
115
|
+
end
|
116
|
+
end
|
117
|
+
if part.name.present? && (@buildonly.nil? || @buildonly.include?(part.name))
|
118
|
+
result_array.push(Counter.new(part: 'end'))
|
119
|
+
end
|
120
|
+
end
|
121
|
+
rescue ReVIEW::FileNotFound, ReVIEW::CompileError => e
|
122
|
+
@logger.error e
|
123
|
+
exit 1
|
68
124
|
end
|
125
|
+
|
126
|
+
result_array
|
69
127
|
end
|
70
128
|
|
71
|
-
def
|
72
|
-
|
129
|
+
def print_result(result_array)
|
130
|
+
result_array.each do |result|
|
131
|
+
if result.part
|
132
|
+
next
|
133
|
+
end
|
134
|
+
|
135
|
+
if result.name
|
136
|
+
# file information
|
137
|
+
if @detail
|
138
|
+
puts '============================='
|
139
|
+
printf("%6dC %5dL %5dP %s\n", result.chars, result.lines, calc_pages(result).ceil, result.name)
|
140
|
+
puts '-----------------------------'
|
141
|
+
end
|
142
|
+
next
|
143
|
+
end
|
144
|
+
|
145
|
+
# section information
|
146
|
+
if @detail
|
147
|
+
printf('%6dC %5dL %5.1fP ', result.chars, result.lines, calc_pages(result))
|
148
|
+
end
|
149
|
+
if @indent && result.level
|
150
|
+
print ' ' * (result.level == 0 ? 0 : result.level - 1)
|
151
|
+
end
|
152
|
+
puts result.headline
|
153
|
+
end
|
73
154
|
end
|
74
155
|
|
75
|
-
def
|
76
|
-
|
77
|
-
|
78
|
-
cols[0, 3] # does not display volume of level-4 section
|
156
|
+
def calc_pages(result)
|
157
|
+
(result.list_lines.to_f / @book.page_metric.list.n_lines) +
|
158
|
+
(result.text_lines.to_f / @book.page_metric.text.n_lines)
|
79
159
|
end
|
80
|
-
end
|
81
160
|
|
82
|
-
|
83
|
-
|
161
|
+
def calc_linesize(line)
|
162
|
+
return line.size unless @calc_char_width
|
84
163
|
|
85
|
-
|
86
|
-
|
87
|
-
|
88
|
-
|
164
|
+
line.each_char.inject(0) do |result, char|
|
165
|
+
# XXX: should include A also?
|
166
|
+
if %i[Na H N].include?(Unicode::Eaw.property(char))
|
167
|
+
result + 0.5 # halfwidth
|
168
|
+
else
|
169
|
+
result + 1
|
170
|
+
end
|
171
|
+
end
|
89
172
|
end
|
90
173
|
|
91
|
-
def
|
92
|
-
|
93
|
-
|
174
|
+
def parse_contents(name, upper, content)
|
175
|
+
headline_array = []
|
176
|
+
counter = Counter.new(lines: 0, chars: 0, list_lines: 0, text_lines: 0)
|
177
|
+
listmode = nil
|
178
|
+
|
179
|
+
content.each_line(chomp: true) do |l|
|
180
|
+
if l.start_with?("\x01STARTLIST\x01")
|
181
|
+
listmode = true
|
182
|
+
next
|
183
|
+
elsif l.start_with?("\x01ENDLIST\x01")
|
184
|
+
listmode = nil
|
185
|
+
next
|
186
|
+
elsif l =~ /\A\x01H(\d)\x01/
|
187
|
+
# headline
|
188
|
+
level = $1.to_i
|
189
|
+
l = $'
|
190
|
+
if level <= upper
|
191
|
+
if counter.chars > 0
|
192
|
+
headline_array.push(counter)
|
193
|
+
end
|
194
|
+
headline = l
|
195
|
+
counter = Counter.new(
|
196
|
+
level: level,
|
197
|
+
headline: headline,
|
198
|
+
lines: 1,
|
199
|
+
chars: headline.size,
|
200
|
+
list_lines: 0,
|
201
|
+
text_lines: 1
|
202
|
+
)
|
203
|
+
next
|
204
|
+
end
|
205
|
+
end
|
206
|
+
|
207
|
+
counter.lines += 1
|
208
|
+
counter.chars += l.size
|
209
|
+
|
210
|
+
if listmode
|
211
|
+
# code list: calculate line wrapping
|
212
|
+
counter.list_lines += calc_line_wrapping(l, mode: :list)
|
213
|
+
else
|
214
|
+
# normal paragraph: calculate line wrapping
|
215
|
+
counter.text_lines += calc_line_wrapping(l, mode: :text)
|
216
|
+
end
|
94
217
|
end
|
95
|
-
|
218
|
+
headline_array.push(counter)
|
219
|
+
|
220
|
+
total = calc_total_count(name, headline_array)
|
221
|
+
headline_array.unshift(total)
|
96
222
|
end
|
97
223
|
|
98
|
-
def
|
99
|
-
|
100
|
-
|
101
|
-
|
102
|
-
|
103
|
-
|
104
|
-
|
105
|
-
|
106
|
-
end
|
107
|
-
@out.puts li(a_name(path, escape_html(label)))
|
108
|
-
return unless print?(2)
|
109
|
-
if print?(3)
|
110
|
-
@out.puts chap_sections_to_s(chap_node)
|
111
|
-
else
|
112
|
-
@out.puts chapter_to_s(chap_node)
|
224
|
+
def calc_line_wrapping(line, mode:)
|
225
|
+
return 1 if line.size == 0
|
226
|
+
|
227
|
+
case mode
|
228
|
+
when :list
|
229
|
+
(calc_linesize(line) - 1) / @book.page_metric.list.n_columns + 1
|
230
|
+
else # mode == :text
|
231
|
+
(calc_linesize(line) - 1) / @book.page_metric.text.n_columns + 1
|
113
232
|
end
|
114
233
|
end
|
115
234
|
|
116
|
-
|
235
|
+
def calc_total_count(name, headline_array)
|
236
|
+
total = Counter.new(name: name,
|
237
|
+
lines: 0,
|
238
|
+
chars: 0,
|
239
|
+
list_lines: 0,
|
240
|
+
text_lines: 0)
|
117
241
|
|
118
|
-
|
119
|
-
|
120
|
-
res = []
|
121
|
-
res << '<ol>'
|
122
|
-
chap.each_section { |sec| res << li(escape_html(sec.label)) }
|
123
|
-
res << '</ol>'
|
124
|
-
res.join("\n")
|
125
|
-
end
|
242
|
+
headline_array.each do |h|
|
243
|
+
next unless h.lines
|
126
244
|
|
127
|
-
|
128
|
-
|
129
|
-
|
130
|
-
|
131
|
-
next unless print?(4)
|
132
|
-
next unless sec.section_size > 0
|
133
|
-
res << '<ul>'
|
134
|
-
sec.each_section { |node| res << li(escape_html(node.label)) }
|
135
|
-
res << '</ul>'
|
245
|
+
total.lines += h.lines
|
246
|
+
total.chars += h.chars
|
247
|
+
total.list_lines += h.list_lines
|
248
|
+
total.text_lines += h.text_lines
|
136
249
|
end
|
137
|
-
|
250
|
+
|
251
|
+
total
|
138
252
|
end
|
139
253
|
|
140
|
-
def
|
141
|
-
|
254
|
+
def build_chap(chap)
|
255
|
+
compiler = ReVIEW::Compiler.new(ReVIEW::PLAINTEXTTocBuilder.new)
|
256
|
+
begin
|
257
|
+
compiler.compile(@book.chapter(chap.name))
|
258
|
+
rescue ReVIEW::ApplicationError => e
|
259
|
+
@logger.error e.message
|
260
|
+
exit 1
|
261
|
+
end
|
142
262
|
end
|
143
263
|
|
144
|
-
def
|
145
|
-
|
264
|
+
def parse_options(args)
|
265
|
+
opts = OptionParser.new
|
266
|
+
opts.version = ReVIEW::VERSION
|
267
|
+
opts.on('--yaml=YAML', 'Read configurations from YAML file.') { |yaml| @yamlfile = yaml }
|
268
|
+
opts.on('-y', '--only file1,file2,...', 'list only specified files.') do |v|
|
269
|
+
@buildonly = v.split(/\s*,\s*/).map { |m| m.strip.sub(/\.re\Z/, '') }
|
270
|
+
end
|
271
|
+
opts.on('-l', '--level N', 'list upto N level (default=4)') do |n|
|
272
|
+
@upper = n.to_i
|
273
|
+
end
|
274
|
+
opts.on('-d', '--detail', 'show characters and lines of each section.') do
|
275
|
+
@detail = true
|
276
|
+
end
|
277
|
+
opts.on('--noindent', "don't indent headlines.") do
|
278
|
+
@indent = nil
|
279
|
+
end
|
280
|
+
opts.on('--help', 'print this message and quit.') do
|
281
|
+
puts opts.help
|
282
|
+
exit 0
|
283
|
+
end
|
284
|
+
begin
|
285
|
+
opts.parse!(args)
|
286
|
+
rescue OptionParser::ParseError => e
|
287
|
+
@logger.error e.message
|
288
|
+
$stderr.puts opts.help
|
289
|
+
exit 1
|
290
|
+
end
|
146
291
|
end
|
147
292
|
end
|
148
293
|
end
|