review 1.0.0 → 1.1.0

data/lib/review/book/part.rb

@@ -0,0 +1,44 @@
+#
+# $Id: book.rb 4315 2009-09-02 04:15:24Z kmuto $
+#
+# Copyright (c) 2002-2008 Minero Aoki
+#               2009 Minero Aoki, 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 'review/book/compilable'
+module ReVIEW
+  module Book
+    class Part
+      include Compilable
+
+      def initialize(book, number, chapters, name="")
+        @book = book
+        @number = number
+        @chapters = chapters
+        @path = name
+        @name = name ? File.basename(name, '.*') : nil
+      end
+
+      attr_reader :number
+      attr_reader :chapters
+      attr_reader :name
+
+      def each_chapter(&block)
+        @chapters.each(&block)
+      end
+
+      def volume
+        Volume.sum(@chapters.map {|chap| chap.volume })
+      end
+
+      def file?
+        (name.present? and path =~ /\.re\z/) ? true : false
+      end
+
+    end
+  end
+end

data/lib/review/book/volume.rb

@@ -0,0 +1,65 @@
+#
+# $Id: volume.rb 3883 2008-02-10 11:48:23Z aamine $
+#
+# Copyright (c) 2002-2007 Minero Aoki
+#
+# 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
+  module Book
+    class Volume
+
+      def Volume.count_file(path)
+        b = c = l = 0
+        File.foreach(path) do |line|
+          next if %r<\A\#@> =~ line
+          text = line.gsub(/\s+/, '')
+          b += text.bytesize
+          c += text.charsize
+          l += 1
+        end
+        new(b, c, l)
+      end
+
+      def Volume.sum(vols)
+        vols.inject(new()) {|sum, i| sum + i }
+      end
+
+      def Volume.dummy
+        new(-1, -1, -1)
+      end
+
+      def initialize(bytes = 0, chars = 0, lines = 0)
+        @bytes = bytes
+        @chars = chars
+        @lines = lines
+      end
+
+      attr_reader :bytes
+      attr_reader :chars
+      attr_accessor :lines
+
+      def kbytes
+        (@bytes.to_f / 1024).ceil
+      end
+
+      def page
+        (kbytes.to_f/ReVIEW.book.page_metric.page_per_kbyte).ceil
+      end
+
+      def to_s
+        "#{kbytes()}KB #{@chars}C #{@lines}L #{page()}P"
+      end
+
+      def +(other)
+        Volume.new(@bytes + other.bytes,
+          @chars + other.chars,
+          @lines + other.lines)
+      end
+
+    end
+  end
+end

data/lib/review/builder.rb

@@ -7,15 +7,17 @@
 # the GNU LGPL, Lesser General Public License version 2.1.
 #
 
-require 'review/index'
+require 'review/book/index'
 require 'review/exception'
+require 'review/textutils'
 require 'stringio'
-require 'nkf'
 require 'cgi'
 
 module ReVIEW
 
   class Builder
+    include TextUtils
+
     CAPTION_TITLES = %w(note memo tip info planning best important security caution term link notice point shoot reference practice expert)
 
     def pre_paragraph
@@ -27,6 +29,10 @@ module ReVIEW
 
     def initialize(strict = false, *args)
       @strict = strict
+      @tabwidth = nil
+      if ReVIEW.book.param && ReVIEW.book.param["tabwidth"]
+        @tabwidth = ReVIEW.book.param["tabwidth"]
+      end
       builder_init(*args)
     end
 
@@ -53,28 +59,16 @@ module ReVIEW
 
     alias :raw_result result
 
-    def convert_outencoding(*s)
-      if ReVIEW.book.param["outencoding"] =~ /^EUC$/i
-        NKF.nkf("-W, -e", *s)
-      elsif ReVIEW.book.param["outencoding"] =~ /^SJIS$/i
-        NKF.nkf("-W, -s", *s)
-      elsif ReVIEW.book.param["outencoding"] =~ /^JIS$/i
-        NKF.nkf("-W, -j", *s)
-      else
-        ## for 1.9 compatibility
-        if s.size == 1
-          return s[0]
-        end
-        return *s
-      end
-    end
-
     def print(*s)
-      @output.print(convert_outencoding(*s))
+      @output.print *s.map{|i|
+        convert_outencoding(i, ReVIEW.book.param["outencoding"])
+      }
     end
 
     def puts(*s)
-      @output.puts(convert_outencoding(*s))
+      @output.puts *s.map{|i|
+        convert_outencoding(i, ReVIEW.book.param["outencoding"])
+      }
     end
 
     def list(lines, id, caption)
@@ -83,7 +77,7 @@ module ReVIEW
       rescue KeyError
         error "no such list: #{id}"
       end
-      list_body lines
+      list_body id, lines
     end
 
     def listnum(lines, id, caption)
@@ -230,7 +224,9 @@ module ReVIEW
     end
 
     def inline_ruby(arg)
-      base, ruby = *arg.split(',', 2)
+      base, *ruby = *arg.scan(/(?:(?:(?:\\\\)*\\,)|[^,\\]+)+/)
+      base = base.gsub(/\\,/, ",") if base
+      ruby = ruby.join(",").gsub(/\\,/, ",") if ruby
       compile_ruby(base, ruby)
     end
 
@@ -276,7 +272,6 @@ module ReVIEW
           ""
         end
       else
-        warn "It is recommended to set builder(s)."
         print str.gsub("\\n", "\n")
       end
     end
@@ -327,7 +322,7 @@ module ReVIEW
     end
 
     def parse_metric(type, metric)
-      return "" if metric.nil? || metric.empty?
+      return "" if metric.blank?
       params = metric.split(/,\s*/)
       results = []
       params.each do |p|
@@ -352,7 +347,7 @@ module ReVIEW
     end
 
     def extract_chapter_id(chap_ref)
-      m = /\A(\w+)\|(.+)/.match(chap_ref)
+      m = /\A([\w+-]+)\|(.+)/.match(chap_ref)
       if m
         return [@book.chapters.detect{|chap| chap.id == m[1]}, m[2]]
       else
@@ -405,27 +400,16 @@ module ReVIEW
     end
 
     def inline_include(file_name)
-      enc = inencoding()
-      compile_inline NKF.nkf("--#{enc}", File.open(file_name).read)
+      compile_inline convert_inencoding(File.open(file_name).read,
+                                        ReVIEW.book.param["inencoding"])
     end
 
     def include(file_name)
-      enc = inencoding()
       File.foreach(file_name) do |line|
-        paragraph([NKF.nkf("--#{enc}", line)])
+        paragraph([convert_inencoding(line, ReVIEW.book.param["inencoding"])])
       end
     end
 
-    def inencoding
-      if ReVIEW.book.param["inencoding"].nil?
-        enc = "utf8"
-      else
-        # UTF-8, SJIS, EUC => utf8, sjis, euc
-        enc = ReVIEW.book.param["inencoding"].gsub(/-/, '').downcase
-      end
-    end
-    private :inencoding
-
     def ul_item_begin(lines)
       ul_item(lines)
     end
@@ -443,10 +427,20 @@ module ReVIEW
           ""
         end
       else
-        warn "It is recommended to set builder(s)."
         args.gsub("\\n", "\n")
       end
     end
+
+    ## override TextUtils::detab
+    def detab(str, num = nil)
+      if num
+        super(str, num)
+      elsif @tabwidth
+        super(str, @tabwidth)
+      else
+        super(str)
+      end
+    end
   end
 
 end   # module ReVIEW

data/lib/review/compiler.rb

@@ -8,7 +8,7 @@
 # the GNU LGPL, Lesser General Public License version 2.1.
 #
 
-require 'review/compat'
+require 'review/extentions'
 require 'review/preprocessor'
 require 'review/exception'
 require 'lineinput'
@@ -136,7 +136,7 @@ module ReVIEW
     defblock :table, 0..2
     defblock :quote, 0
     defblock :image, 2..3, true
-    defblock :source, 1
+    defblock :source, 0..1
     defblock :listnum, 2
     defblock :emlistnum, 0..1
     defblock :bibpaper, 2..3, true
@@ -149,11 +149,12 @@ module ReVIEW
     defblock :blockquote, 0
     defblock :bpo, 0
     defblock :flushright, 0
+    defblock :centering, 0
     defblock :note, 0..1
     defblock :box, 0..1
+    defblock :comment, 0..1, true
 
     defsingle :footnote, 2
-    defsingle :comment, 1
     defsingle :noindent, 0
     defsingle :linebreak, 0
     defsingle :pagebreak, 0
@@ -165,6 +166,7 @@ module ReVIEW
     defsingle :raw, 1
     defsingle :tsize, 1
     defsingle :include, 1
+    defsingle :olnum, 1
 
     definline :chapref
     definline :chap
@@ -224,6 +226,8 @@ module ReVIEW
       tagged_section_init
       while f.next?
         case f.peek
+        when /\A\#@/
+          f.gets # Nothing to do
         when /\A=+[\[\s\{]/
           compile_headline f.gets
         when %r<\A\s+\*>
@@ -280,7 +284,6 @@ module ReVIEW
           unless prev_tag_info.first == open_tag
             raise CompileError, "#{open_tag} is not opened."
           end
-          @strategy.warn("It is not recommended to use \"#{line.chomp}\"")
           close_tagged_section(*prev_tag_info)
         end
       else
@@ -340,7 +343,8 @@ module ReVIEW
 
     def compile_ulist(f)
       level = 0
-      f.while_match(/\A\s+\*/) do |line|
+      f.while_match(/\A\s+\*|\A\#@/) do |line|
+        next if line =~ /\A\#@/
 
         buf = [text(line.sub(/\*+/, '').strip)]
         f.while_match(/\A\s+(?!\*)\S/) do |cont|
@@ -368,8 +372,8 @@ module ReVIEW
           (1..level_diff).to_a.reverse.each do |i|
             @strategy.ul_item_end
             @strategy.ul_end {level + i}
-            @strategy.ul_item_end
           end
+          @strategy.ul_item_end
           # body
           @strategy.ul_item_begin buf
         end
@@ -383,7 +387,9 @@ module ReVIEW
 
     def compile_olist(f)
       @strategy.ol_begin
-      f.while_match(/\A\s+\d+\./) do |line|
+      f.while_match(/\A\s+\d+\.|\A\#@/) do |line|
+        next if line =~ /\A\#@/
+
         num = line.match(/(\d+)\./)[1]
         buf = [text(line.sub(/\d+\./, '').strip)]
         f.while_match(/\A\s+(?!\d+\.)\S/) do |cont|
@@ -406,7 +412,7 @@ module ReVIEW
 
     def compile_paragraph(f)
       buf = []
-      f.until_match(%r<\A//>) do |line|
+      f.until_match(%r<\A//|\A\#@|\A===+>) do |line|
         break if line.strip.empty?
         buf.push text(line.sub(/^(\t+)\s*/) {|m| "<!ESCAPETAB!>" * m.size}.strip.gsub(/<!ESCAPETAB!>/, "\t"))
       end
@@ -429,7 +435,9 @@ module ReVIEW
       head = f.lineno
       buf = []
       f.until_match(%r<\A//\}>) do |line|
-        buf.push text(line.rstrip)
+        unless line =~ /\A\#@/
+          buf.push text(line.rstrip)
+        end
       end
       unless %r<\A//\}> =~ f.peek
         error "unexpected EOF (block begins at: #{head})"
@@ -441,11 +449,20 @@ module ReVIEW
 
     def parse_args(str, name=nil)
       return [] if str.empty?
-      unless str[0,1] == '[' and str[-1,1] == ']'
-        error "argument syntax error: #{str.inspect}"
+      scanner = StringScanner.new(str)
+      words = []
+      while word = scanner.scan(/(\[\]|\[.*?[^\\]\])/)
+        w2 = word[1..-2].gsub(/\\(.)/){
+          ch = $1
+          (ch == "]" or ch == "\\") ? ch : "\\" + ch
+        }
+        words << w2
+      end
+      if !scanner.eos?
+        error "argument syntax error: #{scanner.rest} in #{str.inspect}"
         return []
       end
-      str[1..-2].split('][', -1)
+      return words
     end
 
     def compile_command(syntax, args, lines)
@@ -458,7 +475,7 @@ module ReVIEW
         syntax.check_args args
       rescue CompileError => err
         error err.message
-        args = ['(NoArgument)'] * SYNTAX[name].min_argc
+        args = ['(NoArgument)'] * syntax.min_argc
       end
       if syntax.block_allowed?
         compile_block syntax, args, lines
@@ -501,6 +518,8 @@ module ReVIEW
         result << @strategy.nofunc_text(words.shift)
       end
       result
+    rescue => err
+      error err.message
     end
     public :text   # called from strategy
 

data/lib/review/configure.rb

@@ -0,0 +1,38 @@
+# -*- coding: utf-8 -*-
+module ReVIEW
+  class Configure
+    def self.values
+      { # These parameters can be overridden by YAML file.
+        "bookname"=> "example", # it defines epub file name also
+        "booktitle" => "ReVIEW EPUBサンプル",
+        "title" => "example",
+        "aut" => nil, # author
+        "prt" => nil, # printer(publisher)
+        "asn" => nil, # associated name
+        "ant" => nil, # bibliographic antecedent
+        "clb" => nil, # Collaborator
+        "edt" => nil, # Editor
+        "dsr" => nil, # Designer
+        "ill" => nil, # Illustrator
+        "pht" => nil, # Photographer
+        "trl" => nil, # Translator
+        "date" => nil, # publishing date
+        "rights" => nil, # Copyright messages
+        "description" => nil, # Description
+        "urnid" => nil, # Identifier (nil makes random uuid)
+        "stylesheet" => "stylesheet.css", # stylesheet file
+        "coverfile" => nil, # content file of body of cover page
+        "mytoc" => nil, # whether make own table of contents or not
+        "params" => "", # specify review2html parameters
+        "toclevel" => 3, # level of toc
+        "secnolevel" => 2, # level of section #
+        "posthook" => nil, # command path of post hook
+        "epubversion" => 2,
+        "titlepage" => true, # Use title page
+        "toc" => true, # Use table of contents
+        "colophon" => false, # Use colophon
+        "debug" => nil, # debug flag
+      }
+    end
+  end
+end