review 3.0.0 → 4.2.0

data/lib/review/webmaker.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2016-2018 Masayoshi Takahashi, Masanori Kado, Kenshi Muto
+# Copyright (c) 2016-2020 Masayoshi Takahashi, Masanori Kado, Kenshi Muto
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -35,12 +35,12 @@ module ReVIEW
     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 self.execute(*args)
@@ -50,6 +50,7 @@ module ReVIEW
     def parse_opts(args)
       cmd_config = {}
       opts = OptionParser.new
+      @buildonly = nil
 
       opts.banner = 'Usage: review-webmaker [option] configfile'
       opts.version = ReVIEW::VERSION
@@ -58,6 +59,7 @@ module ReVIEW
         exit 0
       end
       opts.on('--ignore-errors', 'Ignore review-compile errors.') { cmd_config['ignore-errors'] = true }
+      opts.on('-y', '--only file1,file2,...', 'Build only specified files.') { |v| @buildonly = v.split(/\s*,\s*/).map { |m| m.strip.sub(/\.re\Z/, '') } }
 
       opts.parse!(args)
       if args.size != 1
@@ -116,7 +118,7 @@ module ReVIEW
       copy_backmatter(@path)
 
       math_dir = "./#{@config['imagedir']}/_review_math"
-      if @config['imgmath'] && File.exist?("#{math_dir}/__IMGMATH_BODY__.tex")
+      if @config['imgmath'] && File.exist?("#{math_dir}/__IMGMATH_BODY__.map")
         make_math_images(math_dir)
       end
 
@@ -186,6 +188,11 @@ module ReVIEW
       end
       id = File.basename(filename).sub(/\.re\Z/, '')
 
+      if @buildonly && !@buildonly.include?(id)
+        warn "skip #{id}.re"
+        return
+      end
+
       htmlfile = "#{id}.#{@config['htmlext']}"
 
       if @config['params'].present?

data/lib/review/webtocprinter.rb

@@ -6,49 +6,52 @@ module ReVIEW
     include HTMLUtils
 
     def self.book_to_string(book)
-      io = StringIO.new
-      ReVIEW::WEBTOCPrinter.new(1, {}, io).print_book(book)
-      io.seek(0)
-      io.read
+      ReVIEW::WEBTOCPrinter.new.print_book(book)
     end
 
     def print_book(book)
-      @out.puts '<ul class="book-toc">'
-      @out.puts %Q(<li><a href="index.html">TOP</a></li>\n)
-      book.each_part do |part|
-        print_part(part)
-      end
-      @out.puts '</ul>'
+      @book = book
+      @indent = nil
+      @upper = 1 # only part and chapter
+      print_result(build_result_array)
     end
 
-    def print_part(part)
-      if part.number
-        if part.file?
-          ext = part.book.config['htmlext'] || 'html'
-          path = File.basename(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)
+    def print_result(result_array)
+      content = <<EOT
+<ul class="book-toc">
+<li><a href="index.html">TOP</a></li>
+EOT
+
+      path = ''
+      result_array.each do |result|
+        unless result[:headline]
+          result[:headline] = '-'
+        end
+
+        if result[:name]
+          path = "#{result[:name]}.#{@book.config['htmlext']}"
+          next
+        end
+
+        if result[:part]
+          if result[:part] == 'end'
+            content << "</ul></li>\n"
+          end
+          next
+        end
+
+        if path.start_with?('.')
+          content << "<li>#{escape(result[:headline])}"
         else
-          @out.puts %Q(<li>#{h(I18n.t('part_short', part.number) + ' ' + part.title)}\n<ul>\n)
+          content << %Q(<li><a href="#{path}">#{escape(result[:headline])}</a>)
+        end
+        if result[:level] == 0
+          content << "\n<ul>" # part
+        else
+          content << "</li>\n"
         end
       end
-      part.each_chapter do |chap|
-        print_chapter(chap)
-      end
-      if part.number
-        @out.puts "</ul>\n</li>\n"
-      end
-    end
-
-    def print_chapter(chap)
-      chap_node = TOCParser.chapter_node(chap)
-      ext = chap.book.config['htmlext'] || 'html'
-      path = File.basename(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)
+      content << "</ul>\n"
     end
   end
 end

data/lib/review/yamlloader.rb

@@ -15,31 +15,41 @@ module ReVIEW
       loaded_files = {}
       yaml = {}
 
-      loop do
-        # Check exit condition
-        return yaml if file_queue.empty?
-
+      while file_queue.present?
         current_file = file_queue.shift
         current_yaml = YAML.load_file(current_file)
+        if current_yaml.class == FalseClass
+          raise "#{File.basename(current_file)} is malformed."
+        end
         yaml = current_yaml.deep_merge(yaml)
 
-        next unless yaml.key?('inherit')
+        if yaml.key?('inherit')
+          inherit_files = parse_inherit(yaml, yamlfile, loaded_files)
+          file_queue = inherit_files + file_queue
+        end
+      end
 
-        buf = []
-        yaml['inherit'].reverse_each do |item|
-          inherit_file = File.expand_path(item, File.dirname(yamlfile))
+      yaml
+    end
 
-          # Check loop
-          if loaded_files[inherit_file]
-            raise "Found circular YAML inheritance '#{inherit_file}' in #{yamlfile}."
-          end
+    def parse_inherit(yaml, yamlfile, loaded_files)
+      files = []
 
-          loaded_files[inherit_file] = true
-          buf << inherit_file
+      yaml['inherit'].reverse_each do |item|
+        inherit_file = File.expand_path(item, File.dirname(yamlfile))
+
+        # Check loop
+        if loaded_files[inherit_file]
+          raise "Found circular YAML inheritance '#{inherit_file}' in #{yamlfile}."
         end
-        yaml.delete('inherit')
-        file_queue = buf + file_queue
+
+        loaded_files[inherit_file] = true
+        files << inherit_file
       end
+
+      yaml.delete('inherit')
+
+      files
     end
   end
 end

data/review.gemspec

@@ -1,4 +1,4 @@
-$LOAD_PATH.push File.expand_path('lib', __dir__)
+$LOAD_PATH.push(File.expand_path('lib', __dir__))
 require 'review/version'
 
 Gem::Specification.new do |gem|
@@ -11,8 +11,8 @@ Gem::Specification.new do |gem|
   gem.homepage    = 'http://github.com/kmuto/review'
   gem.summary     = 'Re:VIEW: a easy-to-use digital publishing system'
   gem.description = 'Re:VIEW is a digital publishing system for books and ebooks. It supports InDesign, EPUB and LaTeX.'
-  gem.required_rubygems_version = Gem::Requirement.new('>= 0') if gem.respond_to? :required_rubygems_version=
-  gem.date = '2018-11-30'
+  gem.required_rubygems_version = Gem::Requirement.new('>= 0') if gem.respond_to?(:required_rubygems_version=)
+  gem.date = '2020-06-29'
 
   gem.files         = `git ls-files`.split("\n")
   gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
@@ -25,7 +25,9 @@ Gem::Specification.new do |gem|
   gem.add_dependency('rubyzip')
   gem.add_development_dependency('pygments.rb')
   gem.add_development_dependency('rake')
-  gem.add_development_dependency('rubocop', '~> 0.57.2')
+  gem.add_development_dependency('rubocop', '~> 0.77.0')
+  gem.add_development_dependency('rubocop-performance')
   gem.add_development_dependency('simplecov')
   gem.add_development_dependency('test-unit')
+  gem.add_development_dependency('unicode-eaw')
 end

data/samples/sample-book/README.md

@@ -2,6 +2,11 @@
 
 Re:VIEW ( http://github.com/kmuto/review )で書籍データを作るためのサンプルファイルです。
 
-必要なファイルはsrc/ディレクトリ内にあります。srcディレクトリで「review-epubmaker config.yml」と実行すればEPUBが、「review-pdfmaker config.yml」とすればPDFが生成されます(PDFの生成にはupLaTeXとdvipdfmxが必要です)。
+必要なファイルはsrcディレクトリ内にあります。srcディレクトリで以下のようにして各形式のファイルを生成できます。
 
-Ruby製のビルドツールであるrakeがインストールされている環境の場合、「rake pdf」を実行すればPDFが、「rake epub」を実行すればEPUBが生成されます。また、「rake html_all」を実行すればHTMLが生成されます。
+- rake pdf: PDF (upLaTeXとdvipdfmxが必要です)
+- rake epub: EPUB
+- rake web: HTML Webページ
+- rake text: テキストファイル
+- rake plaintext: テキストファイル (装飾なし)
+- rake idgxml: InDesign用XMLファイル

data/samples/sample-book/src/.gitignore

@@ -0,0 +1,154 @@
+/*.pdf
+/*.epub
+/*.html
+/webroot
+/*-pdf
+/*-epub
+/*-text
+/*-idgxml
+
+/vendor
+/.bundle
+
+# Created by https://www.gitignore.io/api/vim,linux,macos,emacs,windows
+# Edit at https://www.gitignore.io/?templates=vim,linux,macos,emacs,windows
+
+### Emacs ###
+# -*- mode: gitignore; -*-
+*~
+\#*\#
+/.emacs.desktop
+/.emacs.desktop.lock
+*.elc
+auto-save-list
+tramp
+.\#*
+
+# Org-mode
+.org-id-locations
+*_archive
+
+# flymake-mode
+*_flymake.*
+
+# eshell files
+/eshell/history
+/eshell/lastdir
+
+# elpa packages
+/elpa/
+
+# reftex files
+*.rel
+
+# AUCTeX auto folder
+/auto/
+
+# cask packages
+.cask/
+dist/
+
+# Flycheck
+flycheck_*.el
+
+# server auth directory
+/server/
+
+# projectiles files
+.projectile
+
+# directory configuration
+.dir-locals.el
+
+# network security
+/network-security.data
+
+
+### Linux ###
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### Vim ###
+# Swap
+[._]*.s[a-v][a-z]
+[._]*.sw[a-p]
+[._]s[a-rt-v][a-z]
+[._]ss[a-gi-z]
+[._]sw[a-p]
+
+# Session
+Session.vim
+Sessionx.vim
+
+# Temporary
+.netrwhist
+# Auto-generated tag files
+tags
+# Persistent undo
+[._]*.un~
+
+### Windows ###
+# Windows thumbnail cache files
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+# End of https://www.gitignore.io/api/vim,linux,macos,emacs,windows

data/samples/sample-book/src/config-ebook.yml

@@ -0,0 +1,4 @@
+# call me by 'REVIEW_CONFIG_FILE=config-ebook.yml rake pdf'
+inherit: ["config.yml"]
+pdfmaker:
+  texdocumentclass: ["review-jsbook", "media=ebook,paper=a5"]

data/samples/sample-book/src/config-jlreq-ebook.yml

@@ -0,0 +1,4 @@
+# call me by 'REVIEW_TEMPLATE=review-jlreq REVIEW_CONFIG_FILE=config-jlreq-ebook.yml rake pdf'
+inherit: ["config.yml"]
+pdfmaker:
+  texdocumentclass: ["review-jlreq", "media=ebook,paper=a5"]

data/samples/sample-book/src/config-jlreq.yml

@@ -0,0 +1,6 @@
+# call me by 'REVIEW_TEMPLATE=review-jlreq REVIEW_CONFIG_FILE=config-jlreq.yml rake pdf'
+inherit: ["config.yml"]
+pdfmaker:
+  texdocumentclass: ["review-jlreq", "media=print,paper=a5"]
+  # texdocumentclass: ["review-jlreq", "media=ebook,paper=a5"]
+  # texdocumentclass: ["review-jlreq", "media=print,paper=a5,tombopaper=a4,bleed_margin=3mm,cover=true,Q=14,startpage=3,serial_pagination=true,hiddenfolio=nikko-pc"]

data/samples/sample-book/src/config.yml

@@ -1,5 +1,5 @@
 ## config.yml for sample book
-review_version: 3.0
+review_version: 4.0
 bookname: book
 language: ja
 booktitle: Re:VIEWサンプル書籍
@@ -35,7 +35,7 @@ colophon: true
 # font_ext: ["ttf", "woff", "otf"]
 # catalogfile: catalog.yml
 # page_metric: A5
-# page_metric: [40,80,40,80,2]
+# page_metric: [40,34,29,34]
 # direction: "ltr"
 
 epubmaker:

data/samples/sample-book/src/lib/tasks/review.rake

@@ -1,4 +1,4 @@
-# Copyright (c) 2006-2018 Minero Aoki, Kenshi Muto, Masayoshi Takahashi, Masanori Kado.
+# Copyright (c) 2006-2020 Minero Aoki, Kenshi Muto, Masayoshi Takahashi, Masanori Kado.
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -29,15 +29,21 @@ CATALOG_FILE = ENV['REVIEW_CATALOG_FILE'] || 'catalog.yml'
 WEBROOT = ENV['REVIEW_WEBROOT'] || 'webroot'
 TEXTROOT = BOOK + '-text'
 TOPROOT = BOOK + '-text'
+IDGXMLROOT = BOOK + '-idgxml'
+PDF_OPTIONS = ENV['REVIEW_PDF_OPTIONS'] || ''
+EPUB_OPTIONS = ENV['REVIEW_EPUB_OPTIONS'] || ''
+WEB_OPTIONS = ENV['REVIEW_WEB_OPTIONS'] || ''
+IDGXML_OPTIONS = ENV['REVIEW_IDGXML_OPTIONS'] || ''
+TEXT_OPTIONS = ENV['REVIEW_TEXT_OPTIONS'] || ''
 
 def build(mode, chapter)
-  sh "review-compile --target=#{mode} --footnotetext --stylesheet=style.css #{chapter} > tmp"
+  sh("review-compile --target=#{mode} --footnotetext --stylesheet=style.css #{chapter} > tmp")
   mode_ext = { 'html' => 'html', 'latex' => 'tex', 'idgxml' => 'xml', 'top' => 'txt', 'plaintext' => 'txt' }
-  FileUtils.mv 'tmp', chapter.gsub(/re\z/, mode_ext[mode])
+  FileUtils.mv('tmp', chapter.gsub(/re\z/, mode_ext[mode]))
 end
 
 def build_all(mode)
-  sh "review-compile --target=#{mode} --footnotetext --stylesheet=style.css"
+  sh("review-compile --target=#{mode} --footnotetext --stylesheet=style.css")
 end
 
 task default: :html_all
@@ -74,12 +80,17 @@ task web: WEBROOT
 
 desc 'generate text file (without decoration)'
 task plaintext: TEXTROOT do
-  sh "review-textmaker -n #{CONFIG_FILE}"
+  sh "review-textmaker #{TEXT_OPTIONS} -n #{CONFIG_FILE}"
 end
 
 desc 'generate (decorated) text file'
 task text: TOPROOT do
-  sh "review-textmaker #{CONFIG_FILE}"
+  sh "review-textmaker #{TEXT_OPTIONS} #{CONFIG_FILE}"
+end
+
+desc 'generate IDGXML file'
+task idgxml: IDGXMLROOT do
+  sh "review-idgxmlmaker #{IDGXML_OPTIONS} #{CONFIG_FILE}"
 end
 
 desc 'generate EPUB file'
@@ -92,22 +103,26 @@ SRC_EPUB = FileList['*.css']
 SRC_PDF = FileList['layouts/*.erb', 'sty/**/*.sty']
 
 file BOOK_PDF => SRC + SRC_PDF do
-  FileUtils.rm_rf [BOOK_PDF, BOOK, BOOK + '-pdf']
-  sh "review-pdfmaker #{CONFIG_FILE}"
+  FileUtils.rm_rf([BOOK_PDF, BOOK, BOOK + '-pdf'])
+  sh "review-pdfmaker #{PDF_OPTIONS} #{CONFIG_FILE}"
 end
 
 file BOOK_EPUB => SRC + SRC_EPUB do
-  FileUtils.rm_rf [BOOK_EPUB, BOOK, BOOK + '-epub']
-  sh "review-epubmaker #{CONFIG_FILE}"
+  FileUtils.rm_rf([BOOK_EPUB, BOOK, BOOK + '-epub'])
+  sh "review-epubmaker #{EPUB_OPTIONS} #{CONFIG_FILE}"
 end
 
 file WEBROOT => SRC do
-  FileUtils.rm_rf [WEBROOT]
-  sh "review-webmaker #{CONFIG_FILE}"
+  FileUtils.rm_rf([WEBROOT])
+  sh "review-webmaker #{WEB_OPTIONS} #{CONFIG_FILE}"
 end
 
 file TEXTROOT => SRC do
-  FileUtils.rm_rf [TEXTROOT]
+  FileUtils.rm_rf([TEXTROOT])
+end
+
+file IDGXMLROOT => SRC do
+  FileUtils.rm_rf([IDGXMLROOT])
 end
 
-CLEAN.include([BOOK, BOOK_PDF, BOOK_EPUB, BOOK + '-pdf', BOOK + '-epub', WEBROOT, 'images/_review_math', TEXTROOT])
+CLEAN.include([BOOK, BOOK_PDF, BOOK_EPUB, BOOK + '-pdf', BOOK + '-epub', WEBROOT, 'images/_review_math', 'images/_review_math_text', TEXTROOT, IDGXMLROOT])