pickup 0.0.8 → 0.0.9

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NjM5ZjczZmRhZjIzYzBkY2NjNmY5ZGNmNzY1NzczZDg0NTQ4NTMyYw==
+  data.tar.gz: !binary |-
+    MDZmNzcxNjM4MTFkMDU1OTBhNDA5MjI2YmIyNDdiM2UyMDc4MGE4Zg==
+SHA512:
+  metadata.gz: !binary |-
+    MmM4NGU2YzY2NDkyODdkZWY1ZDdhNWM5ZWFmN2VlNGFmMzVhMGQ0M2Q1ZGMy
+    MDc1MGU3MDI0NWNhNjRiYmI4YzA1YThjNDc0NTE3YTIyZmM5ODNjMzM0Mjk3
+    NWU0NjBhNDE0OTBlMzY0MTRlMThiMDcwOTg3ZTM5YzkwNTg3YTY=
+  data.tar.gz: !binary |-
+    N2JiZWU0N2JmOWFkZDExMTA1NjY2MDIyZDdkN2U5NTZjZTc0NDE0MTQxMmU4
+    NmVjOWQxYWNlZWQwOTJiYmUzZDU5M2JhODNjYzU3ODkxZDBiYzQ3MjNkMWFh
+    ZmYzNDk1ODYwODJkZWM2MzY2YTkxYWY2NDljMGQ5M2IzZTIxNTk=

data/README.md

@@ -31,7 +31,7 @@ pond = {
   "minnow" => 20
 }
 ```
-Values are a chence to get this fish.
+Values are a chance (probability) to get this fish.
 
 So we should create our pickup.
 
@@ -42,6 +42,8 @@ pickup.pick(3)
 ```
 Look, we've just catched few minnows! To get selmon we need some more tries ;)
 
+### Custom distribution function
+
 Ok. What if our probability is not a linear function. We can create our pickup with a function:
 
 ```ruby
@@ -51,7 +53,7 @@ pickup.pick(3)
 ```
 Wow, good catch!
 
-Also you can change our `function` on the fly. Let's make square function:
+Also you can change our "function" on the fly. Let's make square function:
 
 ```ruby
 pickup = Pickup.new(pond)
@@ -67,6 +69,22 @@ pickup.pick
 #=> "minnow"
 ```
 
+In case of `f(weight)=weight^10` most possible result will be "minnow", because `20^10` is `2^10` more possible then "gudgeon"
+
+```ruby
+pickup = Pickup.new(pond)
+pickup.pick(10){ |v| v**10 }
+#=> ["minnow", "minnow", "minnow", "minnow", "minnow", "minnow", "minnow", "minnow", "minnow", "minnow"]
+```
+
+Or you can use reverse probability:
+
+```ruby
+pickup = Pickup.new(pond)
+pickup.pick(10){ |v| v**(-10) }
+#=> ["selmon", "selmon", "selmon", "selmon", "crucian", "selmon", "selmon", "selmon", "selmon", "selmon"]
+```
+
 ### Random uniq pick
 
 Also we can pick random uniq items from the list
@@ -83,24 +101,34 @@ pickup.pick
 #=> "sturgeon"
 ```
 
-### Custom probability function
-
-You can define your own function. So in case of `f(weight)=weight^10` most possible result will be "minnow", because `20^10` is `2^10` more possible then "gudgeon"
-```ruby
-pickup = Pickup.new(pond)
-pickup.pick(10){ |v| v**10 }
-#=> ["minnow", "minnow", "minnow", "minnow", "minnow", "minnow", "minnow", "minnow", "minnow", "minnow"]
-```
+### Custom key and weight selection functions
 
-Or you can use reverse probability:
+We can use more complex collections by defining our own key and weight selectors:
 
 ```ruby
-pickup = Pickup.new(pond)
-pickup.pick(10){ |v| v**(-10) }
-#=> ["selmon", "selmon", "selmon", "selmon", "crucian", "selmon", "selmon", "selmon", "selmon", "selmon"]
-```
+require "ostruct"
+
+pond_ostruct = [
+  OpenStruct.new(key: "sel", name: "selmon", weight: 1),
+  OpenStruct.new(key: "car", name: "carp", weight: 4),
+  OpenStruct.new(key: "cru", name: "crucian", weight: 3),
+  OpenStruct.new(key: "her", name: "herring", weight: 6),
+  OpenStruct.new(key: "stu", name: "sturgeon", weight: 8),
+  OpenStruct.new(key: "gud", name: "gudgeon", weight: 10),
+  OpenStruct.new(key: "min", name: "minnow", weight: 20)
+]
+
+key_func = Proc.new{ |item| item.key }
+weight_func = Proc.new{ |item| item.weight }
+
+pickup = Pickup.new(pond_ostruct, key_func: key_func, weight_func: weight_func)
+pickup.pick
+#=> "gud"
 
-Reverse
+name_func = Proc.new{ |item| item.name }
+pickup.pick(1, key_func: name_func)
+#=> "gudgeon"
+```
 
 ## Contributing
 
@@ -108,4 +136,4 @@ Reverse
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Added some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+5. Create new Pull Request

data/benchmarks/pickup.rb

@@ -46,8 +46,6 @@ def big_weights(uniq=false)
   pickup.pick(100)
 end
 
-
-
 n = 500
 
 Benchmark.bm do |x|

data/lib/pickup.rb

@@ -2,17 +2,21 @@ require "pickup/version"
 
 class Pickup
   attr_reader :list, :uniq
-  attr_writer :pick_func
+  attr_writer :pick_func, :key_func, :weight_func
 
   def initialize(list, opts={}, &block)
     @list = list
     @uniq = opts[:uniq] || false
     @pick_func = block if block_given?
+    @key_func = opts[:key_func]
+    @weight_func = opts[:weight_func]
   end
 
-  def pick(count=1, &block)
+  def pick(count=1, opts={}, &block)
     func = block || pick_func
-    mlist = MappedList.new(list, func, uniq)
+    key_func = opts[:key_func] || @key_func
+    weight_func = opts[:weight_func] || @weight_func
+    mlist = MappedList.new(list, func, uniq: uniq, key_func: key_func, weight_func: weight_func)
     result = mlist.random(count)
     count == 1 ? result.first : result
   end
@@ -26,22 +30,43 @@ class Pickup
   end
 
   class CircleIterator
-    attr_reader :func, :obj, :max
+    attr_reader :func, :obj, :max, :key_func, :weight_func
 
-    def initialize(obj, func, max)
+    def initialize(obj, func, max, opts={})
       @obj = obj.dup
       @func = func
       @max = max
+      @key_func = opts[:key_func] || key_func
+      @weight_func = opts[:weight_func] || weight_func
+    end
+
+    def key_func
+      @key_func ||= begin
+        Proc.new do |item|
+          item[0]
+        end
+      end
+    end
+
+    def weight_func
+      @weight_func ||= begin
+        Proc.new do |item|
+          item[1]
+        end
+      end
     end
 
     def each
       until obj.empty?
         start = 0
-        obj.each do |item, weight|
+        obj.each do |item|
+          key = key_func.call(item)
+          weight = weight_func.call(item)
+
           val = func.call(weight)
           start += val
-          if yield([item, start, max])
-            obj.delete item
+          if yield([key, start, max])
+            obj.delete key
             @max -= val
           end
         end
@@ -50,17 +75,37 @@ class Pickup
   end
 
   class MappedList
-    attr_reader :list, :func, :uniq
+    attr_reader :list, :func, :uniq, :key_func, :weight_func
+
+    def initialize(list, func, opts=nil)
+      if Hash === opts
+        @key_func = opts[:key_func]
+        @weight_func = opts[:weight_func] || weight_func
+        @uniq = opts[:uniq] || false
+      else
+        if !!opts == opts
+          # If opts is explicitly provided as a boolean, show the deprecated warning.
+          warn "[DEPRECATED] Passing uniq as a boolean to MappedList's initialize method is deprecated. Please use the opts hash instead."
+        end
+
+        @uniq = opts || false
+      end
 
-    def initialize(list, func, uniq=false)
       @func = func
-      @uniq = uniq
       @list = list
       @current_state = 0
     end
 
+    def weight_func
+      @weight_func ||= begin
+        Proc.new do |item|
+          item[1]
+        end
+      end
+    end
+
     def each(&blk)
-      CircleIterator.new(@list, func, max).each do |item|
+      CircleIterator.new(@list, func, max, key_func: @key_func, weight_func: weight_func).each do |item|
         if uniq
           true if yield item
         else
@@ -92,7 +137,7 @@ class Pickup
     def max
       @max ||= begin
         max = 0
-        list.each{ |item| max += func.call(item[1]) }
+        list.each{ |item| max += func.call(weight_func.call(item)) }
         max
       end
     end

data/lib/pickup/version.rb

@@ -1,3 +1,3 @@
 class Pickup
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 end

data/spec/pickup/pickup_spec.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 require 'spec_helper'
+require 'ostruct'
+require 'stringio'
 
 describe Pickup do
   before do
@@ -12,20 +14,44 @@ describe Pickup do
       "gudgeon" => 10,    # 32
       "minnow" => 20      # 52
     }
+
+    @struct_list = @list.map{ |key, weight| OpenStruct.new(key: key, weight: weight) }
+
     @func = Proc.new{ |a| a }
     @pickup = Pickup.new(@list)
     @pickup2 = Pickup.new(@list, uniq: true)
+
+    @key_func = Proc.new{ |item| item.key }
+    @weight_func = Proc.new{ |item| item.weight }
+    @pickup3 = Pickup.new(@struct_list, key_func: @key_func, weight_func: @weight_func)
   end
 
-  it "should pick correct ammount of items" do
+  it "should pick correct amount of items" do
     @pickup.pick(2).size.must_equal 2
     @pickup.pick(10).size.must_equal 10
   end
 
   describe Pickup::MappedList do
     before do
-      @ml = Pickup::MappedList.new(@list, @func, true)
+      @ml = Pickup::MappedList.new(@list, @func, uniq: true)
       @ml2 = Pickup::MappedList.new(@list, @func)
+      @ml3 = Pickup::MappedList.new(@struct_list, @func, key_func: @key_func, weight_func: @weight_func)
+      @ml4 = Pickup::MappedList.new(@struct_list, @func, uniq: true, key_func: @key_func, weight_func: @weight_func)
+    end
+
+    it "deprecated warning on initialization if uniq is passed directly as a boolean" do
+      # Swap in a fake IO object for $stderr.
+      orig_stderr = $stderr
+      $stderr = StringIO.new
+
+      Pickup::MappedList.new(@list, @func, true)
+
+      # Inspect the fake IO object for the deprecated warning.
+      $stderr.rewind
+      $stderr.string.chomp.must_equal("[DEPRECATED] Passing uniq as a boolean to MappedList's initialize method is deprecated. Please use the opts hash instead.")
+    
+      # Restore the original stderr.
+      $stderr = orig_stderr
     end
 
     it "should return selmon and then carp and then crucian for uniq pickup" do
@@ -49,6 +75,18 @@ describe Pickup do
     it "should return right max" do
       @ml.max.must_equal 52
     end
+
+    it "should return selmon 4 times for non-uniq pickup (using custom weight function)" do
+      4.times{ @ml3.get_random_items([0]).first.must_equal "selmon" }
+    end
+
+    it "should return right max (using custom weight function)" do
+      @ml3.max.must_equal 52
+    end
+
+    it "should return selmon and then carp and then crucian for uniq pickup (using custom weight function)" do
+      @ml4.get_random_items([0, 0, 0]).must_equal ["selmon", "carp", "crucian"]
+    end
   end
 
   it "should take 7 different fish" do
@@ -60,13 +98,22 @@ describe Pickup do
     proc{ items = @pickup2.pick(8) }.must_raise RuntimeError
   end
 
-  it "should return include most weigtfull item (but not always - sometimes it will fail)" do
+  it "should return a list of items including the heaviest item (but not always - sometimes it will fail)" do
     items = @pickup2.pick(2){ |v| v**20 }
     (items.include? "minnow").must_equal true
   end
 
-  it "should return include less weigtfull item (but not always - sometimes it will fail)" do
+  it "should return a list of items including the lightest item (but not always - sometimes it will fail)" do
     items = @pickup2.pick(2){ |v| v**(-20) }
     (items.include? "selmon").must_equal true
   end
+
+  it "should pick correct amount of items (using custom weight function)" do
+    @pickup3.pick(4).size.must_equal 4
+    @pickup3.pick(12).size.must_equal 12
+  end
+
+  it "should take 5 fish (using custom weight function)" do
+    @pickup3.pick(5, key_func: @key_func, weight_func: @weight_func).size.must_equal 5
+  end
 end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pickup
 version: !ruby/object:Gem::Version
-  version: 0.0.8
-  prerelease: 
+  version: 0.0.9
 platform: ruby
 authors:
 - fl00r
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-04 00:00:00.000000000 Z
+date: 2014-05-20 00:00:00.000000000 Z
 dependencies: []
 description: Pickup helps you to pick item from collection by it's weight/probability
 email:
@@ -31,27 +30,26 @@ files:
 - spec/spec_helper.rb
 homepage: ''
 licenses: []
+metadata: {}
 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.23
+rubygems_version: 2.2.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Pickup helps you to pick item from collection by it's weight/probability
 test_files:
 - spec/pickup/pickup_spec.rb