Class: ReVIEW::PDFMaker

Inherits:
Object show all
Includes:
CallHook, LaTeXUtils, Loggable
Defined in:
lib/review/pdfmaker.rb

Instance Attribute Summary collapse

Attributes included from Loggable

#logger

Class Method Summary collapse

Instance Method Summary collapse

Methods included from CallHook

#call_hook

Methods included from Loggable

#app_error, #debug, #error, #error!, #warn

Methods included from LaTeXUtils

#escape, #escape_index, #escape_mendex_display, #escape_mendex_key, #escape_url, #initialize_metachars, #macro, #unescape

Constructor Details

#initialize ⇒ PDFMaker

Returns a new instance of PDFMaker.



37
38
39
40
41
42
43
 
# File 'lib/review/pdfmaker.rb', line 37

def initialize
  @basedir = nil
  @logger = ReVIEW.logger
  @input_files = Hash.new { |h, key| h[key] = '' }
  @mastertex = '__REVIEW_BOOK__'
  @compile_errors = nil
end

Instance Attribute Details

#basedir ⇒ Object

Returns the value of attribute basedir.



35
36
37
 
# File 'lib/review/pdfmaker.rb', line 35

def basedir
  @basedir
end

#config ⇒ Object

Returns the value of attribute config.



35
36
37
 
# File 'lib/review/pdfmaker.rb', line 35

def config
  @config
end

Class Method Details

.execute(*args) ⇒ Object 



92
93
94
 
# File 'lib/review/pdfmaker.rb', line 92

def self.execute(*args)
  self.new.execute(*args)
end

Instance Method Details

#build_path ⇒ Object 



69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/review/pdfmaker.rb', line 69

def build_path
  if @config['debug']
    path = "#{@config['bookname']}-pdf"
    if File.exist?(path)
      FileUtils.rm_rf(path, secure: true)
    end
    Dir.mkdir(path)
    path
  else
    Dir.mktmpdir("#{@config['bookname']}-pdf-")
  end
end

#build_pdf ⇒ Object 



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/review/pdfmaker.rb', line 193

def build_pdf
  template = template_content
  Dir.chdir(@path) do
    File.open("./#{@mastertex}.tex", 'wb') { |f| f.write template }

    call_hook('hook_beforetexcompile', Dir.pwd, @basedir, base_dir: @basedir)

    ## do compile
    if ENV['REVIEW_SAFE_MODE'].to_i & 4 > 0
      warn 'command configuration is prohibited in safe mode. ignored.'
      texcommand = ReVIEW::Configure.values['texcommand']
      dvicommand = ReVIEW::Configure.values['dvicommand']
      dvioptions = ReVIEW::Configure.values['dvioptions'].shellsplit
      texoptions = ReVIEW::Configure.values['texoptions'].shellsplit
      makeindex_command = ReVIEW::Configure.values['pdfmaker']['makeindex_command']
      makeindex_options = ReVIEW::Configure.values['pdfmaker']['makeindex_options'].shellsplit
      makeindex_sty = ReVIEW::Configure.values['pdfmaker']['makeindex_sty']
      makeindex_dic = ReVIEW::Configure.values['pdfmaker']['makeindex_dic']
    else
      unless @config['texcommand'].present?
        error! "texcommand isn't defined."
      end
      texcommand = @config['texcommand']
      dvicommand = @config['dvicommand']
      @config['dvioptions'] = '' unless @config['dvioptions']
      dvioptions = @config['dvioptions'].shellsplit
      @config['texoptions'] = '' unless @config['texoptions']
      texoptions = @config['texoptions'].shellsplit
      makeindex_command = @config['pdfmaker']['makeindex_command']
      @config['pdfmaker']['makeindex_options'] = '' unless @config['pdfmaker']['makeindex_options']
      makeindex_options = @config['pdfmaker']['makeindex_options'].shellsplit
      makeindex_sty = @config['pdfmaker']['makeindex_sty']
      makeindex_dic = @config['pdfmaker']['makeindex_dic']
    end

    if makeindex_sty.present?
      makeindex_sty = File.absolute_path(makeindex_sty, @basedir)
      makeindex_options += ['-s', makeindex_sty] if File.exist?(makeindex_sty)
    end
    if makeindex_dic.present?
      makeindex_dic = File.absolute_path(makeindex_dic, @basedir)
      makeindex_options += ['-d', makeindex_dic] if File.exist?(makeindex_dic)
    end

    2.times do
      system_or_raise(*[texcommand, texoptions, "#{@mastertex}.tex"].flatten.compact)
    end

    call_hook('hook_beforemakeindex', Dir.pwd, @basedir, base_dir: @basedir)
    if @config['pdfmaker']['makeindex'] && File.size?("#{@mastertex}.idx")
      system_or_raise(*[makeindex_command, makeindex_options, @mastertex].flatten.compact)
      call_hook('hook_aftermakeindex', Dir.pwd, @basedir, base_dir: @basedir)
      system_or_raise(*[texcommand, texoptions, "#{@mastertex}.tex"].flatten.compact)
    end

    system_or_raise(*[texcommand, texoptions, "#{@mastertex}.tex"].flatten.compact)
    call_hook('hook_aftertexcompile', Dir.pwd, @basedir, base_dir: @basedir)

    if File.exist?("#{@mastertex}.dvi") && dvicommand.present?
      system_or_raise(*[dvicommand, dvioptions, "#{@mastertex}.dvi"].flatten.compact)
      call_hook('hook_afterdvipdf', Dir.pwd, @basedir, base_dir: @basedir)
    end
  end
end

#check_compile_status(ignore_errors) ⇒ Object 



82
83
84
85
86
87
88
89
90
 
# File 'lib/review/pdfmaker.rb', line 82

def check_compile_status(ignore_errors)
  return unless @compile_errors

  if ignore_errors
    @logger.info 'compile error, but try to generate PDF file'
  else
    error! 'compile error, No PDF file output.'
  end
end

#copy_images(from, to) ⇒ Object

PDFMaker#copy_images should copy image files



309
310
311
312
313
314
315
316
317
318
 
# File 'lib/review/pdfmaker.rb', line 309

def copy_images(from, to)
  return unless File.exist?(from)

  Dir.mkdir(to)
  if @config['pdfmaker']['use_symlink']
    ReVIEW::MakerHelper.copy_images_to_dir(from, to, use_symlink: true)
  else
    ReVIEW::MakerHelper.copy_images_to_dir(from, to)
  end
end

#copy_sty(dirname, copybase, extname = 'sty') ⇒ Object 



506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
 
# File 'lib/review/pdfmaker.rb', line 506

def copy_sty(dirname, copybase, extname = 'sty')
  unless File.directory?(dirname)
    warn "No such directory - #{dirname}"
    return
  end

  Dir.open(dirname) do |dir|
    dir.sort.each do |fname|
      next unless File.extname(fname).downcase == '.' + extname

      FileUtils.mkdir_p(copybase) unless Dir.exist?(copybase)
      if extname == 'erb'
        File.open(File.join(copybase, fname.sub(/\.erb\Z/, '')), 'w') do |f|
          f.print erb_content(File.join(dirname, fname))
        end
      elsif @config['pdfmaker']['use_symlink']
        FileUtils.ln_s(File.join(dirname, fname), copybase)
      else
        FileUtils.cp(File.join(dirname, fname), copybase)
      end
    end
  end
end

#date_to_s(date) ⇒ Object 



397
398
399
400
401
 
# File 'lib/review/pdfmaker.rb', line 397

def date_to_s(date)
  require 'date'
  d = Date.parse(date)
  d.strftime(ReVIEW::I18n.t('date_format'))
end

#erb_config ⇒ Object 



403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'lib/review/pdfmaker.rb', line 403

def erb_config
  @texcompiler = File.basename(@config['texcommand'], '.*')
  dclass = @config['texdocumentclass'] || []
  @documentclass = dclass[0] || 'review-jsbook'
  @documentclassoption = dclass[1] || ''
  if @config['dvicommand'] =~ /dvipdfmx/ && @documentclassoption !~ /dvipdfmx/
    @documentclassoption = "dvipdfmx,#{@documentclassoption}".sub(/,\Z/, '')
  end

  @okuduke = make_colophon
  @authors = make_authors

  @custom_coverpage = make_custom_page(@config['cover']) || make_custom_page(@config['coverfile'])
  @custom_titlepage = make_custom_page(@config['titlefile'])
  @custom_originaltitlepage = make_custom_page(@config['originaltitlefile'])
  @custom_creditpage = make_custom_page(@config['creditfile'])

  @custom_profilepage = make_custom_page(@config['profile'])
  @custom_advfilepage = make_custom_page(@config['advfile'])
  if @config['colophon'] && @config['colophon'].is_a?(String)
    @custom_colophonpage = make_custom_page(@config['colophon'])
  end
  @custom_backcoverpage = make_custom_page(@config['backcover'])

  if @config['pubhistory']
    warn 'pubhistory is oboleted. use history.'
  else
    @config['pubhistory'] = make_history_list.join("\n")
  end

  @coverimageoption =
    if @documentclass == 'ubook' || @documentclass == 'utbook'
      'keepaspectratio,angle=90'
    else
      'keepaspectratio'
    end

  if @config.check_version('2', exception: false)
    @coverimageoption =
      if @documentclass == 'ubook' || @documentclass == 'utbook'
        'width=\\textheight,height=\\textwidth,keepaspectratio,angle=90'
      else
        'width=\\textwidth,height=\\textheight,keepaspectratio'
      end
  end

  if @config['coverimage'] && !File.exist?(File.join(@config['imagedir'], @config['coverimage']))
    raise ReVIEW::ConfigError, "coverimage #{@config['coverimage']} is not found."
  end

  @locale_latex = {}
  part_tuple = I18n.get('part').split(/%[A-Za-z]{1,3}/, 2)
  chapter_tuple = I18n.get('chapter').split(/%[A-Za-z]{1,3}/, 2)
  appendix_tuple = I18n.get('appendix').split(/%[A-Za-z]{1,3}/, 2)
  @locale_latex['prepartname'] = part_tuple[0].to_s
  @locale_latex['postpartname'] = part_tuple[1].to_s
  @locale_latex['prechaptername'] = chapter_tuple[0].to_s
  @locale_latex['postchaptername'] = chapter_tuple[1].to_s
  @locale_latex['preappendixname'] = appendix_tuple[0].to_s
  @locale_latex['postappendixname'] = appendix_tuple[1].to_s

  if @config['pdfmaker']['boxsetting']
    begin
      @boxsetting = ReVIEW::LaTeXBox.new.tcbox(@config)
    rescue ReVIEW::ConfigError => e
      error! e
    end
  end
end

#execute(*args) ⇒ Object 



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/review/pdfmaker.rb', line 120

def execute(*args)
  cmd_config, yamlfile = parse_opts(args)
  error! "#{yamlfile} not found." unless File.exist?(yamlfile)

  @config = ReVIEW::Configure.create(maker: 'pdfmaker',
                                     yamlfile: yamlfile,
                                     config: cmd_config)

  I18n.setup(@config['language'])
  @basedir = File.absolute_path(File.dirname(yamlfile))

  begin
    @config.check_version(ReVIEW::VERSION)
  rescue ReVIEW::ConfigError => e
    warn e.message
  end

  # version 2 compatibility
  unless @config['texdocumentclass']
    if @config.check_version(2, exception: false)
      @config['texdocumentclass'] = ['jsbook', 'uplatex,oneside']
    else
      @config['texdocumentclass'] = @config['_texdocumentclass']
    end
  end

  begin
    generate_pdf
  rescue ApplicationError => e
    raise if @config['debug']

    error! e.message
  end
end

#generate_pdf ⇒ Object 



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/review/pdfmaker.rb', line 258

def generate_pdf
  remove_old_file
  @path = build_path
  begin
    @compile_errors = nil

    book = ReVIEW::Book::Base.new(@basedir, config: @config)
    @converter = ReVIEW::Converter.new(book, ReVIEW::LATEXBuilder.new)
    erb_config

    @input_files = make_input_files(book)

    check_compile_status(@config['ignore-errors'])

    # for backward compatibility
    @config['usepackage'] = ''
    @config['usepackage'] = "\\usepackage{#{@config['texstyle']}}" if @config['texstyle']

    if @config['pdfmaker']['use_symlink']
      logger.info 'use symlink'
    end
    copy_images(@config['imagedir'], File.join(@path, @config['imagedir']))
    copy_sty(File.join(Dir.pwd, 'sty'), @path)
    copy_sty(File.join(Dir.pwd, 'sty'), @path, 'fd')
    copy_sty(File.join(Dir.pwd, 'sty'), @path, 'cls')
    copy_sty(File.join(Dir.pwd, 'sty'), @path, 'erb')
    copy_sty(File.join(Dir.pwd, 'sty'), @path, 'tex')
    copy_sty(Dir.pwd, @path, 'tex')

    build_pdf

    FileUtils.cp(File.join(@path, "#{@mastertex}.pdf"), pdf_filepath)
    @logger.success("built #{File.basename(pdf_filepath)}")
  ensure
    FileUtils.remove_entry_secure(@path) unless @config['debug']
  end
end

#join_with_separator(value, sep) ⇒ Object 



333
334
335
336
337
338
339
 
# File 'lib/review/pdfmaker.rb', line 333

def join_with_separator(value, sep)
  if value.is_a?(Array)
    value.join(sep)
  else
    value
  end
end

#latex_config ⇒ Object 



473
474
475
476
477
478
479
480
481
482
 
# File 'lib/review/pdfmaker.rb', line 473

def latex_config
  result = ReVIEW::Template.generate(path: './latex/config.erb', mode: '-', binding: binding)
  local_config_file = File.join(@basedir, 'layouts', 'config-local.tex.erb')
  if File.exist?(local_config_file)
    result << "%% BEGIN: config-local.tex.erb\n"
    result << ReVIEW::Template.generate(path: 'layouts/config-local.tex.erb', mode: '-', binding: binding, template_dir: @basedir)
    result << "%% END: config-local.tex.erb\n"
  end
  result
end

#make_authors ⇒ Object 



356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/review/pdfmaker.rb', line 356

def make_authors
  authors = ''
  if @config['aut'].present?
    author_names = join_with_separator(@config.names_of('aut').map { |s| escape_latex(s) }, ReVIEW::I18n.t('names_splitter'))
    authors = ReVIEW::I18n.t('author_with_label', author_names)
  end
  if @config['csl'].present?
    csl_names = join_with_separator(@config.names_of('csl').map { |s| escape_latex(s) }, ReVIEW::I18n.t('names_splitter'))
    authors += " \\\\\n" + ReVIEW::I18n.t('supervisor_with_label', csl_names)
  end
  if @config['trl'].present?
    trl_names = join_with_separator(@config.names_of('trl').map { |s| escape_latex(s) }, ReVIEW::I18n.t('names_splitter'))
    authors += " \\\\\n" + ReVIEW::I18n.t('translator_with_label', trl_names)
  end
  authors
end

#make_colophon ⇒ Object 



350
351
352
353
354
 
# File 'lib/review/pdfmaker.rb', line 350

def make_colophon
  colophon = ''
  @config['colophon_order'].each { |role| colophon += make_colophon_role(role) }
  colophon
end

#make_colophon_role(role) ⇒ Object 



341
342
343
344
345
346
347
348
 
# File 'lib/review/pdfmaker.rb', line 341

def make_colophon_role(role)
  if @config[role].present?
    initialize_metachars(@config['texcommand'])
    "#{ReVIEW::I18n.t(role)} & #{escape_latex(join_with_separator(@config.names_of(role), ReVIEW::I18n.t('names_splitter')))} \\\\\n"
  else
    ''
  end
end

#make_custom_page(file) ⇒ Object 



320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/review/pdfmaker.rb', line 320

def make_custom_page(file)
  if file.nil?
    return nil
  end

  file_sty = file.to_s.sub(/\.[^.]+\Z/, '.tex')
  if File.exist?(file_sty)
    File.read(file_sty)
  else
    warn "File #{file_sty} is not found."
  end
end

#make_history_list ⇒ Object 



373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/review/pdfmaker.rb', line 373

def make_history_list
  buf = []
  if @config['history']
    @config['history'].each_with_index do |items, edit|
      items.each_with_index do |item, rev|
        editstr = edit == 0 ? ReVIEW::I18n.t('first_edition') : ReVIEW::I18n.t('nth_edition', (edit + 1).to_s)
        revstr = ReVIEW::I18n.t('nth_impression', (rev + 1).to_s)
        if item =~ /\A\d+-\d+-\d+\Z/
          buf << ReVIEW::I18n.t('published_by1', [date_to_s(item), editstr + revstr])
        elsif item =~ /\A(\d+-\d+-\d+)[\s　](.+)/
          # custom date with string
          item.match(/\A(\d+-\d+-\d+)[\s　](.+)/) { |m| buf << ReVIEW::I18n.t('published_by3', [date_to_s(m[1]), m[2]]) }
        else
          # free format
          buf << item
        end
      end
    end
  elsif @config['date']
    buf << ReVIEW::I18n.t('published_by2', date_to_s(@config['date']))
  end
  buf
end

#make_input_files(book) ⇒ Object 



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/review/pdfmaker.rb', line 155

def make_input_files(book)
  input_files = Hash.new { |h, key| h[key] = '' }
  book.parts.each do |part|
    if part.name.present?
      @config['use_part'] = true
      if part.file?
        if @buildonly && !@buildonly.include?(part.name)
          warn "skip #{part.name}.re"
          input_files['CHAPS'] << %Q(\\part{}\n)
        else
          output_chaps(part.name)
          input_files['CHAPS'] << %Q(\\input{#{part.name}.tex}\n)
        end
      else
        input_files['CHAPS'] << %Q(\\part{#{part.name}}\n)
      end
    end

    part.chapters.each do |chap|
      filename = File.basename(chap.path, '.*')
      entry = "\\input{#{filename}.tex}\n"
      if @buildonly && !@buildonly.include?(filename)
        warn "skip #{filename}.re"
        entry = "\\chapter{}\n"
      else
        output_chaps(filename)
      end

      input_files['PREDEF'] << entry if chap.on_predef?
      input_files['CHAPS'] << entry if chap.on_chaps?
      input_files['APPENDIX'] << entry if chap.on_appendix?
      input_files['POSTDEF'] << entry if chap.on_postdef?
    end
  end

  input_files
end

#output_chaps(filename) ⇒ Object 



296
297
298
299
300
301
302
303
304
305
 
# File 'lib/review/pdfmaker.rb', line 296

def output_chaps(filename)
  @logger.info "compiling #{filename}.tex"
  begin
    @converter.convert(filename + '.re', File.join(@path, filename + '.tex'))
  rescue => e
    @compile_errors = true
    error "compile error in #{filename}.tex (#{e.class})"
    error e.message
  end
end

#parse_opts(args) ⇒ Object 



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/review/pdfmaker.rb', line 96

def parse_opts(args)
  cmd_config = {}
  opts = OptionParser.new
  @buildonly = nil

  opts.banner = 'Usage: review-pdfmaker configfile'
  opts.version = ReVIEW::VERSION
  opts.on('--help', 'Prints this message and quit.') do
    puts opts.help
    exit 0
  end
  opts.on('--[no-]debug', 'Keep temporary files.') { |debug| cmd_config['debug'] = debug }
  opts.on('--ignore-errors', 'Ignore review-compile errors.') { cmd_config['ignore-errors'] = true }
  opts.on('-y', '--only file1,file2,...', 'Build only specified files.') { |v| @buildonly = v.split(/\s*,\s*/).map { |m| m.strip.sub(/\.re\Z/, '') } }

  opts.parse!(args)
  if args.size != 1
    puts opts.help
    exit 0
  end

  [cmd_config, args[0]]
end

#pdf_filepath ⇒ Object 



61
62
63
 
# File 'lib/review/pdfmaker.rb', line 61

def pdf_filepath
  File.join(@basedir, @config['bookname'] + '.pdf')
end

#remove_old_file ⇒ Object 



65
66
67
 
# File 'lib/review/pdfmaker.rb', line 65

def remove_old_file
  FileUtils.rm_f(pdf_filepath)
end

#system_or_raise(*args) ⇒ Object 



53
54
55
56
57
58
59
 
# File 'lib/review/pdfmaker.rb', line 53

def system_or_raise(*args)
  @logger.info args.join(' ')
  out, status = Open3.capture2e(*args)
  unless status.success?
    error! "failed to run command: #{args.join(' ')}\n\nError log:\n#{out}"
  end
end

#system_with_info(*args) ⇒ Object 



45
46
47
48
49
50
51
 
# File 'lib/review/pdfmaker.rb', line 45

def system_with_info(*args)
  @logger.info args.join(' ')
  out, status = Open3.capture2e(*args)
  unless status.success?
    error "execution error\n\nError log:\n#{out}"
  end
end

#template_content ⇒ Object 



484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
 
# File 'lib/review/pdfmaker.rb', line 484

def template_content
  template_dir = ReVIEW::Template::TEMPLATE_DIR
  if @config.check_version('2', exception: false)
    template_path = './latex-compat2/layout.tex.erb'
  else
    template_path = './latex/layout.tex.erb'
  end
  layout_file = File.join(@basedir, 'layouts', 'layout.tex.erb')
  if File.exist?(layout_file)
    template_dir = @basedir
    template_path = 'layouts/layout.tex.erb'
  end
  ReVIEW::Template.generate(path: template_path, mode: '-', binding: binding, template_dir: template_dir)
rescue => e
  if defined?(e.full_message)
    error! "template or configuration error: #{e.full_message(highlight: false)}"
  else
    # <= Ruby 2.4
    error! "template or configuration error: #{e.message}"
  end
end