games_dice 0.3.12 → 0.4.0

data/spec/reroll_rule_spec.rb

@@ -1,44 +1,40 @@
-require 'helpers'
-
-describe GamesDice::RerollRule do
-
-  describe "#new" do
-
-    it "should accept self-consistent operator/value pairs as a trigger" do
-      GamesDice::RerollRule.new( 5, :>, :reroll_subtract )
-      GamesDice::RerollRule.new( (1..5), :member?, :reroll_replace )
-    end
-
-    it "should reject inconsistent operator/value pairs for a trigger" do
-      lambda { GamesDice::RerollRule.new( 5, :member?, :reroll_subtract ) }.should raise_error( ArgumentError )
-      lambda { GamesDice::RerollRule.new( (1..5), :>, :reroll_replace ) }.should raise_error( ArgumentError )
-    end
-
-    it "should reject bad re-roll types" do
-      lambda { GamesDice::RerollRule.new( 5, :>, :reroll_again ) }.should raise_error( ArgumentError )
-      lambda { GamesDice::RerollRule.new( (1..5), :member?, 42 ) }.should raise_error( ArgumentError )
-    end
-
-  end
-
-  describe '#applies?' do
-
-    it "should return true if a trigger condition is met" do
-      rule = GamesDice::RerollRule.new( 5, :>, :reroll_subtract )
-      rule.applies?(4).should == true
-
-      rule = GamesDice::RerollRule.new( (1..5), :member?, :reroll_subtract )
-      rule.applies?(4).should == true
-    end
-
-    it "should return false if a trigger condition is not met" do
-      rule = GamesDice::RerollRule.new( 5, :>, :reroll_subtract )
-      rule.applies?(7).should == false
-
-      rule = GamesDice::RerollRule.new( (1..5), :member?, :reroll_subtract )
-      rule.applies?(6).should == false
-    end
-
-  end
-
-end
+# frozen_string_literal: true
+
+require 'helpers'
+
+describe GamesDice::RerollRule do
+  describe '#new' do
+    it 'should accept self-consistent operator/value pairs as a trigger' do
+      GamesDice::RerollRule.new(5, :>, :reroll_subtract)
+      GamesDice::RerollRule.new((1..5), :member?, :reroll_replace)
+    end
+
+    it 'should reject inconsistent operator/value pairs for a trigger' do
+      expect(-> { GamesDice::RerollRule.new(5, :member?, :reroll_subtract) }).to raise_error(ArgumentError)
+      expect(-> { GamesDice::RerollRule.new((1..5), :>, :reroll_replace) }).to raise_error(ArgumentError)
+    end
+
+    it 'should reject bad re-roll types' do
+      expect(-> { GamesDice::RerollRule.new(5, :>, :reroll_again) }).to raise_error(ArgumentError)
+      expect(-> { GamesDice::RerollRule.new((1..5), :member?, 42) }).to raise_error(ArgumentError)
+    end
+  end
+
+  describe '#applies?' do
+    it 'should return true if a trigger condition is met' do
+      rule = GamesDice::RerollRule.new(5, :>, :reroll_subtract)
+      expect(rule.applies?(4)).to be true
+
+      rule = GamesDice::RerollRule.new((1..5), :member?, :reroll_subtract)
+      expect(rule.applies?(4)).to be true
+    end
+
+    it 'should return false if a trigger condition is not met' do
+      rule = GamesDice::RerollRule.new(5, :>, :reroll_subtract)
+      expect(rule.applies?(7)).to be false
+
+      rule = GamesDice::RerollRule.new((1..5), :member?, :reroll_subtract)
+      expect(rule.applies?(6)).to be false
+    end
+  end
+end

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: games_dice
 version: !ruby/object:Gem::Version
-  version: 0.3.12
+  version: 0.4.0
 platform: ruby
 authors:
 - Neil Slater
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-10-17 00:00:00.000000000 Z
+date: 2021-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.13.0
+        version: 0.6.7
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.13.0
+        version: 0.6.7
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.7
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -39,75 +53,75 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.9.1
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.6
+        version: 0.8.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.6
+        version: 0.8.3
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.7
+        version: 2.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.7
+        version: 2.13.0
 - !ruby/object:Gem::Dependency
-  name: json
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.7
+        version: 1.2.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.7
+        version: 1.2.1
 - !ruby/object:Gem::Dependency
-  name: rake-compiler
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.3
+        version: 0.8.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.3
+        version: 0.8.6
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: 3.5.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: 3.5.1
 - !ruby/object:Gem::Dependency
   name: parslet
   requirement: !ruby/object:Gem::Requirement
@@ -132,6 +146,7 @@ extensions:
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - ".yardopts"
 - CHANGELOG.md
@@ -155,8 +170,6 @@ files:
 - lib/games_dice/map_rule.rb
 - lib/games_dice/marshal.rb
 - lib/games_dice/parser.rb
-- lib/games_dice/prob_helpers.rb
-- lib/games_dice/probabilities.rb
 - lib/games_dice/reroll_rule.rb
 - lib/games_dice/version.rb
 - spec/bunch_spec.rb
@@ -175,7 +188,7 @@ homepage: https://github.com/neilslater/games_dice
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -183,16 +196,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Simulates and explains dice rolls from simple "1d6" to complex "roll 7 ten-sided
   dice, take best 3, results of 10 roll again and add on".
@@ -209,4 +221,3 @@ test_files:
 - spec/probability_spec.rb
 - spec/readme_spec.rb
 - spec/reroll_rule_spec.rb
-has_rdoc: 

data/lib/games_dice/prob_helpers.rb

@@ -1,259 +0,0 @@
-# @!visibility private
-module GamesDice::ProbabilityValidations
-
-  # @!visibility private
-  # the Array, Offset representation of probabilities.
-  def to_ao
-    [ @probs, @offset ]
-  end
-
-  def self.included(klass)
-    klass.extend ClassMethods
-  end
-
-  private
-
-  def check_probs_array probs_array
-    raise TypeError unless probs_array.is_a?( Array )
-    probs_array.map!{ |n| Float(n) }
-    total = probs_array.inject(0.0) do |t,x|
-      if x < 0.0 || x > 1.0
-        raise ArgumentError, "Found probability value #{x} which is not in range 0.0..1.0"
-      end
-      t+x
-    end
-    if (total-1.0).abs > 1e-6
-      raise ArgumentError, "Total probabilities too far from 1.0 for a valid distribution"
-    end
-    probs_array
-  end
-
-  def check_keep_mode kmode
-    raise "Keep mode #{kmode.inspect} not recognised" unless [:keep_best,:keep_worst].member?( kmode )
-  end
-
-  module ClassMethods
-    # Convert hash to array,offset notation
-    def prob_h_to_ao h
-      rmin,rmax = h.keys.minmax
-      o = rmin
-      s = 1 + rmax - rmin
-      raise ArgumentError, "Range of possible results too large" if s > 1000000
-      a = Array.new( s, 0.0 )
-      h.each { |k,v| a[k-rmin] = Float(v) }
-      [a,o]
-    end
-
-    # Convert array,offset notation to hash
-    def prob_ao_to_h a, o
-      h = Hash.new
-      a.each_with_index { |v,i| h[i+o] = v if v > 0.0 }
-      h
-    end
-
-    private
-
-    def check_is_gdp *probs
-      probs.each do |prob|
-        unless prob.is_a?( GamesDice::Probabilities )
-          raise TypeError, "parameter is not a GamesDice::Probabilities"
-        end
-      end
-    end
-  end
-end
-
-# @!visibility private
-# This module is a set of related private methods for GamesDice::Probabilities that
-# calculate how two distributions can be combined.
-module GamesDice::ProbabilityCalcAddDistributions
-  private
-
-  def calc_combined_extremes m_a, pd_a, m_b, pd_b
-    [ [ :min, :min ], [ :min, :max ], [ :max, :min ], [ :max, :max ] ].map do |pda_meth, pdb_meth|
-      m_a * pd_a.send(pda_meth) + m_b * pd_b.send(pdb_meth)
-    end
-  end
-
-  def add_distributions_internal combined_min, combined_max, m_a, pd_a, m_b, pd_b
-    new_probs = Array.new( 1 + combined_max - combined_min, 0.0 )
-    probs_a, offset_a = pd_a.to_ao
-    probs_b, offset_b = pd_b.to_ao
-
-    probs_a.each_with_index do |pa,i|
-      probs_b.each_with_index do |pb,j|
-        k = m_a * (i + offset_a) + m_b * (j + offset_b) - combined_min
-        pc = pa * pb
-        new_probs[ k ] += pc
-      end
-    end
-    GamesDice::Probabilities.new( new_probs, combined_min )
-  end
-end
-
-
-# @!visibility private
-# This module is a set of related private methods for GamesDice::Probabilities that
-# calculate how a distribution can be combined with itself.
-module GamesDice::ProbabilityCalcSums
-
-  private
-
-  def repeat_sum_internal( n )
-    pd_power = self
-    pd_result = nil
-
-    use_power = 1
-    loop do
-      if ( use_power & n ) > 0
-        if pd_result
-          pd_result = GamesDice::Probabilities.add_distributions( pd_result, pd_power )
-        else
-          pd_result = pd_power
-        end
-      end
-      use_power = use_power << 1
-      break if use_power > n
-      pd_power = GamesDice::Probabilities.add_distributions( pd_power, pd_power )
-    end
-    pd_result
-  end
-
-  def repeat_n_sum_k_internal( n, k, kmode )
-    if k >= n
-      return repeat_sum_internal( n )
-    end
-    new_probs = Array.new( @probs.count * k, 0.0 )
-    new_offset = @offset * k
-    d = n - k
-
-    each do | q, p_maybe |
-      repeat_n_sum_k_each_q( q, p_maybe, n, k, kmode, d, new_probs, new_offset )
-    end
-
-    GamesDice::Probabilities.new( new_probs, new_offset )
-  end
-
-  def repeat_n_sum_k_each_q q, p_maybe, n, k, kmode, d, new_probs, new_offset
-    # keep_distributions is array of Probabilities, indexed by number of keepers > q, which is in 0...k
-    keep_distributions = calc_keep_distributions( k, q, kmode )
-    p_table = calc_p_table( q, p_maybe, kmode )
-    (0...k).each do |kn|
-      repeat_n_sum_k_each_q_kn( k, kn, d, new_probs, new_offset, keep_distributions, p_table )
-    end
-  end
-
-  def repeat_n_sum_k_each_q_kn k, kn, d, new_probs, new_offset, keep_distributions, p_table
-    keepers = [2] * kn + [1] * (k-kn)
-    p_so_far = keepers.inject(1.0) { |p,idx| p * p_table[idx] }
-    return unless p_so_far > 0.0
-    (0..d).each do |dn|
-      repeat_n_sum_k_each_q_kn_dn( keepers, kn, d, dn, p_so_far, new_probs, new_offset, keep_distributions, p_table )
-    end
-  end
-
-  def repeat_n_sum_k_each_q_kn_dn keepers, kn, d, dn, p_so_far, new_probs, new_offset, keep_distributions, p_table
-    discards = [1] * (d-dn) + [0] * dn
-    sequence = keepers + discards
-    p_sequence = discards.inject( p_so_far ) { |p,idx| p * p_table[idx] }
-    return unless p_sequence > 0.0
-    p_sequence *= GamesDice::Combinations.count_variations( sequence )
-    kd = keep_distributions[kn]
-    kd.each { |r,p_r| new_probs[r-new_offset] += p_r * p_sequence }
-  end
-
-  def calc_keep_distributions k, q, kmode
-    kd_probabilities = calc_keep_definite_distributions q, kmode
-
-    keep_distributions = [ GamesDice::Probabilities.new( [1.0], q * k ) ]
-    if kd_probabilities && k > 1
-      (1...k).each do |n|
-        extra_o = GamesDice::Probabilities.new( [1.0], q * ( k - n ) )
-        n_probs = kd_probabilities.repeat_sum( n )
-        keep_distributions[n] = GamesDice::Probabilities.add_distributions( extra_o, n_probs )
-      end
-    end
-
-    keep_distributions
-  end
-
-  def calc_keep_definite_distributions q, kmode
-    kd_probabilities = nil
-    case kmode
-    when :keep_best
-      p_definites = p_gt(q)
-      kd_probabilities = given_ge( q + 1 ) if p_definites > 0.0
-    when :keep_worst
-      p_definites = p_lt(q)
-      kd_probabilities = given_le( q - 1 ) if p_definites > 0.0
-    end
-    kd_probabilities
-  end
-
-  def calc_p_table q, p_maybe, kmode
-    case kmode
-    when :keep_best
-      p_kept = p_gt(q)
-      p_rejected = p_lt(q)
-    when :keep_worst
-      p_kept = p_lt(q)
-      p_rejected = p_gt(q)
-    end
-    [ p_rejected, p_maybe, p_kept ]
-  end
-
-end
-
-
-# @!visibility private
-# Helper module with optimised Ruby for counting variations of arrays, such as those returned by
-# Array#repeated_combination
-#
-# @example How many ways can [3,3,6] be arranged?
-#  GamesDice::Combinations.count_variations( [3,3,6] )
-#  => 3
-#
-# @example When prob( a ) and result( a ) are same for any arrangement of Array a
-#  items = [1,2,3,4,5,6]
-#  items.repeated_combination(5).each do |a|
-#    this_result = result( a )
-#    this_prob = prob( a ) * GamesDice::Combinations.count_variations( a )
-#    # Do something useful with this knowledge! E.g. save it to probability array.
-#  end
-#
-module GamesDice::Combinations
-  @@variations_cache = {}
-  @@factorial_cache = [1, 1, 2, 6, 24, 120, 720, 5040, 40320, 362880, 3628800]
-
-  # Counts variations of an array. A unique variation is an arrangement of the array elements which
-  # is detectably different (using ==) from any other. So [1,1,1] has only 1 unique arrangement,
-  # but [1,2,3] has 6 possibilities.
-  # @param [Array] array List of things that can be arranged
-  # @return [Integer] Number of unique arrangements
-  def self.count_variations array
-    all_count = array.count
-    group_sizes = group_counts( array )
-    cache_key = all_count.to_s + ":" + group_sizes.join(',')
-    @@variations_cache[cache_key] ||= variations_of( all_count, group_sizes )
-  end
-
-  private
-
-  def self.variations_of all_count, groups
-    all_arrangements = factorial( all_count )
-    # The reject is an optimisation to avoid calculating and multplying by factorial(1) (==1)
-    identical_arrangements = groups.reject {|x| x==1 }.inject(1) { |prod,g| prod * factorial(g) }
-    all_arrangements/identical_arrangements
-  end
-
-  # Returns counts of unique items in array e.g. [8,8,8,7,6,6] returns [1,2,3]
-  # Sort is for caching
-  def self.group_counts array
-    array.group_by {|x| x}.values.map {|v| v.count}.sort
-  end
-
-  def self.factorial n
-    # Can start range from 2 because we have pre-cached the result for n=1
-    @@factorial_cache[n] ||= (2..n).inject(:*)
-  end
-end