concurrent_executor 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8f1975dab1c7cd6e9f3d28d145d6dbb9dbe56b9e2cdffbded41d1c429abe9b6c
+  data.tar.gz: b11700ed8f4e9fe790840b9381949b9917ba2433b2c0919dac981c2d7eaa4622
+SHA512:
+  metadata.gz: 2b5c684a7a533597d6948e64b07cd85fb22d95c8b05b46fbe2fa3c542abba1db2b677d6c7902bd2e4c9514dd863195e847234476bdae89789404781fadd2120b
+  data.tar.gz: a4da54f9daa7366c557ffde0731334abaf3970af134a34c45a6d5e8fc0b5d68a52821126990ea41989601b90b294cda94665058066532c598e6e18e642baba52

data/.gitignore

@@ -0,0 +1,3 @@
+
+.rspec_status
+coverage

data/.rubocop-https---raw-githubusercontent-com-GetTerminus-ruby-shared-configs-master--rubocop-yml

@@ -0,0 +1,91 @@
+AllCops:
+  Exclude:
+    - Makefile
+    - vendor/**/*
+    - bin/**/*
+
+Layout/EndOfLine:
+  Enabled: false
+
+Style/DateTime:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Lint/Debugger:
+  Enabled: true
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  EnforcedStyle: always
+
+Style/TrailingCommaInHashLiteral:
+  Enabled: true
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArrayLiteral:
+  Enabled: true
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArguments:
+  Enabled: true
+  EnforcedStyleForMultiline: comma
+
+Lint/UnusedMethodArgument:
+  AllowUnusedKeywordArguments: true
+
+Layout/LineLength:
+  Enabled: true
+  Max: 280
+  IgnoreCopDirectives: true
+  IgnoredPatterns: ['\A#', '\A\s*sig { .* }\Z']
+  Exclude:
+    - '**/*_pb.rb'
+
+Metrics/AbcSize:
+  Enabled: true
+  Max: 48
+
+Metrics/CyclomaticComplexity:
+  Max: 9
+
+Metrics/MethodLength:
+  Enabled: true
+  Max: 32
+
+Layout/ParameterAlignment:
+  Enabled: true
+  EnforcedStyle: with_fixed_indentation
+
+Naming/MethodParameterName:
+  Enabled: true
+  AllowedNames: ['io', 'id', 'to', 'by', 'on', 'in', 'at', '_'] # Defaults + _
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: true
+  EnforcedStyle: indented
+
+Style/ParallelAssignment:
+  Enabled: true
+
+Metrics/ClassLength:
+  Max: 240
+
+Metrics/BlockLength:
+  Max: 30
+  Exclude:
+    - spec/**/*.rb
+    - '**/*_pb.rb'
+
+Metrics/ParameterLists:
+  Max: 6
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - spec/**/*.rb
+
+Style/BlockDelimiters:
+  Enabled: true
+  Exclude:
+    - spec/**/*

data/.rubocop.yml

@@ -0,0 +1,8 @@
+inherit_from: https://raw.githubusercontent.com/GetTerminus/ruby_shared_configs/master/.rubocop.yml
+
+AllCops:
+  Exclude:
+    - Makefile
+    - vendor/**/*
+    - bin/*
+    - Guardfile

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in concurrent_executor.gemspec
+gemspec
+
+gem 'pry'

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    concurrent_executor (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    codecov (0.1.16)
+      json
+      simplecov
+      url
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    jaro_winkler (1.5.4)
+    json (2.3.0)
+    method_source (1.0.0)
+    parallel (1.19.1)
+    parser (2.7.0.2)
+      ast (~> 2.4.0)
+    pry (0.13.0)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    rubocop (0.80.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    simplecov (0.18.5)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.2)
+    unicode-display_width (1.6.1)
+    url (0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  codecov
+  concurrent_executor!
+  pry
+  rake (~> 12)
+  rspec (~> 3)
+  rubocop
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -0,0 +1,29 @@
+# concurrent_executor
+Eat your enumerables in threads and fast!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'concurrent_executer'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install concurrent_executer
+
+## Usage
+```ruby
+require 'concurrent_executer'
+
+some_enumerable = [1, 2, 3, 4]
+ConcurrentExecutor.consume_enumerable(some_enumerable) do |num|
+  # do something to each item
+end
+```
+

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "concurrent_executor"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/concurrent_executor.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative 'lib/concurrent_executor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'concurrent_executor'
+  spec.version       = ConcurrentExecutorVersion::VERSION
+  spec.authors       = ['Brian Malinconico']
+  spec.email         = ['bmalinconico@terminus.com']
+
+  spec.summary       = 'Execute things concurrently'
+  spec.description   = 'Executes things concurrently'
+  spec.homepage      = 'https://github.com/GetTerminus/concurrent_executor'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  spec.metadata['allowed_push_host'] = 'https://www.rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/GetTerminus/concurrent_executor'
+  spec.metadata['changelog_uri'] = 'https://github.com/GetTerminus/concurrent_executor/blob/master/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'codecov'
+  spec.add_development_dependency 'rake', '~> 12'
+  spec.add_development_dependency 'rspec', '~> 3'
+  spec.add_development_dependency 'rubocop'
+end

data/lib/concurrent_executor.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+class ConcurrentExecutor
+  MAX_NUMBER_OF_THREADS = 100
+  attr_accessor :threads, :queue, :number_of_threads, :executor, :logger
+
+  def initialize(number_of_threads: 4, queue_size: 100, executor: nil)
+    raise 'queue must be sized' unless queue_size
+    raise 'number of threads must be > 0' unless (0..MAX_NUMBER_OF_THREADS).cover?(number_of_threads)
+
+    @errors = Queue.new
+    @errored = false
+
+    self.logger = if defined?(Rails)
+                    Rails.logger
+                  elsif defined?(App) && App.respond_to?(:logger)
+                    App.logger
+                  else
+                    Logger.new(STDERR)
+                  end
+
+    self.threads = []
+    self.executor = executor
+    self.queue = SizedQueue.new(queue_size)
+    self.number_of_threads = number_of_threads
+
+    start_threads
+  end
+
+  def consume_enumerable(enum)
+    enum.each(&queue.method(:push))
+  rescue ClosedQueueError
+    self.class.logger.warn 'Queue closed during iteration'
+  end
+
+  class << self
+    def consume_enumerable(enum, **args, &blk)
+      executor = new(args.merge(executor: blk))
+      executor.consume_enumerable(enum)
+    rescue StandardError => e
+      puts e
+      raise e
+    ensure
+      executor&.graceful_shutdown
+    end
+  end
+
+  def graceful_shutdown
+    queue.close
+    threads.map(&:join)
+    raise @errors.pop(false) unless @errors.empty?
+  end
+
+  private
+
+  def start_threads
+    number_of_threads.times do
+      threads << if Thread.respond_to?(:new_traced)
+                   Thread.new_traced(&method(:work_loop))
+                 else
+                   Thread.new(&method(:work_loop))
+                 end
+    end
+  end
+
+  def work_loop
+    while (work_item = queue.pop)
+      begin
+        executor.call(work_item)
+      rescue StandardError => e
+        @errors << e
+        queue.clear
+        queue.close
+      end
+    end
+  end
+end

data/lib/concurrent_executor/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ConcurrentExecutorVersion
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: concurrent_executor
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Brian Malinconico
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Executes things concurrently
+email:
+- bmalinconico@terminus.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop-https---raw-githubusercontent-com-GetTerminus-ruby-shared-configs-master--rubocop-yml"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- concurrent_executor.gemspec
+- lib/concurrent_executor.rb
+- lib/concurrent_executor/version.rb
+homepage: https://github.com/GetTerminus/concurrent_executor
+licenses: []
+metadata:
+  allowed_push_host: https://www.rubygems.org
+  homepage_uri: https://github.com/GetTerminus/concurrent_executor
+  source_code_uri: https://github.com/GetTerminus/concurrent_executor
+  changelog_uri: https://github.com/GetTerminus/concurrent_executor/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Execute things concurrently
+test_files: []