signalize 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e4f4fc25e9d3e2f4e343a22ecd6bf37daa4628da775f9c5d7709177881c927e
-  data.tar.gz: e91df598b0d5c11a6f4a803481e3fabb8476e59ac873c6fa8d0e2f57d3851cae
+  metadata.gz: d07f1ae6a575b06c9831c5a167f69fcc1432a653a907e1cc4ed392271b297e6c
+  data.tar.gz: 053fdbe6ce667fee00b58f3ee910b58a7639b44093508dbdf4cc1bcccf09c488
 SHA512:
-  metadata.gz: d9bb28f9f5e35093aaf5567df71a9f8c05edd1467c5788f6afd7a4678790a9bd6a8f08c2296641a9bc7bed8c303da594b17ee308f7b57dcb6754d1bc6a9a7451
-  data.tar.gz: a85f5867add9ecce1cad3bb7bcc9cd975c69097436ec8d9bfccdc260245aa1c5c93f1031b4aa0337cc144ad5453bc4a67ec71611b8dad850e17481d614b5b5c6
+  metadata.gz: 9f2e7666b585b08d1b9e770cd09e558f44fda4bd76be3a58b3355770116ac7e730563b1fba29d273151797ad5efc4aeee8705d195a9d4a21ece91fc247f8f846
+  data.tar.gz: 0d44bbd6f232bb3c9e8f02d99f4d785826cb6ee885bb6be1c43503657dad1c7bbadbc55dc87a24d58d601e534e61497088d6a817b9aaee47808a28463dd4c6bb

data/CHANGELOG.md

@@ -1,5 +1,24 @@
+# Changelog
+
 ## [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)
+- Use Concurrent::Map for thread-safe globals (fixes #3)
+
+## [1.0.1] - 2023-03-08
+
+- Prevent early returns in effect blocks
+- Use gem's error class (fixes #2)
+
 ## [1.0.0] - 2023-03-07
 
 - Initial release

data/Gemfile.lock

@@ -1,12 +1,14 @@
 PATH
   remote: .
   specs:
-    signalize (1.0.1)
+    signalize (1.2.0)
+      concurrent-ruby (~> 1.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
     coderay (1.1.3)
+    concurrent-ruby (1.2.2)
     ffi (1.15.5)
     formatador (1.1.0)
     guard (2.18.0)

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".
@@ -248,7 +269,3 @@ This project is intended to be a safe, welcoming space for collaboration, and co
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the Signalize project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/whitefusionhq/signalize/blob/main/CODE_OF_CONDUCT.md).

data/lib/signalize/version.rb

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

data/lib/signalize.rb

@@ -1,17 +1,18 @@
 # frozen_string_literal: true
 
+require "concurrent"
 require_relative "signalize/version"
 
 module Signalize
   class Error < StandardError; end
 
   class << self
-    def class_variablize(name)
+    def global_map_accessor(name)
       define_singleton_method "#{name}" do
-        class_variable_get("@@#{name}")
+        GLOBAL_MAP[name]
       end
       define_singleton_method "#{name}=" do |value|
-        class_variable_set("@@#{name}", value)
+        GLOBAL_MAP[name] = value
       end
     end
   end
@@ -20,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
@@ -27,24 +32,30 @@ module Signalize
   HAS_ERROR = 1 << 4
   TRACKING = 1 << 5
 
+  GLOBAL_MAP = Concurrent::Map.new
+
   # Computed | Effect | nil
-  @@eval_context = nil
-  class_variablize :eval_context
+  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.
-  @@batched_effect = nil
-  class_variablize :batched_effect
-  @@batch_depth = 0
-  class_variablize :batch_depth
-  @@batch_iteration = 0
-  class_variablize :batch_iteration
+  global_map_accessor :batched_effect
+  self.batched_effect = nil
+  global_map_accessor :batch_depth
+  self.batch_depth = 0
+  global_map_accessor :batch_iteration
+  self.batch_iteration = 0
 
   # NOTE: we have removed the global version optimization for Ruby, due to
   # the possibility of long-running server processes and the number reaching
   # a dangerously high integer value.
   #
-  # @@global_version = 0  
-  # class_variablize :global_version
+  # global_map_accessor :global_version
+  # self.global_version = 0
 
   Node = Struct.new(
     :_version,
@@ -411,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
 
@@ -436,6 +449,10 @@ module Signalize
     end
 
     def peek = @value
+
+    def inspect
+      "#<#{self.class} value: #{peek.inspect}>"
+    end
   end
 
   class Computed < Signal
@@ -477,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
@@ -492,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
 
@@ -660,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

data/signalize.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency "concurrent-ruby", "~> 1.2"
 
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: signalize
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Jared White
@@ -9,8 +9,22 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-09 00:00:00.000000000 Z
-dependencies: []
+date: 2023-10-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 description: A Ruby port of Signals, providing reactive variables, derived computed
   state, side effect callbacks, and batched updates.
 email: