sashite-pan 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ddc5404d30aecb881216eeeda12f98c7295f8dd415302f343c8ac0d0434a7289
-  data.tar.gz: a70d32986e8e6c1f90dedd8039562089e1f40b8c64a4dcfb518f0bfdd0592904
+  metadata.gz: 12680869115791fc6fe8332162cbeaa71174b8ba5c5d74ebb531a805355dae1b
+  data.tar.gz: 1147d462de504b726ec26337bf8bfa69b28a8d3e195dbf6b2922b9b3ccaa9cf3
 SHA512:
-  metadata.gz: f1ec2c07c1e3ecfbd9dde636595c182178891217eeea5c2724c994b8e8010f2d8ae371e48a5399ef3682ef22b6f9c35550a83123b0e2035dd0603a00c1cf101c
-  data.tar.gz: ca173e3c7ecd0e49e9026a1f8b5ae9b7f8375c7d893e45b20b8ca7723e10dfe8701f4b4ef837414f2436014653b2accc2a9d2fb2b9b71cf9307c88d4840b745b
+  metadata.gz: 8bcb5c10788c3ba49269612062c6eea16251f372a176efd8c390fbe2e7967562bb4c83a27f7f70dd4f5af4af8f3a9ee33695f5d2a1394d105dff00e65043b45d
+  data.tar.gz: 0afbe377cfe6b68a5748f74221ef4e6084c55e0439ae6d7234e6864d5403e65a3b2d19f1c5f6579869a795c994c1ccc3f8b1ef0c8bc5ed2df8734318817c0c9a

data/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2014-2020 Cyril Kato
+Copyright (c) 2014-2021 Cyril Kato
 
 MIT License
 

data/README.md

@@ -1,5 +1,11 @@
 # Portable Action Notation
 
+[![Version](https://img.shields.io/github/v/tag/sashite/pan.rb?label=Version&logo=github)](https://github.com/sashite/pan.rb/releases)
+[![Yard documentation](https://img.shields.io/badge/Yard-documentation-blue.svg?logo=github)](https://rubydoc.info/github/sashite/pan.rb/main)
+[![CI](https://github.com/sashite/pan.rb/workflows/CI/badge.svg?branch=main)](https://github.com/sashite/pan.rb/actions?query=workflow%3Aci+branch%3Amain)
+[![RuboCop](https://github.com/sashite/pan.rb/workflows/RuboCop/badge.svg?branch=main)](https://github.com/sashite/pan.rb/actions?query=workflow%3Arubocop+branch%3Amain)
+[![License](https://img.shields.io/github/license/sashite/pan.rb?label=License&logo=github)](https://github.com/sashite/pan.rb/raw/main/LICENSE.md)
+
 A Ruby interface for data serialization in [PAN](https://developer.sashite.com/specs/portable-action-notation) format.
 
 ## Installation
@@ -7,72 +13,90 @@ A Ruby interface for data serialization in [PAN](https://developer.sashite.com/s
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'sashite-pan'
+gem "sashite-pan"
 ```
 
 And then execute:
 
-    $ bundle
+```sh
+bundle
+```
 
 Or install it yourself as:
 
-    $ gem install sashite-pan
+```sh
+gem install sashite-pan
+```
 
 ## Usage
 
 Working with PAN can be very simple, for example:
 
 ```ruby
-require 'sashite/pan'
+require "sashite/pan"
 
 # Emit a PAN string
 
 actions = [
-  [52, 36, '♙', nil]
+  [52, 36, "♙"]
 ]
 
-Sashite::PAN.dump(*actions) # => '52,36,♙'
+Sashite::PAN.dump(*actions) # => "52,36,♙"
 
 # Parse a PAN string
 
-Sashite::PAN.parse('52,36,♙') # => [[52, 36, '♙', nil]]
+Sashite::PAN.parse("52,36,♙") # => [[52, 36, "♙", nil]]
 ```
 
-## Examples
+## Example
+
+### Promoting a chess pawn into a knight
 
 ```ruby
-# Black castles on king-side
+Sashite::PAN.dump([12, 4, "♘"]) # => "12,4,♘"
+Sashite::PAN.parse("12,4,♘") # => [[12, 4, "♘", nil]]
+```
 
-Sashite::PAN.dump([60, 62, '♔', nil], [63, 61, '♖', nil]) # => '60,62,♔;63,61,♖'
-Sashite::PAN.parse('60,62,♔;63,61,♖') # => [[60, 62, '♔', nil], [63, 61, '♖', nil]]
+### Capturing a rook and promoting a shogi pawn
 
-# Promoting a chess pawn into a knight
+```ruby
+Sashite::PAN.dump([33, 24, "+P", "R"]) # => "33,24,+P,R"
+Sashite::PAN.parse("33,24,+P,R") # => [[33, 24, "+P", "R"]]
+```
 
-Sashite::PAN.dump([12, 4, '♘', nil]) # => '12,4,♘'
-Sashite::PAN.parse('12,4,♘') # => [[12, 4, '♘', nil]]
+### Dropping a shogi pawn
 
-# Capturing a rook and promoting a shogi pawn
+```ruby
+Sashite::PAN.dump([nil, 42, "P"]) # => "*,42,P"
+Sashite::PAN.parse("*,42,P") # => [[nil, 42, "P", nil]]
+```
+
+***
 
-Sashite::PAN.dump([33, 24, '+P', 'R']) # => '33,24,+P,R'
-Sashite::PAN.parse('33,24,+P,R') # => [[33, 24, '+P', 'R']]
+In the context of a game with several possible actions per turn, like in
+Western chess, more than one action could be consider like a move, and joined
+thanks to the [`portable_move_notation`](https://rubygems.org/gems/portable_move_notation) gem.
 
-# Dropping a shogi pawn
+### Black castles on king-side
 
-Sashite::PAN.dump([nil, 42, 'P', nil]) # => '*,42,P'
-Sashite::PAN.parse('*,42,P') # => [[nil, 42, 'P', nil]]
+```ruby
+Sashite::PAN.dump([60, 62, "♔"], [63, 61, "♖"]) # => "60,62,♔;63,61,♖"
+Sashite::PAN.parse("60,62,♔;63,61,♖") # => [[60, 62, "♔", nil], [63, 61, "♖", nil]]
+```
 
-# Capturing a white chess pawn en passant
+### Capturing a white chess pawn en passant
 
-Sashite::PAN.dump([33, 32, '♟', nil], [32, 40, '♟', nil]) # => '33,32,♟;32,40,♟'
-Sashite::PAN.parse('33,32,♟;32,40,♟') # => [[33, 32, '♟', nil], [32, 40, '♟', nil]]
+```ruby
+Sashite::PAN.dump([33, 32, "♟"], [32, 40, "♟"]) # => "33,32,♟;32,40,♟"
+Sashite::PAN.parse("33,32,♟;32,40,♟") # => [[33, 32, "♟", nil], [32, 40, "♟", nil]]
 ```
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The code is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
 ## About Sashite
 
-The `sashite-pan` gem is maintained by [Sashite](https://sashite.com/).
+This [gem](https://rubygems.org/gems/sashite-pan) is maintained by [Sashite](https://sashite.com/).
 
 With some [lines of code](https://github.com/sashite/), let's share the beauty of Chinese, Japanese and Western cultures through the game of chess!

data/lib/sashite-pan.rb

@@ -3,4 +3,4 @@
 # Sashite namespace
 module Sashite; end
 
-require_relative 'sashite/pan'
+require_relative "sashite/pan"

data/lib/sashite/pan.rb

@@ -13,5 +13,5 @@ module Sashite
   end
 end
 
-require_relative 'pan/dumper'
-require_relative 'pan/parser'
+require_relative "pan/dumper"
+require_relative "pan/parser"

data/lib/sashite/pan/action.rb

@@ -7,17 +7,17 @@ module Sashite
       attr_reader :src_square, :dst_square, :piece_name, :piece_hand
 
       private_class_method def self.separator
-        ';'
+        ";"
       end
 
       private
 
       def separator
-        ','
+        ","
       end
 
       def drop_char
-        '*'
+        "*"
       end
     end
   end

data/lib/sashite/pan/dumper.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'action'
+require_relative "action"
 
 module Sashite
   module PAN
@@ -11,7 +11,9 @@ module Sashite
                .join(separator)
       end
 
-      def initialize(src_square, dst_square, piece_name, piece_hand)
+      def initialize(src_square, dst_square, piece_name, piece_hand = nil)
+        super()
+
         @src_square = src_square.nil? ? drop_char : Integer(src_square)
         @dst_square = Integer(dst_square)
         @piece_name = piece_name.to_s

data/lib/sashite/pan/parser.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'action'
+require_relative "action"
 
 module Sashite
   module PAN
@@ -12,6 +12,8 @@ module Sashite
       end
 
       def initialize(serialized_action)
+        super()
+
         action_args = serialized_action.split(separator)
         src_square  = action_args.fetch(0)
         @src_square = src_square.eql?(drop_char) ? nil : Integer(src_square)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sashite-pan
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Cyril Kato
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-05 00:00:00.000000000 Z
+date: 2021-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-md
+  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: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  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: rubocop-thread_safety
   requirement: !ruby/object:Gem::Requirement
@@ -143,7 +171,7 @@ metadata:
   bug_tracker_uri: https://github.com/sashite/pan.rb/issues
   documentation_uri: https://rubydoc.info/gems/sashite-pan/index
   source_code_uri: https://github.com/sashite/pan.rb
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -151,15 +179,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: Data serialization in PAN format.
 test_files: []