always 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95841105f15ff9ce3bbaf1e683874442ac7b6001470cbb001800461bdbfcac08
-  data.tar.gz: 2bd3f82bd21442bbb0649e6178855cb3a92655e1de9092e8428efeada20eb824
+  metadata.gz: 1d5c02ea320168984342dcf8805da07bec45d9a685097400c9f3e406a75a96b9
+  data.tar.gz: 0db1ae1c2006db2de79982172f8fd7cc1d53e3fb8dfaffc8e474ea5972139224
 SHA512:
-  metadata.gz: 72fcd1877695615e951d78a68caaece60904ac76c6668a80fb4d7f00a5f23514b575ef1499c9fef57e3162368df7b96a3df5280eb531469339a7f5fdaedbb6ce
-  data.tar.gz: d11c2fc0c61a531dfb20826b9daa760c4da5f214f030a2024086e9b23367acaf3e98c4d6ffebf009986b85cc78557e296ffd752d630b77679d4e29f1dfd233e8
+  metadata.gz: 628d7ddcbc48d5e1b87adcccb7446a60c0ec1b4f1e047ee85b9a3188f76e3dbd42de40d384fc7e4f84de21c750ba26312b136d63a1248b575a1d3c2d68430a0a
+  data.tar.gz: d9e259a904b1785543bb0282f026b0ee08e7ec1b641ee2243bd23d063a99df90b9dc69c69438f6d36f09bc7351a893b32581d0f475b7761d9997d7f112afa75a

data/Gemfile

@@ -23,15 +23,11 @@
 source 'https://rubygems.org'
 gemspec
 
-gem 'cucumber', '9.2.0', require: false
 gem 'minitest', '5.23.1', require: false
-gem 'net-ping', '2.0.8', require: false
 gem 'rake', '13.2.1', require: false
 gem 'rspec-rails', '6.1.2', require: false
-gem 'rubocop', '1.64.0', require: false
-gem 'rubocop-performance', '1.21.0', require: false
+gem 'rubocop', '1.64.1', require: false
 gem 'rubocop-rspec', '2.29.2', require: false
 gem 'simplecov', '0.22.0', require: false
 gem 'simplecov-cobertura', '2.1.0', require: false
-gem 'webmock', '3.23.1', require: false
 gem 'yard', '0.9.36', require: false

data/Gemfile.lock

@@ -2,6 +2,7 @@ PATH
   remote: .
   specs:
     always (0.0.0)
+      concurrent-ruby (~> 1.1)
 
 GEM
   remote: https://rubygems.org/
@@ -32,50 +33,17 @@ GEM
       minitest (>= 5.1)
       mutex_m
       tzinfo (~> 2.0)
-    addressable (2.8.6)
-      public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
     base64 (0.2.0)
     bigdecimal (3.1.8)
     builder (3.2.4)
-    concurrent-ruby (1.2.3)
+    concurrent-ruby (1.3.1)
     connection_pool (2.4.1)
-    crack (1.0.0)
-      bigdecimal
-      rexml
     crass (1.0.6)
-    cucumber (9.2.0)
-      builder (~> 3.2)
-      cucumber-ci-environment (> 9, < 11)
-      cucumber-core (> 13, < 14)
-      cucumber-cucumber-expressions (~> 17.0)
-      cucumber-gherkin (> 24, < 28)
-      cucumber-html-formatter (> 20.3, < 22)
-      cucumber-messages (> 19, < 25)
-      diff-lcs (~> 1.5)
-      mini_mime (~> 1.1)
-      multi_test (~> 1.1)
-      sys-uname (~> 1.2)
-    cucumber-ci-environment (10.0.1)
-    cucumber-core (13.0.2)
-      cucumber-gherkin (>= 27, < 28)
-      cucumber-messages (>= 20, < 23)
-      cucumber-tag-expressions (> 5, < 7)
-    cucumber-cucumber-expressions (17.1.0)
-      bigdecimal
-    cucumber-gherkin (27.0.0)
-      cucumber-messages (>= 19.1.4, < 23)
-    cucumber-html-formatter (21.3.1)
-      cucumber-messages (> 19, < 25)
-    cucumber-messages (22.0.0)
-    cucumber-tag-expressions (6.1.0)
     diff-lcs (1.5.1)
     docile (1.4.0)
     drb (2.2.1)
     erubi (1.12.0)
-    ffi (1.16.3)
-    ffi (1.16.3-x64-mingw-ucrt)
-    hashdiff (1.1.0)
     i18n (1.14.5)
       concurrent-ruby (~> 1.0)
     io-console (0.7.2)
@@ -87,11 +55,8 @@ GEM
     loofah (2.22.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
-    mini_mime (1.1.5)
     minitest (5.23.1)
-    multi_test (1.1.0)
     mutex_m (0.2.0)
-    net-ping (2.0.8)
     nokogiri (1.16.5-aarch64-linux)
       racc (~> 1.4)
     nokogiri (1.16.5-arm-linux)
@@ -112,7 +77,6 @@ GEM
       racc
     psych (5.1.2)
       stringio
-    public_suffix (5.0.5)
     racc (1.8.0)
     rack (3.0.11)
     rack-session (2.0.0)
@@ -163,7 +127,7 @@ GEM
       rspec-mocks (~> 3.13)
       rspec-support (~> 3.13)
     rspec-support (3.13.1)
-    rubocop (1.64.0)
+    rubocop (1.64.1)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
@@ -180,9 +144,6 @@ GEM
       rubocop (~> 1.41)
     rubocop-factory_bot (2.25.1)
       rubocop (~> 1.41)
-    rubocop-performance (1.21.0)
-      rubocop (>= 1.48.1, < 2.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
     rubocop-rspec (2.29.2)
       rubocop (~> 1.40)
       rubocop-capybara (~> 2.17)
@@ -202,16 +163,10 @@ GEM
     simplecov_json_formatter (0.1.4)
     stringio (3.1.0)
     strscan (3.1.0)
-    sys-uname (1.2.3)
-      ffi (~> 1.1)
     thor (1.3.1)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.5.0)
-    webmock (3.23.1)
-      addressable (>= 2.8.0)
-      crack (>= 0.3.2)
-      hashdiff (>= 0.4.0, < 2.0.0)
     webrick (1.8.1)
     yard (0.9.36)
     zeitwerk (2.6.15)
@@ -227,17 +182,13 @@ PLATFORMS
 
 DEPENDENCIES
   always!
-  cucumber (= 9.2.0)
   minitest (= 5.23.1)
-  net-ping (= 2.0.8)
   rake (= 13.2.1)
   rspec-rails (= 6.1.2)
-  rubocop (= 1.64.0)
-  rubocop-performance (= 1.21.0)
+  rubocop (= 1.64.1)
   rubocop-rspec (= 2.29.2)
   simplecov (= 0.22.0)
   simplecov-cobertura (= 2.1.0)
-  webmock (= 3.23.1)
   yard (= 0.9.36)
 
 BUNDLED WITH

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.1'
+  s.version = '0.0.2'
   s.license = 'MIT'
   s.summary = 'A simple Ruby framework that spins a loop forever, in a background thread'
   s.description =
@@ -40,5 +40,6 @@ Gem::Specification.new do |s|
   s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
   s.rdoc_options = ['--charset=UTF-8']
   s.extra_rdoc_files = ['README.md', 'LICENSE.txt']
+  s.add_runtime_dependency 'concurrent-ruby', '~>1.1'
   s.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/always.rb

@@ -20,50 +20,101 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
+require 'concurrent/atom'
+
 # Always.
+#
+# In order to start five threads performing the same piece of code
+# over and over again, with a 60-seconds pause between cycles, do this:
+#
+#  require 'always'
+#  a = Always.new(5)
+#  a.start(60) do
+#    puts 'Hello, world!
+#  end
+#
+# Then, in order stop them all together:
+#
+#  a.stop
+#
+# It's possible to get a quick summary of the thread pool, by calling +to_s+.
+#
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
 # Copyright:: Copyright (c) 2024 Yegor Bugayenko
 # License:: MIT
 class Always
   # The version of the framework.
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 
   # Constructor.
-  def initialize(total, pause = 0)
+  # @param [Integer] total The number of threads to run
+  def initialize(total)
+    raise "The number of threads (#{total}) must be positive" unless total.positive?
+
     @total = total
-    @pause = pause
     @on_error = nil
     @threads = []
+    @cycles = Concurrent::Atom.new(0)
+    @errors = Concurrent::Atom.new(0)
   end
 
   # What to do when an exception occurs?
+  #
+  # Call it like this (the +e+ provided is the exception and +i+ is the
+  # number of the thread where it occured):
+  #
+  #  a = Always.new(5)
+  #  a.on_error do |e, i|
+  #    puts e.message
+  #  end
+  #
+  # If the block that you provided will also throw an error, it will
+  # simply be ignored (not logged anywhere, just ignored!)
+  # @return [Always] Returns itself
   def on_error(&block)
     @on_error = block
+    self
   end
 
-  def start
+  # Start them all.
+  # @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)
+        body(i, pause)
+        @cycles.swap { |c| c + 1 }
       end
     end
   end
 
+  # Stop them all.
   def stop
     @threads.each(&:terminate)
+    @threads = []
+  end
+
+  # Represent its internal state as a string.
+  # @return [String] Something like "4/230/23", where 4 is the number of running
+  #  threads, 230 is the number of successfull loops, and 23 is the number
+  #  of failures occured so far.
+  def to_s
+    "#{@threads.size}/#{@cycles.value}/#{@errors.value}"
   end
 
   private
 
   # rubocop:disable Lint/RescueException
-  def body(idx)
+  def body(idx, pause)
     loop do
       begin
         yield
       rescue Exception => e
+        @errors.swap { |c| c + 1 }
         @on_error&.call(e, idx)
       end
-      sleep(@pause)
+      sleep(pause)
     rescue Exception
       # If we reach this point, we must not even try to
       # do anything. Here we must quietly ignore everything

data/test/test_always.rb

@@ -35,4 +35,24 @@ class TestAlways < Minitest::Test
     end
     a.stop
   end
+
+  def test_with_error
+    a = Always.new(5)
+    failures = 0
+    a.on_error { |_e, i| failures += i }.start do
+      raise 'intentionally'
+    end
+    sleep(0.1)
+    a.stop
+    assert(failures.positive?)
+  end
+
+  def test_converts_to_string
+    a = Always.new(5)
+    a.start do
+      # nothing
+    end
+    assert(a.to_s.start_with?('5/'))
+    a.stop
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: always
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Yegor Bugayenko
@@ -9,7 +9,21 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2024-05-31 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 description: You may need this framework if you have a routine task that must be performed
   every once in a while, but may raise exceptions which you don't want to cause a
   termination of the entire routine cycle.