RubyGems - review - Versions diffs - 5.5.0 → 5.7.0 - Mend

review 5.5.0 → 5.7.0

Files changed (109) hide show

checksums.yaml +4 -4
data/.github/workflows/rubocop.yml +31 -0
data/.github/workflows/ruby-tex.yml +1 -1
data/.github/workflows/ruby-win.yml +1 -1
data/.github/workflows/ruby.yml +2 -2
data/.rubocop.yml +13 -2
data/NEWS.ja.md +40 -0
data/NEWS.md +39 -0
data/README.md +1 -1
data/doc/format.ja.md +70 -33
data/doc/format.md +69 -34
data/doc/quickstart.ja.md +7 -1
data/doc/quickstart.md +7 -1
data/lib/review/book/base.rb +1 -1
data/lib/review/builder.rb +6 -10
data/lib/review/epubmaker/epubcommon.rb +13 -7
data/lib/review/epubmaker/epubv2.rb +0 -5
data/lib/review/epubmaker/epubv3.rb +9 -1
data/lib/review/epubmaker/producer.rb +2 -3
data/lib/review/epubmaker.rb +2 -4
data/lib/review/htmlbuilder.rb +2 -2
data/lib/review/i18n.yml +24 -2
data/lib/review/idgxmlbuilder.rb +29 -10
data/lib/review/idgxmlmaker.rb +11 -1
data/lib/review/img_math.rb +9 -2
data/lib/review/init.rb +10 -5
data/lib/review/latexbuilder.rb +2 -2
data/lib/review/lineinput.rb +2 -2
data/lib/review/makerhelper.rb +2 -2
data/lib/review/pdfmaker.rb +3 -5
data/lib/review/update.rb +3 -7
data/lib/review/version.rb +1 -1
data/lib/review/yamlloader.rb +0 -3
data/review.gemspec +3 -3
data/samples/syntax-book/Gemfile +1 -1
data/templates/latex/config.erb +6 -1
data/templates/latex/review-jlreq/review-base.sty +11 -8
data/templates/latex/review-jsbook/review-base.sty +15 -11
data/templates/opf/epubv2.opf.erb +2 -0
data/templates/opf/epubv3.opf.erb +2 -0
data/templates/opf/opf_manifest_epubv2.opf.erb +2 -0
data/templates/opf/opf_manifest_epubv3.opf.erb +2 -0
data/templates/opf/opf_tocx_epubv3.opf.erb +2 -0
metadata +24 -139
data/test/assets/black.eps +0 -280
data/test/assets/fit.png +0 -0
data/test/assets/header_listener.html +0 -35
data/test/assets/img_math/img1.png +0 -0
data/test/assets/img_math/img2.png +0 -0
data/test/assets/img_math/img3.png +0 -0
data/test/assets/large.gif +0 -0
data/test/assets/large.jpg +0 -0
data/test/assets/large.png +0 -0
data/test/assets/large.svg +0 -65
data/test/assets/syntax_book_index_detail.txt +0 -60
data/test/assets/test.xml.erb +0 -3
data/test/assets/test_template.tex +0 -179
data/test/assets/test_template_backmatter.tex +0 -190
data/test/book_test_helper.rb +0 -44
data/test/run_test.rb +0 -12
data/test/test_book.rb +0 -588
data/test/test_book_chapter.rb +0 -329
data/test/test_book_part.rb +0 -53
data/test/test_builder.rb +0 -126
data/test/test_catalog.rb +0 -174
data/test/test_catalog_converter_cmd.rb +0 -73
data/test/test_compiler.rb +0 -52
data/test/test_configure.rb +0 -91
data/test/test_converter.rb +0 -21
data/test/test_epub3maker.rb +0 -733
data/test/test_epubmaker.rb +0 -931
data/test/test_epubmaker_cmd.rb +0 -56
data/test/test_extentions_hash.rb +0 -66
data/test/test_helper.rb +0 -62
data/test/test_htmlbuilder.rb +0 -3312
data/test/test_htmltoc.rb +0 -29
data/test/test_htmlutils.rb +0 -43
data/test/test_i18n.rb +0 -300
data/test/test_idgxmlbuilder.rb +0 -1487
data/test/test_idgxmlmaker_cmd.rb +0 -50
data/test/test_image_finder.rb +0 -81
data/test/test_img_math.rb +0 -120
data/test/test_index.rb +0 -287
data/test/test_indexbuilder.rb +0 -52
data/test/test_latexbuilder.rb +0 -2964
data/test/test_latexbuilder_v2.rb +0 -1654
data/test/test_lineinput.rb +0 -104
data/test/test_location.rb +0 -30
data/test/test_logger.rb +0 -33
data/test/test_makerhelper.rb +0 -44
data/test/test_markdownbuilder.rb +0 -371
data/test/test_md2inaobuilder.rb +0 -90
data/test/test_pdfmaker.rb +0 -354
data/test/test_pdfmaker_cmd.rb +0 -130
data/test/test_plaintextbuilder.rb +0 -1211
data/test/test_preprocessor.rb +0 -196
data/test/test_review_ext.rb +0 -30
data/test/test_reviewheaderlistener.rb +0 -49
data/test/test_rstbuilder.rb +0 -616
data/test/test_sec_counter.rb +0 -156
data/test/test_template.rb +0 -33
data/test/test_textmaker_cmd.rb +0 -58
data/test/test_textutils.rb +0 -187
data/test/test_tocprinter.rb +0 -46
data/test/test_topbuilder.rb +0 -1298
data/test/test_update.rb +0 -473
data/test/test_webtocprinter.rb +0 -195
data/test/test_yamlloader.rb +0 -186
data/test/test_zip_exporter.rb +0 -106

data/test/test_pdfmaker.rb DELETED Viewed

@@ -1,354 +0,0 @@
-require 'test_helper'
-require 'review/pdfmaker'
-class PDFMakerTest < Test::Unit::TestCase
-  include ReVIEW
-  def setup
-    @maker = ReVIEW::PDFMaker.new
-    @config = ReVIEW::Configure.values
-    @config.merge!(
-      'bookname' => 'sample',
-      'title' => 'Sample Book',
-      'aut' => 'anonymous',
-      'review_version' => 4,
-      'urnid' => 'http://example.jp/',
-      'date' => '2020-07-11',
-      'language' => 'ja',
-      'texcommand' => 'uplatex'
-    )
-    @maker.config = @config
-    @maker.initialize_metachars(@config['texcommand'])
-    @output = StringIO.new
-    I18n.setup(@config['language'])
-  end
-  def test_check_book_existed
-    Dir.mktmpdir do |dir|
-      Dir.chdir(dir) do
-        pdf_file = File.join(dir, 'sample.pdf')
-        FileUtils.touch(pdf_file)
-        @maker.basedir = Dir.pwd
-        @maker.remove_old_file
-        assert !File.exist?(pdf_file)
-      end
-    end
-  end
-  def test_check_book_none
-    Dir.mktmpdir do
-      assert_nothing_raised do
-        @maker.basedir = Dir.pwd
-        @maker.remove_old_file
-      end
-    end
-  end
-  def test_buildpath_debug
-    @maker.config['debug'] = true
-    path = @maker.build_path
-    begin
-      assert_equal(path, 'sample-pdf')
-    ensure
-      FileUtils.remove_entry_secure(path)
-    end
-  end
-  def test_parse_opts_help
-    io = StringIO.new
-    $stdout = io
-    assert_raises SystemExit do
-      @maker.parse_opts(['-h'])
-    end
-    $stdout = STDOUT
-    io.rewind
-    str = io.gets
-    assert_equal "Usage: review-pdfmaker configfile\n", str
-  end
-  def test_parse_opts_ignore_errors
-    conf, yml = @maker.parse_opts(['--ignore-errors', 'hoge.yml'])
-    assert_equal conf['ignore-errors'], true
-    assert_equal yml, 'hoge.yml'
-  end
-  def test_make_custom_page
-    Dir.mktmpdir do |dir|
-      coverfile = 'cover.html'
-      content = '<html><body>test</body></html>'
-      File.write(File.join(dir, 'cover.tex'), content)
-      page = @maker.make_custom_page(File.join(dir, coverfile))
-      assert_equal(content, page)
-    end
-  end
-  def test_make_authors
-    @config.merge!(
-      'aut' => ['テスト太郎', 'テスト次郎'],
-      'csl' => ['監修三郎'],
-      'trl' => ['翻訳四郎', '翻訳五郎']
-    )
-    Dir.mktmpdir do
-      authors = @maker.make_authors
-      assert_equal("テスト太郎、テスト次郎　著 \\\\\n監修三郎　監修 \\\\\n翻訳四郎、翻訳五郎　訳",
-                   authors)
-    end
-  end
-  def test_make_authors_only_aut
-    @config['aut'] = 'テスト太郎'
-    Dir.mktmpdir do
-      authors = @maker.make_authors
-      assert_equal('テスト太郎　著', authors)
-    end
-  end
-  def test_make_okuduke
-    @config.merge!(
-      'aut' => ['テスト太郎', 'テスト次郎'],
-      'csl' => ['監修三郎'],
-      'trl' => ['翻訳四郎', '翻訳五郎'],
-      'dsr' => ['デザイン六郎'],
-      'ill' => ['イラスト七郎', 'イラスト八郎'],
-      'cov' => ['表紙九郎'],
-      'edt' => ['編集十郎'],
-      'pbl' => 'テスト出版',
-      'prt' => 'テスト印刷'
-    )
-    Dir.mktmpdir do
-      okuduke = @maker.make_colophon
-      assert_equal("著　者 & テスト太郎、テスト次郎 \\\\\n監　修 & 監修三郎 \\\\\n翻　訳 & 翻訳四郎、翻訳五郎 \\\\\nデザイン & デザイン六郎 \\\\\nイラスト & イラスト七郎、イラスト八郎 \\\\\n表　紙 & 表紙九郎 \\\\\n編　集 & 編集十郎 \\\\\n発行所 & テスト出版 \\\\\n印刷所 & テスト印刷 \\\\\n",
-                   okuduke)
-    end
-  end
-  def test_make_okuduke_dojin
-    @config.merge!(
-      'aut' => ['テスト太郎', 'テスト次郎'],
-      'csl' => ['監修三郎'],
-      'ill' => ['イラスト七郎', 'イラスト八郎'],
-      'pbl' => 'テスト出版',
-      'prt' => 'テスト印刷',
-      'contact' => 'tarou@example.jp'
-    )
-    Dir.mktmpdir do
-      I18n.update({ 'prt' => '印刷所' }, 'ja')
-      okuduke = @maker.make_colophon
-      assert_equal("著　者 & テスト太郎、テスト次郎 \\\\\n監　修 & 監修三郎 \\\\\nイラスト & イラスト七郎、イラスト八郎 \\\\\n発行所 & テスト出版 \\\\\n連絡先 & tarou@example.jp \\\\\n印刷所 & テスト印刷 \\\\\n",
-                   okuduke)
-    end
-  end
-  def test_template_content
-    Dir.mktmpdir do
-      @maker.basedir = Dir.pwd
-      @maker.erb_config
-      tmpl = @maker.template_content
-      expect = File.read(File.join(assets_dir, 'test_template.tex'))
-      expect.gsub!(/\\def\\review@reviewversion{[^}]+}/, "\\def\\review@reviewversion{#{ReVIEW::VERSION}}")
-      assert_equal(expect, tmpl)
-    end
-  end
-  def test_template_content_with_localconfig
-    @config['mycustom'] = { 'value' => '#_TEST_' }
-    Dir.mktmpdir do |dir|
-      Dir.chdir(dir) do
-        Dir.mkdir('layouts')
-        File.write(File.join('layouts', 'config-local.tex.erb'), %q(\def\customvalue{<%= escape(@config['mycustom']['value']) %>}) + "\n")
-        @maker.basedir = Dir.pwd
-        @maker.erb_config
-        tmpl = @maker.template_content
-        expect = File.read(File.join(assets_dir, 'test_template.tex'))
-        expect.gsub!(/\\def\\review@reviewversion{[^}]+}/, "\\def\\review@reviewversion{#{ReVIEW::VERSION}}")
-        expect.sub!("\\makeatother\n", '\&' + "%% BEGIN: config-local.tex.erb\n\\def\\customvalue{\\#\\textunderscore{}TEST\\textunderscore{}}\n%% END: config-local.tex.erb\n")
-        assert_equal(expect, tmpl)
-      end
-    end
-  end
-  def test_template_content_with_invalid_localconfig
-    Dir.mktmpdir do |dir|
-      Dir.chdir(dir) do
-        Dir.mkdir('layouts')
-        File.write(File.join('layouts', 'config-local.tex.erb'), %q(<%= not_existed_method %>\n))
-        @maker.basedir = Dir.pwd
-        @maker.erb_config
-        @maker.instance_eval do
-          def error!(msg)
-            msg
-          end
-        end
-        error_msg = @maker.template_content
-        assert_match(/template or configuration error:/, error_msg)
-        assert_match(/undefined local variable or method `not_existed_method'/, error_msg)
-      end
-    end
-  end
-  def test_gettemplate_with_backmatter
-    @config.merge!(
-      'backcover' => 'backcover.tex',
-      'profile' => 'profile.tex',
-      'advfile' => 'advfile.tex'
-    )
-    Dir.mktmpdir do |dir|
-      Dir.chdir(dir) do
-        profile = "\\thispagestyle{empty}\\chapter*{Profile}\nsome profile\n"
-        File.write(File.join(dir, 'profile.tex'), profile)
-        advfile = "\\thispagestyle{empty}\\chapter*{Ad}\nsome ad content\n"
-        File.write(File.join(dir, 'advfile.tex'), advfile)
-        backcover = "\\clearpage\n\\thispagestyle{empty}\\AddToShipoutPictureBG{%\n\\AtPageLowerLeft{\\includegraphics[width=\\paperwidth,height=\\paperheight]{images/backcover.png}}\n}\n\\null"
-        File.write(File.join(dir, 'backcover.tex'), backcover)
-        expect = File.read(File.join(assets_dir, 'test_template_backmatter.tex'))
-        expect.gsub!(/\\def\\review@reviewversion{[^}]+}/, "\\def\\review@reviewversion{#{ReVIEW::VERSION}}")
-        @maker.basedir = Dir.pwd
-        @maker.erb_config
-        tmpl = @maker.template_content
-        assert_equal(expect, tmpl)
-      end
-    end
-  end
-  def test_colophon_history
-    @config['aut'] = ['Mr.Smith']
-    @config['pbl'] = ['BLUEPRINT']
-    @config['pht'] = ['Mrs.Smith']
-    @config['language'] = 'ja'
-    history = @maker.make_history_list
-    expect = ['2020年7月11日　発行']
-    assert_equal expect, history
-  end
-  def test_colophon_history_2
-    @config['aut'] = ['Mr.Smith']
-    @config['pbl'] = ['BLUEPRINT']
-    @config['pht'] = ['Mrs.Smith']
-    @config['language'] = 'ja'
-    @config['history'] =
-      [['2011-08-03 v1.0.0版発行',
-        '2020-07-11 v1.2.0版発行']]
-    history = @maker.make_history_list
-    expect = ['2011年8月3日　v1.0.0版発行', '2020年7月11日　v1.2.0版発行']
-    assert_equal expect, history
-  end
-  def test_colophon_history_date
-    @config['aut'] = ['Mr.Smith']
-    @config['pbl'] = ['BLUEPRINT']
-    @config['pht'] = ['Mrs.Smith']
-    @config['language'] = 'ja'
-    @config['history'] =
-      [['2011-08-03',
-        '2012-02-15']]
-    history = @maker.make_history_list
-    expect = ['2011年8月3日　初版第1刷　発行',
-              '2012年2月15日　初版第2刷　発行']
-    assert_equal expect, history
-  end
-  def test_colophon_history_date2
-    @config['aut'] = ['Mr.Smith']
-    @config['pbl'] = ['BLUEPRINT']
-    @config['pht'] = ['Mrs.Smith']
-    @config['language'] = 'ja'
-    @config['history'] =
-      [['2011-08-03',
-        '2012-02-15'],
-       ['2012-10-01'],
-       ['2013-03-01']]
-    history = @maker.make_history_list
-    expect = ['2011年8月3日　初版第1刷　発行',
-              '2012年2月15日　初版第2刷　発行',
-              '2012年10月1日　第2版第1刷　発行',
-              '2013年3月1日　第3版第1刷　発行']
-    assert_equal expect, history
-  end
-  def test_colophon_history_freeformat
-    @config['aut'] = ['Mr.Smith']
-    @config['pbl'] = ['BLUEPRINT']
-    @config['pht'] = ['Mrs.Smith']
-    @config['language'] = 'ja'
-    @config['history'] =
-      [['2011年8月3日 ver 1.1.0発行'],
-       ['2011年10月12日 ver 1.2.0発行'],
-       ['2012年1月31日 ver 1.2.1発行']]
-    history = @maker.make_history_list
-    expect = ['2011年8月3日 ver 1.1.0発行',
-              '2011年10月12日 ver 1.2.0発行',
-              '2012年1月31日 ver 1.2.1発行']
-    assert_equal expect, history
-  end
-  def test_box_setting_is_defined
-    %w[column note memo tip info warning important caution notice].each do |name|
-      @config['pdfmaker']['boxsetting'] = {
-        name => { 'style' => 'simplebox' }
-      }
-      assert !ReVIEW::LaTeXBox.new.tcbox(@config).empty?
-    end
-    @config['pdfmaker']['boxsetting'] = {
-      'invalid' => { 'style' => 'simplebox' }
-    }
-    assert ReVIEW::LaTeXBox.new.tcbox(@config).empty?
-  end
-  def test_box_setting_options
-    @config['pdfmaker']['boxsetting'] = {
-      'note' => { 'style' => 'simplebox' },
-      'important' => { 'style' => 'simplebox', 'options' => 'colback=blue,arc=3mm' },
-      'caution' => { 'style' => 'squarecaptionbox', 'options_with_caption' => 'attach boxed title to top bottom' }
-    }
-    expected = <<-EOS
-\\renewenvironment{reviewnote}[1][]{%
-  \\csdef{rv@tmp@withcaption}{true}
-  \\notblank{##1}{
-    \\begin{rv@simplebox@caption}{##1}[]
-   }{
-    \\csundef{rv@tmp@withcaption}
-    \\begin{rv@simplebox@nocaption}[]
-   }
-}{
-  \\ifcsdef{rv@tmp@withcaption}{
-    \\end{rv@simplebox@caption}
-  }{
-    \\end{rv@simplebox@nocaption}
-  }
-}
-\\renewenvironment{reviewimportant}[1][]{%
-  \\csdef{rv@tmp@withcaption}{true}
-  \\notblank{##1}{
-    \\begin{rv@simplebox@caption}{##1}[colback=blue,arc=3mm]
-   }{
-    \\csundef{rv@tmp@withcaption}
-    \\begin{rv@simplebox@nocaption}[colback=blue,arc=3mm]
-   }
-}{
-  \\ifcsdef{rv@tmp@withcaption}{
-    \\end{rv@simplebox@caption}
-  }{
-    \\end{rv@simplebox@nocaption}
-  }
-}
-\\renewenvironment{reviewcaution}[1][]{%
-  \\csdef{rv@tmp@withcaption}{true}
-  \\notblank{##1}{
-    \\begin{rv@squarecaptionbox@caption}{##1}[attach boxed title to top bottom]
-   }{
-    \\csundef{rv@tmp@withcaption}
-    \\begin{rv@squarecaptionbox@nocaption}[]
-   }
-}{
-  \\ifcsdef{rv@tmp@withcaption}{
-    \\end{rv@squarecaptionbox@caption}
-  }{
-    \\end{rv@squarecaptionbox@nocaption}
-  }
-}
-EOS
-    actual = ReVIEW::LaTeXBox.new.tcbox(@config)
-    assert_equal expected, actual
-  end
-end

data/test/test_pdfmaker_cmd.rb DELETED Viewed

@@ -1,130 +0,0 @@
-require 'test_helper'
-require 'tmpdir'
-require 'fileutils'
-require 'yaml'
-require 'rbconfig'
-require 'open3'
-REVIEW_PDFMAKER = File.expand_path('../bin/review-pdfmaker', __dir__)
-class PDFMakerCmdTest < Test::Unit::TestCase
-  def setup
-    @tmpdir1 = Dir.mktmpdir
-    @old_rubylib = ENV['RUBYLIB']
-    ENV['RUBYLIB'] = File.expand_path('../lib', __dir__)
-  end
-  def teardown
-    FileUtils.rm_rf(@tmpdir1)
-    ENV['RUBYLIB'] = @old_rubylib
-  end
-  def common_buildpdf(bookdir, templatedir, configfile, targetpdffile, option = nil)
-    unless /mswin|mingw|cygwin/.match?(RUBY_PLATFORM)
-      config = prepare_samplebook(@tmpdir1, bookdir, templatedir, configfile)
-      builddir = File.join(@tmpdir1, config['bookname'] + '-pdf')
-      assert !File.exist?(builddir)
-      ruby_cmd = File.join(RbConfig::CONFIG['bindir'], RbConfig::CONFIG['ruby_install_name'])
-      Dir.chdir(@tmpdir1) do
-        _o, e, s = Open3.capture3("#{ruby_cmd} -S #{REVIEW_PDFMAKER} #{option} #{configfile}")
-        if !e.empty? && !s.success?
-          $stderr.puts e
-        end
-        assert s.success?
-      end
-      assert File.exist?(File.join(@tmpdir1, targetpdffile))
-    end
-  end
-  def test_pdfmaker_cmd_sample_jsbook_print
-    begin
-      `uplatex -v`
-    rescue StandardError
-      $stderr.puts 'skip test_pdfmaker_cmd_sample_jsbook_print'
-      return true
-    end
-    common_buildpdf('sample-book/src', 'review-jsbook', 'config.yml', 'book.pdf')
-  end
-  def test_pdfmaker_cmd_sample_jsbook_ebook
-    begin
-      `uplatex -v`
-    rescue StandardError
-      $stderr.puts 'skip test_pdfmaker_cmd_sample_jsbook_ebook'
-      return true
-    end
-    common_buildpdf('sample-book/src', 'review-jsbook', 'config-ebook.yml', 'book.pdf')
-  end
-  def test_pdfmaker_cmd_sample_jlreq_print
-    begin
-      `uplatex -v`
-    rescue StandardError
-      $stderr.puts 'skip test_pdfmaker_cmd_sample_jlreq_print'
-      return true
-    end
-    common_buildpdf('sample-book/src', 'review-jlreq', 'config-jlreq.yml', 'book.pdf')
-  end
-  def test_pdfmaker_cmd_sample_jlreq_ebook
-    begin
-      `uplatex -v`
-    rescue StandardError
-      $stderr.puts 'skip test_pdfmaker_cmd_sample_jlreq_ebook'
-      return true
-    end
-    common_buildpdf('sample-book/src', 'review-jlreq', 'config-jlreq-ebook.yml', 'book.pdf')
-  end
-  def test_pdfmaker_cmd_syntax_jsbook_print
-    begin
-      `uplatex -v`
-    rescue StandardError
-      $stderr.puts 'skip test_pdfmaker_cmd_syntax_jsbook_print'
-      return true
-    end
-    common_buildpdf('syntax-book', 'review-jsbook', 'config-print.yml', 'syntax-book.pdf')
-  end
-  def test_pdfmaker_cmd_syntax_jsbook_print_buildonly
-    begin
-      `uplatex -v`
-    rescue StandardError
-      $stderr.puts 'skip test_pdfmaker_cmd_syntax_jsbook_print_buildonly'
-      return true
-    end
-    common_buildpdf('syntax-book', 'review-jsbook', 'config-print.yml', 'syntax-book.pdf', '-y ch01')
-  end
-  def test_pdfmaker_cmd_syntax_jsbook_ebook
-    begin
-      `uplatex -v`
-    rescue StandardError
-      $stderr.puts 'skip test_pdfmaker_cmd_syntax_jsbook_ebook'
-      return true
-    end
-    common_buildpdf('syntax-book', 'review-jsbook', 'config.yml', 'syntax-book.pdf')
-  end
-  def test_pdfmaker_cmd_syntax_jlreq_ebook
-    begin
-      `uplatex -v`
-    rescue StandardError
-      $stderr.puts 'skip test_pdfmaker_cmd_syntax_jlreq_ebook'
-      return true
-    end
-    common_buildpdf('syntax-book', 'review-jlreq', 'config-jlreq.yml', 'syntax-book.pdf')
-  end
-  def test_pdfmaker_cmd_syntax_jlreq_ebook_lualatex
-    begin
-      `lualatex -v`
-    rescue StandardError
-      $stderr.puts 'skip test_pdfmaker_cmd_syntax_jlreq_ebook_lualatex'
-      return true
-    end
-    common_buildpdf('syntax-book', 'review-jlreq', 'config-jlreq-lualatex.yml', 'syntax-book.pdf')
-  end
-end