threads 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a727b29dfd70ee9fd089218c0342e43955118073e027b937f255c42dc623dcd
-  data.tar.gz: af92d34fc180a47af611fe5dadfbf0241a576e910b6deaa4f3e430cb009e28de
+  metadata.gz: 11b9c960e3ade614ef2537ed594aca491bf650b0e2efbc0c4723eb6ed06441d7
+  data.tar.gz: 794bbdead21ac26baffb375566fac252495767a312729c94ce15628078f2d835
 SHA512:
-  metadata.gz: 15035cb016d91eef122223906088e73ed9117c404d40af293ece442b443a4724275717a210aadad830050afc9f7d33caed17b4a387f67c705466f66e398cd142
-  data.tar.gz: 85f9284c7b484db5870a3d39af33aafe71a308671b2180cc602d03ba3c5580a6a1acc0647bca1604c27c5def30f3cd4021d28fa8accc622dad9f117fea99ee6c
+  metadata.gz: 7ad26d667349ecee26e8671473375d679c4a34edd4ab5b2a015f4d8913415a87560e7bfb2fbd64c0ad913ad34f2721840d8d507380f2611fa9b7e5a9982dc494
+  data.tar.gz: 74cdf428dde2ec03ca340924414763c4f6cb5204f53e3cda05086c11ae24f8d7dd1ed938ead94100047550a82e84fae8dd29eba00c81768b38e67a4b35f19708

data/README.md

@@ -3,9 +3,12 @@
 
 [![Build Status](https://travis-ci.org/yegor256/threads.svg)](https://travis-ci.org/yegor256/threads)
 [![Gem Version](https://badge.fury.io/rb/threads.svg)](http://badge.fury.io/rb/threads)
-[![Maintainability](https://api.codeclimate.com/v1/badges/0296baf81e86b90fba70/maintainability)](https://codeclimate.com/github/yegor256/threads/maintainability)
+[![Maintainability](https://api.codeclimate.com/v1/badges/24fc3acdf781d98b8749/maintainability)](https://codeclimate.com/github/yegor256/threads/maintainability)
 
-Ruby test threads.
+When you need to test your code for thread safety, what do you do?
+That's right, you just don't test it.
+That's [wrong](https://www.yegor256.com/2018/03/27/how-to-test-thread-safety.html)!
+This simple gem helps you test your code with just two additional lines of code.
 
 First, install it:
 
@@ -13,12 +16,23 @@ First, install it:
 $ gem install threads
 ```
 
-Then, use it like this, to print a threads:
+Then, use it like this, to test your code from multiple concurrently running threads:
 
 ```ruby
 require 'threads'
-Threads.new.assert do |i|
-  puts "Hello from threads no.#{i}"
+Threads.new(5).assert do |i|
+  puts "Hello from the thread no.#{i}"
+end
+```
+
+You can put whatever you want into the block. The code will be executed from five threads, concurrently.
+You can also make sure the code block runs only a specific number of times
+specifying the argument in the `assert` method (it can't be smaller than the amount of threads):
+
+```ruby
+require 'threads'
+Threads.new(5).assert(20) do |i, r|
+  puts "Hello from the thread no.#{i}, repetition no.#{r}"
 end
 ```
 

data/lib/threads.rb

@@ -33,9 +33,12 @@ class Threads
     @total = total
   end
 
-  def assert(reps = 0)
+  def assert(reps = @total)
+    if reps < @total
+      raise "Repetition counter #{reps} can't be smaller than #{@total}"
+    end
     done = Concurrent::AtomicFixnum.new
-    cycles = Concurrent::AtomicFixnum.new
+    rep = Concurrent::AtomicFixnum.new
     pool = Concurrent::FixedThreadPool.new(@total)
     latch = Concurrent::CountDownLatch.new(1)
     @total.times do |t|
@@ -43,14 +46,14 @@ class Threads
         Thread.current.name = "assert-thread-#{t}"
         latch.wait(10)
         loop do
+          r = rep.increment
+          break if r > reps
           begin
-            yield t
+            yield(t, r - 1)
           rescue StandardError => e
             puts Backtrace.new(e)
             raise e
           end
-          cycles.increment
-          break if cycles.value > reps
         end
         done.increment
       end

data/test/test_threads.rb

@@ -33,10 +33,17 @@ require_relative '../lib/threads'
 class ThreadsTest < Minitest::Test
   def test_multiple_threads
     done = Concurrent::AtomicFixnum.new
-    total = 10
-    Threads.new(total).assert do
+    Threads.new(10).assert do
       done.increment
     end
-    assert_equal(total, done.value)
+    assert_equal(10, done.value)
+  end
+
+  def test_multiple_threads_with_cap
+    done = Concurrent::AtomicFixnum.new
+    Threads.new(3).assert(20) do
+      done.increment
+    end
+    assert_equal(20, done.value)
   end
 end

data/threads.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |s|
   s.rubygems_version = '2.3.3'
   s.required_ruby_version = '>=2.3'
   s.name = 'threads'
-  s.version = '0.1.0'
+  s.version = '0.2.0'
   s.license = 'MIT'
   s.summary = 'Test threads'
   s.description = 'Rugy Gem to test a piece of code in concurrent threads'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: threads
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Yegor Bugayenko