review 3.2.0 → 4.0.0

data/lib/review/init.rb

@@ -18,12 +18,12 @@ module ReVIEW
       new.execute(*args)
     end
 
-    TEX_DOCUMENTCLASS_OPTS = {
-      'review-jsbook' => 'media=print,paper=a5',
-      'review-jlreq' => 'media=print,paper=a5'
-    }
-
     def initialize
+      @tex_documentclass_opts = {
+        'review-jsbook' => 'media=print,paper=a5',
+        'review-jlreq' => 'media=print,paper=a5'
+      }
+
       @template = 'review-jsbook'
       @logger = ReVIEW.logger
       @review_dir = File.dirname(File.expand_path('..', __dir__))
@@ -32,15 +32,25 @@ module ReVIEW
     def execute(*args)
       initdir = parse_options(args)
 
+      if @webui
+        start_webui
+        unless @web_result
+          @logger.error 'Aborted.'
+          exit 1
+        end
+        @template = @web_result[0]
+        @tex_documentclass_opts[@template] = @web_result[1]
+      end
+
       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_gitignore(dir)
         generate_locale(dir) if @locale
         generate_rakefile(dir)
         generate_gemfile(dir)
@@ -50,6 +60,9 @@ module ReVIEW
     end
 
     def parse_options(args)
+      @port = 18000
+      @bind = '0'
+
       opts = OptionParser.new
       opts.version = ReVIEW::VERSION
       opts.banner = "Usage: #{File.basename($PROGRAM_NAME)} [option] dirname"
@@ -63,7 +76,7 @@ module ReVIEW
       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|
+      opts.on('-t', '--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|
@@ -75,6 +88,15 @@ module ReVIEW
       opts.on('-p', '--package archivefile', 'extract from local or network archive.') do |archive|
         @archive = archive
       end
+      opts.on('-w', '--wizard', 'launch Web based layout configuration.') do
+        @webui = true
+      end
+      opts.on('', '--port port', 'port to use for Web based layout configuration. (default: 18000)') do |port|
+        @port = port
+      end
+      opts.on('', '--bind bindaddress', 'address to use for Web based layout configuration. (default: 0 (any))') do |bind|
+        @bind = bind
+      end
 
       begin
         opts.parse!(args)
@@ -99,7 +121,7 @@ module ReVIEW
         @logger.error "#{dir} already exists."
         exit 1
       end
-      FileUtils.mkdir_p dir
+      FileUtils.mkdir_p(dir)
       yield dir
     end
 
@@ -109,10 +131,6 @@ module ReVIEW
       end
     end
 
-    def generate_layout(dir)
-      FileUtils.mkdir_p File.join(dir, 'layouts')
-    end
-
     def generate_catalog_file(dir)
       File.open(File.join(dir, 'catalog.yml'), 'w') do |file|
         file.write <<-EOS
@@ -154,31 +172,49 @@ EOS
         content.gsub!(/^#.*htmlversion:.*$/, 'htmlversion: 4')
       end
 
-      if TEX_DOCUMENTCLASS_OPTS[@template]
-        content.gsub!(/^#\s*texdocumentclass:.*$/, %Q(texdocumentclass: ["#{@template}", "#{TEX_DOCUMENTCLASS_OPTS[@template]}"]))
+      if @tex_documentclass_opts[@template]
+        content.gsub!(/^#\s*texdocumentclass:.*$/, %Q(texdocumentclass: ["#{@template}", "#{@tex_documentclass_opts[@template]}"]))
+      end
+
+      File.open(File.join(dir, 'config.yml'), 'w') { |f| f.write content }
+      if @webui && !@web_result[2].empty?
+        File.open(File.join(dir, 'config-ebook.yml'), 'w') do |f|
+          f.puts <<EOT
+# for ebook PDF
+# REVIEW_CONFIG_FILE=config.yml rake pdf
+inherit: ["config.yml"]
+# bookname: book-ebook
+texdocumentclass: ["#{@web_result[0]}", "#{@web_result[2]}"]
+EOT
+        end
       end
+    end
 
-      File.open(File.join(dir, 'config.yml'), 'w') { |f| f.write(content) }
+    def generate_gitignore(dir)
+      FileUtils.cp(File.join(@review_dir, 'samples/sample-book/src/.gitignore'), dir)
     end
 
     def generate_style(dir)
-      FileUtils.cp File.join(@review_dir, 'samples/sample-book/src/style.css'), dir
+      FileUtils.cp(File.join(@review_dir, 'samples/sample-book/src/style.css'), dir)
     end
 
     def generate_texmacro(dir)
       texmacrodir = File.join(dir, 'sty')
-      FileUtils.mkdir_p texmacrodir
+      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(File.join(tdir, '*.*')), texmacrodir
-      # provide jsbook from vendor/. current version is 2018/06/23
-      FileUtils.cp File.join(@review_dir, 'vendor/jsclasses/jsbook.cls'), File.join(texmacrodir, 'jsbook.cls')
-      # provide gentombow from vendor/. current version is 2018/08/30 v0.9j
-      FileUtils.cp File.join(@review_dir, 'vendor/gentombow/gentombow.sty'), File.join(texmacrodir, 'gentombow.sty')
+      FileUtils.cp(Dir.glob(File.join(tdir, '*.*')), texmacrodir)
+
+      if @template == 'review-jsbook'
+        # provide jsbook from vendor/. current version is 2018/06/23
+        FileUtils.cp(File.join(@review_dir, 'vendor/jsclasses/jsbook.cls'), File.join(texmacrodir, 'jsbook.cls'))
+        # provide gentombow from vendor/. current version is 2018/08/30 v0.9j
+        FileUtils.cp(File.join(@review_dir, 'vendor/gentombow/gentombow.sty'), File.join(texmacrodir, 'gentombow.sty'))
+      end
     end
 
     def generate_rakefile(dir)
-      FileUtils.mkdir_p File.join(dir, 'lib/tasks')
+      FileUtils.mkdir_p(File.join(dir, 'lib/tasks'))
 
       File.open(File.join(dir, 'Rakefile'), 'w') do |file|
         file.write <<-EOS
@@ -193,7 +229,7 @@ EOS
     end
 
     def generate_locale(dir)
-      FileUtils.cp File.join(@review_dir, 'lib/review/i18n.yml'), File.join(dir, 'locale.yml')
+      FileUtils.cp(File.join(@review_dir, 'lib/review/i18n.yml'), File.join(dir, 'locale.yml'))
     end
 
     def generate_gemfile(dir)
@@ -209,9 +245,9 @@ EOS
 
     def generate_doc(dir)
       docdir = File.join(dir, 'doc')
-      FileUtils.mkdir_p docdir
+      FileUtils.mkdir_p(docdir)
       md_files = Dir.glob(File.join(@review_dir, 'doc/*.md')).map.to_a
-      FileUtils.cp md_files, docdir
+      FileUtils.cp(md_files, docdir)
     end
 
     def download_and_extract_archive(dir, filename)
@@ -271,5 +307,53 @@ EOS
         @logger.error "#{originalfilename} seems invalid or broken zip file: #{e.message}"
       end
     end
+
+    def start_webui
+      require 'webrick'
+      web_config = {
+        BindAddress: @bind,
+        Port: @port,
+        HTTPVersion: WEBrick::HTTPVersion.new('1.1'),
+        AccessLog: [[File.open(IO::NULL, 'w'), '']]
+      }
+
+      bind_address = (@bind == '0') ? '<thishost>' : @bind
+      puts "Please access http://#{bind_address}:#{web_config[:Port]} from Web browser."
+      begin
+        @web_server = WEBrick::HTTPServer.new(web_config)
+      rescue StandardError => e
+        @logger.error "Error: #{e}"
+        exit 1
+      end
+
+      @web_result = nil
+      web_mounts
+
+      trap(:INT) { @web_server.shutdown }
+      @web_server.start
+
+      # validation
+      if @web_result
+        @web_result.each do |s|
+          if s !~ /\A[a-z0-9=_,\.-]*\Z/i
+            @web_result = nil
+            break
+          end
+        end
+      end
+    end
+
+    def web_mounts
+      htmldir = File.join(@review_dir, 'lib', 'review', 'init-web')
+      @web_server.mount('/', WEBrick::HTTPServlet::FileHandler, File.join(htmldir, 'index.html'))
+      @web_server.mount('/review-layout-design.js', WEBrick::HTTPServlet::FileHandler, File.join(htmldir, 'review-layout-design.js'))
+
+      @web_server.mount_proc('/finish') do |req, res|
+        @web_result = [req.query['cls'], req.query['result_print'], req.query['result_ebook']]
+        res.content_type = 'text/html'
+        res.body = File.read(File.join(htmldir, 'finish.html'))
+        @web_server.shutdown
+      end
+    end
   end
 end

data/lib/review/latexbuilder.rb

@@ -32,7 +32,6 @@ module ReVIEW
       @blank_needed = false
       @latex_tsize = nil
       @tsize = nil
-      @table_caption = nil
       @cellwidth = nil
       @ol_num = nil
       @first_line_num = nil
@@ -257,7 +256,11 @@ module ReVIEW
     end
 
     def ul_item(lines)
-      str = lines.map(&:chomp).join("\n")
+      str = join_lines_to_paragraph(lines)
+      unless @book.config['join_lines_by_lang']
+        str = lines.map(&:chomp).join("\n")
+      end
+
       str.sub!(/\A(\[)/) { '\lbrack{}' }
       puts '\item ' + str
     end
@@ -276,7 +279,11 @@ module ReVIEW
     end
 
     def ol_item(lines, _num)
-      str = lines.map(&:chomp).join("\n")
+      str = join_lines_to_paragraph(lines)
+      unless @book.config['join_lines_by_lang']
+        str = lines.map(&:chomp).join("\n")
+      end
+
       str.sub!(/\A(\[)/) { '\lbrack{}' }
       puts '\item ' + str
     end
@@ -298,7 +305,11 @@ module ReVIEW
     end
 
     def dd(lines)
-      puts lines.map(&:chomp).join("\n")
+      if @book.config['join_lines_by_lang']
+        puts join_lines_to_paragraph(lines)
+      else
+        puts lines.map(&:chomp).join("\n")
+      end
     end
 
     def dl_end
@@ -308,8 +319,10 @@ module ReVIEW
 
     def paragraph(lines)
       blank
-      lines.each do |line|
-        puts line
+      if @book.config['join_lines_by_lang']
+        puts join_lines_to_paragraph(lines)
+      else
+        lines.each { |line| puts line }
       end
       blank
     end
@@ -319,22 +332,35 @@ module ReVIEW
     end
 
     def read(lines)
-      latex_block 'quotation', lines
+      latex_block('quotation', lines)
     end
 
     alias_method :lead, :read
 
+    def highlight?
+      @book.config['highlight'] &&
+        @book.config['highlight']['latex']
+    end
+
     def highlight_listings?
       @book.config['highlight'] && @book.config['highlight']['latex'] == 'listings'
     end
     private :highlight_listings?
 
+    def code_line(_type, line, _idx, _id, _caption, _lang)
+      detab(line) + "\n"
+    end
+
+    def code_line_num(_type, line, first_line_num, idx, _id, _caption, _lang)
+      detab((idx + first_line_num).to_s.rjust(2) + ': ' + line) + "\n"
+    end
+
     def emlist(lines, caption = nil, lang = nil)
       blank
       if highlight_listings?
         common_code_block_lst(nil, lines, 'reviewemlistlst', 'title', caption, lang)
       else
-        common_code_block(nil, lines, 'reviewemlist', caption, lang) { |line, _idx| detab(line) + "\n" }
+        common_code_block(nil, lines, 'reviewemlist', caption, lang) { |line, idx| code_line('emlist', line, idx, nil, caption, lang) }
       end
     end
 
@@ -344,7 +370,7 @@ module ReVIEW
       if highlight_listings?
         common_code_block_lst(nil, lines, 'reviewemlistnumlst', 'title', caption, lang, first_line_num: first_line_num)
       else
-        common_code_block(nil, lines, 'reviewemlist', caption, lang) { |line, idx| detab((idx + first_line_num).to_s.rjust(2) + ': ' + line) + "\n" }
+        common_code_block(nil, lines, 'reviewemlist', caption, lang) { |line, idx| code_line_num('emlistnum', line, first_line_num, idx, nil, caption, lang) }
       end
     end
 
@@ -353,7 +379,7 @@ module ReVIEW
       if highlight_listings?
         common_code_block_lst(id, lines, 'reviewlistlst', 'caption', caption, lang)
       else
-        common_code_block(id, lines, 'reviewlist', caption, lang) { |line, _idx| detab(line) + "\n" }
+        common_code_block(id, lines, 'reviewlist', caption, lang) { |line, idx| code_line('list', line, idx, id, caption, lang) }
       end
     end
 
@@ -363,7 +389,7 @@ module ReVIEW
       if highlight_listings?
         common_code_block_lst(id, lines, 'reviewlistnumlst', 'caption', caption, lang, first_line_num: first_line_num)
       else
-        common_code_block(id, lines, 'reviewlist', caption, lang) { |line, idx| detab((idx + first_line_num).to_s.rjust(2) + ': ' + line) + "\n" }
+        common_code_block(id, lines, 'reviewlist', caption, lang) { |line, idx| code_line_num('listnum', line, first_line_num, idx, id, caption, lang) }
       end
     end
 
@@ -372,7 +398,7 @@ module ReVIEW
         common_code_block_lst(nil, lines, 'reviewcmdlst', 'title', caption, lang)
       else
         blank
-        common_code_block(nil, lines, 'reviewcmd', caption, lang) { |line, _idx| detab(line) + "\n" }
+        common_code_block(nil, lines, 'reviewcmd', caption, lang) { |line, idx| code_line('cmd', line, idx, nil, caption, lang) }
       end
     end
 
@@ -414,7 +440,7 @@ module ReVIEW
       if title == 'title' && caption.blank? && @book.config.check_version('2', exception: false)
         print '\vspace{-1.5em}'
       end
-      body = lines.inject('') { |i, j| i + detab(unescape(j)) + "\n" }
+      body = lines.inject('') { |i, j| i + detab(j) + "\n" }
       args = make_code_block_args(title, caption, lang, first_line_num: first_line_num)
       puts %Q(\\begin{#{command}}[#{args}])
       print body
@@ -449,7 +475,7 @@ module ReVIEW
       if highlight_listings?
         common_code_block_lst(nil, lines, 'reviewsourcelst', 'title', caption, lang)
       else
-        common_code_block(nil, lines, 'reviewsource', caption, lang) { |line, _idx| detab(line) + "\n" }
+        common_code_block(nil, lines, 'reviewsource', caption, lang) { |line, idx| code_line('source', line, idx, nil, caption, lang) }
       end
     end
 
@@ -514,7 +540,7 @@ module ReVIEW
     end
 
     def existence(id)
-      @chapter.image(id).bound? ? 'exist' : 'not exist'
+      @chapter.image_bound?(id) ? 'exist' : 'not exist'
     end
     private :existence
 
@@ -594,26 +620,30 @@ module ReVIEW
     alias_method :numberlessimage, :indepimage
 
     def table(lines, id = nil, caption = nil)
-      rows = []
-      sepidx = nil
-      lines.each_with_index do |line, idx|
-        if /\A[\=\{\-\}]{12}/ =~ line
-          # just ignore
-          # error "too many table separator" if sepidx
-          sepidx ||= idx
-          next
+      if caption.present?
+        if @book.config.check_version('2', exception: false)
+          puts "\\begin{table}[h]%%#{id}"
+        else
+          puts "\\begin{table}%%#{id}"
         end
-        rows.push(line.strip.split(/\t+/).map { |s| s.sub(/\A\./, '') })
       end
-      rows = adjust_n_cols(rows)
-      error 'no rows in the table' if rows.empty?
 
+      sepidx, rows = parse_table_rows(lines)
       begin
         table_header(id, caption) if caption.present?
       rescue KeyError
         error "no such table: #{id}"
       end
       table_begin(rows.first.size)
+      table_rows(sepidx, rows)
+      table_end
+      if caption.present?
+        puts '\end{table}'
+      end
+      blank
+    end
+
+    def table_rows(sepidx, rows)
       if sepidx
         sepidx.times do
           cno = -1
@@ -640,31 +670,18 @@ module ReVIEW
              end)
         end
       end
-      table_end
     end
 
     def table_header(id, caption)
       if id.nil?
         if caption.present?
-          @table_caption = true
           @doc_status[:caption] = true
-          if @book.config.check_version('2', exception: false)
-            puts "\\begin{table}[h]%%#{id}"
-          else
-            puts "\\begin{table}%%#{id}"
-          end
           puts macro('reviewtablecaption*', compile_inline(caption))
           @doc_status[:caption] = nil
         end
       else
         if caption.present?
-          @table_caption = true
           @doc_status[:caption] = true
-          if @book.config.check_version('2', exception: false)
-            puts "\\begin{table}[h]%%#{id}"
-          else
-            puts "\\begin{table}%%#{id}"
-          end
           puts macro('reviewtablecaption', compile_inline(caption))
           @doc_status[:caption] = nil
         end
@@ -767,12 +784,9 @@ module ReVIEW
 
     def table_end
       puts macro('end', 'reviewtable')
-      puts '\end{table}' if @table_caption
-      @table_caption = nil
       @tsize = nil
       @latex_tsize = nil
       @cellwidth = nil
-      blank
     end
 
     def emtable(lines, caption = nil)
@@ -780,17 +794,16 @@ module ReVIEW
     end
 
     def imgtable(lines, id, caption = nil, metric = nil)
-      unless @chapter.image(id).bound?
+      unless @chapter.image_bound?(id)
         warn "image not bound: #{id}"
-        image_dummy id, caption, lines
+        image_dummy(id, caption, lines)
         return
       end
 
       begin
         if caption.present?
-          @table_caption = true
-          @doc_status[:caption] = true
           puts "\\begin{table}[h]%%#{id}"
+          @doc_status[:caption] = true
           puts macro('reviewimgtablecaption', compile_inline(caption))
           @doc_status[:caption] = nil
         end
@@ -800,8 +813,9 @@ module ReVIEW
       end
       imgtable_image(id, caption, metric)
 
-      puts '\end{table}' if @table_caption
-      @table_caption = nil
+      if caption.present?
+        puts '\end{table}'
+      end
       blank
     end
 
@@ -824,17 +838,17 @@ module ReVIEW
     end
 
     def quote(lines)
-      latex_block 'quote', lines
+      latex_block('quote', lines)
     end
 
     def center(lines)
-      latex_block 'center', lines
+      latex_block('center', lines)
     end
 
     alias_method :centering, :center
 
     def flushright(lines)
-      latex_block 'flushright', lines
+      latex_block('flushright', lines)
     end
 
     def texequation(lines, id = nil, caption = '')
@@ -851,7 +865,7 @@ module ReVIEW
 
       puts macro('begin', 'equation*')
       lines.each do |line|
-        puts unescape(line)
+        puts line
       end
       puts macro('end', 'equation*')
 
@@ -883,7 +897,7 @@ module ReVIEW
       return true unless @book.config['draft']
       lines ||= []
       unless comment.blank?
-        lines.unshift escape(comment)
+        lines.unshift(escape(comment))
       end
       str = lines.join('\par ')
       puts macro('pdfcomment', str)
@@ -995,6 +1009,9 @@ module ReVIEW
 
     def footnote(id, content)
       if @book.config['footnotetext'] || @foottext[id]
+        if @doc_status[:column]
+          warn "//footnote[#{id}] is in the column block. It is recommended to move out of the column block."
+        end
         puts macro("footnotetext[#{@chapter.footnote(id).number}]", compile_inline(content.strip))
       end
     end
@@ -1215,7 +1232,12 @@ module ReVIEW
     end
 
     def bibpaper_bibpaper(_id, _caption, lines)
-      print split_paragraph(lines).map(&:chomp).join("\n")
+      if @book.config['join_lines_by_lang']
+        print split_paragraph(lines).join("\n\n")
+      else
+        print split_paragraph(lines).map(&:chomp).join("\n")
+      end
+
       puts ''
     end