koyomi

package module
v0.5.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 17, 2022 License: Apache-2.0 Imports: 11 Imported by: 2

README

koyomi -- 日本のこよみ

check vulns lint status GitHub license GitHub release

Migrated repository to github.com/goark/koyomi

「国立天文台 天文情報センター 暦計算室」より日本の暦情報を取得する Go 言語用パッケージです。 Google Calendar を経由して取得しています。

取得可能な情報は以下の通りです。

const (
    Holiday   CalendarID = iota + 1 //国民の祝日および休日
    MoonPhase                       //朔弦望
    SolarTerm                       //二十四節気・雑節
    Eclipse                         //日食・月食・日面経過
    Planet                          //惑星現象
)

簡単な使い方

start, _ := koyomi.DateFrom("2019-05-01")
end := koyomi.NewDate(time.Date(2019, time.May, 31, 0, 0, 0, 0, koyomi.JST))
k, err := koyomi.NewSource(
    koyomi.WithCalendarID(koyomi.Holiday, koyomi.SolarTerm),
    koyomi.WithStartDate(start),
    koyomi.WithEndDate(end),
).Get()
if err != nil {
    return
}

csv, err := k.EncodeCSV()
if err != nil {
    return
}
io.Copy(os.Stdout, bytes.NewReader(csv))
//Output:
//"Date","Title"
//"2019-05-01","休日 (天皇の即位の日)"
//"2019-05-02","休日"
//"2019-05-02","八十八夜"
//"2019-05-03","憲法記念日"
//"2019-05-04","みどりの日"
//"2019-05-05","こどもの日"
//"2019-05-06","休日"
//"2019-05-06","立夏"
//"2019-05-21","小満"

おまけ機能

西暦⇔和暦 変換

元号を含む和暦と西暦との変換を行います。 元号は以下のものに対応しています。

元号 起点
明治（改暦以降） 1873年1月1日
大正 1912年7月30日
昭和 1926年12月25日
平成 1989年1月8日
令和 2019年5月1日
西暦から和暦への変換
//go:build run
// +build run

package main

import (
    "flag"
    "fmt"
    "os"
    "strconv"
    "time"

    "github.com/goark/koyomi"
)

func main() {
    flag.Parse()
    argsStr := flag.Args()
    tm := time.Now()
    if len(argsStr) > 0 {
        if len(argsStr) < 3 {
            fmt.Fprintln(os.Stderr, "年月日を指定してください")
            return
        }
        args := make([]int, 3)
        for i := 0; i < 3; i++ {
            num, err := strconv.Atoi(argsStr[i])
            if err != nil {
                fmt.Fprintln(os.Stderr, err)
                return
            }
            args[i] = num
        }
        tm = time.Date(args[0], time.Month(args[1]), args[2], 0, 0, 0, 0, time.Local)
    }
    te := koyomi.NewDate(tm)
    n, y := te.YearEraString()
    if len(n) == 0 {
        fmt.Fprintln(os.Stderr, "正しい年月日を指定してください")
        return
    }
    fmt.Printf("%s%s%d月%d日\n", n, y, te.Month(), te.Day())
}

これを実行すると以下のような結果になります。

$ go run sample/sample1.go 2019 4 30
平成31年4月30日

$ go run sample/sample1.go 2019 5 1
令和元年5月1日
和暦から西暦への変換
//go:build run
// +build run

package main

import (
    "flag"
    "fmt"
    "os"
    "strconv"
    "time"

    "github.com/goark/koyomi"
)

func main() {
    flag.Parse()
    argsStr := flag.Args()

    if len(argsStr) < 4 {
        fmt.Fprintln(os.Stderr, "元号 年 月 日 を指定してください")
        return
    }
    name := argsStr[0]
    args := make([]int, 3)
    for i := 0; i < 3; i++ {
        num, err := strconv.Atoi(argsStr[i+1])
        if err != nil {
            fmt.Fprintln(os.Stderr, err)
            return
        }
        args[i] = num
    }
    te := koyomi.NewDateEra(koyomi.EraName(name), args[0], time.Month(args[1]), args[2], 0, 0, 0, 0, time.Local)
    fmt.Println(te.Format("西暦2006年1月2日"))
}

これを実行すると以下のような結果になります。

$ go run sample/sample2.go 平成 31 4 30
西暦2019年4月30日

$ go run sample/sample2.go 令和 1 5 1
西暦2019年5月1日
十干十二支を数え上げる
//go:build run
// +build run

package main

import (
    "flag"
    "fmt"
    "os"

    "github.com/goark/koyomi"
    "github.com/goark/koyomi/zodiac"
)

func main() {
    flag.Parse()
    args := flag.Args()
    if len(args) < 1 {
        fmt.Fprintln(os.Stderr, os.ErrInvalid)
        return
    }
    for _, s := range args {
        t, err := koyomi.DateFrom(s)
        if err != nil {
            fmt.Fprintln(os.Stderr, err)
            continue
        }
        kan, shi := zodiac.ZodiacYearNumber(t.Year())
        fmt.Printf("Year %v is %v%v\n", t.Year(), kan, shi)
        kan, shi = zodiac.ZodiacDayNumber(t)
        fmt.Printf("Day %v is %v%v\n", t.Format("2006-01-02"), kan, shi)
    }
}

これを実行すると以下のような結果になります。

$ go run sample/sample3.go 2021-07-28
Year 2021 is 辛丑
Day 2021-07-28 is 丁丑

Modules Requirement Graph

dependency.png

Documentation

Index

Examples

Constants

View Source 
const (
	EraUnknown eraName = iota //不明な元号
	Meiji                     //明治
	Taisho                    //大正
	Showa                     //昭和
	Heisei                    //平成
	Reiwa                     //令和
)

Variables

View Source 
var (
	ErrNullPointer   = errors.New("Null reference instance")
	ErrNoData        = errors.New("No data")
	ErrInvalidRecord = errors.New("Invalid record")
)
View Source 
var (
	JST = time.FixedZone("JST", int(jstoffset)) // Japan standard Time
)

Functions

func EraName added in v0.4.0 

func EraName(s string) eraName

koyomi.EraName() 関数は元号の文字列から元号名 eraName を取得します。 該当する元号名がない場合は era.Unknown を返します。

func WithCalendarID 

func WithCalendarID(cid ...CalendarID) optFunc

WithCalendarID returns function for setting Reader

func WithEndDate 

func WithEndDate(end DateJp) optFunc

WithEndDate returns function for setting Reader

func WithStartDate 

func WithStartDate(start DateJp) optFunc

WithStartDate returns function for setting Reader

func WithTempDir 

func WithTempDir(dir string) optFunc

WithTempDir returns function for setting Reader

Types

type CalendarID 

type CalendarID int
const (
	Holiday   CalendarID = iota + 1 //国民の祝日および休日
	MoonPhase                       //朔弦望
	SolarTerm                       //二十四節気・雑節
	Eclipse                         //日食・月食・日面経過
	Planet                          //惑星現象
)

func (CalendarID) String 

func (cid CalendarID) String() string

String is Stringer of CalendarID

func (CalendarID) URL 

func (cid CalendarID) URL() string

URL returns URL string from CalendarID

type DateJp 

type DateJp struct {
	time.Time
}

DateJp is wrapper class of time.Time

func DateFrom 

func DateFrom(s string) (DateJp, error)

DateFrom returns DateJp instance from date string

func NewDate 

func NewDate(tm time.Time) DateJp

NewDate returns DateJp instance

func NewDateEra added in v0.4.0 

func NewDateEra(en eraName, year int, month time.Month, day int) DateJp

koyomi.NewDateEra() 関数は 元号・年・月・日・時・分・秒・タイムゾーン を指定して koyomi.DateJp 型のインスタンスを返します。 起点が定義されない元号を指定した場合は西暦として処理します。

func (DateJp) AddDate added in v0.5.0 

func (t DateJp) AddDate(years int, months int, days int) DateJp

AddDate method adds years/months/days and returns new Date instance.

func (DateJp) AddDay added in v0.5.0 

func (t DateJp) AddDay(days int) DateJp

AddDay method adds n days and returns new Date instance.

func (DateJp) After 

func (t DateJp) After(dt DateJp) bool

After reports whether the DateJp instant t is after dt.

func (DateJp) Before 

func (t DateJp) Before(dt DateJp) bool

Before reports whether the DateJp instant t is before dt.

func (DateJp) Equal 

func (t DateJp) Equal(dt DateJp) bool

Equal reports whether t and dt represent the same time instant.

func (DateJp) Era added in v0.4.0 

func (t DateJp) Era() eraName

koyomi.DateJp.Era() メソッドは元号名 koyomi.eraName のインスタンスを返します。 元号が不明の場合は era.Unknown を返します。

func (*DateJp) MarshalJSON 

func (t *DateJp) MarshalJSON() ([]byte, error)

MarshalJSON returns time string with RFC3339 format

func (DateJp) String 

func (t DateJp) String() string

func (*DateJp) UnmarshalJSON 

func (t *DateJp) UnmarshalJSON(b []byte) error

UnmarshalJSON returns result of Unmarshal for json.Unmarshal()

func (DateJp) YearEra added in v0.4.0 

func (t DateJp) YearEra() (eraName, int)

koyomi.DateJp.YearEra() メソッドは元号付きの年の値を返します。 元号が不明の場合は (era.Unknown, 0) を返します。

func (DateJp) YearEraString added in v0.4.0 

func (t DateJp) YearEraString() (string, string)

koyomi.DateJp.YearEraString() メソッドは元号付きの年の値を文字列で返します。 元号が不明の場合は空文字列を返します。

type Event 

type Event struct {
	Date  DateJp
	Title string
}

Event is koyomi event data

type Koyomi 

type Koyomi struct {
	// contains filtered or unexported fields
}

Koyomi is array of Event

Example 
package main

import (
	"bytes"
	"fmt"
	"io"
	"os"
	"time"

	"github.com/goark/koyomi"
)

func main() {
	start, _ := koyomi.DateFrom("2019-05-01")
	end := koyomi.NewDate(time.Date(2019, time.May, 31, 0, 0, 0, 0, koyomi.JST))
	k, err := koyomi.NewSource(
		koyomi.WithCalendarID(koyomi.Holiday, koyomi.SolarTerm),
		koyomi.WithStartDate(start),
		koyomi.WithEndDate(end),
	).Get()
	if err != nil {
		return
	}

	csv, err := k.EncodeCSV()
	if err != nil {
		return
	}
	if _, err := io.Copy(os.Stdout, bytes.NewReader(csv)); err != nil {
		fmt.Fprintln(os.Stderr, err)
		return
	}
}

Output:
"Date","Title"
"2019-05-01","休日 (天皇の即位の日)"
"2019-05-02","休日"
"2019-05-02","八十八夜"
"2019-05-03","憲法記念日"
"2019-05-04","みどりの日"
"2019-05-05","こどもの日"
"2019-05-06","休日"
"2019-05-06","立夏"
"2019-05-21","小満"

func (*Koyomi) Add 

func (k *Koyomi) Add(kk *Koyomi)

Add adds other Kyomoi instance

func (*Koyomi) EncodeCSV 

func (k *Koyomi) EncodeCSV() ([]byte, error)

func (*Koyomi) EncodeJSON 

func (k *Koyomi) EncodeJSON() ([]byte, error)

func (*Koyomi) Events 

func (k *Koyomi) Events() []Event

Events returns event array

func (*Koyomi) SortByDate 

func (k *Koyomi) SortByDate()

SortByDate sorts event data by date

type Source 

type Source struct {
	// contains filtered or unexported fields
}

Source is information of data source for koyomi

func NewSource 

func NewSource(opts ...optFunc) *Source

NewSource creates a new Source instance

func (*Source) Get 

func (s *Source) Get() (*Koyomi, error)

Get returns koyomi data from calendar dources

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.