review 3.0.0 → 4.2.0

data/lib/review/catalog.rb

@@ -3,8 +3,8 @@ require 'yaml'
 module ReVIEW
   class Catalog
     def initialize(file)
-      if file.respond_to? :read
-        @yaml = YAML.load(file.read)
+      if file.respond_to?(:read)
+        @yaml = YAML.safe_load(file.read, [Date])
       else ## as Object
         @yaml = file
       end
@@ -12,12 +12,11 @@ module ReVIEW
     end
 
     def predef
-      return '' unless @yaml['PREDEF']
-      @yaml['PREDEF'].join("\n")
+      @yaml['PREDEF'] || []
     end
 
     def chaps
-      return '' unless @yaml['CHAPS']
+      return [] unless @yaml['CHAPS']
 
       @yaml['CHAPS'].map do |entry|
         if entry.is_a?(String)
@@ -25,11 +24,11 @@ module ReVIEW
         elsif entry.is_a?(Hash)
           entry.values # chaps in a part
         end
-      end.flatten.join("\n")
+      end.flatten
     end
 
     def parts
-      return '' unless @yaml['CHAPS']
+      return [] unless @yaml['CHAPS']
 
       part_list = @yaml['CHAPS'].map do |entry|
         if entry.is_a?(Hash)
@@ -37,7 +36,7 @@ module ReVIEW
         end
       end
 
-      part_list.flatten.compact.join("\n")
+      part_list.flatten.compact
     end
 
     def replace_part(old_name, new_name)
@@ -50,18 +49,16 @@ module ReVIEW
     end
 
     def parts_with_chaps
-      return '' unless @yaml['CHAPS']
+      return [] unless @yaml['CHAPS']
       @yaml['CHAPS'].flatten.compact
     end
 
     def appendix
-      return '' unless @yaml['APPENDIX']
-      @yaml['APPENDIX'].join("\n")
+      @yaml['APPENDIX'] || []
     end
 
     def postdef
-      return '' unless @yaml['POSTDEF']
-      @yaml['POSTDEF'].join("\n")
+      @yaml['POSTDEF'] || []
     end
 
     def to_s
@@ -71,7 +68,7 @@ module ReVIEW
     def validate!(config, basedir)
       filenames = []
       if predef.present?
-        filenames.concat(predef.split(/\n/))
+        filenames.concat(predef)
       end
       parts_with_chaps.each do |chap|
         if chap.is_a?(Hash)
@@ -86,10 +83,10 @@ module ReVIEW
         end
       end
       if appendix.present?
-        filenames.concat(appendix.split(/\n/))
+        filenames.concat(appendix)
       end
       if postdef.present?
-        filenames.concat(postdef.split(/\n/))
+        filenames.concat(postdef)
       end
       filenames.each do |filename|
         refile = File.join(basedir, config['contentdir'], filename)

data/lib/review/compiler.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2009-2018 Minero Aoki, Kenshi Muto
+# Copyright (c) 2009-2020 Minero Aoki, Kenshi Muto
 # Copyright (c) 2002-2007 Minero Aoki
 #
 # This program is free software.
@@ -9,39 +9,31 @@
 require 'review/extentions'
 require 'review/preprocessor'
 require 'review/exception'
+require 'review/location'
 require 'strscan'
 
 module ReVIEW
-  class Location
-    def initialize(filename, f)
-      @filename = filename
-      @f = f
-    end
-
-    attr_reader :filename
-
-    def lineno
-      @f.lineno
-    end
-
-    def string
-      begin
-        "#{@filename}:#{@f.lineno}"
-      rescue
-        "#{@filename}:nil"
-      end
-    end
-
-    alias_method :to_s, :string
-  end
-
   class Compiler
     def initialize(strategy)
       @strategy = strategy
+
+      ## commands which do not parse block lines in compiler
+      @non_parsed_commands = %i[embed texequation graph]
+
+      ## to decide escaping/non-escaping for text
+      @command_name_stack = []
     end
 
     attr_reader :strategy
 
+    def non_escaped_commands
+      if @strategy.highlight?
+        %i[list emlist listnum emlistnum cmd]
+      else
+        []
+      end
+    end
+
     def compile(chap)
       @chapter = chap
       do_compile
@@ -88,11 +80,11 @@ module ReVIEW
     SYNTAX = {}
 
     def self.defblock(name, argc, optional = false, &block)
-      defsyntax name, (optional ? :optional : :block), argc, &block
+      defsyntax(name, (optional ? :optional : :block), argc, &block)
     end
 
     def self.defsingle(name, argc, &block)
-      defsyntax name, :line, argc, &block
+      defsyntax(name, :line, argc, &block)
     end
 
     def self.defsyntax(name, type, argc, &block)
@@ -131,7 +123,7 @@ module ReVIEW
     defblock :emlist, 0..2
     defblock :cmd, 0..1
     defblock :table, 0..2
-    defblock :imgtable, 0..2
+    defblock :imgtable, 0..3
     defblock :emtable, 0..1
     defblock :quote, 0
     defblock :image, 2..3, true
@@ -239,32 +231,39 @@ module ReVIEW
 
     def do_compile
       f = LineInput.new(StringIO.new(@chapter.content))
-      @strategy.bind self, @chapter, Location.new(@chapter.basename, f)
+      @strategy.bind(self, @chapter, Location.new(@chapter.basename, f))
+
       tagged_section_init
       while f.next?
         case f.peek
         when /\A\#@/
           f.gets # Nothing to do
         when /\A=+[\[\s\{]/
-          compile_headline f.gets
+          compile_headline(f.gets)
         when /\A\s+\*/
-          compile_ulist f
+          compile_ulist(f)
         when /\A\s+\d+\./
-          compile_olist f
+          compile_olist(f)
+        when /\A\s+:\s/
+          compile_dlist(f)
         when /\A\s*:\s/
-          compile_dlist f
+          warn 'Definition list starting with `:` is deprecated. It should start with ` : `.'
+          compile_dlist(f)
         when %r{\A//\}}
           f.gets
           error 'block end seen but not opened'
         when %r{\A//[a-z]+}
+          # @command_name_stack.push(name) ## <- move into read_command() to use name
           name, args, lines = read_command(f)
           syntax = syntax_descriptor(name)
           unless syntax
             error "unknown command: //#{name}"
-            compile_unknown_command args, lines
+            compile_unknown_command(args, lines)
+            @command_name_stack.pop
             next
           end
-          compile_command syntax, args, lines
+          compile_command(syntax, args, lines)
+          @command_name_stack.pop
         when %r{\A//}
           line = f.gets
           warn "`//' seen but is not valid command: #{line.strip.inspect}"
@@ -277,7 +276,7 @@ module ReVIEW
             f.gets
             next
           end
-          compile_paragraph f
+          compile_paragraph(f)
         end
       end
       close_all_tagged_section
@@ -318,7 +317,7 @@ module ReVIEW
         end
         @headline_indexs[index] += 1
         close_current_tagged_section(level)
-        @strategy.headline level, label, caption
+        @strategy.headline(level, label, caption)
       end
     end
 
@@ -329,7 +328,7 @@ module ReVIEW
     end
 
     def headline(level, label, caption)
-      @strategy.headline level, label, caption
+      @strategy.headline(level, label, caption)
     end
 
     def tagged_section_init
@@ -340,17 +339,17 @@ module ReVIEW
       mid = "#{tag}_begin"
       unless @strategy.respond_to?(mid)
         error "strategy does not support tagged section: #{tag}"
-        headline level, label, caption
+        headline(level, label, caption)
         return
       end
-      @tagged_section.push [tag, level]
-      @strategy.__send__ mid, level, label, caption
+      @tagged_section.push([tag, level])
+      @strategy.__send__(mid, level, label, caption)
     end
 
     def close_tagged_section(tag, level)
       mid = "#{tag}_end"
       if @strategy.respond_to?(mid)
-        @strategy.__send__ mid, level
+        @strategy.__send__(mid, level)
       else
         error "strategy does not support block op: #{mid}"
       end
@@ -369,7 +368,7 @@ module ReVIEW
 
         buf = [text(line.sub(/\*+/, '').strip)]
         f.while_match(/\A\s+(?!\*)\S/) do |cont|
-          buf.push text(cont.strip)
+          buf.push(text(cont.strip))
         end
 
         line =~ /\A\s+(\*+)/
@@ -377,16 +376,15 @@ module ReVIEW
         if level == current_level
           @strategy.ul_item_end
           # body
-          @strategy.ul_item_begin buf
+          @strategy.ul_item_begin(buf)
         elsif level < current_level # down
           level_diff = current_level - level
-          level = current_level
-          (1..(level_diff - 1)).to_a.reverse_each do |i|
-            @strategy.ul_begin { i }
-            @strategy.ul_item_begin []
+          if level_diff != 1
+            error 'too many *.'
           end
+          level = current_level
           @strategy.ul_begin { level }
-          @strategy.ul_item_begin buf
+          @strategy.ul_item_begin(buf)
         elsif level > current_level # up
           level_diff = level - current_level
           level = current_level
@@ -396,7 +394,7 @@ module ReVIEW
           end
           @strategy.ul_item_end
           # body
-          @strategy.ul_item_begin buf
+          @strategy.ul_item_begin(buf)
         end
       end
 
@@ -414,9 +412,9 @@ module ReVIEW
         num = line.match(/(\d+)\./)[1]
         buf = [text(line.sub(/\d+\./, '').strip)]
         f.while_match(/\A\s+(?!\d+\.)\S/) do |cont|
-          buf.push text(cont.strip)
+          buf.push(text(cont.strip))
         end
-        @strategy.ol_item buf, num
+        @strategy.ol_item(buf, num)
       end
       @strategy.ol_end
     end
@@ -424,7 +422,10 @@ module ReVIEW
     def compile_dlist(f)
       @strategy.dl_begin
       while /\A\s*:/ =~ f.peek
-        @strategy.dt text(f.gets.sub(/\A\s*:/, '').strip)
+        # defer compile_inline to handle footnotes
+        @strategy.doc_status[:dt] = true
+        @strategy.dt(text(f.gets.sub(/\A\s*:/, '').strip))
+        @strategy.doc_status[:dt] = nil
         desc = f.break(/\A(\S|\s*:|\s+\d+\.\s|\s+\*\s)/).map { |line| text(line.strip) }
         @strategy.dd(desc)
         f.skip_blank_lines
@@ -437,15 +438,16 @@ module ReVIEW
       buf = []
       f.until_match(%r{\A//|\A\#@}) do |line|
         break if line.strip.empty?
-        buf.push text(line.sub(/^(\t+)\s*/) { |m| '<!ESCAPETAB!>' * m.size }.strip.gsub('<!ESCAPETAB!>', "\t"))
+        buf.push(text(line.sub(/^(\t+)\s*/) { |m| '<!ESCAPETAB!>' * m.size }.strip.gsub('<!ESCAPETAB!>', "\t")))
       end
-      @strategy.paragraph buf
+      @strategy.paragraph(buf)
     end
 
     def read_command(f)
       line = f.gets
       name = line.slice(/[a-z]+/).to_sym
-      ignore_inline = (name == :embed)
+      ignore_inline = @non_parsed_commands.include?(name)
+      @command_name_stack.push(name)
       args = parse_args(line.sub(%r{\A//[a-z]+}, '').rstrip.chomp('{'), name)
       @strategy.doc_status[name] = true
       lines = block_open?(line) ? read_block(f, ignore_inline) : nil
@@ -462,12 +464,12 @@ module ReVIEW
       buf = []
       f.until_match(%r{\A//\}}) do |line|
         if ignore_inline
-          buf.push line
+          buf.push(line.chomp)
         elsif line !~ /\A\#@/
-          buf.push text(line.rstrip)
+          buf.push(text(line.rstrip, true))
         end
       end
-      unless %r{\A//\}} =~ f.peek
+      unless f.peek.to_s.start_with?('//}')
         error "unexpected EOF (block begins at: #{head})"
         return buf
       end
@@ -496,27 +498,27 @@ module ReVIEW
     def compile_command(syntax, args, lines)
       unless @strategy.respond_to?(syntax.name)
         error "strategy does not support command: //#{syntax.name}"
-        compile_unknown_command args, lines
+        compile_unknown_command(args, lines)
         return
       end
       begin
-        syntax.check_args args
-      rescue CompileError => err
-        error err.message
+        syntax.check_args(args)
+      rescue CompileError => e
+        error e.message
         args = ['(NoArgument)'] * syntax.min_argc
       end
       if syntax.block_allowed?
-        compile_block syntax, args, lines
+        compile_block(syntax, args, lines)
       else
         if lines
           error "block is not allowed for command //#{syntax.name}; ignore"
         end
-        compile_single syntax, args
+        compile_single(syntax, args)
       end
     end
 
     def compile_unknown_command(args, lines)
-      @strategy.unknown_command args, lines
+      @strategy.unknown_command(args, lines)
     end
 
     def compile_block(syntax, args, lines)
@@ -550,7 +552,12 @@ module ReVIEW
       str.gsub("\x01", '@').gsub("\x02", '\\').gsub("\x03", '{').gsub("\x04", '}')
     end
 
-    def text(str)
+    def in_non_escaped_command?
+      current_command = @command_name_stack.last
+      current_command && non_escaped_commands.include?(current_command)
+    end
+
+    def text(str, block_mode = false)
       return '' if str.empty?
       words = replace_fence(str).split(/(@<\w+>\{(?:[^\}\\]|\\.)*?\})/, -1)
       words.each do |w|
@@ -558,14 +565,19 @@ module ReVIEW
           error "`@<xxx>' seen but is not valid inline op: #{w}"
         end
       end
-      result = @strategy.nofunc_text(revert_replace_fence(words.shift))
+      result = ''
       until words.empty?
+        if in_non_escaped_command? && block_mode
+          result << revert_replace_fence(words.shift)
+        else
+          result << @strategy.nofunc_text(revert_replace_fence(words.shift))
+        end
+        break if words.empty?
         result << compile_inline(revert_replace_fence(words.shift.gsub(/\\\}/, '}').gsub(/\\\\/, '\\')))
-        result << @strategy.nofunc_text(revert_replace_fence(words.shift))
       end
       result
-    rescue => err
-      error err.message
+    rescue => e
+      error e.message
     end
     public :text # called from strategy
 
@@ -578,8 +590,8 @@ module ReVIEW
         raise "strategy does not support inline op: @<#{op}>"
       end
       @strategy.__send__("inline_#{op}", arg)
-    rescue => err
-      error err.message
+    rescue => e
+      error e.message
       @strategy.nofunc_text(str)
     end
 

data/lib/review/configure.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2012-2018 Masanori Kado, Masayoshi Takahashi, Kenshi Muto
+# Copyright (c) 2012-2020 Masanori Kado, Masayoshi Takahashi, Kenshi Muto
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -15,10 +15,10 @@ module ReVIEW
     def self.values
       conf = Configure[
         # These parameters can be overridden by YAML file.
-        'bookname' => 'example', # it defines epub file name also
+        'bookname' => 'book', # it defines epub file name also
         'booktitle' => 'Re:VIEW Sample Book',
         'title' => nil,
-        'aut' => nil, # author
+        'aut' => ['anonymous'], # author
         'prt' => nil, # printer(publisher)
         'asn' => nil, # associated name
         'ant' => nil, # bibliographic antecedent
@@ -32,7 +32,7 @@ module ReVIEW
         'rights' => nil, # Copyright messages
         'description' => nil, # Description
         'urnid' => "urn:uid:#{SecureRandom.uuid}", # Identifier
-        'stylesheet' => 'stylesheet.css', # stylesheet file
+        'stylesheet' => [], # stylesheet file
         'coverfile' => nil, # content file of body of cover page
         'mytoc' => nil, # whether make own table of contents or not
         'params' => '', # specify review2html parameters
@@ -65,6 +65,8 @@ module ReVIEW
         'words_file' => nil,
         'colophon_order' => %w[aut csl trl dsr ill cov edt pbl contact prt],
         'externallink' => true,
+        'join_lines_by_lang' => nil, # experimental. default should be nil
+        'table_row_separator' => 'tabs',
         # for IDGXML
         'tableopt' => nil,
         'listinfo' => nil,
@@ -73,22 +75,25 @@ module ReVIEW
         'structuredxml' => nil,
         'pt_to_mm_unit' => 0.3528, # DTP: 1pt = 0.3528mm, JIS: 1pt = 0.3514mm
         # for LaTeX
-        'image_scale2width' => true,
         'footnotetext' => nil,
         'texcommand' => 'uplatex',
-        'texoptions' => '-interaction=nonstopmode -file-line-error',
+        'texoptions' => '-interaction=nonstopmode -file-line-error -halt-on-error',
         '_texdocumentclass' => ['review-jsbook', ''],
+        'texstyle' => ['reviewmacro'],
         'dvicommand' => 'dvipdfmx',
         'dvioptions' => '-d 5 -z 9',
         # for PDFMaker
         'pdfmaker' => {
+          'image_scale2width' => true,
           'makeindex' => nil, # Make index page
           'makeindex_command' => 'mendex', # works only when makeindex is true
           'makeindex_options' => '-f -r -I utf8',
           'makeindex_sty' => nil,
           'makeindex_dic' => nil,
           'makeindex_mecab' => true,
-          'makeindex_mecab_opts' => '-Oyomi'
+          'makeindex_mecab_opts' => '-Oyomi',
+          'use_cover_nombre' => true,
+          'use_original_image_size' => nil
         },
         'imgmath_options' => {
           'format' => 'png',
@@ -99,8 +104,14 @@ module ReVIEW
           'preamble_file' => nil,
           'fontsize' => 10,
           'lineheight' => 10 * 1.2,
-          'pdfcrop_pixelize_cmd' => 'pdftocairo -png -r 90 -f %p -l %p -singlefile %i %O',
+          'pdfcrop_pixelize_cmd' => 'pdftocairo -%t -r 90 -f %p -l %p -singlefile %i %O',
           'dvipng_cmd' => 'dvipng -T tight -z 9 -p %p -l %p -o %o %i'
+        },
+        'caption_position' => {
+          'list' => 'top',
+          'image' => 'bottom',
+          'table' => 'top',
+          'equation' => 'top'
         }
       ]
       conf.maker = nil