leonardo-bridge 0.4.3 → 0.6.5

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    OWRjMmJjOGYwNTVlZmU3OGQ3ZDVkNTlhODg5NWVmOWZhMjllMGE3MA==
-  data.tar.gz: !binary |-
-    OGI1YTBkY2QwZjI0NjcwMDIyMzYxMDE1NzQzZDRkOTYzYTdmYTU5Ng==
+SHA1:
+  metadata.gz: 9be6e3140176b3db2048e72737b9f3e2a4530b38
+  data.tar.gz: 7c9fe92ceab4462a2aebf9ae3c6d5937cf347f80
 SHA512:
-  metadata.gz: !binary |-
-    OGRmMDkzZjMzNGVjYjMxY2E4OTFlNTBjNzMwMzY1YmRhYjU0ZDQ3YTFmZTE2
-    ZDNjOWMzYzA0ZWY0NjY5MDM0NWZmODllZjM0NmU5NzEwZGI3MjhjMjBkYWQy
-    YmZhYjdmZWQ0NzdhZmZkNjlhMGM3MTE4MzZmM2FiOTk2YWQ2MmE=
-  data.tar.gz: !binary |-
-    OGY2OGRiOGIzYTJkMzg5MGZhNzcxODdjMWRhMGQwYmU5NTYyMWVkYTU3NjIz
-    MjhlNDU5NjRiZTk5ZjcyNzA1YzE5ODZiZjcwN2RjMTEzYmM1MDEwM2YwZmMz
-    NjgzNjM3MzcyNTU2OGVmY2Y3OGI1NjQzMjRlODE2MjFjZGE5MjI=
+  metadata.gz: df553f217643aad19ae9253be133c5a38b308544cf3e0438284d19af649d7b4f0a681d7128340b04d26f48d05c0e6c4553d453660e03cbda433cd350bde5e771
+  data.tar.gz: 7422db23f08aeba5d8df54f5da27318664bacafa06bc77461f77552319ef4de518e3e67ffe5182914116f76e0dbb25865d62a3eacfa30a3018199f3ba924a0c5

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Achilles Charmpilas
+Copyright (c) 2018 Achilles Charmpilas
 
 MIT License
 

data/README.md

@@ -1,16 +1,16 @@
 # Bridge
+Bridge is the bridge playing engine sitting behind [Leo Bridge](https://leobridge.net/) this is the first version initially built in 2013 and is shared here as a working game engine example. 
 
-A lean mean bridge playing machine.
-Large portions of this gem have been ported from [pybridge](http://sourceforge.net/projects/pybridge/)
+You can use it to experiment with building a card game UI, or however else you wish. 
 
-Bridge is the bridge playing engine sitting behind the Leonardo Bridge API.
+Large portions of this gem have been ported from [pybridge](http://sourceforge.net/projects/pybridge/)
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
     #!ruby
-    gem 'bridge'
+    gem 'leonardo-bridge', require: 'bridge'
 
 And then execute:
     
@@ -18,11 +18,14 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install bridge
+    $ gem install leonardo-bridge
 
 ## Usage
 
-You can have a look at `bin/play` for an example of interaction with the Bridge::Game class.
+You can have a look at `bin/leo-play` for an example of interaction with the Bridge::Game class (type `help` for available commands).
+
+IF you clone the source, you can also run `./bin/leo-play` to try out a rudimentary interactive game (meant as a demo, this is NOT a full bridge game).
+
 
 Here's a quick run-through:
 
@@ -43,4 +46,4 @@ Here's a quick run-through:
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+5. Create new Pull Request

data/bin/leo-console

@@ -4,4 +4,5 @@ libs << '-r irb/completion'
 libs << '-r pp'
 libs << '-r ./lib/bridge'
 libs << '-r ./bridge.rc.rb'
+
 exec "irb #{libs.join(' ')}"

data/bin/leo-play

@@ -78,6 +78,15 @@ end
 
 while cmd = gets.strip
   case cmd
+  when 'help'
+    puts "* Available Commands".green
+    puts "`hand` show current player hand"
+    puts "`bid [valid bid]` make an auction bid (e.g. `bid one spade`)"
+    puts "`[card]` play a card while in play (e.g. `AH` or `10S`)"
+    puts "`rush [auction|trick]` fast-forward auction or trick stage"
+    puts "`history` display move history"
+    puts "`undo` undo last auction or trick stage move"
+    print cursor
   when 'bye','exit','leave'
     break
   when 'rush trick' # play an automatic trick
@@ -85,12 +94,18 @@ while cmd = gets.strip
     rush_trick
   when 'rush auction' # play a canned auction
     rush_auction
+  when 'undo'
+    if @game.undo!
+      put 'OK'.green
+    else
+      put 'Undo unavailable'.yellow
+    end
   when 'history'
     put 'Move history:'.yellow
     put @history.join("\n")
     
   when 'hand'
-    put @game.get_hand(@game.get_turn).inspect.white
+    put @game.get_hand(@game.get_turn).to_s
     print cursor
     
   else
@@ -111,10 +126,14 @@ while cmd = gets.strip
           else
             card = Card.from_string(ary.first)
           end
-          
-          @players[position_i].play_card(card)
+          player = if @game.get_turn == @game.play.dummy
+            @players[@game.play.declarer]
+          else
+            @players[position_i]
+          end
+          player.play_card(card)
           print "#{position.white} plays #{card.to_s.magenta} ~> "
-          puts @game.play.get_current_trick.cards.compact.inspect.white
+          puts @game.play.get_current_trick.cards.map(&:to_s).compact.join(' ').white
         rescue Exception => e
           put e.message.red
         end

data/bridge.gemspec

@@ -7,23 +7,19 @@ Gem::Specification.new do |spec|
   spec.name          = "leonardo-bridge"
   spec.version       = Bridge::VERSION
   spec.authors       = ["Achilles Charmpilas"]
-  spec.email         = ["ac@humbuckercode.co.uk"]
+  spec.email         = ["achilles@clickitmedia.eu"]
   spec.description   = %q{A lean mean bridge playing machine}
   spec.summary       = %q{Encapsulates all the necessary logic that allows 4 players to play a bridge game. Also supports rubber scoring.}
-  spec.homepage      = "http://bridge.leonardogames.net/"
+  spec.homepage      = "https://leobridge.net"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
   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 "redis"
   spec.add_dependency "nutrun-string"
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rspec"
-  spec.add_development_dependency "fuubar"
-  spec.add_development_dependency "geminabox"
-  spec.add_development_dependency "gem-release"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "simplecov"
 end

data/lib/bridge.rb

@@ -1,11 +1,12 @@
 require 'rubygems'
 require 'ostruct'
 require 'pathname'
+require 'json'
 require 'nutrun-string'
 
 root = File.dirname(__FILE__)
 
-%W{ uuid redis_model enum }.each { |r| require File.join(root,r) }
+%W{ enum }.each { |r| require File.join(root,r) }
 
 module Bridge
   DEBUG = false

data/lib/bridge/auction.rb

@@ -4,7 +4,6 @@ module Bridge
   class InvalidCallClassError < StandardError; end
   
   # The auction (bidding phase) of a game of bridge.
-  # Swiped from: https://pybridge.svn.sourceforge.net/svnroot/pybridge/trunk/pybridge/pybridge/games/bridge/auction.py
   class Auction
     attr_accessor :dealer, :calls, :contract
   

data/lib/bridge/board.rb

@@ -1,5 +1,4 @@
 module Bridge
-  # Swiped from https://pybridge.svn.sourceforge.net/svnroot/pybridge/trunk/pybridge/pybridge/games/bridge/board.py
   # An encapsulation of board information.
   # @keyword deal: the cards in each hand.
   # @type deal: Deal

data/lib/bridge/call.rb

@@ -1,4 +1,3 @@
-# ref: https://pybridge.svn.sourceforge.net/svnroot/pybridge/trunk/pybridge/pybridge/games/bridge/call.py
 module Bridge
   module Level
     extend Enum

data/lib/bridge/contract.rb

@@ -1,8 +1,5 @@
 module Bridge
   class InvalidAuctionError < StandardError; end
-  
-  # Represents the result of an auction.
-  # Swiped from: https://pybridge.svn.sourceforge.net/svnroot/pybridge/trunk/pybridge/pybridge/games/bridge/auction.py
   class Contract
     attr_accessor :redouble_by, :double_by, :bid, :declarer
     

data/lib/bridge/deal.rb

@@ -1,9 +1,4 @@
 module Bridge
-  # deal, not game
-  # bidding create the contract
-  # bidding is also persistent
-  # bidding finishes after 3 passes
-  
   class Deal
     attr_accessor :hands, :deck
   
@@ -16,12 +11,20 @@ module Bridge
       deal!
       self
     end
-  
+    
     # deals one card per hand on a cycle until we run out of cards
     def deal!
       hands.cycle(deck.size/hands.size) { |hand| hand << deck.shift }
     end
     
+    def to_page
+      # returns HEX bridge book page value
+    end
+    
+    def self.from_page
+      # create deal and hands based on HEX bridge book page number
+    end
+    
     def method_missing(m, *args, &block)
       if hands.respond_to?(m)
         hands.send(m, *args, &block)

data/lib/bridge/deck.rb

@@ -1,12 +1,23 @@
+require 'securerandom'
+
 module Bridge
   class Deck
     attr_accessor :cards
   
     def initialize
       @cards = Card::RANKS.product(Card::SUITS).map { |a| Card.new(a[0],a[1]) }
-      @cards.shuffle!
+      @cards.shuffle!(random: SecureRandom)
     end
-  
+    
+    # make sure shuffling is as random as possible
+    def shuffle!
+      @cards.shuffle!(random: SecureRandom)
+    end
+    
+    def shuffle
+      @cards.shuffle(random: SecureRandom)
+    end
+    
     def inspect
       cards.inspect
     end

data/lib/bridge/game.rb

@@ -1,8 +1,6 @@
 #require File.join(File.dirname(__FILE__),'result')
 
 module Bridge
-  # Raised by game in response to an unsatisfiable or erroneous request.
-  # ref: https://pybridge.svn.sourceforge.net/svnroot/pybridge/trunk/pybridge/pybridge/network/error.py
   class GameError < StandardError
   end
 
@@ -12,9 +10,7 @@ module Bridge
   # Modifications to the state are typically made through BridgePlayer objects.
   # Methods which change the game state (make_call, playCard) require a player
   # argument as "authentication".
-  class Game < RedisModel
-    use_timestamps
-    
+  class Game
     attr_accessor :auction, :play, :players, :options, :number
     attr_accessor :board, :board_queue, :results, :visible_hands
     attr_accessor :trump_suit, :result, :contract, :state
@@ -105,7 +101,22 @@ module Bridge
       self.state = :auction
       true
     end
-
+    
+    def in_play?
+      if !self.play.nil?
+        !self.play.complete?
+      else
+        false
+      end
+    end
+    
+    def in_auction?
+      if !self.auction.nil?
+        !self.auction.passed_out?
+      else
+        false
+      end
+    end
 
     def in_progress?
       if !self.play.nil?
@@ -168,7 +179,44 @@ module Bridge
       
       self.players.reject! { |player,pos| pos == position }
     end
-
+    
+    # Send undo message to either auction or trick play
+    # this is only available while there is an auction or trick_play
+    def undo!
+      case self.state
+      when :auction
+        if self.auction.complete?
+          false # can't undo if auction is complete yo.
+        else
+          card = self.auction.calls.pop # remove the last undo
+          if card
+            true
+          else
+            false
+          end
+        end
+      when :playing
+        # remove the last card from everywhere
+        card = self.play.history.pop
+        if card
+          trick = self.play.get_current_trick
+          player = self.play.who_played?(card)
+          # this was a completed trick, we need to remove it from the winner queue
+          if trick.cards.compact.size == 4
+            winner = self.play.who_played?(self.play.winning_card(trick))
+            self.play.winners.pop if self.play.winners.last == winner
+          end
+          self.play.get_current_trick.cards.delete(card)
+          self.play.played.each { |k,h| h.delete(card) }
+          self.board.deal.hands[player] << card
+          true
+        else
+          false          
+        end
+      else
+        false
+      end
+    end
 
     # Bridge-specific methods.
   

data/lib/bridge/hand.rb

@@ -15,7 +15,7 @@ module Bridge
     end
   
     def to_s
-      cards.to_s
+      cards.map(&:to_s).join(' ')
     end
     
     def to_json opts = {}

data/lib/bridge/player.rb

@@ -1,7 +1,5 @@
 module Bridge
-  # Actor representing a player's view of a BridgeGame object.
-  # ref: https://pybridge.svn.sourceforge.net/svnroot/pybridge/trunk/pybridge/pybridge/games/bridge/game.py
-  class Player < RedisModel
+  class Player
     def initialize(game)
       @game = game  # Access to game is private to this object.
     end

data/lib/bridge/result.rb

@@ -1,7 +1,5 @@
 
 module Bridge
-# Represents the result of a completed round of bridge.
-# Swiped from: https://svn.code.sf.net/p/pybridge/code/trunk/pybridge/pybridge/games/bridge/result.py
   class Result
     VULN_MAP = {
       Vulnerability.none => [],
@@ -127,17 +125,19 @@ module Bridge
           else
             components['slambonus'] = 500
           end
-        elsif components['odd'] >= 100 # Game contract (non-slam).
+        end
+        
+        if components['odd'] >= 100 # Game contract (non-slam).
           # 500 for game if vulnerable, 300 if not.
           if is_vulnerable
             components['gamebonus'] = 500
           else
             components['gamebonus'] = 300
           end
-        else  # Non-game contract.
+        else # Non-game contract.
           components['partscore'] = 50
         end
-
+        
         #### Insult bonus ####
         if is_redoubled
           components['insultbonus'] = 100

data/lib/bridge/trick_play.rb

@@ -2,7 +2,6 @@ module Bridge
   # This class models the trick-taking phase of a game of bridge.
   # This code is generalised, and could easily be adapted to support a
   # variety of trick-taking card games.
-  # Swiped from: https://pybridge.svn.sourceforge.net/svnroot/pybridge/trunk/pybridge/pybridge/games/bridge/auction.py
   class TrickPlay
     attr_accessor :trumps, :declarer, :dummy, :lho, :rho, :played, :winners, :history
     

data/lib/bridge/version.rb

@@ -1,3 +1,3 @@
 module Bridge
-  VERSION = "0.4.3"
+  VERSION = "0.6.5"
 end

data/spec/auction_spec.rb

@@ -13,30 +13,30 @@ describe Auction do
   
   subject(:instance) { Auction.new(dealer) }
   
-  it { subject.contract.should be_a(NilClass) }
-  it { subject.get_contract.should be_a(NilClass) }
-  it { subject.calls.size.should eq(0) }
-  it { subject.dealer.should eq(dealer) }
+  it { expect(subject.contract).to be_a(NilClass) }
+  it { expect(subject.get_contract).to be_a(NilClass) }
+  it { expect(subject.calls.size).to eq(0) }
+  it { expect(subject.dealer).to eq(dealer) }
   
   it 'should pass out on 4 passes only' do
-    subject.passed_out?.should eq(false)
+    expect(subject.passed_out?).to eq(false)
     3.times do
-      subject.make_call(Pass.new).should eq(true)
-      subject.passed_out?.should eq(false)
+      expect(subject.make_call(Pass.new)).to eq(true)
+      expect(subject.passed_out?).to eq(false)
     end
     
-    subject.make_call(Pass.new).should eq(true)
-    subject.passed_out?.should eq(true)
+    expect(subject.make_call(Pass.new)).to eq(true)
+    expect(subject.passed_out?).to eq(true)
   end
   
   describe 'when finished' do
     before { calls.each { |call| subject.make_call(call) } }
     
-    it { subject.calls.should eq(calls) }
-    it { subject.contract.should_not be_a(NilClass) }
-    it { subject.contract.should be_a(Contract) }
-    it { subject.get_contract.should be_a(Hash) }
-    it { subject.get_contract.should eq(subject.contract.to_hash) }
+    it { expect(subject.calls).to eq(calls) }
+    it { expect(subject.contract).to_not be_a(NilClass) }
+    it { expect(subject.contract).to be_a(Contract) }
+    it { expect(subject.get_contract).to be_a(Hash) }
+    it { expect(subject.get_contract).to eq(subject.contract.to_hash) }
   end
   
   describe 'current call' do
@@ -57,35 +57,35 @@ describe Auction do
   
   it 'does not allow invalid calls' do
     subject.make_call(Bid.new(Level.two, Strain.club))
-    expect { subject.make_call(Bid.new(Level.one, Strain.club)) }.to raise_error
+    expect { subject.make_call(Bid.new(Level.one, Strain.club)) }.to raise_error(Bridge::InvalidCallError)
     expect { subject.make_call(Bid.new(Level.three, Strain.club)) }.to_not raise_error
-    expect { subject.make_call(Bid.new(Level.two, Strain.heart)) }.to raise_error
+    expect { subject.make_call(Bid.new(Level.two, Strain.heart)) }.to raise_error(Bridge::InvalidCallError)
     expect { subject.make_call(Bid.new(Level.three, Strain.heart)) }.to_not raise_error
   end
   
   it 'knows whose turn it is' do
     turn = dealer
-    subject.whose_turn.should eq(turn)
+    expect(subject.whose_turn).to eq(turn)
     
     calls.each_index do |i|
       subject.make_call(calls[i])
       if i == calls.size - 1
-        subject.whose_turn.should eq(nil)
+        expect(subject.whose_turn).to eq(nil)
       else
         turn = Direction[(turn + 1) % 4]  # Turn moves clockwise.
-        subject.whose_turn.should eq(turn)
+        expect(subject.whose_turn).to eq(turn)
       end
     end
   end
   
   it 'only marks an auction as complete if it is' do
-    subject.complete?.should eq(false)
+    expect(subject.complete?).to eq(false)
     calls.each_index do |i|
       subject.make_call(calls[i])
       if i == calls.size - 1
-        subject.complete?.should eq(true)
+        expect(subject.complete?).to eq(true)
       else
-        subject.complete?.should eq(false)
+        expect(subject.complete?).to eq(false)
       end
     end
   end
@@ -94,7 +94,7 @@ describe Auction do
     calls.each_index do |i|
       subject.make_call(calls[i])
       next_call = calls[i+1]
-      subject.valid_call?(next_call).should eq(true) unless next_call.nil?
+      expect(subject.valid_call?(next_call)).to eq(true) unless next_call.nil?
     end
   end
 end