sashite-ggn 0.1.0 → 0.3.0

data/lib/sashite-ggn.rb

@@ -1 +1,112 @@
-require 'sashite/ggn'
+# frozen_string_literal: true
+
+# Sashité - Abstract Strategy Board Games Notation Library
+#
+# This library provides a comprehensive implementation of the General Gameplay Notation (GGN)
+# specification, which is a rule-agnostic, JSON-based format for describing pseudo-legal
+# moves in abstract strategy board games.
+#
+# GGN works alongside other Sashité specifications:
+# - GAN (General Actor Notation): Unique piece identifiers
+# - FEEN (Forsyth-Edwards Enhanced Notation): Board position representation
+# - PMN (Portable Move Notation): Move sequence representation
+#
+# @author Sashité <https://sashite.com/>
+# @version 1.0.0
+# @see https://sashite.dev/documents/ggn/1.0.0/ GGN Specification
+# @see https://github.com/sashite/ggn.rb Official Ruby implementation
+#
+# @example Basic usage with a chess pawn double move
+#   # Load GGN data from file
+#   require "sashite/ggn"
+#
+#   piece_data = Sashite::Ggn.load_file("chess_moves.json")
+#   engine = piece_data.fetch("CHESS:P").fetch("e2").fetch("e4")
+#
+#   # Check if the move is valid given current board state
+#   board_state = {
+#     "e2" => "CHESS:P",  # White pawn on e2
+#     "e3" => nil,        # Empty square
+#     "e4" => nil         # Empty square
+#   }
+#
+#   result = engine.evaluate(board_state, {}, "CHESS")
+#
+#   if result
+#     puts "Move is valid!"
+#     puts "Board changes: #{result.diff}"
+#     # => { "e2" => nil, "e4" => "CHESS:P" }
+#     puts "Piece gained: #{result.gain}" # => nil (no capture)
+#     puts "Piece dropped: #{result.drop}" # => nil (not a drop move)
+#   else
+#     puts "Move is not valid under current conditions"
+#   end
+#
+# @example Piece drops in Shogi
+#   # Shogi allows captured pieces to be dropped back onto the board
+#   piece_data = Sashite::Ggn.load_file("shogi_moves.json")
+#   engine = piece_data.fetch("SHOGI:P").fetch("*").fetch("5e")
+#
+#   # Player has captured pawns available
+#   captures = { "SHOGI:P" => 2 }
+#
+#   # Current board state (5th file is clear of unpromoted pawns)
+#   board_state = {
+#     "5e" => nil,     # Target square is empty
+#     "5a" => nil, "5b" => nil, "5c" => nil, "5d" => nil,
+#     "5f" => nil, "5g" => nil, "5h" => nil, "5i" => nil
+#   }
+#
+#   result = engine.evaluate(board_state, captures, "SHOGI")
+#
+#   if result
+#     puts "Pawn drop is valid!"
+#     puts "Board changes: #{result.diff}"  # => { "5e" => "SHOGI:P" }
+#     puts "Piece dropped from hand: #{result.drop}"  # => "SHOGI:P"
+#   end
+#
+# @example Captures with piece promotion
+#   # A chess pawn capturing and promoting to queen
+#   piece_data = Sashite::Ggn.load_file("chess_moves.json")
+#   engine = piece_data.fetch("CHESS:P").fetch("g7").fetch("h8")
+#
+#   # Board with enemy piece on h8
+#   board_state = {
+#     "g7" => "CHESS:P",  # Our pawn ready to promote
+#     "h8" => "chess:r"   # Enemy rook (lowercase = opponent)
+#   }
+#
+#   result = engine.evaluate(board_state, {}, "CHESS")
+#
+#   if result
+#     puts "Pawn promotes and captures!"
+#     puts "Final position: #{result.diff}"
+#     # => { "g7" => nil, "h8" => "CHESS:Q" }
+#     puts "Captured piece: #{result.gain}"  # => nil (no capture _in hand_)
+#   end
+#
+# @example Loading GGN data from different sources
+#   # From file
+#   piece_data = Sashite::Ggn.load_file("moves.json")
+#
+#   # From JSON string
+#   json_string = '{"CHESS:K": {"e1": {"e2": [{"perform": {"e1": null, "e2": "CHESS:K"}}]}}}'
+#   piece_data = Sashite::Ggn.load_string(json_string)
+#
+#   # From Hash
+#   ggn_hash = { "CHESS:K" => { "e1" => { "e2" => [{ "perform" => { "e1" => nil, "e2" => "CHESS:K" } }] } } }
+#   piece_data = Sashite::Ggn.load_hash(ggn_hash)
+module Sashite
+  # Base namespace for all Sashité notation libraries.
+  #
+  # Sashité provides a comprehensive suite of specifications and implementations
+  # for representing abstract strategy board games in a rule-agnostic manner.
+  # This allows for unified game engines, cross-game analysis, and hybrid
+  # game variants.
+  #
+  # @see https://sashite.com/ Official Sashité website
+  # @see https://sashite.dev/ Developer documentation and specifications
+end
+
+# Load the main GGN implementation
+require_relative "sashite/ggn"

metadata

@@ -1,144 +1,59 @@
 --- !ruby/object:Gem::Specification
 name: sashite-ggn
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
-- Cyril Wack
-autorequire: 
+- Cyril Kato
 bindir: bin
 cert_chain: []
-date: 2014-06-10 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: json_schemer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
-  type: :development
+        version: 2.4.0
+  type: :runtime
   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 Ruby interface for data serialization in GGN format.
-email:
-- contact@cyril.io
+        version: 2.4.0
+description: A Ruby implementation of the General Gameplay Notation (GGN) specification.
+  GGN is a rule-agnostic, JSON-based format for describing pseudo-legal moves in abstract
+  strategy board games. This library provides parsing, validation, and evaluation
+  capabilities for GGN documents, enabling game engines to work with movement rules
+  across different board games including Chess, Shogi, Xiangqi, and custom variants.
+email: contact@cyril.email
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".ruby-version"
-- ".travis.yml"
-- Gemfile
 - LICENSE.md
 - README.md
-- Rakefile
-- VERSION.semver
 - lib/sashite-ggn.rb
 - lib/sashite/ggn.rb
-- lib/sashite/ggn/ability.rb
-- lib/sashite/ggn/actor.rb
-- lib/sashite/ggn/ally.rb
-- lib/sashite/ggn/area.rb
-- lib/sashite/ggn/attacked.rb
-- lib/sashite/ggn/boolean.rb
-- lib/sashite/ggn/digit.rb
-- lib/sashite/ggn/digit_excluding_zero.rb
-- lib/sashite/ggn/direction.rb
-- lib/sashite/ggn/gameplay.rb
-- lib/sashite/ggn/gameplay_into_base64.rb
-- lib/sashite/ggn/integer.rb
-- lib/sashite/ggn/last_moved_actor.rb
-- lib/sashite/ggn/maximum_magnitude.rb
-- lib/sashite/ggn/name.rb
-- lib/sashite/ggn/negative_integer.rb
-- lib/sashite/ggn/null.rb
-- lib/sashite/ggn/object.rb
-- lib/sashite/ggn/occupied.rb
-- lib/sashite/ggn/pattern.rb
-- lib/sashite/ggn/previous_moves_counter.rb
-- lib/sashite/ggn/promotable_into_actors.rb
-- lib/sashite/ggn/required.rb
-- lib/sashite/ggn/self.rb
-- lib/sashite/ggn/square.rb
-- lib/sashite/ggn/state.rb
-- lib/sashite/ggn/subject.rb
-- lib/sashite/ggn/unsigned_integer.rb
-- lib/sashite/ggn/unsigned_integer_excluding_zero.rb
-- lib/sashite/ggn/verb.rb
-- lib/sashite/ggn/zero.rb
-- sashite-ggn.gemspec
-- test/_test_helper.rb
-- test/test_ggn.rb
-- test/test_ggn_ability.rb
-- test/test_ggn_actor.rb
-- test/test_ggn_ally.rb
-- test/test_ggn_area.rb
-- test/test_ggn_attacked.rb
-- test/test_ggn_boolean.rb
-- test/test_ggn_digit.rb
-- test/test_ggn_digit_excluding_zero.rb
-- test/test_ggn_direction.rb
-- test/test_ggn_gameplay.rb
-- test/test_ggn_gameplay_into_base64.rb
-- test/test_ggn_integer.rb
-- test/test_ggn_last_moved_actor.rb
-- test/test_ggn_maximum_magnitude.rb
-- test/test_ggn_name.rb
-- test/test_ggn_negative_integer.rb
-- test/test_ggn_null.rb
-- test/test_ggn_object.rb
-- test/test_ggn_occupied.rb
-- test/test_ggn_pattern.rb
-- test/test_ggn_previous_moves_counter.rb
-- test/test_ggn_promotable_into_actors.rb
-- test/test_ggn_required.rb
-- test/test_ggn_self.rb
-- test/test_ggn_square.rb
-- test/test_ggn_state.rb
-- test/test_ggn_subject.rb
-- test/test_ggn_unsigned_integer.rb
-- test/test_ggn_unsigned_integer_excluding_zero.rb
-- test/test_ggn_verb.rb
-- test/test_ggn_zero.rb
+- lib/sashite/ggn/piece.rb
+- lib/sashite/ggn/piece/source.rb
+- lib/sashite/ggn/piece/source/destination.rb
+- lib/sashite/ggn/piece/source/destination/engine.rb
+- lib/sashite/ggn/piece/source/destination/engine/transition.rb
+- lib/sashite/ggn/schema.rb
+- lib/sashite/ggn/validation_error.rb
 homepage: https://github.com/sashite/ggn.rb
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  bug_tracker_uri: https://github.com/sashite/ggn.rb/issues
+  documentation_uri: https://rubydoc.info/github/sashite/ggn.rb/main
+  homepage_uri: https://github.com/sashite/ggn.rb
+  source_code_uri: https://github.com/sashite/ggn.rb
+  specification_uri: https://sashite.dev/documents/ggn/1.0.0/
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -146,49 +61,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.2.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: 
+rubygems_version: 3.6.9
 specification_version: 4
-summary: General Gameplay Notation.
-test_files:
-- test/_test_helper.rb
-- test/test_ggn.rb
-- test/test_ggn_ability.rb
-- test/test_ggn_actor.rb
-- test/test_ggn_ally.rb
-- test/test_ggn_area.rb
-- test/test_ggn_attacked.rb
-- test/test_ggn_boolean.rb
-- test/test_ggn_digit.rb
-- test/test_ggn_digit_excluding_zero.rb
-- test/test_ggn_direction.rb
-- test/test_ggn_gameplay.rb
-- test/test_ggn_gameplay_into_base64.rb
-- test/test_ggn_integer.rb
-- test/test_ggn_last_moved_actor.rb
-- test/test_ggn_maximum_magnitude.rb
-- test/test_ggn_name.rb
-- test/test_ggn_negative_integer.rb
-- test/test_ggn_null.rb
-- test/test_ggn_object.rb
-- test/test_ggn_occupied.rb
-- test/test_ggn_pattern.rb
-- test/test_ggn_previous_moves_counter.rb
-- test/test_ggn_promotable_into_actors.rb
-- test/test_ggn_required.rb
-- test/test_ggn_self.rb
-- test/test_ggn_square.rb
-- test/test_ggn_state.rb
-- test/test_ggn_subject.rb
-- test/test_ggn_unsigned_integer.rb
-- test/test_ggn_unsigned_integer_excluding_zero.rb
-- test/test_ggn_verb.rb
-- test/test_ggn_zero.rb
+summary: General Gameplay Notation (GGN) parser and validator for Ruby
+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/.ruby-version

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

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.1.0

data/lib/sashite/ggn/ability.rb

@@ -1,29 +0,0 @@
-require_relative 'subject'
-require_relative 'verb'
-require_relative 'object'
-
-module Sashite
-  module GGN
-    module Ability
-      PATTERN = /#{Subject::PATTERN}\^#{Verb::PATTERN}=#{Object::PATTERN}/
-
-      def self.valid? io
-        !!io.match("^#{PATTERN}$")
-      end
-
-      def self.load io
-        raise ArgumentError unless valid? io
-
-        subject = Subject.load io.split('^').fetch 0
-        verb    = Verb.load io.split('^').fetch(1).split('=').fetch 0
-        object  = Object.load io.split('=').fetch 1
-
-        {
-          subject: subject,
-          verb: verb,
-          object: object
-        }
-      end
-    end
-  end
-end

data/lib/sashite/ggn/actor.rb

@@ -1,20 +0,0 @@
-require_relative 'gameplay_into_base64'
-require_relative 'self'
-
-module Sashite
-  module GGN
-    class Actor
-      PATTERN = /(#{Self::PATTERN}|#{GameplayIntoBase64::PATTERN})/
-
-      def self.valid? io
-        !!io.match("^#{PATTERN}$")
-      end
-
-      def self.load io
-        raise ArgumentError unless valid? io
-
-        Self.valid?(io) ? Self.load : GameplayIntoBase64.load(io)
-      end
-    end
-  end
-end

data/lib/sashite/ggn/ally.rb

@@ -1,20 +0,0 @@
-require_relative 'boolean'
-require_relative 'null'
-
-module Sashite
-  module GGN
-    module Ally
-      PATTERN = /(#{Boolean::PATTERN}|#{Null::PATTERN})/
-
-      def self.valid? io
-        !!io.match("^#{PATTERN}$")
-      end
-
-      def self.load io
-        raise ArgumentError unless valid? io
-
-        Null.valid?(io) ? Null.load : Boolean.load(io)
-      end
-    end
-  end
-end

data/lib/sashite/ggn/area.rb

@@ -1,17 +0,0 @@
-module Sashite
-  module GGN
-    module Area
-      PATTERN = /(all|furthest_rank|palace|furthest_one-third|nearest_two-thirds)/
-
-      def self.valid? io
-        !!io.match("^#{PATTERN}$")
-      end
-
-      def self.load io
-        raise ArgumentError unless valid? io
-
-        io.to_sym
-      end
-    end
-  end
-end

data/lib/sashite/ggn/attacked.rb

@@ -1,20 +0,0 @@
-require_relative 'boolean'
-require_relative 'null'
-
-module Sashite
-  module GGN
-    module Attacked
-      PATTERN = /(#{Boolean::PATTERN}|#{Null::PATTERN})/
-
-      def self.valid? io
-        !!io.match("^#{PATTERN}$")
-      end
-
-      def self.load io
-        raise ArgumentError unless valid? io
-
-        Null.valid?(io) ? Null.load : Boolean.load(io)
-      end
-    end
-  end
-end

data/lib/sashite/ggn/boolean.rb

@@ -1,17 +0,0 @@
-module Sashite
-  module GGN
-    module Boolean
-      PATTERN = /[ft]/
-
-      def self.valid? io
-        !!io.match("^#{PATTERN}$")
-      end
-
-      def self.load io
-        raise ArgumentError unless valid? io
-
-        io.to_sym == :t
-      end
-    end
-  end
-end

data/lib/sashite/ggn/digit.rb

@@ -1,20 +0,0 @@
-require_relative 'digit_excluding_zero'
-require_relative 'zero'
-
-module Sashite
-  module GGN
-    module Digit
-      PATTERN = /(#{Zero::PATTERN}|#{DigitExcludingZero::PATTERN})/
-
-      def self.valid? io
-        !!io.match("^#{PATTERN}$")
-      end
-
-      def self.load io
-        raise ArgumentError unless valid? io
-
-        Zero.valid?(io) ? Zero.load : DigitExcludingZero.load(io)
-      end
-    end
-  end
-end

data/lib/sashite/ggn/digit_excluding_zero.rb

@@ -1,17 +0,0 @@
-module Sashite
-  module GGN
-    module DigitExcludingZero
-      PATTERN = /[1-9]/
-
-      def self.valid? io
-        !!io.match("^#{PATTERN}$")
-      end
-
-      def self.load io
-        raise ArgumentError unless valid? io
-
-        io.to_i
-      end
-    end
-  end
-end

data/lib/sashite/ggn/direction.rb

@@ -1,19 +0,0 @@
-require_relative 'integer'
-
-module Sashite
-  module GGN
-    module Direction
-      PATTERN = /(#{Integer::PATTERN},)*#{Integer::PATTERN}/
-
-      def self.valid? io
-        !!io.match("^#{PATTERN}$")
-      end
-
-      def self.load io
-        raise ArgumentError unless valid? io
-
-        io.split(',').map { |s| Integer.load s }
-      end
-    end
-  end
-end

data/lib/sashite/ggn/gameplay.rb

@@ -1,20 +0,0 @@
-require_relative 'pattern'
-
-module Sashite
-  module GGN
-    module Gameplay
-      PATTERN = /#{Pattern::PATTERN}(\. #{Pattern::PATTERN})*\./
-
-      def self.valid? io
-        io.match("^#{PATTERN}$") &&
-        io.split('. ').sort.join('. ') == io &&
-        io[0..-2].split('. ').uniq.join('. ').concat('.') == io
-      end
-
-      def self.load io
-        raise ArgumentError unless valid? io
-        io[0..-2].split('. ').map { |s| Pattern.load s }
-      end
-    end
-  end
-end

data/lib/sashite/ggn/gameplay_into_base64.rb

@@ -1,21 +0,0 @@
-require 'base64'
-require_relative 'gameplay'
-
-module Sashite
-  module GGN
-    module GameplayIntoBase64
-      PATTERN = /(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?/
-
-      def self.valid? io
-        io.match("^#{PATTERN}$") &&
-        Gameplay.valid?(Base64.strict_decode64(io))
-      end
-
-      def self.load io
-        raise ArgumentError unless valid? io
-
-        Gameplay.load Base64.strict_decode64(io)
-      end
-    end
-  end
-end

data/lib/sashite/ggn/integer.rb

@@ -1,20 +0,0 @@
-require_relative 'negative_integer'
-require_relative 'unsigned_integer'
-
-module Sashite
-  module GGN
-    module Integer
-      PATTERN = /(#{NegativeInteger::PATTERN}|#{UnsignedInteger::PATTERN})/
-
-      def self.valid? io
-        !!io.match("^#{PATTERN}$")
-      end
-
-      def self.load io
-        raise ArgumentError unless valid? io
-
-        NegativeInteger.valid?(io) ? NegativeInteger.load(io) : UnsignedInteger.load(io)
-      end
-    end
-  end
-end

data/lib/sashite/ggn/last_moved_actor.rb

@@ -1,20 +0,0 @@
-require_relative 'boolean'
-require_relative 'null'
-
-module Sashite
-  module GGN
-    module LastMovedActor
-      PATTERN = /(#{Boolean::PATTERN}|#{Null::PATTERN})/
-
-      def self.valid? io
-        !!io.match("^#{PATTERN}$")
-      end
-
-      def self.load io
-        raise ArgumentError unless valid? io
-
-        Null.valid?(io) ? Null.load : Boolean.load(io)
-      end
-    end
-  end
-end

data/lib/sashite/ggn/maximum_magnitude.rb

@@ -1,20 +0,0 @@
-require_relative 'null'
-require_relative 'unsigned_integer_excluding_zero'
-
-module Sashite
-  module GGN
-    module MaximumMagnitude
-      PATTERN = /(#{Null::PATTERN}|#{UnsignedIntegerExcludingZero::PATTERN})/
-
-      def self.valid? io
-        !!io.match("^#{PATTERN}$")
-      end
-
-      def self.load io
-        raise ArgumentError unless valid? io
-
-        Null.valid?(io) ? Null.load : UnsignedIntegerExcludingZero.load(io)
-      end
-    end
-  end
-end