review 2.3.0 → 2.4.0

data/lib/review/unfold.rb

@@ -1,7 +1,5 @@
-#
-# $Id: unfold.rb 3878 2008-02-09 13:12:15Z aamine $
-#
-# Copyright (c) 2002-2007 Minero Aoki
+# Copyright (c) 2007-2017 Kenshi Muto
+#               2002-2007 Minero Aoki
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -13,18 +11,16 @@ require 'review/preprocessor'
 require 'stringio'
 
 module ReVIEW
-
   class WrongInput < Error; end
 
   class Unfold
-
     # unfold paragraphs and strip preprocessor tags.
-    def Unfold.unfold_author_source(s)
+    def self.unfold_author_source(s)
       unfold(Preprocessor::Strip.new(StringIO.new(s)))
     end
 
-    def Unfold.unfold(f)
-      new().unfold(f)
+    def self.unfold(f)
+      new.unfold(f)
     end
 
     def initialize(indent_paragraph = false)
@@ -47,14 +43,14 @@ module ReVIEW
 
     private
 
-    ZSPACE = "\241\241" # EUC-JP zen-kaku space
+    ZSPACE = "\241\241".freeze # EUC-JP zen-kaku space
 
     def do_unfold(input)
       @blank_needed = false
       first = true
       indent = @indent_paragraph ? ZSPACE : ''
       f = LineInput.new(input)
-      while line = f.gets
+      f.each_line do |line|
         case line
         when /\A\#@/
           raise "must not happen: input includes preproc directive: #{line.inspect}"
@@ -81,27 +77,25 @@ module ReVIEW
           println line
           skip_block f, /\A:|\A\s+\S/
           blank
-        when %r<\A//\w.*\{\s*\z>
+        when %r{\A//\w.*\{\s*\z}
           blank
           println line
-          f.until_terminator(%r<\A//\}>) do |s|
+          f.until_terminator(%r{\A//\}}) do |s|
             println s
           end
           println '//}'
           blank
-        when %r<\A//\w>
+        when %r{\A//\w}
           blank
           println line
           blank
         when /\A\S/
-          if %r<\A//\[> =~ line
+          if %r{\A//\[} =~ line
             $stderr.puts "warning: #{f.path}:#{f.lineno}: paragraph begin with `//['; missing ReVIEW directive name?"
           end
           flush_blank
           @output.print indent + line.rstrip
-          f.until_match(%r<\A\s*\z|\A//\w>) do |s|
-            @output.print s.rstrip
-          end
+          f.until_match(%r{\A\s*\z|\A//\w}) { |s| @output.print s.rstrip }
           @output.puts
         else
           unless line.strip.empty?
@@ -127,12 +121,9 @@ module ReVIEW
     end
 
     def flush_blank
-      if @blank_needed
-        @output.puts
-        @blank_needed = false
-      end
+      return unless @blank_needed
+      @output.puts
+      @blank_needed = false
     end
-
   end
-
 end # module ReVIEW

data/lib/review/version.rb

@@ -1,3 +1,3 @@
 module ReVIEW
-  VERSION = "2.3.0"
+  VERSION = '2.4.0'.freeze
 end

data/lib/review/webmaker.rb

@@ -1,5 +1,3 @@
-# encoding: 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.
@@ -28,6 +26,7 @@ module ReVIEW
 
     def initialize
       @basedir = nil
+      @logger = ReVIEW.logger
     end
 
     def self.execute(*args)
@@ -38,15 +37,13 @@ module ReVIEW
       cmd_config = {}
       opts = OptionParser.new
 
-      opts.banner = "Usage: review-webmaker configfile"
+      opts.banner = 'Usage: review-webmaker configfile'
       opts.version = ReVIEW::VERSION
       opts.on('--help', 'Prints this message and quit.') do
         puts opts.help
         exit 0
       end
-      opts.on('--ignore-errors', 'Ignore review-compile errors.') do
-        cmd_config["ignore-errors"] = true
-      end
+      opts.on('--ignore-errors', 'Ignore review-compile errors.') { cmd_config['ignore-errors'] = true }
 
       opts.parse!(args)
       if args.size != 1
@@ -54,33 +51,35 @@ module ReVIEW
         exit 0
       end
 
-      return cmd_config, args[0]
+      [cmd_config, args[0]]
     end
 
     def build_path
-      @config["docroot"] || "webroot"
+      @config['docroot'] || 'webroot'
     end
 
     def remove_old_files(path)
+      math_dir = "./#{@config['imagedir']}/_review_math"
+      FileUtils.rm_rf(math_dir) if @config['imgmath'] && Dir.exist?(math_dir)
       FileUtils.rm_rf(path)
     end
 
     def execute(*args)
       @config = ReVIEW::Configure.values
-      @config.maker = "webmaker"
+      @config.maker = 'webmaker'
       cmd_config, yamlfile = parse_opts(args)
 
       @config.merge!(YAML.load_file(yamlfile))
       # YAML configs will be overridden by command line options.
       @config.merge!(cmd_config)
-      @config["htmlext"] = "html"
-      I18n.setup(@config["language"])
+      @config['htmlext'] = 'html'
+      I18n.setup(@config['language'])
       generate_html_files(yamlfile)
     end
 
     def generate_html_files(yamlfile)
       @basedir = File.dirname(yamlfile)
-      @path = build_path()
+      @path = build_path
       remove_old_files(@path)
       Dir.mkdir(@path)
 
@@ -92,56 +91,50 @@ module ReVIEW
       build_body(@path, yamlfile)
       copy_backmatter(@path)
 
-      copy_images(@config["imagedir"], "#{@path}/#{@config["imagedir"]}")
+      copy_images(@config['imagedir'], "#{@path}/#{@config['imagedir']}")
 
-      copy_resources("covers", "#{@path}/#{@config["imagedir"]}")
-      copy_resources("adv", "#{@path}/#{@config["imagedir"]}")
-      copy_resources(@config["fontdir"], "#{@path}/fonts", @config["font_ext"])
+      copy_resources('covers', "#{@path}/#{@config['imagedir']}")
+      copy_resources('adv', "#{@path}/#{@config['imagedir']}")
+      copy_resources(@config['fontdir'], "#{@path}/fonts", @config['font_ext'])
     end
 
-    def build_body(basetmpdir, yamlfile)
+    def build_body(basetmpdir, _yamlfile)
       base_path = Pathname.new(@basedir)
       builder = ReVIEW::HTMLBuilder.new
       @converter = ReVIEW::Converter.new(@book, builder)
       @book.parts.each do |part|
-        htmlfile = nil
         if part.name.present?
           if part.file?
             build_chap(part, base_path, basetmpdir, true)
           else
-            htmlfile = "part_#{part.number}.#{@config["htmlext"]}"
+            htmlfile = "part_#{part.number}.#{@config['htmlext']}"
             build_part(part, basetmpdir, htmlfile)
-            title = ReVIEW::I18n.t("part", part.number)
-            title += ReVIEW::I18n.t("chapter_postfix") + part.name.strip if part.name.strip.present?
+            # title = ReVIEW::I18n.t('part', part.number)
+            # title += ReVIEW::I18n.t('chapter_postfix') + part.name.strip unless part.name.strip.empty?
           end
         end
 
-        part.chapters.each do |chap|
-          build_chap(chap, base_path, basetmpdir, false)
-        end
+        part.chapters.each { |chap| build_chap(chap, base_path, basetmpdir, false) }
       end
     end
 
     def build_part(part, basetmpdir, htmlfile)
-      File.open("#{basetmpdir}/#{htmlfile}", "w") do |f|
-        @body = ""
-        @body << "<div class=\"part\">\n"
-        @body << "<h1 class=\"part-number\">#{ReVIEW::I18n.t("part", part.number)}</h1>\n"
-        if part.name.strip.present?
-          @body << "<h2 class=\"part-title\">#{part.name.strip}</h2>\n"
-        end
+      File.open("#{basetmpdir}/#{htmlfile}", 'w') do |f|
+        @body = ''
+        @body << %Q(<div class="part">\n)
+        @body << %Q(<h1 class="part-number">#{ReVIEW::I18n.t('part', part.number)}</h1>\n)
+        @body << %Q(<h2 class="part-title">#{part.name.strip}</h2>\n) if part.name.strip.present?
         @body << "</div>\n"
 
         @language = @config['language']
-        @stylesheets = @config["stylesheet"]
+        @stylesheets = @config['stylesheet']
         tmplfile = File.expand_path(template_name, ReVIEW::Template::TEMPLATE_DIR)
-        tmpl = ReVIEW::Template.load(tmplfile)
-        f.write tmpl.result(binding)
+        f.write ReVIEW::Template.load(tmplfile).result(binding)
       end
     end
 
     def template_name
-      if @config["htmlversion"].to_i == 5
+      if @config['htmlversion'].to_i == 5
         'web/html/layout-html5.html.erb'
       else
         'web/html/layout-xhtml1.html.erb'
@@ -149,41 +142,39 @@ module ReVIEW
     end
 
     def build_chap(chap, base_path, basetmpdir, ispart)
-      filename = ""
+      filename = ''
 
       if ispart.present?
         filename = chap.path
       else
         filename = Pathname.new(chap.path).relative_path_from(base_path).to_s
       end
-      id = filename.sub(/\.re\Z/, "")
+      id = filename.sub(/\.re\Z/, '')
 
-      htmlfile = "#{id}.#{@config["htmlext"]}"
+      htmlfile = "#{id}.#{@config['htmlext']}"
 
-      if @config["params"].present?
-        warn "'params:' in config.yml is obsoleted."
+      if @config['params'].present?
+        @logger.warn %Q('params:' in config.yml is obsoleted.)
       end
 
       begin
         @converter.convert(filename, File.join(basetmpdir, htmlfile))
       rescue => e
-        warn "compile error in #{filename} (#{e.class})"
-        warn e.message
+        @logger.warn "compile error in #{filename} (#{e.class})"
+        @logger.warn e.message
       end
     end
 
     def copy_images(resdir, destdir)
       return nil unless File.exist?(resdir)
-      allow_exts = @config["image_ext"]
+      allow_exts = @config['image_ext']
       FileUtils.mkdir_p(destdir)
       recursive_copy_files(resdir, destdir, allow_exts)
     end
 
-    def copy_resources(resdir, destdir, allow_exts=nil)
-      if !resdir || !File.exist?(resdir)
-        return nil
-      end
-      allow_exts = @config["image_ext"] if allow_exts.nil?
+    def copy_resources(resdir, destdir, allow_exts = nil)
+      return nil if !resdir || !File.exist?(resdir)
+      allow_exts = @config['image_ext'] if allow_exts.nil?
       FileUtils.mkdir_p(destdir)
       recursive_copy_files(resdir, destdir, allow_exts)
     end
@@ -194,107 +185,92 @@ module ReVIEW
           next if fname.start_with?('.')
           if FileTest.directory?("#{resdir}/#{fname}")
             recursive_copy_files("#{resdir}/#{fname}", "#{destdir}/#{fname}", allow_exts)
-          else
-            if fname =~ /\.(#{allow_exts.join("|")})\Z/i
-              FileUtils.mkdir_p(destdir)
-              FileUtils.cp("#{resdir}/#{fname}", destdir)
-            end
+          elsif fname =~ /\.(#{allow_exts.join('|')})\Z/i
+            FileUtils.mkdir_p(destdir)
+            FileUtils.cp("#{resdir}/#{fname}", destdir)
           end
         end
       end
     end
 
     def copy_stylesheet(basetmpdir)
-      if @config["stylesheet"].size > 0
-        @config["stylesheet"].each do |sfile|
-          FileUtils.cp(sfile, basetmpdir)
-        end
-      end
+      @config['stylesheet'].each { |sfile| FileUtils.cp(sfile, basetmpdir) } if @config['stylesheet'].size > 0
     end
 
     def copy_frontmatter(basetmpdir)
       build_indexpage(basetmpdir)
 
-      if @config["titlepage"]
-        if @config["titlefile"]
-          FileUtils.cp(@config["titlefile"], "#{basetmpdir}/titlepage.#{@config["htmlext"]}")
+      if @config['titlepage']
+        if @config['titlefile']
+          FileUtils.cp(@config['titlefile'], "#{basetmpdir}/titlepage.#{@config['htmlext']}")
         else
-          build_titlepage(basetmpdir, "titlepage.#{@config["htmlext"]}")
+          build_titlepage(basetmpdir, "titlepage.#{@config['htmlext']}")
         end
       end
 
-      copy_file_with_param("creditfile")
-      copy_file_with_param("originaltitlefile")
+      copy_file_with_param('creditfile')
+      copy_file_with_param('originaltitlefile')
     end
 
     def build_indexpage(basetmpdir)
-      File.open("#{basetmpdir}/index.html", "w") do |f|
-        if @config["coverimage"]
-          file = File.join(@config["imagedir"], @config["coverimage"])
+      File.open("#{basetmpdir}/index.html", 'w') do |f|
+        if @config['coverimage']
+          file = File.join(@config['imagedir'], @config['coverimage'])
           @body = <<-EOT
   <div id="cover-image" class="cover-image">
     <img src="#{file}" class="max"/>
   </div>
         EOT
         else
-          @body = ""
+          @body = ''
         end
         @language = @config['language']
-        @stylesheets = @config["stylesheet"]
+        @stylesheets = @config['stylesheet']
         @toc = ReVIEW::WEBTOCPrinter.book_to_string(@book)
         @next = @book.chapters[0]
-        @next_title = @next ? @next.title : ""
+        @next_title = @next ? @next.title : ''
         tmplfile = File.expand_path(template_name, ReVIEW::Template::TEMPLATE_DIR)
-        tmpl = ReVIEW::Template.load(tmplfile)
-        f.write tmpl.result(binding)
+        f.write ReVIEW::Template.load(tmplfile).result(binding)
       end
     end
 
     def build_titlepage(basetmpdir, htmlfile)
-      File.open("#{basetmpdir}/#{htmlfile}", "w") do |f|
-        @body = ""
-        @body << "<div class=\"titlepage\">"
-        @body << "<h1 class=\"tp-title\">#{CGI.escapeHTML(@config["booktitle"])}</h1>"
-        if @config["aut"]
-          @body << "<h2 class=\"tp-author\">#{join_with_separator(@config["aut"], ReVIEW::I18n.t("names_splitter"))}</h2>"
-        end
-        if @config["prt"]
-          @body << "<h3 class=\"tp-publisher\">#{join_with_separator(@config["prt"], ReVIEW::I18n.t("names_splitter"))}</h3>"
-        end
-        @body << "</div>"
+      File.open("#{basetmpdir}/#{htmlfile}", 'w') do |f|
+        @body = ''
+        @body << %Q(<div class="titlepage">)
+        @body << %Q(<h1 class="tp-title">#{CGI.escapeHTML(@config.name_of('booktitle'))}</h1>)
+        @body << %Q(<h2 class="tp-author">#{join_with_separator(@config.names_of('aut'), ReVIEW::I18n.t('names_splitter'))}</h2>) if @config['aut']
+        @body << %Q(<h3 class="tp-publisher">#{join_with_separator(@config.names_of('prt'), ReVIEW::I18n.t('names_splitter'))}</h3>) if @config['prt']
+        @body << '</div>'
 
         @language = @config['language']
-        @stylesheets = @config["stylesheet"]
+        @stylesheets = @config['stylesheet']
         tmplfile = File.expand_path(template_name, ReVIEW::Template::TEMPLATE_DIR)
-        tmpl = ReVIEW::Template.load(tmplfile)
-        f.write tmpl.result(binding)
+        f.write ReVIEW::Template.load(tmplfile).result(binding)
       end
     end
 
-    def copy_backmatter(basetmpdir)
-      copy_file_with_param("profile")
-      copy_file_with_param("advfile")
-      if @config["colophon"] && @config["colophon"].kind_of?(String)
-        copy_file_with_param("colophon", "colophon.#{@config["htmlext"]}")
+    def copy_backmatter(_basetmpdir)
+      copy_file_with_param('profile')
+      copy_file_with_param('advfile')
+      if @config['colophon'] && @config['colophon'].is_a?(String)
+        copy_file_with_param('colophon', "colophon.#{@config['htmlext']}")
       end
-      copy_file_with_param("backcover")
+      copy_file_with_param('backcover')
     end
 
     def copy_file_with_param(name, target_file = nil)
-      if @config[name] && File.exist?(@config[name])
-        target_file ||= File.basename(@config[name])
-        FileUtils.cp(@config[name], File.join(basetmpdir, target_file))
-      end
+      return if @config[name].nil? || !File.exist?(@config[name])
+      target_file ||= File.basename(@config[name])
+      FileUtils.cp(@config[name], File.join(basetmpdir, target_file))
     end
 
     def join_with_separator(value, sep)
-      if value.kind_of? Array
+      if value.is_a?(Array)
         value.join(sep)
       else
         value
       end
     end
-
   end
 end
-

data/lib/review/webtocprinter.rb

@@ -14,7 +14,7 @@ module ReVIEW
 
     def print_book(book)
       @out.puts '<ul class="book-toc">'
-      @out.puts "<li><a href=\"index.html\">TOP</a></li>\n"
+      @out.puts %Q(<li><a href="index.html">TOP</a></li>\n)
       book.each_part do |part|
         print_part(part)
       end
@@ -24,32 +24,27 @@ module ReVIEW
     def print_part(part)
       if part.number
         if part.file?
-          ext = part.book.config["htmlext"] || "html"
-          path = part.path.sub(/\.re/, "."+ext)
-          @out.puts "<li><a href=\"#{path}\">#{h(I18n.t("part_short", part.number) + " " + part.title)}</a>\n<ul>\n"
+          ext = part.book.config['htmlext'] || 'html'
+          path = part.path.sub(/\.re/, '.' + ext)
+          @out.puts %Q(<li><a href="#{path}">#{h(I18n.t('part_short', part.number) + ' ' + part.title)}</a>\n<ul>\n)
         else
-          @out.puts "<li>#{h(I18n.t("part_short", part.number) + " " + part.title)}\n<ul>\n"
+          @out.puts %Q(<li>#{h(I18n.t('part_short', part.number) + ' ' + part.title)}\n<ul>\n)
         end
       end
-      part.each_chapter do |chap|
-        print_chapter(chap)
-      end
-      if part.number
-        @out.puts "</ul>\n</li>\n"
-      end
+      part.each_chapter { |chap| print_chapter(chap) }
+      @out.puts "</ul>\n</li>\n" if part.number
     end
 
     def print_chapter(chap)
       chap_node = TOCParser.chapter_node(chap)
-      ext = chap.book.config["htmlext"] || "html"
-      path = chap.path.sub(/\.re/, "."+ext)
-      if chap_node.number && chap.on_CHAPS?
-        label = "#{I18n.t("chapter_short", chap.number)} #{chap.title}"
-      else
-        label = chap.title
-      end
-      @out.puts "<li><a href=\"#{path}\">#{h(label)}</a></li>\n"
+      ext = chap.book.config['htmlext'] || 'html'
+      path = chap.path.sub(/\.re/, '.' + ext)
+      label = if chap_node.number && chap.on_chaps?
+                "#{I18n.t('chapter_short', chap.number)} #{chap.title}"
+              else
+                chap.title
+              end
+      @out.puts %Q(<li><a href="#{path}">#{h(label)}</a></li>\n)
     end
-
   end
 end