deck_of_cards_handler 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1b2047d98e01703a7121033f7f3fe003222b97d72e7e1d2bfee7c53e2ad2b8f5
+  data.tar.gz: '0786c32ac1a61c75a1f37c5e89b1bb52f70e1e578c8c471bf7c49b648ba14a20'
+SHA512:
+  metadata.gz: b07650c2422846f715bd3e5ba4d63a02e984cc08067a328544dff5da67c016dd0c3aef9fa99ee657e2fe06b036bd030ddab0aadae5f70bdf11aafa0bbbff5203
+  data.tar.gz: 699e114cd1c825d53104a7611a546d9c963b43bfbc9acb2e1fef9c6cba9cb5950da6753018958d6164824c2dcc56b9674961856c1b4eec4704efd3d9934a2b91

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.1
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-09-26
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Simon Bernard
+
+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,38 @@
+# DeckOfCards
+
+This is a gem that simulates the handling of a deck of cards.
+It provides all the moves one could do such as shuffling, cutting, dealing, culling, etc.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at <https://github.com/simonbernard2/deck_of_cards>.
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/data/duplicate_cards.txt

@@ -0,0 +1,14 @@
+A:H
+2:H
+3:H
+4:H
+5:H
+6:H
+7:H
+8:H
+9:H
+10:H
+10:H
+10:H
+10:H
+J:H

data/data/mnemonica.txt

@@ -0,0 +1,52 @@
+4:C
+2:H
+7:D
+3:C
+4:H
+6:D
+A:S
+5:H
+9:S
+2:S
+Q:H
+3:D
+Q:C
+8:H
+6:S
+5:S
+9:H
+K:C
+2:D
+J:H
+3:S
+8:S
+6:H
+10:C
+5:D
+K:D
+2:C
+3:H
+8:D
+5:C
+K:S
+J:D
+8:C
+10:S
+K:H
+J:C
+7:S
+10:H
+A:D
+4:S
+7:H
+4:D
+A:C
+9:C
+J:S
+Q:D
+7:C
+Q:S
+10:D
+6:C
+A:H
+9:D

data/lib/deck_of_cards/card/card.rb

@@ -0,0 +1,70 @@
+# typed: strict
+# frozen_string_literal: true
+
+# This represents a Playing Card.
+# It has the following properties: a suit, a value and a position.
+class Card
+  extend T::Sig
+
+  sig { returns(String) }
+  attr_accessor :suit
+
+  sig { returns(String) }
+  attr_accessor :value
+
+  sig { returns(T.nilable(Integer)) }
+  attr_accessor :position
+
+  sig { params(suit: String, value: String, position: T.nilable(Integer)).void }
+  def initialize(suit:, value:, position: nil)
+    raise ArgumentError, "Invalid suit" unless Card.suits.include?(suit)
+    raise ArgumentError, "Invalid value" unless Card.values.include?(value)
+
+    @suit = T.let(suit, String)
+    @value = T.let(value, String)
+    @position = T.let(position, T.nilable(Integer))
+  end
+
+  sig { returns(String) }
+  def color
+    red? ? "red" : "black"
+  end
+
+  sig { returns(T::Boolean) }
+  def red?
+    Card.red_suits.include?(suit)
+  end
+
+  sig { returns(T::Boolean) }
+  def black?
+    Card.black_suits.include?(suit)
+  end
+
+  sig { returns(String) }
+  def to_s
+    "#{value} of #{suit}"
+  end
+
+  class << self
+    extend T::Sig
+    sig { returns(T::Array[String]) }
+    def suits
+      %w[C H S D].freeze
+    end
+
+    sig { returns(T::Array[String]) }
+    def red_suits
+      %w[H D].freeze
+    end
+
+    sig { returns(T::Array[String]) }
+    def black_suits
+      %w[S C].freeze
+    end
+
+    sig { returns(T::Array[String]) }
+    def values
+      %w[A 2 3 4 5 6 7 8 9 10 J Q K].freeze
+    end
+  end
+end

data/lib/deck_of_cards/card.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "card/card"

data/lib/deck_of_cards/packet/cuts.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+# typed: true
+
+# Includes cutting methods, either splits or assembles packets of cards
+module Cuts
+  extend T::Helpers
+  extend T::Sig
+  requires_ancestor { Packet }
+
+  sig { params(number: Integer).returns(Packet) }
+  def cut(number:)
+    raise ArgumentError if invalid_number_to_cut_to?(number)
+
+    cut_cards = cards.slice!(0...number)
+    Packet.new(cards: T.must(cut_cards))
+  end
+
+  sig { params(number: Integer).void }
+  def cut_and_complete(number:)
+    top_half = cut(number:)
+    self.cards = [cards, top_half.cards].flatten
+  end
+
+  private
+
+  sig { params(number: Integer).returns(T::Boolean) }
+  def invalid_number_to_cut_to?(number)
+    return true if number.negative?
+    return true if number.zero?
+    return true if number >= cards.size
+
+    false
+  end
+end

data/lib/deck_of_cards/packet/deals.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+# typed: true
+
+# Includes dealing methods, that either returns a single Card or Packet(s) of cards
+module Deals
+  extend T::Helpers
+  extend T::Sig
+
+  requires_ancestor { Packet }
+  sig { returns(Card) }
+  def top_deal
+    raise StandardError if size.zero?
+
+    T.must(cards.slice!(0))
+  end
+
+  sig { returns(Card) }
+  def second_deal
+    raise StandardError if size < 2
+
+    T.must(cards.slice!(1))
+  end
+
+  sig { returns(Card) }
+  def bottom_deal
+    raise StandardError if size.zero?
+
+    T.must(cards.pop)
+  end
+
+  sig { params(number_of_piles: Integer, number_of_cards: Integer).returns(T::Array[Packet]) }
+  def deal_into_piles(number_of_piles:, number_of_cards:)
+    raise StandardError, "Not enough cards" if (number_of_cards * number_of_piles) > size
+    raise StandardError, "Invalid number_of_cards" unless number_of_cards.positive?
+
+    piles = Array.new(number_of_piles) { [] }
+    number_of_cards.times do
+      piles.each { |pile| pile << top_deal }
+    end
+
+    piles.map { Packet.new(cards: _1) }
+  end
+end

data/lib/deck_of_cards/packet/packet.rb

@@ -0,0 +1,89 @@
+# typed: strict
+# frozen_string_literal: true
+
+# This represents a packet of cards
+class Packet
+  extend T::Sig
+  require "deck_of_cards/packet/shuffles"
+  require "deck_of_cards/packet/deals"
+  require "deck_of_cards/packet/cuts"
+  include Deals
+  include Cuts
+
+  sig { returns(T::Array[Card]) }
+  attr_accessor :cards
+
+  sig { params(cards: T::Array[Card]).void }
+  def initialize(cards:)
+    raise ArgumentError if cards.empty?
+
+    @cards = T.let(cards, T::Array[Card])
+  end
+
+  sig { returns(Integer) }
+  def size
+    cards.size
+  end
+
+  class << self
+    extend T::Sig
+
+    sig { params(file_path: String).returns(Packet) }
+    def build_from_text_file(file_path:) # rubocop:disable Metrics
+      file_content = File.read(file_path)
+      cards = []
+      cards_set = Set.new
+
+      file_content.each_line do |line|
+        value, suit = line.chomp.split(":")
+        raise StandardError unless value && suit
+
+        card = Card.new(suit:, value:)
+        card_string = card.to_s
+        raise StandardError, "Duplicate card. (#{card_string})" if cards_set.include?(card_string)
+
+        cards_set << card_string
+        cards << card
+      end
+
+      packet = Packet.new(cards:)
+      set_cards_positions(packet:)
+
+      packet
+    end
+
+    private
+
+    sig { params(packet: Packet).void }
+    def set_cards_positions(packet:)
+      packet.cards.each_with_index do |card, index|
+        card.position = index + 1
+      end
+    end
+  end
+
+  sig { params(other_packet: Packet).void }
+  def faro(other_packet:)
+    self.cards = Shuffles.faro_shuffle(top_half: self, bottom_half: other_packet)
+  end
+
+  sig { params(other_packet: Packet).void }
+  def riffle_shuffle(other_packet:)
+    self.cards = Shuffles.riffle_shuffle(left_half: self, right_half: other_packet)
+  end
+
+  sig { void }
+  def shuffle
+    self.cards = cards.shuffle
+  end
+
+  sig { void }
+  def reverse
+    self.cards = cards.reverse
+  end
+
+  sig { returns(T::Array[String]) }
+  def to_s
+    cards.map(&:to_s)
+  end
+end

data/lib/deck_of_cards/packet/shuffles.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+# typed: strict
+
+module Shuffles
+  class << self
+    extend T::Sig
+    sig { params(left_half: Packet, right_half: Packet).returns(T::Array[Card]) }
+    def riffle_shuffle(left_half:, right_half:) # rubocop:disable Metrics/AbcSize
+      shuffled_cards = []
+      until left_half.cards.empty? && right_half.cards.empty?
+        if !left_half.cards.empty? && (right_half.cards.empty? || Kernel.rand < 0.5)
+          shuffled_cards.concat(left_half.cards.shift(Kernel.rand(1..3)))
+        else
+          shuffled_cards.concat(right_half.cards.shift(Kernel.rand(1..3)))
+        end
+      end
+      shuffled_cards
+    end
+
+    sig { params(top_half: Packet, bottom_half: Packet).returns(T::Array[Card]) }
+    def faro_shuffle(top_half:, bottom_half:)
+      top_cards = top_half.cards
+      bottom_cards = bottom_half.cards
+      remaining_cards = []
+
+      remaining_cards = top_cards[bottom_cards.size..top_cards.size] if bottom_cards.size < top_cards.size
+
+      zipped_cards = bottom_cards.zip(top_cards).flatten.compact
+      [zipped_cards, remaining_cards].flatten.compact
+    end
+  end
+end

data/lib/deck_of_cards/packet.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "packet/packet"

data/lib/deck_of_cards/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DeckOfCards
+  VERSION = "0.1.0"
+end

data/lib/deck_of_cards.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require "sorbet-runtime"
+require_relative "deck_of_cards/version"
+require_relative "deck_of_cards/card"
+require_relative "deck_of_cards/packet"

data/sig/deck_of_cards.rbs

@@ -0,0 +1,4 @@
+module DeckOfCards
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: deck_of_cards_handler
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Simon Bernard
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sorbet-runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: sorbet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: tapioca
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.17.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.17.7
+description: |2
+      It provides all the moves one could do with a deck of cards.
+      Such as shuffling, cutting, dealing, culling, etc.
+email:
+- simonbernard@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- data/duplicate_cards.txt
+- data/mnemonica.txt
+- lib/deck_of_cards.rb
+- lib/deck_of_cards/card.rb
+- lib/deck_of_cards/card/card.rb
+- lib/deck_of_cards/packet.rb
+- lib/deck_of_cards/packet/cuts.rb
+- lib/deck_of_cards/packet/deals.rb
+- lib/deck_of_cards/packet/packet.rb
+- lib/deck_of_cards/packet/shuffles.rb
+- lib/deck_of_cards/version.rb
+- sig/deck_of_cards.rbs
+homepage: https://rubygems.org/gems/deck_of_cards_handler
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://rubygems.org/gems/deck_of_cards_handler
+  source_code_uri: https://github.com/simonbernard2/deck_of_cards
+  changelog_uri: https://github.com/simonbernard2/deck_of_cards/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: A gem that simulates the handling of a deck of cards
+test_files: []