review 3.2.0 → 5.1.0

data/lib/review/preprocessor.rb

@@ -51,10 +51,10 @@ module ReVIEW
     end
 
     def process(inf, outf)
-      init_errorutils inf
+      init_errorutils(inf)
       @f = outf
       begin
-        preproc inf
+        preproc(inf)
       rescue Errno::ENOENT => e
         error e.message
       end
@@ -80,7 +80,7 @@ module ReVIEW
           direc = parse_directive(line, 1, 'stderr')
           @f.print line
           get_output(expand(direc.arg), direc['stderr']).each { |out| @f.print out.string }
-          skip_list f
+          skip_list(f)
 
         when /\A\#@mapfile/
           direc = parse_directive(line, 1, 'eval')
@@ -115,7 +115,7 @@ module ReVIEW
 
         when /\A\s*\z/ # empty line
           @f.puts
-        else
+        else # rubocop:disable Lint/DuplicateBranch
           @f.print line
         end
       end
@@ -131,15 +131,15 @@ module ReVIEW
       @f.print directive_line
       newlines.each do |line|
         if with_lineno
-          print_number line.number
+          print_number(line.number)
         end
         @f.print line.string
       end
-      skip_list f
+      skip_list(f)
     end
 
     def print_number(num)
-      @f.printf '%4s  ', (num ? num.to_s : '')
+      @f.printf('%4s  ', (num ? num.to_s : ''))
     end
 
     def skip_list(f)
@@ -195,7 +195,8 @@ module ReVIEW
       op = m[1]
       args = m[2].split(/,\s*/)
       opts = parse_optargs(m[3])
-      return if argc == 0 and args.empty?
+      return if (argc == 0) && args.empty?
+
       if argc == -1
         # Any number of arguments are allowed.
       elsif args.size != argc
@@ -212,6 +213,7 @@ module ReVIEW
 
     def parse_optargs(str)
       return nil unless str
+
       table = {}
       str.split(/,\s*/).each do |a|
         name, spec = a.split('=', 2)
@@ -222,11 +224,14 @@ module ReVIEW
 
     def optarg_value(spec)
       case spec
-      when 'true' then true # [name=true]
-      when 'false' then false # [name=false]
-      when 'nil' then nil # [name=nil]
-      when nil then true # [name]
-      when /^\d+$/ then $&.to_i # [name=8]
+      when 'true' # [name=true], [name]
+        true
+      when 'false' # [name=false]
+        false
+      when 'nil' # [name=nil]
+        nil
+      when /^\d+$/ # [name=8]
+        $&.to_i
       else # [name=val]
         spec
       end
@@ -279,12 +284,12 @@ module ReVIEW
       Open3.popen3(cmd) do |_stdin, stdout, stderr|
         out = stdout.readlines
         if use_stderr
-          out.concat stderr.readlines
+          out.concat(stderr.readlines)
         else
           err = stderr.readlines
         end
       end
-      if err and !err.empty?
+      if err && !err.empty?
         $stderr.puts '[unexpected stderr message]'
         err.each { |line| $stderr.print line }
         error 'get_output: got unexpected output'
@@ -355,14 +360,14 @@ module ReVIEW
 
     def parse_git_blob(g_obj)
       IO.popen('git show ' + g_obj.sub(/\Agit\|/, ''), 'r') do |f|
-        init_errorutils f
+        init_errorutils(f)
         return _parse_file(f)
       end
     end
 
     def parse_file(fname)
-      File.open(fname, 'r:BOM|utf-8') do |f|
-        init_errorutils f
+      File.open(fname, 'rt:BOM|utf-8') do |f|
+        init_errorutils(f)
         return _parse_file(f)
       end
     end
@@ -403,14 +408,14 @@ module ReVIEW
             error "begin x2: #{key}"
           end
           (repo[type] ||= {})[spec] = curr[key] = []
-          opened.push [type, spec]
+          opened.push([type, spec])
 
         when %r{(?:\A\#@|\#@@)([a-z]+)/(\w+)\}}
           type = check_type($1)
           spec = check_spec($2)
           curr.delete("#{type}/#{spec}") or
             error "end before begin: #{type}/#{spec}"
-          opened.delete "#{type}/#{spec}"
+          opened.delete("#{type}/#{spec}")
 
         when /(?:\A\#@|\#@@)\}/
           type, spec = opened.last
@@ -423,17 +428,18 @@ module ReVIEW
 
         when /\A\#@-/ # does not increment line number.
           line = canonical($')
-          curr.each_value { |list| list.push Line.new(nil, line) }
+          curr.each_value { |list| list.push(Line.new(nil, line)) }
 
         else
-          next if yacchack and line.strip == ';'
+          next if yacchack && (line.strip == ';')
+
           line = canonical(line)
-          curr.each_value { |list| list.push Line.new(lineno, line) }
+          curr.each_value { |list| list.push(Line.new(lineno, line)) }
           lineno += 1
         end
       end
       if curr.size > 1
-        curr.delete 'WHOLE'
+        curr.delete('WHOLE')
         curr.each { |range, lines| @logger.warn "#{filename}: unclosed range: #{range} (begin @#{lines.first.number})" }
         raise ApplicationError, 'ERROR'
       end

data/lib/review/rstbuilder.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2008-2017 Minero Aoki, Kenshi Muto
+# Copyright (c) 2008-2020 Minero Aoki, Kenshi Muto
 #               2002-2006 Minero Aoki
 #
 # This program is free software.
@@ -67,13 +67,13 @@ module ReVIEW
     end
     private :builder_init_file
 
-    def print(s)
+    def print(*s)
       @blank_seen = false
       super
     end
     private :print
 
-    def puts(s)
+    def puts(*s)
       @blank_seen = false
       super
     end
@@ -86,7 +86,7 @@ module ReVIEW
     private :blank
 
     def result
-      @output.string
+      solve_nest(@output.string)
     end
 
     def headline(level, label, caption)
@@ -97,19 +97,19 @@ module ReVIEW
       end
       p = '='
       case level
-      when 1 then
+      when 1
         unless label
           puts ".. _#{@chapter.name}:"
           blank
         end
         puts '=' * caption.size * 2
-      when 2 then
+      when 2
         p = '='
-      when 3 then
+      when 3
         p = '-'
-      when 4 then
+      when 4
         p = '`'
-      when 5 then
+      when 5
         p = '~'
       end
 
@@ -124,7 +124,7 @@ module ReVIEW
     end
 
     def ul_item(lines)
-      puts '  ' * (@ul_indent - 1) + "* #{lines.join}"
+      puts '  ' * (@ul_indent - 1) + "* #{join_lines_to_paragraph(lines)}"
     end
 
     def ul_end
@@ -138,7 +138,7 @@ module ReVIEW
     end
 
     def ol_item(lines, _num)
-      puts '  ' * (@ol_indent - 1) + "#. #{lines.join}"
+      puts '  ' * (@ol_indent - 1) + "#. #{join_lines_to_paragraph(lines)}"
     end
 
     def ol_end
@@ -155,7 +155,7 @@ module ReVIEW
 
     def dd(lines)
       split_paragraph(lines).each do |paragraph|
-        puts "  #{paragraph.gsub(/\n/, '')}"
+        puts "  #{paragraph.delete("\n")}"
       end
     end
 
@@ -167,7 +167,7 @@ module ReVIEW
       if @in_role
         pre = '   '
       end
-      puts pre + lines.join
+      puts pre + join_lines_to_paragraph(lines)
       puts "\n"
     end
 
@@ -373,8 +373,9 @@ module ReVIEW
 
     def compile_kw(word, alt)
       if alt
-        then " **#{word}（#{alt.strip}）** "
-      else " **#{word}** "
+        " **#{word}（#{alt.strip}）** "
+      else
+        " **#{word}** "
       end
     end
 
@@ -575,87 +576,105 @@ module ReVIEW
     end
 
     def flushright(lines)
-      base_parablock 'flushright', lines, nil
+      base_parablock('flushright', lines, nil)
     end
 
     def centering(lines)
-      base_parablock 'centering', lines, nil
+      base_parablock('centering', lines, nil)
+    end
+
+    CAPTION_TITLES.each do |name|
+      class_eval %Q(
+        def #{name}_begin(caption = nil)
+          check_nested_minicolumn
+          @doc_status[:minicolumn] = '#{name}'
+          puts ".. #{name}::"
+          blank
+          puts "   " + compile_inline(caption).to_s unless caption.nil?
+          print "   "
+        end
+
+        def #{name}_end
+          blank
+          @doc_status[:minicolumn] = nil
+        end
+      ), __FILE__, __LINE__ - 14
     end
 
     def note(lines, caption = nil)
-      base_parablock 'note', lines, caption
+      base_parablock('note', lines, caption)
     end
 
     def memo(lines, caption = nil)
-      base_parablock 'memo', lines, caption
+      base_parablock('memo', lines, caption)
     end
 
     def tip(lines, caption = nil)
-      base_parablock 'tip', lines, caption
+      base_parablock('tip', lines, caption)
     end
 
     def info(lines, caption = nil)
-      base_parablock 'info', lines, caption
+      base_parablock('info', lines, caption)
     end
 
     def planning(lines, caption = nil)
-      base_parablock 'planning', lines, caption
+      base_parablock('planning', lines, caption)
     end
 
     def best(lines, caption = nil)
-      base_parablock 'best', lines, caption
+      base_parablock('best', lines, caption)
     end
 
     def important(lines, caption = nil)
-      base_parablock 'important', lines, caption
+      base_parablock('important', lines, caption)
     end
 
     def security(lines, caption = nil)
-      base_parablock 'security', lines, caption
+      base_parablock('security', lines, caption)
     end
 
     def caution(lines, caption = nil)
-      base_parablock 'caution', lines, caption
+      base_parablock('caution', lines, caption)
     end
 
     def term(lines)
-      base_parablock 'term', lines, nil
+      base_parablock('term', lines, nil)
     end
 
     def link(lines, caption = nil)
-      base_parablock 'link', lines, caption
+      base_parablock('link', lines, caption)
     end
 
     def notice(lines, caption = nil)
-      base_parablock 'notice', lines, caption
+      base_parablock('notice', lines, caption)
     end
 
     def point(lines, caption = nil)
-      base_parablock 'point', lines, caption
+      base_parablock('point', lines, caption)
     end
 
     def shoot(lines, caption = nil)
-      base_parablock 'shoot', lines, caption
+      base_parablock('shoot', lines, caption)
     end
 
     def reference(lines)
-      base_parablock 'reference', lines, nil
+      base_parablock('reference', lines, nil)
     end
 
     def practice(lines)
-      base_parablock 'practice', lines, nil
+      base_parablock('practice', lines, nil)
     end
 
     def expert(lines)
-      base_parablock 'expert', lines, nil
+      base_parablock('expert', lines, nil)
     end
 
     def insn(lines, caption = nil)
-      base_block 'insn', lines, caption
+      base_block('insn', lines, caption)
     end
 
     def warning(lines, caption = nil)
-      base_parablock 'warning', lines, caption
+      base_parablock('warning', lines, caption)
     end
 
     alias_method :box, :insn
@@ -682,7 +701,7 @@ module ReVIEW
     end
 
     def bpo(lines)
-      base_block 'bpo', lines, nil
+      base_block('bpo', lines, nil)
     end
 
     def inline_dtp(_str)
@@ -705,7 +724,7 @@ module ReVIEW
       str
     end
 
-    def inline_chap(id)
+    def inline_chap(id) # rubocop:disable Lint/UselessMethodDefinition
       super
     end
 
@@ -714,7 +733,7 @@ module ReVIEW
     end
 
     def source(lines, caption = nil, _lang = nil)
-      base_block 'source', lines, caption
+      base_block('source', lines, caption)
     end
 
     def inline_ttibold(str)

data/lib/review/sec_counter.rb

@@ -37,11 +37,25 @@ module ReVIEW
       str
     end
 
+    def number_list
+      buf = @counter.dup
+      while buf.present?
+        if buf.last == 0
+          buf.pop
+        else
+          return buf
+        end
+      end
+
+      buf
+    end
+
     def prefix(level, secnolevel)
       return nil if @chapter.number.blank?
 
       if level == 1
         return nil unless secnolevel >= 1
+
         if @chapter.is_a?(ReVIEW::Book::Part)
           num = @chapter.number
           "#{I18n.t('part', num)}#{I18n.t('chapter_postfix')}"

data/lib/review/template.rb

@@ -10,8 +10,14 @@ module ReVIEW
       self.new(filename, mode)
     end
 
+    def self.generate(path:, binding:, mode: 1, template_dir: ReVIEW::Template::TEMPLATE_DIR)
+      template_file = File.expand_path(path, template_dir)
+      self.new(template_file, mode).result(binding)
+    end
+
     def initialize(filename = nil, mode = nil)
       return unless filename
+
       content = File.read(filename)
       @erb = ERB.new(content, nil, mode)
     end