jkf 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10de9aac464bd36cb02f25fe54861977cef819870cfe2b35d8f9741b119c3165
-  data.tar.gz: 9a9271b5bf437c8d3a493732046ee3b86c50a4c26313c975a0041e9d8d91e290
+  metadata.gz: 365393f77c09c5ca61d79d520d1e8700449f66b9c5f8dd98f3c533d08b5205d6
+  data.tar.gz: de3a842b9d14005cfff7e9e4d41129b58d0fd9713b91def327e3e579c227498c
 SHA512:
-  metadata.gz: 778bd58dffa3e570cb4f9a4f235518d402f8e135b1a33f7e3f3758d71807b3a6e0b9f77bda86ec6da478da9932a0dc242e3a979a2318f02c47dcd3023b899615
-  data.tar.gz: 9f52cef3917dc571e3edd7bad14b6e3d8a3debd7da08dfa480f7b3861db7fbe23c63a4b7eb06c11f7322eec7176a7f08dcee29e216d5b7d6a51ef96ea484d470
+  metadata.gz: 290f7bd7bec9ccf530ae186a6ee5293827be45fb4b9c3e719d355044b00695d3656e62fd47111d7a7c031ed007d369b51f45518ba48b71a9e80b82dba2b093db
+  data.tar.gz: c6d9965c4d109352d9fab43dbc17647ded822e02ea24ff41755194c70f8523d7636b43b04df891e127d070bf235c93a63815749adda2b0780260f66778122442

data/.envrc

@@ -0,0 +1 @@
+use guix

data/.rubocop.yml

@@ -7,6 +7,7 @@ AllCops:
 require:
   - rubocop-rake
   - rubocop-rspec
+  - rubocop-performance
 
 Style/FrozenStringLiteralComment:
   Enabled: true
@@ -63,3 +64,12 @@ Style/StringLiterals:
 
 Style/GuardClause:
   Enabled: true
+
+Performance/StringInclude:
+  Enabled: true
+
+Performance/RegexpMatch:
+  Enabled: true
+
+Performance/MapCompact:
+  Enabled: true

data/.yardopts

@@ -0,0 +1,4 @@
+-
+README.md
+README.en.md
+CHANGELOG.md

data/CHANGELOG.md

@@ -7,6 +7,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## 0.5.2 - 2024-10-26
+
+This is a maintenance release.
+
+### Others
+
+* Lint with RuboCop performance plugin
+* Update documentation
+* Update gem dependencies; RuboCop and RuboCop RSpec.
+
 ## [0.5.1] - 2023-06-24
 
 ### Changed

data/Gemfile

@@ -5,17 +5,18 @@ gemspec
 gem 'rake'
 
 group :development do
-  gem 'redcarpet', require: false
-  gem 'yard', require: false
+  gem 'redcarpet'
+  gem 'yard'
 
-  gem 'guard-rubocop', require: false
-  gem 'rubocop', '~> 1.32.0', require: false
-  gem 'rubocop-rake', '~> 0.6.0', require: false
-  gem 'rubocop-rspec', '~> 2.12', require: false
+  gem 'guard-rubocop'
+  gem 'rubocop', '~> 1.63'
+  gem 'rubocop-performance'
+  gem 'rubocop-rake', '~> 0.6.0'
+  gem 'rubocop-rspec', '~> 3.1'
 end
 
 group :test do
-  gem 'guard-rspec', require: false
-  gem 'rspec', '~> 3.0', require: false
-  gem 'simplecov', require: false
+  gem 'guard-rspec'
+  gem 'rspec', '~> 3.0'
+  gem 'simplecov'
 end

data/README.en.md

@@ -1,37 +1,40 @@
-# Jkf
+# jkf gem
+
 [![Gem
 Version](https://badge.fury.io/rb/jkf.svg)](https://badge.fury.io/rb/jkf)
 [![Build
 Status](https://travis-ci.org/iyuuya/jkf.svg?branch=master)](https://travis-ci.org/iyuuya/jkf)
 [![CI](https://github.com/iyuuya/jkf/actions/workflows/ci.yml/badge.svg)](https://github.com/iyuuya/jkf/actions/workflows/ci.yml)
 
-jkf is a Ruby port of [json-kifu-format][jkf].
-It supports both of the conversion from KIF, KI2, or CSA to jkf, and the one
-from jkf to KIF, KI2, or CSA.
+The jkf gem is a Ruby port of [json-kifu-format (JKF)][jkf].
+It supports both of the conversion from KIF (see [棋譜ファイル KIF 形式][kakinoki]),
+KI2, or CSA (see [CSA標準棋譜ファイル形式][csa]) to JKF, and the one from JKF to KIF,
+KI2, or CSA.
 
-[jkf]:https://github.com/na2hiro/Kifu-for-JS/tree/master/packages/json-kifu-format
+[csa]: http://www2.computer-shogi.org/protocol/record_v22.html
+[jkf]:
+https://github.com/na2hiro/Kifu-for-JS/tree/master/packages/json-kifu-format
+[kakinoki]: http://kakinoki.o.oo7.jp/kif_format.html
 
 ## Installation
 
-If you install this gem to your application (with Bundler), add this to
-Gemfile.
+If you install this gem to your application (with [Bundler][bundler]), add
+this to `Gemfile`.
+
+[bundler]: https://bundler.io/
 
 ```ruby
 gem 'jkf'
 ```
 
-Then run bundle to install this gem.
-
-    $ bundle
+Then run `bundle` to install this gem.
 
-Or directly install with gem install command.
-
-    $ gem install jkf
+Or directly install with `gem install` command.
 
 ## Usage
 
-This gem has the Parser and the Converter for each formats: KIF, KI2, and
-CSA.
+This gem has the parser {Jkf::Parser} and the converter {Jkf::Converter} for
+each formats: KIF, KI2, and CSA.
 
 ```ruby
 kif_parser = Jkf::Parser::Kif.new
@@ -45,8 +48,8 @@ ki2_converter = Jkf::Converter::Ki2.new
 csa_converter = Jkf::Converter::Csa.new
 ```
 
-`parser#parse(str)` to convert into jkf.
-`#convert(jkf)` to convert into each formats from jkf.
+{Jkf::Parser::Base#parse} to convert into JKF.
+{Jkf::Converter::Base#convert} to convert into each formats from JKF.
 
 ```ruby
 jkf = kif_parser.parse(kif_str) #=> Hash
@@ -62,13 +65,15 @@ csa = csa_converter.convert(jkf) #=> String
 
 ## Contributing
 
-Feel free to report bugs or send pull requests at
-[GitHub](https://github.com/iyuuya/jkf).
+Feel free to report bugs or send pull requests at [the GitHub
+repository][repo].
+
+[repo]: https://github.com/iyuuya/jkf
 
 If you work on Guix, run tests by `guix shell`.
 
 ## License
 
-This gem is licensed under the [MIT
-License](http://opensource.org/licenses/MIT).
+This gem is provided under the [MIT License][mit].
 
+[mit]: http://opensource.org/licenses/MIT

data/README.md

@@ -1,30 +1,31 @@
-# Jkf
+# jkf gem
+
 [![Gem Version](https://badge.fury.io/rb/jkf.svg)](https://badge.fury.io/rb/jkf) [![Build Status](https://travis-ci.org/iyuuya/jkf.svg?branch=master)](https://travis-ci.org/iyuuya/jkf) [![CI](https://github.com/iyuuya/jkf/actions/workflows/ci.yml/badge.svg)](https://github.com/iyuuya/jkf/actions/workflows/ci.yml)
 
-jkfは[JSON棋譜フォーマット (JKF)][jkf]をRubyに移植したものです。
-KIF, KI2, CSAをパースしJKFへ変換、JKFからKIF, KI2, CSAへの変換に対応しています。
+jkf gemは[JSON棋譜フォーマット (JKF)][jkf]をRubyに移植したものです。
+柿木形式（[棋譜ファイル KIF 形式][kakinoki]、KI2）、[CSA標準棋譜ファイル形式][csa]の構文解析とJKFへの変換、JKFからKIF, KI2, CSAへの変換に対応しています。
 
+[csa]: http://www2.computer-shogi.org/protocol/record_v22.html
 [jkf]: https://github.com/na2hiro/Kifu-for-JS/tree/master/packages/json-kifu-format
+[kakinoki]: http://kakinoki.o.oo7.jp/kif_format.html
+
+## インストール
 
-## Installation
+アプリケーションにインストールする場合（[Bundler][bundler]を使用する場合）、`Gemfile`に以下のように記述してください。
 
-アプリケーションにインストールする場合(bundlerを使用する場合)、Gemfileに以下のように記述してください。
+[bundler]: https://bundler.io/
 
 ```ruby
 gem 'jkf'
 ```
 
-さらにbundleコマンドを実行することでインストールできます。
-
-    $ bundle
+さらに`bundle`コマンドを実行することでインストールできます。
 
-または、gem installコマンドを使って直接インストールすることもできます。
+または、`gem install`コマンドを使って直接インストールもできます。
 
-    $ gem install jkf
+## 使い方
 
-## Usage
-
-KIF, KI2, CSAそれぞれParserとConverterが用意してあります。
+KIF, KI2, CSAそれぞれ構文解析器 {Jkf::Parser} と変換器 {Jkf::Converter} が用意してあります。
 
 ```ruby
 kif_parser = Jkf::Parser::Kif.new
@@ -38,7 +39,7 @@ ki2_converter = Jkf::Converter::Ki2.new
 csa_converter = Jkf::Converter::Csa.new
 ```
 
-`parser#parse(str)`でjkfへの変換、`#convert(jkf)`でjkfから各フォーマットへ変換できます。
+{Jkf::Parser::Base#parse} でJKFへの変換、 {Jkf::Converter::Base#convert} でJKFから各形式へ変換できます。
 
 ```ruby
 jkf = kif_parser.parse(kif_str) #=> Hash
@@ -52,15 +53,23 @@ ki2 = ki2_converter.convert(jkf) #=> String
 csa = csa_converter.convert(jkf) #=> String
 ```
 
-## Contributing
+## 貢献
+
+バグレポートやプルリクエストは[GitHubのリポジトリ][repo]でよろしくお願いします。
 
-バグレポートやプルリクエストはGithubでよろしくお願いします。
-https://github.com/iyuuya/jkf.
+[repo]: https://github.com/iyuuya/jkf
 
 Guixで開発されている場合は`guix shell`で`rake test`によるテスト実行ができます。
 
-## License
+翻訳はドキュメントとAPIの2種類があります。
+APIについてはRDocの国際化の機能を使います。
+POTファイルの生成には`rdoc --format pot`とします。
+これにより`doc/rdoc.pot`が生成されます。
+このPOTファイルから各言語のPOファイルを初期化できます。
+例えば`msginit -i doc/rdoc.pot -o po/en.rdoc.po --locale en_US.UTF-8`です。
+
+## 利用許諾
 
-ライセンスはMITです。
-[MIT License](http://opensource.org/licenses/MIT).
+ライセンスは[MIT License][mit]です。
 
+[mit]: http://opensource.org/licenses/MIT

data/bench.rb

@@ -2,7 +2,7 @@ require 'benchmark/ips'
 require_relative 'lib/jkf'
 
 Benchmark.ips do |x|
-  x.report("parse") do
+  x.report('parse') do
     Dir['spec/*fixtures/**/*'].each do |file|
       Jkf.parse_file(file)
     rescue Jkf::FileTypeError, Jkf::Parser::ParseError

data/jkf.gemspec

@@ -5,19 +5,21 @@ require 'jkf/version'
 Gem::Specification.new do |spec|
   spec.name = 'jkf'
   spec.version = Jkf::VERSION
-  spec.authors = ['iyuuya']
-  spec.email = ['i.yuuya@gmail.com']
+  spec.authors = ['iyuuya', 'gemmaro']
+  spec.email = ['i.yuuya@gmail.com', 'gemmaro.dev@gmail.com']
 
-  spec.summary = 'jkf/csa/kif/ki2 parser and converter'
-  spec.description = 'converter/parser of records of shogi'
+  spec.summary = 'Shogi formats parser and converter'
+  spec.description = 'The jkf gem provides parsers and converters (generaters) for several shogi formats.'
   spec.homepage = 'https://github.com/iyuuya/jkf'
   spec.license = 'MIT'
 
   spec.required_ruby_version = '>= 3.0'
 
   spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir = 'exe'
-  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
-  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  spec.metadata = {
+    'rubygems_mfa_required' => 'true',
+    'documentation_uri' => 'https://www.rubydoc.info/gems/jkf'
+  }
 end

data/lib/jkf/converter/ki2.rb

@@ -24,20 +24,20 @@ module Jkf
       end
 
       def convert_header(header)
-        header.map do |(key, value)|
+        header.filter_map do |(key, value)|
           result = add_header(key, value)
-          if key =~ /\A[先後上下]手\Z/
+          if /\A[先後上下]手\Z/.match?(key)
             nil
           else
             result
           end
-        end.compact.join
+        end.join
       end
 
       def add_header(key, value)
         result = "#{key}：#{value}\n"
-        if key =~ /\A[先後上下]手\Z/
-          if key =~ /[先下]/
+        if /\A[先後上下]手\Z/.match?(key)
+          if /[先下]/.match?(key)
             @header2.unshift result
           else
             @header2 << result

data/lib/jkf/converter/kif.rb

@@ -25,10 +25,10 @@ module Jkf
       end
 
       def convert_header(header, jkf)
-        header.map do |(key, value)|
+        header.filter_map do |(key, value)|
           result = "#{key}：#{value}\n"
-          if key =~ /\A[先後上下]手\Z/
-            if key =~ /[先下]/
+          if /\A[先後上下]手\Z/.match?(key)
+            if /[先下]/.match?(key)
               @header2.unshift result
             else
               @header2 << result
@@ -39,7 +39,7 @@ module Jkf
           else
             result
           end
-        end.compact.join
+        end.join
       end
 
       def convert_moves(moves, idx = 0)

data/lib/jkf/converter/kifuable.rb

@@ -52,7 +52,7 @@ module Jkf
       end
 
       def convert_motigoma(pieces)
-        pieces.to_a.reverse.map do |(piece, num)|
+        pieces.to_a.reverse.filter_map do |(piece, num)|
           if num > 0
             str = csa2kind(piece)
             if num > 1
@@ -62,7 +62,7 @@ module Jkf
             end
             str
           end
-        end.compact.join('　') + "　\n"
+        end.join('　') + "　\n"
       end
 
       def convert_board_piece(piece)
@@ -81,7 +81,7 @@ module Jkf
       def convert_special(special, index)
         result = "まで#{index + 1}手"
 
-        if special == 'TORYO' || special =~ /ILLEGAL/
+        if special == 'TORYO' || special.include?('ILLEGAL')
           turn = @players[index % 2]
           result += "で#{turn}手の"
           result += { 'TORYO' => '勝ち',

data/lib/jkf/parser/base.rb

@@ -92,7 +92,7 @@ module Jkf
         end
       end
 
-      def record_failure(expected)
+      def record_failure(_expected)
         return if @scanner.pos < @max_fail_pos
 
         return unless @scanner.pos > @max_fail_pos

data/lib/jkf/parser/csa.rb

@@ -6,7 +6,7 @@ module Jkf
 
       # kifu : csa2 | csa1
       def parse_root
-        @scanner << "\n" unless @scanner.string[-1] =~ /\n|\r|,/ # FIXME
+        @scanner << "\n" unless /\n|\r|,/.match?(@scanner.string[-1]) # FIXME
         s0 = parse_csa2
         s0 = parse_csa1 if s0 == :failed
         s0

data/lib/jkf/version.rb

@@ -1,3 +1,3 @@
 module Jkf
-  VERSION = '0.5.1'
+  VERSION = '0.5.2'
 end

data/manifest.scm

@@ -49,34 +49,6 @@ RuboCop when files are modified.")
     (home-page "https://github.com/guard/guard-compat")
     (license license:expat)))
 
-(define-public ruby-ruby-dep
-  (package
-    (name "ruby-ruby-dep")
-    (version "1.5.0")
-    (source (origin
-             (method git-fetch)
-             (uri (git-reference
-                   (url "https://github.com/e2/ruby_dep")
-                   (commit "4e79416a55dff4b3ff50e73c8fbd0455de1e68b7")))
-             (file-name (git-file-name name version))
-             (sha256
-              (base32
-               "0vv2bm4lghh5pl8zi0ihp6hpbp7xlk8d5h888nhxr725in0ypy9x"))))
-    (build-system ruby-build-system)
-    (arguments
-     `(#:test-target "spec"
-       #:tests? #f ;FIXME: needs gem_isolator, but cyclic dependencies
-       ))
-    (native-inputs (list ruby-rspec))
-    (synopsis
-     "Creates a version constraint of supported Rubies, suitable for a
-gemspec file")
-    (description
-     "This package creates a version constraint of supported Rubies,
-suitable for a gemspec file.")
-    (home-page "https://github.com/e2/ruby_dep")
-    (license license:expat)))
-
 (define-public ruby-gem-isolator
   (package
     (name "ruby-gem-isolator")
@@ -96,7 +68,7 @@ suitable for a gemspec file.")
        #:tests? #f ;FIXME: uninitialized constant Pathname
        ))
     (native-inputs (list ruby-rspec ruby-nenv ruby-rubocop))
-    (propagated-inputs (list ruby-ruby-dep))
+    (propagated-inputs (list ruby-dep))
     (synopsis
      "Good for testing dependencies of a gem and/or different gem version
 combinations")
@@ -137,7 +109,7 @@ different gem version combinations.")
                           ruby-rubocop-rake
                           ruby-rubocop-rspec
                           ruby-rspec
-                          ruby-guard-rspec
                           ruby-simplecov
                           ruby-benchmark-ips
+                          ruby-rubocop-performance
                           ruby))