Ruby_Dice 1.0.0.pre.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0b41e4272ad3e63b64929479bca5d394678b8d8
-  data.tar.gz: bd450c716e3859116be0fa928c521ca299382ff9
+  metadata.gz: ef8117351f5cfdb375f63cbda1f3da98d3da62aa
+  data.tar.gz: f108f818986f325633806d14022096b585f17c9a
 SHA512:
-  metadata.gz: e1be61f9c2979458163467c3d16c8c9ee546779ee19859539651bdbb2bb0326a1cdccd482559be94fd3575722efe9ffef59f4b35f26351635d0dcd96ed9b281d
-  data.tar.gz: 0311fda4468da9264582b638bc8ef9c910f4ca1fa13404f7b0c507549ae1d16c4f2179a0f66b1a9c94831a820ba781cf7d6289484333fdabb07a1f48460219a7
+  metadata.gz: 04d5812de399b4e905d9f6ac7a28e6d465683b69b1b421e21c5df7bb04ec1aba8edcca237fb07ac348e53a64050396332e7614e12676a567e17340832d214bee
+  data.tar.gz: 84fcd63edbfbf2bef34de656b78e72619f111eb3982c1ec5c439b837a1f33c1e6320936488f3b339cf0b501e090fed851c0f8698b6d5b2fd1fda0a63d471bef6

data/bin/Ruby_Dice

@@ -1,27 +1,38 @@
 #!/usr/bin/env ruby
 BEGIN { # Checks for options
-  if ARGV.include? "-h"
-    puts <<HELP
+	if ARGV.include? "-h"
+    		puts <<HELP
 Usage: $ Ruby_Dice [--help]
 	\u00B7 --help -> Displays this help message
 Gameplay:
-	Abbreviations:
-		\u00B7 1	->	Ones 
-		\u00B7 2	->	Twos 
-		\u00B7 3	->	Threes
-		\u00B7 4	->	Fours 
-		\u00B7 5	->	Fives 
-		\u00B7 6	->	Sixes 
-		\u00B7 ss	->	Small Straight 
-		\u00B7 ls	->	Large Straight 
-		\u00B7 tok	->	Three Of A Kind 
-		\u00B7 fok	->	Four Of A Kind 
-		\u00B7 fh 	-> 	Full House 
-		\u00B7 y 	->	Yahtzee 
-		\u00B7 ?	->	Chance
+	\u00B7	Rolling:
+		\u00B7	You must not put any scoring abbreviations in your input (See Scoring Abbreviations)
+		\u00B7	You can only roll twice before you must score
+		\u00B7	Select the characters of the dice you want to roll again
+			\u00B7	The characters must consist of at least one of these: ZXCVB
+			\u00B7	They can be touching
+			\u00B7	They can be in any order
+	\u00B7	Scoring:
+		\u00B7	You must not roll
+		\u00B7	You must use an abbreviation specified in Scoring Abbreviations
+		\u00B7	It must be available (with the exeception of Yahztee, which can be used multiple times)
+	\u00B7	Scoring Abbreviations:
+		\u00B7	1	->	Ones 
+		\u00B7	2	->	Twos 
+		\u00B7	3	->	Threes
+		\u00B7	4	->	Fours 
+		\u00B7	5	->	Fives 
+		\u00B7	6	->	Sixes 
+		\u00B7	ss	->	Small Straight 
+		\u00B7	ls	->	Large Straight 
+		\u00B7	tok	->	Three Of A Kind 
+		\u00B7	fok	->	Four Of A Kind 
+		\u00B7	fh 	-> 	Full House 
+		\u00B7	y 	->	Yahtzee 
+		\u00B7	?	->	Chance
 HELP
-    exit
-  end
+		exit
+	end
 }
 
 require "Ruby_Dice"

data/lib/dice.rb

@@ -7,8 +7,6 @@ class Dice  # Class for working with the 5 dice at the same time
 		@values = values
 	end 
 
-# @!group Roll Methods
-
 =begin
 @raise [ArgumentError] if i element > 4
 @return [void]
@@ -30,7 +28,6 @@ class Dice  # Class for working with the 5 dice at the same time
 		initialize
 	end
 
-# @!endgroup
 
 	def to_s # @return [String] instance variable dice
 		print @values

data/lib/scoresheet.rb

@@ -56,8 +56,6 @@ class ScoreSheet # Keeps score throughout the game
 		lower_score_total + upper_score_total
 	end
 	
-
-
 =begin
 Checks if upper score bonus can be awarded
 @return [Fixnum] 0 if raw_upper < 63
@@ -70,7 +68,7 @@ Checks if upper score bonus can be awarded
 		end
 	end
 =begin
-@return [Fixnum]
+@return [Integer]
 Checks to see if you have all the of the same dice
 =end
 	def yahtzee
@@ -127,7 +125,7 @@ Checks to see if you have all the of the same dice
 Replace underscores with spaces
 =end
 	def format_score(score_region, index)
-		score_label = "#{score_region[index]}".tr(?_, " ")
+		score_label = score_region[index].to_s.tr(?_, " ")
 		cap_label score_label
 		score_field = @sheet[score_region[index]]
 		return justify_score(score_label, "#{score_field[1]? score_field[0]:?-}")
@@ -140,11 +138,11 @@ Replace underscores with spaces
 =begin
 @param score_label [String]
 @return [String]
-Capitalize each letter of each word only if the score label has two words
+Capitalize each letter of each word only if the score label has two or more words
 Else only capitalize the first letter of the score label
 =end
 	def cap_label(score_label)
-		if score_label.split.length == 2
+		if score_label.split.length >= 2
 			score_label = score_label.split.map(&:capitalize)*' '
 		else
 			score_label.capitalize!

data/lib/scoring.rb

@@ -7,9 +7,10 @@ module Scoring # methods for calculating score
 	LowerScores = :three_of_a_kind, :four_of_a_kind, :full_house, :small_straight, :large_straight, :chance, :yahtzee  # The fields on the bottom section of the score sheet
 
 =begin
-Checks to see if you have 3 of one kind of dice and 2 of another
-@return [Fixnum] 25 if @dice.dice contains 3 of one Fixnum and 2 of another
-@return [Fixnum] 0 if @dice.dice does not contain 3 of one Fixnum and 2 of another
+@param dice [Array<Fixnum>] The dice to be tested
+Checks to see if dice has 3 of one kind of dice and 2 of another
+@return [Fixnum] 25 if dice contains 3 of one Fixnum and 2 of another
+@return [Fixnum] 0 if dice does not contain 3 of one Fixnum and 2 of another
 =end
 	def full_house(dice)
 		f_table = freq dice
@@ -19,10 +20,11 @@ Checks to see if you have 3 of one kind of dice and 2 of another
 	end
 	
 =begin
+@param dice [Array<Fixnum>] The dice to be tested
 Checks to see if you have 4 of the same dice
 @return [Fixnum]  0 if <= 4 indices have the same value
 @return [Fixnum]  dice.reduce(:+) if >= 4 indices have the same value
-@see (#three_of_a_kind)
+@see (three_of_a_kind)
 =end
 	def four_of_a_kind(dice)
 		of_a_kind dice, 4
@@ -30,28 +32,48 @@ Checks to see if you have 4 of the same dice
 
 =begin
 @param d [Array<Fixnum>] the dice to be tested
-@return [Fixnum] the score
+@return [Fixnum] the total of all the ones
 =end
 	def ones(d)
 		single_face d, 1
 	end
 
-	def twos(d)	# @see (#ones)
+=begin
+@param d [Array<Fixnum>] the dice to be tested
+@return [Fixnum] the total of all the twos
+=end
+	def twos(d)
 		single_face d, 2
 	end
 
-	def threes(d)	# @see (#ones)
+=begin
+@param d [Array<Fixnum>] the dice to be tested
+@return [Fixnum] the score
+=end
+	def threes(d)
 		single_face d, 3
 	end 
 
-	def fours(d)	# @see (#ones)
+=begin
+@param d [Array<Fixnum>] the dice to be tested
+@return [Fixnum] the score
+=end
+	def fours(d)
 		single_face d, 4
 	end
-
-	def fives(d)	# @see (#ones)
+	
+=begin
+@param d [Array<Fixnum>] the dice to be tested
+@return [Fixnum] the score
+=end
+	def fives(d)
 		single_face d, 5
 	end
 
+=begin
+@param d [Array<Fixnum>] the dice to be tested
+@return [Fixnum] the score
+=end
 	def sixes(d)	# @see (#ones)
 		single_face d, 6
 	end
@@ -78,7 +100,7 @@ Checks to see if you have 3 of the same dice
 @param dice [Array<Fixnum>] the dice to be tested
 @return [Fixnum] 30 if there are 3 consecutive Fixnums in dice
 @return [Fixnum] 0 if there are not three conscecutive Fixnums in dice
-@see (#large_straight)
+@see (large_straight)
 =end
 	def small_straight(dice)
 		straight dice, 4, 30
@@ -89,7 +111,7 @@ Checks to see if you have 3 of the same dice
 @param dice [Array<Fixnum>] the dice to be tested
 @return [Fixnum] 40 if there are 4 consecutive Fixnums in dice
 @return [Fixnum] 0 if there are not three conscecutive Fixnums in dice
-@see (#small_straight)
+@see (small_straight)
 =end
 	def large_straight(dice)
 		straight dice, 5, 40
@@ -98,32 +120,32 @@ Checks to see if you have 3 of the same dice
 	
 	private # Helper methods for score calculation
 
-		def single_face(dice, value)
-		 	v = dice.select{|number| number == value}.reduce :+
-		 	unless v.nil?
-		 		return v
-		 	else
-		 		return 0
-		 	end
+	def single_face(dice, value)
+	 	v = dice.select{|number| number == value}.reduce :+
+	 	unless v.nil?
+		 	return v
+		else
+		 	return 0
 		end
+	end
 
-		def freq(dice)
-			dice.inject(Hash.new(0)) { |h,v| h[v] += 1; h }
-		end
+	def freq(dice)
+		dice.inject(Hash.new(0)) { |h,v| h[v] += 1; h }
+	end
 
-		def modal_frequency(dice)
-			freq(dice).max_by{|k,v| v}[1]
-		end 
+	def modal_frequency(dice)
+		freq(dice).max_by{|k,v| v}[1]
+	end 
 
-		def of_a_kind(dice, limit)
-			if modal_frequency(dice) >= limit
-				dice.reduce :+
-			else
-				0
-			end
+	def of_a_kind(dice, limit)
+		if modal_frequency(dice) >= limit
+			dice.reduce :+
+		else
+			0
 		end
+	end
 
-=begin
+=begin	
 @param dice [Fixnum] the dice to be tested
 @param limit [Fixnum] = 4 for small straight
 @param limit [Fixnum] = 5 for large straight
@@ -132,14 +154,11 @@ common code for both small straight (SS) and large straight (LS)
 @return [Fixnum] score
 =end
 	def straight(dice, limit, score) 
-		#each_cons is generating every possible value for a straight of length limit
-		(1..6).each_cons(limit).each do |i|
-			# Asking if i is a subset of dice
-			if (i - dice).empty?
+		(1..6).each_cons(limit).each do |i| #each_cons is generating every possible value for a straight of length limit
+			if (i - dice).empty? # Asking if i is a subset of dice
 				return score if (i - dice)
 			end
 		end
 		return 0
 	end
-
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: Ruby_Dice
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Zachary Perlmutter
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-27 00:00:00.000000000 Z
+date: 2014-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -76,9 +76,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements:
 - Terminal
 rubyforge_project: