Class: ReVIEW::Builder

Inherits:
Object show all
Includes:
Loggable, TextUtils
Defined in:
lib/review/builder.rb

Constant Summary collapse

CAPTION_TITLES = 
Compiler.minicolumn_names

Instance Attribute Summary collapse

Attributes included from Loggable

#logger

Instance Method Summary collapse

Methods included from Loggable

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

Methods included from TextUtils

#add_space?, #join_lines_to_paragraph, #split_paragraph

Constructor Details

#initialize(strict = false, *_args, img_math: nil, img_graph: nil) ⇒ Builder

Returns a new instance of Builder.



39
40
41
42
43
44
45
46
47
48
 
# File 'lib/review/builder.rb', line 39

def initialize(strict = false, *_args, img_math: nil, img_graph: nil)
  @strict = strict
  @output = nil
  @logger = ReVIEW.logger
  @doc_status = {}
  @dictionary = {}
  @img_math = img_math
  @img_graph = img_graph
  @shown_endnotes = true
end

Instance Attribute Details

#doc_status ⇒ Object

Returns the value of attribute doc_status.



36
37
38
 
# File 'lib/review/builder.rb', line 36

def doc_status
  @doc_status
end

#location ⇒ Object (readonly)

Returns the value of attribute location.



37
38
39
 
# File 'lib/review/builder.rb', line 37

def location
  @location
end

Instance Method Details

#beginchild ⇒ Object 



792
793
794
795
796
797
798
799
 
# File 'lib/review/builder.rb', line 792

def beginchild
  @children ||= []
  unless previous_list_type
    app_error "#{@location}: //beginchild is shown, but previous element isn't ul, ol, or dl"
  end
  puts "\x01→#{previous_list_type}←\x01"
  @children.push(previous_list_type)
end

#bibpaper(lines, id, caption) ⇒ Object 



434
435
436
437
438
439
440
441
 
# File 'lib/review/builder.rb', line 434

def bibpaper(lines, id, caption)
  bibpaper_header(id, caption)
  unless lines.empty?
    puts
    bibpaper_bibpaper(id, caption, lines)
  end
  puts
end

#bind(compiler, chapter, location) ⇒ Object 



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/review/builder.rb', line 50

def bind(compiler, chapter, location)
  @compiler = compiler
  @chapter = chapter
  @location = location
  @output = StringIO.new
  if @chapter.present?
    @book = @chapter.book
  end
  @chapter.generate_indexes
  if @book
    @book.generate_indexes
  end
  @tabwidth = nil
  @tsize = nil
  if @book && @book.config
    @img_math ||= ReVIEW::ImgMath.new(@book.config)
    @img_graph ||= ReVIEW::ImgGraph.new(@book.config, target_name)
    if words_file_path = @book.config['words_file']
      words_files = if words_file_path.is_a?(String)
                      [words_file_path]
                    else
                      words_file_path
                    end
      words_files.each do |f|
        load_words(f)
      end
    end
    if @book.config['tabwidth']
      @tabwidth = @book.config['tabwidth']
    end

    if @book.config['join_lines_by_lang']
      begin
        require 'unicode/eaw'
      rescue LoadError
        warn 'not found unicode/eaw. disabled join_lines_by_lang feature.', location: @location
        @book.config['join_lines_by_lang'] = nil
      end
    end
  end
  builder_init_file
end

#blankline ⇒ Object 



309
310
311
 
# File 'lib/review/builder.rb', line 309

def blankline
  puts ''
end

#caption_top?(type) ⇒ Boolean

Returns:

  • (Boolean) 


809
810
811
812
813
814
 
# File 'lib/review/builder.rb', line 809

def caption_top?(type)
  unless %w[top bottom].include?(@book.config['caption_position'][type])
    warn "invalid caption_position/#{type} parameter. 'top' is assumed", location: @location
  end
  @book.config['caption_position'][type] != 'bottom'
end

#captionblock(_type, _lines, _caption, _specialstyle = nil) ⇒ Object

Raises:

  • (NotImplementedError) 


591
592
593
 
# File 'lib/review/builder.rb', line 591

def captionblock(_type, _lines, _caption, _specialstyle = nil)
  raise NotImplementedError
end

#check_nest ⇒ Object 



108
109
110
111
112
 
# File 'lib/review/builder.rb', line 108

def check_nest
  if @children && !@children.empty?
    app_error "#{@location}: //beginchild of #{@children.reverse.join(',')} misses //endchild"
  end
end

#check_nested_minicolumn ⇒ Object 



616
617
618
619
620
 
# File 'lib/review/builder.rb', line 616

def check_nested_minicolumn
  if @doc_status[:minicolumn]
    app_error "#{@location}: nested mini-column is not allowed"
  end
end

#check_printendnotes ⇒ Object 



114
115
116
117
118
 
# File 'lib/review/builder.rb', line 114

def check_printendnotes
  if @shown_endnotes.nil?
    app_error "#{@location}: //endnote is found but //printendnotes is not found."
  end
end

#compile_inline(s) ⇒ Object 



313
314
315
 
# File 'lib/review/builder.rb', line 313

def compile_inline(s)
  @compiler.text(s)
end

#detab(str, num = nil) ⇒ Object

override TextUtils::detab



774
775
776
777
778
779
780
781
782
 
# File 'lib/review/builder.rb', line 774

def detab(str, num = nil)
  if num
    super(str, num)
  elsif @tabwidth
    super(str, @tabwidth)
  else
    super(str)
  end
end

#embed(lines, arg = nil) ⇒ Object 



534
535
536
537
538
539
540
541
542
 
# File 'lib/review/builder.rb', line 534

def embed(lines, arg = nil)
  if arg
    builders = arg.gsub(/^\s*\|/, '').gsub(/\|\s*$/, '').gsub(/\s/, '').split(',')
    c = target_name
    print lines.join("\n") + "\n" if builders.include?(c)
  else
    print lines.join("\n") + "\n"
  end
end

#emtable(lines, caption = nil) ⇒ Object 



282
283
284
 
# File 'lib/review/builder.rb', line 282

def emtable(lines, caption = nil)
  table(lines, nil, caption)
end

#endchild ⇒ Object 



801
802
803
804
805
806
807
 
# File 'lib/review/builder.rb', line 801

def endchild
  if @children.nil? || @children.empty?
    app_error "#{@location}: //endchild is shown, but any opened //beginchild doesn't exist"
  else
    puts "\x01→/#{@children.pop}←\x01"
  end
end

#endnote(_id, _str) ⇒ Object 



295
296
297
 
# File 'lib/review/builder.rb', line 295

def endnote(_id, _str)
  @shown_endnotes = nil
end

#endnote_begin ⇒ Object 



299
300
 
# File 'lib/review/builder.rb', line 299

def endnote_begin
end

#endnote_end ⇒ Object 



302
303
 
# File 'lib/review/builder.rb', line 302

def endnote_end
end

#endnote_item(id) ⇒ Object 



305
306
307
 
# File 'lib/review/builder.rb', line 305

def endnote_item(id)
  puts "(#{@chapter.endnote(id).number}) #{compile_inline(@chapter.endnote(id).content)}"
end

#escape(str) ⇒ Object 



784
785
786
 
# File 'lib/review/builder.rb', line 784

def escape(str)
  str
end

#extract_chapter_id(chap_ref) ⇒ Object 



580
581
582
583
584
585
586
587
588
589
 
# File 'lib/review/builder.rb', line 580

def extract_chapter_id(chap_ref)
  m = /\A([\w+-]+)\|(.+)/.match(chap_ref)
  if m
    ch = @book.contents.detect { |chap| chap.id == m[1] }
    raise KeyError unless ch

    return [ch, m[2]]
  end
  [@chapter, chap_ref]
end

#firstlinenum(num) ⇒ Object

for //firstlinenum



156
157
158
 
# File 'lib/review/builder.rb', line 156

def firstlinenum(num)
  @first_line_num = num.to_i
end

#get_chap(chapter = @chapter) ⇒ Object 



569
570
571
572
573
574
575
576
577
578
 
# File 'lib/review/builder.rb', line 569

def get_chap(chapter = @chapter)
  if @book.config['secnolevel'] > 0 && !chapter.number.nil? && !chapter.number.to_s.empty?
    if chapter.is_a?(ReVIEW::Book::Part)
      return I18n.t('part_short', chapter.number)
    else
      return chapter.format_number(nil)
    end
  end
  nil
end

#graph(lines, id, command, caption = '') ⇒ Object 



630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
 
# File 'lib/review/builder.rb', line 630

def graph(lines, id, command, caption = '')
  c = target_name
  dir = File.join(@book.imagedir, c)
  FileUtils.mkdir_p(dir)
  file = "#{id}.#{image_ext}"
  file_path = File.join(dir, file)

  content = lines.join("\n") + "\n"

  tf = Tempfile.new('review_graph')
  tf.puts content
  tf.close
  begin
    file_path = send("graph_#{command}".to_sym, id, file_path, content, tf.path)
  ensure
    tf.unlink
  end
  @chapter.image_index.image_finder.add_entry(file_path)

  image(lines, id, caption)
end

#graph_aafigure(id, file_path, _line, tf_path) ⇒ Object 



679
680
681
682
 
# File 'lib/review/builder.rb', line 679

def graph_aafigure(id, file_path, _line, tf_path)
  system_graph(id, 'aafigure', '-t', image_ext, '-o', file_path, tf_path)
  file_path
end

#graph_blockdiag(id, file_path, _line, tf_path) ⇒ Object 



674
675
676
677
 
# File 'lib/review/builder.rb', line 674

def graph_blockdiag(id, file_path, _line, tf_path)
  system_graph(id, 'blockdiag', '-a', '-T', image_ext, '-o', file_path, tf_path)
  file_path
end

#graph_gnuplot(id, file_path, line, tf_path) ⇒ Object 



662
663
664
665
666
667
668
669
670
671
672
 
# File 'lib/review/builder.rb', line 662

def graph_gnuplot(id, file_path, line, tf_path)
  File.open(tf_path, 'w') do |tf|
    tf.puts <<EOTGNUPLOT
set terminal #{image_ext == 'eps' ? 'postscript eps' : image_ext}
set output "#{file_path}"
#{line}
EOTGNUPLOT
  end
  system_graph(id, 'gnuplot', tf_path)
  file_path
end

#graph_graphviz(id, file_path, _line, tf_path) ⇒ Object 



657
658
659
660
 
# File 'lib/review/builder.rb', line 657

def graph_graphviz(id, file_path, _line, tf_path)
  system_graph(id, 'dot', "-T#{image_ext}", "-o#{file_path}", tf_path)
  file_path
end

#graph_mermaid(id, _file_path, _line, tf_path) ⇒ Object 



705
706
707
708
709
710
711
712
713
 
# File 'lib/review/builder.rb', line 705

def graph_mermaid(id, _file_path, _line, tf_path)
  begin
    require 'playwrightrunner'
  rescue LoadError
    app_error "#{@location}: could not handle Mermaid of //graph in this builder."
  end

  @img_graph.defer_mermaid_image(File.read(tf_path), id)
end

#graph_plantuml(id, file_path, _line, tf_path) ⇒ Object 



684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
 
# File 'lib/review/builder.rb', line 684

def graph_plantuml(id, file_path, _line, tf_path)
  ext = image_ext
  if ext == 'pdf'
    ext = 'eps'
    file_path.sub!(/\.pdf\Z/, '.eps')
  end
  plant_path = nil
  if File.exist?('plantuml.jar')
    plant_path = 'plantuml.jar'
  elsif File.exist?('/usr/share/plantuml/plantuml.jar')
    plant_path = '/usr/share/plantuml/plantuml.jar'
  elsif File.exist?('/usr/share/java/plantuml.jar')
    plant_path = '/usr/share/java/plantuml.jar'
  else
    error!('missing plantuml.jar. Please put plantuml.jar at the working folder.')
  end
  system_graph(id, 'java', '-jar', plant_path, "-t#{ext}", '-charset', 'UTF-8', tf_path)
  FileUtils.mv("#{tf_path}.#{ext}", file_path)
  file_path
end

#handle_metric(str) ⇒ Object 



544
545
546
 
# File 'lib/review/builder.rb', line 544

def handle_metric(str)
  str
end

#highlight? ⇒ Boolean

Returns:

  • (Boolean) 


99
100
101
 
# File 'lib/review/builder.rb', line 99

def highlight?
  false
end

#image(lines, id, caption, metric = nil) ⇒ Object 



195
196
197
198
199
200
201
202
 
# File 'lib/review/builder.rb', line 195

def image(lines, id, caption, metric = nil)
  if @chapter.image_bound?(id)
    image_image(id, caption, metric)
  else
    warn "image not bound: #{id}", location: @location if @strict
    image_dummy(id, caption, lines)
  end
end

#image_ext ⇒ Object

Raises:

  • (NotImplementedError) 


715
716
717
 
# File 'lib/review/builder.rb', line 715

def image_ext
  raise NotImplementedError
end

#in_minicolumn? ⇒ Boolean

Returns:

  • (Boolean) 


622
623
624
 
# File 'lib/review/builder.rb', line 622

def in_minicolumn?
  @doc_status[:minicolumn]
end

#inline_balloon(arg) ⇒ Object 



504
505
506
 
# File 'lib/review/builder.rb', line 504

def inline_balloon(arg)
  "← #{arg}"
end

#inline_bou(str) ⇒ Object 



401
402
403
 
# File 'lib/review/builder.rb', line 401

def inline_bou(str)
  text(str)
end

#inline_chap(id) ⇒ Object 



323
324
325
326
327
 
# File 'lib/review/builder.rb', line 323

def inline_chap(id)
  @book.chapter_index.number(id)
rescue KeyError
  app_error "unknown chapter: #{id}"
end

#inline_chapref(id) ⇒ Object 



317
318
319
320
321
 
# File 'lib/review/builder.rb', line 317

def inline_chapref(id)
  compile_inline(@book.chapter_index.display_string(id))
rescue KeyError
  app_error "unknown chapter: #{id}"
end

#inline_column(id) ⇒ Object 



478
479
480
481
482
483
484
485
486
487
488
489
490
 
# File 'lib/review/builder.rb', line 478

def inline_column(id)
  m = /\A([^|]+)\|(.+)/.match(id)
  if m && m[1]
    chapter = @book.chapters.detect { |chap| chap.id == m[1] }
  end
  if chapter
    inline_column_chap(chapter, m[2])
  else
    inline_column_chap(@chapter, id)
  end
rescue KeyError
  app_error "unknown column: #{id}"
end

#inline_column_chap(chapter, id) ⇒ Object 



492
493
494
 
# File 'lib/review/builder.rb', line 492

def inline_column_chap(chapter, id)
  I18n.t('column', chapter.column(id).caption)
end

#inline_embed(args) ⇒ Object 



756
757
758
759
760
761
762
763
764
765
766
767
 
# File 'lib/review/builder.rb', line 756

def inline_embed(args)
  if matched = args.match(/\|(.*?)\|(.*)/)
    builders = matched[1].split(',').map { |i| i.gsub(/\s/, '') }
    if builders.include?(target_name)
      matched[2]
    else
      ''
    end
  else
    args
  end
end

#inline_endnote(id) ⇒ Object 



395
396
397
398
399
 
# File 'lib/review/builder.rb', line 395

def inline_endnote(id)
  "(#{@chapter.endnote(id).number})"
rescue KeyError
  app_error "unknown endnote: #{id}"
end

#inline_eq(id) ⇒ Object 



378
379
380
381
382
383
384
385
386
387
 
# File 'lib/review/builder.rb', line 378

def inline_eq(id)
  chapter, id = extract_chapter_id(id)
  if get_chap(chapter)
    %Q(#{I18n.t('equation')}#{I18n.t('format_number', [get_chap(chapter), chapter.equation(id).number])})
  else
    %Q(#{I18n.t('equation')}#{I18n.t('format_number_without_chapter', [chapter.equation(id).number])})
  end
rescue KeyError
  app_error "unknown equation: #{id}"
end

#inline_fn(id) ⇒ Object 



389
390
391
392
393
 
# File 'lib/review/builder.rb', line 389

def inline_fn(id)
  @chapter.footnote(id).content
rescue KeyError
  app_error "unknown footnote: #{id}"
end

#inline_hd(id) ⇒ Object Also known as: inline_secref 



443
444
445
446
447
448
449
450
451
452
453
454
455
 
# File 'lib/review/builder.rb', line 443

def inline_hd(id)
  m = /\A([^|]+)\|(.+)/.match(id)
  if m && m[1]
    chapter = @book.contents.detect { |chap| chap.id == m[1] }
  end
  if chapter
    inline_hd_chap(chapter, m[2])
  else
    inline_hd_chap(@chapter, id)
  end
rescue KeyError
  app_error "unknown headline: #{id}"
end

#inline_href(arg) ⇒ Object 



421
422
423
424
425
426
427
428
 
# File 'lib/review/builder.rb', line 421

def inline_href(arg)
  url, label = *arg.scan(/(?:(?:(?:\\\\)*\\,)|[^,\\]+)+/).map(&:lstrip)
  url = url.gsub(/\\,/, ',').strip
  if label
    label = label.gsub(/\\,/, ',').strip
  end
  compile_href(url, label)
end

#inline_img(id) ⇒ Object 



346
347
348
349
350
351
352
353
354
355
 
# File 'lib/review/builder.rb', line 346

def inline_img(id)
  chapter, id = extract_chapter_id(id)
  if get_chap(chapter)
    %Q(#{I18n.t('image')}#{I18n.t('format_number', [get_chap(chapter), chapter.image(id).number])})
  else
    %Q(#{I18n.t('image')}#{I18n.t('format_number_without_chapter', [chapter.image(id).number])})
  end
rescue KeyError
  app_error "unknown image: #{id}"
end

#inline_imgref(id) ⇒ Object 



357
358
359
360
361
362
363
364
365
 
# File 'lib/review/builder.rb', line 357

def inline_imgref(id)
  img = inline_img(id)

  if @chapter.image(id).caption
    "#{img}#{I18n.t('image_quote', @chapter.image(id).caption)}"
  else
    img
  end
end

#inline_include(file_name) ⇒ Object 



719
720
721
 
# File 'lib/review/builder.rb', line 719

def inline_include(file_name)
  compile_inline(File.read(file_name, mode: 'rt:BOM|utf-8').chomp)
end

#inline_kw(arg) ⇒ Object 



416
417
418
419
 
# File 'lib/review/builder.rb', line 416

def inline_kw(arg)
  word, alt = *arg.split(',', 2)
  compile_kw(word, alt)
end

#inline_list(id) ⇒ Object 



335
336
337
338
339
340
341
342
343
344
 
# File 'lib/review/builder.rb', line 335

def inline_list(id)
  chapter, id = extract_chapter_id(id)
  if get_chap(chapter)
    %Q(#{I18n.t('list')}#{I18n.t('format_number', [get_chap(chapter), chapter.list(id).number])})
  else
    %Q(#{I18n.t('list')}#{I18n.t('format_number_without_chapter', [chapter.list(id).number])})
  end
rescue KeyError
  app_error "unknown list: #{id}"
end

#inline_pageref(id) ⇒ Object 



496
497
498
 
# File 'lib/review/builder.rb', line 496

def inline_pageref(id)
  "[link:#{id}]"
end

#inline_raw(args) ⇒ Object 



742
743
744
745
746
747
748
749
750
751
752
753
754
 
# File 'lib/review/builder.rb', line 742

def inline_raw(args)
  if matched = args.match(/\|(.*?)\|(.*)/)
    builders = matched[1].split(',').map { |i| i.gsub(/\s/, '') }
    c = self.class.to_s.gsub('ReVIEW::', '').gsub('Builder', '').downcase
    if builders.include?(c)
      matched[2].gsub('\\n', "\n")
    else
      ''
    end
  else
    args.gsub('\\n', "\n")
  end
end

#inline_ruby(arg) ⇒ Object 



405
406
407
408
409
410
411
412
413
414
 
# File 'lib/review/builder.rb', line 405

def inline_ruby(arg)
  base, *ruby = *arg.scan(/(?:(?:(?:\\\\)*\\,)|[^,\\]+)+/)
  if base
    base = base.gsub(/\\,/, ',').strip
  end
  if ruby
    ruby = ruby.join(',').gsub(/\\,/, ',').strip
  end
  compile_ruby(base, ruby)
end

#inline_sec(id) ⇒ Object 



459
460
461
462
463
464
465
466
467
468
469
 
# File 'lib/review/builder.rb', line 459

def inline_sec(id)
  chapter, id = extract_chapter_id(id)
  n = chapter.headline_index.number(id)
  if n.present? && chapter.number && over_secnolevel?(n)
    n
  else
    app_error "the target headline doesn't have a number: #{id}"
  end
rescue KeyError
  app_error "unknown headline: #{id}"
end

#inline_sectitle(id) ⇒ Object 



471
472
473
474
475
476
 
# File 'lib/review/builder.rb', line 471

def inline_sectitle(id)
  chapter, id = extract_chapter_id(id)
  compile_inline(chapter.headline(id).caption)
rescue KeyError
  app_error "unknown headline: #{id}"
end

#inline_table(id) ⇒ Object 



367
368
369
370
371
372
373
374
375
376
 
# File 'lib/review/builder.rb', line 367

def inline_table(id)
  chapter, id = extract_chapter_id(id)
  if get_chap(chapter)
    %Q(#{I18n.t('table')}#{I18n.t('format_number', [get_chap(chapter), chapter.table(id).number])})
  else
    %Q(#{I18n.t('table')}#{I18n.t('format_number_without_chapter', [chapter.table(id).number])})
  end
rescue KeyError
  app_error "unknown table: #{id}"
end

#inline_tcy(arg) ⇒ Object 



500
501
502
 
# File 'lib/review/builder.rb', line 500

def inline_tcy(arg)
  "#{arg}[rotate 90 degree]"
end

#inline_title(id) ⇒ Object 



329
330
331
332
333
 
# File 'lib/review/builder.rb', line 329

def inline_title(id)
  compile_inline(@book.chapter_index.title(id))
rescue KeyError
  app_error "unknown chapter: #{id}"
end

#inline_w(s) ⇒ Object 



508
509
510
511
512
513
514
515
516
 
# File 'lib/review/builder.rb', line 508

def inline_w(s)
  translated = @dictionary[s]
  if translated
    escape(translated)
  else
    warn "word not bound: #{s}", location: @location
    escape("[missing word: #{s}]")
  end
end

#inline_wb(s) ⇒ Object 



518
519
520
 
# File 'lib/review/builder.rb', line 518

def inline_wb(s)
  inline_b(@dictionary[s] || "[missing word: #{s}]")
end

#line_num ⇒ Object 



160
161
162
163
164
165
166
167
 
# File 'lib/review/builder.rb', line 160

def line_num
  return 1 unless @first_line_num

  line_n = @first_line_num
  @first_line_num = nil

  line_n
end

#list(lines, id, caption, lang = nil) ⇒ Object 



169
170
171
172
173
174
175
176
177
 
# File 'lib/review/builder.rb', line 169

def list(lines, id, caption, lang = nil)
  begin
    list_header(id, caption, lang) if caption_top?('list')
    list_body(id, lines, lang)
    list_header(id, caption, lang) unless caption_top?('list')
  rescue KeyError
    app_error "no such list: #{id}"
  end
end

#listnum(lines, id, caption, lang = nil) ⇒ Object 



179
180
181
182
183
184
185
186
187
 
# File 'lib/review/builder.rb', line 179

def listnum(lines, id, caption, lang = nil)
  begin
    list_header(id, caption, lang) if caption_top?('list')
    listnum_body(lines, lang)
    list_header(id, caption, lang) unless caption_top?('list')
  rescue KeyError
    app_error "no such list: #{id}"
  end
end

#load_words(file) ⇒ Object 



139
140
141
142
143
144
145
 
# File 'lib/review/builder.rb', line 139

def load_words(file)
  if File.exist?(file) && /\.csv\Z/i.match?(file)
    CSV.foreach(file) do |row|
      @dictionary[row[0]] = row[1]
    end
  end
end

#minicolumn_block_name?(name) ⇒ Boolean

Returns:

  • (Boolean) 


626
627
628
 
# File 'lib/review/builder.rb', line 626

def minicolumn_block_name?(name)
  CAPTION_TITLES.include?(name)
end

#over_secnolevel?(n) ⇒ Boolean

Returns:

  • (Boolean) 


769
770
771
 
# File 'lib/review/builder.rb', line 769

def over_secnolevel?(n)
  @book.config['secnolevel'] >= n.to_s.split('.').size
end

#parse_metric(type, metric) ⇒ Object 



552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
 
# File 'lib/review/builder.rb', line 552

def parse_metric(type, metric)
  return '' if metric.blank?

  params = metric.split(/,\s*/)
  results = []
  params.each do |param|
    if /\A.+?::/.match?(param)
      next unless /\A#{type}::/.match?(param)

      param.sub!(/\A#{type}::/, '')
    end
    param2 = handle_metric(param)
    results.push(param2)
  end
  result_metric(results)
end

#parse_table_rows(lines) ⇒ Object 



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/review/builder.rb', line 236

def parse_table_rows(lines)
  sepidx = nil
  rows = []
  lines.each_with_index do |line, idx|
    # {} is for LaTeX
    if /\A[=-]{12}/ =~ line || /\A[={}-]{12}/ =~ line
      sepidx ||= idx
      next
    end
    rows.push(line.strip.split(table_row_separator_regexp).map { |s| s.sub(/\A\./, '') })
  end
  rows = adjust_n_cols(rows)
  app_error 'no rows in the table' if rows.empty?
  [sepidx, rows]
end

#post_paragraph ⇒ Object 



32
33
34
 
# File 'lib/review/builder.rb', line 32

def post_paragraph
  nil
end

#pre_paragraph ⇒ Object 



28
29
30
 
# File 'lib/review/builder.rb', line 28

def pre_paragraph
  nil
end

#previous_list_type ⇒ Object 



788
789
790
 
# File 'lib/review/builder.rb', line 788

def previous_list_type
  @compiler.previous_list_type
end

#print(*s) ⇒ Object 



127
128
129
 
# File 'lib/review/builder.rb', line 127

def print(*s)
  @output.print(*s)
end

#printendnotes ⇒ Object 



286
287
288
289
290
291
292
293
 
# File 'lib/review/builder.rb', line 286

def printendnotes
  @shown_endnotes = true
  endnote_begin
  @chapter.endnotes.each do |en|
    endnote_item(en.id)
  end
  endnote_end
end

#puts(*s) ⇒ Object 



131
132
133
 
# File 'lib/review/builder.rb', line 131

def puts(*s)
  @output.puts(*s)
end

#raw(str) ⇒ Object 



522
523
524
525
526
527
528
529
530
531
532
 
# File 'lib/review/builder.rb', line 522

def raw(str)
  if matched = str.match(/\|(.*?)\|(.*)/)
    builders = matched[1].split(',').map { |i| i.gsub(/\s/, '') }
    c = target_name
    if builders.include?(c)
      print matched[2].gsub('\\n', "\n")
    end
  else
    print str.gsub('\\n', "\n")
  end
end

#result ⇒ Object Also known as: raw_result 



120
121
122
123
 
# File 'lib/review/builder.rb', line 120

def result
  check_printendnotes
  solve_nest(@output.string)
end

#result_metric(array) ⇒ Object 



548
549
550
 
# File 'lib/review/builder.rb', line 548

def result_metric(array)
  array.join(',')
end

#solve_nest(s) ⇒ Object 



103
104
105
106
 
# File 'lib/review/builder.rb', line 103

def solve_nest(s)
  check_nest
  s.gsub(/\x01→.+?←\x01/, '')
end

#source(lines, caption = nil, lang = nil) ⇒ Object 



189
190
191
192
193
 
# File 'lib/review/builder.rb', line 189

def source(lines, caption = nil, lang = nil)
  source_header(caption) if caption_top?('list')
  source_body(lines, lang)
  source_header(caption) unless caption_top?('list')
end

#system_graph(id, *args) ⇒ Object 



652
653
654
655
 
# File 'lib/review/builder.rb', line 652

def system_graph(id, *args)
  @logger.info args.join(' ')
  Kernel.system(*args) or @logger.error("failed to run command for id #{id}: #{args.join(' ')}")
end

#table(lines, id = nil, caption = nil) ⇒ Object 



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/review/builder.rb', line 204

def table(lines, id = nil, caption = nil)
  sepidx, rows = parse_table_rows(lines)
  begin
    if caption_top?('table') && caption.present?
      table_header(id, caption)
    end
    table_begin(rows.first.size)
    table_rows(sepidx, rows)
    table_end
    if !caption_top?('table') && caption.present?
      table_header(id, caption)
    end
  rescue KeyError
    app_error "no such table: #{id}"
  end
end

#table_row_separator_regexp ⇒ Object 



221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/review/builder.rb', line 221

def table_row_separator_regexp
  case @book.config['table_row_separator']
  when 'tabs'
    Regexp.new('\t+')
  when 'singletab'
    Regexp.new('\t')
  when 'spaces'
    Regexp.new('\s+')
  when 'verticalbar'
    Regexp.new('\s*\\' + escape('|') + '\s*')
  else
    app_error "Unknown value for 'table_row_separator', shold be: tabs, singletab, spaces, verticalbar"
  end
end

#table_rows(sepidx, rows) ⇒ Object 



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/review/builder.rb', line 252

def table_rows(sepidx, rows)
  if sepidx
    sepidx.times do
      tr(rows.shift.map { |s| th(s) })
    end
    rows.each do |cols|
      tr(cols.map { |s| td(s) })
    end
  else
    rows.each do |cols|
      h, *cs = *cols
      tr([th(h)] + cs.map { |s| td(s) })
    end
  end
end

#target_name ⇒ Object 



135
136
137
 
# File 'lib/review/builder.rb', line 135

def target_name
  self.class.to_s.gsub(/ReVIEW::/, '').gsub(/Builder/, '').downcase
end

#text(str) ⇒ Object 



430
431
432
 
# File 'lib/review/builder.rb', line 430

def text(str)
  str
end

#tsize(str) ⇒ Object 



730
731
732
733
734
735
736
737
738
739
740
 
# File 'lib/review/builder.rb', line 730

def tsize(str)
  if matched = str.match(/\A\|(.*?)\|(.*)/)
    builders = matched[1].split(',').map { |i| i.gsub(/\s/, '') }
    c = self.class.to_s.gsub('ReVIEW::', '').gsub('Builder', '').downcase
    if builders.include?(c)
      @tsize = matched[2]
    end
  else
    @tsize = str
  end
end

#ul_item_begin(lines) ⇒ Object 



723
724
725
 
# File 'lib/review/builder.rb', line 723

def ul_item_begin(lines)
  ul_item(lines)
end

#ul_item_end ⇒ Object 



727
728
 
# File 'lib/review/builder.rb', line 727

def ul_item_end
end