review 2.5.0 → 3.0.0.preview1

data/lib/review/idgxmlbuilder.rb

@@ -16,7 +16,7 @@ module ReVIEW
     include TextUtils
     include HTMLUtils
 
-    %i[ttbold hint maru keytop labelref ref balloon].each { |e| Compiler.definline(e) }
+    %i[ttbold hint maru keytop labelref ref].each { |e| Compiler.definline(e) }
     Compiler.defsingle(:dtp, 1)
 
     Compiler.defblock(:insn, 0..1)
@@ -44,8 +44,7 @@ module ReVIEW
       '.xml'
     end
 
-    def builder_init(no_error = false)
-      @no_error = no_error
+    def builder_init
     end
     private :builder_init
 
@@ -62,13 +61,12 @@ module ReVIEW
       @ol_num = nil
       @first_line_num = nil
       @rootelement = 'doc'
-      @secttags = nil
       @tsize = nil
       @texblockequation = 0
       @texinlineequation = 0
       print %Q(<?xml version="1.0" encoding="UTF-8"?>\n)
       print %Q(<#{@rootelement} xmlns:aid="http://ns.adobe.com/AdobeInDesign/4.0/">)
-      @secttags = true unless @book.config['structuredxml'].nil?
+      @secttags = @book.config['structuredxml']
     end
     private :builder_init_file
 
@@ -102,7 +100,7 @@ module ReVIEW
           print '</sect>' if @section > 0
         end
 
-        print %Q(<chapter id="chap:#{@chapter.number}">) unless @secttags.nil?
+        print %Q(<chapter id="chap:#{@chapter.number}">) if @secttags
 
         @section = 0
         @subsection = 0
@@ -116,7 +114,7 @@ module ReVIEW
           print '</sect>' if @section > 0
         end
         @section += 1
-        print %Q(<sect id="sect:#{@chapter.number}.#{@section}">) unless @secttags.nil?
+        print %Q(<sect id="sect:#{@chapter.number}.#{@section}">) if @secttags
 
         @subsection = 0
         @subsubsection = 0
@@ -129,7 +127,7 @@ module ReVIEW
         end
 
         @subsection += 1
-        print %Q(<sect2 id="sect:#{@chapter.number}.#{@section}.#{@subsection}">) unless @secttags.nil?
+        print %Q(<sect2 id="sect:#{@chapter.number}.#{@section}.#{@subsection}">) if @secttags
 
         @subsubsection = 0
         @subsubsubsection = 0
@@ -155,7 +153,7 @@ module ReVIEW
       prefix, _anchor = headline_prefix(level)
 
       label = label.nil? ? '' : %Q( id="#{label}")
-      toccaption = escape_html(compile_inline(caption.gsub(/@<fn>\{.+?\}/, '')).gsub(/<[^>]+>/, ''))
+      toccaption = escape(compile_inline(caption.gsub(/@<fn>\{.+?\}/, '')).gsub(/<[^>]+>/, ''))
       puts %Q(<title#{label} aid:pstyle="h#{level}">#{prefix}#{compile_inline(caption)}</title><?dtp level="#{level}" section="#{prefix}#{toccaption}"?>)
     end
 
@@ -591,12 +589,12 @@ module ReVIEW
       lines ||= []
       lines.unshift comment unless comment.blank?
       str = lines.join("\n")
-      print "<msg>#{escape_html(str)}</msg>"
+      print "<msg>#{escape(str)}</msg>"
     end
 
     def inline_comment(str)
       if @book.config['draft']
-        %Q(<msg>#{escape_html(str)}</msg>)
+        %Q(<msg>#{escape(str)}</msg>)
       else
         ''
       end
@@ -613,34 +611,34 @@ module ReVIEW
     end
 
     def compile_ruby(base, ruby)
-      %Q(<GroupRuby><aid:ruby xmlns:aid="http://ns.adobe.com/AdobeInDesign/3.0/"><aid:rb>#{escape_html(base.strip)}</aid:rb><aid:rt>#{escape_html(ruby.strip)}</aid:rt></aid:ruby></GroupRuby>)
+      %Q(<GroupRuby><aid:ruby xmlns:aid="http://ns.adobe.com/AdobeInDesign/3.0/"><aid:rb>#{escape(base.strip)}</aid:rb><aid:rt>#{escape(ruby.strip)}</aid:rt></aid:ruby></GroupRuby>)
     end
 
     def compile_kw(word, alt)
       '<keyword>' +
         if alt
-        then escape_html("#{word}（#{alt.strip}）")
-        else escape_html(word)
+        then escape("#{word}（#{alt.strip}）")
+        else escape(word)
         end +
       '</keyword>' +
-        %Q(<index value="#{escape_html(word)}" />) +
+        %Q(<index value="#{escape(word)}" />) +
         if alt
-          alt.split(/\s*,\s*/).collect! { |e| %Q(<index value="#{escape_html(e.strip)}" />) }.join
+          alt.split(/\s*,\s*/).collect! { |e| %Q(<index value="#{escape(e.strip)}" />) }.join
         else
           ''
         end
     end
 
     def compile_href(url, label)
-      %Q(<a linkurl='#{escape_html(url)}'>#{label.nil? ? escape_html(url) : escape_html(label)}</a>)
+      %Q(<a linkurl='#{escape(url)}'>#{label.nil? ? escape(url) : escape(label)}</a>)
     end
 
     def inline_sup(str)
-      %Q(<sup>#{escape_html(str)}</sup>)
+      %Q(<sup>#{escape(str)}</sup>)
     end
 
     def inline_sub(str)
-      %Q(<sub>#{escape_html(str)}</sub>)
+      %Q(<sub>#{escape(str)}</sub>)
     end
 
     def inline_raw(str)
@@ -649,9 +647,9 @@ module ReVIEW
 
     def inline_hint(str)
       if @book.config['nolf']
-        %Q(<hint>#{escape_html(str)}</hint>)
+        %Q(<hint>#{escape(str)}</hint>)
       else
-        %Q(\n<hint>#{escape_html(str)}</hint>)
+        %Q(\n<hint>#{escape(str)}</hint>)
       end
     end
 
@@ -676,41 +674,41 @@ module ReVIEW
     end
 
     def inline_idx(str)
-      %Q(#{escape_html(str)}<index value="#{escape_html(str)}" />)
+      %Q(#{escape(str)}<index value="#{escape(str)}" />)
     end
 
     def inline_hidx(str)
-      %Q(<index value="#{escape_html(str)}" />)
+      %Q(<index value="#{escape(str)}" />)
     end
 
     def inline_ami(str)
-      %Q(<ami>#{escape_html(str)}</ami>)
+      %Q(<ami>#{escape(str)}</ami>)
     end
 
     def inline_i(str)
-      %Q(<i>#{escape_html(str)}</i>)
+      %Q(<i>#{escape(str)}</i>)
     end
 
     def inline_b(str)
-      %Q(<b>#{escape_html(str)}</b>)
+      %Q(<b>#{escape(str)}</b>)
     end
 
     def inline_tt(str)
-      %Q(<tt>#{escape_html(str)}</tt>)
+      %Q(<tt>#{escape(str)}</tt>)
     end
 
     def inline_ttb(str)
-      %Q(<tt style='bold'>#{escape_html(str)}</tt>)
+      %Q(<tt style='bold'>#{escape(str)}</tt>)
     end
 
     alias_method :inline_ttbold, :inline_ttb
 
     def inline_tti(str)
-      %Q(<tt style='italic'>#{escape_html(str)}</tt>)
+      %Q(<tt style='italic'>#{escape(str)}</tt>)
     end
 
     def inline_u(str)
-      %Q(<underline>#{escape_html(str)}</underline>)
+      %Q(<underline>#{escape(str)}</underline>)
     end
 
     def inline_icon(id)
@@ -723,25 +721,25 @@ module ReVIEW
     end
 
     def inline_bou(str)
-      %Q(<bou>#{escape_html(str)}</bou>)
+      %Q(<bou>#{escape(str)}</bou>)
     end
 
     def inline_keytop(str)
-      %Q(<keytop>#{escape_html(str)}</keytop>)
+      %Q(<keytop>#{escape(str)}</keytop>)
     end
 
     def inline_labelref(idref)
-      %Q(<ref idref='#{escape_html(idref)}'>「#{I18n.t('label_marker')}#{escape_html(idref)}」</ref>) # FIXME: 節名とタイトルも込みで要出力
+      %Q(<ref idref='#{escape(idref)}'>「#{I18n.t('label_marker')}#{escape(idref)}」</ref>) # FIXME: 節名とタイトルも込みで要出力
     end
 
     alias_method :inline_ref, :inline_labelref
 
     def inline_pageref(idref)
-      %Q(<pageref idref='#{escape_html(idref)}'>●●</pageref>) # ページ番号を参照
+      %Q(<pageref idref='#{escape(idref)}'>●●</pageref>) # ページ番号を参照
     end
 
     def inline_balloon(str)
-      %Q(<balloon>#{escape_html(str).gsub(/@maru\[(\d+)\]/) { inline_maru($1) }}</balloon>)
+      %Q(<balloon>#{escape(str).gsub(/@maru\[(\d+)\]/) { inline_maru($1) }}</balloon>)
     end
 
     def inline_uchar(str)
@@ -750,7 +748,7 @@ module ReVIEW
 
     def inline_m(str)
       @texinlineequation += 1
-      %Q(<replace idref="texinline-#{@texinlineequation}"><pre>#{escape_html(str)}</pre></replace>)
+      %Q(<replace idref="texinline-#{@texinlineequation}"><pre>#{escape(str)}</pre></replace>)
     end
 
     def noindent
@@ -766,12 +764,25 @@ module ReVIEW
     end
 
     def nonum_begin(level, _label, caption)
-      puts %Q(<title aid:pstyle="h#{level}">#{compile_inline(caption)}</title><?dtp level="#{level}" section="#{escape_html(compile_inline(caption))}"?>)
+      puts %Q(<title aid:pstyle="h#{level}">#{compile_inline(caption)}</title><?dtp level="#{level}" section="#{escape(compile_inline(caption))}"?>)
     end
 
     def nonum_end(level)
     end
 
+    def notoc_begin(level, _label, caption)
+      puts %Q(<title aid:pstyle="h#{level}">#{compile_inline(caption)}</title>)
+    end
+
+    def notoc_end(level)
+    end
+
+    def nodisp_begin(level, label, caption)
+    end
+
+    def nodisp_end(level)
+    end
+
     def circle_begin(_level, _label, caption)
       puts %Q(<title aid:pstyle="smallcircle">&#x2022;#{compile_inline(caption)}</title>)
     end
@@ -783,7 +794,7 @@ module ReVIEW
       @column += 1
       a_id = %Q(id="column-#{@column}")
       print "<#{type}column #{a_id}>"
-      puts %Q(<title aid:pstyle="#{type}column-title">#{compile_inline(caption)}</title><?dtp level="9" section="#{escape_html(compile_inline(caption))}"?>)
+      puts %Q(<title aid:pstyle="#{type}column-title">#{compile_inline(caption)}</title><?dtp level="9" section="#{escape(compile_inline(caption))}"?>)
     end
 
     def common_column_end(type)
@@ -1035,7 +1046,7 @@ module ReVIEW
     end
 
     def inline_code(str)
-      %Q(<tt type='inline-code'>#{escape_html(str)}</tt>)
+      %Q(<tt type='inline-code'>#{escape(str)}</tt>)
     end
 
     def inline_br(_str)
@@ -1142,11 +1153,11 @@ module ReVIEW
 
     def inline_recipe(id)
       # FIXME
-      %Q(<recipe idref="#{escape_html(id)}">[XXX]「#{escape_html(id)}」　p.XX</recipe>)
+      %Q(<recipe idref="#{escape(id)}">[XXX]「#{escape(id)}」　p.XX</recipe>)
     end
 
     def nofunc_text(str)
-      escape_html(str)
+      escape(str)
     end
 
     def image_ext

data/lib/review/init.rb

@@ -0,0 +1,194 @@
+#
+# Copyright (c) 2018 Masanori Kado, Masayoshi Takahashi, Kenshi Muto
+#
+# 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 'fileutils'
+require 'optparse'
+require 'review'
+
+module ReVIEW
+  class Init
+    def self.execute(*args)
+      new.execute(*args)
+    end
+
+    def initialize
+      @template = 'review-jsbook'
+      @logger = ReVIEW.logger
+      @review_dir = File.dirname(File.expand_path('..', __dir__))
+    end
+
+    def execute(*args)
+      initdir = parse_options(args)
+
+      generate_dir(initdir) do |dir|
+        generate_catalog_file(dir)
+        generate_sample(dir)
+        generate_images_dir(dir)
+        generate_cover_image(dir)
+        generate_layout(dir)
+        generate_style(dir)
+        generate_texmacro(dir)
+        generate_config(dir)
+        generate_locale(dir) if @locale
+        generate_rakefile(dir)
+        generate_gemfile(dir)
+        generate_doc(dir) unless @without_doc
+      end
+    end
+
+    def parse_options(args)
+      opts = OptionParser.new
+      opts.version = ReVIEW::VERSION
+      opts.banner = "Usage: #{File.basename($PROGRAM_NAME)} [option] dirname"
+      opts.on('-h', '--help', 'print this message and quit.') do
+        puts opts.help
+        exit 0
+      end
+      opts.on('-f', '--force', 'generate files (except *.re) if directory has already existed.') do
+        @force = true
+      end
+      opts.on('-l', '--locale', 'generate locale.yml file.') do
+        @locale = true
+      end
+      opts.on('--latex-template name', 'specify LaTeX template name. (default: review-jsbook)') do |tname|
+        @template = tname
+      end
+      opts.on('', '--epub-version VERSION', 'define EPUB version') do |version|
+        @epub_version = version
+      end
+      opts.on('', '--without-doc', "don't generate doc files") do
+        @without_doc = true
+      end
+
+      begin
+        opts.parse!(args)
+      rescue OptionParser::ParseError => err
+        @logger.error err.message
+        $stderr.puts opts.help
+        exit 1
+      end
+
+      if args.empty?
+        $stderr.puts opts.help
+        exit 1
+      end
+
+      initdir = File.expand_path(args[0])
+
+      initdir
+    end
+
+    def generate_dir(dir)
+      if File.exist?(dir) && !@force
+        @logger.error "#{dir} already exists."
+        exit 1
+      end
+      FileUtils.mkdir_p dir
+      yield dir
+    end
+
+    def generate_sample(dir)
+      unless @force
+        File.write("#{dir}/#{File.basename(dir)}.re", '= ')
+      end
+    end
+
+    def generate_layout(dir)
+      FileUtils.mkdir_p dir + '/layouts'
+    end
+
+    def generate_catalog_file(dir)
+      File.open(dir + '/catalog.yml', 'w') do |file|
+        file.write <<-EOS
+PREDEF:
+
+CHAPS:
+  - #{File.basename(dir)}.re
+
+APPENDIX:
+
+POSTDEF:
+
+EOS
+      end
+    end
+
+    def generate_images_dir(dir)
+      FileUtils.mkdir_p(dir + '/images')
+    end
+
+    def generate_cover_image(dir)
+      FileUtils.cp(@review_dir + '/test/sample-book/src/images/cover.jpg',
+                   dir + '/images/')
+    end
+
+    def generate_config(dir)
+      today = Time.now.strftime('%Y-%m-%d')
+      content = File.read(@review_dir + '/doc/config.yml.sample', encoding: 'utf-8')
+      content.gsub!(/^#\s*coverimage:.*$/, 'coverimage: cover.jpg')
+      content.gsub!(/^#\s*date:.*$/, "date: #{today}")
+      content.gsub!(/^#\s*history:.*$/, %Q(history: [["#{today}"]]))
+      content.gsub!(/^#\s*texstyle:.*$/, 'texstyle: reviewmacro')
+      content.gsub!(/^(#\s*)?stylesheet:.*$/, %Q(stylesheet: ["style.css"]))
+      if @epub_version.to_i == 2
+        content.gsub!(/^#.*epubversion:.*$/, 'epubversion: 2')
+        content.gsub!(/^#.*htmlversion:.*$/, 'htmlversion: 4')
+      end
+      File.open(File.join(dir, 'config.yml'), 'w') { |f| f.write(content) }
+    end
+
+    def generate_style(dir)
+      FileUtils.cp @review_dir + '/test/sample-book/src/style.css', dir
+    end
+
+    def generate_texmacro(dir)
+      texmacrodir = dir + '/sty'
+      FileUtils.mkdir_p texmacrodir
+      tdir = File.join(@review_dir, '/templates/latex', @template)
+      @logger.error "#{tdir} not found." unless File.exist?(tdir)
+      FileUtils.cp Dir.glob(tdir + '/*.*'), texmacrodir
+    end
+
+    def generate_rakefile(dir)
+      FileUtils.mkdir_p dir + '/lib/tasks'
+
+      File.open(dir + '/Rakefile', 'w') do |file|
+        file.write <<-EOS
+Dir.glob('lib/tasks/*.rake').each do |file|
+  load(file)
+end
+EOS
+      end
+
+      FileUtils.cp(@review_dir + '/test/sample-book/src/Rakefile',
+                   dir + '/lib/tasks/review.rake')
+    end
+
+    def generate_locale(dir)
+      FileUtils.cp @review_dir + '/lib/review/i18n.yml', dir + '/locale.yml'
+    end
+
+    def generate_gemfile(dir)
+      File.open(dir + '/Gemfile', 'w') do |file|
+        file.write <<-EOS
+source 'https://rubygems.org'
+
+gem 'rake'
+gem 'review', '#{ReVIEW::VERSION}'
+EOS
+      end
+    end
+
+    def generate_doc(dir)
+      docdir = dir + '/doc'
+      FileUtils.mkdir_p docdir
+      md_files = Dir.glob(@review_dir + '/doc/*.md').map.to_a
+      FileUtils.cp md_files, docdir
+    end
+  end
+end