weighted_list 0.5.0 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a8ad1ca4f95df917bd99628170dfc4b7571633216e6b3637504135ab3fb759e
-  data.tar.gz: cff9e4ee6597b77a60cbbd04abfe39f84cce89ed787d898a3a627ad5638664ad
+  metadata.gz: 555c81c41659a9b521328efe8a369460ca51db7f6fa80b9ea425354ae98a3e80
+  data.tar.gz: 479301f4950b0cd0d99140bae561bfe42f89fe4579774d85c9a37736826cd5cc
 SHA512:
-  metadata.gz: ba0ec48511362ad411da0188ed6680fd58edf866141a23bfe2d71c70b51d4f74965c930187ed27537d27a39466516d93e47bdcff8498700a7561091f0e4b86cc
-  data.tar.gz: c0f9c8f9a7058396fa711973f04abe04de40bf09f03ac08f6ddadfac3a94c131fc6e563ecb36171918c170a7e59b4d5d9e59dafce39c07a17ad422cb3eb65dbc
+  metadata.gz: 0c03ed7714d0dee0d40e3d70b90c84b5c59f603387c9a2c7535bf92adac4353264b0bb6546fa63878e55af849a0441989bb2b0585a0fef5990429db35b305eb2
+  data.tar.gz: 635ab3ff9ba2f452232d84c9f03b9cd26106faf753f77bba061d08d3132bee0ce4f75868febfe47604fe1a4d02117dd1a53179ffaf3b5a265f5abcb886026dcd

data/.ruby-version

@@ -0,0 +1 @@
+3.0.2

data/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    weighted_list (0.5.0)
+    weighted_list (0.8.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
     diff-lcs (1.3)
-    rake (10.5.0)
+    rake (13.0.1)
     rspec (3.6.0)
       rspec-core (~> 3.6.0)
       rspec-expectations (~> 3.6.0)
@@ -26,10 +26,10 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.16)
-  rake (~> 10.0)
+  bundler (>= 2.2.10)
+  rake (~> 13.0)
   rspec (~> 3.0)
   weighted_list!
 
 BUNDLED WITH
-   1.16.5
+   2.2.22

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,14 @@ 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]
+
+# If you want to mutate the original list:
+list.shuffle!
 ```
 
 ## 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,18 @@ class WeightedList
     end[:selected]
   end
 
+  def shuffle(random: Random)
+    sample(hash.length, random: random)
+  end
+
+  def shuffle!(random: Random)
+    sample(hash.length, random: random).tap do |returned_collection|
+      returned_collection.each_with_object({}) do |item, replace_with|
+        replace_with[item] = hash[item]
+      end.tap { |replace_with| @hash = replace_with }
+    end
+  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.8.2'
 end

data/weighted_list.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.16'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'bundler', '>= 2.2.10'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: weighted_list
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.8.2
 platform: ruby
 authors:
 - Jayson Virissimo
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-12-03 00:00:00.000000000 Z
+date: 2021-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 2.2.10
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 2.2.10
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -61,6 +61,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
@@ -79,7 +80,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org/
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -94,9 +95,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Sample from a weighted list.
 test_files: []