sashite-pan 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e7418ca5f0d9461164075f8a7362d0c70439fcbe
+  data.tar.gz: 697a969bab18dc6cc1346db2e18492afc48da862
+SHA512:
+  metadata.gz: 4b6f11ef92ded4ef26958029c6066e8b6ff76b032139f8d82c0e2b23a2112e39e2aafbe2b14bdde1cd47cea3745f8348deb35de207d2e53f0557f2bd23839fa3
+  data.tar.gz: 4664588f59115312c34f7d37b4d77be1cedb9ba2a9c2639877e061c59781a99ddfd66a16d02b07046d7ed6e6d6e5004246632a61afb78c58c2f132a4fcc3c2b1

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.ruby-version

@@ -0,0 +1 @@
+2.1.2

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.2

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Cyril Wack
+
+MIT License
+
+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,38 @@
+# Sashite::PAN
+
+Ruby implementation of [PAN](http://sashite.wiki/Portable_Action_Notation) parser and emitter.
+
+## Status
+
+* [![Gem Version](https://badge.fury.io/rb/sashite-pan.svg)](//badge.fury.io/rb/sashite-pan)
+* [![Build Status](https://secure.travis-ci.org/sashite/pan.rb.svg?branch=master)](//travis-ci.org/sashite/pan.rb?branch=master)
+* [![Dependency Status](https://gemnasium.com/sashite/pan.rb.svg)](//gemnasium.com/sashite/pan.rb)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sashite-pan'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sashite-pan
+
+## Example
+
+    require 'sashite-pan'
+
+    action = Sashite::PAN.load :shift, 42, 43
+    action.src_square # => 42
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+end
+
+task(default: :test)

data/VERSION.semver

@@ -0,0 +1 @@
+0.0.1

data/lib/sashite/pan/capture.rb

@@ -0,0 +1,24 @@
+module Sashite
+  module PAN
+    class Capture
+      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/drop.rb

@@ -0,0 +1,23 @@
+module Sashite
+  module PAN
+    class Drop
+      attr_reader :actor, :dst_square
+
+      def initialize actor, dst_square
+        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,
+          @actor,
+          @dst_square
+        ]
+      end
+    end
+  end
+end

data/lib/sashite/pan/error/not_implemented_verb_error.rb

@@ -0,0 +1,6 @@
+module Sashite
+  module PAN
+    class NotImplementedVerbError < ::StandardError
+    end
+  end
+end

data/lib/sashite/pan/error/same_square_error.rb

@@ -0,0 +1,6 @@
+module Sashite
+  module PAN
+    class SameSquareError < ::StandardError
+    end
+  end
+end

data/lib/sashite/pan/promote.rb

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

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

@@ -0,0 +1,24 @@
+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/lib/sashite/pan.rb

@@ -0,0 +1,34 @@
+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'
+
+module Sashite
+  module PAN
+    def self.load verb, arg1, arg2
+      case verb
+
+      when :capture
+        Capture.new arg1, arg2
+
+      when :drop
+        Drop.new arg1, arg2
+
+      when :promote
+        Promote.new arg1, arg2
+
+      when :remove
+        Remove.new arg1, arg2
+
+      when :shift
+        Shift.new arg1, arg2
+
+      else
+        raise NotImplementedVerbError
+      end
+    end
+  end
+end

data/sashite-pan.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |spec|
+  spec.name          = 'sashite-pan'
+  spec.version       = File.read('VERSION.semver')
+  spec.authors       = ['Cyril Wack']
+  spec.email         = ['contact@cyril.io']
+  spec.summary       = %q{Portable Action Notation (PAN) parser and emitter.}
+  spec.description   = %q{A Portable Action Notation (PAN) parser and emitter, optimized for programmer happiness.}
+  spec.homepage      = 'https://github.com/sashite/pan.rb'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) {|f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^test/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler',  '~> 1.6'
+  spec.add_development_dependency 'minitest', '~> 5'
+  spec.add_development_dependency 'rake',     '~> 10'
+end

data/test/_test_helper.rb

@@ -0,0 +1,2 @@
+require 'sashite/pan'
+require 'minitest/autorun'

data/test/test_capture.rb

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

data/test/test_drop.rb

@@ -0,0 +1,37 @@
+require_relative '_test_helper'
+
+describe Sashite::PAN do
+  describe 'drops' do
+    describe 'errors' do
+      it 'raises a type error from the actor' do
+        -> { Sashite::PAN.load :drop, 'foobar', 42 }.must_raise TypeError
+      end
+
+      it 'raises a type error from the destination square' do
+        -> { Sashite::PAN.load :drop, :foobar, '42' }.must_raise TypeError
+      end
+    end
+
+    describe 'instances' do
+      before do
+        @action = Sashite::PAN.load :drop, :foobar, 42
+      end
+
+      it 'returns the action' do
+        @action.to_a.must_equal [ :drop, :foobar, 42 ]
+      end
+
+      it 'returns the action (once again)' do
+        @action.to_a.must_equal Sashite::PAN::Drop.new(:foobar, 42).to_a
+      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
+      end
+    end
+  end
+end

data/test/test_movement.rb.rb

@@ -0,0 +1,9 @@
+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_pan.rb

@@ -0,0 +1,9 @@
+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_promote.rb

@@ -0,0 +1,37 @@
+require_relative '_test_helper'
+
+describe Sashite::PAN do
+  describe 'promotion' do
+    describe 'errors' do
+      it 'raises a type error from the source square' do
+        -> { Sashite::PAN.load :promote, '42', :foobar }.must_raise TypeError
+      end
+
+      it 'raises a type error from the actor' do
+        -> { Sashite::PAN.load :promote, 42, 'foobar' }.must_raise TypeError
+      end
+    end
+
+    describe 'instances' do
+      before do
+        @action = Sashite::PAN.load :promote, 42, :foobar
+      end
+
+      it 'returns the action' do
+        @action.to_a.must_equal [ :promote, 42, :foobar ]
+      end
+
+      it 'returns the action (once again)' 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
+      end
+
+      it 'returns the actor of the action' do
+        @action.actor.must_equal :foobar
+      end
+    end
+  end
+end

data/test/test_remove.rb

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

data/test/test_shift.rb

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

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: sashite-pan
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Cyril Wack
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+description: A Portable Action Notation (PAN) parser and emitter, optimized for programmer
+  happiness.
+email:
+- contact@cyril.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- VERSION.semver
+- 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
+- sashite-pan.gemspec
+- test/_test_helper.rb
+- test/test_capture.rb
+- test/test_drop.rb
+- test/test_movement.rb.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:
+- 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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Portable Action Notation (PAN) parser and emitter.
+test_files:
+- test/_test_helper.rb
+- test/test_capture.rb
+- test/test_drop.rb
+- test/test_movement.rb.rb
+- test/test_pan.rb
+- test/test_promote.rb
+- test/test_remove.rb
+- test/test_shift.rb