weighted_random 0.0.2

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/README.rdoc

@@ -0,0 +1,75 @@
+= Weighted Random
+Weighted randomization extension for ActiveRecord.
+
+Loads records with weight value for randomization and gives ability of weighted randomization of them.
+
+== Setup
+
+Simply put the latest gem from into your Gemfile:
+
+  gem 'weighted_random'
+
+== Usage
+
+=== Migration
+
+Put these two lines into your migration file of model for which you want weighted randomization ability:
+
+  t.integer :weight
+  t.integer :cumulative_weight
+
+=== Load methods
+
+Load methods for weighted randomization into your desired class model:
+
+  class LastName << ActiveRecord::Base
+    weighted_randomizable
+    ...
+  end
+
+=== Load records
+
+Load records with weight property for randomization, here is an example of loading last names and their frequencies from CSV file:
+
+last_names.csv:
+  Smith,10
+  Johnson,8
+  Williams,7
+  Jones,6
+  Brown,6
+  Davis,5
+  Miller,4
+  Wilson,3
+
+seeds.rb:
+  csv = CSV.open(File.expand_path("seeds/first_names.csv", File.dirname(__FILE__)))
+  names = csv.collect { |name, weight| {:name => name, :weight => to_i} }
+  csv.close
+  LastName.create_with_cumulative_weight(names)
+
+Simply you have to supply collection of hashes, each with :weight integer property, to create_with_cumulative_weight
+method of your desired model class and it will load them all into database with additional cumulative_weight attribute.
+
+=== Weighted randomization
+
+To randomize some record in a weighted way, simply run:
+
+  LastName.weighted_rand
+
+== Demonstration
+
+  10.times { puts FirstName.weighted_rand.name }
+  Johnson
+  Brown
+  Johnson
+  Smith
+  Smith
+  Jones
+  Smith
+  Williams
+  Miller
+  Jones
+
+== Author
+
+Szymon Przybył (github.com/apocalyptiq)

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/weighted_random/activerecord/base.rb

@@ -0,0 +1,7 @@
+module ActiveRecord
+  class Base
+    def self.weighted_randomizable
+      extend WeightedRandom
+    end
+  end
+end

data/lib/weighted_random/version.rb

@@ -0,0 +1,3 @@
+module WeightedRandom
+  VERSION = "0.0.2"
+end

data/lib/weighted_random.rb

@@ -0,0 +1,20 @@
+module WeightedRandom
+  def compute_and_insert_cumulative_weight(collection)
+    weight_sum = 0
+    collection.collect do |item|
+      weight_sum += item[:weight]
+      item[:cumulative_weight] = weight_sum
+      item
+    end
+  end
+
+  def create_with_cumulative_weight(collection)
+    self.create! self.compute_and_insert_cumulative_weight(collection)
+  end
+
+  def weighted_rand
+    self.where("cumulative_weight >= #{rand(self.maximum('cumulative_weight'))}").order('cumulative_weight').first
+  end
+end
+
+require 'weighted_random/activerecord/base'

data/weighted_random.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "weighted_random/version"
+
+Gem::Specification.new do |s|
+  s.name        = "weighted_random"
+  s.version     = WeightedRandom::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Szymon Przybył"]
+  s.email       = ["apocalyptiq@gmail.com"]
+  s.homepage    = "https://github.com/apocalyptiq/weighted_random"
+  s.summary     = %q{Weighted randomization extension for ActiveRecord}
+  s.description = %q{ActiveRecord extension for weighted randomization which supplies loading records with weight for randomize into database and weighted randomization of them}
+
+  s.rubyforge_project = "weighted_random"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: weighted_random
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Szymon Przybył
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-04-11 00:00:00.000000000 +02:00
+default_executable: 
+dependencies: []
+description: ActiveRecord extension for weighted randomization which supplies loading
+  records with weight for randomize into database and weighted randomization of them
+email:
+- apocalyptiq@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.rdoc
+- Rakefile
+- lib/weighted_random.rb
+- lib/weighted_random/activerecord/base.rb
+- lib/weighted_random/version.rb
+- weighted_random.gemspec
+has_rdoc: true
+homepage: https://github.com/apocalyptiq/weighted_random
+licenses: []
+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: weighted_random
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Weighted randomization extension for ActiveRecord
+test_files: []