concurrent_rails 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 781c36a372e489c0bf0aa7f1d0ea027fd4a39f79f9ad00f6ba94d32a00cb6d49
-  data.tar.gz: 9da7d081f4a638b7b05bc8ead8abd1c733673b15cb81a6d73c43b5b958d1e7a3
+  metadata.gz: afa4c6f568f01ea4ada14fabc78e2e47b7c9a8c3f7ddaa3f3cbc8d3c39dad949
+  data.tar.gz: cc4165e43a1a6a48fc0dd2bb5b6154257af0ab4d8c32a3620c61b6425e3f32c1
 SHA512:
-  metadata.gz: 8f2c1899c386ad3ed53bb634dbaa5a48c609126cbec0baf13b763e469008e65da4ef05d438c317abc280ba8d97da7988940241f2d014f0dbf50e82aa241665fd
-  data.tar.gz: 5508edb264cc1fbaa55f85aeaeeba565b018e32306ff0e300223159dd804c7b979fd10d2ec19bdd131bbf13d246e22b24d978a7d190ce8a5d2f4a75f98926e96
+  metadata.gz: f68e51f1d5fdc986e4fe70a16beac361f77334727da261ae545dc725f2d9424c9d9b0df7755e7b1e8fb22b010d03db253e1c5206217e13640b246c60c9330177
+  data.tar.gz: d20462ad8cd6a4b72c86e36654441b53b614e0c98684f4c087d5b7fff251e7dbe8f2e4c1627df623d2e332da8c6017b941d0d922160f78c27023ed942f3adf4f

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` 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 { sleep(5); 42 }
+=> #<ConcurrentRails::Promises:0x00007fe92ea9ff28 @future_instance=#<Con...
+
+irb(main):003:0> future.state
+=> :pending
+
+# After future is processed
+irb(main):004:0> future.state
+=> :fulfilled
+
+irb(main):005: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):006:0> future = ConcurrentRails::Promises.future { 42 }.then { |v| v * 2 }
+=> #<ConcurrentRails::Promises:0x00007fe92eba3460 @future_instance=#...
+irb(main):007: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.3'
 ```
 
 And then execute:

data/lib/concurrent_rails.rb

@@ -4,6 +4,7 @@ require 'concurrent_rails/version'
 require 'concurrent_rails/railtie'
 require 'concurrent_rails/future'
 require 'concurrent_rails/multi'
+require 'concurrent_rails/promises'
 
 module ConcurrentRails
 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

data/lib/concurrent_rails/promises.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module ConcurrentRails
+  class Promises
+    include Concurrent::Promises::FactoryMethods
+    extend Forwardable
+
+    def self.future(*args, &block)
+      new.run_on_rails(*args, &block)
+    end
+
+    def then(*args, &block)
+      @future_instance = Rails.application.executor.wrap do
+        future_instance.then(*args, &block)
+      end
+
+      self
+    end
+
+    %i[value value!].each do |method_name|
+      define_method method_name do
+        Rails.application.executor.wrap do
+          result = nil
+
+          ActiveSupport::Dependencies.interlock.permit_concurrent_loads do
+            result = future_instance.__send__(method_name)
+          end
+
+          result
+        end
+      end
+    end
+
+    def run_on_rails(*args, &block)
+      @future_instance = Rails.application.executor.wrap do
+        future(args, &block)
+      end
+
+      self
+    end
+
+    def_delegators :@future_instance, :state, :reason, :rejected?, :complete?
+
+    private
+
+    attr_reader :task, :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.3'
 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.3
 platform: ruby
 authors:
-- Luiz Eduardo
+- Luiz Eduardo Kowalski
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-18 00:00:00.000000000 Z
+date: 2021-04-19 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/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:
   - - ">="