jason-rails 0.3.0

data/client/src/createJasonReducers.ts

@@ -0,0 +1,34 @@
+import { createEntityAdapter, createSlice } from '@reduxjs/toolkit'
+import pluralize from 'pluralize'
+import _ from 'lodash'
+
+function generateSlices(schema) {
+  const sliceNames = schema.map(k => pluralize(k))
+  const adapter = createEntityAdapter()
+
+  return _.fromPairs(_.map(sliceNames, name => {
+    return [name, createSlice({
+      name,
+      initialState: adapter.getInitialState(),
+      reducers: {
+        upsert: adapter.upsertOne,
+        upsertMany: adapter.upsertMany,
+        add: adapter.addOne,
+        setAll: adapter.setAll,
+        remove: adapter.removeOne,
+        movePriority: (s, { payload: { id, priority, parentFilter } }) => {
+          // Get IDs and insert our item at the new index
+          var affectedIds = _.orderBy(_.filter(_.values(s.entities), parentFilter).filter(e => e.id !== id), 'priority').map(e => e.id)
+          affectedIds.splice(priority, 0, id)
+
+          // Apply update
+          affectedIds.forEach((id, i) => (s.entities[id] as any).priority = i)
+        }
+      }
+    }).reducer]
+  }))
+}
+
+export default function createJasonReducers(schema) {
+  return generateSlices(_.keys(schema))
+}

data/client/src/createPayloadHandler.ts

@@ -0,0 +1,95 @@
+import { apply_patch } from 'jsonpatch'
+import { camelizeKeys } from 'humps'
+import pluralize from 'pluralize'
+import _ from 'lodash'
+
+function diffSeconds(dt2, dt1) {
+  var diff =(dt2.getTime() - dt1.getTime()) / 1000
+  return Math.abs(Math.round(diff))
+}
+
+export default function createPayloadHandler(dispatch, subscription, model, config) {
+  console.log({ model, config })
+  let payload = {}
+  let idx = 0
+  let patchQueue = {}
+
+  let lastCheckAt = new Date()
+  let updateDeadline = null as Date | null
+  let checkInterval
+
+  function getPayload() {
+    console.log({ getPayload: model, subscription })
+    subscription.send({ getPayload: { model, config } })
+  }
+
+  const tGetPayload = _.throttle(getPayload, 10000)
+
+  function dispatchPayload() {
+    const includeModels = (config.includeModels || []).map(m => _.camelCase(m))
+
+    console.log("Dispatching", { payload, includeModels })
+
+    includeModels.forEach(m => {
+      const subPayload = _.flatten(_.compact(camelizeKeys(payload).map(instance => instance[m])))
+      console.log({ type: `${pluralize(m)}/upsertMany`, payload: subPayload })
+      dispatch({ type: `${pluralize(m)}/upsertMany`, payload: subPayload })
+    })
+
+    dispatch({ type: `${pluralize(model)}/upsertMany`, payload: camelizeKeys(payload) })
+  }
+
+  function processQueue() {
+    console.log({ idx, patchQueue })
+    lastCheckAt = new Date()
+    if (patchQueue[idx]) {
+      payload = apply_patch(payload, patchQueue[idx])
+      if (patchQueue[idx]) {
+        dispatchPayload()
+      }
+      delete patchQueue[idx]
+      idx++
+      updateDeadline = null
+      processQueue()
+    // If there are updates in the queue that are ahead of the index, some have arrived out of order
+    // Set a deadline for new updates before it declares the update missing and refetches.
+    } else if (_.keys(patchQueue).length > 0 && !updateDeadline) {
+      var t = new Date()
+      t.setSeconds(t.getSeconds() + 3)
+      updateDeadline = t
+      setTimeout(processQueue, 3100)
+    // If more than 10 updates in queue, or deadline has passed, restart
+    } else if (_.keys(patchQueue).length > 10 || (updateDeadline && diffSeconds(updateDeadline, new Date()) < 0)) {
+      tGetPayload()
+      updateDeadline = null
+    }
+  }
+
+  function handlePayload(data) {
+    const { value, idx: newIdx, diff, latency, type } = data
+    console.log({ data })
+
+    if (type === 'payload') {
+      if (!value) return null;
+
+      payload = value
+      dispatchPayload()
+      idx = newIdx + 1
+      // Clear any old changes left in the queue
+      patchQueue= _.pick(patchQueue, _.keys(patchQueue).filter(k => k > newIdx + 1))
+      return
+    }
+
+    patchQueue[newIdx] = diff
+
+    processQueue()
+
+    if (diffSeconds((new Date()), lastCheckAt) >= 3) {
+      lastCheckAt = new Date()
+      console.log('Interval lost. Pulling from server')
+      tGetPayload()
+    }
+  }
+
+  return handlePayload
+}

data/client/src/index.ts

@@ -0,0 +1,7 @@
+import _JasonProvider from './JasonProvider'
+import _useAct from './useAct'
+import _useSub from './useSub'
+
+export const JasonProvider = _JasonProvider
+export const useAct = _useAct
+export const useSub = _useSub

data/client/src/makeEager.ts

@@ -0,0 +1,46 @@
+import pluralize from 'pluralize'
+import _ from 'lodash'
+import { useSelector } from 'react-redux'
+
+export default function (schema) {
+  function addRelations(s, objects, objectType, relations) {
+    // first find out relation name
+    if (_.isArray(relations)) {
+      relations.forEach(relation => {
+        objects = addRelations(s, objects, objectType, relation)
+      })
+    } else if (typeof(relations) === 'object') {
+      const relation = Object.keys(relations)[0]
+      const subRelations = relations[relation]
+
+      objects = addRelations(s, objects, objectType, relation)
+      objects[relation] = addRelations(s, objects[relation], pluralize(relation), subRelations)
+      // #
+    } else if (typeof(relations) === 'string') {
+      const relation = relations
+      if (_.isArray(objects)) {
+        objects = objects.map(obj => addRelations(s, obj, objectType, relation))
+      } else {
+        const relatedObjects = _.values(s[pluralize(relation)].entities)
+
+        if(pluralize.isSingular(relation)) {
+          objects = { ...objects, [relation]: _.find(relatedObjects, { id: objects[relation + 'Id'] }) }
+        } else {
+          objects = { ...objects, [relation]: relatedObjects.filter(e => e[pluralize.singular(objectType) + 'Id'] === objects.id) }
+        }
+      }
+    }
+
+    return objects
+  }
+
+  function useEager(entity, id = null, relations = []) {
+    if (id) {
+      return useSelector(s => addRelations(s, { ...s[entity].entities[String(id)] }, entity, relations))
+    } else {
+      return useSelector(s => addRelations(s, _.values(s[entity].entities), entity, relations))
+    }
+  }
+
+  return useEager
+}

data/client/src/useAct.ts

@@ -0,0 +1,9 @@
+import JasonContext from './JasonContext'
+import { useContext } from 'react'
+
+export default function useAct() {
+  const { actions } = useContext(JasonContext)
+
+  return actions
+}
+

data/client/src/useSub.ts

@@ -0,0 +1,10 @@
+import JasonContext from './JasonContext'
+import { useContext, useEffect } from 'react'
+
+export default function useSub(config) {
+  const subscribe = useContext(JasonContext).subscribe
+
+  useEffect(() => {
+    return subscribe(config)
+  }, [])
+}

data/client/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "target": "es2015",
+    "module": "es2015",
+    "module": "commonjs",
+    "declaration": true,
+    "outDir": "./lib",
+    "strict": true,
+    "noImplicitAny": false,
+    "jsx": "react",
+    "esModuleInterop": true
+  },
+  "include": ["src"],
+  "exclude": ["node_modules", "**/__tests__/*"]
+}

data/client/yarn.lock

@@ -0,0 +1,140 @@
+# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+# yarn lockfile v1
+
+
+"@rails/actioncable@^6.0.3-4":
+  version "6.0.3-4"
+  resolved "https://registry.yarnpkg.com/@rails/actioncable/-/actioncable-6.0.3-4.tgz#f17c0ef2235d1624d6052b749005608260bd55ef"
+  integrity sha512-uie5McTpl69vHnXCVzKj7iYpVKFfLuE7aqul/I7MX5zVd+yVyyC/g75T1Q10GofyqHYNYWgPiIxgQIoYPyyeKw==
+
+axios-case-converter@^0.6.0:
+  version "0.6.0"
+  resolved "https://registry.yarnpkg.com/axios-case-converter/-/axios-case-converter-0.6.0.tgz#7a99120138046ad6faaf1fc2b638fea0fe63f26f"
+  integrity sha512-mlpaFFTBlv+o+NL2YPSWfC8BQv3qUesxTYD0N11/8dgrg0aDbxUaAglromCBI+0NUcfenM42xMGEUhzTtWZqKg==
+  dependencies:
+    camel-case "^4.1.1"
+    header-case "^2.0.3"
+    snake-case "^3.0.3"
+
+axios@^0.21.0:
+  version "0.21.0"
+  resolved "https://registry.yarnpkg.com/axios/-/axios-0.21.0.tgz#26df088803a2350dff2c27f96fef99fe49442aca"
+  integrity sha512-fmkJBknJKoZwem3/IKSSLpkdNXZeBu5Q7GA/aRsr2btgrptmSCxi2oFjZHqGdK9DoTil9PIHlPIZw2EcRJXRvw==
+  dependencies:
+    follow-redirects "^1.10.0"
+
+blueimp-md5@^2.18.0:
+  version "2.18.0"
+  resolved "https://registry.yarnpkg.com/blueimp-md5/-/blueimp-md5-2.18.0.tgz#1152be1335f0c6b3911ed9e36db54f3e6ac52935"
+  integrity sha512-vE52okJvzsVWhcgUHOv+69OG3Mdg151xyn41aVQN/5W5S+S43qZhxECtYLAEHMSFWX6Mv5IZrzj3T5+JqXfj5Q==
+
+camel-case@^4.1.1:
+  version "4.1.2"
+  resolved "https://registry.yarnpkg.com/camel-case/-/camel-case-4.1.2.tgz#9728072a954f805228225a6deea6b38461e1bd5a"
+  integrity sha512-gxGWBrTT1JuMx6R+o5PTXMmUnhnVzLQ9SNutD4YqKtI6ap897t3tKECYla6gCWEkplXnlNybEkZg9GEGxKFCgw==
+  dependencies:
+    pascal-case "^3.1.2"
+    tslib "^2.0.3"
+
+capital-case@^1.0.4:
+  version "1.0.4"
+  resolved "https://registry.yarnpkg.com/capital-case/-/capital-case-1.0.4.tgz#9d130292353c9249f6b00fa5852bee38a717e669"
+  integrity sha512-ds37W8CytHgwnhGGTi88pcPyR15qoNkOpYwmMMfnWqqWgESapLqvDx6huFjQ5vqWSn2Z06173XNA7LtMOeUh1A==
+  dependencies:
+    no-case "^3.0.4"
+    tslib "^2.0.3"
+    upper-case-first "^2.0.2"
+
+dot-case@^3.0.4:
+  version "3.0.4"
+  resolved "https://registry.yarnpkg.com/dot-case/-/dot-case-3.0.4.tgz#9b2b670d00a431667a8a75ba29cd1b98809ce751"
+  integrity sha512-Kv5nKlh6yRrdrGvxeJ2e5y2eRUpkUosIW4A2AS38zwSz27zu7ufDwQPi5Jhs3XAlGNetl3bmnGhQsMtkKJnj3w==
+  dependencies:
+    no-case "^3.0.4"
+    tslib "^2.0.3"
+
+follow-redirects@^1.10.0:
+  version "1.13.0"
+  resolved "https://registry.yarnpkg.com/follow-redirects/-/follow-redirects-1.13.0.tgz#b42e8d93a2a7eea5ed88633676d6597bc8e384db"
+  integrity sha512-aq6gF1BEKje4a9i9+5jimNFIpq4Q1WiwBToeRK5NvZBd/TRsmW8BsJfOEGkr76TbOyPVD3OVDN910EcUNtRYEA==
+
+header-case@^2.0.3:
+  version "2.0.4"
+  resolved "https://registry.yarnpkg.com/header-case/-/header-case-2.0.4.tgz#5a42e63b55177349cf405beb8d775acabb92c063"
+  integrity sha512-H/vuk5TEEVZwrR0lp2zed9OCo1uAILMlx0JEMgC26rzyJJ3N1v6XkwHHXJQdR2doSjcGPM6OKPYoJgf0plJ11Q==
+  dependencies:
+    capital-case "^1.0.4"
+    tslib "^2.0.3"
+
+humps@^2.0.1:
+  version "2.0.1"
+  resolved "https://registry.yarnpkg.com/humps/-/humps-2.0.1.tgz#dd02ea6081bd0568dc5d073184463957ba9ef9aa"
+  integrity sha1-3QLqYIG9BWjcXQcxhEY5V7qe+ao=
+
+jsonpatch@^3.0.1:
+  version "3.0.1"
+  resolved "https://registry.yarnpkg.com/jsonpatch/-/jsonpatch-3.0.1.tgz#97225367c1c3c5bf1641be59b2f73be19759f06f"
+  integrity sha1-lyJTZ8HDxb8WQb5Zsvc74ZdZ8G8=
+
+lodash@^4.17.20:
+  version "4.17.20"
+  resolved "https://registry.yarnpkg.com/lodash/-/lodash-4.17.20.tgz#b44a9b6297bcb698f1c51a3545a2b3b368d59c52"
+  integrity sha512-PlhdFcillOINfeV7Ni6oF1TAEayyZBoZ8bcshTHqOYJYlrqzRK5hagpagky5o4HfCzzd1TRkXPMFq6cKk9rGmA==
+
+lower-case@^2.0.2:
+  version "2.0.2"
+  resolved "https://registry.yarnpkg.com/lower-case/-/lower-case-2.0.2.tgz#6fa237c63dbdc4a82ca0fd882e4722dc5e634e28"
+  integrity sha512-7fm3l3NAF9WfN6W3JOmf5drwpVqX78JtoGJ3A6W0a6ZnldM41w2fV5D490psKFTpMds8TJse/eHLFFsNHHjHgg==
+  dependencies:
+    tslib "^2.0.3"
+
+no-case@^3.0.4:
+  version "3.0.4"
+  resolved "https://registry.yarnpkg.com/no-case/-/no-case-3.0.4.tgz#d361fd5c9800f558551a8369fc0dcd4662b6124d"
+  integrity sha512-fgAN3jGAh+RoxUGZHTSOLJIqUc2wmoBwGR4tbpNAKmmovFoWq0OdRkb0VkldReO2a2iBT/OEulG9XSUc10r3zg==
+  dependencies:
+    lower-case "^2.0.2"
+    tslib "^2.0.3"
+
+pascal-case@^3.1.2:
+  version "3.1.2"
+  resolved "https://registry.yarnpkg.com/pascal-case/-/pascal-case-3.1.2.tgz#b48e0ef2b98e205e7c1dae747d0b1508237660eb"
+  integrity sha512-uWlGT3YSnK9x3BQJaOdcZwrnV6hPpd8jFH1/ucpiLRPh/2zCVJKS19E4GvYHvaCcACn3foXZ0cLB9Wrx1KGe5g==
+  dependencies:
+    no-case "^3.0.4"
+    tslib "^2.0.3"
+
+pluralize@^8.0.0:
+  version "8.0.0"
+  resolved "https://registry.yarnpkg.com/pluralize/-/pluralize-8.0.0.tgz#1a6fa16a38d12a1901e0320fa017051c539ce3b1"
+  integrity sha512-Nc3IT5yHzflTfbjgqWcCPpo7DaKy4FnpB0l/zCAW0Tc7jxAiuqSxHasntB3D7887LSrA93kDJ9IXovxJYxyLCA==
+
+snake-case@^3.0.3:
+  version "3.0.4"
+  resolved "https://registry.yarnpkg.com/snake-case/-/snake-case-3.0.4.tgz#4f2bbd568e9935abdfd593f34c691dadb49c452c"
+  integrity sha512-LAOh4z89bGQvl9pFfNF8V146i7o7/CqFPbqzYgP+yYzDIDeS9HaNFtXABamRW+AQzEVODcvE79ljJ+8a9YSdMg==
+  dependencies:
+    dot-case "^3.0.4"
+    tslib "^2.0.3"
+
+tslib@^2.0.3:
+  version "2.0.3"
+  resolved "https://registry.yarnpkg.com/tslib/-/tslib-2.0.3.tgz#8e0741ac45fc0c226e58a17bfc3e64b9bc6ca61c"
+  integrity sha512-uZtkfKblCEQtZKBF6EBXVZeQNl82yqtDQdv+eck8u7tdPxjLu2/lp5/uPW+um2tpuxINHWy3GhiccY7QgEaVHQ==
+
+typescript@^4.1.2:
+  version "4.1.2"
+  resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.1.2.tgz#6369ef22516fe5e10304aae5a5c4862db55380e9"
+  integrity sha512-thGloWsGH3SOxv1SoY7QojKi0tc+8FnOmiarEGMbd/lar7QOEd3hvlx3Fp5y6FlDUGl9L+pd4n2e+oToGMmhRQ==
+
+upper-case-first@^2.0.2:
+  version "2.0.2"
+  resolved "https://registry.yarnpkg.com/upper-case-first/-/upper-case-first-2.0.2.tgz#992c3273f882abd19d1e02894cc147117f844324"
+  integrity sha512-514ppYHBaKwfJRK/pNC6c/OxfGa0obSnAl106u97Ed0I625Nin96KAjttZF6ZL3e1XLtphxnqrOi9iWgm+u+bg==
+  dependencies:
+    tslib "^2.0.3"
+
+uuid@^8.3.1:
+  version "8.3.1"
+  resolved "https://registry.yarnpkg.com/uuid/-/uuid-8.3.1.tgz#2ba2e6ca000da60fce5a196954ab241131e05a31"
+  integrity sha512-FOmRr+FmWEIG8uhZv6C2bTgEVXsHk08kE7mPlrBbEe+c3r9pjceVPgupIfNIhc4yx55H69OXANrUaSuu9eInKg==

data/jason-rails.gemspec

@@ -0,0 +1,25 @@
+require_relative 'lib/jason/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jason-rails"
+  spec.version       = Jason::VERSION
+  spec.authors       = ["James Rees"]
+  spec.email         = ["jarees@gmail.com"]
+
+  spec.summary       = "Reactive user interfaces with minimal boilerplate, using Rails + Redux"
+  spec.homepage      = "https://github.com/jamesr2323/jason"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/jamesr2323/jason"
+  spec.metadata["changelog_uri"] = "https://github.com/jamesr2323/jason"
+
+  # 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(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.executables   = []
+  spec.require_paths = ["lib"]
+end

data/lib/jason.rb

@@ -0,0 +1,10 @@
+require "jason/version"
+require 'jason/api_model'
+require 'jason/channel'
+require 'jason/publisher'
+require 'jason/subscription'
+
+module Jason
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/jason/api_model.rb

@@ -0,0 +1,47 @@
+class Jason::ApiModel
+  cattr_accessor :models
+  attr_accessor :model, :name
+
+  def self.configure(models)
+    @@models = models
+  end
+
+  def initialize(name)
+    @name = name
+    @model = OpenStruct.new(JASON_API_MODEL[name.to_sym])
+  end
+
+  def allowed_params
+    model.allowed_params || []
+  end
+
+  def include_models
+    model.include_models || []
+  end
+
+  def include_methods
+    model.include_methods || []
+  end
+
+  def priority_scope
+    model.priority_scope || []
+  end
+
+  def subscribed_fields
+    model.subscribed_fields || []
+  end
+
+  def scope
+    model.scope
+  end
+
+  def as_json_config
+    include_configs = include_models.map do |assoc|
+      reflection = name.classify.constantize.reflect_on_association(assoc.to_sym)
+      api_model = Jason::ApiModel.new(reflection.klass.name.underscore)
+      { assoc => { only: api_model.subscribed_fields, methods: api_model.include_methods } }
+    end
+
+    { only: subscribed_fields, include: include_configs, methods: include_methods }
+  end
+end