weighted_random 0.0.2 → 0.0.3

data/README.rdoc

@@ -3,33 +3,36 @@ Weighted randomization extension for ActiveRecord.
 
 Loads records with weight value for randomization and gives ability of weighted randomization of them.
 
-== Setup
+== Installation
 
-Simply put the latest gem from into your Gemfile:
+=== Gem
 
   gem 'weighted_random'
 
-== Usage
+=== Model
+
+Generate model with <code>weight</code> and <code>cumulative_weight</code> integer attributes:
 
-=== Migration
+  rails g model your_model [your_attributes] weight:integer cumulative_weight:integer 
 
-Put these two lines into your migration file of model for which you want weighted randomization ability:
+Or add these two attributes into migration of existing model:
 
   t.integer :weight
   t.integer :cumulative_weight
 
-=== Load methods
-
-Load methods for weighted randomization into your desired class model:
+Load weighted randomization stuff into desired model and set accessibillity of previous these attributes:
 
-  class LastName << ActiveRecord::Base
+  class YourModel < ActiveRecord::Base
     weighted_randomizable
+    attr_accessible :weight, :cumulative_weight
     ...
   end
 
-=== Load records
+== Usage
+
+=== Load data
 
-Load records with weight property for randomization, here is an example of loading last names and their frequencies from CSV file:
+Load records with <code>weight</code> attribute for randomization, here is an example of loading last names and their frequencies from CSV file:
 
 last_names.csv:
   Smith,10
@@ -47,18 +50,19 @@ seeds.rb:
   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.
+Simply you have to supply collection of hashes, each with <code>weight</code> integer property, to
+<code>create_with_cumulative_weight</code> method of your desired model class, so it will load them all
+into database with additional <code>cumulative_weight</code> attribute, which is reqired for faster weighted randomization.
 
 === Weighted randomization
 
-To randomize some record in a weighted way, simply run:
+To get weighed random record simply run:
 
   LastName.weighted_rand
 
-== Demonstration
+=== Demonstration
 
-  10.times { puts FirstName.weighted_rand.name }
+  10.times { puts LastName.weighted_rand.name }
   Johnson
   Brown
   Johnson
@@ -72,4 +76,4 @@ To randomize some record in a weighted way, simply run:
 
 == Author
 
-Szymon Przybył (github.com/apocalyptiq)
+Szymon Przybył (http://github.com/apocalyptiq)

data/lib/weighted_random/railtie.rb

@@ -0,0 +1,12 @@
+module WeightedRandom
+  if defined? Rails::Railtie
+    require 'rails'
+    class Railtie < Rails::Railtie
+      initializer 'weighted_random.insert_into_active_record' do
+        ActiveSupport.on_load :active_record do
+          ActiveRecord::Base.send(:extend, WeightedRandom::Loader)
+        end
+      end
+    end
+  end
+end

data/lib/weighted_random/version.rb

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

data/lib/weighted_random.rb

@@ -1,20 +1,30 @@
+require 'weighted_random/railtie'
+
 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
+
+  module Loader
+    def weighted_randomizable
+      extend WeightedRandom::ClassMethods
     end
   end
 
-  def create_with_cumulative_weight(collection)
-    self.create! self.compute_and_insert_cumulative_weight(collection)
-  end
+  module ClassMethods
+    def weighted_rand
+      self.where("cumulative_weight >= #{rand(self.maximum('cumulative_weight'))}").order('cumulative_weight').first
+    end
 
-  def weighted_rand
-    self.where("cumulative_weight >= #{rand(self.maximum('cumulative_weight'))}").order('cumulative_weight').first
+    def create_with_cumulative_weight(collection)
+      self.create! self.compute_and_insert_cumulative_weight(collection)
+    end
+
+    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
   end
-end
 
-require 'weighted_random/activerecord/base'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: weighted_random
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-04-11 00:00:00.000000000 +02:00
+date: 2011-04-12 00:00:00.000000000 +02:00
 default_executable: 
 dependencies: []
 description: ActiveRecord extension for weighted randomization which supplies loading
@@ -25,7 +25,7 @@ files:
 - README.rdoc
 - Rakefile
 - lib/weighted_random.rb
-- lib/weighted_random/activerecord/base.rb
+- lib/weighted_random/railtie.rb
 - lib/weighted_random/version.rb
 - weighted_random.gemspec
 has_rdoc: true

data/lib/weighted_random/activerecord/base.rb

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