decktet 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ff11d273759fc3fdc43a12ffbedc2ab20e7343fdbb2de5afe46377689e495bb7
+  data.tar.gz: e97a708766a2b31fc965ebdf0fdc0e9e084ea7ca32da94275c6829b9d27a470d
+SHA512:
+  metadata.gz: 7730b570fb0238086a2062d5c7c41c25aa0e584f966e74078742da37c3fa909fde474335479b3b912576d9a9f69478f5721b40b9f6f1a0f00cc752bdd782cedf
+  data.tar.gz: 5bfcf4e06c655fd202967e8c373449388e1a9567e4e22c8b300112e9e06c5df9acfd445603d7495ea1617469f0ca70ec9ef5f2a2d35daf0808967237e22a493f

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.idea/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# not tracking Gemfile.lock in source control for gem
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format progress
+--color
+--require spec_helper

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Brody Fischer
+
+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,125 @@
+# Decktet
+
+This gem provides a basic interface to the Decktet playing card system. Visit [decktet.com](https://www.decktet.com/) for an overview of the Decktet. More detailed information, including many games that can be played with this unique deck, can be found on [The Decktet Wiki](http://decktet.wikidot.com/). This gem is meant as a core library for manipulating the elements of the Decktet itself. As such, it does not include any game engine or other such advanced functionality.  
+
+## Getting Started
+
+Include `decktet` in your application's Gemfile:
+
+```ruby
+gem 'decktet'
+```
+
+Then run `bundle install`.
+
+Alternatively, you can install it manually by running `gem install decktet`.
+
+## Usage
+
+The decktet gem provides 3 classes: `Decktet::Card`, `Decktet::Deck`, and `Decktet::Pile`
+
+A general use case includes creating a new `Decktet::Deck` and moving cards between the deck and various piles.
+
+Here is an example of a simple game setup:
+
+```ruby
+deck = Decktet::Deck.new_basic_deck
+deck.shuffle
+
+player1_hand = deck.draw 3
+player2_hand = deck.draw 3
+
+discard_pile = Decktet::Pile.new(deck.draw)
+```
+
+### Card
+
+The `Decktet::Card` class is an immutable data container that provides some convenience methods for accessing card information.
+
+All of the cards in the extended deck are defined by top-level constants in the `Decktet` namespace.  Additional constants are defined for specific groups of cards based on card attributes, such as `Decktet::ACES`, `Decktet::MOONS`, and `Decktet::PERSONALITIES`.
+
+```ruby
+card = Decktet::THE_SAVAGE
+card.name    # => "the SAVAGE"
+card.excuse? # => false
+
+card.rank    # => 3
+card.number? # => true
+card.ace?    # => false
+
+card.suits   # => [:leaves, :wyrms]
+card.leaves? # => true
+card.leaf?   # => true
+card.moons?  # => false
+
+card.types        # => [:personality]
+card.personality? # => true
+card.location?    # => false
+```
+
+### Pile
+
+The `Decktet::Pile` class defines a collection of cards that can be manipulated. 
+#### Instantiation
+
+A pile can be instantiated with any number of `Decktet::Card` objects or empty. Any combination of cards, card groups, and deck templates are valid arguments for instantiation. 
+
+```ruby
+p1 = Decktet::Pile.new
+p2 = Decktet::Pile.new(Decktet::THE_ACE_OF_MOONS)
+p3 = Decktet::Pile.new(Decktet::ACES, Decktet::CROWNS)
+p4 = Decktet::Pile.new(Decktet::DeckTemplates::BASIC_DECK, Decktet::PAWNS, Decktet::THE_EXCUSE)
+```
+
+#### Methods
+
+The `cards` method returns a duplicated array of all cards currently in the pile. Any operations on the return value of this method that would alter it in some way will have no effect on the collection of cards managed internally by the pile object. 
+
+The `size` method returns the count of cards in the pile.
+
+The `shuffle` method randomizes the order of cards in the pile. This method returns `self`.
+
+The `cut` method will move some number of cards from the top of the pile to the bottom of the pile, preserving order. This method accepts an argument indicating the number of cards to move. If no argument is provided, the number of cards moved will be randomly selected. This method returns `self`. 
+
+The `draw` method removes some number of cards from the pile and returns them in an array. This method accepts an argument indicating the number of cards to draw. If no argument is provided, one card wil be drawn.
+
+The `add` method places cards on the pile. This method accepts any number of `Decktet::Card` objects. This method returns `self`.
+
+
+```ruby
+
+p = Decktet::Pile.new(card_1, card_2, card_3, card_4)
+
+p.cards       # => [card_1, card_2, card_3, card_4]
+
+p.size        # => 4
+
+p.shuffle     # => p
+p.cards       # => [card_4, card_1, card_3, card_2]
+
+p.cut(1)      # => p
+p.cards       # => [card_1, card_3, card_2, card_4]
+
+p.draw(2)     # => [card_1, card_3]
+p.cards       # => [card_2, card_4]
+
+p.add(card_5) # => p
+p.cards       # => [card_5, card_1, card_3]
+```
+
+### Deck
+
+The `Decktet::Deck` class is a subclass of `Decktet::Pile` that does not allow instantiation with an empty set. 
+
+Additionally, `Decktet::Deck` defines some helper methods for instantiating a new deck based on templates defined in `Decktet::DeckTemplates`.
+
+```ruby
+Decktet::Deck.new_basic_deck
+
+# The above is equivalent to:
+Decktet::Deck.new(Decktet::DeckTemplates::BASIC_DECK)
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+require "bundler/setup"
+require "decktet"
+require "irb"
+IRB.start(__FILE__)

data/decktet.gemspec

@@ -0,0 +1,21 @@
+require_relative 'lib/decktet/version'
+
+Gem::Specification.new do |spec|
+  spec.name     = 'decktet'
+  spec.version  = Decktet::VERSION
+  spec.authors  = ['Brody Fischer']
+  spec.email    = ['brodyf42@gmail.com']
+  spec.summary  = 'This gem provides an interface to the versatile decktet playing card system.'
+  spec.homepage = 'https://github.com/brodyf42/decktet'
+  spec.license  = 'MIT'
+
+  spec.required_ruby_version = '>= 3.0.0'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.add_development_dependency 'rspec'
+end

data/lib/decktet/card.rb

@@ -0,0 +1,111 @@
+module Decktet
+  RANKS = ([:ace] + Array(2..9) + %i[pawn court crown]).freeze
+  SUITS = %i[moons suns waves leaves wyrms knots].freeze
+  TYPES = %i[location personality event].freeze
+
+  Card = Data.define(:name, :rank, :suits, :types) do
+    def initialize(name:, rank: nil, suits: nil, types: nil)
+      super(name: name.freeze, rank:, suits: Array(suits).freeze, types: Array(types).freeze)
+    end
+
+    def excuse? = rank.nil? && suits.empty? && types.empty?
+    def number? = Integer === rank
+
+    RANKS.select { |r| Symbol === r }.each { |rank| define_method(:"#{rank}?") { self.rank == rank } }
+    SUITS.each { |suit| define_method(:"#{suit}?") { suits.include?(suit) } }
+    TYPES.each { |type| define_method(:"#{type}?") { types.include?(type) } }
+
+    alias_method :moon?, :moons?
+    alias_method :sun?,  :suns?
+    alias_method :wave?, :waves?
+    alias_method :leaf?, :leaves?
+    alias_method :wyrm?, :wyrms?
+    alias_method :knot?, :knots?
+  end
+
+  THE_EXCUSE         = Card.new('the EXCUSE')
+
+  THE_ACE_OF_MOONS   = Card.new('the ACE of MOONS',  :ace,    :moons)
+  THE_ACE_OF_SUNS    = Card.new('the ACE of SUNS',   :ace,    :suns)
+  THE_ACE_OF_WAVES   = Card.new('the ACE of WAVES',  :ace,    :waves)
+  THE_ACE_OF_LEAVES  = Card.new('the ACE of LEAVES', :ace,    :leaves)
+  THE_ACE_OF_WYRMS   = Card.new('the ACE of WYRMS',  :ace,    :wyrms)
+  THE_ACE_OF_KNOTS   = Card.new('the ACE of KNOTS',  :ace,    :knots)
+
+  THE_AUTHOR         = Card.new('the AUTHOR',         2,      %i[moons knots],        :personality)
+  THE_DESERT         = Card.new('the DESERT',         2,      %i[suns wyrms],         :location)
+  THE_ORIGIN         = Card.new('the ORIGIN',         2,      %i[waves leaves],       %i[location event])
+  THE_JOURNEY        = Card.new('the JOURNEY',        3,      %i[moons waves],        :event)
+  THE_PAINTER        = Card.new('the PAINTER',        3,      %i[suns knots],         :personality)
+  THE_SAVAGE         = Card.new('the SAVAGE',         3,      %i[leaves wyrms],       :personality)
+  THE_MOUNTAIN       = Card.new('the MOUNTAIN',       4,      %i[moons suns],         :location)
+  THE_SAILOR         = Card.new('the SAILOR',         4,      %i[waves leaves],       :personality)
+  THE_BATTLE         = Card.new('the BATTLE',         4,      %i[wyrms knots],        :event)
+  THE_FOREST         = Card.new('the FOREST',         5,      %i[moons leaves],       :location)
+  THE_DISCOVERY      = Card.new('the DISCOVERY',      5,      %i[suns waves],         :event)
+  THE_SOLDIER        = Card.new('the SOLDIER',        5,      %i[wyrms knots],        :personality)
+  THE_LUNATIC        = Card.new('the LUNATIC',        6,      %i[moons waves],        :personality)
+  THE_PENITENT       = Card.new('the PENITENT',       6,      %i[suns wyrms],         :personality)
+  THE_MARKET         = Card.new('the MARKET',         6,      %i[leaves knots],       %i[location event])
+  THE_CHANCE_MEETING = Card.new('the CHANCE MEETING', 7,      %i[moons leaves],       :event)
+  THE_CASTLE         = Card.new('the CASTLE',         7,      %i[suns knots],         :location)
+  THE_CAVE           = Card.new('the CAVE',           7,      %i[waves wyrms],        :location)
+  THE_DIPLOMAT       = Card.new('the DIPLOMAT',       8,      %i[moons suns],         :personality)
+  THE_MILL           = Card.new('the MILL',           8,      %i[waves leaves],       :location)
+  THE_BETRAYAL       = Card.new('the BETRAYAL',       8,      %i[wyrms knots],        :event)
+  THE_PACT           = Card.new('the PACT',           9,      %i[moons suns],         :event)
+  THE_DARKNESS       = Card.new('the DARKNESS',       9,      %i[waves wyrms],        :location)
+  THE_MERCHANT       = Card.new('the MERCHANT',       9,      %i[leaves knots],       :personality)
+
+  THE_HARVEST        = Card.new('the HARVEST',        :pawn,  %i[moons suns leaves],  :event)
+  THE_WATCHMAN       = Card.new('the WATCHMAN',       :pawn,  %i[moons wyrms knots],  :personality)
+  THE_LIGHT_KEEPER   = Card.new('the LIGHT KEEPER',   :pawn,  %i[suns waves knots],   :personality)
+  THE_BORDERLAND     = Card.new('the BORDERLAND',     :pawn,  %i[waves leaves wyrms], :location)
+
+  THE_CONSUL         = Card.new('the CONSUL',         :court, %i[moons waves knots],  :personality)
+  THE_RITE           = Card.new('the RITE',           :court, %i[moons leaves wyrms], :event)
+  THE_ISLAND         = Card.new('the ISLAND',         :court, %i[suns waves wyrms],   :location)
+  THE_WINDOW         = Card.new('the WINDOW',         :court, %i[suns leaves knots],  :location)
+
+  THE_HUNTRESS       = Card.new('the HUNTRESS',       :crown, :moons,                 :personality)
+  THE_BARD           = Card.new('the BARD',           :crown, :suns,                  :personality)
+  THE_SEA            = Card.new('the SEA',            :crown, :waves,                 :location)
+  THE_END            = Card.new('the END',            :crown, :leaves,                %i[location event])
+  THE_CALAMITY       = Card.new('the CALAMITY',       :crown, :wyrms,                 :event)
+  THE_WINDFALL       = Card.new('the WINDFALL',       :crown, :knots,                 :event)
+
+  Card.class_eval { private_class_method :new }
+
+  CARDS = [
+    THE_EXCUSE,
+    THE_ACE_OF_MOONS, THE_ACE_OF_SUNS, THE_ACE_OF_WAVES, THE_ACE_OF_LEAVES, THE_ACE_OF_WYRMS, THE_ACE_OF_KNOTS,
+    THE_AUTHOR, THE_DESERT, THE_ORIGIN,                                   # rank 2
+    THE_JOURNEY, THE_PAINTER, THE_SAVAGE,                                 # rank 3
+    THE_MOUNTAIN, THE_SAILOR, THE_BATTLE,                                 # rank 4
+    THE_FOREST, THE_DISCOVERY, THE_SOLDIER,                               # rank 5
+    THE_LUNATIC, THE_PENITENT, THE_MARKET,                                # rank 6
+    THE_CHANCE_MEETING, THE_CASTLE, THE_CAVE,                             # rank 7
+    THE_DIPLOMAT, THE_MILL, THE_BETRAYAL,                                 # rank 8
+    THE_PACT, THE_DARKNESS, THE_MERCHANT,                                 # rank 9
+    THE_HARVEST, THE_WATCHMAN, THE_LIGHT_KEEPER, THE_BORDERLAND,          # pawns
+    THE_CONSUL, THE_RITE, THE_ISLAND, THE_WINDOW,                         # courts
+    THE_HUNTRESS, THE_BARD, THE_SEA, THE_END, THE_CALAMITY, THE_WINDFALL, # crowns
+  ].freeze
+
+  ACES          = CARDS.select(&:ace?).freeze
+  NUMBERS       = CARDS.select(&:number?).freeze
+  PAWNS         = CARDS.select(&:pawn?).freeze
+  COURTS        = CARDS.select(&:court?).freeze
+  CROWNS        = CARDS.select(&:crown?).freeze
+
+  MOONS         = CARDS.select(&:moons?).freeze
+  SUNS          = CARDS.select(&:suns?).freeze
+  WAVES         = CARDS.select(&:waves?).freeze
+  LEAVES        = CARDS.select(&:leaves?).freeze
+  WYRMS         = CARDS.select(&:wyrms?).freeze
+  KNOTS         = CARDS.select(&:knots?).freeze
+
+  LOCATIONS     = CARDS.select(&:location?).freeze
+  PERSONALITIES = CARDS.select(&:personality?).freeze
+  EVENTS        = CARDS.select(&:event?).freeze
+end

data/lib/decktet/deck.rb

@@ -0,0 +1,24 @@
+module Decktet
+  module DeckTemplates
+    BASIC_DECK =  [ACES, NUMBERS, CROWNS].flatten
+    BASIC_DECK_WITH_EXCUSE = [THE_EXCUSE] + BASIC_DECK
+    EXTENDED_DECK = BASIC_DECK_WITH_EXCUSE + [PAWNS, COURTS].flatten
+    DOUBLE_DECK = BASIC_DECK + BASIC_DECK
+  end
+
+  class Deck < Pile
+    def initialize(*cards)
+      @cards = cards.flatten
+
+      unless @cards.any? && @cards.all?{|card| Decktet::Card === card }
+        raise ArgumentError.new("A deck can only be initialized with Decktet::Card objects. Deck templates defined in Decktet::DeckTemplates and card groups or specific cards are accepted.")
+      end
+    end
+
+    class << self
+      DeckTemplates.constants.each do |template|
+        define_method("new_#{template}".downcase) { new DeckTemplates.const_get(template) }
+      end
+    end
+  end
+end

data/lib/decktet/pile.rb

@@ -0,0 +1,49 @@
+module Decktet
+  class Pile
+    def initialize(*cards)
+      @cards = cards.flatten.compact
+
+      unless cards.empty? || @cards.all? { |card| Decktet::Card === card }
+        raise ArgumentError.new('A pile must be initialized empty or with an array of cards or card groups')
+      end
+    end
+
+    def cards = @cards.dup
+
+    def size = @cards.size
+
+    def shuffle
+      @cards.shuffle!
+      self
+    end
+
+    def cut(depth=nil)
+      return self if @cards.empty?
+
+      unless depth.nil?
+        raise ArgumentError.new('cut depth cannot be negative') if depth < 0
+        raise ArgumentError.new('cut depth cannot be greater than the number of cards') if depth > @cards.count
+      end
+
+      depth ||= rand(1...@cards.count)
+      @cards.rotate!(depth)
+      self
+    end
+
+    def draw(count=1)
+      unless count.between?(0,@cards.count)
+        raise ArgumentError.new('draw amount cannot be negative or greater than the number of cards')
+      end
+      @cards.shift(count)
+    end
+
+    def add(*new_cards)
+      new_cards = new_cards.flatten
+      unless new_cards.all? { |card| Decktet::Card === card }
+        raise ArgumentError, "Only Decktet::Card objects can be added to a #{self.class.name}"
+      end
+      @cards.unshift(*new_cards)
+      self
+    end
+  end
+end

data/lib/decktet/version.rb

@@ -0,0 +1,3 @@
+module Decktet
+  VERSION = "0.1.0"
+end

data/lib/decktet.rb

@@ -0,0 +1,8 @@
+require 'decktet/version'
+require 'decktet/card'
+require 'decktet/pile'
+require 'decktet/deck'
+
+module Decktet
+  Error = Class.new StandardError
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: decktet
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brody Fischer
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-06-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+description:
+email:
+- brodyf42@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- decktet.gemspec
+- lib/decktet.rb
+- lib/decktet/card.rb
+- lib/decktet/deck.rb
+- lib/decktet/pile.rb
+- lib/decktet/version.rb
+homepage: https://github.com/brodyf42/decktet
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: This gem provides an interface to the versatile decktet playing card system.
+test_files: []