lps 0.1.0

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 lps.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,7 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :test do
+  watch(%r{^test/test_.+\.rb$})
+end
+

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Junegunn Choi
+
+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,80 @@
+LPS: Loops Per Second
+=====================
+
+Rate-controlled loop execution.
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+    gem 'lps'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lps
+
+Usage
+-----
+
+```ruby
+# - Loops 10 times per second
+# - Loops for 10 seconds
+now = Time.now
+LPS.freq(10).while { Time.now - now < 10 }.loop do
+  # do something
+end
+
+# - Loops 10 times per second
+# - Loops indefinitely
+LPS.freq(10).loop do
+  # do something
+end
+```
+
+Breaking out of the loop
+------------------------
+
+```ruby
+LPS.freq(10).loop { break if rand(10) == 0 }
+```
+
+Falling behind
+--------------
+
+With LPS, the given loop block is run synchronously,
+which means that if the block execution takes longer than the interval for the given frequency,
+(e.g. 0.01 second for 100)
+it may not be possible to achieve the desired frequency.
+
+```ruby
+12.times.map { |i| 1 << i }.each do |ps|
+  cnt = 0
+  now = Time.now
+  LPS.freq(ps).while { Time.now - now <= 1 }.loop do
+    cnt += 1
+    sleep 0.01
+  end
+
+  puts [ps, cnt].join ' => '
+end
+```
+
+```
+1 => 1
+2 => 2
+4 => 4
+8 => 8
+16 => 16
+32 => 32
+64 => 64
+128 => 98
+256 => 98
+512 => 99
+1024 => 97
+2048 => 98
+```

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end

data/lib/lps.rb

@@ -0,0 +1,60 @@
+require "lps/version"
+
+class LPS
+  def self.freq freq
+    LPS.new :freq => freq
+  end
+
+  def self.while &cond
+    LPS.new :cond => cond
+  end
+
+  def freq freq
+    LPS.new(:freq => freq, :cond => @cond)
+  end
+
+  def while &cond
+    LPS.new(:freq => @freq, :cond => cond)
+  end
+
+  def loop &block
+    ret = nil
+    if @freq.nil?
+      while @cond.call
+        ret = block.call
+      end
+    else
+      sleep_interval = 1.0 / @freq
+
+      nt = Time.now
+      while @cond.call
+        nt += sleep_interval
+        ret = block.call
+
+        now  = Time.now
+        diff = nt - now
+
+        if diff > 0.01
+          sleep diff
+        elsif diff < 0
+          nt = now
+        end
+      end
+    end
+    ret
+  end
+
+  def initialize opts = {}
+    raise ArgumentError.new("Not a Hash") unless opts.is_a?(Hash)
+
+    @freq = opts[:freq]
+    raise ArgumentError.new(
+      "Frequency must be a positive number (or nil)") unless 
+          @freq.nil? || (@freq.is_a?(Numeric) && @freq > 0)
+
+    @cond = opts[:cond] || proc { true }
+    raise ArgumentError.new("Invalid condition block") unless
+        @cond.is_a?(Proc)
+  end
+end
+

data/lib/lps/version.rb

@@ -0,0 +1,3 @@
+class LPS
+  VERSION = '0.1.0'
+end

data/lps.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/lps/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Junegunn Choi"]
+  gem.email         = ["junegunn.c@gmail.com"]
+  gem.description   = %q{Rate-controlled loop execution}
+  gem.summary       = %q{Rate-controlled loop execution}
+  gem.homepage      = "https://github.com/junegunn/lps"
+
+  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          = "lps"
+  gem.require_paths = ["lib"]
+  gem.version       = LPS::VERSION
+
+  gem.add_development_dependency 'test-unit'
+  gem.add_development_dependency 'guard'
+  gem.add_development_dependency 'guard-test'
+end

data/test/test_lps.rb

@@ -0,0 +1,70 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '../lib')
+require 'lps'
+require 'test-unit'
+
+class TestLPS < Test::Unit::TestCase
+  def test_lps
+    duration = 3
+
+    [0.2, 10, 20].each do |ps|
+      cnt = 0
+
+      now = Time.now
+      LPS.while { Time.now - now <= duration }.freq(ps).loop { cnt += 1 }
+
+      expected = (duration * ps).to_i
+      # FIXME: naive assertion
+      assert (expected-1..expected+1).include?(cnt)
+    end
+  end
+
+  def test_no_frequency
+    cnt = 0
+    now = Time.now
+    LPS.while { Time.now - now <= 1 }.loop { cnt += 1 }
+    # FIXME: naive assertion
+    assert cnt > 1000
+  end
+
+  def test_non_positive_frequency
+    assert_raise(ArgumentError) { LPS.freq(0) }
+    assert_raise(ArgumentError) { LPS.freq(-1) }
+  end
+
+  def test_non_number_frequency
+    assert_raise(ArgumentError) { LPS.freq('freq') }
+  end
+
+  def test_non_proc_cond
+    assert_raise(ArgumentError) { LPS.while('freq') }
+  end
+
+  def test_return_value
+    cnt = 0
+    now = Time.now
+    ret = LPS.while { Time.now - now <= 1 }.loop { cnt += 1 }
+    assert_equal cnt, ret
+  end
+
+  def test_loop_break
+    cnt = 0
+    LPS.freq(100).loop { break if (cnt += 1) >= 50 }
+    assert_equal 50, cnt
+  end
+
+  def test_lps_high_freq
+    20.times.map { |i| 1 << i }.each do |ps|
+      cnt = 0
+
+      now = Time.now
+      LPS.freq(ps).while { Time.now - now <= 1 }.loop { cnt += 1 }
+
+      # TODO: need assertion
+      puts [ps, cnt].join ' => '
+    end
+  end
+end
+

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: lps
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Junegunn Choi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: &2155956340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2155956340
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: &2155951960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2155951960
+- !ruby/object:Gem::Dependency
+  name: guard-test
+  requirement: &2155949980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2155949980
+description: Rate-controlled loop execution
+email:
+- junegunn.c@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/lps.rb
+- lib/lps/version.rb
+- lps.gemspec
+- test/test_lps.rb
+homepage: https://github.com/junegunn/lps
+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.11
+signing_key: 
+specification_version: 3
+summary: Rate-controlled loop execution
+test_files:
+- test/test_lps.rb