review 5.0.0 → 5.3.0

data/lib/review/compiler.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2009-2020 Minero Aoki, Kenshi Muto
+# Copyright (c) 2009-2021 Minero Aoki, Kenshi Muto
 # Copyright (c) 2002-2007 Minero Aoki
 #
 # This program is free software.
@@ -10,10 +10,15 @@ require 'review/extentions'
 require 'review/preprocessor'
 require 'review/exception'
 require 'review/location'
+require 'review/loggable'
 require 'strscan'
 
 module ReVIEW
   class Compiler
+    include Loggable
+
+    MAX_HEADLINE_LEVEL = 6
+
     def initialize(builder)
       @builder = builder
 
@@ -22,6 +27,12 @@ module ReVIEW
 
       ## to decide escaping/non-escaping for text
       @command_name_stack = []
+
+      @logger = ReVIEW.logger
+
+      @ignore_errors = builder.is_a?(ReVIEW::IndexBuilder)
+
+      @compile_errors = nil
     end
 
     attr_reader :builder, :previous_list_type
@@ -42,6 +53,10 @@ module ReVIEW
     def compile(chap)
       @chapter = chap
       do_compile
+      if @compile_errors
+        raise ApplicationError, "#{location.filename} cannot be compiled."
+      end
+
       @builder.result
     end
 
@@ -59,6 +74,7 @@ module ReVIEW
         unless @argc_spec === args.size
           raise CompileError, "wrong # of parameters (block command //#{@name}, expect #{@argc_spec} but #{args.size})"
         end
+
         if @checker
           @checker.call(*args)
         end
@@ -180,6 +196,8 @@ module ReVIEW
     defminicolumn :notice, 0..1
 
     defsingle :footnote, 2
+    defsingle :endnote, 2
+    defsingle :printendnotes, 0
     defsingle :noindent, 0
     defsingle :blankline, 0
     defsingle :pagebreak, 0
@@ -204,6 +222,7 @@ module ReVIEW
     definline :table
     definline :eq
     definline :fn
+    definline :endnote
     definline :kw
     definline :ruby
     definline :bou
@@ -258,6 +277,7 @@ module ReVIEW
     def do_compile
       f = LineInput.new(StringIO.new(@chapter.content))
       @builder.bind(self, @chapter, Location.new(@chapter.basename, f))
+      @previous_list_type = nil
 
       ## in minicolumn, such as note/info/alert...
       @minicolumn_name = nil
@@ -269,27 +289,27 @@ module ReVIEW
           f.gets # Nothing to do
         when /\A=+[\[\s{]/
           compile_headline(f.gets)
-          @builder.previous_list_type = nil
+          @previous_list_type = nil
         when /\A\s+\*/
           compile_ulist(f)
-          @builder.previous_list_type = 'ul'
+          @previous_list_type = 'ul'
         when /\A\s+\d+\./
           compile_olist(f)
-          @builder.previous_list_type = 'ol'
+          @previous_list_type = 'ol'
         when /\A\s+:\s/
           compile_dlist(f)
-          @builder.previous_list_type = 'dl'
+          @previous_list_type = 'dl'
         when /\A\s*:\s/
-          warn 'Definition list starting with `:` is deprecated. It should start with ` : `.'
+          warn 'Definition list starting with `:` is deprecated. It should start with ` : `.', location: location
           compile_dlist(f)
-          @builder.previous_list_type = 'dl'
+          @previous_list_type = 'dl'
         when %r{\A//\}}
           if in_minicolumn?
             _line = f.gets
             compile_minicolumn_end
           else
             f.gets
-            error 'block end seen but not opened'
+            error 'block end seen but not opened', location: location
           end
         when %r{\A//[a-z]+}
           line = f.peek
@@ -304,43 +324,44 @@ module ReVIEW
             name, args, lines = read_command(f)
             syntax = syntax_descriptor(name)
             unless syntax
-              error "unknown command: //#{name}"
-              compile_unknown_command(args, lines)
+              error "unknown command: //#{name}", location: location
               @command_name_stack.pop
               next
             end
             compile_command(syntax, args, lines)
             @command_name_stack.pop
           end
-          @builder.previous_list_type = nil
+          @previous_list_type = nil
         when %r{\A//}
           line = f.gets
-          warn "`//' seen but is not valid command: #{line.strip.inspect}"
+          warn "`//' seen but is not valid command: #{line.strip.inspect}", location: location
           if block_open?(line)
-            warn 'skipping block...'
+            warn 'skipping block...', location: location
             read_block(f, false)
           end
-          @builder.previous_list_type = nil
+          @previous_list_type = nil
         else
           if f.peek.strip.empty?
             f.gets
             next
           end
           compile_paragraph(f)
-          @builder.previous_list_type = nil
+          @previous_list_type = nil
         end
       end
       close_all_tagged_section
+    rescue SyntaxError => e
+      error e, location: location
     end
 
     def compile_minicolumn_begin(name, caption = nil)
       mid = "#{name}_begin"
       unless @builder.respond_to?(mid)
-        error "strategy does not support minicolumn: #{name}"
+        error "strategy does not support minicolumn: #{name}", location: location
       end
 
       if @minicolumn_name
-        error "minicolumn cannot be nested: #{name}"
+        error "minicolumn cannot be nested: #{name}", location: location
         return
       end
       @minicolumn_name = name
@@ -350,7 +371,7 @@ module ReVIEW
 
     def compile_minicolumn_end
       unless @minicolumn_name
-        error "minicolumn is not used: #{name}"
+        error "minicolumn is not used: #{name}", location: location
         return
       end
       name = @minicolumn_name
@@ -364,28 +385,32 @@ module ReVIEW
       @headline_indexs ||= [@chapter.number.to_i - 1]
       m = /\A(=+)(?:\[(.+?)\])?(?:\{(.+?)\})?(.*)/.match(line)
       level = m[1].size
+      if level > MAX_HEADLINE_LEVEL
+        raise CompileError, "Invalid header: max headline level is #{MAX_HEADLINE_LEVEL}"
+      end
+
       tag = m[2]
       label = m[3]
       caption = m[4].strip
       index = level - 1
       if tag
-        if tag !~ %r{\A/}
-          if caption.empty?
-            warn 'headline is empty.'
-          end
-          close_current_tagged_section(level)
-          open_tagged_section(tag, level, label, caption)
-        else
+        if tag.start_with?('/')
           open_tag = tag[1..-1]
           prev_tag_info = @tagged_section.pop
           if prev_tag_info.nil? || prev_tag_info.first != open_tag
-            error "#{open_tag} is not opened."
+            error "#{open_tag} is not opened.", location: location
           end
           close_tagged_section(*prev_tag_info)
+        else
+          if caption.empty?
+            warn 'headline is empty.', location: location
+          end
+          close_current_tagged_section(level)
+          open_tagged_section(tag, level, label, caption)
         end
       else
         if caption.empty?
-          warn 'headline is empty.'
+          warn 'headline is empty.', location: location
         end
         if @headline_indexs.size > (index + 1)
           @headline_indexs = @headline_indexs[0..index]
@@ -416,7 +441,7 @@ module ReVIEW
     def open_tagged_section(tag, level, label, caption)
       mid = "#{tag}_begin"
       unless @builder.respond_to?(mid)
-        error "builder does not support tagged section: #{tag}"
+        error "builder does not support tagged section: #{tag}", location: location
         headline(level, label, caption)
         return
       end
@@ -429,7 +454,7 @@ module ReVIEW
       if @builder.respond_to?(mid)
         @builder.__send__(mid, level)
       else
-        error "builder does not support block op: #{mid}"
+        error "builder does not support block op: #{mid}", location: location
       end
     end
 
@@ -458,7 +483,7 @@ module ReVIEW
         elsif level < current_level # down
           level_diff = current_level - level
           if level_diff != 1
-            error 'too many *.'
+            error 'too many *.', location: location
           end
           level = current_level
           @builder.ul_begin { level }
@@ -504,7 +529,10 @@ module ReVIEW
         @builder.doc_status[:dt] = true
         @builder.dt(text(f.gets.sub(/\A\s*:/, '').strip))
         @builder.doc_status[:dt] = nil
-        desc = f.break(/\A(\S|\s*:|\s+\d+\.\s|\s+\*\s)/).map { |line| text(line.strip) }
+        desc = []
+        f.until_match(/\A(\S|\s*:|\s+\d+\.\s|\s+\*\s)/) do |line|
+          desc << text(line.strip)
+        end
         @builder.dd(desc)
         f.skip_blank_lines
         f.skip_comment_lines
@@ -516,6 +544,7 @@ 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")))
       end
       @builder.paragraph(buf)
@@ -548,7 +577,7 @@ module ReVIEW
         end
       end
       unless f.peek.to_s.start_with?('//}')
-        error "unexpected EOF (block begins at: #{head})"
+        error "unexpected EOF (block begins at: #{head})", location: location
         return buf
       end
       f.gets # discard terminator
@@ -557,6 +586,7 @@ module ReVIEW
 
     def parse_args(str, _name = nil)
       return [] if str.empty?
+
       scanner = StringScanner.new(str)
       words = []
       while word = scanner.scan(/(\[\]|\[.*?[^\\]\])/)
@@ -567,7 +597,7 @@ module ReVIEW
         words << w2
       end
       unless scanner.eos?
-        error "argument syntax error: #{scanner.rest} in #{str.inspect}"
+        error "argument syntax error: #{scanner.rest} in #{str.inspect}", location: location
         return []
       end
       words
@@ -575,37 +605,32 @@ module ReVIEW
 
     def compile_command(syntax, args, lines)
       unless @builder.respond_to?(syntax.name)
-        error "builder does not support command: //#{syntax.name}"
-        compile_unknown_command(args, lines)
+        error "builder does not support command: //#{syntax.name}", location: location
         return
       end
       begin
         syntax.check_args(args)
       rescue CompileError => e
-        error e.message
+        error e.message, location: location
         args = ['(NoArgument)'] * syntax.min_argc
       end
       if syntax.block_allowed?
         compile_block(syntax, args, lines)
       else
         if lines
-          error "block is not allowed for command //#{syntax.name}; ignore"
+          error "block is not allowed for command //#{syntax.name}; ignore", location: location
         end
         compile_single(syntax, args)
       end
     end
 
-    def compile_unknown_command(args, lines)
-      @builder.unknown_command(args, lines)
-    end
-
     def compile_block(syntax, args, lines)
       @builder.__send__(syntax.name, (lines || default_block(syntax)), *args)
     end
 
     def default_block(syntax)
       if syntax.block_required?
-        error "block is required for //#{syntax.name}; use empty block"
+        error "block is required for //#{syntax.name}; use empty block", location: location
       end
       []
     end
@@ -619,15 +644,15 @@ module ReVIEW
         op = $1
         arg = $3
         if arg =~ /[\x01\x02\x03\x04]/
-          error "invalid character in '#{str}'"
+          error "invalid character in '#{str}'", location: location
         end
-        replaced = arg.gsub('@', "\x01").gsub('\\', "\x02").gsub('{', "\x03").gsub('}', "\x04")
+        replaced = arg.tr('@', "\x01").tr('\\', "\x02").tr('{', "\x03").tr('}', "\x04")
         "@<#{op}>{#{replaced}}"
       end
     end
 
     def revert_replace_fence(str)
-      str.gsub("\x01", '@').gsub("\x02", '\\').gsub("\x03", '{').gsub("\x04", '}')
+      str.tr("\x01", '@').tr("\x02", '\\').tr("\x03", '{').tr("\x04", '}')
     end
 
     def in_non_escaped_command?
@@ -637,10 +662,11 @@ module ReVIEW
 
     def text(str, block_mode = false)
       return '' if str.empty?
+
       words = replace_fence(str).split(/(@<\w+>\{(?:[^}\\]|\\.)*?\})/, -1)
       words.each do |w|
         if w.scan(/@<\w+>/).size > 1 && !/\A@<raw>/.match(w)
-          error "`@<xxx>' seen but is not valid inline op: #{w}"
+          error "`@<xxx>' seen but is not valid inline op: #{w}", location: location
         end
       end
       result = ''
@@ -651,11 +677,12 @@ module ReVIEW
           result << @builder.nofunc_text(revert_replace_fence(words.shift))
         end
         break if words.empty?
+
         result << compile_inline(revert_replace_fence(words.shift.gsub(/\\\}/, '}').gsub(/\\\\/, '\\')))
       end
       result
     rescue => e
-      error e.message
+      error e.message, location: location
     end
     public :text # called from builder
 
@@ -667,9 +694,10 @@ module ReVIEW
       unless @builder.respond_to?("inline_#{op}")
         raise "builder does not support inline op: @<#{op}>"
       end
+
       @builder.__send__("inline_#{op}", arg)
     rescue => e
-      error e.message
+      error e.message, location: location
       @builder.nofunc_text(str)
     end
 
@@ -681,12 +709,20 @@ module ReVIEW
       @builder.minicolumn_block_name?(name)
     end
 
-    def warn(msg)
-      @builder.warn msg
+    def ignore_errors?
+      @ignore_errors
     end
 
-    def error(msg)
-      @builder.error msg
+    def location
+      @builder.location
+    end
+
+    ## override
+    def error(msg, location: nil)
+      return if ignore_errors? # for IndexBuilder
+
+      @compile_errors = true
+      super
     end
   end
 end # module ReVIEW

data/lib/review/configure.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2012-2020 Masanori Kado, Masayoshi Takahashi, Kenshi Muto
+# Copyright (c) 2012-2021 Masanori Kado, Masayoshi Takahashi, Kenshi Muto
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -7,12 +7,13 @@
 # For details of the GNU LGPL, see the file "COPYING".
 #
 require 'securerandom'
+require 'review/yamlloader'
 
 module ReVIEW
   class Configure < Hash
     attr_accessor :maker
 
-    def self.values
+    def self.values # rubocop:disable Metrics/MethodLength
       conf = Configure[
         # These parameters can be overridden by YAML file.
         'bookname' => 'book', # it defines epub file name also
@@ -31,7 +32,7 @@ module ReVIEW
         'date' => Time.now.strftime('%Y-%m-%d'), # publishing date
         'rights' => nil, # Copyright messages
         'description' => nil, # Description
-        'urnid' => "urn:uid:#{SecureRandom.uuid}", # Identifier
+        'urnid' => "urn:uuid:#{SecureRandom.uuid}", # Identifier
         'stylesheet' => [], # stylesheet file
         'coverfile' => nil, # content file of body of cover page
         'mytoc' => nil, # whether make own table of contents or not
@@ -45,8 +46,7 @@ module ReVIEW
         'debug' => nil, # debug flag
         'catalogfile' => 'catalog.yml',
         'language' => 'ja', # XXX default language should be JA??
-        'mathml' => nil, # for HTML
-        'imgmath' => nil, # for HTML
+        'math_format' => nil,
         'htmlext' => 'html',
         'htmlversion' => 5,
         'contentdir' => '.',
@@ -63,7 +63,7 @@ module ReVIEW
         'image_types' => %w[.ai .psd .eps .pdf .tif .tiff .png .bmp .jpg .jpeg .gif .svg],
         'bib_file' => 'bib.re',
         'words_file' => nil,
-        'colophon_order' => %w[aut csl trl dsr ill cov edt pbl contact prt],
+        'colophon_order' => %w[aut csl trl dsr ill cov edt pbl contact prt pht],
         'chapterlink' => true,
         'externallink' => true,
         'join_lines_by_lang' => nil, # experimental. default should be nil
@@ -113,6 +113,34 @@ module ReVIEW
           'image' => 'bottom',
           'table' => 'top',
           'equation' => 'top'
+        },
+        # for EPUBMaker
+        'modified' => Time.now.utc.strftime('%Y-%02m-%02dT%02H:%02M:%02SZ'),
+        'isbn' => nil,
+        'titlefile' => nil,
+        'originaltitlefile' => nil,
+        'profile' => nil,
+        'direction' => 'ltr',
+        'image_maxpixels' => 4_000_000,
+        'font_ext' => %w[ttf woff otf],
+        'epubmaker' => {
+          'flattoc' => nil,
+          'flattocindent' => true,
+          'ncx_indent' => [],
+          'zip_stage1' => 'zip -0Xq',
+          'zip_stage2' => 'zip -Xr9Dq',
+          'zip_addpath' => nil,
+          'hook_beforeprocess' => nil,
+          'hook_afterfrontmatter' => nil,
+          'hook_afterbody' => nil,
+          'hook_afterbackmatter' => nil,
+          'hook_aftercopyimage' => nil,
+          'hook_prepack' => nil,
+          'rename_for_legacy' => nil,
+          'verify_target_images' => nil,
+          'force_include_images' => [],
+          'cover_linear' => nil,
+          'back_footnote' => nil
         }
       ]
       conf.maker = nil
@@ -128,17 +156,45 @@ module ReVIEW
           loader = ReVIEW::YAMLLoader.new
           conf.deep_merge!(loader.load_file(yamlfile))
         rescue => e
-          error "yaml error #{e.message}"
+          raise ReVIEW::ConfigError, "yaml error #{e.message}"
         end
       end
+
       # YAML configs will be overridden by command line options.
       if config
         conf.deep_merge!(config)
       end
 
+      conf.migrate_parameters
+
       conf
     end
 
+    def migrate_parameters
+      # string to array
+      %w[subject aut
+         a-adp a-ann a-arr a-art a-asn a-aqt a-aft a-aui a-ant a-bkp a-clb a-cmm a-dsr a-edt
+         a-ill a-lyr a-mdc a-mus a-nrt a-oth a-pht a-prt a-red a-rev a-spn a-ths a-trc a-trl
+         adp ann arr art asn aut aqt aft aui ant bkp clb cmm dsr edt
+         ill lyr mdc mus nrt oth pht pbl prt red rev spn ths trc trl
+         stylesheet rights].each do |item|
+        if self[item] && self[item].is_a?(String)
+          self[item] = [self[item]]
+        end
+      end
+
+      # backward compatibility
+      if self['mathml']
+        warn '"mathml: true" is obsoleted. Please use "math_format: mathml"'
+        self['math_format'] = 'mathml'
+      end
+
+      if self['imgmath']
+        warn '"imgmath: true" is obsoleted. Please use "math_format: imgmath"'
+        self['math_format'] = 'imgmath'
+      end
+    end
+
     def [](key)
       maker = self.maker
       if maker && self.key?(maker) && self.fetch(maker) && self.fetch(maker).key?(key)
@@ -147,6 +203,7 @@ module ReVIEW
       if self.key?(key)
         return self.fetch(key)
       end
+
       nil
     end
 

data/lib/review/epubmaker/content.rb

@@ -0,0 +1,113 @@
+# = content.rb -- Content object for EPUBMaker.
+#
+# Copyright (c) 2010-2020 Kenshi Muto
+#
+# This program is free software.
+# You can distribute or modify this program under the terms of
+# the GNU LGPL, Lesser General Public License version 2.1.
+# For details of the GNU LGPL, see the file "COPYING".
+#
+
+module ReVIEW
+  class EPUBMaker
+    # EPUBMaker::Content represents a content data for EPUBMaker.
+    # EPUBMaker#contents takes an array of Content.
+    class Content
+      # ID
+      attr_accessor :id
+      # File path (will accept #<anchor> suffix also)
+      attr_accessor :file
+      # MIME type
+      attr_accessor :media
+      # Title
+      attr_accessor :title
+      # Header level (from 1)
+      attr_accessor :level
+      # Show in TOC? nil:No.
+      attr_accessor :notoc
+      # Properties (EPUB3)
+      attr_accessor :properties
+      # Chapter type (pre/post/part/nil(body))
+      attr_accessor :chaptype
+
+      def inspect
+        "<Content id=#{@id}, file=#{@file}, media=#{@media}, title=#{@title}, level=#{@level}, notoc=#{@notoc}, properties=#{@properties}, chaptype=#{@chaptype}>"
+      end
+
+      # :call-seq:
+      #    initialize(params)
+      # Construct Content object by passing named parameters.
+      # +params+[:file] is required. Others are optional.
+      def initialize(file:, id: nil, media: nil, title: nil, level: nil, notoc: nil, properties: nil, chaptype: nil)
+        @id = id
+        @file = file
+        @media = media
+        @title = title
+        @level = level
+        @notoc = notoc
+        @properties = properties || []
+        @chaptype = chaptype
+        complement
+      end
+
+      def ==(other)
+        return false unless self.class == other.class
+
+        [self.id, self.file, self.media, self.title, self.level, self.notoc, self.chaptype, self.properties] ==
+          [other.id, other.file, other.media, other.title, other.level, other.notoc, other.chaptype, other.properties]
+      end
+
+      def coverimage?(imagefile)
+        self.media.start_with?('image') && self.file =~ /#{imagefile}\Z/
+      end
+
+      def properties_attribute
+        if self.properties.size > 0
+          %Q( properties="#{self.properties.sort.uniq.join(' ')}")
+        else
+          ''
+        end
+      end
+
+      private
+
+      # Complement other parameters by using file parameter.
+      def complement
+        if @id.nil?
+          @id = @file.gsub(%r{[\\/. ]}, '-')
+        end
+        if @id =~ /\A[^a-z]/i
+          @id = "rv-#{@id}"
+        end
+        @id = CGI.escape(@id).gsub('%', '_25_')
+
+        if !@file.nil? && @media.nil?
+          @media = @file.sub(/.+\./, '').downcase
+        end
+
+        case @media
+        when 'xhtml', 'xml', 'html'
+          @media = 'application/xhtml+xml'
+        when 'css'
+          @media = 'text/css'
+        when 'jpg', 'jpeg', 'image/jpg'
+          @media = 'image/jpeg'
+        when 'png'
+          @media = 'image/png'
+        when 'gif'
+          @media = 'image/gif'
+        when 'svg', 'image/svg'
+          @media = 'image/svg+xml'
+        when 'ttf', 'otf'
+          @media = 'application/vnd.ms-opentype'
+        when 'woff'
+          @media = 'application/font-woff'
+        end
+
+        if @id.nil? || @file.nil? || @media.nil?
+          raise "Type error: #{id}, #{file}, #{media}, #{title}, #{notoc}"
+        end
+      end
+    end
+  end
+end