review 2.0.0.beta1 → 2.0.0

data/lib/review/unfold.rb

@@ -47,7 +47,7 @@ module ReVIEW
 
     private
 
-    ZSPACE = "\241\241"  # EUC-JP zen-kaku space
+    ZSPACE = "\241\241" # EUC-JP zen-kaku space
 
     def do_unfold(input)
       @blank_needed = false
@@ -135,4 +135,4 @@ module ReVIEW
 
   end
 
-end   # module ReVIEW
+end # module ReVIEW

data/lib/review/version.rb

@@ -1,3 +1,3 @@
 module ReVIEW
-  VERSION = "2.0.0.beta1"
+  VERSION = "2.0.0"
 end

data/lib/review/webmaker.rb

@@ -0,0 +1,302 @@
+# encoding: utf-8
+#
+# 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".
+#
+require 'optparse'
+require 'yaml'
+require 'fileutils'
+require 'erb'
+
+require 'review/i18n'
+require 'review/converter'
+require 'review/configure'
+require 'review/book'
+require 'review/htmlbuilder'
+require 'review/template'
+require 'review/tocprinter'
+require 'review/version'
+require 'erb'
+
+module ReVIEW
+  class WEBMaker
+    include ERB::Util
+
+    attr_accessor :config, :basedir
+
+    def initialize
+      @basedir = nil
+    end
+
+    def self.execute(*args)
+      self.new.execute(*args)
+    end
+
+    def parse_opts(args)
+      cmd_config = Hash.new
+      opts = OptionParser.new
+
+      opts.banner = "Usage: review-webmaker configfile"
+      opts.version = ReVIEW::VERSION
+      opts.on('--help', 'Prints this message and quit.') do
+        puts opts.help
+        exit 0
+      end
+      opts.on('--ignore-errors', 'Ignore review-compile errors.') do
+        cmd_config["ignore-errors"] = true
+      end
+
+      opts.parse!(args)
+      if args.size != 1
+        puts opts.help
+        exit 0
+      end
+
+      return cmd_config, args[0]
+    end
+
+    def build_path
+      @config["docroot"] || "webroot"
+    end
+
+    def remove_old_files(path)
+      FileUtils.rm_rf(path)
+    end
+
+
+    def execute(*args)
+      @config = ReVIEW::Configure.values
+      @config.maker = "webmaker"
+      cmd_config, yamlfile = parse_opts(args)
+
+      @config.merge!(YAML.load_file(yamlfile))
+      # YAML configs will be overridden by command line options.
+      @config.merge!(cmd_config)
+      @config["htmlext"] = "html"
+      I18n.setup(@config["language"])
+      generate_html_files(yamlfile)
+    end
+
+    def generate_html_files(yamlfile)
+      @basedir = File.dirname(yamlfile)
+      @path = build_path()
+      remove_old_files(@path)
+      Dir.mkdir(@path)
+
+      @book = ReVIEW::Book.load(@basedir)
+      @book.config = @config
+
+      copy_stylesheet(@path)
+      copy_frontmatter(@path)
+      build_body(@path, yamlfile)
+      copy_backmatter(@path)
+
+      copy_images(@config["imagedir"], "#{@path}/images")
+
+      copy_resources("covers", "#{@path}/images")
+      copy_resources("adv", "#{@path}/images")
+      copy_resources(@config["fontdir"], "#{@path}/fonts", @config["font_ext"])
+    end
+
+    def build_body(basetmpdir, yamlfile)
+      base_path = Pathname.new(@basedir)
+      builder = ReVIEW::HTMLBuilder.new
+      @converter = ReVIEW::Converter.new(@book, builder)
+      @book.parts.each do |part|
+        htmlfile = nil
+        if part.name.present?
+          if part.file?
+            build_chap(part, base_path, basetmpdir, true)
+          else
+            htmlfile = "part_#{part.number}.#{@config["htmlext"]}"
+            build_part(part, basetmpdir, htmlfile)
+            title = ReVIEW::I18n.t("part", part.number)
+            title += ReVIEW::I18n.t("chapter_postfix") + part.name.strip if part.name.strip.present?
+          end
+        end
+
+        part.chapters.each do |chap|
+          build_chap(chap, base_path, basetmpdir, false)
+        end
+
+      end
+    end
+
+    def build_part(part, basetmpdir, htmlfile)
+      File.open("#{basetmpdir}/#{htmlfile}", "w") do |f|
+        @body = ""
+        @body << "<div class=\"part\">\n"
+        @body << "<h1 class=\"part-number\">#{ReVIEW::I18n.t("part", part.number)}</h1>\n"
+        if part.name.strip.present?
+          @body << "<h2 class=\"part-title\">#{part.name.strip}</h2>\n"
+        end
+        @body << "</div>\n"
+
+        @language = @config['language']
+        @stylesheets = @config["stylesheet"]
+        tmplfile = File.expand_path(template_name, ReVIEW::Template::TEMPLATE_DIR)
+        tmpl = ReVIEW::Template.load(tmplfile)
+        f.write tmpl.result(binding)
+      end
+    end
+
+    def template_name
+      if @config["htmlversion"].to_i == 5
+        'web/html/layout-html5.html.erb'
+      else
+        'web/html/layout-xhtml1.html.erb'
+      end
+    end
+
+    def build_chap(chap, base_path, basetmpdir, ispart)
+      filename = ""
+
+      if ispart.present?
+        filename = chap.path
+      else
+        filename = Pathname.new(chap.path).relative_path_from(base_path).to_s
+      end
+      id = filename.sub(/\.re\Z/, "")
+
+      htmlfile = "#{id}.#{@config["htmlext"]}"
+
+      if @config["params"].present?
+        warn "'params:' in config.yml is obsoleted."
+      end
+
+      begin
+        @converter.convert(filename, File.join(basetmpdir, htmlfile))
+      rescue => e
+        warn "compile error in #{filename} (#{e.class})"
+        warn e.message
+      end
+    end
+
+    def copy_images(resdir, destdir)
+      return nil unless File.exist?(resdir)
+      allow_exts = @config["image_ext"]
+      FileUtils.mkdir_p(destdir)
+      recursive_copy_files(resdir, destdir, allow_exts)
+    end
+
+    def copy_resources(resdir, destdir, allow_exts=nil)
+      if !resdir || !File.exist?(resdir)
+        return nil
+      end
+      allow_exts = @config["image_ext"] if allow_exts.nil?
+      FileUtils.mkdir_p(destdir)
+      recursive_copy_files(resdir, destdir, allow_exts)
+    end
+
+    def recursive_copy_files(resdir, destdir, allow_exts)
+      Dir.open(resdir) do |dir|
+        dir.each do |fname|
+          next if fname.start_with?('.')
+          if FileTest.directory?("#{resdir}/#{fname}")
+            recursive_copy_files("#{resdir}/#{fname}", "#{destdir}/#{fname}", allow_exts)
+          else
+            if fname =~ /\.(#{allow_exts.join("|")})\Z/i
+              FileUtils.mkdir_p(destdir)
+              FileUtils.cp("#{resdir}/#{fname}", destdir)
+            end
+          end
+        end
+      end
+    end
+
+    def copy_stylesheet(basetmpdir)
+      if @config["stylesheet"].size > 0
+        @config["stylesheet"].each do |sfile|
+          FileUtils.cp(sfile, basetmpdir)
+        end
+      end
+    end
+
+    def copy_frontmatter(basetmpdir)
+      build_indexpage(basetmpdir)
+
+      if @config["titlepage"]
+        if @config["titlefile"]
+          FileUtils.cp(@config["titlefile"], "#{basetmpdir}/titlepage.#{@config["htmlext"]}")
+        else
+          build_titlepage(basetmpdir, "titlepage.#{@config["htmlext"]}")
+        end
+      end
+
+      copy_file_with_param("creditfile")
+      copy_file_with_param("originaltitlefile")
+    end
+
+    def build_indexpage(basetmpdir)
+      File.open("#{basetmpdir}/index.html", "w") do |f|
+        if @config["coverimage"]
+          file = File.join("images", @config["coverimage"])
+        @body = <<-EOT
+  <div id="cover-image" class="cover-image">
+    <img src="#{file}" class="max"/>
+  </div>
+        EOT
+        else
+          @body = ""
+        end
+        @language = @config['language']
+        @stylesheets = @config["stylesheet"]
+        @toc = ReVIEW::WEBTOCPrinter.book_to_string(@book)
+        @next = @book.chapters[0]
+        @next_title = @next ? @next.title : ""
+        tmplfile = File.expand_path(template_name, ReVIEW::Template::TEMPLATE_DIR)
+        tmpl = ReVIEW::Template.load(tmplfile)
+        f.write tmpl.result(binding)
+      end
+    end
+
+    def build_titlepage(basetmpdir, htmlfile)
+      File.open("#{basetmpdir}/#{htmlfile}", "w") do |f|
+        @body = ""
+        @body << "<div class=\"titlepage\">"
+        @body << "<h1 class=\"tp-title\">#{CGI.escapeHTML(@config["booktitle"])}</h1>"
+        if @config["aut"]
+          @body << "<h2 class=\"tp-author\">#{join_with_separator(@config["aut"], ReVIEW::I18n.t("names_splitter"))}</h2>"
+        end
+        if @config["prt"]
+          @body << "<h3 class=\"tp-publisher\">#{join_with_separator(@config["prt"], ReVIEW::I18n.t("names_splitter"))}</h3>"
+        end
+        @body << "</div>"
+
+        @language = @config['language']
+        @stylesheets = @config["stylesheet"]
+        tmplfile = File.expand_path(template_name, ReVIEW::Template::TEMPLATE_DIR)
+        tmpl = ReVIEW::Template.load(tmplfile)
+        f.write tmpl.result(binding)
+      end
+    end
+
+    def copy_backmatter(basetmpdir)
+      copy_file_with_param("profile")
+      copy_file_with_param("advfile")
+      if @config["colophon"] && @config["colophon"].kind_of?(String)
+        copy_file_with_param("colophon", "colophon.#{@config["htmlext"]}")
+      end
+      copy_file_with_param("backcover")
+    end
+
+    def copy_file_with_param(name, target_file = nil)
+      if @config[name] && File.exist?(@config[name])
+        target_file ||= File.basename(@config[name])
+        FileUtils.cp(@config[name], File.join(basetmpdir, target_file))
+      end
+    end
+
+    def join_with_separator(value, sep)
+      if value.kind_of? Array
+        value.join(sep)
+      else
+        value
+      end
+    end
+
+  end
+end
+

data/lib/review/webtocprinter.rb

@@ -0,0 +1,48 @@
+require 'review/tocprinter'
+
+module ReVIEW
+  class WEBTOCPrinter < TOCPrinter
+    include HTMLUtils
+
+    def self.book_to_string(book)
+      io = StringIO.new
+      ReVIEW::WEBTOCPrinter.new(1, {}, io).print_book(book)
+      io.seek(0)
+      io.read
+    end
+
+    def print_book(book)
+      @out.puts '<ul class="book-toc">'
+      @out.puts "<li><a href=\"index.html\">TOP</a></li>\n"
+      book.each_part do |part|
+        print_part(part)
+      end
+      @out.puts '</ul>'
+    end
+
+    def print_part(part)
+      if part.number
+        @out.puts "<li>#{h(part.title)}\n<ul>\n"
+      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 = chap.path.sub(/\.re/, "."+ext)
+      if chap_node.number && chap.on_CHAPS?
+        label = "#{chap.number} #{chap.title}"
+      else
+        label = chap.title
+      end
+      @out.puts "<li><a href=\"#{path}\">#{h(label)}</a></li>\n"
+    end
+
+  end
+end

data/lib/review/yamlloader.rb

@@ -0,0 +1,47 @@
+require 'yaml'
+
+module ReVIEW
+  class YAMLLoader
+    def initialize
+    end
+
+    # load YAML files
+    #
+    # `inherit: [3.yml, 6.yml]` in 7.yml; `inherit: [1.yml, 2.yml]` in 3.yml; `inherit: [4.yml, 5.yml]` in 6.yml
+    #    => 7.yml > 6.yml > 5.yml > 4.yml > 3.yml > 2.yml > 1.yml
+    #
+    def load_file(yamlfile)
+      file_queue = [File.expand_path(yamlfile)]
+      loaded_files = {}
+      yaml = {}
+
+      loop do
+        # Check exit condition
+        if file_queue.empty?
+          return yaml
+        end
+
+        current_file = file_queue.shift
+        current_yaml = YAML.load_file(current_file)
+        yaml = current_yaml.deep_merge(yaml)
+
+        if yaml.key?('inherit')
+          buf = []
+          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
+
+            loaded_files[inherit_file] = true
+            buf << inherit_file
+          end
+          yaml.delete('inherit')
+          file_queue = buf + file_queue
+        end
+      end
+    end
+  end
+end

data/review.gemspec

@@ -13,20 +13,20 @@ 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 = "2015-02-28"
+  gem.date = "2016-04-29"
 
   gem.files         = `git ls-files`.split("\n")
   gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   gem.extra_rdoc_files = [
     "ChangeLog",
-    "README.rdoc"
   ]
   gem.require_paths = ["lib"]
 
+  gem.add_dependency("rubyzip")
   gem.add_development_dependency("rake")
   gem.add_development_dependency("test-unit")
-  gem.add_development_dependency("kpeg")
   gem.add_development_dependency("pygments.rb")
+  gem.add_development_dependency("rubocop")
 end
 

data/templates/html/layout-html5.html.erb

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml" xmlns:epub="http://www.idpf.org/2007/ops" xmlns:ops="http://www.idpf.org/2007/ops" xml:lang="<%= @language %>">
+<head>
+  <meta charset="UTF-8" />
+<% if @stylesheets.present? %>
+<%   @stylesheets.each do |style| %>
+  <link rel="stylesheet" type="text/css" href="<%= style %>" />
+<%   end %>
+<% end%>
+  <meta name="generator" content="Re:VIEW" />
+  <title><%= @title %></title>
+</head>
+<body<%= @body_ext %>>
+<%= @body %>
+</body>
+</html>