jason-rails 0.6.2 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dae8eb61f7d3966c7e34ed81120a16e5c58f84d50ff6ea16ec87340d52cbf0ec
-  data.tar.gz: cd4bc1d677ec413e2368c235632410e744ab3d47f94e7c65160b7665d3a6db45
+  metadata.gz: e62faa4e4f1246fa42810c324eec1f8fe96b8026ccdbe12f5b8bd7bc2df3bd4a
+  data.tar.gz: e4f829ce397c7192c173ba6e712a4b5873bd065d687cebf5ad72025f0436f51a
 SHA512:
-  metadata.gz: 88130bf9bd8d557478de06bcdcb8901799425e3eeaf10a47a969152c13334659c8ffe36911fa2f3c18903a81c4291118e5f0c6daa72ac7a20545c095ab19f918
-  data.tar.gz: 3e708e8b214b74cce9dc87ec07b04bf5a4d1453c7398050be657dfe0c34f7668708352d7bef7d9305ffbb1321728267cbab9ab61f03460af3f7987f7d0381253
+  metadata.gz: 6e3abfbfd6e0fbbe6c40dc7c0540448091cd440aaeec3580951a6148d6f1f92e61d5808b39ca02e8c564e1aa57beaf1de4d4cddb34e27b96ace09ca61d856d9a
+  data.tar.gz: b58a34f35981aea9b991f036cb83f9e059fa17a5932d9e9df78b6e86b5532484fe0dc115531365d5044d2f7df42355b5481a353233dcbd6744077b8fcbd58f18

data/README.md

@@ -1,6 +1,6 @@
 # Jason
 
-Jason is still in a highly experimental phase with a rapidly changing API. Production use not recommended - but please give it a try!
+Jason is still in an experimental phase with a rapidly changing API. It is being used in some production applications, however it is still in 0.x.x series versions, which means that any 0.x version bump could introduce breaking changes.
 
 ## The goal
 
@@ -14,6 +14,8 @@ I also wanted to avoid writing essentially the same code multiple times in diffe
 
 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.
 
+An alternative way of thinking about Jason is "what if we applied the Flux/Redux state update pattern to make the _database_ the store?".
+
 ## Installation
 
 Add the gem and the NPM package
@@ -81,7 +83,7 @@ function extraActions(dispatch, store, restClient, act) {
 - `middleware` - Passed directly to `configureStore` with additional Jason middleware
 
 ## Usage
-Jason provides two custom hooks to access functionality.
+Jason provides three custom hooks to access functionality.
 
 ### useAct
 This returns an object which allows you to access actions which both update models on the server, and perform an optimistic update to the Redux store.
@@ -126,6 +128,28 @@ export default function PostsList() {
 }
 ```
 
+### useEager
+Jason stores all the data in a normalized form - one redux slice per model. Often you might want to get nested data from several slices for use in components. The `useEager` hook provides an API for doing that. Under the hood it's just a wrapper around useSelector, which aims to mimic the behaviour of Rails eager loading.
+
+Example
+This will fetch the comment as well as the post and user linked to it.
+
+```jsx
+import React from 'react'
+import { useSelector } from 'react-redux'
+import { useEager } from '@jamesr2323/jason'
+import _ from 'lodash'
+
+export default function Comment({ id }) {
+  const comment = useEager('comments', id, ['post', 'user'])
+
+  return <div>
+    <p>{ comment.body }</p>
+    <p>Made on post { comment.post.name } by { comment.user.name }</p>
+  </div>
+}
+```
+
 ## Authorization
 
 By default all models can be subscribed to and updated without authentication or authorization. Probably you want to lock down access.

data/app/controllers/jason/api_controller.rb

@@ -35,10 +35,10 @@ class Jason::ApiController < ::ApplicationController
       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)
+        model.find(id).update!(priority: i)
       end
 
-      model.publish_all(model.find(all_instance_ids))
+      model.find(all_instance_ids).each(&:force_publish_json)
     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)

data/client/lib/useEager.d.ts

@@ -0,0 +1 @@
+export default function useEager(entity: any, id?: null, relations?: never[]): void;

data/client/lib/useEager.js

@@ -0,0 +1,12 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const JasonContext_1 = __importDefault(require("./JasonContext"));
+const react_1 = require("react");
+function useEager(entity, id = null, relations = []) {
+    const { eager } = react_1.useContext(JasonContext_1.default);
+    return eager(entity, id, relations);
+}
+exports.default = useEager;

data/client/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jamesr2323/jason",
-  "version": "0.6.1",
+  "version": "0.6.2",
   "module": "./lib/index.js",
   "types": "./lib/index.d.ts",
   "scripts": {

data/client/src/useEager.ts

@@ -0,0 +1,9 @@
+import JasonContext from './JasonContext'
+import { useContext } from 'react'
+
+export default function useEager(entity, id = null, relations = []) {
+  const { eager } = useContext(JasonContext)
+
+  return eager(entity, id, relations)
+}
+

data/lib/jason/version.rb

@@ -1,3 +1,3 @@
 module Jason
-  VERSION = "0.6.2"
+  VERSION = "0.6.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jason-rails
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.3
 platform: ruby
 authors:
 - James Rees
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-16 00:00:00.000000000 Z
+date: 2021-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -168,6 +168,8 @@ files:
 - client/lib/transportAdapters/pusherAdapter.js
 - client/lib/useAct.d.ts
 - client/lib/useAct.js
+- client/lib/useEager.d.ts
+- client/lib/useEager.js
 - client/lib/useJason.d.ts
 - client/lib/useJason.js
 - client/lib/useJason.test.d.ts
@@ -194,6 +196,7 @@ files:
 - client/src/transportAdapters/actionCableAdapter.ts
 - client/src/transportAdapters/pusherAdapter.ts
 - client/src/useAct.ts
+- client/src/useEager.ts
 - client/src/useJason.test.ts
 - client/src/useJason.ts
 - client/src/useSub.ts