review 1.4.0 → 1.5.0

data/lib/review/version.rb

@@ -1,3 +1,3 @@
 module ReVIEW
-  VERSION = "1.4.0"
+  VERSION = "1.5.0"
 end

data/review.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |gem|
   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 = "2014-10-29"
+  gem.date = "2015-02-28"
 
   gem.files         = `git ls-files`.split("\n")
   gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
@@ -25,5 +25,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
   gem.add_development_dependency("rake")
+  gem.add_development_dependency("test-unit")
+  gem.add_development_dependency("pygments.rb")
 end
 

data/test/book_test_helper.rb

@@ -16,7 +16,7 @@ module BookTestHelper
         File.open(path, 'w') {|o| o.print content }
         created_files[basename] = path
       end
-      book = Book::Base.new(dir)
+      book = Book::Base.load(dir)
       yield(dir, book, created_files)
     end
   end

data/test/sample-book/README.md

@@ -3,3 +3,5 @@
 Re:VIEW ( http://github.com/kmuto/review )で書籍データを作るためのサンプルファイルです。
 
 必要なファイルはsrc/ディレクトリ内にあります。srcディレクトリで「review-epubmaker config.yml」と実行すればEPUBが、「review-pdfmaker config.yml」とすればPDFが生成されます(PDFの生成にはpLaTeXとdvipdfmxが必要です)。
+
+Ruby製のビルドツールであるrakeがインストールされている環境の場合、「rake pdf」を実行すればPDFが、「rake epub」を実行すればEPUBが生成されます。また、「rake html_all」を実行すればHTMLが生成されます。

data/test/sample-book/src/Rakefile

@@ -1,4 +1,10 @@
 require 'fileutils'
+require 'rake/clean'
+
+BOOK = "book"
+BOOK_PDF = BOOK+".pdf"
+BOOK_EPUB = BOOK+".epub"
+CONFIG_FILE = "config.yml"
 
 def build(mode, chapter)
   sh "review-compile --target=#{mode} --footnotetext --stylesheet=style.css #{chapter} > tmp"
@@ -11,6 +17,8 @@ def build_all(mode)
   sh "review-compile --all --target=#{mode} --footnotetext --stylesheet=style.css"
 end
 
+task :default => :html_all
+
 desc "build html (Usage: rake build re=target.re)"
 task :html do
   if ENV['re'].nil?
@@ -24,3 +32,26 @@ desc "build all html"
 task :html_all do
   build_all("html")
 end
+
+desc 'generate PDF and EPUB file'
+task :all => [:pdf, :epub]
+
+desc 'generate PDF file'
+task :pdf => BOOK_PDF
+
+desc 'generate EPUB file'
+task :epub => BOOK_EPUB
+
+SRC = FileList['*.re'] + [CONFIG_FILE]
+
+file BOOK_PDF => SRC do
+  FileUtils.rm_rf [BOOK_PDF, BOOK, BOOK+"-pdf"]
+  sh "review-pdfmaker #{CONFIG_FILE}"
+end
+
+file BOOK_EPUB => SRC do
+  FileUtils.rm_rf [BOOK_EPUB, BOOK, BOOK+"-epub"]
+  sh "review-epubmaker #{CONFIG_FILE}"
+end
+
+CLEAN.include([BOOK, BOOK_PDF, BOOK_EPUB, BOOK+"-pdf", BOOK+"-epub"])

data/test/sample-book/src/catalog.yml

@@ -0,0 +1,10 @@
+PREDEF:
+  - preface.re
+
+CHAPS:
+  - ch01.re
+  - ch02.re
+
+APPENDIX:
+
+POSTDEF:

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

@@ -6,50 +6,178 @@
 
 # ブック名(ファイル名になるもの。ASCII範囲の文字を使用)
 bookname: book
+# 記述言語。省略した場合はja
+language: ja
 # 書名
 booktitle: Re:VIEWサンプル書籍
-# 著者
+# 固有IDに使用するドメイン。省略した場合は時刻に基づくランダムUUIDが入る
+urnid: urn:uid:http://tatsu-zine.com/books/review-sample-book/1.0.0/
+# ISBN。省略した場合はurnidが入る
+# isbn: null
+# 著者名。["高橋征義", "John Doe"] のように配列を使うことで複数指定可
 aut: 高橋征義
+# 出版社。配列書式で複数指定可能
 prt: 達人出版会
-prt_url:  http://github.com/takahashim/review-sample-book/
+# 編集者。配列書式で複数指定可能
 edt: 高橋征義
+# 刊行日。YYYY-MM-DD形式。省略した場合は本日の日付
 date: 2011-08-03
-rights: |
-  (C) 2011 Masayoshi Takahashi
-description: 
-# 以下はオプション
-# prt: 出版社
-# asn: Associated name
-# ant: Bibliographic antecedent
-# clb: 貢献者
-# edt: 編集者
+# 発行年月。YYYY-MM-DD形式による配列指定。省略した場合はdateを使用する
+# 複数指定する場合は次のように記述する
+# [["初版第第1刷の日付", "初版第第2刷の日付"], ["第2版第1刷の日付"]]
+# 日付の後ろを空白文字で区切り、任意の文字列を置くことも可能。
+history: [["2011-08-03 v1.0.0版発行"]]
+# 権利表記
+rights: (C) 2011 Masayoshi Takahashi
+
+# 以下はオプション(autと同じように配列書式で複数指定可能)。
+# adp: 異なるメディア向けに作り直した者
+# ann: 注釈記述者
+# arr: アレンジした者
+# art: グラフィックデザインおよび芸術家
+# asn: 関連・かつての所有者・関係者
+# aqt: 大きく引用された人物
+# aft: 後書き・奥付の責任者
+# aui: 序論・序文・前書きの責任者
+# ant: 目録責任者
+# bkp: メディア制作責任者
+# clb: 限定参加または補足者
+# cmm: 解釈・分析・考察者
 # dsr: デザイナ
+# edt: 編集者
 # ill: イラストレータ
-# pht: 撮影者
+# lyr: 歌詞作成者
+# mdc: メタデータセットの一次的責任者
+# mus: 音楽家
+# nrt: 語り手
+# oth: その他
+# pht: 撮影責任者
+# red: 項目の枠組起草者
+# rev: 評論者
+# spn: 援助者
+# ths: 監督者
+# trc: 筆記・タイプ作業者
 # trl: 翻訳者
-# date: 刊行日
-# rights: 権利表記
 # description: ブックの説明
-#
-# coverfile: カバーページのbody要素内に挿入する内容を記述したファイル名
-coverfile: _cover.html
-# coverimage: 表紙用画像ファイル
-coverimage: cover.jpg
-# 固有IDに使用するドメイン
-urnid: http://tatsu-zine.com/books/review-sample-book/1.0.0/
-# CSSファイル (yamlファイルおよびRe:VIEWファイルを置いたディレクトリにあること
-stylesheet: style.css
-# 目次として抽出するレベル
+# subject: 短い説明用タグ
+# type: 書籍のカテゴリーなど
+# format: メディアタイプおよび特徴
+# source: 出版物生成の重要なリソース情報
+# relation: 補助的リソース
+# coverage: 内容の範囲や領域
+
+# htmlext: HTMLファイルの拡張子(省略した場合はhtml)
+# CSSファイル(配列で複数指定可、yamlファイルおよびRe:VIEWファイルを置いたディレクトリにあること)
+stylesheet: ["style.css"]
+
+# ePUBのバージョン (2か3) 省略した場合は2
+epubversion: 3
+# HTMLのバージョン (4か5。epubversionを3にしたときには5にする)
+# htmlversion: 5
+
+# 目次として抽出する見出しレベル。省略した場合は2
 toclevel: 2
-# セクション番号を表示するレベル
+# 本文でセクション番号を表示する見出しレベル。省略した場合は2
+# 採番させたくない見出しには「==[nonum]」のようにnonum指定をする
 secnolevel: 3
-# review-compileに渡すパラメータ
-params: --stylesheet=style.css
-# 目次生成用？
-mytoc: true
-# 奥付生成用
+# EPUB2標準の目次以外に物理目次ファイルを作成するか。省略した場合はnull (作成しない)
+# ePUB3においてはこの設定によらず必ず作成される
+# mytoc: true
+
+# 付録の連番のスタイル。null(アラビア数字1〜。デフォルト)、alpha(英字A〜)、roman(ローマ数字I〜)
+# appendix_format: null
+
+# 表紙にするHTMLファイル。ファイル名を指定すると表紙として入る
+# cover: _cover.html
+# 表紙に配置し、書籍の影絵にも利用する画像ファイル。省略した場合はnull (画像を使わない)
+coverimage: cover.jpg
+# 表紙の後に大扉ページを作成するか。省略した場合はnull (作成しない)
+# titlepage: null
+# 自動生成される大扉ページを上書きするファイル。ファイル名を指定すると大扉として入る
+# titlefile: null
+# 原書大扉ページにするHTMLファイル。ファイル名を指定すると原書大扉として入る
+# originaltitlefile: null
+# 権利表記ページファイル。ファイル名を指定すると権利表記として入る
+# creditfile: null
+# プロフィールページファイル。ファイル名を指定すると著者紹介として入る
+# profile: null
+# プロフィールページの目次上の見出し
+# profiletitle: 著者紹介
+# 広告ファイル。ファイル名を指定すると広告として入る
+# advfile: null
+# 奥付を作成するか。デフォルトでは作成されない。trueを指定するとデフォルトの奥付、ファイル名を指定するとそれがcolophon.htmlとしてコピーされる
 colophon: true
+# 裏表紙ファイル (画像はcoversまたはimagesに配置する)。ファイル名を指定すると裏表紙として入る
+# backcover: null
+
+# 以下のパラメータを有効にするときには、
+# epubmaker:
+#    パラメータ: 値
+#    パラメータ: 値
+#   ...
+# という構成にする必要がある(インデントさせる)
+
+# epubmaker:
+# 目次を要素の階層表現にしない。省略した場合(null)は階層化する。
+# 特に部扉が入るなどの理由で、構成によっては階層化目次でepubcheckに
+# パスしない目次ができるが、そのようなときにはこれをtrueにする
+#  flattoc: null
+# 目次のインデントレベルをスペース文字で表現する(flattocがtrueのときのみ)
+#  flattocindent: true
+# NCX目次の見出しレベルごとの飾り(配列で設定)。EPUB3ではNCXは作られない
+#  ncxindent:
+#- 
+#- - 
+# フックは、各段階で介入したいときのプログラムを指定する。自動で適切な引数が渡される
+# プログラムには実行権限が必要
+# ファイル変換処理の前に実行するプログラム。スタイルシートのコンパイルをしたいときなどに利用する。
+# 渡される引数1=作業用展開ディレクトリ
+#  hook_beforeprocess: null
+# 前付の作成後に実行するプログラム。作業用展開ディレクトリにある目次ファイル(toc-html.txt)を操作したいときなどに利用する。
+# 渡される引数1=作業用展開ディレクトリ
+#  hook_afterfrontmatter: null
+# 本文の変換後に実行するプログラム。作業用展開ディレクトリにある目次ファイル(toc-html.txt)を操作したいときなどに利用する。
+# 渡される引数1=作業用展開ディレクトリ
+#  hook_afterbody: null
+# 後付の作成後に実行するプログラム。作業用展開ディレクトリにある目次ファイル(toc-html.txt)を操作したいときなどに利用する。
+# 渡される引数1=作業用展開ディレクトリ
+#  hook_afterbackmatter: null
+# 画像およびフォントをコピーした後に実行するプログラム。別の画像やフォントを追加したいときなどに利用する。
+# 渡される引数1=作業用展開ディレクトリ
+#  hook_aftercopyimage: null
+# ePUB zipアーカイブ直前に実行するプログラム。メタ情報などを加工したいときなどに利用する。
+# 渡される引数1=ePUB準備ディレクトリ
+#  hook_prepack: null
+# 変換したHTMLファイルおよびCSSを解析して厳密に使用している画像ファイルだけを取り込むか。デフォルトはnull(imagesディレクトリすべてを取り込む)
+# なお、フォント、カバー、広告についてはこの設定によらずディレクトリ内のものがすべて取り込まれる
+#  verify_target_images: null
+#  verify_target_imagesがtrueの状態において、解析で発見されなくても強制的に取り込むファイルの相対パスの配列
+#  force_include_images: []
+# Re:VIEWファイル名を使わず、前付にpre01,pre02...、本文にchap01,chap02l...、後付にpost01,post02...という名前付けルールにするか
+#  rename_for_legacy: null
+# ePUBアーカイブの非圧縮実行
+#  zip_stage1: "zip -0Xq"
+# ePUBアーカイブの圧縮実行
+#  zip_stage2: "zip -Xr9Dq"
+# ePUBアーカイブに追加するパス(デフォルトはmimetype、META-INF、OEBPS)
+#  zip_addpath: null
+#
+# epubmaker:階層を使うものはここまで
+
+# ハイライトを有効にするか。pygments.gemが必要
+# pygments: null
+
+# 取り込む画像が格納されているディレクトリ。省略した場合は以下
+# imagedir: images
+
+# 取り込むフォントが格納されているディレクトリ。省略した場合は以下
+# fontdir: fonts
+
+# imagedir内から取り込まれる対象となるファイル拡張子。省略した場合は以下
+# image_ext: ["png", "gif", "jpg", "jpeg", "svg", "ttf", "woff", "otf"]
+
+# fontdir内から取り込まれる対象となるファイル拡張子。省略した場合は以下
+# font_ext: ["ttf", "woff", "otf"]
+
 texstyle: reviewmacro
-pubhistory: |
-  2011年08月03日 v1.0.0版発行
 debug: true

data/test/sample-book/src/sty/reviewmacro.sty

@@ -18,4 +18,22 @@
 %% using Helvetica as sans-serif
 \renewcommand{\sfdefault}{phv}
 
+%% for listings
+%\renewcommand{\lstlistingname}{List}
+%\lstset{%
+%  breaklines=true,%
+%  breakautoindent=false,%
+%  breakindent=0pt,%
+%  fontadjust=true,%
+%  backgroundcolor=\color{shadecolor},%
+%  frame=single,%
+%  framerule=0pt,%
+%  basicstyle=\ttfamily\scriptsize,%
+%  commentstyle=\color{reviewgreen},%
+%  identifierstyle=\color{reviewblue},%
+%  stringstyle=\color{reviewred},%
+%  keywordstyle=\bfseries\color{reviewdarkred},%
+%}
+
+
 \sloppy

data/test/test_book.rb

@@ -11,29 +11,6 @@ class BookTest < Test::Unit::TestCase
     assert_equal ex_path, re_path, *options
   end
 
-  def test_s_load_default
-    Dir.mktmpdir do |dir|
-      File.open(File.join(dir, 'CHAPS'), 'w') {}
-      Dir.chdir(dir) do
-        assert_same_path dir, File.expand_path(Book.load_default.basedir), "error in dir CHAPS"
-      end
-    end
-
-    # tests for ReVIEW.book
-    default_book = nil
-    Dir.mktmpdir do |dir|
-      Dir.chdir(dir) do
-        default_book = ReVIEW.book
-        assert default_book
-      end
-    end
-    Dir.mktmpdir do |dir|
-      Dir.chdir(dir) do
-        assert_equal default_book, ReVIEW.book, "chdir mktmpdir"
-      end
-    end
-  end
-
   def test_s_update_rubyenv
     save_load_path = $LOAD_PATH.dup
 
@@ -318,10 +295,6 @@ EOC
       assert_equal nil, book.prefaces # XXX: OK?
     end
 
-    mktmpbookdir 'PREDEF' => '' do |dir, book, files|
-      assert_equal nil, book.prefaces
-    end
-
     mktmpbookdir 'PREDEF' => 'chapter1',
                  'chapter1.re' => '' do |dir, book, files|
       assert_kind_of Book::Part, book.prefaces
@@ -555,4 +528,29 @@ EOC
       assert_equal dir, book.basedir
     end
   end
+
+  def test_page_metric
+    Dir.mktmpdir do |dir|
+      book = Book::Base.new(dir)
+      assert_equal ReVIEW::Book::PageMetric::A5, book.page_metric
+    end
+  end
+
+  def test_page_metric_config
+    mktmpbookdir('config.yml'=>"bookname: book\npage_metric: B5\n") do |dir, book, files|
+      book = Book::Base.new(dir)
+      config_file = File.join(dir,"config.yml")
+      book.load_config(config_file)
+      assert_equal ReVIEW::Book::PageMetric::B5, book.page_metric
+    end
+  end
+
+  def test_page_metric_config_array
+    mktmpbookdir('config.yml'=>"bookname: book\npage_metric: [46, 80, 30, 74, 2]\n") do |dir, book, files|
+      book = Book::Base.new(dir)
+      config_file = File.join(dir,"config.yml")
+      book.load_config(config_file)
+      assert_equal ReVIEW::Book::PageMetric::B5, book.page_metric
+    end
+  end
 end

data/test/test_book_chapter.rb

@@ -24,79 +24,8 @@ class ChapterTest < Test::Unit::TestCase
 =end
   end
 
-  def test_s_intern_pathes
-    dir1_files = {
-      'CHAPS' => "ch1.re\nch2.re\n",
-      'ch1.re' => 'ch1',
-      'ch2.re' => 'ch2',
-    }
-    dir2_files = {
-      'CHAPS' => "ch1.re\n",
-      'ch1.re' => 'ch1',
-    }
-    mktmpbookdir dir1_files do |dir1, book1, files1|
-      mktmpbookdir dir2_files do |dir2, book2, files2|
-        paths = (files1.values + files2.values).flatten.grep(/\.re\z/)
-        chs = Book::Chapter.intern_pathes(paths)
-
-        assert_equal 3, chs.size
-        assert chs[0].book == chs[1].book
-        assert chs[0].book != chs[2].book
-        assert dir1, chs[0].book.basedir
-        assert dir2, chs[2].book.basedir
-      end
-    end
-
-    dir_files = {
-      'CHAPS' => "ch1.re\n",
-      'ch1.re' => 'ch1',
-    }
-    mktmpbookdir dir_files do |dir, book, files|
-      paths = files.values.grep(/\.re\z/)
-      paths << __FILE__ + ' not exist file.re'
-      assert_raises ReVIEW::FileNotFound do
-        Book::Chapter.intern_pathes(paths)
-      end
-    end
-
-    dir_files = {
-      'ch1.re' => 'ch1 not in CHAPS',
-      'ch2.re' => 'ch2 not in CHAPS',
-    }
-    mktmpbookdir dir_files do |dir, book, files|
-      paths = files.values.grep(/\.re\z/)
-      assert_nothing_raised do
-        Book::Chapter.intern_pathes(paths)
-      end
-    end
-
-    dir_files = {
-      'CHAPS' => "ch1.re\n",
-      'ch1.re' => 'ch1',
-      'ch2.re' => 'ch2 not in CHAPS',
-    }
-    mktmpbookdir dir_files do |dir, book, files|
-      paths = files.values.grep(/\.re\z/)
-      assert_raises KeyError::FileNotFound do
-        Book::Chapter.intern_pathes(paths)
-      end
-    end
-
-    dir_files = {
-      'CHAPS' => "ch1.re\n",
-      'ch1.re' => 'ch1'
-    }
-    mktmpbookdir dir_files do |dir, book, files|
-      paths = files.values.grep(/\.re\z/)
-      assert_nothing_raised do
-        Book::Chapter.intern_pathes(paths)
-      end
-    end
-  end
-
   def test_initialize
     ch = Book::Chapter.new(:book, :number, :name, '/foo/bar', :io)
-    assert_equal :book, ch.env
     assert_equal :book, ch.book
     assert_equal :number, ch.number
     assert_equal '/foo/bar', ch.path
@@ -248,11 +177,13 @@ class ChapterTest < Test::Unit::TestCase
     tf2.print content
     tf2.close
 
-    ch = Book::Chapter.new(nil, nil, nil, tf1.path)
+    book = Book::Base.new(nil)
+    ch = Book::Chapter.new(book, nil, nil, tf1.path)
     assert ch.volume
     assert_equal content.gsub(/\s/, '').size, ch.volume.bytes
 
-    ch = Book::Chapter.new(nil, nil, nil, tf1.path, tf2)
+    book = Book::Base.new(nil)
+    ch = Book::Chapter.new(book, nil, nil, tf1.path, tf2)
     assert ch.volume
     assert_equal content.gsub(/\s/, '').size, ch.volume.bytes # XXX: OK?
   end