review 2.3.0 → 2.4.0

data/bin/review-checkdep

@@ -1,8 +1,7 @@
 #!/usr/bin/env ruby
 #
-# $Id: review-checkdep 3748 2007-12-24 07:06:06Z aamine $
-#
-# Copyright (c) 1999-2007 Minero Aoki
+# Copyright (c) 2007-2017 Minero Aoki, Kenshi Muto
+#               1999-2007 Minero Aoki
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -15,42 +14,38 @@ require 'pathname'
 bindir = Pathname.new(__FILE__).realpath.dirname
 $LOAD_PATH.unshift((bindir + '../lib').realpath)
 
-PREDEF_FILE = 'PREDEF'
+PREDEF_FILE = 'PREDEF'.freeze
 
 def main
-  @provided = parse_predefined()
+  @provided = parse_predefined
   @unprovided = {}
   ARGF.each do |line|
     case line
     when /\A\#@require\((.*)\)/
       kw = $1
       unless @provided.key?(kw)
-        puts "#{location()}: not provided: #{kw}"
-        @unprovided[kw] = location()
+        puts "#{location}: not provided: #{kw}"
+        @unprovided[kw] = location
       end
     when /\A\#@provide\((.*)\)/
       provide $1
     else
-      line.scan(/@<kw>\{(.*?)[,\}]/) do
-        provide $1
-      end
+      line.scan(/@<kw>\{(.*?)[,\}]/) { provide $1 }
     end
   end
 end
 
 def provide(kw)
-  @provided[kw] ||= location()
+  @provided[kw] ||= location
   if @unprovided[kw]
     reqpos = @unprovided.delete(kw)
-    puts "#{location()}: provided now: #{kw} (#{reqpos})"
+    puts "#{location}: provided now: #{kw} (#{reqpos})"
   end
 end
 
 def parse_predefined
   result = {}
-  File.foreach(PREDEF_FILE) do |line|
-    result[line.strip] = '(predefined)'
-  end
+  File.foreach(PREDEF_FILE) { |line| result[line.strip] = '(predefined)' }
   result
 rescue Errno::ENOENT
   return {}

data/bin/review-compile

@@ -1,7 +1,5 @@
 #!/usr/bin/env ruby
 #
-# $Id: review-compile 4326 2010-01-12 14:10:17Z kmuto $
-#
 # Copyright (c) 2008-2017 Kenshi Muto, Masayoshi Takahashi, KADO Masanori, Minero Aoki
 # Copyright (c) 1999-2007 Minero Aoki
 #
@@ -21,7 +19,7 @@ require 'fileutils'
 require 'optparse'
 require 'yaml'
 
-DEFAULT_CONFIG_FILENAME = "config.yml"
+DEFAULT_CONFIG_FILENAME = 'config.yml'.freeze
 
 def main
   Signal.trap(:INT) { exit 1 }
@@ -34,10 +32,11 @@ rescue Errno::EPIPE
 end
 
 def _main
+  @logger = ReVIEW.logger
   mode = :files
   basedir = nil
-  if /\Areview2/ =~ File.basename($0)
-    target = File.basename($0, '.rb').sub(/review2/, '')
+  if /\Areview2/ =~ File.basename($PROGRAM_NAME)
+    target = File.basename($PROGRAM_NAME, '.rb').sub('review2', '')
   else
     target = nil
   end
@@ -48,90 +47,79 @@ def _main
 
   opts = OptionParser.new
   opts.version = ReVIEW::VERSION
-  opts.banner = "Usage: #{File.basename($0)} [--target=FMT]"
-  opts.on('--yaml=YAML', 'Read configurations from YAML file.') {|yaml| config["yaml"] = yaml}
+  opts.banner = "Usage: #{File.basename($PROGRAM_NAME)} [--target=FMT]"
+  opts.on('--yaml=YAML', 'Read configurations from YAML file.') { |yaml| config['yaml'] = yaml }
   opts.on('-c', '--check', 'Check manuscript') { check_only = true }
-  opts.on('--level=LVL', 'Section level to append number.') {|lvl| config["secnolevel"] = lvl.to_i }
-  opts.on('--toclevel=LVL', 'Section level to append number.') {|lvl| config["toclevel"] = lvl.to_i }
-  opts.on('--structuredxml', 'Produce XML with structured sections. (idgxml)') { config["structuredxml"] = true }
-  opts.on('--table=WIDTH', 'Default table width. (idgxml)') {|tbl| config["tableopt"] = tbl }
-  opts.on('--listinfo', 'Append listinfo tag to lists to indicate begin/end. (idgxml)') { config["listinfo"] = true }
-  opts.on('--chapref="before,middle,after"', 'Chapref decoration. (idgxml)') {|cdec| config["chapref"] = cdec }
-  opts.on('--chapterlink', 'make chapref hyperlink') { config["chapterlink"] = true }
-  opts.on('--stylesheet=file', 'Stylesheet file for HTML (comma separated)') {|files| config["stylesheet"] = files.split(/\s*,\s*/) }
-  opts.on('--mathml', 'Use MathML for TeX equation in HTML') do
-    config["mathml"] = true
-  end
+  opts.on('--level=LVL', 'Section level to append number.') { |lvl| config['secnolevel'] = lvl.to_i }
+  opts.on('--toclevel=LVL', 'Section level to append number.') { |lvl| config['toclevel'] = lvl.to_i }
+  opts.on('--structuredxml', 'Produce XML with structured sections. (idgxml)') { config['structuredxml'] = true }
+  opts.on('--table=WIDTH', 'Default table width. (idgxml)') { |tbl| config['tableopt'] = tbl }
+  opts.on('--listinfo', 'Append listinfo tag to lists to indicate begin/end. (idgxml)') { config['listinfo'] = true }
+  opts.on('--chapref="before,middle,after"', 'Chapref decoration. (idgxml)') { |cdec| config['chapref'] = cdec }
+  opts.on('--chapterlink', 'make chapref hyperlink') { config['chapterlink'] = true }
+  opts.on('--stylesheet=file', 'Stylesheet file for HTML (comma separated)') { |files| config['stylesheet'] = files.split(/\s*,\s*/) }
+  opts.on('--mathml', 'Use MathML for TeX equation in HTML') { config['mathml'] = true }
   opts.on('--htmlversion=VERSION', 'HTML version.') do |v|
     v = v.to_i
-    config["htmlversion"] = v if v == 4 || v == 5
+    config['htmlversion'] = v if [4, 5].include?(v)
   end
   opts.on('--epubversion=VERSION', 'EPUB version.') do |v|
     v = v.to_i
-    config["epubversion"] = v if v == 2 || v == 3
+    config['epubversion'] = v if [2, 3].include?(v)
   end
-  opts.on('--target=FMT', 'Target format.') {|fmt| target = fmt } unless target
+  opts.on('--target=FMT', 'Target format.') { |fmt| target = fmt } unless target
   opts.on('--footnotetext',
-          'Use footnotetext and footnotemark instead of footnote (latex)') {
-    config["footnotetext"] = true
-  }
-  opts.on('--draft', 'use draft mode(inline comment)') { config["draft"] = true }
+          'Use footnotetext and footnotemark instead of footnote (latex)') { config['footnotetext'] = true }
+  opts.on('--draft', 'use draft mode(inline comment)') { config['draft'] = true }
   opts.on('--directory=DIR', 'Compile all chapters in DIR.') do |path|
     mode = :dir
     basedir = path
   end
-  opts.on('--output-file=FILENAME', 'Write all results into file instead of stdout.') do |filename|
-    output_filename = filename
-  end
-  opts.on('--tabwidth=WIDTH', 'tab width') {|width| config["tabwidth"] = width.to_i }
-  opts.on('--catalogfile=FILENAME', 'Set catalog file') do |catalogfile|
-    config["catalogfile"] = catalogfile
-  end
+  opts.on('--output-file=FILENAME', 'Write all results into file instead of stdout.') { |filename| output_filename = filename }
+  opts.on('--tabwidth=WIDTH', 'tab width') { |width| config['tabwidth'] = width.to_i }
+  opts.on('--catalogfile=FILENAME', 'Set catalog file') { |catalogfile| config['catalogfile'] = catalogfile }
   opts.on('--help', 'Prints this message and quit.') do
     puts opts.help
     exit 0
   end
   begin
     opts.parse!
+
     unless target
       if check_only
         target = 'html'
       else
-        raise OptionParser::ParseError, "no target given"
+        raise OptionParser::ParseError, 'no target given'
       end
     end
   rescue OptionParser::ParseError => err
-    error err.message
+    @logger.error(err.message)
     $stderr.puts opts.help
     exit 1
   end
 
   begin
     loader = ReVIEW::YAMLLoader.new
-    if config["yaml"]
-      config.deep_merge!(loader.load_file(config["yaml"]))
-    else
-      if File.exist?(DEFAULT_CONFIG_FILENAME)
-        config.deep_merge!(loader.load_file(DEFAULT_CONFIG_FILENAME))
-      end
+    if config['yaml']
+      config.deep_merge!(loader.load_file(config['yaml']))
+    elsif File.exist?(DEFAULT_CONFIG_FILENAME)
+      config.deep_merge!(loader.load_file(DEFAULT_CONFIG_FILENAME))
     end
 
-    config["builder"] = target
-    ReVIEW::I18n.setup(config["language"])
+    config['builder'] = target
+    ReVIEW::I18n.setup(config['language'])
     begin
       config.check_version(ReVIEW::VERSION)
     rescue ReVIEW::ConfigError => e
-      warn e.message
+      @logger.warn e.message
     end
 
-    if ARGV.blank?
-      mode = :dir
-    end
+    mode = :dir if ARGV.blank?
 
     case mode
     when :files
       if ARGV.empty?
-        error 'no input'
+        @logger.error('no input')
         exit 1
       end
 
@@ -167,24 +155,18 @@ def _main
     end
   rescue ReVIEW::ApplicationError => err
     raise if $DEBUG
-    error err.message
+    @logger.error(err.message)
     exit 1
   end
 end
 
-def error(msg)
-  $stderr.puts "#{File.basename($0, '.*')}: error: #{msg}"
-end
-
 def load_strategy_class(target, strict)
   require "review/#{target}builder"
   ReVIEW.const_get("#{target.upcase}Builder").new(strict)
 end
 
 def write(path, str)
-  File.open(path, 'w') {|f|
-    f.puts str
-  }
+  File.open(path, 'w') { |f| f.puts str }
 end
 
 main

data/bin/review-epubmaker

@@ -1,6 +1,4 @@
 #!/usr/bin/env ruby
-# encoding: utf-8
-
 # Copyright (c) 2010-2017 Kenshi Muto and Masayoshi Takahashi
 #
 # This program is free software.
@@ -15,11 +13,13 @@ $LOAD_PATH.unshift((bindir + '../lib').realpath)
 require 'review/epubmaker'
 require 'review/version'
 
+@logger = ReVIEW.logger
+
 rv = ReVIEW::EPUBMaker.new
 
 opts = OptionParser.new
 opts.version = ReVIEW::VERSION
-opts.banner = "Usage: #{File.basename($0)} [options] YAML_filename [export_filename]"
+opts.banner = "Usage: #{File.basename($PROGRAM_NAME)} [options] YAML_filename [export_filename]"
 opts.on('--help', 'Prints this message and quit.') do
   puts opts.help
   exit 0
@@ -28,12 +28,11 @@ end
 begin
   opts.parse!
 rescue OptionParser::ParseError => err
-  $stderr.puts err.message
+  @logger.error err.message
   $stderr.puts opts.help
   exit 1
 end
 
-
 if ARGV.size < 1 || !File.exist?(ARGV[0])
   puts opts.help
   exit 1

data/bin/review-index

@@ -1,8 +1,7 @@
 #!/usr/bin/env ruby
 #
-#
-# Copyright (c) 1999-2007 Minero Aoki
-#               2008-2014 Minero Aoki, Kenshi Muto
+# Copyright (c) 2008-2017 Minero Aoki, Kenshi Muto
+#               1999-2007 Minero Aoki
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -22,6 +21,7 @@ require 'review/version'
 require 'optparse'
 
 def main
+  @logger = ReVIEW.logger
   Signal.trap(:INT) { exit 1 }
   if RUBY_PLATFORM !~ /mswin(?!ce)|mingw|cygwin|bccwin/
     Signal.trap(:PIPE, 'IGNORE')
@@ -40,48 +40,40 @@ def _main
 
   opts = OptionParser.new
   opts.version = ReVIEW::VERSION
-  opts.on('-a', '--all', 'print all chapters.') {
-    source = book
-  }
-  opts.on('-p', '--part N', 'list only part N.') {|n|
+  opts.on('-a', '--all', 'print all chapters.') { source = book }
+  opts.on('-p', '--part N', 'list only part N.') do |n|
     source = book.part(Integer(n)) or
-        error_exit "part #{n} does not exist in this book"
-  }
-  opts.on('-c', '--chapter C', 'list only chapter C.') {|c|
+      error_exit "part #{n} does not exist in this book"
+  end
+  opts.on('-c', '--chapter C', 'list only chapter C.') do |c|
     begin
       source = ReVIEW::Book::Part.new(nil, 1, [book.chapter(c)])
     rescue
       error_exit "chapter #{c} does not exist in this book"
     end
-  }
-  opts.on('-l', '--level N', 'list upto N level (1..4, default=4)') {|n|
+  end
+  opts.on('-l', '--level N', 'list upto N level (1..4, default=4)') do |n|
     upper = Integer(n)
-    unless (0..4).include?(upper) # 0 is hidden option
-      $stderr.puts "-l/--level option accepts only 1..4"
+    unless (0..4).cover?(upper) # 0 is hidden option
+      $stderr.puts '-l/--level option accepts only 1..4'
       exit 1
     end
-  }
-  opts.on('--text', 'output in plain text (default)') {
-    printer_class = ReVIEW::TextTOCPrinter
-  }
-  opts.on('--html', 'output in HTML (deprecated)') {
-    printer_class = ReVIEW::HTMLTOCPrinter
-  }
-  opts.on('--help', 'print this message and quit.') {
+  end
+  opts.on('--text', 'output in plain text (default)') { printer_class = ReVIEW::TextTOCPrinter }
+  opts.on('--html', 'output in HTML (deprecated)') { printer_class = ReVIEW::HTMLTOCPrinter }
+  opts.on('--help', 'print this message and quit.') do
     puts opts.help
     exit 0
-  }
+  end
   begin
     opts.parse!
   rescue OptionParser::ParseError => err
-    $stderr.puts err.message
+    @logger.error err.message
     $stderr.puts opts.help
     exit 1
   end
   if source
-    unless ARGV.empty?
-      error_exit '-a/-s option and file arguments are exclusive'
-    end
+    error_exit '-a/-s option and file arguments are exclusive' unless ARGV.empty?
   else
     puts opts.help
     exit 0
@@ -89,7 +81,7 @@ def _main
 
   begin
     printer = printer_class.new(upper, param)
-    if source.kind_of?(ReVIEW::Book::Part)
+    if source.is_a?(ReVIEW::Book::Part)
       printer.print_part source
     else
       printer.print_book source
@@ -101,7 +93,7 @@ def _main
 end
 
 def error_exit(msg)
-  $stderr.puts "#{File.basename($0)}: #{msg}"
+  @logger.error "#{File.basename($PROGRAM_NAME)}: #{msg}"
   exit 1
 end
 

data/bin/review-init

@@ -15,29 +15,24 @@ require 'pathname'
 bindir = Pathname.new(__FILE__).realpath.dirname
 $LOAD_PATH.unshift((bindir + '../lib').realpath)
 
-require 'review/version'
+require 'review'
 
 def main
+  @logger = ReVIEW.logger
   opts = OptionParser.new
   opts.version = ReVIEW::VERSION
-  opts.banner = "Usage: #{File.basename($0)} [option] dirname"
+  opts.banner = "Usage: #{File.basename($PROGRAM_NAME)} [option] dirname"
   opts.on('-h', '--help', 'print this message and quit.') do
     puts opts.help
     exit 0
   end
-  opts.on('-f', '--force', 'generate files (except *.re) if directory has already existed.') do
-    @force = true
-  end
-  opts.on('-l', '--locale', 'generate locale.yml file.') do
-    @locale = true
-  end
-  opts.on('', '--epub-version VERSION', 'define EPUB version') do |version|
-    @epub_version = version
-  end
+  opts.on('-f', '--force', 'generate files (except *.re) if directory has already existed.') { @force = true }
+  opts.on('-l', '--locale', 'generate locale.yml file.') { @locale = true }
+  opts.on('', '--epub-version VERSION', 'define EPUB version') { |version| @epub_version = version }
   begin
     opts.parse!
   rescue OptionParser::ParseError => err
-    $stderr.puts err.message
+    @logger.error err.message
     $stderr.puts opts.help
     exit 1
   end
@@ -48,7 +43,7 @@ def main
   end
 
   initdir = File.expand_path(ARGV.shift)
-  @review_dir = File.dirname(File.expand_path(__FILE__ + "./../"))
+  @review_dir = File.dirname(File.expand_path(__FILE__ + './../'))
 
   generate_dir(initdir) do |dir|
     generate_catalog_file(dir)
@@ -67,7 +62,7 @@ end
 
 def generate_dir(dir)
   if File.exist?(dir) && !@force
-    puts "#{dir} already exists."
+    @logger.error "#{dir} already exists."
     exit
   end
   FileUtils.mkdir_p dir
@@ -75,11 +70,7 @@ def generate_dir(dir)
 end
 
 def generate_sample(dir)
-  if !@force
-    File.open("#{dir}/#{File.basename(dir)}.re", "w") do |file|
-      file.write("= ")
-    end
-  end
+  File.open("#{dir}/#{File.basename(dir)}.re", 'w') { |file| file.write('= ') } unless @force
 end
 
 def generate_layout(dir)
@@ -87,7 +78,7 @@ def generate_layout(dir)
 end
 
 def generate_catalog_file(dir)
-  File.open(dir + "/catalog.yml", "w") do |file|
+  File.open(dir + '/catalog.yml', 'w') do |file|
     file.write <<-EOS
 PREDEF:
 
@@ -107,39 +98,39 @@ def generate_images_dir(dir)
 end
 
 def generate_cover_image(dir)
-  FileUtils.cp @review_dir + "/test/sample-book/src/images/cover.jpg", dir + '/images/'
+  FileUtils.cp @review_dir + '/test/sample-book/src/images/cover.jpg', dir + '/images/'
 end
 
 def generate_config(dir)
-  today = Time.now.strftime("%Y-%m-%d")
-  content = File.read(@review_dir + "/doc/config.yml.sample", {:encoding => 'utf-8'})
+  today = Time.now.strftime('%Y-%m-%d')
+  content = File.read(@review_dir + '/doc/config.yml.sample', encoding: 'utf-8')
   content.gsub!(/^#\s*coverimage:.*$/, 'coverimage: cover.jpg')
   content.gsub!(/^#\s*date:.*$/, "date: #{today}")
-  content.gsub!(/^#\s*history:.*$/, %Q|history: [["#{today}"]]|)
-  content.gsub!(/^#\s*texstyle:.*$/, "texstyle: reviewmacro")
-  content.gsub!(/^(#\s*)?stylesheet:.*$/, %Q|stylesheet: ["style.css"]|)
+  content.gsub!(/^#\s*history:.*$/, %Q(history: [["#{today}"]]))
+  content.gsub!(/^#\s*texstyle:.*$/, 'texstyle: reviewmacro')
+  content.gsub!(/^(#\s*)?stylesheet:.*$/, %Q(stylesheet: ["style.css"]))
   if @epub_version.to_i == 2
-    content.gsub!(/^#.*epubversion:.*$/,'epubversion: 2')
-    content.gsub!(/^#.*htmlversion:.*$/,'htmlversion: 4')
+    content.gsub!(/^#.*epubversion:.*$/, 'epubversion: 2')
+    content.gsub!(/^#.*htmlversion:.*$/, 'htmlversion: 4')
   end
-  File.open(File.join(dir, "config.yml"), "w"){|f| f.write(content) }
+  File.open(File.join(dir, 'config.yml'), 'w') { |f| f.write(content) }
 end
 
 def generate_style(dir)
-  FileUtils.cp @review_dir + "/test/sample-book/src/style.css", dir
+  FileUtils.cp @review_dir + '/test/sample-book/src/style.css', dir
 end
 
 def generate_texmacro(dir)
   texmacrodir = dir + '/sty'
   FileUtils.mkdir_p texmacrodir
   FileUtils.cp [
-    @review_dir + "/test/sample-book/src/sty/reviewmacro.sty",
-    @review_dir + "/test/sample-book/src/sty/jumoline.sty"
+    @review_dir + '/test/sample-book/src/sty/reviewmacro.sty',
+    @review_dir + '/test/sample-book/src/sty/jumoline.sty'
   ], texmacrodir
 end
 
 def generate_rakefile(dir)
-  FileUtils.cp @review_dir + "/test/sample-book/src/Rakefile", dir
+  FileUtils.cp @review_dir + '/test/sample-book/src/Rakefile', dir
 end
 
 def generate_locale(dir)
@@ -147,7 +138,7 @@ def generate_locale(dir)
 end
 
 def generate_gemfile(dir)
-  File.open(dir + "/Gemfile", "w") do |file|
+  File.open(dir + '/Gemfile', 'w') do |file|
     file.write <<-EOS
 source 'https://rubygems.org'
 
@@ -157,6 +148,4 @@ EOS
   end
 end
 
-if File.basename($0) == File.basename(__FILE__)
-  main()
-end
+main if File.basename($PROGRAM_NAME) == File.basename(__FILE__)