signalize 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 023d2e474c347003b12bef1210945016175838261a5761dae81cb90d749fe51b
-  data.tar.gz: 04adf75c67d46adf30fabfdf996eea3ef1555678f96189444d32355571c5d12d
+  metadata.gz: d07f1ae6a575b06c9831c5a167f69fcc1432a653a907e1cc4ed392271b297e6c
+  data.tar.gz: 053fdbe6ce667fee00b58f3ee910b58a7639b44093508dbdf4cc1bcccf09c488
 SHA512:
-  metadata.gz: 1c6cc8aad7188bde45f3c5e535d8a7c9ceb17e0598f35ebe45791cf194b8489e799fb32680c130f4bd3f0c06e399ae900bfa8dd103fd7431fe779856fb1685cc
-  data.tar.gz: e3eacdfae3cecd69c3b17158e4ae5610119d83e778e369479c487a1ac42e88dcb554cb9c3389cf4d1e1689a337f1bab2f0e02230d6a22b59df3b4bb2993069c3
+  metadata.gz: 9f2e7666b585b08d1b9e770cd09e558f44fda4bd76be3a58b3355770116ac7e730563b1fba29d273151797ad5efc4aeee8705d195a9d4a21ece91fc247f8f846
+  data.tar.gz: 0d44bbd6f232bb3c9e8f02d99f4d785826cb6ee885bb6be1c43503657dad1c7bbadbc55dc87a24d58d601e534e61497088d6a817b9aaee47808a28463dd4c6bb

data/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 ## [Unreleased]
 
+## [1.2.0] - 2023-10-03
+
+- Add `untracked` method (implements #5)
+- Add `mutation_detected` check for `computed`
+
+Gem now roughly analogous to `@preact/signals-core` v1.5
+
 ## [1.1.0] - 2023-03-25
 
 - Provide better signal/computed inspect strings (fixes #1)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    signalize (1.1.0)
+    signalize (1.2.0)
       concurrent-ruby (~> 1.2)
 
 GEM

data/README.md

@@ -54,6 +54,27 @@ counter = signal(0)
 counter.value += 1
 ```
 
+### `untracked { }`
+
+In case when you're receiving a callback that can read some signals, but you don't want to subscribe to them, you can use `untracked` to prevent any subscriptions from happening.
+
+```ruby
+require "signalize"
+include Signalize::API
+
+counter = signal(0)
+effect_count = signal(0)
+fn = proc { effect_count.value + 1 }
+
+effect do
+  # Logs the value
+	puts counter.value
+
+	# Whenever this effect is triggered, run `fn` that gives new value
+	effect_count.value = untracked(&fn)
+end
+```
+
 ### `computed { }`
 
 You derive computed state by accessing a signal's value within a `computed` block and returning a new value. Every time that signal value is updated, a computed value will likewise be updated. Actually, that's not quite accurate — the computed value only computes when it's read. In this sense, we can call computed values "lazily-evaluated".

data/lib/signalize/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Signalize
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/lib/signalize.rb

@@ -21,6 +21,10 @@ module Signalize
 	  raise Signalize::Error, "Cycle detected"
   end
 
+  def self.mutation_detected
+	  raise Signalize::Error, "Computed cannot have side-effects"
+  end
+
   RUNNING = 1 << 0
   NOTIFIED = 1 << 1
   OUTDATED = 1 << 2
@@ -34,6 +38,10 @@ module Signalize
   global_map_accessor :eval_context
   self.eval_context = nil
 
+  # Used by `untracked` method
+  global_map_accessor :untracked_depth
+  self.untracked_depth = 0
+
   # Effects collected into a batch.
   global_map_accessor :batched_effect
   self.batched_effect = nil
@@ -414,6 +422,8 @@ module Signalize
     end
 
     def value=(value)
+      Signalize.mutation_detected if Signalize.eval_context.is_a?(Signalize::Computed)
+
       if value != @value
         Signalize.cycle_detected if Signalize.batch_iteration > 100
 
@@ -484,7 +494,7 @@ module Signalize
         return true
       end
     
-      prevContext = Signalize.eval_context
+      prev_context = Signalize.eval_context
       begin
         Signalize.prepare_sources(self)
         Signalize.eval_context = self
@@ -499,7 +509,7 @@ module Signalize
         @_flags |= HAS_ERROR
         @_version += 1
       end
-      Signalize.eval_context = prevContext
+      Signalize.eval_context = prev_context
       Signalize.cleanup_sources(self)
       @_flags &= ~RUNNING
 
@@ -667,6 +677,21 @@ module Signalize
         Signalize.end_batch
       end
     end
+
+    def untracked
+      return yield unless Signalize.untracked_depth.zero?
+
+      prev_context = Signalize.eval_context
+      Signalize.eval_context = nil
+      Signalize.untracked_depth += 1
+
+      begin
+        return yield
+      ensure
+        Signalize.untracked_depth -= 1
+        Signalize.eval_context = prev_context
+      end
+    end
   end
 
   extend API

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: signalize
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Jared White
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-25 00:00:00.000000000 Z
+date: 2023-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby