generator

Documentation

Overview

Package generator is a package for generating jrp.

Index

• type Generatable
• type GenerateMode
• type GenerateResult
• type Generator
  • func New(osProxy osproxy.Os, randProxy randproxy.Rand, sqlProxy sqlproxy.Sql, ...) *Generator
  • func (g *Generator) GenerateJrp(wnJpnDBFilePath string, num int, word string, mode GenerateMode) (GenerateResult, []*jrp.Jrp, error)

Types

type Generatable

type Generatable interface {
	GenerateJrp(wnJpnDBFilePath string, num int, word string, mode GenerateMode) (GenerateResult, []*jrp.Jrp, error)
}

Generatable is an interface for Generator.

type GenerateMode

type GenerateMode int

GenerateMode is a type for generate mode.

const (
	// WithNoPrefixOrSuffix is a mode for generate without prefix or suffix.
	WithNoPrefixOrSuffix GenerateMode = iota
	// WithPrefix is a mode for generate with prefix.
	WithPrefix
	// WithSuffix is a mode for generate with suffix.
	WithSuffix
)

type GenerateResult

type GenerateResult int

GenerateResult is a type for generate result.

const (
	// GeneratedSuccessfully is a result for generated successfully.
	GeneratedSuccessfully GenerateResult = iota
	// GeneratedFailed is a result for generated failed.
	GeneratedFailed
	// DBFileNotFound is a result for generated failed because db file is not found.
	DBFileNotFound
)

type Generator

type Generator struct {
	OsProxy         osproxy.Os
	RandProxy       randproxy.Rand
	SqlProxy        sqlproxy.Sql
	TimeProxy       timeproxy.Time
	WNJpnRepository repository.WNJpnRepositoryInterface
}

Generatoor is a struct that implements Generatable interface.

func New

func New(
	osProxy osproxy.Os,
	randProxy randproxy.Rand,
	sqlProxy sqlproxy.Sql,
	timeProxy timeproxy.Time,
	wnJpnRepository repository.WNJpnRepositoryInterface,
) *Generator

New is a constructor of Generator.

func (*Generator) GenerateJrp

func (g *Generator) GenerateJrp(wnJpnDBFilePath string, num int, word string, mode GenerateMode) (GenerateResult, []*jrp.Jrp, error)

GenerateJrp generates jrps.