timers 4.1.2 → 4.2.0

data/spec/timers/performance_spec.rb

@@ -1,4 +1,12 @@
 # frozen_string_literal: true
+#
+# This file is part of the "timers" project and released under the MIT license.
+#
+# Copyright, 2018, by Samuel Williams. All rights reserved.
+#
+
+require "spec_helper"
+require "ruby-prof" unless RUBY_PLATFORM =~ /java|rbx/
 
 # Event based timers:
 
@@ -39,58 +47,79 @@
 # Serviced 1142649 events in 11.194903921 seconds, 102068.70405115146 e/s.
 
 RSpec.describe Timers::Group do
-  it "runs efficiently" do
-    result = []
-    range = (1..500)
-    duration = 2.0
-
-    total = 0
-    range.each do |index|
-      offset = index.to_f / range.max
-      total += (duration / offset).floor
-
-      subject.every(index.to_f / range.max, :strict) { result << index }
-    end
-
-    subject.wait while result.size < total
-
-    rate = result.size.to_f / subject.current_offset
-    puts "Serviced #{result.size} events in #{subject.current_offset} seconds, #{rate} e/s."
-
-    expect(subject.current_offset).to be_within(TIMER_QUANTUM).of(duration)
-  end
-
-  #   it "runs efficiently at high volume" do
-  #     results = []
-  #     range = (1..300)
-  #     groups = (1..20)
-  #     duration = 101
-  #
-  #     timers = []
-  #     @mutex = Mutex.new
-  #     start = Time.now
-  #     groups.each do |gi|
-  #       timers << Thread.new {
-  #         result = []
-  #         timer = Timers::Group.new
-  #         total = 0
-  #         range.each do |ri|
-  #           offset = ri.to_f / range.max
-  #           total += (duration / offset).floor
-  #           timer.every(ri.to_f / range.max, :strict) { result << ri }
-  #         end
-  #         timer.wait while result.size < total
-  #         @mutex.synchronize { results += result }
-  #
-  #       }
-  #     end
-  #     timers.each { |t| t.join }
-  #     finish = Time.now
-  #
-  #     rate = results.size.to_f / ( runtime = finish - start )
-  #
-  #     puts "Serviced #{results.size} events in #{runtime} seconds, #{rate} e/s; across #{groups.max} timers."
-  #
-  #     expect(runtime).to be_within(TIMER_QUANTUM).of(duration)
-  #   end
+	context "with profiler" do
+		if defined? RubyProf
+			before(:each) do
+				# Running RubyProf makes the code slightly slower.
+				RubyProf.start
+				puts "*** Running with RubyProf reduces performance ***"
+			end
+
+			after(:each) do
+				if RubyProf.running?
+					# file = arg.metadata[:description].gsub(/\s+/, '-')
+
+					result = RubyProf.stop
+
+					printer = RubyProf::FlatPrinter.new(result)
+					printer.print($stderr, min_percent: 1.0)
+				end
+			end
+		end
+
+		it "runs efficiently" do
+			result = []
+			range = (1..500)
+			duration = 2.0
+
+			total = 0
+			range.each do |index|
+				offset = index.to_f / range.max
+				total += (duration / offset).floor
+
+				subject.every(index.to_f / range.max, :strict) { result << index }
+			end
+
+			subject.wait while result.size < total
+
+			rate = result.size.to_f / subject.current_offset
+			puts "Serviced #{result.size} events in #{subject.current_offset} seconds, #{rate} e/s."
+
+			expect(subject.current_offset).to be_within(20).percent_of(duration)
+		end
+	end
+	
+	it "runs efficiently at high volume" do
+		results = []
+		range = (1..300)
+		groups = (1..20)
+		duration = 11
+
+		timers = []
+		@mutex = Mutex.new
+		start = Time.now
+		groups.each do |gi|
+			timers << Thread.new {
+				result = []
+				timer = Timers::Group.new
+				total = 0
+				range.each do |ri|
+					offset = ri.to_f / range.max
+					total += (duration / offset).floor
+					timer.every(ri.to_f / range.max, :strict) { result << ri }
+				end
+				timer.wait while result.size < total
+				@mutex.synchronize { results += result }
+
+			}
+		end
+		timers.each { |t| t.join }
+		finish = Time.now
+
+		rate = results.size.to_f / ( runtime = finish - start )
+
+		puts "Serviced #{results.size} events in #{runtime} seconds, #{rate} e/s; across #{groups.max} timers."
+
+		expect(runtime).to be_within(20).percent_of(duration)
+	end
 end

data/spec/timers/strict_spec.rb

@@ -1,36 +1,41 @@
 # frozen_string_literal: true
+#
+# This file is part of the "timers" project and released under the MIT license.
+#
+# Copyright, 2018, by Samuel Williams. All rights reserved.
+#
 
 RSpec.describe Timers::Group do
-  it "should not diverge too much" do
-    fired = :not_fired_yet
-    count = 0
-    quantum = 0.01
-
-    start_offset = subject.current_offset
-    Timers::Timer.new(subject, quantum, :strict, start_offset) do |offset|
-      fired = offset
-      count += 1
-    end
-
-    iterations = 1000
-    subject.wait while count < iterations
-
-    # In my testing on the JVM, without the :strict recurring, I noticed 60ms of error here.
-    expect(fired - start_offset).to be_within(quantum).of(iterations * quantum)
-  end
-
-  it "should only fire once" do
-    fired = :not_fired_yet
-    count = 0
-
-    start_offset = subject.current_offset
-    Timers::Timer.new(subject, 0, :strict, start_offset) do |offset|
-      fired = offset
-      count += 1
-    end
-
-    subject.wait
-
-    expect(count).to be == 1
-  end
+	it "should not diverge too much" do
+		fired = :not_fired_yet
+		count = 0
+		quantum = 0.01
+
+		start_offset = subject.current_offset
+		Timers::Timer.new(subject, quantum, :strict, start_offset) do |offset|
+			fired = offset
+			count += 1
+		end
+
+		iterations = 1000
+		subject.wait while count < iterations
+
+		# In my testing on the JVM, without the :strict recurring, I noticed 60ms of error here.
+		expect(fired - start_offset).to be_within(quantum).of(iterations * quantum)
+	end
+
+	it "should only fire once" do
+		fired = :not_fired_yet
+		count = 0
+
+		start_offset = subject.current_offset
+		Timers::Timer.new(subject, 0, :strict, start_offset) do |offset|
+			fired = offset
+			count += 1
+		end
+
+		subject.wait
+
+		expect(count).to be == 1
+	end
 end

data/spec/timers/wait_spec.rb

@@ -1,30 +1,35 @@
 # frozen_string_literal: true
+#
+# This file is part of the "timers" project and released under the MIT license.
+#
+# Copyright, 2018, by Samuel Williams. All rights reserved.
+#
 
 require "spec_helper"
 require "timers/wait"
 
 RSpec.describe Timers::Wait do
-  it "repeats until timeout expired" do
-    timeout = Timers::Wait.new(5)
-    count = 0
+	it "repeats until timeout expired" do
+		timeout = Timers::Wait.new(5)
+		count = 0
 
-    timeout.while_time_remaining do |remaining|
-      expect(remaining).to be_within(TIMER_QUANTUM).of(timeout.duration - count)
+		timeout.while_time_remaining do |remaining|
+			expect(remaining).to be_within(TIMER_QUANTUM).of(timeout.duration - count)
 
-      count += 1
-      sleep 1
-    end
+			count += 1
+			sleep 1
+		end
 
-    expect(count).to eq(5)
-  end
+		expect(count).to eq(5)
+	end
 
-  it "yields results as soon as possible" do
-    timeout = Timers::Wait.new(5)
+	it "yields results as soon as possible" do
+		timeout = Timers::Wait.new(5)
 
-    result = timeout.while_time_remaining do |_remaining|
-      break :done
-    end
+		result = timeout.while_time_remaining do |_remaining|
+			break :done
+		end
 
-    expect(result).to eq(:done)
-  end
+		expect(result).to eq(:done)
+	end
 end

data/timers.gemspec

@@ -1,26 +1,33 @@
-# -*- encoding: utf-8 -*-
 # frozen_string_literal: true
+#
+# This file is part of the "timers" project and released under the MIT license.
+#
+# Copyright, 2018, by Samuel Williams. All rights reserved.
+#
 
-require File.expand_path("../lib/timers/version", __FILE__)
+require_relative 'lib/timers/version'
 
-Gem::Specification.new do |gem|
-  gem.name          = "timers"
-  gem.version       = Timers::VERSION
-  gem.authors       = ["Tony Arcieri"]
-  gem.email         = ["bascule@gmail.com"]
-  gem.licenses      = ["MIT"]
-  gem.homepage      = "https://github.com/celluloid/timers"
-  gem.summary       = "Pure Ruby one-shot and periodic timers"
-  gem.description = <<-DESCRIPTION.strip.gsub(/\s+/, " ")
-    Schedule procs to run after a certain time, or at periodic intervals,
-    using any API that accepts a timeout.
-  DESCRIPTION
+Gem::Specification.new do |spec|
+	spec.name          = "timers"
+	spec.version       = Timers::VERSION
+	spec.authors       = ["Samuel Williams", "Tony Arcieri"]
+	spec.email         = ["samuel@codeotaku.com", "bascule@gmail.com"]
+	spec.licenses      = ["MIT"]
+	spec.homepage      = "https://github.com/socketry/timers"
+	spec.summary       = "Pure Ruby one-shot and periodic timers"
+	spec.description = <<-DESCRIPTION.strip.gsub(/\s+/, " ")
+		Schedule procs to run after a certain time, or at periodic intervals,
+		using any API that accepts a timeout.
+	DESCRIPTION
 
-  gem.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
-  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
-  gem.add_runtime_dependency "hitimes"
+	spec.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
+	spec.executables   = spec.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+	spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+	spec.require_paths = ["lib"]
 
-  gem.add_development_dependency "bundler"
+	spec.required_ruby_version = '>= 2.2.1'
+
+	spec.add_development_dependency "bundler", "~> 1.3"
+	spec.add_development_dependency "rspec", "~> 3.6"
+	spec.add_development_dependency "rake"
 end

metadata

@@ -1,31 +1,46 @@
 --- !ruby/object:Gem::Specification
 name: timers
 version: !ruby/object:Gem::Version
-  version: 4.1.2
+  version: 4.2.0
 platform: ruby
 authors:
+- Samuel Williams
 - Tony Arcieri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-26 00:00:00.000000000 Z
+date: 2018-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: hitimes
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+        version: '1.3'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -41,26 +56,22 @@ dependencies:
 description: Schedule procs to run after a certain time, or at periodic intervals,
   using any API that accepts a timeout.
 email:
+- samuel@codeotaku.com
 - bascule@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".coveralls.yml"
 - ".gitignore"
 - ".rspec"
-- ".rubocop.yml"
-- ".ruby-version"
 - ".travis.yml"
-- AUTHORS.md
-- CHANGES.md
 - Gemfile
-- LICENSE
 - README.md
 - Rakefile
 - lib/timers.rb
 - lib/timers/events.rb
 - lib/timers/group.rb
+- lib/timers/interval.rb
 - lib/timers/timer.rb
 - lib/timers/version.rb
 - lib/timers/wait.rb
@@ -73,7 +84,7 @@ files:
 - spec/timers/strict_spec.rb
 - spec/timers/wait_spec.rb
 - timers.gemspec
-homepage: https://github.com/celluloid/timers
+homepage: https://github.com/socketry/timers
 licenses:
 - MIT
 metadata: {}
@@ -85,7 +96,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.2.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -93,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Pure Ruby one-shot and periodic timers

data/.coveralls.yml

@@ -1 +0,0 @@
-service-name: travis-pro

data/.rubocop.yml

@@ -1,28 +0,0 @@
-AllCops:
-  DisplayCopNames: true
-
-#
-# Style
-#
-
-LineLength:
-  Max: 128
-
-Style/NumericPredicate:
-  Enabled: false
-
-Style/SafeNavigation:
-  Enabled: false
-
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
-
-#
-# Metrics
-#
-
-Metrics/ClassLength:
-  Max: 100
-
-Metrics/MethodLength:
-  Max: 25