docs: add @slangroom/location examples

docs/examples/index.md

@@ -225,6 +225,78 @@
 <<< @/../examples/json-schema/validate.keys.json{json}
 :::
 
+## location plugin examples
+
+### assign the current location
+::: code-group
+<<< @/../examples/location/assign.slang{3 gherkin:line-numbers}
+<<< @/../examples/location/assign.data.json{json}
+<<< @/../examples/location/assign.keys.json{json}
+:::
+
+### go back in history
+::: code-group
+<<< @/../examples/location/go_back.slang{3 gherkin:line-numbers}
+<<< @/../examples/location/go_back.data.json{json}
+<<< @/../examples/location/go_back.keys.json{json}
+:::
+
+### go forward in history
+::: code-group
+<<< @/../examples/location/go_forward.slang{3 gherkin:line-numbers}
+<<< @/../examples/location/go_forward.data.json{json}
+<<< @/../examples/location/go_forward.keys.json{json}
+:::
+
+### go to a specific page in history
+::: code-group
+<<< @/../examples/location/go_to_index.slang{3 gherkin:line-numbers}
+<<< @/../examples/location/go_to_index.data.json{json}
+<<< @/../examples/location/go_to_index.keys.json{json}
+:::
+
+### get the history length
+::: code-group
+<<< @/../examples/location/history_length.slang{3 gherkin:line-numbers}
+<<< @/../examples/location/history_length.data.json{json}
+<<< @/../examples/location/history_length.keys.json{json}
+:::
+
+### get the current location
+::: code-group
+<<< @/../examples/location/location.slang{9 gherkin:line-numbers}
+<<< @/../examples/location/location.data.json{json}
+<<< @/../examples/location/location.keys.json{json}
+:::
+
+### open the url in a new window
+::: code-group
+<<< @/../examples/location/new_window.slang{3 gherkin:line-numbers}
+<<< @/../examples/location/new_window.data.json{json}
+<<< @/../examples/location/new_window.keys.json{json}
+:::
+
+### redirect to the url
+::: code-group
+<<< @/../examples/location/redirect.slang{3 gherkin:line-numbers}
+<<< @/../examples/location/redirect.data.json{json}
+<<< @/../examples/location/redirect.keys.json{json}
+:::
+
+### reload the page
+::: code-group
+<<< @/../examples/location/reload.slang{3 gherkin:line-numbers}
+<<< @/../examples/location/reload.data.json{json}
+<<< @/../examples/location/reload.keys.json{json}
+:::
+
+### replace the current location
+::: code-group
+<<< @/../examples/location/replace.slang{3 gherkin:line-numbers}
+<<< @/../examples/location/replace.data.json{json}
+<<< @/../examples/location/replace.keys.json{json}
+:::
+
 ## oauth plugin examples
 
 ### add data to authorization details

docs/examples/index.mjs

@@ -17,6 +17,7 @@ let examplesDoc = `\n# Slangroom examples\n\n`;
 	'helpers',
 	'http',
 	'json-schema',
+	'location',
 	'oauth',
 	'pocketbase',
 	'qrcode',

docs/statements/index.md

@@ -166,6 +166,28 @@ neither the open/connect part nor the parameters part are present.
 | ------------ | --------------------- | ------------- |
 |              | json_data,json_schema | validate json |
 
+## location plugin
+| open/connect | params | phrase                                 |
+| ------------ | ------ | -------------------------------------- |
+|              |        | get the current location               |
+|              |        | get the current location href          |
+|              |        | get the current location protocol      |
+|              |        | get the current location host          |
+|              |        | get the current location hostname      |
+|              |        | get the current location port          |
+|              |        | get the current location pathname      |
+|              |        | get the current location search params |
+|              |        | get the current location hash          |
+|              |        | reload the current page                |
+|              | url    | replace the current location           |
+|              | url    | assign the current location            |
+|              | url    | redirect to the url                    |
+|              |        | go back in history                     |
+|              |        | go forward in history                  |
+|              | index  | go to a specific page in history       |
+|              |        | get the history length                 |
+|              | url    | open the url in a new window           |
+
 ## oauth plugin
 | open/connect | params                                | phrase                               |
 | ------------ | ------------------------------------- | ------------------------------------ |

docs/statements/index.mjs

@@ -16,6 +16,7 @@ import {git} from "@slangroom/git";
 import {helpers} from "@slangroom/helpers";
 import {http} from "@slangroom/http";
 import {JSONSchema} from "@slangroom/json-schema";
+import {location} from "@slangroom/location";
 import {oauth} from "@slangroom/oauth";
 import {pocketbase} from "@slangroom/pocketbase";
 import {qrcode} from "@slangroom/qrcode";
@@ -61,6 +62,7 @@ const generateTable = (plugin, name) => {
 	[helpers, 'helpers'],
 	[http, 'http'],
 	[JSONSchema, 'json-schema'],
+	[location, 'location'],
 	[oauth, 'oauth'],
 	[pocketbase, 'pocketbase'],
 	[qrcode, 'qrcode'],

docs/statements/package.json

@@ -18,6 +18,7 @@
 		"@slangroom/helpers": "workspace:^",
 		"@slangroom/http": "workspace:^",
 		"@slangroom/json-schema": "workspace:^",
+		"@slangroom/location": "workspace:^",
 		"@slangroom/oauth": "workspace:^",
 		"@slangroom/pocketbase": "workspace:^",
 		"@slangroom/qrcode": "workspace:^",

examples/location/assign.data.json

@@ -0,0 +1,3 @@
+{
+    "url": "https://example.com"
+}

examples/location/assign.keys.json

@@ -0,0 +1 @@
+{}

examples/location/assign.meta.json

@@ -0,0 +1,4 @@
+{
+	"title": "assign the current location",
+	"highlight": "3"
+}

examples/location/assign.slang

@@ -0,0 +1,6 @@
+Rule unknown ignore
+
+Given I send url 'url' and assign the current location
+
+Given nothing
+Then print data

examples/location/go_back.data.json

@@ -0,0 +1 @@
+{}

examples/location/go_back.keys.json

@@ -0,0 +1 @@
+{}

examples/location/go_back.meta.json

@@ -0,0 +1,4 @@
+{
+	"title": "go back in history",
+	"highlight": "3"
+}

examples/location/go_back.slang

@@ -0,0 +1,6 @@
+Rule unknown ignore
+
+Given I go back in history
+
+Given nothing
+Then print data

examples/location/go_forward.data.json

@@ -0,0 +1 @@
+{}

examples/location/go_forward.keys.json

@@ -0,0 +1 @@
+{}

examples/location/go_forward.meta.json

@@ -0,0 +1,4 @@
+{
+	"title": "go forward in history",
+	"highlight": "3"
+}

examples/location/go_forward.slang

@@ -0,0 +1,6 @@
+Rule unknown ignore
+
+Given I go forward in history
+
+Given nothing
+Then print data

examples/location/go_to_index.data.json

@@ -0,0 +1,3 @@
+{
+    "index": -1
+}

examples/location/go_to_index.keys.json

@@ -0,0 +1 @@
+{}

examples/location/go_to_index.meta.json

@@ -0,0 +1,4 @@
+{
+    "title": "go to a specific page in history",
+    "highlight": 3
+}

examples/location/go_to_index.slang

@@ -0,0 +1,6 @@
+Rule unknown ignore
+
+Given send index 'index' and I go to a specific page in history
+
+Given nothing
+Then print data

examples/location/history_length.data.json

@@ -0,0 +1 @@
+{}

examples/location/history_length.keys.json

@@ -0,0 +1 @@
+{}

examples/location/history_length.meta.json

@@ -0,0 +1,4 @@
+{
+    "title": "get the history length",
+    "highlight": "3"
+}

examples/location/history_length.slang

@@ -0,0 +1,6 @@
+Rule unknown ignore
+
+Given I get the history length and output into 'history_length'
+
+Given I have a 'number' named 'history_length'
+Then print data

examples/location/location.data.json

@@ -0,0 +1 @@
+{}

examples/location/location.keys.json

@@ -0,0 +1 @@
+{}

examples/location/location.meta.json

@@ -0,0 +1,4 @@
+{
+    "title": "get the current location",
+    "highlight": "9"
+}

examples/location/location.slang

@@ -0,0 +1,12 @@
+Rule unknown ignore
+
+# this reutrn the window.location object
+# singular element of location can be obtained by adding
+# the reuqest element, i.e. href, protocol, host, hostname, port,
+# pathname, search params, hash, after 'location' like
+# Given I get the current location href and output into 'result'
+
+Given I get the current location and output into 'location'
+
+Given I have a 'string dictionary' named 'location'
+Then print data

examples/location/new_window.data.json

@@ -0,0 +1,3 @@
+{
+    "url": "https://example.com"
+}

examples/location/new_window.keys.json

@@ -0,0 +1 @@
+{}

examples/location/new_window.meta.json

@@ -0,0 +1,4 @@
+{
+    "title": "open the url in a new window",
+    "highlight": "3"
+}

examples/location/new_window.slang

@@ -0,0 +1,6 @@
+Rule unknown ignore
+
+Given I send url 'url' and open the url in a new window
+
+Given nothing
+Then print data

examples/location/redirect.data.json

@@ -0,0 +1,3 @@
+{
+    "url": "https://example.com"
+}

examples/location/redirect.keys.json

@@ -0,0 +1 @@
+{}

examples/location/redirect.meta.json

@@ -0,0 +1,4 @@
+{
+	"title": "redirect to the url",
+	"highlight": "3"
+}

examples/location/redirect.slang

@@ -0,0 +1,6 @@
+Rule unknown ignore
+
+Given I send url 'url' and redirect to the url
+
+Given nothing
+Then print data

examples/location/reload.data.json

@@ -0,0 +1 @@
+{}

examples/location/reload.keys.json

@@ -0,0 +1 @@
+{}

examples/location/reload.meta.json

@@ -0,0 +1,4 @@
+{
+	"title": "reload the page",
+	"highlight": "3"
+}

examples/location/reload.slang

@@ -0,0 +1,6 @@
+Rule unknown ignore
+
+Given I reload the current page
+
+Given nothing
+Then print data

examples/location/replace.data.json

@@ -0,0 +1,3 @@
+{
+    "url": "https://example.com"
+}

examples/location/replace.keys.json

@@ -0,0 +1 @@
+{}

examples/location/replace.meta.json

@@ -0,0 +1,4 @@
+{
+	"title": "replace the current location",
+	"highlight": "3"
+}

examples/location/replace.slang

@@ -0,0 +1,6 @@
+Rule unknown ignore
+
+Given I send url 'url' and replace the current location
+
+Given nothing
+Then print data