signalize 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3f252599b06ea9725abc4dd66d0b23562cd5b245dd970106c441b22a0890fe42
+  data.tar.gz: 1e46dc796f6bd28fc80292d0ef526ab5691642ec1fb34d213e547a9b9a0b3b22
+SHA512:
+  metadata.gz: b4eb905112dc61711495cca9cca462f37a1a50751b7d0434fd15b916276af57c73e08ac055d14d0e45534e8d82e8a2ad1576197772ffd544036cccc27d548c72
+  data.tar.gz: 8e4bf5a24a1ede2912a1f0b9265598d616829d2d9b0ef28eece14dbb5859d1c1fd75c8a19bbe3eb6ee9bb5922b65a5079e7d578cc75788cac4d13f0f18aca247

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [1.0.0] - 2023-03-07
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at jared@jaredwhite.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in signalize.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "guard"
+gem "guard-minitest"

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    signalize (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.3)
+    ffi (1.15.5)
+    formatador (1.1.0)
+    guard (2.18.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.13.0)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-minitest (2.4.6)
+      guard-compat (~> 1.2)
+      minitest (>= 3.0)
+    listen (3.8.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
+    minitest (5.18.0)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (13.0.6)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    shellany (0.0.1)
+    thor (1.2.1)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  guard
+  guard-minitest
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  signalize!
+
+BUNDLED WITH
+   2.3.14

data/Guardfile

@@ -0,0 +1,42 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+guard :minitest do
+  # with Minitest::Unit
+  watch(%r{^test/(.*)\/?test_(.*)\.rb$})
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+  watch(%r{^test/test_helper\.rb$})      { 'test' }
+
+  # with Minitest::Spec
+  # watch(%r{^spec/(.*)_spec\.rb$})
+  # watch(%r{^lib/(.+)\.rb$})         { |m| "spec/#{m[1]}_spec.rb" }
+  # watch(%r{^spec/spec_helper\.rb$}) { 'spec' }
+
+  # Rails 4
+  # watch(%r{^app/(.+)\.rb$})                               { |m| "test/#{m[1]}_test.rb" }
+  # watch(%r{^app/controllers/application_controller\.rb$}) { 'test/controllers' }
+  # watch(%r{^app/controllers/(.+)_controller\.rb$})        { |m| "test/integration/#{m[1]}_test.rb" }
+  # watch(%r{^app/views/(.+)_mailer/.+})                    { |m| "test/mailers/#{m[1]}_mailer_test.rb" }
+  # watch(%r{^lib/(.+)\.rb$})                               { |m| "test/lib/#{m[1]}_test.rb" }
+  # watch(%r{^test/.+_test\.rb$})
+  # watch(%r{^test/test_helper\.rb$}) { 'test' }
+
+  # Rails < 4
+  # watch(%r{^app/controllers/(.*)\.rb$}) { |m| "test/functional/#{m[1]}_test.rb" }
+  # watch(%r{^app/helpers/(.*)\.rb$})     { |m| "test/helpers/#{m[1]}_test.rb" }
+  # watch(%r{^app/models/(.*)\.rb$})      { |m| "test/unit/#{m[1]}_test.rb" }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022-present Preact Team & ported to Ruby by Jared White
+
+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.

data/README.md

@@ -0,0 +1,195 @@
+# Signalize
+
+Signalize is a Ruby port of the JavaScript-based [core Signals package](https://github.com/preactjs/signals) by the Preact project. Signals provides reactive variables, derived computed state, side effect callbacks, and batched updates.
+
+Additional context as provided by the original documentation:
+
+> Signals is a performant state management library with two primary goals:
+> 
+> Make it as easy as possible to write business logic for small up to complex apps. No matter how complex your logic is, your app updates should stay fast without you needing to think about it. Signals automatically optimize state updates behind the scenes to trigger the fewest updates necessary. They are lazy by default and automatically skip signals that no one listens to.
+> Integrate into frameworks as if they were native built-in primitives. You don't need any selectors, wrapper functions, or anything else. Signals can be accessed directly and your component will automatically re-render when the signal's value changes.
+
+While a lot of what we tend to write in Ruby is in the form of repeated, linear processing cycles (aka HTTP requests/responses on the web), there is increasingly a sense that we can look at concepts which make a lot of sense on the web frontend in the context of UI interactions and data flows and apply similar principles to the backend as well. Signalize helps you do just that.
+
+**NOTE:** read the Contributing section below before submitting a bug report or PR.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add signalize
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install signalize
+
+## Usage
+
+Signalize's public API consists of four methods (you can think of them almost like functions): `signal`, `computed`, `effect`, and `batch`.
+
+### `signal(initial_value)`
+
+The first building block is the `Signalize::Signal` class. You can think of this as a reactive value object which wraps an underlying primitive like String, Integer, Array, etc.
+
+```ruby
+counter = Signalize.signal(0)
+
+# Read value from signal, logs: 0
+puts counter.value
+
+# Write to a signal
+counter.value = 1
+```
+
+You can include the `Signalize::API` mixin to access these methods directly in any context:
+
+```ruby
+include Signalize::API
+
+counter = signal(0)
+
+counter.value += 1
+```
+
+### `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".
+
+```ruby
+include Signalize::API
+
+name = signal("Jane")
+surname = signal("Doe")
+
+full_name = computed do
+  name.value + " " + surname.value
+end
+
+# Logs: "Jane Doe"
+puts full_name.value
+
+name.value = "John"
+name.value = "Johannes"
+# name.value = "..."
+# Setting value multiple times won't trigger a computed value refresh
+
+# NOW we get a refreshed computed value:
+puts full_name.value
+```
+
+### `effect { }`
+
+Effects are callbacks which are executed whenever values which the effect has "subscribed" to by referencing them have changed. An effect callback is run immediately when defined, and then again for any future mutations.
+
+```ruby
+include Signalize::API
+
+name = signal("Jane")
+surname = signal("Doe")
+full_name = computed { name.value + " " + surname.value }
+
+# Logs: "Jane Doe"
+effect { puts full_name.value }
+
+# Updating one of its dependencies will automatically trigger
+# the effect above, and will print "John Doe" to the console.
+name.value = "John"
+```
+
+You can dispose of an effect whenever you want, thereby unsubscribing it from signal notifications.
+
+```ruby
+include Signalize::API
+
+name = signal("Jane")
+surname = signal("Doe")
+full_name = computed { name.value + " " + surname.value }
+
+# Logs: "Jane Doe"
+dispose = effect { puts full_name.value }
+
+# Destroy effect and subscriptions
+dispose.()
+
+# Update does nothing, because no one is subscribed anymore.
+# Even the computed `full_name` signal won't change, because it knows
+# that no one listens to it.
+surname.value = "Doe 2"
+```
+
+### `batch { }`
+
+You can write to  multiple signals within a batch, and flush the updates at all once (thereby notifying computed refreshes and effects).
+
+```ruby
+include Signalize::API
+
+name = signal("Jane")
+surname = signal("Doe")
+full_name = computed { name.value + " " + surname.value }
+
+# Logs: "Jane Doe"
+dispose = effect { puts full_name.value }
+
+batch do
+	name.value = "Foo"
+	surname.value = "Bar"
+end
+```
+
+### `signal.subscribe { }`
+
+You can explicitly subscribe to a signal signal value and be notified on every change. (Essentially the Observable pattern.) In your block, the new signal value will be supplied as an argument.
+
+```ruby
+include Signalize::API
+
+counter = signal(0)
+
+counter.subscribe do |new_value|
+  puts "The new value is #{new_value}"
+end
+
+counter.value = 1 # logs the new value
+```
+
+### `peek`
+
+If you need to access a signal's value inside an effect without subscribing to that signal's updates, use the `peek` method instead of `value`.
+
+```ruby
+include Signalize::API
+
+counter = signal(0)
+effect_count = signal(0)
+
+effect do
+	puts counter.value
+
+	# Whenever this effect is triggered, increase `effect_count`.
+	# But we don't want this signal to react to `effect_count`
+	effect_count.value = effect_count.peek
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/rake test` to run the tests, or `bin/guard` or run them continuously in watch mode. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Signalize is considered a direct port of the [original Signals JavaScript library](https://github.com/preactjs/signals). This means we are unlikely to accept any additional features other than what's provided by Signals. If Signals adds new functionality in the future, we will endeavor to replicate it in Signalize. Furthermore, if there's some unwanted behavior in Signalize that's also present in Signals, we are unlikely to modify that behavior.
+
+However, if you're able to supply a bugfix or performance optimization which will help bring Signalize _more_ into alignment with its Signals counterpart, we will gladly accept your PR!
+
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/whitefusionhq/signalize/blob/main/CODE_OF_CONDUCT.md).
+
+## 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/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+task default: :test

data/lib/signalize/version.rb

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

data/lib/signalize.rb

@@ -0,0 +1,661 @@
+# frozen_string_literal: true
+
+require_relative "signalize/version"
+
+module Signalize
+  class Error < StandardError; end
+
+  class << self
+    def class_variablize(name)
+      define_singleton_method "#{name}" do
+        class_variable_get("@@#{name}")
+      end
+      define_singleton_method "#{name}=" do |value|
+        class_variable_set("@@#{name}", value)
+      end
+    end
+  end
+
+  def self.cycle_detected
+	  raise "Cycle detected"
+  end
+
+  RUNNING = 1 << 0
+  NOTIFIED = 1 << 1
+  OUTDATED = 1 << 2
+  DISPOSED = 1 << 3
+  HAS_ERROR = 1 << 4
+  TRACKING = 1 << 5
+
+  # Computed | Effect | nil
+  @@eval_context = nil
+  class_variablize :eval_context
+
+  # 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
+
+  # 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
+
+  Node = Struct.new(
+    :_version,
+    :_source,
+    :_prev_source,
+    :_next_source,
+    :_target,
+    :_prev_target,
+    :_next_target,
+    :_rollback_node,
+    keyword_init: true
+  )
+
+  class << self
+    ## Batch-related helpers ##
+
+    def start_batch
+      self.batch_depth += 1
+    end
+  
+    def end_batch
+      if batch_depth > 1
+        self.batch_depth -= 1
+        return
+      end
+      error = nil
+      hasError = false
+    
+      while batched_effect.nil?.!
+        effect = batched_effect
+        self.batched_effect = nil
+    
+        self.batch_iteration += 1
+        while effect.nil?.!
+          nxt = effect._next_batched_effect
+          effect._next_batched_effect = nil
+          effect._flags &= ~NOTIFIED
+          unless (effect._flags & DISPOSED).nonzero? && needs_to_recompute(effect)
+            begin
+              effect._callback
+            rescue StandardError => err
+              unless hasError
+                error = err
+                hasError = true
+              end
+            end
+          end
+
+          effect = nxt
+        end
+      end
+
+      self.batch_iteration = 0
+      self.batch_depth -= 1
+    
+      raise error if hasError
+    end
+
+    def batch
+      return yield unless batch_depth.zero?
+
+      start_batch
+
+      begin
+        return yield
+      ensure
+        end_batch
+      end
+    end
+
+    ## Signal-related helpers ##
+
+    def add_dependency(signal)
+      return nil if eval_context.nil?
+
+      node = signal._node
+      if node.nil? || node._target != eval_context
+        # /**
+        # * `signal` is a new dependency. Create a new dependency node, and set it
+        # * as the tail of the current context's dependency list. e.g:
+        # *
+        # * { A <-> B       }
+        # *         ↑     ↑
+        # *        tail  node (new)
+        # *               ↓
+        # * { A <-> B <-> C }
+        # *               ↑
+        # *              tail (evalContext._sources)
+        # */
+        node = Node.new(
+          _version: 0,
+          _source: signal,
+          _prev_source: eval_context._sources,
+          _next_source: nil,
+          _target: eval_context,
+          _prev_target: nil,
+          _next_target: nil,
+          _rollback_node: node,
+        )
+
+        unless eval_context._sources.nil?
+          eval_context._sources._next_source = node
+        end
+        eval_context._sources = node
+        signal._node = node
+
+        # Subscribe to change notifications from this dependency if we're in an effect
+        # OR evaluating a computed signal that in turn has subscribers.
+        if (eval_context._flags & TRACKING).nonzero?
+          signal._subscribe(node)
+        end
+        return node
+      elsif node._version == -1
+        # `signal` is an existing dependency from a previous evaluation. Reuse it.
+        node._version = 0
+
+        # /**
+        # * If `node` is not already the current tail of the dependency list (i.e.
+        # * there is a next node in the list), then make the `node` the new tail. e.g:
+        # *
+        # * { A <-> B <-> C <-> D }
+        # *         ↑           ↑
+        # *        node   ┌─── tail (evalContext._sources)
+        # *         └─────│─────┐
+        # *               ↓     ↓
+        # * { A <-> C <-> D <-> B }
+        # *                     ↑
+        # *                    tail (evalContext._sources)
+        # */
+        unless node._next_source.nil?
+          node._next_source._prev_source = node._prev_source
+
+          unless node._prev_source.nil?
+            node._prev_source._next_source = node._next_source
+          end
+
+          node._prev_source = eval_context._sources
+          node._next_source = nil
+
+          eval_context._sources._next_source = node
+          eval_context._sources = node
+        end
+
+        # We can assume that the currently evaluated effect / computed signal is already
+        # subscribed to change notifications from `signal` if needed.
+        return node
+      end
+
+      nil
+    end
+
+    ## Computed/Effect-related helpers ##
+
+    def needs_to_recompute(target)
+      # Check the dependencies for changed values. The dependency list is already
+      # in order of use. Therefore if multiple dependencies have changed values, only
+      # the first used dependency is re-evaluated at this point.
+      node = target._sources
+      while node.nil?.!
+        # If there's a new version of the dependency before or after refreshing,
+        # or the dependency has something blocking it from refreshing at all (e.g. a
+        # dependency cycle), then we need to recompute.
+        if node._source._version != node._version || !node._source._refresh || node._source._version != node._version
+          return true
+        end
+        node = node._next_source
+      end
+      # If none of the dependencies have changed values since last recompute then
+      # there's no need to recompute.
+      false
+    end
+
+    def prepare_sources(target)
+      # /**
+      # * 1. Mark all current sources as re-usable nodes (version: -1)
+      # * 2. Set a rollback node if the current node is being used in a different context
+      # * 3. Point 'target._sources' to the tail of the doubly-linked list, e.g:
+      # *
+      # *    { undefined <- A <-> B <-> C -> undefined }
+      # *                   ↑           ↑
+      # *                   │           └──────┐
+      # * target._sources = A; (node is head)  │
+      # *                   ↓                  │
+      # * target._sources = C; (node is tail) ─┘
+      # */
+      node = target._sources
+      while node.nil?.!
+        rollbackNode = node._source._node
+        node._rollback_node = rollbackNode unless rollbackNode.nil?
+        node._source._node = node
+        node._version = -1
+
+        if node._next_source.nil?
+          target._sources = node
+          break
+        end
+
+        node = node._next_source
+      end
+    end
+
+    def cleanup_sources(target)
+      node = target._sources
+      head = nil
+
+      # /**
+      # * At this point 'target._sources' points to the tail of the doubly-linked list.
+      # * It contains all existing sources + new sources in order of use.
+      # * Iterate backwards until we find the head node while dropping old dependencies.
+      # */
+      while node.nil?.!
+        prev = node._prev_source
+
+        # /**
+        # * The node was not re-used, unsubscribe from its change notifications and remove itself
+        # * from the doubly-linked list. e.g:
+        # *
+        # * { A <-> B <-> C }
+        # *         ↓
+        # *    { A <-> C }
+        # */
+        if node._version == -1
+          node._source._unsubscribe(node)
+
+          unless prev.nil?
+            prev._next_source = node._next_source
+          end
+          unless node._next_source.nil?
+            node._next_source._prev_source = prev
+          end
+        else
+          # /**
+          # * The new head is the last node seen which wasn't removed/unsubscribed
+          # * from the doubly-linked list. e.g:
+          # *
+          # * { A <-> B <-> C }
+          # *   ↑     ↑     ↑
+          # *   │     │     └ head = node
+          # *   │     └ head = node
+          # *   └ head = node
+          # */
+          head = node
+        end
+
+        node._source._node = node._rollback_node
+        unless node._rollback_node.nil?
+          node._rollback_node = nil
+        end
+
+        node = prev
+      end
+
+      target._sources = head
+    end
+
+    ## Effect-related helpers ##
+
+    def cleanup_effect(effect)
+      cleanup = effect._cleanup
+      effect._cleanup = nil
+
+      if cleanup.is_a?(Proc)
+        start_batch
+
+        # Run cleanup functions always outside of any context.
+        prev_context = eval_context
+        self.eval_context = nil
+        begin
+          cleanup.()
+        rescue StandardError => err
+          effect._flags &= ~RUNNING
+          effect._flags |= DISPOSED
+          dispose_effect(effect)
+          raise err
+        ensure
+          self.eval_context = prev_context
+          end_batch
+        end
+      end
+    end
+
+    def dispose_effect(effect)
+      node = effect._sources
+      while node.nil?.!
+        node._source._unsubscribe(node)
+        node = node._next_source
+      end
+      effect._compute = nil
+      effect._sources = nil
+
+      cleanup_effect(effect)
+    end
+
+    def end_effect(effect, prev_context, *_) # allow additional args for currying
+      raise "Out-of-order effect" if eval_context != effect
+
+      cleanup_sources(effect)
+      self.eval_context = prev_context
+
+      effect._flags &= ~RUNNING
+      dispose_effect(effect) if (effect._flags & DISPOSED).nonzero?
+      end_batch
+    end
+  end
+
+  class Signal
+    attr_accessor :_version, :_node, :_targets
+
+    def initialize(value)
+      @value = value
+      @_version = 0;
+      @_node = nil
+      @_targets = nil
+    end
+
+    def _refresh = true
+
+    def _subscribe(node)
+      if _targets != node && node._prev_target.nil?
+        node._next_target = _targets
+        _targets._prev_target = node if !_targets.nil?
+        self._targets = node
+      end
+    end
+
+    def _unsubscribe(node)
+      # Only run the unsubscribe step if the signal has any subscribers to begin with.
+      if !_targets.nil?
+        prev = node._prev_target
+        nxt = node._next_target
+        if !prev.nil?
+          prev._next_target = nxt
+          node._prev_target = nil
+        end
+        if !nxt.nil?
+          nxt._prev_target = prev
+          node._next_target = nil
+        end
+        self._targets = nxt if node == _targets
+      end
+    end
+
+    def subscribe(&fn)
+      signal = self
+      this = Effect.allocate
+      this.send(:initialize, -> {
+        value = signal.value
+        flag = this._flags & TRACKING
+        this._flags &= ~TRACKING;
+        begin
+          fn.(value)
+        ensure
+          this._flags |= flag
+        end
+      })
+
+      Signalize.effect(this)
+    end
+
+    def value
+      node = Signalize.add_dependency(self)
+      node._version = _version unless node.nil?
+      @value
+    end
+
+    def value=(value)
+      if value != @value
+        Signalize.cycle_detected if Signalize.batch_iteration > 100
+
+        @value = value;
+        @_version += 1
+        # Signalize.global_version += 1
+
+        Signalize.start_batch
+        begin
+          node = _targets
+          while node.nil?.!
+            node._target._notify
+            node = node._next_target
+          end
+        ensure
+          Signalize.end_batch
+        end
+      end
+    end
+
+    def to_s
+      @value.to_s
+    end
+
+    def peek = @value
+  end
+
+  class Computed < Signal
+    attr_accessor :_compute, :_sources, :_flags
+
+    def initialize(compute)
+      super(nil)
+
+      @_compute = compute
+      @_sources = nil
+      # @_global_version = Signalize.global_version - 1
+      @_flags = OUTDATED
+    end
+
+    def _refresh
+      @_flags &= ~NOTIFIED
+
+      return false if (@_flags & RUNNING).nonzero?
+
+      # If this computed signal has subscribed to updates from its dependencies
+      # (TRACKING flag set) and none of them have notified about changes (OUTDATED
+      # flag not set), then the computed value can't have changed.
+      return true if (@_flags & (OUTDATED | TRACKING)) == TRACKING
+
+      @_flags &= ~OUTDATED
+    
+      # NOTE: performance optimization removed.
+      #
+      # if @_global_version == Signalize.global_version
+      #   return true
+      # end
+      # @_global_version = Signalize.global_version
+
+      # Mark this computed signal running before checking the dependencies for value
+      # changes, so that the RUNNING flag can be used to notice cyclical dependencies.
+      @_flags |= RUNNING
+      if @_version > 0 && !Signalize.needs_to_recompute(self)
+        @_flags &= ~RUNNING
+        return true
+      end
+    
+      prevContext = Signalize.eval_context
+      begin
+        Signalize.prepare_sources(self)
+        Signalize.eval_context = self
+        value = @_compute.()
+        if (@_flags & HAS_ERROR).nonzero? || @value != value || @_version == 0
+          @value = value
+          @_flags &= ~HAS_ERROR
+          @_version += 1
+        end
+      rescue StandardError => err
+        @value = err;
+        @_flags |= HAS_ERROR
+        @_version += 1
+      end
+      Signalize.eval_context = prevContext
+      Signalize.cleanup_sources(self)
+      @_flags &= ~RUNNING
+
+      true
+    end
+
+    def _subscribe(node)
+      if @_targets.nil?
+        @_flags |= OUTDATED | TRACKING
+
+        # A computed signal subscribes lazily to its dependencies when the it
+        # gets its first subscriber.
+
+        # RUBY NOTE: if we redefine `node`` here, it messes with `node` top method scope!
+        # So we'll use a new variable name `snode`
+        snode = @_sources
+        while snode.nil?.!
+          snode._source._subscribe(snode)
+          snode = snode._next_source
+        end
+      end
+      super(node)
+    end
+
+    def _unsubscribe(node)
+      # Only run the unsubscribe step if the computed signal has any subscribers.
+      unless @_target.nil?
+        super(node)
+
+        # Computed signal unsubscribes from its dependencies when it loses its last subscriber.
+        # This makes it possible for unreferences subgraphs of computed signals to get garbage collected.
+        if @_targets.nil?
+          @_flags &= ~TRACKING
+
+          node = @_sources
+
+          while node.nil?.!
+            node._source._unsubscribe(node)
+            node = node._next_source
+          end
+        end
+      end
+    end
+
+    def _notify
+      unless (@_flags & NOTIFIED).nonzero?
+        @_flags |= OUTDATED | NOTIFIED
+
+        node = @_targets
+        while node.nil?.!
+          node._target._notify
+          node = node._next_target
+        end
+      end
+    end
+
+    def peek
+      Signalize.cycle_detected unless _refresh
+
+      raise @value if (@_flags & HAS_ERROR).nonzero?
+
+      @value
+    end
+
+    def value
+      Signalize.cycle_detected if (@_flags & RUNNING).nonzero?
+
+      node = Signalize.add_dependency(self)
+      _refresh
+
+      node._version = @_version unless node.nil?
+
+      raise @value if (@_flags & HAS_ERROR).nonzero?
+
+      @value
+    end
+  end
+
+  class Effect
+    attr_accessor :_compute, :_cleanup, :_sources, :_next_batched_effect, :_flags
+
+    def initialize(compute)
+      @_compute = compute
+	    @_cleanup = nil
+      @_sources = nil
+      @_next_batched_effect = nil
+      @_flags = TRACKING
+    end
+
+    def _callback
+      finis = _start
+
+      begin
+        @_cleanup = _compute.() if (@_flags & DISPOSED).zero? && @_compute.nil?.!
+      ensure
+        finis.(nil) # TODO: figure out this weird shit
+      end
+    end
+
+    def _start
+      Signalize.cycle_detected if (@_flags & RUNNING).nonzero?
+
+      @_flags |= RUNNING
+      @_flags &= ~DISPOSED
+      Signalize.cleanup_effect(self)
+      Signalize.prepare_sources(self)
+
+      Signalize.start_batch
+      prev_context = Signalize.eval_context
+      Signalize.eval_context = self
+
+      Signalize.method(:end_effect).curry(3).call(self, prev_context) # HUH
+    end
+
+    def _notify
+      unless (@_flags & NOTIFIED).nonzero?
+        @_flags |= NOTIFIED
+        @_next_batched_effect = Signalize.batched_effect
+        Signalize.batched_effect = self
+      end
+    end
+
+    def _dispose
+	    @_flags |= DISPOSED
+
+      Signalize.dispose_effect(self) unless (@_flags & RUNNING).nonzero?
+    end
+  end
+
+  module API  
+    def signal(value)
+      Signal.new(value)
+    end
+
+    def computed(&block)
+      Computed.new(block)
+    end
+
+    def effect(effect_instance = nil, &block)
+      effect = effect_instance || Effect.new(block)
+
+      begin
+        effect._callback
+      rescue StandardError => err
+        effect._dispose
+        raise err
+      end
+
+      effect.method(:_dispose)
+    end
+
+    def batch
+      return yield unless Signalize.batch_depth.zero?
+
+      Signalize.start_batch
+
+      begin
+        return yield
+      ensure
+        Signalize.end_batch
+      end
+    end
+  end
+
+  extend API
+end

data/signalize.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "lib/signalize/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "signalize"
+  spec.version = Signalize::VERSION
+  spec.authors = ["Jared White", "Preact Team"]
+  spec.email = ["jared@whitefusion.studio"]
+
+  spec.summary = "A Ruby port of Signals, providing reactive variables, derived computed state, side effect callbacks, and batched updates."
+  spec.description = spec.summary
+  spec.homepage = "https://github.com/whitefusionhq/signalize"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: signalize
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jared White
+- Preact Team
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-03-08 00:00:00.000000000 Z
+dependencies: []
+description: A Ruby port of Signals, providing reactive variables, derived computed
+  state, side effect callbacks, and batched updates.
+email:
+- jared@whitefusion.studio
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/signalize.rb
+- lib/signalize/version.rb
+- signalize.gemspec
+homepage: https://github.com/whitefusionhq/signalize
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/whitefusionhq/signalize
+  source_code_uri: https://github.com/whitefusionhq/signalize
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: A Ruby port of Signals, providing reactive variables, derived computed state,
+  side effect callbacks, and batched updates.
+test_files: []