review 4.2.0 → 5.0.0

data/lib/review/configure.rb

@@ -18,7 +18,7 @@ module ReVIEW
         'bookname' => 'book', # it defines epub file name also
         'booktitle' => 'Re:VIEW Sample Book',
         'title' => nil,
-        'aut' => ['anonymous'], # author
+        'aut' => nil, # author
         'prt' => nil, # printer(publisher)
         'asn' => nil, # associated name
         'ant' => nil, # bibliographic antecedent
@@ -64,6 +64,7 @@ module ReVIEW
         'bib_file' => 'bib.re',
         'words_file' => nil,
         'colophon_order' => %w[aut csl trl dsr ill cov edt pbl contact prt],
+        'chapterlink' => true,
         'externallink' => true,
         'join_lines_by_lang' => nil, # experimental. default should be nil
         'table_row_separator' => 'tabs',
@@ -118,6 +119,26 @@ module ReVIEW
       conf
     end
 
+    def self.create(maker: nil, yamlfile: nil, config: nil)
+      conf = self.values
+      conf.maker = maker
+
+      if yamlfile
+        begin
+          loader = ReVIEW::YAMLLoader.new
+          conf.deep_merge!(loader.load_file(yamlfile))
+        rescue => e
+          error "yaml error #{e.message}"
+        end
+      end
+      # YAML configs will be overridden by command line options.
+      if config
+        conf.deep_merge!(config)
+      end
+
+      conf
+    end
+
     def [](key)
       maker = self.maker
       if maker && self.key?(maker) && self.fetch(maker) && self.fetch(maker).key?(key)

data/lib/review/converter.rb

@@ -17,7 +17,7 @@ module ReVIEW
       chap_name = File.basename(file, '.*')
       chap = @book.chapter(chap_name)
       result = @compiler.compile(chap)
-      File.open(output_path, 'w') { |f| f.puts result }
+      File.write(output_path, result)
     end
   end
 end

data/lib/review/epub2html.rb

@@ -8,10 +8,15 @@
 
 require 'zip'
 require 'rexml/document'
-require 'cgi'
 require 'optparse'
 require 'review/version'
 
+begin
+  require 'cgi/escape'
+rescue
+  require 'cgi/util'
+end
+
 module ReVIEW
   class Epub2Html
     def self.execute(*args)

data/lib/review/epubmaker.rb

@@ -18,7 +18,6 @@ require 'review/version'
 require 'review/htmltoc'
 require 'review/htmlbuilder'
 
-require 'review/yamlloader'
 require 'rexml/document'
 require 'rexml/streamlistener'
 require 'epubmaker'
@@ -52,18 +51,9 @@ module ReVIEW
     end
 
     def load_yaml(yamlfile)
-      loader = ReVIEW::YAMLLoader.new
-      @config = ReVIEW::Configure.values
-      begin
-        @config.deep_merge!(loader.load_file(yamlfile))
-      rescue => e
-        error "yaml error #{e.message}"
-      end
-
       @producer = Producer.new(@config)
       @producer.load(yamlfile)
       @config = @producer.config
-      @config.maker = 'epubmaker'
     end
 
     def self.execute(*args)
@@ -94,13 +84,13 @@ module ReVIEW
     end
 
     def execute(*args)
-      @config = ReVIEW::Configure.values
-      @config.maker = 'epubmaker'
       cmd_config, yamlfile, exportfile = parse_opts(args)
       error "#{yamlfile} not found." unless File.exist?(yamlfile)
 
+      @config = ReVIEW::Configure.create(maker: 'epubmaker',
+                                         yamlfile: yamlfile,
+                                         config: cmd_config)
       load_yaml(yamlfile)
-      @config.deep_merge!(cmd_config)
       update_log_level
       log("Loaded yaml file (#{yamlfile}).")
 
@@ -252,7 +242,7 @@ module ReVIEW
       if @config['epubmaker']['verify_target_images'].present?
         @config['epubmaker']['force_include_images'].each do |file|
           unless File.exist?(file)
-            if file !~ /\Ahttp[s]?:/
+            if file !~ /\Ahttps?:/
               warn "#{file} is not found, skip."
             end
             next
@@ -307,8 +297,7 @@ module ReVIEW
 
       basedir = File.dirname(yamlfile)
       base_path = Pathname.new(basedir)
-      book = ReVIEW::Book.load(basedir)
-      book.config = @config
+      book = ReVIEW::Book::Base.new(basedir, config: @config)
       @converter = ReVIEW::Converter.new(book, ReVIEW::HTMLBuilder.new)
       @compile_errors = nil
 
@@ -340,9 +329,9 @@ module ReVIEW
       File.open(File.join(basetmpdir, htmlfile), 'w') do |f|
         @body = ''
         @body << %Q(<div class="part">\n)
-        @body << %Q(<h1 class="part-number">#{CGI.escapeHTML(ReVIEW::I18n.t('part', part.number))}</h1>\n)
+        @body << %Q(<h1 class="part-number">#{h(ReVIEW::I18n.t('part', part.number))}</h1>\n)
         if part.name.strip.present?
-          @body << %Q(<h2 class="part-title">#{CGI.escapeHTML(part.name.strip)}</h2>\n)
+          @body << %Q(<h2 class="part-title">#{h(part.name.strip)}</h2>\n)
         end
         @body << %Q(</div>\n)
 
@@ -563,19 +552,19 @@ module ReVIEW
 
     def build_titlepage(basetmpdir, htmlfile)
       # TODO: should be created via epubcommon
-      @title = CGI.escapeHTML(@config.name_of('booktitle'))
+      @title = h(@config.name_of('booktitle'))
       File.open(File.join(basetmpdir, htmlfile), 'w') do |f|
         @body = ''
         @body << %Q(<div class="titlepage">\n)
-        @body << %Q(<h1 class="tp-title">#{CGI.escapeHTML(@config.name_of('booktitle'))}</h1>\n)
+        @body << %Q(<h1 class="tp-title">#{h(@config.name_of('booktitle'))}</h1>\n)
         if @config['subtitle']
-          @body << %Q(<h2 class="tp-subtitle">#{CGI.escapeHTML(@config.name_of('subtitle'))}</h2>\n)
+          @body << %Q(<h2 class="tp-subtitle">#{h(@config.name_of('subtitle'))}</h2>\n)
         end
         if @config['aut']
-          @body << %Q(<h2 class="tp-author">#{CGI.escapeHTML(@config.names_of('aut').join(ReVIEW::I18n.t('names_splitter')))}</h2>\n)
+          @body << %Q(<h2 class="tp-author">#{h(@config.names_of('aut').join(ReVIEW::I18n.t('names_splitter')))}</h2>\n)
         end
         if @config['pbl']
-          @body << %Q(<h3 class="tp-publisher">#{CGI.escapeHTML(@config.names_of('pbl').join(ReVIEW::I18n.t('names_splitter')))}</h3>\n)
+          @body << %Q(<h3 class="tp-publisher">#{h(@config.names_of('pbl').join(ReVIEW::I18n.t('names_splitter')))}</h3>\n)
         end
         @body << '</div>'
 

data/lib/review/htmlbuilder.rb

@@ -41,10 +41,6 @@ module ReVIEW
       ".#{@book.config['htmlext']}"
     end
 
-    def builder_init
-    end
-    private :builder_init
-
     def builder_init_file
       @noindent = nil
       @ol_num = nil
@@ -92,7 +88,7 @@ module ReVIEW
     def result
       # default XHTML header/footer
       @title = strip_html(compile_inline(@chapter.title))
-      @body = @output.string
+      @body = solve_nest(@output.string)
       @language = @book.config['language']
       @stylesheets = @book.config['stylesheet']
       @next = @chapter.next_chapter
@@ -107,6 +103,20 @@ module ReVIEW
       ReVIEW::Template.load(layoutfile).result(binding)
     end
 
+    def solve_nest(s)
+      check_nest
+      s.gsub("</dd>\n</dl>\n\x01→dl←\x01", '').
+        gsub("\x01→/dl←\x01", "</dd>\n</dl>←END\x01").
+        gsub("</li>\n</ul>\n\x01→ul←\x01", '').
+        gsub("\x01→/ul←\x01", "</li>\n</ul>←END\x01").
+        gsub("</li>\n</ol>\n\x01→ol←\x01", '').
+        gsub("\x01→/ol←\x01", "</li>\n</ol>←END\x01").
+        gsub("</dl>←END\x01\n<dl>", '').
+        gsub("</ul>←END\x01\n<ul>", '').
+        gsub("</ol>←END\x01\n<ol>", '').
+        gsub("←END\x01", '')
+    end
+
     def xmlns_ops_prefix
       if @book.config['epubversion'].to_i == 3
         'epub'
@@ -228,6 +238,7 @@ module ReVIEW
     end
 
     def captionblock(type, lines, caption)
+      check_nested_minicolumn
       puts %Q(<div class="#{type}">)
       if caption.present?
         puts %Q(<p class="caption">#{compile_inline(caption)}</p>)
@@ -312,6 +323,24 @@ module ReVIEW
       captionblock('note', lines, caption)
     end
 
+    CAPTION_TITLES.each do |name|
+      class_eval %Q(
+        def #{name}_begin(caption = nil)
+          check_nested_minicolumn
+          @doc_status[:minicolumn] = '#{name}'
+          puts %Q(<div class="#{name}">)
+          if caption.present?
+            puts %Q(<p class="caption">\#{compile_inline(caption)}</p>)
+          end
+        end
+
+        def #{name}_end
+          puts '</div>'
+          @doc_status[:minicolumn] = nil
+        end
+      ), __FILE__, __LINE__ - 14
+    end
+
     def ul_begin
       puts '<ul>'
     end
@@ -1018,7 +1047,7 @@ EOS
 
     def inline_column_chap(chapter, id)
       if @book.config['chapterlink']
-        %Q(<a href="\##{column_label(id, chapter)}" class="columnref">#{I18n.t('column', compile_inline(chapter.column(id).caption))}</a>)
+        %Q(<a href="#{chapter.id}#{extname}##{column_label(id, chapter)}" class="columnref">#{I18n.t('column', compile_inline(chapter.column(id).caption))}</a>)
       else
         I18n.t('column', compile_inline(chapter.column(id).caption))
       end
@@ -1180,7 +1209,7 @@ EOS
       %Q(<span class="balloon">#{escape_html(str)}</span>)
     end
 
-    def inline_raw(str)
+    def inline_raw(str) # rubocop:disable Lint/UselessMethodDefinition
       super(str)
     end
 

data/lib/review/htmlutils.rb

@@ -7,19 +7,16 @@
 # the GNU LGPL, Lesser General Public License version 2.1.
 #
 
-require 'cgi/util'
+begin
+  require 'cgi/escape'
+rescue
+  require 'cgi/util'
+end
+
 module ReVIEW
   module HTMLUtils
-    ESC = {
-      '&' => '&',
-      '<' => '&lt;',
-      '>' => '&gt;',
-      '"' => '&quot;'
-    } # .freeze
-
     def escape(str)
-      t = ESC
-      str.gsub(/[&"<>]/) { |c| t[c] }
+      CGI.escapeHTML(str)
     end
 
     alias_method :escape_html, :escape # for backward compatibility

data/lib/review/i18n.rb

@@ -125,7 +125,7 @@ module ReVIEW
       frmt.gsub!('%%', '##')
 
       unless args.is_a?(Array)
-        args = args.nil? && frmt !~ /\%/ ? [] : [args]
+        args = args.nil? && frmt !~ /%/ ? [] : [args]
       end
 
       percents = frmt.scan(/%[A-Za-z]{1,3}/)

data/lib/review/idgxmlbuilder.rb

@@ -46,10 +46,6 @@ module ReVIEW
       '.xml'
     end
 
-    def builder_init
-    end
-    private :builder_init
-
     def builder_init_file
       @warns = []
       @errors = []
@@ -89,7 +85,21 @@ module ReVIEW
         s += '</sect>' if @section > 0
         s += '</chapter>' if @chapter.number > 0
       end
-      @output.string + s + "</#{@rootelement}>\n"
+      solve_nest(@output.string) + s + "</#{@rootelement}>\n"
+    end
+
+    def solve_nest(s)
+      check_nest
+      s.gsub("</dd></dl>\x01→dl←\x01", '').
+        gsub("\x01→/dl←\x01", "</dd></dl>←END\x01").
+        gsub("</li></ul>\x01→ul←\x01", '').
+        gsub("\x01→/ul←\x01", "</li></ul>←END\x01").
+        gsub("</li></ol>\x01→ol←\x01", '').
+        gsub("\x01→/ol←\x01", "</li></ol>←END\x01").
+        gsub("</dl>←END\x01<dl>", '').
+        gsub("</ul>←END\x01<ul>", '').
+        gsub("</ol>←END\x01<ol>", '').
+        gsub("←END\x01", '')
     end
 
     def headline(level, label, caption)
@@ -508,7 +518,7 @@ module ReVIEW
       sepidx = nil
       rows = []
       lines.each_with_index do |line, idx|
-        if /\A[\=\-]{12}/ =~ line
+        if /\A[=\-]{12}/ =~ line
           sepidx ||= idx
           next
         end
@@ -942,18 +952,22 @@ module ReVIEW
     end
 
     def note(lines, caption = nil)
+      check_nested_minicolumn
       captionblock('note', lines, caption)
     end
 
     def memo(lines, caption = nil)
+      check_nested_minicolumn
       captionblock('memo', lines, caption)
     end
 
     def tip(lines, caption = nil)
+      check_nested_minicolumn
       captionblock('tip', lines, caption)
     end
 
     def info(lines, caption = nil)
+      check_nested_minicolumn
       captionblock('info', lines, caption)
     end
 
@@ -966,6 +980,7 @@ module ReVIEW
     end
 
     def important(lines, caption = nil)
+      check_nested_minicolumn
       captionblock('important', lines, caption)
     end
 
@@ -974,10 +989,12 @@ module ReVIEW
     end
 
     def caution(lines, caption = nil)
+      check_nested_minicolumn
       captionblock('caution', lines, caption)
     end
 
     def warning(lines, caption = nil)
+      check_nested_minicolumn
       captionblock('warning', lines, caption)
     end
 
@@ -990,6 +1007,7 @@ module ReVIEW
     end
 
     def notice(lines, caption = nil)
+      check_nested_minicolumn
       if caption
         captionblock('notice-t', lines, caption, 'notice-title')
       else
@@ -1025,6 +1043,33 @@ module ReVIEW
       captionblock('expert', lines, nil)
     end
 
+    CAPTION_TITLES.each do |name|
+      class_eval %Q(
+        def #{name}_begin(caption = nil)
+          check_nested_minicolumn
+          if '#{name}' == 'notice' && caption.present?
+            @doc_status[:minicolumn] = '#{name}-t'
+            print "<#{name}-t>"
+          else
+            @doc_status[:minicolumn] = '#{name}'
+            print "<#{name}>"
+          end
+          if caption.present?
+            puts %Q(<title aid:pstyle='#{name}-title'>\#{compile_inline(caption)}</title>)
+          end
+        end
+
+        def #{name}_end
+          if '#{name}' == 'notice' && @doc_status[:minicolumn] == 'notice-t'
+            print "</#{name}-t>"
+          else
+            print "</#{name}>"
+          end
+          @doc_status[:minicolumn] = nil
+        end
+      ), __FILE__, __LINE__ - 23
+    end
+
     def syntaxblock(type, lines, caption)
       captionstr = nil
       if caption.present?

data/lib/review/idgxmlmaker.rb

@@ -15,9 +15,12 @@ require 'review/book'
 require 'review/yamlloader'
 require 'review/idgxmlbuilder'
 require 'review/version'
+require 'review/makerhelper'
 
 module ReVIEW
   class IDGXMLMaker
+    include MakerHelper
+
     attr_accessor :config, :basedir
 
     def initialize
@@ -74,19 +77,12 @@ module ReVIEW
     end
 
     def execute(*args)
-      @config = ReVIEW::Configure.values
-      @config.maker = 'idgxmlmaker'
       cmd_config, yamlfile = parse_opts(args)
       error "#{yamlfile} not found." unless File.exist?(yamlfile)
 
-      begin
-        loader = ReVIEW::YAMLLoader.new
-        @config.deep_merge!(loader.load_file(yamlfile))
-      rescue => e
-        error "yaml error #{e.message}"
-      end
-      # YAML configs will be overridden by command line options.
-      @config.deep_merge!(cmd_config)
+      @config = ReVIEW::Configure.create(maker: 'idgxmlmaker',
+                                         yamlfile: yamlfile,
+                                         config: cmd_config)
       I18n.setup(@config['language'])
       begin
         generate_idgxml_files(yamlfile)
@@ -102,8 +98,7 @@ module ReVIEW
       remove_old_files(@path)
       Dir.mkdir(@path)
 
-      @book = ReVIEW::Book.load(@basedir)
-      @book.config = @config
+      @book = ReVIEW::Book::Base.new(@basedir, config: @config)
       if @table
         @book.config['tableopt'] = @table
       end
@@ -155,9 +150,9 @@ module ReVIEW
         end
         f.puts '<?xml version="1.0" encoding="UTF-8"?>'
         f.print '<doc xmlns:aid="http://ns.adobe.com/AdobeInDesign/4.0/"><title aid:pstyle="h1">'
-        f.print CGI.escapeHTML(title)
+        f.print h(title)
         f.print '</title><?dtp level="1" section="'
-        f.print CGI.escapeHTML(title)
+        f.print h(title)
         f.puts '"?></doc>'
       end
       apply_filter(File.join(basetmpdir, xmlfile))