sashite-drop 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 45e87ee3db030fcceac3b6063ab757fb1ea76196a1c3a80e568ab84cebd4bf1b
+  data.tar.gz: ab8764f2ee621be3f56bc7260946d109f9659a478b02ae2a074f6ac1e14c0951
+SHA512:
+  metadata.gz: d4e7da427b0e68e13b1ba1069d48c3ae83a12f3e10bb724b34fe78ef8f68819ed4e576cc7348b0a8a6c752e151de4ecb2c812148a1e62d280843008796d6ebb4
+  data.tar.gz: a53a2c540df9a9ed9f64d350abe1c1169f1d6a6b94bc575a9f610799ed7f7bf8f9e9f1697e896cfc32f4d2b42d04d72bd770baea561b9cdd15d659ef9205e79e

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2025 Sashite
+
+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,192 @@
+# Drop.rb
+
+[![Version](https://img.shields.io/github/v/tag/sashite/drop.rb?label=Version&logo=github)](https://github.com/sashite/drop.rb/tags)
+[![Yard documentation](https://img.shields.io/badge/Yard-documentation-blue.svg?logo=github)](https://rubydoc.info/github/sashite/drop.rb/main)
+![Ruby](https://github.com/sashite/drop.rb/actions/workflows/main.yml/badge.svg?branch=main)
+[![License](https://img.shields.io/github/license/sashite/drop.rb?label=License&logo=github)](https://github.com/sashite/drop.rb/raw/main/LICENSE.md)
+
+> **DROP** (Droppable Reserve Operations Placement) support for the Ruby language.
+
+## What is DROP?
+
+DROP (Droppable Reserve Operations Placement) is a simple, standardized notation for representing piece reserve locations in board games where captured pieces can be held and/or placed onto the board. This applies to games like shōgi, crazyhouse, go, and other games featuring capture-and-drop mechanics.
+
+This gem implements the [DROP Specification v1.0.0](https://sashite.dev/documents/drop/1.0.0/), providing a Ruby interface for working with reserve locations through a functional and minimalist API.
+
+## Installation
+
+```ruby
+# In your Gemfile
+gem "sashite-drop"
+```
+
+Or install manually:
+
+```sh
+gem install sashite-drop
+```
+
+## DROP Format
+
+DROP uses a single character to represent all off-board reserve locations:
+
+**Reserve Location**: `*` (asterisk)
+- **Unicode**: U+002A
+- **ASCII**: 42
+- **UTF-8**: 0x2A
+
+## Basic Usage
+
+### Basic Usage
+
+The primary functionality is checking if a location represents the reserve:
+
+```ruby
+require "sashite/drop"
+
+# Check if a string represents the reserve location
+Sashite::Drop.reserve?("*")    # => true
+Sashite::Drop.reserve?("a1")   # => false
+Sashite::Drop.reserve?("**")   # => false
+Sashite::Drop.reserve?("")     # => false
+
+# Alias for convenience
+Drop = Sashite::Drop
+Drop.reserve?("*") # => true
+```
+
+### String Representation
+
+```ruby
+# Get the canonical DROP representation
+Sashite::Drop.to_s # => "*"
+```
+
+## Usage Examples
+
+### Movement Notation
+
+```ruby
+# Representing moves with DROP notation
+source = "*"           # From reserve
+destination = "e4"     # To board position (using CELL coordinates)
+
+# Check if move involves reserve
+Sashite::Drop.reserve?(source)      # => true (drop move)
+Sashite::Drop.reserve?(destination) # => false (board position)
+```
+
+### Game Context Examples
+
+**Shōgi**
+
+```ruby
+# Reserve operations
+reserve = "*"
+board_position = "5e"
+
+# Drop move: place piece from reserve to board
+puts "Dropping piece from reserve to #{board_position}" if Sashite::Drop.reserve?(reserve)
+```
+
+**Crazyhouse**
+
+```ruby
+# Capture to reserve
+captured_position = "e4"
+reserve = "*"
+
+# Capture move: piece goes to reserve
+puts "Piece captured to reserve from #{captured_position}" if Sashite::Drop.reserve?(reserve)
+```
+
+## Integration with CELL
+
+DROP complements the CELL specification for complete location coverage:
+
+```ruby
+# Combined location validation
+def valid_location?(location)
+  Sashite::Drop.reserve?(location) || Cell.valid?(location)
+end
+
+valid_location?("*")   # => true (reserve)
+valid_location?("a1")  # => true (board position)
+valid_location?("xx")  # => false (invalid)
+```
+
+## API Reference
+
+### Module Methods
+
+- `Sashite::Drop.reserve?(string)` - Check if string represents the reserve location
+- `Sashite::Drop.to_s` - Get the canonical DROP representation (`"*"`)
+
+### Constants
+
+- `Sashite::Drop::RESERVE` - The reserve location character (`"*"`)
+
+## Properties of DROP
+
+* **Minimalist**: Uses only a single character (`*`) for all reserve operations
+* **Universal**: Works across different board game types and rule systems
+* **Complementary**: Designed to work alongside CELL coordinates for complete game notation
+* **Functional**: Provides a clean, stateless API for reserve location operations
+
+## Constraints
+
+* DROP represents **only off-board reserve locations**
+* The asterisk (`*`) is the **only valid DROP character**
+* Context determines the specific meaning (player's reserve, captured pieces, stone supply, etc.)
+* For on-board positions, use **CELL coordinates** instead
+
+## Examples in Different Games
+
+### Shogi
+
+```ruby
+# Piece in hand (reserve)
+reserve = "*"
+Sashite::Drop.reserve?(reserve) # => true
+
+# Drop to board
+destination = "5e"
+puts "#{reserve} → #{destination}" # "* → 5e"
+```
+
+### Go
+
+```ruby
+# Stone supply (reserve)
+supply = "*"
+Sashite::Drop.reserve?(supply) # => true
+
+# Place stone
+position = "dd"
+puts "#{supply} → #{position}" # "* → dd"
+```
+
+### Crazyhouse
+
+```ruby
+# Captured piece reserve
+reserve = "*"
+Sashite::Drop.reserve?(reserve) # => true
+
+# Drop piece
+square = "e4"
+puts "#{reserve} → #{square}" # "* → e4"
+```
+
+## Documentation
+
+- [Official DROP Specification](https://sashite.dev/documents/drop/1.0.0/)
+- [API Documentation](https://rubydoc.info/github/sashite/drop.rb/main)
+
+## License
+
+The [gem](https://rubygems.org/gems/sashite-drop) is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## About Sashité
+
+This project is maintained by [Sashité](https://sashite.com/) — promoting chess variants and sharing the beauty of Chinese, Japanese, and Western chess cultures.

data/lib/sashite/drop.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Sashite
+  # DROP (Droppable Reserve Operations Placement) implementation
+  #
+  # DROP defines a simple, standardized notation for piece reserve locations
+  # in board games where captured pieces can be held and/or placed onto the board.
+  #
+  # @see https://sashite.dev/documents/drop/1.0.0/
+  # @author Sashité
+  # @since 1.0.0
+  #
+  # @example Basic usage
+  #   Sashite::Drop.reserve?("*")     # => true
+  #   Sashite::Drop.reserve?("a1")    # => false
+  #   Sashite::Drop.to_s              # => "*"
+  module Drop
+    # The reserve location character
+    RESERVE = "*"
+
+    # Check if a string represents the reserve location
+    #
+    # @param string [String] the string to check
+    # @return [Boolean] true if the string is the reserve location
+    #
+    # @example
+    #   Sashite::Drop.reserve?("*")   # => true
+    #   Sashite::Drop.reserve?("a1")  # => false
+    #   Sashite::Drop.reserve?("**")  # => false
+    #   Sashite::Drop.reserve?("")    # => false
+    def self.reserve?(string)
+      RESERVE.eql?(string)
+    end
+
+    # Get the canonical DROP representation
+    #
+    # @return [String] the reserve location character
+    #
+    # @example
+    #   Sashite::Drop.to_s            # => "*"
+    def self.to_s
+      RESERVE
+    end
+  end
+end

data/lib/sashite-drop.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# Sashité namespace
+module Sashite
+  # @see https://sashite.dev/documents/drop/1.0.0/ DROP Specification v1.0.0
+  # @author Sashité
+  # @since 1.0.0
+end
+
+require_relative "sashite/drop"

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: sashite-drop
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Cyril Kato
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: DROP defines a simple, standardized notation for piece reserve locations
+  in board games where captured pieces can be held and/or placed onto the board. This
+  applies to games like shōgi, crazyhouse, go, and other games featuring capture-and-drop
+  mechanics.
+email: contact@cyril.email
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- lib/sashite-drop.rb
+- lib/sashite/drop.rb
+homepage: https://github.com/sashite/drop.rb
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/sashite/drop.rb/issues
+  documentation_uri: https://rubydoc.info/github/sashite/drop.rb/main
+  homepage_uri: https://github.com/sashite/drop.rb
+  source_code_uri: https://github.com/sashite/drop.rb
+  specification_uri: https://sashite.dev/documents/drop/1.0.0/
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: DROP (Droppable Reserve Operations Placement) implementation for Ruby
+test_files: []