r_signals 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 622ce0ab4dc783351f84fd930367140fb61c7231bc101ac50e39adb256f41b2b
+  data.tar.gz: ebc2063fc0de0e056495af3d167e5b14a6b771032cc8f8e507c69d5a4836d51f
+SHA512:
+  metadata.gz: de670d1c8d0180f7c509f39a77f5e02f4d752794f5146911c044c63e2f43ece63a26e78a986a0149a1fd618bdc96653ff1e531ceb090cdc1f9d5cddc949e72a9
+  data.tar.gz: a4bca09d2737dca53652c4f33d04516ad30c0f27340a32e76654288c84e91041c2e96757c248121ec415ed4e24389721596371c122dec0b584682952bd1aa1e4

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,11 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Metrics/BlockLength:
+  AllowedMethods: ['describe']

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-06-11
+
+- 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 kingsley@peoplebox.ai. 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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Unegbu kingsley
+
+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,82 @@
+# RSignals
+
+RSignals is a reactive signal gem for ruby. Create reactivity with your variables.
+
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+    bundle add r_signals
+```
+
+## Usage
+
+### First include the module
+
+```ruby
+    class Klass
+        include RSignals::Signalizer
+
+        signalize count: 0, shop: -> { count + 2 }
+    end
+```
+
+### Then we use it 
+
+```ruby
+    instance = Klass.new
+    
+    puts instance.count     # 0
+
+    instance.count 2    
+
+    puts instance.count     # 2
+
+    puts instance.shop     # 4
+
+```
+
+This instance methods are reactive and cached. from the above example, `shop` depends on `count` but will only call `count` if their is a change to `count`.
+
+
+### Class based
+```ruby
+    class Klass
+        include RSignals::Signalizer
+
+        signalize :class, count: 0, shop: -> { count + 2 }
+    end
+
+
+    puts Klass.count     # 0
+
+    Klass.count 2    
+
+    puts Klass.count     # 2
+
+    puts Klass.shop     # 4
+```
+
+## Development
+
+N:B Files with name ending  with `_` should be ignored. they are currently not part of the repository. They are waiting to be deleted.
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/urchmaney/r_signals. 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/urchmaney/r_signals/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 RSignals project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/urchmaney/r_signals/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/r_signals/dependency_context/base.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require "set"
+
+module RSignals
+  module DependencyContext
+    #
+    # Base class for all dependency context to inherit from
+    #
+    class Base
+      @collection_set = Set.new
+      @collection_stack = []
+
+      class << self
+        attr_reader :collection_set, :collection_stack
+      end
+
+      attr_reader :mark_dirty, :dependencies
+
+      def initialize(owner = nil)
+        @owner = owner
+        @dependencies = Set.new
+        @event = EventDispatchers::FlagDispatcher.new
+        @mark_dirty = -> { @event.raise }
+      end
+
+      # protected
+
+      def invoke; end
+
+      def start_collecting
+        if Base.collection_set.include?(self)
+          throw "A circular dependency has occured between signals.
+          This can occur if signal reference each other in a loop."
+        end
+
+        Base.collection_set.add(self)
+        Base.collection_stack.push(self)
+      end
+
+      def finish_collecting
+        Base.collection_set.delete self
+        throw "collectStart/collectEnd was called out of order." if Base.collection_stack.pop != self
+      end
+
+      def clear_dependencies
+        @dependencies.each { |dep| dep.unsubscribe(@mark_dirty) }
+        @dependencies.clear
+      end
+
+      def collect
+        signal = Base.collection_stack[-1]
+        return unless signal
+
+        signal.dependencies.add(@event.subscribable)
+        @event.subscribe(signal.mark_dirty)
+      end
+
+      def dispose
+        clear_dependencies
+        @event.clear
+      end
+    end
+  end
+end

data/lib/r_signals/dependency_context/signal.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module RSignals
+  module DependencyContext
+    #
+    # Signal Context
+    #
+    class Signal < Base
+      def initialize(owner = nil, initial = nil)
+        super(owner)
+        @initial = initial
+        return unless @initial
+
+        @current = @initial
+        @mark_dirty.call
+        @last = @initial unless RSignals.reactive? @initial
+      end
+
+      def signal(val = nil)
+        return value if val.nil?
+
+        self.value = val
+      end
+
+      private
+
+      def value
+        if (RSignals.reactive? @current) && @event.raised?
+          clear_dependencies
+          start_collecting
+          execute_reactive_value
+          finish_collecting
+        end
+        @event.reset
+        collect
+        @last
+      end
+
+      def execute_reactive_value
+        @last = @owner.instance_exec(&@current)
+      rescue StandardError
+        p $ERROR_INFO
+      end
+
+      def value=(val)
+        val = @initial if val == :default
+
+        @current = val
+        clear_dependencies
+        @last = val unless RSignals.reactive? val
+
+        @mark_dirty.call
+      end
+    end
+  end
+end

data/lib/r_signals/dependency_context.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative "dependency_context/base"
+require_relative "dependency_context/signal"

data/lib/r_signals/event_dispatchers/base.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module RSignals
+  module EventDispatchers
+    # The base abstract class for all event dispatching class
+    class Base
+      attr_reader :subscribable
+
+      def initialize
+        @subscribers = Set.new
+        @subscribable = Subscribable.new self
+      end
+
+      def subscribe(handler)
+        @subscribers.add(handler)
+        -> { unsubscribe(handler) }
+      end
+
+      def unsubscribe(handler)
+        @subscribers.delete handler
+      end
+
+      def clear
+        @subscribers.clear
+      end
+
+      def notify_subscribers
+        @subscribers.to_a.map(&:call)
+      end
+    end
+
+    #
+    # A safe way to subscribe and unsubscribe to events
+    #
+    class Subscribable
+      def initialize(dispatcher)
+        @dispatcher = dispatcher
+      end
+
+      def subscribe(handler)
+        @dispatcher.subscribe(handler)
+      end
+
+      def unsubscribe(handler)
+        @dispatcher.unsubscribe(handler)
+      end
+    end
+  end
+end

data/lib/r_signals/event_dispatchers/flag_dispatcher.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module RSignals
+  module EventDispatchers
+    # Flag dispatcher that has a boolean value
+    class FlagDispatcher < Base
+      def initialize
+        super
+        @value = false
+      end
+
+      def raise
+        return if @value
+
+        @value = true
+        notify_subscribers
+      end
+
+      def raised?
+        @value
+      end
+
+      def subscribe(handler)
+        unsub = super
+        handler.call if @value
+        unsub
+      end
+
+      def reset
+        @value = false
+      end
+    end
+  end
+end

data/lib/r_signals/event_dispatchers.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "./event_dispatchers/base"
+
+module RSignals
+  # EventDispatchers
+  module EventDispatchers
+    autoload :FlagDispatcher, "r_signals/event_dispatchers/flag_dispatcher"
+  end
+end

data/lib/r_signals/r_node_.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+# This file is currently not used in the repository. Just waiting to be deleted
+
+require "set"
+
+module RSignals
+  # Class definition to create node
+  class RNode
+    attr_reader :previous, :value_type, :dependent_nodes, :binding
+
+    def initialize(val, binding, &block)
+      @value = val
+      @previous = nil
+      @value_type = val.class
+      @block = block
+      @dependent_nodes = Set.new
+      @clean = !val.nil?
+      @binding = binding
+    end
+
+    def value
+      return @value if @block.nil? || clean?
+
+      run_block
+    end
+
+    def value=(new_val)
+      raise TypeMismatchError.new new_val, value_type if new_val.class != value_type
+
+      store_new_value new_val
+      mark_dependents_dirty
+    end
+
+    def r
+      RSignals::ParameterHelpers.calling_node = self
+      RSignals::ParameterHelpers
+    end
+
+    def add_dependent_node(node)
+      @dependent_nodes.add(node)
+    end
+
+    def clean?
+      @clean
+    end
+
+    def mark_dirty
+      @clean = false
+      mark_dependents_dirty
+    end
+
+    def mark_dependents_dirty
+      @dependent_nodes.each(&:mark_dirty)
+    end
+
+    def run_block
+      result = binding.instance_exec r, &@block
+      store_new_value result
+    end
+
+    def store_new_value(new_val)
+      @previous = @value
+      @value = new_val
+    end
+  end
+end

data/lib/r_signals/r_signalable_.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+# This file is currently not used in the repository. Just waiting to be deleted
+
+module RSignals
+  # Parameter Helpers
+  # This class contains dynamic methods for signals
+  # This is what we use in
+  # create_r_signal("name") do |r|
+  #
+  # end
+  #
+  # r --> is this class
+  class ParameterHelpers
+    class << self
+      attr_accessor :calling_node
+    end
+  end
+
+  # Included module to that bring signal behaviour
+  module RSignalable
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    # Module class methods
+    module ClassMethods
+      def create_r_signal(name, val = nil, &block)
+        node = RNode.new val, self, &block
+        register_signal name, node
+        create_r_node_method name, node
+        create_r_node_previous_method name, node
+      end
+
+      def create_r_node_method(name, node)
+        define_singleton_method(name) do |*args|
+          return node.value if args.length <= 0
+
+          node.value = args[0]
+        end
+      end
+
+      def create_r_node_previous_method(name, node)
+        define_singleton_method("#{name}_previous") do
+          node.previous
+        end
+      end
+
+      def register_signal(signal_name, node)
+        RSignals::ParameterHelpers.define_singleton_method(signal_name) do
+          node.add_dependent_node(RSignals::ParameterHelpers.calling_node)
+          node.value
+        end
+      end
+
+      def full_signal_name(signal_name)
+        "#{name}.#{signal_name}"
+      end
+    end
+  end
+end

data/lib/r_signals/signalizer.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module RSignals
+  # module to be included to allow signalizing
+  module Signalizer
+    def self.included(base)
+      base.extend ClassMethods
+      base.extend self
+    end
+
+    def signal_instance(instance, key, value)
+      instance_key = "@_signal_#{key}"
+      node = instance.instance_variable_get(instance_key)
+      return node if node
+
+      instance.instance_variable_set(instance_key, RSignals::DependencyContext::Signal.new(self, value))
+      instance.instance_variable_get(instance_key)
+    end
+
+    # module containing class methods that will be added to class that extends Signaler
+    module ClassMethods
+      def signalize(*args)
+        to, hash = verify_args(*args)
+        if to == :class
+          define_signal_singleton_methods hash
+        else
+          define_signal_methods hash
+        end
+      end
+
+      private
+
+      def verify_args(*args)
+        unless (args.length == 1 && args[0].is_a?(Hash)) || (
+          args.length == 2 && args[0].is_a?(Symbol) && args[1].is_a?(Hash))
+          throw "Wrong parameter structure."
+        end
+        args.length == 2 ? args : [:instance, *args]
+      end
+
+      def define_signal_methods(hash)
+        hash.each do |key, val|
+          define_method key do |value = nil|
+            node = signal_instance(self, key, val)
+            node.signal value
+          end
+        end
+      end
+
+      def define_signal_singleton_methods(hash)
+        hash.each do |key, val|
+          define_singleton_method key do |value = nil|
+            node = signal_instance(self, key, val)
+            node.signal value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/r_signals/util.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+#
+# Module for uitility functions
+#
+module RSignals
+  def self.reactive?(value)
+    value.respond_to? :call
+  end
+end

data/lib/r_signals/version.rb

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

data/lib/r_signals.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative "r_signals/version"
+require_relative "r_signals/util"
+require_relative "r_signals/event_dispatchers"
+require_relative "r_signals/dependency_context"
+require_relative "r_signals/signalizer"
+
+# Parent Container Module
+module RSignals
+  # Type Mismatch exception class
+  class TypeMismatchError < StandardError
+    def initialize(value, type)
+      super("TYPE MISMATCH: type of '#{value}' does not match default type : #{type}")
+    end
+  end
+end

data/sig/r_signals.rbs

@@ -0,0 +1,4 @@
+module RSignals
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: r_signals
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Unegbu Kingsley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2025-04-01 00:00:00.000000000 Z
+dependencies: []
+description: RSignals is a reactive signal gem for ruby. Create reactivity with your
+  variables.
+email:
+- kingsobino@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/r_signals.rb
+- lib/r_signals/dependency_context.rb
+- lib/r_signals/dependency_context/base.rb
+- lib/r_signals/dependency_context/signal.rb
+- lib/r_signals/event_dispatchers.rb
+- lib/r_signals/event_dispatchers/base.rb
+- lib/r_signals/event_dispatchers/flag_dispatcher.rb
+- lib/r_signals/r_node_.rb
+- lib/r_signals/r_signalable_.rb
+- lib/r_signals/signalizer.rb
+- lib/r_signals/util.rb
+- lib/r_signals/version.rb
+- sig/r_signals.rbs
+homepage: https://github.com/Urchmaney/r_signals
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Urchmaney/r_signals
+  source_code_uri: https://github.com/Urchmaney/r_signals
+  changelog_uri: https://github.com/Urchmaney/r_signals/blob/main/CHANGELOG.md
+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.5.11
+signing_key: 
+specification_version: 4
+summary: RSignals is a reactive signal gem for ruby. Create reactivity with your variables.
+test_files: []