jkf 0.4.3 → 0.5.1

data/.rubocop_todo.yml

@@ -1,11 +1,7 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2016-02-24 04:22:16 +0900 using RuboCop version 0.37.2.
+# on 2023-06-18 08:39:04 UTC using RuboCop version 1.48.1.
 # 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.
-
-# Offense count: 30
-Metrics/AbcSize:
-  Max: 127

data/CHANGELOG.md

@@ -0,0 +1,63 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.5.1] - 2023-06-24
+
+### Changed
+
+* Update required Ruby version to 3.0 (security fix only stable
+  version), although the library itself might works with older Ruby
+  versions.
+
+### Others
+
+* Refactor parser with StringScanner.  This makes parser approx. 5x
+  faster.
+* Fixed link to json-kifu-format
+* Remove Inch CI link on readmes
+* Lint Ruby sources
+* Add benchmark script
+
+## [0.5.0] - 2023-06-18
+
+### Changed
+
+* Set required Ruby version to 2.7; this will be updated to 3.0 or
+  later in the next release.
+
+### Fixed
+
+* Remove `Fixnum` usage with integrated `Integer` for Ruby 3.2 or
+  later.
+
+### Others
+
+* Remove Rake version constraint
+* Support development on Guix
+* Enable RubyGems MFA required to true (for maintainers)
+
+Documents:
+
+* Fixed readme usages
+* Update English readme; introduce translation management
+* Update readme links about CI or code coverage services
+
+CI:
+
+* Migrate CI from Travis CI to GitHub Actions
+* Migrate from Code Climate to SimpleCov
+
+Lint tool:
+
+* Update RuboCop versin and config
+* Lint source codes with RuboCop
+
+and,
+
+* Add this changelog

data/Gemfile

@@ -1,19 +1,21 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 gemspec
 
-gem "rake", "~> 10.0"
+gem 'rake'
 
 group :development do
-  gem "yard", require: false
-  gem "redcarpet", require: false
+  gem 'redcarpet', require: false
+  gem 'yard', require: false
 
-  gem "rubocop", "~> 0.37.2", require: false
-  gem "guard-rubocop", 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
 end
 
 group :test do
-  gem "codeclimate-test-reporter", require: nil
-  gem "rspec", "~> 3.0", require: false
-  gem "guard-rspec", require: false
+  gem 'guard-rspec', require: false
+  gem 'rspec', '~> 3.0', require: false
+  gem 'simplecov', require: false
 end

data/Guardfile

@@ -3,8 +3,8 @@ scope(groups: %w(specs))
 directories %w(spec lib)
 
 group :specs, halt_on_fail: true do
-  guard :rspec, cmd: "bundle exec rspec", failed_mode: :keep do
-    require "guard/rspec/dsl"
+  guard :rspec, cmd: 'bundle exec rspec', failed_mode: :keep do
+    require 'guard/rspec/dsl'
     dsl = Guard::RSpec::Dsl.new(self)
 
     # RSpec files
@@ -18,7 +18,7 @@ group :specs, halt_on_fail: true do
     dsl.watch_spec_files_for(ruby.lib_files)
   end
 
-  guard :rubocop, all_on_start: false, cli: "--rails" do
+  guard :rubocop, all_on_start: false, cli: '--rails' do
     watch(%r{.+\.rb$}) { |m| m[0] }
     watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
   end

data/README.en.md

@@ -1,32 +1,38 @@
 # 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)
+[![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.
 
-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
+[jkf]:https://github.com/na2hiro/Kifu-for-JS/tree/master/packages/json-kifu-format
 
 ## Installation
 
-Add this line to your application's Gemfile:
+If you install this gem to your application (with Bundler), add this to
+Gemfile.
 
 ```ruby
 gem 'jkf'
 ```
 
-And then execute:
+Then run bundle to install this gem.
 
     $ bundle
 
-Or install it yourself as:
+Or directly install with gem install command.
 
     $ gem install jkf
 
 ## Usage
 
+This gem has the Parser and the Converter for each formats: KIF, KI2, and
+CSA.
+
 ```ruby
 kif_parser = Jkf::Parser::Kif.new
 ki2_parser = Jkf::Parser::Ki2.new
@@ -39,6 +45,9 @@ 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.
+
 ```ruby
 jkf = kif_parser.parse(kif_str) #=> Hash
 jkf = ki2_parser.parse(ki2_str) #=> Hash
@@ -46,16 +55,20 @@ 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
+kif = kif_converter.convert(jkf) #=> String
+ki2 = ki2_converter.convert(jkf) #=> String
+csa = csa_converter.convert(jkf) #=> String
 ```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/iyuuya/jkf.
+Feel free to report bugs or send pull requests at
+[GitHub](https://github.com/iyuuya/jkf).
+
+If you work on Guix, run tests by `guix shell`.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+This gem is licensed under the [MIT
+License](http://opensource.org/licenses/MIT).
 

data/README.md

@@ -1,9 +1,11 @@
 # 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)
+[![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棋譜フォーマット( https://github.com/na2hiro/json-kifu-format )をRubyに移植したものです。
+jkfは[JSON棋譜フォーマット (JKF)][jkf]をRubyに移植したものです。
 KIF, KI2, CSAをパースしJKFへ変換、JKFからKIF, KI2, CSAへの変換に対応しています。
 
+[jkf]: https://github.com/na2hiro/Kifu-for-JS/tree/master/packages/json-kifu-format
+
 ## Installation
 
 アプリケーションにインストールする場合(bundlerを使用する場合)、Gemfileに以下のように記述してください。
@@ -45,9 +47,9 @@ 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
+kif = kif_converter.convert(jkf) #=> String
+ki2 = ki2_converter.convert(jkf) #=> String
+csa = csa_converter.convert(jkf) #=> String
 ```
 
 ## Contributing
@@ -55,6 +57,8 @@ csa = csa_converter.parse(jkf) #=> String
 バグレポートやプルリクエストはGithubでよろしくお願いします。
 https://github.com/iyuuya/jkf.
 
+Guixで開発されている場合は`guix shell`で`rake test`によるテスト実行ができます。
+
 ## License
 
 ライセンスはMITです。

data/Rakefile

@@ -1,6 +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'
+task :translate do
+  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,21 +1,23 @@
-# 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']
+  spec.email = ['i.yuuya@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 = '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.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.bindir = 'exe'
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
+  spec.metadata['rubygems_mfa_required'] = 'true'
 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