review 2.3.0 → 2.4.0

data/lib/review/book/compilable.rb

@@ -1,8 +1,5 @@
-#
-# $Id: book.rb 4315 2009-09-02 04:15:24Z kmuto $
-#
-# Copyright (c) 2002-2008 Minero Aoki
-#               2009-2017 Minero Aoki, Kenshi Muto
+# Copyright (c) 2009-2017 Minero Aoki, Kenshi Muto
+#               2002-2008 Minero Aoki
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -10,6 +7,7 @@
 # For details of the GNU LGPL, see the file "COPYING".
 #
 require 'review/textutils'
+
 module ReVIEW
   module Book
     module Compilable
@@ -42,7 +40,7 @@ module ReVIEW
         return @title if @title
 
         @title = ''
-        return @title if !content
+        return @title unless content
         content.each_line do |line|
           if line =~ /\A=+/
             @title = line.sub(/\A=+(\[.+?\])?(\{.+?\})?/, '').strip
@@ -57,16 +55,16 @@ module ReVIEW
       end
 
       def volume
-        if !@volume
-          @volume = Volume.count_file(path())
+        unless @volume
+          @volume = Volume.count_file(path)
           @volume.page_per_kbyte = @book.page_metric.page_per_kbyte
         end
         @volume
       end
 
       # deprecated; use content()
-      def open(&block)
-        return (block_given?() ? yield(@io) : @io) if @io
+      def open(&_block)
+        return (block_given? ? yield(@io) : @io) if @io
         StringIO.new(content)
       end
 
@@ -78,59 +76,59 @@ module ReVIEW
 
       def lines
         # FIXME: we cannot duplicate Enumerator on ruby 1.9 HEAD
-        (@lines ||= content().lines.to_a).dup
+        (@lines ||= content.lines.to_a).dup
       end
 
       def list(id)
-        list_index()[id]
+        list_index[id]
       end
 
       def list_index
-        @list_index ||= ListIndex.parse(lines())
+        @list_index ||= ListIndex.parse(lines)
         @list_index
       end
 
       def table(id)
-        table_index()[id]
+        table_index[id]
       end
 
       def table_index
-        @table_index ||= TableIndex.parse(lines())
+        @table_index ||= TableIndex.parse(lines)
         @table_index
       end
 
       def footnote(id)
-        footnote_index()[id]
+        footnote_index[id]
       end
 
       def footnote_index
-        @footnote_index ||= FootnoteIndex.parse(lines())
+        @footnote_index ||= FootnoteIndex.parse(lines)
         @footnote_index
       end
 
       def image(id)
-        return image_index()[id] if image_index().key?(id)
-        return icon_index()[id] if icon_index().key?(id)
-        return numberless_image_index()[id] if numberless_image_index().key?(id)
-        indepimage_index()[id]
+        return image_index[id] if image_index.key?(id)
+        return icon_index[id] if icon_index.key?(id)
+        return numberless_image_index[id] if numberless_image_index.key?(id)
+        indepimage_index[id]
       end
 
       def numberless_image_index
         @numberless_image_index ||=
-          NumberlessImageIndex.parse(lines(), id(),
+          NumberlessImageIndex.parse(lines, id,
                                      "#{book.basedir}/#{@book.config['imagedir']}",
                                      @book.image_types, @book.config['builder'])
       end
 
       def image_index
-        @image_index ||= ImageIndex.parse(lines(), id(),
+        @image_index ||= ImageIndex.parse(lines, id,
                                           "#{book.basedir}/#{@book.config['imagedir']}",
                                           @book.image_types, @book.config['builder'])
         @image_index
       end
 
       def icon_index
-        @icon_index ||= IconIndex.parse(lines(), id(),
+        @icon_index ||= IconIndex.parse(lines, id,
                                         "#{book.basedir}/#{@book.config['imagedir']}",
                                         @book.image_types, @book.config['builder'])
         @icon_index
@@ -138,13 +136,13 @@ module ReVIEW
 
       def indepimage_index
         @indepimage_index ||=
-          IndepImageIndex.parse(lines(), id(),
+          IndepImageIndex.parse(lines, id,
                                 "#{book.basedir}/#{@book.config['imagedir']}",
                                 @book.image_types, @book.config['builder'])
       end
 
       def bibpaper(id)
-        bibpaper_index()[id]
+        bibpaper_index[id]
       end
 
       def bibpaper_index
@@ -154,19 +152,19 @@ module ReVIEW
       end
 
       def headline(caption)
-        headline_index()[caption]
+        headline_index[caption]
       end
 
       def headline_index
-        @headline_index ||= HeadlineIndex.parse(lines(), self)
+        @headline_index ||= HeadlineIndex.parse(lines, self)
       end
 
       def column(id)
-        column_index()[id]
+        column_index[id]
       end
 
       def column_index
-        @column_index ||= ColumnIndex.parse(lines())
+        @column_index ||= ColumnIndex.parse(lines)
       end
 
       def next_chapter
@@ -179,4 +177,3 @@ module ReVIEW
     end
   end
 end
-

data/lib/review/book/image_finder.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2014 Minero Aoki, Kenshi Muto, Masayoshi Takahashi
+# Copyright (c) 2014-2017 Minero Aoki, Kenshi Muto, Masayoshi Takahashi
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -18,28 +18,22 @@ module ReVIEW
         @chapid = chapid
         @builder = builder
         @exts = exts
-        @entries = get_entries()
+        @entries = dir_entries
       end
 
-      def get_entries
-        Dir.glob(File.join(@basedir, "**{,/*/**}/*.*")).uniq
+      def dir_entries
+        Dir.glob(File.join(@basedir, '**{,/*/**}/*.*')).uniq
       end
 
       def add_entry(path)
-        unless @entries.include?(path)
-          @entries << path
-        end
+        @entries << path unless @entries.include?(path)
         @entries
       end
 
       def find_path(id)
         targets = target_list(id)
         targets.each do |target|
-          @exts.each do |ext|
-            if @entries.include?("#{target}#{ext}")
-              return "#{target}#{ext}"
-            end
-          end
+          @exts.each { |ext| return "#{target}#{ext}" if @entries.include?("#{target}#{ext}") }
         end
         nil
       end
@@ -65,7 +59,6 @@ module ReVIEW
           "#{@basedir}/#{id}"
         ]
       end
-
     end
   end
 end

data/lib/review/book/index.rb

@@ -1,7 +1,5 @@
-# encoding: utf-8
-
-# Copyright (c) 2002-2007 Minero Aoki
-#               2008-2017 Minero Aoki, Kenshi Muto
+# Copyright (c) 2008-2017 Minero Aoki, Kenshi Muto
+#               2002-2007 Minero Aoki
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -13,20 +11,19 @@ require 'review/extentions'
 require 'review/exception'
 require 'review/book/image_finder'
 require 'review/i18n'
+require 'review/logger'
 
 module ReVIEW
   module Book
     class Index
-      def Index.parse(src, *args)
+      def self.parse(src, *args)
         items = []
         seq = 1
-        src.grep(%r<^//#{item_type()}>) do |line|
+        src.grep(%r{\A//#{item_type}}) do |line|
           if id = line.slice(/\[(.*?)\]/, 1)
-            items.push item_class().new(id, seq)
+            items.push item_class.new(id, seq)
             seq += 1
-            if id == ""
-              warn "warning: no ID of #{item_type()} in #{line}"
-            end
+            ReVIEW.logger.warn "warning: no ID of #{item_type} in #{line}" if id.empty?
           end
         end
         new(items, *args)
@@ -34,7 +31,7 @@ module ReVIEW
 
       Item = Struct.new(:id, :number)
 
-      def Index.item_class
+      def self.item_class
         self::Item
       end
 
@@ -47,8 +44,9 @@ module ReVIEW
       def initialize(items)
         @items = items
         @index = {}
+        @logger = ReVIEW.logger
         items.each do |i|
-          warn "warning: duplicate ID: #{i.id} (#{i})" unless @index[i.id].nil?
+          @logger.warn "warning: duplicate ID: #{i.id} (#{i})" if @index[i.id]
           @index[i.id] = i
         end
         @image_finder = nil
@@ -57,16 +55,14 @@ module ReVIEW
       def [](id)
         @index.fetch(id)
       rescue
-        if @index.keys.map{|i| i.split(/\|/).last }.flatten. # unfold all ids
-           each_with_object(Hash.new(0)){|i, h| h[i] += 1}. # number of occurrences
-           select{|k, v| k == id && v > 1 }.present? # detect duplicated
+        if @index.keys.map { |i| i.split('|').last }.flatten. # unfold all ids
+           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
 
         @items.each do |i|
-          if i.id.split(/\|/).include?(id)
-            return i
-          end
+          return i if i.id.split('|').include?(id)
         end
         raise KeyError, "not found key '#{id}' for #{self.class}"
       end
@@ -80,12 +76,11 @@ module ReVIEW
       end
 
       def key?(id)
-        return @index.key?(id)
+        @index.key?(id)
       end
       alias_method :has_key?, :key?
     end
 
-
     class ChapterIndex < Index
       def item_type
         'chapter'
@@ -95,7 +90,7 @@ module ReVIEW
         chapter = @index.fetch(id)
         chapter.format_number
       rescue # part
-        "#{I18n.t("part", chapter.number)}"
+        I18n.t('part', chapter.number)
       end
 
       def title(id)
@@ -105,35 +100,32 @@ module ReVIEW
       end
 
       def display_string(id)
-        "#{number(id)}#{I18n.t("chapter_quote", title(id))}"
+        "#{number(id)}#{I18n.t('chapter_quote', title(id))}"
       end
     end
 
-
     class ListIndex < Index
-      def ListIndex.item_type
+      def self.item_type
         '(list|listnum)'
       end
     end
 
-
     class TableIndex < Index
-      def TableIndex.item_type
+      def self.item_type
         '(table|imgtable)'
       end
     end
 
-
     class FootnoteIndex < Index
       Item = Struct.new(:id, :number, :content)
 
-      def FootnoteIndex.parse(src)
+      def self.parse(src)
         items = []
         seq = 1
-        src.grep(%r<^//footnote>) do |line|
+        src.grep(%r{\A//footnote}) do |line|
           if m = /\[(.*?)\]\[(.*)\]/.match(line)
-            m1 = m[1].gsub(/\\(\])/){$1}
-            m2 = m[2].gsub(/\\(\])/){$1}
+            m1 = m[1].gsub(/\\(\])/) { $1 }
+            m2 = m[2].gsub(/\\(\])/) { $1 }
             items.push Item.new(m1, seq, m2)
           end
           seq += 1
@@ -142,31 +134,31 @@ module ReVIEW
       end
     end
 
-
     class ImageIndex < Index
       def self.parse(src, *args)
         items = []
         seq = 1
-        src.grep(%r<^//#{item_type()}>) do |line|
+        src.grep(%r{\A//#{item_type}}) do |line|
           # ex. ["//image", "id", "", "caption"]
           elements = line.split(/\[(.*?)\]/)
           if elements[1].present?
-            if line =~ %r{^//imgtable}
-              items.push item_class().new(elements[1], 0, elements[3])
-            else ## %r<^//(image|graph)>
-              items.push item_class().new(elements[1], seq, elements[3])
+            if line =~ %r{\A//imgtable}
+              items.push item_class.new(elements[1], 0, elements[3])
+            else ## %r<\A//(image|graph)>
+              items.push item_class.new(elements[1], seq, elements[3])
               seq += 1
             end
-            if elements[1] == ""
-              warn "warning: no ID of #{item_type()} in #{line}"
-            end
+            ReVIEW.logger.warn "warning: no ID of #{item_type} in #{line}" if elements[1] == ''
           end
         end
         new(items, *args)
       end
 
-      class Item
+      def self.item_type
+        '(image|graph|imgtable)'
+      end
 
+      class Item
         def initialize(id, number, caption = nil)
           @id = id
           @number = number
@@ -188,10 +180,6 @@ module ReVIEW
         end
       end
 
-      def ImageIndex.item_type
-        '(image|graph|imgtable)'
-      end
-
       attr_reader :image_finder
 
       def initialize(items, chapid, basedir, types, builder)
@@ -203,8 +191,7 @@ module ReVIEW
         @basedir = basedir
         @types = types
 
-        @image_finder = ReVIEW::Book::ImageFinder.new(basedir, chapid,
-                                                      builder, types)
+        @image_finder = ReVIEW::Book::ImageFinder.new(basedir, chapid, builder, types)
       end
 
       def find_path(id)
@@ -216,13 +203,8 @@ module ReVIEW
       def initialize(items, chapid, basedir, types, builder)
         @items = items
         @index = {}
-        items.each do |i|
-          ## warn "warning: duplicate ID: #{i.id} (#{i})" unless @index[i.id].nil?
-          @index[i.id] = i
-        end
-        items.each do |i|
-          i.index = self
-        end
+        items.each { |i| @index[i.id] = i }
+        items.each { |i| i.index = self }
         @chapid = chapid
         @basedir = basedir
         @types = types
@@ -230,12 +212,12 @@ module ReVIEW
         @image_finder = ImageFinder.new(basedir, chapid, builder, types)
       end
 
-      def IconIndex.parse(src, *args)
+      def self.parse(src, *args)
         items = []
         seq = 1
-        src.grep(%r!@<icon>!) do |line|
-          line.gsub(/@<icon>\{(.+?)\}/) do |m|
-            items.push item_class().new($1, seq)
+        src.grep(/@<icon>/) do |line|
+          line.gsub(/@<icon>\{(.+?)\}/) do
+            items.push item_class.new($1, seq)
             seq += 1
           end
         end
@@ -246,13 +228,13 @@ module ReVIEW
     class BibpaperIndex < Index
       Item = Struct.new(:id, :number, :caption)
 
-      def BibpaperIndex.parse(src)
+      def self.parse(src)
         items = []
         seq = 1
-        src.grep(%r<^//bibpaper>) do |line|
+        src.grep(%r{\A//bibpaper}) do |line|
           if m = /\[(.*?)\]\[(.*)\]/.match(line)
-            m1 = m[1].gsub(/\\(.)/){$1}
-            m2 = m[2].gsub(/\\(.)/){$1}
+            m1 = m[1].gsub(/\\(.)/) { $1 }
+            m2 = m[2].gsub(/\\(.)/) { $1 }
             items.push Item.new(m1, seq, m2)
           end
           seq += 1
@@ -262,15 +244,15 @@ module ReVIEW
     end
 
     class NumberlessImageIndex < ImageIndex
-      class Item < ImageIndex::Item
+      def self.item_type
+        'numberlessimage'
       end
 
-      def NumberlessImageIndex.item_type
-        'numberlessimage'
+      class Item < ImageIndex::Item
       end
 
-      def number(id)
-        ""
+      def number(_id)
+        ''
       end
     end
 
@@ -278,12 +260,12 @@ module ReVIEW
       class Item < ImageIndex::Item
       end
 
-      def IndepImageIndex.item_type
+      def self.item_type
         '(indepimage|imgtable)'
       end
 
-      def number(id)
-        ""
+      def number(_id)
+        ''
       end
     end
 
@@ -292,45 +274,48 @@ module ReVIEW
       Item = Struct.new(:id, :number, :caption)
       attr_reader :items
 
-      def HeadlineIndex.parse(src, chap)
+      def self.parse(src, chap)
         items = []
         indexs = []
         headlines = []
         inside_column = false
+        inside_block = nil
         src.each do |line|
-          if m = HEADLINE_PATTERN.match(line)
-            next if m[1].size > 10 # Ignore too deep index
-            index = m[1].size - 2
-
-            # column
-            if m[2] == 'column'
-              inside_column = true
-              next
-            end
-            if m[2] == '/column'
-              inside_column = false
-              next
-            end
-            if indexs.blank? || index <= indexs[-1]
-              inside_column = false
-            end
-            if inside_column
-              next
-            end
+          if line =~ %r{\A//[a-z]+.*\{\Z}
+            inside_block = true
+            next
+          elsif line =~ %r{\A//\}}
+            inside_block = nil
+            next
+          elsif inside_block
+            next
+          end
 
-            if index >= 0
-              if indexs.size > (index + 1)
-                indexs = indexs.take(index + 1)
-                headlines = headlines.take(index + 1)
-              end
-              if indexs[index].nil?
-                (0..index).each{|i| indexs[i] = 0 if indexs[i].nil?}
-              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)
-            end
+          m = HEADLINE_PATTERN.match(line)
+          next if m.nil? || m[1].size > 10 # Ignore too deep index
+          next if m[4].strip.empty? # no title
+          index = m[1].size - 2
+
+          # column
+          if m[2] == 'column'
+            inside_column = true
+            next
+          elsif m[2] == '/column'
+            inside_column = false
+            next
+          end
+          inside_column = false if indexs.blank? || index <= indexs[-1]
+          next if inside_column
+
+          next unless index >= 0
+          if indexs.size > (index + 1)
+            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?
+          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)
         end
         new(items, chap)
       end
@@ -340,17 +325,15 @@ module ReVIEW
         @chap = chap
         @index = {}
         items.each do |i|
-          warn "warning: duplicate ID: #{i.id}" unless @index[i.id].nil?
+          @logger.warn "warning: duplicate ID: #{i.id}" if @index[i.id]
           @index[i.id] = i
         end
       end
 
       def number(id)
         n = @chap.number
-        if @chap.on_APPENDIX? && @chap.number > 0 && @chap.number < 28
-          n = @chap.format_number(false)
-        end
-        return ([n] + self[id].number).join(".")
+        n = @chap.format_number(false) if @chap.on_appendix? && @chap.number > 0 && @chap.number < 28
+        ([n] + self[id].number).join('.')
       end
     end
 
@@ -358,26 +341,22 @@ module ReVIEW
       COLUMN_PATTERN = /\A(=+)\[column\](?:\{(.+?)\})?(.*)/
       Item = Struct.new(:id, :number, :caption)
 
-      def ColumnIndex.parse(src, *args)
+      def self.parse(src, *_args)
         items = []
         seq = 1
         src.each do |line|
-          if m = COLUMN_PATTERN.match(line)
-            _level = m[1] ## not use it yet
-            id = m[2]
-            caption = m[3].strip
-            if !id || id == ""
-              id = caption
-            end
-
-            items.push item_class().new(id, seq, caption)
-            seq += 1
-          end
+          m = COLUMN_PATTERN.match(line)
+          next unless m
+          _level = m[1] ## not use it yet
+          id = m[2]
+          caption = m[3].strip
+          id = caption if id.nil? || id.empty?
+
+          items.push item_class.new(id, seq, caption)
+          seq += 1
         end
         new(items)
       end
-
     end
-
   end
 end