shinkansen-gears 1.0.23

package/.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npm run pre-commit

package/README.md

@@ -0,0 +1,43 @@
+## `shinkansen-gears`
+
+# Shinkansen Gears
+
+*Gears* implements *React* + *React Router* navigation components for *Zashiki Karakuri*.
+
+## Usage
+
+```javascript
+import {
+  Gears
+} from 'shinkansen-gears'
+```
+
+*Gears* exposes the props `reverse`, `forward`, and `pattern`.
+
+These props are _optional_. If no props are given then *Gears* will render `null`.
+
+*Gears* depends on a peer of *[Shinkansen Rails](https://github.com/modernpoacher/shinkansen-rails)* to transform the props `reverse` and `forward` into `<Link />` components for *React Router*. (The prop `pattern` describes how `reverse` and `forward` should be transformed.)
+
+```javascript
+import React from 'react'
+import PropTypes from 'prop-types'
+
+export class Gears extends React.Component { }
+
+Gears.propTypes = {
+  reverse: PropTypes.shape({
+    alpha: PropTypes.string,
+    omega: PropTypes.string
+  }),
+  forward: PropTypes.shape({
+    alpha: PropTypes.string,
+    omega: PropTypes.string
+  }),
+  pattern: PropTypes.string
+}
+```
+
+## See also
+
+- [Shinkansen Rails](https://github.com/modernpoacher/shinkansen-rails)
+- [Shinkansen Pantograph](https://github.com/modernpoacher/shinkansen-pantograph)

package/babel.config.js

@@ -0,0 +1,71 @@
+const debug = require('debug')
+
+const log = debug('shinkansen-gears')
+
+const {
+  env: {
+    NODE_ENV = 'development'
+  }
+} = process
+
+log('`shinkansen` is awake')
+
+function env () {
+  log({ NODE_ENV })
+
+  return (
+    NODE_ENV === 'production'
+  )
+}
+
+const presets = [
+  [
+    '@babel/env', {
+      targets: {
+        node: '12.19.0',
+        browsers: [
+          'last 4 versions',
+          'safari >= 9',
+          'ios >= 8',
+          'ie >= 9',
+          '> 2%'
+        ]
+      },
+      useBuiltIns: 'usage',
+      corejs: 3
+    }
+  ],
+  '@babel/react'
+]
+
+const plugins = [
+  '@babel/proposal-export-default-from',
+  [
+    '@babel/proposal-class-properties',
+    {
+      loose: false
+    }
+  ],
+  [
+    'module-resolver', {
+      root: ['./src'],
+      cwd: 'babelrc',
+      alias: {
+        'shinkansen-gears': './src',
+        build: './build',
+        stories: './stories'
+      }
+    }
+  ]
+]
+
+module.exports = (api) => {
+  if (api) api.cache.using(env)
+
+  return {
+    compact: true,
+    comments: false,
+    presets,
+    plugins
+  }
+}

package/gulp.sh

@@ -0,0 +1,42 @@
+#!/bin/bash
+
+
+NVM=~/.nvm
+
+if [[ -f "$NVM/nvm.sh" ]];
+then
+  unset npm_package_scripts_nvm
+  unset npm_config_prefix
+  unset npm_lifecycle_script
+
+  source $NVM/nvm.sh
+fi
+
+VERSION=$(nvm --version)
+
+if [[ -z "$VERSION" ]];
+then
+  echo NVM not installed
+else
+  echo NVM version $VERSION installed
+
+  set -e
+
+  nvm use &> /dev/null
+
+  if [[ $? != 0 ]];
+  then
+    echo NVM not configured
+  else
+    echo NVM configured
+  fi
+fi
+
+if [[ $# -gt 0 ]];
+then
+  npx gulp "$@"
+else
+  npx gulp
+fi
+
+exit 0

package/index.js

@@ -0,0 +1,7 @@
+const debug = require('debug')
+
+const log = debug('shinkansen-gears')
+
+log('`gears` is awake')
+
+module.exports = require('./lib')

package/lib/gears/forward/index.js

@@ -0,0 +1 @@
+"use strict";require("core-js/modules/es.object.define-property.js");Object.defineProperty(exports,"__esModule",{value:true});exports["default"]=void 0;require("core-js/modules/es.array.concat.js");var _react=_interopRequireDefault(require("react"));var _propTypes=_interopRequireDefault(require("prop-types"));var _reactRouterDom=require("react-router-dom");function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{"default":obj};}function Forward(_ref){var pathname=_ref.pathname;var key=pathname.concat('-forward');var to={pathname:pathname};return _react["default"].createElement("li",{key:key,className:"shinkansen-gears-forward"},_react["default"].createElement(_reactRouterDom.Link,{to:to},"Forward"));}Forward.propTypes={pathname:_propTypes["default"].string.isRequired};var _default=Forward;exports["default"]=_default;

package/lib/gears/index.js

@@ -0,0 +1 @@
+"use strict";function _typeof(obj){"@babel/helpers - typeof";if(typeof Symbol==="function"&&typeof Symbol.iterator==="symbol"){_typeof=function _typeof(obj){return typeof obj;};}else{_typeof=function _typeof(obj){return obj&&typeof Symbol==="function"&&obj.constructor===Symbol&&obj!==Symbol.prototype?"symbol":typeof obj;};}return _typeof(obj);}require("core-js/modules/es.object.set-prototype-of.js");require("core-js/modules/es.object.get-prototype-of.js");require("core-js/modules/es.reflect.construct.js");require("core-js/modules/es.object.create.js");require("core-js/modules/es.array.iterator.js");require("core-js/modules/es.object.to-string.js");require("core-js/modules/es.string.iterator.js");require("core-js/modules/es.weak-map.js");require("core-js/modules/web.dom-collections.iterator.js");require("core-js/modules/es.object.get-own-property-descriptor.js");require("core-js/modules/es.symbol.js");require("core-js/modules/es.symbol.description.js");require("core-js/modules/es.symbol.iterator.js");Object.defineProperty(exports,"__esModule",{value:true});exports.renderReverse=renderReverse;exports.renderForward=renderForward;exports["default"]=void 0;require("core-js/modules/es.array.concat.js");require("core-js/modules/es.array.reverse.js");require("core-js/modules/es.object.define-property.js");var _react=_interopRequireWildcard(require("react"));var _propTypes=_interopRequireDefault(require("prop-types"));var _immutable=_interopRequireDefault(require("immutable"));var _shinkansenRails=require("shinkansen-rails");var _reverse=_interopRequireDefault(require("./reverse"));var _forward=_interopRequireDefault(require("./forward"));function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{"default":obj};}function _getRequireWildcardCache(nodeInterop){if(typeof WeakMap!=="function")return null;var cacheBabelInterop=new WeakMap();var cacheNodeInterop=new WeakMap();return(_getRequireWildcardCache=function _getRequireWildcardCache(nodeInterop){return nodeInterop?cacheNodeInterop:cacheBabelInterop;})(nodeInterop);}function _interopRequireWildcard(obj,nodeInterop){if(!nodeInterop&&obj&&obj.__esModule){return obj;}if(obj===null||_typeof(obj)!=="object"&&typeof obj!=="function"){return{"default":obj};}var cache=_getRequireWildcardCache(nodeInterop);if(cache&&cache.has(obj)){return cache.get(obj);}var newObj={};var hasPropertyDescriptor=Object.defineProperty&&Object.getOwnPropertyDescriptor;for(var key in obj){if(key!=="default"&&Object.prototype.hasOwnProperty.call(obj,key)){var desc=hasPropertyDescriptor?Object.getOwnPropertyDescriptor(obj,key):null;if(desc&&(desc.get||desc.set)){Object.defineProperty(newObj,key,desc);}else{newObj[key]=obj[key];}}}newObj["default"]=obj;if(cache){cache.set(obj,newObj);}return newObj;}function _classCallCheck(instance,Constructor){if(!(instance instanceof Constructor)){throw new TypeError("Cannot call a class as a function");}}function _defineProperties(target,props){for(var i=0;i<props.length;i++){var descriptor=props[i];descriptor.enumerable=descriptor.enumerable||false;descriptor.configurable=true;if("value"in descriptor)descriptor.writable=true;Object.defineProperty(target,descriptor.key,descriptor);}}function _createClass(Constructor,protoProps,staticProps){if(protoProps)_defineProperties(Constructor.prototype,protoProps);if(staticProps)_defineProperties(Constructor,staticProps);return Constructor;}function _inherits(subClass,superClass){if(typeof superClass!=="function"&&superClass!==null){throw new TypeError("Super expression must either be null or a function");}subClass.prototype=Object.create(superClass&&superClass.prototype,{constructor:{value:subClass,writable:true,configurable:true}});if(superClass)_setPrototypeOf(subClass,superClass);}function _setPrototypeOf(o,p){_setPrototypeOf=Object.setPrototypeOf||function _setPrototypeOf(o,p){o.__proto__=p;return o;};return _setPrototypeOf(o,p);}function _createSuper(Derived){var hasNativeReflectConstruct=_isNativeReflectConstruct();return function _createSuperInternal(){var Super=_getPrototypeOf(Derived),result;if(hasNativeReflectConstruct){var NewTarget=_getPrototypeOf(this).constructor;result=Reflect.construct(Super,arguments,NewTarget);}else{result=Super.apply(this,arguments);}return _possibleConstructorReturn(this,result);};}function _possibleConstructorReturn(self,call){if(call&&(_typeof(call)==="object"||typeof call==="function")){return call;}else if(call!==void 0){throw new TypeError("Derived constructors may only return object or undefined");}return _assertThisInitialized(self);}function _assertThisInitialized(self){if(self===void 0){throw new ReferenceError("this hasn't been initialised - super() hasn't been called");}return self;}function _isNativeReflectConstruct(){if(typeof Reflect==="undefined"||!Reflect.construct)return false;if(Reflect.construct.sham)return false;if(typeof Proxy==="function")return true;try{Boolean.prototype.valueOf.call(Reflect.construct(Boolean,[],function(){}));return true;}catch(e){return false;}}function _getPrototypeOf(o){_getPrototypeOf=Object.setPrototypeOf?Object.getPrototypeOf:function _getPrototypeOf(o){return o.__proto__||Object.getPrototypeOf(o);};return _getPrototypeOf(o);}function _defineProperty(obj,key,value){if(key in obj){Object.defineProperty(obj,key,{value:value,enumerable:true,configurable:true,writable:true});}else{obj[key]=value;}return obj;}function renderReverse(reverse,pattern){if(_shinkansenRails.Rails.go(reverse,pattern)){var pathname=_shinkansenRails.Rails.to(reverse,pattern);return _react["default"].createElement(_reverse["default"],{pathname:pathname});}return null;}function renderForward(forward,pattern){if(_shinkansenRails.Rails.go(forward,pattern)){var pathname=_shinkansenRails.Rails.to(forward,pattern);return _react["default"].createElement(_forward["default"],{pathname:pathname});}return null;}var Gears=function(_Component){_inherits(Gears,_Component);var _super=_createSuper(Gears);function Gears(){var _this;_classCallCheck(this,Gears);for(var _len=arguments.length,args=new Array(_len),_key=0;_key<_len;_key++){args[_key]=arguments[_key];}_this=_super.call.apply(_super,[this].concat(args));_defineProperty(_assertThisInitialized(_this),"state",{});return _this;}_createClass(Gears,[{key:"shouldComponentUpdate",value:function shouldComponentUpdate(_ref,state){var pattern=_ref.pattern;var PATTERN=this.props.pattern;if(pattern!==PATTERN)return true;var reverse=state.reverse,forward=state.forward;var _this$state=this.state,REVERSE=_this$state.reverse,FORWARD=_this$state.forward;return reverse!==REVERSE||forward!==FORWARD;}},{key:"render",value:function render(){var _this$props=this.props,reverse=_this$props.reverse,forward=_this$props.forward,pattern=_this$props.pattern;var reverseGear=renderReverse(reverse,pattern);var forwardGear=renderForward(forward,pattern);if(reverseGear||forwardGear){return _react["default"].createElement("ul",{className:"shinkansen-gears"},reverseGear,forwardGear);}return null;}}],[{key:"getDerivedStateFromProps",value:function getDerivedStateFromProps(_ref2,_ref3){var reverse=_ref2.reverse,forward=_ref2.forward;var R=_ref3.reverse,F=_ref3.forward;var r=_immutable["default"].Map(reverse);var f=_immutable["default"].Map(forward);return{reverse:_immutable["default"].is(R,r)?R:r,forward:_immutable["default"].is(F,f)?F:f};}}]);return Gears;}(_react.Component);exports["default"]=Gears;Gears.defaultProps={reverse:{},forward:{},pattern:_shinkansenRails.Rails.pattern()};Gears.propTypes={reverse:_propTypes["default"].object,forward:_propTypes["default"].object,pattern:_propTypes["default"].string};

package/lib/gears/reverse/index.js

@@ -0,0 +1 @@
+"use strict";require("core-js/modules/es.object.define-property.js");Object.defineProperty(exports,"__esModule",{value:true});exports["default"]=void 0;require("core-js/modules/es.array.concat.js");var _react=_interopRequireDefault(require("react"));var _propTypes=_interopRequireDefault(require("prop-types"));var _reactRouterDom=require("react-router-dom");function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{"default":obj};}function Reverse(_ref){var pathname=_ref.pathname;var key=pathname.concat('-reverse');var to={pathname:pathname};return _react["default"].createElement("li",{key:key,className:"shinkansen-gears-reverse"},_react["default"].createElement(_reactRouterDom.Link,{to:to},"Reverse"));}Reverse.propTypes={pathname:_propTypes["default"].string.isRequired};var _default=Reverse;exports["default"]=_default;

package/lib/index.js

@@ -0,0 +1 @@
+"use strict";require("core-js/modules/es.object.define-property.js");Object.defineProperty(exports,"__esModule",{value:true});Object.defineProperty(exports,"Gears",{enumerable:true,get:function get(){return _gears["default"];}});var _gears=_interopRequireDefault(require("./gears"));function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{"default":obj};}

package/package.json

@@ -0,0 +1,104 @@
+{
+  "name": "shinkansen-gears",
+  "version": "1.0.23",
+  "description": "Shinkansen Gears",
+  "keywords": [
+    "Shinkansen",
+    "Gears",
+    "Zashiki Karakuri",
+    "Zashiki",
+    "Karakuri",
+    "React",
+    "React Router"
+  ],
+  "main": "./index.js",
+  "author": "Jonathan Perry for Modern Poacher Limited <modernpoacher@modernpoacher.com>",
+  "license": "MIT",
+  "engines": {
+    "node": ">=12.19.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git@github.com/modernpoacher/shinkansen-gears.git"
+  },
+  "scripts": {
+    "prepublishOnly": "cross-env NODE_ENV=production npm run build",
+    "prebuild": "npm run clean",
+    "build": "cross-env DEBUG=shinkansen-gears npm run babel -- --ignore \"**/__tests__/**\" && npm run gulp",
+    "build:watch": "npm run gulp -- build:watch",
+    "watch": "cross-env DEBUG=shinkansen-gears concurrently -r \"npm run babel:watch\" \"npm run build:watch\"",
+    "clean": "rimraf lib",
+    "transform": "npm run gulp -- transform",
+    "transform:watch": "npm run gulp -- transform:watch",
+    "babel": "babel src -d lib",
+    "babel:watch": "npm run babel -- -w",
+    "gulp": "bash gulp.sh --color",
+    "lint": "eslint .",
+    "lint:fix": "npm run lint -- --fix",
+    "test": "cross-env NODE_ENV=test jest --collect-coverage false --verbose --run-in-band",
+    "storybook": "npm run build && npm run transform && start-storybook -p 6006",
+    "build-storybook": "build-storybook",
+    "pre-commit": "npm run lint && npm test && npm run build && npm run transform && git add lib .storybook"
+  },
+  "dependencies": {
+    "debug": "^4.3.2",
+    "immutable": "3.8.2"
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.15.4",
+    "@babel/core": "^7.15.5",
+    "@babel/eslint-parser": "^7.15.4",
+    "@babel/plugin-proposal-class-properties": "^7.14.5",
+    "@babel/plugin-proposal-export-default-from": "^7.14.5",
+    "@babel/preset-env": "^7.15.6",
+    "@babel/preset-react": "^7.14.5",
+    "@babel/register": "^7.15.3",
+    "@modernpoacher/design-system": "0.0.383",
+    "autoprefixer": "^10.3.4",
+    "babel-jest": "^27.2.0",
+    "babel-plugin-module-resolver": "^4.1.0",
+    "babel-plugin-transform-react-jsx": "^6.24.1",
+    "babel-preset-react": "^6.24.1",
+    "concurrently": "^6.2.1",
+    "core-js": "^3.17.3",
+    "cross-env": "^7.0.3",
+    "cssnano": "^5.0.8",
+    "dart-sass": "^1.25.0",
+    "del": "^6.0.0",
+    "enzyme": "^3.11.0",
+    "enzyme-adapter-react-16": "^1.15.6",
+    "eslint": "^7.32.0",
+    "eslint-config-standard": "^16.0.3",
+    "eslint-import-resolver-babel-module": "^5.3.1",
+    "eslint-plugin-import": "^2.24.2",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-promise": "^5.1.0",
+    "eslint-plugin-react": "^7.25.2",
+    "glob-all": "^3.2.1",
+    "gulp": "^4.0.2",
+    "gulp-clean-css": "^4.3.0",
+    "gulp-css-purge": "^3.0.9",
+    "gulp-debug": "^4.0.0",
+    "gulp-postcss": "^9.0.1",
+    "gulp-rename": "^2.0.0",
+    "gulp-sass": "^5.0.0",
+    "gulp-sourcemaps": "^3.0.0",
+    "husky": "^7.0.2",
+    "jest": "^27.2.0",
+    "postcss": "^8.3.6",
+    "postcss-easy-import": "^3.0.0",
+    "postcss-map": "^0.11.0",
+    "postcss-normalize": "^10.0.1",
+    "postcss-scss": "^4.0.0",
+    "prop-types": "15.7.2",
+    "react": "16.14.0",
+    "react-dom": "16.14.0",
+    "react-router": "5.2.0",
+    "react-router-dom": "5.2.0",
+    "react-test-renderer": "16.14.0",
+    "regenerator-runtime": "^0.13.9",
+    "rimraf": "^3.0.2",
+    "shinkansen-rails": "1.0.18",
+    "vinyl-paths": "3.0.1"
+  }
+}

package/src/gears/forward/index.js

@@ -0,0 +1,27 @@
+import React from 'react'
+import PropTypes from 'prop-types'
+
+import {
+  Link
+} from 'react-router-dom'
+
+function Forward ({ pathname }) {
+  const key = pathname.concat('-forward')
+  const to = {
+    pathname
+  }
+
+  return (
+    <li key={key} className='shinkansen-gears-forward'>
+      <Link to={to}>
+        Forward
+      </Link>
+    </li>
+  )
+}
+
+Forward.propTypes = {
+  pathname: PropTypes.string.isRequired
+}
+
+export default Forward

package/src/gears/index.js

@@ -0,0 +1,120 @@
+import React, { Component } from 'react'
+import PropTypes from 'prop-types'
+import Immutable from 'immutable'
+
+import {
+  Rails
+} from 'shinkansen-rails'
+
+import Reverse from './reverse'
+import Forward from './forward'
+
+export function renderReverse (reverse, pattern) {
+  if (Rails.go(reverse, pattern)) {
+    const pathname = Rails.to(reverse, pattern)
+
+    return (
+      <Reverse
+        pathname={pathname}
+      />
+    )
+  }
+
+  return null
+}
+
+export function renderForward (forward, pattern) {
+  if (Rails.go(forward, pattern)) {
+    const pathname = Rails.to(forward, pattern)
+
+    return (
+      <Forward
+        pathname={pathname}
+      />
+    )
+  }
+
+  return null
+}
+
+export default class Gears extends Component {
+  state = {} // define state
+
+  /**
+   *  Convert latest 'props' to an Immutable.Map() and store in 'state'
+   *
+   *  @param {Object} props   Latest props
+   *  @param {Object} state   Current state
+   */
+  static getDerivedStateFromProps ({ reverse, forward }, { reverse: R, forward: F }) { // console.log('[Gears]getDerivedStateFromProps()')
+    const r = Immutable.Map(reverse)
+    const f = Immutable.Map(forward)
+
+    return {
+      reverse: Immutable.is(R, r) ? R : r,
+      forward: Immutable.is(F, f) ? F : f
+    }
+  }
+
+  /**
+   *  Compare latest 'props' and 'state' for changes to 'pattern', 'reverse' or 'forward'
+   *
+   *  @param {Object} props   Latest props
+   */
+  shouldComponentUpdate ({ pattern }, state) { // console.log('(Gears)shouldComponentUpdate()', { pattern }, state)
+    const {
+      pattern: PATTERN
+    } = this.props
+
+    if (pattern !== PATTERN) return true
+
+    const {
+      reverse,
+      forward
+    } = state
+
+    const {
+      reverse: REVERSE,
+      forward: FORWARD
+    } = this.state // state must be defined
+
+    return (
+      reverse !== REVERSE ||
+      forward !== FORWARD
+    )
+  }
+
+  render () { // console.log('(Gears)render()')
+    const {
+      reverse,
+      forward,
+      pattern
+    } = this.props
+
+    const reverseGear = renderReverse(reverse, pattern)
+    const forwardGear = renderForward(forward, pattern)
+
+    if (reverseGear || forwardGear) {
+      return (
+        <ul className='shinkansen-gears'>
+          {reverseGear}
+          {forwardGear}
+        </ul>
+      )
+    }
+
+    return null
+  }
+}
+
+Gears.defaultProps = {
+  reverse: {},
+  forward: {},
+  pattern: Rails.pattern()
+}
+
+Gears.propTypes = {
+  reverse: PropTypes.object,
+  forward: PropTypes.object,
+  pattern: PropTypes.string
+}

package/src/gears/reverse/index.js

@@ -0,0 +1,27 @@
+import React from 'react'
+import PropTypes from 'prop-types'
+
+import {
+  Link
+} from 'react-router-dom'
+
+function Reverse ({ pathname }) {
+  const key = pathname.concat('-reverse')
+  const to = {
+    pathname
+  }
+
+  return (
+    <li key={key} className='shinkansen-gears-reverse'>
+      <Link to={to}>
+        Reverse
+      </Link>
+    </li>
+  )
+}
+
+Reverse.propTypes = {
+  pathname: PropTypes.string.isRequired
+}
+
+export default Reverse

package/src/index.js

@@ -0,0 +1 @@
+export Gears from './gears'