loaded_die 2.0.1 → 2.0.3

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2015-2025 Aaron Beckerman
+Copyright (c) 2015-2026 Aaron Beckerman
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

data/README.txt

@@ -1,7 +1,8 @@
 Loaded Die
 
 Loaded Die is a Ruby library that makes it easy to randomly choose from a set
-of options where some options are more likely than others.
+of options where some options are more likely than others. It's written for
+clarity over performance.
 
 
 Usage
@@ -12,7 +13,7 @@ times as you like.
 
 Let's say you want to choose randomly from three strings: "A", "B", and "C".
 You want "A" and "B" to be equally likely, and "C" to be twice as likely as one
-of them. That means "A" should be 25% likely, B should be 25% likely, and C
+of them. That means "A" should be 25% likely, "B" should be 25% likely, and "C"
 should be 50% likely.
 
 You can create your sampler like this:

data/lib/loaded_die.rb

@@ -28,7 +28,7 @@ module LoadedDie
     # is an individual that can be chosen and the second element is its weight
     # -- that is, the likelihood relative to the other weights that the
     # individual will be chosen. Weights must convert to finite floats that are
-    # zero or positive.
+    # zero or positive. Their sum must also be finite.
 
     def initialize population
       @compiled = population.to_enum.inject [] do |accum, elem|
@@ -45,7 +45,12 @@ module LoadedDie
           else
             0.0
           end
-        accum << { :maximum => prev_max + weight_f, :individual => individual }
+        maximum = prev_max + weight_f
+        unless maximum.finite?
+          ::Kernel.raise ::ArgumentError, "invalid total weight #{maximum}"
+          break
+        end
+        accum << { :maximum => maximum, :individual => individual }
       end
       nil
     end
@@ -80,12 +85,13 @@ module LoadedDie
     end
 
     ##
-    # Returns a randomly-chosen individual. The argument is a hash, empty by
-    # default. If it contains a value for the +:random+ key, that value will be
-    # used as the random number generator instead of the default. This RNG will
-    # be sent a rand message with one argument, the sum of weights, and should
-    # return a number (convertible to a float) greater than or equal to zero
-    # and less than the sum of weights.
+    # Returns a randomly-chosen individual. If the total weight is zero, this
+    # method returns nil. The argument is a hash, empty by default. If it
+    # contains a value for the +:random+ key, that value will be used as the
+    # random number generator instead of the default. This RNG will be sent a
+    # rand message with one argument, the sum of weights, and should return a
+    # number (convertible to a float) greater than or equal to zero and less
+    # than the sum of weights.
 
     def sample options = {}
       rng = options.fetch(:random) { ::LoadedDie::Sampler::DEFAULT_RNG }

data/test/loaded_die_test.rb

@@ -26,6 +26,25 @@ fail "" unless LoadedDie::Sampler.equal? LoadedDie::Sampler.new({}).class
 fail "" unless LoadedDie::Sampler.equal?(
   LoadedDie::Sampler.new({ :a => 0.0, :b => 1.0 }).class)
 
+# LoadedDie::Sampler.new should allow population elements to have more than
+# two elements. It should ignore extras.
+fail "" unless 1.0.eql? LoadedDie::Sampler.new([[:a, 1.0, "ignored"]]).length
+
+# LoadedDie::Sampler.new should allow the population to be anything that
+# returns an enumerable when sent a to_enum message with no arguments.
+class ::Object
+  pop = ::Object.new
+  def pop.to_enum
+    [[:a, 1.0]]
+  end
+  fail "" unless 1.0.eql? LoadedDie::Sampler.new(pop).length
+end
+
+# LoadedDie::Sampler.new should allow weights to be objects that convert to
+# floats in a conventional way.
+fail "" unless 1.0.eql? LoadedDie::Sampler.new({ :a => 1 }).length
+fail "" unless 1.7.eql? LoadedDie::Sampler.new({ :a => "1.7" }).length
+
 # LoadedDie::Sampler.new with a negative weight should raise an exception.
 begin
   LoadedDie::Sampler.new({ :a => -1.0 })
@@ -53,6 +72,16 @@ else
   fail ""
 end
 
+# LoadedDie::Sampler.new with finite weights whose sum is not finite should
+# raise an exception.
+begin
+  LoadedDie::Sampler.new({ :a => Float::MAX, :b => Float::MAX })
+rescue ArgumentError
+  fail "" unless /\Ainvalid total weight / =~ $!.message
+else
+  fail ""
+end
+
 # LoadedDie::Sampler.new with a weight that does not convert to a float should
 # raise an exception.
 begin
@@ -61,6 +90,12 @@ rescue TypeError
 else
   fail ""
 end
+begin
+  LoadedDie::Sampler.new({ :a => "z" })
+rescue ArgumentError
+else
+  fail ""
+end
 
 # LoadedDie::Sampler.new with a population that doesn't conform to the
 # interface should raise an exception.
@@ -101,10 +136,10 @@ class ::Object
 end
 
 # Sampler length should be the sum of weights converted to floats.
-fail "" unless 0.0 == LoadedDie::Sampler.new([]).length
-fail "" unless 2.0 == LoadedDie::Sampler.new([[:a, 2.0]]).length
-fail "" unless (Float(2) + 0.0 + 3.1) ==
-  LoadedDie::Sampler.new([[:a, 2], [:b, 0.0], [:c, 3.1]]).length
+fail "" unless 0.0.eql? LoadedDie::Sampler.new([]).length
+fail "" unless 2.0.eql? LoadedDie::Sampler.new([[:a, 2.0]]).length
+fail "" unless (Float(2) + 0.0 + 3.1).eql? LoadedDie::Sampler.new(
+  [[:a, 2], [:b, 0.0], [:c, 3.1]]).length
 
 # Sending length with superfluous non-block arguments to a sampler should raise
 # an exception.
@@ -172,7 +207,7 @@ class ::Object
   sampler = LoadedDie::Sampler.new [[:a, 3], [:b, 2.0], ["!", 0.0], [:c, 9001]]
   rng = Object.new
   def rng.rand n
-    fail "" unless ((Float(3) + 2.0) + Float(9001)) == n
+    fail "" unless ((Float(3) + 2.0) + Float(9001)).eql? n
     4.9
   end
   fail "" unless :b.equal? sampler.sample({ :random => rng })

metadata

@@ -1,13 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: loaded_die
 version: !ruby/object:Gem::Version 
-  hash: 13
-  prerelease: 
-  segments: 
-  - 2
-  - 0
-  - 1
-  version: 2.0.1
+  version: 2.0.3
 platform: ruby
 authors: 
 - Aaron Beckerman
@@ -15,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2025-05-16 00:00:00 -07:00
+date: 2026-06-06 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -42,24 +36,14 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 57
-      segments: 
-      - 1
-      - 8
-      - 7
       version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 requirements: []