hands 0.2.1 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c2a3b037d84f5c0fbecc3d0d2d7b5828c0aeb00f
+  data.tar.gz: 6f697d707fafae24181d8fc5f0fdc8e69634ca91
+SHA512:
+  metadata.gz: ef5243a890cfb119b0aed00020f7b335778bbfd3e96e2465cbccc5319927e46ce4ff7acd1752a3f5ad2ec0db2f769c1e87dbbf659c5acc071c8046fa2324aa31
+  data.tar.gz: 0878f55fddf5c7ec70b03106327c961808e46de9104143e272469697ab8d81822db7876234f0fb74903ecda591ea67b1a3426033511a8aa9600a2a126523f33b

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.ruby-version

data/.travis.yml

@@ -1,3 +1,7 @@
 language: ruby
+bundler_args: --without development
 rvm:
+  - 1.8.7
   - 1.9.3
+  - 2.0.0
+  - jruby-19mode

data/Contributing.markdown

@@ -0,0 +1,19 @@
+## Submitting a Pull Request
+
+1. [Fork the repository.][fork]
+2. [Create a topic branch.][branch]
+3. Add tests for your unimplemented feature or bug fix.
+4. Run `bundle exec rake`. If your tests pass, return to step 3.
+5. Implement your feature or bug fix.
+6. Run `bundle exec rake`. If your tests fail, return to step 5.
+7. Run `open coverage/index.html`. If your changes are not completely covered
+   by your tests, return to step 3.
+8. Add documentation for your feature or bug fix.
+9. Run `bundle exec rake doc`. If your changes are not 100% documented, go
+   back to step 8.
+10. Add, commit, and push your changes.
+11. [Submit a pull request.][pr]
+
+[fork]: http://help.github.com/fork-a-repo/
+[branch]: http://learn.github.com/p/branching.html
+[pr]: http://help.github.com/send-pull-requests/

data/Gemfile

@@ -3,14 +3,17 @@ source 'https://rubygems.org'
 gemspec
 
 # Utility
-gem 'rake'
+gem 'rake', :group => [:development, :test]
 
 # Documentation
-gem 'yard'
-gem 'redcarpet'
+group :development do
+  gem 'yard'
+  gem 'redcarpet', :platform => :ruby
+end
 
+# Testing
 group :test do
   gem 'minitest'
-  gem 'minitest-wscolor'
-  gem 'simplecov'
+  gem 'minitest-wscolor' if RUBY_VERSION >= '1.9.3'
+  gem 'simplecov', :require => false
 end

data/Rakefile

@@ -5,7 +5,7 @@ Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
   t.pattern = 'test/**/*_test.rb'
 end
-task default: :test
+task :default => :test
 
 task :coverage do
   `open coverage/index.html`

data/Readme.markdown

@@ -4,8 +4,6 @@ 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.
 
-[![Build Status](https://travis-ci.org/soffes/hands.png?branch=master)](undefined) [![Dependency Status](https://gemnasium.com/soffes/hands.png)](https://gemnasium.com/soffes/hands) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/soffes/hands)
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -58,20 +56,12 @@ card2 = Hands::Card.new(:value => 3, :suit => :clubs)
 card2 > card1 # true
 ```
 
-## Running Tests
+## Supported Ruby Versions
 
-Running and reading the tests is (for now) the best way to see the functionality of this gem.
+Hands is tested under 1.9.3, 2.0.0, and JRuby (1.9 mode).
 
-```
-$ bundle exec rake
-```
+[![Build Status](https://travis-ci.org/soffes/hands.png?branch=master)](https://travis-ci.org/soffes/hands)
 
 ## Contributing
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Write passing specs
-4. Write documentation
-5. Commit your changes (`git commit -am 'Added some feature'`)
-6. Push to the branch (`git push origin my-new-feature`)
-7. Create new Pull Request
+See the [contributing guide](Contributing.markdown).

data/hands.gemspec

@@ -7,6 +7,7 @@ Gem::Specification.new do |gem|
   gem.description   = 'Simple library for various poker hands calculations.'
   gem.summary       = 'Simple library for various poker hands calculations.'
   gem.homepage      = 'http://github.com/soffes/hands'
+  gem.license       = 'MIT'
 
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   gem.files         = `git ls-files`.split("\n")
@@ -14,4 +15,6 @@ Gem::Specification.new do |gem|
   gem.name          = 'hands'
   gem.require_paths = ['lib']
   gem.version       = Hands::VERSION
+
+  gem.required_ruby_version = '>= 1.9.2'
 end

data/lib/hands.rb

@@ -1,3 +1,5 @@
+# encoding: UTF-8
+
 require 'hands/version'
 require 'hands/card'
 require 'hands/hand'
@@ -13,12 +15,19 @@ module Hands
   # All card value descriptions
   VALUE_DESCRIPTIONS = %w{two three four five six seven eight nine ten jack queen king ace}
 
-  # Reverse alphabetically ordered suits
+  # Alphabetically ordered suits (higher index in the array is higher value)
   SUITS = [:clubs, :diamonds, :hearts, :spades]
+  SUIT_CHARACTERS = %w{♣ ♦ ♥ ♠}
 
   # Ranks of poker hands
   HAND_ORDER = [
     :high_card, :pair, :two_pair, :three_of_a_kind, :straight, :flush, :full_house,
     :four_of_a_kind, :straight_flush, :royal_flush
   ]
+
+  # Raised when an invalid suit is used
+  class InvalidSuit < StandardError; end
+
+  # Raised when an invalid value is used
+  class InvalidValue < StandardError; end
 end

data/lib/hands/card.rb

@@ -65,14 +65,20 @@ module Hands
 
       # Invalid
       @value = nil
+      raise InvalidValue, "'#{val}' is an invalid suit."
     end
 
     def suit=(suit)
-      if (suit.is_a?(String) or suit.is_a?(Symbol)) and SUITS.include?(suit.to_sym)
-        @suit = suit.to_sym
-      else
+      # Convert to symbol
+      suit = suit.to_sym if suit.is_a?(String)
+
+      # Make sure it's valid
+      unless suit.is_a?(Symbol) and SUITS.include?(suit)
         @suit = nil
+        raise InvalidSuit, "'#{suit}' is an invalid suit."
       end
+
+      @suit = suit
     end
 
     # Standard inspect
@@ -96,15 +102,24 @@ module Hands
       !self.is_valid?
     end
 
+    # Get a short string representation of the card
+    #
+    # Example: "♥2"
+    #
+    # @return [String] short string representation of the card
+    def description
+      return 'invalid' unless self.is_valid?
+      self.value.capitalize + SUIT_CHARACTERS[self.suit_index]
+    end
+
     # Get a string representation of the card
     #
+    # Example: "Two of Hearts"
+    #
     # @return [String] string representation of the card
-    def description
-      if self.is_valid?
-        "#{VALUE_DESCRIPTIONS[self.value_index].capitalize} of #{self.suit.to_s.capitalize}"
-      else
-        'invalid'
-      end
+    def long_description
+      return 'invalid' unless self.is_valid?
+      "#{VALUE_DESCRIPTIONS[self.value_index].capitalize} of #{self.suit.to_s.capitalize}"
     end
 
     # Compares the card with another card
@@ -129,6 +144,7 @@ module Hands
     # @return [Integer] index of the card's suit
     # @see SUITS
     def suit_index
+      return nil unless self.suit
       SUITS.index(self.suit.downcase)
     end
 
@@ -139,6 +155,7 @@ module Hands
     # @return [Integer] index of the card's value
     # @see VALUES
     def value_index
+      return nil unless self.value
       VALUES.index(self.value.downcase)
     end
   end

data/lib/hands/hand_detection.rb

@@ -35,60 +35,42 @@ module Hands
 
     # @return [Array, Nil] Array of {Card} objects with the straight in decending order or `nil` if there isn't a straight in the {Hand}
     def straight
-      return nil unless self.cards.length == 5
+      # Require at least 5 cards
+      return nil unless self.cards.length >= 5
+      
+      # Sort
       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
+      return cs if cs.first.value == 'a' and cs[1].value == '5'
+
+      # Check succession
+      return nil unless succession?
+
+      # Avoid wrap-around
+      values = self.cards.collect(&:value)
+      return nil if values.include?('k') and values.include?(2)
+
       cs
     end
 
     # @return [Array, Nil] Array of {Card} objects with the flush in decending order or `nil` if there isn't a flush in the {Hand}
     def flush
       # If all of the {Card}s are the same suit, we have a flush
-      return nil unless self.suits.length == 1
+      return nil unless self.cards.length >= 5 and self.suits.length == 1
       self.cards.sort.reverse
     end
 
     # @return [Array, Nil] Array of {Card} objects with the full house in decending order or `nil` if there isn't a full house in the {Hand}
     def full_house
       dupes = self.duplicates
-      return nil unless dupes.length == 2
-
-      a = []
-      b = []
-
-      hand = self.cards.select do |card|
-        if dupes.first == card.value
-          a << card
-        elsif dupes.last == card.value
-          b << card
-        end
+      return nil unless self.cards.length >= 5 and dupes.length == 2
+      
+      # Ensure all {Card}s are one of the duplicates
+      self.cards.each do |card|
+        return nil unless dupes.include? card.value
       end
 
-      return nil unless a.length + b.length == 5
       self.cards.sort.reverse
     end
 
@@ -136,7 +118,7 @@ module Hands
 
     def pairs(min)
       dupes = self.duplicates
-      return nil if dupes.length < min
+      return nil unless dupes.length >= min
 
       hand = self.cards.select do |card|
         dupes.include?(card.value)
@@ -161,5 +143,13 @@ module Hands
       hand << (self.cards - hand).sort.reverse
       hand.flatten
     end
+    
+    def succession?
+      cs = self.cards.sort.reverse
+      4.times do |i|
+        return false unless cs[i].value_index == cs[i + 1].value_index + 1
+      end
+      true
+    end
   end
 end

data/lib/hands/version.rb

@@ -1,4 +1,4 @@
 module Hands
   # Gem version
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

data/test/test_helper.rb

@@ -1,11 +1,17 @@
-require 'simplecov'
-SimpleCov.start
-
 require 'rubygems'
 require 'bundler'
 Bundler.require :test
+
+require 'simplecov'
+SimpleCov.start
+
 require 'minitest/autorun'
 require 'hands'
 
+# Support files
+Dir["#{File.expand_path(File.dirname(__FILE__))}/support/*.rb"].each do |file|
+  require file
+end
+
 class Hands::TestCase < MiniTest::Unit::TestCase
 end

data/test/units/card_test.rb

@@ -1,6 +1,13 @@
+# encoding: UTF-8
 require 'test_helper'
 
 class CardTest < Hands::TestCase
+  def test_shorthand
+    card1 = Hands::Card[4, :hearts]
+    card2 = Hands::Card.new(:value => 4, :suit => :hearts)
+    assert_equal card1, card2
+  end
+
   def test_that_it_validates_cards
     card = Hands::Card.new
     refute card.is_valid?
@@ -12,26 +19,31 @@ class CardTest < Hands::TestCase
     card.value = 9
     assert card.is_valid?
 
-    card.suit = 17
-    refute card.is_valid?
+    assert_raises Hands::InvalidSuit do
+      card.suit = 17
+    end
+
+    assert_raises Hands::InvalidValue do
+      card.value = 19
+    end
 
     card.suit = :hearts
-    card.value = 19
-    refute card.is_valid?
+    card.value = 5
+    assert card.is_valid?
   end
 
   def test_that_it_allows_integers_for_high_cards
-    card1 = Hands::Card.new(value: 11, suit: :clubs)
+    card1 = Hands::Card[11, :clubs]
     assert card1.is_valid?
     assert_equal 'j', card1.value
 
-    card2 = Hands::Card.new(value: 'j', suit: :clubs)
+    card2 = Hands::Card['j', :clubs]
     assert_equal card1, card2
   end
 
   def test_that_its_comparable
-    card1 = Hands::Card.new(value: 2, suit: :hearts)
-    card2 = Hands::Card.new(value: 3, suit: :clubs)
+    card1 = Hands::Card[2, :hearts]
+    card2 = Hands::Card[3, :clubs]
 
     assert card2 > card1
     assert card1 < card2
@@ -43,30 +55,34 @@ class CardTest < Hands::TestCase
   end
 
   def test_that_it_is_sortable
-    c2 = Hands::Card.new(value: 2, suit: :hearts)
-    c3 = Hands::Card.new(value: 3, suit: :hearts)
-    c4 = Hands::Card.new(value: 4, suit: :hearts)
-    c5 = Hands::Card.new(value: 5, suit: :hearts)
-    c6 = Hands::Card.new(value: 6, suit: :hearts)
-    c7 = Hands::Card.new(value: 7, suit: :hearts)
-    c8 = Hands::Card.new(value: 8, suit: :hearts)
-    c9 = Hands::Card.new(value: 9, suit: :hearts)
-    c10 = Hands::Card.new(value: 10, suit: :hearts)
-    cJ = Hands::Card.new(value: 'j', suit: :hearts)
-    cQ = Hands::Card.new(value: 'q', suit: :hearts)
-    cK = Hands::Card.new(value: 'k', suit: :hearts)
-    cA = Hands::Card.new(value: 'a', suit: :hearts)
+    c2 = Hands::Card[2, :hearts]
+    c3 = Hands::Card[3, :hearts]
+    c4 = Hands::Card[4, :hearts]
+    c5 = Hands::Card[5, :hearts]
+    c6 = Hands::Card[6, :hearts]
+    c7 = Hands::Card[7, :hearts]
+    c8 = Hands::Card[8, :hearts]
+    c9 = Hands::Card[9, :hearts]
+    c10 = Hands::Card[10, :hearts]
+    cJ = Hands::Card['j', :hearts]
+    cQ = Hands::Card['q', :hearts]
+    cK = Hands::Card['k', :hearts]
+    cA = Hands::Card['a', :hearts]
 
     cards = [c2, c3, c4, c5, c6, c7, c8, c9, c10, cJ, cQ, cK, cA]
     assert_equal cards, cards.sort
   end
 
   def test_that_it_includes_the_description_in_inspect
-    card = Hands::Card.new(value: 2, suit: :hearts)
-    assert_includes card.inspect, 'Two of Hearts'
+    card = Hands::Card[2, :hearts]
+    assert_equal '2♥', card.description
+    assert_includes card.inspect, '2♥'
+    assert_equal 'Two of Hearts', card.long_description
 
     card = Hands::Card.new
     assert_equal 'invalid', card.description
+    assert_equal 'invalid', card.description
     refute_includes card.inspect, 'invalid'
+    assert_equal 'invalid', card.description
   end
 end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hands
 version: !ruby/object:Gem::Version
-  version: 0.2.1
-  prerelease: 
+  version: 0.3.0
 platform: ruby
 authors:
 - Sam Soffes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-22 00:00:00.000000000 Z
+date: 2013-02-25 00:00:00.000000000 Z
 dependencies: []
 description: Simple library for various poker hands calculations.
 email:
@@ -21,6 +20,7 @@ files:
 - .gitignore
 - .travis.yml
 - .yardopts
+- Contributing.markdown
 - Gemfile
 - LICENSE
 - Rakefile
@@ -43,34 +43,28 @@ files:
 - test/units/player_test.rb
 - test/units/table_test.rb
 homepage: http://github.com/soffes/hands
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
-      version: '0'
-      segments:
-      - 0
-      hash: 2894117233871191635
+      version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2894117233871191635
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Simple library for various poker hands calculations.
 test_files:
 - test/test_helper.rb