suimin 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/.rspec

@@ -0,0 +1,3 @@
+--tty
+--colour
+--format <%= ENV["CI"] ? 'progress' : 'documentation'%>

data/Gemfile

@@ -0,0 +1,13 @@
+source "https://rubygems.org"
+
+group :test do
+  gem "rspec", "~> 2.11"
+  unless ENV["CI"]
+    gem "guard-rspec"
+    gem "rb-fsevent"
+  end
+end
+
+gem "rake"
+
+gemspec

data/Guardfile

@@ -0,0 +1,9 @@
+# vim:set filetype=ruby:
+guard(
+  "rspec",
+  all_after_pass: false,
+  cli: "--fail-fast --tty --format documentation --colour") do
+
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$}) { |match| "spec/#{match[1]}_spec.rb" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Koichi Hirano
+
+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,29 @@
+# Suimin
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'suimin'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install suimin
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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 @@
+require "bundler/gem_tasks"

data/lib/suimin.rb

@@ -0,0 +1,38 @@
+require "suimin/version"
+
+module Suimin
+
+  autoload :Sleeper, 'suimin/sleeper'
+
+  class TypeError       < Exception; end
+  class SleeperNotFound < StandardError; end
+
+  # a hash whose key is the sleeper's name, and the value is the sleeper
+  @@sleepers = {}
+
+  class << self
+    def sleepers
+      @@sleepers
+    end
+
+    def add_sleeper(_sleeper)
+      raise TypeError.new("sleeper should be Suimin::Sleeper instance") unless _sleeper.is_a?(Suimin::Sleeper)
+
+      sleepers[_sleeper.name] = _sleeper
+    end
+
+    def let_sleeper_sleep(_sleeper_name)
+      if (sleeper = sleepers[_sleeper_name])
+        sleeper.sleep
+      else
+        raise SleeperNotFound.new("Sleeper #{_sleeper_name} cannot be found")
+      end
+    end
+
+  end
+
+  def self.config
+    yield self
+  end
+
+end

data/lib/suimin/sleeper.rb

@@ -0,0 +1,48 @@
+require 'securerandom'
+
+class Suimin::Sleeper
+
+  attr_reader :name, :distribution
+
+  # _config[:name]:i         The name of the sleeper instance.
+  # _config[:distribution]: An array of arrays whose element is [_probablility_, _sleep_duration_in_second_]
+  #                         For example [0.5, 1] means the probablity of sleeping for 1 second is 0.5
+  #                         If sum of the probability isn't 1.0, the probablities are normalized automatically.
+  #                         For example, [[1.0, 1], [1.0, 3]] => [[0.5, 1], [0.5, 3]]
+  def initialize(_config)
+    @distribution = normalize_distribution(_config[:distribution]).sort{|a,b| a[0] <=> b[0]}
+    @name = _config[:name]
+  end
+
+  # converts the distribution to cdf
+  def rule
+    @rule || @distribution.inject([]){|result, elm| result << [(result.empty? ? 0.0 : result.last[0]) + elm[0], elm[1]]}\
+                          .tap{|array| array.last[0] = 1.0 } # make sure the last element's cdf is 1.0
+  end
+
+  def sleep
+    Kernel.sleep sleep_duration
+  end
+
+  def sleep_duration
+    return 0 if rule.empty?
+
+    _rand = SecureRandom.random_number
+    rule.find{|elm| elm[0] >= _rand}[1]
+  end
+
+  def expected_sleep_duration_value
+    distribution.inject(0.0) {|res, elm| res += elm[0] * elm[1] }
+  end
+
+  private
+  def normalize_distribution(_distribution)
+    if _distribution.nil? || _distribution.empty?
+      raise InvalidRuleException.new("distribution should be an array of [probability, sleep_time_in_sec]")
+    end
+    _sum = _distribution.inject(0.0){|result, elm| result += elm[0] }
+    return _distribution.collect{|elm| [elm[0]/_sum, elm[1]]}
+  end
+
+  class InvalidRuleException < StandardError; end
+end

data/lib/suimin/version.rb

@@ -0,0 +1,3 @@
+module Suimin
+  VERSION = "0.0.1"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'suimin'
+
+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
+
+  config.order = 'random'
+end

data/spec/suimin/sleeper_spec.rb

@@ -0,0 +1,103 @@
+require 'spec_helper'
+require 'benchmark'
+
+describe Suimin::Sleeper do
+  describe "initialization" do
+    let(:suimin) { Suimin::Sleeper.new(name: "ichiro", distribution: [[0.2, 1], [0.8, 2]]) }
+    subject { suimin }
+    its(:name) { should == "ichiro" }
+    its(:distribution) { should == [[0.2, 1], [0.8, 2]]}
+  end
+
+  describe "#distribution" do
+
+    describe "normalize distribution of the distribution" do
+      subject { suimin.distribution }
+
+      context "the given distribution has [0.2, 1], [0.8, 2]" do
+        let(:suimin) { Suimin::Sleeper.new(name: "ichiro", distribution: [[0.2, 1], [0.8, 2]]) }
+        subject { suimin.distribution }
+        it { should == [[0.2, 1], [0.8, 2]] }
+      end
+
+      context "the given distribution has [0.2, 1], [0.2, 2]" do
+        let(:suimin) { Suimin::Sleeper.new(name: "ichiro", distribution: [[0.2, 1], [0.2, 2]]) }
+        subject { suimin.distribution }
+        it { should == [[0.5, 1], [0.5, 2]] }
+      end
+
+    end
+
+    describe "sort the distribution elements by probability" do
+      subject { suimin.distribution }
+
+      context "the given distribution has [0.8, 1], [0.2, 2]" do
+        let(:suimin) { Suimin::Sleeper.new(name: "ichiro", distribution: [[0.8, 1], [0.2, 2]]) }
+        subject { suimin.distribution }
+        it { should == [[0.2, 2], [0.8, 1]] }
+      end
+
+    end
+
+  end
+
+  describe "#rule" do #rule is a list of possible sleep interval in the form of cumulative distribution function
+    subject { suimin.rule }
+
+    context "the given distribution has [0.8, 1], [0.2, 2]" do
+      let(:suimin) { Suimin::Sleeper.new(name: "ichiro", distribution: [[0.8, 1], [0.2, 2]]) }
+      subject { suimin.rule }
+      it { should == [[0.2, 2], [1.0, 1]] }
+    end
+
+  end
+
+  describe "#sleep_duration" do
+    subject { suimin.sleep_duration }
+
+    context "given [0.8, 1], [0.2, 2] and SecureRandom::random_number returns 0.0" do
+      before { SecureRandom.stub(random_number: 0.0) }
+      let(:suimin) { Suimin::Sleeper.new(name: "ichiro", distribution: [[0.8, 1], [0.2, 2]]) }
+      it { should == 2 }
+    end
+
+    context "given [0.8, 1], [0.2, 2] and SecureRandom::random_number returns 0.2" do
+      before { SecureRandom.stub(random_number: 0.2) }
+      let(:suimin) { Suimin::Sleeper.new(name: "ichiro", distribution: [[0.8, 1], [0.2, 2]]) }
+      it { should == 2 }
+    end
+
+    context "given [0.8, 1], [0.2, 2] and SecureRandom::random_number returns 0.21" do
+      before { SecureRandom.stub(random_number: 0.21) }
+      let(:suimin) { Suimin::Sleeper.new(name: "ichiro", distribution: [[0.8, 1], [0.2, 2]]) }
+      it { should == 1 }
+    end
+
+    context "given [0.8, 1], [0.2, 2] and SecureRandom::random_number returns 1.0" do
+      before { SecureRandom.stub(random_number: 1.0) }
+      let(:suimin) { Suimin::Sleeper.new(name: "ichiro", distribution: [[0.8, 1], [0.2, 2]]) }
+      it { should == 1 }
+    end
+
+  end
+
+  describe "#expected_sleep_duration_value" do
+    context "given [0.8, 1], [0.2, 2]" do
+      subject { suimin.expected_sleep_duration_value }
+      let(:suimin) { Suimin::Sleeper.new(name: "ichiro", distribution: [[0.8, 1], [0.2, 2]]) }
+      it { should be_within(0.0000001).of(1.2) }
+    end
+  end
+
+  describe "#sleep" do
+
+    context "the given distribution has [0.2, 0.1], [0.8, 0.05]" do
+      let(:suimin) { Suimin::Sleeper.new(name: "ichiro", distribution: [[0.2, 0.1], [0.8, 0.05]]) }
+
+      specify "calling 100 times would take approximately 100 * 0.2 * 0.1 + 100 * 0.8 * 0.05" do
+        Benchmark.realtime { 1.upto(100) { suimin.sleep } }.should be_within(1.0).of(6.0)
+      end
+    end
+
+  end
+end

data/spec/suimin_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe Suimin do
+
+  describe "::config" do
+    let(:sleeper)  { Suimin::Sleeper.new(name: "napper", distribution: [[0.2, 0.1], [0.8, 0.2]]) }
+    before do
+      Suimin.config do |config|
+        config.add_sleeper sleeper
+      end
+    end
+
+    it "should have set sleepers" do
+      Suimin.sleepers[sleeper.name].should == sleeper
+    end
+  end
+
+  describe "::let_sleeper_sleep" do
+    let(:quick_napper) { Suimin::Sleeper.new(name: "quick_napper", distribution: [[0.2, 0.2], [0.8, 0.1]]) }
+    let(:snoozer)      { Suimin::Sleeper.new(name: "snoozer", distribution: [[0.2, 2], [0.8, 1]]) }
+    let(:sleepers) { [quick_napper, snoozer] }
+    before do
+      Suimin.config do |s|
+        s.add_sleeper quick_napper
+        s.add_sleeper snoozer
+      end
+    end
+
+    specify "Suimin::let_sleeper_sleep with quick_napper should call quick_napper.sleep" do
+      quick_napper.should_receive(:sleep).and_return(true)
+      snoozer.should_not_receive(:sleep)
+      Suimin.let_sleeper_sleep("quick_napper")
+    end
+
+    specify "Suimin::let_sleeper_sleep with non-existent sleeper should blow up" do
+      lambda { Suimin.let_sleeper_sleep("not_registered_napper") }.should raise_exception(Suimin::SleeperNotFound)
+    end
+
+  end
+end

data/suimin.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'suimin/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "suimin"
+  gem.version       = Suimin::VERSION
+  gem.authors       = ["Koichi Hirano"]
+  gem.email         = ["internalist@gmail.com"]
+  gem.description   = %q{A gem which provides a method that sleeps in the way you want}
+  gem.summary       = %q{When you need to have a sleeping behavior following a certain statistical distribution, this is the gem for you.}
+  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.require_paths = ["lib"]
+
+  gem.add_development_dependency 'rspec', '~> 2.10'
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: suimin
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Koichi Hirano
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.10'
+description: A gem which provides a method that sleeps in the way you want
+email:
+- internalist@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/suimin.rb
+- lib/suimin/sleeper.rb
+- lib/suimin/version.rb
+- spec/spec_helper.rb
+- spec/suimin/sleeper_spec.rb
+- spec/suimin_spec.rb
+- suimin.gemspec
+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'
+      segments:
+      - 0
+      hash: -3559506569192083543
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3559506569192083543
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: When you need to have a sleeping behavior following a certain statistical
+  distribution, this is the gem for you.
+test_files:
+- spec/spec_helper.rb
+- spec/suimin/sleeper_spec.rb
+- spec/suimin_spec.rb