Merge pull request #498 from takahashim/webmaker

add webmaker

bin/review-webmaker

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+#
+# 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 'pathname'
+bindir = Pathname.new(__FILE__).realpath.dirname
+$LOAD_PATH.unshift((bindir + '../lib').realpath)
+
+require 'review/webmaker'
+
+ReVIEW::WEBMaker.execute(*ARGV)

lib/review/configure.rb

@@ -40,6 +40,9 @@ def self.values
         "mathml" => nil, # for HTML
         "htmlext" => "html",
         "htmlversion" => 5,
+        "imagedir" => "images",
+        "image_ext" => %w(png gif jpg jpeg svg ttf woff otf),
+        "fontdir" => "fonts",
 
         "chapter_file" => 'CHAPS',
         "part_file" => 'PART',

lib/review/htmlbuilder.rb

@@ -13,6 +13,7 @@
 require 'review/htmlutils'
 require 'review/template'
 require 'review/textutils'
+require 'review/webtocprinter'
 
 module ReVIEW
 
@@ -54,17 +55,25 @@ def builder_init_file
       @sec_counter = SecCounter.new(5, @chapter)
       @nonum_counter = 0
       @body_ext = nil
+      @toc = nil
     end
     private :builder_init_file
 
     def result
+      if @book.config.maker == "webmaker"
+        htmldir = "web/html"
+        localfilename = "layout-web.html.erb"
+      else
+        htmldir = "html"
+        localfilename = "layout.html.erb"
+      end
       if @book.htmlversion == 5
-        htmlfilename = "./html/layout-html5.html.erb"
+        htmlfilename = File.join(htmldir, "layout-html5.html.erb")
       else
-        htmlfilename = "./html/layout-xhtml1.html.erb"
+        htmlfilename = File.join(htmldir, "layout-xhtml1.html.erb")
       end
 
-      layout_file = File.join(@book.basedir, "layouts", "layout.html.erb")
+      layout_file = File.join(@book.basedir, "layouts", localfilename)
       if !File.exist?(layout_file) && File.exist?(File.join(@book.basedir, "layouts", "layout.erb"))
         raise ReVIEW::ConfigError, "layout.erb is obsoleted. Please use layout.html.erb."
       end
@@ -86,6 +95,12 @@ def result
       @stylesheets = @book.config["stylesheet"]
       @next = @chapter.next_chapter
       @prev = @chapter.prev_chapter
+      @next_title = @next ? compile_inline(@next.title) : ""
+      @prev_title = @prev ? compile_inline(@prev.title) : ""
+
+      if @book.config.maker == "webmaker"
+        @toc = ReVIEW::WEBTOCPrinter.book_to_string(@book)
+      end
 
       tmpl = ReVIEW::Template.load(layout_file)
       tmpl.result(binding)

lib/review/htmlutils.rb

@@ -25,6 +25,7 @@ def escape_html(str)
     end
 
     alias_method :escape, :escape_html
+    alias_method :h, :escape_html
 
     def unescape_html(str)
       # FIXME better code

lib/review/webmaker.rb

@@ -0,0 +1,297 @@
+# 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'
+require 'review/i18n'
+require 'review/converter'
+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
+