sashite-pan 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b34d7729fc0d82a1d1c2c86159962a4833440f7b
-  data.tar.gz: 20f7db3f64d3300f646ebb4c1abcf1cc0f911c9a
+  metadata.gz: b0df5e40949504b396898aafaa9995e22ceffcc4
+  data.tar.gz: 21ea803ef8d8bedffe43c49f957ba953a4a906fe
 SHA512:
-  metadata.gz: 44bf0808b56d9905d7c28b5e8045bba47938d280cf3c8822261a9c334719f1e59f1d971081f0543fe59dc94013364161d3e691a6cbef578808daf2bccae4c7ec
-  data.tar.gz: 7c3593b2d96924d43477a612096d9d6438b0198caf97747d809f47d685f00f863edcd039cadc60a325ffcb90b3e542a0c0c656b7aca7f73aca56546824306ec5
+  metadata.gz: c31d786fe117f64ba500d4be7768cfee0019dfd7a65b7c7412f73ba685d07be1ba823b44d82bdf16224255935ede441805eed99b450a83ed5921db7753d08809
+  data.tar.gz: 7e74e5ddb41667b0cbfe3b54fe58fbdd556e9619012b1f3c6c988a55da1f6f96840273e0e2eabbef02c0c4e936a21eef58e8e1025dbabae8b4dca40031e69f88

data/README.md

@@ -22,6 +22,28 @@ Or install it yourself as:
 
     $ gem install sashite-pan
 
+## API
+
+Module method:
+
+```ruby
+Sashite::PAN.load verb, arg1, arg2
+```
+
+Set actor's instance methods:
+
+* `verb`
+* `actor`
+* `square`
+* `to_a`
+
+Movement's instance methods:
+
+* `verb`
+* `src_square`
+* `dst_square`
+* `to_a`
+
 ## Example
 
 ```ruby
@@ -29,6 +51,7 @@ require 'sashite-pan'
 
 action = Sashite::PAN.load :shift, 42, 43
 action.src_square # => 42
+action.to_a       # => [ :shift, 42, 43 ]
 ```
 
 ## Contributing

data/VERSION.semver

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/sashite/pan.rb

@@ -1,10 +1,9 @@
-require_relative 'pan/capture'
-require_relative 'pan/drop'
 require_relative 'pan/error/not_implemented_verb_error'
 require_relative 'pan/error/same_square_error'
-require_relative 'pan/promote'
-require_relative 'pan/remove'
-require_relative 'pan/shift'
+require_relative 'pan/movement/capture'
+require_relative 'pan/movement/shift'
+require_relative 'pan/set_actor/drop'
+require_relative 'pan/set_actor/promote'
 
 module Sashite
   module PAN
@@ -20,9 +19,6 @@ module Sashite
       when :promote
         Promote.new arg1, arg2
 
-      when :remove
-        Remove.new arg1, arg2
-
       when :shift
         Shift.new arg1, arg2
 

data/lib/sashite/pan/{capture.rb → movement.rb}

@@ -1,6 +1,6 @@
 module Sashite
   module PAN
-    class Capture
+    class Movement
       attr_reader :src_square, :dst_square
 
       def initialize src_square, dst_square
@@ -14,11 +14,15 @@ module Sashite
 
       def to_a
         [
-          self.class.name.split('::').last.downcase.to_sym,
+          verb,
           @src_square,
           @dst_square
         ]
       end
+
+      def verb
+        self.class.name.split('::').last.downcase.to_sym
+      end
     end
   end
 end

data/lib/sashite/pan/movement/capture.rb

@@ -0,0 +1,8 @@
+require_relative '../movement'
+
+module Sashite
+  module PAN
+    class Capture < Movement
+    end
+  end
+end

data/lib/sashite/pan/movement/shift.rb

@@ -0,0 +1,8 @@
+require_relative '../movement'
+
+module Sashite
+  module PAN
+    class Shift < Movement
+    end
+  end
+end

data/lib/sashite/pan/set_actor.rb

@@ -0,0 +1,27 @@
+module Sashite
+  module PAN
+    class SetActor
+      attr_reader :actor, :square
+
+      def initialize square, actor
+        raise TypeError unless actor.is_a? Symbol
+        raise TypeError unless square.is_a? Fixnum
+
+        @actor = actor
+        @square = square
+      end
+
+      def to_a
+        [
+          verb,
+          @square,
+          @actor
+        ]
+      end
+
+      def verb
+        self.class.name.split('::').last.downcase.to_sym
+      end
+    end
+  end
+end

data/lib/sashite/pan/set_actor/drop.rb

@@ -0,0 +1,8 @@
+require_relative '../set_actor'
+
+module Sashite
+  module PAN
+    class Drop < SetActor
+    end
+  end
+end

data/lib/sashite/pan/set_actor/promote.rb

@@ -0,0 +1,8 @@
+require_relative '../set_actor'
+
+module Sashite
+  module PAN
+    class Promote < SetActor
+    end
+  end
+end

data/test/test_capture.rb

@@ -29,6 +29,10 @@ describe Sashite::PAN do
         @action.to_a.must_equal Sashite::PAN::Capture.new(42, 43).to_a
       end
 
+      it 'returns the verb of the action' do
+        @action.verb.must_equal :capture
+      end
+
       it 'returns the src_square of the action' do
         @action.src_square.must_equal 42
       end

data/test/test_drop.rb

@@ -25,12 +25,16 @@ describe Sashite::PAN do
         @action.to_a.must_equal Sashite::PAN::Drop.new(42, :foobar).to_a
       end
 
+      it 'returns the verb of the action' do
+        @action.verb.must_equal :drop
+      end
+
       it 'returns the actor of the action' do
         @action.actor.must_equal :foobar
       end
 
-      it 'returns the dst_square of the action' do
-        @action.dst_square.must_equal 42
+      it 'returns the square of the action' do
+        @action.square.must_equal 42
       end
     end
   end

data/test/test_promote.rb

@@ -25,8 +25,12 @@ describe Sashite::PAN do
         @action.to_a.must_equal Sashite::PAN::Promote.new(42, :foobar).to_a
       end
 
-      it 'returns the src_square of the action' do
-        @action.src_square.must_equal 42
+      it 'returns the verb of the action' do
+        @action.verb.must_equal :promote
+      end
+
+      it 'returns the square of the action' do
+        @action.square.must_equal 42
       end
 
       it 'returns the actor of the action' do

data/test/test_shift.rb

@@ -29,6 +29,10 @@ describe Sashite::PAN do
         @action.to_a.must_equal Sashite::PAN::Shift.new(42, 43).to_a
       end
 
+      it 'returns the verb of the action' do
+        @action.verb.must_equal :shift
+      end
+
       it 'returns the src_square of the action' do
         @action.src_square.must_equal 42
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sashite-pan
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Cyril Wack
@@ -70,21 +70,20 @@ files:
 - VERSION.semver
 - lib/sashite-pan.rb
 - lib/sashite/pan.rb
-- lib/sashite/pan/capture.rb
-- lib/sashite/pan/drop.rb
 - lib/sashite/pan/error/not_implemented_verb_error.rb
 - lib/sashite/pan/error/same_square_error.rb
-- lib/sashite/pan/promote.rb
-- lib/sashite/pan/remove.rb
-- lib/sashite/pan/shift.rb
+- lib/sashite/pan/movement.rb
+- lib/sashite/pan/movement/capture.rb
+- lib/sashite/pan/movement/shift.rb
+- lib/sashite/pan/set_actor.rb
+- lib/sashite/pan/set_actor/drop.rb
+- lib/sashite/pan/set_actor/promote.rb
 - sashite-pan.gemspec
 - test/_test_helper.rb
 - test/test_capture.rb
 - test/test_drop.rb
-- test/test_movement.rb
 - test/test_pan.rb
 - test/test_promote.rb
-- test/test_remove.rb
 - test/test_shift.rb
 homepage: https://github.com/sashite/pan.rb
 licenses:
@@ -114,8 +113,6 @@ test_files:
 - test/_test_helper.rb
 - test/test_capture.rb
 - test/test_drop.rb
-- test/test_movement.rb
 - test/test_pan.rb
 - test/test_promote.rb
-- test/test_remove.rb
 - test/test_shift.rb

data/lib/sashite/pan/drop.rb

@@ -1,23 +0,0 @@
-module Sashite
-  module PAN
-    class Drop
-      attr_reader :actor, :dst_square
-
-      def initialize dst_square, actor
-        raise TypeError unless actor.is_a? Symbol
-        raise TypeError unless dst_square.is_a? Fixnum
-
-        @actor = actor
-        @dst_square = dst_square
-      end
-
-      def to_a
-        [
-          self.class.name.split('::').last.downcase.to_sym,
-          @dst_square,
-          @actor
-        ]
-      end
-    end
-  end
-end

data/lib/sashite/pan/promote.rb

@@ -1,23 +0,0 @@
-module Sashite
-  module PAN
-    class Promote
-      attr_reader :src_square, :actor
-
-      def initialize src_square, actor
-        raise TypeError unless src_square.is_a? Fixnum
-        raise TypeError unless actor.is_a? Symbol
-
-        @src_square = src_square
-        @actor = actor
-      end
-
-      def to_a
-        [
-          self.class.name.split('::').last.downcase.to_sym,
-          @src_square,
-          @actor
-        ]
-      end
-    end
-  end
-end

data/lib/sashite/pan/remove.rb

@@ -1,24 +0,0 @@
-module Sashite
-  module PAN
-    class Remove
-      attr_reader :src_square, :dst_square
-
-      def initialize src_square, dst_square
-        raise TypeError unless src_square.is_a? Fixnum
-        raise TypeError unless dst_square.is_a? Fixnum
-        raise SameSquareError if src_square == dst_square
-
-        @src_square = src_square
-        @dst_square = dst_square
-      end
-
-      def to_a
-        [
-          self.class.name.split('::').last.downcase.to_sym,
-          @src_square,
-          @dst_square
-        ]
-      end
-    end
-  end
-end

data/lib/sashite/pan/shift.rb

@@ -1,24 +0,0 @@
-module Sashite
-  module PAN
-    class Shift
-      attr_reader :src_square, :dst_square
-
-      def initialize src_square, dst_square
-        raise TypeError unless src_square.is_a? Fixnum
-        raise TypeError unless dst_square.is_a? Fixnum
-        raise SameSquareError if src_square == dst_square
-
-        @src_square = src_square
-        @dst_square = dst_square
-      end
-
-      def to_a
-        [
-          self.class.name.split('::').last.downcase.to_sym,
-          @src_square,
-          @dst_square
-        ]
-      end
-    end
-  end
-end

data/test/test_movement.rb

@@ -1,9 +0,0 @@
-require_relative '_test_helper'
-
-describe Sashite::PAN do
-  describe 'errors' do
-    it 'raises a not implemented method error' do
-      -> { Sashite::PAN.load :foobar, 42, 43 }.must_raise Sashite::PAN::NotImplementedVerbError
-    end
-  end
-end

data/test/test_remove.rb

@@ -1,41 +0,0 @@
-require_relative '_test_helper'
-
-describe Sashite::PAN do
-  describe 'remove' do
-    describe 'errors' do
-      it 'raises a same square error' do
-        -> { Sashite::PAN::Remove.new 42, 42 }.must_raise Sashite::PAN::SameSquareError
-      end
-
-      it 'raises a type error from the source square' do
-        -> { Sashite::PAN::Remove.new '42', 43 }.must_raise TypeError
-      end
-
-      it 'raises a type error from the destination square' do
-        -> { Sashite::PAN::Remove.new 42, '43' }.must_raise TypeError
-      end
-    end
-
-    describe 'instances' do
-      before do
-        @action = Sashite::PAN.load :remove, 42, 43
-      end
-
-      it 'returns the action' do
-        @action.to_a.must_equal [ :remove, 42, 43 ]
-      end
-
-      it 'returns the action (once again)' do
-        @action.to_a.must_equal Sashite::PAN::Remove.new(42, 43).to_a
-      end
-
-      it 'returns the src_square of the action' do
-        @action.src_square.must_equal 42
-      end
-
-      it 'returns the dst_square of the action' do
-        @action.dst_square.must_equal 43
-      end
-    end
-  end
-end