formgo

README

FormGo

FormGo is a Go (Golang) package that simplifies the process of encoding a struct into URL form values by extracting tagged fields. It's a convenient tool for working with web forms, making it easy to map Go structs to URL form data.

Features

• Encode Go structs into URL form values with minimal code.
• Supports string, integer, boolean, and float fields.
• Easily customize field names using struct tags.
• Support for pointers and omitempty tag for field exclusion.
• Customizable precision for float values.

Installation

To use FormGo in your Go project, you need to install it:

go get github.com/amazzalel-habib/form-go

Usage

package main

import (
	"fmt"
	"github.com/amazzalel-habib/form-go"
	"net/url"
)

type MyForm struct {
	Name        string  `form:"name"`
	Age         int     `form:"age"`
	Email       string  `form:"email"`
	Active      bool    `form:"active"`
	Price       float64 `form:"price"`
	Description *string `form:"description,omitempty"`
}

func main() {
	data := MyForm{
		Name:        "John Doe",
		Age:         30,
		Email:       "john@example.com",
		Active:      true,
		Price:       19.99,
		Description: nil, // Pointer field is nil and excluded due to omitempty tag.
	}

	formValues, err := formgo.EncodeFormValues(data)
	if err != nil {
		fmt.Println("Error:", err)
		return
	}

	fmt.Println(formValues.Encode())
}

In this example, we have a struct MyForm, and we use the form tag to specify the field names for the URL form values. The formgo.EncodeFormValues function encodes the struct into URL form values, supporting various data types and handling pointer fields with the omitempty tag.

Contributing

We welcome contributions from the community. If you find a bug or have an idea for an improvement, please open an issue or create a pull request.

License

FormGo is licensed under the MIT License.

Documentation

Index

• Variables
• func EncodeFormValues(data interface{}) (url.Values, error)

Variables

var FloatPrecision = -1

FloatPrecision is the precision used when formatting float values.

Functions

func EncodeFormValues

func EncodeFormValues(data interface{}) (url.Values, error)

EncodeFormValues encodes a struct into URL form values by extracting tagged fields.

The function accepts a struct and extracts fields with the "form" tag. It then converts non-empty string, non-zero integer, true boolean, and non-zero float fields into URL form values. It also handles pointer values for these primitive types.

The "omitempty" tag can be used to skip fields that have the "omitempty" tag and are empty.

Parameters:

• data: The input struct to be encoded.

Returns:

• url.Values: A map of field names to their string values in URL form.
• error: An error if the input data is not a struct or if encoding fails.