hands 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake'
+gem 'rspec', '~>2.7.0'

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2011 Sam Soffes
+
+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/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+desc 'Run specs'
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = ['--color']
+end

data/Readme.markdown

@@ -0,0 +1,73 @@
+# Hands
+
+Simple library for calculating poker hands.
+
+Currently this gem is very limited. I plan on adding outs, odds, and other actually useful stuff. I started writing this on a plane as a personal challenge. It's current state is crude, although tested and works.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+``` ruby
+gem 'hands'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hands
+
+## Usage
+
+``` ruby
+# Best hand detection
+straight = Hands::Hand.new
+straight << Hands::Card['A', :hearts]
+straight << Hands::Card[2, :spades]
+straight << Hands::Card[3, :diamonds]
+straight << Hands::Card[4, :hearts]
+straight << Hands::Card[5, :clubs]
+straight.best_hand[:type] # 'straight'
+
+# Hand comparison
+pair = Hands::Hand.new
+pair << Hands::Card[2, :hearts]
+pair << Hands::Card[2, :clubs]
+pair << Hands::Card[3, :diamonds]
+pair << Hands::Card[4, :hearts]
+pair << Hands::Card[5, :clubs]
+
+flush = Hands::Hand.new
+flush << Hands::Card[6, :hearts]
+flush << Hands::Card[7, :hearts]
+flush << Hands::Card[8, :hearts]
+flush << Hands::Card[2, :hearts]
+flush << Hands::Card[4, :hearts]
+flush > pair # true
+
+# Card comparison
+card1 = Hands::Card.new(:value => 2, :suite => :hearts)
+card2 = Hands::Card.new(:value => 3, :suite => :clubs)
+card2 > card1 # true
+```
+
+## Running Tests
+
+Running and reading the tests is (for now) the best way to see the functionality of this gem.
+
+```
+$ bundle
+$ bundle exec rake spec
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Write a passing spec
+4. Commit your changes (`git commit -am 'Added some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

data/hands.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/hands/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ['Sam Soffes']
+  gem.email         = ['sam@samsoff.es']
+  gem.description   = 'Simple library for various poker hands calculations.'
+  gem.summary       = 'Simple library for various poker hands calculations.'
+  gem.homepage      = 'http://github.com/samsoffes/hands'
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = 'hands'
+  gem.require_paths = ['lib']
+  gem.version       = Hands::VERSION
+end

data/lib/hands/card.rb

@@ -0,0 +1,90 @@
+module Hands
+  class Card
+    include Comparable
+
+    attr_accessor :suite
+    attr_accessor :value
+
+    def self.[](first = nil, second = nil)
+      self.new(first, second)
+    end
+
+    def initialize(first = nil, suite = nil)
+      # Value provided
+      if first.is_a?(Integer) or first.is_a?(String)
+        self.value = first
+
+      # Hash provided
+      elsif first.is_a?(Hash)
+        self.value = first[:value] if first[:value]
+        self.suite = first[:suite] if first[:suite]
+      end
+      
+      # Set suite
+      self.suite = suite if suite
+    end
+
+    def value=(val)
+      # Integer
+      if val.is_a?(Integer)
+        # Number range
+        if val > 0 and val <= 10
+          @value = val
+          return
+
+        # Face card or ace range
+        elsif val > 10 and val < 15
+          @value = VALUES[val - 2]
+          return
+        end
+
+      # String
+      elsif val.is_a?(String) and VALUES.include?(val.downcase)
+        @value = val.downcase
+        return
+      end
+
+      # Invalid
+      @value = nil
+    end
+
+    def inspect
+      if self.is_valid?
+        "#{super} #{self.description}"
+      else
+        super
+      end
+    end
+
+    def is_valid?
+      SUITES.include?(self.suite.to_s) and VALUES.include?(self.value.to_s.downcase)
+    end
+
+    def is_invalid?
+      !self.is_valid?
+    end
+
+    def description
+      if self.is_valid?
+        "#{VALUE_DESCRIPTIONS[self.value_index].capitalize} of #{self.suite.to_s.capitalize}"
+      else
+        'invalid'
+      end
+    end
+
+    def <=>(other_card, check_suite = false)
+      # TODO: Handle invalid cards
+      result = self.value_index <=> other_card.value_index
+      return self.suite_index <=> other_card.suite_index if result == 0 and check_suite
+      result
+    end
+
+    def suite_index
+      SUITES.index(self.suite.to_s.downcase)
+    end
+
+    def value_index
+      VALUES.index(self.value.to_s.downcase)
+    end
+  end
+end

data/lib/hands/hand.rb

@@ -0,0 +1,136 @@
+module Hands
+  class Hand
+    include Comparable
+
+    attr_accessor :cards
+
+    def cards
+      @cards ||= []
+    end
+        
+    def <=>(other_hand)
+      response = (self.hand_index <=> other_hand.hand_index)
+
+      # If the hands tie, see which is higher (i.e. higher pair)
+      if response == 0
+        self.cards <=> other_hand.cards
+      else
+        response
+      end
+    end
+
+    def <<(card)
+      self.cards << card
+    end
+
+    def suites
+      self.cards.collect(&:suite).uniq
+    end
+
+    def best_hand
+      response = {}
+      HAND_ORDER.reverse.each do |type|
+        cards = self.send(type.to_sym)
+        next unless cards
+        response[:type] = type
+        response[:cards] = cards
+        break
+      end
+      response
+    end
+
+    def high_card
+      self.cards.sort.reverse
+    end
+
+    def pair
+      self.pairs(1)
+    end
+
+    def two_pair
+      self.pairs(2)
+    end
+
+    def three_of_a_kind
+      nil
+    end
+
+    def straight
+      return nil unless self.cards.length == 5
+      cs = self.cards.sort.reverse
+
+      # Ace's low
+      if cs.first.value == 'a' and cs[1].value == 5
+        # Move ace to end
+        ace = cs.first
+        cs = cs[1..4]
+        cs << ace
+
+        # Check succession
+        csr = cs.reverse
+        4.times do |i|
+          next if i == 0
+          return nil unless csr[i].value_index == i - 1
+        end
+
+      # Normal
+      else
+        # Check range
+        return nil unless cs.first.value_index - cs.last.value_index == 4
+
+        # Check succession
+        4.times do |i|        
+          return nil unless cs[i].value_index == cs[i + 1].value_index + 1
+        end
+      end
+      cs
+    end
+    
+    def flush
+      # If all of the cards are the same suite, we have a flush
+      return nil unless self.suites.length == 1
+      self.cards.sort.reverse
+    end
+    
+    def full_house
+      # TODO: Implement
+      nil
+    end
+    
+    def four_of_a_kind
+      # TODO: Implement
+      nil
+    end
+    
+    def straight_flush
+      # TODO: Implement
+      nil
+    end
+    
+    protected
+
+    def hand_index
+      best = self.best_hand
+      return -1 if best.nil?
+      HAND_ORDER.index(best[:type].to_s)
+    end
+
+    def duplicates
+      pairs = self.cards.collect(&:value)
+      pairs.uniq.select{ |e| (pairs - [e]).size < pairs.size - 1 }
+    end
+
+    def pairs(min)
+      dupes = self.duplicates
+      return nil if dupes.length < min
+
+      hand = self.cards.select do |card|
+        dupes.include?(card.value)
+      end
+
+      hand = hand.sort.reverse
+      hand << (self.cards - hand).sort.reverse
+      hand.flatten
+    end
+  end
+end

data/lib/hands/version.rb

@@ -0,0 +1,3 @@
+module Hands
+  VERSION = '0.0.1'
+end

data/lib/hands.rb

@@ -0,0 +1,12 @@
+require 'hands/version'
+require 'hands/card'
+require 'hands/hand'
+
+module Hands
+  SUITES = %w{ clubs diamonds hearts spades }
+  VALUES = %w{ 2 3 4 5 6 7 8 9 10 j q k a }
+  VALUE_DESCRIPTIONS = %w{ two three four five six seven eight nine ten jack queen king ace }
+
+  # See http://www.pagat.com/poker/rules/ranking.html
+  HAND_ORDER = %w{ high_card pair two_pair three_of_a_kind straight flush full_house four_of_a_kind straight_flush }
+end

data/spec/models/card_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe Hands::Card do
+  it 'should validate cards' do
+    card = Hands::Card.new
+    card.is_valid?.should eq(false)
+    card.is_invalid?.should eq(true)
+    
+    card.suite = :hearts
+    card.is_valid?.should eq(false)
+    
+    card.value = 9
+    card.is_valid?.should eq(true)
+    
+    card.suite = 17
+    card.is_valid?.should eq(false)
+  end
+  
+  it 'should allow for integers instead of characters for high cards' do
+    card1 = Hands::Card.new(:value => 11, :suite => :clubs)
+    
+    card1.is_valid?.should eq(true)
+    card1.value.should eq('j')
+    
+    card2 = Hands::Card.new(:value => 'j', :suite => :clubs)
+    card2.should eq(card1)
+  end
+  
+  it 'should be comparable' do
+    card1 = Hands::Card.new(:value => 2, :suite => :hearts)
+    card2 = Hands::Card.new(:value => 3, :suite => :clubs)
+    
+    (card2 > card1).should eq(true)
+    (card1 < card2).should eq(true)
+    
+    card1.value = 3
+    (card1 == card2).should eq(true)
+    (card1.<=>(card2, true)).should eq(1)
+    (card2.<=>(card1, true)).should eq(-1)
+  end
+  
+  it 'should be sortable' do
+    c2 = Hands::Card.new(:value => 2, :suite => :hearts)
+    c3 = Hands::Card.new(:value => 3, :suite => :hearts)
+    c4 = Hands::Card.new(:value => 4, :suite => :hearts)
+    c5 = Hands::Card.new(:value => 5, :suite => :hearts)
+    c6 = Hands::Card.new(:value => 6, :suite => :hearts)
+    c7 = Hands::Card.new(:value => 7, :suite => :hearts)
+    c8 = Hands::Card.new(:value => 8, :suite => :hearts)
+    c9 = Hands::Card.new(:value => 9, :suite => :hearts)
+    c10 = Hands::Card.new(:value => 10, :suite => :hearts)
+    cJ = Hands::Card.new(:value => 'j', :suite => :hearts)
+    cQ = Hands::Card.new(:value => 'q', :suite => :hearts)
+    cK = Hands::Card.new(:value => 'k', :suite => :hearts)
+    cA = Hands::Card.new(:value => 'a', :suite => :hearts)
+    
+    cards = [c2, c3, c4, c5, c6, c7, c8, c9, c10, cJ, cQ, cK, cA]
+    cards.sort.should eq(cards)    
+  end
+end

data/spec/models/hand_spec.rb

@@ -0,0 +1,147 @@
+require 'spec_helper'
+
+describe Hands::Hand do
+  it 'should order different types of hands' do
+    pair = Hands::Hand.new
+    pair << Hands::Card[2, :hearts]
+    pair << Hands::Card[2, :clubs]
+    
+    flush = Hands::Hand.new
+    flush << Hands::Card[6, :hearts]
+    flush << Hands::Card[7, :hearts]
+    flush << Hands::Card[8, :hearts]
+    flush << Hands::Card[2, :hearts]
+    flush << Hands::Card[4, :hearts]
+    (flush > pair).should eq(true)
+  end
+  
+  it 'should order same types of hands' do
+    small_pair = Hands::Hand.new
+    small_pair << Hands::Card[2, :hearts]
+    small_pair << Hands::Card[2, :clubs]
+    
+    large_pair = Hands::Hand.new
+    large_pair << Hands::Card['A', :hearts]
+    large_pair << Hands::Card['A', :clubs]
+    (large_pair > small_pair).should eq(true)
+    
+    small_kicker = Hands::Hand.new
+    small_kicker << Hands::Card['A', :spades]
+    small_kicker << Hands::Card['A', :diamonds]
+    small_kicker << Hands::Card[2, :diamonds]
+    small_kicker << Hands::Card[3, :diamonds]
+    small_kicker << Hands::Card[4, :diamonds]
+    
+    big_kicker = Hands::Hand.new
+    big_kicker << Hands::Card['A', :hearts]
+    big_kicker << Hands::Card['A', :clubs]
+    big_kicker << Hands::Card[10, :diamonds]
+    big_kicker << Hands::Card[9, :diamonds]
+    big_kicker << Hands::Card[7, :diamonds]
+    (big_kicker > small_kicker).should eq(true)
+  end
+  
+  it 'should collect suites' do
+    hand = Hands::Hand.new
+    hand << Hands::Card[2, :hearts]
+    hand << Hands::Card[2, :clubs]
+    hand.suites.should eq([:hearts, :clubs])
+    
+    hand << Hands::Card[3, :clubs]
+    hand.suites.should eq([:hearts, :clubs])
+  end
+  
+  it 'should recognize high card' do
+    hand = Hands::Hand.new
+    hand << Hands::Card[2, :hearts]
+    hand << Hands::Card[9, :clubs]
+    hand << Hands::Card[7, :hearts]
+    hand << Hands::Card['a', :spades]
+    hand << Hands::Card[4, :diamonds]
+    hand.high_card.collect(&:value).should eq(['a', 9, 7, 4, 2])
+    hand.pair.should eql(nil)
+    hand.two_pair.should eql(nil)
+  end
+  
+  it 'should recognize a pair' do
+    hand = Hands::Hand.new
+    hand << Hands::Card[9, :hearts]
+    hand << Hands::Card[9, :clubs]
+    hand << Hands::Card[7, :hearts]
+    hand << Hands::Card[2, :spades]
+    hand << Hands::Card[4, :diamonds]
+    hand.pair.collect(&:value).should eq([9, 9, 7, 4, 2])
+    hand.two_pair.should eql(nil)
+  end
+  
+  it 'should recognize two pair'  do
+    hand = Hands::Hand.new
+    hand << Hands::Card[7, :hearts]
+    hand << Hands::Card[7, :spades]
+    hand << Hands::Card[4, :diamonds]
+    hand << Hands::Card[9, :hearts]
+    hand << Hands::Card[9, :clubs]
+    hand.two_pair.collect(&:value).should eq([9, 9, 7, 7, 4])
+    hand.two_pair.should eql(hand.pair)
+  end
+   
+  it 'should recognize three of a kind'
+  
+  it 'should recognize a straight' do
+    hand1 = Hands::Hand.new
+    hand1 << Hands::Card[2, :hearts]
+    hand1 << Hands::Card[3, :spades]
+    hand1 << Hands::Card[4, :diamonds]
+    hand1 << Hands::Card[5, :hearts]
+    hand1 << Hands::Card[6, :clubs]
+    hand1.best_hand[:type].should eq('straight')
+    
+    hand2 = Hands::Hand.new
+    hand2 << Hands::Card['A', :hearts]
+    hand2 << Hands::Card[2, :spades]
+    hand2 << Hands::Card[3, :diamonds]
+    hand2 << Hands::Card[4, :hearts]
+    hand2 << Hands::Card[5, :clubs]
+    hand2.best_hand[:type].should eq('straight')
+    
+    hand3 = Hands::Hand.new
+    hand3 << Hands::Card[10, :hearts]
+    hand3 << Hands::Card['J', :spades]
+    hand3 << Hands::Card['Q', :diamonds]
+    hand3 << Hands::Card['K', :hearts]
+    hand3 << Hands::Card['A', :clubs]
+    hand3.best_hand[:type].should eq('straight')
+    
+    hand4 = Hands::Hand.new
+    hand4 << Hands::Card['J', :spades]
+    hand4 << Hands::Card['Q', :diamonds]
+    hand4 << Hands::Card['K', :hearts]
+    hand4 << Hands::Card['A', :clubs]
+    hand4 << Hands::Card[2, :hearts]  
+    hand4.best_hand[:type].should eq('high_card')
+  end
+  
+  it 'should recognize a flush' do
+    hand = Hands::Hand.new
+    hand << Hands::Card[6, :hearts]
+    hand << Hands::Card[7, :hearts]
+    hand << Hands::Card[8, :hearts]
+    hand << Hands::Card[2, :hearts]
+    hand << Hands::Card[4, :hearts]
+    hand.best_hand[:type].should eq('flush')
+  end
+  
+  it 'should recognize a full house'
+  it 'should recognize four of a kind'
+  it 'should recognize a straight flush'
+  
+  it 'should recognize the best hand'  do
+    hand = Hands::Hand.new
+    hand << Hands::Card[7, :hearts]
+    hand << Hands::Card[7, :spades]
+    hand << Hands::Card[4, :diamonds]
+    hand << Hands::Card[9, :hearts]
+    hand << Hands::Card[9, :clubs]
+    hand.best_hand[:type].should eq('two_pair')
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'rspec'
+require 'hands'

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: hands
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Sam Soffes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-23 00:00:00.000000000 Z
+dependencies: []
+description: Simple library for various poker hands calculations.
+email:
+- sam@samsoff.es
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- Rakefile
+- Readme.markdown
+- hands.gemspec
+- lib/hands.rb
+- lib/hands/card.rb
+- lib/hands/hand.rb
+- lib/hands/version.rb
+- spec/models/card_spec.rb
+- spec/models/hand_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/samsoffes/hands
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Simple library for various poker hands calculations.
+test_files:
+- spec/models/card_spec.rb
+- spec/models/hand_spec.rb
+- spec/spec_helper.rb