callback_timer 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5443a3376ac4153cbebc4fe044abf8a16d7acfc135031e783e54666b65dbc074
+  data.tar.gz: 55b84d5abd524a13c75b2461d951d27ce887117e1464fae04100a3a0c42b15cc
+SHA512:
+  metadata.gz: d8a65ef5c30e15450ba728e0222103bc3c137471cca00a4174a9b4064549ecdb3a13712f67a09a96101482274771416b9360349be42167110b44715aab1204a6
+  data.tar.gz: 310b3db17b748cccf29ded50cdbbb12299801829e53ee40e7993842b640bac4a5d3836df359ba5d8eb99cf32d3267de4c3cbad24f80d63d959c7d845dbf0b304

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Rob Fors
+
+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,16 @@
+# Callback Timer
+A Ruby Gem to create timers. The timer objects will call a given callback when the time has elapsed or can be canceled before then. *Callback Timer* only uses a single thread to schedule all the timers.
+
+# Install
+`gem install callback_timer`
+
+# Documentation
+[![Yard Docs](https://img.shields.io/badge/yard-docs-blue.svg?style=for-the-badge)](http://www.rubydoc.info/gems/callback_timer)
+
+# Example
+```ruby
+require 'callback_timer'
+
+greeting_callback = proc { puts 'Hello World!' }
+CallbackTimer.new(callback: greeting_callback, duration: 5)
+```

data/lib/callback_timer.rb

@@ -0,0 +1,113 @@
+require 'thread'
+require 'time'
+
+class CallbackTimer
+
+  # I would like to use a priority queue here but I need to be able to remove sleepers randomly.
+  #@timers = PQueue.new { |a, b| a < b }
+  @timers = []
+  @condition_variable = ConditionVariable.new
+  @mutex = Mutex.new
+  @thread = Thread.new { worker_loop }
+  
+  # Add {CallbackTimer} to the scheduler.
+  # @api private
+  # @param timer [CallbackTimer]
+  # @return [void]
+  def self.add(timer)
+    @mutex.synchronize do
+      @timers.push(timer)
+      @timers.sort_by!(&:deadline)
+      if @timers.first == timer
+        @condition_variable.signal
+      end
+    end
+    nil
+  end
+  
+  # Remove {CallbackTimer} from scheduler.
+  # @api private
+  # @param timer [CallbackTimer]
+  # @return [void]
+  def self.cancel(timer)
+    @mutex.synchronize do
+      @condition_variable.signal if @timers.first == timer
+      @timers.delete(timer)
+    end
+    nil
+  end
+  
+  # Scheduler worker loop to run in it's own thread.
+  # @api private
+  # @return [void]
+  def self.worker_loop
+    @mutex.lock
+    loop do
+      next_timer = @timers.first
+      unless next_timer
+        @condition_variable.wait(@mutex)
+        next
+      end
+      next_deadline = next_timer.deadline
+      duration = next_deadline - Time.now
+      @condition_variable.wait(@mutex, duration) if duration.positive?
+      if @timers.first != next_timer
+        # timer may have been canceled or a new timer has been added to @timers with an earlier deadline
+        next
+      end
+      @timers.shift
+      @mutex.unlock
+      next_timer.time_has_elapsed
+      @mutex.lock
+    end
+    nil
+  end
+  
+  # Time that the {CallbackTimer} should call it's callback.
+  # @api private
+  # @return [Time]
+  attr_reader :deadline
+  
+  # Creates and starts a new {CallbackTimer}.
+  # @param callback [#to_proc]
+  # @param duration [Numeric] non-negative number specified in seconds
+  # @return [CallbackTimer]
+  def initialize(callback: , duration: )
+    raise ArgumentError, "'callback' must respond to 'to_proc'" unless callback.respond_to?(:to_proc)
+    @callback = callback.to_proc
+    unless duration.is_a?(Numeric) && duration >= 0
+      raise ArgumentError, "'duration' must be a non-negative Numeric"
+    end
+    @start_time = Time.now
+    @deadline = @start_time + duration
+    @mutex = Mutex.new
+    @complete = false
+    self.class.add(self)
+  end
+  
+  # Cancels the {CallbackTimer}.
+  # Will ignore if already called or if callback has already been called.
+  # @return [void]
+  def cancel
+    @mutex.synchronize do
+      return if @complete
+      @complete = true
+    end
+    self.class.cancel(self)
+    nil
+  end
+  
+  # Tells {CallbackTimer} it has reached it's deadline.
+  # @api private
+  # @return [void]
+  def time_has_elapsed
+    @mutex.synchronize do
+      return if @complete
+      @complete = true
+    end
+    elapsed_time = Time.now - @start_time
+    @callback.call(elapsed_time)
+    nil
+  end
+  
+end

data/spec/callback_timer_spec.rb

@@ -0,0 +1,99 @@
+require 'callback_timer'
+
+
+require 'pry'
+
+RSpec.describe CallbackTimer do
+  
+  describe "::new" do
+  
+    context "when creating a new CallbackTimer with no 'duration'" do
+      it "should raise ArgumentError" do
+        callback = proc {}
+        expect{ CallbackTimer.new(callback: callback) }.to raise_error(ArgumentError)
+      end
+    end
+    
+    context "when creating a new CallbackTimer with a negative 'duration'" do
+      it "should raise ArgumentError" do
+        callback = proc {}
+        duration = -1
+        expect{ CallbackTimer.new(callback: callback, duration: duration) }.to raise_error(ArgumentError)
+      end
+    end
+    
+    context "when creating a new CallbackTimer with no 'callback'" do
+      it "should raise ArgumentError" do
+        duration = 1
+        expect{ CallbackTimer.new(duration: duration) }.to raise_error(ArgumentError)
+      end
+    end
+    
+    context "when creating a new CallbackTimer with a 'duration' of 1" do
+      it "should call the callback in 1 second" do
+        $test = nil
+        target_time = Time.now + 1
+        callback = proc { $test = Time.now }
+        CallbackTimer.new(callback: callback, duration: 1)
+        sleep 2
+        expect($test).to be_between(target_time - 0.2, target_time + 0.2)
+      end
+    end
+    
+    context "when creating three new CallbackTimers with different 'duration's" do
+      it "should all call the callback at correct times" do
+        #binding.pry
+        $tt = 0
+        $test = []
+        start_time = Time.now
+        durations = [1, 0.5, 2]
+        target_times = durations.map { |duration| start_time + duration }
+        callbacks = 3.times.map { |index| proc { $test[index] = Time.now } }
+        3.times { |index| CallbackTimer.new(callback: callbacks[index], duration: durations[index]) }
+        sleep 2.2
+        3.times { |index| expect($test[index]).to be_between(target_times[index] - 0.2, target_times[index] + 0.2) }
+      end
+    end
+    
+    context "when creating a lot of new CallbackTimers with different 'duration's" do
+      it "should all call the callback at correct times" do
+        $test = []
+        start_time = Time.now
+        random = Random.new(1234)
+        durations = 100.times.map { random.rand(0.0..10.0) }
+        target_times = durations.map { |duration| start_time + duration }
+        callbacks = 100.times.map { |index| proc { $test[index] = Time.now } }
+        100.times { |index| CallbackTimer.new(callback: callbacks[index], duration: durations[index]) }
+        sleep 10.2
+        100.times { |index| expect($test[index]).to be_between(target_times[index] - 0.2, target_times[index] + 0.2) }
+      end
+    end
+    
+  end
+  
+  describe "#cancel" do
+  
+    context "when calling #cancel on a pending CallbackTimer" do
+      it "should not call callback" do
+        $called = false
+        callback = proc { $called = true }
+        timer = CallbackTimer.new(callback: callback, duration: 2)
+        sleep 1
+        timer.cancel
+        sleep 2
+        expect($called).to eql false
+      end
+    end
+    
+    context "when calling #cancel on completed CallbackTimer" do
+      it "should do nothing" do
+        callback = proc { }
+        timer = CallbackTimer.new(callback: callback, duration: 1)
+        sleep 2
+        expect{ timer.cancel }.not_to raise_error
+      end
+    end
+  
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,100 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: callback_timer
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Rob Fors
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-27 00:00:00.000000000 Z
+dependencies: []
+description: Create cancelable timer objects that will call a given callback when
+  time has elapsed. Implemented using a single scheduling thread.
+email: mail@robfors.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/callback_timer.rb
+- spec/callback_timer_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/robfors/callback_timer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Create timers that support a callback.
+test_files: []