review 3.1.0 → 5.0.0

data/README.md

@@ -1,7 +1,7 @@
 # Re:VIEW
 
 [![Gem Version](https://badge.fury.io/rb/review.svg)](http://badge.fury.io/rb/review)
-[![Build Status](https://secure.travis-ci.org/kmuto/review.svg)](http://travis-ci.org/kmuto/review)
+[![Build Status](https://github.com/kmuto/review/workflows/Test/badge.svg)](https://github.com/kmuto/review/actions)
 [![Build status](https://ci.appveyor.com/api/projects/status/github/kmuto/review?svg=true)](https://ci.appveyor.com/project/kmuto/review)
 
 Re:VIEW is an easy-to-use digital publishing system for paper books and ebooks.
@@ -22,15 +22,17 @@ Re:VIEW uses its original format('Re:VIEW format') as source files.  See doc/for
 
 ## Commands
 
-There are two commands generate files directly.
+There are commands generate files directly.
 
 * review-epubmaker: generate EPUB file.
 * review-pdfmaker: generate PDF file using LaTeX (TeXLive).
 * review-textmaker: generate text files.
 * review-webmaker: generate Web pages.
+* review-idgxmlmaker: generate InDesign XML files.
 
 And some useful commands.
 
+* review-init: create a project.
 * review-compile: compile Re:VIEW format files.
 * review-vol: figure out size of Re:VIEW files.
 * review-index: generate index with various format.
@@ -60,10 +62,11 @@ $ echo "export PATH=PATH_OF_REVIEW/bin:$PATH" >> ~/.profile
 $ review-init hello
 $ cd hello
 $ (... add and edit *.re file, config.yml and catalog.yml ...)
-$ rake epub  ## generating EPUB
-$ rake pdf   ## generating PDF (Requirement TeXLive)
-$ rake text  ## generating texts
-$ rake web   ## generating Web pages
+$ rake epub    ## generating EPUB
+$ rake pdf     ## generating PDF (Requirement TeXLive)
+$ rake text    ## generating texts
+$ rake web     ## generating Web pages
+$ rake idgxml  ## generating InDesign XML files
 ```
 
 For further information, see [doc/quickstart.md](https://github.com/kmuto/review/blob/master/doc/quickstart.md)
@@ -112,4 +115,4 @@ Exception:
 
 ## Copyright
 
-Copyright (c) 2006-2019 Minero Aoki, Kenshi Muto, Masayoshi Takahashi, Masanori Kado.
+Copyright (c) 2006-2020 Minero Aoki, Kenshi Muto, Masayoshi Takahashi, Masanori Kado.

data/appveyor.yml

@@ -6,7 +6,6 @@ install:
 build_script:
   - bundle install
   - bundle exec rake test --trace --verbose
-  - bundle exec rubocop
 
 branches:
   only:
@@ -14,5 +13,4 @@ branches:
 
 environment:
   matrix:
-    - ruby_version: "23"
-    - ruby_version: "23-x64"
+    - ruby_version: "26"

data/bin/review-catalog-converter

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 #
-# Copyright (c) 2014-2017 Masanori Kado, Kenshi Muto
+# Copyright (c) 2014-2019 Masanori Kado, Kenshi Muto
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -30,8 +30,8 @@ def main
 
   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
@@ -109,7 +109,7 @@ def parse_postdef(str, to_appendix = false)
 end
 
 def parse_parts(parts_str, chaps_str)
-  if parts_str.blank? or chaps_str.blank?
+  if parts_str.blank? || chaps_str.blank?
     return "CHAPS:\n\n"
   end
 
@@ -140,7 +140,7 @@ end
 def replace_old_style_part(dir)
   catalog = ReVIEW::Catalog.new(File.open("#{dir}/catalog.yml"))
   Array.new(catalog.parts.split("\n")).each_with_index do |part, part_idx|
-    next if part.end_with? '.re'
+    next if part.end_with?('.re')
 
     allow_overwrite = true
     part_name = sprintf('part%d.re', part_idx + 1)

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.
@@ -31,9 +31,7 @@ end
 
 def main
   @config = ReVIEW::Configure.values
-  @book = ReVIEW::Book::Base.load
-  @book.config = @config
-
+  @book = ReVIEW::Book::Base.new(config: @config)
   @logger = ReVIEW.logger
 
   modes = nil
@@ -50,7 +48,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 +56,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 +70,7 @@ def main
   modes.each do |mode|
     case mode
     when :text
-      check_text files
+      check_text(files)
     else
       raise 'must not happen'
     end
@@ -87,7 +85,7 @@ def check_text(files)
         s = para.join
         m = re.match(s)
         next if m.nil? || m[0] == @review_utils_word_ok
-        next if neg and neg =~ s
+        next if neg && neg =~ s
         str, offset = find_line(para, re)
         out = sprintf("%s:%d: %s\n", path, lineno + offset, str)
         print out
@@ -122,9 +120,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 +155,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,9 +28,9 @@ def main
         @unprovided[kw] = location
       end
     when /\A\#@provide\((.*)\)/
-      provide $1
+      provide($1)
     else
-      line.scan(/@<kw>\{(.*?)[,\}]/) { provide $1 }
+      line.scan(/@<kw>\{(.*?)[,}]/) { provide($1) }
     end
   end
 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
@@ -79,38 +79,36 @@ def _main
       error('no input') if ARGV.empty?
 
       @basedir = File.dirname(ARGV[0])
-      book = ReVIEW::Book::Base.load(@basedir)
-      book.config = @config # needs only at the first time
+      book = ReVIEW::Book::Base.new(@basedir, config: @config)
       ARGV.each do |item|
         error("file not found: #{item}") unless File.exist?(File.join(book.config['contentdir'], item))
         chap_name = File.basename(item, '.*')
         chap = book.chapter(chap_name)
-        compiler = ReVIEW::Compiler.new(load_strategy_class(@target, @check_only))
+        compiler = ReVIEW::Compiler.new(load_builder_class(@target, @check_only))
         result = compiler.compile(chap)
         if @output_filename
-          write @output_filename, result
+          File.write(@output_filename, result)
         else
           puts result unless @check_only
         end
       end
     when :dir
-      book = @basedir ? ReVIEW::Book.load(@basedir) : ReVIEW::Book::Base.load
-      book.config = @config
-      compiler = ReVIEW::Compiler.new(load_strategy_class(@target, @check_only))
+      book = @basedir ? ReVIEW::Book::Base.new(@basedir, config: @config) : ReVIEW::Book::Base.new(config: @config)
+      compiler = ReVIEW::Compiler.new(load_builder_class(@target, @check_only))
       book.chapters.each do |chap|
         str = compiler.compile(chap)
-        write "#{chap.name}#{compiler.strategy.extname}", str unless @check_only
+        File.write("#{chap.name}#{compiler.builder.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
+        File.write("#{part.name}#{compiler.builder.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,29 +160,25 @@ 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)
+def load_builder_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 }
-end
-
 main

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)