jason-rails 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2883964fb830dbb506a0e845caa3398436d72262f72cc6b295efce14dcc96346
+  data.tar.gz: 631d00d04195b1e1f48111ca5a6cc02775488e48f94ab5d8d29783a66a6c91a8
+SHA512:
+  metadata.gz: 6de81fcdba79fc067fe7515ad83be895e30d19686e548bfb774026993ab965cf6f0aaa9cebcd4807448e5218c8c9609f414e6ec05d5eb717aef880e3f2e012ea
+  data.tar.gz: adb6476af69fe904588f55214b930959a0b0d1d2357c3edafca77cc4f8d528a72cb0f72cde6dbec4e097e58d6e5758a2c429419cd9ad60f02d0352dd9abe385b

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+client/node_modules/
+
+client/yarn-error.log

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.2
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at jarees@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in jason.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 James Rees
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,52 @@
+# Jason
+
+## The goal
+
+I wanted:
+ - Automatic updates to client state based on database state
+ - Automatic persistence to database
+ - Redux for awesome state management
+ - Optimistic updates
+
+I also wanted to avoid writing essentially the same code multiple times in different places to handle common CRUD-like operations. Combine Rails schema definition files, REST endpoints, Redux actions, stores, reducers, handlers for websocket payloads and the translations between them, and it adds up to tons of repetitive boilerplate. Every change to the data schema requires updates in five or six files. This inhibits refactoring and makes mistakes more likely.
+
+Jason attempts to minimize this repitition by auto-generating API endpoints, redux stores and actions from a single schema definition. Further it adds listeners to ActiveRecord models allowing the redux store to be subscribed to updates from a model or set of models.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jason-rails'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install jason
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jason. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/jason/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Jason project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/jason/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jason"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/client/lib/JasonContext.d.ts

@@ -0,0 +1,2 @@
+declare const context: any;
+export default context;

data/client/lib/JasonContext.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const react_1 = require("react");
+const context = react_1.createContext({ actions: {}, subscribe: null, eager: null });
+exports.default = context;

data/client/lib/JasonProvider.d.ts

@@ -0,0 +1,7 @@
+declare const JasonProvider: ({ reducers, middleware, extraActions, children }: {
+    reducers: any;
+    middleware: any;
+    extraActions: any;
+    children: any;
+}) => any;
+export default JasonProvider;

data/client/lib/JasonProvider.js

@@ -0,0 +1,109 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const createActions_1 = __importDefault(require("./createActions"));
+const actioncable_1 = require("@rails/actioncable");
+const JasonContext_1 = __importDefault(require("./JasonContext"));
+const axios_1 = __importDefault(require("axios"));
+const axios_case_converter_1 = __importDefault(require("axios-case-converter"));
+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 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 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());
+    react_1.useEffect(() => {
+        restClient.get('/jason/api/schema')
+            .then(({ data: snakey_schema }) => {
+            const schema = humps_1.camelizeKeys(snakey_schema);
+            const consumer = actioncable_1.createConsumer();
+            const allReducers = Object.assign(Object.assign({}, reducers), createJasonReducers_1.default(schema));
+            console.log({ schema, allReducers });
+            const store = toolkit_1.configureStore({ reducer: allReducers, middleware });
+            let payloadHandlers = {};
+            function handlePayload(payload) {
+                const { model, md5Hash } = payload;
+                console.log({ md5Hash, fn: `${model}:${md5Hash}`, payloadHandlers, model: lodash_1.default.camelCase(model), payload });
+                const handler = payloadHandlers[`${lodash_1.default.camelCase(model)}:${md5Hash}`];
+                if (handler) {
+                    handler(Object.assign(Object.assign({}, payload), { model: lodash_1.default.camelCase(model) }));
+                }
+            }
+            const subscription = (consumer.subscriptions.create({
+                channel: 'Jason::Channel'
+            }, {
+                connected: () => {
+                    setConnected(true);
+                },
+                received: payload => {
+                    console.log("Payload received", payload);
+                    handlePayload(payload);
+                },
+                disconnected: () => console.warn('Disconnected from ActionCable')
+            }));
+            console.log('sending message');
+            subscription.send({ message: 'test' });
+            function createSubscription(config) {
+                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]);
+                });
+                subscription.send({ createSubscription: config });
+                return () => removeSubscription(config);
+            }
+            function removeSubscription(config) {
+                subscription.send({ removeSubscription: config });
+                const md5Hash = blueimp_md5_1.default(JSON.stringify(config));
+                lodash_1.default.map(config, (v, model) => {
+                    delete payloadHandlers[`${model}:${md5Hash}`];
+                });
+            }
+            const actions = createActions_1.default(schema, store, restClient, extraActions);
+            const eager = makeEager_1.default(schema);
+            console.log({ actions });
+            setValue({
+                actions: actions,
+                subscribe: (config) => createSubscription(config),
+                eager
+            });
+            setStore(store);
+        });
+    }, []);
+    if (!(store && value && connected))
+        return react_1.default.createElement("div", null); // Wait for async fetch of schema to complete
+    return react_1.default.createElement(react_redux_1.Provider, { store: store },
+        react_1.default.createElement(JasonContext_1.default.Provider, { value: value }, children));
+};
+exports.default = JasonProvider;

data/client/lib/actionFactory.d.ts

@@ -0,0 +1,5 @@
+declare const _default: (dis: any, store: any, entity: any, { extraActions, hasPriority }?: {
+    extraActions?: {} | undefined;
+    hasPriority?: boolean | undefined;
+}) => any;
+export default _default;

data/client/lib/actionFactory.js

@@ -0,0 +1,33 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const pluralize_1 = __importDefault(require("pluralize"));
+const lodash_1 = __importDefault(require("lodash"));
+const uuid_1 = require("uuid");
+exports.default = (dis, store, entity, { extraActions = {}, hasPriority = false } = {}) => {
+    function add(data = {}) {
+        const id = uuid_1.v4();
+        return dis({ type: `${pluralize_1.default(entity)}/add`, payload: Object.assign({ id }, data) });
+    }
+    function upsert(id, data) {
+        return dis({ type: `${pluralize_1.default(entity)}/upsert`, payload: Object.assign({ id }, data) });
+    }
+    function movePriority(id, priority, parentFilter = {}) {
+        return dis({ type: `${pluralize_1.default(entity)}/movePriority`, payload: { id, priority, parentFilter } });
+    }
+    function setAll(data) {
+        return dis({ type: `${pluralize_1.default(entity)}/setAll`, payload: data });
+    }
+    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));
+    if (hasPriority) {
+        return Object.assign({ add, upsert, setAll, remove, movePriority }, extraActionsResolved);
+    }
+    else {
+        return Object.assign({ add, upsert, setAll, remove }, extraActionsResolved);
+    }
+};

data/client/lib/createActions.d.ts

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

data/client/lib/createActions.js

@@ -0,0 +1,46 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+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);
+    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 })];
+        }
+        else {
+            return [pluralize_1.default(model), actionFactory_1.default(optDis, store, model)];
+        }
+    }));
+    const extraActionsResolved = extraActions(optDis, store, restClient);
+    return lodash_1.default.merge(actions, extraActionsResolved);
+}
+exports.default = createActions;