Renamed IVar #set? method to #try_set to be more idiomatic.

Author: jdantonio

lib/concurrent/channel/buffered_channel.rb

@@ -40,7 +40,7 @@ def select(probe)
           @probe_set.put(probe)
           true
         else
-          shift_buffer if probe.set?([peek_buffer, self])
+          shift_buffer if probe.try_set([peek_buffer, self])
         end
 
       end
@@ -76,7 +76,7 @@ def set_probe_or_push_into_buffer(value)
           push_into_buffer(value)
           true
         else
-          @probe_set.take.set?([value, self])
+          @probe_set.take.try_set([value, self])
         end
       end
     end

lib/concurrent/channel/unbuffered_channel.rb

@@ -12,7 +12,7 @@ def probe_set_size
     end
 
     def push(value)
-      until @probe_set.take.set?([value, self])
+      until @probe_set.take.try_set([value, self])
       end
     end
 

lib/concurrent/ivar.rb

@@ -98,16 +98,17 @@ def add_observer(observer = nil, func = :update, &block)
       observer
     end
 
-    # Set the `IVar` to a value and wake or notify all threads waiting on it.
-    #
-    # @!macro [attach] ivar_set_parameters_and_exceptions
-    #   @param [Object] value the value to store in the `IVar`
-    #   @yield A block operation to use for setting the value
-    #   @raise [ArgumentError] if both a value and a block are given
-    #   @raise [Concurrent::MultipleAssignmentError] if the `IVar` has already
-    #     been set or otherwise completed
-    #
-    # @return [IVar] self
+    # @!macro [attach] ivar_set_method
+    #   Set the `IVar` to a value and wake or notify all threads waiting on it.
+    #  
+    #   @!macro [attach] ivar_set_parameters_and_exceptions
+    #     @param [Object] value the value to store in the `IVar`
+    #     @yield A block operation to use for setting the value
+    #     @raise [ArgumentError] if both a value and a block are given
+    #     @raise [Concurrent::MultipleAssignmentError] if the `IVar` has already
+    #       been set or otherwise completed
+    #  
+    #   @return [IVar] self
     def set(value = NO_VALUE)
       check_for_block_or_value!(block_given?, value)
       raise MultipleAssignmentError unless compare_and_set_state(:processing, :pending)
@@ -120,12 +121,13 @@ def set(value = NO_VALUE)
       end
     end
 
-    # Set the `IVar` to failed due to some error and wake or notify all threads waiting on it.
-    #
-    # @param [Object] reason for the failure
-    # @raise [Concurrent::MultipleAssignmentError] if the `IVar` has already
-    #   been set or otherwise completed
-    # @return [IVar] self
+    # @!macro [attach] ivar_fail_method
+    #   Set the `IVar` to failed due to some error and wake or notify all threads waiting on it.
+    #  
+    #   @param [Object] reason for the failure
+    #   @raise [Concurrent::MultipleAssignmentError] if the `IVar` has already
+    #     been set or otherwise completed
+    #   @return [IVar] self
     def fail(reason = StandardError.new)
       complete(false, nil, reason)
     end
@@ -136,7 +138,7 @@ def fail(reason = StandardError.new)
     # @!macro ivar_set_parameters_and_exceptions
     #
     # @return [Boolean] true if the value was set else false
-    def set?(value = NO_VALUE, &block)
+    def try_set(value = NO_VALUE, &block)
       set(value, &block)
       true
     rescue MultipleAssignmentError

spec/concurrent/channel/probe_spec.rb

@@ -20,41 +20,41 @@ def trigger_observable(observable)
       it_should_behave_like :observable
     end
 
-    describe '#set?' do
+    describe '#try_set' do
       context 'empty probe' do
         it 'assigns the value' do
-          probe.set?([32, channel])
+          probe.try_set([32, channel])
           expect(probe.value.first).to eq 32
         end
 
         it 'assign the channel' do
-          probe.set?([32, channel])
+          probe.try_set([32, channel])
           expect(probe.value.last).to be channel
         end
 
         it 'returns true' do
-          expect(probe.set?(['hi', channel])).to eq true
+          expect(probe.try_set(['hi', channel])).to eq true
         end
       end
 
       context 'fulfilled probe' do
         before(:each) { probe.set([27, nil]) }
 
         it 'does not assign the value' do
-          probe.set?([88, channel])
+          probe.try_set([88, channel])
           expect(probe.value.first).to eq 27
         end
 
         it 'returns false' do
-          expect(probe.set?(['hello', channel])).to eq false
+          expect(probe.try_set(['hello', channel])).to eq false
         end
       end
 
       context 'rejected probe' do
         before(:each) { probe.fail }
 
         it 'does not assign the value' do
-          probe.set?([88, channel])
+          probe.try_set([88, channel])
           expect(probe).to be_rejected
         end
 
@@ -63,7 +63,7 @@ def trigger_observable(observable)
         end
 
         it 'returns false' do
-          expect(probe.set?(['hello', channel])).to eq false
+          expect(probe.try_set(['hello', channel])).to eq false
         end
       end
     end

spec/concurrent/ivar_shared.rb

@@ -94,22 +94,22 @@
     end
   end
 
-  describe '#set?' do
+  describe '#try_set' do
 
     context 'when unset' do
 
       it 'assigns the value' do
-        subject.set?(32)
+        subject.try_set(32)
         expect(subject.value).to eq 32
       end
 
       it 'assigns the block result' do
-        subject.set?{ 32 }
+        subject.try_set{ 32 }
         expect(subject.value).to eq 32
       end
 
       it 'returns true' do
-        expect(subject.set?('hi')).to eq true
+        expect(subject.try_set('hi')).to eq true
       end
     end
 
@@ -118,17 +118,17 @@
       before(:each) { subject.set(27) }
 
       it 'does not assign the value' do
-        subject.set?(88)
+        subject.try_set(88)
         expect(subject.value).to eq 27
       end
 
       it 'does not assign the block result' do
-        subject.set?{ 88 }
+        subject.try_set{ 88 }
         expect(subject.value).to eq 27
       end
 
       it 'returns false' do
-        expect(subject.set?('hello')).to eq false
+        expect(subject.try_set('hello')).to eq false
       end
     end
 
@@ -137,12 +137,12 @@
       before(:each) { subject.fail }
 
       it 'does not assign the value' do
-        subject.set?(88)
+        subject.try_set(88)
         expect(subject).to be_rejected
       end
 
       it 'does not assign the block result' do
-        subject.set?{ 88 }
+        subject.try_set{ 88 }
         expect(subject).to be_rejected
       end
 
@@ -151,7 +151,7 @@
       end
 
       it 'returns false' do
-        expect(subject.set?('hello')).to eq false
+        expect(subject.try_set('hello')).to eq false
       end
     end
   end