review 5.2.0 → 5.5.0

data/lib/review/book/part.rb

@@ -14,11 +14,11 @@ module ReVIEW
       def self.mkpart_from_namelistfile(book, path)
         chaps = []
         File.read(path, mode: 'rt:BOM|utf-8').split.each_with_index do |name, number|
-          if path =~ /PREDEF/
-            chaps << Chapter.mkchap(book, name)
-          else
-            chaps << Chapter.mkchap(book, name, number + 1)
-          end
+          chaps << if /PREDEF/.match?(path)
+                     Chapter.mkchap(book, name)
+                   else
+                     Chapter.mkchap(book, name, number + 1)
+                   end
         end
         Part.mkpart(chaps)
       end
@@ -47,11 +47,11 @@ module ReVIEW
         else
           @content = ''
         end
-        if file?
-          @title = nil
-        else
-          @title = name
-        end
+        @title = if file?
+                   nil
+                 else
+                   name
+                 end
         @volume = nil
 
         super()
@@ -78,11 +78,10 @@ module ReVIEW
 
       def volume
         if @number && file?
-          vol = Volume.count_file(File.join(@book.config['contentdir'], @path))
+          Volume.count_file(File.join(@book.config['contentdir'], @path))
         else
-          vol = Volume.new(0, 0, 0)
+          Volume.new(0, 0, 0)
         end
-        vol
       end
 
       def file?

data/lib/review/book/volume.rb

@@ -12,7 +12,7 @@ module ReVIEW
       def self.count_file(path)
         b = c = l = 0
         File.foreach(path) do |line|
-          next if /\A\#@/ =~ line
+          next if /\A\#@/.match?(line)
 
           text = line.gsub(/\s+/, '')
           b += text.bytesize

data/lib/review/builder.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2002-2020 Minero Aoki, Kenshi Muto
+# Copyright (c) 2002-2022 Minero Aoki, Kenshi Muto
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -42,6 +42,7 @@ module ReVIEW
       @doc_status = {}
       @dictionary = {}
       @img_math = img_math
+      @shown_endnotes = true
     end
 
     def bind(compiler, chapter, location)
@@ -61,11 +62,11 @@ module ReVIEW
       if @book && @book.config
         @img_math ||= ReVIEW::ImgMath.new(@book.config)
         if words_file_path = @book.config['words_file']
-          if words_file_path.is_a?(String)
-            words_files = [words_file_path]
-          else
-            words_files = words_file_path
-          end
+          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
@@ -103,11 +104,18 @@ module ReVIEW
 
     def check_nest
       if @children && !@children.empty?
-        app_error "//beginchild of #{@children.reverse.join(',')} misses //endchild"
+        app_error "#{@location}: //beginchild of #{@children.reverse.join(',')} misses //endchild"
+      end
+    end
+
+    def check_printendnotes
+      if @shown_endnotes.nil?
+        app_error "#{@location}: //endnote is found but //printendnotes is not found."
       end
     end
 
     def result
+      check_printendnotes
       solve_nest(@output.string)
     end
 
@@ -126,11 +134,9 @@ module ReVIEW
     end
 
     def load_words(file)
-      if File.exist?(file)
-        if file =~ /\.csv\Z/i
-          CSV.foreach(file) do |row|
-            @dictionary[row[0]] = row[1]
-          end
+      if File.exist?(file) && /\.csv\Z/i.match?(file)
+        CSV.foreach(file) do |row|
+          @dictionary[row[0]] = row[1]
         end
       end
     end
@@ -273,17 +279,28 @@ module ReVIEW
       table(lines, nil, caption)
     end
 
-    # def footnote(id, str)
-    #   @footnotes.push [id, str]
-    # end
-    #
-    # def flush_footnote
-    #   footnote_begin
-    #   @footnotes.each do |id, str|
-    #     footnote_item(id, str)
-    #   end
-    #   footnote_end
-    # end
+    def printendnotes
+      @shown_endnotes = true
+      endnote_begin
+      @chapter.endnotes.each do |en|
+        endnote_item(en.id)
+      end
+      endnote_end
+    end
+
+    def endnote(_id, _str)
+      @shown_endnotes = nil
+    end
+
+    def endnote_begin
+    end
+
+    def endnote_end
+    end
+
+    def endnote_item(id)
+      puts "(#{@chapter.endnote(id).number}) #{compile_inline(@chapter.endnote(id).content)}"
+    end
 
     def blankline
       puts ''
@@ -371,6 +388,12 @@ module ReVIEW
       app_error "unknown footnote: #{id}"
     end
 
+    def inline_endnote(id)
+      "(#{@chapter.endnote(id).number})"
+    rescue KeyError
+      app_error "unknown endnote: #{id}"
+    end
+
     def inline_bou(str)
       text(str)
     end
@@ -427,6 +450,27 @@ module ReVIEW
       app_error "unknown headline: #{id}"
     end
 
+    alias_method :inline_secref, :inline_hd
+
+    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
+
+    def inline_sectitle(id)
+      chapter, id = extract_chapter_id(id)
+      compile_inline(chapter.headline(id).caption)
+    rescue KeyError
+      app_error "unknown headline: #{id}"
+    end
+
     def inline_column(id)
       m = /\A([^|]+)\|(.+)/.match(id)
       if m && m[1]
@@ -512,8 +556,8 @@ module ReVIEW
       params = metric.split(/,\s*/)
       results = []
       params.each do |param|
-        if param =~ /\A.+?::/
-          next unless param =~ /\A#{type}::/
+        if /\A.+?::/.match?(param)
+          next unless /\A#{type}::/.match?(param)
 
           param.sub!(/\A#{type}::/, '')
         end
@@ -644,7 +688,17 @@ EOTGNUPLOT
         ext = 'eps'
         file_path.sub!(/\.pdf\Z/, '.eps')
       end
-      system_graph(id, 'java', '-jar', 'plantuml.jar', "-t#{ext}", '-charset', 'UTF-8', tf_path)
+      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
@@ -729,7 +783,7 @@ EOTGNUPLOT
     def beginchild
       @children ||= []
       unless previous_list_type
-        app_error "//beginchild is shown, but previous element isn't ul, ol, or dl"
+        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)
@@ -737,7 +791,7 @@ EOTGNUPLOT
 
     def endchild
       if @children.nil? || @children.empty?
-        app_error "//endchild is shown, but any opened //beginchild doesn't exist"
+        app_error "#{@location}: //endchild is shown, but any opened //beginchild doesn't exist"
       else
         puts "\x01→/#{@children.pop}←\x01"
       end

data/lib/review/catalog.rb

@@ -1,13 +1,14 @@
 require 'yaml'
+require 'date'
 
 module ReVIEW
   class Catalog
     def initialize(file)
-      if file.respond_to?(:read)
-        @yaml = YAML.safe_load(file.read, [Date])
-      else ## as Object
-        @yaml = file
-      end
+      @yaml = if file.respond_to?(:read)
+                YAMLLoader.safe_load(file.read)
+              else ## as Object
+                file
+              end
       @yaml ||= {}
     end
 

data/lib/review/compiler.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2009-2020 Minero Aoki, Kenshi Muto
+# Copyright (c) 2009-2022 Minero Aoki, Kenshi Muto
 # Copyright (c) 2002-2007 Minero Aoki
 #
 # This program is free software.
@@ -44,7 +44,7 @@ module ReVIEW
 
     def non_escaped_commands
       if @builder.highlight?
-        %i[list emlist listnum emlistnum cmd]
+        %i[list emlist listnum emlistnum cmd source]
       else
         []
       end
@@ -71,7 +71,7 @@ module ReVIEW
       attr_reader :name
 
       def check_args(args)
-        unless @argc_spec === args.size
+        unless @argc_spec === args.size # rubocop:disable Style/CaseEquality
           raise CompileError, "wrong # of parameters (block command //#{@name}, expect #{@argc_spec} but #{args.size})"
         end
 
@@ -196,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
@@ -220,6 +222,7 @@ module ReVIEW
     definline :table
     definline :eq
     definline :fn
+    definline :endnote
     definline :kw
     definline :ruby
     definline :bou
@@ -229,6 +232,9 @@ module ReVIEW
     definline :code
     definline :bib
     definline :hd
+    definline :secref
+    definline :sec
+    definline :sectitle
     definline :href
     definline :recipe
     definline :column
@@ -464,7 +470,7 @@ module ReVIEW
     def compile_ulist(f)
       level = 0
       f.while_match(/\A\s+\*|\A\#@/) do |line|
-        next if line =~ /\A\#@/
+        next if /\A\#@/.match?(line)
 
         buf = [text(line.sub(/\*+/, '').strip)]
         f.while_match(/\A\s+(?!\*)\S/) do |cont|
@@ -507,7 +513,7 @@ module ReVIEW
     def compile_olist(f)
       @builder.ol_begin
       f.while_match(/\A\s+\d+\.|\A\#@/) do |line|
-        next if line =~ /\A\#@/
+        next if /\A\#@/.match?(line)
 
         num = line.match(/(\d+)\./)[1]
         buf = [text(line.sub(/\d+\./, '').strip)]
@@ -569,7 +575,7 @@ module ReVIEW
       f.until_match(%r{\A//\}}) do |line|
         if ignore_inline
           buf.push(line.chomp)
-        elsif line !~ /\A\#@/
+        elsif !/\A\#@/.match?(line)
           buf.push(text(line.rstrip, true))
         end
       end
@@ -640,7 +646,7 @@ module ReVIEW
       str.gsub(/@<(\w+)>([$|])(.+?)(\2)/) do
         op = $1
         arg = $3
-        if arg =~ /[\x01\x02\x03\x04]/
+        if /[\x01\x02\x03\x04]/.match?(arg)
           error "invalid character in '#{str}'", location: location
         end
         replaced = arg.tr('@', "\x01").tr('\\', "\x02").tr('{', "\x03").tr('}', "\x04")
@@ -668,17 +674,17 @@ module ReVIEW
       end
       result = ''
       until words.empty?
-        if in_non_escaped_command? && block_mode
-          result << revert_replace_fence(words.shift)
-        else
-          result << @builder.nofunc_text(revert_replace_fence(words.shift))
-        end
+        result << if in_non_escaped_command? && block_mode
+                    revert_replace_fence(words.shift)
+                  else
+                    @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
+    rescue StandardError => e
       error e.message, location: location
     end
     public :text # called from builder
@@ -693,7 +699,7 @@ module ReVIEW
       end
 
       @builder.__send__("inline_#{op}", arg)
-    rescue => e
+    rescue StandardError => e
       error e.message, location: location
       @builder.nofunc_text(str)
     end

data/lib/review/configure.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2012-2021 Masanori Kado, Masayoshi Takahashi, Kenshi Muto
+# Copyright (c) 2012-2022 Masanori Kado, Masayoshi Takahashi, Kenshi Muto
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -141,6 +141,9 @@ module ReVIEW
           'force_include_images' => [],
           'cover_linear' => nil,
           'back_footnote' => nil
+        },
+        'textmaker' => {
+          'th_bold' => nil
         }
       ]
       conf.maker = nil
@@ -155,7 +158,7 @@ module ReVIEW
         begin
           loader = ReVIEW::YAMLLoader.new
           conf.deep_merge!(loader.load_file(yamlfile))
-        rescue => e
+        rescue StandardError => e
           raise ReVIEW::ConfigError, "yaml error #{e.message}"
         end
       end

data/lib/review/epub2html.rb

@@ -13,7 +13,7 @@ require 'review/version'
 
 begin
   require 'cgi/escape'
-rescue
+rescue StandardError
   require 'cgi/util'
 end
 
@@ -62,10 +62,10 @@ EOT
     def parse_epub(epubname)
       Zip::File.open(epubname) do |zio|
         zio.each do |entry|
-          if entry.name =~ /.+\.opf\Z/
+          if /.+\.opf\Z/.match?(entry.name)
             opf = entry.get_input_stream.read
             @opfxml = REXML::Document.new(opf)
-          elsif entry.name =~ /.+\.x?html\Z/
+          elsif /.+\.x?html\Z/.match?(entry.name)
             @htmls[entry.name.sub('OEBPS/', '')] = entry.get_input_stream.read.force_encoding('utf-8')
           end
         end
@@ -107,15 +107,15 @@ EOT
         end
 
         file, anc = href.split('#', 2)
-        if anc
-          if file.empty?
-            anc = "#{sanitize(fname)}_#{sanitize(anc)}"
-          else
-            anc = "#{sanitize(file)}_#{sanitize(anc)}"
-          end
-        else
-          anc = sanitize(file)
-        end
+        anc = if anc
+                if file.empty?
+                  "#{sanitize(fname)}_#{sanitize(anc)}"
+                else
+                  "#{sanitize(file)}_#{sanitize(anc)}"
+                end
+              else
+                sanitize(file)
+              end
 
         e.attributes['href'] = "##{anc}"
       end

data/lib/review/epubmaker/content.rb

@@ -76,7 +76,7 @@ module ReVIEW
         if @id.nil?
           @id = @file.gsub(%r{[\\/. ]}, '-')
         end
-        if @id =~ /\A[^a-z]/i
+        if /\A[^a-z]/i.match?(@id)
           @id = "rv-#{@id}"
         end
         @id = CGI.escape(@id).gsub('%', '_25_')

data/lib/review/epubmaker/epubcommon.rb

@@ -1,6 +1,6 @@
 # = epubcommon.rb -- super class for EPUBv2 and EPUBv3
 #
-# Copyright (c) 2010-2019 Kenshi Muto and Masayoshi Takahashi
+# Copyright (c) 2010-2022 Kenshi Muto and Masayoshi Takahashi
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -27,6 +27,7 @@ module ReVIEW
         @contents = producer.contents
         @body_ext = nil
         @logger = ReVIEW.logger
+        @workdir = nil
       end
 
       attr_reader :config
@@ -36,7 +37,8 @@ module ReVIEW
         CGI.escapeHTML(str)
       end
 
-      def produce(epubfile, basedir, tmpdir)
+      def produce(_epubfile, _basedir, _tmpdir, base_dir:)
+        @workdir = base_dir
         raise NotImplementedError # should be overridden
       end
 
@@ -70,7 +72,7 @@ module ReVIEW
           item = contents.find { |content| content.coverimage?(config['coverimage']) }
 
           unless item
-            raise "coverimage #{config['coverimage']} not found. Abort."
+            raise ApplicationError, "coverimage #{config['coverimage']} not found. Abort."
           end
 
           %Q(    <meta name="cover" content="#{item.id}"/>\n)
@@ -99,27 +101,43 @@ module ReVIEW
         end
       end
 
+      def template_name(localfile: 'layout.html.erb', systemfile: nil)
+        if @workdir
+          layoutfile = File.join(@workdir, 'layouts', localfile)
+          if File.exist?(layoutfile)
+            return layoutfile
+          end
+        end
+
+        if systemfile
+          return systemfile
+        end
+
+        if config['htmlversion'].to_i == 5
+          './html/layout-html5.html.erb'
+        else
+          './html/layout-xhtml1.html.erb'
+        end
+      end
+
       # Return cover content.
       # If Producer#config["coverimage"] is defined, it will be used for
       # the cover image.
       def cover
-        @body_ext = config['epubversion'] >= 3 ? %Q( epub:type="cover") : ''
+        @body_ext = config['epubversion'] >= 3 ? %Q( epub:type="cover") : nil
 
         if config['coverimage']
           @coverimage_src = coverimage
-          raise "coverimage #{config['coverimage']} not found. Abort." unless @coverimage_src
+          raise ApplicationError, "coverimage #{config['coverimage']} not found. Abort." unless @coverimage_src
         end
-        @body = ReVIEW::Template.generate(path: './html/_cover.html.erb', binding: binding)
+        @body = ReVIEW::Template.generate(path: template_name(localfile: '_cover.html.erb', systemfile: 'html/_cover.html.erb'), binding: binding)
 
         @title = h(config.name_of('title'))
         @language = config['language']
         @stylesheets = config['stylesheet']
-        template_path = if config['htmlversion'].to_i == 5
-                          './html/layout-html5.html.erb'
-                        else
-                          './html/layout-xhtml1.html.erb'
-                        end
-        ReVIEW::Template.generate(path: template_path, binding: binding)
+        ret = ReVIEW::Template.generate(path: template_name, binding: binding)
+        @body_ext = nil
+        ret
       end
 
       # Return title (copying) content.
@@ -138,16 +156,11 @@ module ReVIEW
         if config.names_of('pbl')
           @publisher_str = join_with_separator(config.names_of('pbl'), ReVIEW::I18n.t('names_splitter'))
         end
-        @body = ReVIEW::Template.generate(path: './html/_titlepage.html.erb', binding: binding)
+        @body = ReVIEW::Template.generate(path: template_name(localfile: '_titlepage.html.erb', systemfile: './html/_titlepage.html.erb'), binding: binding)
 
         @language = config['language']
         @stylesheets = config['stylesheet']
-        template_path = if config['htmlversion'].to_i == 5
-                          './html/layout-html5.html.erb'
-                        else
-                          './html/layout-xhtml1.html.erb'
-                        end
-        ReVIEW::Template.generate(path: template_path, binding: binding)
+        ReVIEW::Template.generate(path: template_name, binding: binding)
       end
 
       # Return colophon content.
@@ -155,24 +168,19 @@ module ReVIEW
         @title = h(ReVIEW::I18n.t('colophontitle'))
         @isbn_hyphen = isbn_hyphen
 
-        @body = ReVIEW::Template.generate(path: './html/_colophon.html.erb', binding: binding)
+        @body = ReVIEW::Template.generate(path: template_name(localfile: '_colophon.html.erb', systemfile: './html/_colophon.html.erb'), binding: binding)
 
         @language = config['language']
         @stylesheets = config['stylesheet']
-        template_path = if config['htmlversion'].to_i == 5
-                          './html/layout-html5.html.erb'
-                        else
-                          './html/layout-xhtml1.html.erb'
-                        end
-        ReVIEW::Template.generate(path: template_path, binding: binding)
+        ReVIEW::Template.generate(path: template_name, binding: binding)
       end
 
       def isbn_hyphen
         str = config['isbn'].to_s
 
-        if str =~ /\A\d{10}\Z/
+        if /\A\d{10}\Z/.match?(str)
           "#{str[0..0]}-#{str[1..5]}-#{str[6..8]}-#{str[9..9]}"
-        elsif str =~ /\A\d{13}\Z/
+        elsif /\A\d{13}\Z/.match?(str)
           "#{str[0..2]}-#{str[3..3]}-#{str[4..8]}-#{str[9..11]}-#{str[12..12]}"
         end
       end
@@ -184,9 +192,9 @@ module ReVIEW
             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/
+              if /\A\d+-\d+-\d+\Z/.match?(item)
                 @col_history << ReVIEW::I18n.t('published_by1', [date_to_s(item), editstr + revstr])
-              elsif item =~ /\A(\d+-\d+-\d+)[\s　](.+)/
+              elsif /\A(\d+-\d+-\d+)[\s　](.+)/.match?(item)
                 # custom date with string
                 item.match(/\A(\d+-\d+-\d+)[\s　](.+)/) do |m|
                   @col_history << ReVIEW::I18n.t('published_by3', [date_to_s(m[1]), m[2]])
@@ -199,7 +207,7 @@ module ReVIEW
           end
         end
 
-        ReVIEW::Template.generate(path: './html/_colophon_history.html.erb', binding: binding)
+        ReVIEW::Template.generate(path: template_name(localfile: '_colophon_history.html.erb', systemfile: './html/_colophon_history.html.erb'), binding: binding)
       end
 
       def date_to_s(date)
@@ -211,22 +219,16 @@ module ReVIEW
       # Return own toc content.
       def mytoc
         @title = h(ReVIEW::I18n.t('toctitle'))
-
         @body = %Q(  <h1 class="toc-title">#{h(ReVIEW::I18n.t('toctitle'))}</h1>\n)
-        if config['epubmaker']['flattoc'].nil?
-          @body << hierarchy_ncx('ul')
-        else
-          @body << flat_ncx('ul', config['epubmaker']['flattocindent'])
-        end
+        @body << if config['epubmaker']['flattoc'].nil?
+                   hierarchy_ncx('ul')
+                 else
+                   flat_ncx('ul', config['epubmaker']['flattocindent'])
+                 end
 
         @language = config['language']
         @stylesheets = config['stylesheet']
-        template_path = if config['htmlversion'].to_i == 5
-                          './html/layout-html5.html.erb'
-                        else
-                          './html/layout-xhtml1.html.erb'
-                        end
-        ReVIEW::Template.generate(path: template_path, binding: binding)
+        ReVIEW::Template.generate(path: template_name, binding: binding)
       end
 
       def hierarchy_ncx(type)
@@ -334,11 +336,11 @@ module ReVIEW
         end
 
         contents.each do |item|
-          next if item.file =~ /#/ # skip subgroup
+          next if /#/.match?(item.file) # skip subgroup
 
           fname = "#{basedir}/#{item.file}"
           unless File.exist?(fname)
-            raise "#{fname} is not found."
+            raise ApplicationError, "#{fname} is not found."
           end
 
           FileUtils.mkdir_p(File.dirname("#{tmpdir}/OEBPS/#{item.file}"))

data/lib/review/epubmaker/epubv2.rb

@@ -1,6 +1,6 @@
 # = epubv2.rb -- EPUB version 2 producer.
 #
-# Copyright (c) 2010-2017 Kenshi Muto and Masayoshi Takahashi
+# Copyright (c) 2010-2022 Kenshi Muto and Masayoshi Takahashi
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -159,6 +159,7 @@ EOT
       # +basedir+ points the directory has contents.
       # +tmpdir+ defines temporary directory.
       def produce(epubfile, work_dir, tmpdir, base_dir:)
+        @workdir = base_dir
         produce_write_common(work_dir, tmpdir)
 
         ncx_file = "#{tmpdir}/OEBPS/#{config['bookname']}.ncx"