concurrent-ruby 1.1.4 → 1.1.5

data/lib/concurrent/synchronization/abstract_struct.rb

@@ -152,6 +152,7 @@ module Concurrent
           end
         end
         clazz.class_exec(&block) unless block.nil?
+        clazz.singleton_class.send :alias_method, :[], :new
         clazz
       end
     end

data/lib/concurrent/synchronization/condition.rb

@@ -1,5 +1,7 @@
 module Concurrent
   module Synchronization
+
+    # @!visibility private
     # TODO (pitr-ch 04-Dec-2016): should be in edge
     class Condition < LockableObject
       safe_initialization!

data/lib/concurrent/synchronization/jruby_object.rb

@@ -3,6 +3,7 @@ module Concurrent
 
     if Concurrent.on_jruby? && Concurrent.java_extensions_loaded?
 
+      # @!visibility private
       module JRubyAttrVolatile
         def self.included(base)
           base.extend(ClassMethods)

data/lib/concurrent/synchronization/lock.rb

@@ -1,5 +1,7 @@
 module Concurrent
   module Synchronization
+
+    # @!visibility private
     # TODO (pitr-ch 04-Dec-2016): should be in edge
     class Lock < LockableObject
       # TODO use JavaReentrantLock on JRuby

data/lib/concurrent/synchronization/mri_object.rb

@@ -1,6 +1,7 @@
 module Concurrent
   module Synchronization
 
+    # @!visibility private
     module MriAttrVolatile
       def self.included(base)
         base.extend(ClassMethods)

data/lib/concurrent/synchronization/object.rb

@@ -27,15 +27,15 @@ module Concurrent
 
       # @!method self.attr_volatile(*names)
       #   Creates methods for reading and writing (as `attr_accessor` does) to a instance variable with
-      #   volatile (Java) semantic. The instance variable should be accessed oly through generated methods.
+      #   volatile (Java) semantic. The instance variable should be accessed only through generated methods.
       #
-      #   @param [Array<Symbol>] names of the instance variables to be volatile
-      #   @return [Array<Symbol>] names of defined method names
+      #   @param [::Array<Symbol>] names of the instance variables to be volatile
+      #   @return [::Array<Symbol>] names of defined method names
 
       # Has to be called by children.
       def initialize
         super
-        initialize_volatile_with_cas
+        __initialize_atomic_fields__
       end
 
       # By calling this method on a class, it and all its children are marked to be constructed safely. Meaning that
@@ -49,10 +49,12 @@ module Concurrent
       #       @AFinalValue = 'value' # published safely, does not have to be synchronized
       #     end
       #   end
+      # @return [true]
       def self.safe_initialization!
         # define only once, and not again in children
         return if safe_initialization?
 
+        # @!visibility private
         def self.new(*args, &block)
           object = super(*args, &block)
         ensure
@@ -70,6 +72,8 @@ module Concurrent
 
       # For testing purposes, quite slow. Injects assert code to new method which will raise if class instance contains
       # any instance variables with CamelCase names and isn't {.safe_initialization?}.
+      # @raise when offend found
+      # @return [true]
       def self.ensure_safe_initialization_when_final_fields_are_present
         Object.class_eval do
           def self.new(*args, &block)
@@ -81,6 +85,7 @@ module Concurrent
             end
           end
         end
+        true
       end
 
       # Creates methods for reading and writing to a instance variable with
@@ -89,13 +94,30 @@ module Concurrent
       # This method generates following methods: `value`, `value=(new_value) #=> new_value`,
       # `swap_value(new_value) #=> old_value`,
       # `compare_and_set_value(expected, value) #=> true || false`, `update_value(&block)`.
-      # @param [Array<Symbol>] names of the instance variables to be volatile with CAS.
-      # @return [Array<Symbol>] names of defined method names.
+      # @param [::Array<Symbol>] names of the instance variables to be volatile with CAS.
+      # @return [::Array<Symbol>] names of defined method names.
+      # @!macro attr_atomic
+      #   @!method $1
+      #     @return [Object] The $1.
+      #   @!method $1=(new_$1)
+      #     Set the $1.
+      #     @return [Object] new_$1.
+      #   @!method swap_$1(new_$1)
+      #     Set the $1 to new_$1 and return the old $1.
+      #     @return [Object] old $1
+      #   @!method compare_and_set_$1(expected_$1, new_$1)
+      #     Sets the $1 to new_$1 if the current $1 is expected_$1
+      #     @return [true, false]
+      #   @!method update_$1(&block)
+      #     Updates the $1 using the block.
+      #     @yield [Object] Calculate a new $1 using given (old) $1
+      #     @yieldparam [Object] old $1
+      #     @return [Object] new $1
       def self.attr_atomic(*names)
-        @volatile_cas_fields ||= []
-        @volatile_cas_fields += names
+        @__atomic_fields__ ||= []
+        @__atomic_fields__ += names
         safe_initialization!
-        define_initialize_volatile_with_cas
+        define_initialize_atomic_fields
 
         names.each do |name|
           ivar = :"@Atomic#{name.to_s.gsub(/(?:^|_)(.)/) { $1.upcase }}"
@@ -124,32 +146,36 @@ module Concurrent
         names.flat_map { |n| [n, :"#{n}=", :"swap_#{n}", :"compare_and_set_#{n}", :"update_#{n}"] }
       end
 
-      # @param [true,false] inherited should inherited volatile with CAS fields be returned?
-      # @return [Array<Symbol>] Returns defined volatile with CAS fields on this class.
-      def self.volatile_cas_fields(inherited = true)
-        @volatile_cas_fields ||= []
-        ((superclass.volatile_cas_fields if superclass.respond_to?(:volatile_cas_fields) && inherited) || []) +
-            @volatile_cas_fields
+      # @param [true, false] inherited should inherited volatile with CAS fields be returned?
+      # @return [::Array<Symbol>] Returns defined volatile with CAS fields on this class.
+      def self.atomic_attributes(inherited = true)
+        @__atomic_fields__ ||= []
+        ((superclass.atomic_attributes if superclass.respond_to?(:atomic_attributes) && inherited) || []) + @__atomic_fields__
+      end
+
+      # @return [true, false] is the attribute with name atomic?
+      def self.atomic_attribute?(name)
+        atomic_attributes.include? name
       end
 
       private
 
-      def self.define_initialize_volatile_with_cas
-        assignments = @volatile_cas_fields.map do |name|
+      def self.define_initialize_atomic_fields
+        assignments = @__atomic_fields__.map do |name|
           "@Atomic#{name.to_s.gsub(/(?:^|_)(.)/) { $1.upcase }} = Concurrent::AtomicReference.new(nil)"
         end.join("\n")
 
         class_eval <<-RUBY, __FILE__, __LINE__ + 1
-          def initialize_volatile_with_cas
+          def __initialize_atomic_fields__
             super
             #{assignments}
           end
         RUBY
       end
 
-      private_class_method :define_initialize_volatile_with_cas
+      private_class_method :define_initialize_atomic_fields
 
-      def initialize_volatile_with_cas
+      def __initialize_atomic_fields__
       end
 
     end

data/lib/concurrent/synchronization/rbx_object.rb

@@ -1,6 +1,7 @@
 module Concurrent
   module Synchronization
 
+    # @!visibility private
     module RbxAttrVolatile
       def self.included(base)
         base.extend(ClassMethods)

data/lib/concurrent/synchronization/truffleruby_object.rb

@@ -1,6 +1,7 @@
 module Concurrent
   module Synchronization
 
+    # @!visibility private
     module TruffleRubyAttrVolatile
       def self.included(base)
         base.extend(ClassMethods)

data/lib/concurrent/version.rb

@@ -1,4 +1,3 @@
 module Concurrent
-  VERSION      = '1.1.4'
-  EDGE_VERSION = '0.4.1'
+  VERSION      = '1.1.5'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: concurrent-ruby
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.1.5
 platform: ruby
 authors:
 - Jerry D'Antonio
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-15 00:00:00.000000000 Z
+date: 2019-03-11 00:00:00.000000000 Z
 dependencies: []
 description: |
   Modern concurrency tools including agents, futures, promises, thread pools, actors, supervisors, and more.
@@ -167,7 +167,8 @@ files:
 homepage: http://www.concurrent-ruby.com
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/ruby-concurrency/concurrent-ruby
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -184,7 +185,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: Modern concurrency tools for Ruby. Inspired by Erlang, Clojure, Scala, Haskell,