ztimer 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e9203fd984c0ca9b608ec0a473f7653eee3a943
-  data.tar.gz: 8c998b3131d0a6c969bdac9b994fcaf9beeefc32
+  metadata.gz: ba1fe46353cca7319d61150f6fe52622d3668db2
+  data.tar.gz: ac6dc6b45e0001d39e63a6ead7950b5db75ac7d0
 SHA512:
-  metadata.gz: 10b8f4fb11edd3746d143456d89fa85e57cf0d46c0166ed15e6a678d240fcdc1fbafbe19a5e2c130972b66988a54ad13f1b58b00fef74ad9ee01a5a7b132ef65
-  data.tar.gz: 02e53d5d6f47657543503afac5a5ea29de347c78a039673900a9da2e10fac7952b1d1f02c956f1e70e66a104769204207711474d556c15f3ed1470ce595af8bd
+  metadata.gz: 1eac7a0992c9d806a76c35cc31805bb716e7ca8b39e4b15b0609ac8c9415464c816b6b57a74821745b213ad57a9e21843f641b16663c19cf3e46d267b6216ce9
+  data.tar.gz: f81c9081bad5354bb6e0f056596b9c8db7ce5878d6ff6d1da5e82536c218e143c59ef60389bda4b27bed205d09881c35e6c7dccf28f8f15d7395cf487142fe00

data/.travis.yml

@@ -1,4 +1,9 @@
 language: ruby
 rvm:
-  - 2.2.1
+  - 2.2
+
 before_install: gem install bundler -v 1.11.2
+script:
+  - gem build ztimer.gemspec
+  - gem install ztimer --local
+  - bundle exec rspec

data/Gemfile

@@ -2,3 +2,7 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in ztimer.gemspec
 gemspec
+
+group :test do
+  gem 'lounger', '~> 0.2.0'
+end

data/README.md

@@ -1,7 +1,9 @@
 # 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. 
+**Ztimer** is a simple Ruby implementation of an asynchronous timer, that allows to enqueue the execution of Ruby
+code, so that it will be asynchronously executed on timeout. It's very useful when you need a simple way to execute
+some code asynchronously or with a certain delay.
+
 
 ## Installation
 
@@ -46,14 +48,27 @@ end
 sleep 10    # wait for 10 seconds (10 executions)
 job.cancel! # cancel the recurrent job
 
+# Custom Ztimer instance
+my_timer = Ztimer.new(concurrency: 5) # create a new Ztimer instance
+10.times do
+  # Use the custom ztimer to execute jobs asynchronously
+  my_timer.async do
+    puts "Doing async job..."
+  end
+end
 ```
 
 By default **Ztimer** will run at maximum 20 jobs concurrently, so that if you have 100 jobs 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 jobs have to be sent at the same time.
+executed at the same time, at most 20 of them will run concurrently. This is necessary in order to prevent uncontrolled threads spawn when many jobs have to be run 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`).
+Anyway, you can change the concurrency level by calling `Ztimer.concurrency = <concurrency>`, where `<concurrency>` is the maximum number of `Ztimer` workers allowed to run in parallel (ex: `Ztimer.concurrency = 50`).
+
+If you're using custom **Ztimer** instance, you can specify the concurrency while creating the new instance:
+
+```ruby
+my_timer = Ztimer.new(concurrency: 42) # create a ztimer with concurrency set to 42
+```
 
 ## 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/lib/ztimer.rb

@@ -3,116 +3,124 @@ require "ztimer/slot"
 require "ztimer/sorted_store"
 require "ztimer/watcher"
 
-module Ztimer
-  @concurrency  = 20
-  @watcher      = Ztimer::Watcher.new(){|slot| execute(slot) }
-  @workers_lock = Mutex.new
-  @count_lock   = Mutex.new
-  @queue        = Queue.new
-  @running      = 0
-  @count        = 0
-
-  class << self
-    attr_reader :concurrency, :running, :count, :watcher, :queue
-
-    def async(&callback)
-      enqueued_at = utc_microseconds
-      slot        = Slot.new(enqueued_at, enqueued_at, -1, &callback)
-
-      incr_counter!
-      execute(slot)
-
-      return slot
-    end
+class Ztimer
+  @default_instance = nil
+
+  attr_reader :concurrency, :running, :count, :watcher, :queue
+
+  def initialize(concurrency: 20)
+    @concurrency  = concurrency
+    @watcher      = Ztimer::Watcher.new(){|slot| execute(slot) }
+    @workers_lock = Mutex.new
+    @count_lock   = Mutex.new
+    @queue        = Queue.new
+    @running      = 0
+    @count        = 0
+  end
 
-    def after(milliseconds, &callback)
-      enqueued_at = utc_microseconds
-      expires_at  = enqueued_at + milliseconds * 1000
-      slot        = Slot.new(enqueued_at, expires_at, -1, &callback)
+  def async(&callback)
+    enqueued_at = utc_microseconds
+    slot        = Slot.new(enqueued_at, enqueued_at, -1, &callback)
 
-      add(slot)
+    incr_counter!
+    execute(slot)
 
-      return slot
-    end
+    return slot
+  end
 
-    def every(milliseconds, &callback)
-      enqueued_at = utc_microseconds
-      expires_at  = enqueued_at + milliseconds * 1000
-      slot        = Slot.new(enqueued_at, expires_at, milliseconds * 1000, &callback)
+  def after(milliseconds, &callback)
+    enqueued_at = utc_microseconds
+    expires_at  = enqueued_at + milliseconds * 1000
+    slot        = Slot.new(enqueued_at, expires_at, -1, &callback)
 
-      add(slot)
+    add(slot)
 
-      return slot
-    end
+    return slot
+  end
 
-    def jobs_count
-      return @watcher.jobs
-    end
+  def every(milliseconds, &callback)
+    enqueued_at = utc_microseconds
+    expires_at  = enqueued_at + milliseconds * 1000
+    slot        = Slot.new(enqueued_at, expires_at, milliseconds * 1000, &callback)
 
-    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
+    add(slot)
 
+    return slot
+  end
 
-    def stats
-      {
-        running:   @running,
-        scheduled: @watcher.jobs,
-        executing: @queue.size,
-        total:     @count
-      }
-    end
+  def jobs_count
+    return @watcher.jobs
+  end
 
-    protected
+  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
 
-    def add(slot)
-      incr_counter!
-      @watcher << slot
-    end
 
-    def incr_counter!
-      @count_lock.synchronize{ @count += 1 }
-    end
+  def stats
+    {
+      running:   @running,
+      scheduled: @watcher.jobs,
+      executing: @queue.size,
+      total:     @count
+    }
+  end
 
-    def execute(slot)
-      @queue << slot
 
-      @workers_lock.synchronize do
-        [@concurrency - @running, @queue.size].min.times do
-          @running += 1
-          start_new_thread!
-        end
+  def self.method_missing(name, *args, &block)
+    @default_instance ||= Ztimer.new(concurrency: 20)
+    @default_instance.send(name, *args, &block)
+  end
+
+  protected
+
+  def add(slot)
+    incr_counter!
+    @watcher << slot
+  end
+
+  def incr_counter!
+    @count_lock.synchronize{ @count += 1 }
+  end
+
+  def execute(slot)
+    @queue << slot
+
+    @workers_lock.synchronize do
+      [@concurrency - @running, @queue.size].min.times do
+        @running += 1
+        start_new_thread!
       end
     end
+  end
 
-    def start_new_thread!
-      worker = Thread.new do
-        begin
-          loop do
-            current_slot = nil
-            @workers_lock.synchronize do
-              current_slot = @queue.pop(true) unless @queue.empty?
-            end
-            break if current_slot.nil?
-
-            begin
-              current_slot.executed_at = utc_microseconds
-              current_slot.callback.call(current_slot) unless current_slot.callback.nil? || current_slot.canceled?
-            rescue => e
-              STDERR.puts e.inspect + (e.backtrace ? "\n" + e.backtrace.join("\n") : "")
-            end
+  def start_new_thread!
+    worker = Thread.new do
+      begin
+        loop do
+          current_slot = nil
+          @workers_lock.synchronize do
+            current_slot = @queue.pop(true) unless @queue.empty?
+          end
+          break if current_slot.nil?
+
+          begin
+            current_slot.executed_at = utc_microseconds
+            current_slot.callback.call(current_slot) unless current_slot.callback.nil? || current_slot.canceled?
+          rescue => e
+            STDERR.puts e.inspect + (e.backtrace ? "\n" + e.backtrace.join("\n") : "")
           end
-        rescue ThreadError
-          puts "queue is empty"
         end
-        @workers_lock.synchronize { @running -= 1 }
+      rescue ThreadError
+        puts "queue is empty"
       end
-      worker.abort_on_exception = true
+      @workers_lock.synchronize { @running -= 1 }
     end
+    worker.abort_on_exception = true
+  end
 
-    def utc_microseconds
-      return Time.now.to_f * 1_000_000
-    end
+  def utc_microseconds
+    return Time.now.to_f * 1_000_000
   end
-end
+end

data/lib/ztimer/slot.rb

@@ -1,5 +1,5 @@
 
-module Ztimer
+class Ztimer
   class Slot
     attr_reader :enqueued_at, :expires_at, :recurrency, :callback
     attr_accessor :started_at, :executed_at
@@ -36,4 +36,4 @@ module Ztimer
       return @expires_at <=> other.expires_at
     end
   end
-end
+end

data/lib/ztimer/sorted_store.rb

@@ -1,5 +1,5 @@
 
-module Ztimer
+class Ztimer
   class SortedStore
 
     def initialize
@@ -94,4 +94,4 @@ module Ztimer
       end
     end
   end
-end
+end

data/lib/ztimer/version.rb

@@ -1,3 +1,3 @@
-module Ztimer
-  VERSION = "0.5.0"
+class Ztimer
+  VERSION = "0.6.0"
 end

data/lib/ztimer/watcher.rb

@@ -1,5 +1,5 @@
 
-module Ztimer
+class Ztimer
   class Watcher
 
     def initialize(&callback)
@@ -92,4 +92,4 @@ module Ztimer
       return Time.now.to_f * 1_000_000
     end
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ztimer
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Groza Sergiu
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-14 00:00:00.000000000 Z
+date: 2017-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,4 +100,3 @@ signing_key:
 specification_version: 4
 summary: An asyncrhonous timer
 test_files: []
-has_rdoc: