standard-procedure-async 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c712b9a4a30138eb2c834422df444d22da7fbb16da26de1c1ec81db7cf15985
-  data.tar.gz: 71dbabb9e071adb19146e17a275daaad05b0c9f242843b3d957908087f604a91
+  metadata.gz: 4936777d02c93a9195506f2807a9ecfbc80ccbfd4e50e9af6477456742efaf9a
+  data.tar.gz: 1a094f5fbe3e205204a1425eeb798cdfd075b497d2e9afb4e64b132a040964f6
 SHA512:
-  metadata.gz: d84213a0def468819fbd0f63bc42d10a483b13790e1e3ee632b72d63d2d2d9438df2c7a3a586b6acbedba07ceaf8794b999c33cd53df4fb166cf0f5e5f998289
-  data.tar.gz: 3972be625613fa325b92273d594f0e9c213fa4675e03181c39d60e334251f3fea7e6d369a9335dc639994aa182de8ead6785be04d011d21186c56b08badfc9fb
+  metadata.gz: 9bacc126f5ecde4c54d9caf9d25cc73ccce1aa683d39ed4936ed4504791ab526af630511b4522c9fad7d699e55f5b8c9139a6d5e5b763fd0d550f386a4fafdf9
+  data.tar.gz: 45aceadf0e436aee7da11a21f2958953caa5e6de88938faac63340384554da0afae44230629a184560ecf4c700d93dab6d7c9d88c4b63d71d97726be43398423

data/.nova/Configuration.json

@@ -0,0 +1,3 @@
+{
+  "tommasonegri.solargraph.internals.server.error" : true
+}

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    standard-procedure-async (0.1.2)
+    standard-procedure-async (0.2.0)
       concurrent-ruby (>= 1.0)
 
 GEM
@@ -119,6 +119,7 @@ GEM
 
 PLATFORMS
   arm64-darwin-22
+  arm64-darwin-23
   x86_64-linux
 
 DEPENDENCIES

data/LICENSE.txt

@@ -1,21 +1,165 @@
-The MIT License (MIT)
-
-Copyright (c) 2023 Rahoul Baruah
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+				   GNU LESSER GENERAL PUBLIC LICENSE
+					   Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+	   0) Convey the Minimal Corresponding Source under the terms of this
+	   License, and the Corresponding Application Code in a form
+	   suitable for, and under terms that permit, the user to
+	   recombine or relink the Application with a modified version of
+	   the Linked Version to produce a modified Combined Work, in the
+	   manner specified by section 6 of the GNU GPL for conveying
+	   Corresponding Source.
+
+	   1) Use a suitable shared library mechanism for linking with the
+	   Library.  A suitable mechanism is one that (a) uses at run time
+	   a copy of the Library already present on the user's computer
+	   system, and (b) will operate properly with a modified version
+	   of the Library that is interface-compatible with the Linked
+	   Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -75,14 +75,18 @@ end
 
 # Getting started
 puts @my_object.report_status # => internal message object
-puts @my_object.report_status.value # => :idle
+@my_object.report_status.then do |value|
+  puts value # => :idle
+end
 puts await { @my_object.report_status } # => :idle
 puts await { @my_object.greet } # => "Hello George"
+
 # Do some actual work
 await { @my_object.rename "Ringo" }
 puts await { @my_object.greet } # => "Hello Ringo"
 @my_object.rename "Paul" # Note: we didn't use await here - we'll talk about that later
 puts await { @my_object.greet } # => "Hello Paul"
+
 # Do something a bit more complex
 @initial_status = @my_object.do_some_long_running_task 
 puts await { @initial_status } # => :in_progress
@@ -99,19 +103,32 @@ When defining `MyObject`, we use `async` instead of `def` for each method.  For
 
 ### Awaiting the results from those methods
 
-The asynchronous wrapper always returns a internal message object that contains a [Concurrent::MVar](https://ruby-concurrency.github.io/concurrent-ruby/master/Concurrent/MVar.html).  The MVar is empty until the actor has completed its work but if you need the return value from the method, there are two ways to access it.    
+The asynchronous wrapper always returns a internal message object that contains a [Concurrent::MVar](https://ruby-concurrency.github.io/concurrent-ruby/master/Concurrent/MVar.html).  The MVar is empty until the actor has completed its work but if you need the return value from the method, there are a few ways to access it.    
+
+You can call `value` on the returned message.  For convenience, `value` is also aliased as `get` and `await`.  
+
+```ruby
+  # The following calls are all equivalent
+  @my_object.report_status.value 
+  @my_object.report_status.get 
+  @my_object.report_status.await
+```
 
-You can call `value` on the returned message.  
+You can use the global `await` method.
 
-Or you can use the `await` method (which is just a fancy wrapper around `value`).  
+```ruby 
+  puts await { @my_object.report_status }
+```
 
-In both cases the calling thread will block until the value is returned.  
+Or you can use the [promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)-style resolution. 
 
-In the example above, you can see how this works. 
+```ruby
+  @my_object.report_status.then do |value|
+    puts value 
+  end
+```
 
-- `puts @my_object.report_status` returns the internal message object itself, not any meaningful information.  
-- `puts @my_object.report_status.value` blocks until the `report_status` method has completed and gives you the return value.
-- `puts await { @my_object.report_status }` is just a fancier (and potentially more readable and explicit) way of doing the same thing
+In all cases the calling thread will block until the value is returned (or the `then` clause is triggered).  
 
 ### The strict sequencing of asynchronous calls
 
@@ -148,6 +165,22 @@ This queueing has an important implication.
 If you are within an actor class, you can happily call async methods on other objects and `await` the results - because each actor has its own independent queue.  But if you are calling your own methods, you must **never** call `await` (or call `value` on the returned message object).  
 
 Picture this: 
+
+```ruby 
+class ClassThatWillDeadlock 
+  include StandardProcedure::Async::Actor 
+
+  async :start_processing do 
+    do_some_complicated_calculation.value 
+  end
+  
+  async :do_some_complicated_calculation do 
+    sleep 1 
+    2 + 2   
+  end
+end
+```
+
 - Your actor has two `async` methods - `start_processing` and `do_complicated_calculation`
 - The main thread calls `start_processing` - so a message gets added to the head of the queue.  
 - The actor's internal thread starts working on the message at the head of the queue, and `_start_processing` (the actual implementation) is called.
@@ -158,6 +191,22 @@ Picture this:
 
 To avoid this, if you ever need the return value from an internal `async` method, always call the implementation method:  `_do_complicated_calculation` instead of `do_complicated_calculation`.  This does not put anything on the queue and proceeds as a normal method call.  
 
+```ruby 
+class ClassThatWillNotDeadlock 
+  include StandardProcedure::Async::Actor 
+
+  async :start_processing do 
+    _do_some_complicated_calculation
+  end
+  
+  async :do_some_complicated_calculation do 
+    sleep 1 
+    2 + 2   
+  end
+end
+```
+
+
 As a fail-safe, any calls to `value` will also time-out after 30 seconds, returning Concurrent::MVar::TIMEOUT.  If you need to override the timeout value you can use `message.value(timeout: value_in_seconds)`.  
 
 ### The rules of using actors
@@ -200,10 +249,11 @@ Or install it yourself as:
 ## Development
 
 Coming soon
+
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/standard-procedure-async.
+Bug reports and pull requests are welcome on GitHub at https://github.com/standard-procedure/async.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [GNU Lesser General Public Licence](https://www.gnu.org/licenses/lgpl-3.0.txt).  Paraphrased, this means you can use this library in your applications, but you must make give prominent notice that you are using this code, under this licence, and you must make the source to this library available if the software is distributed.  Any changes you make _to this library_ must also be released under the LGPL and made available if the software is distributed.  The licensing for your own code (that does not amend this library) is unaffected.  

data/checksums/standard-procedure-async-0.2.0.gem.sha512

@@ -0,0 +1 @@
+e9ecad84981421f13a69b6fa77964a1331488ddeb9581dcb2381d7daa4f6ae712f4a33edd1291b50fb70a49896a14b9b84dc6df4001a5c834ed561173685ba30

data/lib/standard_procedure/async/actor.rb

@@ -51,10 +51,17 @@ module StandardProcedure::Async
       end
     end
 
+    # nodoc:
     class Message < Concurrent::ImmutableStruct.new(:target, :name, :args, :block, :result)
       def value(timeout: 30)
         result.take(timeout)
       end
+      alias_method :get, :value
+      alias_method :await, :value
+
+      def then &block
+        block&.call value
+      end
 
       def call
         result.put target.send(name, *args, &block)

data/lib/standard_procedure/async/version.rb

@@ -2,6 +2,6 @@
 
 module StandardProcedure
   module Async
-    VERSION = "0.1.2"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: standard-procedure-async
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Rahoul Baruah
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-31 00:00:00.000000000 Z
+date: 2023-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -74,6 +74,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".nova/Configuration.json"
 - ".rspec"
 - ".standard.yml"
 - CHANGELOG.md
@@ -82,6 +83,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- checksums/standard-procedure-async-0.2.0.gem.sha512
 - lib/standard_procedure/async.rb
 - lib/standard_procedure/async/actor.rb
 - lib/standard_procedure/async/await.rb
@@ -114,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.12
+rubygems_version: 3.4.20
 signing_key:
 specification_version: 4
 summary: A simple wrapper around Concurrent::Future to make concurrent-ruby Rails-friendly.