weighted_list 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 79a123c813e3841e14a5e3c69cd9cabad1a235e8a31ad072d0413b633714a6cf
+  data.tar.gz: 8517d24ed3f7cb6a0f003fe217532b2cf61e01fbc1b6c41b166d475e1cd6f227
+SHA512:
+  metadata.gz: e055b1d48cbe320e0aac31a57a31d270fea8b5b92a7c81e3ec15a1a1b3e26654070262dc4e3221819914c3efe245ba9ab0552aaefdb1f0951977c1a4635d7379
+  data.tar.gz: 320b9a7bd0a458983d58e1b74023842524b82c5fd9c35232049c1b17dd99af6b7ee1f3986c3907db4f346e1ce9f776da0752735134201f1dbd106a6d82ad43c6

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.rspec_status
+.DS_Store

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.5

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in weighted_list.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    weighted_list (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  weighted_list!
+
+BUNDLED WITH
+   1.16.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Jayson Virissimo
+
+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 the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,58 @@
+# WeightedList [![Build Status](https://travis-ci.org/jaysonvirissimo/weighted_list.svg?branch=master)](https://travis-ci.org/jaysonvirissimo/weighted_list)
+
+**WeightedList** attempts to improve on the very popular [weighted_randomizer](https://rubygems.org/gems/weighted_randomizer) gem, by:
+
+1. Sampling *without* replacement, analogous to Ruby's own `Array#sample`
+
+2. Behaving as a typical Ruby collection with `#each`, `#map`, `#sort`, etc...
+
+3. Using any user supplied randomizer that responds to `#rand` with a number
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'weighted_list'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install weighted_list
+
+## Usage
+```ruby
+list = WeightedList.new({ eastern: 150, central: 92, mountain: 21, pacific: 53 })
+
+list.sample # => :pacific
+list.sample(1) # => [:central]
+list.sample(3) # => [:central, :eastern, :pacific]
+list.sample(100) # => [:central, :eastern, :pacific, :mountain]
+
+list.map(&:to_s).map(&:capitalize).sort.join(', ') # => "Central, Eastern, Mountain, Pacific"
+
+class CustomRandomizer
+  def rand(n)
+    1.0
+  end
+end
+list.sample(2, random: CustomRandomizer.new) # => [:eastern, :central]
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jaysonvirissimo/weighted_list.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "weighted_list"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/weighted_list/sampler.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+class WeightedList
+  class Sampler
+    def initialize(hash, random: Random)
+      @hash = hash.clone
+      @random = random
+    end
+
+    def call
+      Result.new(chosen, remaining)
+    end
+
+    private
+
+    attr_reader :hash, :random
+
+    Result = Struct.new(:chosen, :remaining)
+
+    def choose
+      return if hash.empty?
+      current_target = random.rand(total_weight)
+
+      hash.each do |item, weight|
+        return item if current_target <= weight
+        current_target -= weight
+      end
+    end
+
+    def chosen
+      @chosen ||= choose
+    end
+
+    def remaining
+      hash.reject { |item, _weight| chosen == item }
+    end
+
+    def total_weight
+      @total_weight ||= hash.values.reduce(&:+)
+    end
+  end
+end

data/lib/weighted_list/version.rb

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

data/lib/weighted_list.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'weighted_list/version'
+require 'weighted_list/sampler'
+
+class WeightedList
+  include Enumerable
+
+  def initialize(hash)
+    @hash = hash
+  end
+
+  def each(&block)
+    hash.keys.each(&block)
+  end
+
+  def sample(quantity = nil, random: Random)
+    @random = random
+    return single_item unless quantity
+    (0...quantity).each_with_object(initial_memo) do |_index, memo|
+      result = Sampler.new(memo[:current_list], random: random).call
+      memo[:chosen].push(result.chosen)
+      memo[:current_list] = result.remaining
+    end[:chosen].compact
+  end
+
+  private
+
+  attr_reader :hash, :random
+
+  def initial_memo
+    { chosen: [], current_list: hash }
+  end
+
+  def single_item
+    Sampler.new(hash, random: random).call.chosen
+  end
+end

data/weighted_list.gemspec

@@ -0,0 +1,37 @@
+
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'weighted_list/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'weighted_list'
+  spec.version       = WeightedList::VERSION
+  spec.authors       = ['Jayson Virissimo']
+  spec.email         = ['jayson.virissimo@asu.edu']
+
+  spec.summary       = 'Sample from a weighted list.'
+  spec.description   = 'Choose random elements from a weighted list with or without replacement.'
+  spec.homepage      = 'https://github.com/jaysonvirissimo/weighted_list'
+  spec.license       = 'MIT'
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org/'
+  else
+    raise 'RubyGems >= 2.0 is required to protect against public gem pushes.'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  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 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: weighted_list
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jayson Virissimo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-10-26 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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Choose random elements from a weighted list with or without replacement.
+email:
+- jayson.virissimo@asu.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/weighted_list.rb
+- lib/weighted_list/sampler.rb
+- lib/weighted_list/version.rb
+- weighted_list.gemspec
+homepage: https://github.com/jaysonvirissimo/weighted_list
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Sample from a weighted list.
+test_files: []