ar_sync 1.0.3 → 1.1.0

data/src/core/hooks.ts

@@ -4,30 +4,35 @@ import ArSyncModel from './ArSyncModel'
 let useState: <T>(t: T | (() => T)) => [T, (t: T | ((t: T) => T)) => void]
 let useEffect: (f: (() => void) | (() => (() => void)), deps: any[]) => void
 let useMemo: <T>(f: () => T, deps: any[]) => T
+let useRef: <T>(value: T) => { current: T }
 type InitializeHooksParams = {
   useState: typeof useState
   useEffect: typeof useEffect
   useMemo: typeof useMemo
+  useRef: typeof useRef
 }
 export function initializeHooks(hooks: InitializeHooksParams) {
   useState = hooks.useState
   useEffect = hooks.useEffect
   useMemo = hooks.useMemo
+  useRef = hooks.useRef
 }
 function checkHooks() {
-  if (!useState) throw 'uninitialized. needs `initializeHooks({ useState, useEffect, useMemo })`'
+  if (!useState) throw 'uninitialized. needs `initializeHooks({ useState, useEffect, useMemo, useRef })`'
 }
 
 interface ModelStatus { complete: boolean; notfound?: boolean; connected: boolean }
 export type DataAndStatus<T> = [T | null, ModelStatus]
-export interface Request { api: string; params?: any; query: any }
+export interface Request { api: string; params?: any; id?: number; query: any }
 
 const initialResult: DataAndStatus<any> = [null, { complete: false, notfound: undefined, connected: true }]
 export function useArSyncModel<T>(request: Request | null): DataAndStatus<T> {
   checkHooks()
   const [result, setResult] = useState<DataAndStatus<T>>(initialResult)
-  const requestString = JSON.stringify(request && request.params)
+  const requestString = JSON.stringify(request?.id ?? request?.params)
+  const prevRequestStringRef = useRef(requestString)
   useEffect(() => {
+    prevRequestStringRef.current = requestString
     if (!request) {
       setResult(initialResult)
       return () => {}
@@ -36,8 +41,9 @@ export function useArSyncModel<T>(request: Request | null): DataAndStatus<T> {
     function update() {
       const { complete, notfound, connected, data } = model
       setResult(resultWas => {
-        const [, statusWas] = resultWas
+        const [dataWas, statusWas] = resultWas
         const statusPersisted = statusWas.complete === complete && statusWas.notfound === notfound && statusWas.connected === connected
+        if (dataWas === data && statusPersisted) return resultWas
         const status = statusPersisted ? statusWas : { complete, notfound, connected }
         return [data, status]
       })
@@ -47,21 +53,37 @@ export function useArSyncModel<T>(request: Request | null): DataAndStatus<T> {
     } else {
       setResult(initialResult)
     }
+    model.subscribe('load', update)
     model.subscribe('change', update)
     model.subscribe('connection', update)
     return () => model.release()
   }, [requestString])
-  return result
+  return prevRequestStringRef.current === requestString ? result : initialResult
 }
 
 interface FetchStatus { complete: boolean; notfound?: boolean }
 type DataStatusUpdate<T> = [T | null, FetchStatus, () => void]
 type FetchState<T> = { data: T | null; status: FetchStatus }
 const initialFetchState: FetchState<any> = { data: null, status: { complete: false, notfound: undefined } }
+
+function extractParams(query: unknown, output: any[] = []): any[] {
+  if (typeof(query) !== 'object' || query == null || Array.isArray(query)) return output
+  if ('params' in query) output.push((query as { params: any }).params)
+  for (const key in query) {
+    extractParams(query[key], output)
+  }
+  return output
+}
+
 export function useArSyncFetch<T>(request: Request | null): DataStatusUpdate<T> {
   checkHooks()
   const [state, setState] = useState<FetchState<T>>(initialFetchState)
-  const requestString = JSON.stringify(request && request.params)
+  const query = request && request.query
+  const resourceIdentifier = request?.id ?? request?.params
+  const requestString = useMemo(() => {
+    return JSON.stringify(extractParams(query, [resourceIdentifier]))
+  }, [query, resourceIdentifier])
+  const prevRequestStringRef = useRef(requestString)
   const loader = useMemo(() => {
     let lastLoadId = 0
     let timer: null | number = null
@@ -100,9 +122,11 @@ export function useArSyncFetch<T>(request: Request | null): DataStatusUpdate<T>
     return { update, cancel }
   }, [requestString])
   useEffect(() => {
+    prevRequestStringRef.current = requestString
     setState(initialFetchState)
     loader.update()
     return () => loader.cancel()
   }, [requestString])
-  return [state.data, state.status, loader.update]
+  const responseState = prevRequestStringRef.current === requestString ? state : initialFetchState
+  return [responseState.data, responseState.status, loader.update]
 }

data/tsconfig.json

@@ -1,10 +1,10 @@
 {
   "compilerOptions": {
-    "incremental": true,
     "outDir": ".",
     "rootDir": "./src",
     "module": "commonjs",
-    "target": "es2017",
+    "target": "es5",
+    "lib": ["es2017", "dom"],
     "strictNullChecks": true,
     "noUnusedLocals": true,
     "noUnusedParameters": true,

data/vendor/assets/javascripts/{ar_sync_actioncable_adapter.js.erb → ar_sync_action_cable_adapter.js.erb}

@@ -2,6 +2,6 @@
   var modules = { actioncable: window.ActionCable }
   var exports = {}
   function require(name) { return modules[name] }
-  <%= File.read File.dirname(__FILE__) + '/../../../core/ActioncableAdapter.js' %>
+  <%= File.read File.dirname(__FILE__) + '/../../../core/ActionCableAdapter.js' %>
   window.ArSyncActionCableAdapter = ActionCableAdapter
 }())

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ar_sync
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - tompng
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-12-16 00:00:00.000000000 Z
+date: 2022-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -28,16 +28,16 @@ dependencies:
   name: ar_serializer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -101,6 +101,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".travis.yml"
 - Gemfile
@@ -111,8 +112,8 @@ files:
 - ar_sync.gemspec
 - bin/console
 - bin/setup
-- core/ActioncableAdapter.d.ts
-- core/ActioncableAdapter.js
+- core/ActionCableAdapter.d.ts
+- core/ActionCableAdapter.js
 - core/ArSyncApi.d.ts
 - core/ArSyncApi.js
 - core/ArSyncModel.d.ts
@@ -127,6 +128,8 @@ files:
 - core/DataType.js
 - core/hooks.d.ts
 - core/hooks.js
+- gemfiles/Gemfile-rails-6
+- gemfiles/Gemfile-rails-7
 - index.d.ts
 - index.js
 - lib/ar_sync.rb
@@ -134,7 +137,6 @@ files:
 - lib/ar_sync/collection.rb
 - lib/ar_sync/config.rb
 - lib/ar_sync/core.rb
-- lib/ar_sync/field.rb
 - lib/ar_sync/instance_methods.rb
 - lib/ar_sync/rails.rb
 - lib/ar_sync/type_script.rb
@@ -143,7 +145,7 @@ files:
 - lib/generators/ar_sync/types/types_generator.rb
 - package-lock.json
 - package.json
-- src/core/ActioncableAdapter.ts
+- src/core/ActionCableAdapter.ts
 - src/core/ArSyncApi.ts
 - src/core/ArSyncModel.ts
 - src/core/ArSyncStore.ts
@@ -154,12 +156,12 @@ files:
 - src/index.ts
 - tsconfig.json
 - vendor/assets/javascripts/ar_sync.js.erb
-- vendor/assets/javascripts/ar_sync_actioncable_adapter.js.erb
+- vendor/assets/javascripts/ar_sync_action_cable_adapter.js.erb
 homepage: https://github.com/tompng/ar_sync
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -174,9 +176,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: ActiveRecord - JavaScript Sync
 test_files: []

data/core/ActioncableAdapter.js

@@ -1,29 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-class ActionCableAdapter {
-    constructor(actionCableClass) {
-        this.connected = true;
-        this.actionCableClass = actionCableClass;
-        this.subscribe(Math.random().toString(), () => { });
-    }
-    subscribe(key, received) {
-        const disconnected = () => {
-            if (!this.connected)
-                return;
-            this.connected = false;
-            this.ondisconnect();
-        };
-        const connected = () => {
-            if (this.connected)
-                return;
-            this.connected = true;
-            this.onreconnect();
-        };
-        if (!this._cable)
-            this._cable = this.actionCableClass.createConsumer();
-        return this._cable.subscriptions.create({ channel: 'SyncChannel', key }, { received, disconnected, connected });
-    }
-    ondisconnect() { }
-    onreconnect() { }
-}
-exports.default = ActionCableAdapter;

data/lib/ar_sync/field.rb

@@ -1,96 +0,0 @@
-class ArSync::Field
-  attr_reader :name
-  def initialize(name)
-    @name = name
-  end
-
-  def skip_propagation?(_parent, _child, _path)
-    false
-  end
-
-  def action_convert(action)
-    action
-  end
-
-  def order_param; end
-end
-
-class ArSync::DataField < ArSync::Field
-  def type
-    :data
-  end
-
-  def data(parent, _child, to_user:, **)
-    ArSync.serialize parent, name, user: to_user
-  end
-
-  def path(_child)
-    []
-  end
-
-  def action_convert(_action)
-    :update
-  end
-
-  def skip_propagation?(_parent, _child, path)
-    !path.nil?
-  end
-end
-
-class ArSync::HasOneField < ArSync::Field
-  def type
-    :one
-  end
-
-  def data(_parent, child, action:, **)
-    child._sync_data new_record: action == :create
-  end
-
-  def path(_child)
-    [name]
-  end
-end
-
-class ArSync::HasManyField < ArSync::Field
-  attr_reader :limit, :order, :association, :propagate_when
-  def type
-    :many
-  end
-
-  def initialize(name, association: nil, limit: nil, order: nil, propagate_when: nil)
-    super name
-    @limit = limit
-    @order = order
-    @association = association || name
-    @propagate_when = propagate_when
-  end
-
-  def skip_propagation?(parent, child, _path)
-    return false unless limit
-    return !propagate_when.call(child) if propagate_when
-    ids = parent.send(association).order(id: order).limit(limit).ids
-    if child.destroyed?
-      ids.size == limit && (order == :asc ? ids.max < child.id : child.id < ids.min)
-    else
-      !ids.include? child.id
-    end
-  end
-
-  def data(_parent, child, action:, **)
-    child._sync_data new_record: action == :create
-  end
-
-  def order_param
-    { limit: limit, order: order } if order
-  end
-
-  def path(child)
-    [name, child.id]
-  end
-end
-
-class ArSync::CollectionField < ArSync::HasManyField
-  def path(child)
-    [child.id]
-  end
-end