weighted_list 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a8ad1ca4f95df917bd99628170dfc4b7571633216e6b3637504135ab3fb759e
-  data.tar.gz: cff9e4ee6597b77a60cbbd04abfe39f84cce89ed787d898a3a627ad5638664ad
+  metadata.gz: 5d5b3840de4d609e646fb51214fd8ee68ffb538878213e5d3a03e59d53410f7b
+  data.tar.gz: 6a6a085e2d086c4ae4ca00e7dacecd3350f1af2f98cd910f3c1d8a0be07c3c15
 SHA512:
-  metadata.gz: ba0ec48511362ad411da0188ed6680fd58edf866141a23bfe2d71c70b51d4f74965c930187ed27537d27a39466516d93e47bdcff8498700a7561091f0e4b86cc
-  data.tar.gz: c0f9c8f9a7058396fa711973f04abe04de40bf09f03ac08f6ddadfac3a94c131fc6e563ecb36171918c170a7e59b4d5d9e59dafce39c07a17ad422cb3eb65dbc
+  metadata.gz: f52a7a8bdc0e912069f1ef71ce74220c24d720e71c8d3faadc328f5398127daac959a327cb1b9268e9ed9a227892a214b80816d46ef22fcfa8318e86dd1d7044
+  data.tar.gz: d79b5c017734bb73f73392d280a0d745f50c868b2c56a3b826d69f7b93db929dd1d633a415c9bb6244ffeacb47e1016c01a881d5c889d6909805d244a01638f1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    weighted_list (0.5.0)
+    weighted_list (0.7.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -4,9 +4,11 @@
 
 1. Sampling *without* replacement, analogous to Ruby's own `Array#sample`
 
-2. Behaving as a typical Ruby collection with `#each`, `#map`, `#sort`, etc...
+2. Implementing a weighted shuffle
 
-3. Using any user supplied randomizer that responds to `#rand` with a number
+3. Accepting an external source of randomness for easy deterministic testing
+
+4. Behaving like other Ruby collections with `#each`, `#map`, `#sort`, etc...
 
 ## Installation
 
@@ -40,7 +42,8 @@ list.sample(100) # => [:central, :eastern, :pacific, :mountain]
 # It acts like a proper Ruby collection should:
 list.map(&:to_s).map(&:capitalize).sort.join(', ') # => "Central, Eastern, Mountain, Pacific"
 
-# For when you'd like to provide your own entropy or cleanly test deterministically.
+# For when you'd like to provide your own entropy (perhaps for deterministic tests):
+# Just make sure the object you pass responds to `rand`
 class CustomRandomizer
   def rand(n)
     1.0
@@ -50,6 +53,11 @@ list.sample(2, random: CustomRandomizer.new) # => [:eastern, :central]
 
 # If you want to allow repeats:
 list.sample(4, with_replacement: true) # => [:eastern, :mountain, :eastern, :eastern]
+
+# Shuffle the list while still respecting the weights
+list.shuffle # => [:central, :eastern, :mountain, :pacific]
+list.shuffle # => [:pacific, :eastern, :central, :mountain]
+list.shuffle # => [:pacific, :central, :eastern, :mountain]
 ```
 
 ## Development

data/lib/weighted_list.rb

@@ -16,7 +16,7 @@ class WeightedList
   end
 
   def each(&block)
-    hash.keys.each(&block)
+    hash.each_key(&block)
   end
 
   def sample(quantity = nil, random: Random, with_replacement: false)
@@ -29,6 +29,10 @@ class WeightedList
     end[:selected]
   end
 
+  def shuffle(random: Random)
+    sample(hash.length, random: random)
+  end
+
   private
 
   attr_reader :hash, :random

data/lib/weighted_list/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class WeightedList
-  VERSION = '0.5.0'
+  VERSION = '0.7.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: weighted_list
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Jayson Virissimo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-03 00:00:00.000000000 Z
+date: 2018-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler