review 4.2.0 → 5.0.0

data/lib/review/init.rb

@@ -114,9 +114,7 @@ module ReVIEW
         exit 1
       end
 
-      initdir = File.expand_path(args[0])
-
-      initdir
+      File.expand_path(args[0])
     end
 
     def generate_dir(dir)
@@ -135,8 +133,7 @@ module ReVIEW
     end
 
     def generate_catalog_file(dir)
-      File.open(File.join(dir, 'catalog.yml'), 'w') do |file|
-        file.write <<-EOS
+      File.write(File.join(dir, 'catalog.yml'), <<-EOS)
 PREDEF:
 
 CHAPS:
@@ -147,7 +144,6 @@ APPENDIX:
 POSTDEF:
 
 EOS
-      end
     end
 
     def generate_images_dir(dir)
@@ -223,13 +219,11 @@ EOT
     def generate_rakefile(dir)
       FileUtils.mkdir_p(File.join(dir, 'lib/tasks'))
 
-      File.open(File.join(dir, 'Rakefile'), 'w') do |file|
-        file.write <<-EOS
+      File.write(File.join(dir, 'Rakefile'), <<-EOS)
 Dir.glob('lib/tasks/*.rake').sort.each do |file|
   load(file)
 end
 EOS
-      end
 
       FileUtils.cp(File.join(@review_dir, 'samples/sample-book/src/lib/tasks/review.rake'),
                    File.join(dir, 'lib/tasks/review.rake'))
@@ -240,14 +234,12 @@ EOS
     end
 
     def generate_gemfile(dir)
-      File.open(File.join(dir, 'Gemfile'), 'w') do |file|
-        file.write <<-EOS
+      File.write(File.join(dir, 'Gemfile'), <<-EOS)
 source 'https://rubygems.org'
 
 gem 'rake'
 gem 'review', '#{ReVIEW::VERSION}'
 EOS
-      end
     end
 
     def generate_doc(dir)
@@ -342,7 +334,7 @@ EOS
       # validation
       if @web_result
         @web_result.each do |s|
-          if s !~ /\A[a-z0-9=_,\.-]*\Z/i
+          if s !~ /\A[a-z0-9=_,.-]*\Z/i
             @web_result = nil
             break
           end

data/lib/review/latexbuilder.rb

@@ -100,7 +100,21 @@ module ReVIEW
       if @chapter.is_a?(ReVIEW::Book::Part) && !@book.config.check_version('2', exception: false)
         puts '\end{reviewpart}'
       end
-      @output.string
+      solve_nest(@output.string)
+    end
+
+    def solve_nest(s)
+      check_nest
+      s.gsub("\\end{description}\n\n\x01→dl←\x01\n", "\n").
+        gsub("\x01→/dl←\x01", "\\end{description}←END\x01").
+        gsub("\\end{itemize}\n\n\x01→ul←\x01\n", "\n").
+        gsub("\x01→/ul←\x01", "\\end{itemize}←END\x01").
+        gsub("\\end{enumerate}\n\n\x01→ol←\x01\n", "\n").
+        gsub("\x01→/ol←\x01", "\\end{enumerate}←END\x01").
+        gsub("\\end{description}←END\x01\n\n\\begin{description}", '').
+        gsub("\\end{itemize}←END\x01\n\n\\begin{itemize}", '').
+        gsub("\\end{enumerate}←END\x01\n\n\\begin{enumerate}", '').
+        gsub("←END\x01", '')
     end
 
     HEADLINE = {
@@ -212,7 +226,53 @@ module ReVIEW
       @doc_status[:column] = nil
     end
 
+    def common_block_begin(type, caption = nil)
+      check_nested_minicolumn
+      if @book.config.check_version('2', exception: false)
+        type = 'minicolumn'
+      end
+
+      @doc_status[:minicolumn] = type
+      print "\\begin{review#{type}}"
+
+      @doc_status[:caption] = true
+      if @book.config.check_version('2', exception: false)
+        puts
+        if caption.present?
+          puts "\\reviewminicolumntitle{#{compile_inline(caption)}}"
+        end
+      else
+        if caption.present?
+          print "[#{compile_inline(caption)}]"
+        end
+        puts
+      end
+      @doc_status[:caption] = nil
+    end
+
+    def common_block_end(type)
+      if @book.config.check_version('2', exception: false)
+        type = 'minicolumn'
+      end
+
+      puts "\\end{review#{type}}"
+      @doc_status[:minicolumn] = nil
+    end
+
+    CAPTION_TITLES.each do |name|
+      class_eval %Q(
+        def #{name}_begin(caption = nil)
+          common_block_begin('#{name}', caption)
+        end
+
+        def #{name}_end
+          common_block_end('#{name}')
+        end
+      ), __FILE__, __LINE__ - 8
+    end
+
     def captionblock(type, lines, caption)
+      check_nested_minicolumn
       if @book.config.check_version('2', exception: false)
         type = 'minicolumn'
       end
@@ -599,7 +659,8 @@ module ReVIEW
     end
     private :bib_label
 
-    def column_label(id, chapter = @chapter)
+    def column_label(id, chapter = nil)
+      chapter ||= @chapter
       filename = chapter.id
       num = chapter.column(id).number
       "column:#{filename}:#{num}"
@@ -637,7 +698,7 @@ module ReVIEW
       else
         warn "image not bound: #{id}"
         puts '\begin{reviewdummyimage}'
-        puts "--[[path = #{id} (#{existence(id)})]]--"
+        puts "--[[path = #{escape(id)} (#{existence(id)})]]--"
         lines.each do |line|
           puts detab(line.rstrip)
         end
@@ -1217,7 +1278,7 @@ module ReVIEW
       error "unknown column: #{id}"
     end
 
-    def inline_raw(str)
+    def inline_raw(str) # rubocop:disable Lint/UselessMethodDefinition
       super(str)
     end
 

data/lib/review/logger.rb

@@ -2,14 +2,14 @@ require 'logger'
 
 module ReVIEW
   class Logger < ::Logger
-    def initialize(io = STDERR, progname: '--')
+    def initialize(io = $stderr, progname: '--')
       super(io, progname: progname)
       self.formatter = ->(severity, _datetime, name, msg) { "#{severity} #{name}: #{msg}\n" }
     end
   end
 
   def self.logger
-    @logger ||= ReVIEW::Logger.new(STDERR, progname: File.basename($PROGRAM_NAME, '.*'))
+    @logger ||= ReVIEW::Logger.new($stderr, progname: File.basename($PROGRAM_NAME, '.*'))
   end
 
   def self.logger=(logger)

data/lib/review/makerhelper.rb

@@ -10,6 +10,12 @@ require 'fileutils'
 require 'yaml'
 require 'shellwords'
 
+begin
+  require 'cgi/escape'
+rescue
+  require 'cgi/util'
+end
+
 module ReVIEW
   module MakerHelper
     # Return review/bin directory
@@ -18,6 +24,11 @@ module ReVIEW
     end
     module_function :bindir
 
+    def h(str)
+      CGI.escapeHTML(str)
+    end
+    module_function :h
+
     # Copy image files under from_dir to to_dir recursively
     # ==== Args
     # from_dir :: path to the directory which has image files to be copied

data/lib/review/markdownbuilder.rb

@@ -155,10 +155,28 @@ module ReVIEW
       puts %Q(<div class="#{type}">)
       puts %Q(<p class="caption">#{compile_inline(caption)}</p>) if caption.present?
       blocked_lines = split_paragraph(lines)
-      puts blocked_lines.join("\n")
+      puts blocked_lines.join("\n\n")
       puts '</div>'
     end
 
+    CAPTION_TITLES.each do |name|
+      class_eval %Q(
+        def #{name}_begin(caption = nil)
+          check_nested_minicolumn
+          @doc_status[:minicolumn] = '#{name}'
+          puts %Q(<div class="#{name}">)
+          if caption.present?
+            puts %Q(<p class="caption">\#{compile_inline(caption)}</p>)
+          end
+        end
+
+        def #{name}_end
+          puts '</div>'
+          @doc_status[:minicolumn] = nil
+        end
+      ), __FILE__, __LINE__ - 14
+    end
+
     def hr
       puts '----'
     end

data/lib/review/pdfmaker.rb

@@ -122,20 +122,13 @@ module ReVIEW
     end
 
     def execute(*args)
-      @config = ReVIEW::Configure.values
-      @config.maker = 'pdfmaker'
       cmd_config, yamlfile = parse_opts(args)
       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: 'pdfmaker',
+                                         yamlfile: yamlfile,
+                                         config: cmd_config)
 
-      # YAML configs will be overridden by command line options.
-      @config.deep_merge!(cmd_config)
       I18n.setup(@config['language'])
       @basedir = File.absolute_path(File.dirname(yamlfile))
 
@@ -272,8 +265,7 @@ module ReVIEW
       begin
         @compile_errors = nil
 
-        book = ReVIEW::Book.load(@basedir)
-        book.config = @config
+        book = ReVIEW::Book::Base.new(@basedir, config: @config)
         @converter = ReVIEW::Converter.new(book, ReVIEW::LATEXBuilder.new)
 
         @input_files = make_input_files(book)
@@ -311,23 +303,12 @@ module ReVIEW
       end
     end
 
-    # PDFMaker#copy_images should copy image files _AND_ execute extractbb (or ebb).
+    # PDFMaker#copy_images should copy image files
     #
     def copy_images(from, to)
       return unless File.exist?(from)
       Dir.mkdir(to)
       ReVIEW::MakerHelper.copy_images_to_dir(from, to)
-      Dir.chdir(to) do
-        images = Dir.glob('**/*').find_all { |f| File.file?(f) and f =~ /\.(jpg|jpeg|png|pdf|ai|eps|tif)\z/i }
-        break if images.empty?
-        if @config['pdfmaker']['bbox']
-          system_with_info('extractbb', '-B', @config['pdfmaker']['bbox'], *images)
-          system_or_raise('ebb', '-B', @config['pdfmaker']['bbox'], *images) unless system('extractbb', '-B', @config['pdfmaker']['bbox'], '-m', *images)
-        else
-          system_with_info('extractbb', *images)
-          system_or_raise('ebb', *images) unless system('extractbb', '-m', *images)
-        end
-      end
     end
 
     def make_custom_page(file)
@@ -385,11 +366,11 @@ module ReVIEW
           items.each_with_index do |item, rev|
             editstr = edit == 0 ? ReVIEW::I18n.t('first_edition') : ReVIEW::I18n.t('nth_edition', (edit + 1).to_s)
             revstr = ReVIEW::I18n.t('nth_impression', (rev + 1).to_s)
-            if item =~ /\A\d+\-\d+\-\d+\Z/
+            if item =~ /\A\d+-\d+-\d+\Z/
               buf << ReVIEW::I18n.t('published_by1', [date_to_s(item), editstr + revstr])
-            elsif item =~ /\A(\d+\-\d+\-\d+)[\s　](.+)/
+            elsif item =~ /\A(\d+-\d+-\d+)[\s　](.+)/
               # custom date with string
-              item.match(/\A(\d+\-\d+\-\d+)[\s　](.+)/) { |m| buf << ReVIEW::I18n.t('published_by3', [date_to_s(m[1]), m[2]]) }
+              item.match(/\A(\d+-\d+-\d+)[\s　](.+)/) { |m| buf << ReVIEW::I18n.t('published_by3', [date_to_s(m[1]), m[2]]) }
             else
               # free format
               buf << item
@@ -455,15 +436,15 @@ module ReVIEW
       end
 
       @locale_latex = {}
-      part_tuple = I18n.get('part').split(/\%[A-Za-z]{1,3}/, 2)
-      chapter_tuple = I18n.get('chapter').split(/\%[A-Za-z]{1,3}/, 2)
-      appendix_tuple = I18n.get('appendix').split(/\%[A-Za-z]{1,3}/, 2)
-      @locale_latex['prepartname'] = part_tuple[0]
-      @locale_latex['postpartname'] = part_tuple[1]
-      @locale_latex['prechaptername'] = chapter_tuple[0]
-      @locale_latex['postchaptername'] = chapter_tuple[1]
-      @locale_latex['preappendixname'] = appendix_tuple[0]
-      @locale_latex['postappendixname'] = appendix_tuple[1]
+      part_tuple = I18n.get('part').split(/%[A-Za-z]{1,3}/, 2)
+      chapter_tuple = I18n.get('chapter').split(/%[A-Za-z]{1,3}/, 2)
+      appendix_tuple = I18n.get('appendix').split(/%[A-Za-z]{1,3}/, 2)
+      @locale_latex['prepartname'] = part_tuple[0].to_s
+      @locale_latex['postpartname'] = part_tuple[1].to_s
+      @locale_latex['prechaptername'] = chapter_tuple[0].to_s
+      @locale_latex['postchaptername'] = chapter_tuple[1].to_s
+      @locale_latex['preappendixname'] = appendix_tuple[0].to_s
+      @locale_latex['postappendixname'] = appendix_tuple[1].to_s
     end
 
     def erb_content(file)

data/lib/review/plaintextbuilder.rb

@@ -74,7 +74,26 @@ module ReVIEW
     private :blank
 
     def result
-      @output.string
+      solve_nest(@output.string)
+    end
+
+    def solve_nest(s)
+      check_nest
+      lines = []
+      clevel = []
+      s.split("\n", -1).each do |l| # -1 means don't omit last "\n"
+        if l =~ /\A\x01→(dl|ul|ol)←\x01/
+          clevel.push($1)
+          lines.push("\x01→END←\x01")
+        elsif l =~ %r{\A\x01→/(dl|ul|ol)←\x01}
+          clevel.pop
+          lines.push("\x01→END←\x01")
+        else
+          lines.push("\t" * clevel.size + l)
+        end
+      end
+
+      lines.join("\n").gsub(/\n*\x01→END←\x01\n*/, "\n")
     end
 
     def headline(level, _label, caption)
@@ -501,18 +520,22 @@ module ReVIEW
     end
 
     def note(lines, caption = nil)
+      check_nested_minicolumn
       base_parablock('note', lines, caption)
     end
 
     def memo(lines, caption = nil)
+      check_nested_minicolumn
       base_parablock('memo', lines, caption)
     end
 
     def tip(lines, caption = nil)
+      check_nested_minicolumn
       base_parablock('tip', lines, caption)
     end
 
     def info(lines, caption = nil)
+      check_nested_minicolumn
       base_parablock('info', lines, caption)
     end
 
@@ -521,10 +544,12 @@ module ReVIEW
     end
 
     def best(lines, caption = nil)
+      check_nested_minicolumn
       base_parablock('best', lines, caption)
     end
 
     def important(lines, caption = nil)
+      check_nested_minicolumn
       base_parablock('important', lines, caption)
     end
 
@@ -533,6 +558,7 @@ module ReVIEW
     end
 
     def caution(lines, caption = nil)
+      check_nested_minicolumn
       base_parablock('caution', lines, caption)
     end
 
@@ -545,6 +571,7 @@ module ReVIEW
     end
 
     def notice(lines, caption = nil)
+      check_nested_minicolumn
       base_parablock('notice', lines, caption)
     end
 
@@ -573,11 +600,30 @@ module ReVIEW
     end
 
     def warning(lines, caption = nil)
+      check_nested_minicolumn
       base_parablock('warning', lines, caption)
     end
 
     alias_method :box, :insn
 
+    CAPTION_TITLES.each do |name|
+      class_eval %Q(
+        def #{name}_begin(caption = nil)
+          check_nested_minicolumn
+          @doc_status[:minicolumn] = '#{name}'
+          blank
+          if caption.present?
+            puts compile_inline(caption)
+          end
+        end
+
+        def #{name}_end
+          blank
+          @doc_status[:minicolumn] = nil
+        end
+      ), __FILE__, __LINE__ - 14
+    end
+
     def indepimage(_lines, _id, caption = nil, _metric = nil)
       blank
       puts "図　#{compile_inline(caption)}" if caption.present?
@@ -613,7 +659,7 @@ module ReVIEW
       str
     end
 
-    def inline_chap(id)
+    def inline_chap(id) # rubocop:disable Lint/UselessMethodDefinition
       # "「第#{super}章　#{inline_title(id)}」"
       # "第#{super}章"
       super