review 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ede64a20eecee63934877cb311e35313c6ffeb75
-  data.tar.gz: 629a36d714fd028da9d7b7fda334406f6f128843
+  metadata.gz: 7003949429e45e08f404dd70af9d6cbe419d6b74
+  data.tar.gz: 081d336549a9141b9172c1dd1f0cc673bce73bbf
 SHA512:
-  metadata.gz: a2b09524e28687e28c86df4cb5971bb999e09813db2c52fe1d4af4e25bb3f00ce66eb4570c21a907ca3d3f9d708fde6a82b101c3b8564f34c62ec01976ad19a8
-  data.tar.gz: 0623f1131de71a1bfcc388c78fd2bce77ad191ba8c338d82f6390c92172457707220a18e626c24e5965dba643bf40aab7d2041a8759eae2de883b4d3d4b281bb
+  metadata.gz: 2b74a8d6ff2b7258b7fbcb51b27f2417f066734a96ec86cd75cc0a3d15d91c9d958630e4ed88519d3a0cde307309a08f124231cd0409b093ba337a7fab0c1544
+  data.tar.gz: 2fa797cd9ff23cddc563440e07d03de0fd75a130ca73ea7b5192a03175e2e79135c7c6b75e33ae1413981f595b64e69029531f4e499a2119603e84d62f8596a8

data/ChangeLog

@@ -1,3 +1,45 @@
+Wed Oct 29 18:54:28 2014  KADO Masanori  <kdmsnr@gmail.com>
+
+	* Release 1.4.0.
+
+Thu Sep 18 13:48:24 2014  KADO Masanori  <kdmsnr@gmail.com>
+
+	* bin/review-init, doc/format.rdoc, lib/review/htmlbuilder.rb, lib/review/pdfmaker.rb, lib/review/tocprinter.rb, lib/review/review.tex.erb: change the name of layout template files to "layout.html.erb" and "layout.tex.erb"
+
+Wed Aug 20 17:15:04 2014  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* lib/review/book/chapter.rb: remove unused method Chapter.for_stdin and Chapter.for_path
+
+Wed Aug 20 01:51:02 2014  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* lib/review/book/parameters.rb: remove ReVIEW::Book::Parameters
+
+Wed Aug 20 00:30:07 2014  Masayoshi Takahashi  <takahashimm@gmail.com>
+
+	* lib/review/book/parameters.rb, lib/review/book/base.rb,
+	  test/test_book.rb, test/test_book_parameter.rb:
+
+	  remove unused method: ReVIEW::Book::Parameters.default and ReVIEW::Book::Parameters.load
+
+Thu Aug  7 16:25:23 2014  KADO Masanori  <kdmsnr@gmail.com>
+
+	* lib/review/book/base.rb (Base#prefaces, postscripts):
+	  remove implicit prefaces and postscripts.
+
+Wed Aug  6 18:55:31 2014  KADO Masanori  <kdmsnr@gmail.com>
+
+	* bin/review-catalog-converter: add review-catalog-converter for
+	  converting old style catalog files into a new style catalog.yml file.
+
+Thu Jul 31 15:05:34 2014  Kenshi Muto  <kmuto@debian.org>
+
+	* lib/review/htmlbuilder.rb, lib/review/idgxmlbuilder.rb: 
+	  provides warning message if image couldn't be found.
+
+Sun Jun 29 22:12:58 2014  Masanori Kado <kdmsnr@gmail.com>
+
+	* Release 1.3.0.
+
 Sun Jun 29 10:40:02 2014  Kenshi Muto  <kmuto@debian.org>
 
 	* Now review-epubmaker-ng becomes review-epubmaker.

data/README.rdoc

@@ -3,6 +3,11 @@
 {<img src="https://secure.travis-ci.org/kmuto/review.png"/>}[http://travis-ci.org/kmuto/review]
 {<img src="https://badge.fury.io/rb/review.png" alt="Gem Version" />}[http://badge.fury.io/rb/review]
 
+home :: 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
+
 Re:VIEW is an easy-to-use digital publishing system for books and ebooks.
 
 == Format
@@ -31,6 +36,32 @@ And some useful commands.
 * 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
+
+== Resources
+=== Documents
+
+* Wiki pages: https://github.com/kmuto/review/wiki
+* doc/* files (in Japanese)
+
+=== Issues tracker
+
+* GitHub: https://github.com/kmuto/review
+
 == Note on Patches/Pull Requests
  
 * Fork the project.

data/bin/review-catalog-converter

@@ -0,0 +1,129 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+#
+# Copyright (c) 2014 Masanori Kado
+#
+# 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".
+#
+# Convert old PREDEF/CHAPS/PART/POSTDEF files into catalog.yml.
+
+require 'pathname'
+require 'optparse'
+bindir = Pathname.new(__FILE__).realpath.dirname
+$LOAD_PATH.unshift((bindir + '../lib').realpath)
+require 'review/version'
+require 'review/extentions'
+
+def main
+  opts = OptionParser.new
+  opts.version = ReVIEW::VERSION
+  opts.banner = "Usage: #{File.basename($0)} dirname"
+  opts.on('-h', '--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
+    exit 1
+  end
+
+  dir = Dir.pwd
+
+  # confirmation
+  if File.exist?("#{dir}/catalog.yml")
+    while true
+      print "The catalog.yml already exists. Do you want to overwrite it? [y/n]"
+      case gets
+      when /^[yY]/
+        puts "Start writing..."
+        break
+      when /^[nN]/, /^$/
+        puts "bye."
+        exit
+      end
+    end
+  end
+
+  File.open("#{dir}/catalog.yml", "w") do |catalog|
+    # predef
+    if File.exist?("#{dir}/PREDEF")
+      catalog << parse_predef(File.open("#{dir}/PREDEF").read)
+    end
+    # chaps and parts
+    if File.exist?("#{dir}/CHAPS")
+      if File.exist?("#{dir}/PART")
+        catalog << parse_parts(File.open("#{dir}/PART").read,
+                               File.open("#{dir}/CHAPS").read)
+      else
+        catalog << parse_chaps(File.open("#{dir}/CHAPS").read)
+      end
+    end
+    # postdef
+    if File.exist?("#{dir}/POSTDEF")
+      postdef = File.open("#{dir}/POSTDEF").read
+      while true
+        print "Do you want to convert POSTDEF into APPENDIX? [y/n]"
+        case gets
+        when /^[yY]/
+          catalog << parse_postdef(postdef, true)
+          break
+        when /^[nN]/, /^$/
+          catalog << parse_postdef(postdef)
+          break
+        end
+      end
+    end
+  end
+
+  puts File.open("#{dir}/catalog.yml").read
+end
+
+def _parse(str, header)
+  if str.present?
+    header + str.split("\n").map{|i| "  - #{i}\n" }.join
+  else
+    header
+  end
+end
+
+def parse_predef(str)
+  header = "PREDEF:\n"
+  _parse(str, header) + "\n"
+end
+
+def parse_chaps(str)
+  header = "CHAPS:\n"
+  _parse(str, header) + "\n"
+end
+
+def parse_postdef(str, to_appendix = false)
+  if to_appendix
+    header = "APPENDIX:\n"
+  else
+    header = "POSTDEF:\n"
+  end
+  _parse(str, header) + "\n"
+end
+
+def parse_parts(parts_str, chaps_str)
+  if parts_str.blank? or chaps_str.blank?
+    return "CHAPS:\n\n"
+  end
+
+  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"
+end
+
+if File.basename($0) == File.basename(__FILE__)
+  main()
+end

data/bin/review-check

@@ -37,6 +37,8 @@ def main
     "inencoding" => "UTF-8",
     "outencoding" => "UTF-8"
   })
+  @book = ReVIEW::Book::Base.load_default
+  @book.config = @config
 
   modes = nil
   files = ARGV unless ARGV.empty?
@@ -49,7 +51,7 @@ def main
     @config["outencoding"] = enc
   }
   opts.on('-a', '--all-chapters', 'Check all chapters.') {
-    files = ReVIEW.book.chapters.map {|ent| ent.path }
+    files = @book.chapters.map {|ent| ent.path }
   }
   opts.on('-s', '--section N', 'Check section N. (deprecated)') {|n|
     ents = ReVIEW.env.parts[Integer(n) - 1] or
@@ -87,7 +89,7 @@ def main
 end
 
 def check_text(files)
-  re, neg = words_re(ReVIEW.book.basedir + ReVIEW.book.reject_file)
+  re, neg = words_re("#{@book.basedir}/#{@book.reject_file}")
   files.each do |path|
     File.open(path) {|f|
       each_paragraph(f) do |para, lineno|

data/bin/review-compile

@@ -90,8 +90,6 @@ def _main
   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
     config["mathml"] = true
-    require 'math_ml'
-    require "math_ml/symbol/character_reference"
   end
   opts.on('--htmlversion=VERSION', 'HTML version.') do |v|
     v = v.to_i
@@ -146,7 +144,6 @@ def _main
   begin
     config["builder"] = target
 
-    ReVIEW.book.config = config
     compiler = ReVIEW::Compiler.new(load_strategy_class(target, check_only))
     case mode
     when :files
@@ -157,7 +154,7 @@ def _main
 
       begin
         ReVIEW::Book::Chapter.intern_pathes(ARGV).each do |chap|
-          chap.book.config = config
+          chap.book.config = config # needs only at the first time
           result = compiler.compile(chap)
           if output_filename
             write output_filename, result
@@ -167,8 +164,10 @@ def _main
         end
       rescue => e
         # PART
-        part = ReVIEW.book.parts_in_file.select do |part|
-          ARGV.map{|path| File.basename path}.include? part.path
+        book = ReVIEW::Book::Base.load_default
+        book.config = config
+        part = book.parts_in_file.select do |part_item|
+          ARGV.map{|path| File.basename path}.include? part_item.path
         end
         if part.present?
           result = compiler.compile(part.first)
@@ -182,7 +181,8 @@ def _main
         end
       end
     when :dir
-      book = basedir ? ReVIEW::Book.load(basedir) : ReVIEW.book
+      book = basedir ? ReVIEW::Book.load(basedir) : ReVIEW::Book::Base.load_default
+      book.config = config
       book.chapters.each do |chap|
         str = compiler.compile(chap)
         write "#{chap.name}#{compiler.strategy.extname}", str  unless check_only

data/bin/review-index

@@ -41,6 +41,7 @@ def _main
     "inencoding" => "UTF-8",
     "outencoding" => "UTF-8"
   }
+  book = ReVIEW::Book::Base.load_default
 
   opts = OptionParser.new
   opts.version = ReVIEW::VERSION
@@ -52,18 +53,18 @@ def _main
   }
   opts.on('-a', '--all', 'print all chapters.') {
     begin
-      source = ReVIEW.book
+      source = book
     rescue ReVIEW::Error => err
       error_exit err.message
     end
   }
   opts.on('-p', '--part N', 'list only part N.') {|n|
-    source = ReVIEW.book.part(Integer(n)) or
+    source = book.part(Integer(n)) or
         error_exit "part #{n} does not exist in this book"
   }
   opts.on('-c', '--chapter C', 'list only chapter C.') {|c|
     begin
-      source = ReVIEW::Book::Part.new(nil, 1, [ReVIEW.book.chapter(c)])
+      source = ReVIEW::Book::Part.new(nil, 1, [book.chapter(c)])
     rescue
       error_exit "chapter #{c} does not exist in this book"
     end

data/bin/review-init

@@ -71,7 +71,7 @@ end
 
 def generate_layout(dir)
   Dir.mkdir dir + '/layouts'
-  File.open("#{dir}/layouts/layout.erb", "w") do |file|
+  File.open("#{dir}/layouts/layout.html.erb", "w") do |file|
     file.write <<-EOS
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
@@ -99,6 +99,8 @@ PREDEF:
 CHAPS:
   - #{File.basename(dir)}.re
 
+APPENDIX:
+
 POSTDEF:
 
 EOS

data/bin/review-pdfmaker

@@ -9,266 +9,10 @@
 # For details of the GNU LGPL, see the file "COPYING".
 #
 
-require 'tmpdir'
-require 'yaml'
-require 'fileutils'
-require 'erb'
-require 'optparse'
-
 require 'pathname'
 bindir = Pathname.new(__FILE__).realpath.dirname
 $LOAD_PATH.unshift((bindir + '../lib').realpath)
 
-require 'review'
-require 'review/i18n'
-
-include ReVIEW::LaTeXUtils
-
-include FileUtils
-
-def error(msg)
-  $stderr.puts "#{File.basename($0, '.*')}: error: #{msg}"
-  exit 1
-end
-
-def warn(msg)
-  $stderr.puts "#{File.basename($0, '.*')}: warning: #{msg}"
-end
-
-def check_book(config)
-  pdf_file = config["bookname"]+".pdf"
-  if File.exist? pdf_file
-    error "file already exists:#{pdf_file}"
-  end
-end
-
-def build_path(config)
-  "./#{config["bookname"]}-pdf"
-end
-
-def check_compile_status(ignore_errors)
-  return unless @compile_errors
-
-  if ignore_errors
-    $stderr.puts "compile error, but try to generate PDF file"
-  else
-    error "compile error, No PDF file output."
-  end
-end
-
-
-def main
-  config = ReVIEW::Configure.values
-  cmd_config = Hash.new
-
-  opts = OptionParser.new
-  opts.banner = "Usage: #{File.basename($0)} configfile"
-  opts.version = ReVIEW::VERSION
-  opts.on('--help', 'Prints this message and quit.') do
-    puts opts.help
-    exit 0
-  end
-  opts.on('--[no-]debug', 'Keep temporary files.') do |debug|
-    cmd_config["debug"] = debug
-  end
-  opts.on('--ignore-errors', 'Ignore review-compile errors.') do
-    cmd_config["ignore-errors"] = true
-  end
-
-  opts.parse!(ARGV)
-  if ARGV.size != 1
-    puts opts.help
-    exit 0
-  end
-  yamlfile = ARGV[0]
-  config.merge!(YAML.load_file(yamlfile))
-  # YAML configs will be overridden by command line options.
-  config.merge!(cmd_config)
-
-  check_book(config)
-  @basedir = Dir.pwd
-  @path = build_path(config)
-  bookname = config["bookname"]
-  Dir.mkdir(@path)
-
-  @chaps_fnames = Hash.new{|h, key| h[key] = ""}
-  @compile_errors = nil
-
-  ReVIEW::Book.load(@basedir).parts.each do |part|
-    if part.name.present?
-      if part.file?
-        output_parts(part.name, config)
-        @chaps_fnames["CHAPS"] << %Q|\\input{#{part.name}.tex}\n|
-      else
-        @chaps_fnames["CHAPS"] << %Q|\\part{#{part.name}}\n|
-      end
-    end
-
-    part.chapters.each do |chap|
-      filename = "#{File.basename(chap.path, ".*")}.tex"
-      output_chaps(filename, config)
-      @chaps_fnames["PREDEF"]  << "\\input{#{filename}}\n" if chap.on_PREDEF?
-      @chaps_fnames["CHAPS"]   << "\\input{#{filename}}\n" if chap.on_CHAPS?
-      @chaps_fnames["POSTDEF"] << "\\input{#{filename}}\n" if chap.on_POSTDEF?
-    end
-  end
-
-  check_compile_status(config["ignore-errors"])
-
-  config["pre_str"]  = @chaps_fnames["PREDEF"]
-  config["chap_str"] = @chaps_fnames["CHAPS"]
-  config["post_str"] = @chaps_fnames["POSTDEF"]
-
-  config["usepackage"] = ""
-  if config["texstyle"]
-    config["usepackage"] = "\\usepackage{#{config['texstyle']}}"
-  end
-
-  %w[aut csl trl dsr ill cov edt].each do |item|
-    config[item] = [config[item]] if !config[item].nil? && config[item].instance_of?(String)
-  end
-
-  copy_images("./images", "#{@path}/images")
-  copyStyToDir(Dir.pwd + "/sty", @path)
-  copyStyToDir(Dir.pwd, @path, "tex")
-
-  Dir.chdir(@path) {
-    template = get_template(config)
-    File.open("./book.tex", "wb"){|f| f.write(template)}
-
-    ## do compile
-    enc = config["params"].to_s.split(/\s+/).find{|i| i =~ /\A--outencoding=/ }
-    kanji = 'utf8'
-    if enc
-      kanji = enc.split(/\=/).last.gsub(/-/, '').downcase
-    end
-    texcommand = config["texcommand"] || "platex"
-    3.times do
-      system("#{texcommand} -kanji=#{kanji} book.tex")
-    end
-    if File.exist?("book.dvi")
-      system("dvipdfmx -d 5 book.dvi")
-    end
-  }
-  FileUtils.cp("#{@path}/book.pdf", "#{@basedir}/#{bookname}.pdf")
-
-  unless config["debug"]
-    remove_entry_secure @path
-  end
-end
-
-def output_chaps(filename, config)
-  $stderr.puts "compiling #{filename}"
-  cmd = "#{ReVIEW::MakerHelper.bindir}/review-compile --target=latex --level=#{config["secnolevel"]} --toclevel=#{config["toclevel"]} #{config["params"]} #{filename} > #{@path}/#{filename}"
-  if system cmd
-    # OK
-  else
-    @compile_errors = true
-    warn cmd
-  end
-end
-
-def output_parts(filename, config)
-  $stderr.puts "compiling #{filename}.tex"
-  cmd = "review-compile --target=latex --level=#{config["secnolevel"]} --toclevel=#{config["toclevel"]} #{config["params"]} #{filename}.re | sed -e s/\\chapter{/\\part{/ > #{@path}/#{filename}.tex"
-  if system cmd
-    # OK
-  else
-    @compile_errors = true
-    warn cmd
-  end
-end
-
-
-def copy_images(from, to)
-  if File.exist?(from)
-    Dir.mkdir(to)
-    ReVIEW::MakerHelper.copy_images_to_dir(from, to)
-    Dir.chdir(to) do
-      images = Dir.glob("**/*").find_all{|f|
-        File.file?(f) and f =~ /\.(jpg|jpeg|png|pdf)\z/
-      }
-      system("extractbb", *images)
-      unless system("extractbb", "-m", *images)
-        system("ebb", *images)
-      end
-    end
-  end
-end
-
-def make_custom_titlepage(coverfile)
-  coverfile_sty = coverfile.to_s.sub(/\.[^.]+$/, ".tex")
-  if File.exist?(coverfile_sty)
-    File.read(coverfile_sty)
-  else
-    nil
-  end
-end
-
-def get_template(config)
-  dclass = config["texdocumentclass"] || []
-  documentclass =  dclass[0] || "jsbook"
-  documentclassoption =  dclass[1] || "oneside"
-
-  okuduke = ""
-  authors = ""
-  if !config["aut"].nil? && !config["aut"].empty?
-    okuduke += "著　者 & #{escape_latex(config["aut"].join(ReVIEW::I18n.t("names_splitter")))} \\\\\n"
-    authors = config["aut"].join(ReVIEW::I18n.t("names_splitter")) + ReVIEW::I18n.t("author_postfix")
-  end
-  if !config["csl"].nil? && !config["csl"].empty?
-    okuduke += "監　修 & #{escape_latex(config["csl"].join(ReVIEW::I18n.t("names_splitter")))} \\\\\n"
-    authors += " \\\\\n"+config["csl"].join(ReVIEW::I18n.t("names_splitter")) + ReVIEW::I18n.t("supervisor_postfix")
-  end
-  if !config["trl"].nil? && !config["trl"].empty?
-    okuduke += "翻　訳 & #{escape_latex(config["trl"].join(ReVIEW::I18n.t("names_splitter")))} \\\\\n"
-    authors += " \\\\\n"+config["trl"].join(ReVIEW::I18n.t("names_splitter")) + ReVIEW::I18n.t("translator_postfix")
-  end
-  if !config["dsr"].nil? && !config["dsr"].empty?
-    okuduke += "デザイン & #{escape_latex(config["dsr"].join(ReVIEW::I18n.t("names_splitter")))} \\\\\n"
-  end
-  if !config["ill"].nil? && !config["ill"].empty?
-    okuduke += "イラスト & #{escape_latex(config["ill"].join(ReVIEW::I18n.t("names_splitter")))} \\\\\n"
-  end
-  if !config["cov"].nil? && !config["cov"].empty?
-    okuduke += "表　紙 & #{escape_latex(config["cov"].join(ReVIEW::I18n.t("names_splitter")))} \\\\\n"
-  end
-  if !config["edt"].nil? && !config["edt"].empty?
-    okuduke += "編集者 & #{escape_latex(config["edt"].join(ReVIEW::I18n.t("names_splitter")))} \\\\\n"
-  end
-  okuduke += <<EOB
-発行所 & #{config["prt"]} \\\\
-EOB
-
-  custom_titlepage = make_custom_titlepage(config["coverfile"])
-
-  template = File.expand_path(File.dirname(__FILE__) +
-                              '/../lib/review/review.tex.erb')
-  layout_file = File.join(@basedir, "layouts", "layout.tex.erb")
-  if File.exist?(layout_file)
-    template = layout_file
-  end
-
-  erb = ERB.new(File.open(template).read)
-  values = config # must be 'values' for legacy files
-  erb.result(binding)
-end
-
-def copyStyToDir(dirname, copybase, extname = "sty")
-  unless File.directory?(dirname)
-    $stderr.puts "No such directory - #{dirname}"
-    return
-  end
-
-  Dir.open(dirname) {|dir|
-    dir.each {|fname|
-      next if fname =~ /^\./
-      if fname =~ /\.(#{extname})$/i
-        Dir.mkdir(copybase) unless File.exist?(copybase)
-        FileUtils.cp "#{dirname}/#{fname}", copybase
-      end
-    }
-  }
-end
+require 'review/pdfmaker'
 
-main
+ReVIEW::PDFMaker.execute(*ARGV)