review 2.0.0.beta1 → 2.0.0

data/.travis.yml

@@ -1,9 +1,24 @@
+language: ruby
+sudo: false
+
+before_install:
+  - gem update bundler
+
 rvm:
-  - 1.9.3
   - 2.0.0
   - 2.1.*
   - 2.2.*
+  - 2.3.0
+
+addons:
+  apt_packages:
+    - libgmp3-dev
 
 branches:
   only:
     - master
+
+script:
+  - bundle exec rake test
+  - bundle exec rubocop
+

data/ChangeLog

@@ -1,3 +1,51 @@
+Fri Apr 29 23:11:06 2016  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* Release 2.0.0
+
+Mon Apr  4 14:42:51 2016  Kenshi Muto  <kmuto@debian.org>
+
+	* config.yml:
+	  support "inherit: YAMLfilename" parameter in config.yml to
+	  read other YAML file (such as common.yml.)
+
+Sun Apr 3 17:21:25 2016  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* epubmaker:
+	  add direction in default setting.
+
+Sun Apr 3 11:04:53 2016  Kenshi Muto  <kmuto@debian.org>
+
+	* epubmaker:
+	  accept hash value for 'booktitle' and some other parameters,
+	  as same as 'aut:' (author value).
+	  This change aims to set "file-as" variable to book title.
+
+Sun Apr 3 11:03:47 2016  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	use SecureRandom.uuid instead of ruby-uuid
+
+Fri Mar 25 22:16:33 2016  Kenshi Muto  <kmuto@debian.org>
+
+	* bin/review-preproc:
+	  load review-preproc-ext.rb if it exists, to overwrite
+	  review-preproc.
+
+Sun Dec 27 16:25:45 2015  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* Release 1.7.2
+
+Sun Nov 29 23:12:29 2015  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* Release 1.7.1
+
+Thu Oct 29 13:58:22 2015  KADO Masanori  <kdmsnr@gmail.com>
+
+	* Release 1.7.0
+
+Mon Jun 29 18:16:06 2015  KADO Masanori  <kdmsnr@gmail.com>
+
+	* Release 1.6.0
+
 Sat Feb 28 19:51:29 2015  KADO Masanori  <kdmsnr@gmail.com>
 
 	* Release 1.5.0.

data/Dockerfile

@@ -0,0 +1,22 @@
+# This file is a sample Dockerfile to build Re:VIEW documents.
+#
+# Build:
+#   $ docker build -t review .
+#
+# Usage:
+#   $ cd path/to/review/project
+#   $ docker run -it --rm -v `pwd`:/work review rake pdf
+#
+# cf. https://github.com/vvakame/docker-review/blob/master/Dockerfile
+
+FROM debian:sid
+MAINTAINER takahashim
+
+RUN apt-get update \
+	&& apt-get install -y --no-install-recommends git-core ruby locales zip \
+    && apt-get install -y --no-install-recommends texlive-lang-cjk texlive-lang-japanese texlive-fonts-recommended texlive-latex-extra ghostscript \
+	&& rm -rf /var/lib/apt/lists/*
+RUN gem install review rake bundler --no-rdoc --no-ri
+
+VOLUME ["/work"]
+WORKDIR /work

data/Gemfile

@@ -3,4 +3,3 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in review.gemspec
 gemspec
 
-gem "json"

data/README.md

@@ -0,0 +1,97 @@
+# Re:VIEW
+
+[![Build Status](https://secure.travis-ci.org/kmuto/review.png)](http://travis-ci.org/kmuto/review)
+[![Gem Version](https://badge.fury.io/rb/review.png)](http://badge.fury.io/rb/review)
+
+Re:VIEW is an easy-to-use digital publishing system for paper books and ebooks.
+
+## Supported Format
+
+Output formats Re:VIEW supports are:
+
+* EPUB
+* LaTeX
+* InDesign (IDGXML)
+* Markdown
+* plain text (TOPBuilder Text Markup Language)
+
+Re:VIEW uses its original format('Re:VIEW format') as source files.  See doc/format.md.
+
+## Commands
+
+There are two commands generate files directly.
+
+* review-epubmaker: generate EPUB file.
+* review-pdfmaker: generate PDF file using LaTeX(ptexlive).
+
+And some useful commands.
+
+* review-compile: compile Re:VIEW fomat files.
+* review-vol: figure out size of Re:VIEW files.
+* review-index: generate index with various format.
+* review-preproc: preprocessor.
+
+## Installation
+
+Install gem yourself as:
+
+    $ gem install review
+
+Or build from source:
+
+    $ git clone https://github.com/kmuto/review.git
+    $ cd review
+    $ rake install
+
+Or add the `./bin` directory to your $PATH:
+
+$ echo "export PATH=PATH_OF_REVIEW/bin:$PATH" >> ~/.profile
+
+## Quick Start
+
+```
+$ review-init hello
+$ cd hello
+$ (... add and edit *.re file, config.yml and catalog.yml ...)
+$ rake epub  ## generating EPUB
+$ rake pdf   ## generating PDF
+```
+
+For further information, see [doc/quickstart.md](https://github.com/kmuto/review/blob/readme-md/doc/quickstart.md)
+
+## Resources
+
+|         | URL                                    |
+|---------|----------------------------------------|
+| Home    | http://reviewml.org                    |
+| Project | https://github.com/kmuto/review/       |
+| Gems    | https://rubygems.org/gems/review       |
+| Wiki    | https://github.com/kmuto/review/wiki   |
+| Bugs    | https://github.com/kmuto/review/issues |
+
+### Documents
+
+* Wiki pages: https://github.com/kmuto/review/wiki
+* doc/* files (in English and Japanese)
+
+### Issues tracker
+
+* GitHub: https://github.com/kmuto/review
+
+### Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## License
+
+LGPL. See [COPYING](https://github.com/kmuto/review/blob/master/COPYING) file.
+
+## Copyright
+
+Copyright (c) 2006-2016 Minero Aoki, Kenshi Muto, Masayoshi Takahashi, Masanori Kado.

data/Rakefile

@@ -1,5 +1,3 @@
-require 'fileutils'
-
 begin
   require 'bundler'
   Bundler::GemHelper.install_tasks
@@ -11,21 +9,22 @@ require 'rubygems'
 require 'rake/testtask'
 require 'rake/clean'
 
-task :default => [:test]
+task :default => [:test, :rubocop]
 
-task :kpeg do
-  FileUtils.rm_f "lib/review/compiler.rb"
-  FileUtils.rm_f "lib/review/compiler/literals_1_8.rb"
-  FileUtils.rm_f "lib/review/compiler/literals_1_9.rb"
-  sh "kpeg -s lib/review/compiler/literals_1_8.kpeg -o lib/review/compiler/literals_1_8.rb"
-  sh "kpeg -s lib/review/compiler/literals_1_9.kpeg -o lib/review/compiler/literals_1_9.rb"
-  sh "kpeg -s lib/review/review.kpeg -o lib/review/compiler.rb"
+task :rubocop do
+  begin
+    require 'rubocop/rake_task'
+    RuboCop::RakeTask.new
+  rescue LoadError
+    warn "rubocop not found"
+  end
 end
 
 Rake::TestTask.new("test") do |t|
-  t.libs   << "test"
+  t.libs << "test"
   t.test_files = Dir.glob("test/**/test_*.rb")
   t.verbose = true
+  t.warning = false
 end
 
 begin

data/appveyor.yml

@@ -0,0 +1,9 @@
+---
+install:
+  - SET PATH=C:\Ruby22-x64\bin;%PATH%
+  - ruby --version
+  - gem --version
+build_script:
+  - bundle install
+  - bundle exec rake test --trace --verbose
+  - bundle exec rubocop

data/bin/review

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+
+#
+# review: Wrapper command to call subcommand
+#
+# ex.
+#    review epubmaker config.yml
+#      -> call `review-epubmaker config.yml`
+#
+
+require 'pathname'
+
+def usage
+  message = <<-EOB
+usage: review <command> [<args>]
+
+ReVIEW commands are:
+  init
+  preproc
+  compile
+  epubmaker
+  pdfmaker
+  vol
+  check
+  index
+  validate
+EOB
+  print message
+  exit 1
+end
+
+usage if ARGV.length == 0
+
+command = "review-#{ARGV.shift}"
+bindir = Pathname.new(__FILE__).realpath.dirname
+command_path = File.join(bindir, command)
+
+if !File.exist?(command_path)
+  print "cannot find command: #{command}\n\n"
+  usage
+end
+
+exec(command_path, *ARGV)
+
+
+

data/bin/review-check

@@ -31,12 +31,7 @@ rescue Errno::EPIPE
 end
 
 def main
-  $KCODE = 'UTF-8' unless defined?(Encoding)
   @config = ReVIEW::Configure.values
-  @config.merge!({
-    "inencoding" => "UTF-8",
-    "outencoding" => "UTF-8"
-  })
   @book = ReVIEW::Book::Base.load
   @book.config = @config
 
@@ -44,12 +39,6 @@ def main
   files = ARGV unless ARGV.empty?
   opts = OptionParser.new
   opts.version = ReVIEW::VERSION
-  opts.on('--inencoding=ENCODING', 'Set input encoding. (UTF-8, EUC, JIS, and SJIS)') {|enc|
-    @config["inencoding"] = enc
-  }
-  opts.on('--outencoding=ENCODING', 'Set output encoding. (UTF-8[default], EUC, JIS, and SJIS)') {|enc|
-    @config["outencoding"] = enc
-  }
   opts.on('-a', '--all-chapters', 'Check all chapters.') {
     files = @book.chapters.map {|ent| ent.path }
   }
@@ -95,11 +84,11 @@ def check_text(files)
       each_paragraph(f) do |para, lineno|
         s = para.join('')
         if m = re.match(s)
-          next if m[0] == $ReVIEW_utils_word_ok
+          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 convert_outencoding(out, @config["outencoding"])
+          print out
         end
       end
     }
@@ -109,14 +98,14 @@ end
 def find_line(lines, re)
   # single line?
   lines.each_with_index do |line, idx|
-    return line.gsub(re, '<<<\&>>>'), idx  if re =~ line
+    return line.gsub(re, '<<<\&>>>'), idx if re =~ line
   end
 
   # multiple lines?
   i = 0
   while i < lines.size - 1
     str = lines[i] + lines[i+1]
-    return str.gsub(re, '<<<\&>>>'), i  if re =~ str
+    return str.gsub(re, '<<<\&>>>'), i if re =~ str
     i += 1
   end
 
@@ -127,7 +116,7 @@ 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)
       nega.push n.strip
@@ -139,13 +128,11 @@ def words_re(rc)
 end
 
 def each_paragraph(f)
-  $ReVIEW_utils_word_ok = nil
+  @review_utils_word_ok = nil
   while line = f.gets
-    line = convert_inencoding(line, @config["inencoding"])
-
     case line
     when /\A\#@ok\((.*)\)/
-      $ReVIEW_utils_word_ok = $1
+      @review_utils_word_ok = $1
     when /\A\#@/
       ;
     when %r[\A//caption\{(.*?)//\}]
@@ -168,7 +155,7 @@ def each_paragraph(f)
         buf.push line.strip
       end
       yield buf, lineno
-      $ReVIEW_utils_word_ok = nil
+      @review_utils_word_ok = nil
     end
   end
 end

data/bin/review-compile

@@ -2,7 +2,7 @@
 #
 # $Id: review-compile 4326 2010-01-12 14:10:17Z kmuto $
 #
-# Copyright (c) 2008-2014 Kenshi Muto, Masayoshi Takahashi, KADO Masanori, Minero Aoki
+# Copyright (c) 2008-2016 Kenshi Muto, Masayoshi Takahashi, KADO Masanori, Minero Aoki
 # Copyright (c) 1999-2007 Minero Aoki
 #
 # This program is free software.
@@ -17,11 +17,11 @@ bindir = Pathname.new(__FILE__).realpath.dirname
 $LOAD_PATH.unshift((bindir + '../lib').realpath)
 
 require 'review'
-require 'review/compiler'
-require 'review/book'
-require 'review/i18n'
 require 'fileutils'
 require 'optparse'
+require 'yaml'
+
+DEFAULT_CONFIG_FILENAME = "config.yml"
 
 def main
   Signal.trap(:INT) { exit 1 }
@@ -34,8 +34,6 @@ rescue Errno::EPIPE
 end
 
 def _main
-  $KCODE = 'UTF-8' unless defined?(Encoding)
-
   mode = :files
   basedir = nil
   if /\Areview2/ =~ File.basename($0)
@@ -47,32 +45,11 @@ def _main
   output_filename = nil
 
   config = ReVIEW::Configure.values
-  config.merge!({
-    "secnolevel" => 2,    # for IDGXML and HTML
-    "tableopt" => nil,    # for IDGXML
-    "nolf" => nil,        # for IDGXML
-    "chapref" => nil,     # for IDGXML
-    "structuredxml" => nil, # for IDGXML
-    "inencoding" => "UTF-8",
-    "outencoding" => "UTF-8",
-    "stylesheet" => [],   # for HTML
-    "mathml" => nil,      # for HTML
-    "language" => "ja",   # for HTML
-    "deprecated-blocklines" => nil,
-    "footnotetext" => false,
-    "htmlext" => "html",
-    "htmlversion" => 4,
-  })
 
   opts = OptionParser.new
   opts.version = ReVIEW::VERSION
   opts.banner = "Usage: #{File.basename($0)} [--target=FMT]"
-  opts.on('--yaml=YAML', 'Read configurations from YAML file.') do |yaml|
-    require 'yaml'
-    config = config.merge(YAML.load_file(yaml))
-  end
-  opts.on('--inencoding=ENCODING', 'Set input encoding. (UTF-8, EUC, JIS, and SJIS)') {|enc| config["inencoding"] = enc }
-  opts.on('--outencoding=ENCODING', 'Set output encoding. (UTF-8[default], EUC, JIS, and SJIS)') {|enc| config["outencoding"] = enc }
+  opts.on('--yaml=YAML', 'Read configurations from YAML file.') {|yaml| config["yaml"] = yaml}
   opts.on('-c', '--check', 'Check manuscript') { check_only = true }
   opts.on('--level=LVL', 'Section level to append number.') {|lvl| config["secnolevel"] = lvl.to_i }
   opts.on('--toclevel=LVL', 'Section level to append number.') {|lvl| config["toclevel"] = lvl.to_i }
@@ -80,13 +57,7 @@ def _main
   opts.on('--structuredxml', 'Produce XML with structured sections. (idgxml)') { config["structuredxml"] = true }
   opts.on('--table=WIDTH', 'Default table width. (idgxml)') {|tbl| config["tableopt"] = tbl }
   opts.on('--listinfo', 'Append listinfo tag to lists to indicate begin/end. (idgxml)') { config["listinfo"] = true }
-  opts.on('--chapref="before,middle,after"', 'Chapref decoration.') {|cdec| config["chapref"] = cdec }
-  opts.on('--subdirmode', 'Use chapter/id.ext path style to find images. (deprecated)') do
-    STDERR.puts "Warning: --subdirmode is deprecated. Images are automatically detected."
-  end
-  opts.on('--singledirmode', 'Use id.ext path style to find images. (deprecated)') do
-    STDERR.puts "Warning: --singledirmode is deprecated. Images are automatically detected."
-  end
+  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') do
@@ -100,18 +71,12 @@ def _main
     v = v.to_i
     config["epubversion"] = v if v == 2 || v == 3
   end
-  opts.on('--hdnumberingmode', 'Output numbering headlines. (deprecated)') { config["hdnumberingmode"] = true }
-  opts.on('--deprecated-blocklines', 'Disable paragrahs in block tags. Treat physical line as a paragraph. (deprecated)') { config["deprecated-blocklines"] = true }
   opts.on('--target=FMT', 'Target format.') {|fmt| target = fmt } unless target
   opts.on('--footnotetext',
             'Use footnotetext and footnotemark instead of footnote (latex)') {
     config["footnotetext"] = true
   }
   opts.on('--draft', 'use draft mode(inline comment)') { config["draft"] = true }
-  opts.on('-a', '--all', 'Compile all chapters.') do
-    mode = :dir
-    basedir = nil
-  end
   opts.on('--directory=DIR', 'Compile all chapters in DIR.') do |path|
     mode = :dir
     basedir = path
@@ -143,8 +108,26 @@ def _main
   end
 
   begin
+    loader = ReVIEW::YAMLLoader.new
+    if config["yaml"]
+      config.deep_merge!(loader.load_file(config["yaml"]))
+    else
+      if File.exist?(DEFAULT_CONFIG_FILENAME)
+        config.deep_merge!(loader.load_file(DEFAULT_CONFIG_FILENAME))
+      end
+    end
+
     config["builder"] = target
     ReVIEW::I18n.setup(config["language"])
+    begin
+      config.check_version(ReVIEW::VERSION)
+    rescue ReVIEW::ConfigError => e
+      warn e.message
+    end
+
+    if ARGV.blank?
+      mode = :dir
+    end
 
     case mode
     when :files
@@ -173,12 +156,12 @@ 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}"