review 4.1.0 → 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

@@ -1,4 +1,4 @@
-# Copyright (c) 2008-2019 Minero Aoki, Kenshi Muto
+# Copyright (c) 2008-2020 Minero Aoki, Kenshi Muto
 #               2002-2006 Minero Aoki
 #
 # This program is free software.
@@ -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
@@ -86,7 +86,7 @@ module ReVIEW
     private :blank
 
     def result
-      @output.string
+      solve_nest(@output.string)
     end
 
     def headline(level, label, caption)
@@ -97,7 +97,7 @@ module ReVIEW
       end
       p = '='
       case level
-      when 1 then
+      when 1
         unless label
           puts ".. _#{@chapter.name}:"
           blank
@@ -155,7 +155,7 @@ module ReVIEW
 
     def dd(lines)
       split_paragraph(lines).each do |paragraph|
-        puts "  #{paragraph.gsub(/\n/, '')}"
+        puts "  #{paragraph.delete("\n")}"
       end
     end
 
@@ -373,8 +373,9 @@ module ReVIEW
 
     def compile_kw(word, alt)
       if alt
-        then " **#{word}（#{alt.strip}）** "
-      else " **#{word}** "
+        " **#{word}（#{alt.strip}）** "
+      else
+        " **#{word}** "
       end
     end
 
@@ -582,6 +583,24 @@ module ReVIEW
       base_parablock('centering', lines, nil)
     end
 
+    CAPTION_TITLES.each do |name|
+      class_eval %Q(
+        def #{name}_begin(caption = nil)
+          check_nested_minicolumn
+          @doc_status[:minicolumn] = '#{name}'
+          puts ".. #{name}::"
+          blank
+          puts "   " + compile_inline(caption).to_s unless caption.nil?
+          print "   "
+        end
+
+        def #{name}_end
+          blank
+          @doc_status[:minicolumn] = nil
+        end
+      ), __FILE__, __LINE__ - 14
+    end
+
     def note(lines, caption = nil)
       base_parablock('note', lines, caption)
     end
@@ -705,7 +724,7 @@ module ReVIEW
       str
     end
 
-    def inline_chap(id)
+    def inline_chap(id) # rubocop:disable Lint/UselessMethodDefinition
       super
     end
 

data/lib/review/sec_counter.rb

@@ -37,11 +37,25 @@ module ReVIEW
       str
     end
 
+    def number_list
+      buf = @counter.dup
+      while buf.present?
+        if buf.last == 0
+          buf.pop
+        else
+          return buf
+        end
+      end
+
+      buf
+    end
+
     def prefix(level, secnolevel)
       return nil if @chapter.number.blank?
 
       if level == 1
         return nil unless secnolevel >= 1
+
         if @chapter.is_a?(ReVIEW::Book::Part)
           num = @chapter.number
           "#{I18n.t('part', num)}#{I18n.t('chapter_postfix')}"

data/lib/review/template.rb

@@ -10,10 +10,20 @@ module ReVIEW
       self.new(filename, mode)
     end
 
+    def self.generate(path:, binding:, mode: 1, template_dir: ReVIEW::Template::TEMPLATE_DIR)
+      template_file = File.expand_path(path, template_dir)
+      self.new(template_file, mode).result(binding)
+    end
+
     def initialize(filename = nil, mode = nil)
       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

@@ -1,4 +1,4 @@
-# Copyright (c) 2018-2020 Kenshi Muto
+# Copyright (c) 2018-2021 Kenshi Muto
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -16,10 +16,13 @@ require 'review/yamlloader'
 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
 
@@ -27,15 +30,8 @@ module ReVIEW
       @basedir = nil
       @logger = ReVIEW.logger
       @plaintext = nil
-    end
-
-    def error(msg)
-      @logger.error msg
-      exit 1
-    end
-
-    def warn(msg)
-      @logger.warn msg
+      @img_math = nil
+      @compile_errors = nil
     end
 
     def self.execute(*args)
@@ -70,36 +66,31 @@ module ReVIEW
     end
 
     def remove_old_files(path)
-      cleanup_mathimg('_review_math_text')
+      @img_math.cleanup_mathimg
       FileUtils.rm_rf(path)
     end
 
     def execute(*args)
-      @config = ReVIEW::Configure.values
-      @config.maker = 'textmaker'
       cmd_config, yamlfile = parse_opts(args)
-      error "#{yamlfile} not found." unless File.exist?(yamlfile)
+      error! "#{yamlfile} not found." unless File.exist?(yamlfile)
 
-      begin
-        loader = ReVIEW::YAMLLoader.new
-        @config.deep_merge!(loader.load_file(yamlfile))
-      rescue => e
-        error "yaml error #{e.message}"
-      end
+      @config = ReVIEW::Configure.create(maker: 'textmaker',
+                                         yamlfile: yamlfile,
+                                         config: cmd_config)
+      @img_math = ReVIEW::ImgMath.new(@config, path_name: '_review_math_text')
 
-      # YAML configs will be overridden by command line options.
-      @config.deep_merge!(cmd_config)
       I18n.setup(@config['language'])
       begin
         generate_text_files(yamlfile)
+        @logger.success("built #{build_path}")
       rescue ApplicationError => e
         raise if @config['debug']
-        error(e.message)
+
+        error! e.message
       end
 
-      math_dir = "./#{@config['imagedir']}/_review_math_text"
-      if @config['imgmath'] && File.exist?(File.join(math_dir, '__IMGMATH_BODY__.tex'))
-        make_math_images(math_dir)
+      if @config['math_format'] == 'imgmath'
+        @img_math.make_math_images
       end
     end
 
@@ -109,19 +100,22 @@ module ReVIEW
       remove_old_files(@path)
       Dir.mkdir(@path)
 
-      @book = ReVIEW::Book.load(@basedir)
-      @book.config = @config
+      @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)
       base_path = Pathname.new(@basedir)
       builder = nil
       if @plaintext
-        builder = ReVIEW::PLAINTEXTBuilder.new
+        builder = ReVIEW::PLAINTEXTBuilder.new(img_math: @img_math)
       else
-        builder = ReVIEW::TOPBuilder.new
+        builder = ReVIEW::TOPBuilder.new(img_math: @img_math)
       end
       @converter = ReVIEW::Converter.new(@book, builder)
       @book.parts.each do |part|
@@ -166,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