lps 0.1.0 → 0.1.1

data/README.md

@@ -29,11 +29,18 @@ 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
+
+
+# Every 0.1 second
+LPS.interval(0.1).loop do
+  # do something
+end
 ```
 
 Breaking out of the loop

data/lib/lps.rb

@@ -1,22 +1,43 @@
 require "lps/version"
 
 class LPS
+  # @param [Numeric] freq Frequency of loop execution (loops/sec)
+  # @return [LPS]
   def self.freq freq
-    LPS.new :freq => freq
+    LPS.new.freq freq
   end
 
+  # @param [Numeric] intv Loop execution interval
+  # @return [LPS]
+  def self.interval intv
+    LPS.new.interval intv
+  end
+
+  # @param [Proc] &cond Loop condition
+  # @return [LPS]
   def self.while &cond
-    LPS.new :cond => cond
+    LPS.new.while &cond
   end
 
+  # @param [Numeric] freq Frequency of loop execution (loops/sec)
+  # @return [LPS]
   def freq freq
     LPS.new(:freq => freq, :cond => @cond)
   end
 
+  # @param [Numeric] intv Loop execution interval
+  # @return [LPS]
+  def interval intv
+    freq(intv == 0 ? nil : (1.0 / intv))
+  end
+
+  # @param [Proc] &cond Loop condition
+  # @return [LPS]
   def while &cond
     LPS.new(:freq => @freq, :cond => cond)
   end
 
+  # @param [Proc] &block Loop
   def loop &block
     ret = nil
     if @freq.nil?
@@ -44,17 +65,20 @@ class LPS
     ret
   end
 
+  # @param [Hash] opts Options Hash.
+  # @option opts [Numeric] :freq Frequency of loop execution (loops/sec)
+  # @option opts [#call] :cond Loop condition
   def initialize opts = {}
-    raise ArgumentError.new("Not a Hash") unless opts.is_a?(Hash)
+    raise ArgumentError, 'Not a Hash' unless opts.is_a?(Hash)
 
     @freq = opts[:freq]
-    raise ArgumentError.new(
-      "Frequency must be a positive number (or nil)") unless 
+    raise ArgumentError,
+      '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)
+    raise ArgumentError, 'Invalid condition block' unless
+        @cond.respond_to?(:call)
   end
 end
 

data/lib/lps/version.rb

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

data/test/test_lps.rb

@@ -66,5 +66,16 @@ class TestLPS < Test::Unit::TestCase
       puts [ps, cnt].join ' => '
     end
   end
+
+  def test_lps_interval
+    20.times.map { |i| 1 << i }.each do |ps|
+      cnt = 0
+
+      now = Time.now
+      LPS.interval(1.0 / ps).while { Time.now - now <= 1 }.loop { cnt += 1 }
+
+      puts [ps, cnt].join ' => '
+    end
+  end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lps
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-23 00:00:00.000000000 Z
+date: 2013-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit
-  requirement: &2155956340 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2155956340
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &2155951960 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2155951960
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-test
-  requirement: &2155949980 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +53,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2155949980
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Rate-controlled loop execution
 email:
 - junegunn.c@gmail.com
@@ -81,9 +96,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Rate-controlled loop execution
 test_files:
 - test/test_lps.rb
+has_rdoc: