@civ-clone/base-unit-action-goto 0.1.0

package/.deepsource.toml

@@ -0,0 +1,21 @@
+version = 1
+
+test_patterns = ["test/**/*.test.ts"]
+
+exclude_patterns = ["**/*.js"]
+
+[[analyzers]]
+name = "javascript"
+enabled = true
+
+[analyzers.meta]
+dialect = "typescript"
+environment = [
+  "nodejs",
+  "mocha"
+]
+
+[[analyzers]]
+name = "test-coverage"
+enabled = true
+

package/.gitattributes

@@ -0,0 +1,2 @@
+**/*.js linguist-generated=true
+

package/.github/workflows/build-on-push.yml

@@ -0,0 +1,14 @@
+name: Build and test application on push to remote
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 12
+      - run: npm install
+      - run: npm run prettier:check

package/.prettierrc

@@ -0,0 +1,4 @@
+{
+  "semi": true,
+  "singleQuote": true
+}

package/GoTo.d.ts

@@ -0,0 +1,20 @@
+import { PathFinderRegistry } from '@civ-clone/core-world-path/PathFinderRegistry';
+import { RuleRegistry } from '@civ-clone/core-rule/RuleRegistry';
+import { StrategyNoteRegistry } from '@civ-clone/core-strategy/StrategyNoteRegistry';
+import Action from '@civ-clone/core-unit/Action';
+import Tile from '@civ-clone/core-world/Tile';
+import Unit from '@civ-clone/core-unit/Unit';
+export declare const generateKey: (unit: Unit) => string;
+export declare class GoTo extends Action {
+  #private;
+  constructor(
+    from: Tile,
+    to: Tile,
+    unit: Unit,
+    ruleRegistry?: RuleRegistry,
+    pathFinderRegistry?: PathFinderRegistry,
+    strategyNoteRegistry?: StrategyNoteRegistry
+  );
+  perform(): void;
+}
+export default GoTo;

package/GoTo.js

@@ -0,0 +1,52 @@
+"use strict";
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _GoTo_pathFinderRegistry, _GoTo_strategyNoteRegistry;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GoTo = exports.generateKey = void 0;
+const PathFinderRegistry_1 = require("@civ-clone/core-world-path/PathFinderRegistry");
+const RuleRegistry_1 = require("@civ-clone/core-rule/RuleRegistry");
+const StrategyNote_1 = require("@civ-clone/core-strategy/StrategyNote");
+const StrategyNoteRegistry_1 = require("@civ-clone/core-strategy/StrategyNoteRegistry");
+const Action_1 = require("@civ-clone/core-unit/Action");
+const moveAlongPath_1 = require("./lib/moveAlongPath");
+const generateKey = (unit) => (0, StrategyNote_1.generateKey)(unit, 'currentPath');
+exports.generateKey = generateKey;
+class GoTo extends Action_1.default {
+    constructor(from, to, unit, ruleRegistry = RuleRegistry_1.instance, pathFinderRegistry = PathFinderRegistry_1.instance, strategyNoteRegistry = StrategyNoteRegistry_1.instance) {
+        super(from, to, unit, ruleRegistry);
+        _GoTo_pathFinderRegistry.set(this, void 0);
+        _GoTo_strategyNoteRegistry.set(this, void 0);
+        __classPrivateFieldSet(this, _GoTo_pathFinderRegistry, pathFinderRegistry, "f");
+        __classPrivateFieldSet(this, _GoTo_strategyNoteRegistry, strategyNoteRegistry, "f");
+    }
+    perform() {
+        const [PathFinder] = __classPrivateFieldGet(this, _GoTo_pathFinderRegistry, "f").entries();
+        if (!PathFinder) {
+            // TODO: shout about this?
+            return;
+        }
+        const path = new PathFinder(this.unit(), this.unit().tile(), this.to()).generate();
+        if (!path) {
+            // TODO: shout about this?
+            return;
+        }
+        // remove the current `Tile` so that the next shift will be the target.
+        path.shift();
+        __classPrivateFieldGet(this, _GoTo_strategyNoteRegistry, "f").replace(new StrategyNote_1.StrategyNote((0, exports.generateKey)(this.unit()), path));
+        (0, moveAlongPath_1.default)(this.unit(), path);
+    }
+}
+exports.GoTo = GoTo;
+_GoTo_pathFinderRegistry = new WeakMap(), _GoTo_strategyNoteRegistry = new WeakMap();
+exports.default = GoTo;
+//# sourceMappingURL=GoTo.js.map

package/GoTo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GoTo.js","sourceRoot":"","sources":["GoTo.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,sFAGuD;AACvD,oEAG2C;AAC3C,wEAG+C;AAC/C,wFAGuD;AACvD,wDAAiD;AAGjD,uDAAgD;AAEzC,MAAM,WAAW,GAAG,CAAC,IAAU,EAAE,EAAE,CAAC,IAAA,0BAAc,EAAC,IAAI,EAAE,aAAa,CAAC,CAAC;AAAlE,QAAA,WAAW,eAAuD;AAE/E,MAAa,IAAK,SAAQ,gBAAM;IAI9B,YACE,IAAU,EACV,EAAQ,EACR,IAAU,EACV,eAA6B,uBAAoB,EACjD,qBAAyC,6BAA0B,EACnE,uBAA6C,+BAA4B;QAEzE,KAAK,CAAC,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC;QAXtC,2CAAwC;QACxC,6CAA4C;QAY1C,uBAAA,IAAI,4BAAuB,kBAAkB,MAAA,CAAC;QAC9C,uBAAA,IAAI,8BAAyB,oBAAoB,MAAA,CAAC;IACpD,CAAC;IAED,OAAO;QACL,MAAM,CAAC,UAAU,CAAC,GAAG,uBAAA,IAAI,gCAAoB,CAAC,OAAO,EAAE,CAAC;QAExD,IAAI,CAAC,UAAU,EAAE;YACf,0BAA0B;YAC1B,OAAO;SACR;QAED,MAAM,IAAI,GAAG,IAAI,UAAU,CACzB,IAAI,CAAC,IAAI,EAAE,EACX,IAAI,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,EAClB,IAAI,CAAC,EAAE,EAAE,CACV,CAAC,QAAQ,EAAE,CAAC;QAEb,IAAI,CAAC,IAAI,EAAE;YACT,0BAA0B;YAC1B,OAAO;SACR;QAED,uEAAuE;QACvE,IAAI,CAAC,KAAK,EAAE,CAAC;QAEb,uBAAA,IAAI,kCAAsB,CAAC,OAAO,CAChC,IAAI,2BAAY,CAAC,IAAA,mBAAW,EAAC,IAAI,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI,CAAC,CACjD,CAAC;QAEF,IAAA,uBAAa,EAAC,IAAI,CAAC,IAAI,EAAE,EAAE,IAAI,CAAC,CAAC;IACnC,CAAC;CACF;AA9CD,oBA8CC;;AAED,kBAAe,IAAI,CAAC"}

package/GoTo.ts

@@ -0,0 +1,72 @@
+import {
+  PathFinderRegistry,
+  instance as pathFinderRegistryInstance,
+} from '@civ-clone/core-world-path/PathFinderRegistry';
+import {
+  RuleRegistry,
+  instance as ruleRegistryInstance,
+} from '@civ-clone/core-rule/RuleRegistry';
+import {
+  StrategyNote,
+  generateKey as generateRawKey,
+} from '@civ-clone/core-strategy/StrategyNote';
+import {
+  StrategyNoteRegistry,
+  instance as strategyNoteRegistryInstance,
+} from '@civ-clone/core-strategy/StrategyNoteRegistry';
+import Action from '@civ-clone/core-unit/Action';
+import Tile from '@civ-clone/core-world/Tile';
+import Unit from '@civ-clone/core-unit/Unit';
+import moveAlongPath from './lib/moveAlongPath';
+
+export const generateKey = (unit: Unit) => generateRawKey(unit, 'currentPath');
+
+export class GoTo extends Action {
+  #pathFinderRegistry: PathFinderRegistry;
+  #strategyNoteRegistry: StrategyNoteRegistry;
+
+  constructor(
+    from: Tile,
+    to: Tile,
+    unit: Unit,
+    ruleRegistry: RuleRegistry = ruleRegistryInstance,
+    pathFinderRegistry: PathFinderRegistry = pathFinderRegistryInstance,
+    strategyNoteRegistry: StrategyNoteRegistry = strategyNoteRegistryInstance
+  ) {
+    super(from, to, unit, ruleRegistry);
+
+    this.#pathFinderRegistry = pathFinderRegistry;
+    this.#strategyNoteRegistry = strategyNoteRegistry;
+  }
+
+  perform(): void {
+    const [PathFinder] = this.#pathFinderRegistry.entries();
+
+    if (!PathFinder) {
+      // TODO: shout about this?
+      return;
+    }
+
+    const path = new PathFinder(
+      this.unit(),
+      this.unit().tile(),
+      this.to()
+    ).generate();
+
+    if (!path) {
+      // TODO: shout about this?
+      return;
+    }
+
+    // remove the current `Tile` so that the next shift will be the target.
+    path.shift();
+
+    this.#strategyNoteRegistry.replace(
+      new StrategyNote(generateKey(this.unit()), path)
+    );
+
+    moveAlongPath(this.unit(), path);
+  }
+}
+
+export default GoTo;

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Dom Hastings
+
+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.

package/README.md

@@ -0,0 +1,3 @@
+# base-unit-action-goto
+
+This is a template repo.

package/lib/moveAlongPath.d.ts

@@ -0,0 +1,4 @@
+import Path from '@civ-clone/core-world-path/Path';
+import Unit from '@civ-clone/core-unit/Unit';
+export declare const moveAlongPath: (unit: Unit, path: Path) => void;
+export default moveAlongPath;

package/lib/moveAlongPath.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.moveAlongPath = void 0;
+const Move_1 = require("@civ-clone/base-unit-action-move/Move");
+const NoOrders_1 = require("@civ-clone/base-unit-action-no-orders/NoOrders");
+const moveAlongPath = (unit, path) => {
+    while (unit.moves().value() > 0.25) {
+        const [move] = unit
+            .actions(path.shift())
+            .filter((action) => action instanceof Move_1.default);
+        if (!move) {
+            break;
+        }
+        move.perform();
+    }
+    if (unit.moves().value() === 0) {
+        return;
+    }
+    const [noOrders] = unit
+        .actions()
+        .filter((action) => action instanceof NoOrders_1.default);
+    if (noOrders) {
+        noOrders.perform();
+        return;
+    }
+    unit.moves().set(0);
+    unit.setActive(false);
+};
+exports.moveAlongPath = moveAlongPath;
+exports.default = exports.moveAlongPath;
+//# sourceMappingURL=moveAlongPath.js.map

package/lib/moveAlongPath.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"moveAlongPath.js","sourceRoot":"","sources":["moveAlongPath.ts"],"names":[],"mappings":";;;AACA,gEAAyD;AACzD,6EAAsE;AAI/D,MAAM,aAAa,GAAG,CAAC,IAAU,EAAE,IAAU,EAAQ,EAAE;IAC5D,OAAO,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,EAAE,GAAG,IAAI,EAAE;QAClC,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI;aAChB,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;aACrB,MAAM,CACL,CAAC,MAAqB,EAAkB,EAAE,CAAC,MAAM,YAAY,cAAI,CAClE,CAAC;QAEJ,IAAI,CAAC,IAAI,EAAE;YACT,MAAM;SACP;QAED,IAAI,CAAC,OAAO,EAAE,CAAC;KAChB;IAED,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE;QAC9B,OAAO;KACR;IAED,MAAM,CAAC,QAAQ,CAAC,GAAG,IAAI;SACpB,OAAO,EAAE;SACT,MAAM,CAAC,CAAC,MAAM,EAAsB,EAAE,CAAC,MAAM,YAAY,kBAAQ,CAAC,CAAC;IAEtE,IAAI,QAAQ,EAAE;QACZ,QAAQ,CAAC,OAAO,EAAE,CAAC;QAEnB,OAAO;KACR;IAED,IAAI,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IACpB,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;AACxB,CAAC,CAAC;AA/BW,QAAA,aAAa,iBA+BxB;AAEF,kBAAe,qBAAa,CAAC"}

package/lib/moveAlongPath.ts

@@ -0,0 +1,40 @@
+import Action from '@civ-clone/core-unit/Action';
+import Move from '@civ-clone/base-unit-action-move/Move';
+import NoOrders from '@civ-clone/base-unit-action-no-orders/NoOrders';
+import Path from '@civ-clone/core-world-path/Path';
+import Unit from '@civ-clone/core-unit/Unit';
+
+export const moveAlongPath = (unit: Unit, path: Path): void => {
+  while (unit.moves().value() > 0.25) {
+    const [move] = unit
+      .actions(path.shift())
+      .filter(
+        (action: Action | Move): action is Move => action instanceof Move
+      );
+
+    if (!move) {
+      break;
+    }
+
+    move.perform();
+  }
+
+  if (unit.moves().value() === 0) {
+    return;
+  }
+
+  const [noOrders] = unit
+    .actions()
+    .filter((action): action is NoOrders => action instanceof NoOrders);
+
+  if (noOrders) {
+    noOrders.perform();
+
+    return;
+  }
+
+  unit.moves().set(0);
+  unit.setActive(false);
+};
+
+export default moveAlongPath;

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@civ-clone/base-unit-action-goto",
+  "version": "0.1.0",
+  "repository": "git@github.com:civ-clone/base-unit-action-goto.git",
+  "keywords": [
+    "typescript",
+    "civilization"
+  ],
+  "author": "dom111 <dom111@users.noreply.github.com>",
+  "license": "MIT",
+  "private": false,
+  "scripts": {
+    "build": "npm run ts:compile && npm run prettier:format",
+    "prettier:check": "prettier --config .prettierrc '**/*.ts'",
+    "prettier:format": "prettier --config .prettierrc '**/*.ts' --write",
+    "ts:compile": "tsc --build tsconfig.json"
+  },
+  "devDependencies": {
+    "@types/node": "^14.11.2",
+    "prettier": "^2.1.2",
+    "typescript": "^4.0.3"
+  },
+  "dependencies": {
+    "@civ-clone/base-unit-action-move": "^0.1.1",
+    "@civ-clone/base-unit-action-no-orders": "^0.1.0",
+    "@civ-clone/core-rule": "^0.1.2",
+    "@civ-clone/core-strategy": "^0.1.0",
+    "@civ-clone/core-unit": "^0.1.13",
+    "@civ-clone/core-world": "^0.1.9",
+    "@civ-clone/core-world-path": "^0.1.0"
+  }
+}

package/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "declaration": true,
+    "lib": [
+      "es2019"
+    ],
+    "module": "commonjs",
+    "sourceMap": true,
+    "strict": true,
+    "target": "ES2018"
+  },
+  "exclude": [
+    "node_modules",
+    "tests/*.test.ts"
+  ]
+}