lps 0.2.0 → 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3a433af96e982c102cc101b37b9a9c042f19db11
+  data.tar.gz: 800b2fbcb1ed6b121d04a44148d38076722416e9
+SHA512:
+  metadata.gz: acaef70ad1f4aeb6df6e64f14b0a52a9834da3793274b423cc1139051be6200f1471905c18389ab789e4c88b9eb624c849a66184bc2ed4351a82cb1d4a9444db
+  data.tar.gz: bc3f0a35462336e7d7be7ed8daf83e14f1d9d8956e69b5588854e3041f542c9243da88cc6a0ea3e171beb8980f5569f83cd52e069243259e98cba5c0a7052290

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - "1.8.7"
+  - "1.9.2"
+  - "1.9.3"
+  - "2.0.0"
+  - jruby-18mode # JRuby in 1.8 mode
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-18mode
+  - rbx-19mode

data/README.md

@@ -50,6 +50,17 @@ Breaking out of the loop
 LPS.freq(10).loop { break if rand(10) == 0 }
 ```
 
+Changing loop frequency
+-----------------------
+
+```ruby
+i = 0
+LPS.while { i < 100 }.loop do |lps|
+  print '.'
+  lps.freq = i += 1
+end
+```
+
 Falling behind
 --------------
 

data/Rakefile

@@ -6,3 +6,5 @@ Rake::TestTask.new(:test) do |test|
   test.pattern = 'test/**/test_*.rb'
   test.verbose = true
 end
+
+task :default => :test

data/lib/lps.rb

@@ -1,6 +1,10 @@
 require "lps/version"
 require 'option_initializer'
 
+# @!attribute [r] freq
+#   @return [Number] Loop frequency
+# @!attribute [r] interval
+#   @return [Number] Loop interval (inverse of frequency)
 class LPS
   include OptionInitializer
   option_initializer! :freq, :interval => Numeric, :while => :&
@@ -13,24 +17,32 @@ class LPS
     raise ArgumentError, 'interval must be a non-negative number' if v < 0
   end
 
-  # @param [Proc] &block Loop
+  attr_reader :freq, :interval
+
+  # Main loop
+  # @param [Proc] block Loop
   def loop &block
     ret = nil
     always = @while.nil?
+
     if @freq.nil?
       while always || @while.call
-        ret = block.call
+        ret = block.call self
+
+        # Frequency set!
+        return loop(&block) if @freq
       end
     else
-      sleep_interval = 1.0 / @freq
-
       nt = Time.now
       while always || @while.call
-        nt += sleep_interval
-        ret = block.call
+        ret = block.call self
+
+        # Frequency unset!
+        return loop(&block) unless @freq
 
-        now  = Time.now
-        diff = nt - now
+        nt   += @interval
+        now   = Time.now
+        diff  = nt - now
 
         if diff > 0.01
           sleep diff
@@ -42,9 +54,30 @@ class LPS
     ret
   end
 
+  # Changes loop frequency
+  # @param [Number|nil] f Loop frequency
+  # @return [Number|nil]
+  def freq= f
+    validate_options(:freq => f)
+
+    @freq, @interval = [f, f ? 1.0 / f : 0]
+    @freq
+  end
+
+  # Changes loop interval
+  # @param [Number] intv Loop interval
+  # @return [Number]
+  def interval= intv
+    validate_options(:interval => intv)
+
+    @freq, @interval = [(intv == 0) ? nil : 1.0 / intv, intv]
+    @interval
+  end
+
   # @param [Hash] opts Options Hash.
   # @option opts [Numeric] :freq Frequency of loop execution (loops/sec)
   # @option opts [#call] :cond Loop condition
+  # @private
   def initialize opts = {}
     validate_options opts
 
@@ -60,6 +93,7 @@ class LPS
       else
         nil
       end
+    @interval = @freq ? 1.0 / @freq : 0
   end
 end
 

data/lib/lps/version.rb

@@ -1,3 +1,3 @@
 class LPS
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

data/lps.gemspec

@@ -19,4 +19,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'test-unit'
   gem.add_development_dependency 'guard'
   gem.add_development_dependency 'guard-test'
+  gem.add_development_dependency 'rake'
 end

data/test/test_lps.rb

@@ -90,5 +90,57 @@ class TestLPS < Test::Unit::TestCase
       puts [ps, cnt].join ' => '
     end
   end
+
+  def test_freq=
+    st = Time.now
+    i = 0
+    LPS.freq(1).while { i < 100 }.loop do |lps|
+      print i += 1
+      print ' '
+
+      lps.freq = i
+      assert_equal i, lps.freq
+    end
+    assert ((Time.now - st) - (1...100).map { |e| 1.0 / e }.inject(:+)).abs < 0.1
+  end
+
+  def test_freq_to_nil
+    i = 0
+    st = Time.now
+    LPS.freq(1).while { i < 100 }.loop do |lps|
+      print i += 1
+      print ' '
+
+      lps.freq = nil
+    end
+    assert (Time.now - st) < 0.1
+  end
+
+  def test_interval=
+    st = Time.now
+    i = 0
+    LPS.interval(1).while { i < 100 }.loop do |lps|
+      print i += 1
+      print ' '
+
+      lps.interval = 1.0 / i
+      assert_equal 1.0 / i, lps.interval
+    end
+    assert ((Time.now - st) - (1...100).map { |e| 1.0 / e }.inject(:+)).abs < 0.1
+  end
+
+  def test_invalid_freq_interval
+    assert_raise(ArgumentError) do
+      LPS.freq(10).loop do |lps|
+        lps.freq = -1
+      end
+    end
+
+    assert_raise(ArgumentError) do
+      LPS.freq(10).loop do |lps|
+        lps.interval = -1
+      end
+    end
+  end
 end
 

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: lps
 version: !ruby/object:Gem::Version
-  version: 0.2.0
-  prerelease: 
+  version: 0.2.1
 platform: ruby
 authors:
 - Junegunn Choi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-18 00:00:00.000000000 Z
+date: 2013-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: option_initializer
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,49 +27,57 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-test
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Rate-controlled loop execution
@@ -83,6 +88,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - Guardfile
 - LICENSE
@@ -94,27 +100,27 @@ files:
 - test/test_lps.rb
 homepage: https://github.com/junegunn/lps
 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.25
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Rate-controlled loop execution
 test_files:
 - test/test_lps.rb
+has_rdoc: