portable_move_notation 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b589b978146bc86d24e4190c46e89c055d22ad75c3ae50605b64159e8e6908c
-  data.tar.gz: 9b7391b895988cf11771ccd79e6827f09e26215ca2393a0cd45b50c2c7ae2385
+  metadata.gz: 1ea18bccd3175b8aa44c30320449202c692edd0e62f5024b0f1a35a912124f52
+  data.tar.gz: 0d57d166480c1c823b8ef6a6d6d4333947c467eebe3fc8f3386e72a217faaf19
 SHA512:
-  metadata.gz: 8db07cc1f4b394860a4b169ea8c66dfe3a49b9dc386c4d822a9b581d30b9bc9c42893f857e82cb88a2323f0bd6e9314356bb48da41192cea81e8c0b48a768e70
-  data.tar.gz: 41fe5971834d95f244d62daaa26a53fb57b34f6f1ab6730c76fd1696b3ce5a8d70daa9c783222d13e5c874624716cb30c5dcc07dd01432331e4ba57842cb4894
+  metadata.gz: cfd09a1595d388851a9e9e286f83abf130005c2a883938a369bee3111fce52631e8b22b79f7f21d3cb9415dc3e09a9b7e9ea8c36724a7eb28072eb76b9af0110
+  data.tar.gz: 6f2be96f2952714b6977d6c2e811a67ef0c4d07fa4b324b5c98b754d8e8572961f74ce6a2c2b27336b57fb7a3145daf54b078d798d737845bacbcc039bc458ee

data/README.md

@@ -1,6 +1,6 @@
 # Portable Move Notation
 
-A Ruby interface for data serialization in PMN format.
+A Ruby interface for data serialization in [PMN](https://developer.sashite.com/specs/portable-move-notation) format.
 
 ## Installation
 
@@ -27,14 +27,14 @@ require 'portable_move_notation'
 
 # Parse a PMN string
 
-PortableMoveNotation.load('52,36,C:P.12,28,c:p.53,37,C:P') # => [[[52, 36, 'C:P', nil]], [[12, 28, 'c:p', nil]], [[53, 37, 'C:P', nil]]]
+PortableMoveNotation.parse('52,36,C:P.12,28,c:p.53,37,C:P') # => [[52, 36, 'C:P', nil], [12, 28, 'c:p', nil], [53, 37, 'C:P', nil]]
 
 # Emit some PMN
 
 some_moves = [
-  [[52, 36, 'C:P', nil]],
-  [[12, 28, 'c:p', nil]],
-  [[53, 37, 'C:P', nil]]
+  [52, 36, 'C:P', nil],
+  [12, 28, 'c:p', nil],
+  [53, 37, 'C:P', nil]
 ]
 
 PortableMoveNotation.dump(*some_moves) # => '52,36,C:P.12,28,c:p.53,37,C:P'
@@ -45,50 +45,42 @@ PortableMoveNotation.dump(*some_moves) # => '52,36,C:P.12,28,c:p.53,37,C:P'
 #### Castling on kingside
 
 ```ruby
-PortableMoveNotation.load('60,62,C:-K;63,61,C:R') # => [[[60, 62, 'C:-K', nil], [63, 61, 'C:R', nil]]]
+PortableMoveNotation.parse('60,62,C:-K;63,61,C:R') # => [[60, 62, 'C:-K', nil, 63, 61, 'C:R', nil]]
 PortableMoveNotation.dump(*[[[60, 62, 'C:-K', nil], [63, 61, 'C:R', nil]]]) # => '60,62,C:-K;63,61,C:R'
 ```
 
 #### Promoting a chess pawn into a knight
 
 ```ruby
-PortableMoveNotation.load('12,4,C:P,C:N') # => [[[12, 4, 'C:P', 'C:N']]]
+PortableMoveNotation.parse('12,4,C:P,C:N') # => [[12, 4, 'C:P', 'C:N']]
 PortableMoveNotation.dump(*[[[12, 4, 'C:P', 'C:N']]]) # => '12,4,C:P,C:N'
 ```
 
 #### Promoting a shogi pawn
 
 ```ruby
-PortableMoveNotation.load('33,24,S:P,S:+P') # => [[[33, 24, 'S:P', 'S:+P']]]
+PortableMoveNotation.parse('33,24,S:P,S:+P') # => [[33, 24, 'S:P', 'S:+P']]
 PortableMoveNotation.dump(*[[[33, 24, 'S:P', 'S:+P']]]) # => '33,24,S:P,S:+P'
 ```
 
 #### Dropping a shogi pawn
 
 ```ruby
-PortableMoveNotation.load('*,42,S:P') # => [[[nil, 42, 'S:P', nil]]]
+PortableMoveNotation.parse('*,42,S:P') # => [[nil, 42, 'S:P', nil]]
 PortableMoveNotation.dump(*[[[nil, 42, 'S:P', nil]]]) # => '*,42,S:P'
 ```
 
 #### Capturing a white chess pawn en passant
 
 ```ruby
-PortableMoveNotation.load('48,32,C:P.33,32,c:p;32,40,c:p') # => [[[48, 32, 'C:P', nil]], [[33, 32, 'c:p', nil], [32, 40, 'c:p', nil]]]
+PortableMoveNotation.parse('48,32,C:P.33,32,c:p;32,40,c:p') # => [[48, 32, 'C:P', nil], [33, 32, 'c:p', nil, 32, 40, 'c:p', nil]]
 PortableMoveNotation.dump(*[[[48, 32, 'C:P', nil]], [[33, 32, 'c:p', nil], [32, 40, 'c:p', nil]]]) # => '48,32,C:P.33,32,c:p;32,40,c:p'
 ```
 
-## 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](https://www.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).
-
 ## About Sashite
 
 The `portable_move_notation` gem is maintained by [Sashite](https://sashite.com/).

data/lib/portable_move_notation.rb

@@ -3,13 +3,13 @@
 # Portable Move Notation module
 module PortableMoveNotation
   def self.dump(*moves)
-    Dump.call(*moves)
+    Dumper.call(*moves)
   end
 
-  def self.load(pmn_string)
-    Load.call(pmn_string)
+  def self.parse(pmn_string)
+    Parser.call(pmn_string)
   end
 end
 
-require_relative 'portable_move_notation/dump'
-require_relative 'portable_move_notation/load'
+require_relative 'portable_move_notation/dumper'
+require_relative 'portable_move_notation/parser'

data/lib/portable_move_notation/action/{dump.rb → dumper.rb}

@@ -2,7 +2,7 @@
 
 module PortableMoveNotation
   module Action
-    class Dump
+    class Dumper
       def self.call(*unserialized_actions)
         unserialized_actions.map { |params| new(*params).call }.join(';')
       end
@@ -28,13 +28,15 @@ module PortableMoveNotation
       end
 
       def call
-        arr = if piece_hand.nil?
-                [src_square, dst_square, piece_name]
-              else
-                [src_square, dst_square, piece_name, piece_hand]
-              end
+        action_items.join(',')
+      end
+
+      private
+
+      def action_items
+        return [src_square, dst_square, piece_name] if piece_hand.nil?
 
-        arr.join(',')
+        [src_square, dst_square, piece_name, piece_hand]
       end
     end
   end

data/lib/portable_move_notation/action/{load.rb → parser.rb}

@@ -2,9 +2,9 @@
 
 module PortableMoveNotation
   module Action
-    class Load
+    class Parser
       def self.call(serialized_actions)
-        serialized_actions.split(';').map do |serialized_action|
+        serialized_actions.split(';').flat_map do |serialized_action|
           new(serialized_action).call
         end
       end

data/lib/portable_move_notation/dumper.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module PortableMoveNotation
+  class Dumper
+    def self.call(*unserialized_moves)
+      unserialized_moves.map do |move|
+        actions = move.each_slice(4)
+        Action::Dumper.call(*actions)
+      end.join('.')
+    end
+  end
+end
+
+require_relative 'action/dumper'

data/lib/portable_move_notation/parser.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: portable_move_notation
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-14 00:00:00.000000000 Z
+date: 2020-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -122,7 +122,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A Ruby interface for data serialization in PMN format.
+description: A Ruby interface for data serialization in PMN (Portable Move Notation)
+  format.
 email: contact@cyril.email
 executables: []
 extensions: []
@@ -131,10 +132,10 @@ files:
 - LICENSE.md
 - README.md
 - 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
+- lib/portable_move_notation/action/dumper.rb
+- lib/portable_move_notation/action/parser.rb
+- lib/portable_move_notation/dumper.rb
+- lib/portable_move_notation/parser.rb
 homepage: https://developer.sashite.com/specs/portable-move-notation
 licenses:
 - MIT

data/lib/portable_move_notation/dump.rb

@@ -1,11 +0,0 @@
-# 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

@@ -1,13 +0,0 @@
-# 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'