sashite-gan 0.0.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b966a687c469afbb15fda785200eb0d038798aa6
-  data.tar.gz: 04ce3d9c51b5880e5a3a93cdb9924cb969661734
+SHA256:
+  metadata.gz: dffb3b5300bf9cfe17f98e0bea0fc2daa5a90d56df88a652e82f4a3b9056d7a1
+  data.tar.gz: a27352efa48e49bff0f89a1371853452edd6ffd09aca5cb8c1e360193f7576cc
 SHA512:
-  metadata.gz: 4812faaead240700c59190386094aab58f1256192c4e5d1649fe1054e50c5ab487e48a4b6365a5147ef48134f2bbcb0e2e5f1e0d5ddffa16c2957c713cd3f714
-  data.tar.gz: a356e0eb9d0f72fc4173c7d6d8747a3c6321157d4b3731cb4279725ab0ab4f62053a3ce9c5fde8292ca258e6be300f5964b3fe92b98af102e9fb51f88ddaffe2
+  metadata.gz: 2f635c1fd54f5a81b9c0303471011952197058a8997bcd006ce3f6776ad4ee845e04a444139ebba8c65b9f56b90f9225f305b17cc9b93d7bb1aa75fda8f50e2b
+  data.tar.gz: ac3c7237c234e7bd61c38edf7ac83acced6ef46951ffd19077b855a33f7ce5078edaced35be5b1ee7008fa26beff9102888c9935def92a45b75718210dcd5fac

data/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Cyril Wack
+Copyright (c) 2014-2020 Cyril Kato
 
 MIT License
 

data/README.md

@@ -1,11 +1,6 @@
-# Sashite::GAN
+# Sashite::GAN ♟️
 
-Implementation of [General Actor Notation](//sashite-wiki.herokuapp.com/General_Actor_Notation) for storing actors from abstract strategy games.
-
-## Status
-
-[![Gem Version](https://badge.fury.io/rb/sashite-gan.svg)](//badge.fury.io/rb/sashite-gan)
-[![Build Status](https://secure.travis-ci.org/sashite/gan.rb.svg?branch=master)](//travis-ci.org/sashite/gan.rb?branch=master)
+> An implementation of [General Actor Notation](https://developer.sashite.com/specs/general-actor-notation) for storing actors from abstract strategy games.
 
 ## Installation
 
@@ -25,14 +20,33 @@ Or install it yourself as:
 
     require 'sashite-gan'
 
-    actor = Sashite::GAN::Actor.new 2,
-      'bc096c4c7f48fc5c4c162555e4df98169e204aea', 'top', 'xianqi', 'rook'
-    actor.to_gan # => '2:bc096c4c7f48fc5c4c162555e4df98169e204aea:top:xianqi:rook'
+    # Chess (Western) Rook, White
+    Sashite::GAN.string(is_checkmateable: false, is_promoted: false, is_topside: false, piece_abbr: 'r', style_abbr: 'c') # => 'C:R'
+
+    # Chess (Western) King, Black
+    Sashite::GAN.string(is_checkmateable: true, is_promoted: false, is_topside: true, piece_abbr: 'k', style_abbr: 'c') # => 'c:-k'
+
+    # Shogi King, Gote
+    Sashite::GAN.string(is_checkmateable: true, is_promoted: false, is_topside: true, piece_abbr: 'k', style_abbr: 's') # => 's:-k'
+
+    # Shogi promoted Pawn, Sente
+    Sashite::GAN.string(is_checkmateable: false, is_promoted: true, is_topside: false, piece_abbr: 'p', style_abbr: 's') # => 'S:+P'
+
+    # Xiangqi General, Red
+    Sashite::GAN.string(is_checkmateable: true, is_promoted: false, is_topside: false, piece_abbr: 'g', style_abbr: 'x') # => 'X:-G'
+
+    # Xiangqi Flying General, Red
+    Sashite::GAN.string(is_checkmateable: true, is_promoted: true, is_topside: false, piece_abbr: 'g', style_abbr: 'x') # => 'X:+-G'
+
+    # Go Stone, Black
+    Sashite::GAN.string(is_checkmateable: false, is_promoted: false, is_topside: false, piece_abbr: 's', style_abbr: 'go') # => 'GO:S'
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## About Sashite
 
-## Contributing
+The `sashite-gan` gem is maintained by [Sashite](https://sashite.com/).
 
-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 a new Pull Request
+With some [lines of code](https://github.com/sashite/), let's share the beauty of Chinese, Japanese and Western cultures through the game of chess!

data/lib/sashite-gan.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require 'sashite/gan'

data/lib/sashite/gan.rb

@@ -1,25 +1,43 @@
+# frozen_string_literal: true
+
 module Sashite
-  module GAN
-    class Actor
-      attr_accessor :dimension, :cgh, :side, :variant, :name
+  # General Actor Notation
+  class GAN
+    # @return [String] The representation of an actor.
+    def self.string(is_checkmateable:, is_promoted:, is_topside:, piece_abbr:, style_abbr:)
+      unless [false, true].include?(is_topside)
+        raise TypeError, is_topside.class.inspect
+      end
+
+      piece_code = piece_code_builder(
+        piece_abbr: piece_abbr,
+        is_checkmateable: is_checkmateable,
+        is_promoted: is_promoted
+      )
+
+      piece_code_with_prefix = "#{style_abbr}:#{piece_code}"
 
-      def initialize dimension, cgh, side, variant, name
-        @dimension = dimension
-        @cgh = cgh
-        @side = side
-        @variant = variant
-        @name = name
+      if is_topside
+        piece_code_with_prefix.downcase
+      else
+        piece_code_with_prefix.upcase
+      end
+    end
+
+    def self.piece_code_builder(piece_abbr:, is_checkmateable:, is_promoted:)
+      unless [false, true].include?(is_checkmateable)
+        raise TypeError, is_checkmateable.class.inspect
       end
 
-      def to_gan
-        [
-          @dimension,
-          @cgh,
-          @side,
-          @variant,
-          @name
-        ].join ':'
+      unless [false, true].include?(is_promoted)
+        raise TypeError, is_promoted.class.inspect
       end
+
+      str = piece_abbr
+      str = "-#{str}" if is_checkmateable
+      str = "+#{str}" if is_promoted
+      str
     end
+    private_class_method :piece_code_builder
   end
 end

metadata

@@ -1,81 +1,118 @@
 --- !ruby/object:Gem::Specification
 name: sashite-gan
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
 platform: ruby
 authors:
-- Cyril Wack
+- Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-29 00:00:00.000000000 Z
+date: 2020-05-21 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'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-thread_safety
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '0'
 description: Implementation of GAN (General Actor Notation) for storing actors from
   abstract strategy games.
-email:
-- contact@cyril.io
+email: contact@cyril.email
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
-- Gemfile
 - LICENSE.md
 - README.md
-- Rakefile
-- VERSION.semver
 - lib/sashite-gan.rb
 - lib/sashite/gan.rb
-- sashite-gan.gemspec
-- test/_test_helper.rb
-- test/test_gan.rb
-homepage: https://github.com/sashite/gan.rb
+homepage: https://developer.sashite.com/specs/general-actor-notation
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/sashite/gan.rb/issues
+  documentation_uri: https://rubydoc.info/gems/sashite-gan/index
+  source_code_uri: https://github.com/sashite/gan.rb
+  wiki_uri: https://github.com/sashite/gan.rb/wiki
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -91,11 +128,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A GAN implementation in Ruby.
-test_files:
-- test/_test_helper.rb
-- test/test_gan.rb
+test_files: []

data/.gitignore

@@ -1,22 +0,0 @@
-*.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/.travis.yml

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

data/Gemfile

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

data/Rakefile

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

data/VERSION.semver

@@ -1 +0,0 @@
-0.0.2

data/sashite-gan.gemspec

@@ -1,19 +0,0 @@
-Gem::Specification.new do |spec|
-  spec.name          = 'sashite-gan'
-  spec.version       = File.read('VERSION.semver')
-  spec.authors       = ['Cyril Wack']
-  spec.email         = ['contact@cyril.io']
-  spec.summary       = %q{A GAN implementation in Ruby.}
-  spec.description   = %q{Implementation of GAN (General Actor Notation) for storing actors from abstract strategy games.}
-  spec.homepage      = 'https://github.com/sashite/gan.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

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

data/test/test_gan.rb

@@ -1,15 +0,0 @@
-require_relative '_test_helper'
-
-describe Sashite::GAN::Actor do
-  describe '#to_s' do
-    before do
-      @actor = Sashite::GAN::Actor.new 2,
-        'bc096c4c7f48fc5c4c162555e4df98169e204aea',
-        'top', 'xianqi', 'rook'
-    end
-
-    it 'returns the GAN of the actor' do
-      @actor.to_gan.must_equal '2:bc096c4c7f48fc5c4c162555e4df98169e204aea:top:xianqi:rook'
-    end
-  end
-end