always 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed19cd7a3109c141b0537f2229876cc00f5d0a70740095b810b281c47fe44834
-  data.tar.gz: 793763757135f8492edb8bb6b6abb6b9ee19459c7e35d3acde3ac13f0c97a230
+  metadata.gz: 3e58e6ba3b68a86d0f9fc12a7bc34580085f00b4511e5ea34167465338a51789
+  data.tar.gz: cac5d0bc4f8d7d16aff1ae095e4b204c431737603fa2a3be4245c10a44d0bb84
 SHA512:
-  metadata.gz: 3c09324fe351d257d252e466e9be7d263ffb0e9781d1134b777ae207ee0321779273b82771d595fad47f4ca67ed2bebbc4a8864758c0f522f0233f66b5745b79
-  data.tar.gz: 44c0a7f8d9117e69845c58577b6f40ccd29f7292e07c9df0cc18a05870a3fb4b5795c85cc0bfcd5434c543ed5575a081b35de6cc7a402ef59d70459ac87659de
+  metadata.gz: ec65e4cc308a110d2867ca647e197061b1811b15a09da8dd9e5e71259135808409c0e26d47c738d9e0c3187cf93050caec5779622cf9c5a8f14e895befaf18c9
+  data.tar.gz: 6fa3988429a11ef790c92715a23a9f31a4445ffd27fcbc5eaa8ecfd91d5d42f7c7da18d6ee18802d4f0000bd9c6b9ad86ee84a1a1e9e9c333e94a75633e48bd8

data/.rubocop.yml

@@ -27,3 +27,8 @@ AllCops:
   TargetRubyVersion: 3.2
   SuggestExtensions: false
   NewCops: enable
+
+Layout/EndOfLine:
+  EnforcedStyle: lf
+Style/EvalWithLocation:
+  Enabled: false

data/Gemfile

@@ -23,11 +23,11 @@
 source 'https://rubygems.org'
 gemspec
 
-gem 'minitest', '5.23.1', require: false
+gem 'minitest', '5.24.1', require: false
 gem 'rake', '13.2.1', require: false
-gem 'rspec-rails', '6.1.2', require: false
+gem 'rspec-rails', '6.1.3', require: false
 gem 'rubocop', '1.64.1', require: false
-gem 'rubocop-rspec', '2.29.2', require: false
+gem 'rubocop-rspec', '3.0.2', require: false
 gem 'simplecov', '0.22.0', require: false
 gem 'simplecov-cobertura', '2.1.0', require: false
 gem 'yard', '0.9.36', require: false

data/Gemfile.lock

@@ -7,9 +7,9 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (7.1.3.3)
-      actionview (= 7.1.3.3)
-      activesupport (= 7.1.3.3)
+    actionpack (7.1.3.4)
+      actionview (= 7.1.3.4)
+      activesupport (= 7.1.3.4)
       nokogiri (>= 1.8.5)
       racc
       rack (>= 2.2.4)
@@ -17,13 +17,13 @@ GEM
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.2)
       rails-html-sanitizer (~> 1.6)
-    actionview (7.1.3.3)
-      activesupport (= 7.1.3.3)
+    actionview (7.1.3.4)
+      activesupport (= 7.1.3.4)
       builder (~> 3.1)
       erubi (~> 1.11)
       rails-dom-testing (~> 2.2)
       rails-html-sanitizer (~> 1.6)
-    activesupport (7.1.3.3)
+    activesupport (7.1.3.4)
       base64
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
@@ -36,18 +36,18 @@ GEM
     ast (2.4.2)
     base64 (0.2.0)
     bigdecimal (3.1.8)
-    builder (3.2.4)
-    concurrent-ruby (1.3.1)
+    builder (3.3.0)
+    concurrent-ruby (1.3.3)
     connection_pool (2.4.1)
     crass (1.0.6)
     diff-lcs (1.5.1)
     docile (1.4.0)
     drb (2.2.1)
-    erubi (1.12.0)
+    erubi (1.13.0)
     i18n (1.14.5)
       concurrent-ruby (~> 1.0)
     io-console (0.7.2)
-    irb (1.13.1)
+    irb (1.13.2)
       rdoc (>= 4.0.0)
       reline (>= 0.4.2)
     json (2.7.2)
@@ -55,30 +55,30 @@ GEM
     loofah (2.22.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
-    minitest (5.23.1)
+    minitest (5.24.1)
     mutex_m (0.2.0)
-    nokogiri (1.16.5-aarch64-linux)
+    nokogiri (1.16.6-aarch64-linux)
       racc (~> 1.4)
-    nokogiri (1.16.5-arm-linux)
+    nokogiri (1.16.6-arm-linux)
       racc (~> 1.4)
-    nokogiri (1.16.5-arm64-darwin)
+    nokogiri (1.16.6-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.16.5-x64-mingw-ucrt)
+    nokogiri (1.16.6-x64-mingw-ucrt)
       racc (~> 1.4)
-    nokogiri (1.16.5-x86-linux)
+    nokogiri (1.16.6-x86-linux)
       racc (~> 1.4)
-    nokogiri (1.16.5-x86_64-darwin)
+    nokogiri (1.16.6-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.16.5-x86_64-linux)
+    nokogiri (1.16.6-x86_64-linux)
       racc (~> 1.4)
-    parallel (1.24.0)
-    parser (3.3.2.0)
+    parallel (1.25.1)
+    parser (3.3.3.0)
       ast (~> 2.4.1)
       racc
     psych (5.1.2)
       stringio
     racc (1.8.0)
-    rack (3.0.11)
+    rack (3.1.6)
     rack-session (2.0.0)
       rack (>= 3.0.0)
     rack-test (2.1.0)
@@ -93,9 +93,9 @@ GEM
     rails-html-sanitizer (1.6.0)
       loofah (~> 2.21)
       nokogiri (~> 1.14)
-    railties (7.1.3.3)
-      actionpack (= 7.1.3.3)
-      activesupport (= 7.1.3.3)
+    railties (7.1.3.4)
+      actionpack (= 7.1.3.4)
+      activesupport (= 7.1.3.4)
       irb
       rackup (>= 1.0.0)
       rake (>= 12.2)
@@ -106,19 +106,19 @@ GEM
     rdoc (6.7.0)
       psych (>= 4.0.0)
     regexp_parser (2.9.2)
-    reline (0.5.8)
+    reline (0.5.9)
       io-console (~> 0.5)
-    rexml (3.2.8)
-      strscan (>= 3.0.9)
+    rexml (3.3.1)
+      strscan
     rspec-core (3.13.0)
       rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.0)
+    rspec-expectations (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-mocks (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-rails (6.1.2)
+    rspec-rails (6.1.3)
       actionpack (>= 6.1)
       activesupport (>= 6.1)
       railties (>= 6.1)
@@ -140,17 +140,8 @@ GEM
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.31.3)
       parser (>= 3.3.1.0)
-    rubocop-capybara (2.20.0)
-      rubocop (~> 1.41)
-    rubocop-factory_bot (2.25.1)
-      rubocop (~> 1.41)
-    rubocop-rspec (2.29.2)
-      rubocop (~> 1.40)
-      rubocop-capybara (~> 2.17)
-      rubocop-factory_bot (~> 2.22)
-      rubocop-rspec_rails (~> 2.28)
-    rubocop-rspec_rails (2.28.3)
-      rubocop (~> 1.40)
+    rubocop-rspec (3.0.2)
+      rubocop (~> 1.61)
     ruby-progressbar (1.13.0)
     simplecov (0.22.0)
       docile (~> 1.1)
@@ -161,7 +152,7 @@ GEM
       simplecov (~> 0.19)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    stringio (3.1.0)
+    stringio (3.1.1)
     strscan (3.1.0)
     thor (1.3.1)
     tzinfo (2.0.6)
@@ -169,7 +160,7 @@ GEM
     unicode-display_width (2.5.0)
     webrick (1.8.1)
     yard (0.9.36)
-    zeitwerk (2.6.15)
+    zeitwerk (2.6.16)
 
 PLATFORMS
   aarch64-linux
@@ -182,11 +173,11 @@ PLATFORMS
 
 DEPENDENCIES
   always!
-  minitest (= 5.23.1)
+  minitest (= 5.24.1)
   rake (= 13.2.1)
-  rspec-rails (= 6.1.2)
+  rspec-rails (= 6.1.3)
   rubocop (= 1.64.1)
-  rubocop-rspec (= 2.29.2)
+  rubocop-rspec (= 3.0.2)
   simplecov (= 0.22.0)
   simplecov-cobertura (= 2.1.0)
   yard (= 0.9.36)

data/README.md

@@ -15,9 +15,9 @@ This simple Ruby gem helps you run a loop forever, in a background thread.
 
 ```ruby
 require 'always'
-# Prepare, with five threads and 30-seconds delay between loop cycles:
-a = Always.new(5, 30)
-# Start them all together spinning forever:
+# Prepare, with five threads:
+a = Always.new(5)
+# Start them all together spinning forever with 30-seconds delay between cycles:
 a.start do
   puts "I'm alive"
 end
@@ -25,6 +25,18 @@ end
 a.stop
 ```
 
+You may be interested to get the backtraces of the exceptions that
+happened most recently:
+
+```ruby
+# Keep the last 10 error backtraces in memory:
+a = Always.new(5, max_backtraces: 10)
+# Retrieve them:
+p a.backtraces
+```
+
+That's it.
+
 ## How to contribute
 
 Read

data/always.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to? :required_rubygems_version=
   s.required_ruby_version = '>=3.2'
   s.name = 'always'
-  s.version = '0.0.3'
+  s.version = '0.0.5'
   s.license = 'MIT'
   s.summary = 'A simple Ruby framework that spins a loop forever, in a background thread'
   s.description =

data/lib/always.rb

@@ -33,29 +33,37 @@ require 'concurrent/atom'
 #    puts 'Hello, world!
 #  end
 #
-# Then, in order stop them all together:
+# Then, in order to stop them all together:
 #
 #  a.stop
 #
 # It's possible to get a quick summary of the thread pool, by calling +to_s+.
+# The result will be a +"T/C/E"+ string, where +T+ is the total number of
+# currently running threads, +C+ is the total number of all cycles
+# so far, and +E+ is the total number of all errors seen so far.
 #
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
 # Copyright:: Copyright (c) 2024 Yegor Bugayenko
 # License:: MIT
 class Always
+  attr_reader :backtraces
+
   # The version of the framework.
-  VERSION = '0.0.3'
+  VERSION = '0.0.5'
 
   # Constructor.
   # @param [Integer] total The number of threads to run
-  def initialize(total)
+  # @param [Integer] max_backtraces How many backtraces to keep in memory?
+  def initialize(total, max_backtraces: 32)
     raise "The number of threads (#{total}) must be positive" unless total.positive?
 
     @total = total
     @on_error = nil
     @threads = []
+    @backtraces = []
     @cycles = Concurrent::Atom.new(0)
     @errors = Concurrent::Atom.new(0)
+    @max_backtraces = max_backtraces
   end
 
   # What to do when an exception occurs?
@@ -76,23 +84,29 @@ class Always
     self
   end
 
-  # Start them all.
+  # Start them all and let them run forever (until the +stop+ method is called).
   # @param [Integer] pause The delay between cycles, in seconds
   def start(pause = 0, &)
     raise 'It is running now, call .stop() first' unless @threads.empty?
 
     (0..@total - 1).each do |i|
       @threads[i] = Thread.new do
-        body(i, pause, &)
-        @cycles.swap { |c| c + 1 }
+        body(pause, &)
       end
     end
   end
 
   # Stop them all.
   def stop
-    @threads.each(&:terminate)
-    @threads = []
+    raise 'It is not running now, call .start() first' if @threads.empty?
+
+    @threads.delete_if do |t|
+      t.kill
+      sleep(0.001) while t.alive?
+      true
+    end
+    @cycles.swap { |_| 0 }
+    @errors.swap { |_| 0 }
   end
 
   # Represent its internal state as a string.
@@ -106,15 +120,11 @@ class Always
   private
 
   # rubocop:disable Lint/RescueException
-  def body(idx, pause)
+  def body(pause, &)
     loop do
-      begin
-        yield
-      rescue Exception => e
-        @errors.swap { |c| c + 1 }
-        @on_error&.call(e, idx)
-      end
-      sleep(pause)
+      one(&)
+      @cycles.swap { |c| c + 1 }
+      sleep(pause) unless pause.zero?
     rescue Exception
       # If we reach this point, we must not even try to
       # do anything. Here we must quietly ignore everything
@@ -122,4 +132,15 @@ class Always
     end
   end
   # rubocop:enable Lint/RescueException
+
+  # rubocop:disable Lint/RescueException
+  def one
+    yield
+  rescue Exception => e
+    @errors.swap { |c| c + 1 }
+    @backtraces << e
+    @backtraces.shift if @backtraces.size > @max_backtraces
+    @on_error&.call(e)
+  end
+  # rubocop:enable Lint/RescueException
 end

data/test/test_always.rb

@@ -39,7 +39,7 @@ class TestAlways < Minitest::Test
   def test_with_error
     a = Always.new(5)
     failures = 0
-    a.on_error { |_e, i| failures += i }.start do
+    a.on_error { |_e| failures += 1 }.start do
       raise 'intentionally'
     end
     sleep(0.1)
@@ -47,13 +47,37 @@ class TestAlways < Minitest::Test
     assert(failures.positive?)
   end
 
-  def test_converts_to_string
-    a = Always.new(5)
-    a.start do
-      # nothing
+  def test_read_backtraces
+    max = 5
+    a = Always.new(5, max_backtraces: max)
+    failures = 0
+    a.on_error { |_e| failures += 1 }.start do
+      raise 'intentionally'
     end
-    assert(a.to_s.start_with?('5/'))
+    sleep(0.1)
+    a.stop
+    assert(failures.positive?)
+    assert_equal(max, a.backtraces.size)
+  end
+
+  def test_converts_to_string
+    n = 6
+    a = Always.new(6)
+    a.start { sleep(0.01) }
+    sleep(0.1)
+    threads, cycles, errors = a.to_s.split('/')
+    assert_equal(n, threads.to_i)
+    assert(cycles.to_i.positive?)
+    assert(errors.to_i.zero?)
+    a.stop
+  end
+
+  def test_stops_correctly
+    a = Always.new(6)
+    a.start { sleep(0.01) }
+    sleep(0.01)
     a.stop
+    assert_equal('0/0/0', a.to_s)
   end
 
   def test_with_counter
@@ -66,4 +90,17 @@ class TestAlways < Minitest::Test
     a.stop
     assert(done.positive?)
   end
+
+  def test_with_broken_syntax
+    a = Always.new(1)
+    failures = 0
+    a.on_error { |_e| failures += 1 }.start do
+      eval('broken$ruby$syntax')
+    end
+    sleep(0.1)
+    _, _, errors = a.to_s.split('/')
+    assert(!errors.to_i.zero?)
+    assert(!failures.zero?)
+    a.stop
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: always
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-31 00:00:00.000000000 Z
+date: 2024-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby