jkf 0.5.0 → 0.5.2

data/README.en.md

@@ -1,38 +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)
-[![Inline
-docs](http://inch-ci.org/github/iyuuya/jkf.svg?branch=develop)](http://inch-ci.org/github/iyuuya/jkf)
 
-jkf is a Ruby port of
-[json-kifu-format](https://github.com/na2hiro/json-kifu-format).
-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.
+
+[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.
+Then run `bundle` to install this gem.
 
-    $ bundle
-
-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
@@ -46,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
@@ -63,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,28 +1,31 @@
-# 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) [![Inline docs](http://inch-ci.org/github/iyuuya/jkf.svg?branch=develop)](http://inch-ci.org/github/iyuuya/jkf)
+# jkf gem
 
-jkfはJSON棋譜フォーマット( https://github.com/na2hiro/json-kifu-format )をRubyに移植したものです。
-KIF, KI2, CSAをパースしJKFへ変換、JKFからKIF, KI2, CSAへの変換に対応しています。
+[![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)
 
-## Installation
+jkf gemは[JSON棋譜フォーマット (JKF)][jkf]をRubyに移植したものです。
+柿木形式（[棋譜ファイル KIF 形式][kakinoki]、KI2）、[CSA標準棋譜ファイル形式][csa]の構文解析とJKFへの変換、JKFからKIF, KI2, CSAへの変換に対応しています。
 
-アプリケーションにインストールする場合(bundlerを使用する場合)、Gemfileに以下のように記述してください。
+[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
+
+## インストール
+
+アプリケーションにインストールする場合（[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
@@ -36,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
@@ -50,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/Rakefile

@@ -1,11 +1,11 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec
 
-desc "translate documents"
+desc 'translate documents'
 task :translate do
-  sh "po4a po4a.cfg"
+  sh 'po4a po4a.cfg'
 end

data/bench.rb

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

data/bin/console

@@ -1,15 +1,15 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "jkf"
+require 'bundler/setup'
+require 'jkf'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
 
 # (If you use this, don't forget to add pry to your Gemfile!)
-if require "pry"
+if require 'pry'
   Pry.start
 else
-  require "irb"
+  require 'irb'
   IRB.start
 end

data/jkf.gemspec

@@ -1,24 +1,25 @@
-# coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "jkf/version"
+require 'jkf/version'
 
 Gem::Specification.new do |spec|
-  spec.name = "jkf"
+  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.homepage = "https://github.com/iyuuya/jkf"
-  spec.license = "MIT"
+  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 = '>= 2.7'
+  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.require_paths = ['lib']
+
+  spec.metadata = {
+    'rubygems_mfa_required' => 'true',
+    'documentation_uri' => 'https://www.rubydoc.info/gems/jkf'
+  }
 end

data/lib/jkf/converter/base.rb

@@ -1,13 +1,15 @@
-module Jkf::Converter
-  # Base of Converter
-  class Base
-    # start convert
-    # 
-    # @param [String, Hash] jkf
-    # @return [String] kif or ki2 or csa text
-    def convert(jkf)
-      jkf = jkf.is_a?(Hash) ? jkf : JSON.parse(jkf)
-      convert_root(jkf)
+module Jkf
+  module Converter
+    # Base of Converter
+    class Base
+      # start convert
+      # 
+      # @param [String, Hash] jkf
+      # @return [String] kif or ki2 or csa text
+      def convert(jkf)
+        jkf = jkf.is_a?(Hash) ? jkf : JSON.parse(jkf)
+        convert_root(jkf)
+      end
     end
   end
 end

data/lib/jkf/converter/csa.rb

@@ -1,174 +1,165 @@
-module Jkf::Converter
-  # CSA v2.2 Converter
-  class Csa < Base
-    VERSION = "2.2".freeze
-
-    protected
-
-    def convert_root(jkf)
-      result = version
-      result += convert_information(jkf["header"]) if jkf["header"]
-      result += convert_initial(jkf["initial"]) if jkf["initial"]
-      result += convert_moves(jkf["moves"]) if jkf["moves"]
-      result
-    end
-
-    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"
+module Jkf
+  module Converter
+    # CSA v2.2 Converter
+    class Csa < Base
+      VERSION = '2.2'.freeze
+
+      protected
+
+      def convert_root(jkf)
+        result = version
+        result += convert_information(jkf['header']) if jkf['header']
+        result += convert_initial(jkf['initial']) if jkf['initial']
+        result += convert_moves(jkf['moves']) if jkf['moves']
+        result
       end
-      header.each { |(k, v)| result += "$#{csa_header_key(k)}:#{v}\n" }
-      result
-    end
 
-    def convert_initial(initial)
-      result = ""
-      data = initial["data"] || {}
-      result += if initial["preset"] == "OTHER"
-                  convert_board(data["board"])
-                else
-                  convert_preset(initial["preset"])
-                end
-      # 持駒
-      if data["hands"]
-        result += convert_hands(data["hands"], 0)
-        result += convert_hands(data["hands"], 1)
+      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
+        header.each { |(k, v)| result += "$#{csa_header_key(k)}:#{v}\n" }
+        result
       end
-      result += csa_color(data["color"]) + "\n" if data["color"]
-      result
-    end
 
-    def convert_hands(hands, color)
-      result = ""
-      sum = 0
-      hands[color].each_value { |n| sum += n }
-      if sum > 0
-        result += "P#{csa_color(color)}"
-        hands[color].to_a.reverse_each { |(k, v)| v.times { result += "00#{k}" } }
-        result += "\n"
+      def convert_initial(initial)
+        result = ''
+        data = initial['data'] || {}
+        result += if initial['preset'] == 'OTHER'
+                    convert_board(data['board'])
+                  else
+                    convert_preset(initial['preset'])
+                  end
+        # 持駒
+        if data['hands']
+          result += convert_hands(data['hands'], 0)
+          result += convert_hands(data['hands'], 1)
+        end
+        result += csa_color(data['color']) + "\n" if data['color']
+        result
       end
-      result
-    end
 
-    def convert_moves(moves)
-      result = ""
-      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"]
-          result += "," + convert_time(move["time"])
-        elsif move["move"] || move["special"]
+      def convert_hands(hands, color)
+        result = ''
+        sum = 0
+        hands[color].each_value { |n| sum += n }
+        if sum > 0
+          result += "P#{csa_color(color)}"
+          hands[color].to_a.reverse_each { |(k, v)| v.times { result += "00#{k}" } }
           result += "\n"
         end
-        result += convert_comments(move["comments"]) if move["comments"]
-        before_pos = move["move"]["to"] if move["move"] && move["move"]["to"]
+        result
       end
-      result
-    end
 
-    def convert_move(move, before_pos)
-      result = csa_color(move["color"])
-      result += move["from"] ? pos2str(move["from"]) : "00"
-      result += if move["to"]
-                  pos2str(move["to"]) + move["piece"]
-                else
-                  pos2str(before_pos) + move["piece"]
-                end
-      result
-    end
+      def convert_moves(moves)
+        result = ''
+        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']
+            result += ',' + convert_time(move['time'])
+          elsif move['move'] || move['special']
+            result += "\n"
+          end
+          result += convert_comments(move['comments']) if move['comments']
+          before_pos = move['move']['to'] if move['move'] && move['move']['to']
+        end
+        result
+      end
 
-    def convert_special(special, color = nil)
-      result = "%"
-      result += csa_color(color) if color
-      result + special
-    end
+      def convert_move(move, before_pos)
+        result = csa_color(move['color'])
+        result += move['from'] ? pos2str(move['from']) : '00'
+        result += if move['to']
+                    pos2str(move['to']) + move['piece']
+                  else
+                    pos2str(before_pos) + move['piece']
+                  end
+        result
+      end
 
-    def convert_time(time)
-      sec = (time["now"]["m"] * 60) + time["now"]["s"]
-      "T#{sec}\n"
-    end
+      def convert_special(special, color = nil)
+        result = '%'
+        result += csa_color(color) if color
+        result + special
+      end
 
-    def convert_comments(comments)
-      comments.map { |comment| "'#{comment}" }.join("\n") + "\n"
-    end
+      def convert_time(time)
+        sec = (time['now']['m'] * 60) + time['now']['s']
+        "T#{sec}\n"
+      end
 
-    def convert_board(board)
-      result = ""
-      9.times do |y|
-        result += "P#{y + 1}"
-        9.times do |x|
-          piece = board[8 - x][y]
-          result += if piece == {}
-                      " * "
-                    else
-                      csa_color(piece["color"]) + piece["kind"]
-                    end
-        end
-        result += "\n"
+      def convert_comments(comments)
+        comments.map { |comment| "'#{comment}" }.join("\n") + "\n"
       end
-      result
-    end
 
-    def convert_preset(preset)
-      "PI" +
-        case preset
-        when "HIRATE" # 平手
-          ""
-        when "KY" # 香落ち
-          "11KY"
-        when "KY_R" # 右香落ち
-          "91KY"
-        when "KA" # 角落ち
-          "22KA"
-        when "HI" # 飛車落ち
-          "82HI"
-        when "HIKY" # 飛香落ち
-          "22HI11KY91KY"
-        when "2" # 二枚落ち
-          "82HI22KA"
-        when "3" # 三枚落ち
-          "82HI22KA91KY"
-        when "4" # 四枚落ち
-          "82HI22KA11KY91KY"
-        when "5" # 五枚落ち
-          "82HI22KA81KE11KY91KY"
-        when "5_L" # 左五枚落ち
-          "82HI22KA21KE11KY91KY"
-        when "6" # 六枚落ち
-          "82HI22KA21KE81KE11KY91KY"
-        when "8" # 八枚落ち
-          "82HI22KA31GI71GI21KE81KE11KY91KY"
-        when "10" # 十枚落ち
-          "82HI22KA41KI61KI31GI71GI21KE81KE11KY91KY"
+      def convert_board(board)
+        result = ''
+        9.times do |y|
+          result += "P#{y + 1}"
+          9.times do |x|
+            piece = board[8 - x][y]
+            result += if piece == {}
+                        ' * '
+                      else
+                        csa_color(piece['color']) + piece['kind']
+                      end
+          end
+          result += "\n"
         end
-    end
+        result
+      end
 
-    def csa_color(color)
-      color == 0 ? "+" : "-"
-    end
+      def convert_preset(preset)
+        'PI' + PRESET_NAME_TO_CSA_MAPPING[preset]
+      end
 
-    def pos2str(pos)
-      "%d%d" % [pos["x"], pos["y"]]
-    end
+      PRESET_NAME_TO_CSA_MAPPING = {
+        'HIRATE' => '', # 平手
+        'KY' => '11KY', # 香落ち
+        'KY_R' => '91KY', # 右香落ち
+        'KA' => '22KA', # 角落ち
+        'HI' => '82HI', # 飛車落ち
+        'HIKY' => '22HI11KY91KY', # 飛香落ち
+        '2' => '82HI22KA', # 二枚落ち
+        '3' => '82HI22KA91KY', # 三枚落ち
+        '4' => '82HI22KA11KY91KY', # 四枚落ち
+        '5' => '82HI22KA81KE11KY91KY', # 五枚落ち
+        '5_L' => '82HI22KA21KE11KY91KY', # 左五枚落ち
+        '6' => '82HI22KA21KE81KE11KY91KY', # 六枚落ち
+        '8' => '82HI22KA31GI71GI21KE81KE11KY91KY', # 八枚落ち
+        '10' => '82HI22KA41KI61KI31GI71GI21KE81KE11KY91KY' # 十枚落ち
+      }.freeze
+
+      private_constant :PRESET_NAME_TO_CSA_MAPPING
+
+      def csa_color(color)
+        color == 0 ? '+' : '-'
+      end
 
-    def version
-      "V#{VERSION}\n"
-    end
+      def pos2str(pos)
+        '%d%d' % [pos['x'], pos['y']]
+      end
+
+      def version
+        "V#{VERSION}\n"
+      end
 
-    def csa_header_key(key)
-      {
-        "棋戦" => "EVENT",
-        "場所" => "SITE",
-        "開始日時" => "START_TIME",
-        "終了日時" => "END_TIME",
-        "持ち時間" => "TIME_LIMIT"
-      }[key] || key
+      def csa_header_key(key)
+        {
+          '棋戦' => 'EVENT',
+          '場所' => 'SITE',
+          '開始日時' => 'START_TIME',
+          '終了日時' => 'END_TIME',
+          '持ち時間' => 'TIME_LIMIT'
+        }[key] || key
+      end
     end
   end
 end