Merge pull request #623 from pitr-ch/master

Merging #613 and #612 with fixed travis

Author: Petr Chalupa

.travis.yml

@@ -1,17 +1,15 @@
 language: ruby
 
-cache: bundler
-
 rvm:
   # start with the latest
   - 2.4.0
   - jruby-9.1.5.0
 
   # older versions
   - 2.3.3
-  - 2.2
-  - 2.1
-  - 2.0
+  - 2.2.6
+  - 2.1.9
+  - 2.0.0
   - 1.9.3
 
   - jruby-9.0.5.0
@@ -52,7 +50,8 @@ env:
   global:
     - JAVA_OPTS=-Xmx1024m
 
-before_script:
+before_install:
   - "echo $JAVA_OPTS"
+  - bundle update # temporary fix, not sure why it helps
 
 script: if [[ -v TRUFFLE ]]; then support/test-truffle.sh; else RUBYOPT=-w bundle exec rake ci; fi

lib/concurrent/atomic/event.rb

@@ -13,6 +13,26 @@ module Concurrent
   # `#reset` at any time once it has been set.
   #
   # @see http://msdn.microsoft.com/en-us/library/windows/desktop/ms682655.aspx
+  # @example
+  #   event = Concurrent::Event.new
+  #
+  #   t1 = Thread.new do
+  #     puts "t1 is waiting"
+  #     event.wait(1)
+  #     puts "event ocurred"
+  #   end
+  #
+  #   t2 = Thread.new do
+  #     puts "t2 calling set"
+  #     event.set
+  #   end
+  #
+  #   [t1, t2].each(&:join)
+  #
+  #   # prints:
+  #   # t2 calling set
+  #   # t1 is waiting
+  #   # event ocurred
   class Event < Synchronization::LockableObject
 
     # Creates a new `Event` in the unset state. Threads calling `#wait` on the

lib/concurrent/atomic/semaphore.rb

@@ -108,6 +108,38 @@ module Concurrent
   #   count of the number available and acts accordingly.
   #
   # @!macro semaphore_public_api
+  # @example
+  #   semaphore = Concurrent::Semaphore.new(2)
+  #
+  #   t1 = Thread.new do
+  #     semaphore.acquire
+  #     puts "Thread 1 acquired semaphore"
+  #   end
+  #
+  #   t2 = Thread.new do
+  #     semaphore.acquire
+  #     puts "Thread 2 acquired semaphore"
+  #   end
+  #
+  #   t3 = Thread.new do
+  #     semaphore.acquire
+  #     puts "Thread 3 acquired semaphore"
+  #   end
+  #
+  #   t4 = Thread.new do
+  #     sleep(2)
+  #     puts "Thread 4 releasing semaphore"
+  #     semaphore.release
+  #   end
+  #
+  #   [t1, t2, t3, t4].each(&:join)
+  #
+  #   # prints:
+  #   # Thread 3 acquired semaphore
+  #   # Thread 2 acquired semaphore
+  #   # Thread 4 releasing semaphore
+  #   # Thread 1 acquired semaphore
+  #
   class Semaphore < SemaphoreImplementation
   end
 end