weighted_shuffle 0.1.0

data/.document

@@ -0,0 +1,4 @@
+lib/**/*.rb
+README.rdoc
+ChangeLog.rdoc
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,5 @@
+html/
+pkg/
+bin/
+.bundle/
+coverage/

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - ruby-head
+  - jruby-19mode
+  - jruby-head
+  - rbx-19mode
+  - rbx-head
+script: bundle exec rspec
+matrix:
+  allow_failures:
+    - rvm: rbx-19mode
+    - rvm: rbx-head

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in yaga.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    weighted_shuffle (0.1.0)
+      activesupport
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (3.2.13)
+      i18n (= 0.6.1)
+      multi_json (~> 1.0)
+    colorize (0.5.8)
+    coveralls (0.6.7)
+      colorize
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      thor
+    diff-lcs (1.2.4)
+    i18n (0.6.1)
+    mime-types (1.23)
+    multi_json (1.7.6)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+    rubygems-tasks (0.2.4)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    thor (0.18.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  coveralls
+  rspec (~> 2.4)
+  rubygems-tasks (~> 0.2)
+  simplecov
+  weighted_shuffle!

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Frank C. Eckert
+
+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,48 @@
+# Weighted Shuffle
+
+[![Build Status](https://travis-ci.org/opahk/weighted_shuffle.png?branch=master)](https://travis-ci.org/opahk/weighted_shuffle)
+[![Coverage Status](https://coveralls.io/repos/opahk/weighted_shuffle/badge.png)](https://coveralls.io/r/opahk/weighted_shuffle)
+[![Code Climate](https://codeclimate.com/github/opahk/weighted_shuffle.png)](https://codeclimate.com/github/opahk/weighted_shuffle)
+
+An extension to the Fisher-Yates-Shuffle algorithm to support weights. It
+includes a ruby core extension convenience of arrays.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'weighted_shuffle'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install weighted_shuffle
+
+## Usage
+
+standalone usage:
+
+    array = [[:a, 1], [:b, 2]] # 1, 2 are weights
+    dealer = WeightedShuffle::Dealer.new array
+
+    dealer.weighted_shuffle
+    => [:b, :a]
+
+integrated into ruby Array:
+
+    require 'weighted_shuffle/core_ext/array/weighted_shuffle'
+
+    array = [[:a, 1], [:b, 2]]
+    array.weighted_shuffle
+    => [:b, :a]
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'rake'
+
+begin
+  gem 'rubygems-tasks', '~> 0.2'
+  require 'rubygems/tasks'
+
+  Gem::Tasks.new
+rescue LoadError => e
+  warn e.message
+  warn "Run `gem install rubygems-tasks` to install Gem::Tasks."
+end
+
+begin
+  gem 'rdoc', '~> 3.0'
+  require 'rdoc/task'
+
+  RDoc::Task.new do |rdoc|
+    rdoc.title = "weighted_shuffle"
+  end
+rescue LoadError => e
+  warn e.message
+  warn "Run `gem install rdoc` to install 'rdoc/task'."
+end
+task :doc => :rdoc
+
+begin
+  gem 'rspec', '~> 2.4'
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new
+rescue LoadError => e
+  task :spec do
+    abort "Please run `gem install rspec` to install RSpec."
+  end
+end
+
+task :test    => :spec
+task :default => :spec

data/lib/weighted_shuffle.rb

@@ -0,0 +1,5 @@
+require 'weighted_shuffle/version'
+require 'weighted_shuffle/dealer'
+
+module WeightedShuffle
+end

data/lib/weighted_shuffle/core_ext/array/weighted_shuffle.rb

@@ -0,0 +1,6 @@
+class Array
+
+  def weighted_shuffle
+    WeightedShuffle::Dealer.new(self).weighted_shuffle
+  end
+end

data/lib/weighted_shuffle/dealer.rb

@@ -0,0 +1,25 @@
+require 'active_support/core_ext/enumerable'
+
+module WeightedShuffle
+  class Dealer < Struct.new(:array)
+
+    def weighted_shuffle
+      a = Marshal.load Marshal.dump(array)
+      sum = a.sum { |k,v| v || 0.0 }
+      b = []
+      a.length.times do
+        random = SecureRandom.random_number * sum
+        a.each_with_index do |(k,v),j|
+          if random <= v
+            b << a.delete_at(j).first
+            sum -= v
+            break
+          else
+            random -= v
+          end
+        end
+      end
+      b
+    end
+  end
+end

data/lib/weighted_shuffle/version.rb

@@ -0,0 +1,4 @@
+module WeightedShuffle
+  # weighted_shuffle version
+  VERSION = "0.1.0"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start do
+  add_filter '/spec/'
+end
+
+require 'rspec'
+require 'weighted_shuffle'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/weighted_shuffle/core_ext/array/weighted_shuffle_spec.rb

@@ -0,0 +1,7 @@
+require 'weighted_shuffle/core_ext/array/weighted_shuffle'
+
+describe '#weighted_shuffle' do
+  it 'responds to weighted_shuffle' do
+    Array.new.should respond_to(:weighted_shuffle)
+  end
+end

data/spec/weighted_shuffle/dealer_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+module WeightedShuffle
+  describe Dealer do
+    describe '#weighted_shuffle' do
+      [[ [[:a, 1], [:b, 2]], [:a, :b] ],
+       [ [[1, 1], [2, 3]], [1, 2] ],
+       [ [[2.0, 1], [:a, 1.5], ['a', 2.3]], [2.0, :a, 'a'] ]]
+        .each do |input, output|
+
+        it "returns a permutation of #{output} given #{input}" do
+          output.permutation.to_a.should include(
+            Dealer.new(input).weighted_shuffle)
+        end
+
+        it 'gives correct relative frequency for first position' do
+          weights = input.map(&:last)
+          # calculate probabiities
+          sum = weights.sum
+          probabilities = weights.map { |e| e.to_f / sum }
+
+          # establish frequencies
+          size = 1000
+          sample = size.times.map { Dealer.new(input).weighted_shuffle }
+          frequencies = input.map(&:first)
+            .map do |e|
+              sample.select { |s| s.first == e }.count.to_f / size
+            end
+
+          # calculate sum of absolute values of differences
+          diff = probabilities.zip(frequencies).map { |p,f| (p - f).abs }.sum
+          diff.should < 0.1
+        end
+      end
+    end
+  end
+end

data/weighted_shuffle.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path('../lib/weighted_shuffle/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "weighted_shuffle"
+  gem.version       = WeightedShuffle::VERSION
+  gem.summary       = %q{Fisher-Yates-Shuffle algorithm with weight support}
+  gem.description   = <<-EOF
+  An extension to the Fisher-Yates-Shuffle algorithm to support weights.  It
+  includes a ruby core extension for arrays.
+  EOF
+  gem.license       = "MIT"
+  gem.authors       = ["Frank C. Eckert"]
+  gem.email         = "frank.eckert@boost-project.com"
+  gem.homepage      = "https://rubygems.org/gems/weighted_shuffle"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'activesupport'
+
+  gem.add_development_dependency 'rspec', '~> 2.4'
+  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'coveralls'
+  gem.add_development_dependency 'rubygems-tasks', '~> 0.2'
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: weighted_shuffle
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Frank C. Eckert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubygems-tasks
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: ! "  An extension to the Fisher-Yates-Shuffle algorithm to support weights.
+  \ It\n  includes a ruby core extension for arrays.\n"
+email: frank.eckert@boost-project.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .document
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/weighted_shuffle.rb
+- lib/weighted_shuffle/core_ext/array/weighted_shuffle.rb
+- lib/weighted_shuffle/dealer.rb
+- lib/weighted_shuffle/version.rb
+- spec/spec_helper.rb
+- spec/weighted_shuffle/core_ext/array/weighted_shuffle_spec.rb
+- spec/weighted_shuffle/dealer_spec.rb
+- weighted_shuffle.gemspec
+homepage: https://rubygems.org/gems/weighted_shuffle
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Fisher-Yates-Shuffle algorithm with weight support
+test_files:
+- spec/spec_helper.rb
+- spec/weighted_shuffle/core_ext/array/weighted_shuffle_spec.rb
+- spec/weighted_shuffle/dealer_spec.rb
+has_rdoc: