@thoughtbot/superglue 0.50.0-beta1 → 0.50.0

package/README.md

@@ -5,10 +5,11 @@ Use classic Rails to build rich React Redux applications with **NO APIs** and
 
 [![Build Status](https://circleci.com/gh/thoughtbot/superglue.svg?style=shield)](https://circleci.com/gh/thoughtbot/superglue)
 
-Superglue is a React Redux starter and library inspired by Turbolinks and designed
-to complement classic Rails. You can enjoy the benefits of Redux state
-management and React components without giving up the productivity of Rails form
-helpers, UJS, tag helpers, the flash, cookie auth, and more.
+Superglue makes React and Redux equally as productive as Hotwire, Turbo and
+Stimulus. Its inspired by Turbolinks and designed to feel like a natural
+extension of Rails. Enjoy the benefits of Redux state management and React
+components without giving up the productivity of Rails form helpers, UJS,
+tag helpers, flash, cookie auth, and more.
 
 ## Caution
 
@@ -67,7 +68,6 @@ The above will request for `/posts` with an `accept` of `application/json`, and
 when the client receives the response, swap out the current component for the
 component the response asks for, and `pushState` on history.
 
-
 #### Partial updates
 Some features rely on updating some parts of the existing page. In
 addition to `data-sg-visit` and it's equivalent `this.props.visit`, Superglue
@@ -106,9 +106,8 @@ Documentation is hosted on [Github pages](https://thoughtbot.github.io/superglue
 
 ## Contributing
 
-See the [CONTRIBUTING] document. Thank you, [contributors]!
+Thank you, [contributors]!
 
-  [CONTRIBUTING]: CONTRIBUTING.md
   [contributors]: https://github.com/thoughtbot/superglue/graphs/contributors
 
 ## Special Thanks
@@ -118,5 +117,3 @@ Thanks to [jbuilder](https://github.com/rails/jbuilder),
 [turbolinks3](https://github.com/turbolinks/turbolinks-classic),
 [turbograft](https://github.com/Shopify/turbograft/),
 [turbostreamer](https://github.com/malomalo/turbostreamer)
-
-

package/action_creators/requests.js

@@ -1,7 +1,6 @@
 "use strict";
 
 exports.__esModule = true;
-exports.clearFlash = clearFlash;
 exports.remote = remote;
 exports.visit = visit;
 
@@ -11,6 +10,20 @@ var _actions = require("../actions");
 
 var _index = require("./index");
 
+function beforeVisit(payload) {
+  return {
+    type: _actions.BEFORE_VISIT,
+    payload: payload
+  };
+}
+
+function beforeRemote(payload) {
+  return {
+    type: _actions.BEFORE_REMOTE,
+    payload: payload
+  };
+}
+
 function beforeFetch(payload) {
   return {
     type: _actions.BEFORE_FETCH,
@@ -46,28 +59,18 @@ function buildMeta(pageKey, page, state) {
   };
 }
 
-function clearFlash(_ref) {
-  var pageKey = _ref.pageKey;
-  return {
-    type: _actions.CLEAR_FLASH,
-    payload: {
-      pageKey: pageKey
-    }
-  };
-}
-
 function remote(path, _temp) {
-  var _ref2 = _temp === void 0 ? {} : _temp,
-      _ref2$method = _ref2.method,
-      method = _ref2$method === void 0 ? 'GET' : _ref2$method,
-      headers = _ref2.headers,
-      _ref2$body = _ref2.body,
-      body = _ref2$body === void 0 ? '' : _ref2$body,
-      pageKey = _ref2.pageKey,
-      _ref2$beforeSave = _ref2.beforeSave,
-      beforeSave = _ref2$beforeSave === void 0 ? function (prevPage, receivedPage) {
+  var _ref = _temp === void 0 ? {} : _temp,
+      _ref$method = _ref.method,
+      method = _ref$method === void 0 ? 'GET' : _ref$method,
+      headers = _ref.headers,
+      _ref$body = _ref.body,
+      body = _ref$body === void 0 ? '' : _ref$body,
+      pageKey = _ref.pageKey,
+      _ref$beforeSave = _ref.beforeSave,
+      beforeSave = _ref$beforeSave === void 0 ? function (prevPage, receivedPage) {
     return receivedPage;
-  } : _ref2$beforeSave;
+  } : _ref$beforeSave;
 
   path = (0, _utils.withoutBusters)(path);
   pageKey = pageKey && (0, _utils.urlToPageKey)(pageKey);
@@ -78,12 +81,17 @@ function remote(path, _temp) {
       body: body
     });
     pageKey = pageKey || getState().superglue.currentPageKey;
+    var currentPageKey = getState().superglue.currentPageKey;
+    dispatch(beforeRemote({
+      currentPageKey: currentPageKey,
+      fetchArgs: fetchArgs
+    }));
     dispatch(beforeFetch({
       fetchArgs: fetchArgs
     }));
-    return fetch.apply(void 0, fetchArgs).then(_utils.parseResponse).then(function (_ref3) {
-      var rsp = _ref3.rsp,
-          json = _ref3.json;
+    return fetch.apply(void 0, fetchArgs).then(_utils.parseResponse).then(function (_ref2) {
+      var rsp = _ref2.rsp,
+          json = _ref2.json;
 
       var _getState = getState(),
           superglue = _getState.superglue,
@@ -111,27 +119,23 @@ var lastVisitController = {
 };
 
 function visit(path, _temp2) {
-  var _ref4 = _temp2 === void 0 ? {} : _temp2,
-      _ref4$method = _ref4.method,
-      method = _ref4$method === void 0 ? 'GET' : _ref4$method,
-      headers = _ref4.headers,
-      _ref4$body = _ref4.body,
-      body = _ref4$body === void 0 ? '' : _ref4$body,
-      placeholderKey = _ref4.placeholderKey,
-      _ref4$beforeSave = _ref4.beforeSave,
-      beforeSave = _ref4$beforeSave === void 0 ? function (prevPage, receivedPage) {
+  var _ref3 = _temp2 === void 0 ? {} : _temp2,
+      _ref3$method = _ref3.method,
+      method = _ref3$method === void 0 ? 'GET' : _ref3$method,
+      headers = _ref3.headers,
+      _ref3$body = _ref3.body,
+      body = _ref3$body === void 0 ? '' : _ref3$body,
+      placeholderKey = _ref3.placeholderKey,
+      _ref3$beforeSave = _ref3.beforeSave,
+      beforeSave = _ref3$beforeSave === void 0 ? function (prevPage, receivedPage) {
     return receivedPage;
-  } : _ref4$beforeSave,
-      _ref4$revisit = _ref4.revisit,
-      revisit = _ref4$revisit === void 0 ? false : _ref4$revisit;
+  } : _ref3$beforeSave,
+      _ref3$revisit = _ref3.revisit,
+      revisit = _ref3$revisit === void 0 ? false : _ref3$revisit;
 
   path = (0, _utils.withoutBusters)(path);
   var pageKey = (0, _utils.urlToPageKey)(path);
   return function (dispatch, getState) {
-    var currentKey = getState().superglue.currentPageKey;
-    dispatch(clearFlash({
-      pageKey: currentKey
-    }));
     placeholderKey = placeholderKey && (0, _utils.urlToPageKey)(placeholderKey);
     var hasPlaceholder = !!getState().pages[placeholderKey];
 
@@ -160,14 +164,19 @@ function visit(path, _temp2) {
       method: method,
       signal: signal
     });
+    var currentPageKey = getState().superglue.currentPageKey;
+    dispatch(beforeVisit({
+      currentPageKey: currentPageKey,
+      fetchArgs: fetchArgs
+    }));
     dispatch(beforeFetch({
       fetchArgs: fetchArgs
     }));
     lastVisitController.abort();
     lastVisitController = controller;
-    return fetch.apply(void 0, fetchArgs).then(_utils.parseResponse).then(function (_ref5) {
-      var rsp = _ref5.rsp,
-          json = _ref5.json;
+    return fetch.apply(void 0, fetchArgs).then(_utils.parseResponse).then(function (_ref4) {
+      var rsp = _ref4.rsp,
+          json = _ref4.json;
 
       var _getState2 = getState(),
           superglue = _getState2.superglue,

package/actions.js

@@ -1,15 +1,17 @@
 "use strict";
 
 exports.__esModule = true;
-exports.UPDATE_FRAGMENTS = exports.SUPERGLUE_ERROR = exports.SET_CSRF_TOKEN = exports.SAVE_RESPONSE = exports.REMOVE_PAGE = exports.HISTORY_CHANGE = exports.HANDLE_GRAFT = exports.GRAFTING_SUCCESS = exports.GRAFTING_ERROR = exports.COPY_PAGE = exports.CLEAR_FLASH = exports.BEFORE_FETCH = void 0;
+exports.UPDATE_FRAGMENTS = exports.SUPERGLUE_ERROR = exports.SET_CSRF_TOKEN = exports.SAVE_RESPONSE = exports.REMOVE_PAGE = exports.HISTORY_CHANGE = exports.HANDLE_GRAFT = exports.GRAFTING_SUCCESS = exports.GRAFTING_ERROR = exports.COPY_PAGE = exports.BEFORE_VISIT = exports.BEFORE_REMOTE = exports.BEFORE_FETCH = void 0;
 var BEFORE_FETCH = '@@superglue/BEFORE_FETCH';
 exports.BEFORE_FETCH = BEFORE_FETCH;
+var BEFORE_VISIT = '@@superglue/BEFORE_VISIT';
+exports.BEFORE_VISIT = BEFORE_VISIT;
+var BEFORE_REMOTE = '@@superglue/BEFORE_REMOTE';
+exports.BEFORE_REMOTE = BEFORE_REMOTE;
 var SAVE_RESPONSE = '@@superglue/SAVE_RESPONSE';
 exports.SAVE_RESPONSE = SAVE_RESPONSE;
 var HANDLE_GRAFT = '@@superglue/HANDLE_GRAFT';
 exports.HANDLE_GRAFT = HANDLE_GRAFT;
-var CLEAR_FLASH = '@@superglue/CLEAR_FLASH';
-exports.CLEAR_FLASH = CLEAR_FLASH;
 var SUPERGLUE_ERROR = '@@superglue/ERROR';
 exports.SUPERGLUE_ERROR = SUPERGLUE_ERROR;
 var GRAFTING_ERROR = '@@superglue/GRAFTING_ERROR';

package/index.js

@@ -1,7 +1,7 @@
 "use strict";
 
 exports.__esModule = true;
-exports.updateFragments = exports.superglueReducer = exports.pageReducer = exports.mapDispatchToPropsIncludingVisitAndRemote = exports.getIn = exports.fragmentMiddleware = exports.ApplicationBase = void 0;
+exports.updateFragments = exports.superglueReducer = exports.pageReducer = exports.mapDispatchToPropsIncludingVisitAndRemote = exports.getIn = exports.fragmentMiddleware = exports.UPDATE_FRAGMENTS = exports.SAVE_RESPONSE = exports.REMOVE_PAGE = exports.GRAFTING_SUCCESS = exports.GRAFTING_ERROR = exports.COPY_PAGE = exports.BEFORE_VISIT = exports.BEFORE_REMOTE = exports.BEFORE_FETCH = exports.ApplicationBase = void 0;
 
 var _react = _interopRequireDefault(require("react"));
 
@@ -24,6 +24,17 @@ var _action_creators = require("./action_creators");
 
 var _actions = require("./actions");
 
+exports.HISTORY_CHANGE = _actions.HISTORY_CHANGE;
+exports.BEFORE_FETCH = _actions.BEFORE_FETCH;
+exports.BEFORE_VISIT = _actions.BEFORE_VISIT;
+exports.BEFORE_REMOTE = _actions.BEFORE_REMOTE;
+exports.SAVE_RESPONSE = _actions.SAVE_RESPONSE;
+exports.UPDATE_FRAGMENTS = _actions.UPDATE_FRAGMENTS;
+exports.COPY_PAGE = _actions.COPY_PAGE;
+exports.REMOVE_PAGE = _actions.REMOVE_PAGE;
+exports.GRAFTING_ERROR = _actions.GRAFTING_ERROR;
+exports.GRAFTING_SUCCESS = _actions.GRAFTING_SUCCESS;
+
 var _redux = require("redux");
 
 var _reduxThunk = _interopRequireDefault(require("redux-thunk"));
@@ -67,9 +78,10 @@ function _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.g
 function pageToInitialState(key, page) {
   var _pages;
 
-  return {
+  var slices = page.slices || {};
+  return Object.assign({
     pages: (_pages = {}, _pages[key] = page, _pages)
-  };
+  }, slices);
 }
 
 function start(_ref) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thoughtbot/superglue",
-  "version": "0.50.0-beta1",
+  "version": "0.50.0",
   "description": "Use a vanilla Rails with React and Redux",
   "repository": {
     "type": "git",

package/reducers/index.js

@@ -1,7 +1,6 @@
 "use strict";
 
 exports.__esModule = true;
-exports.addFlash = addFlash;
 exports.appendReceivedFragmentsOntoPage = appendReceivedFragmentsOntoPage;
 exports.graftNodeOntoPage = graftNodeOntoPage;
 exports.handleGraft = handleGraft;
@@ -99,14 +98,6 @@ function appendReceivedFragmentsOntoPage(state, pageKey, receivedFragments) {
   return nextState;
 }
 
-function addFlash(state, pageKey, receivedFlash) {
-  var nextState = Object.assign({}, state);
-  var nextPage = Object.assign({}, state[pageKey]);
-  nextPage.flash = Object.assign({}, nextPage.flash, receivedFlash);
-  nextState[pageKey] = nextPage;
-  return nextState;
-}
-
 function graftNodeOntoPage(state, pageKey, node, pathToNode) {
   if (!node) {
     console.warn('There was no node returned in the response. Do you have the correct key path in your props_at?');
@@ -132,14 +123,11 @@ function handleGraft(state, pageKey, page) {
   var receivedNode = page.data,
       pathToNode = page.path,
       _page$fragments = page.fragments,
-      receivedFragments = _page$fragments === void 0 ? [] : _page$fragments,
-      receivedFlash = page.flash;
+      receivedFragments = _page$fragments === void 0 ? [] : _page$fragments;
   return [function (nextState) {
     return graftNodeOntoPage(nextState, pageKey, receivedNode, pathToNode);
   }, function (nextState) {
     return appendReceivedFragmentsOntoPage(nextState, pageKey, receivedFragments);
-  }, function (nextState) {
-    return addFlash(nextState, pageKey, receivedFlash);
   }].reduce(function (memo, fn) {
     return fn(memo);
   }, state);
@@ -189,37 +177,25 @@ function pageReducer(state, action) {
         return nextState;
       }
 
-    case _actions.CLEAR_FLASH:
-      {
-        var _pageKey2 = action.payload.pageKey;
-
-        var _nextState = Object.assign({}, state);
-
-        var nextPage = Object.assign({}, state[_pageKey2]);
-        nextPage.flash = {};
-        _nextState[_pageKey2] = nextPage;
-        return _nextState;
-      }
-
     case _actions.COPY_PAGE:
       {
-        var _nextState2 = Object.assign({}, state);
+        var _nextState = Object.assign({}, state);
 
         var _action$payload3 = action.payload,
             from = _action$payload3.from,
             to = _action$payload3.to;
-        _nextState2[(0, _utils.urlToPageKey)(to)] = JSON.parse(JSON.stringify(_nextState2[from]));
-        return _nextState2;
+        _nextState[(0, _utils.urlToPageKey)(to)] = JSON.parse(JSON.stringify(_nextState[from]));
+        return _nextState;
       }
 
     case _actions.REMOVE_PAGE:
       {
-        var _pageKey3 = action.payload.pageKey;
+        var _pageKey2 = action.payload.pageKey;
 
-        var _nextState3 = Object.assign({}, state);
+        var _nextState2 = Object.assign({}, state);
 
-        delete _nextState3[_pageKey3];
-        return _nextState3;
+        delete _nextState2[_pageKey2];
+        return _nextState2;
       }
 
     default:

package/utils/react.js

@@ -23,17 +23,14 @@ function mapStateToProps(state, ownProps) {
 
   var _ref = state.pages[pageKey] || {
     data: {},
-    flash: {},
     fragments: []
   },
       data = _ref.data,
-      flash = _ref.flash,
       fragments = _ref.fragments;
 
   return Object.assign({}, data, params, {
     pageKey: pageKey,
     csrfToken: csrfToken,
-    flash: flash,
     fragments: fragments
   });
 }