games_dice 0.0.2 → 0.0.3

data/lib/games_dice/map_rule.rb

@@ -0,0 +1,46 @@
+module GamesDice
+  # convert integer die result into value used in a game (e.g. 1 for a 'success')
+  class MapRule
+
+    # trigger_op, trigger_value, mapped_value and mapped_name set the attributes of the same name
+    #  rule = RPGMapRule.new( 6, :<=, 1, 'Success' ) # score 1 for a result of 6 or more
+    def initialize trigger_value, trigger_op, mapped_value=0, mapped_name=''
+
+      if ! trigger_value.respond_to?( trigger_op )
+        raise ArgumentError, "trigger_value #{trigger_value.inspect} cannot respond to trigger_op #{trigger_value.inspect}"
+      end
+
+      @trigger_value = trigger_value
+      @trigger_op = trigger_op
+      raise TypeError if ! mapped_value.is_a? Numeric
+      @mapped_value = Integer(mapped_value)
+      @mapped_name = mapped_name.to_s
+    end
+
+    # an Integer value or Range that will be mapped to a single value. #trigger_op is called against it
+    attr_reader :trigger_value
+
+    # a valid symbol for a method, which will be called against #trigger_value with the current
+    # die result as a param. If the operator returns true for a specific die result, then the
+    # mapped_value will be used in its stead. If the operator returns nil or false, the map is not
+    # triggered. All other values will be returned as the result of the map (allowing you to
+    # specify any method that takes an integer as input and returns something else as the end result)
+    attr_reader :trigger_op
+
+    # an integer value
+    attr_reader :mapped_value
+
+    # a string description of the mapping, e.g. 'S' for a success
+    attr_reader :mapped_name
+
+    # runs the rule against test_value, returning either a new value, or nil if the rule does not apply
+    def map_from test_value
+      op_result = @trigger_value.send( @trigger_op, test_value )
+      return nil unless op_result
+      if op_result == true
+        return @mapped_value
+      end
+      return op_result
+    end
+  end # class MapRule
+end # module GamesDice

data/lib/games_dice/reroll_rule.rb

@@ -0,0 +1,64 @@
+module GamesDice
+
+  # specifies when and how a ComplexDie should be re-rolled
+  class RerollRule
+
+    # allowed reasons for making a reroll
+    TYPES = {
+      :reroll_add => '+',
+      :reroll_new_die => '*',
+      :reroll_new_keeper => '*',
+      :reroll_subtract => '-',
+      :reroll_replace => '|',
+      :reroll_use_best => '/',
+      :reroll_use_worst => '\\',
+    }
+
+    # trigger_op, trigger_value, type and limit set the attributes of the same name
+    #  rule = GamesDice::RerollRule.new( 10, :<=, :reroll_add ) # an 'exploding' die
+    def initialize trigger_value, trigger_op, type, limit=nil
+
+      if ! trigger_value.respond_to?( trigger_op )
+        raise ArgumentError, "trigger_value #{trigger_value.inspect} cannot respond to trigger_op #{trigger_value.inspect}"
+      end
+
+      unless TYPES.has_key?(type)
+        raise ArgumentError, "Unrecognised reason for a re-roll #{type}"
+      end
+
+      @trigger_value = trigger_value
+      @trigger_op = trigger_op
+      @type = type
+      @limit = limit ? Integer(limit) : 1000
+      @limit = 1 if @type == :reroll_subtract
+    end
+
+    # a valid symbol for a method, which will be called against #trigger_value with the current
+    # die result as a param. It should return true or false
+    attr_reader :trigger_op
+
+    # an Integer value or Range that will cause the reroll to occur. #trigger_op is called against it
+    attr_reader :trigger_value
+
+    # a symbol, should be one of the following:
+    #   :reroll_add - add result of reroll to running total, and ignore :reroll_subtract for this die
+    #   :reroll_new_die - roll a new die of the same type
+    #   :reroll_new_keeper - roll a new die of the same type, and keep the result
+    #   :reroll_subtract - subtract result of reroll from running total, and reverse sense of any further :reroll_add results
+    #   :reroll_replace - use the new value in place of existing value for the die
+    #   :reroll_use_best - use the new value if it is higher than the erxisting value
+    #   :reroll_use_worst - use the new value if it is higher than the existing value
+    attr_reader :type
+
+    # maximum number of times this rule should be applied to a single die. If type is:reroll_subtract,
+    # this value is always 1. A default value of 100 is used if not set in the constructor
+    attr_reader :limit
+
+    # runs the rule against a test value, returning truth value from calling the trigger_op method
+    def applies? test_value
+      @trigger_value.send( @trigger_op, test_value ) ? true : false
+    end
+
+  end # class RerollRule
+
+end # module GamesDice

data/lib/games_dice/version.rb

@@ -1,3 +1,3 @@
 module GamesDice
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/bunch_spec.rb

@@ -0,0 +1,414 @@
+require 'games_dice'
+
+describe GamesDice::Bunch do
+
+  describe "dice scheme" do
+
+    before :each do
+      srand(67809)
+    end
+
+    describe '1d10' do
+      let(:dice) { GamesDice::Bunch.new( :sides => 10, :ndice => 1 ) }
+
+      it "should simulate rolling a ten-sided die" do
+        [3,2,8,8,5,3,7].each do |expected_total|
+          dice.roll.should == expected_total
+          dice.result.should == expected_total
+        end
+      end
+
+      it "should concisely explain each result" do
+        ["3", "2", "8", "8"].each do |expected_explain|
+          dice.roll
+          dice.explain_result.should == expected_explain
+        end
+      end
+
+      it "should calculate correct min, max = 1,10" do
+        dice.min.should == 1
+        dice.max.should == 10
+      end
+
+      it "should have a mean value of 5.5" do
+        dice.expected_result.should be_within(1e-10).of 5.5
+      end
+
+      it "should calculate probabilities correctly" do
+        dice.probabilities[1].should be_within(1e-10).of 0.1
+        dice.probabilities[2].should be_within(1e-10).of 0.1
+        dice.probabilities[3].should be_within(1e-10).of 0.1
+        dice.probabilities[4].should be_within(1e-10).of 0.1
+        dice.probabilities[5].should be_within(1e-10).of 0.1
+        dice.probabilities[6].should be_within(1e-10).of 0.1
+        dice.probabilities[7].should be_within(1e-10).of 0.1
+        dice.probabilities[8].should be_within(1e-10).of 0.1
+        dice.probabilities[9].should be_within(1e-10).of 0.1
+        dice.probabilities[10].should be_within(1e-10).of 0.1
+        dice.probabilities.values.inject(:+).should be_within(1e-9).of 1.0
+      end
+    end
+
+    describe '2d6' do
+      let(:dice) { GamesDice::Bunch.new( :sides => 6, :ndice => 2 ) }
+
+      it "should simulate rolling two six-sided dice and adding them" do
+        [9,6,11,9,7,7,10].each do |expected_total|
+          dice.roll.should == expected_total
+          dice.result.should == expected_total
+        end
+      end
+
+      it "should concisely explain each result" do
+        ["3 + 6 = 9","2 + 4 = 6","5 + 6 = 11","3 + 6 = 9","2 + 5 = 7","6 + 1 = 7","5 + 5 = 10",].each do |expected_explain|
+          dice.roll
+          dice.explain_result.should == expected_explain
+        end
+      end
+
+      it "should calculate correct min, max = 2,12" do
+        dice.min.should == 2
+        dice.max.should == 12
+      end
+
+      it "should have a mean value of 7.0" do
+        dice.expected_result.should be_within(1e-10).of 7.0
+      end
+
+      it "should calculate probabilities correctly" do
+        dice.probabilities[2].should be_within(1e-10).of 1/36.0
+        dice.probabilities[3].should be_within(1e-10).of 2/36.0
+        dice.probabilities[4].should be_within(1e-10).of 3/36.0
+        dice.probabilities[5].should be_within(1e-10).of 4/36.0
+        dice.probabilities[6].should be_within(1e-10).of 5/36.0
+        dice.probabilities[7].should be_within(1e-10).of 6/36.0
+        dice.probabilities[8].should be_within(1e-10).of 5/36.0
+        dice.probabilities[9].should be_within(1e-10).of 4/36.0
+        dice.probabilities[10].should be_within(1e-10).of 3/36.0
+        dice.probabilities[11].should be_within(1e-10).of 2/36.0
+        dice.probabilities[12].should be_within(1e-10).of 1/36.0
+        dice.probabilities.values.inject(:+).should be_within(1e-9).of 1.0
+      end
+    end
+
+    describe '20d10' do
+      let(:dice) { GamesDice::Bunch.new( :sides => 10, :ndice => 20 ) }
+
+      it "should simulate rolling twenty ten-sided dice and adding them" do
+        [132,103,102,124,132,96,111].each do |expected_total|
+          dice.roll.should == expected_total
+          dice.result.should == expected_total
+        end
+      end
+
+      it "should concisely explain each result" do
+        ["3 + 2 + 8 + 8 + 5 + 3 + 7 + 7 + 6 + 10 + 7 + 6 + 9 + 5 + 5 + 8 + 10 + 9 + 5 + 9 = 132",
+         "3 + 9 + 1 + 4 + 3 + 5 + 7 + 1 + 10 + 4 + 7 + 7 + 6 + 5 + 2 + 7 + 4 + 9 + 7 + 2 = 103",
+         "6 + 1 + 1 + 3 + 1 + 4 + 9 + 6 + 3 + 10 + 9 + 10 + 8 + 4 + 1 + 4 + 2 + 1 + 10 + 9 = 102",
+         ].each do |expected_explain|
+          dice.roll
+          dice.explain_result.should == expected_explain
+        end
+      end
+
+      it "should calculate correct min, max = 20,200" do
+        dice.min.should == 20
+        dice.max.should == 200
+      end
+
+      it "should have a mean value of 110.0" do
+        dice.expected_result.should be_within(1e-8).of 110.0
+      end
+
+      it "should calculate probabilities correctly" do
+        dice.probabilities[20].should be_within(1e-26).of 1e-20
+        dice.probabilities[110].should be_within(1e-10).of 0.0308191892
+        dice.probabilities.values.inject(:+).should be_within(1e-9).of 1.0
+      end
+    end
+
+    describe '4d6 keep best 3' do
+      let(:dice) { GamesDice::Bunch.new( :sides => 6, :ndice => 4, :keep_mode => :keep_best, :keep_number => 3 ) }
+
+      it "should simulate rolling four six-sided dice and adding the best three values" do
+        [13,17,13,12,13,10,14].each do |expected_total|
+          dice.roll.should == expected_total
+          dice.result.should == expected_total
+        end
+      end
+
+      it "should concisely explain each result" do
+        ["3, 6, 2, 4. Keep: 3 + 4 + 6 = 13",
+         "5, 6, 3, 6. Keep: 5 + 6 + 6 = 17",
+         "2, 5, 6, 1. Keep: 2 + 5 + 6 = 13",
+         "5, 5, 2, 1. Keep: 2 + 5 + 5 = 12",
+         ].each do |expected_explain|
+          dice.roll
+          dice.explain_result.should == expected_explain
+        end
+      end
+
+      it "should calculate correct min, max = 3,18" do
+        dice.min.should == 3
+        dice.max.should == 18
+      end
+
+      it "should have a mean value of roughly 12.2446" do
+        dice.expected_result.should be_within(1e-9).of 12.244598765
+      end
+
+      it "should calculate probabilities correctly" do
+        dice.probabilities[3].should be_within(1e-10).of 1/1296.0
+        dice.probabilities[4].should be_within(1e-10).of 4/1296.0
+        dice.probabilities[5].should be_within(1e-10).of 10/1296.0
+        dice.probabilities[6].should be_within(1e-10).of 21/1296.0
+        dice.probabilities[7].should be_within(1e-10).of 38/1296.0
+        dice.probabilities[8].should be_within(1e-10).of 62/1296.0
+        dice.probabilities[9].should be_within(1e-10).of 91/1296.0
+        dice.probabilities[10].should be_within(1e-10).of 122/1296.0
+        dice.probabilities[11].should be_within(1e-10).of 148/1296.0
+        dice.probabilities[12].should be_within(1e-10).of 167/1296.0
+        dice.probabilities[13].should be_within(1e-10).of 172/1296.0
+        dice.probabilities[14].should be_within(1e-10).of 160/1296.0
+        dice.probabilities[15].should be_within(1e-10).of 131/1296.0
+        dice.probabilities[16].should be_within(1e-10).of 94/1296.0
+        dice.probabilities[17].should be_within(1e-10).of 54/1296.0
+        dice.probabilities[18].should be_within(1e-10).of 21/1296.0
+        dice.probabilities.values.inject(:+).should be_within(1e-9).of 1.0
+      end
+    end
+
+    describe '10d10 keep worst one' do
+      let(:dice) { GamesDice::Bunch.new( :sides => 10, :ndice => 10, :keep_mode => :keep_worst, :keep_number => 1 ) }
+
+      it "should simulate rolling ten ten-sided dice and keeping the worst value" do
+        [2,5,1,2,1,1,2].each do |expected_total|
+          dice.roll.should == expected_total
+          dice.result.should == expected_total
+        end
+      end
+
+      it "should concisely explain each result" do
+        ["3, 2, 8, 8, 5, 3, 7, 7, 6, 10. Keep: 2",
+         "7, 6, 9, 5, 5, 8, 10, 9, 5, 9. Keep: 5",
+         "3, 9, 1, 4, 3, 5, 7, 1, 10, 4. Keep: 1",
+         "7, 7, 6, 5, 2, 7, 4, 9, 7, 2. Keep: 2",
+         ].each do |expected_explain|
+          dice.roll
+          dice.explain_result.should == expected_explain
+        end
+      end
+
+      it "should calculate correct min, max = 1,10" do
+        dice.min.should == 1
+        dice.max.should == 10
+      end
+
+      it "should have a mean value of roughly 1.491" do
+        dice.expected_result.should be_within(1e-9).of 1.4914341925
+      end
+
+      it "should calculate probabilities correctly" do
+        dice.probabilities[1].should be_within(1e-10).of 0.6513215599
+        dice.probabilities[2].should be_within(1e-10).of 0.2413042577
+        dice.probabilities[3].should be_within(1e-10).of 0.0791266575
+        dice.probabilities[4].should be_within(1e-10).of 0.0222009073
+        dice.probabilities[5].should be_within(1e-10).of 0.0050700551
+        dice.probabilities[6].should be_within(1e-10).of 0.0008717049
+        dice.probabilities[7].should be_within(1e-10).of 0.0000989527
+        dice.probabilities[8].should be_within(1e-10).of 0.0000058025
+        dice.probabilities[9].should be_within(1e-10).of 0.0000001023
+        dice.probabilities[10].should be_within(1e-18).of 1e-10
+        dice.probabilities.values.inject(:+).should be_within(1e-9).of 1.0
+      end
+    end
+
+    describe '5d10, re-roll and add on 10s, keep best 2' do
+      let(:dice) {
+        GamesDice::Bunch.new(
+          :sides => 10, :ndice => 5, :keep_mode => :keep_best, :keep_number => 2,
+          :rerolls => [GamesDice::RerollRule.new(10,:==,:reroll_add)]
+          ) }
+
+      it "should simulate rolling five ten-sided 'exploding' dice and adding the best two values" do
+        [16,24,17,28,12,21,16].each do |expected_total|
+          dice.roll.should == expected_total
+          dice.result.should == expected_total
+        end
+      end
+
+      it "should concisely explain each result" do
+        ["3, 2, 8, 8, 5. Keep: 8 + 8 = 16",
+         "3, 7, 7, 6, [10+7] 17. Keep: 7 + 17 = 24",
+         "6, 9, 5, 5, 8. Keep: 8 + 9 = 17",
+         "[10+9] 19, 5, 9, 3, 9. Keep: 9 + 19 = 28",
+         ].each do |expected_explain|
+          dice.roll
+          dice.explain_result.should == expected_explain
+        end
+      end
+
+      it "should calculate correct min, max = 2, > 100" do
+        dice.min.should == 2
+        dice.max.should > 100
+      end
+
+      it "should have a mean value of roughly 18.986" do
+        pending "Too slow"
+        dice.expected_result.should be_within(1e-9).of 18.9859925804
+      end
+
+      it "should calculate probabilities correctly" do
+        pending "Too slow"
+        dice.probabilities[2].should be_within(1e-10).of 0.00001
+        dice.probabilities[3].should be_within(1e-10).of 0.00005
+        dice.probabilities[4].should be_within(1e-10).of 0.00031
+        dice.probabilities[5].should be_within(1e-10).of 0.00080
+        dice.probabilities[6].should be_within(1e-10).of 0.00211
+        dice.probabilities[7].should be_within(1e-10).of 0.00405
+        dice.probabilities[8].should be_within(1e-10).of 0.00781
+        dice.probabilities[9].should be_within(1e-10).of 0.01280
+        dice.probabilities[10].should be_within(1e-10).of 0.02101
+        dice.probabilities[12].should be_within(1e-10).of 0.045715
+        dice.probabilities[13].should be_within(1e-10).of 0.060830
+        dice.probabilities[14].should be_within(1e-10).of 0.077915
+        dice.probabilities[15].should be_within(1e-10).of 0.090080
+        dice.probabilities[16].should be_within(1e-10).of 0.097935
+        dice.probabilities[17].should be_within(1e-10).of 0.091230
+        dice.probabilities[18].should be_within(1e-10).of 0.070015
+        dice.probabilities[19].should be_within(1e-10).of 0.020480
+        dice.probabilities[20].should be_within(1e-10).of 0.032805
+        dice.probabilities[22].should be_within(1e-10).of 0.0334626451
+        dice.probabilities[23].should be_within(1e-10).of 0.0338904805
+        dice.probabilities[24].should be_within(1e-10).of 0.0338098781
+        dice.probabilities[25].should be_within(1e-10).of 0.0328226480
+        dice.probabilities[26].should be_within(1e-10).of 0.0304393461
+        dice.probabilities[27].should be_within(1e-10).of 0.0260456005
+        dice.probabilities[28].should be_within(1e-10).of 0.0189361531
+        dice.probabilities[29].should be_within(1e-10).of 0.0082804480
+        dice.probabilities[30].should be_within(1e-10).of 0.0103524151
+        dice.probabilities.values.inject(:+).should be_within(1e-9).of 1.0
+      end
+    end
+
+    describe 'roll 2d20, keep best value' do
+      let(:dice) do
+        GamesDice::Bunch.new(
+          :sides => 20, :ndice => 2, :keep_mode => :keep_best, :keep_number => 1
+        )
+      end
+
+      it "should simulate rolling two twenty-sided dice and keeping the best value" do
+        [19,18,14,6,13,10,16].each do |expected_total|
+          dice.roll.should == expected_total
+          dice.result.should == expected_total
+        end
+      end
+
+      it "should concisely explain each result" do
+        ["19, 14. Keep: 19",
+         "18, 16. Keep: 18",
+         "5, 14. Keep: 14",
+         "3, 6. Keep: 6",
+         ].each do |expected_explain|
+          dice.roll
+          dice.explain_result.should == expected_explain
+        end
+      end
+
+      it "should calculate correct min, max = 1,20" do
+        dice.min.should == 1
+        dice.max.should == 20
+      end
+
+      it "should have a mean value of 13.825" do
+        dice.expected_result.should be_within(1e-9).of 13.825
+      end
+
+      it "should calculate probabilities correctly" do
+        dice.probabilities[1].should be_within(1e-10).of 1/400.0
+        dice.probabilities[2].should be_within(1e-10).of 3/400.0
+        dice.probabilities[3].should be_within(1e-10).of 5/400.0
+        dice.probabilities[4].should be_within(1e-10).of 7/400.0
+        dice.probabilities[5].should be_within(1e-10).of 9/400.0
+        dice.probabilities[6].should be_within(1e-10).of 11/400.0
+        dice.probabilities[7].should be_within(1e-10).of 13/400.0
+        dice.probabilities[8].should be_within(1e-10).of 15/400.0
+        dice.probabilities[9].should be_within(1e-10).of 17/400.0
+        dice.probabilities[10].should be_within(1e-10).of 19/400.0
+        dice.probabilities[11].should be_within(1e-10).of 21/400.0
+        dice.probabilities[12].should be_within(1e-10).of 23/400.0
+        dice.probabilities[13].should be_within(1e-10).of 25/400.0
+        dice.probabilities[14].should be_within(1e-10).of 27/400.0
+        dice.probabilities[15].should be_within(1e-10).of 29/400.0
+        dice.probabilities[16].should be_within(1e-10).of 31/400.0
+        dice.probabilities[17].should be_within(1e-10).of 33/400.0
+        dice.probabilities[18].should be_within(1e-10).of 35/400.0
+        dice.probabilities[19].should be_within(1e-10).of 37/400.0
+        dice.probabilities[20].should be_within(1e-10).of 39/400.0
+        dice.probabilities.values.inject(:+).should be_within(1e-9).of 1.0
+      end
+    end
+
+    describe 'roll 2d20, keep worst value' do
+      let(:dice) do
+        GamesDice::Bunch.new(
+          :sides => 20, :ndice => 2, :keep_mode => :keep_worst, :keep_number => 1
+        )
+      end
+
+      it "should simulate rolling two twenty-sided dice and keeping the best value" do
+        [14,16,5,3,7,5,9].each do |expected_total|
+          dice.roll.should == expected_total
+          dice.result.should == expected_total
+        end
+      end
+
+      it "should concisely explain each result" do
+        ["19, 14. Keep: 14",
+         "18, 16. Keep: 16",
+         "5, 14. Keep: 5",
+         "3, 6. Keep: 3",
+         ].each do |expected_explain|
+          dice.roll
+          dice.explain_result.should == expected_explain
+        end
+      end
+
+      it "should calculate correct min, max = 1,20" do
+        dice.min.should == 1
+        dice.max.should == 20
+      end
+
+      it "should have a mean value of 7.175" do
+        dice.expected_result.should be_within(1e-9).of 7.175
+      end
+
+      it "should calculate probabilities correctly" do
+        dice.probabilities[1].should be_within(1e-10).of 39/400.0
+        dice.probabilities[2].should be_within(1e-10).of 37/400.0
+        dice.probabilities[3].should be_within(1e-10).of 35/400.0
+        dice.probabilities[4].should be_within(1e-10).of 33/400.0
+        dice.probabilities[5].should be_within(1e-10).of 31/400.0
+        dice.probabilities[6].should be_within(1e-10).of 29/400.0
+        dice.probabilities[7].should be_within(1e-10).of 27/400.0
+        dice.probabilities[8].should be_within(1e-10).of 25/400.0
+        dice.probabilities[9].should be_within(1e-10).of 23/400.0
+        dice.probabilities[10].should be_within(1e-10).of 21/400.0
+        dice.probabilities[11].should be_within(1e-10).of 19/400.0
+        dice.probabilities[12].should be_within(1e-10).of 17/400.0
+        dice.probabilities[13].should be_within(1e-10).of 15/400.0
+        dice.probabilities[14].should be_within(1e-10).of 13/400.0
+        dice.probabilities[15].should be_within(1e-10).of 11/400.0
+        dice.probabilities[16].should be_within(1e-10).of 9/400.0
+        dice.probabilities[17].should be_within(1e-10).of 7/400.0
+        dice.probabilities[18].should be_within(1e-10).of 5/400.0
+        dice.probabilities[19].should be_within(1e-10).of 3/400.0
+        dice.probabilities[20].should be_within(1e-10).of 1/400.0
+        dice.probabilities.values.inject(:+).should be_within(1e-9).of 1.0
+      end
+    end
+
+  end
+
+end