review 2.3.0 → 2.4.0

data/lib/review/sec_counter.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 # Copyright (c) 2008-2017 Minero Aoki, Kenshi Muto, Masayoshi Takahashi,
 #                         KADO Masanori
 #
@@ -9,7 +7,6 @@
 #
 
 module ReVIEW
-
   # Secion Counter class
   #
   class SecCounter
@@ -24,21 +21,13 @@ module ReVIEW
 
     def inc(level)
       n = level - 2
-      if n >= 0
-        @counter[n] += 1
-      end
-      if @counter.size > n
-        (n+1..@counter.size).each do |i|
-          @counter[i] = 0
-        end
-      end
+      @counter[n] += 1 if n >= 0
+      (n + 1..@counter.size).each { |i| @counter[i] = 0 } if @counter.size > n
     end
 
     def anchor(level)
-      str = "#{@chapter.format_number(false)}"
-      0.upto(level-2) do |i|
-        str << "-#{@counter[i]}"
-      end
+      str = @chapter.format_number(false)
+      0.upto(level - 2) { |i| str << "-#{@counter[i]}" }
       str
     end
 
@@ -46,27 +35,22 @@ module ReVIEW
       return nil if @chapter.number.blank?
 
       if level == 1
-        if secnolevel >= 1
-          if @chapter.is_a? ReVIEW::Book::Part
-            num = @chapter.number
-            return "#{I18n.t('part', num)}#{I18n.t("chapter_postfix")}"
-          else
-            return "#{@chapter.format_number}#{I18n.t("chapter_postfix")}"
-          end
-        end
-      elsif secnolevel >= level
-        prefix = ''
-        if @chapter.is_a? ReVIEW::Book::Part
-          prefix = I18n.t('part_short', @chapter.number)
+        return nil unless secnolevel >= 1
+        if @chapter.is_a?(ReVIEW::Book::Part)
+          num = @chapter.number
+          "#{I18n.t('part', num)}#{I18n.t('chapter_postfix')}"
         else
-          prefix = @chapter.format_number(false)
+          "#{@chapter.format_number}#{I18n.t('chapter_postfix')}"
         end
-
-        0.upto(level - 2) do |i|
-          prefix << ".#{@counter[i]}"
-        end
-        prefix << I18n.t("chapter_postfix")
-        return prefix
+      elsif secnolevel >= level
+        prefix = if @chapter.is_a?(ReVIEW::Book::Part)
+                   I18n.t('part_short', @chapter.number)
+                 else
+                   @chapter.format_number(false)
+                 end
+        0.upto(level - 2) { |i| prefix << ".#{@counter[i]}" }
+        prefix << I18n.t('chapter_postfix')
+        prefix
       end
     end
   end

data/lib/review/template.rb

@@ -4,17 +4,16 @@ module ReVIEW
   class Template
     include ERB::Util
 
-    TEMPLATE_DIR = File.join(File.dirname(__FILE__), "../../templates")
+    TEMPLATE_DIR = File.join(File.dirname(__FILE__), '../../templates')
 
     def self.load(filename, mode = 1)
       self.new(filename, mode)
     end
 
     def initialize(filename = nil, mode = nil)
-      if filename
-        content = File.read(filename)
-        @erb = ERB.new(content, nil, mode)
-      end
+      return unless filename
+      content = File.read(filename)
+      @erb = ERB.new(content, nil, mode)
     end
 
     def result(bind_data = nil)

data/lib/review/textbuilder.rb

@@ -1,6 +1,7 @@
 # textbuilder.rb
 #
-# Copyright (c) 2010 Kenshi Muto
+# Copyright (c) 2010-2017 Kenshi Muto
+#               2010 Kenshi Muto
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -10,8 +11,6 @@
 require 'review/topbuilder'
 
 module ReVIEW
-
   class TEXTBuilder < TOPBuilder
   end
-
 end # module ReVIEW

data/lib/review/textutils.rb

@@ -1,4 +1,3 @@
-# $Id: textutils.rb 2192 2005-11-13 11:55:42Z aamine $
 require 'nkf'
 
 module ReVIEW
@@ -6,11 +5,11 @@ module ReVIEW
     def detab(str, ts = 8)
       add = 0
       len = nil
-      str.gsub(/\t/) {
+      str.gsub("\t") do
         len = ts - ($`.size + add) % ts
         add += len - 1
         ' ' * len
-      }
+      end
     end
 
     def split_paragraph(lines)
@@ -18,21 +17,16 @@ module ReVIEW
       post = post_paragraph
 
       blocked_lines = [[]]
-      lines.each {|element|
-        if element == ""
-          if blocked_lines.last != []
-            blocked_lines << []
-          end
+      lines.each do |element|
+        if element.empty?
+          blocked_lines << [] if blocked_lines.last != []
         else
           blocked_lines.last << element
         end
-      }
-
-      if !pre.nil? and !post.nil?
-        blocked_lines.map!{|i| [pre] + i + [post] }
       end
 
-      blocked_lines.map{|l| l.join("")}
+      blocked_lines.map! { |i| [pre] + i + [post] } if pre && post
+      blocked_lines.map(&:join)
     end
   end
 end

data/lib/review/tocparser.rb

@@ -1,6 +1,6 @@
 #
-# Copyright (c) 2002-2007 Minero Aoki
-#               2008-2016 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,9 +13,8 @@ require 'review/book'
 require 'review/textbuilder'
 
 module ReVIEW
-
   class TOCParser
-    def TOCParser.parse(chap)
+    def self.parse(chap)
       f = StringIO.new(chap.content, 'r:BOM|utf-8')
       stream = Preprocessor::Strip.new(f)
       new.parse(stream, chap).map do |root|
@@ -24,24 +23,24 @@ module ReVIEW
       end
     end
 
-    def TOCParser.chapter_node(chap)
-      toc = TOCParser.parse(chap)
-      unless toc.size == 1
-        $stderr.puts "warning: chapter #{toc.join} contains more than 1 chapter"
-      end
+    def self.chapter_node(chap)
+      toc = self.parse(chap)
+      $stderr.puts "warning: chapter #{toc.join} contains more than 1 chapter" unless toc.size == 1
       toc.first
     end
 
     def parse(f, chap)
-      roots = [] ## list of chapters
+      roots = [] # list of chapters
       node_stack = []
       filename = chap.path
       while line = f.gets
         case line
         when /\A\#@/
           # do nothing
+          next
         when /\A\s*\z/
           # do nothing
+          next
         when /\A(={2,})[\[\s\{]/
           lev = $1.size
           error! filename, f.lineno, "section level too deep: #{lev}" if lev > 5
@@ -52,11 +51,9 @@ module ReVIEW
             node_stack.push dummy_chapter
             roots.push dummy_chapter
           end
-          next if label =~ /\A\[\// # ex) "[/column]"
-          sec = Section.new(lev, label.gsub(/\A\{.*?\}\s?/, ""))
-          until node_stack.last.level < sec.level
-            node_stack.pop
-          end
+          next if label =~ %r{\A\[/} # ex) "[/column]"
+          sec = Section.new(lev, label.gsub(/\A\{.*?\}\s?/, ''))
+          node_stack.pop until node_stack.last.level < sec.level
           node_stack.last.add_child sec
           node_stack.push sec
 
@@ -67,25 +64,24 @@ module ReVIEW
           node_stack.push new_chapter
           roots.push new_chapter
 
-        when %r<\A//\w+(?:\[.*?\])*\{\s*\z>
-          if node_stack.empty?
-            error! filename, f.lineno, 'list found before section label'
-          end
+        when %r{\A//\w+(?:\[.*?\])*\{\s*\z}
+          error! filename, f.lineno, 'list found before section label' if node_stack.empty?
           node_stack.last.add_child(list = List.new)
           beg = f.lineno
           list.add line
           while line = f.gets
-            break if %r<\A//\}> =~ line
+            break if %r{\A//\}} =~ line
             list.add line
           end
           error! filename, beg, 'unterminated list' unless line
 
-        when %r<\A//\w>
+        when %r{\A//\w}
           # do nothing
+          next
         else
-          #if node_stack.empty?
-          #  error! filename, f.lineno, 'text found before section label'
-          #end
+          # if node_stack.empty?
+          #   error! filename, f.lineno, 'text found before section label'
+          # end
           next if node_stack.empty?
           node_stack.last.add_child(par = Paragraph.new(chap))
           par.add line
@@ -108,7 +104,7 @@ module ReVIEW
       b = ReVIEW::TEXTBuilder.new
       dummy_book = ReVIEW::Book::Base.load
       dummy_chapter = ReVIEW::Book::Chapter.new(dummy_book, 1, '-', nil, StringIO.new)
-      dummy_loc = Location.new("", StringIO.new)
+      dummy_loc = Location.new('', StringIO.new)
       b.bind(ReVIEW::Compiler.new(b), dummy_chapter, dummy_loc)
       b.compile_inline(line)
     end
@@ -117,9 +113,7 @@ module ReVIEW
       raise "#{filename}:#{lineno}: #{msg}"
     end
 
-
     class Node
-
       def initialize(children = [])
         @children = children
       end
@@ -146,9 +140,7 @@ module ReVIEW
       end
 
       def each_section(&block)
-        @children.each do |n|
-          n.yield_section(&block)
-        end
+        @children.each { |n| n.yield_section(&block) }
       end
 
       def each_section_with_index
@@ -161,22 +153,17 @@ module ReVIEW
 
       def section_size
         cnt = 0
-        @children.each do |n|
-          n.yield_section { cnt += 1 }
-        end
+        @children.each { |n| n.yield_section { cnt += 1 } }
         cnt
       end
-
     end
 
-
     class Section < Node
-
       def initialize(level, label, path = nil)
         super()
         @level = level
         @label = label
-        @filename = (path ? real_filename(path) : nil)
+        @filename = path ? real_filename(path) : nil
       end
 
       def real_filename(path)
@@ -192,7 +179,7 @@ module ReVIEW
       attr_reader :label
 
       def estimated_lines
-        @children.inject(0) {|sum, n| sum + n.estimated_lines }
+        @children.inject(0) { |sum, n| sum + n.estimated_lines }
       end
 
       def yield_section
@@ -200,14 +187,11 @@ module ReVIEW
       end
 
       def inspect
-        "\#<#{self.class} level=#{@level} #{@label}>"
+        "#<#{self.class} level=#{@level} #{@label}>"
       end
-
     end
 
-
     class Chapter < Section
-
       def initialize(label, chap)
         super 1, label, chap.path
         @chapter = chap
@@ -229,26 +213,23 @@ module ReVIEW
       def volume
         return @volume if @volume
         @volume = @chapter.volume
-        @volume.lines = estimated_lines()
+        @volume.lines = estimated_lines
         @volume
       end
 
       def inspect
-        "\#<#{self.class} #{@filename}>"
+        "#<#{self.class} #{@filename}>"
       end
-
     end
 
-
     class Paragraph < Node
-
       def initialize(chap)
         @bytes = 0
         @page_metric = chap.book.page_metric
       end
 
       def inspect
-        "\#<#{self.class}>"
+        "#<#{self.class}>"
       end
 
       def add(line)
@@ -261,21 +242,18 @@ module ReVIEW
 
       def yield_section
       end
-
     end
 
-
     class List < Node
-
       def initialize
         @lines = 0
       end
 
       def inspect
-        "\#<#{self.class}>"
+        "#<#{self.class}>"
       end
 
-      def add(line)
+      def add(_line)
         @lines += 1
       end
 
@@ -285,9 +263,6 @@ module ReVIEW
 
       def yield_section
       end
-
     end
-
   end
 end
-

data/lib/review/tocprinter.rb

@@ -1,9 +1,5 @@
-# -*- coding: utf-8 -*-
-#
-# $Id: tocprinter.rb 4309 2009-07-19 04:15:02Z aamine $
-#
-# Copyright (c) 2002-2007 Minero Aoki
-#               2008-2009 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
@@ -15,10 +11,8 @@ require 'review/htmlutils'
 require 'review/tocparser'
 
 module ReVIEW
-
   class TOCPrinter
-
-    def TOCPrinter.default_upper_level
+    def self.default_upper_level
       99 # no one use 99 level nest
     end
 
@@ -29,15 +23,11 @@ module ReVIEW
     end
 
     def print_book(book)
-      book.each_part do |part|
-        print_part(part)
-      end
+      book.each_part { |part| print_part(part) }
     end
 
     def print_part(part)
-      part.each_chapter do |chap|
-        print_chapter(chap)
-      end
+      part.each_chapter { |chap| print_chapter(chap) }
     end
 
     def print_chapter(chap)
@@ -51,16 +41,14 @@ module ReVIEW
     end
   end
 
-
   class TextTOCPrinter < TOCPrinter
-
     private
 
     def print_children(node)
       return unless print?(node.level + 1)
       node.each_section_with_index do |section, idx|
         unless section.blank?
-          print_node idx+1, section
+          print_node idx + 1, section
           print_children section
         end
       end
@@ -85,42 +73,35 @@ module ReVIEW
     end
 
     def volume_columns(level, volstr)
-      cols = ["", "", "", nil]
+      cols = ['', '', '', nil]
       cols[level - 1] = volstr
       cols[0, 3] # does not display volume of level-4 section
     end
-
   end
 
-
   class HTMLTOCPrinter < TOCPrinter
-
     include HTMLUtils
 
     def print_book(book)
       @out.puts '<ul class="book-toc">'
-      book.each_part do |part|
-        print_part(part)
-      end
+      book.each_part { |part| print_part(part) }
       @out.puts '</ul>'
     end
 
     def print_part(part)
-      if part.number
-        @out.puts li(part.title)
-      end
+      @out.puts li(part.title) if part.number
       super
     end
 
     def print_chapter(chap)
       chap_node = TOCParser.chapter_node(chap)
-      ext = chap.book.config["htmlext"] || "html"
-      path = chap.path.sub(/\.re/, "."+ext)
-      if chap_node.number && chap.on_CHAPS?
-        label = "#{chap.number} #{chap.title}"
-      else
-        label = chap.title
-      end
+      ext = chap.book.config['htmlext'] || 'html'
+      path = chap.path.sub(/\.re/, '.' + ext)
+      label = if chap_node.number && chap.on_chaps?
+                "#{chap.number} #{chap.title}"
+              else
+                chap.title
+              end
       @out.puts li(a_name(path, escape_html(label)))
       return unless print?(2)
       if print?(3)
@@ -133,14 +114,12 @@ module ReVIEW
     private
 
     def chap_sections_to_s(chap)
-      return "" if chap.section_size < 1
+      return '' if chap.section_size < 1
       res = []
-      res << "<ol>"
-      chap.each_section do |sec|
-        res << li(escape_html(sec.label))
-      end
-      res << "</ol>"
-      return res.join("\n")
+      res << '<ol>'
+      chap.each_section { |sec| res << li(escape_html(sec.label)) }
+      res << '</ol>'
+      res.join("\n")
     end
 
     def chapter_to_s(chap)
@@ -148,15 +127,12 @@ module ReVIEW
       chap.each_section do |sec|
         res << li(escape_html(sec.label))
         next unless print?(4)
-        if sec.section_size > 0
-          res << "<ul>"
-          sec.each_section do |node|
-            res << li(escape_html(node.label))
-          end
-          res << "</ul>"
-        end
+        next unless sec.section_size > 0
+        res << '<ul>'
+        sec.each_section { |node| res << li(escape_html(node.label)) }
+        res << '</ul>'
       end
-      return res.join("\n")
+      res.join("\n")
     end
 
     def li(content)
@@ -166,7 +142,5 @@ module ReVIEW
     def a_name(name, label)
       %Q(<a name="#{name}">#{label}</a>)
     end
-
   end
-
 end