review 2.5.0 → 3.0.0.preview1

data/lib/review/book/index.rb

@@ -23,7 +23,9 @@ module ReVIEW
           if id = line.slice(/\[(.*?)\]/, 1)
             items.push item_class.new(id, seq)
             seq += 1
-            ReVIEW.logger.warn "warning: no ID of #{item_type} in #{line}" if id.empty?
+            if id.empty?
+              ReVIEW.logger.warn "warning: no ID of #{item_type} in #{line}"
+            end
           end
         end
         new(items, *args)
@@ -46,7 +48,9 @@ module ReVIEW
         @index = {}
         @logger = ReVIEW.logger
         items.each do |i|
-          @logger.warn "warning: duplicate ID: #{i.id} (#{i})" if @index[i.id]
+          if @index[i.id]
+            @logger.warn "warning: duplicate ID: #{i.id} (#{i})"
+          end
           @index[i.id] = i
         end
         @image_finder = nil
@@ -62,7 +66,9 @@ module ReVIEW
         end
 
         @items.each do |i|
-          return i if i.id.split('|').include?(id)
+          if i.id.split('|').include?(id)
+            return i
+          end
         end
         raise KeyError, "not found key '#{id}' for #{self.class}"
       end
@@ -150,7 +156,9 @@ module ReVIEW
               items.push item_class.new(elements[1], seq, elements[3])
               seq += 1
             end
-            ReVIEW.logger.warn "warning: no ID of #{item_type} in #{line}" if elements[1] == ''
+            if elements[1] == ''
+              ReVIEW.logger.warn "warning: no ID of #{item_type} in #{line}"
+            end
           end
         end
         new(items, *args)
@@ -295,7 +303,9 @@ module ReVIEW
           end
 
           m = HEADLINE_PATTERN.match(line)
-          next if m.nil? || m[1].size > 10 # Ignore too deep index
+          if m.nil? || m[1].size > 10 # Ignore too deep index
+            next
+          end
           index = m[1].size - 2
 
           # column
@@ -307,7 +317,9 @@ module ReVIEW
             inside_column = false
             next
           end
-          inside_column = false if indexs.blank? || index <= column_level
+          if indexs.blank? || index <= column_level
+            inside_column = false
+          end
           next if inside_column
           next if m[4].strip.empty? # no title
 
@@ -316,7 +328,11 @@ module ReVIEW
             indexs = indexs.take(index + 1)
             headlines = headlines.take(index + 1)
           end
-          (0..index).each { |i| indexs[i] = 0 if indexs[i].nil? } if indexs[index].nil?
+          if indexs[index].nil?
+            (0..index).each do |i|
+              indexs[i] ||= 0
+            end
+          end
           indexs[index] += 1
           headlines[index] = m[3].present? ? m[3].strip : m[4].strip
           items.push Item.new(headlines.join('|'), indexs.dup, m[4].strip)
@@ -330,14 +346,19 @@ module ReVIEW
         @index = {}
         @logger = ReVIEW.logger
         items.each do |i|
-          @logger.warn "warning: duplicate ID: #{i.id}" if @index[i.id]
+          if @index[i.id]
+            @logger.warn "warning: duplicate ID: #{i.id}"
+          end
           @index[i.id] = i
         end
       end
 
       def number(id)
         n = @chap.number
-        n = @chap.format_number(false) if @chap.on_appendix? && @chap.number > 0 && @chap.number < 28
+        # XXX: remove magic number (move to lib/review/book/chapter.rb)
+        if @chap.on_appendix? && @chap.number > 0 && @chap.number < 28
+          n = @chap.format_number(false)
+        end
         ([n] + self[id].number).join('.')
       end
     end

data/lib/review/book/part.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2009-2017 Minero Aoki, Kenshi Muto
+# Copyright (c) 2009-2018 Minero Aoki, Kenshi Muto
 #               2002-2008 Minero Aoki
 #
 # This program is free software.
@@ -24,12 +24,15 @@ module ReVIEW
         @content = nil
         if io
           @content = io.read
-        elsif @path && File.exist?(@path)
-          @content = File.read(@path, mode: 'r:BOM|utf-8')
+        elsif @path.present? && File.exist?(File.join(@book.config['contentdir'], @path))
+          @content = File.read(File.join(@book.config['contentdir'], @path), mode: 'r:BOM|utf-8')
           @name = File.basename(@name, '.re')
         end
-        @title = name
-        @title = nil if file?
+        if file?
+          @title = nil
+        else
+          @title = name
+        end
         @volume = nil
       end
 
@@ -48,7 +51,7 @@ module ReVIEW
       end
 
       def file?
-        name.present? and path.end_with?('.re') ? true : false
+        name.present? and path.end_with?('.re')
       end
 
       def format_number(heading = true)

data/lib/review/book.rb

@@ -17,23 +17,9 @@ require 'review/book/volume'
 require 'review/book/index'
 
 module ReVIEW
-  @default_book = nil
-
-  def self.book
-    @default_book ||= Book::Base.load
-  end
-
   module Book
-    def self.load_default
-      Base.load_default
-    end
-
     def self.load(dir)
       Base.load dir
     end
-
-    def self.update_rubyenv(dir)
-      Base.update_rubyenv dir
-    end
   end
 end

data/lib/review/builder.rb

@@ -13,6 +13,8 @@ require 'review/sec_counter'
 require 'stringio'
 require 'cgi'
 require 'fileutils'
+require 'tempfile'
+require 'csv'
 
 module ReVIEW
   class Builder
@@ -35,6 +37,7 @@ module ReVIEW
       @output = nil
       @logger = ReVIEW.logger
       @doc_status = {}
+      @dictionary = {}
       builder_init(*args)
     end
 
@@ -47,10 +50,19 @@ module ReVIEW
       @chapter = chapter
       @location = location
       @output = StringIO.new
-      @book = @chapter.book if @chapter.present?
+      if @chapter.present?
+        @book = @chapter.book
+      end
       @tabwidth = nil
       @tsize = nil
-      @tabwidth = @book.config['tabwidth'] if @book && @book.config && @book.config['tabwidth']
+      if @book && @book.config
+        if @book.config['words_file']
+          load_words(@book.config['words_file'])
+        end
+        if @book.config['tabwidth']
+          @tabwidth = @book.config['tabwidth']
+        end
+      end
       builder_init_file
     end
 
@@ -77,6 +89,16 @@ module ReVIEW
       self.class.to_s.gsub(/ReVIEW::/, '').gsub(/Builder/, '').downcase
     end
 
+    def load_words(file)
+      if File.exist?(file)
+        if file =~ /\.csv\Z/i
+          CSV.foreach(file) do |row|
+            @dictionary[row[0]] = row[1]
+          end
+        end
+      end
+    end
+
     def headline_prefix(level)
       @sec_counter.inc(level)
       anchor = @sec_counter.anchor(level)
@@ -145,7 +167,9 @@ module ReVIEW
       rows = adjust_n_cols(rows)
 
       begin
-        table_header id, caption if caption.present?
+        if caption.present?
+          table_header id, caption
+        end
       rescue KeyError
         error "no such table: #{id}"
       end
@@ -339,6 +363,24 @@ module ReVIEW
       "#{arg}[rotate 90 degree]"
     end
 
+    def inline_balloon(arg)
+      "← #{arg}"
+    end
+
+    def inline_w(s)
+      translated = @dictionary[s]
+      if translated
+        escape(translated)
+      else
+        warn "word not bound: #{s}"
+        escape("[missing word: #{s}]")
+      end
+    end
+
+    def inline_wb(s)
+      inline_b(unescape(inline_w(s)))
+    end
+
     def raw(str)
       if matched = str.match(/\|(.*?)\|(.*)/)
         builders = matched[1].split(',').map { |i| i.gsub(/\s/, '') }
@@ -427,31 +469,71 @@ module ReVIEW
       )
     end
 
-    def graph(lines, id, command, caption = nil)
+    def graph(lines, id, command, caption = '')
       c = target_name
-      dir = File.join(@book.basedir, @book.image_dir, c)
+      dir = File.join(@book.imagedir, c)
       FileUtils.mkdir_p(dir)
       file = "#{id}.#{image_ext}"
       file_path = File.join(dir, file)
 
       line = self.unescape(lines.join("\n"))
-      cmds = {
-        graphviz: "echo '#{line}' | dot -T#{image_ext} -o#{file_path}",
-        gnuplot: %Q(echo 'set terminal ) +
-        "#{image_ext == 'eps' ? 'postscript eps' : image_ext}\n" +
-        %Q( set output "#{file_path}"\n#{line}' | gnuplot),
-        blockdiag: "echo '#{line}' " +
-        "| blockdiag -a -T #{image_ext} -o #{file_path} /dev/stdin",
-        aafigure: "echo '#{line}' | aafigure -t#{image_ext} -o#{file_path}"
-      }
-      cmd = cmds[command.to_sym]
-      warn cmd
-      system cmd
+
+      tf = Tempfile.new('review_graph')
+      tf.puts line
+      tf.close
+      begin
+        file_path = send("graph_#{command}".to_sym, id, file_path, line, tf.path)
+      ensure
+        tf.unlink
+      end
       @chapter.image_index.image_finder.add_entry(file_path)
 
       image(lines, id, caption)
     end
 
+    def system_graph(id, *args)
+      @logger.info args.join(' ')
+      Kernel.system(*args) or @logger.error("failed to run command for id #{id}: #{args.join(' ')}")
+    end
+
+    def graph_graphviz(id, file_path, _line, tf_path)
+      system_graph(id, 'dot', "-T#{image_ext}", "-o#{file_path}", tf_path)
+      file_path
+    end
+
+    def graph_gnuplot(id, file_path, line, tf_path)
+      File.open(tf_path, 'w') do |tf|
+        tf.puts <<EOTGNUPLOT
+set terminal #{image_ext == 'eps' ? 'postscript eps' : image_ext}
+set output "#{file_path}"
+#{line}
+EOTGNUPLOT
+      end
+      system_graph(id, 'gnuplot', tf_path)
+      file_path
+    end
+
+    def graph_blockdiag(id, file_path, _line, tf_path)
+      system_graph(id, 'blockdiag', '-a', '-T', image_ext, '-o', file_path, tf_path)
+      file_path
+    end
+
+    def graph_aafigure(id, file_path, _line, tf_path)
+      system_graph(id, 'aafigure', '-t', image_ext, '-o', file_path, tf_path)
+      file_path
+    end
+
+    def graph_plantuml(id, file_path, _line, tf_path)
+      ext = image_ext
+      if ext == 'pdf'
+        ext = 'eps'
+        file_path.sub!(/\.pdf\Z/, '.eps')
+      end
+      system_graph(id, 'java', '-jar', 'plantuml.jar', "-t#{ext}", '-charset', 'UTF-8', tf_path)
+      FileUtils.mv "#{tf_path}.#{ext}", file_path
+      file_path
+    end
+
     def image_ext
       raise NotImplementedError
     end
@@ -471,7 +553,9 @@ module ReVIEW
       if matched = str.match(/\A\|(.*?)\|(.*)/)
         builders = matched[1].split(',').map { |i| i.gsub(/\s/, '') }
         c = self.class.to_s.gsub('ReVIEW::', '').gsub('Builder', '').downcase
-        @tsize = matched[2] if builders.include?(c)
+        if builders.include?(c)
+          @tsize = matched[2]
+        end
       else
         @tsize = str
       end
@@ -514,5 +598,13 @@ module ReVIEW
         super(str)
       end
     end
+
+    def escape(str)
+      str
+    end
+
+    def unescape(str)
+      str
+    end
   end
 end # module ReVIEW

data/lib/review/catalog.rb

@@ -31,7 +31,22 @@ module ReVIEW
     def parts
       return '' unless @yaml['CHAPS']
 
-      @yaml['CHAPS'].map { |entry| entry.keys if entry.is_a?(Hash) }.flatten.compact.join("\n")
+      part_list = @yaml['CHAPS'].map do |entry|
+        if entry.is_a?(Hash)
+          entry.keys
+        end
+      end
+
+      part_list.flatten.compact.join("\n")
+    end
+
+    def replace_part(old_name, new_name)
+      @yaml['CHAPS'].map! do |e|
+        if e.is_a?(Hash) and (e.keys.first == old_name)
+          e = { new_name => e.values.first }
+        end
+        e
+      end
     end
 
     def parts_with_chaps
@@ -49,7 +64,11 @@ module ReVIEW
       @yaml['POSTDEF'].join("\n")
     end
 
-    def validate!(basedir)
+    def to_s
+      YAML.dump(@yaml).gsub(/\A---\n/, '') # remove yaml header
+    end
+
+    def validate!(config, basedir)
       filenames = []
       if predef.present?
         filenames.concat(predef.split(/\n/))
@@ -73,8 +92,9 @@ module ReVIEW
         filenames.concat(postdef.split(/\n/))
       end
       filenames.each do |filename|
-        unless File.exist?(File.join(basedir, filename))
-          raise FileNotFound, "file not found in catalog.yml: #{basedir}/#{filename}"
+        refile = File.join(basedir, config['contentdir'], filename)
+        unless File.exist?(refile)
+          raise FileNotFound, "file not found in catalog.yml: #{refile}"
         end
       end
     end

data/lib/review/compiler.rb

@@ -198,6 +198,7 @@ module ReVIEW
     definline :recipe
     definline :column
     definline :tcy
+    definline :balloon
 
     definline :abbr
     definline :acronym
@@ -228,9 +229,10 @@ module ReVIEW
     definline :hidx
     definline :comment
     definline :include
-    definline :tcy
     definline :embed
     definline :pageref
+    definline :w
+    definline :wb
 
     private
 

data/lib/review/configure.rb

@@ -1,3 +1,11 @@
+#
+# Copyright (c) 2012-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 'securerandom'
 
 module ReVIEW
@@ -41,6 +49,7 @@ module ReVIEW
         'imgmath' => nil, # for HTML
         'htmlext' => 'html',
         'htmlversion' => 5,
+        'contentdir' => '.',
         'imagedir' => 'images',
         'image_ext' => %w[png gif jpg jpeg svg ttf woff otf],
         'fontdir' => 'fonts',
@@ -51,9 +60,9 @@ module ReVIEW
         'postdef_file' => 'POSTDEF',
         'page_metric' => ReVIEW::Book::PageMetric::A5,
         'ext' => '.re',
-        'image_dir' => 'images',
         'image_types' => %w[.ai .psd .eps .pdf .tif .tiff .png .bmp .jpg .jpeg .gif .svg],
         'bib_file' => 'bib.re',
+        'words_file' => nil,
         'colophon_order' => %w[aut csl trl dsr ill cov edt pbl contact prt],
         'externallink' => true,
         # for IDGXML
@@ -67,9 +76,10 @@ module ReVIEW
         'image_scale2width' => true,
         'footnotetext' => nil,
         'texcommand' => 'uplatex',
+        'texoptions' => '-interaction=nonstopmode -file-line-error',
         'texdocumentclass' => ['jsbook', 'uplatex,oneside'],
         'dvicommand' => 'dvipdfmx',
-        'dvioptions' => '-d 5',
+        'dvioptions' => '-d 5 -z 9',
         # for PDFMaker
         'pdfmaker' => {
           'makeindex' => nil, # Make index page
@@ -87,18 +97,42 @@ module ReVIEW
 
     def [](key)
       maker = self.maker
-      return self.fetch(maker).fetch(key, nil) if maker && self.key?(maker) && self.fetch(maker) && self.fetch(maker).key?(key)
-      return self.fetch(key) if self.key?(key)
+      if maker && self.key?(maker) && self.fetch(maker) && self.fetch(maker).key?(key)
+        return self.fetch(maker).fetch(key, nil)
+      end
+      if self.key?(key)
+        return self.fetch(key)
+      end
       nil
     end
 
-    def check_version(version)
-      raise ReVIEW::ConfigError, 'configuration file has no review_version property.' unless self.key?('review_version')
+    def check_version(version, exception: true)
+      unless self.key?('review_version')
+        if exception
+          raise ReVIEW::ConfigError, 'configuration file has no review_version property.'
+        else
+          return false
+        end
+      end
 
-      return true if self['review_version'].blank?
+      if self['review_version'].blank?
+        return true
+      end
 
-      raise ReVIEW::ConfigError, 'major version of configuration file is different.' if self['review_version'].to_i != version.to_i ## major version
-      raise ReVIEW::ConfigError, "Re:VIEW version '#{version}' is older than configuration file's version '#{self['review_version']}'." if self['review_version'].to_f > version.to_f ## minor version
+      if self['review_version'].to_i != version.to_i ## major version
+        if exception
+          raise ReVIEW::ConfigError, 'major version of configuration file is different.'
+        else
+          return false
+        end
+      elsif self['review_version'].to_f > version.to_f ## minor version
+        if exception
+          raise ReVIEW::ConfigError, "Re:VIEW version '#{version}' is older than configuration file's version '#{self['review_version']}'."
+        else
+          return false
+        end
+      end
+      return true
     end
 
     def name_of(key)

data/lib/review/epubmaker/reviewheaderlistener.rb

@@ -0,0 +1,57 @@
+# Copyright (c) 2010-2018 Kenshi Muto and Masayoshi Takahashi
+#
+# 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".
+#
+module ReVIEW
+  class EPUBMaker
+    class ReVIEWHeaderListener
+      include REXML::StreamListener
+      def initialize(headlines)
+        @level = nil
+        @content = ''
+        @headlines = headlines
+      end
+
+      def tag_start(name, attrs)
+        if name =~ /\Ah(\d+)/
+          raise "#{name}, #{attrs}" if @level.present?
+          @level = $1.to_i
+          @id = attrs['id'] if attrs['id'].present?
+          @notoc = attrs['notoc'] if attrs['notoc'].present?
+        elsif !@level.nil?
+          if name == 'img' && attrs['alt'].present?
+            @content << attrs['alt']
+          elsif name == 'a' && attrs['id'].present?
+            @id = attrs['id']
+          end
+        end
+      end
+
+      def tag_end(name)
+        if name =~ /\Ah\d+/
+          if @id.present?
+            @headlines.push({ 'level' => @level,
+                              'id' => @id,
+                              'title' => @content,
+                              'notoc' => @notoc })
+          end
+          @content = ''
+          @level = nil
+          @id = nil
+          @notoc = nil
+        end
+
+        true
+      end
+
+      def text(text)
+        if @level.present?
+          @content << text.gsub("\t", '　')
+        end
+      end
+    end
+  end
+end