fiftytwo 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6c00da0e98ce49dd9546e2936caf0f8b19dea1353ff953e35edf0fa4e8856e97
+  data.tar.gz: bd0ec3c7c3b7bb0305c3b9b8ed534865eee21dd47a9b0e61e69655d9a7d3c8ff
+SHA512:
+  metadata.gz: c2dbb21639b82fe689c8de2ef7033783e9a5ade2fd35372f7e763b09464cec1bc46bac943cd9274499621143922fe7eb7c0d34426b9430f698ea8dcc120b3216
+  data.tar.gz: cebde92a30ff69c21a3244e29588eef325431c0d684cddbb2b7a66c4bf34846a397b8529edc87397862512fbde75bd9a0960ff61c0f83d86e569211aecef6d83

data/.github/workflows/gem-push.yml

@@ -0,0 +1,31 @@
+name: Ruby Gem
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.github/workflows/ruby.yml

@@ -0,0 +1,35 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rspec

data/.gitignore

@@ -0,0 +1,7 @@
+**.DS_Store
+*.gem
+Gemfile.lock
+.bundle
+.yardoc
+doc
+coverage

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.yardopts

@@ -0,0 +1 @@
+--protected lib/**/*.rb

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at kevinstuffandthings@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

data/Gemfile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2021 Kevin McDonald
+
+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,151 @@
+# FiftyTwo ![Build Status](https://github.com/kevinstuffandthings/fiftytwo/actions/workflows/ruby.yml/badge.svg) [![Gem Version](https://badge.fury.io/rb/fiftytwo.svg)](https://badge.fury.io/rb/fiftytwo)
+
+A [standard 52-card deck](https://en.wikipedia.org/wiki/Standard_52-card_deck), written in Ruby.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+# update with the version of your choice
+gem 'fiftytwo'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install fiftytwo
+```
+
+## Usage
+Get a deck of cards:
+```ruby
+require "fiftytwo"
+
+deck = FiftyTwo::Deck.standard
+# => #<FiftyTwo::Deck:0x00007f905c154b10 @cards=[...]>
+
+deck.count
+# => 52
+```
+
+Examine how neatly organized the cards are, and then do something about it:
+```ruby
+deck[0..7].map(&:to_s)
+# => ["2 of Clubs", "2 of Diamonds", "2 of Hearts", "2 of Spades", "3 of Clubs", "3 of Diamonds", "3 of Hearts", "3 of Spades"]
+
+deck.shuffle! # you can always deck.sort! later
+deck[0..7].map(&:to_s)
+# => ["5 of Diamonds", "Jack of Spades", "Ace of Hearts", "6 of Hearts", "9 of Hearts", "2 of Diamonds", "3 of Spades", "7 of Spades"]
+```
+
+Take a deep dive into a card:
+```ruby
+card = deck.first
+# => #<FiftyTwo::Card:0x00007f905c154548 ...>
+
+card.rank
+#  => #<FiftyTwo::Rank:0x00007f9056a04068 @value=5, @name="5", @category=:pip>
+
+card.suit
+# => #<FiftyTwo::Suit:0x00007f9056a1f138 @name="diamonds", @color=#<FiftyTwo::Suit::Color:0x00007f9056a1f638 @name="red", @rgb="ff0000">, @symbol="♦">
+
+card.red?
+# => true
+
+card.spades?
+# => false
+
+card.pip?
+# => true
+
+card.king?
+# => false
+```
+
+Look for types of cards in your deck, as they are currently ordered:
+```ruby
+deck.kings.count
+# => 4
+
+deck.faces.reds.count
+# => 6
+
+deck.faces.reds.first.name
+# => "Queen of Hearts"
+
+deck.locate("AS").name
+# => "Ace of Spades"
+
+deck.locate("10C").name
+# => "Ten of Clubs"
+```
+
+Draw a card from the deck, and give it back later:
+```ruby
+deck.shuffle!
+card = deck.draw
+# => #<FiftyTwo::Card:0x00007fb3d2284960 ...>
+
+deck.count
+# => 51
+card.name
+# => "9 of Diamonds"
+
+deck << card
+deck.count
+# => 52
+deck.last.name
+# => "9 of Diamonds"
+```
+
+Deal some cards from the deck to yourself and a friend:
+```ruby
+my_hand = FiftyTwo::Hand.new
+# => #<FiftyTwo::Hand:0x00007fb3d50ca7c0 @cards=[]>
+your_hand = FiftyTwo::Hand.new
+# => #<FiftyTwo::Hand:0x00007fb3d21c68c0 @cards=[]>
+
+deck.deal([my_hand, your_hand], hand_size: 5)
+"Deck has #{deck.count} cards, I have #{my_hand.count} cards, you have #{your_hand.count} cards"
+# => "Deck has 42 cards, I have 5 cards, you have 5 cards"
+
+puts my_hand.render, your_hand.render # by the way renderings are colored red/black in your terminal, just like the suit!
+ 3♦  4♠  5♦  7♥  2♣
+ 6♠  A♦  5♠ 10♦  Q♣
+```
+
+Hands, just like the deck, can be shuffled, sorted, searched, etc:
+```ruby
+your_hand.sort!
+puts your_hand.render
+ 5♠  6♠ 10♦  Q♣  A♦
+
+your_hand.aces.count
+# => 1
+```
+
+Pass your cards around:
+```ruby
+my_hand.transfer("4S", your_hand)
+puts my_hand.render, your_hand.render
+ 3♦  5♦  7♥  2♣
+ 5♠  6♠ 10♦  Q♣  A♦  4♠
+
+your_hand.transfer("QC") # goes back to the deck
+puts my_hand.render, your_hand.render
+ 3♦  5♦  7♥  2♣
+ 5♠  6♠ 10♦  A♦  4♠
+
+deck.count
+# => 43
+```
+
+# Problems?
+Please submit an [issue](https://github.com/kevinstuffandthings/fiftytwo/issues).
+We'll figure out how to get you up and running with FiftyTwo as smoothly as possible.

data/Rakefile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "bundler/gem_tasks"
+require "standard/rake"
+
+Dir.glob("lib/tasks/*.rake").each { |r| load r }

data/fiftytwo.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "fiftytwo/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "fiftytwo"
+  spec.version = FiftyTwo::VERSION
+  spec.authors = ["Kevin McDonald"]
+  spec.email = ["kevinstuffandthings@gmail.com"]
+  spec.summary = "A deck of cards, written in Ruby"
+  spec.description = spec.summary
+  spec.homepage = "https://github.com/kevinstuffandthings/fiftytwo"
+  spec.license = "MIT"
+
+  spec.files = `git ls-files -z`.split("\x0")
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport"
+  spec.add_dependency "colorize"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "standard"
+  spec.add_development_dependency "yard"
+end

data/lib/fiftytwo.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "fiftytwo/version"
+require "active_support"
+require "active_support/core_ext"
+
+%w[rank suit card hand deck].each { |f| require "fiftytwo/#{f}" }
+
+# FiftyTwo
+module FiftyTwo
+end

data/lib/fiftytwo/card.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require "colorize"
+
+module FiftyTwo
+  class Card
+    include Comparable
+
+    attr_reader :deck, :rank, :suit
+    delegate :color, to: :suit
+
+    def initialize(deck, rank, suit)
+      @deck = deck
+      @rank = rank
+      @suit = suit
+    end
+
+    def code
+      "#{rank.code}#{suit.code}"
+    end
+
+    def to_s
+      "#{rank} of #{suit}"
+    end
+    alias_method :name, :to_s
+
+    def identifier
+      "#{rank.identifier}#{suit.identifier}"
+    end
+
+    def render
+      code.rjust(3).send(suit.color.name)
+    end
+
+    def <=>(other)
+      [rank, suit] <=> [other.rank, other.suit]
+    end
+
+    def method_missing(name, **args, &block)
+      return super unless name.to_s.ends_with?("?")
+
+      attributes.each do |attribute|
+        return attribute.send(name) if attribute.respond_to?(name)
+      end
+
+      super
+    end
+
+    def respond_to_missing?(name, include_private = false)
+      return false unless name.to_s.ends_with?("?")
+      return false unless attributes.any? { |a| a.respond_to?(name) }
+    end
+
+    private
+
+    def attributes
+      [rank, suit]
+    end
+  end
+end