review 2.3.0 → 2.4.0

data/NEWS.md

@@ -1,3 +1,86 @@
+# Version 2.4.0
+
+## New Features
+
+* use built-in Logger class for warns and errors ([#705])
+* EPUBMaker: warn of large images because of rejecting ebook stores ([#819])
+* LATEXBuilder: add new inline command `@<pageref>` ([#836])
+* support inline notaion `| |` and `$ $` instead of `{}` to surpress escaping `}` ([#876])
+
+## Breaking Changes
+
+* LATEXBuilder: use Roman numerals as part numbers ([#837])
+* EPUBMaker: TOC should be after frontmatter ([#840])
+* `imgmath` uses folder `images/_review_math`, not `images` directly ([#856])
+* EPUBMaker: default value of titlepage is `true`, not `null` ([#862])
+* EPUBMaker: `params` in template files should be `config` ([#867])
+* EWBBuilder is removed because nobody maintained it ([#828])
+
+## Bug Fixes
+
+* fix misrecognition of HeadlineIndex ([#121])
+* TOPBuilder: fix metric parameter in `//image` and `//indepimage` ([#805])
+* fix refering columns in other chapters ([#817])
+* use execution date when `date` in config.yml is empty ([#824])
+* fix I18N messages of `listref`, `imgref`, and `tableref` in frontmatters and backmatters ([#830])
+* WebMaker: fix booktitle using Hash ([#831])
+* LATEXBuilder: use lmodern package to avoid to use Type3 font in Western languages ([#843])
+* fix broken title using `/` in config.yml ([#852])
+* PDFMaker: fix toclevel ([#846])
+
+## Enhancements
+
+* allow block `{ 〜 //}` in `//indepimage`. ([#802])
+* warn when images are not found in `//indepimage`([#803])
+* LATEXBuilder: allow caption in `//source` ([#834])
+
+## Docs
+
+* add that installing LaTeX environments is needed to use `rake pdf` ([#800])
+* fix links in README.md ([#815])
+* add sample document to test commands of Re:VIEW ([#833])
+* fix comment of `titlepage` in config.yml ([#847])
+* fix description of `footnotetext` ([#872])
+
+## Others
+
+* fix coding rules to surpress rubocop v0.50.0 ([#823])
+
+## Contributors
+
+* [@ryota-murakami](https://github.com/ryota-murakami)
+* [@nasum](https://github.com/nasum)
+* [@kokuyouwind](https://github.com/kokuyouwind)
+
+[#121]: https://github.com/kmuto/review/issues/121
+[#705]: https://github.com/kmuto/review/issues/705
+[#800]: https://github.com/kmuto/review/pull/800
+[#802]: https://github.com/kmuto/review/issues/802
+[#803]: https://github.com/kmuto/review/issues/803
+[#805]: https://github.com/kmuto/review/pull/805
+[#815]: https://github.com/kmuto/review/pull/815
+[#817]: https://github.com/kmuto/review/pull/817
+[#819]: https://github.com/kmuto/review/issues/819
+[#823]: https://github.com/kmuto/review/issues/823
+[#824]: https://github.com/kmuto/review/issues/824
+[#828]: https://github.com/kmuto/review/pull/828
+[#830]: https://github.com/kmuto/review/pull/830
+[#831]: https://github.com/kmuto/review/pull/831
+[#833]: https://github.com/kmuto/review/pull/833
+[#834]: https://github.com/kmuto/review/issues/834
+[#836]: https://github.com/kmuto/review/issues/836
+[#840]: https://github.com/kmuto/review/pull/840
+[#843]: https://github.com/kmuto/review/issues/843
+[#837]: https://github.com/kmuto/review/issues/837
+[#846]: https://github.com/kmuto/review/issues/846
+[#847]: https://github.com/kmuto/review/pull/847
+[#852]: https://github.com/kmuto/review/issues/852
+[#856]: https://github.com/kmuto/review/issues/856
+[#862]: https://github.com/kmuto/review/pull/862
+[#867]: https://github.com/kmuto/review/issues/867
+[#872]: https://github.com/kmuto/review/issues/872
+[#876]: https://github.com/kmuto/review/issues/876
+
 # Version 2.3.0
 
 ## New Features

data/README.md

@@ -6,7 +6,9 @@
 
 Re:VIEW is an easy-to-use digital publishing system for paper books and ebooks.
 
-## Supported Format
+## Supported Formats
+
+![supported formats](./doc/images/review-generate.png)
 
 Output formats Re:VIEW supports are:
 
@@ -55,10 +57,10 @@ $ review-init hello
 $ cd hello
 $ (... add and edit *.re file, config.yml and catalog.yml ...)
 $ rake epub  ## generating EPUB
-$ rake pdf   ## generating PDF
+$ rake pdf   ## generating PDF(Requirement TeX)
 ```
 
-For further information, see [doc/quickstart.md](https://github.com/kmuto/review/blob/readme-md/doc/quickstart.md)
+For further information, see [doc/quickstart.md](https://github.com/kmuto/review/blob/master/doc/quickstart.md)
 
 ## Resources
 

data/Rakefile

@@ -3,26 +3,26 @@ begin
   Bundler::GemHelper.install_tasks
 rescue LoadError
   # ignore if bundler does not exist
-  warn "Bundler not found"
+  warn 'Bundler not found'
 end
 
 require 'rubygems'
 require 'rake/clean'
 
-task :default => [:test, :rubocop]
+task default: %i[test rubocop]
 
-desc "Check with rubocop"
+desc 'Check with rubocop'
 task :rubocop do
   begin
     require 'rubocop/rake_task'
     RuboCop::RakeTask.new
   rescue LoadError
-    warn "rubocop not found"
+    warn 'rubocop not found'
   end
 end
 
 task :test do
-  ruby("test/run_test.rb")
+  ruby('test/run_test.rb')
 end
 
 begin
@@ -35,18 +35,18 @@ begin
     t.verbose = true
   end
 rescue LoadError
-  warn "rcov not found"
+  warn 'rcov not found'
 end
 
 begin
   require 'rdoc/task'
   Rake::RDocTask.new do |rdoc|
-    version = File.exist?('VERSION') ? File.read('VERSION') : ""
+    version = File.exist?('VERSION') ? File.read('VERSION') : ''
     rdoc.rdoc_dir = 'rdoc'
     rdoc.title = "review #{version}"
     rdoc.rdoc_files.include('README*')
     rdoc.rdoc_files.include('lib/**/*.rb')
   end
 rescue LoadError
-  warn "rdoc not found"
+  warn 'rdoc not found'
 end

data/bin/review

@@ -1,5 +1,4 @@
 #!/usr/bin/env ruby
-
 #
 # review: Wrapper command to call subcommand
 #
@@ -35,12 +34,9 @@ command = "review-#{ARGV.shift}"
 bindir = Pathname.new(__FILE__).realpath.dirname
 command_path = File.join(bindir, command)
 
-if !File.exist?(command_path)
+unless File.exist?(command_path)
   print "cannot find command: #{command}\n\n"
   usage
 end
 
 exec(command_path, *ARGV)
-
-
-

data/bin/review-catalog-converter

@@ -1,7 +1,6 @@
 #!/usr/bin/env ruby
-# -*- coding: utf-8 -*-
 #
-# Copyright (c) 2014 Masanori Kado
+# Copyright (c) 2014-2017 Masanori Kado, Kenshi Muto
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -16,11 +15,13 @@ bindir = Pathname.new(__FILE__).realpath.dirname
 $LOAD_PATH.unshift((bindir + '../lib').realpath)
 require 'review/version'
 require 'review/extentions'
+require 'review/logger'
 
 def main
+  @logger = ReVIEW.logger
   opts = OptionParser.new
   opts.version = ReVIEW::VERSION
-  opts.banner = "Usage: #{File.basename($0)} dirname"
+  opts.banner = "Usage: #{File.basename($PROGRAM_NAME)} dirname"
   opts.on('-h', '--help', 'print this message and quit.') do
     puts opts.help
     exit 0
@@ -29,7 +30,7 @@ def main
   begin
     opts.parse!
   rescue OptionParser::ParseError => err
-    $stderr.puts err.message
+    @logger.error err.message
     $stderr.puts opts.help
     exit 1
   end
@@ -39,19 +40,19 @@ def main
   # confirmation
   if File.exist?("#{dir}/catalog.yml")
     loop do
-      print "The catalog.yml already exists. Do you want to overwrite it? [y/n]"
+      print 'The catalog.yml already exists. Do you want to overwrite it? [y/n]'
       case gets
-      when /^[yY]/
-        puts "Start writing..."
+      when /\A[yY]/
+        @logger.info 'Start writing...'
         break
-      when /^[nN]/, /^$/
-        puts "bye."
+      when /\A[nN]/, /\A\Z/
+        @logger.info 'bye.'
         exit
       end
     end
   end
 
-  File.open("#{dir}/catalog.yml", "w") do |catalog|
+  File.open("#{dir}/catalog.yml", 'w') do |catalog|
     # predef
     if File.exist?("#{dir}/PREDEF")
       catalog << parse_predef(File.open("#{dir}/PREDEF").read)
@@ -69,12 +70,12 @@ def main
     if File.exist?("#{dir}/POSTDEF")
       postdef = File.open("#{dir}/POSTDEF").read
       loop do
-        print "Do you want to convert POSTDEF into APPENDIX? [y/n]"
+        print 'Do you want to convert POSTDEF into APPENDIX? [y/n]'
         case gets
-        when /^[yY]/
+        when /\A[yY]/
           catalog << parse_postdef(postdef, true)
           break
-        when /^[nN]/, /^$/
+        when /\A[nN]/, /\A\Z/
           catalog << parse_postdef(postdef)
           break
         end
@@ -85,9 +86,9 @@ def main
   puts File.open("#{dir}/catalog.yml").read
 end
 
-def _parse(str, header)
+def parse_internal(str, header)
   if str.present?
-    header + str.split("\n").map{|i| "  - #{i}\n" }.join
+    header + str.split("\n").map { |i| "  - #{i}\n" }.join
   else
     header
   end
@@ -95,12 +96,12 @@ end
 
 def parse_predef(str)
   header = "PREDEF:\n"
-  _parse(str, header) + "\n"
+  parse_internal(str, header) + "\n"
 end
 
 def parse_chaps(str)
   header = "CHAPS:\n"
-  _parse(str, header) + "\n"
+  parse_internal(str, header) + "\n"
 end
 
 def parse_postdef(str, to_appendix = false)
@@ -109,21 +110,15 @@ def parse_postdef(str, to_appendix = false)
   else
     header = "POSTDEF:\n"
   end
-  _parse(str, header) + "\n"
+  parse_internal(str, header) + "\n"
 end
 
 def parse_parts(parts_str, chaps_str)
-  if parts_str.blank? or chaps_str.blank?
-    return "CHAPS:\n\n"
-  end
+  return "CHAPS:\n\n" if parts_str.blank? or chaps_str.blank?
 
   parts = parts_str.split("\n")
   chaps = chaps_str.split("\n\n")
-  "CHAPS:\n" + parts.zip(chaps).map{|k, vs|
-    "  - #{k}:\n" + vs.split("\n").map{|i| "    - #{i}\n"}.join
-  }.join + "\n"
+  "CHAPS:\n" + parts.zip(chaps).map { |k, vs| "  - #{k}:\n" + vs.split("\n").map { |i| "    - #{i}\n" }.join }.join + "\n"
 end
 
-if File.basename($0) == File.basename(__FILE__)
-  main()
-end
+main if File.basename($PROGRAM_NAME) == File.basename(__FILE__)

data/bin/review-check

@@ -1,8 +1,7 @@
 #!/usr/bin/env ruby
 #
-#
-# Copyright (c) 1999-2007 Minero Aoki
-# Copyright (c) 2010-2014 Kenshi Muto, Minero Aoki
+# Copyright (c) 2010-2017 Kenshi Muto, Minero Aoki
+#               1999-2007 Minero Aoki
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -35,34 +34,32 @@ def main
   @book = ReVIEW::Book::Base.load
   @book.config = @config
 
+  @logger = ReVIEW.logger
+
   modes = nil
   files = ARGV unless ARGV.empty?
   opts = OptionParser.new
   opts.version = ReVIEW::VERSION
-  opts.on('-a', '--all-chapters', 'Check all chapters.') {
-    files = @book.chapters.map {|ent| ent.path }
-  }
-  opts.on('-s', '--section N', 'Check section N. (deprecated)') {|n|
+  opts.on('-a', '--all-chapters', 'Check all chapters.') { files = @book.chapters.map(&:path) }
+  opts.on('-s', '--section N', 'Check section N. (deprecated)') do |n|
     ents = @book.parts[Integer(n) - 1] or
-        raise ReVIEW::ApplicationError, "section #{n} not exist"
-    files = ents.map {|ent| ent.path }
-  }
-  opts.on('--text', 'Check text.') {
-    (modes ||= []).push :text
-  }
-  opts.on('--help', 'print this message and quit.') {
+      raise ReVIEW::ApplicationError, "section #{n} not exist"
+    files = ents.map(&:path)
+  end
+  opts.on('--text', 'Check text.') { (modes ||= []).push :text }
+  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
-    $stderr.puts opts.help
+    @logger.error(err.message)
+    puts opts.help
     exit 1
   end
   unless files
-    $stderr.puts "no input"
+    @logger.error('no input')
     exit 1
   end
   modes ||= [:text]
@@ -80,31 +77,28 @@ end
 def check_text(files)
   re, neg = words_re("#{@book.basedir}/#{@book.reject_file}")
   files.each do |path|
-    File.open(path) {|f|
+    File.open(path) do |f|
       each_paragraph(f) do |para, lineno|
-        s = para.join('')
-        if m = re.match(s)
-          next if m[0] == @review_utils_word_ok
-          next if neg and neg =~ s
-          str, offset = find_line(para, re)
-          out = sprintf("%s:%d: %s\n", path, lineno + offset, str)
-          print out
-        end
+        s = para.join
+        m = re.match(s)
+        next if m.nil? || m[0] == @review_utils_word_ok
+        next if neg and neg =~ s
+        str, offset = find_line(para, re)
+        out = sprintf("%s:%d: %s\n", path, lineno + offset, str)
+        print out
       end
-    }
+    end
   end
 end
 
 def find_line(lines, re)
   # single line?
-  lines.each_with_index do |line, idx|
-    return line.gsub(re, '<<<\&>>>'), idx if re =~ line
-  end
+  lines.each_with_index { |line, idx| return line.gsub(re, '<<<\&>>>'), idx if re =~ line }
 
   # multiple lines?
   i = 0
   while i < lines.size - 1
-    str = lines[i] + lines[i+1]
+    str = lines[i] + lines[i + 1]
     return str.gsub(re, '<<<\&>>>'), i if re =~ str
     i += 1
   end
@@ -116,15 +110,14 @@ def words_re(rc)
   words = []
   nega = []
   File.foreach(rc) do |line|
-    next if line[0,1] == '#'
+    next if line[0, 1] == '#'
     if / !/ =~ line
-      line, n = *line.split(/!/, 2)
+      line, n = *line.split('!', 2)
       nega.push n.strip
     end
     words.push line.strip
   end
-  return Regexp.compile(words.join('|')),
-         nega.empty?() ? nil : Regexp.compile(nega.join('|'))
+  [Regexp.compile(words.join('|')), nega.empty? ? nil : Regexp.compile(nega.join('|'))]
 end
 
 def each_paragraph(f)
@@ -135,23 +128,25 @@ def each_paragraph(f)
       @review_utils_word_ok = $1
     when /\A\#@/
       # do nothing
-    when %r[\A//caption\{(.*?)//\}]
+      next
+    when %r{\A//caption\{(.*?)//\}}
       yield [$1], f.filename, f.lineno
     when %r<\A//\w.*\{\s*\z>
       while line = f.gets
-        break if %r<//\}> === line
+        break if %r{//\}} === line
       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
       while line = f.gets
         break if line.strip.empty?
-        break if %r<\A(?:=|//[\w\}])> =~ line
-        next if %r<\A\#@> =~ line
+        break if %r{\A(?:=|//[\w\}])} =~ line
+        next if /\A\#@/ =~ line
         buf.push line.strip
       end
       yield buf, lineno
@@ -161,9 +156,7 @@ def each_paragraph(f)
 end
 
 def each_paragraph_line(f, &block)
-  each_paragraph(f) do |para, *|
-    para.each(&block)
-  end
+  each_paragraph(f) { |para, *| para.each(&block) }
 end
 
 sigmain