jkf 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79e1ae754b51607fe6534b5c8c41204442af455e
-  data.tar.gz: b61950a75a9b4c7bd38016b32a586bf7ce7d6e95
+  metadata.gz: cad7bbf021250fb745379dfde6cdd189ac23065f
+  data.tar.gz: eff17d1efc52ff07bdc58bc6d4b61afa0022a1fb
 SHA512:
-  metadata.gz: 82c946e99c94984ba20f5af1369b3d555bf0dfea5fc27886bd0808006b91f9ae22acd29de33d71d813b1810b5a31eb978f6be92c40224887115ea05c39626589
-  data.tar.gz: 669322bd5d08c7b6a78e887e773c90d89e20dd927e0043c16417cdadb49bbf30a4bcef2c72fb225d378e63849f27abd92df20c6051da3a0b32798e21fbae16a5
+  metadata.gz: 081f1b970eb509aaa33495fb14459d6a37ce7510f59d94a1ee9ea1c3b2f23319b6ccb36383029f456cfa681d3ae5e7ab164dfde4f647ae25d8ddd3d1f46a7906
+  data.tar.gz: 7d0bb2322d33f323f64b82350108721b2d6694a04000879a58e9d87299bc4426deed8b730c28f85288b8b54d73e7f011d41d37cbeac1e2b3f60f81e145686a18

data/README.en.md

@@ -0,0 +1,61 @@
+# 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) [![Code Climate](https://codeclimate.com/github/iyuuya/jkf/badges/gpa.svg)](https://codeclimate.com/github/iyuuya/jkf) [![Test Coverage](https://codeclimate.com/github/iyuuya/jkf/badges/coverage.svg)](https://codeclimate.com/github/iyuuya/jkf/coverage) [![Inline docs](http://inch-ci.org/github/iyuuya/jkf.svg?branch=develop)](http://inch-ci.org/github/iyuuya/jkf)
+
+
+jkf is json-kifu-format( https://github.com/na2hiro/json-kifu-format ) library for ruby.
+
+### Feature
+
+* KIF, KI2, CSA to JKF
+* JKF to KIF, KI2, CSA
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jkf'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jkf
+
+## Usage
+
+```ruby
+kif_parser = Jkf::Parser::Kif.new
+ki2_parser = Jkf::Parser::Ki2.new
+csa_parser = Jkf::Parser::Csa.new
+```
+
+```ruby
+kif_converter = Jkf::Converter::Kif.new
+ki2_converter = Jkf::Converter::Ki2.new
+csa_converter = Jkf::Converter::Csa.new
+```
+
+```ruby
+jkf = kif_parser.parse(kif_str) #=> Hash
+jkf = ki2_parser.parse(ki2_str) #=> Hash
+jkf = csa_parser.parse(csa_str) #=> Hash
+```
+
+```ruby
+kif = kif_converter.parse(jkf) #=> String
+ki2 = ki2_converter.parse(jkf) #=> String
+csa = csa_converter.parse(jkf) #=> String
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/iyuuya/jkf.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/README.md

@@ -1,42 +1,62 @@
 # 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) [![Code Climate](https://codeclimate.com/github/iyuuya/jkf/badges/gpa.svg)](https://codeclimate.com/github/iyuuya/jkf) [![Test Coverage](https://codeclimate.com/github/iyuuya/jkf/badges/coverage.svg)](https://codeclimate.com/github/iyuuya/jkf/coverage) [![Inline docs](http://inch-ci.org/github/iyuuya/jkf.svg?branch=develop)](http://inch-ci.org/github/iyuuya/jkf)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/jkf`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+jkfはJSON棋譜フォーマット( https://github.com/na2hiro/json-kifu-format )をRubyに移植したものです。
+KIF, KI2, CSAをパースしJKFへ変換、JKFからKIF, KI2, CSAへの変換に対応しています。
 
 ## Installation
 
-Add this line to your application's Gemfile:
+アプリケーションにインストールする場合(bundlerを使用する場合)、Gemfileに以下のように記述してください。
 
 ```ruby
 gem 'jkf'
 ```
 
-And then execute:
+さらにbundleコマンドを実行することでインストールできます。
 
     $ bundle
 
-Or install it yourself as:
+または、gem installコマンドを使って直接インストールすることもできます。
 
     $ gem install jkf
 
 ## Usage
 
-TODO: Write usage instructions here
+KIF, KI2, CSAそれぞれParserとConverterが用意してあります。
 
-## Development
+```ruby
+kif_parser = Jkf::Parser::Kif.new
+ki2_parser = Jkf::Parser::Ki2.new
+csa_parser = Jkf::Parser::Csa.new
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. Run `bundle exec jkf` to use the gem in this directory, ignoring other installed copies of this gem.
+```ruby
+kif_converter = Jkf::Converter::Kif.new
+ki2_converter = Jkf::Converter::Ki2.new
+csa_converter = Jkf::Converter::Csa.new
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+`parser#parse(str)`でjkfへの変換、`#convert(jkf)`でjkfから各フォーマットへ変換できます。
 
-## Contributing
+```ruby
+jkf = kif_parser.parse(kif_str) #=> Hash
+jkf = ki2_parser.parse(ki2_str) #=> Hash
+jkf = csa_parser.parse(csa_str) #=> Hash
+```
+
+```ruby
+kif = kif_converter.parse(jkf) #=> String
+ki2 = ki2_converter.parse(jkf) #=> String
+csa = csa_converter.parse(jkf) #=> String
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jkf.
+## Contributing
 
+バグレポートやプルリクエストはGithubでよろしくお願いします。
+https://github.com/iyuuya/jkf.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+ライセンスはMITです。
+[MIT License](http://opensource.org/licenses/MIT).
 

data/lib/jkf.rb

@@ -3,10 +3,17 @@ require "jkf/version"
 require "jkf/parser"
 require "jkf/converter"
 
+# JSON Kifu Format
 module Jkf
+  # raise when unsupport file type
   class FileTypeError < StandardError; end
 
   class << self
+    # ファイルからパースします。拡張子でフォーマットの判定をします。
+    #
+    # @param [String] filename
+    #
+    # @return [String] KIF, KI2, CSA, JKF(JSON)
     def parse_file(filename, encoding: "Shift_JIS")
       parser = case ::File.extname(filename)
                when /kif/
@@ -17,11 +24,18 @@ module Jkf
                  ::Jkf::Parser::Csa.new
                when /jkf|json/
                  JSON
+               else
+                 raise FileTypeError
                end
       str = File.read(File.expand_path(filename), encoding: encoding).toutf8
       parser.parse(str)
     end
 
+    # 文字列からパースします。各パーサでパースに試みて成功した場合結果を返します。
+    #
+    # @param [String] str
+    #
+    # @return [Hash] JKF
     def parse(str)
       parsers = [::Jkf::Parser::Kif.new, ::Jkf::Parser::Ki2.new, ::Jkf::Parser::Csa.new, JSON]
 

data/lib/jkf/converter.rb

@@ -1,5 +1,7 @@
 module Jkf
+  # Define converter namespace
   module Converter
+    # Convert error
     class ConvertError < StandardError; end
   end
 end

data/lib/jkf/converter/base.rb

@@ -1,5 +1,10 @@
 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)

data/lib/jkf/converter/csa.rb

@@ -1,7 +1,10 @@
 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"]
@@ -10,8 +13,6 @@ module Jkf::Converter
       result
     end
 
-    protected
-
     def convert_information(header)
       result = ""
       if header["先手"] || header["下手"]

data/lib/jkf/converter/ki2.rb

@@ -1,9 +1,10 @@
 module Jkf::Converter
+  # KI2 Converter
   class Ki2 < Base
-    protected
-
     include Kifuable
 
+    protected
+
     def convert_root(jkf)
       reset!
       setup_players!(jkf)

data/lib/jkf/converter/kif.rb

@@ -1,4 +1,5 @@
 module Jkf::Converter
+  # KIF Converter
   class Kif < Base
     protected
 

data/lib/jkf/converter/kifuable.rb

@@ -1,4 +1,5 @@
 module Jkf::Converter
+  # Intersection of KIF and KI2
   module Kifuable
     protected
 

data/lib/jkf/parser.rb

@@ -1,5 +1,7 @@
 module Jkf
+  # Define parser namespace
   module Parser
+    # Parse error
     class ParseError < StandardError; end
   end
 end

data/lib/jkf/parser/base.rb

@@ -1,5 +1,11 @@
 module Jkf::Parser
+  # Base of Parser
   class Base
+    # start parse
+    #
+    # @param [String] input
+    #
+    # @return [Hash] JKF
     def parse(input)
       @input = input.clone
 
@@ -29,6 +35,7 @@ module Jkf::Parser
 
     def failed?; !success?; end
 
+    # match regexp
     def match_regexp(reg)
       ret = nil
       if matched = reg.match(@input[@current_pos])
@@ -41,6 +48,7 @@ module Jkf::Parser
       ret
     end
 
+    # match string
     def match_str(str)
       ret = nil
       if @input[@current_pos, str.size] == str
@@ -53,10 +61,12 @@ module Jkf::Parser
       ret
     end
 
+    # match space
     def match_space
       match_str(" ")
     end
 
+    # match space one or more
     def match_spaces
       stack = []
       matched = match_space
@@ -67,10 +77,12 @@ module Jkf::Parser
       stack
     end
 
+    # match digit
     def match_digit
       match_regexp(/^\d/)
     end
 
+    # match digits
     def match_digits
       stack = []
       matched = match_digit
@@ -81,6 +93,7 @@ module Jkf::Parser
       stack
     end
 
+    # match digit one ore more
     def match_digits!
       matched = match_digits
       if matched.empty?
@@ -90,6 +103,7 @@ module Jkf::Parser
       end
     end
 
+    # record failure
     def fail(expected)
       return if @current_pos < @max_fail_pos
 

data/lib/jkf/parser/csa.rb

@@ -1,7 +1,11 @@
 # coding: utf-8
 
 module Jkf::Parser
+  # CSA Parser
   class Csa < Base
+    protected
+
+    # kifu : csa2 | csa1
     def parse_root
       @input += "\n" unless @input[-1] =~ /\n|\r|,/ # FIXME
       s0 = parse_csa2
@@ -9,6 +13,7 @@ module Jkf::Parser
       s0
     end
 
+    # csa2 : version22 information? initialboard moves?
     def parse_csa2
       s0 = @current_pos
       if parse_version22 != :failed
@@ -38,6 +43,7 @@ module Jkf::Parser
       s0
     end
 
+    # version22 : comment* "V2.2" nl
     def parse_version22
       s0 = @current_pos
       s1 = parse_comments
@@ -57,6 +63,7 @@ module Jkf::Parser
       s0
     end
 
+    # information : players? headers
     def parse_information
       s0 = @current_pos
       s1 = parse_players
@@ -72,6 +79,7 @@ module Jkf::Parser
       s0
     end
 
+    # headers : header*
     def parse_headers
       s0 = @current_pos
       s1 = []
@@ -91,6 +99,7 @@ module Jkf::Parser
       s0
     end
 
+    # header : comment* "$" [^:]+ ":" nonls nl
     def parse_header
       s0 = @current_pos
       parse_comments
@@ -130,6 +139,7 @@ module Jkf::Parser
       s0
     end
 
+    # csa1 : players? initialboard? moves
     def parse_csa1
       s0 = @current_pos
       s1 = parse_players
@@ -154,6 +164,7 @@ module Jkf::Parser
       s0
     end
 
+    # players : comment* ("N+" nonls nl)? comment* ("N-" nonls nl)?
     def parse_players
       s0 = @current_pos
       parse_comments
@@ -193,6 +204,7 @@ module Jkf::Parser
       s0
     end
 
+    # initialboard : comment* (hirate | ikkatsu | "") komabetsu comment* teban nl
     def parse_initial_board
       s0 = @current_pos
       parse_comments
@@ -244,6 +256,7 @@ module Jkf::Parser
       end
     end
 
+    # hirate : "PI" xypiece* nl
     def parse_hirate
       s0 = @current_pos
       if match_str("PI") != :failed
@@ -273,6 +286,7 @@ module Jkf::Parser
       s0
     end
 
+    # ikkatsu : ikkatsuline+
     def parse_ikkatsu
       s0 = @current_pos
       s2 = parse_ikkatsu_line
@@ -303,10 +317,11 @@ module Jkf::Parser
       s0
     end
 
+    # ikkatsuline : "P" [1-9] masu+ nl
     def parse_ikkatsu_line
       s0 = @current_pos
       if match_str("P") != :failed
-        if match_regexp(/^[1-9]/) != :failed
+        if match_digit != :failed
           s4 = parse_masu
           if s4 != :failed
             s3 = []
@@ -341,6 +356,7 @@ module Jkf::Parser
       s0
     end
 
+    # masu : teban piece | " * "
     def parse_masu
       s0 = @current_pos
       s1 = parse_teban
@@ -368,6 +384,7 @@ module Jkf::Parser
       s0
     end
 
+    # komabetsu : komabetsuline*
     def parse_komabetsu
       s0 = @current_pos
       s1 = []
@@ -380,6 +397,7 @@ module Jkf::Parser
       transform_komabetsu_lines(s1)
     end
 
+    # komabetsuline : "P" teban xypiece+ nl
     def parse_komabetsu_line
       s0 = @current_pos
       if match_str("P") != :failed
@@ -418,6 +436,7 @@ module Jkf::Parser
       s0
     end
 
+    # moves : firstboard move* comment*
     def parse_moves
       s0 = @current_pos
       s1 = parse_firstboard
@@ -438,6 +457,7 @@ module Jkf::Parser
       s0
     end
 
+    # firstboard : comment*
     def parse_firstboard
       s0 = @current_pos
       s1 = parse_comments
@@ -445,6 +465,7 @@ module Jkf::Parser
       s1.empty? ? {} : { "comments" => s1 }
     end
 
+    # move : (normalmove | specialmove) time? comment*
     def parse_move
       s0 = @current_pos
       s1 = parse_normal_move
@@ -472,6 +493,7 @@ module Jkf::Parser
       s0
     end
 
+    # normalmove : teban xy xy piece nl
     def parse_normal_move
       s0 = @current_pos
       s1 = parse_teban
@@ -512,6 +534,7 @@ module Jkf::Parser
       s0
     end
 
+    # specialmove : "%" [-+_A-Z]+ nl
     def parse_special_move
       s0 = @current_pos
       s1 = match_str("%")
@@ -545,6 +568,7 @@ module Jkf::Parser
       s0
     end
 
+    # teban : "+" | "-"
     def parse_teban
       s0 = @current_pos
       s1 = match_str("+")
@@ -565,6 +589,7 @@ module Jkf::Parser
       s0
     end
 
+    # comment : "'" nonls nl
     def parse_comment
       s0 = @current_pos
       if match_str("'") != :failed
@@ -582,6 +607,7 @@ module Jkf::Parser
       end
     end
 
+    # comments : comment*
     def parse_comments
       stack = []
       matched = parse_comment
@@ -592,6 +618,7 @@ module Jkf::Parser
       stack
     end
 
+    # time : "T" [0-9]* nl
     def parse_time
       s0 = @current_pos
       if match_str("T") != :failed
@@ -610,6 +637,7 @@ module Jkf::Parser
       s0
     end
 
+    # xy : [0-9] [0-9]
     def parse_xy
       s0 = @current_pos
       s1 = match_digit
@@ -629,6 +657,7 @@ module Jkf::Parser
       s0
     end
 
+    # piece : [A-Z] [A-Z]
     def parse_piece
       s0 = @current_pos
       s1 = match_regexp(/^[A-Z]/)
@@ -648,6 +677,7 @@ module Jkf::Parser
       s0
     end
 
+    # xypiece : xy piece
     def parse_xy_piece
       s0 = @current_pos
       s1 = parse_xy
@@ -667,6 +697,7 @@ module Jkf::Parser
       s0
     end
 
+    # nl : ("\r"? "\n") | " "* ","
     def parse_nl
       s0 = @current_pos
       s1 = match_str("\r")
@@ -692,10 +723,12 @@ module Jkf::Parser
       s0
     end
 
+    # nonl : [^\r\n]
     def parse_nonl
       match_regexp(/^[^\r\n]/)
     end
 
+    # nonls : nonl*
     def parse_nonls
       stack = []
       matched = parse_nonl
@@ -706,8 +739,7 @@ module Jkf::Parser
       stack
     end
 
-    protected
-
+    # lines to jkf
     def transform_komabetsu_lines(lines)
       board = generate_empty_board
       hands = [
@@ -737,6 +769,7 @@ module Jkf::Parser
       { "preset" => "OTHER", "data" => { "board" => board, "hands" => hands } }
     end
 
+    # return empty board jkf
     def generate_empty_board
       board = []
       9.times do |_i|
@@ -749,12 +782,14 @@ module Jkf::Parser
       board
     end
 
+    # sec to time(m, s)
     def sec2time(sec)
       s = sec % 60
       m = (sec - s) / 60
       { "m" => m, "s" => s }
     end
 
+    # return hirate board jkf
     def get_hirate
       [
         [{ "color" => 1, "kind" => "KY" }, {}, { "color" => 1, "kind" => "FU" }, {}, {}, {},
@@ -780,6 +815,7 @@ module Jkf::Parser
       ]
     end
 
+    # normalize header key
     def normalize_header_key(key)
       {
         "EVENT" => "棋戦",

data/lib/jkf/parser/ki2.rb

@@ -1,9 +1,13 @@
 # coding: utf-8
 
 module Jkf::Parser
+  # KI2 Parser
   class Ki2 < Base
     include Kifuable
 
+    protected
+
+    # kifu : header* initialboard? header* moves fork*
     def parse_root
       s0 = @current_pos
       s1 = []
@@ -42,6 +46,7 @@ module Jkf::Parser
       s0
     end
 
+    # header : [^：\r\n]+ "：" nonls nl+ | header_teban
     def parse_header
       s0 = @current_pos
       s2 = match_regexp(/^[^*：\r\n]/)
@@ -86,9 +91,10 @@ module Jkf::Parser
       s0
     end
 
+    # header_teban : [先後上下] "手番" nl
     def parse_header_teban
       s0 = @current_pos
-      s1 = match_regexp(/^[先後上下]/)
+      s1 = parse_turn
       if s1 != :failed
         s2 = match_str("手番")
         if s2 != :failed
@@ -110,6 +116,7 @@ module Jkf::Parser
       end
     end
 
+    # moves : firstboard : move* result?
     def parse_moves
       s0 = @current_pos
       s1 = parse_firstboard
@@ -135,6 +142,7 @@ module Jkf::Parser
       s0
     end
 
+    # firstboard : comment* pointer?
     def parse_firstboard
       s0 = @current_pos
       s1 = []
@@ -149,6 +157,7 @@ module Jkf::Parser
       s0
     end
 
+    # move : line comment* pointer? (nl | " ")*
     def parse_move
       s0 = @current_pos
       s1 = parse_line
@@ -182,6 +191,7 @@ module Jkf::Parser
       s0
     end
 
+    # line : [▲△] fugou (nl / " ")*
     def parse_line
       s0 = @current_pos
       s1 = match_regexp(/^[▲△]/)
@@ -214,6 +224,7 @@ module Jkf::Parser
       s0
     end
 
+    # fugou : place piece soutai? dousa? ("成" | "不成")? "打"?
     def parse_fugou
       s0 = @current_pos
       s1 = parse_place
@@ -241,6 +252,7 @@ module Jkf::Parser
       end
     end
 
+    # place : num numkan
     def parse_place
       s0 = @current_pos
       s1 = parse_num
@@ -271,15 +283,17 @@ module Jkf::Parser
       s0
     end
 
-
+    # soutai : [左直右]
     def parse_soutai
       match_regexp(/^[左直右]/)
     end
 
+    # dousa : [上寄引]
     def parse_dousa
       match_regexp(/^[上寄引]/)
     end
 
+    # "*" nonls nl
     def parse_comment
       s0 = @current_pos
       if match_str("*") != :failed
@@ -298,6 +312,7 @@ module Jkf::Parser
       s0
     end
 
+    # fork : "変化：" " "* [0-9]+ "手" nl moves
     def parse_fork
       s0 = @current_pos
       if match_str("変化：") != :failed
@@ -333,12 +348,12 @@ module Jkf::Parser
       s0
     end
 
+    # turn : [先後上下]
     def parse_turn
       match_regexp(/^[先後上下]/)
     end
 
-    protected
-
+    # transform to jkf
     def transform_root(headers, ini, headers2, moves, forks)
       ret = { "header" => {}, "moves" => moves }
       headers.compact.each { |h| ret["header"][h["k"]] = h["v"] }
@@ -354,6 +369,7 @@ module Jkf::Parser
       ret
     end
 
+    # transfrom fugou to jkf
     def transform_fugou(pl, pi, sou, dou, pro, da)
       ret = { "piece" => pi }
       if pl["same"]
@@ -371,6 +387,7 @@ module Jkf::Parser
       ret
     end
 
+    # relative string to jkf
     def soutai2relative(str)
       {
         "左" => "L",
@@ -379,6 +396,7 @@ module Jkf::Parser
       }[str] || ""
     end
 
+    # movement string to jkf
     def dousa2relative(str)
       {
         "上" => "U",
@@ -387,6 +405,7 @@ module Jkf::Parser
       }[str] || ""
     end
 
+    # generate motigoma
     def make_hand(str)
       ret = { "FU" => 0, "KY" => 0, "KE" => 0, "GI" => 0, "KI" => 0, "KA" => 0, "HI" => 0 }
       return ret if str.empty?
@@ -399,6 +418,7 @@ module Jkf::Parser
       ret
     end
 
+    # check eos
     def eos?
       @input[@current_pos].nil?
     end

data/lib/jkf/parser/kif.rb

@@ -1,9 +1,13 @@
 # coding: utf-8
 
 module Jkf::Parser
+  # KIF Parser
   class Kif < Base
     include Kifuable
 
+    protected
+
+    # kifu : skipline* header* initialboard? header* split? moves fork* nl?
     def parse_root
       @input += "\n" unless @input.end_with?("\n")
 
@@ -49,6 +53,9 @@ module Jkf::Parser
       s0
     end
 
+    # header : [^：\r\n]+ "：" nonls nl
+    #        | turn "手番" nl
+    #        | "盤面回転" nl
     def parse_header
       s0 = @current_pos
       s2 = match_regexp(/^[^：\r\n]/)
@@ -120,10 +127,12 @@ module Jkf::Parser
       s0
     end
 
+    # turn : [先後上下]
     def parse_turn
-      match_regexp(/[先後上下]/)
+      match_regexp(/^[先後上下]/)
     end
 
+    # split : "手数----指手--" "-------消費時間--"? nl
     def parse_split
       s0 = @current_pos
       s1 = match_str("手数----指手--")
@@ -144,6 +153,7 @@ module Jkf::Parser
       s0
     end
 
+    # moves : firstboard split? move* result?
     def parse_moves
       s0 = @current_pos
       s1 = parse_firstboard
@@ -165,6 +175,7 @@ module Jkf::Parser
       s0
     end
 
+    # firstboard : comment* pointer?
     def parse_firstboard
       s0 = @current_pos
       s1 = []
@@ -179,6 +190,7 @@ module Jkf::Parser
       s0
     end
 
+    # move : line comment* pointer?
     def parse_move
       s0 = @current_pos
       s1 = parse_line
@@ -199,6 +211,7 @@ module Jkf::Parser
       s0
     end
 
+    # line : " "* te " "* (fugou from | [^\r\n ]*) " "* time? "+"? nl
     def parse_line
       s0 = @current_pos
       match_spaces
@@ -254,10 +267,12 @@ module Jkf::Parser
       s0
     end
 
+    # te : [0-9]+
     def parse_te
       match_digits!
     end
 
+    # fugou : place piece "成"?
     def parse_fugou
       s0 = @current_pos
       s1 = parse_place
@@ -279,6 +294,7 @@ module Jkf::Parser
       s0
     end
 
+    # place : num numkan | "同　"
     def parse_place
       s0 = @current_pos
       s1 = parse_num
@@ -307,6 +323,7 @@ module Jkf::Parser
       s0
     end
 
+    # from : "打" | "(" [1-9] [1-9] ")"
     def parse_from
       s0 = @current_pos
       s1 = match_str("打")
@@ -345,16 +362,20 @@ module Jkf::Parser
       s0
     end
 
+    # time :  "(" " "* ms " "* "/" " "* (hms | ms) " "* ")"
     def parse_time
       s0 = @current_pos
       if match_str("(") != :failed
         match_spaces
         s3 = parse_ms
         if s3 != :failed
+          match_spaces
           if match_str("/") != :failed
+            match_spaces
             s5 = parse_hms
             s5 = parse_ms(with_hour: true) if s5 == :failed
             if s5 != :failed
+              match_spaces
               if match_str(")") != :failed
                 @reported_pos = s0
                 s0 = { "now" => s3, "total" => s5 }
@@ -381,6 +402,7 @@ module Jkf::Parser
       s0
     end
 
+    # hms : [0-9]+ ":" [0-9]+ ":" [0-9]+
     def parse_hms
       s0 = @current_pos
       s1 = match_digits!
@@ -417,6 +439,7 @@ module Jkf::Parser
       s0
     end
 
+    # ms : [0-9]+ ":" [0-9]+
     def parse_ms(with_hour: false)
       s0 = @current_pos
       s1 = match_digits!
@@ -449,6 +472,7 @@ module Jkf::Parser
       s0
     end
 
+    # comment : "*" nonls nl | "&" nonls nl
     def parse_comment
       s0 = @current_pos
       if match_str("*") != :failed
@@ -484,6 +508,7 @@ module Jkf::Parser
       s0
     end
 
+    # fork :  "変化：" " "* [0-9]+ "手" nl moves
     def parse_fork
       s0 = @current_pos
       if match_str("変化：") != :failed
@@ -519,8 +544,7 @@ module Jkf::Parser
       s0
     end
 
-    protected
-
+    # transfrom to jkf
     def transform_root(headers, ini, headers2, moves, forks)
       ret = { "header" => {}, "moves" => moves }
       headers.compact.each { |h| ret["header"][h["k"]] = h["v"] }
@@ -539,6 +563,7 @@ module Jkf::Parser
       ret
     end
 
+    # transform move to jkf
     def transform_move(line, c)
       ret = {}
       ret["comments"] = c if !c.empty?
@@ -551,6 +576,7 @@ module Jkf::Parser
       ret
     end
 
+    # transform teban-fugou-from to jkf
     def transform_teban_fugou_from(teban, fugou, from)
       ret = { "color" => teban2color(teban.join), "piece" => fugou["piece"] }
       if fugou["to"]
@@ -563,6 +589,7 @@ module Jkf::Parser
       ret
     end
 
+    # special string to csa
     def special2csa(str)
       {
         "中断" => "CHUDAN",
@@ -577,11 +604,13 @@ module Jkf::Parser
       }[str] || (raise ParseError)
     end
 
+    # teban to color
     def teban2color(teban)
       teban = teban.to_i unless teban.is_a? Fixnum
       (teban + 1) % 2
     end
 
+    # generate motigoma
     def make_hand(str)
       # Kifu for iPhoneは半角スペース区切り
       ret = { "FU" => 0, "KY" => 0, "KE" => 0, "GI" => 0, "KI" => 0, "KA" => 0, "HI" => 0 }
@@ -595,6 +624,7 @@ module Jkf::Parser
       ret
     end
 
+    # exchange sente gote
     def reverse_color(moves)
       moves.each do |move|
         if move["move"] && move["move"]["color"]

data/lib/jkf/parser/kifuable.rb

@@ -1,5 +1,9 @@
 module Jkf::Parser
+  # Intersection of KIF and KI2
   module Kifuable
+    protected
+
+    # initialboard : (" " nonls nl)? ("+" nonls nl)? ikkatsuline+ ("+" nonls nl)?
     def parse_initialboard
       s0 = s1 = @current_pos
       if match_space != :failed
@@ -42,6 +46,7 @@ module Jkf::Parser
       end
     end
 
+    # ikkatsuline : "|" masu:masu+ "|" nonls! nl
     def parse_ikkatsuline
       s0 = @current_pos
       if match_str("|") != :failed
@@ -86,6 +91,7 @@ module Jkf::Parser
       s0
     end
 
+    # masu : teban piece | " ・"
     def parse_masu
       s0 = @current_pos
       s1 = parse_teban
@@ -115,6 +121,7 @@ module Jkf::Parser
       s0
     end
 
+    # teban : (" " | "+" | "^") | ("v" | "V")
     def parse_teban
       s0 = @current_pos
       s1 = match_space
@@ -140,6 +147,7 @@ module Jkf::Parser
       s0
     end
 
+    # pointer : "&" nonls nl
     def parse_pointer
       s0 = @current_pos
       s1 = match_str("&")
@@ -159,6 +167,29 @@ module Jkf::Parser
       s0
     end
 
+    # num : [１２３４５６７８９]
+    def parse_num
+      s0 = @current_pos
+      s1 = match_regexp(/^[１２３４５６７８９]/)
+      if s1 != :failed
+        @reported_pos = s0
+        s1 = zen2n(s1)
+      end
+      s1
+    end
+
+    # numkan : [一二三四五六七八九]
+    def parse_numkan
+      s0 = @current_pos
+      s1 = match_regexp(/^[一二三四五六七八九]/)
+      if s1 != :failed
+        @reported_pos = s0
+        s1 = kan2n(s1)
+      end
+      s1
+    end
+
+    # piece : "成"? [歩香桂銀金角飛王玉と杏圭全馬竜龍]
     def parse_piece
       s0 = @current_pos
       s1 = match_str("成")
@@ -173,6 +204,11 @@ module Jkf::Parser
       end
     end
 
+    # result : "まで" [0-9]+ "手" (
+    #            "で" (turn "手の" (result_toryo | result_illegal)) |
+    #            result_timeup | result_chudan | result_jishogi |
+    #            result_sennichite | result_tsumi | result_fuzumi
+    #          ) nl
     def parse_result
       s0 = @current_pos
       if match_str("まで") != :failed
@@ -246,6 +282,7 @@ module Jkf::Parser
       end
     end
 
+    # result_toryo : "勝ち"
     def parse_result_toryo
       s0 = @current_pos
       s1 = match_str("勝ち")
@@ -258,6 +295,7 @@ module Jkf::Parser
       end
     end
 
+    # result_illegal : "反則" ("勝ち" | "負け")
     def parse_result_illegal
       s0 = @current_pos
       if match_str("反則") != :failed
@@ -290,6 +328,7 @@ module Jkf::Parser
       end
     end
 
+    # result_timeup : "で時間切れにより" turn "手の勝ち"
     def parse_result_timeup
       s0 = @current_pos
       if match_str("で時間切れにより") != :failed
@@ -311,6 +350,7 @@ module Jkf::Parser
       end
     end
 
+    # result_chudan : "で中断"
     def parse_result_chudan
       s0 = @current_pos
       s1 = match_str("で中断")
@@ -323,6 +363,7 @@ module Jkf::Parser
       end
     end
 
+    # result_jishogi : "で持将棋"
     def parse_result_jishogi
       s0 = @current_pos
       s1 = match_str("で持将棋")
@@ -335,6 +376,7 @@ module Jkf::Parser
       end
     end
 
+    # result_sennichite : "で千日手"
     def parse_result_sennichite
       s0 = @current_pos
       s1 = match_str("で千日手")
@@ -347,6 +389,7 @@ module Jkf::Parser
       end
     end
 
+    # result_tsumi : "で"? "詰" "み"?
     def parse_result_tsumi
       s0 = @current_pos
       match_str("で")
@@ -360,6 +403,7 @@ module Jkf::Parser
       end
     end
 
+    # result_fuzumi : "で不詰"
     def parse_result_fuzumi
       s0 = @current_pos
       s1 = match_str("で不詰")
@@ -372,6 +416,7 @@ module Jkf::Parser
       end
     end
 
+    # skipline : "#" nonls newline
     def parse_skipline
       s0 = @current_pos
       s1 = match_str("#")
@@ -391,30 +436,12 @@ module Jkf::Parser
       s0
     end
 
-    def parse_num
-      s0 = @current_pos
-      s1 = match_regexp(/^[１２３４５６７８９]/)
-      if s1 != :failed
-        @reported_pos = s0
-        s1 = zen2n(s1)
-      end
-      s1
-    end
-
-    def parse_numkan
-      s0 = @current_pos
-      s1 = match_regexp(/^[一二三四五六七八九]/)
-      if s1 != :failed
-        @reported_pos = s0
-        s1 = kan2n(s1)
-      end
-      s1
-    end
-
+    # whitespace : " " | "\t"
     def parse_whitespace
       match_regexp(/^[ \t]/)
     end
 
+    # newline : whitespace* ("\n" | "\r" "\n"?)
     def parse_newline
       s0 = @current_pos
       s1 = []
@@ -444,6 +471,7 @@ module Jkf::Parser
       end
     end
 
+    # nl : newline+ skipline*
     def parse_nl
       s0 = @current_pos
       s2 = parse_newline
@@ -470,10 +498,12 @@ module Jkf::Parser
       end
     end
 
+    # nonl : 
     def parse_nonl
       match_regexp(/^[^\r\n]/)
     end
 
+    # nonls : nonl*
     def parse_nonls
       stack = []
       matched = parse_nonl
@@ -484,6 +514,7 @@ module Jkf::Parser
       stack
     end
 
+    # nonls! : nonl+
     def parse_nonls!
       matched = parse_nonls
       if matched.empty?
@@ -493,8 +524,7 @@ module Jkf::Parser
       end
     end
 
-    protected
-
+    # transform header-data to jkf
     def transform_root_header_data(ret)
       if ret["header"]["手番"]
         ret["initial"]["data"]["color"] = "下先".include?(ret["header"]["手番"]) ? 0 : 1
@@ -511,6 +541,7 @@ module Jkf::Parser
       end
     end
 
+    # transfrom forks to jkf
     def transform_root_forks(forks, moves)
       fork_stack = [{ "te" => 0, "moves" => moves }]
       forks.each do |f|
@@ -525,6 +556,7 @@ module Jkf::Parser
       end
     end
 
+    # transform initialboard to jkf
     def transform_initialboard(lines)
       board = []
       9.times do |i|
@@ -537,14 +569,17 @@ module Jkf::Parser
       { "preset" => "OTHER", "data" => { "board" => board } }
     end
 
+    # zenkaku number to number
     def zen2n(s)
       "０１２３４５６７８９".index(s)
     end
 
+    # kanji number to number (1)
     def kan2n(s)
       "〇一二三四五六七八九".index(s)
     end
 
+    # kanji number to number (2)
     def kan2n2(s)
       case s.length
       when 1
@@ -556,6 +591,7 @@ module Jkf::Parser
       end
     end
 
+    # kanji piece-type to csa
     def kind2csa(kind)
       if kind[0] == "成"
         {
@@ -585,6 +621,7 @@ module Jkf::Parser
       end
     end
 
+    # preset string to jkf
     def preset2str(preset)
       {
         "平手" => "HIRATE",

data/lib/jkf/version.rb

@@ -1,3 +1,4 @@
 module Jkf
-  VERSION = "0.4.1".freeze
+  # Gem version
+  VERSION = "0.4.2".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jkf
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - iyuuya
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-24 00:00:00.000000000 Z
+date: 2016-02-25 00:00:00.000000000 Z
 dependencies: []
 description: converter/parser of records of shogi
 email:
@@ -27,6 +27,7 @@ files:
 - Gemfile
 - Guardfile
 - LICENSE.txt
+- README.en.md
 - README.md
 - Rakefile
 - bin/console