isomorfeus-redux 4.0.19 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0eabc9771d1a6cd01277a34a779def3b54053a6cf18d81ed659a39cdbce6e84b
-  data.tar.gz: 8474fbbb10aa537d2136484e36938d66a6c3ba118854ee7db441d0cd6ab7678a
+  metadata.gz: eee10cde82ff56029869c6158c2e0eb99dc5df7bf7746920d2d155023870cc51
+  data.tar.gz: 312c159a65766706fb871cca8caf8d5c3d8cf037fb6bdb6384b5933c5821f113
 SHA512:
-  metadata.gz: 9e1bbc10687e598ba74712425f84165ca3a89ad373a62f1ccd21381b3420f5f9d2d60a8dc953b30dddfe9d830fa3dbd443c575c81d30f75b98c6aad3a531bbc4
-  data.tar.gz: 2a720626c51e0c24764c0afb8bcaa825a39e929ac45475ddec90b7a933a982b54f718908b6cf2343e375dc3fba3dfe7b12d21bd4cae6a5efe3dec801bfb59702
+  metadata.gz: a38191643a83bec9f169c8d645c076a539408d3ea4417c11c284a3b91ccf3ce6ca0fafe2105f5da1a5c051d0bdab18118735c8eee22dd771654b478c6529e3b9
+  data.tar.gz: baf7135019055ef0377a1a542130482dec78cd7119bc9d1c20f55294f645492d49fa122bfc067fec7c55ddcce199abc563fec9b3f8402b3154912cedc6aace26

data/README.md

@@ -7,12 +7,12 @@ At the [Isomorfeus Framework Project](http://isomorfeus.com)
 
 ## Versioning
 isomorfeus-redux version follows the Redux version which features and API it implements.
-Isomorfeus-redux 4.0.x implements features and the API of Redux 4.0 and should be used with Redux 4.0
+Isomorfeus-redux 4.1.x implements features and the API of Redux 4.1 and should be used with Redux 4.1
 
 ## Installation
 To install redux with the matching version:
 ```
-yarn add redux@4.0.5
+yarn add redux@4.1.0
 ```
 then add to the Gemfile:
 ```ruby
@@ -34,11 +34,117 @@ For full functionality the following are required:
 For the Gemfile:
 ```ruby
 gem 'opal', github: 'janbiedermann/opal', branch: 'es6_modules_1_1'
-gem 'opal-webpack-loader', '~> 0.9.1'
-gem 'opal-autoloader', '~> 0.0.3'
+gem 'opal-webpack-loader', '~> 0.10.1'
 ```
 
-## Usage
+## Usage within Isomorfeus
+
+Lucid Components have store access integrated, see the isomorfeus-react documentation.
+
+The following stores are available:
+- AppStore - reactive store managed by redux
+- LocalStore - convenient access to the Browsers localStorage, changes from within ruby can be subscribed to
+- SessionStore - convenient access to the Browsers sessionStorage, changes from within ruby can be subscribed to
+
+### AppStore
+All keys must be Strings or Symbols! All values must be serializable, simple types preferred!
+
+Example Usage:
+```ruby
+# setting a value:
+AppStore.some_key = 10
+AppStore[:some_key] = 10
+AppStore.set(:some_key, 10) 
+AppStore.promise_set(:some_key, 10)
+
+# getting a value:
+val = AppStore.some_key
+val = AppStore[:some_key]
+val = AppStore.get(:some_key) 
+AppStore.promise_get(:some_key).then do |val|
+  # do something
+end
+
+# subscribing to changes
+unsub = AppStore.subscribe do
+  @val = AppStore.some_key
+end
+
+# MUST be unsibscribed if changes are no longer wanted
+AppStore.unsubscribe(unsub) 
+```
+
+### LocalStore
+All keys and values must be Strings or Symbols!
+
+```ruby
+# setting a value:
+LocalStore.some_key = 10
+LocalStore[:some_key] = 10
+LocalStore.set(:some_key, 10) 
+LocalStore.promise_set(:some_key, 10)
+
+# getting a value:
+val = LocalStore.some_key
+val = LocalStore[:some_key]
+val = LocalStore.get(:some_key) 
+LocalStore.promise_get(:some_key).then do |val|
+  # do something
+end
+
+# deleting a value
+LocalStore.delete(:some_key)
+LocalStore.promise_delete(:some_key)
+
+# clearing the store
+LocalStore.clear 
+LocalStore.promise_clear
+
+# subscribing to changes
+unsub = LocalStore.subscribe do
+  @val = LocalStore.some_key
+end
+
+# MUST be unsibscribed if changes are no longer wanted
+LocalStore.unsubscribe(unsub) 
+```
+
+### SessionStore
+All keys and values must be Strings or Symbols!
+
+```ruby
+# setting a value:
+SessionStore.some_key = 10
+SessionStore[:some_key] = 10
+SessionStore.set(:some_key, 10) 
+SessionStore.promise_set(:some_key, 10)
+
+# getting a value:
+val = SessionStore.some_key
+val = SessionStore[:some_key]
+val = SessionStore.get(:some_key) 
+SessionStore.promise_get(:some_key).then do |val|
+  # do something
+end
+
+# deleting a value
+SessionStore.delete(:some_key)
+SessionStore.promise_delete(:some_key)
+
+# clearing the store
+SessionStore.clear 
+SessionStore.promise_clear
+
+# subscribing to changes
+unsub = SessionStore.subscribe do
+  @val = SessionStore.some_key
+end
+
+# MUST be unsibscribed if changes are no longer wanted
+LocalStore.unsubscribe(unsub) 
+```
+
+## Advanced Usage
 Because isomorfeus-redux follows closely the Redux principles/implementation/API and Documentation, most things of the official Redux documentation
 apply, but in the Ruby way, see:
 - https://redux.js.org
@@ -102,6 +208,7 @@ Isomorfeus.store.subscribe do
   # something useful here
 end
 ```
+
 ### Setup
 If isomorfeus-redux is used in isolation, these methods can be used:
 ```ruby
@@ -111,3 +218,6 @@ Redux::Store.init! # initializes the global store
 
 ### Development Tools
 The Redux Development Tools allow for detailed debugging of store/state changes: https://github.com/zalmoxisus/redux-devtools-extension
+
+### Specs
+Specs for the stores are in isomorfeus-react.

data/lib/app_store.rb

@@ -0,0 +1,42 @@
+class AppStore
+  class << self
+    def method_missing(key, *args, &block)
+      if `args.length > 0`
+        # set class state, simply a dispatch
+        action = { type: 'APPLICATION_STATE', name: (`key.endsWith('=')` ? key.chop : key), value: args[0] }
+        Isomorfeus.store.collect_and_defer_dispatch(action)
+      else
+        # check store for value
+        a_state = Isomorfeus.store.get_state
+        if a_state.key?(:application_state) && a_state[:application_state].key?(key)
+          return a_state[:application_state][key]
+        end
+
+        # otherwise return nil
+        return nil
+      end
+    end
+
+    alias [] method_missing
+    alias []= method_missing
+
+    alias get method_missing
+    alias set method_missing
+
+    def promise_get(key)
+      Promise.new.resolve(get(key))
+    end
+
+    def promise_set(key, value)
+      Promise.new.resolve(set(key, value))
+    end
+
+    def subscribe(&block)
+      Isomorfeus.store.subscribe(&block)
+    end
+
+    def unsubscribe(unsubscriber)
+      `unsubscriber()`
+    end
+  end
+end

data/lib/isomorfeus-redux.rb

@@ -1,13 +1,20 @@
 require 'opal'
+require 'isomorfeus/execution_environment'
+require 'isomorfeus/core_ext/kernel'
+
 if RUBY_ENGINE == 'opal'
   require 'native'
   require 'promise'
+  require 'securerandom'
   require 'isomorfeus/core_ext/hash/deep_merge'
-  require 'isomorfeus/execution_environment'
   require 'redux'
   require 'redux/store'
   require 'redux/reducers'
   require 'isomorfeus/redux_config'
+  require 'isomorfeus/browser_store_api'
+  require 'local_store'
+  require 'session_store'
+  require 'app_store'
 
   Redux::Reducers::add_application_reducers_to_store
   Isomorfeus.init_store
@@ -16,7 +23,6 @@ else
   promise_path = File.join(opal_path, 'stdlib', 'promise.rb')
   require promise_path
   require 'redux/version'
-  require 'isomorfeus/execution_environment'
 
   Opal.append_path(__dir__.untaint)
 

data/lib/isomorfeus/browser_store_api.rb

@@ -0,0 +1,43 @@
+module Isomorfeus
+  module BrowserStoreApi
+    def promise_get(key)
+      Promise.new.resolve(get(key))
+    end
+
+    def promise_set(key, value)
+      Promise.new.resolve(set(key, value))
+    end
+
+    def promise_delete(key)
+      Promise.new.resolve(delete(key))
+    end
+
+    def promise_clear
+      Promise.new.resolve(clear)
+    end
+
+    def subscribe(&block)
+      key = SecureRandom.uuid
+      subscribers[key] = block
+      key
+    end
+
+    def unsubscribe(key)
+      subscribers.delete(key)
+      nil
+    end
+
+    def notify_subscribers
+      return if subscribers.empty?
+      after 0 do
+        subscribers.each_value do |block|
+          block.call
+        end
+      end
+    end
+
+    def subscribers
+      @subscribers ||= {}
+    end
+  end
+end

data/lib/isomorfeus/core_ext/kernel.rb

@@ -0,0 +1,30 @@
+module Kernel
+  def promise_after(time_ms)
+    p = Promise.new
+    after(time_ms) { p.resolve(true) }
+    p
+  end
+
+  def on_browser?;   Isomorfeus.on_browser?;   end
+  def on_ssr?;       Isomorfeus.on_ssr?;       end
+  def on_server?;    Isomorfeus.on_server?;    end
+  def on_desktop?;   Isomorfeus.on_desktop?;   end
+  def on_ios?;       Isomorfeus.on_ios?;       end
+  def on_android?;   Isomorfeus.on_android?;   end
+  def on_mobile?;    Isomorfeus.on_mobile?;    end
+  def on_database?;  Isomorfeus.on_database?;  end
+  def on_tvos?;      Isomorfeus.on_tvos?;      end
+  def on_androidtv?; Isomorfeus.on_androidtv?; end
+  def on_tv?;        Isomorfeus.on_tv?;        end
+
+  if RUBY_ENGINE == 'opal'
+    def after(time_ms, &block)
+      `setTimeout(#{block.to_n}, time_ms)`
+    end
+  else
+    def after(time_ms, &block)
+      sleep time_ms/1000
+      block.call
+    end
+  end
+end

data/lib/isomorfeus/execution_environment.rb

@@ -9,6 +9,9 @@ module Isomorfeus
       attr_accessor :on_android
       attr_accessor :on_mobile
       attr_accessor :on_database
+      attr_accessor :on_tvos
+      attr_accessor :on_androidtv
+      attr_accessor :on_tv
 
       def on_browser?
         # true if running on browser
@@ -45,33 +48,59 @@ module Isomorfeus
         @on_mobile
       end
 
+      def on_pad?
+        # true if running on a pad
+        @on_pad
+      end
+
       def on_database?
         # true if running in database context
         @on_database
       end
+
+      def on_tvos?
+        # true if running in react-native on tvOS
+        @on_tvos
+      end
+
+      def on_androidtv?
+        # true if running in react-native on androidtv
+        @on_androidtv
+      end
+
+      def on_tv?
+        # true if running in react-native on a tv
+        @on_tv
+      end
     end
 
-    self.on_ssr      = `(typeof process   === 'object' && typeof process.release === 'object' && typeof process.release.name === 'string' && process.release.name === 'node') ? true : false`
-    self.on_desktop  = `(typeof navigator === 'object' && typeof navigator.userAgent === 'string' && navigator.userAgent.toLowerCase().indexOf(' electron/') > -1) ? true : false`
-    self.on_ios      = `(typeof Platform  === 'object' && typeof Platform.OS === 'string' && Platform.OS.toLowerCase().includes?('ios')) ? true : false`
-    self.on_android  = `(typeof Platform  === 'object' && typeof Platform.OS === 'string' && Platform.OS.toLowerCase().includes?('android')) ? true : false`
-    self.on_mobile   = self.on_ios? || self.on_android?
-    self.on_database = false
-    self.on_browser  = !self.on_ssr? && !self.on_desktop? && !self.on_mobile? && !self.on_database?
-    self.on_server   = false
+    self.on_ssr       = `(typeof process   === 'object' && typeof process.release === 'object' && typeof process.release.name === 'string' && process.release.name === 'node') ? true : false`
+    self.on_desktop   = false
+    self.on_ios       = `(typeof Platform  === 'object' && Platform.OS.toLowerCase().includes('ios')) ? true : false`
+    self.on_android   = `(typeof Platform  === 'object' && Platform.OS.toLowerCase().includes('android')) ? true : false`
+    self.on_pad       = `(typeof Platform  === 'object') ? (Platform.OS.toLowerCase().includes('ios') && Platform.isPad) : false`
+    self.on_tvos      = `(typeof Platform  === 'object') ? (Platform.isTV && Platform.OS.toLowerCase().includes('ios') && Platform.isTVOS) : false`
+    self.on_androidtv = `(typeof Platform  === 'object') ? (Platform.isTV && Platform.OS.toLowerCase().includes('android')) : false`
+    self.on_tv        = `(typeof Platform  === 'object') ? Platform.isTV : false`
+    self.on_mobile    = self.on_ios? || self.on_android?
+    self.on_database  = false
+    self.on_server    = false
+    self.on_browser   = !self.on_ssr? && !self.on_desktop? && !self.on_mobile? && !self.on_database? && !self.on_tv?
   else
     class << self
-      def on_ssr?;      false; end
-      def on_desktop?;  false; end
-      def on_ios?;      false; end
-      def on_android?;  false; end
-      def on_mobile?;   false; end
-      def on_database?; false; end
-      def on_browser?;  false; end
+      def on_ssr?;       false; end
+      def on_desktop?;   false; end
+      def on_ios?;       false; end
+      def on_android?;   false; end
+      def on_mobile?;    false; end
+      def on_pad?;       false; end
+      def on_database?;  false; end
+      def on_browser?;   false; end
+      def on_tvos?;      false; end
+      def on_androidtv?; false; end
+      def on_tv?;        false; end
 
-      def on_server?
-        true # so true ...
-      end
+      def on_server?;    true;  end
     end
   end
 end

data/lib/local_store.rb

@@ -0,0 +1,41 @@
+class LocalStore
+  extend Isomorfeus::BrowserStoreApi
+
+  class << self
+    def method_missing(key, *args, &block)
+      if Isomorfeus.on_browser?
+        if `args.length > 0`
+          key = `key.endsWith('=')` ? key.chop : key
+          value = args[0]
+          `Opal.global.localStorage.setItem(key, value)`
+          notify_subscribers
+          value
+        else
+          # check store for value
+          value = `Opal.global.localStorage.getItem(key)`
+          return value if value
+        end
+      end
+      # otherwise return nil
+      return nil
+    end
+
+    alias [] method_missing
+    alias []= method_missing
+
+    alias get method_missing
+    alias set method_missing
+
+    def delete(key)
+      `Opal.global.localStorage.removeItem(key)`
+      notify_subscribers
+      nil
+    end
+
+    def clear
+      `Opal.global.localStorage.clear()`
+      notify_subscribers
+      nil
+    end
+  end
+end

data/lib/redux/reducers.rb

@@ -10,7 +10,13 @@ module Redux
               action[:set_state]
             else
               new_state = {}.merge!(prev_state) # make a copy of state
-              new_state.merge!(action[:name] => action[:value])
+              if action.key?(:collected)
+                action[:collected].each do |act|
+                  new_state.merge!(act[:name] => act[:value])
+                end
+              else
+                new_state.merge!(action[:name] => action[:value])
+              end
               new_state
             end
           else
@@ -18,8 +24,53 @@ module Redux
           end
         end
 
-        Redux::Store.preloaded_state_merge!(application_state: {})
-        Redux::Store.add_reducers(application_state: app_reducer)
+        instance_reducer = Redux.create_reducer do |prev_state, action|
+          case action[:type]
+          when 'INSTANCE_STATE'
+            if action.key?(:set_state)
+              action[:set_state]
+            else
+              new_state = {}.merge!(prev_state) # make a copy of state
+              if action.key?(:collected)
+                action[:collected].each do |act|
+                  new_state[act[:object_id]] = {} unless new_state.key?(act[:object_id])
+                  new_state[act[:object_id]].merge!(act[:name] => act[:value])
+                end
+              else
+                new_state[action[:object_id]] = {} unless new_state.key?(action[:object_id])
+                new_state[action[:object_id]].merge!(action[:name] => action[:value])
+              end
+              new_state
+            end
+          else
+            prev_state
+          end
+        end
+
+        class_reducer = Redux.create_reducer do |prev_state, action|
+          case action[:type]
+          when 'CLASS_STATE'
+            if action.key?(:set_state)
+              action[:set_state]
+            else
+              new_state = {}.merge!(prev_state) # make a copy of state
+              if action.key?(:collected)
+                action[:collected].each do |act|
+                  new_state[act[:class]] = {} unless new_state.key?(act[:class])
+                  new_state[act[:class]].merge!(act[:name] => act[:value])
+                end
+              else
+                new_state[action[:class]] = {} unless new_state.key?(action[:class])
+                new_state[action[:class]].merge!(action[:name] => action[:value])
+              end
+              new_state
+            end
+          else
+            prev_state
+          end
+        end
+        Redux::Store.preloaded_state_merge!(application_state: {}, instance_state: {}, class_state: {})
+        Redux::Store.add_reducers(application_state: app_reducer, instance_state: instance_reducer, class_state: class_reducer)
       end
     end
   end

data/lib/redux/store.rb

@@ -125,16 +125,18 @@ module Redux
       Hash.new(`this.native.getState()`)
     end
 
-    def merge_and_defer_dispatch(action)
-      if Isomorfeus.on_browser?
+    def collect_and_defer_dispatch(action)
+      if !Isomorfeus.on_ssr?
         type = action.delete(:type)
-        @deferred_actions[type] = {} unless @deferred_actions.key?(type)
-        @deferred_actions[type].deep_merge!(action)
-        @last_dispatch_time = `new Date()`
-        create_deferred_dispatcher(`new Date()`) unless @deferred_dispatcher
+        @deferred_actions[type] = [] unless @deferred_actions.key?(type)
+        @deferred_actions[type].push(action)
+        @last_dispatch_time = `Date.now()`
+        # `console.log(#@last_dispatch_time)`
+        deferred_dispatcher(`Date.now()`) unless @deferred_dispatcher
       else
         dispatch(action)
       end
+      nil
     end
 
     def replace_reducer(next_reducer)
@@ -143,35 +145,39 @@ module Redux
 
     # returns function needed to unsubscribe the listener
     def subscribe(&listener)
-      `this.native.subscribe(function() { return listener$.call(); })`
+      `this.native.subscribe(function() { return listener.$call(); })`
     end
 
     private
 
-    def create_deferred_dispatcher(first)
+    def deferred_dispatcher(first)
       @deferred_dispatcher = true
       %x{
         setTimeout(function() {
-          if (#{wait_longer?(first)}) { #{create_deferred_dispatcher(first)} }
+          if (#{wait_longer?(first)}) { #{deferred_dispatcher(first)} }
           else { #{dispatch_deferred_dispatches} }
-        }, 25)
+        }, 10)
       }
     end
 
     def dispatch_deferred_dispatches
+      # `console.log(Date.now())`
       @deferred_dispatcher = false
       actions = @deferred_actions
       @deferred_actions = {}
       actions.each do |type, data|
-        dispatch({type: type}.merge(data))
+        dispatch(type: type, collected: data)
       end
     end
 
     def wait_longer?(first)
-      t = `new Date()`
-      return false if (`t - first`) > 50 # ms
-      return false if (`t - #@last_dispatch_time`) > 10 # ms
+      t = `Date.now()`
+      time_since_first = `t - first`
+      # `console.log('delta', time_since_first)`
+      return true if `typeof Opal.React !== 'undefined' && typeof Opal.React.render_buffer !== 'undefined' && Opal.React.render_buffer.length > 0 && time_since_first < 1000`
+      return false if time_since_first > 100 # ms
+      return false if (`t - #@last_dispatch_time`) > 9 # ms
       return true
     end
   end
-end
+end

data/lib/redux/version.rb

@@ -1,3 +1,3 @@
 module Redux
-  VERSION = '4.0.19'
+  VERSION = '4.1.0'
 end

data/lib/session_store.rb

@@ -0,0 +1,41 @@
+class SessionStore
+  extend Isomorfeus::BrowserStoreApi
+
+  class << self
+    def method_missing(key, *args, &block)
+      if Isomorfeus.on_browser?
+        if `args.length > 0`
+          key = `key.endsWith('=')` ? key.chop : key
+          value = args[0]
+          `Opal.global.sessionStorage.setItem(key, value)`
+          notify_subscribers
+          value
+        else
+          # check store for value
+          value = `Opal.global.sessionStorage.getItem(key)`
+          return value if value
+        end
+      end
+      # otherwise return nil
+      return nil
+    end
+
+    alias [] method_missing
+    alias []= method_missing
+
+    alias get method_missing
+    alias set method_missing
+
+    def delete(key)
+      `Opal.global.sessionStorage.removeItem(key)`
+      notify_subscribers
+      nil
+    end
+
+    def clear
+      `Opal.global.sessionStorage.clear()`
+      notify_subscribers
+      nil
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: isomorfeus-redux
 version: !ruby/object:Gem::Version
-  version: 4.0.19
+  version: 4.1.0
 platform: ruby
 authors:
 - Jan Biedermann
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-02-22 00:00:00.000000000 Z
+date: 2021-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opal
@@ -38,7 +38,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Use a global store and write reducers for it in Opal Ruby.
+description: Use different stores within Isomorfeus and write reducers for redux.
 email:
 - jan@kursator.com
 executables: []
@@ -46,21 +46,25 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
+- lib/app_store.rb
 - lib/isomorfeus-redux.rb
+- lib/isomorfeus/browser_store_api.rb
 - lib/isomorfeus/core_ext/hash/deep_merge.rb
+- lib/isomorfeus/core_ext/kernel.rb
 - lib/isomorfeus/execution_environment.rb
-- lib/isomorfeus/promise.rb
 - lib/isomorfeus/redux_config.rb
+- lib/local_store.rb
 - lib/redux.rb
 - lib/redux/reducers.rb
 - lib/redux/store.rb
 - lib/redux/version.rb
+- lib/session_store.rb
 homepage: http://isomorfeus.com
 licenses:
 - MIT
 metadata:
   github_repo: ssh://github.com/isomorfeus/gems
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -75,8 +79,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
-summary: Redux for Opal Ruby.
+summary: Redux and Stores for Isomorfeus.
 test_files: []

data/lib/isomorfeus/promise.rb

@@ -1,3 +0,0 @@
-opal_path = Gem::Specification.find_by_name('opal').full_gem_path
-promise_path = File.join(opal_path, 'stdlib', 'promise.rb')
-require promise_path