sashite-cpn 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6830c4520f3621c796a6d5a4a723a1c672d454f6
+  data.tar.gz: 59c64f01c3ff30ddc5e8f7db3d3a322e16f144dc
+SHA512:
+  metadata.gz: 59e97c50a55fb524023db8048445e0d26116ee471a1c783b09c57b44d0ab5e83cd7be543304629cc1ca63a967aec7ebc9ceb6267b6e7636b64a949410e9c9a9b
+  data.tar.gz: 46755b1e85057e93b6228fc579e1d0574ac28bd100efd240323085bfb8b3d357ca2fdb5b169390bd2752821107cd841893e8f0d6ae3b5a640c9cbf65483f93d5

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.ruby-version
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+sudo: false
+cache: bundler
+script: 'bundle exec rake test:coverage --trace'
+before_install:
+  - gem install bundler
+rvm:
+  - 1.9.3
+  - 2.0
+  - 2.1
+  - 2.2
+  - jruby
+  - jruby-head
+  - rbx-2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Cyril Wack
+
+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,55 @@
+# Sashite::Cpn
+
+[![Build Status](https://travis-ci.org/sashite/cpn.rb.svg?branch=master)][travis]
+[![Gem Version](https://badge.fury.io/rb/sashite-cpn.svg)][gem]
+[![Inline docs](http://inch-ci.org/github/sashite/cpn.rb.svg?branch=master)][inchpages]
+[![Documentation](http://img.shields.io/:yard-docs-38c800.svg)][rubydoc]
+
+Export in to the [CPN format](http://www.sashite.com/developer/wiki/Chess-Position-Notation).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sashite-cpn'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sashite-cpn
+
+## Usage
+
+```ruby
+Sashite::Cpn.generate(false, [8, 8], ['w:r', 'w:n', 'w:b', 'w:q', 'w:^k', 'w:b', 'w:n', 'w:r',
+                                      'w:p', 'w:p', 'w:p', 'w:p', 'w:p', 'w:p', 'w:p', 'w:p',
+                                      nil, nil, nil, nil, nil, nil, nil, nil,
+                                      nil, nil, nil, nil, nil, nil, nil, nil,
+                                      nil, nil, nil, nil, nil, nil, nil, nil,
+                                      nil, nil, nil, nil, nil, nil, nil, nil,
+                                      'W:P', 'W:P', 'W:P', 'W:P', 'W:P', 'W:P', 'W:P', 'W:P',
+                                      'W:R', 'W:N', 'W:B', 'W:Q', 'W:^K', 'W:B', 'W:N', 'W:R'], [])
+# => 'B--8,8--w:r,w:n,w:b,w:q,w:^k,w:b,w:n,w:r,w:p,w:p,w:p,w:p,w:p,w:p,w:p,w:p,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,W:P,W:P,W:P,W:P,W:P,W:P,W:P,W:P,W:R,W:N,W:B,W:Q,W:^K,W:B,W:N,W:R--'
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sashite/cpn.rb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+## Versioning
+
+__Sashite::Cpn__ follows [Semantic Versioning 2.0](http://semver.org/).
+
+## License
+
+See `LICENSE.md` file.
+
+[gem]: https://rubygems.org/gems/sashite-cpn
+[travis]: https://travis-ci.org/sashite/cpn.rb
+[inchpages]: http://inch-ci.org/github/sashite/cpn.rb/
+[rubydoc]: http://rubydoc.info/gems/sashite-cpn/frames

data/Rakefile

@@ -0,0 +1,20 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+Rake::TestTask.new do |t|
+  t.verbose = true
+  t.warning = true
+end
+
+namespace :test do
+  task :coverage do
+    ENV['COVERAGE'] = 'true'
+    Rake::Task['test'].invoke
+  end
+end
+
+task(:doc_stats) { ruby '-S yard stats' }
+task default: [:test, :doc_stats, :rubocop]

data/VERSION.semver

@@ -0,0 +1 @@
+0.1.0

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'sashite/cpn'
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,5 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install

data/lib/sashite/cpn.rb

@@ -0,0 +1,49 @@
+# Global namespace.
+module Sashite
+  # Namespace for the library.
+  module Cpn
+    # Generate the CPN.
+    #
+    # @param bool     [Boolean] The turn to play.
+    # @param indexes  [Array]   The shape of the board.
+    # @param squares  [Array]   The board structure.
+    # @param pieces   [Array]   The list of pieces in hand.
+    def self.generate(bool, indexes, squares, pieces)
+      Generate.new(bool, indexes, squares, pieces).to_s
+    end
+
+    # Custom error raised with indexes and squares are not synchonized.
+    class LengthError < RuntimeError
+    end
+
+    # Main class.
+    class Generate
+      # @param bool     [Boolean] The turn to play.
+      # @param indexes  [Array]   The shape of the board.
+      # @param squares  [Array]   The board structure.
+      # @param pieces   [Array]   The list of pieces in hand.
+      def initialize(bool, indexes, squares, pieces)
+        fail LengthError unless indexes.inject(:*).to_i.equal?(squares.length)
+
+        @turn           = Turn.new(bool)
+        @shape          = Shape.new(*indexes)
+        @position       = Position.new(*squares)
+        @pieces_in_hand = PiecesInHand.new(*pieces)
+      end
+
+      # @return [String] A CPN string.
+      def to_s
+        [
+          @turn.to_s,
+          @shape.to_s,
+          @position.to_s,
+          @pieces_in_hand.to_s
+        ].join('--')
+      end
+    end
+  end
+end
+
+Dir[File.join File.dirname(__FILE__), 'cpn', '*.rb'].each do |fname|
+  require_relative fname
+end

data/lib/sashite/cpn/pieces_in_hand.rb

@@ -0,0 +1,23 @@
+# Global namespace.
+module Sashite
+  # Namespace for the library.
+  module Cpn
+    # Pieces in hand class.
+    class PiecesInHand
+      # @param pieces [Array] The list of pieces in hand.
+      def initialize(*pieces)
+        @pieces = pieces.map(&:to_s).sort
+      end
+
+      # @!attribute [r] pieces
+      #
+      # @return [Array] The list of pieces in hand.
+      attr_reader :pieces
+
+      # @return [String] A string representation.
+      def to_s
+        pieces.join(',')
+      end
+    end
+  end
+end

data/lib/sashite/cpn/position.rb

@@ -0,0 +1,23 @@
+# Global namespace.
+module Sashite
+  # Namespace for the library.
+  module Cpn
+    # Position class.
+    class Position
+      # @param squares [Array] The list of squares.
+      def initialize(*squares)
+        @squares = squares
+      end
+
+      # @!attribute [r] squares
+      #
+      # @return [Array] The list of squares.
+      attr_reader :squares
+
+      # @return [String] A string representation.
+      def to_s
+        squares.join(',')
+      end
+    end
+  end
+end

data/lib/sashite/cpn/shape.rb

@@ -0,0 +1,23 @@
+# Global namespace.
+module Sashite
+  # Namespace for the library.
+  module Cpn
+    # Shape class.
+    class Shape
+      # @param indexes [Array] The list of indexes.
+      def initialize(*indexes)
+        @indexes = indexes
+      end
+
+      # @!attribute [r] indexes
+      #
+      # @return [Array] The list of indexes.
+      attr_reader :indexes
+
+      # @return [String] A string representation.
+      def to_s
+        indexes.join(',')
+      end
+    end
+  end
+end

data/lib/sashite/cpn/turn.rb

@@ -0,0 +1,27 @@
+# Global namespace.
+module Sashite
+  # Namespace for the library.
+  module Cpn
+    # Turn class.
+    class Turn
+      # @param b [Boolean] The turn to play (topside: true, bottomside: false).
+      def initialize(b)
+        @b = b
+      end
+
+      # @return [Boolean] Returns false when the turn to play is for bottom.
+      def turn_to_topside?
+        @b
+      end
+
+      # @return [String] A string representation.
+      def to_s
+        if turn_to_topside?
+          't'
+        else
+          'B'
+        end
+      end
+    end
+  end
+end

data/sashite-cpn.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |spec|
+  spec.name          = 'sashite-cpn'
+  spec.version       = File.read('VERSION.semver').chomp
+  spec.authors       = ['Cyril Wack']
+  spec.email         = ['contact@cyril.email']
+
+  spec.summary       = 'CPN generator.'
+  spec.description   = 'A CPN generator for Ruby.'
+  spec.homepage      = 'https://github.com/sashite/cpn.rb'
+  spec.license       = 'MIT'
+
+  spec.files         =
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^test/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler',    '~> 1.10'
+  spec.add_development_dependency 'rake',       '~> 10.4'
+  spec.add_development_dependency 'yard',       '~> 0.8'
+  spec.add_development_dependency 'simplecov',  '~> 0.10'
+  spec.add_development_dependency 'rubocop',    '~> 0.35'
+  spec.add_development_dependency 'spectus',    '~> 3.0'
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: sashite-cpn
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Cyril Wack
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.35'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.35'
+- !ruby/object:Gem::Dependency
+  name: spectus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A CPN generator for Ruby.
+email:
+- contact@cyril.email
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- VERSION.semver
+- bin/console
+- bin/setup
+- lib/sashite/cpn.rb
+- lib/sashite/cpn/pieces_in_hand.rb
+- lib/sashite/cpn/position.rb
+- lib/sashite/cpn/shape.rb
+- lib/sashite/cpn/turn.rb
+- sashite-cpn.gemspec
+homepage: https://github.com/sashite/cpn.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.4.5.1
+signing_key: 
+specification_version: 4
+summary: CPN generator.
+test_files: []
+has_rdoc: