resource

Documentation

Overview

Package resource supplies a generic Access[K, V] interface for CRUD operations on key-value pairs, backed by an in-memory and JSON file implementation.

Index

• Constants
• type Access
• type InMemoryAccess
  • func NewInMemoryAccess[K comparable, V any]() *InMemoryAccess[K, V]
  • func (a *InMemoryAccess[K, V]) Create(ctx context.Context, key K, value V) (err error)
  • func (a *InMemoryAccess[K, V]) Delete(ctx context.Context, key K) (err error)
  • func (a *InMemoryAccess[K, V]) Read(ctx context.Context, key K) (ptr *V, err error)
  • func (a *InMemoryAccess[K, V]) ReadAll(ctx context.Context) (values []V, err error)
  • func (a *InMemoryAccess[K, V]) Update(ctx context.Context, key K, value V) (err error)
• type IndexFunc
• type IndexedAccess
  • func NewIndexedAccess[K comparable, V any](access Access[K, V]) *IndexedAccess[K, V]
  • func (a *IndexedAccess[K, V]) AddIndex(name string, fn IndexFunc[V])
  • func (a *IndexedAccess[K, V]) Create(ctx context.Context, key K, value V) error
  • func (a *IndexedAccess[K, V]) Delete(ctx context.Context, key K) error
  • func (a *IndexedAccess[K, V]) FindByIndex(ctx context.Context, indexName string, indexKey string) ([]V, error)
  • func (a *IndexedAccess[K, V]) FindOneByIndex(ctx context.Context, indexName string, indexKey string) (*V, bool)
  • func (a *IndexedAccess[K, V]) Read(ctx context.Context, key K) (*V, error)
  • func (a *IndexedAccess[K, V]) ReadAll(ctx context.Context) ([]V, error)
  • func (a *IndexedAccess[K, V]) Update(ctx context.Context, key K, value V) error
• type JsonFileAccess
  • func NewJsonFileAccess[K comparable, V any](path string) *JsonFileAccess[K, V]
  • func (a *JsonFileAccess[K, V]) Create(ctx context.Context, key K, value V) error
  • func (a *JsonFileAccess[K, V]) Delete(ctx context.Context, key K) error
  • func (a *JsonFileAccess[K, V]) Read(ctx context.Context, key K) (*V, error)
  • func (a *JsonFileAccess[K, V]) ReadAll(ctx context.Context) ([]V, error)
  • func (a *JsonFileAccess[K, V]) Update(ctx context.Context, key K, value V) error
• type MockAccess
  • func NewMockAccess[K, V any]() *MockAccess[K, V]
  • func (a *MockAccess[K, V]) Create(ctx context.Context, key K, value V) error
  • func (a *MockAccess[K, V]) Delete(ctx context.Context, key K) (err error)
  • func (a *MockAccess[K, V]) Read(ctx context.Context, key K) (value *V, err error)
  • func (a *MockAccess[K, V]) ReadAll(ctx context.Context) (values []V, err error)
  • func (a *MockAccess[K, V]) Update(ctx context.Context, key K, value V) error
  • func (a *MockAccess[K, V]) WithCreateFn(fn func(ctx context.Context, key K, value V) error) *MockAccess[K, V]
  • func (a *MockAccess[K, V]) WithDeleteFn(fn func(ctx context.Context, key K) error) *MockAccess[K, V]
  • func (a *MockAccess[K, V]) WithReadAllFn(fn func(ctx context.Context) ([]V, error)) *MockAccess[K, V]
  • func (a *MockAccess[K, V]) WithReadFn(fn func(ctx context.Context, key K) (*V, error)) *MockAccess[K, V]
  • func (a *MockAccess[K, V]) WithUpdateFn(fn func(ctx context.Context, key K, value V) error) *MockAccess[K, V]
• type SqliteAccess
  • func NewSqliteAccess[K comparable, V any](db *sql.DB) *SqliteAccess[K, V]
  • func (a *SqliteAccess[K, V]) Create(ctx context.Context, key K, value V) (err error)
  • func (a *SqliteAccess[K, V]) Delete(ctx context.Context, key K) (err error)
  • func (a *SqliteAccess[K, V]) Init(ctx context.Context) (err error)
  • func (a *SqliteAccess[K, V]) Read(ctx context.Context, key K) (ptr *V, err error)
  • func (a *SqliteAccess[K, V]) ReadAll(ctx context.Context) (values []V, err error)
  • func (a *SqliteAccess[K, V]) Update(ctx context.Context, key K, value V) (err error)
• type YamlFileAccess
  • func NewYamlFileAccess[K comparable, V any](path string) *YamlFileAccess[K, V]
  • func (a *YamlFileAccess[K, V]) Create(ctx context.Context, key K, value V) error
  • func (a *YamlFileAccess[K, V]) Delete(ctx context.Context, key K) error
  • func (a *YamlFileAccess[K, V]) Read(ctx context.Context, key K) (*V, error)
  • func (a *YamlFileAccess[K, V]) ReadAll(ctx context.Context) ([]V, error)
  • func (a *YamlFileAccess[K, V]) Update(ctx context.Context, key K, value V) error

Constants

const (
	ErrorResourceAlreadyExists = "Resource already exists"
	ErrorResourceNotFound      = "Resource not found"
)

Types

type Access

type Access[K, V any] interface {
	Create(ctx context.Context, key K, value V) error
	Read(ctx context.Context, key K) (*V, error)
	ReadAll(ctx context.Context) ([]V, error)
	Update(ctx context.Context, key K, value V) error
	Delete(ctx context.Context, key K) error
}

Access specifies the CRUD operations for a resource using generics. It supports context.Context for cancellation and timeouts.

type InMemoryAccess

type InMemoryAccess[K comparable, V any] struct {
	// contains filtered or unexported fields
}

InMemoryAccess is a generic access implementation backed by a mock, in-memory and JSON file.

func NewInMemoryAccess

func NewInMemoryAccess[K comparable, V any]() *InMemoryAccess[K, V]

NewInMemoryAccess creates a new in-memory access.

func (*InMemoryAccess[K, V]) Create

func (a *InMemoryAccess[K, V]) Create(ctx context.Context, key K, value V) (err error)

Create creates a new resource.

func (*InMemoryAccess[K, V]) Delete

func (a *InMemoryAccess[K, V]) Delete(ctx context.Context, key K) (err error)

Delete deletes a resource.

func (*InMemoryAccess[K, V]) Read

func (a *InMemoryAccess[K, V]) Read(ctx context.Context, key K) (ptr *V, err error)

Read reads a resource.

func (*InMemoryAccess[K, V]) ReadAll

func (a *InMemoryAccess[K, V]) ReadAll(ctx context.Context) (values []V, err error)

ReadAll reads all resources.

func (*InMemoryAccess[K, V]) Update

func (a *InMemoryAccess[K, V]) Update(ctx context.Context, key K, value V) (err error)

Update updates a resource.

type IndexFunc

type IndexFunc[V any] func(V) string

IndexFunc extracts an index key from a value. Returns an empty string if the value should not be indexed.

type IndexedAccess

type IndexedAccess[K comparable, V any] struct {
	// contains filtered or unexported fields
}

IndexedAccess wraps a resource.Access and maintains secondary indexes. It supports both unique and non-unique indexes (stored as lists of keys).

func NewIndexedAccess

func NewIndexedAccess[K comparable, V any](access Access[K, V]) *IndexedAccess[K, V]

NewIndexedAccess creates a new indexed access wrapper.

func (*IndexedAccess[K, V]) AddIndex

func (a *IndexedAccess[K, V]) AddIndex(name string, fn IndexFunc[V])

AddIndex adds a new secondary index. name is the unique name of the index. fn is the function to extract the index key from the value.

func (*IndexedAccess[K, V]) Create

func (a *IndexedAccess[K, V]) Create(ctx context.Context, key K, value V) error

Create stores a new value and updates secondary indexes.

func (*IndexedAccess[K, V]) Delete

func (a *IndexedAccess[K, V]) Delete(ctx context.Context, key K) error

Delete removes a value and its secondary index entries.

func (*IndexedAccess[K, V]) FindByIndex

func (a *IndexedAccess[K, V]) FindByIndex(ctx context.Context, indexName string, indexKey string) ([]V, error)

FindByIndex retrieves values by a secondary index key.

func (*IndexedAccess[K, V]) FindOneByIndex

func (a *IndexedAccess[K, V]) FindOneByIndex(ctx context.Context, indexName string, indexKey string) (*V, bool)

FindOneByIndex retrieves a single value by a secondary index key. Returns nil, false if not found.

func (*IndexedAccess[K, V]) Read

func (a *IndexedAccess[K, V]) Read(ctx context.Context, key K) (*V, error)

Read retrieves a value by its primary key.

func (*IndexedAccess[K, V]) ReadAll

func (a *IndexedAccess[K, V]) ReadAll(ctx context.Context) ([]V, error)

ReadAll retrieves all values.

func (*IndexedAccess[K, V]) Update

func (a *IndexedAccess[K, V]) Update(ctx context.Context, key K, value V) error

Update updates an existing value and its secondary indexes.

type JsonFileAccess

type JsonFileAccess[K comparable, V any] struct {
	// contains filtered or unexported fields
}

JsonFileAccess is a json file access.

func NewJsonFileAccess

func NewJsonFileAccess[K comparable, V any](path string) *JsonFileAccess[K, V]

NewJsonFileAccess creates a new json file access.

func (*JsonFileAccess[K, V]) Create

func (a *JsonFileAccess[K, V]) Create(ctx context.Context, key K, value V) error

Create creates a new resource.

func (*JsonFileAccess[K, V]) Delete

func (a *JsonFileAccess[K, V]) Delete(ctx context.Context, key K) error

Delete deletes a resource.

func (*JsonFileAccess[K, V]) Read

func (a *JsonFileAccess[K, V]) Read(ctx context.Context, key K) (*V, error)

Read reads a resource.

func (*JsonFileAccess[K, V]) ReadAll

func (a *JsonFileAccess[K, V]) ReadAll(ctx context.Context) ([]V, error)

ReadAll reads all resources.

func (*JsonFileAccess[K, V]) Update

func (a *JsonFileAccess[K, V]) Update(ctx context.Context, key K, value V) error

Update updates a resource.

type MockAccess

type MockAccess[K, V any] struct {
	// contains filtered or unexported fields
}

MockAccess is a mock implementation of Access[K, V]. Each method has a corresponding mock function pointer (...Ptr). Use the builder-pattern to set the mock function pointers for each method. This allows for more flexible and readable test cases.

func NewMockAccess

func NewMockAccess[K, V any]() *MockAccess[K, V]

NewMockAccess creates a new instance of MockAccess[K, V].

func (*MockAccess[K, V]) Create

func (a *MockAccess[K, V]) Create(ctx context.Context, key K, value V) error

Create creates a new resource with the given key and value.

func (*MockAccess[K, V]) Delete

func (a *MockAccess[K, V]) Delete(ctx context.Context, key K) (err error)

Delete deletes a resource with the given key.

func (*MockAccess[K, V]) Read

func (a *MockAccess[K, V]) Read(ctx context.Context, key K) (value *V, err error)

Read reads a resource with the given key.

func (*MockAccess[K, V]) ReadAll

func (a *MockAccess[K, V]) ReadAll(ctx context.Context) (values []V, err error)

ReadAll reads all resources.

func (*MockAccess[K, V]) Update

func (a *MockAccess[K, V]) Update(ctx context.Context, key K, value V) error

Update updates a resource with the given key and value.

func (*MockAccess[K, V]) WithCreateFn

func (a *MockAccess[K, V]) WithCreateFn(fn func(ctx context.Context, key K, value V) error) *MockAccess[K, V]

WithCreateFn sets the mock function pointer for creating a resource.

func (*MockAccess[K, V]) WithDeleteFn

func (a *MockAccess[K, V]) WithDeleteFn(fn func(ctx context.Context, key K) error) *MockAccess[K, V]

WithDeleteFn sets the mock function pointer for deleting a resource.

func (*MockAccess[K, V]) WithReadAllFn

func (a *MockAccess[K, V]) WithReadAllFn(fn func(ctx context.Context) ([]V, error)) *MockAccess[K, V]

WithReadAllFn sets the mock function pointer for reading all resources.

func (*MockAccess[K, V]) WithReadFn

func (a *MockAccess[K, V]) WithReadFn(fn func(ctx context.Context, key K) (*V, error)) *MockAccess[K, V]

WithReadFn sets the mock function pointer for reading a resource.

func (*MockAccess[K, V]) WithUpdateFn

func (a *MockAccess[K, V]) WithUpdateFn(fn func(ctx context.Context, key K, value V) error) *MockAccess[K, V]

WithUpdateFn sets the mock function pointer for updating a resource.

type SqliteAccess

type SqliteAccess[K comparable, V any] struct {
	// contains filtered or unexported fields
}

SqliteAccess provides a simple key-value store using SQLite.

func NewSqliteAccess

func NewSqliteAccess[K comparable, V any](db *sql.DB) *SqliteAccess[K, V]

NewSqliteAccess creates a new instance of SqliteAccess.

func (*SqliteAccess[K, V]) Create

func (a *SqliteAccess[K, V]) Create(ctx context.Context, key K, value V) (err error)

Create inserts a new key-value pair into the table.

func (*SqliteAccess[K, V]) Delete

func (a *SqliteAccess[K, V]) Delete(ctx context.Context, key K) (err error)

Delete removes the key-value pair associated with the given key.

func (*SqliteAccess[K, V]) Init

func (a *SqliteAccess[K, V]) Init(ctx context.Context) (err error)

Init initializes the table and index.

func (*SqliteAccess[K, V]) Read

func (a *SqliteAccess[K, V]) Read(ctx context.Context, key K) (ptr *V, err error)

Read returns the value associated with the given key.

func (*SqliteAccess[K, V]) ReadAll

func (a *SqliteAccess[K, V]) ReadAll(ctx context.Context) (values []V, err error)

ReadAll returns all values from the table.

func (*SqliteAccess[K, V]) Update

func (a *SqliteAccess[K, V]) Update(ctx context.Context, key K, value V) (err error)

Update updates the value associated with the given key.

type YamlFileAccess

type YamlFileAccess[K comparable, V any] struct {
	// contains filtered or unexported fields
}

YamlFileAccess is a yaml file access.

func NewYamlFileAccess

func NewYamlFileAccess[K comparable, V any](path string) *YamlFileAccess[K, V]

NewYamlFileAccess creates a new yaml file access.

func (*YamlFileAccess[K, V]) Create

func (a *YamlFileAccess[K, V]) Create(ctx context.Context, key K, value V) error

Create creates a new resource.

func (*YamlFileAccess[K, V]) Delete

func (a *YamlFileAccess[K, V]) Delete(ctx context.Context, key K) error

Delete deletes a resource.

func (*YamlFileAccess[K, V]) Read

func (a *YamlFileAccess[K, V]) Read(ctx context.Context, key K) (*V, error)

Read reads a resource.

func (*YamlFileAccess[K, V]) ReadAll

func (a *YamlFileAccess[K, V]) ReadAll(ctx context.Context) ([]V, error)

ReadAll reads all resources.

func (*YamlFileAccess[K, V]) Update

func (a *YamlFileAccess[K, V]) Update(ctx context.Context, key K, value V) error

Update updates a resource.