seltabl

func New ¶

func New[T any](doc *goquery.Document) ([]T, error)

New parses a goquery doc into a slice of structs.

The struct given as an argument must have a field with the tag seltabl, a header selector with the tag hSel, and a data selector with the tag dSel.

The selectors responsibilities:

• header selector (hSel): used to find the header row and column for the field in the given struct.
• data selector (dSel): used to find the data column for the field in the given struct.
• query selector (qSel): used to query for the inner text or attribute of the cell.
• control selector (cSel): used to control what to query for the inner text or attribute of the cell.

Example:

package main

var fixture = `
<table>
     <tr> <td>a</td> <td>b</td> </tr>
     <tr> <td>1</td> <td>2</td> </tr>
     <tr> <td>3</td> <td>4</td> </tr>
     <tr> <td>5</td> <td>6</td> </tr>
     <tr> <td>7</td> <td>8</td> </tr>
</table>
`

type FixtureStruct struct {
        A string `json:"a" hSel:"tr:nth-child(1)" dSel:"table tr:not(:first-child) td:nth-child(1)" cSel:"$text"`
        B string `json:"b" hSel:"tr:nth-child(1)" dSel:"table tr:not(:first-child) td:nth-child(2)" cSel:"$text"`
}

func main() {
	p, err := seltabl.New[fixtureStruct](fixture)
	if err != nil {
		panic(err)
	}
	for _, pp := range p {
		fmt.Printf("pp %+v\n", pp)
	}
}

func NewFromReader ¶

func NewFromReader[T any](r io.Reader) ([]T, error)

NewFromReader parses a reader into a slice of structs.

The reader must be a valid html page with a single table.

The passed in generic type must be a struct with valid selectors for the table and data (hSel, dSel, cSel).

The selectors responsibilities:

• header selector (hSel): used to find the header row and column for the field in the given struct.
• data selector (dSel): used to find the data column for the field in the given struct.
• query selector (qSel): used to query for the inner text or attribute of the cell.
• control selector (cSel): used to control what to query for the inner text or attribute of the cell.

Example:

package main

import (
	"fmt"
	"github.com/conneroisu/seltabl"
)

type TableStruct struct {
	A string `json:"a" hSel:"tr:nth-child(1) td:nth-child(1)" dSel:"tr td:nth-child(1)" cSel:"$text"`
	B string `json:"b" hSel:"tr:nth-child(1) td:nth-child(2)" dSel:"tr td:nth-child(2)" cSel:"$text"`
}

func main() {
	p, err := seltabl.NewFromReader[TableStruct](strings.NewReader(`
	<table>
		<tr> <td>a</td> <td>b</td> </tr>
		<tr> <td>1</td> <td>2</td> </tr>
		<tr> <td>3</td> <td>4</td> </tr>
		<tr> <td>5</td> <td>6</td> </tr>
		<tr> <td>7</td> <td>8</td> </tr>
	</table>
	`))
	if err != nil {
		panic(err)
	}
	for _, pp := range p {
		fmt.Printf("pp %+v\n", pp)
	}
}

func NewFromString ¶

func NewFromString[T any](htmlInput string) ([]T, error)

NewFromString parses a string into a slice of structs.

The struct must have a field with the tag seltabl, a header selector with the tag hSel, and a data selector with the tag dSel.

The selectors responsibilities:

• header selector (hSel): used to find the header row and column for the field in the given struct.
• data selector (dSel): used to find the data column for the field in the given struct.
• query selector (qSel): used to query for the inner text or attribute of the cell.
• control selector (cSel): used to control what to query for the inner text or attribute of the cell.

Example:

package main

import (
	"fmt"
	"github.com/conneroisu/seltabl"
)

type FixtureStruct struct {
        A string `json:"a" hSel:"tr:nth-child(1)" dSel:"table tr:not(:first-child) td:nth-child(1)" cSel:"$text"`
        B string `json:"b" hSel:"tr:nth-child(1)" dSel:"table tr:not(:first-child) td:nth-child(2)" cSel:"$text"`
}

func main() {
	p, err := seltabl.NewFromString[TableStruct](`
	<table>
		<tr> <td>a</td> <td>b</td> </tr>
		<tr> <td>1</td> <td>2</td> </tr>
		<tr> <td>3</td> <td>4</td> </tr>
		<tr> <td>5</td> <td>6</td> </tr>
		<tr> <td>7</td> <td>8</td> </tr>
	</table>
	`)
	if err != nil {
		panic(err)
	}
	for _, pp := range p {
		fmt.Printf("pp %+v\n", pp)
	}
}

func NewFromURL ¶

func NewFromURL[T any](url string) ([]T, error)

NewFromURL parses a given URL's html into a slice of structs adhering to the given generic type.

The URL must be a valid html page with a single table.

The passed in generic type must be a struct with valid selectors for the table and data (hSel, dSel, cSel).

The selectors responsibilities:

• header selector (hSel): used to find the header row and column for the field in the given struct.
• data selector (dSel): used to find the data column for the field in the given struct.
• query selector (qSel): used to query for the inner text or attribute of the cell.
• control selector (cSel): used to control what to query for the inner text or attribute of the cell.

Example:

package main

import (
	"fmt"
	"github.com/conneroisu/seltabl"
)

type FixtureStruct struct {
        A string `json:"a" hSel:"tr:nth-child(1)" dSel:"table tr:not(:first-child) td:nth-child(1)" cSel:"$text"`
        B string `json:"b" hSel:"tr:nth-child(1)" dSel:"table tr:not(:first-child) td:nth-child(2)" cSel:"$text"`
}

func main() {
	p, err := seltabl.NewFromURL[TableStruct]("https://github.com/conneroisu/seltabl/blob/main/testdata/ab_num_table.html")
	if err != nil {
		panic(err)
	}
	for _, pp := range p {
		fmt.Printf("pp %+v\n", pp)
	}
}

func SetStructField ¶

func SetStructField[T any](
	structPtr *T,
	fieldName string,
	cellValue *goquery.Selection,
	selector SelectorI,
) error

SetStructField sets a struct field to a value. It uses generics to specify the type of the struct and the field name. It also uses the selector interface to find the value and uses the type of the selector to parse and set the value.

It is used by the NewFromString function.