review 5.1.1 → 5.2.0

data/lib/review/preprocessor/directive.rb

@@ -0,0 +1,35 @@
+# Copyright (c) 2010-2021 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".
+#
+
+module ReVIEW
+  class Preprocessor
+    class Directive
+      def initialize(op, args, opts)
+        @op = op
+        @args = args
+        @opts = opts
+      end
+
+      attr_reader :op
+      attr_reader :args
+      attr_reader :opts
+
+      def arg
+        @args.first
+      end
+
+      def opt
+        @opts.first
+      end
+
+      def [](key)
+        @opts[key]
+      end
+    end
+  end
+end

data/lib/review/preprocessor/line.rb

@@ -0,0 +1,34 @@
+# Copyright (c) 2010-2021 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".
+#
+
+module ReVIEW
+  class Preprocessor
+    class Line
+      def initialize(number, string)
+        @number = number
+        @string = string
+      end
+
+      attr_reader :number
+      attr_reader :string
+      alias_method :to_s, :string
+
+      def edit
+        self.class.new(@number, yield(@string))
+      end
+
+      def empty?
+        @string.strip.empty?
+      end
+
+      def num_indent
+        @string.slice(/\A\s*/).size
+      end
+    end
+  end
+end

data/lib/review/preprocessor/repository.rb

@@ -0,0 +1,177 @@
+# Copyright (c) 2010-2021 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/textutils'
+require 'review/loggable'
+
+module ReVIEW
+  class Preprocessor
+    class Repository
+      include TextUtils
+      include Loggable
+
+      def initialize(param)
+        @repository = {}
+        @config = param
+        @leave_content = nil
+        @logger = ReVIEW.logger
+      end
+
+      def fetch_file(file)
+        file_descripter(file)['file']
+      end
+
+      def fetch_range(file, name)
+        fetch(file, 'range', name)
+      end
+
+      def fetch(file, type, name)
+        table = file_descripter(file)[type] or return nil
+        table[name]
+      end
+
+      private
+
+      def file_descripter(fname)
+        @leave_content = File.extname(fname) == '.re'
+        return @repository[fname] if @repository[fname]
+
+        @repository[fname] = git?(fname) ? parse_git_blob(fname) : parse_file(fname)
+      end
+
+      def git?(fname)
+        fname.start_with?('git|')
+      end
+
+      def parse_git_blob(g_obj)
+        IO.popen('git show ' + g_obj.sub(/\Agit\|/, ''), 'r') do |f|
+          @inf = f
+          return _parse_file(f)
+        end
+      end
+
+      def parse_file(fname)
+        File.open(fname, 'rt:BOM|utf-8') do |f|
+          @inf = f
+          return _parse_file(f)
+        end
+      end
+
+      def _parse_file(f)
+        whole = []
+        repo = { 'file' => whole }
+        curr = { 'WHOLE' => whole }
+        lineno = 1
+        yacchack = false # remove ';'-only lines.
+        opened = [['(not opened)', '(not opened)']] * 3
+
+        f.each do |line|
+          begin
+            case line
+            when /(?:\A\#@|\#@@)([a-z]+)_(begin|end)\((.*)\)/
+              type = check_type($1)
+              direction = $2
+              spec = check_spec($3)
+              case direction
+              when 'begin'
+                key = "#{type}/#{spec}"
+                if curr[key]
+                  app_error "begin x2: #{key}"
+                end
+                (repo[type] ||= {})[spec] = curr[key] = []
+              when 'end'
+                curr.delete("#{type}/#{spec}") or
+                  app_error "end before begin: #{type}/#{spec}"
+              else
+                app_error 'must not happen'
+              end
+
+            when %r{(?:\A\#@|\#@@)([a-z]+)/(\w+)\{}
+              type = check_type($1)
+              spec = check_spec($2)
+              key = "#{type}/#{spec}"
+              if curr[key]
+                app_error "begin x2: #{key}"
+              end
+              (repo[type] ||= {})[spec] = curr[key] = []
+              opened.push([type, spec])
+
+            when %r{(?:\A\#@|\#@@)([a-z]+)/(\w+)\}}
+              type = check_type($1)
+              spec = check_spec($2)
+              curr.delete("#{type}/#{spec}") or
+                app_error "end before begin: #{type}/#{spec}"
+              opened.delete("#{type}/#{spec}")
+
+            when /(?:\A\#@|\#@@)\}/
+              type, spec = opened.last
+              curr.delete("#{type}/#{spec}") or
+                app_error "closed before open: #{type}/#{spec}"
+              opened.pop
+
+            when /(?:\A\#@|\#@@)yacchack/
+              yacchack = true
+
+            when /\A\#@-/ # does not increment line number.
+              line = canonical($')
+              curr.each_value { |list| list.push(Line.new(nil, line)) }
+
+            else
+              next if yacchack && (line.strip == ';')
+
+              line = canonical(line)
+              curr.each_value { |list| list.push(Line.new(lineno, line)) }
+              lineno += 1
+            end
+          rescue ApplicationError => e
+            @has_errors = true
+            error e.message, location: location
+          end
+        end
+        if curr.size > 1
+          curr.delete('WHOLE')
+          curr.each { |range, lines| warn "#{@inf.path}: unclosed range: #{range} (begin @#{lines.first.number})" }
+          @has_errors = true
+        end
+
+        if @has_errors
+          error! 'repository failed.'
+        end
+
+        repo
+      end
+
+      def canonical(line)
+        if @leave_content
+          return line
+        end
+
+        tabwidth = @config['tabwidth'] || 8
+        if tabwidth > 0
+          detab(line, tabwidth).rstrip + "\n"
+        else
+          line
+        end
+      end
+
+      def check_type(type)
+        app_error "wrong type: #{type.inspect}" unless Preprocessor::TYPES.index(type)
+        type
+      end
+
+      def check_spec(spec)
+        app_error "wrong spec: #{spec.inspect}" unless /\A\w+\z/ =~ spec
+        spec
+      end
+
+      def location
+        "#{@inf.path}:#{@inf.lineno}"
+      end
+    end
+  end
+end

data/lib/review/rstbuilder.rb

@@ -54,12 +54,12 @@ module ReVIEW
     end
 
     def builder_init_file
+      super
       @section = 0
       @subsection = 0
       @subsubsection = 0
       @subsubsubsection = 0
       @blank_seen = true
-      @sec_counter = SecCounter.new(5, @chapter)
       @ul_indent = 0
       @ol_indent = 0
       @in_role = false

data/lib/review/template.rb

@@ -19,7 +19,11 @@ module ReVIEW
       return unless filename
 
       content = File.read(filename)
-      @erb = ERB.new(content, nil, mode)
+      @erb = if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.6')
+               ERB.new(content, trim_mode: mode)
+             else
+               ERB.new(content, nil, mode)
+             end
     end
 
     def result(bind_data = nil)

data/lib/review/textmaker.rb

@@ -17,10 +17,12 @@ require 'review/topbuilder'
 require 'review/version'
 require 'review/makerhelper'
 require 'review/img_math'
+require 'review/loggable'
 
 module ReVIEW
   class TEXTMaker
     include MakerHelper
+    include Loggable
 
     attr_accessor :config, :basedir
 
@@ -29,15 +31,7 @@ module ReVIEW
       @logger = ReVIEW.logger
       @plaintext = nil
       @img_math = nil
-    end
-
-    def error(msg)
-      @logger.error msg
-      exit 1
-    end
-
-    def warn(msg)
-      @logger.warn msg
+      @compile_errors = nil
     end
 
     def self.execute(*args)
@@ -78,7 +72,7 @@ module ReVIEW
 
     def execute(*args)
       cmd_config, yamlfile = parse_opts(args)
-      error "#{yamlfile} not found." unless File.exist?(yamlfile)
+      error! "#{yamlfile} not found." unless File.exist?(yamlfile)
 
       @config = ReVIEW::Configure.create(maker: 'textmaker',
                                          yamlfile: yamlfile,
@@ -92,7 +86,7 @@ module ReVIEW
       rescue ApplicationError => e
         raise if @config['debug']
 
-        error(e.message)
+        error! e.message
       end
 
       if @config['math_format'] == 'imgmath'
@@ -109,6 +103,10 @@ module ReVIEW
       @book = ReVIEW::Book::Base.new(@basedir, config: @config)
 
       build_body(@path, yamlfile)
+
+      if @compile_errors
+        app_error 'compile error, No TEXT file output.'
+      end
     end
 
     def build_body(basetmpdir, _yamlfile)
@@ -162,8 +160,9 @@ module ReVIEW
       begin
         @converter.convert(filename, File.join(basetmpdir, textfile))
       rescue => e
-        warn "compile error in #{filename} (#{e.class})"
-        warn e.message
+        @compile_errors = true
+        error "compile error in #{filename} (#{e.class})"
+        error e.message
       end
     end
   end

data/lib/review/tocprinter.rb

@@ -257,7 +257,7 @@ module ReVIEW
         compiler.compile(@book.chapter(chap.name))
       rescue ReVIEW::ApplicationError => e
         @logger.error e.message
-        exit 1
+        ''
       end
     end
 

data/lib/review/topbuilder.rb

@@ -105,7 +105,7 @@ module ReVIEW
           list_header(id, caption, lang)
         end
       rescue KeyError
-        error "no such list: #{id}"
+        app_error "no such list: #{id}"
       end
       puts "◆→終了:#{@titles['list']}←◆"
       blank
@@ -178,7 +178,7 @@ module ReVIEW
           list_header(id, caption, lang)
         end
       rescue KeyError
-        error "no such list: #{id}"
+        app_error "no such list: #{id}"
       end
       puts "◆→終了:#{@titles['list']}←◆"
       blank
@@ -202,7 +202,7 @@ module ReVIEW
       if @chapter.image_bound?(id)
         puts "◆→#{@chapter.image(id).path}#{metrics}←◆"
       else
-        warn "image not bound: #{id}"
+        warn "image not bound: #{id}", location: location
         lines.each do |line|
           puts line
         end
@@ -287,7 +287,7 @@ module ReVIEW
     def inline_fn(id)
       "【注#{@chapter.footnote(id).number}】"
     rescue KeyError
-      error "unknown footnote: #{id}"
+      app_error "unknown footnote: #{id}"
     end
 
     def compile_ruby(base, ruby)
@@ -381,7 +381,7 @@ module ReVIEW
       begin
         "◆→画像 #{@chapter.image(id).path.sub(%r{\A\./}, '')}←◆"
       rescue
-        warn "image not bound: #{id}"
+        warn "image not bound: #{id}", location: location
         "◆→画像 #{id}←◆"
       end
     end
@@ -425,7 +425,7 @@ module ReVIEW
     def inline_bib(id)
       %Q([#{@chapter.bibpaper(id).number}])
     rescue KeyError
-      error "unknown bib: #{id}"
+      app_error "unknown bib: #{id}"
     end
 
     def noindent
@@ -487,7 +487,7 @@ module ReVIEW
       begin
         puts "◆→画像 #{@chapter.image(id).path.sub(%r{\A\./}, '')}#{metrics}←◆"
       rescue
-        warn "image not bound: #{id}"
+        warn "image not bound: #{id}", location: location
         puts "◆→画像 #{id}←◆"
       end
       if !caption_top?('image') && caption.present?

data/lib/review/version.rb

@@ -1,3 +1,3 @@
 module ReVIEW
-  VERSION = '5.1.1'.freeze
+  VERSION = '5.2.0'.freeze
 end

data/lib/review/webmaker.rb

@@ -21,11 +21,13 @@ require 'review/tocprinter'
 require 'review/version'
 require 'review/makerhelper'
 require 'review/img_math'
+require 'review/loggable'
 
 module ReVIEW
   class WEBMaker
     include ERB::Util
     include MakerHelper
+    include Loggable
 
     attr_accessor :config, :basedir
 
@@ -33,15 +35,7 @@ module ReVIEW
       @basedir = nil
       @logger = ReVIEW.logger
       @img_math = nil
-    end
-
-    def error(msg)
-      @logger.error msg
-      exit 1
-    end
-
-    def warn(msg)
-      @logger.warn msg
+      @compile_errors = nil
     end
 
     def self.execute(*args)
@@ -82,7 +76,7 @@ module ReVIEW
 
     def execute(*args)
       cmd_config, yamlfile = parse_opts(args)
-      error "#{yamlfile} not found." unless File.exist?(yamlfile)
+      error! "#{yamlfile} not found." unless File.exist?(yamlfile)
 
       @config = ReVIEW::Configure.create(maker: 'webmaker',
                                          yamlfile: yamlfile,
@@ -98,7 +92,7 @@ module ReVIEW
       rescue ApplicationError => e
         raise if @config['debug']
 
-        error(e.message)
+        error! e.message
       end
     end
 
@@ -129,6 +123,7 @@ module ReVIEW
 
     def build_body(basetmpdir, _yamlfile)
       base_path = Pathname.new(@basedir)
+      @compile_errors = nil
       @book.parts.each do |part|
         if part.name.present?
           if part.file?
@@ -143,6 +138,9 @@ module ReVIEW
 
         part.chapters.each { |chap| build_chap(chap, base_path, basetmpdir, false) }
       end
+      if @compile_errors
+        app_error 'compile error, No web files output.'
+      end
     end
 
     def build_part(part, basetmpdir, htmlfile)
@@ -191,9 +189,10 @@ module ReVIEW
 
       begin
         @converter.convert(filename, File.join(basetmpdir, htmlfile))
-      rescue => e
-        warn "compile error in #{filename} (#{e.class})"
-        warn e.message
+      rescue ApplicationError => e
+        @compile_errors = true
+        error "compile error in #{filename} (#{e.class})"
+        error e.message
       end
     end