game_shuffle_cards 1.0.4

data/features/initial_settings.feature

@@ -0,0 +1,76 @@
+Feature: Initials Setting
+  Checking the valid settings
+	Scenario Outline: Checking Maximun Cards per Player
+		Given one user has set a Game with <Players> to shuffle cards
+		When I check the game restrictions
+		Then It should has this <Maximun Cards per Player>
+		Examples:
+			| Players | Maximun Cards per Player	|
+			|		1			|						52							|
+			|		2			|						26							|
+			|		3			|						17							|
+			|		4			|						13							|
+			|		5			|						10							|
+			|		6			|						8								|
+			|		7			|						7								|
+			|		8			|						6								|
+			|		9			|						5								|
+			|		10		|						5								|
+			|		11		|						4								|
+			|		12		|						4								|
+			|		13		|						4								|
+			|		14		|						3								|
+			|		15		|						3								|
+			|		16		|						3								|
+			|		17		|						3								|
+			|		18		|						2								|
+			|		19		|						2								|
+			|		20		|						2								|
+			|		21		|						2								|
+			|		22		|						2								|
+			|		23		|						2								|
+			|		24		|						2								|
+			|		25		|						2								|
+			|		26		|						2								|
+			|		27		|						1								|
+			|		28		|						1								|
+			|		29		|						1								|
+			|		30		|						1								|
+			|		31		|						1								|
+			|		32		|						1								|
+			|		33		|						1								|
+			|		34		|						1								|
+			|		35		|						1								|
+			|		36		|						1								|
+			|		37		|						1								|
+			|		38		|						1								|
+			|		39		|						1								|
+			|		40		|						1								|
+			|		41		|						1								|
+			|		42		|						1								|
+			|		43		|						1								|
+			|		44		|						1								|
+			|		45		|						1								|
+			|		46		|						1								|
+			|		47		|						1								|
+			|		48		|						1								|
+			|		49		|						1								|
+			|		50		|						1								|
+			|		51		|						1								|
+			|		52		|						1								|
+
+	Scenario Outline: Checking limits restrictions
+		When I start a game with this number of <Players>
+		And and this <Cards per Player>
+		Then I should rescue this <Error>
+
+		Examples:
+			| Players	|	Cards per Player	| Error													|
+			| 60			|	1									| ToManyPlayersError						|
+			| 1				|	53								|	ToManyCardsPerPlayerError			|
+			|	0				|	2									|	NotEnoughPlayersError					|
+			|	2				|	0									|	NotEnoughCardsPerPlayersError	|
+			| 4				|	16								| TooManyCardsDemandedError			|
+			| ff			|	16								| TypeError											|
+			| 8				|	hh55p							| TypeError											|
+			| fesef1	|	hh55p							| TypeError											|

data/features/step_definitions/deck_of_cards_step.rb

@@ -0,0 +1,21 @@
+Given(/^this deak of cards defined to check$/) do |table|
+  @deck= table.raw
+end
+
+When(/^I list the cards$/) do
+  @game = Game.new
+  @card_list =[]
+
+  @game.cards_collection.keys.each do |key|
+		@card_list.push [key]
+  end
+
+end
+Then(/^all should be included$/) do
+	expect(@card_list).to match_array(@deck)
+
+end
+
+Then(/^they should be a total of (\d+)$/) do |total_cards|
+  expect(@game.cards_collection.count).to eq(total_cards.to_i)
+end

data/features/step_definitions/initial_settings_step.rb

@@ -0,0 +1,44 @@
+Given(/^one user has set a Game with (\d+) to shuffle cards$/) do |players|
+	# create a new game with the given playeres
+	@game =  Game.new(players.to_i,1)
+end
+
+When(/^I check the game restrictions$/) do
+  @maximun_cards_per_player = @game.maximun_cards_per_player
+end
+
+Then(/^It should has this (\d+)$/) do |maximun_cards_per_player|
+  expect(@maximun_cards_per_player).to eq(maximun_cards_per_player.to_i)
+end
+
+When(/^I start a game with this number of (\w+)$/) do |players|
+  @players=players
+end
+
+And(/^and this (\w+)$/) do |cards_per_player|
+  @cards_per_player = cards_per_player
+end
+
+
+Then(/^I should rescue this ToManyPlayersError$/) do
+	expect{@game = Game.new(@players,@cards_per_player)}.to raise_error(ToManyPlayersError)
+end
+
+Then(/^I should rescue this ToManyCardsPerPlayerError$/) do
+	expect{@game = Game.new(@players,@cards_per_player)}.to raise_error(ToManyCardsPerPlayerError)
+end
+
+Then(/^I should rescue this NotEnoughPlayersError$/) do
+	expect{@game = Game.new(@players,@cards_per_player)}.to raise_error(NotEnoughPlayersError)
+end
+
+Then(/^I should rescue this NotEnoughCardsPerPlayersError$/) do
+	expect{@game = Game.new(@players,@cards_per_player)}.to raise_error(NotEnoughCardsPerPlayersError)
+end
+
+Then(/^I should rescue this TooManyCardsDemandedError$/) do
+	expect{@game = Game.new(@players,@cards_per_player)}.to raise_error(TooManyCardsDemandedError)
+end
+Then(/^I should rescue this TypeError$/) do
+  expect{@game = Game.new(@players,@cards_per_player)}.to raise_error(TypeError)
+end

data/features/step_definitions/step.rb

@@ -0,0 +1,2 @@
+
+require 'game_shuffle_cards'

data/game_shuffle_cards.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'game_shuffle_cards/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "game_shuffle_cards"
+  spec.version       = GameShuffleCards::VERSION
+  spec.authors       = ["Diego"]
+  spec.email         = ["diego@guiasrails.es"]
+  spec.summary       = "A Game to shuffle a deck of cards and presents the result"
+  spec.description   = "With the class Game you can handle a deck of cards and setting the players and the cards per player. And shuffle the deak of cards."
+  spec.homepage      = ""
+  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_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.has_rdoc = 'yard'
+end

data/lib/game_shuffle_cards/card.rb

@@ -0,0 +1,26 @@
+
+module GameShuffleCards
+
+	# @author Diego Hernán Piccinini Lagos
+	class Card
+
+		# Create a new card
+		# @param card_value [String]
+		# @param suit [String]
+		def initialize(card_value,suit)
+			@id= card_value + ' of ' + suit
+			@card_value=card_value
+			@suit=suit
+		end
+		attr_reader	:id, :card_value, :suit, :image
+
+		# Get a image name file
+		# @param id [String]
+		# @return a file name [String]
+		class << self
+			def image(id)
+				id.tr(' ','_') + '.png'
+			end
+		end
+	end
+end

data/lib/game_shuffle_cards/exceptions.rb

@@ -0,0 +1,9 @@
+
+
+module GameShuffleCards
+	class ToManyPlayersError < RangeError; end
+	class NotEnoughPlayersError < RangeError; end
+	class ToManyCardsPerPlayerError < RangeError; end
+	class NotEnoughCardsPerPlayersError < RangeError; end
+	class TooManyCardsDemandedError < RangeError; end
+end

data/lib/game_shuffle_cards/game.rb

@@ -0,0 +1,84 @@
+
+
+module GameShuffleCards
+	# This class is the main class to shuffle a deck of cards
+	# @author Diego Piccinini Lagos
+	class Game
+		# the minimun cards per player
+		MINIMUN_CARDS = 1
+
+		# the minimun players in a game
+		MINIMUN_PLAYERS= 1
+
+		# the default value of players
+		PLAYERS = 2
+
+		# the defaul value of cards per player
+		CARDS_PER_PLAYER = 3
+
+		# The suit collection of the deck of cards
+		SUITS = ['spades', 'hearts', 'diamonds', 'clubs']
+
+		# The cards values collection
+		CARDS_VALUES = ['A','2','3','4','5','6','7','8','9','10','J','Q','K']
+
+		# Count total cards in a deck
+		TOTAL_CARDS = SUITS.count * CARDS_VALUES.count
+
+		# Maximun players allowed in a Game
+		MAXIMUN_PLAYERS = TOTAL_CARDS # the maximun players in a game
+
+		# Initialize the game players and cards per player you want
+		# @param players [String|Integer] the number of players in the game
+		# @param cards_per_player [String|Integer] the number of cards that will recieve each player
+		def initialize(players = PLAYERS, cards_per_player=CARDS_PER_PLAYER)
+			# Validate the input params and parse values
+			@players, @cards_per_player = ValidateGame.parse_and_validate(players,cards_per_player)
+
+			# The card collection, all the cards in the deck
+			@cards_collection = {}
+
+			CARDS_VALUES.each do |card_value|
+				SUITS.each do |suit|
+					# Create one card and add it to cards_collections
+					card = Card.new(card_value,suit)
+					@cards_collection[card.id]=card
+				end
+				# add the cards keys to the cards availables
+				@cards_availables= @cards_collection.keys
+			end
+			# Initialize the maximun possible of cards per player,
+			# given a card collection and a number of players
+			@maximun_cards_per_player = Game.get_maximun_cards_per_player(@players)
+
+		end
+		attr_reader :players, :cards_per_player,  :cards_collection, :maximun_cards_per_player
+		attr_accessor :cards_availables
+
+		# Shuffle the deck of cards
+		# @return a group of players [Hash] each with their cards
+		def results
+			players={}
+			@players.times do |player|
+				players[player]=get_cards
+			end
+			return players
+		end
+
+		# Get cards of the cards still availables in the deck
+		# @return group of cards [Array] an array of cards_per_player
+		def get_cards
+			cards=@cards_availables.sample(@cards_per_player)
+			@cards_availables-= cards
+			cards
+		end
+
+		# Get the maximun of cards per player,
+		# given a card collection and a number of players
+		# @return maximun cards per player [Integer]
+		def self.get_maximun_cards_per_player(players)
+			players = ValidateGame.parse_and_validate_players(players)
+			TOTAL_CARDS / players
+		end
+	end
+end

data/lib/game_shuffle_cards/validate_game.rb

@@ -0,0 +1,43 @@
+
+module GameShuffleCards
+	# @author Diego Hernán Piccinini Lagos
+	# validation to secure the inputs of the Game
+	class ValidateGame
+		class << self
+			# Given two values String or Integer, checks whether they are valid in a context Game
+			# then return the integers values or raise an exception
+			# @param players [String|Integer]
+			# @param cards_per_player [String|Integer]
+			# @return players and cards per player [Array] with integers values of each one
+			def parse_and_validate(players, cards_per_player)
+				begin
+					players = Integer(players)
+					cards_per_player= Integer(cards_per_player)
+
+				rescue
+					raise TypeError
+				end
+				raise GameShuffleCards::ToManyPlayersError if players > GameShuffleCards::Game::MAXIMUN_PLAYERS
+				raise GameShuffleCards::NotEnoughPlayersError if players < GameShuffleCards::Game::MINIMUN_PLAYERS
+				raise GameShuffleCards::ToManyCardsPerPlayerError if cards_per_player > GameShuffleCards::Game::TOTAL_CARDS
+				raise GameShuffleCards::NotEnoughCardsPerPlayersError if cards_per_player < GameShuffleCards::Game::MINIMUN_CARDS
+				raise GameShuffleCards::TooManyCardsDemandedError if (players * cards_per_player) > GameShuffleCards::Game::TOTAL_CARDS
+				[players,cards_per_player]
+			end
+
+			# Validates whether the amount and type of players are right. Otherwise raise an exception
+			# @param players [String|Integer]
+			# @return number of players [Integer]
+			def parse_and_validate_players(players)
+				begin
+					players = Integer(players)
+				rescue
+					raise TypeError
+				end
+				raise GameShuffleCards::ToManyPlayersError if players > GameShuffleCards::Game::MAXIMUN_PLAYERS
+				raise GameShuffleCards::NotEnoughPlayersError if players < GameShuffleCards::Game::MINIMUN_PLAYERS
+				players
+			end
+		end
+	end
+end

data/lib/game_shuffle_cards/version.rb

@@ -0,0 +1,5 @@
+Dir[File.join(File.dirname(__FILE__),'*.rb')].each {|file| require file }
+
+module GameShuffleCards
+  VERSION = "1.0.4"
+end

data/lib/game_shuffle_cards.rb

@@ -0,0 +1,2 @@
+require "game_shuffle_cards/version"
+include GameShuffleCards

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: game_shuffle_cards
+version: !ruby/object:Gem::Version
+  version: 1.0.4
+platform: ruby
+authors:
+- Diego
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: With the class Game you can handle a deck of cards and setting the players
+  and the cards per player. And shuffle the deak of cards.
+email:
+- diego@guiasrails.es
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- doc/GameShuffleCards.html
+- doc/GameShuffleCards/Card.html
+- doc/GameShuffleCards/Game.html
+- doc/GameShuffleCards/NotEnoughCardsPerPlayersError.html
+- doc/GameShuffleCards/NotEnoughPlayersError.html
+- doc/GameShuffleCards/ToManyCardsPerPlayerError.html
+- doc/GameShuffleCards/ToManyPlayersError.html
+- doc/GameShuffleCards/TooManyCardsDemandedError.html
+- doc/GameShuffleCards/ValidateGame.html
+- doc/_index.html
+- doc/class_list.html
+- doc/css/common.css
+- doc/css/full_list.css
+- doc/css/style.css
+- doc/file.README.html
+- doc/file_list.html
+- doc/frames.html
+- doc/index.html
+- doc/js/app.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/method_list.html
+- doc/top-level-namespace.html
+- features/deck_of_cards.feature
+- features/initial_settings.feature
+- features/step_definitions/deck_of_cards_step.rb
+- features/step_definitions/initial_settings_step.rb
+- features/step_definitions/step.rb
+- game_shuffle_cards.gemspec
+- lib/game_shuffle_cards.rb
+- lib/game_shuffle_cards/card.rb
+- lib/game_shuffle_cards/exceptions.rb
+- lib/game_shuffle_cards/game.rb
+- lib/game_shuffle_cards/validate_game.rb
+- lib/game_shuffle_cards/version.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A Game to shuffle a deck of cards and presents the result
+test_files:
+- features/deck_of_cards.feature
+- features/initial_settings.feature
+- features/step_definitions/deck_of_cards_step.rb
+- features/step_definitions/initial_settings_step.rb
+- features/step_definitions/step.rb
+has_rdoc: yard