ruby-dice 1.0.0

data/README

@@ -0,0 +1,6 @@
+# This gem provides classes for dices like they are used in pen&paper role
+# playing games.
+#
+# Have a look at the examples section to see how they're used.
+#
+# Have a look at the +UA+ namespace to see how to create special dice

data/examples/example.rb

@@ -0,0 +1,16 @@
+$: << File.join(File.dirname(__FILE__), '..', 'lib')
+require 'dice/d6'
+include Dice
+
+[
+  'D6 * 3',
+  '3 * D6',
+  'D6 + 2',
+  '3 * D6 + 2',
+  '1 - D6'
+].each do |code|
+  puts '---'
+  puts "#{code} => #{eval code}"
+end
+
+

data/lib/dice/d10.rb

@@ -0,0 +1,8 @@
+require 'dice/dice'
+
+# Implements a standard 10-sided dice with a roll value range of 1-10
+class Dice::D10 < Dice::Dice
+	def initialize
+		super 1, 10
+  end
+end

data/lib/dice/d100.rb

@@ -0,0 +1,8 @@
+require 'dice/dice'
+
+# Implements a standard 100-sided dice with a roll value range of 00-99
+class Dice::D100 < Dice::Dice
+	def initialize
+		super 0, 100
+  end
+end

data/lib/dice/d12.rb

@@ -0,0 +1,8 @@
+require 'dice/dice'
+
+# Implements a standard 12-sided dice with a roll value range of 1-12
+class Dice::D12 < Dice::Dice
+	def initialize
+		super 1, 12
+  end
+end

data/lib/dice/d20.rb

@@ -0,0 +1,8 @@
+require 'dice/dice'
+
+# Implements a standard 20-sided dice with a roll value range of 1-20
+class Dice::D20 < Dice::Dice
+	def initialize
+		super 1, 20
+  end
+end

data/lib/dice/d30.rb

@@ -0,0 +1,11 @@
+require 'dice/dice'
+
+# Implements a standard 30-sided dice with a roll value range of 1-30
+#
+# The only game using this kind of dice as far as I know
+# is the german rpg 'Ruf des Warlock'
+class Dice::D30 < Dice::Dice
+	def initialize
+		super 1, 30
+  end
+end

data/lib/dice/d4.rb

@@ -0,0 +1,8 @@
+require 'dice/dice'
+
+# Implements a standard 4-sided dice with a roll value range of 1-4
+class Dice::D4 < Dice::Dice
+	def initialize
+		super 1, 4
+  end
+end

data/lib/dice/d6.rb

@@ -0,0 +1,8 @@
+require 'dice/dice'
+
+# Implements a standard 6-sided dice with a roll value range of 1-6
+class Dice::D6 < Dice::Dice
+	def initialize
+		super 1, 6
+  end
+end

data/lib/dice/d8.rb

@@ -0,0 +1,8 @@
+require 'dice/dice'
+
+# Implements a standard 8-sided dice with a roll value range of 1-8
+class Dice::D8 < Dice::Dice
+	def initialize
+		super 1, 8
+  end
+end

data/lib/dice/dice.rb

@@ -0,0 +1,89 @@
+require 'singleton'
+
+module Dice
+  autoload :D4, 'dice/d4'
+  autoload :D6, 'dice/d6'
+  autoload :D8, 'dice/d8'
+  autoload :D10, 'dice/d10'
+  autoload :D12, 'dice/d12'
+  autoload :D20, 'dice/d20'
+  autoload :D30, 'dice/d30'
+  autoload :D100, 'dice/d100'
+end
+
+class Dice::Dice
+
+  include Singleton
+  private_class_method :instance
+  
+	attr_reader :min_val, :sides
+	attr_writer :coerced # :nodoc:
+
+	def initialize min_val_arg, sides_arg
+		@min_val = min_val_arg
+		@sides = sides_arg
+	end
+  
+  # rolls dice and returns result as +Fixnum+
+	def roll
+		min_val + rand(sides)
+	end
+
+  # 3 * D6 rolls 3 times, returns added results
+  # D6 * 3 rolls 1 time and multiplies with 3
+  def * other
+    if @coerced
+      result = 0
+      other.to_i.times do
+        result += roll
+      end
+      result
+    else
+      roll * other
+    end
+  end
+
+  def /(other)
+    @coerced ? (other / roll) : (roll / other)
+  end
+  
+  def -(other)
+    @coerced ? (other - roll) : (roll - other)
+  end
+  
+  def +(other)
+    roll + other
+  end
+
+  ['*', '/', '+', '-'].each do |op|
+    class_eval <<-EOF
+      def self.#{op}(other)
+        instance.send(:#{op}, other)
+      end
+    EOF
+  end
+  
+	def coerce(other)
+		[coerced_clone, other]
+	end
+
+	def self.coerce(other)
+		[coerced_instance, other]
+	end
+
+	def self.coerced_instance # :nodoc:
+		result = new
+		result.coerced = true
+		result
+	end
+  private_class_method :coerced_instance
+
+private
+
+	def coerced_clone # :nodoc:
+		result = clone
+		result.coerced = true
+		result
+	end
+
+end

data/lib/dice/ua.rb

@@ -0,0 +1,6 @@
+module Dice
+  module UA
+    autoload :D100, 'dice/ua/d100'
+    autoload :D10, 'dice/ua/d10'
+  end
+end

data/lib/dice/ua/d10.rb

@@ -0,0 +1,6 @@
+require 'dice/dice'
+
+module Dice::UA; end
+
+# This is an ordinary D10 just in Namespace UA
+class Dice::UA::D10 < Dice::D10; end

data/lib/dice/ua/d100.rb

@@ -0,0 +1,79 @@
+require 'dice/dice'
+
+# Contains Dice for Unknown Armies by Atlas Games
+module Dice::UA; end
+
+# This is a special D100 which returns not only a number, but an instance of Result
+# which has some special methods needed by Unknown Armies
+class Dice::UA::D100 < Dice::Dice
+  def initialize
+    super 0, 10
+  end
+  
+	def roll 
+		Result.new(super, super)
+  end
+end
+
+# The methods are according to Rulebook 2nd (AG6020)
+# Chapter 'About the rules' (P. 7)
+# This result holds the values of two D10 rolls
+class Dice::UA::Result
+	def initialize(tens, ones)
+		@tens = tens
+		@ones = ones
+	end
+
+  # creates cross sum with special cases as stated in paragraph "Rolling Dice"
+	def add
+		(@tens.zero? ? 10 : @tens) + (@ones.zero? ? 10 : @ones)
+	end
+
+  # returns +true+ if both dice show same result, else returns +false+
+	def matched?
+		@tens == @ones
+	end
+
+	def to_i
+		result = 10 * @tens + @ones
+		result.zero? ? 100 : result
+	end
+
+  # returns +true+ if both dice show 0, else returns +false+
+	def fumble?
+		@tens == 0 && @ones == 0
+	end
+
+  # returns +true+ if result is zero-one, else returns +false+
+	def crit?
+		@tens == 0 && @ones == 1
+	end
+
+  # switch the dice
+	def flip_flop!
+		@tens, @ones = @ones, @tens
+	end
+
+	def -(subtrahend)
+		to_i - subtrahend
+	end
+
+	def +(addend)
+		to_i + addend
+	end
+
+	def *(other)
+		to_i * other
+	end
+
+	def /(other)
+		to_i / other
+	end
+
+	# exact coercion is done in next step
+	def coerce other
+		[other, self.to_i]
+	end
+
+end
+

data/tests/tc_test.rb

@@ -0,0 +1,69 @@
+require 'dice/dice'
+require 'test/unit'
+
+class DTest < Dice::Dice
+
+	@@call_count = 0
+	
+  # always returns 6
+	def initialize
+		super 6, 1
+  end
+  
+  # overwritten to provide roll count
+	def roll
+		@@call_count += 1
+		super
+	end
+
+	def self.call_count
+		@@call_count
+	end
+end
+
+class TestDice < Test::Unit::TestCase
+
+  def test_dice_multiply
+    multiplier = 3
+    result = 0
+    assert_rolled_n_times 1 do |dice|
+      result = dice * multiplier
+    end
+    assert_equal result, 6 * multiplier
+  end
+  
+  def test_other_multiply
+    multiplier = 3
+    result = 0
+    assert_rolled_n_times multiplier do |dice|
+      result = multiplier * dice
+    end
+    assert_equal result, 6 * multiplier
+  end
+  
+  def test_dice_subtract
+    assert_equal DTest - 2, 4
+  end
+  
+  def test_other_subtract
+    assert_equal 2 - DTest, -4
+  end
+  
+  def test_dice_divide
+    assert_equal DTest / 2, 3
+  end
+  
+  def test_other_divide
+    assert_equal 12 / DTest, 2
+  end
+  
+private
+
+  def assert_rolled_n_times count, &block
+		before = DTest.call_count
+    block.call DTest
+		after = DTest.call_count
+    assert_equal(before + count, after)
+  end
+  
+end

data/tests/tc_ua.rb

@@ -0,0 +1,21 @@
+require 'dice/ua'
+require 'test/unit'
+
+include Dice::UA
+
+class TestUA < Test::Unit::TestCase
+
+  def test_both
+    a = D100.instance
+    b = D10.instance
+    assert_equal a.sides, 10 # its a special dice
+    assert_equal b.sides, 10
+  end
+
+	def test_calc_with_result
+		assert_nothing_raised do
+			D100 - 20
+		end
+  end
+
+end

data/tests/ts_all.rb

@@ -0,0 +1,10 @@
+# testsuite is called by gem or directly from folder tests
+# rake-task uses testcases itself
+
+require 'test/unit'
+
+$: << File.join(File.dirname(__FILE__), '..', 'lib')
+
+Dir.glob(File.join(File.dirname(__FILE__), 'tc_*.rb')).each do |file|
+  require file
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: ruby-dice
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Stefan Achatz
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-13 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: "    Provides dice representations for roleplaying games with neat syntax\n"
+email: stefan_achatz@web.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- examples/example.rb
+- lib/dice/d20.rb
+- lib/dice/d8.rb
+- lib/dice/d10.rb
+- lib/dice/d4.rb
+- lib/dice/dice.rb
+- lib/dice/ua.rb
+- lib/dice/d30.rb
+- lib/dice/d100.rb
+- lib/dice/ua/d10.rb
+- lib/dice/ua/d100.rb
+- lib/dice/d12.rb
+- lib/dice/d6.rb
+- tests/tc_ua.rb
+- tests/ts_all.rb
+- tests/tc_test.rb
+- README
+has_rdoc: true
+homepage: http://rubyforge.org/projects/ruby-dice/
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+- --title
+- ruby-dice Documentation
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: ruby-dice
+rubygems_version: 1.3.4
+signing_key: 
+specification_version: 3
+summary: Dice library for Ruby
+test_files: 
+- tests/ts_all.rb