Merge branch 'main' into zapdiff

Author: AryaHassanli

.github/version.json

@@ -1,3 +1,3 @@
 {
-  "version": "v1.5.24"
+  "version": "v1.6.5"
 }

.github/workflows/build.yml

@@ -0,0 +1,24 @@
+name: Build and Test
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Go
+      uses: actions/setup-go@v5
+      with:
+        go-version-file: 'go.mod'
+
+    - name: Build
+      run: go build -v ./...
+
+    - name: Test
+      run: go test -v ./...

README.md

@@ -340,15 +340,13 @@ To query, use you favorite MySQL client. On the command line, for example:
 
 
 ```console
-mysql -h 127.0.0.1 --skip-ssl
+mysql -h 127.0.0.1 --skip-ssl MatterSpec
 ```
 
 The `--skip-ssl` is because `alchemy-db` runs locally without SSL certificates, as a debug tool, yet modern MySQL versions require SSL on the connection unless otherwise specified.
 
 ##### Semantic tags used across multiple Namespaces
 ```sql
-USE MatterSpec;
-
 SELECT
     t.name AS tag,
     ns.name AS namespace,
@@ -410,3 +408,28 @@ WHERE
         (SELECT NAME FROM LargeEnums)
     );  
 ```
+
+##### Export full list of semantic tags
+```sql
+
+SELECT
+    n.id AS namespace_id,
+    t.id AS tag_id,    
+    t.name AS tag_name,
+    n.name AS namespace_name,
+    d.name AS source_name
+FROM
+    tag AS t
+INNER JOIN
+    namespace AS n ON t.namespace_id = n.namespace_id
+INNER JOIN
+    document AS d ON n.document_id = d.document_id
+ORDER BY
+    namespace_id ASC, tag_id ASC;
+```
+
+An export as CSV of this query can be done directly like this:
+
+```console
+mysql -h 127.0.0.1 --skip-ssl --batch -e "SELECT n.id AS namespace_id, t.id AS tag_id, t.name AS tag_name, n.name AS namespace_name, d.name AS source_name FROM tag AS t INNER JOIN namespace AS n ON t.namespace_id = n.namespace_id INNER JOIN document AS d ON n.document_id = d.document_id ORDER BY namespace_id ASC, tag_id ASC;" MatterSpec | sed 's/\t/,/g' > namespaces.csv
+```

asciidoc/counter.go

@@ -6,10 +6,10 @@ type Counter struct {
 
 	Name         string
 	InitialValue string
-	Display      bool
+	Display      CounterVisibility
 }
 
-func NewCounter(name string, initialValue any, display bool) *Counter {
+func NewCounter(name string, initialValue any, display CounterVisibility) *Counter {
 	iv, _ := initialValue.(string)
 	return &Counter{Name: name, InitialValue: iv, Display: display}
 }
@@ -44,6 +44,17 @@ const (
 	CounterTypeLowerCase
 )
 
+type CounterVisibility uint8
+
+const (
+	CounterVisibilityHidden CounterVisibility = iota
+	CounterVisibilityVisible
+)
+
+func (cb CounterVisibility) Visible() bool {
+	return cb == CounterVisibilityVisible
+}
+
 type CounterState struct {
 	CounterType CounterType
 	Value       int

asciidoc/describe.go

@@ -164,7 +164,7 @@ func Describe(el Element) string {
 		if el.InitialValue != "" {
 			s += fmt.Sprintf(" (initial value: %s)", el.InitialValue)
 		}
-		if el.Display {
+		if el.Display.Visible() {
 			s += " (display)"
 		}
 		return s

asciidoc/overlay/overlay.go

@@ -123,17 +123,17 @@ func preparseFile(cxt OverlayContext, pps *overlayFileState, d *asciidoc.Documen
 			}
 			remove = true
 		case *asciidoc.IfDef:
-			suppressStack.Push(&conditionalBlock{suppress: suppress, open: el})
+			suppressStack.Push(&conditionalBlock{suppress: suppress, open: el, addToCell: addToCell})
 			suppress = suppress || !el.Eval(pps)
 			remove = true
-			addToCell = el.Inline
+			addToCell = el.Inline || isContentIfDef(parent, index)
 		case *asciidoc.IfNDef:
-			suppressStack.Push(&conditionalBlock{suppress: suppress, open: el})
+			suppressStack.Push(&conditionalBlock{suppress: suppress, open: el, addToCell: addToCell})
 			suppress = suppress || !el.Eval(pps)
 			remove = true
-			addToCell = el.Inline
+			addToCell = el.Inline || isContentIfDef(parent, index)
 		case *asciidoc.IfEval:
-			suppressStack.Push(&conditionalBlock{suppress: suppress, open: el})
+			suppressStack.Push(&conditionalBlock{suppress: suppress, open: el, addToCell: addToCell})
 			if !suppress {
 				var include bool
 				include, err = el.Eval(pps)
@@ -144,7 +144,7 @@ func preparseFile(cxt OverlayContext, pps *overlayFileState, d *asciidoc.Documen
 				suppress = !include
 			}
 			remove = true
-			addToCell = el.Inline
+			addToCell = el.Inline || isContentIfDef(parent, index)
 		case *asciidoc.IfDefBlock, *asciidoc.IfNDefBlock, *asciidoc.IfEvalBlock:
 			err = fmt.Errorf("unexpected type in preparse: %T", el)
 			should = parse.SearchShouldStop
@@ -163,7 +163,7 @@ func preparseFile(cxt OverlayContext, pps *overlayFileState, d *asciidoc.Documen
 			}
 			suppress = cb.suppress
 			remove = true
-			addToCell = false
+			addToCell = cb.addToCell
 		case *asciidoc.InlineIfDef:
 			if !suppress {
 				if el.Eval(pps) {
@@ -365,3 +365,26 @@ func parseLevelOffset(el asciidoc.Parent, elements asciidoc.Elements) (leveloffs
 	leveloffset, relative, err = text.ParseRelativeNumber(val)
 	return
 }
+
+func isContentIfDef(parent asciidoc.ParentElement, index int) bool {
+	if _, ok := parent.(*asciidoc.Table); !ok {
+		return false
+	}
+	children := parent.Children()
+	depth := 0
+	for i := index + 1; i < len(children); i++ {
+		child := children[i]
+		switch child.(type) {
+		case *asciidoc.IfDef, *asciidoc.IfNDef, *asciidoc.IfEval:
+			depth++
+		case *asciidoc.EndIf:
+			if depth == 0 {
+				return true
+			}
+			depth--
+		case *asciidoc.TableRow:
+			return false
+		}
+	}
+	return false
+}

asciidoc/overlay/state.go

@@ -7,8 +7,9 @@ import (
 )
 
 type conditionalBlock struct {
-	open     asciidoc.Element
-	suppress bool
+	open      asciidoc.Element
+	suppress  bool
+	addToCell bool
 }
 
 type overlayState struct {

asciidoc/parse/asciidoc.go

@@ -5,6 +5,7 @@ import (
 	"fmt"
 	"io"
 	"log/slog"
+	"os"
 	"time"
 
 	"github.com/project-chip/alchemy/asciidoc"
@@ -31,6 +32,16 @@ func Bytes(path asciidoc.Path, b []byte, opts ...Option) (*asciidoc.Document, er
 	return d, nil
 }
 
+func File(path asciidoc.Path, opts ...Option) (*asciidoc.Document, error) {
+
+	file, err := os.Open(path.Absolute)
+	if err != nil {
+		return nil, err
+	}
+	defer file.Close()
+	return Reader(path, file, opts...)
+}
+
 func parseBytes(document *asciidoc.Document, b []byte, opts ...Option) (elements asciidoc.Elements, err error) {
 
 	opts = append(opts, setDocument(document))

asciidoc/parse/parse.go

@@ -30,12 +30,19 @@ const (
 	AttributeFilterFloat
 )
 
+type attributeRenderType uint8
+
+const (
+	attributeRenderTypeBlock attributeRenderType = iota
+	attributeRenderTypeInline
+)
+
 func shouldRenderAttributeType(at AttributeFilter, include AttributeFilter, exclude AttributeFilter) bool {
 	return ((at & include) == at) && ((at & exclude) != at)
 }
 
-func renderAttributes(cxt Target, attributes []asciidoc.Attribute, inline bool) error {
-	_, err := renderSelectAttributes(cxt, attributes, AttributeFilterAll, AttributeFilterNone, inline)
+func renderAttributes(cxt Target, attributes []asciidoc.Attribute, renderType attributeRenderType) error {
+	_, err := renderSelectAttributes(cxt, attributes, AttributeFilterAll, AttributeFilterNone, renderType)
 	return err
 }
 
@@ -67,12 +74,12 @@ func getAttributeType(name asciidoc.AttributeName) AttributeFilter {
 	return AttributeFilterNone
 }
 
-func renderSelectAttributes(cxt Target, attributes []asciidoc.Attribute, include AttributeFilter, exclude AttributeFilter, inline bool) (n int, err error) {
+func renderSelectAttributes(cxt Target, attributes []asciidoc.Attribute, include AttributeFilter, exclude AttributeFilter, renderType attributeRenderType) (n int, err error) {
 	if len(attributes) == 0 {
 		return
 	}
 
-	type attributeClass uint32
+	type attributeClass uint8
 
 	const (
 		attributeClassNone attributeClass = iota
@@ -136,7 +143,7 @@ func renderSelectAttributes(cxt Target, attributes []asciidoc.Attribute, include
 				continue
 			}
 			for _, ta := range anchors {
-				err = renderAttributeAnchor(cxt, ta, include, exclude, inline)
+				err = renderAttributeAnchor(cxt, ta, include, exclude, renderType)
 				if err != nil {
 					return
 				}
@@ -170,7 +177,7 @@ func renderSelectAttributes(cxt Target, attributes []asciidoc.Attribute, include
 			if len(filtered) == 0 {
 				continue
 			}
-			if !inline {
+			if renderType != attributeRenderTypeInline {
 				cxt.EnsureNewLine()
 			}
 			cxt.FlushWrap()
@@ -216,7 +223,7 @@ func renderSelectAttributes(cxt Target, attributes []asciidoc.Attribute, include
 				n++
 			}
 			cxt.WriteString("]")
-			if !inline {
+			if renderType != attributeRenderTypeInline {
 				cxt.WriteString("\n")
 			}
 			cxt.EndBlock()
@@ -229,10 +236,10 @@ func renderSelectAttributes(cxt Target, attributes []asciidoc.Attribute, include
 	return
 }
 
-func renderAttributeAnchor(cxt Target, anchor *asciidoc.AnchorAttribute, include AttributeFilter, exclude AttributeFilter, inline bool) (err error) {
+func renderAttributeAnchor(cxt Target, anchor *asciidoc.AnchorAttribute, include AttributeFilter, exclude AttributeFilter, renderType attributeRenderType) (err error) {
 	id := anchor.ID
 	if len(id) > 0 && shouldRenderAttributeType(AttributeFilterID, include, exclude) {
-		if !inline {
+		if renderType != attributeRenderTypeInline {
 			cxt.EnsureNewLine()
 		}
 		cxt.FlushWrap()
@@ -255,7 +262,7 @@ func renderAttributeAnchor(cxt Target, anchor *asciidoc.AnchorAttribute, include
 			}
 		}
 		cxt.WriteString("]]")
-		if !inline {
+		if renderType != attributeRenderTypeInline {
 			cxt.WriteRune('\n')
 		}
 		cxt.EndBlock()