sashite-pan 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e063831fd8f910bd4ad5fd11d708be1bd0afc801b44d00e56934ac083996f34
-  data.tar.gz: f86d2d6b9fc44f15e9ef9cd5bb09518bea27f6e34644ad74fd11eabce05347aa
+  metadata.gz: 4294266795d470a55b2b4d52b1b07e006791ace8a41491473057f839112a8f7d
+  data.tar.gz: 30063832b6dba93e56ef2c4450581a3a4f24c1e13592b55576b7a391cbfd23fa
 SHA512:
-  metadata.gz: 5aa2c4c4387486061b7d5ef452292fd75067775405b068b127efc27aaf703bb2cf9b1d817f662c8b2076ddd9bf9f14ed605421a3c0f9cd14146529574d308a72
-  data.tar.gz: 634cdd1a259a459d93b4c3a2eab9db96b30c220f5c320604c6b00dc729634ce69f697c448c0748d05c9d785802007efd6ac4c9db9a60c4008f6d236e1f404fb2
+  metadata.gz: 44ce213800f73cfd3094eb4f0d7f52090dae9a229c533827e2c2840cde605fefd2b515c8839277f85c3e4ee67b4d73245f026aa1810111e55cf739e4689c9ee1
+  data.tar.gz: 8b97bf4eaec6b839ebfb551bce73341033bcfa3702d6b6c01945355aab3d1857d661e48c5a4ea3783fac8540f4537189e0eb4dfb029812373314a473066275c0

data/README.md

@@ -20,52 +20,51 @@ Or install it yourself as:
 
 ## Usage
 
-Working with PMN can be very simple, for example:
+Working with PAN can be very simple, for example:
 
 ```ruby
 require 'sashite/pan'
-```
 
-### King's Pawn opening at chess
+# Emit a PAN string
+
+actions = [
+  [52, 36, '♙', nil]
+]
+
+Sashite::PAN.dump(*actions) # => '52,36,♙'
+
+# Parse a PAN string
 
-```ruby
 Sashite::PAN.parse('52,36,♙') # => [[52, 36, '♙', nil]]
-Sashite::PAN.dump([52, 36, '♙', nil]) # => '52,36,♙'
 ```
 
-### Black castles on king-side
+## Examples
 
 ```ruby
-Sashite::PAN.parse('60,62,♔;63,61,♖') # => [[60, 62, '♔', nil], [63, 61, '♖', nil]]
+# Black castles on king-side
+
 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]]
 
-### Promoting a chess pawn into a knight
+# Promoting a chess pawn into a knight
 
-```ruby
-Sashite::PAN.parse('12,4,♘') # => [[12, 4, '♘', nil]]
 Sashite::PAN.dump([12, 4, '♘', nil]) # => '12,4,♘'
-```
+Sashite::PAN.parse('12,4,♘') # => [[12, 4, '♘', nil]]
 
-### Capturing a rook and promoting a shogi pawn
+# Capturing a rook and promoting a shogi pawn
 
-```ruby
-Sashite::PAN.parse('33,24,+P,R') # => [[33, 24, '+P', 'R']]
 Sashite::PAN.dump([33, 24, '+P', 'R']) # => '33,24,+P,R'
-```
+Sashite::PAN.parse('33,24,+P,R') # => [[33, 24, '+P', 'R']]
 
-### Dropping a shogi pawn
+# Dropping a shogi pawn
 
-```ruby
-Sashite::PAN.parse('*,42,P') # => [[nil, 42, 'P', nil]]
 Sashite::PAN.dump([nil, 42, 'P', nil]) # => '*,42,P'
-```
+Sashite::PAN.parse('*,42,P') # => [[nil, 42, 'P', nil]]
 
-### Capturing a white chess pawn _en passant_
+# Capturing a white chess pawn en passant
 
-```ruby
-Sashite::PAN.parse('33,32,♟;32,40,♟') # => [[33, 32, '♟', nil], [32, 40, '♟', nil]]
 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]]
 ```
 
 ## License

data/lib/sashite/pan/action.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Sashite
+  module PAN
+    # Action class
+    class Action
+      attr_reader :src_square, :dst_square, :piece_name, :piece_hand
+    end
+  end
+end

data/lib/sashite/pan/dumper.rb

@@ -1,25 +1,25 @@
 # frozen_string_literal: true
 
+require_relative 'action'
+
 module Sashite
   module PAN
     # Dumper class
-    class Dumper
-      def self.call(*unserialized_actions)
-        unserialized_actions.map { |params| new(*params).call }.join(';')
+    class Dumper < Action
+      def self.call(*actions)
+        actions.map { |action_items| new(*action_items).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)
+          raise TypeError, 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)
+        raise TypeError, dst_square.inspect unless dst_square.is_a?(Integer)
+        raise TypeError, piece_name.inspect unless piece_name.is_a?(String)
 
         unless piece_hand.nil?
-          raise piece_hand.inspect unless piece_hand.is_a?(String)
+          raise TypeError, piece_hand.inspect unless piece_hand.is_a?(String)
         end
 
         @src_square = (src_square.nil? ? '*' : src_square)

data/lib/sashite/pan/parser.rb

@@ -1,31 +1,33 @@
 # frozen_string_literal: true
 
+require_relative 'action'
+
 module Sashite
   module PAN
     # Parser class
-    class Parser
-      def self.call(serialized_actions)
-        serialized_actions.split(';').map do |serialized_action|
+    class Parser < Action
+      def self.call(pan_string)
+        pan_string.split(';').map do |serialized_action|
           new(serialized_action).call
         end
       end
 
-      attr_reader :serialized_action
-
       def initialize(serialized_action)
-        @serialized_action = serialized_action
+        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)
       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]
+        [
+          src_square,
+          dst_square,
+          piece_name,
+          piece_hand
+        ]
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sashite-pan
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-16 00:00:00.000000000 Z
+date: 2020-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -133,6 +133,7 @@ files:
 - README.md
 - lib/sashite-pan.rb
 - lib/sashite/pan.rb
+- lib/sashite/pan/action.rb
 - lib/sashite/pan/dumper.rb
 - lib/sashite/pan/parser.rb
 homepage: https://developer.sashite.com/specs/portable-action-notation