timeloop 1.0.3 → 2.0.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MTMzN2I2ZmE3MGY1MjMyMzY5ZWQxOTNkNDVhMDljYjc0OWQ0MTk5NQ==
-  data.tar.gz: !binary |-
-    ODYxODZmNWFlOTM5Njc0OTkxZjc5YTg3OWFhOTNjZjZlNjVkY2ZiNQ==
+SHA1:
+  metadata.gz: f87b83fb56ecfca6fa89255b53b1e07da53d9963
+  data.tar.gz: a6f76643df4419b586da4df4726003db238b6ae8
 SHA512:
-  metadata.gz: !binary |-
-    OGQwMDk2Y2YyMThkNDc3MmEyNWJmZmJmZTM1ZjkxYmQ3NGM0NDk5YWMxMjg5
-    ZDgyNDI4OWRhYWY0NzJiNTRmYTYxMTMxZTZhNGIwZTg5ZTdiOTdhZmJhMjFi
-    NGNjZjYyMjRiZDc2ODRmMzA0MmViMjI5NmE0NGU3YmY0ZDUwNjA=
-  data.tar.gz: !binary |-
-    YzUxOTg2ZGJkNjFiZGZlM2VkNTUxNmRjNDMwMGRhY2IyMmJmMTkwN2ZhOTI5
-    YzgwYzZkNWJjNzAwYzRkNzNlNWNkNGRhZWVlYjcxNTY4ODY4NzMxNTk1ZWUy
-    YTFhNjMyYWViZWRhNmMwMDAzYTJjYzM5OTBmNmMwNWJjMjk0NGQ=
+  metadata.gz: 68ebd000097745cfb4f9de25a4ba3152a44876a9987b5a6361eec557f3600a6da5f943e0e5c45ffad39faa2dcf08a90ccf33da5e3ff8c9f72d4a8372016f6b8a
+  data.tar.gz: df2377a796a83f2cb6431fd7ef607f9432e7c48e80cc52e6776d314bbf6168313a2402d31ca8226dd8d636f997d7bf136a25e85e7b428b62e97be56fb5536fc6

data/.travis.yml

@@ -1,5 +1,6 @@
 language: ruby
 script: bundle exec rake
+sudo: false
 rvm:
   - 1.9.3
   - 2.0.0

data/README.md

@@ -1,6 +1,6 @@
 # Timeloop [![Code Climate](https://codeclimate.com/github/pinoss/timeloop.png)](https://codeclimate.com/github/pinoss/timeloop) [![Build Status](https://travis-ci.org/pinoss/timeloop.svg?branch=master)](https://travis-ci.org/pinoss/timeloop) [![Coverage Status](https://coveralls.io/repos/pinoss/timeloop/badge.png?branch=master)](https://coveralls.io/r/pinoss/timeloop?branch=master) [![Gem Version](https://badge.fury.io/rb/timeloop.svg)](http://badge.fury.io/rb/timeloop)
 
-Timeloop is a simple Ruby gem that provides loop with time interval inspired on 'every' method from whenever gem. 
+Timeloop is a simple Ruby gem that provides loop with time interval inspired on 'every' method from whenever gem.
 
 ## Installation
 
@@ -23,7 +23,7 @@ Require gem in you Ruby file:
 ```ruby
 require 'timeloop'
 
-every 10.seconds do
+Timeloop.every 10.seconds do
   puts '10 seconds delay'
 end
 
@@ -34,7 +34,7 @@ end
 # 10 seconds delay
 # ...
 
-every 3.hours do
+Timeloop.every 3.hours do
   Mail.deliver do
     from    'me@test.email'
     to      'you@test.email'
@@ -43,7 +43,7 @@ every 3.hours do
   end
 end
 
-every :minute do
+Timeloop.every :minute do
   product = 2 * 2
   puts "and 2 * 2 is still #{product}"
 end
@@ -59,7 +59,7 @@ end
 You can also specify how many times your block will be evaluated:
 
 ```ruby
-every 10.seconds, maximum: 4.times do |i|
+Timeloop.every 10.seconds, maximum: 4.times do |i|
  puts i
 end
 
@@ -71,7 +71,7 @@ end
 # 3
 # => 4
 
-every 'second', maximum: 3 do |i|
+Timeloop.every 'second', maximum: 3 do |i|
  puts 'You will see me only 3 times.'
 end
 
@@ -83,6 +83,21 @@ end
 # => 3
 ```
 
+If you want to include the `every` method in your own classes simply
+include the `Timeloop::Helper` module.
+
+```ruby
+class MyClass
+  include Timeloop::Helper
+
+  def doit
+    every 10.seconds, max: 4 do |i|
+      puts i
+    end
+  end
+end
+```
+
 ## Contributing
 
 1. Fork it ( https://github.com/pinoss/timeloop/fork )

data/lib/timeloop.rb

@@ -1,28 +1,69 @@
 require 'timeloop/core_ext'
 require 'timeloop/version'
 
-module Kernel
-  def every(value, opts = {})
-    maximum = parse_maximum_value(opts.fetch(:maximum)) if opts.key? :maximum
-    frequency = parse_frequency(value)
-
-    if maximum.nil?
-      i = 0
-      loop do
-        yield(i) if block_given?
-        sleep frequency
-        
-        i += 1
-      end
-    else
-      maximum.times do |i|
-        yield(i) if block_given?
-        sleep frequency
-      end
+# Execute a block of code periodically. The runtime of the block is
+# taken in to account so a delay in one run does not impact the start
+# times of future runs.
+class Timeloop
+  # Runs provided block periodically.
+  #
+  # Yields Integer index of the iteration to the provide block every `period`.
+  def loop
+    i = -1
+    super() do
+      run_started_at = Time.now
+      i += 1
+      logger.debug("#{to_s}: starting #{i}th run")
+      yield(i) if block_given?
+
+      break if i+1 >= max
+
+      sleep til_next_start_time(Time.now - run_started_at)
+             .tap{|s| logger.debug "#{to_s}: sleeping #{s} seconds until next run" }
     end
   end
 
-  private
+  # Returns string representation of self,
+  def to_s
+    ["#<Timeloop period=#{period}",
+     max < Float::INFINITY ? ", max=#{max}" : "",
+     ">"].join
+  end
+
+  protected
+
+  attr_reader :period, :max, :logger
+
+  # Initialize a new Timeloop object.
+  #
+  # Options
+  #   period  - seconds or name of time period (eg, 'second', 'hour')
+  #             between iterations
+  #   max     - the maximum number of executions of the block. Default:
+  #             INFINITY
+  #   maximum - synonym of `max`
+  #   logger  - logger to which debugging info should be sent. Default:
+  #             no logging
+  def initialize(opts)
+    @period = parse_frequency(opts.fetch(:period))
+    @max    = parse_maximum_value(opts.fetch(:maximum){opts.fetch(:max, Float::INFINITY)})
+    @logger = opts.fetch(:logger) { NULL_LOGGER }
+  end
+
+  def til_next_start_time(current_run_duration)
+    [0, period - current_run_duration].max
+  end
+
+  def parse_maximum_value(maximum)
+    case maximum
+    when Enumerator
+      maximum.count
+    when Integer, Float::INFINITY
+      maximum
+    else
+      fail ArgumentError.new('wrong type of argument (should be an Enumerator or Integer)')
+    end
+  end
 
   def parse_frequency(frequency)
     case frequency
@@ -30,7 +71,7 @@ module Kernel
       frequency
     when :second, 'second'
       1.second
-    when :minute, 'second'
+    when :minute, 'minute'
       1.minute
     when :hour, 'hour'
       1.hour
@@ -45,18 +86,34 @@ module Kernel
     end
   end
 
-  def parse_maximum_value(maximum)
-    case maximum
-    when Enumerator
-      maximum.count
-    when Integer
-      maximum
-    else
-      fail ArgumentError.new('wrong type of argument (should be an Enumerator or Integer)')
+  # Useful to avoid conditionals in logging code.
+  NULL_LOGGER = Class.new do
+    def debug(*args); end
+  end.new
+
+  # Conveniences methods that provide access to the Timeloop
+  # functionality to be included in other classes and modules.
+  module Helper
+    # Provides a way to execute a block of code periodically. The
+    # runtime of the block is taken in to account so a delay in one run
+    # does not impact the start times of future runs.
+    #
+    # Arguments
+    #   period - seconds or name of time period (eg,
+    #            'second', 'hour') between iterations
+    #
+    # Options
+    #   max     - the maximum number of executions of the block. Default:
+    #             INFINITY
+    #   maximum - synonym of `max`
+    #   logger  - logger to which debugging info should be sent. Default:
+    #             no logging
+    #
+    # Yields Integer index of the iteration to the provide block every `period`.
+    def every(period, opts = {}, &blk)
+      Timeloop.new(opts.merge(period: period)).loop(&blk)
     end
   end
-end
 
-class Object
-  include Kernel
+  extend Helper
 end

data/lib/timeloop/version.rb

@@ -1,3 +1,3 @@
-module Timeloop
-  VERSION = '1.0.3'
+class Timeloop
+  VERSION = '2.0.0'
 end

data/spec/unit/timeloop_spec.rb

@@ -0,0 +1,129 @@
+require 'spec_helper'
+require 'logger'
+
+describe Timeloop do
+  describe ".new" do
+    it "accepts all the options" do
+      expect(described_class.new(period: 0.1, maximum: 3, logger: a_logger))
+        .to be_kind_of described_class
+    end
+
+    it "works with minimal options set" do
+      expect(described_class.new(period: 0.1))
+        .to be_kind_of described_class
+    end
+
+    it "understands english periods" do
+      expect(described_class.new(period: :second))
+        .to be_kind_of described_class
+    end
+
+    it "rejects bogus periods" do
+      expect{described_class.new(period: :circle)}
+        .to raise_error ArgumentError
+    end
+  end
+
+  describe ".every(period, max: 3)" do
+    it "invokes block on the specified period" do
+      start_times = []
+      Timeloop.every(0.1, max: 3) { start_times << Time.now }
+
+      expect(start_times[1] - start_times[0]).to be_within(0.01).of(0.1)
+      expect(start_times[2] - start_times[1]).to be_within(0.01).of(0.1)
+    end
+  end
+
+  describe ".every(period, maximum: 3)" do
+    it "invokes block on the specified period" do
+      start_times = []
+      Timeloop.every(0.1, maximum: 3) { start_times << Time.now }
+
+      expect(start_times[1] - start_times[0]).to be_within(0.01).of(0.1)
+      expect(start_times[2] - start_times[1]).to be_within(0.01).of(0.1)
+    end
+  end
+
+  describe ".every(period)" do
+    it "loops forever" do
+      expect {
+        Timeout.timeout(1) do
+          expect{|b| Timeloop.every(0.1, &b)}.to yield_control.exactly(10).times
+        end
+      }.to raise_error(Timeout::Error)
+    end
+  end
+
+  subject { described_class.new(period: 0.1, maximum: 3, logger: a_logger) }
+
+  describe "logging" do
+    it "records sleeps" do
+      subject.loop {}
+
+      expect(a_logger).to have_received(:debug).with(/sleeping/i).exactly(2)
+    end
+
+    it "records starts" do
+      subject.loop {}
+
+      expect(a_logger).to have_received(:debug).with(/starting/i).exactly(3)
+      expect(a_logger).to have_received(:debug).with(/starting.*0/i)
+      expect(a_logger).to have_received(:debug).with(/starting.*1/i)
+      expect(a_logger).to have_received(:debug).with(/starting.*2/i)
+    end
+  end
+
+  it "invokes block on the specified period" do
+    start_times = []
+    subject.loop { start_times << Time.now }
+
+    expect(start_times[1] - start_times[0]).to be_within(0.01).of(0.1)
+    expect(start_times[2] - start_times[1]).to be_within(0.01).of(0.1)
+  end
+
+  it "invokes block on the specified period even if block takes a (relatively) long time" do
+    start_times = []
+    subject.loop { start_times << Time.now; sleep 0.08 }
+
+    expect(start_times[1] - start_times[0]).to be_within(0.01).of(0.1)
+    expect(start_times[2] - start_times[1]).to be_within(0.01).of(0.1)
+  end
+
+  it "invokes block continuously without any delays if block takes longer than period" do
+    start_times = []
+    subject.loop { start_times << Time.now; sleep 0.18 }
+
+    expect(start_times[1] - start_times[0]).to be_within(0.01).of(0.18)
+    expect(start_times[2] - start_times[1]).to be_within(0.01).of(0.18)
+  end
+
+  it "provides run count on iteration" do
+    expect{|b| subject.loop(&b)}.to yield_successive_args(0, 1, 2)
+  end
+
+  context "w/ max" do
+    specify { expect(subject.to_s).to eq "#<Timeloop period=0.1, max=3>" }
+
+    it "stops looping at maximum number of time" do
+      expect{|b| subject.loop(&b)}.to yield_control.exactly(3).times
+    end
+  end
+
+  context "w/o max" do
+    subject { described_class.new(period: 0.1) }
+
+    specify { expect(subject.to_s).to eq "#<Timeloop period=0.1>" }
+
+    it "loops forever" do
+      expect {
+        Timeout.timeout(1) do
+          subject.loop {  }
+        end
+      }.to raise_error(Timeout::Error)
+    end
+  end
+
+  # Background
+
+  let(:a_logger) { spy(instance_double(Logger)) }
+end

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: timeloop
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 2.0.0
 platform: ruby
 authors:
 - Maciej Paruszewski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-23 00:00:00.000000000 Z
+date: 2015-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
 - !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'
 - !ruby/object:Gem::Dependency
   name: rspec
   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'
 - !ruby/object:Gem::Dependency
   name: coveralls
   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: 
@@ -73,9 +73,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -90,6 +90,7 @@ files:
 - spec/spec_helper.rb
 - spec/unit/core_ext/integer_spec.rb
 - spec/unit/core_ext/numeric_spec.rb
+- spec/unit/timeloop_spec.rb
 - timeloop.gemspec
 homepage: https://github.com/pinoss/timeloop
 licenses:
@@ -101,17 +102,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Timeloop is a simple Ruby gem that provides loop with time interval.
@@ -119,3 +120,4 @@ test_files:
 - spec/spec_helper.rb
 - spec/unit/core_ext/integer_spec.rb
 - spec/unit/core_ext/numeric_spec.rb
+- spec/unit/timeloop_spec.rb