feat: add a function to keep parts of a structure.

6afe64f2 · Volker Schukai · 3d7474e7 · 6afe64f2 · 6afe64f2 · 6afe64f2
Verified Commit 6afe64f2 authored 2 years ago by Volker Schukai
--- a/README.md
+++ b/README.md
@@ -45,7 +45,7 @@ Furthermore, it will parse the templates for images, anchors, and text.
 This will generate HTML files from the prepared templates.

 ```bash
-bob template generate --input ./output/ --output ./output/
+bob html generate --input ./output/ --output ./output/
 ```

 ##### Sync
@@ -53,7 +53,7 @@ bob template generate --input ./output/ --output ./output/
 This will sync HTML nodes from a source to a destination.

 ```bash
-bob template sync --specification ./specification.yaml 
+bob html sync --specification ./specification.yaml 
 ```

 The structure of the specification file is as follows:
@@ -62,17 +62,19 @@ The structure of the specification file is as follows:
 sync:
  - source:
      path: './source.html'
-      selector: '#mainscript'
+      selector: 'head'
    destination:
      path: './'
      exclude:
        - ./source.html
+      keep:
+        - title
 ```

-The `source` is the source file and the `selector` is the selector to find the node to sync.
-The `destination` is the destination directory and the `exclude` is a list of files to exclude.
+With the above specification, the `head` node from `./source.html` will be synced to all files in `./` except `./source.html`.
+Furthermore, the `title` node will be kept.

-Relative paths are relative to the specification file.
+Relative paths are relative to the specification file. Absolute paths are absolute, obviously.

 #### Cut


--- a/application/source/html/sync.go
+++ b/application/source/html/sync.go
@@ -44,7 +44,7 @@ func SyncHtml(p string) error {

 	sourceFiles := make(map[string]*html.Node)
 	destinationFiles := make(map[string]*html.Node)
-	sourceDestination := make(map[string][]string)
+	destinationFile := make(map[string][]string)

 	for _, r := range specification.Sync {

@@ -107,7 +107,7 @@ func SyncHtml(p string) error {
 						}

 						destinationFiles[pp] = dd
-						sourceDestination[absSource] = append(sourceDestination[absSource], pp)
+						destinationFile[absSource] = append(destinationFile[absSource], pp)

 					}

@@ -133,7 +133,7 @@ func SyncHtml(p string) error {
 				}

 				destinationFiles[d] = dd
-				sourceDestination[absSource] = append(sourceDestination[absSource], d)
+				destinationFile[absSource] = append(destinationFile[absSource], d)

 			}

@@ -154,13 +154,32 @@ func SyncHtml(p string) error {

 			sourceNode := query.MatchFirst(sourceFiles[absSource])

-			dp := sourceDestination[absSource]
+			dp := destinationFile[absSource]
 			for _, d := range dp {
 				destinationSelector := r.Destination.Selector
 				if destinationSelector == "" {
 					destinationSelector = sourceSelector
 				}

+				keepMap := make(map[string][]*html.Node)
+
+				for _, n := range r.Destination.Keep {
+					q, err := cascadia.Compile(n)
+					if err != nil {
+						return err
+					}
+
+					kNode := q.MatchAll(destinationFiles[d])
+					if kNode == nil {
+						return fmt.Errorf("keep node not found: %s", n)
+					}
+
+					for _, k := range kNode {
+						keepMap[n] = append(keepMap[n], engine.CloneNode(k))
+					}
+
+				}
+
 				query, err := cascadia.Compile(destinationSelector)
 				if err != nil {
 					return err
@@ -174,6 +193,34 @@ func SyncHtml(p string) error {
 				n := engine.CloneNode(sourceNode)
 				destinationData.Parent.InsertBefore(n, destinationData)
 				destinationData.Parent.RemoveChild(destinationData)
+
+				for sel, k := range keepMap {
+					cas, err := cascadia.Compile(sel)
+					if err != nil {
+						return err
+					}
+					x := cas.MatchAll(destinationFiles[d])
+					if x == nil {
+						return fmt.Errorf("could not find selector %s in %s", sel, d)
+					}
+
+					for _, n1 := range x {
+
+						for _, kk := range k {
+
+							// node already removed, for example, by a previous keep
+							if n1.Parent == nil {
+								continue
+							}
+
+							n1.Parent.InsertBefore(kk, n1)
+							n1.Parent.RemoveChild(n1)
+						}
+
+					}
+
+				}
+
 			}

 		}

--- a/application/source/types/sync-specification.go
+++ b/application/source/types/sync-specification.go
@@ -4,9 +4,6 @@ import "gopkg.in/yaml.v3"

 type PathOrList []string

-//	func (p PathOrList) MarshalYAML() (interface{}, error) {
-//		return yaml.Marshal(p)
-//	}
 func (p *PathOrList) UnmarshalYAML(value *yaml.Node) error {

 	var multi []string
@@ -24,15 +21,6 @@ func (p *PathOrList) UnmarshalYAML(value *yaml.Node) error {
 	return nil
 }

-//func (p *PathOrList) UnmarshalYAML(b interface{}) error {
-//	var s string
-//	if err := yaml.Unmarshal(b, &s); err != nil {
-//		return err
-//	}
-//
-//	return nil
-//}
-
 type Sync struct {
 	Source struct {
 		Selector string `yaml:"selector"`
@@ -42,6 +30,7 @@ type Sync struct {
 		Selector string     `yaml:"selector"`
 		Path     PathOrList `yaml:"path"`
 		Exclude  []string   `yaml:"exclude"`
+		Keep     []string   `yaml:"keep"`
 	} `yaml:"destination"`
 }


--- a/development/examples/example1/config/spec1.yaml
+++ b/development/examples/example1/config/spec1.yaml
@@ -2,19 +2,23 @@ sync:

  - source:
      path: '../original/test1.html'
-      selector: '#mainscript'
+      selector: head
    destination:
      path: '../original/'
      exclude:
        - ../original/test1.html
+      keep:
+        - title
+        - meta[name=description]
+        - meta[name=author]
        
-  - source:
-      path: '../original/test1.html'
-      selector: '.deco'
-    destination:
-      path: '../original/'
-      exclude:
-        - ../original/test1.html
+#  - source:
+#      path: '../original/test1.html'
+#      selector: '.deco'
+#    destination:
+#      path: '../original/'
+#      exclude:
+#        - ../original/test1.html
     

     
--- a/development/examples/example1/original/test1.html
+++ b/development/examples/example1/original/test1.html
@@ -9,7 +9,7 @@
    <meta charset="utf-8"/>
    <meta name="viewport" content="width=device-width, initial-scale=1"/>

-    <meta name="robots" content="noindex,noarchive"/>
+    <meta name="robots" content="noindex"/>

    <link rel="icon" type="image/x-icon" href="/asset/icon/favicon.svg"/>
    <meta name="theme-color" content="#c10000"/>
@@ -17,10 +17,10 @@
    <link rel="icon" type="image/png" sizes="32x32" href="/asset/icon/favicon-32x32.png"/>
    <link rel="icon" type="image/png" sizes="16x16" href="/asset/icon/favicon-16x16.png"/>
    <link rel="mask-icon" href="/asset/icon/safari-pinned-tab.svg" color="#fd1d1d"/>
-    <meta name="msapplication-TileColor" content="#fd1d1d"/>
    <meta name="msapplication-TileImage" content="/asset/icon/mstile-144x144.png"/>
+    <meta name="msapplication-TileColor" content="#fd1d1d"/>

-    <title>Bad Request ME</title>
+    <title>TESTx</title>
    <meta name="description" content="The request was malformed or invalid."/>
    <meta name="author" content="schukai GmbH"/>


--- a/development/examples/example1/original/test2.html
+++ b/development/examples/example1/original/test2.html
@@ -9,7 +9,7 @@
    <meta charset="utf-8"/>
    <meta name="viewport" content="width=device-width, initial-scale=1"/>

-    <meta name="robots" content="noindex,noarchive"/>
+    <meta name="robots" content="noindex"/>

    <link rel="icon" type="image/x-icon" href="/asset/icon/favicon.svg"/>
    <meta name="theme-color" content="#c10000"/>
@@ -17,12 +17,12 @@
    <link rel="icon" type="image/png" sizes="32x32" href="/asset/icon/favicon-32x32.png"/>
    <link rel="icon" type="image/png" sizes="16x16" href="/asset/icon/favicon-16x16.png"/>
    <link rel="mask-icon" href="/asset/icon/safari-pinned-tab.svg" color="#fd1d1d"/>
-    <meta name="msapplication-TileColor" content="#fd1d1d"/>
    <meta name="msapplication-TileImage" content="/asset/icon/mstile-144x144.png"/>
+    <meta name="msapplication-TileColor" content="#fd1d1d"/>

-    <title>Bad Request ME</title>
-    <meta name="description" content="The request was malformed or invalid."/>
-    <meta name="author" content="schukai GmbH"/>
+    <title>TEST2</title>
+    <meta name="description" content="The 2request was malformed or invalid."/>
+    <meta name="author" content="sch2ukai GmbH"/>

    <link rel="icon" href="/favicon.ico"/>
    <link rel="icon" href="/favicon.svg" type="image/svg+xml"/>

--- a/development/examples/example1/original/test3.html
+++ b/development/examples/example1/original/test3.html
@@ -9,7 +9,7 @@
    <meta charset="utf-8"/>
    <meta name="viewport" content="width=device-width, initial-scale=1"/>

-    <meta name="robots" content="noindex,noarchive"/>
+    <meta name="robots" content="noindex"/>

    <link rel="icon" type="image/x-icon" href="/asset/icon/favicon.svg"/>
    <meta name="theme-color" content="#c10000"/>
@@ -17,12 +17,12 @@
    <link rel="icon" type="image/png" sizes="32x32" href="/asset/icon/favicon-32x32.png"/>
    <link rel="icon" type="image/png" sizes="16x16" href="/asset/icon/favicon-16x16.png"/>
    <link rel="mask-icon" href="/asset/icon/safari-pinned-tab.svg" color="#fd1d1d"/>
-    <meta name="msapplication-TileColor" content="#fd1d1d"/>
    <meta name="msapplication-TileImage" content="/asset/icon/mstile-144x144.png"/>
+    <meta name="msapplication-TileColor" content="#fd1d1d"/>

-    <title>Bad Request ME</title>
-    <meta name="description" content="The request was malformed or invalid."/>
-    <meta name="author" content="schukai GmbH"/>
+    <title>TEST3</title>
+    <meta name="description" content="The 3request was malformed or invalid."/>
+    <meta name="author" content="schukai3 GmbH"/>

    <link rel="icon" href="/favicon.ico"/>
    <link rel="icon" href="/favicon.svg" type="image/svg+xml"/>