review 4.0.0 → 5.1.1

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,12 @@ $ 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
+$ rake vivliostyle  ## generating PDF using Vivliostyle-CLI (Requirement Vivliostyle-CLI)
 ```
 
 For further information, see [doc/quickstart.md](https://github.com/kmuto/review/blob/master/doc/quickstart.md)
@@ -112,4 +116,4 @@ Exception:
 
 ## Copyright
 
-Copyright (c) 2006-2019 Minero Aoki, Kenshi Muto, Masayoshi Takahashi, Masanori Kado.
+Copyright (c) 2006-2021 Minero Aoki, Kenshi Muto, Masayoshi Takahashi, Masanori Kado.

data/Rakefile

@@ -21,8 +21,13 @@ task :rubocop do
   end
 end
 
-task :test do
-  ruby('test/run_test.rb')
+desc 'Run tests'
+task :test, :target do |_, argv|
+  if argv[:target].nil?
+    ruby('test/run_test.rb')
+  else
+    ruby('test/run_test.rb', "--pattern=#{argv[:target]}")
+  end
 end
 
 begin

data/appveyor.yml

@@ -6,21 +6,6 @@ install:
 build_script:
   - bundle install
   - bundle exec rake test --trace --verbose
-  - bundle exec rubocop
-
-before_test:
-  - gem install -N epubcheck-ruby
-
-test_script:
-  - ruby bin/review-init hello
-  - cd hello
-  - ruby ../bin/review-epubmaker config.yml
-  - epubcheck book.epub
-  - cd ..
-  - ruby bin/review-init hello2 --epub-version 2
-  - cd hello2
-  - ruby ../bin/review-epubmaker config.yml
-  - epubcheck book.epub
 
 branches:
   only:
@@ -28,9 +13,4 @@ branches:
 
 environment:
   matrix:
-    - ruby_version: "24"
-    - ruby_version: "24-x64"
-    - ruby_version: "25"
-    - ruby_version: "25-x64"
     - ruby_version: "26"
-    - ruby_version: "26-x64"

data/bin/review

@@ -13,9 +13,7 @@
 # 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)
+$LOAD_PATH.unshift(File.realpath('../lib', __dir__))
 
 require 'review'
 
@@ -52,7 +50,7 @@ if ARGV[0] == 'version'
 end
 
 command = "review-#{ARGV.shift}"
-bindir = Pathname.new(__FILE__).realpath.dirname
+bindir = File.realpath(__dir__)
 command_path = File.join(bindir, command)
 
 unless File.exist?(command_path)

data/bin/review-catalog-converter

@@ -9,10 +9,9 @@
 #
 # Convert old PREDEF/CHAPS/PART/POSTDEF files into catalog.yml.
 
-require 'pathname'
+$LOAD_PATH.unshift(File.realpath('../lib', __dir__))
+
 require 'optparse'
-bindir = Pathname.new(__FILE__).realpath.dirname
-$LOAD_PATH.unshift((bindir + '../lib').realpath)
 require 'review/version'
 require 'review/extentions'
 require 'review/logger'
@@ -109,7 +108,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
 
@@ -158,6 +157,7 @@ def replace_old_style_part(dir)
     end
 
     next unless allow_overwrite
+
     File.write("#{dir}/#{part_name}", "= #{part}")
     catalog.replace_part(part, part_name)
   end

data/bin/review-check

@@ -9,10 +9,7 @@
 # For details of the GNU LGPL, see the file "COPYING".
 #
 
-require 'pathname'
-
-bindir = Pathname.new(__FILE__).realpath.dirname
-$LOAD_PATH.unshift((bindir + '../lib').realpath)
+$LOAD_PATH.unshift(File.realpath('../lib', __dir__))
 
 require 'review'
 require 'optparse'
@@ -31,9 +28,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
@@ -87,7 +82,8 @@ 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
@@ -109,6 +105,7 @@ def find_line(lines, re)
   while i < lines.size - 1
     str = lines[i] + lines[i + 1]
     return str.gsub(re, '<<<\&>>>'), i if re =~ str
+
     i += 1
   end
 
@@ -120,6 +117,7 @@ def words_re(rc)
   nega = []
   File.foreach(rc) do |line|
     next if line[0, 1] == '#'
+
     if / !/ =~ line
       line, n = *line.split('!', 2)
       nega.push(n.strip)
@@ -136,7 +134,7 @@ def each_paragraph(f)
     case line
     when /\A\#@ok\((.*)\)/
       @review_utils_word_ok = $1
-    when /\A\#@/
+    when /\A\#@/, /\A\s*\z/
       # do nothing
       next
     when %r{\A//caption\{(.*?)//\}}
@@ -147,9 +145,6 @@ def each_paragraph(f)
       end
     when /\A=/
       yield [line.slice(/\A=+(?:\[.*?\])?\s+(.*)/, 1).strip], f.lineno
-    when /\A\s*\z/
-      # skip
-      next
     else
       buf = [line.strip]
       lineno = f.lineno
@@ -157,6 +152,7 @@ def each_paragraph(f)
         break if line.strip.empty?
         break if %r{\A(?:=|//[\w\}])} =~ line
         next if /\A\#@/ =~ line
+
         buf.push(line.strip)
       end
       yield buf, lineno

data/bin/review-checkdep

@@ -9,10 +9,7 @@
 # For details of the GNU LGPL, see the file "COPYING".
 #
 
-require 'pathname'
-
-bindir = Pathname.new(__FILE__).realpath.dirname
-$LOAD_PATH.unshift((bindir + '../lib').realpath)
+$LOAD_PATH.unshift(File.realpath('../lib', __dir__))
 
 PREDEF_FILE = 'PREDEF'.freeze
 
@@ -30,7 +27,7 @@ def main
     when /\A\#@provide\((.*)\)/
       provide($1)
     else
-      line.scan(/@<kw>\{(.*?)[,\}]/) { provide $1 }
+      line.scan(/@<kw>\{(.*?)[,}]/) { provide($1) }
     end
   end
 end

data/bin/review-compile

@@ -9,10 +9,7 @@
 # For details of the GNU LGPL, see the file "COPYING".
 #
 
-require 'pathname'
-
-bindir = Pathname.new(__FILE__).realpath.dirname
-$LOAD_PATH.unshift((bindir + '../lib').realpath)
+$LOAD_PATH.unshift(File.realpath('../lib', __dir__))
 
 require 'review'
 require 'fileutils'
@@ -35,7 +32,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
@@ -79,32 +76,30 @@ 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}"
@@ -128,7 +123,7 @@ def parse_opts
   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('--mathml', 'Use MathML for TeX equation in HTML') { @config['math_format'] = 'mathml' }
   opts.on('--htmlversion=VERSION', 'HTML version.') do |v|
     v = v.to_i
     @config['htmlversion'] = v if [4, 5].include?(v)
@@ -178,13 +173,9 @@ def warn(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-epub2html

@@ -7,10 +7,7 @@
 # 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)
+$LOAD_PATH.unshift(File.realpath('../lib', __dir__))
 
 require 'review/epub2html'
 

data/bin/review-epubmaker

@@ -6,11 +6,10 @@
 # the GNU LGPL, Lesser General Public License version 2.1.
 # For details of the GNU LGPL, see the file "COPYING".
 #
-require 'pathname'
-require 'optparse'
-bindir = Pathname.new(__FILE__).realpath.dirname
-$LOAD_PATH.unshift((bindir + '../lib').realpath)
 
+$LOAD_PATH.unshift(File.realpath('../lib', __dir__))
+
+require 'optparse'
 require 'review/epubmaker'
 
 ReVIEW::EPUBMaker.execute(*ARGV)

data/bin/review-idgxmlmaker

@@ -7,9 +7,7 @@
 # For details of the GNU LGPL, see the file "COPYING".
 #
 
-require 'pathname'
-bindir = Pathname.new(__FILE__).realpath.dirname
-$LOAD_PATH.unshift((bindir + '../lib').realpath)
+$LOAD_PATH.unshift(File.realpath('../lib', __dir__))
 
 require 'review/idgxmlmaker'
 

data/bin/review-index

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 #
-# Copyright (c) 2008-2019 Minero Aoki, Kenshi Muto
+# Copyright (c) 2008-2020 Minero Aoki, Kenshi Muto
 #               1999-2007 Minero Aoki
 #
 # This program is free software.
@@ -9,98 +9,17 @@
 # For details of the GNU LGPL, see the file "COPYING".
 #
 
-require 'pathname'
+$LOAD_PATH.unshift(File.realpath('../lib', __dir__))
 
-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
+begin
   Signal.trap(:INT) { exit 1 }
   if RUBY_PLATFORM !~ /mswin(?!ce)|mingw|cygwin|bccwin/
     Signal.trap(:PIPE, 'IGNORE')
   end
-  _main
+
+  ReVIEW::TOCPrinter.execute(*ARGV)
 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 => e
-    @logger.error e.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 => e
-    raise if $DEBUG
-    error_exit(e.message)
-  end
-end
-
-def error_exit(msg)
-  @logger.error msg
-  exit 1
-end
-
-main