ztimer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4276cd850421d06becfd20e5f2aac36adffa711d
+  data.tar.gz: 1e7de82540217efb028a25b7ac14b49ae185bf62
+SHA512:
+  metadata.gz: becb4c8ce8fdcbe33bda649b0d554a9d49866e35e0004fdfc631acb01f47753c4368381874126dc9b4459e01c0ea80e0f44b410be86ed873f2f61c3225b30233
+  data.tar.gz: d016de3e26f0a8da5bc5366287c36931b96ad0679d916e64c7e4c580206a5ad0e7e0c5c0f5e596344bdd228cd36dfd5d4ff672a6f01050474aff65c39820aacf

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at serioja90@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ztimer.gemspec
+gemspec

data/README.md

@@ -0,0 +1,47 @@
+# Ztimer
+
+**Ztimer** is a Ruby gem that allows to get asynchronous delayed notifications. You can enqueue callbacks to be
+called after some amount of time. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ztimer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ztimer
+
+## Usage
+
+All you have to do is to tell **Ztimer** the delay after which your code have to be executed. An example of how to use it
+is illustrated below:
+
+```ruby
+require 'ztimer'
+
+delay = 5000 # milliseconds
+Ztimer.after(delay) do
+  puts "Doing something useful..."
+end
+```
+
+By default **Ztimer** will run at maximum 20 notifications concurrently, so that if you have 100 notifications to be
+executed at the same time, at maximum 20 of them will run at the same time. This is necessary in order to prevent uncontrolled
+threads spawn when many notifications have to be sent at the same time.
+
+Anyway, you can change the concurrency by calling `Ztimer.concurrency = <concurrency>`, where `<concurrency>` is the maximum number
+of `Ztimer` workers allowed to run in parallel (ex: `Ztimer.concurrency = 50`).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/serioja90/ztimer. This project is intended to be a safe,
+welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ztimer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/ztimer/slot.rb

@@ -0,0 +1,18 @@
+
+module Ztimer
+  class Slot
+    attr_reader :expires_at, :callback
+    attr_accessor :started_at, :executed_at
+
+    def initialize(expires_at, &callback)
+      @expires_at  = expires_at
+      @callback    = callback
+      @started_at  = nil
+      @executed_at = nil
+    end
+
+    def <=>(other)
+      return @expires_at <=> other.expires_at
+    end
+  end
+end

data/lib/ztimer/version.rb

@@ -0,0 +1,3 @@
+module Ztimer
+  VERSION = "0.1.0"
+end

data/lib/ztimer.rb

@@ -0,0 +1,89 @@
+require 'set'
+require 'hitimes'
+require "ztimer/version"
+require "ztimer/slot"
+
+module Ztimer
+  @concurrency = 20
+  @slots       = SortedSet.new
+  @metric      = Hitimes::Metric.new("Notifier")
+  @monitor     = nil
+  @running     = 0
+  @lock        = Mutex.new
+  @mutex       = Mutex.new
+  @queue       = Queue.new
+
+  class << self
+    attr_reader :concurrency, :running
+
+    def after(milliseconds, &callback)
+      expires_at   = @metric.utc_microseconds + milliseconds * 1000
+      slot = Slot.new(expires_at, &callback)
+      add(slot)
+
+      return slot
+    end
+
+    def jobs_count
+      return @slots.count
+    end
+
+    def concurrency=(new_value)
+      raise ArgumentError.new("Invalid concurrency value: #{new_value}") unless new_value.is_a?(Fixnum) && new_value > 1
+      @concurrency = new_value
+    end
+
+    protected
+
+    def add(slot)
+      @mutex.synchronize do
+        @slots << slot
+        restart_monitor if @slots.first == slot || @monitor.nil? || !@monitor.alive?
+      end
+    end
+
+    def restart_monitor
+      @monitor.kill if @monitor
+
+      @monitor = Thread.new do
+        loop do
+          break if @slots.empty?
+
+          delay = @slots.first.expires_at - @metric.utc_microseconds
+          select(nil, nil, nil, delay / 1_000_000.to_f) if delay > 1 # 1 microsecond of cranularity
+
+          while @slots.first && (@slots.first.expires_at < @metric.utc_microseconds) do
+            @mutex.synchronize do
+              slot = @slots.first
+              slot.started_at = @metric.utc_microseconds
+              execute(slot)
+              @slots.delete slot
+            end
+          end
+        end
+      end
+      @monitor.abort_on_exception = true
+    end
+
+    def execute(slot)
+      @queue.push slot
+
+      @lock.synchronize do
+        [@concurrency - @running, @queue.size].min.times do
+          @running += 1
+          worker = Thread.new do
+            begin
+              while !@queue.empty? && (slot = @queue.pop(true))
+                slot.callback.call(slot) unless slot.callback.nil?
+              end
+            rescue => e
+              STDERR.puts e.inspect + (e.backtrace ? "\n" + e.backtrace.join("\n") : "")
+            end
+            @lock.synchronize { @running -= 1 }
+          end
+          worker.abort_on_exception = true
+        end
+      end
+    end
+  end
+end

data/ztimer.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ztimer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ztimer"
+  spec.version       = Ztimer::VERSION
+  spec.authors       = ["Groza Sergiu"]
+  spec.email         = ["serioja90@gmail.com"]
+
+  spec.summary       = %q{An asyncrhonous timer}
+  spec.description   = %q{Ruby asyncrhonous timer that allows you to enqueue tasks to be executed asyncrhonously after a delay}
+  spec.homepage      = "https://github.com/serioja90/ztimer"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake",    "~> 10.0"
+  spec.add_development_dependency "rspec",   "~> 3.0"
+  spec.add_dependency             "hitimes", "~> 1.2"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: ztimer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Groza Sergiu
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: hitimes
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: Ruby asyncrhonous timer that allows you to enqueue tasks to be executed
+  asyncrhonously after a delay
+email:
+- serioja90@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ztimer.rb
+- lib/ztimer/slot.rb
+- lib/ztimer/version.rb
+- ztimer.gemspec
+homepage: https://github.com/serioja90/ztimer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.4.6
+signing_key: 
+specification_version: 4
+summary: An asyncrhonous timer
+test_files: []
+has_rdoc: