harmonyc 0.1.0 → 0.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 harmony-ac
+
+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,85 @@
+# Harmony Code
+
+A simple model-based test design tool that generates Cucumber feature files.
+
+## Setup
+
+You need to have Node.js installed. Then you can install Harmony Code in your project folder by:
+
+```bash
+npm install harmonyc
+```
+
+And then run it for all `.harmony` files in your `src` folder:
+
+```bash
+harmonyc src/**/*.harmony
+```
+
+This will generate `.feature` files next to the `.harmony` files.
+
+## Syntax
+
+A `.harmony` file is a text file with a syntax that looks like this:
+
+```
+Products API:
++ Create:
+  + Anonymous:
+    - create product => error: unauthorized
+  + Admin:
+    - authenticate admin
+    - create product => product created
+    - Delete:
+      - delete product => product deleted
+```
+
+Compiling this with `harmonyc` will generate this `.feature` file:
+
+```gherkin
+Feature: change_password
+
+    Scenario: T1 - Products API - Create - Anonymous
+        When create product
+        Then error: unauthorized
+    
+    Scenario: T2 - Products API - Create - Admin - Delete
+        When authenticate admin
+        When create product
+        Then product created
+        When delete product
+        Then product deleted
+```
+
+### Indentation
+
+The lines of a file are nodes of a tree. The tree is specified with the indentation of the lines, which is n times 2 spaces and a `+` or `-` with one more space. The `+` or `-` sign is considered to be part of the indentation.
+
+### Sequences and forks
+
+`-` means a sequence: the node follows the previous sibling node and its descendants.
+
+`+` means a fork: the node directly follows its parent node. All siblings with `+` are separate branches, they will generate separate scenarios.
+
+### Labels
+
+Label are nodes that end with `:`. You can use them to structure your test design.
+They are not included in the test case, but the test case name is generated from the labels.
+
+### Comments
+
+Lines starting with `#` or `//` are comments and are ignored.
+
+### Steps
+
+All other lines are steps. A step consists of an action, and one or more responses denoted by `=>`.
+Actions will become `When` steps, and responses will become `Then` steps.
+
+
+## Running the tests
+
+`harmonyc` only compiles `.harmony` files to `.feature` files. To run the tests, you need to set up Cucumber or Specflow, depending on your environment.
+
+## License
+
+MIT

package/package.json

@@ -1,18 +1,18 @@
 {
   "name": "harmonyc",
   "description": "Harmony Code - Test design compiler from high-level model to Gherkin",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "author": "Bernát Kalló",
   "bin": {
     "harmonyc": "./cli.js"
   },
-  "homepage": "https://github.com/harmony-ac/code#readme",
+  "homepage": "https://github.com/harmony-ac/harmony-code#readme",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/harmony-ac/code.git"
+    "url": "git+https://github.com/harmony-ac/harmony-code.git"
   },
   "bugs": {
-    "url": "https://github.com/harmony-ac/code/issues"
+    "url": "https://github.com/harmony-ac/harmony-code/issues"
   },
   "dependencies": {
     "fast-glob": "^3.3.2",
@@ -20,9 +20,22 @@
   },
   "license": "MIT",
   "keywords": [
-    "unit test", "unit testing", "cucumber", "bdd", "behavior-driven",
-    "test design", "test design automation", "gherkin", "cucumber",
-    "specflow", "harmony.ac", "test framework", "model-based test",
-    "model-based testing", "test model", "test modeling", "test modelling"
+    "unit test",
+    "unit testing",
+    "cucumber",
+    "bdd",
+    "behavior-driven",
+    "test design",
+    "test design automation",
+    "gherkin",
+    "cucumber",
+    "specflow",
+    "harmony.ac",
+    "test framework",
+    "model-based test",
+    "model-based testing",
+    "test model",
+    "test modeling",
+    "test modelling"
   ]
 }

package/util/xmur3.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.xmur3 = void 0;
-// https://stackoverflow.com/a/47593316
+// https://stackoverflow.com/revisions/47593316/25 by bryc (github.com/bryc)
 function xmur3(str) {
     let h = 1779033703 ^ str.length;
     for (let i = 0; i < str.length; i++)