README
¶
go-gimei
This project is a golang port of Ruby's gimei. Import as library or use as CLI.
go-gimei generates fake data that people's name and address in Japanese and supports furigana phonetic renderings of kanji.
The project name comes from Japanese '偽名' means a false name.
Usage
package main
import (
"fmt"
"github.com/mattn/go-gimei"
)
func main() {
name := gimei.NewName()
fmt.Println(name) // 斎藤 陽菜
fmt.Println(name.Kanji()) // 斎藤 陽菜
fmt.Println(name.Hiragana()) // さいとう はるな
fmt.Println(name.Katakana()) // サイトウ ハルナ
fmt.Println(name.Romaji()) // Haruna Saito
fmt.Println(name.Last.Kanji()) // 斎藤
fmt.Println(name.Last.Hiragana()) // さいとう
fmt.Println(name.Last.Katakana()) // サイトウ
fmt.Println(name.Last.Romaji()) // Saito
fmt.Println(name.First.Kanji()) // 陽菜
fmt.Println(name.First.Hiragana()) // はるな
fmt.Println(name.First.Katakana()) // ハルナ
fmt.Println(name.First.Romaji()) // Haruna
fmt.Println(name.Sex) // 女
fmt.Println(name.IsMale()) // false
male := gimei.NewMale()
fmt.Println(male) // 小林 顕士
fmt.Println(male.IsMale()) // true
fmt.Println(male.IsFemale()) // false
address := gimei.NewAddress()
fmt.Println(address) // 岡山県大島郡大和村稲木町
fmt.Println(address.Kanji()) // 岡山県大島郡大和村稲木町
fmt.Println(address.Hiragana()) // おかやまけんおおしまぐんやまとそんいなぎちょう
fmt.Println(address.Katakana()) // オカヤマケンオオシマグンヤマトソンイナギチョウ
fmt.Println(address.Prefecture) // 岡山県
fmt.Println(address.Prefecture.Kanji()) // 岡山県
fmt.Println(address.Prefecture.Hiragana()) // おかやまけん
fmt.Println(address.Prefecture.Katakana()) // オカヤマケン
fmt.Println(address.City) // 大島郡大和村
fmt.Println(address.City.Kanji()) // 大島郡大和村
fmt.Println(address.City.Hiragana()) // おおしまぐんやまとそん
fmt.Println(address.City.Katakana()) // オオシマグンヤマトソン
fmt.Println(address.Town) // 稲木町
fmt.Println(address.Town.Kanji()) // 稲木町
fmt.Println(address.Town.Hiragana()) // いなぎちょう
fmt.Println(address.Town.Katakana()) // イナギチョウ
prefecture := gimei.NewPrefecture()
fmt.Println(prefecture) // 青森県
}
Deterministic Random
go-gimei supports seeding of its pseudo-random number generator to provide deterministic output of repeated method calls.
import "math/rand"
gimei.SetRandom(rand.New(rand.NewSource(42)))
fmt.Println(gimei.NewName()) // 前川 永麻
fmt.Println(gimei.NewAddress()) // 佐賀県斜里郡斜里町浄法寺町樋口
gimei.SetRandom(rand.New(rand.NewSource(42)))
fmt.Println(gimei.NewName()) // 前川 永麻
fmt.Println(gimei.NewAddress()) // 佐賀県斜里郡斜里町浄法寺町樋口
CLI Usage
$ gimei [OPTIONS] [ARGS]
Omitting ARGS is equivalent to specifying name:kanji.
OPTIONS
-sep string
specify string used to separate fields(default: ", ").
-n number
display number record(s).
-count
display records read from embedded yaml files and exit.
-h, -help
display usage and exit.
ARGS
Argument for a personal name:
name|male|female[:NAME_DISPLAY_OPTION]
NAME_DISPLAY_OPTION list
to display full name:
'kanji', (is equivalent to omitting NAME_DISPLAY_OPTION)
'hiragana',
'katakana',
'romaji'
to display last name:
'last-kanji',
'last-hiragana',
'last-katakana',
'last-romaji'
to display first name:
'first-kanji',
'first-hiragana',
'first-katakana',
'first-romaji'
to display which it is male/female:
'is-male',
'is-female'
Argument for an address:
address[:ADDRESS_DISPLAY_OPTION]
ADDRESS_DISPLAY_OPTION list
to display address:
'kanji', (is eqivalent ot omitting ADDRESS_DISPLAY_OPTION)
'hiragana',
'katakana'
to display prefecture:
'prefecture-kanji',
'prefecture-hiragana',
'prefecture-katakana'
to display city:
'city-kanji',
'city-hiragana',
'city-katakana'
to display town:
'town-kanji',
'town-hiragana',
'town-katakana'
EXAMPLES
$ gimei
古賀 正浩
$ gimei name:kanji name:katakana
中村 紳一, ナカムラ シンイチ
$ gimei -sep '/' address:prefecture-kanji address:town-kanji
滋賀県/田所町
$ gimei -n 3 name name:hiragana
白川 彰花, しらかわ あきか
関根 勇一, せきね ゆういち
大場 星良, おおば きらら
Requirements
golang
Installation
Install the library.
$ go get github.com/mattn/go-gimei
CLI installation
On Go version 1.16 or later, this command works:
$ go install github.com/mattn/go-gimei/cmd/gimei@latest
Running Tests
To run all the tests, do:
$ go test
License
MIT
Dictionary YAML file is generated from naist-jdic.
Author
Yasuhiro Matsumoto (a.k.a mattn)
Documentation
¶
Index ¶
- func CountData() string
- func SetRandom(rnd *rand.Rand)
- type Address
- type Item
- type Name
- func FindNameByHiragana(hiragana string) *Name
- func FindNameByKanji(kanji string) *Name
- func FindNameByKatakana(katakana string) *Name
- func FindNameByRomaji(romaji string) *Name
- func NewCat() *Name
- func NewDog() *Name
- func NewFemale() *Name
- func NewFemaleCat() *Name
- func NewFemaleDog() *Name
- func NewMale() *Name
- func NewMaleCat() *Name
- func NewMaleDog() *Name
- func NewName() *Name
- type Sex
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Address ¶
Address store address that is pointed by prefecture/city/town.
Example ¶
address := gimei.FindAddressByKanji("岡山県大島郡大和村稲木町")
fmt.Println(address)
fmt.Println(address.Kanji())
fmt.Println(address.Hiragana())
fmt.Println(address.Katakana())
fmt.Println(address.Prefecture.Kanji())
fmt.Println(address.Prefecture.Hiragana())
fmt.Println(address.Prefecture.Katakana())
fmt.Println(address.City.Kanji())
fmt.Println(address.City.Hiragana())
fmt.Println(address.City.Katakana())
fmt.Println(address.Town.Kanji())
fmt.Println(address.Town.Hiragana())
fmt.Println(address.Town.Katakana())
Output: 岡山県大島郡大和村稲木町 岡山県大島郡大和村稲木町 おかやまけんおおしまぐんやまとそんいなぎちょう オカヤマケンオオシマグンヤマトソンイナギチョウ 岡山県 おかやまけん オカヤマケン 大島郡大和村 おおしまぐんやまとそん オオシマグンヤマトソン 稲木町 いなぎちょう イナギチョウ
func FindAddressByHiragana ¶
FindAddressByHiragana find Address by hiragana.
func FindAddressByKanji ¶
FindAddressByKanji find Address by kanji.
func FindAddressByKatakana ¶
FindAddressByKatakana find Address by katakana.
type Item ¶
type Item []string
Item take four figure for japanese. Kanji/Hiragana/Katakana/Romaji. It's not only the difference of sounds, it just letters.
type Name ¶
Name store name and sex for a person.
Example ¶
name := gimei.FindNameByKanji("小林 顕士")
fmt.Println(name)
fmt.Println(name.Kanji())
fmt.Println(name.Hiragana())
fmt.Println(name.Katakana())
fmt.Println(name.Romaji())
fmt.Println(name.Last.Kanji())
fmt.Println(name.Last.Hiragana())
fmt.Println(name.Last.Katakana())
fmt.Println(name.Last.Romaji())
fmt.Println(name.First.Kanji())
fmt.Println(name.First.Hiragana())
fmt.Println(name.First.Katakana())
fmt.Println(name.First.Romaji())
fmt.Println(name.Sex)
Output: 小林 顕士 小林 顕士 こばやし けんじ コバヤシ ケンジ Kenji Kobayashi 小林 こばやし コバヤシ Kobayashi 顕士 けんじ ケンジ Kenji 男
func FindNameByHiragana ¶
FindNameByHiragana find Name by hiragana.
func FindNameByKatakana ¶
FindNameByKatakana find Name by katakana.
func FindNameByRomaji ¶
FindNameByRomaji find Name by romaji.
func NewCat ¶
func NewCat() *Name
NewCat return new instance of person whose last name begins "neko".
func NewDog ¶
func NewDog() *Name
NewDog return new instance of person whose last name begins "inu".
func NewFemaleCat ¶
func NewFemaleCat() *Name
NewFemaleCat return new instance of female person whose last name begins "neko".
func NewFemaleDog ¶
func NewFemaleDog() *Name
NewFemaleDog return new instance of female person whose last name begins "inu".
func NewMaleCat ¶
func NewMaleCat() *Name
NewMaleCat return new instance of male person whose last name begins "neko".
func NewMaleDog ¶
func NewMaleDog() *Name
NewMaleDog return new instance of male person whose last name begins "inu".
Source Files
Directories