concurrent-ruby 1.1.10 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2508d8671dc3f93a6d41204a69a2444669688ac1e9e7790104162ac5180579e
-  data.tar.gz: 5eba3636194c783d376ed010bd3d6ec8796fe409870e07a84c6b0b0ea2704b41
+  metadata.gz: f224c72d89a1bd079ad1086c9ed28a1d4d6432c718b9e0624c9a32afc8500cc8
+  data.tar.gz: dfb811189c8e7eeb2ea1f17fc1e680657dffe767c77bb09312e85a4f29f2bd60
 SHA512:
-  metadata.gz: 4c1cbc5311e939aecda5e291bb579a690807de5240bb2fb30600a9d1d9de8c353558de7d6e3e0dff871fcca364bd7caa76b304428e0fdaba323cbe04be300056
-  data.tar.gz: 863635cad877062864813b9ba72685b3afdadabf258a62b36f8d7093a5be9c7115d64aade01c9a98b9e68ef86dff2698e5e0cef7766b9c4dfc740e0e76eccf0c
+  metadata.gz: 807b1aac5e1bdee569df0b9e38fff1ed339f2c8569cd0a7ab565cbbecb23ffc9c6cf968e457e2acecf3abd187ac43da16dc2fb91716c912e78c08aa122dcaf0e
+  data.tar.gz: 07c37140aa1417ad32daa0de92f4c0883c7a96c1c53fba9aa09e34598632b3ad274283034064df41181e59964d0c79e41d083f17912e8e121c4f2d774c988b81

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 ## Current
 
-## Release v1.1.10
+## Release v1.2.0 (23 Jan 2023)
+
+* (#962) Fix ReentrantReadWriteLock to use the same granularity for locals as for Mutex it uses.
+* (#983) Add FiberLocalVar
+* (#934) concurrent-ruby now supports requiring individual classes (public classes listed in the docs), e.g., `require 'concurrent/map'`
+* (#976) Let `Promises.any_fulfilled_future` take an `Event`
+* Improve documentation of various classes
+* (#975) Set the Ruby compatibility version at 2.3
+* (#972) Remove Rubinius-related code
+
+## Release v1.1.10 (22 Mar 2022)
 
 concurrent-ruby:
 

data/Gemfile

@@ -2,7 +2,6 @@ source 'https://rubygems.org'
 
 require File.join(File.dirname(__FILE__), 'lib/concurrent-ruby/concurrent/version')
 require File.join(File.dirname(__FILE__ ), 'lib/concurrent-ruby-edge/concurrent/edge/version')
-require File.join(File.dirname(__FILE__ ), 'lib/concurrent-ruby/concurrent/utility/engine')
 
 no_path = ENV['NO_PATH']
 options = no_path ? {} : { path: '.' }

data/README.md

@@ -42,8 +42,8 @@ You can also get started by triaging issues which may include reproducing bug re
 ## Thread Safety
 
 *Concurrent Ruby makes one of the strongest thread safety guarantees of any Ruby concurrency 
-library, providing consistent behavior and guarantees on all four of the main Ruby interpreters 
-(MRI/CRuby, JRuby, Rubinius, TruffleRuby).*
+library, providing consistent behavior and guarantees on all three main Ruby interpreters
+(MRI/CRuby, JRuby, TruffleRuby).*
 
 Every abstraction in this library is thread safe. Specific thread safety guarantees are documented 
 with each abstraction.
@@ -58,9 +58,9 @@ other Ruby library, many of which support the mantra of
 Concurrent Ruby is also the only Ruby library which provides a full suite of thread safe and
 immutable variable types and data structures.
 
-We've also initiated discussion to document [memory model](docs-source/synchronization.md) of Ruby which 
-would provide consistent behaviour and guarantees on all four of the main Ruby interpreters 
-(MRI/CRuby, JRuby, Rubinius, TruffleRuby).
+We've also initiated discussion to document the [memory model](docs-source/synchronization.md) of Ruby which 
+would provide consistent behaviour and guarantees on all three main Ruby interpreters 
+(MRI/CRuby, JRuby, TruffleRuby).
 
 ## Features & Documentation
 
@@ -259,13 +259,10 @@ be obeyed though. Features developed in `concurrent-ruby-edge` are expected to m
 
 ## Supported Ruby versions
 
-* MRI 2.2 and above
+* MRI 2.3 and above
 * Latest JRuby 9000
 * Latest TruffleRuby
 
-The legacy support for Rubinius is kept for the moment but it is no longer maintained and is liable to be removed. If you would like to help 
-please respond to [#739](https://github.com/ruby-concurrency/concurrent-ruby/issues/739).
-
 ## Usage
 
 Everything within this gem can be loaded simply by requiring it:
@@ -274,7 +271,12 @@ Everything within this gem can be loaded simply by requiring it:
 require 'concurrent'
 ```
 
-*Requiring only specific abstractions from Concurrent Ruby is not yet supported.*
+You can also require a specific abstraction [part of the public documentation](https://ruby-concurrency.github.io/concurrent-ruby/master/index.html) since concurrent-ruby 1.2.0, for example:
+```ruby
+require 'concurrent/map'
+require 'concurrent/atomic/atomic_reference'
+require 'concurrent/executor/fixed_thread_pool'
+```
 
 To use the tools in the Edge gem it must be required separately:
 
@@ -362,20 +364,18 @@ best practice is to depend on `concurrent-ruby` and let users to decide if they
 
 * Update `version.rb`
 * Update the CHANGELOG
-* Update the Yard documentation
-    - Add the new version to `docs-source/signpost.md`. Needs to be done only if there are visible changes in the
-      documentation.
-    - Run `bundle exec rake yard` to update the master documentation and signpost.
-    - Run `bundle exec rake yard:<new-version>` to add or update the documentation of the new version.
+* Add the new version to `docs-source/signpost.md`. Needs to be done only if there are visible changes in the documentation.
 * Commit (and push) the changes.
-* Use `be rake release` to release the gem. It consists
-  of `['release:checks', 'release:build', 'release:test', 'release:publish']` steps. It will ask at the end before
-  publishing anything. Steps can also be executed individually.
+* Use `bundle exec rake release` to release the gem.
+  It consists of `['release:checks', 'release:build', 'release:test', 'release:publish']` steps.
+  It will ask at the end before publishing anything. Steps can also be executed individually.
 
 ## Maintainers
 
-* [Chris Seaton](https://github.com/chrisseaton) — Lead maintainer, point-of-contact.
-* [Benoit Daloze](https://github.com/eregon) — If Chris is not available Benoit can help.
+* [Benoit Daloze](https://github.com/eregon)
+* [Matthew Draper](https://github.com/matthewd)
+* [Rafael França](https://github.com/rafaelfranca)
+* [Samuel Williams](https://github.com/ioquatix)
 
 ### Special Thanks to
 
@@ -386,6 +386,7 @@ best practice is to depend on `concurrent-ruby` and let users to decide if they
 
 to the past maintainers
 
+* [Chris Seaton](https://github.com/chrisseaton)
 * [Petr Chalupa](https://github.com/pitr-ch)
 * [Michele Della Torre](https://github.com/mighe)
 * [Paweł Obrok](https://github.com/obrok)

data/Rakefile

@@ -34,14 +34,20 @@ namespace :repackage do
   task :all do
     Dir.chdir(__dir__) do
       # store gems in vendor cache for docker
-      sh 'bundle package'
+      Bundler.with_original_env do
+        sh 'bundle package'
+      end
 
       # build only the jar file not the whole gem for java platform, the jar is part the concurrent-ruby-x.y.z.gem
       Rake::Task['lib/concurrent-ruby/concurrent/concurrent_ruby.jar'].invoke
 
       # build all gem files
       %w[x86-mingw32 x64-mingw32].each do |plat|
-        RakeCompilerDock.sh "bundle install --local && bundle exec rake native:#{plat} gem --trace", platform: plat
+        RakeCompilerDock.sh(
+          "bundle install --local && bundle exec rake native:#{plat} gem --trace",
+          platform: plat,
+          options: ['--privileged'], # otherwise the directory in the image is empty
+          runas: false)
       end
     end
   end
@@ -54,7 +60,10 @@ Gem::PackageTask.new(core_gemspec) {} if core_gemspec
 Gem::PackageTask.new(ext_gemspec) {} if ext_gemspec && !Concurrent.on_jruby?
 Gem::PackageTask.new(edge_gemspec) {} if edge_gemspec
 
-CLEAN.include('lib/concurrent-ruby/concurrent/2.*', 'lib/concurrent-ruby/concurrent/*.jar')
+CLEAN.include(
+  'lib/concurrent-ruby/concurrent/concurrent_ruby_ext.*',
+  'lib/concurrent-ruby/concurrent/2.*',
+  'lib/concurrent-ruby/concurrent/*.jar')
 
 begin
   require 'rspec'
@@ -74,13 +83,15 @@ begin
 
     desc '* test packaged and installed gems instead of local files'
     task :installed do
-      Dir.chdir(__dir__) do
-        sh "gem install pkg/concurrent-ruby-#{Concurrent::VERSION}.gem"
-        sh "gem install pkg/concurrent-ruby-ext-#{Concurrent::VERSION}.gem" if Concurrent.on_cruby?
-        sh "gem install pkg/concurrent-ruby-edge-#{Concurrent::EDGE_VERSION}.gem"
-        ENV['NO_PATH'] = 'true'
-        sh 'bundle update'
-        sh 'bundle exec rake spec:ci'
+      Bundler.with_original_env do
+        Dir.chdir(__dir__) do
+          sh "gem install pkg/concurrent-ruby-#{Concurrent::VERSION}.gem"
+          sh "gem install pkg/concurrent-ruby-ext-#{Concurrent::VERSION}.gem" if Concurrent.on_cruby?
+          sh "gem install pkg/concurrent-ruby-edge-#{Concurrent::EDGE_VERSION}.gem"
+          ENV['NO_PATH'] = 'true'
+          sh 'bundle update'
+          sh 'bundle exec rake spec:ci'
+        end
       end
     end
   end
@@ -88,6 +99,19 @@ begin
   desc 'executed in CI'
   task :ci => [:compile, 'spec:ci']
 
+  desc 'run each spec file in a separate process to help find missing requires'
+  task 'spec:isolated' do
+    glob = "#{ENV['DIR'] || 'spec'}/**/*_spec.rb"
+    from = ENV['FROM']
+    env = { 'ISOLATED' => 'true' }
+    Dir[glob].each do |spec|
+      next if from and from != spec
+      from = nil if from == spec
+
+      sh env, 'rspec', spec
+    end
+  end
+
   task :default => [:clobber, :compile, :spec]
 rescue LoadError => e
   puts 'RSpec is not installed, skipping test task definitions: ' + e.message
@@ -184,34 +208,6 @@ begin
         *common_yard_options)
       yard.files = ['no-lib']
     end
-
-    define_uptodate_task = -> name do
-      namespace name do
-        desc "** ensure that #{name} generated documentation is matching the source code"
-        task :uptodate do
-          Dir.chdir(__dir__) do
-            begin
-              FileUtils.cp_r 'docs', 'docs-copy', verbose: true
-              Rake::Task["yard:#{name}"].invoke
-              sh 'diff -r docs/ docs-copy/' do |ok, res|
-                unless ok
-                  begin
-                    STDOUT.puts "yard:#{name} is not properly generated and committed.", "Continue? (y/n)"
-                    input = STDIN.gets.strip.downcase
-                  end until %w(y n).include?(input)
-                  exit 1 if input == 'n'
-                end
-              end
-            ensure
-              FileUtils.rm_rf 'docs-copy', verbose: true
-            end
-          end
-        end
-      end
-    end
-
-    define_uptodate_task.call current_yard_version_name
-    define_uptodate_task.call 'master'
   end
 
 rescue LoadError => e
@@ -224,7 +220,7 @@ task :release => ['release:checks', 'release:build', 'release:test', 'release:pu
 namespace :release do
   # Depends on environment of @pitr-ch
 
-  task :checks => "yard:#{current_yard_version_name}:uptodate" do
+  task :checks do
     Dir.chdir(__dir__) do
       sh 'test -z "$(git status --porcelain)"' do |ok, res|
         unless ok
@@ -256,25 +252,18 @@ namespace :release do
   desc '* test actual installed gems instead of cloned repository on MRI and JRuby'
   task :test do
     Dir.chdir(__dir__) do
-      old = ENV['RBENV_VERSION']
+      puts "Testing with the installed gem"
 
-      mri_version   = `ruby -e 'puts RUBY_VERSION'`.chomp
-      jruby_version = File.basename(ENV['CONCURRENT_JRUBY_HOME'])
+      Bundler.with_original_env do
+        sh 'ruby -v'
+        sh 'bundle exec rake spec:installed'
 
-      puts "Using following version:"
-      pp mri_version: mri_version, jruby_version: jruby_version
-
-      ENV['RBENV_VERSION'] = mri_version
-      sh 'rbenv version'
-      sh 'bundle exec rake spec:installed'
-
-      ENV['RBENV_VERSION'] = jruby_version
-      sh 'rbenv version'
-      sh 'bundle exec rake spec:installed'
+        env = { "PATH" => "#{ENV['CONCURRENT_JRUBY_HOME']}/bin:#{ENV['PATH']}" }
+        sh env, 'ruby -v'
+        sh env, 'bundle exec rake spec:installed'
+      end
 
       puts 'Windows build is untested'
-
-      ENV['RBENV_VERSION'] = old
     end
   end
 
@@ -321,9 +310,9 @@ namespace :release do
     desc '** print post release steps'
     task :post_steps do
       # TODO: (petr 05-Jun-2021) automate and renew the process
-      # puts 'Manually: create a release on GitHub with relevant changelog part'
-      # puts 'Manually: send email same as release with relevant changelog part'
-      # puts 'Manually: tweet'
+      puts 'Manually: create a release on GitHub with relevant changelog part'
+      puts 'Manually: send email same as release with relevant changelog part'
+      puts 'Manually: tweet'
     end
   end
 end

data/ext/concurrent-ruby/com/concurrent_ruby/ext/SynchronizationLibrary.java

@@ -55,12 +55,6 @@ public class SynchronizationLibrary implements Library {
         }
     }
 
-    private static final ObjectAllocator JRUBY_OBJECT_ALLOCATOR = new ObjectAllocator() {
-        public IRubyObject allocate(Ruby runtime, RubyClass klazz) {
-            return new JRubyObject(runtime, klazz);
-        }
-    };
-
     private static final ObjectAllocator OBJECT_ALLOCATOR = new ObjectAllocator() {
         public IRubyObject allocate(Ruby runtime, RubyClass klazz) {
             return new Object(runtime, klazz);
@@ -87,10 +81,7 @@ public class SynchronizationLibrary implements Library {
         RubyModule jrubyAttrVolatileModule = synchronizationModule.defineModuleUnder("JRubyAttrVolatile");
         jrubyAttrVolatileModule.defineAnnotatedMethods(JRubyAttrVolatile.class);
 
-        defineClass(runtime, synchronizationModule, "AbstractObject", "JRubyObject",
-                JRubyObject.class, JRUBY_OBJECT_ALLOCATOR);
-
-        defineClass(runtime, synchronizationModule, "JRubyObject", "Object",
+        defineClass(runtime, synchronizationModule, "AbstractObject", "Object",
                 Object.class, OBJECT_ALLOCATOR);
 
         defineClass(runtime, synchronizationModule, "Object", "AbstractLockableObject",
@@ -143,8 +134,8 @@ public class SynchronizationLibrary implements Library {
         // attempt to avoid code elimination.
         private static volatile int volatileField;
 
-        @JRubyMethod(name = "full_memory_barrier", visibility = Visibility.PUBLIC)
-        public static IRubyObject fullMemoryBarrier(ThreadContext context, IRubyObject self) {
+        @JRubyMethod(name = "full_memory_barrier", visibility = Visibility.PUBLIC, module = true)
+        public static IRubyObject fullMemoryBarrier(ThreadContext context, IRubyObject module) {
             // Prevent reordering of ivar writes with publication of this instance
             if (!FULL_FENCE) {
                 // Assuming that following volatile read and write is not eliminated it simulates fullFence.
@@ -158,9 +149,10 @@ public class SynchronizationLibrary implements Library {
             return context.nil;
         }
 
-        @JRubyMethod(name = "instance_variable_get_volatile", visibility = Visibility.PUBLIC)
+        @JRubyMethod(name = "instance_variable_get_volatile", visibility = Visibility.PUBLIC, module = true)
         public static IRubyObject instanceVariableGetVolatile(
                 ThreadContext context,
+                IRubyObject module,
                 IRubyObject self,
                 IRubyObject name) {
             // Ensure we ses latest value with loadFence
@@ -174,9 +166,10 @@ public class SynchronizationLibrary implements Library {
             }
         }
 
-        @JRubyMethod(name = "instance_variable_set_volatile", visibility = Visibility.PUBLIC)
+        @JRubyMethod(name = "instance_variable_set_volatile", visibility = Visibility.PUBLIC, module = true)
         public static IRubyObject InstanceVariableSetVolatile(
                 ThreadContext context,
+                IRubyObject module,
                 IRubyObject self,
                 IRubyObject name,
                 IRubyObject value) {
@@ -195,16 +188,8 @@ public class SynchronizationLibrary implements Library {
         }
     }
 
-    @JRubyClass(name = "JRubyObject", parent = "AbstractObject")
-    public static class JRubyObject extends RubyObject {
-
-        public JRubyObject(Ruby runtime, RubyClass metaClass) {
-            super(runtime, metaClass);
-        }
-    }
-
-    @JRubyClass(name = "Object", parent = "JRubyObject")
-    public static class Object extends JRubyObject {
+    @JRubyClass(name = "Object", parent = "AbstractObject")
+    public static class Object extends RubyObject {
 
         public Object(Ruby runtime, RubyClass metaClass) {
             super(runtime, metaClass);
@@ -220,7 +205,7 @@ public class SynchronizationLibrary implements Library {
     }
 
     @JRubyClass(name = "JRubyLockableObject", parent = "AbstractLockableObject")
-    public static class JRubyLockableObject extends JRubyObject {
+    public static class JRubyLockableObject extends AbstractLockableObject {
 
         public JRubyLockableObject(Ruby runtime, RubyClass metaClass) {
             super(runtime, metaClass);

data/lib/concurrent-ruby/concurrent/agent.rb

@@ -1,9 +1,10 @@
 require 'concurrent/configuration'
 require 'concurrent/atomic/atomic_reference'
+require 'concurrent/atomic/count_down_latch'
 require 'concurrent/atomic/thread_local_var'
 require 'concurrent/collection/copy_on_write_observer_set'
 require 'concurrent/concern/observable'
-require 'concurrent/synchronization'
+require 'concurrent/synchronization/lockable_object'
 
 module Concurrent
 

data/lib/concurrent-ruby/concurrent/array.rb

@@ -34,16 +34,6 @@ module Concurrent
                           end
                           JRubyArray
 
-                        when Concurrent.on_rbx?
-                          require 'monitor'
-                          require 'concurrent/thread_safe/util/data_structures'
-
-                          class RbxArray < ::Array
-                          end
-
-                          ThreadSafe::Util.make_synchronized_on_rbx RbxArray
-                          RbxArray
-
                         when Concurrent.on_truffleruby?
                           require 'concurrent/thread_safe/util/data_structures'
 

data/lib/concurrent-ruby/concurrent/atom.rb

@@ -1,7 +1,7 @@
 require 'concurrent/atomic/atomic_reference'
 require 'concurrent/collection/copy_on_notify_observer_set'
 require 'concurrent/concern/observable'
-require 'concurrent/synchronization'
+require 'concurrent/synchronization/object'
 
 # @!macro thread_safe_variable_comparison
 #

data/lib/concurrent-ruby/concurrent/atomic/atomic_boolean.rb

@@ -1,5 +1,6 @@
+require 'concurrent/utility/native_extension_loader' # load native parts first
+
 require 'concurrent/atomic/mutex_atomic_boolean'
-require 'concurrent/synchronization'
 
 module Concurrent
 
@@ -79,10 +80,10 @@ module Concurrent
   # @!visibility private
   # @!macro internal_implementation_note
   AtomicBooleanImplementation = case
-                                when defined?(JavaAtomicBoolean)
-                                  JavaAtomicBoolean
-                                when defined?(CAtomicBoolean)
+                                when Concurrent.on_cruby? && Concurrent.c_extensions_loaded?
                                   CAtomicBoolean
+                                when Concurrent.on_jruby?
+                                  JavaAtomicBoolean
                                 else
                                   MutexAtomicBoolean
                                 end

data/lib/concurrent-ruby/concurrent/atomic/atomic_fixnum.rb

@@ -1,5 +1,6 @@
+require 'concurrent/utility/native_extension_loader' # load native parts first
+
 require 'concurrent/atomic/mutex_atomic_fixnum'
-require 'concurrent/synchronization'
 
 module Concurrent
 
@@ -96,10 +97,10 @@ module Concurrent
   # @!visibility private
   # @!macro internal_implementation_note
   AtomicFixnumImplementation = case
-                               when defined?(JavaAtomicFixnum)
-                                 JavaAtomicFixnum
-                               when defined?(CAtomicFixnum)
+                               when Concurrent.on_cruby? && Concurrent.c_extensions_loaded?
                                  CAtomicFixnum
+                               when Concurrent.on_jruby?
+                                 JavaAtomicFixnum
                                else
                                  MutexAtomicFixnum
                                end

data/lib/concurrent-ruby/concurrent/atomic/atomic_markable_reference.rb

@@ -1,3 +1,6 @@
+require 'concurrent/errors'
+require 'concurrent/synchronization/object'
+
 module Concurrent
   # An atomic reference which maintains an object reference along with a mark bit
   # that can be updated atomically.