in_threads 1.5.4 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a13000fc0f561105a6adeeea71266dbf5c612be3db0a9091966b2296e5778f4
-  data.tar.gz: f8fd0391af01fcf83066904a32fd99e9709e2724d301753e960a0d227b0bc551
+  metadata.gz: 9ab96a79a5ad21d6198f4c91e689a37343371ca5932a30d695c91f8f8949a9c5
+  data.tar.gz: 91e41ba4f9073cff55f925e40cbc8728893974ec365a440b1f57cafd315ce4be
 SHA512:
-  metadata.gz: db4a7b1c67f3a0e53af5e74b43c8620ca90a7ba863415c8d7246feb55f687ac49772d4aa96e43152b64df6b8822e34563186f94233ea9fff8a49002e0d920a29
-  data.tar.gz: 7a5305b83387426a78f502a71941f476f0af8dd69c1ca16cb95902270898aebf72b5c7f513c52419b398e0fc02f8fec5e65466279f44cec953f3c547a3340259
+  metadata.gz: 0c03797c1506c3bc73b1fd8191ba931f21c63c30e56a897bc309815a461eaa2baa368e7daa88a2023113c954c1016666f0b267cfa11b01455d59b3af4d0999f7
+  data.tar.gz: 274d7a37b752f0f673eb575a348422999b177cdd56e9519f11dbbee0305bd16b17aceccdfd08f1c2ba12b46c8119a309e1a4cc88f8ff3be6078940dc579f96f0

data/.github/workflows/check.yml

@@ -0,0 +1,51 @@
+name: check
+on:
+  push:
+  pull_request:
+  schedule:
+  - cron: 45 4 * * 3
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby:
+        - '2.0'
+        - '2.1'
+        - '2.2'
+        - '2.3'
+        - '2.4'
+        - '2.5'
+        - '2.6'
+        - '2.7'
+        - '3.0'
+        - '3.1'
+        - jruby-9.1
+        - jruby-9.2
+        - jruby-9.3
+        include:
+        - ruby: ruby-head
+          allow-failure: allow-failure
+      fail-fast: false
+    continue-on-error: ${{ matrix.allow-failure && true || false }}
+    timeout-minutes: 5
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: "${{ matrix.ruby }}"
+        bundler-cache: true
+    - run: bundle exec rspec --format documentation
+  legacy:
+    runs-on: ubuntu-latest
+    container: ${{ matrix.container }}
+    strategy:
+      matrix:
+        container:
+        - rspec/ci:1.8.7
+        - rspec/ci:1.9.3
+      fail-fast: false
+    steps:
+    - uses: actions/checkout@v2
+    - run: bundle install
+    - run: bundle exec rspec --format documentation

data/.github/workflows/rubocop.yml

@@ -0,0 +1,16 @@
+name: rubocop
+on:
+  push:
+  pull_request:
+  schedule:
+  - cron: 45 4 * * 3
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.1'
+        bundler-cache: true
+    - run: bundle exec rubocop

data/.rubocop.yml

@@ -1,6 +1,8 @@
 AllCops:
   Exclude:
     - '*.gemspec'
+    - 'vendor/bundle/**/*'
+  NewCops: enable
 
 Layout/AccessModifierIndentation:
   EnforcedStyle: outdent
@@ -17,6 +19,9 @@ Layout/EndAlignment:
 Layout/FirstHashElementIndentation:
   EnforcedStyle: consistent
 
+Layout/LineLength:
+  Max: 120
+
 Layout/RescueEnsureAlignment:
   Enabled: false
 
@@ -52,21 +57,30 @@ Metrics/ClassLength:
 Metrics/CyclomaticComplexity:
   Max: 10
 
-Metrics/LineLength:
-  Max: 120
-
 Metrics/MethodLength:
   Max: 30
 
 Style/DoubleNegation:
   Enabled: false
 
+Style/HashEachMethods:
+  Enabled: true
+
 Style/HashSyntax:
   EnforcedStyle: hash_rockets
 
+Style/HashTransformKeys:
+  Enabled: false
+
+Style/HashTransformValues:
+  Enabled: false
+
 Style/IfUnlessModifier:
   Enabled: false
 
+Style/OptionalBooleanParameter:
+  Enabled: false
+
 Style/ParallelAssignment:
   Enabled: false
 

data/CHANGELOG.markdown

@@ -2,6 +2,13 @@
 
 ## unreleased
 
+## v1.6.0 (2022-01-18)
+
+* Fix return for shortcut `enum.in_threads{ break … }` vs `enum.in_threads.each{ break … }` [@toy](https://github.com/toy)
+* Switch `each_with_object` to run in threads, unlike inject/reduce there is no contradiction, care should be taken if passed object is not thread safe [@toy](https://github.com/toy)
+* Switch `to_h` (ruby >= 2.6) and `to_set` to run in threads, they accept block to apply before creating Hash and Set respectively [@toy](https://github.com/toy)
+* Register `compact` added in 3.1 to run without threads (as it doesn't accept block) [@toy](https://github.com/toy)
+
 ## v1.5.4 (2019-12-26)
 
 * Register `filter_map` to run in threads and `tally` to run without threads (as it doesn't accept block) [@toy](https://github.com/toy)

data/Gemfile

@@ -5,7 +5,3 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'rspec-retry', '< 0.6.1' if RUBY_VERSION < '1.9'
-
-if RUBY_VERSION >= '2.0'
-  gem 'travis_check_rubies', '~> 0.2'
-end

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2009-2019 Ivan Kuchin
+Copyright (c) 2009-2022 Ivan Kuchin
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.markdown

@@ -1,8 +1,8 @@
-[![Gem Version](https://img.shields.io/gem/v/in_threads.svg?style=flat)](https://rubygems.org/gems/in_threads)
-[![Build Status](https://img.shields.io/travis/toy/in_threads/master.svg?style=flat)](https://travis-ci.org/toy/in_threads)
-[![Code Climate](https://img.shields.io/codeclimate/maintainability/toy/in_threads.svg?style=flat)](https://codeclimate.com/github/toy/in_threads)
-[![Depfu](https://badges.depfu.com/badges/0579058f30df655f684aff1be244691e/overview.svg)](https://depfu.com/github/toy/in_threads)
-[![Inch CI](https://inch-ci.org/github/toy/in_threads.svg?branch=master&style=flat)](https://inch-ci.org/github/toy/in_threads)
+[![Gem Version](https://img.shields.io/gem/v/in_threads?logo=rubygems)](https://rubygems.org/gems/in_threads)
+[![Build Status](https://img.shields.io/github/workflow/status/toy/in_threads/check/master?logo=github)](https://github.com/toy/in_threads/actions/workflows/check.yml)
+[![Code Climate](https://img.shields.io/codeclimate/maintainability/toy/in_threads?logo=codeclimate)](https://codeclimate.com/github/toy/in_threads)
+[![Depfu](https://img.shields.io/depfu/toy/in_threads)](https://depfu.com/github/toy/in_threads)
+[![Inch CI](https://inch-ci.org/github/toy/in_threads.svg?branch=master)](https://inch-ci.org/github/toy/in_threads)
 
 # in_threads
 
@@ -25,13 +25,13 @@ gem 'in_threads'
 ...and install it with [Bundler](http://bundler.io).
 
 ```sh
-$ bundle install
+bundle install
 ```
 
 Or install globally:
 
 ```sh
-$ gem install in_threads
+gem install in_threads
 ```
 
 ## Usage
@@ -90,9 +90,20 @@ urls.in_threads.all? { |url| HTTP.get(url).status == 200 }
 urls.in_threads.any? { |url| HTTP.get(url).status == 404 }
 ```
 
-You can call any `Enumerable` method, but some (`#inject`, `#reduce`, `#max`,
-`#min`, `#sort`, `#to_a`, and others) cannot run concurrently, and so will
-simply act as if `in_threads` wasn't used.
+### Compatibility
+
+All methods of `Enumerable` with a block can be used if block calls are evaluated independently, so following will
+
+`all?`, `any?`, `collect_concat`, `collect`, `count`, `cycle`, `detect`, `drop_while`, `each_cons`, `each_entry`,
+`each_slice`, `each_with_index`, `each_with_object`, `each`, `enum_cons`, `enum_slice`, `enum_with_index`,
+`filter_map`, `filter`, `find_all`, `find_index`, `find`, `flat_map`, `group_by`, `map`, `max_by`, `min_by`,
+`minmax_by`, `none?`, `one?`, `partition`, `reject`, `reverse_each`, `select`, `sort_by`, `sum`, `take_while`, `to_h`,
+`to_set`, `uniq`, `zip`.
+
+Following either don't accept block (like `first`), depend on previous block evaluation (like `inject`) or return an enumerator (like `chunk`), so will simply act as if `in_threads` wasn't used:
+
+`chain`, `chunk_while`, `chunk`, `compact`, `drop`, `entries`, `first`, `include?`, `inject`, `lazy`, `max`, `member?`,
+`minmax`, `min`, `reduce`, `slice_after`, `slice_before`, `slice_when`, `sort`, `take`, `tally`, `to_a`.
 
 ### Break and exceptions
 
@@ -100,8 +111,8 @@ Exceptions are caught and re-thrown after allowing blocks that are still running
 
 **IMPORTANT**: only the first encountered exception is propagated, so it is recommended to handle exceptions in the block.
 
-`break` is handled in ruby >= 1.9 and should be handled in jruby [after 9.1.9.0](https://github.com/jruby/jruby/issues/4697). Handling is done in special way: as blocks are run outside of original context, calls to `break` cause `LocalJumpError` which is caught and its result is returned.
+`break` is handled in ruby >= 1.9 and should be handled in jruby [9.1 after 9.1.9.0](https://github.com/jruby/jruby/issues/4697) and [9.2 and 9.3 after #7009](https://github.com/jruby/jruby/issues/7009). Handling is done in special way: as blocks are run outside of original context, calls to `break` cause `LocalJumpError` which is caught and its result is returned.
 
 ## Copyright
 
-Copyright (c) 2009-2019 Ivan Kuchin. See LICENSE.txt for details.
+Copyright (c) 2009-2022 Ivan Kuchin. See LICENSE.txt for details.

data/in_threads.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = 'in_threads'
-  s.version     = '1.5.4'
+  s.version     = '1.6.0'
   s.summary     = %q{Run all possible enumerable methods in concurrent/parallel threads}
   s.homepage    = "https://github.com/toy/#{s.name}"
   s.authors     = ['Ivan Kuchin']
@@ -22,7 +22,8 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'rspec', '~> 3.0'
   s.add_development_dependency 'rspec-retry', '~> 0.3'
-  if RUBY_VERSION >= '2.2'
-    s.add_development_dependency 'rubocop', '~> 0.59', '!= 0.78.0'
+  if RUBY_VERSION >= '2.5'
+    s.add_development_dependency 'rubocop', '~> 1.22', '!= 1.22.2'
+    s.add_development_dependency 'rubocop-rspec', '~> 2.0'
   end
 end

data/lib/in_threads.rb

@@ -2,6 +2,7 @@
 
 require 'thread'
 require 'delegate'
+require 'set'
 
 Enumerable.class_eval do
   # Run enumerable method blocks in threads
@@ -33,17 +34,23 @@ class InThreads < SimpleDelegator
   protected :__getobj__, :__setobj__
 
   attr_reader :enumerable, :thread_count
-  def initialize(enumerable, thread_count = 10, &block)
+
+  def self.new(enumerable, thread_count = 10, &block)
+    if block
+      super.each(&block)
+    else
+      super
+    end
+  end
+
+  def initialize(enumerable, thread_count = 10)
     super(enumerable)
+
     @enumerable, @thread_count = enumerable, thread_count.to_i
-    unless enumerable.is_a?(Enumerable)
-      fail ArgumentError, '`enumerable` should include Enumerable.'
-    end
-    if thread_count < 2
-      fail ArgumentError, '`thread_count` can\'t be less than 2.'
-    end
 
-    each(&block) if block
+    fail ArgumentError, '`enumerable` should include Enumerable.' unless enumerable.is_a?(Enumerable)
+
+    fail ArgumentError, '`thread_count` can\'t be less than 2.' if thread_count < 2
   end
 
   # Creates new instance using underlying enumerable and new thread_count
@@ -68,13 +75,13 @@ class InThreads < SimpleDelegator
         next if ignore_undefined && !enumerable_method?(method)
 
         class_eval <<-RUBY, __FILE__, __LINE__ + 1
-          def #{method}(*args, &block)
-            if block
-              #{runner}(:#{method}, *args, &block)
-            else
-              enumerable.#{method}(*args)
-            end
-          end
+          def #{method}(*args, &block)             # def foo_bar(*args, &block)
+            if block                               #   if block
+              #{runner}(:#{method}, *args, &block) #     run_in_threads_method(:foo_bar, *args, &block)
+            else                                   #   else
+              enumerable.#{method}(*args)          #     enumerable.foo_bar(*args)
+            end                                    #   end
+          end                                      # end
         RUBY
       end
     end
@@ -94,6 +101,7 @@ class InThreads < SimpleDelegator
     zip
     cycle
     each_entry
+    each_with_object
   ], :ignore_undefined => true
   use :run_in_threads_use_block_result, :for => %w[
     all? any? none? one?
@@ -102,22 +110,37 @@ class InThreads < SimpleDelegator
     collect map group_by max_by min_by minmax_by sort_by sum uniq
     flat_map collect_concat
     filter_map
+    to_set
   ], :ignore_undefined => true
 
-  INCOMPATIBLE_METHODS = %w[
+  DEPENDENT_BLOCK_CALLS = %w[
     inject reduce
     max min minmax sort
-    entries to_a to_set to_h
+  ].map(&:to_sym)
+
+  ENUMERATOR_RETURNED = %w[
+    chunk chunk_while slice_before slice_after slice_when
+  ].map(&:to_sym)
+
+  BLOCKLESS_METHODS = %w[
+    entries to_a
     drop take
     first
     include? member?
-    each_with_object
-    chunk chunk_while slice_before slice_after slice_when
     lazy
     chain
     tally
+    compact
   ].map(&:to_sym)
 
+  if enumerable_method?(:to_h) && [[0, 0]].to_h{ [1, 1] } == {1 => 1}
+    use :run_in_threads_use_block_result, :for => %w[to_h]
+  else
+    BLOCKLESS_METHODS << :to_h
+  end
+
+  INCOMPATIBLE_METHODS = DEPENDENT_BLOCK_CALLS + ENUMERATOR_RETURNED + BLOCKLESS_METHODS
+
   # Special case method, works by applying `run_in_threads_use_block_result` with
   # map on enumerable returned by blockless run
   def grep(*args, &block)

data/spec/in_threads_spec.rb

@@ -18,7 +18,12 @@ end
 # not in jruby in mri < 1.9
 # https://github.com/jruby/jruby/issues/4697
 SKIP_IF_BREAK_IN_THREAD_IS_IGNORED = begin
-  Thread.new{ break }.join
+  proc do |&block|
+    Thread.new do
+      Thread.current.report_on_exception = false if Thread.current.respond_to?(:report_on_exception=)
+      block.call
+    end.join
+  end.call{ break } # rubocop:disable Style/MultilineBlockChain
   'can not handle break in thread'
 rescue LocalJumpError
   false
@@ -142,6 +147,13 @@ describe InThreads do
     end
 
     describe 'exception/break handling' do
+      it 'returns identical to each when initialized with block', :skip => SKIP_IF_BREAK_IN_THREAD_IS_IGNORED do
+        v = double
+        expect(enum.each{ break v }).to eq(v) # rubocop:disable Lint/UnreachableLoop
+        expect(enum.in_threads{ break v }).to eq(v)
+        expect(enum.in_threads.each{ break v }).to eq(v) # rubocop:disable Lint/UnreachableLoop
+      end
+
       %w[each map all?].each do |method|
         describe "for ##{method}" do
           it 'passes exception raised in block' do
@@ -153,7 +165,7 @@ describe InThreads do
               fail 'expected'
             end
 
-            expect{ enum.in_threads.send(method){} }.to raise_error('expected')
+            expect{ enum.in_threads.send(method){ nil } }.to raise_error('expected')
           end
 
           it 'handles break', :skip => SKIP_IF_BREAK_IN_THREAD_IS_IGNORED do
@@ -205,15 +217,18 @@ describe InThreads do
           context 'exception order' do
             before do
               stub_const('Order', Queue.new)
+              def Order.releasing
+                fail 'expected'
+              ensure
+                push nil
+              end
             end
 
             it 'passes exception raised during iteration if it happens earlier than in block' do
               def enum.each(&block)
                 5.times(&block)
-                begin
+                Order.releasing do
                   fail 'expected'
-                ensure
-                  Order.push nil
                 end
               end
 
@@ -236,10 +251,8 @@ describe InThreads do
 
               expect do
                 enum.in_threads(10).send(method) do
-                  begin
+                  Order.releasing do
                     fail 'expected'
-                  ensure
-                    Order.push nil
                   end
                 end
               end.to raise_error('expected')
@@ -249,10 +262,8 @@ describe InThreads do
               expect do
                 enum.in_threads(10).send(method) do |i|
                   if i == 5
-                    begin
+                    Order.releasing do
                       fail 'expected'
-                    ensure
-                      Order.push nil
                     end
                   else
                     Thread.pass while Order.empty?
@@ -511,8 +522,13 @@ describe InThreads do
         collect map
         group_by max_by min_by minmax_by sort_by
         sum uniq
+        to_h to_set
       ].each do |method|
+        next if method == 'to_h' && InThreads::INCOMPATIBLE_METHODS.include?(:to_h)
+
         describe_enum_method method do
+          let(:value_proc){ proc{ [rand] * 2 } } if method == 'to_h'
+
           it 'returns same result with threads' do
             expect(enum.in_threads.send(method, &:compute)).
               to eq(enum.send(method, &:compute))
@@ -718,6 +734,34 @@ describe InThreads do
           end
         end
       end
+
+      describe_enum_method :each_with_object do
+        let(:block) do
+          proc do |o, h|
+            v = o.compute
+            mutex.synchronize{ h[v] = true }
+          end
+        end
+
+        it 'returns same result with threads' do
+          expect(enum.in_threads.each_with_object({}, &block)).
+            to eq(enum.each_with_object({}, &block))
+        end
+
+        it 'yields same objects' do
+          yielded = []
+          enum.in_threads.each_with_object({}) do |o, _h|
+            mutex.synchronize{ yielded << o }
+            o.compute
+          end
+          expect(yielded).to match_array(items)
+        end
+
+        it 'runs faster with threads', :flaky do
+          expect{ enum.in_threads.each_with_object({}, &block) }.
+            to be_faster_than{ enum.each_with_object({}, &block) }
+        end
+      end
     end
 
     context 'unthreaded' do
@@ -776,14 +820,6 @@ describe InThreads do
         end
       end
 
-      describe_enum_method :each_with_object do
-        let(:block){ proc{ |o, h| h[o] = true } }
-
-        it 'returns same result' do
-          expect(enum.in_threads.each_with_object({}, &block)).to eq(enum.each_with_object({}, &block))
-        end
-      end
-
       %w[chunk slice_before slice_after].each do |method|
         describe_enum_method method do
           it 'returns same result' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: in_threads
 version: !ruby/object:Gem::Version
-  version: 1.5.4
+  version: 1.6.0
 platform: ruby
 authors:
 - Ivan Kuchin
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-12-26 00:00:00.000000000 Z
+date: 2022-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -44,29 +44,44 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.59'
+        version: '1.22'
     - - "!="
       - !ruby/object:Gem::Version
-        version: 0.78.0
+        version: 1.22.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.59'
+        version: '1.22'
     - - "!="
       - !ruby/object:Gem::Version
-        version: 0.78.0
-description: 
-email: 
+        version: 1.22.2
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description:
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/check.yml"
+- ".github/workflows/rubocop.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.markdown
 - Gemfile
 - LICENSE.txt
@@ -80,9 +95,9 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/toy/in_threads/issues
   changelog_uri: https://github.com/toy/in_threads/blob/master/CHANGELOG.markdown
-  documentation_uri: https://www.rubydoc.info/gems/in_threads/1.5.4
+  documentation_uri: https://www.rubydoc.info/gems/in_threads/1.6.0
   source_code_uri: https://github.com/toy/in_threads
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -97,8 +112,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.3.5
+signing_key:
 specification_version: 4
 summary: Run all possible enumerable methods in concurrent/parallel threads
 test_files:

data/.travis.yml

@@ -1,33 +0,0 @@
-sudo: false
-dist: trusty
-language: ruby
-rvm:
-  - '1.8.7-p374'
-  - '1.9.3-p551'
-  - '2.0.0-p648'
-  - '2.1.10'
-  - '2.2.10'
-  - '2.3.8'
-  - '2.4.9'
-  - '2.5.7'
-  - '2.6.5'
-  - '2.7.0'
-  - 'ruby-head'
-  - 'jruby-9.1.17.0'
-  - 'jruby-9.2.7.0'
-before_install:
-  - gem install rubygems-update || gem install rubygems-update --version '< 3'
-  - gem update --system
-  - gem install bundler || gem install bundler --version '< 2'
-script: bundle exec rspec
-matrix:
-  include:
-    - env: RUBOCOP=✓
-      rvm: '2.6.5'
-      script: bundle exec rubocop
-    - env: CHECK_RUBIES=✓
-      rvm: '2.6.5'
-      script: bundle exec travis_check_rubies
-  allow_failures:
-    - rvm: 'ruby-head'
-    - rvm: 'jruby-9.2.7.0'