opal-async 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 050f56171be0bacefeff4c68f9ba1e517b81adf3017b4013dcbeff44e8bbc331
-  data.tar.gz: 242811c68a22d384c2b6ce5e916fef95b729460b1dfab5a13e7891405c16d0e7
+  metadata.gz: e4ac70e28d27ce5551acbba060dba2956e791e33ab7788673ffd6ebfc08fc35f
+  data.tar.gz: c02be17a79bab91865aa0898afc97a024376bf0c7686dd85854193fd4174516a
 SHA512:
-  metadata.gz: 1265a3c27ccbbe5e9a78f2f734a16697b5d4cff3cfe7294c071b04c246f5530f7cca397592ff76683f4bfbc3682116d6c335bc4ca51dd4382b722cdd85ffbe2d
-  data.tar.gz: c260fc81573eea00cd1be33410655dbbbffec077d88fad31bb9f7f1c4941f04351dbaa1bb385e45e6fda67e0d4ee41d1f68a49f3c55e0639480e76383cddd01b
+  metadata.gz: 1cd290ff3f7b6173e7d6cf6440bca1819e53294a2a7859a016bf0e2632cc7b43b5a18f5563d21be0b755e7018cf5449f5f1e6e18a3217a44d950d580cd4eac57
+  data.tar.gz: 0bc9487d71ce6343d0b708c56c6878bb445390db5043a5972221723ffec12059286f03486424f0b480441a46bb4d9af0407028444f0a119a2dd3b566031ba7e7

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change Log
 
+## 1.2.0
+
+- Asynchronous `Array#cycle` method that is web browser event loop friendly
+
 ## 1.1.1
 
 - Added `Thread` class extension to enable using `Async::Task` as `Thread` in Opal

data/README.md

@@ -5,7 +5,7 @@
 
 Add this line to your application's Gemfile:
 
-    gem 'opal-async', '~> 1.1.1'
+    gem 'opal-async', '~> 1.2.0'
 
 And then execute:
 
@@ -161,21 +161,51 @@ Async::Interval.new 3000 do
 end
 ```
 
-### Thread
+### Ruby Extensions
+
+[opal-async](https://rubygems.org/gems/opal-async) ships with some Opal Ruby extensions that enhance Ruby classes with asynchronous capabilities.
+
+You may activate all the Ruby extensions via this require statement:
+
+```ruby
+require 'async/ext'
+```
+
+#### Thread
 
 You may use the `Async::Task` class as a `Thread` class in Opal to perform asynchronous work with an extra `require` statement.
 
 ```ruby
-require 'async/ext/thread'
+require 'async/ext/thread' # not needed if you called `require 'async/ext'`
 
 Thread.new do
   puts "hello world"
 end
 ```
 
+#### Array
+
+`Array#cycle` has been amended to work asynchronously via `Async::Task` when triggered inside another `Async::Task` (auto-detects it)
+
+This makes it not block the web browser event loop, thus allowing other tasks to update the DOM unhindered while `Array#cycle` is running.
+
+```ruby
+require 'async/ext/array' # not needed if you called `require 'async/ext'`
+
+Async::Task.new do
+  [1,2,3,4].cycle do |n| 
+    puts n
+    Async::Task.new do
+      # make a DOM update
+    end
+    sleep(1) # this does not block the event loop since it is transparently happening inside an Async::Task
+  end
+end
+```
+
 ## In The Wild
 
-opal-async is currently used in the following projects:
+opal-async is currently used in:
 - [Glimmer DSL for Opal](https://github.com/AndyObtiva/glimmer-dsl-opal)
 
 ## Change Log

data/VERSION

@@ -1 +1 @@
-1.1.1
+1.2.0

data/opal/async/ext.rb

@@ -0,0 +1,2 @@
+require 'async/ext/thread'
+require 'async/ext/array'

data/opal/async/ext/array.rb

@@ -0,0 +1,25 @@
+require 'async/task'
+
+class Array
+  alias cycle_without_opal_async cycle
+  def cycle(n=nil, &block)
+    if Async::Task.started? && block_given?
+      array = self * n unless n.nil?
+      index = 0
+      looper = lambda do
+        if n.nil?
+          block.call(self[index])
+          index += 1
+          index = index % self.size
+          Async::Task.new(&looper)
+        else
+          block.call(array.shift)
+          Async::Task.new(&looper) unless array.empty?
+        end
+      end
+      Async::Task.new(&looper)
+    else
+      cycle_without_opal_async(n, &block)
+    end
+  end
+end

data/opal/async/task.rb

@@ -1,5 +1,23 @@
 module Async
   class Task
+    class << self
+      # returns general status of whether a task is running. 
+      # Useful to code running in the task block to determine if it is running 
+      # as part of a task or not and take special actions accordingly.
+      def started?
+        @@started = false unless defined? :@@started
+        @@started
+      end
+      
+      def start
+        @@started = true
+      end
+      
+      def stop
+        @@started = false
+      end
+    end
+  
     attr_accessor :delay, :times
     def initialize options={}, &block
       @options = options
@@ -15,6 +33,7 @@ module Async
       @delay = @options[:delay] || 0
       @times = @options[:times]
       @proc = Proc.new do
+        self.class.start
         if @times
           if @times.is_a?(Fixnum)
             @block.call(@countup, @countdown)
@@ -34,6 +53,7 @@ module Async
           @block.call
           @stopped = true
         end
+        self.class.stop
       end
     end
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opal-async
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Ravenstine
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-22 00:00:00.000000000 Z
+date: 2020-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opal
@@ -121,6 +121,8 @@ files:
 - opal/async.rb
 - opal/async/countdown.rb
 - opal/async/enumerator.rb
+- opal/async/ext.rb
+- opal/async/ext/array.rb
 - opal/async/ext/thread.rb
 - opal/async/interval.rb
 - opal/async/task.rb
@@ -150,7 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Provides non-blocking tasks and enumerators for Opal.