review 3.0.0 → 4.2.0

data/bin/review-check

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 #
-# Copyright (c) 2010-2017 Kenshi Muto, Minero Aoki
+# Copyright (c) 2010-2019 Kenshi Muto, Minero Aoki
 #               1999-2007 Minero Aoki
 #
 # This program is free software.
@@ -50,7 +50,7 @@ def main
   end
   opts.on('--text', 'Check text.') do
     modes ||= []
-    modes.push :text
+    modes.push(:text)
   end
   opts.on('--help', 'print this message and quit.') do
     puts opts.help
@@ -58,8 +58,8 @@ def main
   end
   begin
     opts.parse!
-  rescue OptionParser::ParseError => err
-    @logger.error(err.message)
+  rescue OptionParser::ParseError => e
+    @logger.error(e.message)
     puts opts.help
     exit 1
   end
@@ -72,7 +72,7 @@ def main
   modes.each do |mode|
     case mode
     when :text
-      check_text files
+      check_text(files)
     else
       raise 'must not happen'
     end
@@ -122,9 +122,9 @@ def words_re(rc)
     next if line[0, 1] == '#'
     if / !/ =~ line
       line, n = *line.split('!', 2)
-      nega.push n.strip
+      nega.push(n.strip)
     end
-    words.push line.strip
+    words.push(line.strip)
   end
   return Regexp.compile(words.join('|')),
          nega.empty? ? nil : Regexp.compile(nega.join('|'))
@@ -157,7 +157,7 @@ def each_paragraph(f)
         break if line.strip.empty?
         break if %r{\A(?:=|//[\w\}])} =~ line
         next if /\A\#@/ =~ line
-        buf.push line.strip
+        buf.push(line.strip)
       end
       yield buf, lineno
       @review_utils_word_ok = nil

data/bin/review-checkdep

@@ -28,7 +28,7 @@ def main
         @unprovided[kw] = location
       end
     when /\A\#@provide\((.*)\)/
-      provide $1
+      provide($1)
     else
       line.scan(/@<kw>\{(.*?)[,\}]/) { provide $1 }
     end

data/bin/review-compile

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 #
-# Copyright (c) 2008-2018 Kenshi Muto, Masayoshi Takahashi, KADO Masanori, Minero Aoki
+# Copyright (c) 2008-2019 Kenshi Muto, Masayoshi Takahashi, KADO Masanori, Minero Aoki
 # Copyright (c) 1999-2007 Minero Aoki
 #
 # This program is free software.
@@ -35,7 +35,7 @@ def _main
   @logger = ReVIEW.logger
   @mode = :files
   @basedir = nil
-  if /\Areview2/ =~ File.basename($PROGRAM_NAME)
+  if File.basename($PROGRAM_NAME).start_with?('review2')
     @target = File.basename($PROGRAM_NAME, '.rb').sub('review2', '')
   else
     @target = nil
@@ -50,7 +50,7 @@ def _main
   begin
     loader = ReVIEW::YAMLLoader.new
     if @config['yaml']
-      error "#{config['yaml']} not found." unless File.exist?(@config['yaml'])
+      error "#{@config['yaml']} not found." unless File.exist?(@config['yaml'])
       begin
         @config.deep_merge!(loader.load_file(@config['yaml']))
       rescue => e
@@ -88,7 +88,7 @@ def _main
         compiler = ReVIEW::Compiler.new(load_strategy_class(@target, @check_only))
         result = compiler.compile(chap)
         if @output_filename
-          write @output_filename, result
+          write(@output_filename, result)
         else
           puts result unless @check_only
         end
@@ -99,18 +99,18 @@ def _main
       compiler = ReVIEW::Compiler.new(load_strategy_class(@target, @check_only))
       book.chapters.each do |chap|
         str = compiler.compile(chap)
-        write "#{chap.name}#{compiler.strategy.extname}", str unless @check_only
+        write("#{chap.name}#{compiler.strategy.extname}", str) unless @check_only
       end
       # PART
       book.parts_in_file.each do |part|
         str = compiler.compile(part)
-        write "#{part.name}#{compiler.strategy.extname}", str unless @check_only
+        write("#{part.name}#{compiler.strategy.extname}", str) unless @check_only
       end
     else
       raise "must not happen: #{@mode}"
     end
-  rescue ReVIEW::ApplicationError => err
-    error(err.message)
+  rescue ReVIEW::ApplicationError => e
+    error(e.message)
   end
 end
 
@@ -162,20 +162,20 @@ def parse_opts
         raise OptionParser::ParseError, 'no target given'
       end
     end
-  rescue OptionParser::ParseError => err
-    warn(err.message)
+  rescue OptionParser::ParseError => e
+    warn(e.message)
     $stderr.puts opts.help
     exit 1
   end
 end
 
 def error(msg)
-  @logger.error "#{File.basename($PROGRAM_NAME, '.*')}: #{msg}"
+  @logger.error msg
   exit 1
 end
 
 def warn(msg)
-  @logger.warn "#{File.basename($PROGRAM_NAME, '.*')}: #{msg}"
+  @logger.warn msg
 end
 
 def load_strategy_class(target, strict)

data/bin/review-epubmaker

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-# Copyright (c) 2010-2017 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
@@ -10,39 +10,7 @@ require 'pathname'
 require 'optparse'
 bindir = Pathname.new(__FILE__).realpath.dirname
 $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($PROGRAM_NAME)} [options] YAML_filename [export_filename]"
-opts.on('--help', 'Prints this message and quit.') do
-  puts opts.help
-  exit 0
-end
 
-begin
-  opts.parse!
-rescue OptionParser::ParseError => err
-  @logger.error err.message
-  $stderr.puts opts.help
-  exit 1
-end
-
-if ARGV.size < 1
-  puts opts.help
-  exit 1
-end
-
-unless File.exist?(ARGV[0])
-  @logger.error "#{File.basename($PROGRAM_NAME, '.*')}: #{ARGV[0]} not found."
-  exit 1
-end
+require 'review/epubmaker'
 
-yaml_file = ARGV[0]
-bookname = ARGV[1]
-rv.produce(yaml_file, bookname)
+ReVIEW::EPUBMaker.execute(*ARGV)

data/bin/review-idgxmlmaker

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+# Copyright (c) 2019 Kenshi Muto
+#
+# 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.
+# For details of the GNU LGPL, see the file "COPYING".
+#
+
+require 'pathname'
+bindir = Pathname.new(__FILE__).realpath.dirname
+$LOAD_PATH.unshift((bindir + '../lib').realpath)
+
+require 'review/idgxmlmaker'
+
+ReVIEW::IDGXMLMaker.execute(*ARGV)

data/bin/review-index

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 #
-# Copyright (c) 2008-2017 Minero Aoki, Kenshi Muto
+# Copyright (c) 2008-2020 Minero Aoki, Kenshi Muto
 #               1999-2007 Minero Aoki
 #
 # This program is free software.
@@ -14,93 +14,6 @@ require 'pathname'
 bindir = Pathname.new(__FILE__).realpath.dirname
 $LOAD_PATH.unshift((bindir + '../lib').realpath)
 
-require 'review/book'
-require 'review/tocparser'
 require 'review/tocprinter'
-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')
-  end
-  _main
-rescue Errno::EPIPE
-  exit 0
-end
-
-def _main
-  yamlfile = 'config.yml'
-  printer_class = ReVIEW::TextTOCPrinter
-  source = nil
-  upper = ReVIEW::TOCPrinter.default_upper_level
-  param = {}
-  book = ReVIEW::Book::Base.load
-
-  opts = OptionParser.new
-  opts.version = ReVIEW::VERSION
-  opts.on('--yaml=YAML', 'Read configurations from YAML file.') { |yaml| yamlfile = yaml }
-  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"
-  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
-  end
-  opts.on('-l', '--level N', 'list upto N level (1..4, default=4)') do |n|
-    upper = Integer(n)
-    unless (0..4).cover?(upper) # 0 is hidden option
-      $stderr.puts '-l/--level option accepts only 1..4'
-      exit 1
-    end
-  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
-    @logger.error err.message
-    $stderr.puts opts.help
-    exit 1
-  end
-
-  book.config = ReVIEW::Configure.values
-  book.load_config(yamlfile) if yamlfile
-
-  if source
-    error_exit '-a/-s option and file arguments are exclusive' unless ARGV.empty?
-  else
-    puts opts.help
-    exit 0
-  end
-
-  begin
-    printer = printer_class.new(upper, param)
-    if source.is_a?(ReVIEW::Book::Part)
-      printer.print_part source
-    else
-      printer.print_book source
-    end
-  rescue ReVIEW::Error, Errno::ENOENT => err
-    raise if $DEBUG
-    error_exit err.message
-  end
-end
-
-def error_exit(msg)
-  @logger.error "#{File.basename($PROGRAM_NAME)}: #{msg}"
-  exit 1
-end
-
-main
+ReVIEW::TOCPrinter.execute(*ARGV)

data/bin/review-preproc

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 #
-# Copyright (c) 2010-2014 Minero Aoki, Kenshi Muto
+# Copyright (c) 2010-2019 Minero Aoki, Kenshi Muto
 #               1999-2007 Minero Aoki
 #
 # This program is free software.
@@ -39,7 +39,7 @@ def main
     if ENV['REVIEW_SAFE_MODE'].to_i & 2 > 0
       @logger.warn 'review-preproc-ext.rb is prohibited in safe mode. ignored.'
     else
-      Kernel.load File.expand_path('review-preproc-ext.rb')
+      Kernel.load(File.expand_path('review-preproc-ext.rb'))
     end
   end
 
@@ -52,7 +52,6 @@ def main
   opts.on('-c', '--check', 'Check if preprocess is needed.') { mode = :check }
   opts.on('-d', '--diff', 'Show diff from current file.') { mode = :diff }
   opts.on('--replace', 'Replace file by preprocessed one.') { mode = :replace }
-  opts.on('-s', '--strip', 'Strip preprocessor tags.') { mode = :strip }
   opts.on('--tabwidth=WIDTH', "Replace tabs with space characters. (0: don't replace)") { |width| param['tabwidth'] = width.to_i }
   opts.on('--help', 'Print this message and quit.') do
     puts opts.help
@@ -60,8 +59,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
@@ -72,39 +71,35 @@ def main
     current_file = path
     case mode
     when :output
-      File.open(path) { |f| pp.process f, $stdout }
+      File.open(path) { |f| pp.process(f, $stdout) }
     when :replace
-      File.write "#{path}.pptmp", preproc(pp, path)
-      File.rename "#{path}.pptmp", path
+      File.write("#{path}.pptmp", preproc(pp, path))
+      File.rename("#{path}.pptmp", path)
     when :diff, :check
       tmp = '/tmp/review.pptmp'
       begin
-        File.write tmp, preproc(pp, path)
+        File.write(tmp, preproc(pp, path))
         if mode == :check
-          system "diff -qu #{path} #{tmp} >/dev/null || echo #{path}"
+          system("diff -qu #{path} #{tmp} >/dev/null || echo #{path}")
         else
-          system "diff -u #{path} #{tmp}"
+          system("diff -u #{path} #{tmp}")
         end
       ensure
-        FileUtils.rm_f tmp
-      end
-    when :strip
-      File.open(path) do |f|
-        ReVIEW::Preprocessor::Strip.new(f).each { |line| puts line }
+        FileUtils.rm_f(tmp)
       end
     else
       raise "must not happen: #{mode}"
     end
   end
-rescue ReVIEW::Error => err
+rescue ReVIEW::Error => e
   raise if $DEBUG
-  @logger.error err.message
+  @logger.error e.message
   exit 1
 end
 
 def preproc(pp, path)
   buf = StringIO.new
-  File.open(path) { |f| pp.process f, buf }
+  File.open(path) { |f| pp.process(f, buf) }
   buf.string
 end
 

data/bin/review-validate

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-# Copyright (c) 2010-2017 Kenshi Muto
+# Copyright (c) 2010-2019 Kenshi Muto
 #
 # This program is free software
 # You can distribute or modify this program under the terms of
@@ -30,7 +30,7 @@ ARGF.each do |line|
       @logger.warn "#{ln}: block #{new_block} started, but previous block #{block} didn't close yet."
     end
     block = new_block
-  elsif line =~ %r{\A//\}}
+  elsif line.start_with?('//}')
     if block.nil?
       @logger.warn "#{ln}: block ended, but not opened."
     end
@@ -48,7 +48,7 @@ ARGF.each do |line|
       @logger.warn "#{ln}: found '*' without the head space. Is it correct?"
     end
   elsif line =~ /\A\s+(\d+\.)\s+/ && line =~ /\A\s+\*\s+/
-    unless Tw[list emlist listnum emlistnum cmd image table].include?(block)
+    unless %w[list emlist listnum emlistnum cmd image table].include?(block)
       @logger.warn "#{ln}: found itemized list or numbered list in #{block}. Is it correct?"
     end
   elsif block == 'table'

data/bin/review-vol

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 #
-# Copyright (c) 2014-2017 Minero Aoki, Kenshi Muto
+# Copyright (c) 2014-2020 Minero Aoki, Kenshi Muto
 #               2003-2014 Minero Aoki
 #
 # This program is free software.
@@ -14,82 +14,8 @@ require 'pathname'
 bindir = Pathname.new(__FILE__).realpath.dirname
 $LOAD_PATH.unshift((bindir + '../lib').realpath)
 
-require 'review'
-require 'optparse'
+require 'review/volumeprinter'
 
-include ReVIEW::TextUtils
-
-def main
-  @logger = ReVIEW.logger
-  @config = ReVIEW::Configure.values
-
-  part_sensitive = false
-  basedir = nil
-  yamlfile = 'config.yml'
-  opts = OptionParser.new
-  opts.version = ReVIEW::VERSION
-  opts.on('--yaml=YAML', 'Read configurations from YAML file.') { |yaml| yamlfile = yaml }
-  opts.on('-P', '--part-sensitive', 'Prints volume of each parts.') { part_sensitive = true }
-  opts.on('--directory=DIR', 'Compile all chapters in DIR.') { |path| basedir = path }
-  opts.on('--help', 'Print this message and quit') do
-    puts opts.help
-    exit 0
-  end
-  begin
-    opts.parse!
-  rescue OptionParser::ParseError => err
-    @logger.error err.message
-    $stderr.puts opts.help
-    exit 1
-  end
-
-  book = basedir ? ReVIEW::Book.load(basedir) : ReVIEW::Book::Base.load
-  book.config = @config
-  if yamlfile
-    book.load_config(yamlfile)
-  end
-
-  if part_sensitive
-    sep = ''
-    book.each_part do |part|
-      print sep
-      sep = "\n"
-      if part.number
-        puts "Part #{part.number} #{part.name}"
-      end
-      part.each_chapter do |chap|
-        print_chapter_volume chap
-      end
-      puts '    --------------------'
-      print_volume part.volume
-    end
-  else
-    book.each_chapter do |chap|
-      print_chapter_volume chap
-    end
-  end
-  puts '============================='
-  print_volume book.volume # puts "Total #{book.volume}"
-rescue ReVIEW::ApplicationError, Errno::ENOENT => err
-  raise if $DEBUG
-  @logger.error "#{File.basename($PROGRAM_NAME)}: #{err.message}"
-  exit 1
-end
-
-def print_chapter_volume(chap)
-  vol = chap.volume
-  title = chap.title
-  printf "%s %3dKB %6dC %5dL %3dP %s %-s\n",
-         chapnumstr(chap.number), vol.kbytes, vol.chars, vol.lines, vol.page,
-         "#{chap.name} ".ljust(25, '.'), title
+if File.basename($PROGRAM_NAME) == File.basename(__FILE__)
+  ReVIEW::VolumePrinter.execute(*ARGV)
 end
-
-def print_volume(vol)
-  printf "    %3dKB %6dC %5dL %3dP\n", vol.kbytes, vol.chars, vol.lines, vol.page
-end
-
-def chapnumstr(n)
-  n ? sprintf('%2d.', n) : '   '
-end
-
-main