RubyGems - physh_roller - Versions diffs - 0.0.1 - Mend

physh_roller 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (60) hide show

checksums.yaml +7 -0
data/LICENSE +7 -0
data/README +1 -0
data/bin/dice +42 -0
data/doc/Object.html +204 -0
data/doc/Output.html +226 -0
data/doc/PhyshRoller.html +140 -0
data/doc/PhyshRoller/DiceRoll.html +498 -0
data/doc/PhyshRoller/Die.html +266 -0
data/doc/created.rid +14 -0
data/doc/doc/created_rid.html +97 -0
data/doc/features/physh_roller/parse_dice_roll_string_feature.html +117 -0
data/doc/features/physh_roller/roll_dice_feature.html +119 -0
data/doc/features/physh_roller/roll_die_feature.html +117 -0
data/doc/images/add.png +0 -0
data/doc/images/arrow_up.png +0 -0
data/doc/images/brick.png +0 -0
data/doc/images/brick_link.png +0 -0
data/doc/images/bug.png +0 -0
data/doc/images/bullet_black.png +0 -0
data/doc/images/bullet_toggle_minus.png +0 -0
data/doc/images/bullet_toggle_plus.png +0 -0
data/doc/images/date.png +0 -0
data/doc/images/delete.png +0 -0
data/doc/images/find.png +0 -0
data/doc/images/loadingAnimation.gif +0 -0
data/doc/images/macFFBgHack.png +0 -0
data/doc/images/package.png +0 -0
data/doc/images/page_green.png +0 -0
data/doc/images/page_white_text.png +0 -0
data/doc/images/page_white_width.png +0 -0
data/doc/images/plugin.png +0 -0
data/doc/images/ruby.png +0 -0
data/doc/images/tag_blue.png +0 -0
data/doc/images/tag_green.png +0 -0
data/doc/images/transparent.png +0 -0
data/doc/images/wrench.png +0 -0
data/doc/images/wrench_orange.png +0 -0
data/doc/images/zoom.png +0 -0
data/doc/index.html +94 -0
data/doc/js/darkfish.js +155 -0
data/doc/js/jquery.js +18 -0
data/doc/js/navigation.js +142 -0
data/doc/js/search.js +94 -0
data/doc/js/search_index.js +1 -0
data/doc/js/searcher.js +228 -0
data/doc/rdoc.css +595 -0
data/doc/table_of_contents.html +98 -0
data/features/physh_roller/parse_dice_roll_string.feature +19 -0
data/features/physh_roller/roll_dice.feature +22 -0
data/features/physh_roller/roll_die.feature +19 -0
data/features/step_definitions/physh_roller/physh_roller_steps.rb +79 -0
data/features/support/env.rb +3 -0
data/lib/physh_roller.rb +2 -0
data/lib/physh_roller/dice_roll.rb +62 -0
data/lib/physh_roller/die.rb +14 -0
data/spec/physh_roller/dice_roll_spec.rb +145 -0
data/spec/physh_roller/die_spec.rb +44 -0
data/spec/spec_helper.rb +3 -0
metadata +133 -0

data/doc/table_of_contents.html ADDED Viewed

@@ -0,0 +1,98 @@
+<!DOCTYPE html>
+<html>
+<head>
+<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
+<title>Table of Contents - RDoc Documentation</title>
+<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet">
+<script type="text/javascript">
+  var rdoc_rel_prefix = "./";
+</script>
+<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/search.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script>
+<body class="indexpage">
+<h1>Table of Contents - RDoc Documentation</h1>
+<h2>Pages</h2>
+<ul>
+  <li class="file">
+    <a href="doc/created_rid.html">created.rid</a>
+  </li>
+    <li class="file">
+    <a href="features/physh_roller/parse_dice_roll_string_feature.html">parse_dice_roll_string.feature</a>
+  </li>
+    <li class="file">
+    <a href="features/physh_roller/roll_dice_feature.html">roll_dice.feature</a>
+  </li>
+    <li class="file">
+    <a href="features/physh_roller/roll_die_feature.html">roll_die.feature</a>
+  </li>
+</ul>
+<h2 id="classes">Classes/Modules</h2>
+<ul>
+  <li class="class">
+    <a href="Object.html">Object</a>
+  </li>
+    <li class="class">
+    <a href="Output.html">Output</a>
+  </li>
+    <li class="module">
+    <a href="PhyshRoller.html">PhyshRoller</a>
+  </li>
+    <li class="class">
+    <a href="PhyshRoller/DiceRoll.html">PhyshRoller::DiceRoll</a>
+  </li>
+    <li class="class">
+    <a href="PhyshRoller/Die.html">PhyshRoller::Die</a>
+  </li>
+</ul>
+<h2 id="methods">Methods</h2>
+<ul>
+    <li class="method"><a href="PhyshRoller/Die.html#method-c-new">::new &mdash; PhyshRoller::Die</a>
+    <li class="method"><a href="PhyshRoller/DiceRoll.html#method-c-new">::new &mdash; PhyshRoller::DiceRoll</a>
+    <li class="method"><a href="PhyshRoller/DiceRoll.html#method-i-add_dice_to_dice_array">#add_dice_to_dice_array &mdash; PhyshRoller::DiceRoll</a>
+    <li class="method"><a href="Output.html#method-i-messages">#messages &mdash; Output</a>
+    <li class="method"><a href="PhyshRoller/DiceRoll.html#method-i-number_of_dice">#number_of_dice &mdash; PhyshRoller::DiceRoll</a>
+    <li class="method"><a href="Object.html#method-i-output">#output &mdash; Object</a>
+    <li class="method"><a href="Output.html#method-i-puts">#puts &mdash; Output</a>
+    <li class="method"><a href="PhyshRoller/DiceRoll.html#method-i-results">#results &mdash; PhyshRoller::DiceRoll</a>
+    <li class="method"><a href="PhyshRoller/Die.html#method-i-roll">#roll &mdash; PhyshRoller::Die</a>
+    <li class="method"><a href="PhyshRoller/DiceRoll.html#method-i-roll_dice">#roll_dice &mdash; PhyshRoller::DiceRoll</a>
+    <li class="method"><a href="PhyshRoller/DiceRoll.html#method-i-set_default_values">#set_default_values &mdash; PhyshRoller::DiceRoll</a>
+    <li class="method"><a href="PhyshRoller/DiceRoll.html#method-i-valid_dice_roll_string-3F">#valid_dice_roll_string? &mdash; PhyshRoller::DiceRoll</a>
+</ul>
+<footer id="validator-badges">
+  <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
+  <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 4.0.0.
+  <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
+</footer>

data/features/physh_roller/parse_dice_roll_string.feature ADDED Viewed

@@ -0,0 +1,19 @@
+Feature: Parse String To Dice Roll
+	As a user
+	To create a dice roll
+	I want to parse a string in to its components
+	Scenario Outline: parse valid dice roll string
+		Given I want to roll some dice
+		When I create a new dice roll with the string "<string>"
+		Then the number of dice should be "<number_of_dice>"
+		And the sides on the dice should be "<sides_on_dice>"
+		And the roll modifier should be "<roll_modifier>"
+		Scenarios: different dice strings
+		| string | number_of_dice | sides_on_dice | roll_modifier |
+		| 1d6    | 1              | 6             | 0             |
+		| 3d4    | 3              | 4             | 0             |
+		| 1d6+1  | 1              | 6             | 1             |
+		| 3d4-2  | 3              | 4             | -2            |

data/features/physh_roller/roll_dice.feature ADDED Viewed

@@ -0,0 +1,22 @@
+Feature: Roll dice
+	As a user
+	I want to roll a set of dice
+	To get a set of rolls and a total
+	Scenario Outline: getting the result of rolling some dice
+		Given I have a dice roll string described by "<dice_roll_string>"
+		When I roll the set of dice
+		Then the result should have "<number_of_dice>"
+		And each die roll should be equal to or greater than "<lower_limit>"
+		And each die roll should be equal to or less than "<upper_limit>"
+		And the total should be equal to or greater than "<lowest_total>"
+		And the total should be equal to or less than "<upper_total>"
+		Scenarios: different dice strings
+		| dice_roll_string | lower_limit | upper_limit | lowest_total | upper_total | number_of_dice |
+		| 1d6    					 | 1           | 6           | 1            | 6           | 1              |
+		| 3d4              | 1           | 4           | 3            | 12          | 3              |
+		| 1d6+1            | 1           | 6           | 2            | 7           | 1              |
+		| 3d4-2            | 1           | 4           | 1            | 10          | 3              |

data/features/physh_roller/roll_die.feature ADDED Viewed

@@ -0,0 +1,19 @@
+Feature: Simple Die Roll
+	As a user
+	I want to roll a die
+	To generate a random number between 1 and the number of sides on the die
+	Scenario Outline: Roll a die
+		Given I want to roll a die with "<sides_on_die>" sides
+		When I roll the die
+		Then the result should be between "1" and "<sides_on_die>"
+		Scenarios: different sides on die
+		| sides_on_die |
+		| 2						 |
+		| 6            |
+		| 12           |
+		| 100          |
+		| 1000         |
+		| 3            |

data/features/step_definitions/physh_roller/physh_roller_steps.rb ADDED Viewed

@@ -0,0 +1,79 @@
+class Output
+	def messages
+		@messages = []
+	end
+	def puts(message)
+		messages << message
+	end
+end
+def output
+	@output ||= Output.new
+end
+Given /^I want to roll some dice$/ do
+end
+When /^I create a new dice roll with the string "(.*?)"$/ do |dice_roll_string|
+  @dice_roll = PhyshRoller::DiceRoll.new(dice_roll_string, output)
+end
+Then /^the number of dice should be "(.*?)"$/ do |number_of_dice|
+  @dice_roll.number_of_dice.should == number_of_dice.to_i
+end
+Then /^the sides on the dice should be "(.*?)"$/ do |sides_on_dice|
+  @dice_roll.sides_on_dice.should == sides_on_dice.to_i
+end
+Then /^the roll modifier should be "(.*?)"$/ do |roll_modifier|
+  @dice_roll.roll_modifier.should == roll_modifier.to_i
+end
+Given /^I want to roll a die with "(.*?)" sides$/ do |sides_on_die|
+  @die = PhyshRoller::Die.new(sides_on_die)
+end
+When /^I roll the die$/ do
+  @die.roll
+end
+Then /^the result should be between "(.*?)" and "(.*?)"$/ do |lower_limit, upper_limit|
+  @die.last_result.should be >= lower_limit.to_i
+  puts @die.last_result
+  @die.last_result.should be <= upper_limit.to_i
+end
+Given /^I have a dice roll string described by "(.*?)"$/ do |dice_roll_string|
+  @dice_roll = PhyshRoller::DiceRoll.new(dice_roll_string, output)
+end
+When /^I roll the set of dice$/ do
+  @dice_roll.roll_dice
+end
+Then /^I should see "(.*?)"$/ do |message|
+  @output.messages.should include message
+end
+Then /^the result should have "(.*?)"$/ do |number_of_dice|
+  @dice_roll.results[:dice_rolls].size.should == number_of_dice.to_i
+end
+Then /^each die roll should be equal to or greater than "(.*?)"$/ do |lower_limit|
+  @dice_roll.results[:dice_rolls].each { |roll| roll.should be >= lower_limit.to_i }
+end
+Then /^each die roll should be equal to or less than "(.*?)"$/ do |upper_limit|
+  @dice_roll.results[:dice_rolls].each { |roll| roll.should be <= upper_limit.to_i }
+end
+Then /^the total should be equal to or greater than "(.*?)"$/ do |lowest_total|
+  @dice_roll.results[:sum].should be >= lowest_total.to_i
+end
+Then /^the total should be equal to or less than "(.*?)"$/ do |highest_total|
+  @dice_roll.results[:sum].should be <= highest_total.to_i
+end

data/features/support/env.rb ADDED Viewed

@@ -0,0 +1,3 @@
+$LOAD_PATH.unshift File.expand_path('../../../lib', __FILE__)
+require 'physh_roller'

data/lib/physh_roller.rb ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ require_relative 'physh_roller/dice_roll'
2	+ require_relative 'physh_roller/die'

data/lib/physh_roller/dice_roll.rb ADDED Viewed

@@ -0,0 +1,62 @@
+module PhyshRoller
+	class DiceRoll
+		DICE_ROLL_REGEXP = /\A(\d+)?d(\d+)([\+-]\d*)?\z/i
+		attr_reader :dice_roll_string, :sides_on_dice, :roll_modifier,
+			:dice_array
+		def initialize(dice_roll_string, output=$stdout)
+			@output = output
+			@dice_roll_string = dice_roll_string.downcase.gsub(' ', '')
+			if valid_dice_roll_string?
+				set_default_values
+				add_dice_to_dice_array(@number_of_dice, @sides_on_dice)
+			else
+				raise ArgumentError.new('Invalid dice roll string.')
+			end
+		end
+		def valid_dice_roll_string?
+			!!(@dice_roll_string =~ DICE_ROLL_REGEXP)
+		end
+		def set_default_values
+			@number_of_dice, @sides_on_dice, @roll_modifier =
+					DICE_ROLL_REGEXP.match(@dice_roll_string).captures.map { |capture| capture.to_i }
+			@number_of_dice = 1 unless (@number_of_dice > 0)
+			@roll_modifier ||= 0
+			@dice_array = []
+		end
+		def roll_dice
+			@dice_array.each { |die| die.roll }
+		end
+		def add_dice_to_dice_array(number_of_dice, sides_on_dice)
+			number_of_dice.times do
+				die = Die.new(sides_on_dice)
+				@dice_array << die
+			end
+		end
+		def number_of_dice
+			@dice_array.size
+		end
+		def results
+			results_hash = {
+				:dice_roll 			=> @dice_roll_string,
+				:dice_rolls 		=> @dice_array.map { |die| die.last_result }.sort,
+				:roll_modifier 	=> @roll_modifier,
+				:sum						=> (@dice_array.map { |die| die.last_result }.reduce(:+) + @roll_modifier)
+			}
+		end
+		def output_results
+			results = self.results
+			@output.puts "You rolled: #{results[:dice_roll]}"
+			@output.puts "Dice rolls: #{results[:dice_rolls].join(',')}"
+			@output.puts "Total: #{results[:sum]}"
+		end
+	end
+end

data/lib/physh_roller/die.rb ADDED Viewed

@@ -0,0 +1,14 @@
+module PhyshRoller
+	class Die
+		attr_reader :sides_on_die, :last_result
+		def initialize(sides_on_die)
+			@sides_on_die = sides_on_die.to_i
+			@last_result = 0
+		end
+		def roll
+			@last_result = rand(1..@sides_on_die)
+		end
+	end
+end

data/spec/physh_roller/dice_roll_spec.rb ADDED Viewed

@@ -0,0 +1,145 @@
+require 'spec_helper'
+module PhyshRoller
+	describe DiceRoll do
+		before(:each) { @output = double('output').as_null_object }
+		describe "attributes and method tests" do
+			context "with a valid dice_roll_string" do
+				subject { DiceRoll.new("4d6-1", @output) }
+				it { should respond_to(:dice_roll_string) }
+				it { should respond_to(:number_of_dice) }
+				it { should respond_to(:sides_on_dice) }
+				it { should respond_to(:roll_modifier) }
+				it { should respond_to(:dice_array) }
+				it { should respond_to(:results) }
+			end
+			context "with an invalid dice_roll_string" do
+				it "should raise an error" do
+					expect { DiceRoll.new("this_is_not_a_valid_dice_roll_string", @output) }.to \
+						raise_error(ArgumentError, 'Invalid dice roll string.')
+				end
+			end
+		end
+		describe "#new" do
+			subject do
+			  DiceRoll.new(passed_dice_roll_string, @output)
+		  end
+			context "passed '3d6-1' as dice roll string" do
+				let(:passed_dice_roll_string) { "3d6-1" }
+				its(:dice_roll_string)				{ should == "3d6-1" }
+				its(:number_of_dice)					{ should == 3 }
+				its(:sides_on_dice)						{ should == 6 }
+				its(:roll_modifier)						{ should == -1 }
+			end
+			context "passed 'D4' as dice roll string" do
+				let(:passed_dice_roll_string) { "D4" }
+				its(:dice_roll_string)				{ should == "d4" }
+				its(:number_of_dice)					{ should == 1 }
+				its(:sides_on_dice)						{ should == 4 }
+				its(:roll_modifier)						{ should == 0 }
+			end
+		end
+		describe "#valid_dice_roll_string?" do
+			context "with a valid dice_roll_string" do
+				subject { DiceRoll.new("12d20-10", @output) }
+				its(:valid_dice_roll_string?)	{ should be_true }
+			end
+			context "with an invalid dice_roll_string" do
+				it "should raise an error" do
+					expect { DiceRoll.new("this_is_not_a_valid_dice_roll_string", @output) }.to \
+						raise_error(ArgumentError, 'Invalid dice roll string.')
+				end
+			end
+		end
+		describe "#roll_dice" do
+			context "passed '3D6-1' as the dice_roll_string" do
+				before(:each) { @dice_roll = DiceRoll.new("3D6-1", @output) }
+				after(:each)	{ @dice_roll.roll_dice }
+				it "should roll each die in :dice_array" do
+					@dice_roll.dice_array.each do |die|
+						die.should_receive(:roll)
+					end
+				end
+			end
+		end
+		describe "#add_dice_to_dice_array" do
+			before(:each) { @dice_roll = DiceRoll.new("3d6-1", @output) }
+			context "with number_of_dice == 1 and sides_on_dice == 6" do
+				it "should add another die to the :dice-array" do
+					expect { @dice_roll.add_dice_to_dice_array(1, 6) }.to \
+						change { @dice_roll.dice_array.size }.by(1)
+				end
+			end
+			context "with number_of_dice == 3 and sides_on_dice == 6" do
+				it "should add another die to the :dice-array" do
+					expect { @dice_roll.add_dice_to_dice_array(3, 6) }.to \
+						change { @dice_roll.dice_array.size }.by(3)
+				end
+			end
+		end
+		describe "#results" do
+			context "before rolling the dice '99d20-10'" do
+				subject { DiceRoll.new("99d20-10", @output).results }
+				it 											{ should be_a_kind_of(Hash) }
+				its([:dice_roll]) 			{ should eq("99d20-10") }
+				its([:dice_rolls]) 			{ should have(99).dice }
+				its([:roll_modifier]) 	{ should == -10 }
+				its([:sum]) 						{ should be == -10 }
+			end
+			context "after rolling the dice '100d20+42'" do
+				before(:each) do
+					@dice_roll = DiceRoll.new("100d20+42", @output)
+					@dice_roll.roll_dice
+				end
+				subject { @dice_roll.results }
+				it 											{ should be_a_kind_of(Hash) }
+				its([:dice_roll]) 			{ should eq("100d20+42") }
+				its([:dice_rolls]) 			{ should have(100).dice }
+				its([:roll_modifier]) 	{ should == 42 }
+				its([:sum]) 						{ should be >= 142 }
+				its([:sum])							{ should be <= 2042 }
+			end
+		end
+		describe "#output_results" do
+			before(:each) do
+				@dice_roll = DiceRoll.new("24d3-23", @output)
+				@dice_roll.roll_dice
+			end
+			after(:each) { @dice_roll.output_results }
+			it "should output the dice roll string" do
+				@output.should_receive(:puts).with('You rolled: 24d3-23')
+			end
+			it "should output the dice rolls" do
+				@output.should_receive(:puts).with(/\ADice rolls: (\d,)+\d\z/)
+			end
+			it "should output the total" do
+				@output.should_receive(:puts).with(/\ATotal: \d+\z/)
+			end
+		end
+	end
+end