review 2.3.0 → 2.4.0

data/lib/review/latexindex.rb

@@ -1,7 +1,5 @@
-#
-# $Id: latexindex.rb 2204 2006-03-18 06:10:26Z aamine $
-#
-# Copyright (c) 2002-2006 Minero Aoki
+# Copyright (c) 2017 Minero Aoki, Kenshi Muto
+#               2002-2006 Minero Aoki
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -10,9 +8,7 @@
 #
 
 module ReVIEW
-
   class LaTeXIndex
-
     def load(path)
       table = {}
       File.foreach(path) do |line|
@@ -29,7 +25,5 @@ module ReVIEW
     def [](key)
       @table.fetch(key)
     end
-
   end
-
 end

data/lib/review/latexutils.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 # Copyright (c) 2002-2006 Minero Aoki
 # Copyright (c) 2006-2017 Minero Aoki, Kenshi Muto and Masayoshi Takahashi
 #
@@ -12,13 +10,11 @@
 require 'nkf'
 
 module ReVIEW
-
   module LaTeXUtils
-
     def initialize_metachars(texcommand)
       @metachars = {
         '#' => '\#',
-        "$" => '\textdollar{}',
+        '$' => '\textdollar{}',
         '%' => '\%',
         '&' => '\&',
         '{' => '\{',
@@ -29,36 +25,36 @@ module ReVIEW
         '|' => '\textbar{}',
         '<' => '\textless{}',
         '>' => '\textgreater{}',
-        "\\" => '\reviewbackslash{}',
-        "-" => '{-}'
+        '\\' => '\reviewbackslash{}',
+        '-' => '{-}'
       }
 
-      if File.basename(texcommand, ".*") == "platex"
-        @metachars.merge!({
-                            '⓪' => '\UTF{24EA}',
-                            '①' => '\UTF{2460}',
-                            '②' => '\UTF{2461}',
-                            '③' => '\UTF{2462}',
-                            '④' => '\UTF{2463}',
-                            '⑤' => '\UTF{2464}',
-                            '⑥' => '\UTF{2465}',
-                            '⑦' => '\UTF{2466}',
-                            '⑧' => '\UTF{2467}',
-                            '⑨' => '\UTF{2468}',
-                            '⑩' => '\UTF{2469}',
-                            '⑪' => '\UTF{246A}',
-                            '⑫' => '\UTF{246B}',
-                            '⑬' => '\UTF{246C}',
-                            '⑭' => '\UTF{246D}',
-                            '⑮' => '\UTF{246E}',
-                            '⑯' => '\UTF{246F}'
-                          })
-
-        kanalist = %w{｡ ｢ ｣ ､ ･ ｦ ｧ ｨ ｩ ｪ ｫ ｬ ｭ ｮ ｯ ｰ ｱ ｲ ｳ ｴ
+      if File.basename(texcommand, '.*') == 'platex'
+        @metachars.merge!(
+          '⓪' => '\UTF{24EA}',
+          '①' => '\UTF{2460}',
+          '②' => '\UTF{2461}',
+          '③' => '\UTF{2462}',
+          '④' => '\UTF{2463}',
+          '⑤' => '\UTF{2464}',
+          '⑥' => '\UTF{2465}',
+          '⑦' => '\UTF{2466}',
+          '⑧' => '\UTF{2467}',
+          '⑨' => '\UTF{2468}',
+          '⑩' => '\UTF{2469}',
+          '⑪' => '\UTF{246A}',
+          '⑫' => '\UTF{246B}',
+          '⑬' => '\UTF{246C}',
+          '⑭' => '\UTF{246D}',
+          '⑮' => '\UTF{246E}',
+          '⑯' => '\UTF{246F}'
+        )
+
+        kanalist = %w[｡ ｢ ｣ ､ ･ ｦ ｧ ｨ ｩ ｪ ｫ ｬ ｭ ｮ ｯ ｰ ｱ ｲ ｳ ｴ
                       ｵ ｶ ｷ ｸ ｹ ｺ ｻ ｼ ｽ ｾ ｿ ﾀ ﾁ ﾂ ﾃ ﾄ ﾅ ﾆ ﾇ ﾈ ﾉ ﾊ ﾋ ﾌ ﾍ ﾎ ﾏ
-                      ﾐ ﾑ ﾒ ﾓ ﾔ ﾕ ﾖ ﾗ ﾘ ﾙ ﾚ ﾛ ﾜ ﾝ ﾞ ﾟ}
+                      ﾐ ﾑ ﾒ ﾓ ﾔ ﾕ ﾖ ﾗ ﾘ ﾙ ﾚ ﾛ ﾜ ﾝ ﾞ ﾟ]
         kanalist.each do |char|
-          char_jisx0208 = NKF.nkf('-WwX',char)
+          char_jisx0208 = NKF.nkf('-WwX', char)
           @metachars[char] = "\\aj半角{#{char_jisx0208}}"
         end
       end
@@ -69,34 +65,28 @@ module ReVIEW
     end
 
     def escape_latex(str)
-      str.gsub(@metachars_re) {|s|
-        @metachars[s] or raise "unknown trans char: #{s}"
-      }
+      str.gsub(@metachars_re) { |s| @metachars[s] or raise "unknown trans char: #{s}" }
     end
 
     alias_method :escape, :escape_latex
 
     def unescape_latex(str)
-      metachars_invert_re = Regexp.new(@metachars_invert.keys.collect{|key| Regexp.escape(key)}.join('|'))
-      str.gsub(metachars_invert_re) {|s|
-        @metachars_invert[s] or raise "unknown trans char: #{s}"
-      }
+      metachars_invert_re = Regexp.new(@metachars_invert.keys.collect { |key| Regexp.escape(key) }.join('|'))
+      str.gsub(metachars_invert_re) { |s| @metachars_invert[s] or raise "unknown trans char: #{s}" }
     end
 
     alias_method :unescape, :unescape_latex
 
     def escape_index(str)
-      str.gsub(/[@!|"]/) {|s| '"' + s }
+      str.gsub(/[@!|"]/) { |s| '"' + s }
     end
 
     def escape_url(str)
-      str.gsub(/[\#%]/) {|s| '\\'+s }
+      str.gsub(/[\#%]/) { |s| '\\' + s }
     end
 
     def macro(name, *args)
-      "\\#{name}" + args.map {|a| "{#{a}}" }.join('')
+      "\\#{name}" + args.map { |a| "{#{a}}" }.join
     end
-
   end
-
 end

data/lib/review/lineinput.rb

@@ -4,7 +4,7 @@ module ReVIEW
   class LineInput < LineInput
     def skip_comment_lines
       n = 0
-      while line = gets()
+      while line = gets
         unless line.strip =~ /\A\#@/
           ungets line
           return n

data/lib/review/logger.rb

@@ -0,0 +1,21 @@
+require 'logger'
+
+module ReVIEW
+  class Logger < ::Logger
+    def initialize(*logdev)
+      if logdev.empty?
+        super(STDERR, formatter: ->(severity, _datetime, _progname, msg) { "#{severity}: #{msg}\n" })
+      else
+        super
+      end
+    end
+  end
+
+  def self.logger
+    @logger ||= ReVIEW::Logger.new
+  end
+
+  def self.logger=(logger)
+    @logger = logger
+  end
+end

data/lib/review/makerhelper.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 # Copyright (c) 2012-2017 Yuto HAYAMIZU, Kenshi Muto
 #
 # This program is free software.
@@ -53,7 +51,7 @@ module ReVIEW
               image_files << "#{from_dir}/#{fname}.#{conv_type}"
             end
 
-            exts = options[:exts] || %w(png gif jpg jpeg svg pdf eps ai tif)
+            exts = options[:exts] || %w[png gif jpg jpeg svg pdf eps ai tif]
             exts_str = exts.join('|')
             if !is_converted && fname =~ /\.(#{exts_str})$/i
               FileUtils.cp "#{from_dir}/#{fname}", to_dir
@@ -66,6 +64,5 @@ module ReVIEW
       image_files
     end
     module_function :copy_images_to_dir
-
   end
 end

data/lib/review/markdownbuilder.rb

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-
 # 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.
@@ -9,7 +7,6 @@ require 'review/textutils'
 require 'review/htmlutils'
 
 module ReVIEW
-
   class MARKDOWNBuilder < Builder
     include TextUtils
     include HTMLUtils
@@ -21,7 +18,7 @@ module ReVIEW
     def builder_init_file
       @blank_seen = nil
       @ul_indent = 0
-      @chapter.book.image_types = %w(.png .jpg .jpeg .gif .svg)
+      @chapter.book.image_types = %w[.png .jpg .jpeg .gif .svg]
     end
     private :builder_init_file
 
@@ -35,16 +32,16 @@ module ReVIEW
       @blank_seen = true
     end
 
-    def headline(level, label, caption)
+    def headline(level, _label, caption)
       blank
-      prefix = "#" * level
+      prefix = '#' * level
       puts "#{prefix} #{caption}"
       blank
     end
 
     def quote(lines)
       blank
-      puts split_paragraph(lines).map{|line| "> #{line}"}.join("\n> \n")
+      puts split_paragraph(lines).map { |line| "> #{line}" }.join("\n> \n")
       blank
     end
 
@@ -55,15 +52,15 @@ module ReVIEW
 
     def list_header(id, caption, lang)
       if get_chap.nil?
-        print %Q[リスト#{@chapter.list(id).number} #{compile_inline(caption)}\n\n]
+        print %Q(リスト#{@chapter.list(id).number} #{compile_inline(caption)}\n\n)
       else
-        print %Q[リスト#{get_chap}.#{@chapter.list(id).number} #{compile_inline(caption)}\n\n]
+        print %Q(リスト#{get_chap}.#{@chapter.list(id).number} #{compile_inline(caption)}\n\n)
       end
-      lang ||= ""
+      lang ||= ''
       puts "```#{lang}"
     end
 
-    def list_body(id, lines, lang)
+    def list_body(_id, lines, _lang)
       lines.each do |line|
         puts detab(line)
       end
@@ -76,7 +73,7 @@ module ReVIEW
     end
 
     def ul_item_begin(lines)
-      puts "  " * (@ul_indent - 1) + "* " + "#{lines.join}"
+      puts '  ' * (@ul_indent - 1) + '* ' + lines.join
     end
 
     def ul_item_end
@@ -121,17 +118,17 @@ module ReVIEW
         puts caption
         print "\n"
       end
-      lang ||= ""
+      lang ||= ''
       puts "```#{lang}"
       lines.each do |line|
         puts detab(line)
       end
-      puts "```"
+      puts '```'
       blank
     end
 
     def hr
-      puts "----"
+      puts '----'
     end
 
     def compile_href(url, label)
@@ -163,43 +160,41 @@ module ReVIEW
       "`#{str}`"
     end
 
-    def image_image(id, caption, metric)
+    def image_image(id, caption, _metric)
       blank
-      puts "![#{compile_inline(caption)}](#{@chapter.image(id).path.sub(/\A\.\//, "")})"
+      puts "![#{compile_inline(caption)}](#{@chapter.image(id).path.sub(%r{\A\./}, '')})"
       blank
     end
 
-    def image_dummy(id, caption, lines)
+    def image_dummy(_id, _caption, lines)
       puts lines.join
     end
 
     def inline_img(id)
-      "#{I18n.t("image")}#{@chapter.image(id).number}"
+      "#{I18n.t('image')}#{@chapter.image(id).number}"
     rescue KeyError
       error "unknown image: #{id}"
       nofunc_text("[UnknownImage:#{id}]")
     end
 
-    def indepimage(id, caption="", metric=nil)
+    def indepimage(_lines, id, caption = '', _metric = nil)
       blank
-      puts "![#{compile_inline(caption)}](#{@chapter.image(id).path.sub(/\A\.\//, "")})"
+      puts "![#{compile_inline(caption)}](#{@chapter.image(id).path.sub(%r{\A\./}, '')})"
       blank
     end
 
     def pagebreak
-      puts "{pagebreak}"
+      puts '{pagebreak}'
     end
 
     def image_ext
-      "jpg"
+      'jpg'
     end
 
     def cmd(lines)
-      puts "```shell-session"
-      lines.each do |line|
-        puts detab(line)
-      end
-      puts "```"
+      puts '```shell-session'
+      lines.each { |line| puts detab(line) }
+      puts '```'
     end
 
     def table(lines, id = nil, caption = nil)
@@ -208,11 +203,11 @@ module ReVIEW
       lines.each_with_index do |line, idx|
         if /\A[\=\-]{12}/ =~ line
           # just ignore
-          #error "too many table separator" if sepidx
+          # error "too many table separator" if sepidx
           sepidx ||= idx
           next
         end
-        rows.push(line.strip.split(/\t+/).map {|s| s.sub(/\A\./, '') })
+        rows.push(line.strip.split(/\t+/).map { |s| s.sub(/\A\./, '') })
       end
       rows = adjust_n_cols(rows)
 
@@ -225,16 +220,16 @@ module ReVIEW
       return if rows.empty?
       if sepidx
         sepidx.times do
-          tr(rows.shift.map {|s| th(s) })
+          tr(rows.shift.map { |s| th(s) })
         end
         table_border rows.first.size
         rows.each do |cols|
-          tr(cols.map {|s| td(s) })
+          tr(cols.map { |s| td(s) })
         end
       else
         rows.each do |cols|
           h, *cs = *cols
-          tr([th(h)] + cs.map {|s| td(s) })
+          tr([th(h)] + cs.map { |s| td(s) })
         end
       end
       table_end
@@ -243,12 +238,10 @@ module ReVIEW
     def table_header(id, caption)
       if id.nil?
         puts compile_inline(caption)
+      elsif get_chap
+        puts %Q(#{I18n.t('table')}#{I18n.t('format_number_header', [get_chap, @chapter.table(id).number])}#{I18n.t('caption_prefix')}#{compile_inline(caption)})
       else
-        if get_chap.nil?
-          puts %Q[#{I18n.t("table")}#{I18n.t("format_number_header_without_chapter", [@chapter.table(id).number])}#{I18n.t("caption_prefix")}#{compile_inline(caption)}]
-        else
-          puts %Q[#{I18n.t("table")}#{I18n.t("format_number_header", [get_chap, @chapter.table(id).number])}#{I18n.t("caption_prefix")}#{compile_inline(caption)}]
-        end
+        puts %Q(#{I18n.t('table')}#{I18n.t('format_number_header_without_chapter', [@chapter.table(id).number])}#{I18n.t('caption_prefix')}#{compile_inline(caption)})
       end
       blank
     end
@@ -257,19 +250,19 @@ module ReVIEW
     end
 
     def tr(rows)
-      puts "|#{rows.join("|")}|"
+      puts "|#{rows.join('|')}|"
     end
 
     def table_border(ncols)
-      puts (0..ncols).map{"|"}.join(":--")
+      puts((0..ncols).map { '|' }.join(':--'))
     end
 
     def th(str)
-      "#{str}"
+      str
     end
 
     def td(str)
-      "#{str}"
+      str
     end
 
     def table_end
@@ -285,7 +278,7 @@ module ReVIEW
       "[^#{id}]"
     end
 
-    def inline_br(str)
+    def inline_br(_str)
       "\n"
     end
 
@@ -295,28 +288,26 @@ module ReVIEW
 
     def compile_ruby(base, ruby)
       if @book.htmlversion == 5
-        %Q[<ruby>#{escape_html(base)}<rp>#{I18n.t("ruby_prefix")}</rp><rt>#{escape_html(ruby)}</rt><rp>#{I18n.t("ruby_postfix")}</rp></ruby>]
+        %Q(<ruby>#{escape_html(base)}<rp>#{I18n.t('ruby_prefix')}</rp><rt>#{escape_html(ruby)}</rt><rp>#{I18n.t('ruby_postfix')}</rp></ruby>)
       else
-        %Q[<ruby><rb>#{escape_html(base)}</rb><rp>#{I18n.t("ruby_prefix")}</rp><rt>#{ruby}</rt><rp>#{I18n.t("ruby_postfix")}</rp></ruby>]
+        %Q(<ruby><rb>#{escape_html(base)}</rb><rp>#{I18n.t('ruby_prefix')}</rp><rt>#{ruby}</rt><rp>#{I18n.t('ruby_postfix')}</rp></ruby>)
       end
     end
 
     def comment(lines, comment = nil)
-      if @book.config["draft"]
-        lines ||= []
-        lines.unshift comment unless comment.blank?
-        str = lines.join("<br />")
-        puts %Q(<div class="red">#{escape_html(str)}</div>)
-      end
+      return unless @book.config['draft']
+      lines ||= []
+      lines.unshift comment unless comment.blank?
+      str = lines.join('<br />')
+      puts %Q(<div class="red">#{escape_html(str)}</div>)
     end
 
     def inline_comment(str)
-      if @book.config["draft"]
+      if @book.config['draft']
         %Q(<span class="red">#{escape_html(str)}</span>)
       else
         ''
       end
     end
   end
-
 end # module ReVIEW