portable_move_notation 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e6205e5d1aa0950be8c8934677202eddb3b340eae622041921cd11bd0f3cfa41
+  data.tar.gz: 3e418aa570709a18c755883a008f44bb95831cf62f300137460ab72544169994
+SHA512:
+  metadata.gz: 0e5aafa8e00194014d5ae5a2d29b655f117c5eb61f8f2ce9e899357ec4823a475a313ed1a0f2f86d3b75cf0798aacfc937667a5becff36d09db93c65bc01871b
+  data.tar.gz: fb2fda7806d5fb67f72483d3ff3d9fd93b5ae427bba818a1401df46cc73954c715d1a7108e2a63116c77241cc5c131528e7eb5084d56da1827a5d2fe86b2cee1

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,41 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2019-08-05 16:17:14 +0200 using RuboCop version 0.74.0.
+# 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: 1
+Metrics/AbcSize:
+  Max: 18
+
+# Offense count: 1
+Metrics/CyclomaticComplexity:
+  Max: 8
+
+# Offense count: 1
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/MethodLength:
+  Max: 12
+
+# Offense count: 1
+Metrics/PerceivedComplexity:
+  Max: 8
+
+# Offense count: 4
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/portable_move_notation/action/dump.rb'
+    - 'lib/portable_move_notation/action/load.rb'
+    - 'lib/portable_move_notation/dump.rb'
+    - 'lib/portable_move_notation/load.rb'
+
+# Offense count: 12
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 490

data/.ruby-version

@@ -0,0 +1 @@
+2.6.3

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.0.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at contact@cyril.email. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+ruby '2.6.3'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    portable_move_notation (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    awesome_print (1.8.0)
+    byebug (11.0.1)
+    docile (1.3.2)
+    jaro_winkler (1.5.3)
+    json (2.2.0)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    rubocop (0.74.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-performance (1.4.1)
+      rubocop (>= 0.71.0)
+    ruby-progressbar (1.10.1)
+    simplecov (0.17.0)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    unicode-display_width (1.6.0)
+    yard (0.9.20)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print
+  bundler (~> 2.0)
+  byebug
+  portable_move_notation!
+  rake (~> 12.3)
+  rubocop (~> 0.72)
+  rubocop-performance (~> 1.4)
+  simplecov (~> 0.17)
+  yard (~> 0.9)
+
+RUBY VERSION
+   ruby 2.6.3p62
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Cyril Kato
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,90 @@
+# Portable Move Notation
+
+A Ruby interface for data serialization in PMN format.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'portable_move_notation'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install portable_move_notation
+
+## Usage
+
+Working with PMN can be very simple, for example:
+
+```ruby
+require 'portable_move_notation'
+
+# Parse a PMN string
+
+PortableMoveNotation.load('52,36,W:P.12,28,w:p.53,37,W:P') # => [[[52, 36, "W:P", nil]], [[12, 28, "w:p", nil]], [[53, 37, "W:P", nil]]]
+
+# Emit some PMN
+
+some_moves = [
+  [[52, 36, 'W:P', nil]],
+  [[12, 28, 'w:p', nil]],
+  [[53, 37, 'W:P', nil]]
+]
+
+PortableMoveNotation.dump(*some_moves) # => '52,36,W:P.12,28,w:p.53,37,W:P'
+```
+
+### Other examples
+
+#### Castling on kingside
+
+```ruby
+PortableMoveNotation.dump(*[[[60, 62, "W:-K", nil], [63, 61, "W:R", nil]]]) # => "60,62,W:-K;63,61,W:R"
+PortableMoveNotation.load('60,62,W:-K;63,61,W:R') # => [[[60, 62, "W:-K", nil], [63, 61, "W:R", nil]]]
+```
+
+#### Promoting a chess pawn into a knight
+
+```ruby
+PortableMoveNotation.dump(*[[[12, 4, "W:P", "W:N"]]]) # => "12,4,W:P,W:N"
+PortableMoveNotation.load('12,4,W:P,W:N') # => [[[12, 4, "W:P", "W:N"]]]
+```
+
+#### Promoting a shogi pawn
+
+```ruby
+PortableMoveNotation.dump(*[[[33, 24, "S:P", "S:+P"]]]) # => "33,24,S:P,S:+P"
+PortableMoveNotation.load('33,24,S:P,S:+P') # => [[[33, 24, "S:P", "S:+P"]]]
+```
+
+#### Dropping a shogi pawn
+
+```ruby
+PortableMoveNotation.dump(*[[[nil, 42, "S:P", nil]]]) # => "*,42,S:P"
+PortableMoveNotation.load('*,42,S:P') # => [[[nil, 42, "S:P", nil]]]
+```
+
+#### Capturing a white chess pawn en passant
+
+```ruby
+PortableMoveNotation.dump(*[[[48, 32, "W:P", nil]], [[33, 32, "w:p", nil], [32, 40, "w:p", nil]]]) # => "48,32,W:P.33,32,w:p;32,40,w:p"
+PortableMoveNotation.load('48,32,W:P.33,32,w:p;32,40,w:p') # => [[[48, 32, "W:P", nil]], [[33, 32, "w:p", nil], [32, 40, "w:p", nil]]]
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sashite/portable_move_notation.rb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the PortableMoveNotation project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/sashite/portable_move_notation.rb/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rubocop/rake_task'
+
+require 'byebug'
+
+RuboCop::RakeTask.new do |task|
+  task.requires << 'rubocop-performance'
+end
+
+Rake::TestTask.new do |t|
+  t.pattern = 'test/**/*.rb'
+  t.verbose = true
+  t.warning = true
+end
+
+namespace :test do
+  task :coverage do
+    ENV['COVERAGE'] = 'true'
+    Rake::Task['test'].invoke
+  end
+end
+
+task(:doc_stats) { ruby '-S yard stats' }
+task default: %i[test doc_stats rubocop]
+
+Dir.glob(File.join('tasks', '**', '*.rake')).each { |r| import(r) }

data/VERSION.semver

@@ -0,0 +1 @@
+0.1.0

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'portable_move_notation'
+
+# 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!)
+# require 'pry'
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/portable_move_notation.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# Portable Move Notation module
+module PortableMoveNotation
+  def self.dump(*moves)
+    Dump.call(*moves)
+  end
+
+  def self.load(pmn_string)
+    Load.call(pmn_string)
+  end
+end
+
+require_relative 'portable_move_notation/dump'
+require_relative 'portable_move_notation/load'

data/lib/portable_move_notation/action/dump.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module PortableMoveNotation
+  module Action
+    class Dump
+      def self.call(*unserialized_actions)
+        unserialized_actions.map { |params| new(*params).call }.join(';')
+      end
+
+      attr_reader :src_square, :dst_square, :piece_name, :piece_hand
+
+      def initialize(src_square, dst_square, piece_name, piece_hand)
+        unless src_square.nil?
+          raise src_square.inspect unless src_square.is_a?(Integer)
+        end
+
+        raise dst_square.inspect unless dst_square.is_a?(Integer)
+        raise piece_name.inspect unless piece_name.is_a?(String)
+
+        unless piece_hand.nil?
+          raise piece_hand.inspect unless piece_hand.is_a?(String)
+        end
+
+        @src_square = (src_square.nil? ? '*' : src_square)
+        @dst_square = dst_square
+        @piece_name = piece_name
+        @piece_hand = piece_hand
+      end
+
+      def call
+        arr = if piece_hand.nil?
+                [src_square, dst_square, piece_name]
+              else
+                [src_square, dst_square, piece_name, piece_hand]
+              end
+
+        arr.join(',')
+      end
+    end
+  end
+end

data/lib/portable_move_notation/action/load.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module PortableMoveNotation
+  module Action
+    class Load
+      def self.call(serialized_actions)
+        serialized_actions.split(';').map do |serialized_action|
+          new(serialized_action).call
+        end
+      end
+
+      attr_reader :serialized_action
+
+      def initialize(serialized_action)
+        @serialized_action = serialized_action
+      end
+
+      def call
+        action_args = serialized_action.split(',')
+
+        src_square = action_args.fetch(0)
+        src_square = src_square.eql?('*') ? nil : src_square.to_i
+        dst_square = action_args.fetch(1).to_i
+        piece_name = action_args.fetch(2)
+        piece_hand = action_args.fetch(3, nil)
+
+        [src_square, dst_square, piece_name, piece_hand]
+      end
+    end
+  end
+end

data/lib/portable_move_notation/dump.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module PortableMoveNotation
+  class Dump
+    def self.call(*unserialized_moves)
+      unserialized_moves.map { |actions| Action::Dump.call(*actions) }.join('.')
+    end
+  end
+end
+
+require_relative 'action/dump'

data/lib/portable_move_notation/load.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module PortableMoveNotation
+  class Load
+    def self.call(serialized_moves)
+      serialized_moves.split('.').map do |serialized_actions|
+        Action::Load.call(serialized_actions)
+      end
+    end
+  end
+end
+
+require_relative 'action/load'

data/portable_move_notation.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name          = 'portable_move_notation'
+  spec.version       = File.read('VERSION.semver')
+  spec.authors       = ['Cyril Kato']
+  spec.email         = ['contact@cyril.email']
+  spec.description   = 'A Ruby interface for data serialization in PMN format.'
+  spec.summary       = 'Data serialization in PMN format.'
+  spec.homepage      = 'https://github.com/sashite/portable_move_notation.rb'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'awesome_print'
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'rake', '~> 12.3'
+  spec.add_development_dependency 'rubocop', '~> 0.72'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.4'
+  spec.add_development_dependency 'simplecov', '~> 0.17'
+  spec.add_development_dependency 'yard', '~> 0.9'
+end

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: portable_move_notation
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Cyril Kato
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.72'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.72'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: A Ruby interface for data serialization in PMN format.
+email:
+- contact@cyril.email
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION.semver
+- bin/console
+- bin/setup
+- lib/portable_move_notation.rb
+- lib/portable_move_notation/action/dump.rb
+- lib/portable_move_notation/action/load.rb
+- lib/portable_move_notation/dump.rb
+- lib/portable_move_notation/load.rb
+- portable_move_notation.gemspec
+homepage: https://github.com/sashite/portable_move_notation.rb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Data serialization in PMN format.
+test_files: []