review 2.1.0 → 2.2.0

data/lib/epubmaker/zip_exporter.rb

@@ -0,0 +1,86 @@
+# encoding: utf-8
+#
+# Copyright (c) 2010-2016 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".
+#
+
+require 'pathname'
+begin
+  require 'zip'
+rescue LoadError
+  ## I cannot find rubyzip library, so I use external zip command.
+  warn "rubyzip not found, so use external zip command"
+end
+
+module EPUBMaker
+
+  ##
+  # Export into zip file for EPUB producer.
+  #
+  class ZipExporter
+
+    attr_reader :tmpdir
+
+    def initialize(tmpdir, params)
+      @tmpdir = tmpdir
+      @params = params
+    end
+
+    def export_zip(epubfile)
+      if defined?(Zip)
+        export_zip_rubyzip(epubfile)
+      else
+        export_zip_extcmd(epubfile)
+      end
+    end
+
+    def export_zip_extcmd(epubfile)
+      stage1 = @params["epubmaker"]["zip_stage1"].to_s.split
+      path1 = stage1[0] || "zip"
+      opt1 = stage1[1] || "-0Xq"
+      stage2 = @params["epubmaker"]["zip_stage2"].to_s.split
+      path2 = stage2[0] || "zip"
+      opt2 = stage2[1] || "-Xr9Dq"
+
+      Dir.chdir(tmpdir) do |d|
+        system(path1, opt1, epubfile, "mimetype")
+        addpath = @params["epubmaker"]["zip_addpath"]
+        if addpath
+          system(path2, opt2, epubfile, "META-INF", "OEBPS", addpath)
+        else
+          system(path2, opt2, epubfile, "META-INF", "OEBPS")
+        end
+      end
+    end
+
+    def export_zip_rubyzip(epubfile)
+      Dir.chdir(tmpdir) do |d|
+        Zip::OutputStream.open(epubfile) do |epub|
+          root_pathname = Pathname.new(tmpdir)
+          # relpath = Pathname.new(File.join(tmpdir,'mimetype')).relative_path_from(root_pathname)
+          epub.put_next_entry('mimetype', nil, nil, Zip::Entry::STORED)
+          epub << "application/epub+zip"
+
+          export_zip_rubyzip_addpath(epub, File.join(tmpdir,'META-INF'), root_pathname)
+          export_zip_rubyzip_addpath(epub, File.join(tmpdir,'OEBPS'), root_pathname)
+          if @params["zip_addpath"].present?
+            export_zip_rubyzip_addpath(epub, File.join(tmpdir, @params["zip_addpath"]), root_pathname)
+          end
+        end
+      end
+    end
+
+    def export_zip_rubyzip_addpath(epub, dirname, rootdir)
+      Dir[File.join(dirname,'**','**')].each do |path|
+        next if File.directory?(path)
+        relpath = Pathname.new(path).relative_path_from(rootdir)
+        epub.put_next_entry(relpath)
+        epub << File.binread(path)
+      end
+    end
+  end
+end

data/lib/review/book/base.rb

@@ -15,6 +15,9 @@ module ReVIEW
     class Base
 
       attr_writer :config
+      attr_writer :parts
+      attr_writer :catalog
+      attr_reader :basedir
 
       def self.load_default
         warn 'Book::Base.load_default() is obsoleted. Use Book::Base.load().'
@@ -51,6 +54,7 @@ module ReVIEW
         @config = ReVIEW::Configure.values
         @catalog = nil
         @read_part = nil
+        @warn_old_files = {} # XXX for checking CHAPS, PREDEF, POSTDEF
       end
 
       def bib_file
@@ -99,10 +103,6 @@ module ReVIEW
         @parts ||= read_parts()
       end
 
-      def parts=(parts)
-        @parts = parts
-      end
-
       def parts_in_file
         parts.find_all{|part|
           part if part.present? and part.file?
@@ -198,10 +198,6 @@ module ReVIEW
         @catalog
       end
 
-      def catalog=(catalog)
-        @catalog = catalog
-      end
-
       def read_CHAPS
         if catalog
           catalog.chaps
@@ -298,10 +294,6 @@ module ReVIEW
         end
       end
 
-      def basedir
-        @basedir
-      end
-
       private
 
       def read_parts
@@ -344,9 +336,9 @@ module ReVIEW
           end
         end
 
-        chap = read_CHAPS()\
-               .strip.lines.map {|line| line.strip }.join("\n").split(/\n{2,}/)\
-               .map {|part_chunk|
+        chap = read_CHAPS().
+               strip.lines.map {|line| line.strip }.join("\n").split(/\n{2,}/).
+               map {|part_chunk|
           chaps = part_chunk.split.map {|chapid|
             Chapter.new(self, (num += 1), chapid, "#{@basedir}/#{chapid}")
           }
@@ -396,6 +388,12 @@ module ReVIEW
       end
 
       def read_FILE(filename)
+        if !@warn_old_files[filename]
+          @warn_old_files[filename] = true
+          if !caller().any?{|item| item =~ %r|/review/test/test_|}
+            warn "!!! #{filename} is obsoleted. please use catalog.yml."
+          end
+        end
         res = ""
         File.open("#{@basedir}/#{filename}", 'r:BOM|utf-8') do |f|
           while line = f.gets

data/lib/review/book/chapter.rb

@@ -83,7 +83,7 @@ module ReVIEW
           return "#{@number}" if @number < 1 || @number > 27
           if @book.config["appendix_format"]
             raise ReVIEW::ConfigError,
-            "'appendix_format:' in config.yml is obsoleted."
+                  "'appendix_format:' in config.yml is obsoleted."
           end
 
           i18n_appendix = I18n.get("appendix")
@@ -121,6 +121,7 @@ module ReVIEW
       end
 
       private
+
       def on_FILE?(contents)
         contents.lines.map(&:strip).include?("#{id()}#{@book.ext()}")
       end

data/lib/review/book/compilable.rb

@@ -2,7 +2,7 @@
 # $Id: book.rb 4315 2009-09-02 04:15:24Z kmuto $
 #
 # Copyright (c) 2002-2008 Minero Aoki
-#               2009 Minero Aoki, Kenshi Muto
+#               2009-2017 Minero Aoki, Kenshi Muto
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -118,29 +118,29 @@ module ReVIEW
       def numberless_image_index
         @numberless_image_index ||=
           NumberlessImageIndex.parse(lines(), id(),
-          "#{book.basedir}/#{@book.image_dir}",
-          @book.image_types, @book.config['builder'])
+                                     "#{book.basedir}/#{@book.config['imagedir']}",
+                                     @book.image_types, @book.config['builder'])
       end
 
       def image_index
         @image_index ||= ImageIndex.parse(lines(), id(),
-          "#{book.basedir}/#{@book.image_dir}",
-          @book.image_types, @book.config['builder'])
+                                          "#{book.basedir}/#{@book.config['imagedir']}",
+                                          @book.image_types, @book.config['builder'])
         @image_index
       end
 
       def icon_index
         @icon_index ||= IconIndex.parse(lines(), id(),
-          "#{book.basedir}/#{@book.image_dir}",
-          @book.image_types, @book.config['builder'])
+                                        "#{book.basedir}/#{@book.config['imagedir']}",
+                                        @book.image_types, @book.config['builder'])
         @icon_index
       end
 
       def indepimage_index
         @indepimage_index ||=
           IndepImageIndex.parse(lines(), id(),
-          "#{book.basedir}/#{@book.image_dir}",
-          @book.image_types, @book.config['builder'])
+                                "#{book.basedir}/#{@book.config['imagedir']}",
+                                @book.image_types, @book.config['builder'])
       end
 
       def bibpaper(id)

data/lib/review/book/image_finder.rb

@@ -22,7 +22,7 @@ module ReVIEW
       end
 
       def get_entries
-        Dir.glob(File.join(@basedir, "**/*.*"))
+        Dir.glob(File.join(@basedir, "**{,/*/**}/*.*")).uniq
       end
 
       def add_entry(path)
@@ -46,23 +46,23 @@ module ReVIEW
 
       def target_list(id)
         [
-         # 1. <basedir>/<builder>/<chapid>/<id>.<ext>
-         "#{@basedir}/#{@builder}/#{@chapid}/#{id}",
+          # 1. <basedir>/<builder>/<chapid>/<id>.<ext>
+          "#{@basedir}/#{@builder}/#{@chapid}/#{id}",
 
-         # 2. <basedir>/<builder>/<chapid>-<id>.<ext>
-         "#{@basedir}/#{@builder}/#{@chapid}-#{id}",
+          # 2. <basedir>/<builder>/<chapid>-<id>.<ext>
+          "#{@basedir}/#{@builder}/#{@chapid}-#{id}",
 
-         # 3. <basedir>/<builder>/<id>.<ext>
-         "#{@basedir}/#{@builder}/#{id}",
+          # 3. <basedir>/<builder>/<id>.<ext>
+          "#{@basedir}/#{@builder}/#{id}",
 
-         # 4. <basedir>/<chapid>/<id>.<ext>
-         "#{@basedir}/#{@chapid}/#{id}",
+          # 4. <basedir>/<chapid>/<id>.<ext>
+          "#{@basedir}/#{@chapid}/#{id}",
 
-         # 5. <basedir>/<chapid>-<id>.<ext>
-         "#{@basedir}/#{@chapid}-#{id}",
+          # 5. <basedir>/<chapid>-<id>.<ext>
+          "#{@basedir}/#{@chapid}-#{id}",
 
-         # 6. <basedir>/<id>.<ext>
-         "#{@basedir}/#{id}"
+          # 6. <basedir>/<id>.<ext>
+          "#{@basedir}/#{id}"
         ]
       end
 

data/lib/review/book/index.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 #
 # Copyright (c) 2002-2007 Minero Aoki
-#               2008-2009 Minero Aoki, Kenshi Muto
+#               2008-2017 Minero Aoki, Kenshi Muto
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -58,7 +58,7 @@ module ReVIEW
         @index.fetch(id)
       rescue
         if @index.keys.map{|i| i.split(/\|/).last }.flatten. # unfold all ids
-           reduce(Hash.new(0)){|h, i| h[i] += 1; h}. # number of occurrences
+           each_with_object(Hash.new(0)){|i, h| h[i] += 1}. # number of occurrences
            select{|k, v| k == id && v > 1 }.present? # detect duplicated
           raise KeyError, "key '#{id}' is ambiguous for #{self.class}"
         end

data/lib/review/book/volume.rb

@@ -58,8 +58,8 @@ module ReVIEW
 
       def +(other)
         Volume.new(@bytes + other.bytes,
-          @chars + other.chars,
-          @lines + other.lines)
+                   @chars + other.chars,
+                   @lines + other.lines)
       end
 
     end

data/lib/review/builder.rb

@@ -25,6 +25,7 @@ module ReVIEW
     def pre_paragraph
       nil
     end
+
     def post_paragraph
       nil
     end
@@ -46,6 +47,7 @@ module ReVIEW
       @output = StringIO.new
       @book = @chapter.book if @chapter.present?
       @tabwidth = nil
+      @tsize = nil
       if @book && @book.config && @book.config["tabwidth"]
         @tabwidth = @book.config["tabwidth"]
       end
@@ -83,6 +85,21 @@ module ReVIEW
     end
     private :headline_prefix
 
+    ## for //firstlinenum[num]
+    def firstlinenum(num)
+      @first_line_num = num.to_i
+    end
+
+    def get_line_num
+      if !@first_line_num
+        return 1
+      end
+      line_num = @first_line_num
+      @first_line_num = nil
+
+      line_num
+    end
+
     def list(lines, id, caption, lang = nil)
       begin
         list_header id, caption, lang
@@ -327,6 +344,20 @@ module ReVIEW
       end
     end
 
+    def embed(lines, arg = nil)
+      if arg
+        builders = arg.gsub(/^\s*\|/, "").gsub(/\|\s*$/, "").gsub(/\s/, "").split(/,/)
+        c = target_name
+        if builders.include?(c)
+          print lines.join()
+        else
+          ""
+        end
+      else
+        print lines.join()
+      end
+    end
+
     def warn(msg)
       $stderr.puts "#{@location}: warning: #{msg}"
     end
@@ -350,7 +381,7 @@ module ReVIEW
       params.each do |param|
         if param =~ /\A.+?::/
           if param =~ /\A#{type}::/
-              param.sub!(/\A#{type}::/, '')
+            param.sub!(/\A#{type}::/, '')
           else
             next
           end
@@ -435,6 +466,18 @@ module ReVIEW
     def ul_item_end
     end
 
+    def tsize(str)
+      if matched = str.match(/\A\|(.*?)\|(.*)/)
+        builders = matched[1].split(/,/).map{|i| i.gsub(/\s/, '') }
+        c = self.class.to_s.gsub(/ReVIEW::/, '').gsub(/Builder/, '').downcase
+        if builders.include?(c)
+          @tsize = matched[2]
+        end
+      else
+        @tsize = str
+      end
+    end
+
     def inline_raw(args)
       if matched = args.match(/\|(.*?)\|(.*)/)
         builders = matched[1].split(/,/).map{|i| i.gsub(/\s/, '') }
@@ -449,6 +492,19 @@ module ReVIEW
       end
     end
 
+    def inline_embed(args)
+      if matched = args.match(/\|(.*?)\|(.*)/)
+        builders = matched[1].split(/,/).map{|i| i.gsub(/\s/, '') }
+        if builders.include?(target_name)
+          matched[2]
+        else
+          ""
+        end
+      else
+        args
+      end
+    end
+
     ## override TextUtils::detab
     def detab(str, num = nil)
       if num

data/lib/review/catalog.rb

@@ -35,12 +35,12 @@ module ReVIEW
         if entry.is_a? Hash
           entry.keys
         end
-      }.flatten.reject{|entry| entry.nil?}.join("\n")
+      }.flatten.compact.join("\n")
     end
 
     def parts_with_chaps
       return "" unless @yaml["CHAPS"]
-      @yaml["CHAPS"].flatten.reject{|entry| entry.nil?}
+      @yaml["CHAPS"].flatten.compact
     end
 
     def appendix

data/lib/review/compiler.rb

@@ -161,6 +161,7 @@ module ReVIEW
     defblock :tip, 0..1
     defblock :box, 0..1
     defblock :comment, 0..1, true
+    defblock :embed, 0..1
 
     defsingle :footnote, 2
     defsingle :noindent, 0
@@ -175,6 +176,7 @@ module ReVIEW
     defsingle :tsize, 1
     defsingle :include, 1
     defsingle :olnum, 1
+    defsingle :firstlinenum, 1
 
     definline :chapref
     definline :chap
@@ -229,11 +231,12 @@ module ReVIEW
     definline :comment
     definline :include
     definline :tcy
+    definline :embed
 
     private
 
     def do_compile
-      f = LineInput.new(Preprocessor::Strip.new(StringIO.new(@chapter.content)))
+      f = LineInput.new(StringIO.new(@chapter.content))
       @strategy.bind self, @chapter, Location.new(@chapter.basename, f)
       tagged_section_init
       while f.next?
@@ -265,7 +268,7 @@ module ReVIEW
           warn "`//' seen but is not valid command: #{line.strip.inspect}"
           if block_open?(line)
             warn "skipping block..."
-            read_block(f)
+            read_block(f, false)
           end
         else
           if f.peek.strip.empty?
@@ -431,8 +434,9 @@ module ReVIEW
     def read_command(f)
       line = f.gets
       name = line.slice(/[a-z]+/).to_sym
+      ignore_inline = (name == :embed)
       args = parse_args(line.sub(%r<\A//[a-z]+>, '').rstrip.chomp('{'), name)
-      lines = block_open?(line) ? read_block(f) : nil
+      lines = block_open?(line) ? read_block(f, ignore_inline) : nil
       return name, args, lines
     end
 
@@ -440,12 +444,16 @@ module ReVIEW
       line.rstrip[-1,1] == '{'
     end
 
-    def read_block(f)
+    def read_block(f, ignore_inline)
       head = f.lineno
       buf = []
       f.until_match(%r<\A//\}>) do |line|
-        unless line =~ /\A\#@/
-          buf.push text(line.rstrip)
+        if ignore_inline
+          buf.push line
+        else
+          unless line =~ /\A\#@/
+            buf.push text(line.rstrip)
+          end
         end
       end
       unless %r<\A//\}> =~ f.peek
@@ -523,7 +531,7 @@ module ReVIEW
       end
       result = @strategy.nofunc_text(words.shift)
       until words.empty?
-        result << compile_inline(words.shift.gsub(/\\\}/, '}'))
+        result << compile_inline(words.shift.gsub(/\\\}/, '}').gsub(/\\\\/, '\\'))
         result << @strategy.nofunc_text(words.shift)
       end
       result