jkf 0.5.1 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10de9aac464bd36cb02f25fe54861977cef819870cfe2b35d8f9741b119c3165
-  data.tar.gz: 9a9271b5bf437c8d3a493732046ee3b86c50a4c26313c975a0041e9d8d91e290
+  metadata.gz: 9aa24be83e28547743c1bc4c5c12e3b336fe4f448d8cd8f729620c9878a1de42
+  data.tar.gz: bc7e2b1eba4f7f9c970d266cba6f4887444dde261169a0e8d52eb02642802e0b
 SHA512:
-  metadata.gz: 778bd58dffa3e570cb4f9a4f235518d402f8e135b1a33f7e3f3758d71807b3a6e0b9f77bda86ec6da478da9932a0dc242e3a979a2318f02c47dcd3023b899615
-  data.tar.gz: 9f52cef3917dc571e3edd7bad14b6e3d8a3debd7da08dfa480f7b3861db7fbe23c63a4b7eb06c11f7322eec7176a7f08dcee29e216d5b7d6a51ef96ea484d470
+  metadata.gz: 86861a9621a3dc7fa5e7c61fbeeb53c5791bc28fc37b53f3b7bbea44e4f85b0489d4c7b9da2e669432861ac007cf25803dc99c14cbd9b667969df43ef4871a97
+  data.tar.gz: 5d2ea1626f6a644760b2ae533fdd5497bd3c5c6e14f73e1001146315008ffd6e5424f5acfe9b0654f8793743baf20a96ca228b8cb42f4b16b8c98b5998868627

data/.envrc

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

data/.yardopts

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

data/CHANGELOG.md

@@ -7,6 +7,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## 0.5.3 - 2025-07-21
+
+Update project links.
+
+## 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

@@ -2,20 +2,11 @@ source 'https://rubygems.org'
 
 gemspec
 
-gem 'rake'
-
 group :development do
-  gem 'redcarpet', require: false
-  gem 'yard', require: false
-
-  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 'yard'
 end
 
 group :test do
-  gem 'guard-rspec', require: false
-  gem 'rspec', '~> 3.0', require: false
-  gem 'simplecov', require: false
+  gem 'rspec', '~> 3.0'
+  gem 'simplecov'
 end

data/LICENSE.txt

@@ -1,6 +1,7 @@
 The MIT License (MIT)
 
 Copyright (c) 2016 iyuuya
+Copyright (c) 2025 gemmaro
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

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,29 @@
-# Jkf
-[![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 gem
 
-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を使用する場合)、Gemfileに以下のように記述してください。
+アプリケーションにインストールする場合（[Bundler][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 +37,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 +51,29 @@ ki2 = ki2_converter.convert(jkf) #=> String
 csa = csa_converter.convert(jkf) #=> String
 ```
 
-## Contributing
+## 貢献
+
+バグレポートやプルリクエストは[リポジトリ][repo]でよろしくお願いします。
 
-バグレポートやプルリクエストはGithubでよろしくお願いします。
-https://github.com/iyuuya/jkf.
+[repo]: https://sourceforge.net/p/ruby-jkf/code/
 
 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`です。
+
+## 謝辞
+
+このプロジェクトは[GitHubのiyuuya/jkf](https://github.com/iyuuya/jkf)を元にしています。
+そこから[GitHubのgemmaro/jkf](https://github.com/gemmaro/jkf)にフォークされました。
+現在の開発は[SourceForgeのjkf](https://sourceforge.net/projects/ruby-jkf/)に移っています。
+
+## 利用許諾
 
-ライセンスは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,23 @@ 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 = %w[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.homepage = 'https://github.com/iyuuya/jkf'
+  spec.summary = 'Shogi formats parser and converter'
+  spec.description = 'The jkf gem provides parsers and converters (generaters) for several shogi formats, including json-kifu-format, KIF, KI2, and CSA.'
+  spec.homepage = 'https://sourceforge.net/projects/ruby-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'
+  }
+
+  spec.add_development_dependency "rake"
 end

data/lib/jkf/converter/base.rb

@@ -3,7 +3,7 @@ module Jkf
     # Base of Converter
     class Base
       # start convert
-      # 
+      #
       # @param [String, Hash] jkf
       # @return [String] kif or ki2 or csa text
       def convert(jkf)

data/lib/jkf/converter/csa.rb

@@ -16,12 +16,8 @@ module Jkf
 
       def convert_information(header)
         result = ''
-        if header['先手'] || header['下手']
-          result += 'N+' + (header.delete('先手') || header.delete('下手') || '') + "\n"
-        end
-        if header['後手'] || header['上手']
-          result += 'N-' + (header.delete('後手') || header.delete('上手') || '') + "\n"
-        end
+        result += 'N+' + (header.delete('先手') || header.delete('下手') || '') + "\n" if header['先手'] || header['下手']
+        result += 'N-' + (header.delete('後手') || header.delete('上手') || '') + "\n" if header['後手'] || header['上手']
         header.each { |(k, v)| result += "$#{csa_header_key(k)}:#{v}\n" }
         result
       end
@@ -60,6 +56,7 @@ module Jkf
         before_pos = nil
         moves.each do |move|
           next if move == {}
+
           result += convert_move(move['move'], before_pos) if move['move']
           result += convert_special(move['special'], move['color']) if move['special']
           if move['time']
@@ -144,7 +141,7 @@ module Jkf
       end
 
       def pos2str(pos)
-        '%d%d' % [pos['x'], pos['y']]
+        format('%d%d', pos['x'], pos['y'])
       end
 
       def version

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)
@@ -57,7 +57,7 @@ module Jkf
       end
 
       def convert_move_line(move, index)
-        result = '%4d ' % [index]
+        result = format('%4d ', index)
         result += convert_move(move['move'])
         result += convert_time(move['time']) if move['time']
         result += '+' if move['forks']
@@ -65,7 +65,7 @@ module Jkf
       end
 
       def convert_special_line(move, index)
-        result = '%4d ' % [index]
+        result = format('%4d ', index)
         result += ljust(special2kan(move['special']), 13)
         result += convert_time(move['time']) if move['time']
         result += '+' if move['forks']
@@ -85,13 +85,8 @@ module Jkf
       end
 
       def convert_time(time)
-        '(%2d:%02d/%02d:%02d:%02d)' % [
-          time['now']['m'],
-          time['now']['s'],
-          time['total']['h'],
-          time['total']['m'],
-          time['total']['s']
-        ]
+        format('(%2d:%02d/%02d:%02d:%02d)', time['now']['m'], time['now']['s'], time['total']['h'], time['total']['m'],
+               time['total']['s'])
       end
 
       def special2kan(special)
@@ -119,7 +114,7 @@ module Jkf
       end
 
       def pos2str(pos)
-        '%d%d' % [pos['x'], pos['y']]
+        format('%d%d', pos['x'], pos['y'])
       end
     end
   end

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' => '勝ち',
@@ -115,7 +115,7 @@ module Jkf
 
       def convert_forks(forks, index)
         result = "\n"
-        result = "変化：%4d手\n" % [index] # ki2の場合\nなし
+        result = format("変化：%4d手\n", index) # ki2の場合\nなし
         forks.each do |moves|
           result += convert_moves(moves, index)
         end
@@ -131,9 +131,9 @@ module Jkf
         players_flag = :sengo
         jkf['header']&.keys&.detect { |key| key =~ /[上下]手/ } && players_flag = :uwasimo
         @players = if players_flag == :uwasimo
-                     ['下', '上']
+                     %w[下 上]
                    else
-                     ['先', '後']
+                     %w[先 後]
                    end
       end
 

data/lib/jkf/parser/base.rb

@@ -30,7 +30,7 @@ module Jkf
         @result != :failed
       end
 
-      def failed?; !success?; end
+      def failed? = !success?
 
       def match_regexp(reg)
         matched = @scanner.scan(reg)
@@ -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