jkf 0.5.0 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89917b9a19146787b9ca404350177c8ab0637469ee3092a4763f14e459fbe2c4
-  data.tar.gz: 138426209524888ed9a55d7c759f37de24fa64ec4924600f2905d9413a923d31
+  metadata.gz: 365393f77c09c5ca61d79d520d1e8700449f66b9c5f8dd98f3c533d08b5205d6
+  data.tar.gz: de3a842b9d14005cfff7e9e4d41129b58d0fd9713b91def327e3e579c227498c
 SHA512:
-  metadata.gz: be20978f7c6b209f0cfdaa20f837ddc69eaa78302a6816c2e0e460b421ed14efbc25c38137fa45af5fcd499ba7d510fbe07fdad0b362fd5c6865aaa3b28a3299
-  data.tar.gz: f516443cf0c84ac89203dcf9019b03ec79b434d9991538f69b8ebc4932c6386b81d1b2b0a0149d5520e164fc18b1091ada59afa20ab5ac860df273e59c4d1265
+  metadata.gz: 290f7bd7bec9ccf530ae186a6ee5293827be45fb4b9c3e719d355044b00695d3656e62fd47111d7a7c031ed007d369b51f45518ba48b71a9e80b82dba2b093db
+  data.tar.gz: c6d9965c4d109352d9fab43dbc17647ded822e02ea24ff41755194c70f8523d7636b43b04df891e127d070bf235c93a63815749adda2b0780260f66778122442

data/.envrc

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

data/.rubocop.yml

@@ -2,7 +2,74 @@ inherit_from: .rubocop_todo.yml
 
 AllCops:
   NewCops: enable
+  DisabledByDefault: true
 
 require:
   - rubocop-rake
   - rubocop-rspec
+  - rubocop-performance
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  EnforcedStyle: never
+
+Layout/HashAlignment:
+  Enabled: true
+  EnforcedHashRocketStyle: key # キーが全角文字の場合が多いため
+
+Lint/AssignmentInCondition:
+  Enabled: true
+
+Lint/DuplicateBranch:
+  Enabled: false # FIXME
+
+Lint/UnderscorePrefixedVariableName:
+  Enabled: true
+
+Naming/AccessorMethodName:
+  Enabled: true
+
+RSpec/DescribedClass:
+  Enabled: true
+
+Style/ClassAndModuleChildren:
+  Enabled: true
+
+Style/Encoding:
+  Enabled: true
+
+Style/ExpandPathArguments:
+  Enabled: true
+
+Style/HashLikeCase:
+  Enabled: true
+
+Style/NegatedIf:
+  Enabled: true
+
+Style/RedundantAssignment:
+  Enabled: true
+
+Style/RedundantReturn:
+  Enabled: true
+
+Style/RescueStandardError:
+  Enabled: true
+
+Style/SafeNavigation:
+  Enabled: true
+
+Style/StringLiterals:
+  Enabled: true
+
+Style/GuardClause:
+  Enabled: true
+
+Performance/StringInclude:
+  Enabled: true
+
+Performance/RegexpMatch:
+  Enabled: true
+
+Performance/MapCompact:
+  Enabled: true

data/.rubocop_todo.yml

@@ -1,460 +1,7 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2022-07-22 12:33:37 UTC using RuboCop version 1.32.0.
+# 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: 3
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: TreatCommentsAsGroupSeparators, ConsiderPunctuation, Include.
-# Include: **/*.gemfile, **/Gemfile, **/gems.rb
-Bundler/OrderedGems:
-  Exclude:
-    - 'Gemfile'
-
-# Offense count: 5
-# This cop supports safe autocorrection (--autocorrect).
-Layout/EmptyLineAfterGuardClause:
-  Exclude:
-    - 'lib/jkf.rb'
-    - 'lib/jkf/converter/csa.rb'
-    - 'lib/jkf/parser/base.rb'
-    - 'lib/jkf/parser/ki2.rb'
-    - 'lib/jkf/parser/kif.rb'
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-Layout/EmptyLineAfterMagicComment:
-  Exclude:
-    - 'jkf.gemspec'
-
-# Offense count: 2
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: AllowMultipleStyles, EnforcedHashRocketStyle, EnforcedColonStyle, EnforcedLastArgumentHashStyle.
-# SupportedHashRocketStyles: key, separator, table
-# SupportedColonStyles: key, separator, table
-# SupportedLastArgumentHashStyles: always_inspect, always_ignore, ignore_implicit, ignore_explicit
-Layout/HashAlignment:
-  Exclude:
-    - 'spec/jkf/converter/kif_spec.rb'
-
-# Offense count: 35
-# This cop supports safe autocorrection (--autocorrect).
-Layout/HeredocIndentation:
-  Exclude:
-    - 'spec/jkf/converter/kif_spec.rb'
-    - 'spec/jkf/parser/csa_spec.rb'
-    - 'spec/jkf/parser/ki2_spec.rb'
-    - 'spec/jkf/parser/kif_spec.rb'
-
-# Offense count: 2
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: symmetrical, new_line, same_line
-Layout/MultilineHashBraceLayout:
-  Exclude:
-    - 'spec/jkf/parser/ki2_spec.rb'
-    - 'spec/jkf/parser/kif_spec.rb'
-
-# Offense count: 10
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: require_no_space, require_space
-Layout/SpaceInLambdaLiteral:
-  Exclude:
-    - 'lib/jkf/parser/csa.rb'
-    - 'lib/jkf/parser/ki2.rb'
-
-# Offense count: 58
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: AllowInHeredoc.
-Layout/TrailingWhitespace:
-  Exclude:
-    - 'lib/jkf/converter/base.rb'
-    - 'lib/jkf/parser/kifuable.rb'
-    - 'spec/jkf/converter/kif_spec.rb'
-    - 'spec/jkf/parser/csa_spec.rb'
-    - 'spec/jkf/parser/kif_spec.rb'
-
-# Offense count: 2
-# Configuration parameters: AllowSafeAssignment.
-Lint/AssignmentInCondition:
-  Exclude:
-    - 'lib/jkf/converter/kifuable.rb'
-    - 'lib/jkf/parser/base.rb'
-
-# Offense count: 22
-# Configuration parameters: IgnoreLiteralBranches, IgnoreConstantBranches.
-Lint/DuplicateBranch:
-  Exclude:
-    - 'lib/jkf/parser/csa.rb'
-    - 'lib/jkf/parser/ki2.rb'
-    - 'lib/jkf/parser/kif.rb'
-    - 'lib/jkf/parser/kifuable.rb'
-
-# Offense count: 2
-# Configuration parameters: AllowKeywordBlockArguments.
-Lint/UnderscorePrefixedVariableName:
-  Exclude:
-    - 'lib/jkf/parser/kif.rb'
-    - 'lib/jkf/parser/kifuable.rb'
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-Lint/UnifiedInteger:
-  Exclude:
-    - 'lib/jkf/parser/kif.rb'
-
-# Offense count: 51
-# Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
-Metrics/AbcSize:
-  Max: 50
-
-# Offense count: 13
-# Configuration parameters: CountBlocks.
-Metrics/BlockNesting:
-  Max: 8
-
-# Offense count: 5
-# Configuration parameters: CountComments, CountAsOne.
-Metrics/ClassLength:
-  Max: 738
-
-# Offense count: 21
-# Configuration parameters: IgnoredMethods.
-Metrics/CyclomaticComplexity:
-  Max: 18
-
-# Offense count: 91
-# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
-Metrics/MethodLength:
-  Max: 64
-
-# Offense count: 2
-# Configuration parameters: CountComments, CountAsOne.
-Metrics/ModuleLength:
-  Max: 558
-
-# Offense count: 1
-# Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
-Metrics/ParameterLists:
-  Max: 6
-
-# Offense count: 31
-# Configuration parameters: IgnoredMethods.
-Metrics/PerceivedComplexity:
-  Max: 24
-
-# Offense count: 1
-Naming/AccessorMethodName:
-  Exclude:
-    - 'lib/jkf/parser/csa.rb'
-
-# Offense count: 34
-# Configuration parameters: ForbiddenDelimiters.
-# ForbiddenDelimiters: (?-mix:(^|\s)(EO[A-Z]{1}|END)(\s|$))
-Naming/HeredocDelimiterNaming:
-  Exclude:
-    - 'spec/jkf/parser/csa_spec.rb'
-    - 'spec/jkf/parser/ki2_spec.rb'
-    - 'spec/jkf/parser/kif_spec.rb'
-
-# Offense count: 17
-# Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
-# AllowedNames: at, by, db, id, in, io, ip, of, on, os, pp, to
-Naming/MethodParameterName:
-  Exclude:
-    - 'lib/jkf/converter/kif.rb'
-    - 'lib/jkf/converter/kifuable.rb'
-    - 'lib/jkf/parser/ki2.rb'
-    - 'lib/jkf/parser/kif.rb'
-    - 'lib/jkf/parser/kifuable.rb'
-    - 'spec/spec_helper.rb'
-
-# Offense count: 43
-# Configuration parameters: Prefixes.
-# Prefixes: when, with, without
-RSpec/ContextWording:
-  Exclude:
-    - 'spec/jkf/parser/csa_spec.rb'
-    - 'spec/jkf/parser/ki2_spec.rb'
-    - 'spec/jkf/parser/kif_spec.rb'
-
-# Offense count: 8
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: SkipBlocks, EnforcedStyle.
-# SupportedStyles: described_class, explicit
-RSpec/DescribedClass:
-  Exclude:
-    - 'spec/jkf/converter/csa_spec.rb'
-    - 'spec/jkf/converter/ki2_spec.rb'
-    - 'spec/jkf/converter/kif_spec.rb'
-    - 'spec/jkf/parser/csa_spec.rb'
-    - 'spec/jkf/parser/ki2_spec.rb'
-    - 'spec/jkf/parser/kif_spec.rb'
-    - 'spec/jkf_spec.rb'
-
-# Offense count: 45
-# Configuration parameters: CountAsOne.
-RSpec/ExampleLength:
-  Max: 51
-
-# Offense count: 1
-RSpec/MultipleExpectations:
-  Max: 2
-
-# Offense count: 1
-# Configuration parameters: AllowSubject.
-RSpec/MultipleMemoizedHelpers:
-  Max: 6
-
-# Offense count: 48
-# Configuration parameters: IgnoreSharedExamples.
-RSpec/NamedSubject:
-  Exclude:
-    - 'spec/jkf/converter/kif_spec.rb'
-    - 'spec/jkf/parser/csa_spec.rb'
-    - 'spec/jkf/parser/ki2_spec.rb'
-    - 'spec/jkf/parser/kif_spec.rb'
-    - 'spec/jkf_spec.rb'
-
-# Offense count: 8
-RSpec/NestedGroups:
-  Max: 4
-
-# Offense count: 2
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle, ProceduralMethods, FunctionalMethods, IgnoredMethods, AllowBracesOnProceduralOneLiners, BracesRequiredMethods.
-# SupportedStyles: line_count_based, semantic, braces_for_chaining, always_braces
-# ProceduralMethods: benchmark, bm, bmbm, create, each_with_object, measure, new, realtime, tap, with_object
-# FunctionalMethods: let, let!, subject, watch
-# IgnoredMethods: lambda, proc, it
-Style/BlockDelimiters:
-  Exclude:
-    - 'spec/jkf/converter/kif_spec.rb'
-
-# Offense count: 10
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: nested, compact
-Style/ClassAndModuleChildren:
-  Exclude:
-    - 'lib/jkf/converter/base.rb'
-    - 'lib/jkf/converter/csa.rb'
-    - 'lib/jkf/converter/ki2.rb'
-    - 'lib/jkf/converter/kif.rb'
-    - 'lib/jkf/converter/kifuable.rb'
-    - 'lib/jkf/parser/base.rb'
-    - 'lib/jkf/parser/csa.rb'
-    - 'lib/jkf/parser/ki2.rb'
-    - 'lib/jkf/parser/kif.rb'
-    - 'lib/jkf/parser/kifuable.rb'
-
-# Offense count: 1
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: allowed_in_returns, forbidden
-Style/DoubleNegation:
-  Exclude:
-    - 'lib/jkf/parser/kif.rb'
-
-# Offense count: 4
-# This cop supports safe autocorrection (--autocorrect).
-Style/Encoding:
-  Exclude:
-    - 'jkf.gemspec'
-    - 'lib/jkf/parser/csa.rb'
-    - 'lib/jkf/parser/ki2.rb'
-    - 'lib/jkf/parser/kif.rb'
-
-# Offense count: 2
-# This cop supports safe autocorrection (--autocorrect).
-Style/ExpandPathArguments:
-  Exclude:
-    - 'jkf.gemspec'
-    - 'spec/spec_helper.rb'
-
-# Offense count: 6
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: format, sprintf, percent
-Style/FormatString:
-  Exclude:
-    - 'lib/jkf/converter/csa.rb'
-    - 'lib/jkf/converter/kif.rb'
-    - 'lib/jkf/converter/kifuable.rb'
-
-# Offense count: 9
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: MaxUnannotatedPlaceholdersAllowed, IgnoredMethods.
-# SupportedStyles: annotated, template, unannotated
-Style/FormatStringToken:
-  EnforcedStyle: unannotated
-
-# Offense count: 27
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: always, always_true, never
-Style/FrozenStringLiteralComment:
-  Enabled: false
-
-# Offense count: 1
-# Configuration parameters: MinBodyLength, AllowConsecutiveConditionals.
-Style/GuardClause:
-  Exclude:
-    - 'lib/jkf/parser/base.rb'
-
-# Offense count: 3
-# Configuration parameters: MinBranchesCount.
-Style/HashLikeCase:
-  Exclude:
-    - 'lib/jkf/converter/csa.rb'
-    - 'lib/jkf/converter/kif.rb'
-    - 'lib/jkf/converter/kifuable.rb'
-
-# Offense count: 4
-# This cop supports safe autocorrection (--autocorrect).
-Style/IfUnlessModifier:
-  Exclude:
-    - 'lib/jkf/converter/csa.rb'
-    - 'lib/jkf/parser/kif.rb'
-
-# Offense count: 10
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: line_count_dependent, lambda, literal
-Style/Lambda:
-  Exclude:
-    - 'lib/jkf/parser/csa.rb'
-    - 'lib/jkf/parser/ki2.rb'
-
-# Offense count: 6
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: both, prefix, postfix
-Style/NegatedIf:
-  Exclude:
-    - 'lib/jkf/converter/ki2.rb'
-    - 'lib/jkf/converter/kif.rb'
-    - 'lib/jkf/parser/csa.rb'
-    - 'lib/jkf/parser/ki2.rb'
-    - 'lib/jkf/parser/kif.rb'
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle, MinBodyLength.
-# SupportedStyles: skip_modifier_ifs, always
-Style/Next:
-  Exclude:
-    - 'lib/jkf/converter/kifuable.rb'
-
-# Offense count: 10
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: EnforcedStyle, IgnoredMethods.
-# SupportedStyles: predicate, comparison
-Style/NumericPredicate:
-  Exclude:
-    - 'spec/**/*'
-    - 'lib/jkf/converter/csa.rb'
-    - 'lib/jkf/converter/ki2.rb'
-    - 'lib/jkf/converter/kifuable.rb'
-    - 'lib/jkf/parser/base.rb'
-    - 'lib/jkf/parser/csa.rb'
-
-# Offense count: 3
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: PreferredDelimiters.
-Style/PercentLiteralDelimiters:
-  Exclude:
-    - 'Guardfile'
-    - 'lib/jkf/parser/kifuable.rb'
-
-# Offense count: 5
-# This cop supports safe autocorrection (--autocorrect).
-Style/RedundantAssignment:
-  Exclude:
-    - 'lib/jkf/parser/csa.rb'
-    - 'lib/jkf/parser/ki2.rb'
-    - 'lib/jkf/parser/kif.rb'
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: AllowMultipleReturnValues.
-Style/RedundantReturn:
-  Exclude:
-    - 'lib/jkf/parser/base.rb'
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle, AllowInnerSlashes.
-# SupportedStyles: slashes, percent_r, mixed
-Style/RegexpLiteral:
-  Exclude:
-    - 'Guardfile'
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: implicit, explicit
-Style/RescueStandardError:
-  Exclude:
-    - 'lib/jkf.rb'
-
-# Offense count: 2
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: ConvertCodeThatCanStartToReturnNil, AllowedMethods, MaxChainLength.
-# AllowedMethods: present?, blank?, presence, try, try!
-Style/SafeNavigation:
-  Exclude:
-    - 'lib/jkf/converter/kifuable.rb'
-    - 'lib/jkf/parser/kif.rb'
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: AllowIfMethodIsEmpty.
-Style/SingleLineMethods:
-  Exclude:
-    - 'lib/jkf/parser/base.rb'
-
-# Offense count: 4
-# This cop supports unsafe autocorrection (--autocorrect-all).
-Style/SlicingWithRange:
-  Exclude:
-    - 'lib/jkf/parser/ki2.rb'
-    - 'lib/jkf/parser/kif.rb'
-
-# Offense count: 14
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: Mode.
-Style/StringConcatenation:
-  Exclude:
-    - 'lib/jkf/converter/csa.rb'
-    - 'lib/jkf/converter/ki2.rb'
-    - 'lib/jkf/converter/kif.rb'
-    - 'lib/jkf/converter/kifuable.rb'
-    - 'lib/jkf/parser/kif.rb'
-    - 'spec/jkf/converter/csa_spec.rb'
-
-# Offense count: 4001
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
-# SupportedStyles: single_quotes, double_quotes
-Style/StringLiterals:
-  Enabled: false
-
-# Offense count: 5
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: WordRegex.
-# SupportedStyles: percent, brackets
-Style/WordArray:
-  EnforcedStyle: percent
-  MinSize: 3
-
-# Offense count: 16
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns, IgnoredPatterns.
-# URISchemes: http, https
-Layout/LineLength:
-  Max: 122

data/.yardopts

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

data/CHANGELOG.md

@@ -7,6 +7,33 @@ 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
+
+* 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

data/Gemfile

@@ -1,21 +1,22 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 gemspec
 
-gem "rake"
+gem 'rake'
 
 group :development do
-  gem "yard", require: false
-  gem "redcarpet", require: false
+  gem 'redcarpet'
+  gem 'yard'
 
-  gem "rubocop", "~> 1.32.0", require: false
-  gem "guard-rubocop", 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 "rspec", "~> 3.0", require: false
-  gem "guard-rspec", require: false
-  gem "simplecov", require: false
+  gem 'guard-rspec'
+  gem 'rspec', '~> 3.0'
+  gem 'simplecov'
 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