pickup 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 fl00r
+
+MIT License
+
+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,77 @@
+# Pickup
+
+Pickup helps you to pick item from collection by it's weight/probability
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'pickup'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pickup
+
+## Usage
+
+For example, we have got a pond with fish.
+
+  ```ruby
+    pond = {
+      "selmon"  => 1,
+      "carp" => 4,
+      "crucian"  => 3,
+      "herring" => 6,
+      "sturgeon" => 8,
+      "gudgeon" => 10,
+      "minnow" => 20
+    }
+  ```
+Values are a chence to get this fish.
+
+So we should create our pickup.
+
+  ```ruby
+    pickup = Pickup.new(pond)
+    pickup.pick(3)
+    #=> [ "gudgeon", "minnow", "minnow" ]
+  ```
+Look, we've just catched few minnows! To get selmon we need some mor tries ;)
+
+Ok. What if our probability is not a linear function. We can create our pickup with a function:
+
+  ```ruby
+    pickup = Pickup.new(pond){ |v| v**2 }
+    pickup.pick(3)
+    #=> ["carp", "selmon", "crucian"]
+  ```
+Wow, good catch!
+
+Also you can change our `function` on the fly. Let's make square function:
+
+  ```ruby
+    pickup = Pickup.new(pond)
+    pickup.pick_func = Proc.new{ |v| v**2 }
+  ```
+Or you can pass a block as a probability function wich will be applicable only to current operation
+
+  ```ruby
+    pickup = Pickup.new(pond)
+    pickup.pick{ |v| 1/v } # same as pickup.pick(1){ ... }
+    #=> "selmon"
+    pickup.pick
+    #=> "minnow"
+  ```
+
+
+## Contributing
+
+1. Fork it
+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

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+task :default => :spec
+
+desc 'Tests'
+Rake::TestTask.new(:spec) do |t|
+  t.libs << 'spec'
+  t.pattern = 'spec/**/*_spec.rb'
+  t.verbose = false
+end

data/lib/pickup.rb

@@ -0,0 +1,74 @@
+require "pickup/version"
+
+class Pickup
+  attr_reader :list
+  attr_writer :pick_func
+
+  def initialize(list, &block)
+    @list = list
+    @pick_func = block if block_given?
+  end
+
+  def pick(count=1, &block)
+    func = block || pick_func
+    mlist = MappedList.new(list, func)
+    result = count.times.map do |i|
+      mlist.random
+    end
+    count == 1 ? result.first : result
+  end
+
+  def pick_func
+    @pick_func ||= begin
+      Proc.new do |val|
+        val
+      end
+    end
+  end
+
+  class MappedList
+    attr_reader :list, :func, :uniq
+
+    def initialize(list, func, uniq=false)
+      @func = func
+      @uniq = uniq
+      @list = map_list(list)
+    end
+
+    def map_list(list)
+      n = 0
+      mapped_list = {}
+      list.each do |k, v|
+        n += v
+        mapped_list[k] = {}
+        mapped_list[k][:value] = n
+        mapped_list[k][:picked] = false if uniq
+      end
+      mapped_list
+    end
+
+    def max
+      @max ||= begin
+        list.inject(0){|sum, (k,v)| sum+list[k][:value] }
+      end
+    end
+
+    def random
+      num = rand(max)
+      get_random_item(num)
+    end
+
+    def get_random_item(n)
+      item = list.detect do |k,v|
+        val = func.call v[:value]
+        num = func.call n
+        val >= num && !(uniq && v[:picked])
+      end
+      item ||= list.first{ |k,v| !v[:picked] }
+      raise "No items left" unless item
+      key = item[0]
+      list[key][:picked] = true if uniq
+      key
+    end
+  end
+end

data/lib/pickup/version.rb

@@ -0,0 +1,3 @@
+class Pickup
+  VERSION = "0.0.1"
+end

data/pickup.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/pickup/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["fl00r"]
+  gem.email         = ["fl00r@yandex.ru"]
+  gem.description   = %q{Pickup helps you to pick item from collection by it's weight/probability}
+  gem.summary       = %q{Pickup helps you to pick item from collection by it's weight/probability}
+  gem.homepage      = ""
+
+  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.name          = "pickup"
+  gem.require_paths = ["lib"]
+  gem.version       = Pickup::VERSION
+end

data/spec/pickup/pickup_spec.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Pickup do
+  before do
+    @list = {
+      "selmon"  => 1,
+      "carp" => 4,
+      "crucian"  => 3,
+      "herring" => 6,
+      "sturgeon" => 8,
+      "gudgeon" => 10,
+      "minnow" => 20
+    }
+    @func = Proc.new{ |a| a }
+    @pickup = Pickup.new(@list)
+  end
+
+  it "should be equal" do
+    @pickup.pick(2).size.must_equal 2
+  end
+
+  describe Pickup::MappedList do
+    before do
+      @mapped_list = {"selmon"=>{:value=>1, :picked=>false}, "carp"=>{:value=>5, :picked=>false}, "crucian"=>{:value=>8, :picked=>false}, "herring"=>{:value=>14, :picked=>false}, "sturgeon"=>{:value=>22, :picked=>false}, "gudgeon"=>{:value=>32, :picked=>false}, "minnow"=>{:value=>52, :picked=>false}}
+      @ml = Pickup::MappedList.new(@list, @func, true)
+      @ml2 = Pickup::MappedList.new(@list, @func)
+    end
+    it "should return mapped list" do
+      @ml.list.must_equal(@mapped_list)
+    end
+
+    it "should return selmon and then carp and then crucian" do
+      @ml.get_random_item(1).must_equal "selmon"
+      @ml.get_random_item(1).must_equal "carp"
+      @ml.get_random_item(1).must_equal "crucian"
+    end
+
+    it "should return selmon 3 times" do
+      @ml2.get_random_item(1).must_equal "selmon"
+      @ml2.get_random_item(1).must_equal "selmon"
+      @ml2.get_random_item(1).must_equal "selmon"
+    end
+
+    it "should return first item after last" do
+      @ml.get_random_item(30).must_equal "gudgeon"
+      @ml.get_random_item(30).must_equal "minnow"
+      @ml.get_random_item(30).must_equal "selmon"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'pickup'
+require 'minitest/spec'
+require 'minitest/autorun'

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: pickup
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- fl00r
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-29 00:00:00.000000000 Z
+dependencies: []
+description: Pickup helps you to pick item from collection by it's weight/probability
+email:
+- fl00r@yandex.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/pickup.rb
+- lib/pickup/version.rb
+- pickup.gemspec
+- spec/pickup/pickup_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Pickup helps you to pick item from collection by it's weight/probability
+test_files:
+- spec/pickup/pickup_spec.rb
+- spec/spec_helper.rb