concurrent_rails 0.1.2 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 781c36a372e489c0bf0aa7f1d0ea027fd4a39f79f9ad00f6ba94d32a00cb6d49
-  data.tar.gz: 9da7d081f4a638b7b05bc8ead8abd1c733673b15cb81a6d73c43b5b958d1e7a3
+  metadata.gz: fe2277deed1f15f3c47a332667db0b85bbfb0d39d58bcb6539fa0d15d843c55d
+  data.tar.gz: 0e347f69da65b60fcbdb63a04cdcb3bac782ba01b6e543db93428ff4c2bdbdc0
 SHA512:
-  metadata.gz: 8f2c1899c386ad3ed53bb634dbaa5a48c609126cbec0baf13b763e469008e65da4ef05d438c317abc280ba8d97da7988940241f2d014f0dbf50e82aa241665fd
-  data.tar.gz: 5508edb264cc1fbaa55f85aeaeeba565b018e32306ff0e300223159dd804c7b979fd10d2ec19bdd131bbf13d246e22b24d978a7d190ce8a5d2f4a75f98926e96
+  metadata.gz: '079c165494e1eea8ae9c98fe89031c87408808527a3f90eda3c5c5d87598bfb5932b0285acaa99d4e5e714a1012af3676bc16fc9b5929268ff26640b90f4b191'
+  data.tar.gz: 97944d3f3db134d08eb894f6f3211a705cb080ec4d4ec331657c94940fd08a08c4f1f46859d430f3c2e5097a1cc54d7de322e9f39a0fcc48de78d49982cd26e8

data/README.md

@@ -9,11 +9,40 @@ The goal of this gem is to provide a simple library that allows the developer to
 
 ## Usage
 
-This library provides two classes that will help you run tasks in parallel: `ConcurrentRails::Future` and `ConcurrentRails::Multi`
+This library provides three classes that will help you run tasks in parallel: `ConcurrentRails::Promises`,  `ConcurrentRails::Future` ([in process of being deprecated by concurrent-ruby](https://github.com/ruby-concurrency/concurrent-ruby#deprecated)) and `ConcurrentRails::Multi`
+
+### Promises
+
+`Promises` is the recommended way from `concurrent-ruby` to create `Future`s as `Concurrent::Future` will be deprecated at some point.
+Similar to other classes, all you have to do is call `.future` helper and pass a block:
+
+```ruby
+irb(main):001:0> future = ConcurrentRails::Promises.future(5) { |v| sleep(v); 42 }
+=> #<ConcurrentRails::Promises:0x00007fed68db66b0 @future_instance=#<Concurrent::Promises::Future
+
+irb(main):002:0> future.state
+=> :pending
+
+# After the process slept for 5 seconds
+irb(main):003:0> future.state
+=> :fulfilled
+
+irb(main):004:0> future.value
+=> 42
+```
+
+The benefit of `Promises` over a pure `Future` class is that you can chain futures without blocking the main thread.
+
+```ruby
+irb(main):001:0> future = ConcurrentRails::Promises.future { 42 }.then { |v| v * 2 }
+=> #<ConcurrentRails::Promises:0x00007fe92eba3460 @future_instance=#...
+irb(main):002:0> future.value
+=> 84
+```
 
 ### Future
 
-`ConcurrentRails::Future` will execute your code in a separated thread and you can check the progress of it whenever you need. When the task is ready, you can access the result with `#result` function:
+`ConcurrentRails::Future` will execute your code in a separated thread and you can check the progress of it whenever you need it. When the task is ready, you can access the result with `#result` function:
 
 ```ruby
 irb(main):001:0> future = ConcurrentRails::Future.new do
@@ -114,7 +143,7 @@ For more information on how Futures work and how Rails handle multithread check
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'concurrent_rails'
+gem 'concurrent_rails', '~> 0.1.7'
 ```
 
 And then execute:

data/lib/concurrent_rails.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
-require 'concurrent_rails/version'
-require 'concurrent_rails/railtie'
 require 'concurrent_rails/future'
 require 'concurrent_rails/multi'
+require 'concurrent_rails/promises'
+require 'concurrent_rails/railtie'
+require 'concurrent_rails/version'
 
 module ConcurrentRails
 end

data/lib/concurrent_rails/future.rb

@@ -4,8 +4,7 @@ module ConcurrentRails
   class Future
     extend Forwardable
 
-    def initialize(executor: :io, &block)
-      @task     = block
+    def initialize(executor: :fast, &block)
       @executor = executor
       @future   = run_on_rails(block)
     end
@@ -16,15 +15,13 @@ module ConcurrentRails
       self
     end
 
-    def value
-      Rails.application.executor.wrap do
-        result = nil
-
-        ActiveSupport::Dependencies.interlock.permit_concurrent_loads do
-          result = future.value
+    %i[value value!].each do |method_name|
+      define_method method_name do
+        Rails.application.executor.wrap do
+          ActiveSupport::Dependencies.interlock.permit_concurrent_loads do
+            future.__send__(method_name)
+          end
         end
-
-        result
       end
     end
 
@@ -40,6 +37,6 @@ module ConcurrentRails
       end
     end
 
-    attr_reader :executor, :task, :future
+    attr_reader :executor, :future
   end
 end

data/lib/concurrent_rails/multi.rb

@@ -4,7 +4,7 @@ module ConcurrentRails
   class Multi
     def self.enqueue(*actions, executor: :io)
       unless actions.all? { |action| action.is_a?(Proc) }
-        raise ArgumentError, '#enqueue accepts `Proc`s only' 
+        raise ArgumentError, '#enqueue accepts `Proc`s only'
       end
 
       new(actions, executor).enqueue
@@ -30,6 +30,10 @@ module ConcurrentRails
       futures.map(&:value)
     end
 
+    def compute!
+      futures.map(&:value!)
+    end
+
     def complete?
       futures.all?(&:complete?)
     end

data/lib/concurrent_rails/promises.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module ConcurrentRails
+  class Promises
+    extend Forwardable
+    include Concurrent::Promises::FactoryMethods
+
+    class << self
+      def future(*args, &task)
+        future_on(:fast, *args, &task)
+      end
+
+      def future_on(executor, *args, &task)
+        new.with_rails(executor, *args, &task)
+      end
+    end
+
+    def then(*args, &task)
+      @future_instance = Rails.application.executor.wrap do
+        future_instance.then(*args, &task)
+      end
+
+      self
+    end
+
+    def chain(*args, &task)
+      Rails.application.executor.wrap do
+        future_instance.chain(*args, &task)
+      end
+
+      self
+    end
+
+    %i[value value!].each do |method_name|
+      define_method method_name do |timeout = nil, timeout_value = nil|
+        Rails.application.executor.wrap do
+          ActiveSupport::Dependencies.interlock.permit_concurrent_loads do
+            future_instance.__send__(method_name, timeout, timeout_value)
+          end
+        end
+      end
+    end
+
+    def with_rails(executor, *args, &task)
+      @future_instance = Rails.application.executor.wrap do
+        future_on(executor, *args, &task)
+      end
+
+      self
+    end
+
+    def_delegators :@future_instance, :state, :reason, :rejected?, :resolved?
+
+    private
+
+    attr_reader :future_instance
+  end
+end

data/lib/concurrent_rails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ConcurrentRails
-  VERSION = '0.1.2'
+  VERSION = '0.1.7'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: concurrent_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.7
 platform: ruby
 authors:
-- Luiz Eduardo
+- Luiz Eduardo Kowalski
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-18 00:00:00.000000000 Z
+date: 2021-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -65,16 +65,17 @@ files:
 - lib/concurrent_rails.rb
 - lib/concurrent_rails/future.rb
 - lib/concurrent_rails/multi.rb
+- lib/concurrent_rails/promises.rb
 - lib/concurrent_rails/railtie.rb
 - lib/concurrent_rails/version.rb
 - lib/tasks/concurrent_rails_tasks.rake
-homepage: https://github.com/luizkowalski/concurrent-rails
+homepage: https://github.com/luizkowalski/concurrent_rails
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/luizkowalski/concurrent-rails
-  source_code_uri: https://github.com/luizkowalski/concurrent-rails
-  changelog_uri: https://github.com/luizkowalski/concurrent-rails/CHANGELOG
+  homepage_uri: https://github.com/luizkowalski/concurrent_rails
+  source_code_uri: https://github.com/luizkowalski/concurrent_rails
+  changelog_uri: https://github.com/luizkowalski/concurrent_rails/blob/master/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -83,7 +84,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="