hyper-state 0.1

data/lib/hyperstack/state/observable.rb

@@ -0,0 +1,76 @@
+module Hyperstack
+  module State
+    module Observable
+      def self.bulk_update(&block)
+        Internal::State::Mapper.bulk_update(&block)
+      end
+
+      def self.included(base)
+        base.include Internal::AutoUnmount
+        %i[singleton_method method].each do |kind|
+          base.send(:"define_#{kind}", :receives) do |*args, &block|
+            Internal::Receiver.mount(self, *args, &block)
+          end
+          base.send(:"define_#{kind}", :observe) do |&block|
+            result = block.call if block
+            Internal::State::Mapper.observed! self
+            result
+          end
+          base.send(:"define_#{kind}", :mutate) do |*_args, &block|
+            # any args will be ignored thus allowing us to say `mutate @foo = 123, @bar[:x] = 7` etc
+            result = block.call if block
+            Internal::State::Mapper.mutated! self
+            result
+          end
+          if RUBY_ENGINE == 'opal'
+            base.send(:"define_#{kind}", :set) do |var|
+              lambda do |val|
+                `self[#{var}] = #{val}`
+                mutate if var =~ /^[a-z]/
+              end
+            end
+          else
+            base.send(:"define_#{kind}", :set) do |var|
+              lambda do |val|
+                instance_variable_set(:"@#{var}", val)
+                mutate if var =~ /^[a-z]/
+              end
+            end
+          end
+          base.singleton_class.send(:"define_#{kind}", :observer) do |name, &block|
+            define_method(name) do |*args|
+              instance_exec(*args, &block).tap do
+                Internal::State::Mapper.observed! self
+              end
+            end
+          end
+          base.singleton_class.send(:"define_#{kind}", :mutator) do |name, &block|
+            define_method(name) do |*args|
+              instance_exec(*args, &block).tap do
+                Internal::State::Mapper.mutated! self
+              end
+            end
+          end
+          base.singleton_class.send(:"define_#{kind}", :state_reader) do |*names|
+            names.each do |name|
+              define_method(name) do
+                instance_variable_get(:"@#{name}").tap { Internal::State::Mapper.observed!(self) }
+              end
+            end
+          end
+          base.singleton_class.send(:"define_#{kind}", :state_writer) do |*names|
+            names.each do |name|
+              define_method(:"#{name}=") do |x|
+                instance_variable_set(:"@#{name}", x).tap { Internal::State::Mapper.mutated!(self) }
+              end
+            end
+          end
+          base.singleton_class.send(:"define_#{kind}", :state_accessor) do |*names|
+            state_reader(*names)
+            state_writer(*names)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hyperstack/state/observer.rb

@@ -0,0 +1,17 @@
+module Hyperstack
+  module State
+    module Observer
+      def observing(immediate_update: false, rendering: false, update_objects: false, &block)
+        Internal::State::Mapper.observing(self, immediate_update, rendering, update_objects, &block)
+      end
+
+      def update_objects_to_observe
+        Internal::State::Mapper.update_objects_to_observe(self)
+      end
+
+      def remove
+        Internal::State::Mapper.remove(self)
+      end
+    end
+  end
+end

data/lib/hyperstack/state/version.rb

@@ -0,0 +1,5 @@
+module Hyperstack
+  module State
+    VERSION = '0.1'
+  end
+end

data/notes.md

@@ -0,0 +1,104 @@
+typically we see this:
+
+`State.get_state(obj_or_class, key)` and  `State.set_state(obj_or_class, key, val)`
+
+we would like to see this:
+
+`obj.key.state`  and `obj.key.state = val`
+
+plus `obj.key.mutate` which is short for
+`obj.key.state.tap { |val| val... some mutation; val.key.state = val}`
+
+problems:
+
+1. creates a state object for each key - the only purpose this serves is preventing accidental application of `key = ...` instead of `self.key = `
+
+2. difficult to use application defined keys like Model attributes - have to call the `state` macro for each key before use.
+
+3. many of the objects have only a single state, so `obj.my_only_state.state` is redundant.
+
+what do we want to say?
+
+`obj.states[key]`  or  `obj.states[key] = val` or `obj.mutates[key]`
+
+and in the case of an object with a single state:
+
+`obj.state # reader` and  
+`obj.state = val # setter - careful of self.state = problem` and  
+`obj.mutate`
+
+for the first case we could say:
+
+`state :states, hash: :mutates`
+
+for the second case it would be implemented like this:
+
+```ruby
+state :state_obj
+def state
+  state_obj.state
+end
+
+def state=(val)
+  state_obj.state = val
+end
+
+def mutate
+  state_obj.mutate
+end
+```
+
+and perhaps this would be done by using a subclass instead of include?
+
+```ruby
+class MyStatefulClass < Hyperstack::State::Base
+  #... how to do it the class level?
+end
+```
+
+
+MORE THOUGHTS ON SINGLE STATE OBJECTS
+
+typically we have some instance variable that is the
+reactive state.  We may want to read and change that variable
+internally without reaction
+
+so one approach would be to just provide two methods: `observed!` and `mutated!`
+```ruby
+def observed!
+  State.get_state(self, self)
+end
+
+def mutated!
+  State.set_state(self, self, self)
+end
+```
+
+### So here is the deal
+
+If you want to make some arbitrary piece of data *stateful* then you have to deal with arrays, or at least some kind of data that can be addressed.
+
+hmmm not exactly right... the thing is we want to build state objects out of state variables and variables can be arrays (or other addressable primitive structures).
+
+so lets say we want to build a reactive hash class, but we want each key to be its own reactive variable.
+
+We could create the reactive hash class with an internal class called ReactiveHashValue, where each reactive_hash_value knows its key, its value, and inherits from Observable.  
+
+http://opalrb.com/try/?code:class%20Foo%0A%20%20def%20initialize(x)%0A%20%20%20%20%40x%20%3D%20x%0A%20%20end%0A%20%20def%20meth%0A%20%20%20%20%40x%0A%20%20end%0Aend%0A%0Aputs%20Foo.new(12).meth%0A%0Aclass%20Bar%0A%20%20def%20self.new(x)%0A%20%20%20%20return%20%60%7B%24meth%3A%20function()%20%7B%20return%20(x)%20%7D%20%7D%60%0A%20%20end%0Aend%0A%0Aputs%20Bar.new(12).meth%0A%0Adef%20speedy(x)%0A%20%20return%20%60%7B%24meth%3A%20function()%20%7Breturn%20(x)%20%7D%20%7D%60%0Aend%0A%0Aputs%20speedy(12).meth%0A%0A%0Adef%20timeit(x)%20%0A%20%20start_time%20%3D%20Time.now.to_f%0A%20%20x.times.each%20%7B%20yield%20%7D%0A%20%20(Time.now.to_f%20-%20start_time)%20%2F%20x%0Aend%0A%0Aputs%20timeit(1_000_000)%20%7B%20Foo.new(12).meth%20%7D%0Aputs%20timeit(1_000_000)%20%7B%20speedy(12).meth%20%7D%0Aputs%20timeit(1_000_000)%20%7B%20Bar.new(12).meth%20%7D
+
+
+```ruby
+module Observable
+  # adds state methods to a class
+  # adds the mutated!  and observed! methods to instance and class
+  # which can be used to notify of changes to the instance or classes state
+end
+
+class ObservableState
+  # contains a single state value methods such as state, state= and mutate
+end
+
+# Observable uses ObservableState for each state variable, and also for the single class and
+# instance state variables representing the state of the class as a whole.
+
+```

metadata

@@ -0,0 +1,383 @@
+--- !ruby/object:Gem::Specification
+name: hyper-state
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Mitch VanDuyn
+- Adam Creekroad
+- Jan Biedermann
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-11-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hyperstack-config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: opal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: chromedriver-helper
+  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: hyper-component
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: hyper-spec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: listen
+  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: mini_racer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.15
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.15
+- !ruby/object:Gem::Dependency
+  name: opal-browser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: opal-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.4
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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: pry-rescue
+  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: puma
+  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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: react-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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: rspec-steps
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.51.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.51.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+description: 
+email:
+- mitch@catprint.com
+- jan@kursator.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- DOCS.md
+- Gemfile
+- README.md
+- Rakefile
+- hyper-state.gemspec
+- lib/hyper-state.rb
+- lib/hyperstack/internal/auto_unmount.rb
+- lib/hyperstack/internal/callbacks.rb
+- lib/hyperstack/internal/receiver.rb
+- lib/hyperstack/internal/state/mapper.rb
+- lib/hyperstack/state/observable.rb
+- lib/hyperstack/state/observer.rb
+- lib/hyperstack/state/version.rb
+- notes.md
+homepage: https://ruby-hyperloop.org
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.8
+signing_key: 
+specification_version: 4
+summary: Flux Stores and more for Hyperloop
+test_files: []