jason-rails 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2883964fb830dbb506a0e845caa3398436d72262f72cc6b295efce14dcc96346
-  data.tar.gz: 631d00d04195b1e1f48111ca5a6cc02775488e48f94ab5d8d29783a66a6c91a8
+  metadata.gz: 4231946f3742dee57b9eb0eff4a7367691a1ddff2a2842fbba8ffde0c4f5d460
+  data.tar.gz: c701f79deb2e23b464b4f15f96442084fb4837d429e87715007b6cc41e31ba9c
 SHA512:
-  metadata.gz: 6de81fcdba79fc067fe7515ad83be895e30d19686e548bfb774026993ab965cf6f0aaa9cebcd4807448e5218c8c9609f414e6ec05d5eb717aef880e3f2e012ea
-  data.tar.gz: adb6476af69fe904588f55214b930959a0b0d1d2357c3edafca77cc4f8d528a72cb0f72cde6dbec4e097e58d6e5758a2c429419cd9ad60f02d0352dd9abe385b
+  metadata.gz: 1222df088d647e53b24a735cd9c85b1cf926831171cb21ebd628b67f12fb320003fca93272d94e8173b13d30c21c6ca3cbd55899d604bb2d572196efeb56e8b3
+  data.tar.gz: 34ba69d74e1a6729bd88695ff56d62ea40abf3a804065c9803380bd16c948b9cfea51d33eae986cdc3e240db8f051cda2678a63bebfa87e2c144484f2f0f027b

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    jason-rails (0.3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    rake (12.3.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jason-rails!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.3

data/README.md

@@ -14,23 +14,20 @@ Jason attempts to minimize this repitition by auto-generating API endpoints, red
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add the gem and the NPM package
 
 ```ruby
 gem 'jason-rails'
 ```
 
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
-
-    $ gem install jason
+```bash
+  yarn add @jamesr2323/jason
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+### Define your schema
+
 
 ## Development
 

data/app/assets/config/jason_engine_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/jason/engine .css

data/app/assets/stylesheets/jason/engine/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/jason/api_controller.rb

@@ -0,0 +1,36 @@
+class Jason::ApiController < ::ApplicationController
+  def schema
+    render json: JASON_API_MODEL.to_json
+  end
+
+  def action
+    type = params[:type]
+    entity = type.split('/')[0].underscore
+    api_model = Jason::ApiModel.new(entity.singularize)
+    model = entity.singularize.camelize.constantize
+    action = type.split('/')[1].underscore
+
+    if action == 'move_priority'
+      id, priority = params[:payload].values_at(:id, :priority)
+
+      instance = model.find(id)
+      priority_filter = instance.as_json.with_indifferent_access.slice(*api_model.priority_scope)
+
+      all_instance_ids = model.send(api_model.scope || :all).where(priority_filter).where.not(id: instance.id).order(:priority).pluck(:id)
+      all_instance_ids.insert(priority.to_i, instance.id)
+
+      all_instance_ids.each_with_index do |id, i|
+        model.find(id).update!(priority: i, skip_publish_json: true)
+      end
+
+      model.publish_all(model.find(all_instance_ids))
+    elsif action == 'upsert' || action == 'add'
+      payload = api_model.permit(params)
+      return render json: model.find_or_create_by_id!(payload).as_json(api_model.as_json_config)
+    elsif action == 'remove'
+      model.find(params[:payload]).destroy!
+    end
+
+    return head :ok
+  end
+end

data/app/helpers/jason/engine/application_helper.rb

@@ -0,0 +1,6 @@
+module Jason
+  module Engine
+    module ApplicationHelper
+    end
+  end
+end

data/app/jobs/jason/engine/application_job.rb

@@ -0,0 +1,6 @@
+module Jason
+  module Engine
+    class ApplicationJob < ActiveJob::Base
+    end
+  end
+end

data/app/mailers/jason/engine/application_mailer.rb

@@ -0,0 +1,8 @@
+module Jason
+  module Engine
+    class ApplicationMailer < ActionMailer::Base
+      default from: 'from@example.com'
+      layout 'mailer'
+    end
+  end
+end

data/app/models/jason/engine/application_record.rb

@@ -0,0 +1,7 @@
+module Jason
+  module Engine
+    class ApplicationRecord < ActiveRecord::Base
+      self.abstract_class = true
+    end
+  end
+end

data/app/views/layouts/jason/engine/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Jason engine</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "jason/engine/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/client/babel.config.js

@@ -0,0 +1,13 @@
+module.exports = {
+  presets: [
+    [
+      '@babel/preset-env',
+      {
+        targets: {
+          node: 'current',
+        },
+      },
+    ],
+    '@babel/preset-typescript'
+  ],
+};

data/client/lib/JasonProvider.d.ts

@@ -1,7 +1,8 @@
+import React from 'react';
 declare const JasonProvider: ({ reducers, middleware, extraActions, children }: {
-    reducers: any;
-    middleware: any;
-    extraActions: any;
-    children: any;
+    reducers?: any;
+    middleware?: any;
+    extraActions?: any;
+    children?: any;
 }) => any;
 export default JasonProvider;

data/client/lib/JasonProvider.js

@@ -31,22 +31,48 @@ const react_redux_1 = require("react-redux");
 const toolkit_1 = require("@reduxjs/toolkit");
 const createJasonReducers_1 = __importDefault(require("./createJasonReducers"));
 const createPayloadHandler_1 = __importDefault(require("./createPayloadHandler"));
+const createOptDis_1 = __importDefault(require("./createOptDis"));
 const makeEager_1 = __importDefault(require("./makeEager"));
 const humps_1 = require("humps");
 const blueimp_md5_1 = __importDefault(require("blueimp-md5"));
 const lodash_1 = __importDefault(require("lodash"));
 const react_1 = __importStar(require("react"));
+const uuid_1 = require("uuid");
 const JasonProvider = ({ reducers, middleware, extraActions, children }) => {
     const [store, setStore] = react_1.useState(null);
     const [value, setValue] = react_1.useState(null);
     const [connected, setConnected] = react_1.useState(false);
     const csrfToken = document.querySelector("meta[name=csrf-token]").content;
     axios_1.default.defaults.headers.common['X-CSRF-Token'] = csrfToken;
-    const restClient = axios_case_converter_1.default(axios_1.default.create());
+    const restClient = axios_case_converter_1.default(axios_1.default.create(), {
+        preservedKeys: (key) => {
+            return uuid_1.validate(key);
+        }
+    });
     react_1.useEffect(() => {
         restClient.get('/jason/api/schema')
             .then(({ data: snakey_schema }) => {
             const schema = humps_1.camelizeKeys(snakey_schema);
+            const serverActionQueue = function () {
+                const queue = [];
+                let inFlight = false;
+                return {
+                    addItem: (item) => queue.push(item),
+                    getItem: () => {
+                        if (inFlight)
+                            return false;
+                        const item = queue.shift();
+                        if (item) {
+                            inFlight = true;
+                            return item;
+                        }
+                        return false;
+                    },
+                    itemProcessed: () => inFlight = false,
+                    fullySynced: () => queue.length === 0 && !inFlight,
+                    getData: () => ({ queue, inFlight })
+                };
+            }();
             const consumer = actioncable_1.createConsumer();
             const allReducers = Object.assign(Object.assign({}, reducers), createJasonReducers_1.default(schema));
             console.log({ schema, allReducers });
@@ -78,7 +104,7 @@ const JasonProvider = ({ reducers, middleware, extraActions, children }) => {
                 const md5Hash = blueimp_md5_1.default(JSON.stringify(config));
                 console.log('Subscribe with', config, md5Hash);
                 lodash_1.default.map(config, (v, model) => {
-                    payloadHandlers[`${model}:${md5Hash}`] = createPayloadHandler_1.default(store.dispatch, subscription, model, schema[model]);
+                    payloadHandlers[`${model}:${md5Hash}`] = createPayloadHandler_1.default(store.dispatch, serverActionQueue, subscription, model, schema[model]);
                 });
                 subscription.send({ createSubscription: config });
                 return () => removeSubscription(config);
@@ -90,7 +116,8 @@ const JasonProvider = ({ reducers, middleware, extraActions, children }) => {
                     delete payloadHandlers[`${model}:${md5Hash}`];
                 });
             }
-            const actions = createActions_1.default(schema, store, restClient, extraActions);
+            const optDis = createOptDis_1.default(schema, store.dispatch, restClient, serverActionQueue);
+            const actions = createActions_1.default(schema, store, restClient, optDis, extraActions);
             const eager = makeEager_1.default(schema);
             console.log({ actions });
             setValue({

data/client/lib/actionFactory.js

@@ -23,7 +23,7 @@ exports.default = (dis, store, entity, { extraActions = {}, hasPriority = false
     function remove(id) {
         return dis({ type: `${pluralize_1.default(entity)}/remove`, payload: id });
     }
-    const extraActionsResolved = lodash_1.default.mapValues(extraActions, v => v(dis, store, entity));
+    const extraActionsResolved = extraActions ? lodash_1.default.mapValues(extraActions, v => v(dis, store, entity)) : {};
     if (hasPriority) {
         return Object.assign({ add, upsert, setAll, remove, movePriority }, extraActionsResolved);
     }

data/client/lib/createActions.d.ts

@@ -1,2 +1,2 @@
-declare function createActions(schema: any, store: any, restClient: any, extraActions: any): any;
+declare function createActions(schema: any, store: any, restClient: any, optDis: any, extraActions: any): any;
 export default createActions;

data/client/lib/createActions.js

@@ -6,32 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const actionFactory_1 = __importDefault(require("./actionFactory"));
 const pluralize_1 = __importDefault(require("pluralize"));
 const lodash_1 = __importDefault(require("lodash"));
-const uuid_1 = require("uuid");
-function enrich(type, payload) {
-    if (type.split('/')[1] === 'upsert' && !(type.split('/')[0] === 'session')) {
-        if (!payload.id) {
-            return Object.assign(Object.assign({}, payload), { id: uuid_1.v4() });
-        }
-    }
-    return payload;
-}
-function makeOptDis(schema, dispatch, restClient) {
-    const plurals = lodash_1.default.keys(schema).map(k => pluralize_1.default(k));
-    return function (action) {
-        const { type, payload } = action;
-        const data = enrich(type, payload);
-        dispatch(action);
-        if (plurals.indexOf(type.split('/')[0]) > -1) {
-            return restClient.post('/jason/api/action', { type, payload: data })
-                .catch(e => {
-                dispatch({ type: 'upsertLocalUi', data: { error: JSON.stringify(e) } });
-            });
-        }
-    };
-}
-function createActions(schema, store, restClient, extraActions) {
-    const dis = store.dispatch;
-    const optDis = makeOptDis(schema, dis, restClient);
+function createActions(schema, store, restClient, optDis, extraActions) {
     const actions = lodash_1.default.fromPairs(lodash_1.default.map(schema, (config, model) => {
         if (config.priorityScope) {
             return [pluralize_1.default(model), actionFactory_1.default(optDis, store, model, { hasPriority: true })];
@@ -40,7 +15,7 @@ function createActions(schema, store, restClient, extraActions) {
             return [pluralize_1.default(model), actionFactory_1.default(optDis, store, model)];
         }
     }));
-    const extraActionsResolved = extraActions(optDis, store, restClient);
+    const extraActionsResolved = extraActions ? extraActions(optDis, store, restClient, actions) : {};
     return lodash_1.default.merge(actions, extraActionsResolved);
 }
 exports.default = createActions;

data/client/lib/createJasonReducers.js

@@ -19,6 +19,7 @@ function generateSlices(schema) {
                     add: adapter.addOne,
                     setAll: adapter.setAll,
                     remove: adapter.removeOne,
+                    removeMany: adapter.removeMany,
                     movePriority: (s, { payload: { id, priority, parentFilter } }) => {
                         // Get IDs and insert our item at the new index
                         var affectedIds = lodash_1.default.orderBy(lodash_1.default.filter(lodash_1.default.values(s.entities), parentFilter).filter(e => e.id !== id), 'priority').map(e => e.id);

data/client/lib/createOptDis.d.ts

@@ -0,0 +1 @@
+export default function createOptDis(schema: any, dispatch: any, restClient: any, serverActionQueue: any): (action: any) => void;

data/client/lib/createOptDis.js

@@ -0,0 +1,45 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const lodash_1 = __importDefault(require("lodash"));
+const pluralize_1 = __importDefault(require("pluralize"));
+const uuid_1 = require("uuid");
+function enrich(type, payload) {
+    if (type.split('/')[1] === 'upsert' && !(type.split('/')[0] === 'session')) {
+        if (!payload.id) {
+            return Object.assign(Object.assign({}, payload), { id: uuid_1.v4() });
+        }
+    }
+    return payload;
+}
+function createOptDis(schema, dispatch, restClient, serverActionQueue) {
+    const plurals = lodash_1.default.keys(schema).map(k => pluralize_1.default(k));
+    let inFlight = false;
+    function enqueueServerAction(action) {
+        serverActionQueue.addItem(action);
+    }
+    function dispatchServerAction() {
+        const action = serverActionQueue.getItem();
+        if (!action)
+            return;
+        inFlight = true;
+        restClient.post('/jason/api/action', action)
+            .then(serverActionQueue.itemProcessed)
+            .catch(e => {
+            dispatch({ type: 'upsertLocalUi', data: { error: JSON.stringify(e) } });
+            serverActionQueue.itemProcessed();
+        });
+    }
+    setInterval(dispatchServerAction, 10);
+    return function (action) {
+        const { type, payload } = action;
+        const data = enrich(type, payload);
+        dispatch({ type, payload: data });
+        if (plurals.indexOf(type.split('/')[0]) > -1) {
+            enqueueServerAction({ type, payload: data });
+        }
+    };
+}
+exports.default = createOptDis;

data/client/lib/createPayloadHandler.d.ts

@@ -1 +1 @@
-export default function createPayloadHandler(dispatch: any, subscription: any, model: any, config: any): (data: any) => null | undefined;
+export default function createPayloadHandler(dispatch: any, serverActionQueue: any, subscription: any, model: any, config: any): (data: any) => null | undefined;

data/client/lib/createPayloadHandler.js

@@ -4,16 +4,18 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const jsonpatch_1 = require("jsonpatch");
-const humps_1 = require("humps");
+const deepCamelizeKeys_1 = __importDefault(require("./deepCamelizeKeys"));
 const pluralize_1 = __importDefault(require("pluralize"));
 const lodash_1 = __importDefault(require("lodash"));
+const uuid_1 = require("uuid");
 function diffSeconds(dt2, dt1) {
     var diff = (dt2.getTime() - dt1.getTime()) / 1000;
     return Math.abs(Math.round(diff));
 }
-function createPayloadHandler(dispatch, subscription, model, config) {
+function createPayloadHandler(dispatch, serverActionQueue, subscription, model, config) {
     console.log({ model, config });
-    let payload = {};
+    let payload = [];
+    let previousPayload = [];
     let idx = 0;
     let patchQueue = {};
     let lastCheckAt = new Date();
@@ -23,16 +25,31 @@ function createPayloadHandler(dispatch, subscription, model, config) {
         console.log({ getPayload: model, subscription });
         subscription.send({ getPayload: { model, config } });
     }
+    function camelizeKeys(item) {
+        return deepCamelizeKeys_1.default(item, key => uuid_1.validate(key));
+    }
     const tGetPayload = lodash_1.default.throttle(getPayload, 10000);
     function dispatchPayload() {
+        // We want to avoid updates from server overwriting changes to local state, so if there is a queue then wait.
+        if (!serverActionQueue.fullySynced()) {
+            console.log(serverActionQueue.getData());
+            setTimeout(dispatchPayload, 100);
+            return;
+        }
         const includeModels = (config.includeModels || []).map(m => lodash_1.default.camelCase(m));
         console.log("Dispatching", { payload, includeModels });
         includeModels.forEach(m => {
-            const subPayload = lodash_1.default.flatten(lodash_1.default.compact(humps_1.camelizeKeys(payload).map(instance => instance[m])));
-            console.log({ type: `${pluralize_1.default(m)}/upsertMany`, payload: subPayload });
+            const subPayload = lodash_1.default.flatten(lodash_1.default.compact(camelizeKeys(payload).map(instance => instance[m])));
+            const previousSubPayload = lodash_1.default.flatten(lodash_1.default.compact(camelizeKeys(previousPayload).map(instance => instance[m])));
+            // Find IDs that were in the payload but are no longer
+            const idsToRemove = lodash_1.default.difference(previousSubPayload.map(i => i.id), subPayload.map(i => i.id));
             dispatch({ type: `${pluralize_1.default(m)}/upsertMany`, payload: subPayload });
+            dispatch({ type: `${pluralize_1.default(m)}/removeMany`, payload: idsToRemove });
         });
-        dispatch({ type: `${pluralize_1.default(model)}/upsertMany`, payload: humps_1.camelizeKeys(payload) });
+        const idsToRemove = lodash_1.default.difference(previousPayload.map(i => i.id), payload.map(i => i.id));
+        dispatch({ type: `${pluralize_1.default(model)}/upsertMany`, payload: camelizeKeys(payload) });
+        dispatch({ type: `${pluralize_1.default(model)}/removeMany`, payload: idsToRemove });
+        previousPayload = payload;
     }
     function processQueue() {
         console.log({ idx, patchQueue });