opal-async 1.3.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc5f4a757a39dabc8a7bc7efcb87631a7dd6809f0fd7da29b5b40ec23d436ea8
-  data.tar.gz: b7c60f66044d9e0f49c2b0a49c18046bccfbd89364fbbdb18d62323cf5351991
+  metadata.gz: 6a112b35fc92cf3947ab6225bb32afa7a5e65bd4758a2f644a0d62b74a5ba993
+  data.tar.gz: 142670ab07eb81daf6246d4cf0a677c3d441e0fbafc458709f50c5eed4ac3a05
 SHA512:
-  metadata.gz: bc8669beff060d5f91ffad0b6f1ee68d4708124bb5be87d6759eb67ee7c84211c9a6c6a624a73c1eca170ccb305817d13f6472c9c9986c5488b4afbf918929c1
-  data.tar.gz: cf3fe071bb8e549e76e447a5bfd1e28afceb6385a6f005dbef96a8a2b0c77596fbcbeeb05e9901933f151da36d307353dc4c8c13f02fedb39302f2015a2b6d35
+  metadata.gz: e1c059e8d548c9675a3865969e867090d863815ace67a0b95a0df4bcece2a26e8dd9a42922e990b32abe0e28c8d8273d98a1940169ef5f0699baf74774bc8e1a
+  data.tar.gz: 7b23df0ceb45b01227436e96175b65ad00f90ce223fbfc7c6ec5b25f4578a1a73cfff5e8493830b25e4f84d80afc99ca6f60d6dcd94635202900ae8bcf4c8549

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Change Log
 
+## 1.4.1
+
+- Add `# backtick_javascript: true` where needed to satisfy new Opal requirement
+
+## 1.4.0
+
+- Drop `Array#cycle` and `Array#each` overrides and re-implement as `Array#async_cycle` and `Array#async_each`
+- Asynchronous `Kernel#async_loop` alternative to `Kernel#loop`
+
 ## 1.3.0
 
 - Asynchronous `Array#each` method that is web browser event loop friendly

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2015-2020 Ben Titcomb & Andy Maleh
+Copyright (c) 2015-2024 Ben Titcomb & Andy Maleh
 
 MIT License
 

data/README.md

@@ -1,11 +1,11 @@
-# Opal: Async
+# Opal: Async 1.4.1
 [![Gem Version](https://badge.fury.io/rb/opal-async.svg)](https://badge.fury.io/rb/opal-async)
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'opal-async', '~> 1.3.0'
+    gem 'opal-async', '~> 1.4.1'
 
 And then execute:
 
@@ -185,9 +185,9 @@ end
 
 #### Array
 
-The follow `Array` methods have been amended to work asynchronously via `Async::Task` when triggered inside another `Async::Task` (auto-detects it):
-- `Array#cycle`
-- `Array#each`
+The follow `Array` methods have been added to work asynchronously via `Async::Task`:
+- `Array#async_cycle`
+- `Array#async_each`
 
 This makes them not block the web browser event loop, thus allowing other tasks to update the DOM unhindered while running.
 
@@ -197,12 +197,34 @@ Example:
 require 'async/ext/array' # not needed if you called `require 'async/ext'`
 
 Async::Task.new do
-  [1,2,3,4].cycle do |n|
+  [1,2,3,4].async_cycle do |n|
     puts n
     Async::Task.new do
-      # make a DOM update
+      # make a DOM update that is not blocked
     end
-    sleep(1) # this does not block the event loop since it is transparently happening inside an Async::Task
+    sleep(1)
+  end
+end
+```
+
+#### Kernel
+
+The follow `Kernel` method has been added to work asynchronously via `Async::Task`:
+- `Array#async_loop`
+
+This makes it not block the web browser event loop, thus allowing other tasks to update the DOM unhindered while running.
+
+Example:
+
+```ruby
+require 'async/ext/kernel' # not needed if you called `require 'async/ext'`
+
+Async::Task.new do
+  async_loop do
+    Async::Task.new do
+      # make a DOM update that is not blocked
+    end
+    sleep(1)
   end
 end
 ```
@@ -210,7 +232,8 @@ end
 ## In The Wild
 
 opal-async is currently used in:
-- [Glimmer DSL for Opal](https://github.com/AndyObtiva/glimmer-dsl-opal)
+- [Glimmer DSL for Web](https://github.com/AndyObtiva/glimmer-dsl-web) (Ruby in the Browser Web GUI Frontend Library)
+- [Glimmer DSL for Opal](https://github.com/AndyObtiva/glimmer-dsl-opal) (Pure-Ruby Web GUI and Auto-Webifier of Desktop Apps)
 
 ## Change Log
 

data/VERSION

@@ -1 +1 @@
-1.3.0
+1.4.1

data/opal/async/countdown.rb

@@ -1,3 +1,5 @@
+# backtick_javascript: true
+
 module Async
   class Countdown
     def initialize time=0, intervals=1, step=1, &block

data/opal/async/ext/array.rb

@@ -1,40 +1,30 @@
 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
+  def async_cycle(n=nil, &block)
+    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
-      Async::Task.new(&looper)
-    else
-      cycle_without_opal_async(n, &block)
     end
+    Async::Task.new(&looper)
   end
   
-  alias each_without_opal_async each
-  def each(&block)
-    if Async::Task.started? && block_given?
-      array = self
-      index = 0
-      looper = lambda do
-        block.call(array.shift)
-        Async::Task.new(&looper) unless array.empty?
-      end
-      Async::Task.new(&looper)
-    else
-      each_without_opal_async(&block)
+  def async_each(&block)
+    array = self
+    index = 0
+    looper = lambda do
+      block.call(array.shift)
+      Async::Task.new(&looper) unless array.empty?
     end
+    Async::Task.new(&looper)
   end
 end

data/opal/async/ext/kernel.rb

@@ -0,0 +1,11 @@
+require 'async/task'
+
+module Kernel
+  def async_loop(&block)
+    looper = lambda do
+      block.call
+      Async::Task.new(&looper)
+    end
+    Async::Task.new(&looper)
+  end
+end

data/opal/async/ext.rb

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

data/opal/async/interval.rb

@@ -1,3 +1,5 @@
+# backtick_javascript: true
+
 module Async
   class Interval
     def initialize time=0, &block

data/opal/async/task.rb

@@ -1,3 +1,5 @@
+# backtick_javascript: true
+
 module Async
   class Task
     class << self

data/opal/async/timeout.rb

@@ -1,3 +1,5 @@
+# backtick_javascript: true
+
 module Async
   class Timeout
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opal-async
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.1
 platform: ruby
 authors:
 - Ravenstine
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-18 00:00:00.000000000 Z
+date: 2024-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opal
@@ -45,6 +45,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: opal-sprockets
+  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: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -137,6 +151,7 @@ files:
 - opal/async/enumerator.rb
 - opal/async/ext.rb
 - opal/async/ext/array.rb
+- opal/async/ext/kernel.rb
 - opal/async/ext/thread.rb
 - opal/async/interval.rb
 - opal/async/task.rb
@@ -166,7 +181,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.3.6
 signing_key:
 specification_version: 4
 summary: Provides non-blocking tasks and enumerators for Opal.