aozora2html 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 635bbe67e2511af4a4f8ccc8a820bdb87991d75d88fa9aa7ca9a90f2f67d7785
-  data.tar.gz: ac7c5d1f77f0c4b89d24f93e6117107d3ee4ac5890aef5e082368f0fa7e8e318
+  metadata.gz: 5a2a25b5bae94f8cd3f95db62357eb5de12a99fafe7681132ca045067f72dadc
+  data.tar.gz: 8e4474f765260485a1f4917de8cf8b81438f6a6863b2614b9e5d3f9d50abca29
 SHA512:
-  metadata.gz: a939ef551dd506ae1f7ca4d608fbbe747aa7b4ada56a07fd83385c330fade541353d80f66fa8f4ed5d1342cd01d65af74c6c973ed2979c1dce12dcc7b10830a2
-  data.tar.gz: 5c982a53cdffc60bad3c98406b74f640af4c1896fed6b42398a91025788962b4d2377950d40a0b25e4553fd92f94ac69c4ed8ac34fa21918cd0cb2148a1b0def
+  metadata.gz: b61e229c27b0b90fca3982e566b7fd51683ee9cabc0c1b77988c46d994ac5fb20d295ad5916da8b7a70947337bad034f45780ad335b9f9993562cf655e6b056f
+  data.tar.gz: 4c693c649646c27596545ae7f0577b1336d9afdb21d6380f63f9e2558253796b1c37d54818a9cc90414a01cf0fdcf5e1e01b2997a31fc86a1c770d9d42e3b5ac

data/.github/workflows/rubocop.yml

@@ -0,0 +1,19 @@
+name: rubocop
+on: [pull_request]
+jobs:
+  rubocop:
+    name: runner / rubocop
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v2
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0.3
+          bundler-cache: true
+      - name: Run rubocop
+        run: |
+          gem install bundler --no-document
+          bundle install --retry 3
+          bundle exec rubocop -P

data/.github/workflows/ruby.yml

@@ -18,8 +18,11 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '3.0', '2.7', '2.6', '2.5', '2.4' ]
+        ruby: [ '3.1', '3.0', '2.7' ]
         os: [ubuntu-latest, macos-latest, windows-latest]
+        exclude:
+        - os: windows-latest
+          ruby: '3.1'
     steps:
     - uses: actions/checkout@v1
     - name: Set up Ruby

data/.rubocop.yml

@@ -1,175 +1,78 @@
-inherit_gem:
-  meowcop:
-    - config/rubocop.yml
+inherit_from: .rubocop_todo.yml
 
-AllCops:
-  TargetRubyVersion: 2.1
+# inherit_from: .rubocop_todo.yml
 
-# EnforcedStyle: with_first_parameter => 0 offense
-# EnforcedStyle: with_fixed_indentation => 17 offenses
-Layout/AlignParameters:
-  EnforcedStyle: with_first_parameter
-  Enabled: true
+require:
+  - rubocop-performance
+  - rubocop-rake
 
-# EnforcedStyle: empty_lines => 80 offenses
-# EnforcedStyle: no_empty_lines => 0 offense
-Layout/EmptyLinesAroundBlockBody:
-  EnforcedStyle: no_empty_lines
-  Enabled: true
-
-# EnforcedStyleInsidePipes: space => 39 offenses
-# EnforcedStyleInsidePipes: no_space => 0 offense
-Layout/SpaceAroundBlockParameters:
-  EnforcedStyleInsidePipes: no_space
-  Enabled: true
-
-# EnforcedStyle: space => 42 offenses
-# EnforcedStyle: no_space => 4 offenses
-Layout/SpaceBeforeBlockBraces:
-  EnforcedStyle: no_space
-  Enabled: true
-
-# EnforcedStyle: space => 98 offenses
-# EnforcedStyle: no_space => 0 offense
-Layout/SpaceInsideStringInterpolation:
-  EnforcedStyle: no_space
-  Enabled: true
+AllCops:
+  TargetRubyVersion: 2.7
+  NewCops: enable
 
-# EnforcedStyle: percent_q => 0 offense
-# EnforcedStyle: bare_percent => 30 offenses
 Style/BarePercentLiterals:
   EnforcedStyle: percent_q
-  Enabled: true
 
-# EnforcedStyle: nested => 2 offenses
-# EnforcedStyle: compact => 81 offenses
-Style/ClassAndModuleChildren:
-  EnforcedStyle: nested
-  Enabled: true
+Style/Documentation:
+  Exclude:
+    - 'test/**/*'
 
-# EnforcedStyle: compact => 24 offenses
-# EnforcedStyle: expanded => 0 offense
 Style/EmptyMethod:
   EnforcedStyle: expanded
   Enabled: true
 
-# EnforcedStyle: when_needed => 10 offenses
-# EnforcedStyle: always => 57 offenses
-# EnforcedStyle: never => 32 offenses
-Style/Encoding:
-  EnforcedStyle: when_needed
-  Enabled: true
-
-# EnforcedStyle: for => 13 offenses
-# EnforcedStyle: each => 0 offense
-Style/For:
-  EnforcedStyle: each
-  Enabled: true
-
-# EnforcedStyle: require_parentheses => 0 offense
-# EnforcedStyle: require_no_parentheses => 112 offenses
-# EnforcedStyle: require_no_parentheses_except_multiline => 112 offenses
-Style/MethodDefParentheses:
-  EnforcedStyle: require_parentheses
-  Enabled: true
-
-# EnforcedStyle: snake_case => 0 offense
-# EnforcedStyle: camelCase => 268 offenses
-Style/MethodName:
-  EnforcedStyle: snake_case
-  Enabled: true
-
-# EnforcedStyle: compact => 25 offenses
-# EnforcedStyle: exploded => 0 offense
-Style/RaiseArgs:
-  EnforcedStyle: exploded
-  Enabled: true
-
-# EnforcedStyle: only_raise => 0 offense
-# EnforcedStyle: only_fail => 26 offenses
-# EnforcedStyle: semantic => 25 offenses
-Style/SignalException:
-  EnforcedStyle: only_raise
-  Enabled: true
-
-# EnforcedStyle: snake_case => 0 offense
-# EnforcedStyle: camelCase => 126 offenses
-Style/VariableName:
-  EnforcedStyle: snake_case
-  Enabled: true
-
-# EnforcedStyle: snake_case => 11 offenses
-# EnforcedStyle: normalcase => 0 offense
-# EnforcedStyle: non_integer => 11 offenses
-Style/VariableNumber:
-  EnforcedStyle: normalcase
-  Enabled: true
+Style/FormatString:
+  EnforcedStyle: sprintf
 
-Style/StringLiterals:
-  Enabled: false
+Style/FormatStringToken:
+  EnforcedStyle: unannotated
 
-Layout/SpaceAfterComma:
-  Enabled: false
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - 'lib/aozora2html.rb'
 
-Layout/SpaceAroundOperators:
-  Enabled: false
-
-Layout/SpaceInsideBlockBraces:
-  Enabled: false
-
-Style/UnneededPercentQ:
+Style/RedundantPercentQ:
   Enabled: false
 
 Style/PercentQLiterals:
   Enabled: false
 
-Style/SpecialGlobalVars:
-  Enabled: false
-
-Style/Encoding:
-  Enabled: false
-
 Style/ParallelAssignment:
   Enabled: false
 
-Style/IfInsideElse:
-  Enabled: false
-
-Style/PercentLiteralDelimiters:
-  Enabled: false
-
-Style/ClassCheck:
-  Enabled: false
-
-Style/RedundantBegin:
-  Enabled: false
-
-Layout/EmptyLineAfterMagicComment:
-  Enabled: false
-
 Style/AsciiComments:
   Enabled: false
 
 Style/LineEndConcatenation:
   Enabled: false
 
-Style/MethodCallWithoutArgsParentheses:
+Style/IfUnlessModifier:
   Enabled: false
 
-Style/GlobalVars:
+Style/NumericPredicate:
   Enabled: false
 
-Style/IfUnlessModifier:
+Style/PerlBackrefs:
   Enabled: false
 
-Style/NumericPredicate:
+Style/SpecialGlobalVars:
   Enabled: false
 
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+Style/WordArray:
+  EnforcedStyle: brackets
+
 Style/ZeroLengthPredicate:
   Enabled: false
 
-Layout/TrailingBlankLines:
-  Enabled: false
+Layout/LineLength:
+  Enabled: true
+  Max: 500
+
+Lint/EmptyClass:
+  AllowComments: true
 
 Metrics/AbcSize:
   Enabled: true
@@ -191,17 +94,13 @@ Metrics/CyclomaticComplexity:
   Enabled: true
   Max: 100
 
-Metrics/LineLength:
-  Enabled: true
-  Max: 500
-
 Metrics/MethodLength:
   Enabled: true
   Max: 200
 
 Metrics/ModuleLength:
   Enabled: true
-  Max: 100
+  Max: 200
 
 Metrics/ParameterLists:
   Enabled: true
@@ -210,18 +109,3 @@ Metrics/ParameterLists:
 Metrics/PerceivedComplexity:
   Enabled: true
   Max: 100
-
-
-###
-Performance/RedundantMatch:
-  Enabled: false
-Performance/StringReplacement:
-  Enabled: false
-Layout/SpaceBeforeBlockBraces:
-  Enabled: false
-
-### あとで直す
-Lint/StringConversionInInterpolation:
-  Enabled: false
-Style/ClassAndModuleChildren:
-  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,7 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config --exclude-limit 99999 --no-offense-counts --no-auto-gen-timestamp`
+# using RuboCop version 1.23.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.

data/CHANGELOG.md

@@ -1,3 +1,29 @@
+<a name="3.0.0"></a>
+## 3.0.0
+
+### Breaking Changes
+
+* Ruby 2.7未満をサポート対象外にしました。Ruby 3.0以降を推奨します。それ以前のRubyを使われる場合はv2.0.0をご利用ください https://github.com/aozorahack/aozora2html/pull/49
+* t2hs.rbを廃止し、bin/aozora2html以外からは実行できなくしました https://github.com/aozorahack/aozora2html/pull/65　
+* t2hs.rbにあったメソッドのうち、通常外部から使われないメソッドをprivateにしました https://github.com/aozorahack/aozora2html/pull/93
+
+### Bug Fixes
+
+* 以前は全角空白であったところが半角空白になっていたので修正しました https://github.com/aozorahack/aozora2html/pull/62
+
+### Features
+
+* エラーメッセージがUTF-8になる `--error-utf8` オプションを追加しました https://github.com/aozorahack/aozora2html/pull/72
+* `sample/chukiichiran_kinyurei.txt`に他の例を追加しました https://github.com/aozorahack/aozora2html/pull/78
+* `rake chuuki`で`sample/chukiichiran_kinyurei.txt`を`sample/chukiichiran_kinyurei.html`に変換できるrakeタスクを追加しました https://github.com/aozorahack/aozora2html/pull/95
+
+<a name="2.0.0"></a>
+## 2.0.0
+
+### Bug Fixes
+
+* Ruby 3.0でエラーになる挙動を修正しました https://github.com/aozorahack/aozora2html/pull/36, https://github.com/aozorahack/aozora2html/pull/41
+
 <a name="0.9.1"></a>
 ## 0.9.1
 

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in aozora2html.gemspec

data/Guardfile

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 guard :test do
   watch(%r{^test/test_.+\.rb$})
-  watch('test/test_helper.rb')  { 'test' }
+  watch('test/test_helper.rb') { 'test' }
 
   # Non-rails
   watch(%r{^lib/(.+)\.rb$}) { |m| "test/#{m[1]}_test.rb" }

data/HACKING.md

@@ -0,0 +1,45 @@
+# HACKING
+
+aozora2htmlの技術的なnoteです。
+
+## `char_type`について
+
+aozora2htmlでは、`String#char_type`というメソッドが追加されています。
+
+`char_type`はルビの範囲を判別するために使われるメソッドです。
+
+* ひらがな: :hiragana
+* カタカナ: :katakana
+* 全角英数(ギリシア文字含む): :zenkaku
+* 半角英数(記号#-&',含む): :hankaku
+* 漢字: :kanji
+* 半角句読点等(.;"?!)): :hankaku_terminate
+* その他: :else
+
+欧文アクセント文字は半角英数、濁点つきカタカナはカタカナ、外字は漢字、訓点はその他、ルビ付き文字はその他になります。
+
+RubyBufferも`RubyBuffer#char_type`を持っています。これはRubyBufferの中身次第で変更されます。複数のchar_typeを内部で持つ場合、char_typeは:elseになります。
+
+
+## `Aozora2Html::TextBuffer`について
+
+古いRubyでは、`Array#to_s`はArrayの全要素が文字列だった場合、`join`と同じ挙動でした。
+
+現在のRubyでは、同様のことをするには`Array#join`を使わなければならなくなっており、`Array#to_s`をすると`[]`等が出力されます。これは埋め込み文字列に使った場合も同様です。
+そのため、aozora2htmlでは`Array`の代わりに`Aozora2Html::TextBuffer`クラスを導入しています。`Aozora2Html::TextBuffer#to_s`は適切な文字列を返します。
+
+
+## `Jstream`について
+
+`JStream`は`IO`の代わりとなるクラスです。
+
+主に、読み込み行の行数の管理と、任意の文字数の先読みを行うために使われています。
+
+先読みは同一行内のみ有効で、CRLFを超える先読みは動作が保証されません。
+
+
+## `Aozora2Html::Tag::Multiline`について
+
+`Aozora2Html::Tag::Multiline`は、そのタグが複数行であることを表すマーカー用のモジュールです。
+
+マーカーとして使われるため、メソッド等は特に持っていない、空のモジュールとして実装されています。実行中に追加されたりすることもありません。

data/README.md

@@ -1,6 +1,5 @@
 # Aozora2Html
 
-[![Build Status](https://travis-ci.org/aozorahack/aozora2html.svg?branch=master)](https://travis-ci.org/aozorahack/aozora2html)
 [![Build Status](https://github.com/aozorahack/aozora2html/workflows/Test/badge.svg)](https://github.com/aozorahack/aozora2html/actions)
 [![Gem Version](https://badge.fury.io/rb/aozora2html.svg)](https://badge.fury.io/rb/aozora2html)
 [![Code Climate](https://codeclimate.com/github/aozorahack/aozora2html/badges/gpa.svg)](https://codeclimate.com/github/aozorahack/aozora2html)
@@ -9,7 +8,9 @@
 
 ## 動作環境
 
-Ruby 2.0以上が推奨ですが、1.9でも動くはずです。
+Ruby 3.0以上が推奨ですが、2.7.xでも動くはずです。
+
+それ以前のRuby 2.xで利用する場合は、aozora2html-2.0.xをご利用ください。
 
 ## インストール
 
@@ -54,10 +55,13 @@ $ aozora2html http://example.jp/foo/bar.zip foo.html
 $ aozora2html foo.txt
 ```
 
-コマンドラインオプションとして`--gaiji-dir`と`--use-jisx0213`、`--use-unicode`があります。
-`--gaiji-dir`は外字画像のパスを指定します。
-`--use-jisx0213`はJIS X 0213の外字画像を使わず、数値実体参照として表示します。
-`--use-unicode`はUnicodeのコードポイントが指定されている外字を数値実体参照として表示します。
+コマンドラインオプションとして`--gaiji-dir`と`--css-files`、`--use-jisx0213`、`--use-unicode`、`--error-utf8`があります。
+
+* `--gaiji-dir`は外字画像のパスを指定します。
+* `--css-files`はCSSファイルを`,`区切りで指定します。
+* `--use-jisx0213`はJIS X 0213の外字画像を使わず、数値実体参照として表示します。
+* `--use-unicode`はUnicodeのコードポイントが指定されている外字を数値実体参照として表示します。
+* `--error-utf8`はエラーメッセージをUTF-8で出力するようにします。
 
 可能な限り数値実体参照を使って表示するには、以下のようにオプションを指定します。
 
@@ -78,6 +82,10 @@ $ rake test
 
 主な更新履歴は[CHANGELOG.md](CHANGELOG.md)にあります。
 
+## コードについて
+
+コードに関する技術的なnoteは[HACKING.md](HACKING.md)にあります。
+
 ## License
 
 CC0

data/Rakefile

@@ -1,12 +1,19 @@
+# frozen_string_literal: true
+
 require 'rubygems'
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 require 'rake/testtask'
 require 'rake/clean'
 
-task :default => [:test]
+task default: [:test]
 
-Rake::TestTask.new("test") do |t|
-  t.libs   << "test"
-  t.test_files = Dir.glob("test/**/test_*.rb")
+Rake::TestTask.new('test') do |t|
+  t.libs << 'test'
+  t.test_files = Dir.glob('test/**/test_*.rb')
   t.verbose = true
 end
+
+desc 'convert sample/chukiichiran_kinyurei.txt'
+task :chuuki do
+  sh 'bundle exec aozora2html --error-utf8 sample/chukiichiran_kinyurei.txt sample/chukiichiran_kinyurei.html'
+end

data/aozora2html.gemspec

@@ -1,33 +1,35 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'aozora2html/version'
+# frozen_string_literal: true
+
+require_relative 'lib/aozora2html/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "aozora2html"
+  spec.name          = 'aozora2html'
   spec.version       = Aozora2Html::VERSION
   spec.platform      = Gem::Platform::RUBY
-  spec.license       = "CC0"
-  spec.authors       = ["aozorahack team"]
-  spec.email         = ["takahashimm@gmail.com"]
+  spec.license       = 'CC0'
+  spec.authors       = ['aozorahack team']
+  spec.email         = ['takahashimm@gmail.com']
 
-  spec.summary       = %q{converter from Aozora Bunko format into xhtml. It's based of t2hs.rb from kumihan.aozora.gr.jp.}
-  spec.description   = %q{converter from Aozora Bunko format into xhtml. It's based of t2hs.rb from kumihan.aozora.gr.jp.}
-  spec.homepage      = "https://github.com/aozorahack/aozora2html"
+  spec.summary       = %q(converter from Aozora Bunko format into xhtml. It's based of t2hs.rb from kumihan.aozora.gr.jp.)
+  spec.description   = %q(converter from Aozora Bunko format into xhtml. It's based of t2hs.rb from kumihan.aozora.gr.jp.)
+  spec.homepage      = 'https://github.com/aozorahack/aozora2html'
 
+  spec.required_ruby_version = '>= 2.7.0'
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "bin"
+  spec.bindir        = 'bin'
   spec.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  if RUBY_VERSION < "2.4.0"
-    spec.add_dependency "rubyzip", "~> 1.3"
-  else
-    spec.add_dependency "rubyzip", "~> 2.0"
-  end
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake", "~> 12.0"
-  spec.add_development_dependency "test-unit"
-  spec.add_development_dependency "test-unit-rr"
+  spec.add_dependency 'rubyzip'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-performance'
+  spec.add_development_dependency 'rubocop-rake'
+  spec.add_development_dependency 'test-unit'
+  spec.add_development_dependency 'test-unit-rr'
+  spec.metadata = {
+    'rubygems_mfa_required' => 'true'
+  }
 end

data/bin/aozora2html

@@ -1,8 +1,9 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'aozora2html'
 require 'optparse'
-require "tempfile"
+require 'tempfile'
 require 'open-uri'
 
 opt = OptionParser.new("Usage: aozora2html [options] <text file> [<html file>]\n")
@@ -10,26 +11,27 @@ opt.on('--gaiji-dir DIR', 'setting gaiji directory')
 opt.on('--css-files FILES', 'setting css directory')
 opt.on('--use-jisx0213', 'use JIS X 0213 character')
 opt.on('--use-unicode', 'use Unicode character')
+opt.on('--error-utf8', 'show error messages in UTF-8, not Shift_JIS')
 opt.version = Aozora2Html::VERSION
 options = opt.getopts
 
-if options["gaiji-dir"]
-  $gaiji_dir = options["gaiji-dir"]
-end
+gaiji_dir = options['gaiji-dir'] || nil
 
-if options["css-files"]
-  $css_files = options["css-files"].split(",")
-end
+css_files = options['css-files']&.split(',')
 
-if options["use-jisx0213"]
+if options['use-jisx0213']
   Aozora2Html::Tag::EmbedGaiji.use_jisx0213 = true
   Aozora2Html::Tag::Accent.use_jisx0213 = true
 end
 
-if options["use-unicode"]
+if options['use-unicode']
   Aozora2Html::Tag::EmbedGaiji.use_unicode = true
 end
 
+if options['error-utf8']
+  Aozora2Html::I18n.use_utf8 = true
+end
+
 if ARGV.size < 1 || ARGV.size > 2
   $stderr.print opt.banner
   exit 1
@@ -39,34 +41,34 @@ src_file, dest_file = ARGV[0], ARGV[1]
 
 Dir.mktmpdir do |dir|
   if dest_file.nil?
-    dest_file = File.join(dir, "output.html")
+    dest_file = File.join(dir, 'output.html')
   end
-  if src_file =~ /\Ahttps?:/
+  if /\Ahttps?:/.match?(src_file)
     down_file = File.join(dir, File.basename(src_file))
     begin
       File.write(down_file, URI.parse(src_file).read)
       src_file = down_file
-    rescue
+    rescue StandardError
       $stderr.print "file not found: #{src_file}\n"
       $stderr.print "Download Error: #{$!}\n"
       exit 1
     end
   else
-    if !File.exist?(src_file)
+    unless File.exist?(src_file)
       $stderr.print "file not found: #{src_file}\n"
       exit 1
     end
   end
 
-  if File.extname(src_file) == ".zip"
-    require "aozora2html/zip"
-    tmpfile = File.join(dir, "aozora.txt")
+  if File.extname(src_file) == '.zip'
+    require 'aozora2html/zip'
+    tmpfile = File.join(dir, 'aozora.txt')
     Aozora2Html::Zip.unzip(src_file, tmpfile)
-    Aozora2Html.new(tmpfile, dest_file).process
+    Aozora2Html.new(tmpfile, dest_file, gaiji_dir: gaiji_dir, css_files: css_files).process
   else
-    Aozora2Html.new(src_file, dest_file).process
+    Aozora2Html.new(src_file, dest_file, gaiji_dir: gaiji_dir, css_files: css_files).process
   end
-  if !ARGV[1]
+  unless ARGV[1]
     output = File.read(dest_file)
     print output
   end