rubycards 0.0.1 → 0.0.2

data/README.md

@@ -25,6 +25,7 @@ Or install it yourself as:
 Here's a trivial example of declaring a new deck, shuffling, and drawing 5 cards into a hand:
 
     require 'rubycards'
+    include RubyCards
 
     hand = Hand.new
     deck = Deck.new

data/lib/rubycards/card.rb

@@ -1,131 +1,133 @@
 # encoding: utf-8
 require 'colored'
 
-class Card
+module RubyCards
+  class Card
 
-  include Comparable
+    include Comparable
 
-  # constants for glyphs
-  CLUB    = '♣'
-  DIAMOND = '♦'
-  HEART   = '♥'
-  SPADE   = '♠'
+    # constants for glyphs
+    CLUB    = '♣'
+    DIAMOND = '♦'
+    HEART   = '♥'
+    SPADE   = '♠'
 
-  def initialize(rank = 'Ace', suit = 'Spades')
-    @rank = rank_to_i(rank)
-    @suit = suit_to_i(suit)
-  end
-
-  # returns the rank of the card
-  # optional short parameter will limit face cards to one character
-  def rank(short = false)
-    if (2..10) === @rank
-      @rank.to_s
-    else
-      h = { 11 => 'Jack', 12 => 'Queen', 13 => 'King', 14 => 'Ace' }
-      h[@rank] && short ? h[@rank][0] : h[@rank]
+    def initialize(rank = 'Ace', suit = 'Spades')
+      @rank = rank_to_i(rank)
+      @suit = suit_to_i(suit)
     end
-  end
 
-  # returns the suit of a card
-  # optional glyph parameter displays a colored unicode character
-  def suit(glyph = false)
-    case @suit
-      when 1
-        glyph ? CLUB.black.bold : 'Clubs'
-      when 2
-        glyph ? DIAMOND.red : 'Diamonds'
-      when 3
-        glyph ? HEART.red : 'Hearts'
-      when 4
-        glyph ? SPADE.black.bold : 'Spades'
+    # returns the rank of the card
+    # optional short parameter will limit face cards to one character
+    def rank(short = false)
+      if (2..10) === @rank
+        @rank.to_s
+      else
+        h = { 11 => 'Jack', 12 => 'Queen', 13 => 'King', 14 => 'Ace' }
+        h[@rank] && short ? h[@rank][0] : h[@rank]
+      end
     end
-  end
 
-  # returns the short rank, followed by suit icon
-  def short
-    "#{rank(true)}#{suit(true)}"
-  end
+    # returns the suit of a card
+    # optional glyph parameter displays a colored unicode character
+    def suit(glyph = false)
+      case @suit
+        when 1
+          glyph ? CLUB.black.bold : 'Clubs'
+        when 2
+          glyph ? DIAMOND.red : 'Diamonds'
+        when 3
+          glyph ? HEART.red : 'Hearts'
+        when 4
+          glyph ? SPADE.black.bold : 'Spades'
+      end
+    end
 
-  # comparator
-  def <=>(c)
-    self.to_i <=> c.to_i
-  end
+    # returns the short rank, followed by suit icon
+    def short
+      "#{rank(true)}#{suit(true)}"
+    end
 
-  # returns the numerical representation of the rank
-  def to_i
-    @rank
-  end
+    # comparator
+    def <=>(c)
+      self.to_i <=> c.to_i
+    end
 
-  # draws a card picture
-  def to_s
-    # A simple template with X's as placeholders
-    # YY represents the placement of the card's rank
-    template = <<-TPL.gsub(/^\s+/,'')
-      ╭───────╮
-      | X X X |
-      | X X X |
-      | X YYX |
-      | X X X |
-      ╰───────╯
-    TPL
-
-    # the patterns represent the configuration of glyphys
-    #   read from left to right, top to bottom
-    # X means place a glyph, _ means clear the space
-    case @rank
-      when 2;  pattern = '_X_______X_'
-      when 3;  pattern = '_X__X____X_'
-      when 4;  pattern = 'X_X_____X_X'
-      when 5;  pattern = 'X_X_X___X_X'
-      when 6;  pattern = 'X_XX_X__X_X'
-      when 7;  pattern = 'X_X_X_XXX_X'
-      when 8;  pattern = 'X_XX_XXXX_X'
-      when 9;  pattern = 'X_XXXXXXX_X'
-      when 10; pattern = 'XXXX_XXXXXX'
-      when 11..14;
-        pattern = 'X_________X'
+    # returns the numerical representation of the rank
+    def to_i
+      @rank
     end
 
-    pattern.each_char do |c|
-      # replace X's with glyphs
-      if c == 'X'
-        template.sub!(/X/, "#{suit(true)}")
-      # replace _'s with whitespace
-      else
-        template.sub!(/X/, " ")
+    # draws a card picture
+    def to_s
+      # A simple template with X's as placeholders
+      # YY represents the placement of the card's rank
+      template = <<-TPL.gsub(/^\s+/,'')
+        ╭───────╮
+        | X X X |
+        | X X X |
+        | X YYX |
+        | X X X |
+        ╰───────╯
+      TPL
+
+      # the patterns represent the configuration of glyphys
+      #   read from left to right, top to bottom
+      # X means place a glyph, _ means clear the space
+      case @rank
+        when 2;  pattern = '_X_______X_'
+        when 3;  pattern = '_X__X____X_'
+        when 4;  pattern = 'X_X_____X_X'
+        when 5;  pattern = 'X_X_X___X_X'
+        when 6;  pattern = 'X_XX_X__X_X'
+        when 7;  pattern = 'X_X_X_XXX_X'
+        when 8;  pattern = 'X_XX_XXXX_X'
+        when 9;  pattern = 'X_XXXXXXX_X'
+        when 10; pattern = 'XXXX_XXXXXX'
+        when 11..14;
+          pattern = 'X_________X'
       end
-    end
 
-    # place the card rank (left-padded)
-    template.sub(/YY/, rank(true).ljust(2))
-  end
+      pattern.each_char do |c|
+        # replace X's with glyphs
+        if c == 'X'
+          template.sub!(/X/, "#{suit(true)}")
+        # replace _'s with whitespace
+        else
+          template.sub!(/X/, " ")
+        end
+      end
 
-  private
-
-  # converts the string representation of a rank to an integer
-  def rank_to_i(rank)
-    case rank.to_s
-      when /^(a|ace)/i;   14
-      when /^(k|king)/i;  13
-      when /^(q|queen)/i; 12
-      when /^(j|jack)/i;  11
-      when '10';          10
-      when '2'..'9';      rank
-      else 0
+      # place the card rank (left-padded)
+      template.sub(/YY/, rank(true).ljust(2))
     end
-  end
 
-  # converts the string representation of a suit to an integer
-  # suits are ordered alphabetically
-  def suit_to_i(suit)
-    case suit
-      when /^club/i;    1
-      when /^diamond/i; 2
-      when /^heart/i;   3
-      when /^spade/i;   4
-      else 0
+    private
+
+    # converts the string representation of a rank to an integer
+    def rank_to_i(rank)
+      case rank.to_s
+        when /^(a|ace)/i;   14
+        when /^(k|king)/i;  13
+        when /^(q|queen)/i; 12
+        when /^(j|jack)/i;  11
+        when '10';          10
+        when '2'..'9';      rank
+        else 0
+      end
+    end
+
+    # converts the string representation of a suit to an integer
+    # suits are ordered alphabetically
+    def suit_to_i(suit)
+      case suit
+        when /^club/i;    1
+        when /^diamond/i; 2
+        when /^heart/i;   3
+        when /^spade/i;   4
+        else 0
+      end
     end
-  end
 
+  end
 end

data/lib/rubycards/deck.rb

@@ -1,45 +1,47 @@
-class Deck
+module RubyCards
+  class Deck
 
-  include Enumerable
+    include Enumerable
 
-  attr_reader :cards
+    attr_reader :cards
 
-  RANKS = [*2..10, 'Jack', 'Queen', 'King', 'Ace']
-  SUITS = %w{ Clubs Diamonds Hearts Spades }
+    RANKS = [*2..10, 'Jack', 'Queen', 'King', 'Ace']
+    SUITS = %w{ Clubs Diamonds Hearts Spades }
 
-  # initialize a deck of cards using the RANKS and SUITS constants
-  def initialize
-    @cards = []
+    # initialize a deck of cards using the RANKS and SUITS constants
+    def initialize
+      @cards = []
 
-    RANKS.product(SUITS).each do |rank, suit|
-      @cards << Card.new(rank, suit)
+      RANKS.product(SUITS).each do |rank, suit|
+        @cards << Card.new(rank, suit)
+      end
     end
-  end
 
-  # shuffle the deck
-  def shuffle!
-    @cards.shuffle!
-  end
+    # shuffle the deck
+    def shuffle!
+      @cards.shuffle!
+    end
 
-  # draw a card from the deck
-  def draw
-    @cards.shift
-  end
+    # draw a card from the deck
+    def draw
+      @cards.shift
+    end
 
-  # determines if the deck is empty
-  def empty?
-    @cards.empty?
-  end
+    # determines if the deck is empty
+    def empty?
+      @cards.empty?
+    end
 
-  # Enumerable#each
-  def each(&block)
-    @cards.each do |card|
-      if block_given?
-        block.call card
-      else
-        yield card
+    # Enumerable#each
+    def each(&block)
+      @cards.each do |card|
+        if block_given?
+          block.call card
+        else
+          yield card
+        end
       end
     end
-  end
 
+  end
 end

data/lib/rubycards/hand.rb

@@ -1,57 +1,59 @@
-class Hand
+module RubyCards
+  class Hand
 
-  include Enumerable
+    include Enumerable
 
-  attr_reader :cards
+    attr_reader :cards
 
-  # initialize with an array of cards
-  def initialize(cards = [])
-    @cards = []
-    cards.each do |card|
-      self << card
+    # initialize with an array of cards
+    def initialize(cards = [])
+      @cards = []
+      cards.each do |card|
+        self << card
+      end
     end
-  end
 
-  # add a card if it is valid
-  def add(card)
-    @cards << card if card.instance_of? Card
-  end
+    # add a card if it is valid
+    def add(card)
+      @cards << card if card.instance_of? Card
+    end
 
-  # alias array push (<<) to add method
-  alias_method :<<, :add
+    # alias array push (<<) to add method
+    alias_method :<<, :add
 
-  # indexing
-  def [](n)
-    @cards[n]
-  end
+    # indexing
+    def [](n)
+      @cards[n]
+    end
 
-  # sorting
-  def sort!
-    @cards.sort!
-  end
+    # sorting
+    def sort!
+      @cards.sort!
+    end
 
-  # draw n cards from a deck
-  def draw(deck, n = 1)
-    n.times do
-      @cards << deck.draw unless deck.empty?
+    # draw n cards from a deck
+    def draw(deck, n = 1)
+      n.times do
+        @cards << deck.draw unless deck.empty?
+      end
     end
-  end
 
-  # Enumerable#each
-  def each(&block)
-    @cards.each do |card|
-      if block_given?
-        block.call card
-      else
-        yield card
+    # Enumerable#each
+    def each(&block)
+      @cards.each do |card|
+        if block_given?
+          block.call card
+        else
+          yield card
+        end
       end
     end
-  end
 
-  # displaying the card icons
-  # using extensions/string.rb for String#next
-  def to_s
-    @cards.map(&:to_s).inject(:next)
-  end
+    # displaying the card icons
+    # using extensions/string.rb for String#next
+    def to_s
+      @cards.map(&:to_s).inject(:next)
+    end
 
+  end
 end

data/lib/rubycards/version.rb

@@ -1,3 +1,3 @@
-module Rubycards
-  VERSION = "0.0.1"
+module RubyCards
+  VERSION = "0.0.2"
 end

data/rubycards.gemspec

@@ -5,7 +5,7 @@ require 'rubycards/version'
 
 Gem::Specification.new do |gem|
   gem.name          = "rubycards"
-  gem.version       = Rubycards::VERSION
+  gem.version       = RubyCards::VERSION
   gem.authors       = ["Jordan Scales", "Joe Letizia"]
   gem.email         = ["scalesjordan@gmail.com", "joe.letizia@gmail.com"]
   gem.description   = "RubyCards"

data/spec/card_spec.rb

@@ -1,5 +1,7 @@
 require 'rubycards'
 
+include RubyCards
+
 describe Card do
   describe '#initialize' do
     context 'no params' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubycards
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors: