card_dealer 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10507b7c372be3c958141e1e06c399eaead316c8578bcbca4a988ece49e76af5
-  data.tar.gz: b0dfddf4d95907e61862efa01e0c8c8ae55a33a72d004c4557cf687e83dfaf96
+  metadata.gz: 0c3f3a33b1bc150361102599843b3cf9e7e1eb3d2b799b4116411f3445a00cf2
+  data.tar.gz: 6f32d0a5b10e0703424304aba1e8e3172a50b56066c49505c08f1752ca0c5bbe
 SHA512:
-  metadata.gz: a0407ea05a850c8b2bac7be37c1b128589225d1122bd26ba4e01a4e510565d2b7ca89c187a27c362cd3d7fc564e6e7cc2a7b9d9bbdaf0c8462be512dcf79c72b
-  data.tar.gz: 1eb8477fd9c2f64e83133060a347a7b9a3e3f1f106d01612ec0e5ce72c21975974a9a0b1089c708e8403811063149ae93e22672e5f5eb762c78b86701e2f09e7
+  metadata.gz: 07f8695bf89b50776b4dbd412ed774679ae1d7cd9dccf78581148bd200b7afd30e97fdbe8eb392b640569faf3945dc738a67fd34d8501c6028216fb1d942a73f
+  data.tar.gz: b6936af01081753ab4f0e46174ddab834c2c84091923eb73794660fa2f6ea30c04c495a72121f8ffcc2ac998fb6754927b305d50bd4eabfaf3ae815d988a4c47

data/.rubocop.yml

@@ -1,9 +1,9 @@
-require:
+plugins:
   - rubocop-rake
   - rubocop-rspec
 
 AllCops:
-  TargetRubyVersion: 3.1
+  TargetRubyVersion: 3.3
   DisplayCopNames: true
   DisplayStyleGuide: true
   ExtraDetails: true

data/CHANGELOG.md

@@ -1,12 +1,30 @@
+# Changelog
+
+All notable changes to this project are documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/2.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+The public API covered by Semantic Versioning is the public methods of
+`CardDealer::Card`, `CardDealer::Deck`, `CardDealer::BuildDeck`, and
+`CardDealer::BinaryDeck`, the binary format `BinaryDeck` produces, and the
+minimum Ruby version. Private methods and the RBS signatures under `sig/` are
+outside it. While the version is below 1.0.0, an incompatible change bumps
+MINOR and every other change bumps PATCH. A public item is deprecated with a
+runtime warning naming its replacement for at least one release before it is
+removed.
+
 ## [Unreleased]
 
-## [0.2.0] - 2023-04-01
+## [0.3.0] - 2026-09-07
 
-### BREAKING CHANGES
+### Changed
 
-- Deck building in extracted from the `Deck` class to the `BuildDeck` class:
-  - `Deck#new` now takes an array of cards instead of a hash of options
-  - `Deck#reset` removed
+- **Breaking:** Ruby 3.3 or newer is required. Ruby 3.1 and 3.2 reached end of life and are no longer tested.
+- Development dependencies updated to their current releases (RuboCop 1.90, RSpec 3.13, Steep 2.1, rbs 4.2)
+- CI runs on Ruby 3.3, 3.4, and 4.0
+
+## [0.2.0] - 2023-04-01
 
 ### Added
 
@@ -22,11 +40,20 @@
 - `Deck#from_binary` helper method to convert the binary string to a deck
 - `Deck#==` method to compare decks for equality
 - Lots of documentation
-- [Steep](https://github.com/soutaro/steep) gem to check types correctness
+- [Steep](https://github.com/soutaro/steep) gem to check type correctness
 
 ### Changed
 
-- It's possible to initialize a card with a string now, e.g. `Card.new('9c')`
+- **Breaking:** Deck building is extracted from the `Deck` class to the `BuildDeck` class.
+  `Deck#new` now takes an array of cards instead of a hash of options.
+  Call `BuildDeck.standard52`, `BuildDeck.standard36`, or `BuildDeck.custom` to build a deck.
+- It's now possible to initialize a card with a string, e.g. `Card.new('9c')`
+
+### Removed
+
+- **Breaking:** `Deck#reset`. It was removed without a deprecation notice in 0.1.0,
+  so no release warned before the removal. Build a new deck with `BuildDeck` where
+  `reset` was called.
 
 ### Fixed
 
@@ -40,6 +67,11 @@ Initial release!
 
 - `Card` class
 - `Deck` class
-- Ability to create a decks of various size, ranks and suits
+- Ability to create a decks of various sizes, ranks, and suits
 - Ability to shuffle a deck
 - Ability to reset a deck
+
+[unreleased]: https://github.com/svyatov/card_dealer/compare/v0.3.0...HEAD
+[0.3.0]: https://github.com/svyatov/card_dealer/compare/v0.2.0...v0.3.0
+[0.2.0]: https://github.com/svyatov/card_dealer/compare/v0.1.0...v0.2.0
+[0.1.0]: https://github.com/svyatov/card_dealer/releases/tag/v0.1.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,91 @@
+
+# Contributor Covenant 3.0 Code of Conduct
+
+## Our Pledge
+
+We pledge to make our community welcoming, safe, and equitable for all.
+
+We are committed to fostering an environment that respects and promotes the dignity, rights, and contributions of all individuals, regardless of characteristics including race, ethnicity, caste, color, age, physical characteristics, neurodiversity, disability, sex or gender, gender identity or expression, sexual orientation, language, philosophy or religion, national or social origin, socio-economic position, level of education, or other status. The same privileges of participation are extended to everyone who participates in good faith and in accordance with this Covenant.
+
+
+## Encouraged Behaviors
+
+While acknowledging differences in social norms, we all strive to meet our community's expectations for positive behavior. We also understand that our words and actions may be interpreted differently than we intend based on culture, background, or native language.
+
+With these considerations in mind, we agree to behave mindfully toward each other and act in ways that center our shared values, including:
+
+1. Respecting the **purpose of our community**, our activities, and our ways of gathering.
+2. Engaging **kindly and honestly** with others.
+3. Respecting **different viewpoints** and experiences.
+4. **Taking responsibility** for our actions and contributions.
+5. Gracefully giving and accepting **constructive feedback**.
+6. Committing to **repairing harm** when it occurs.
+7. Behaving in other ways that promote and sustain the **well-being of our community**.
+
+
+## Restricted Behaviors
+
+We agree to restrict the following behaviors in our community. Instances, threats, and promotion of these behaviors are violations of this Code of Conduct.
+
+1. **Harassment.** Violating explicitly expressed boundaries or engaging in unnecessary personal attention after any clear request to stop.
+2. **Character attacks.** Making insulting, demeaning, or pejorative comments directed at a community member or group of people.
+3. **Stereotyping or discrimination.** Characterizing anyone’s personality or behavior on the basis of immutable identities or traits.
+4. **Sexualization.** Behaving in a way that would generally be considered inappropriately intimate in the context or purpose of the community.
+5. **Violating confidentiality**. Sharing or acting on someone's personal or private information without their permission.
+6. **Endangerment.** Causing, encouraging, or threatening violence or other harm toward any person or group.
+7. Behaving in other ways that **threaten the well-being** of our community.
+
+### Other Restrictions
+
+1. **Misleading identity.** Impersonating someone else for any reason, or pretending to be someone else to evade enforcement actions.
+2. **Failing to credit sources.** Not properly crediting the sources of content you contribute.
+3. **Promotional materials**. Sharing marketing or other commercial content in a way that is outside the norms of the community.
+4. **Irresponsible communication.** Failing to responsibly present content which includes, links or describes any other restricted behaviors.
+
+
+## Reporting an Issue
+
+Tensions can occur between community members even when they are trying their best to collaborate. Not every conflict represents a code of conduct violation, and this Code of Conduct reinforces encouraged behaviors and norms that can help avoid conflicts and minimize harm.
+
+When an incident does occur, it is important to report it promptly. To report a possible violation, email Leonid Svyatov at leonid@svyatov.com.
+
+Community Moderators take reports of violations seriously and will make every effort to respond in a timely manner. They will investigate all reports of code of conduct violations, reviewing messages, logs, and recordings, or interviewing witnesses and other participants. Community Moderators will keep investigation and enforcement actions as transparent as possible while prioritizing safety and confidentiality. In order to honor these values, enforcement actions are carried out in private with the involved parties, but communicating to the whole community may be part of a mutually agreed upon resolution.
+
+
+## Addressing and Repairing Harm
+
+If an investigation by the Community Moderators finds that this Code of Conduct has been violated, the following enforcement ladder may be used to determine how best to repair harm, based on the incident's impact on the individuals involved and the community as a whole. Depending on the severity of a violation, lower rungs on the ladder may be skipped.
+
+1) Warning
+   1) Event: A violation involving a single incident or series of incidents.
+   2) Consequence: A private, written warning from the Community Moderators.
+   3) Repair: Examples of repair include a private written apology, acknowledgement of responsibility, and seeking clarification on expectations.
+2) Temporarily Limited Activities
+   1) Event: A repeated incidence of a violation that previously resulted in a warning, or the first incidence of a more serious violation.
+   2) Consequence: A private, written warning with a time-limited cooldown period designed to underscore the seriousness of the situation and give the community members involved time to process the incident. The cooldown period may be limited to particular communication channels or interactions with particular community members.
+   3) Repair: Examples of repair may include making an apology, using the cooldown period to reflect on actions and impact, and being thoughtful about re-entering community spaces after the period is over.
+3) Temporary Suspension
+   1) Event: A pattern of repeated violation which the Community Moderators have tried to address with warnings, or a single serious violation.
+   2) Consequence: A private written warning with conditions for return from suspension. In general, temporary suspensions give the person being suspended time to reflect upon their behavior and possible corrective actions.
+   3) Repair: Examples of repair include respecting the spirit of the suspension, meeting the specified conditions for return, and being thoughtful about how to reintegrate with the community when the suspension is lifted.
+4) Permanent Ban
+   1) Event: A pattern of repeated code of conduct violations that other steps on the ladder have failed to resolve, or a violation so serious that the Community Moderators determine there is no way to keep the community safe with this person as a member.
+   2) Consequence: Access to all community spaces, tools, and communication channels is removed. In general, permanent bans should be rarely used, should have strong reasoning behind them, and should only be resorted to if working through other remedies has failed to change the behavior.
+   3) Repair: There is no possible repair in cases of this severity.
+
+This enforcement ladder is intended as a guideline. It does not limit the ability of Community Managers to use their discretion and judgment, in keeping with the best interests of our community.
+
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public or other spaces. Examples of representing our community include using an official email address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+
+## Attribution
+
+This Code of Conduct is adapted from the Contributor Covenant, version 3.0, permanently available at [https://www.contributor-covenant.org/version/3/0/](https://www.contributor-covenant.org/version/3/0/).
+
+Contributor Covenant is stewarded by the Organization for Ethical Source and licensed under CC BY-SA 4.0. To view a copy of this license, visit [https://creativecommons.org/licenses/by-sa/4.0/](https://creativecommons.org/licenses/by-sa/4.0/)
+
+For answers to common questions about Contributor Covenant, see the FAQ at [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are provided at [https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations). Additional enforcement and community guideline resources can be found at [https://www.contributor-covenant.org/resources](https://www.contributor-covenant.org/resources). The enforcement ladder was inspired by the work of [Mozilla’s code of conduct team](https://github.com/mozilla/inclusion).
+

data/CONTRIBUTING.md

@@ -0,0 +1,32 @@
+# Contributing
+
+Bug reports and pull requests are welcome at https://github.com/svyatov/card_dealer/issues.
+
+## Setup
+
+Install Ruby 3.3 or newer, then run:
+
+```sh
+bin/setup
+```
+
+## Tests and checks
+
+`bundle exec rake` runs what CI runs: Steep, RuboCop, and RSpec. `bundle exec rake spec` runs the tests alone.
+
+## Pull requests
+
+1. Fork the repository and create a branch from `main`.
+2. Make the change. A change that adds or alters behavior arrives with a test in `spec/`.
+3. Run `bundle exec rake` and fix what it reports.
+4. Open a pull request against `main`.
+
+CI runs `bundle exec rake` on Ruby 3.3, 3.4, and 4.0. All three must pass before merge. Pull requests are squash merged, and their titles follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
+
+## What an acceptable change satisfies
+
+`bundle exec rake` passes: RuboCop with the rules in [.rubocop.yml](.rubocop.yml), Steep against the signatures in [sig/](sig/), and the suite in [spec/](spec/).
+
+## Governance
+
+Leonid Svyatov ([@svyatov](https://github.com/svyatov)) is the only maintainer. He reviews, merges, and releases. No succession is arranged: if he stops, the project stops unless someone forks it.

data/Gemfile

@@ -5,14 +5,13 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in card_dealer.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
+gem "rake", "~> 13.4"
 
-gem "rspec", "~> 3.12"
+gem "rspec", "~> 3.13"
 gem "simplecov", require: false
-gem "simplecov_json_formatter", require: false
 
-gem "rubocop", "~> 1.28"
-gem "rubocop-rake", "~> 0.6"
-gem "rubocop-rspec", "~> 2.19"
+gem "rubocop", "~> 1.90"
+gem "rubocop-rake", "~> 0.7"
+gem "rubocop-rspec", "~> 3.10"
 
 gem "steep", require: false

data/Gemfile.lock

@@ -1,119 +1,119 @@
 PATH
   remote: .
   specs:
-    card_dealer (0.2.0)
+    card_dealer (0.3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.4.3)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
-    ast (2.4.2)
-    concurrent-ruby (1.2.2)
-    csv (3.2.6)
-    diff-lcs (1.5.0)
-    docile (1.4.0)
-    ffi (1.15.5)
-    fileutils (1.7.0)
-    i18n (1.12.0)
-      concurrent-ruby (~> 1.0)
-    json (2.6.3)
-    language_server-protocol (3.17.0.3)
-    listen (3.8.0)
+    ast (2.4.3)
+    concurrent-ruby (1.3.8)
+    csv (3.3.6)
+    diff-lcs (1.6.2)
+    ffi (1.17.4-arm64-darwin)
+    ffi (1.17.4-x86_64-linux-gnu)
+    fileutils (1.8.0)
+    json (2.21.2)
+    language_server-protocol (3.17.0.6)
+    lint_roller (1.1.0)
+    listen (3.10.0)
+      logger
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
-    logger (1.5.3)
-    minitest (5.18.0)
-    parallel (1.22.1)
-    parser (3.2.1.1)
+    logger (1.7.0)
+    parallel (2.1.0)
+    parser (3.3.12.0)
       ast (~> 2.4.1)
+      racc
+    prism (1.9.0)
+    racc (1.8.1)
     rainbow (3.1.1)
-    rake (13.0.6)
+    rake (13.4.2)
     rb-fsevent (0.11.2)
-    rb-inotify (0.10.1)
+    rb-inotify (0.11.1)
       ffi (~> 1.0)
-    rbs (2.8.4)
-    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)
+    rbs (4.2.0)
+      logger
+      prism (>= 1.6.0)
+      tsort
+    regexp_parser (2.12.0)
+    rspec (3.13.2)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.6)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.4)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.8)
       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)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.7)
+    rubocop (1.90.0)
+      json (>= 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (>= 1.10)
+      parser (>= 3.3.0.2)
       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)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.49.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)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.50.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.7)
+    rubocop-rake (0.7.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.72.1)
+    rubocop-rspec (3.10.2)
+      lint_roller (~> 1.1)
+      regexp_parser (>= 2.0)
+      rubocop (~> 1.86, >= 1.86.2)
     ruby-progressbar (1.13.0)
-    securerandom (0.2.2)
-    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)
-    steep (1.3.2)
-      activesupport (>= 5.1)
+    securerandom (0.4.1)
+    simplecov (1.1.1)
+    steep (2.1.0)
+      concurrent-ruby (>= 1.1.10)
       csv (>= 3.0.9)
       fileutils (>= 1.1.0)
       json (>= 2.1.0)
-      language_server-protocol (>= 3.15, < 4.0)
+      language_server-protocol (>= 3.17.0.4, < 4.0)
       listen (~> 3.0)
       logger (>= 1.3.0)
-      parallel (>= 1.0.0)
-      parser (>= 3.1)
+      parser (>= 3.2)
+      prism (>= 0.25.0)
       rainbow (>= 2.2.2, < 4.0)
-      rbs (~> 2.8.0)
+      rbs (~> 4.2)
       securerandom (>= 0.1)
       strscan (>= 1.0.0)
-      terminal-table (>= 2, < 4)
-    strscan (3.0.6)
-    terminal-table (3.0.2)
-      unicode-display_width (>= 1.1.1, < 3)
-    tzinfo (2.0.6)
-      concurrent-ruby (~> 1.0)
-    unicode-display_width (2.4.2)
+      terminal-table (>= 2, < 5)
+      uri (>= 0.12.0)
+    strscan (3.1.8)
+    terminal-table (4.0.0)
+      unicode-display_width (>= 1.1.1, < 4)
+    tsort (0.2.0)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.2.0)
+    uri (1.1.1)
 
 PLATFORMS
   arm64-darwin-22
+  arm64-darwin-23
+  arm64-darwin-24
   x86_64-linux
 
 DEPENDENCIES
   card_dealer!
-  rake (~> 13.0)
-  rspec (~> 3.12)
-  rubocop (~> 1.28)
-  rubocop-rake (~> 0.6)
-  rubocop-rspec (~> 2.19)
+  rake (~> 13.4)
+  rspec (~> 3.13)
+  rubocop (~> 1.90)
+  rubocop-rake (~> 0.7)
+  rubocop-rspec (~> 3.10)
   simplecov
-  simplecov_json_formatter
   steep
 
 BUNDLED WITH
-   2.4.9
+  4.0.17

data/README.md

@@ -1,49 +1,58 @@
 # CardDealer
-[![Gem Version](https://badge.fury.io/rb/card_dealer.svg)](https://badge.fury.io/rb/card_dealer)
-[![Maintainability](https://api.codeclimate.com/v1/badges/a5266ef126fbbe754ff8/maintainability)](https://codeclimate.com/github/svyatov/card_dealer/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/a5266ef126fbbe754ff8/test_coverage)](https://codeclimate.com/github/svyatov/card_dealer/test_coverage)
-[![MIT License](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE.txt)
 
-CardDealer is your go-to gem for creating, shuffling, and dealing decks of cards
-with ease. Whether you're building a poker night app or a virtual bridge club,
-CardDealer has got you covered. Enjoy customizable deck options, smooth
-shuffling algorithms, and simple yet powerful deck manipulation tools that bring
-the classic card game experience to life.
+CardDealer builds, shuffles, and deals decks of playing cards for Ruby card game applications.
 
-## Installation
+[![gem](https://img.shields.io/gem/v/card_dealer)](https://rubygems.org/gems/card_dealer)
+[![CI](https://github.com/svyatov/card_dealer/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/svyatov/card_dealer/actions/workflows/main.yml)
 
-Install the gem and add to the application's Gemfile by executing:
+- **Three deck shapes.** Builds standard 52-card and 36-card decks, and custom decks from any ranks, suits, and number of decks.
+- **Replayable shuffles.** Shuffles with Fisher-Yates from a seed you can pass in or read back from the deck.
+- **40 bytes for 52 cards.** Encodes a deck to a binary string for a database, a cache, or a file.
+- **No runtime dependencies.** Requires Ruby 3.3 or newer and nothing else.
 
-    $ bundle add card_dealer
+Add it to your Gemfile:
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+```bash
+bundle add card_dealer
+```
+
+Then build a deck, shuffle it, and deal a hand:
+
+```ruby
+require "card_dealer"
+
+deck = CardDealer::BuildDeck.standard52.shuffle(42)
+deck.deal(5).map(&:to_s) # => ["8d", "4s", "Ts", "Ac", "6s"]
+deck.size                # => 47
+```
 
-    $ gem install card_dealer
+A card prints as its rank (2 to 9, T, J, Q, K, A) followed by its suit (c, d, h, s).
 
 ## Usage
 
-### Creating a standard 52-card deck
+### Building a standard 52-card deck
 
-To create a standard 52-card deck, use the `CardDealer::BuildDeck.standard52` method:
+To build a 52-card deck, call `CardDealer::BuildDeck.standard52`:
 
 ```ruby
 deck = CardDealer::BuildDeck.standard52
-puts deck.cards
+deck.size          # => 52
+deck.to_a.first(3) # => ["2c", "3c", "4c"]
 ```
 
-### Creating a standard 36-card deck
+### Building a standard 36-card deck
 
-To create a standard 36-card deck, use the `CardDealer::BuildDeck.standard36` method:
+To build a 36-card deck, call `CardDealer::BuildDeck.standard36`:
 
 ```ruby
 deck = CardDealer::BuildDeck.standard36
-puts deck.cards
+deck.size          # => 36
+deck.to_a.first(3) # => ["6c", "7c", "8c"]
 ```
 
-### Creating a custom deck of cards
+### Building a custom deck
 
-To create a custom deck of cards, use the `CardDealer::BuildDeck.custom` method.
-You can specify the number of decks, cards per suit, ranks, and suits:
+To build a custom deck, call `CardDealer::BuildDeck.custom`. `ranks` takes `:highest`, `:lowest`, or an array such as `%w[2 4 6 8 T]`. `suits` takes `:all` or an array such as `%w[d h]`:
 
 ```ruby
 deck = CardDealer::BuildDeck.custom(
@@ -52,87 +61,80 @@ deck = CardDealer::BuildDeck.custom(
   ranks: :highest,
   suits: %w[c d]
 )
-puts deck.cards
+deck.size          # => 20
+deck.to_a.first(6) # => ["Tc", "Jc", "Qc", "Kc", "Ac", "Td"]
 ```
 
 ### Shuffling and dealing cards
 
-The `CardDealer::Deck` class provides methods for shuffling and dealing cards:
+`CardDealer::Deck#shuffle` takes an optional seed. Without one, it generates a seed and stores it in `seed`, so you can replay the shuffle later:
 
 ```ruby
 deck = CardDealer::BuildDeck.standard52
 deck.shuffle
-hand = deck.deal(5)
-puts hand
+seed = deck.seed    # keep this to replay the shuffle
+hand = deck.deal(5) # => five CardDealer::Card objects
+deck.size           # => 47
 ```
 
-You can also burn cards before dealing:
+To burn cards before dealing, pass `burn:`:
 
 ```ruby
-deck = CardDealer::BuildDeck.standard52
-deck.shuffle
+deck = CardDealer::BuildDeck.standard52.shuffle(42)
 hand = deck.deal(3, burn: 1)
-puts hand
-```
-
-To burn cards without dealing, just pass `0` as the number of cards to deal:
-
-```ruby
-deck = CardDealer::BuildDeck.standard52
-deck.shuffle
-hand = deck.deal(0, burn: 1)
-puts hand
+hand.map(&:to_s)              # => ["4s", "Ts", "Ac"]
+deck.burned_cards.map(&:to_s) # => ["8d"]
 ```
 
-Burned cards are stored within the deck and can be accessed via `burned_cards` method:
+To burn cards without dealing, deal `0` cards:
 
 ```ruby
-deck = CardDealer::BuildDeck.standard52
-deck.shuffle
+deck = CardDealer::BuildDeck.standard52.shuffle(42)
 deck.deal(0, burn: 10)
-puts deck.burned_cards
+deck.burned_cards.size # => 10
+deck.size              # => 42
 ```
 
-### Encoding a deck of cards as a binary string
+### Encoding a deck as a binary string
 
-To encode a deck of cards as a binary string, use the `CardDealer::BinaryDeck.encode` method.
-This is useful if you'd like to store a deck of cards in a database, cache, or a file:
+To encode a deck, call `CardDealer::BinaryDeck.encode` or `Deck#to_binary_s`. Each card takes 6 bits, after a 1, 2, or 4 byte header carrying the card count:
 
 ```ruby
-deck = CardDealer::BuildDeck.standard52
-encoded_deck = CardDealer::BinaryDeck.encode(deck)
+deck = CardDealer::Deck.new([CardDealer::Card.new("As"), CardDealer::Card.new("Td")])
+encoded = CardDealer::BinaryDeck.encode(deck)
 # - or -
-encoded_deck = deck.to_binary_s
-puts encoded_deck
+encoded = deck.to_binary_s
+encoded # => "\x02\xCDP"
 ```
 
-### Decoding a binary string into a deck of cards
+### Decoding a binary string into a deck
 
-To decode a binary string into a deck of cards, use the `CardDealer::BinaryDeck.decode` method:
+To decode a binary string, call `CardDealer::BinaryDeck.decode` or `Deck.from_binary`:
 
 ```ruby
-encoded_deck = "\x02\xCDP" # binary string
-decoded_deck = CardDealer::BinaryDeck.decode(encoded_deck)
+encoded = "\x02\xCDP"
+deck = CardDealer::BinaryDeck.decode(encoded)
 # - or -
-decoded_deck = CardDealer::Deck.from_binary(encoded_deck)
-puts decoded_deck.cards
+deck = CardDealer::Deck.from_binary(encoded)
+deck.to_a # => ["As", "Td"]
 ```
 
 ## 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.
+After checking out the repo, run `bin/setup` to install dependencies. Run `bundle exec rake` to run the type checker, the linter, and the tests. Run `bin/console` for an interactive prompt.
 
-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).
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `lib/card_dealer/version.rb`. Add the release to `CHANGELOG.md`. Push a tag such as `v0.3.0`, which cuts the release.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/svyatov/card_dealer.
+Read [CONTRIBUTING.md](CONTRIBUTING.md) for setup, tests, and how to open a pull request. To report a vulnerability, follow [SECURITY.md](SECURITY.md).
+
+## Help and status
+
+Ask questions and report bugs in [GitHub issues](https://github.com/svyatov/card_dealer/issues).
+
+CardDealer is actively maintained by one person. Releases happen when there is something to release.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+CardDealer is available under the [MIT License](LICENSE.txt). Releases are listed in [CHANGELOG.md](CHANGELOG.md).

data/SECURITY.md

@@ -0,0 +1,14 @@
+# Security policy
+
+## Supported versions
+
+The latest release on [rubygems.org](https://rubygems.org/gems/card_dealer) receives security fixes. Older releases do not.
+
+## Reporting a vulnerability
+
+Do not open a public issue for a vulnerability. Use one of these private channels:
+
+- [GitHub private vulnerability reporting](https://github.com/svyatov/card_dealer/security/advisories/new)
+- Email to leonid@svyatov.com
+
+You will get a reply within 14 days. A fix ships as a new gem release, and the advisory is published after it.

data/card_dealer.gemspec

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative "lib/card_dealer/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "card_dealer"
+  spec.version = CardDealer::VERSION
+  spec.authors = ["Leonid Svyatov"]
+  spec.email = ["leonid@svyatov.com"]
+
+  spec.summary = "Builds, shuffles, and deals decks of playing cards."
+  spec.description = <<~DESC
+    CardDealer builds standard 52-card and 36-card decks and custom decks,
+    shuffles them with a seedable Fisher-Yates shuffle, deals and burns cards,
+    and encodes a deck to a compact binary string. It has no runtime
+    dependencies and requires Ruby 3.3 or newer.
+  DESC
+  spec.homepage = "https://github.com/svyatov/card_dealer"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.3.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/card_dealer/version.rb

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

data/lib/card_dealer.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "set"
-
 module CardDealer
   class Error < StandardError; end
 end

data/sig/card_dealer/card.rbs

@@ -20,6 +20,16 @@ module CardDealer
 
     def to_s: -> String
 
+    def eql?: (untyped other) -> bool
+
+    def hash: -> Integer
+
+    def ==: (untyped other) -> bool
+
+    def <=>: (untyped other) -> Integer?
+
+    def inspect: -> String
+
     private
 
     def validate_card!: -> void

metadata

@@ -1,21 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: card_dealer
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Leonid Svyatov
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-01 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: |
-  CardDealer is your go-to gem for creating, shuffling, and dealing decks of
-  cards with ease. Whether you're building a poker night app or a virtual
-  bridge club, CardDealer has got you covered. Enjoy customizable deck
-  options, smooth shuffling algorithms, and simple yet powerful deck
-  manipulation tools that bring the classic card game experience to life.
+  CardDealer builds standard 52-card and 36-card decks and custom decks,
+  shuffles them with a seedable Fisher-Yates shuffle, deals and burns cards,
+  and encodes a deck to a compact binary string. It has no runtime
+  dependencies and requires Ruby 3.3 or newer.
 email:
 - leonid@svyatov.com
 executables: []
@@ -25,12 +23,16 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
+- SECURITY.md
 - Steepfile
+- card_dealer.gemspec
 - lib/card_dealer.rb
 - lib/card_dealer/binary_deck.rb
 - lib/card_dealer/build_deck.rb
@@ -49,9 +51,8 @@ licenses:
 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
+  changelog_uri: https://github.com/svyatov/card_dealer/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -59,15 +60,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.9
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
-summary: A delightful card dealing companion for your digital table.
+summary: Builds, shuffles, and deals decks of playing cards.
 test_files: []