card_dealer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e4f9b59efbde62a455eb8cc518b88e10819824ec42723a97947093ebda55ca88
+  data.tar.gz: 8be49f812cbde111460d824e308110dd2dcc5bda31248ab8d41fe8cbe6bf963f
+SHA512:
+  metadata.gz: 271397f599f5d7e05c5cb86795506e5c97afb853d77eb575fa1d8ab612bd8641c3f4d4eea63aed3e4493c9742f01be98d6f2778e8b19c6483552f9ae78d549c2
+  data.tar.gz: abbd762746b5b86b1ee16b983888072e396648fa7fd9632c02c9234d1f7be145c9a2b95ad949f2231a1fd289ed539482d6346bae24ef612db5912d3b0d10071d

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,27 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 3.1
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  ExtraDetails: true
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120
+
+RSpec/NestedGroups:
+  Max: 4

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-03-26
+
+Initial release!
+
+### Added
+
+- Card class
+- Deck class
+- Ability to create a decks of various size, ranks and suits
+- Ability to shuffle a deck
+- Ability to reset a deck

data/Gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in card_dealer.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "faker", "~> 3.1"
+gem "rspec", "~> 3.12"
+gem "simplecov", require: false, group: :test
+
+gem "rubocop", "~> 1.28"
+gem "rubocop-rake", "~> 0.6"
+gem "rubocop-rspec", "~> 2.19"

data/Gemfile.lock

@@ -0,0 +1,80 @@
+PATH
+  remote: .
+  specs:
+    card_dealer (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    concurrent-ruby (1.2.2)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    faker (3.1.1)
+      i18n (>= 1.8.11, < 2)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    parallel (1.22.1)
+    parser (3.2.1.1)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.7.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.48.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.26.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.17.1)
+      rubocop (~> 1.41)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.19.0)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+    ruby-progressbar (1.13.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  card_dealer!
+  faker (~> 3.1)
+  rake (~> 13.0)
+  rspec (~> 3.12)
+  rubocop (~> 1.28)
+  rubocop-rake (~> 0.6)
+  rubocop-rspec (~> 2.19)
+  simplecov
+
+BUNDLED WITH
+   2.4.9

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Leonid Svyatov
+
+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,31 @@
+# CardDealer
+
+This gem allows you to generate a deck of cards, shuffle them, and deal them to players.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TBD
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/svyatov/card_dealer.
+
+## 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 "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/card_dealer/card.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module CardDealer
+  class Card
+    CLUBS    = "c"
+    DIAMONDS = "d"
+    HEARTS   = "h"
+    SPADES   = "s"
+
+    # T = 10, J = Jack, Q = Queen, K = King, A = Ace
+    RANKS = %w[2 3 4 5 6 7 8 9 T J Q K A].freeze
+    SUITS = [CLUBS, DIAMONDS, HEARTS, SPADES].freeze
+
+    # For faster lookup
+    RANKS_SET = RANKS.to_set.freeze
+    SUITS_SET = SUITS.to_set.freeze
+
+    attr_reader :rank, :suit
+
+    # Initializes a new card.
+    #
+    # @param rank [String] the card's rank (2-9, T, J, Q, K, A)
+    # @param suit [String] the card's suit (c, d, h, s)
+    def initialize(rank, suit)
+      validate_arguments rank, suit
+
+      @rank = rank
+      @suit = suit
+    end
+
+    # @return [String] the card's rank and suit
+    def to_s
+      "#{rank}#{suit}"
+    end
+
+    # @return [String] the card's object string representation
+    def inspect
+      %(#<CardDealer::Card "#{self}">)
+    end
+
+    private
+
+    def validate_arguments(rank, suit)
+      raise Error, "Invalid rank: #{rank}" unless RANKS_SET.include?(rank)
+      raise Error, "Invalid suit: #{suit}" unless SUITS_SET.include?(suit)
+    end
+  end
+end

data/lib/card_dealer/deck.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module CardDealer
+  class Deck
+    attr_reader :cards, :seed
+
+    # Initializes a new deck.
+    #
+    # @param decks [Integer] the number of decks to use
+    # @param cards_per_suit [Integer] the number of cards per suit to use
+    # @param ranks [Array<String>, :highest, :lowest] the ranks to use
+    #   @option :highest will use the highest cards_per_suit ranks (A, K, Q, J, T, ...)
+    #   :lowest will use the lowest cards_per_suit ranks (2, 3, 4, 5, 6, ...)
+    #   array will use the specified ranks (e.g. %w[2 4 6 8 T])
+    # @param suits [Array<String>, :all] the suits to use
+    #   :all will use all suits (c, d, h, s)
+    #   array will use the specified suits (e.g. %w[d h])
+    # @raise [Error] if ranks or suits are invalid
+    def initialize(decks: 1, cards_per_suit: 13, ranks: :highest, suits: :all)
+      @decks = decks
+      @ranks = build_ranks ranks, cards_per_suit
+      @suits = build_suits suits
+      reset
+    end
+
+    # Resets the deck to its original state.
+    #
+    # @return [Deck]
+    def reset
+      @cards = []
+
+      @decks.times do
+        @suits.each do |suit|
+          @ranks.each do |rank|
+            @cards << Card.new(rank, suit)
+          end
+        end
+      end
+
+      self
+    end
+
+    # Shuffles the deck using the Fisher-Yates algorithm.
+    #
+    # @param seed [Integer] the seed to use for shuffling
+    # @return [Deck]
+    def shuffle(seed = Random.new_seed)
+      @seed = seed
+      @cards.shuffle! random: Random.new(seed)
+      self
+    end
+
+    # @return [Array<String>] the array of cards in the deck as strings
+    def to_a
+      cards.map(&:to_s)
+    end
+
+    # @return [String] the cards in the deck as a string
+    def to_s
+      to_a.to_s
+    end
+
+    private
+
+    def build_suits(suits)
+      case suits
+      when :all
+        Card::SUITS
+      when Array
+        suits
+      else
+        raise Error, "Invalid suits: #{suits}"
+      end
+    end
+
+    def build_ranks(ranks, cards_per_suit)
+      case ranks
+      when :highest
+        Card::RANKS.last(cards_per_suit)
+      when :lowest
+        Card::RANKS.first(cards_per_suit)
+      when Array
+        ranks
+      else
+        raise Error, "Invalid ranks: #{ranks}"
+      end
+    end
+  end
+end

data/lib/card_dealer/version.rb

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

data/lib/card_dealer.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "set"
+
+require_relative "card_dealer/version"
+require_relative "card_dealer/card"
+require_relative "card_dealer/deck"
+
+module CardDealer
+  class Error < StandardError; end
+end

data/sig/card_dealer/card.rbs

@@ -0,0 +1,25 @@
+module CardDealer
+  class Card
+    CLUBS: 'c'
+    DIAMONDS: 'd'
+    HEARTS: 'h'
+    SPADES: 's'
+
+    RANKS: Array[String]
+    SUITS: Array[String]
+
+    RANKS_SET: Set[String]
+    SUITS_SET: Set[String]
+
+    attr_reader rank: String
+    attr_reader suit: String
+
+    def initialize: (rank: String, suit: String) -> void
+
+    def to_s: -> String
+
+    private
+
+    def validate_arguments: (rank: String, suit: String) -> void
+  end
+end

data/sig/card_dealer/deck.rbs

@@ -0,0 +1,30 @@
+module CardDealer
+  class Deck
+    attr_reader cards: Array[Card]
+    attr_reader seed: Integer
+
+    @decks: Integer
+    @ranks: :highest | :lowest | Array[String]
+    @suits: :all | Array[String]
+
+    def initialize: (
+        ?decks: Integer,
+        ?cards_per_suit: Integer,
+        ?ranks: :highest | :lowest | Array[String],
+        ?suits: :all | Array[String]) -> void
+
+    def reset: -> self
+
+    def shuffle: (?seed: Integer) -> self
+
+    def to_a: -> Array[String]
+
+    def to_s: -> String
+
+    private
+
+    def build_suits: (suits: :all | Array[String]) -> Array[String]
+
+    def build_ranks: (ranks: :highest | :lowest | Array[String]) -> Array[String]
+  end
+end

data/sig/card_dealer.rbs

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

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: card_dealer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Leonid Svyatov
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-03-26 00:00:00.000000000 Z
+dependencies: []
+description: Card dealer allows to generate a deck of cards, shuffle them, and deal
+  them to players.
+email:
+- leonid@svyatov.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/card_dealer.rb
+- lib/card_dealer/card.rb
+- lib/card_dealer/deck.rb
+- lib/card_dealer/version.rb
+- sig/card_dealer.rbs
+- sig/card_dealer/card.rbs
+- sig/card_dealer/deck.rbs
+homepage: https://github.com/svyatov/card_dealer
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/svyatov/card_dealer
+  source_code_uri: https://github.com/svyatov/card_dealer
+  changelog_uri: https://github.com/svyatov/card_dealer/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+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.4.9
+signing_key:
+specification_version: 4
+summary: It deals with cards. It's a card dealer.
+test_files: []