review 3.1.0 → 3.2.0

data/bin/review-vol

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 #
-# Copyright (c) 2014-2017 Minero Aoki, Kenshi Muto
+# Copyright (c) 2014-2019 Minero Aoki, Kenshi Muto
 #               2003-2014 Minero Aoki
 #
 # This program is free software.
@@ -37,8 +37,8 @@ def main
   end
   begin
     opts.parse!
-  rescue OptionParser::ParseError => err
-    @logger.error err.message
+  rescue OptionParser::ParseError => e
+    @logger.error e.message
     $stderr.puts opts.help
     exit 1
   end
@@ -70,9 +70,9 @@ def main
   end
   puts '============================='
   print_volume book.volume # puts "Total #{book.volume}"
-rescue ReVIEW::ApplicationError, Errno::ENOENT => err
+rescue ReVIEW::ApplicationError, Errno::ENOENT => e
   raise if $DEBUG
-  @logger.error "#{File.basename($PROGRAM_NAME)}: #{err.message}"
+  @logger.error "#{File.basename($PROGRAM_NAME)}: #{e.message}"
   exit 1
 end
 

data/doc/format.ja.md

@@ -20,9 +20,9 @@ Re:VIEW フォーマットの文法について解説します。Re:VIEW フォ
 * 2行以上空けても、1行空きと同じ意味になります。
 * 空行せずに改行して段落の記述を続ける際、英文の単語間スペースについては考慮されないことに注意してください。Re:VIEW は各行を単純に連結するだけであり、TeX のように前後の単語を判断してスペースを入れるようなことはしません。
 
-## 章・節・項・段（見出し）
+## 章・節・項・目・段（見出し）
 
-章・節・項・段といった見出しは「`=`」「`==`」「`===`」「`====`」「`=====`」で表します。6 レベル以上は使えません。`=`のあとにはスペースを入れます。
+章・節・項・目といった見出しは「`=`」「`==`」「`===`」「`====`」「`=====`」で表します。7 レベル以上は使えません。`=`のあとにはスペースを入れます。
 
 例:
 
@@ -33,9 +33,11 @@ Re:VIEW フォーマットの文法について解説します。Re:VIEW フォ
 
 === 項のキャプション
 
-==== 段のキャプション
+==== 目のキャプション
 
-===== 小段のキャプション
+===== 段のキャプション
+
+====== 小段のキャプション
 ```
 
 見出しは行の先頭から始める必要があります。行頭に空白を入れると、ただの本文と見なされます。

data/doc/format.md

@@ -24,7 +24,7 @@ Two empty lines or more are same as one empty line.
 
 ## Chapter, Section, Subsection (headings)
 
-Chapters, sections, subsections, subsubsections use `=`, `==`, `===`, `====`, `=====`.
+Chapters, sections, subsections, subsubsections use `=`, `==`, `===`, `====`, `=====`, and `======`.
 You should add one or more spaces after `=`.
 
 Usage:
@@ -39,6 +39,8 @@ Usage:
 ==== 4th level
 
 ===== 5th level
+
+====== 6th level
 ```
 
 Headings should not have any spaces before title; if line head has space, it is as paragraph.

data/lib/epubmaker/epubcommon.rb

@@ -36,10 +36,9 @@ module EPUBMaker
       if @producer.config['coverimage']
         file = nil
         @producer.contents.each do |item|
-          if !item.media.start_with?('image') || item.file !~ /#{@producer.config["coverimage"]}\Z/
+          if !item.media.start_with?('image') || item.file !~ /#{@producer.config['coverimage']}\Z/
             next
           end
-
           s << %Q(    <meta name="cover" content="#{item.id}"/>\n)
           file = item.file
           break

data/lib/epubmaker/epubv2.rb

@@ -39,7 +39,7 @@ module EPUBMaker
         if @producer.config[item].is_a?(Array)
           s << @producer.config.names_of(item).map { |i| %Q(    <dc:#{item}>#{CGI.escapeHTML(i)}</dc:#{item}>\n) }.join
         else
-          s << %Q(    <dc:#{item}>#{CGI.escapeHTML(@producer.config.name_of(item))}</dc:#{item}>\n)
+          s << %Q(    <dc:#{item}>#{CGI.escapeHTML(@producer.config.name_of(item).to_s)}</dc:#{item}>\n)
         end
       end
 

data/lib/epubmaker/epubv3.rb

@@ -26,6 +26,7 @@ module EPUBMaker
     # Return opf file content.
     def opf
       @opf_metainfo = opf_metainfo
+      @opf_coverimage = opf_coverimage
       @opf_manifest = opf_manifest
       @opf_toc = opf_tocx
       @package_attrs = ''

data/lib/epubmaker/producer.rb

@@ -192,7 +192,8 @@ module EPUBMaker
       current = Dir.pwd
       basedir ||= current
 
-      new_tmpdir = tmpdir.nil? ? Dir.mktmpdir : tmpdir
+      # use Dir to solve a path for Windows (see #1011)
+      new_tmpdir = Dir[File.join(tmpdir.nil? ? Dir.mktmpdir : tmpdir)][0]
       if epubfile !~ %r{\A/}
         epubfile = "#{current}/#{epubfile}"
       end

data/lib/review/book/base.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2009-2018 Minero Aoki, Kenshi Muto
+# Copyright (c) 2009-2019 Minero Aoki, Kenshi Muto
 #               2002-2008 Minero Aoki
 #
 # This program is free software.
@@ -266,8 +266,8 @@ module ReVIEW
           if File.file?(predef_file)
             mkpart_from_namelistfile(predef_file)
           end
-        rescue FileNotFound => err
-          raise FileNotFound, "preface #{err.message}"
+        rescue FileNotFound => e
+          raise FileNotFound, "preface #{e.message}"
         end
       end
 
@@ -283,8 +283,8 @@ module ReVIEW
           if File.file?(postdef_file)
             mkpart_from_namelistfile(postdef_file)
           end
-        rescue FileNotFound => err
-          raise FileNotFound, "postscript #{err.message}"
+        rescue FileNotFound => e
+          raise FileNotFound, "postscript #{e.message}"
         end
       end
 

data/lib/review/book/index.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2008-2018 Minero Aoki, Kenshi Muto
+# Copyright (c) 2008-2019 Minero Aoki, Kenshi Muto
 #               2002-2007 Minero Aoki
 #
 # This program is free software.
@@ -316,6 +316,7 @@ module ReVIEW
           if m.nil? || m[1].size > 10 # Ignore too deep index
             next
           end
+
           index = m[1].size - 2
 
           # column
@@ -335,7 +336,9 @@ module ReVIEW
 
           next unless index >= 0
           if indexs.size > (index + 1)
-            indexs = indexs.take(index + 1)
+            unless %w[nonum notoc nodisp].include?(m[2])
+              indexs = indexs.take(index + 1)
+            end
             headlines = headlines.take(index + 1)
           end
           if indexs[index].nil?
@@ -343,9 +346,15 @@ module ReVIEW
               indexs[i] ||= 0
             end
           end
-          indexs[index] += 1
-          headlines[index] = m[3].present? ? m[3].strip : m[4].strip
-          items.push Item.new(headlines.join('|'), indexs.dup, m[4].strip)
+
+          if %w[nonum notoc nodisp].include?(m[2])
+            headlines[index] = m[3].present? ? m[3].strip : m[4].strip
+            items.push Item.new(headlines.join('|'), nil, m[4].strip)
+          else
+            indexs[index] += 1
+            headlines[index] = m[3].present? ? m[3].strip : m[4].strip
+            items.push Item.new(headlines.join('|'), indexs.dup, m[4].strip)
+          end
         end
         new(items, chap)
       end
@@ -364,6 +373,10 @@ module ReVIEW
       end
 
       def number(id)
+        unless self[id].number
+          # when notoc
+          return ''
+        end
         n = @chap.number
         # XXX: remove magic number (move to lib/review/book/chapter.rb)
         if @chap.on_appendix? && @chap.number > 0 && @chap.number < 28

data/lib/review/builder.rb

@@ -165,6 +165,7 @@ module ReVIEW
         rows.push(line.strip.split(/\t+/).map { |s| s.sub(/\A\./, '') })
       end
       rows = adjust_n_cols(rows)
+      error 'no rows in the table' if rows.empty?
 
       begin
         if caption.present?
@@ -173,7 +174,6 @@ module ReVIEW
       rescue KeyError
         error "no such table: #{id}"
       end
-      return if rows.empty?
       table_begin rows.first.size
       if sepidx
         sepidx.times do
@@ -478,7 +478,9 @@ module ReVIEW
     def extract_chapter_id(chap_ref)
       m = /\A([\w+-]+)\|(.+)/.match(chap_ref)
       if m
-        return [@book.contents.detect { |chap| chap.id == m[1] }, m[2]]
+        ch = @book.contents.detect { |chap| chap.id == m[1] }
+        raise KeyError unless ch
+        return [ch, m[2]]
       end
       [@chapter, chap_ref]
     end
@@ -614,6 +616,10 @@ EOTGNUPLOT
       end
     end
 
+    def over_secnolevel?(n)
+      @book.config['secnolevel'] >= n.to_s.split('.').size
+    end
+
     ## override TextUtils::detab
     def detab(str, num = nil)
       if num

data/lib/review/compiler.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2009-2018 Minero Aoki, Kenshi Muto
+# Copyright (c) 2009-2019 Minero Aoki, Kenshi Muto
 # Copyright (c) 2002-2007 Minero Aoki
 #
 # This program is free software.
@@ -9,32 +9,10 @@
 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
@@ -380,11 +358,10 @@ module ReVIEW
           @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
         elsif level > current_level # up
@@ -501,8 +478,8 @@ module ReVIEW
       end
       begin
         syntax.check_args args
-      rescue CompileError => err
-        error err.message
+      rescue CompileError => e
+        error e.message
         args = ['(NoArgument)'] * syntax.min_argc
       end
       if syntax.block_allowed?
@@ -564,8 +541,8 @@ module ReVIEW
         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 +555,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/epub2html.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2018 Kenshi Muto
+# Copyright (c) 2018-2019 Kenshi Muto
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -9,6 +9,8 @@
 require 'zip'
 require 'rexml/document'
 require 'cgi'
+require 'optparse'
+require 'review/version'
 
 module ReVIEW
   class Epub2Html
@@ -17,13 +19,26 @@ module ReVIEW
     end
 
     def execute(*args)
-      if args[0].nil? || !File.exist?(args[0])
-        STDERR.puts <<EOT
-Usage: #{File.basename($PROGRAM_NAME)} EPUBfile [file_for_head_and_foot] > HTMLfile
+      opts = OptionParser.new
+
+      opts.banner = <<EOT
+Usage: review-epub2html [options] EPUBfile [file_for_head_and_foot] > HTMLfile
        file_for_head_and_foot: HTML file to extract header and footer area.
                                This file must be contained in the EPUB.
                                If omitted, the first found file is used.
+
 EOT
+      opts.version = ReVIEW::VERSION
+      opts.on('--help', 'Prints this message and quit.') do
+        puts opts.help
+        exit 0
+      end
+      opts.on('--inline-footnote', 'Embed footnote blocks in paragraph.') { @inline_footnote = true }
+
+      opts.parse!(args)
+
+      if args[0].nil? || !File.exist?(args[0])
+        puts opts.help
         exit 1
       end
 
@@ -36,6 +51,7 @@ EOT
       @htmls = {}
       @head = nil
       @tail = nil
+      @inline_footnote = nil
     end
 
     def parse_epub(epubname)
@@ -99,6 +115,23 @@ EOT
         e.attributes['href'] = "##{anc}"
       end
 
+      if @inline_footnote
+        # move footnotes to inline as same as LaTeX.
+        footnotes = {}
+
+        doc.each_element("//div[@class='footnote']") do |e|
+          e.name = 'span'
+          e.attributes.delete('epub:type')
+          footnotes[e.attributes['id']] = e
+          e.remove
+        end
+
+        doc.each_element("//a[@class='noteref']") do |e|
+          e.parent.insert_after(e, footnotes[e.attributes['href'].sub('#', '')])
+          e.remove
+        end
+      end
+
       doc.to_s.
         sub(/.*(<body.*?>)/m, %Q(<section id="#{sanitize(fname)}">)).
         sub(%r{(</body>).*}m, '</section>')

data/lib/review/epubmaker.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2010-2018 Kenshi Muto and Masayoshi Takahashi
+# Copyright (c) 2010-2019 Kenshi Muto and Masayoshi Takahashi
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -64,7 +64,45 @@ module ReVIEW
       @producer.load(yamlfile)
       @config = @producer.config
       @config.maker = 'epubmaker'
+    end
+
+    def self.execute(*args)
+      self.new.execute(*args)
+    end
+
+    def parse_opts(args)
+      cmd_config = {}
+      opts = OptionParser.new
+
+      opts.banner = 'Usage: review-epubmaker [options] configfile [export_filename]'
+      opts.version = ReVIEW::VERSION
+      opts.on('--help', 'Prints this message and quit.') do
+        puts opts.help
+        exit 0
+      end
+      opts.on('--[no-]debug', 'Keep temporary files.') { |debug| cmd_config['debug'] = debug }
+
+      opts.parse!(args)
+      if args.size < 1 || args.size > 2
+        puts opts.help
+        exit 0
+      end
+
+      [cmd_config, args[0], args[1]]
+    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)
+
+      load_yaml(yamlfile)
+      @config.deep_merge!(cmd_config)
       update_log_level
+      log("Loaded yaml file (#{yamlfile}).")
+
+      produce(yamlfile, exportfile)
     end
 
     def update_log_level
@@ -89,7 +127,6 @@ module ReVIEW
     end
 
     def produce(yamlfile, bookname = nil)
-      load_yaml(yamlfile)
       I18n.setup(@config['language'])
       bookname ||= @config['bookname']
       booktmpname = "#{bookname}-epub"
@@ -99,7 +136,7 @@ module ReVIEW
       rescue ReVIEW::ConfigError => e
         warn e.message
       end
-      log("Loaded yaml file (#{yamlfile}). I will produce #{bookname}.epub.")
+      log("#{bookname}.epub will be created.")
 
       FileUtils.rm_f("#{bookname}.epub")
       if @config['debug']