diff --git a/CHANGELOG.md b/CHANGELOG.md index 90a3f53..30e3b58 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,22 +1,5 @@ # Changelog -## [0.0.6] - 2024-10-07 - -- Update external dependency: go-dateparser - -## [0.0.5] - 2024-10-07 - -- Small change: adds --output_json to drop command. - -## [0.0.4] - 2024-05-08 - -- ✨ Add -p flag to config to print config path - -## [0.0.3] - 2024-03-11 - -- ✨ Add JSON formatter -- 💥 Breaking change: renamed output.stdout.config value formatter to format - ## [0.0.2] - 2024-03-09 - ✨ Use plain formatter to output entry from drop diff --git a/Makefile b/Makefile index a3d8581..35491dc 100644 --- a/Makefile +++ b/Makefile @@ -3,12 +3,6 @@ OUT=my-log GOBIN=$(shell go env GOBIN) COVEROUT=cover.out COVERHTML=cover.html -OPEN=xdg-open -OS=$(shell uname -s) - -ifeq ($(OS),Darwin) -OPEN=open -endif .PHONY: help help: ## Show help for documented recipes @@ -29,8 +23,7 @@ test: ## Test application and generate coverage report $(MAKE) clean $(MAKE) $(COVEROUT) -$(COVEROUT): $(SOURCES) - $(MAKE) fmt +$(COVEROUT): $(SOURCES) fmt go test ./... -race -cover -coverprofile $@ $(COVERHTML): $(COVEROUT) @@ -40,8 +33,8 @@ $(COVERHTML): $(COVEROUT) report: $(COVERHTML) ## Generate a coverage report .PHONY: open-report -open-report: $(COVERHTML) ## Open the coverage report in the default browser - $(OPEN) $< +open-report: report ## Open the coverage report in the default browser + xdg-open $(COVERHTML) .PHONY: build build: $(OUT) ## Builds the application diff --git a/README.md b/README.md index 8b4aa0c..24eae91 100644 --- a/README.md +++ b/README.md @@ -123,7 +123,7 @@ Each separate output has its own set of configuration. So, replace `which-one` w *This section may change in the near future. We're considering supporting multiple formats.* -- `format`: Which formatter to use when outputting data. This value is also used by `my-log drop` to output the new entry. +- `formatter`: Which formatter to use when outputting data. This value is used by `my-log drop` to output the new entry. ### `[formatters]` @@ -144,7 +144,7 @@ Some formatters may have custom configuration. + [ ] filter to specific logs + [ ] stdout - [x] plain text - - [x] JSON + - [ ] JSON - [ ] YAML - [ ] Other formats? Submit an issue! + [ ] file output diff --git a/cmd/config.go b/cmd/config.go index 1407796..dc28dd7 100644 --- a/cmd/config.go +++ b/cmd/config.go @@ -32,11 +32,6 @@ var configCmd = &cobra.Command{ //Long: ``, SilenceUsage: true, RunE: func(cmd *cobra.Command, args []string) (err error) { - print, _ := cmd.Flags().GetBool("print") - if print { - fmt.Fprintln(cmd.OutOrStdout(), config.ConfigPath) - return nil - } force, _ := cmd.Flags().GetBool("force") if !force { _, err = os.Stat(config.ConfigPath) @@ -65,5 +60,4 @@ func init() { rootCmd.AddCommand(configCmd) configCmd.Flags().BoolP("force", "f", false, "Force overwrite") - configCmd.Flags().BoolP("print", "p", false, "Print path only") } diff --git a/cmd/drop.go b/cmd/drop.go index 2c246e6..658cb7c 100644 --- a/cmd/drop.go +++ b/cmd/drop.go @@ -21,7 +21,6 @@ import ( "fmt" "time" - "codeberg.org/danjones000/my-log/config" "codeberg.org/danjones000/my-log/files" "codeberg.org/danjones000/my-log/formatters" "codeberg.org/danjones000/my-log/models" @@ -32,7 +31,6 @@ import ( var d Date var fields map[string]string var j Json -var outJson bool // dropCmd represents the drop command var dropCmd = &cobra.Command{ @@ -42,23 +40,20 @@ var dropCmd = &cobra.Command{ Args: cobra.ExactArgs(2), SilenceUsage: true, RunE: func(cmd *cobra.Command, args []string) error { - if outJson { - config.Overrides["output.stdout.config.format"] = "json" - } - log := args[0] title := args[1] - ms := &models.Metas{} + e := models.PartialEntry() if len(j.RawMessage) > 8 { - err := json.Unmarshal([]byte(j.RawMessage), ms) + err := json.Unmarshal([]byte(j.RawMessage), &e) if err != nil { return err } } for k, v := range fields { - ms.AppendTo(k, tools.ParseString(v)) + e.Fields = append(e.Fields, models.Meta{k, tools.ParseString(v)}) } - e := models.Entry{title, d.t, *ms} + e.Title = title + e.Date = d.t l := models.Log{log, []models.Entry{e}} err := files.Append(l) if err != nil { @@ -73,10 +68,7 @@ var dropCmd = &cobra.Command{ if err != nil { return err } - if len(out) > 0 && out[len(out)-1] != 10 { - out = append(out, 10) - } - fmt.Fprintf(cmd.OutOrStdout(), "%s", out) + fmt.Fprintf(cmd.OutOrStdout(), "%s\n", out) return nil }, @@ -89,7 +81,6 @@ func init() { dropCmd.Flags().VarP(&d, "date", "d", "Date for log entry") dropCmd.Flags().StringToStringVarP(&fields, "fields", "f", nil, "Fields you add to entry") dropCmd.Flags().VarP(&j, "json", "j", "Entire entry as json") - dropCmd.Flags().BoolVarP(&outJson, "output_json", "o", false, "Output result as JSON") } type Json struct { diff --git a/cmd/root.go b/cmd/root.go index 44de5f0..7e7bbbd 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -50,7 +50,7 @@ func init() { // will be global for your application. rootCmd.PersistentFlags().StringVarP(&config.ConfigPath, "config", "c", config.ConfigPath, "config file") - rootCmd.PersistentFlags().StringToStringVarP(&config.Overrides, "config-value", "v", config.Overrides, "Override config values. Use dot syntax to specify key. E.g. -v output.stdout.config.format=json") + rootCmd.PersistentFlags().StringToStringVarP(&config.Overrides, "config-value", "v", config.Overrides, "Override config values. Use dot syntax to specify key. E.g. -v output.stdout.config.formatter=json") // Cobra also supports local flags, which will only run // when this action is called directly. diff --git a/config/default.go b/config/default.go index 8f93873..76ef8d2 100644 --- a/config/default.go +++ b/config/default.go @@ -28,7 +28,7 @@ dotFolder = true enabled = true [output.stdout.config] # Formatter to use when outputting to stdout -format = "plain" +formatter = "plain" [formatters] diff --git a/config/load_test.go b/config/load_test.go index eab7c94..51e024e 100644 --- a/config/load_test.go +++ b/config/load_test.go @@ -70,14 +70,14 @@ func TestStdoutMissing(t *testing.T) { } func TestStdoutLoad(t *testing.T) { - os.Setenv("LOG_STDOUT_FORMAT", "json") - defer os.Unsetenv("LOG_STDOUT_FORMAT") + os.Setenv("LOG_STDOUT_FORMATTER", "json") + defer os.Unsetenv("LOG_STDOUT_FORMATTER") os.Setenv("LOG_STDOUT_ENABLED", "true") defer os.Unsetenv("LOG_STDOUT_ENABLED") c, _ := Load() std, en := c.Outputs.Stdout() assert.True(t, en) - assert.Equal(t, "json", std.Format) + assert.Equal(t, "json", std.Formatter) } func TestFormatJson(t *testing.T) { diff --git a/config/types.go b/config/types.go index 58fb2c4..a950a80 100644 --- a/config/types.go +++ b/config/types.go @@ -21,7 +21,7 @@ type Output struct { } type Stdout struct { - Format string `env:"LOG_STDOUT_FORMAT" mapstructure:"format"` + Formatter string `env:"LOG_STDOUT_FORMATTER" mapstructure:"formatter"` } type stdoutEnabled struct { diff --git a/files/append_test.go b/files/append_test.go index 03f0253..0976363 100644 --- a/files/append_test.go +++ b/files/append_test.go @@ -211,7 +211,7 @@ func (s *AppendTestSuite) TestConfLoadErr() { func (s *AppendTestSuite) TestMkdirErr() { // Don't run this test as root - config.Overrides["input.path"] = "/var/my-logs-test" + config.Overrides["input.path"] = "/root/my-logs-test" defer func(path string) { config.Overrides["input.path"] = path }(s.dir) diff --git a/formatters/interface.go b/formatters/interface.go index 5478572..4276aed 100644 --- a/formatters/interface.go +++ b/formatters/interface.go @@ -4,7 +4,6 @@ import "codeberg.org/danjones000/my-log/models" type Formatter interface { Name() string - Logs([]models.Log) (out []byte, err error) Log(models.Log) (out []byte, err error) Entry(models.Entry) (out []byte, err error) Meta(models.Meta) (out []byte, err error) diff --git a/formatters/json.go b/formatters/json.go deleted file mode 100644 index d56854d..0000000 --- a/formatters/json.go +++ /dev/null @@ -1,77 +0,0 @@ -package formatters - -import ( - "bytes" - "encoding/json" - "time" - - "codeberg.org/danjones000/my-log/config" - "codeberg.org/danjones000/my-log/models" -) - -func newJson(ff config.Formatters) (Formatter, error) { - return &Json{ff.Json().PrettyPrint}, nil -} - -type Json struct { - prettPrint bool -} - -func (js *Json) Name() string { - return "json" -} - -func (js *Json) marshal(v any) (o []byte, err error) { - o, err = json.Marshal(v) - if err != nil { - return - } - if js.prettPrint { - buff := &bytes.Buffer{} - err = json.Indent(buff, o, "", "\t") - if err == nil { - o = buff.Bytes() - } - } - return -} - -func (js *Json) Meta(m models.Meta) ([]byte, error) { - o := map[string]any{m.Key: m.Value} - return js.marshal(o) -} - -func (js *Json) entryMap(e models.Entry) map[string]any { - o := map[string]any{ - "title": e.Title, - "date": e.Date.Format(time.RFC3339), - } - for _, m := range e.Fields { - o[m.Key] = m.Value - } - return o -} - -func (js *Json) Entry(e models.Entry) ([]byte, error) { - return js.marshal(js.entryMap(e)) -} - -func (js *Json) Log(l models.Log) ([]byte, error) { - return js.Logs([]models.Log{l}) -} - -func (js *Json) Logs(logs []models.Log) (out []byte, err error) { - if len(logs) == 0 { - return - } - - o := map[string][]map[string]any{} - for _, l := range logs { - es := []map[string]any{} - for _, e := range l.Entries { - es = append(es, js.entryMap(e)) - } - o[l.Name] = es - } - return js.marshal(o) -} diff --git a/formatters/json_test.go b/formatters/json_test.go deleted file mode 100644 index da6f111..0000000 --- a/formatters/json_test.go +++ /dev/null @@ -1,81 +0,0 @@ -package formatters - -import ( - "fmt" - "testing" - "time" - - "codeberg.org/danjones000/my-log/models" - "github.com/stretchr/testify/assert" -) - -func TestJsonName(t *testing.T) { - f, _ := New("json") - assert.Equal(t, "json", f.Name()) -} - -func TestJsonMeta(t *testing.T) { - f, _ := New("json") - m := models.Meta{"foo", 42} - exp := `{"foo":42}` - o, err := f.Meta(m) - assert.NoError(t, err) - assert.JSONEq(t, exp, string(o)) -} - -func TestJsonEntry(t *testing.T) { - when := time.Now() - f, _ := New("json") - m := models.Meta{"foo", 42} - e := models.Entry{ - Title: "Homer", - Date: when, - Fields: []models.Meta{m}, - } - exp := fmt.Sprintf(`{"title":"%s","date":"%s","foo":42}`, e.Title, when.Format(time.RFC3339)) - o, err := f.Entry(e) - assert.NoError(t, err) - assert.JSONEq(t, exp, string(o)) -} - -func TestJsonLog(t *testing.T) { - when := time.Now() - f, _ := New("json") - m := models.Meta{"foo", 42} - e := models.Entry{ - Title: "Homer", - Date: when, - Fields: []models.Meta{m}, - } - l := models.Log{"stuff", []models.Entry{e}} - exp := fmt.Sprintf(`{"%s":[{"title":"%s","date":"%s","foo":42}]}`, l.Name, e.Title, when.Format(time.RFC3339)) - o, err := f.Log(l) - assert.NoError(t, err) - assert.JSONEq(t, exp, string(o)) -} - -func TestJsonNoLogs(t *testing.T) { - f, _ := New("json") - o, err := f.Logs([]models.Log{}) - var exp []byte - assert.NoError(t, err) - assert.Equal(t, exp, o) -} - -func TestJsonErr(t *testing.T) { - f, _ := New("json") - o, err := f.Meta(models.Meta{"foo", make(chan bool)}) - var exp []byte - assert.Error(t, err) - assert.Equal(t, exp, o) -} - -func TestJsonPretty(t *testing.T) { - f := Json{true} - o, err := f.Meta(models.Meta{"foo", 42}) - exp := `{ - "foo": 42 -}` - assert.NoError(t, err) - assert.Equal(t, exp, string(o)) -} diff --git a/formatters/new.go b/formatters/new.go index bade49b..d88a9d0 100644 --- a/formatters/new.go +++ b/formatters/new.go @@ -10,8 +10,6 @@ type formatMaker func(config.Formatters) (Formatter, error) var formatterMap = map[string]formatMaker{ "plain": newPlain, - "json": newJson, - "zero": newNull, } func Preferred() (f Formatter, err error) { @@ -20,7 +18,8 @@ func Preferred() (f Formatter, err error) { return } std, _ := conf.Outputs.Stdout() - return New(std.Format) + kind := std.Formatter + return New(kind) } func New(kind string) (f Formatter, err error) { diff --git a/formatters/new_test.go b/formatters/new_test.go index ed56be3..04b40fb 100644 --- a/formatters/new_test.go +++ b/formatters/new_test.go @@ -10,7 +10,7 @@ import ( ) func TestKinds(t *testing.T) { - assert.ElementsMatch(t, []string{"plain", "json", "zero"}, Kinds()) + assert.Equal(t, []string{"plain"}, Kinds()) } func TestNewUnsupported(t *testing.T) { diff --git a/formatters/null.go b/formatters/null.go deleted file mode 100644 index 4dd1775..0000000 --- a/formatters/null.go +++ /dev/null @@ -1,32 +0,0 @@ -package formatters - -import ( - "codeberg.org/danjones000/my-log/config" - "codeberg.org/danjones000/my-log/models" -) - -func newNull(ff config.Formatters) (Formatter, error) { - return &Null{}, nil -} - -type Null struct{} - -func (n *Null) Name() string { - return "zero" -} - -func (n *Null) Meta(m models.Meta) (o []byte, err error) { - return -} - -func (n *Null) Entry(e models.Entry) (o []byte, err error) { - return -} - -func (n *Null) Log(l models.Log) (o []byte, err error) { - return -} - -func (n *Null) Logs(logs []models.Log) (out []byte, err error) { - return -} diff --git a/formatters/null_test.go b/formatters/null_test.go deleted file mode 100644 index f7c26c1..0000000 --- a/formatters/null_test.go +++ /dev/null @@ -1,45 +0,0 @@ -package formatters - -import ( - "testing" - "time" - - "codeberg.org/danjones000/my-log/models" - "github.com/stretchr/testify/assert" -) - -var empty []byte - -func TestNullName(t *testing.T) { - f, err := New("zero") - assert.NoError(t, err) - assert.Equal(t, "zero", f.Name()) -} - -func TestNullMeta(t *testing.T) { - f, _ := New("zero") - o, err := f.Meta(models.Meta{"foo", 42}) - assert.NoError(t, err) - assert.Equal(t, empty, o) -} - -func TestNullEntry(t *testing.T) { - f, _ := New("zero") - o, err := f.Entry(models.Entry{"title", time.Now(), models.Metas{}}) - assert.NoError(t, err) - assert.Equal(t, empty, o) -} - -func TestNullLog(t *testing.T) { - f, _ := New("zero") - o, err := f.Log(models.Log{"jim", []models.Entry{{"title", time.Now(), models.Metas{}}}}) - assert.NoError(t, err) - assert.Equal(t, empty, o) -} - -func TestNullLogs(t *testing.T) { - f, _ := New("zero") - o, err := f.Logs([]models.Log{{"jim", []models.Entry{{"title", time.Now(), models.Metas{}}}}}) - assert.NoError(t, err) - assert.Equal(t, empty, o) -} diff --git a/formatters/plain.go b/formatters/plain.go index 2b79f00..ed8ee82 100644 --- a/formatters/plain.go +++ b/formatters/plain.go @@ -20,26 +20,6 @@ func (pt *PlainText) Name() string { return "plain" } -func (pt *PlainText) Logs(logs []models.Log) (out []byte, err error) { - if len(logs) == 0 { - return - } - - buff := &bytes.Buffer{} - first := true - for _, log := range logs { - o, _ := pt.Log(log) - if !first { - buff.WriteByte(10) - buff.WriteByte(10) - } - first = false - buff.Write(o) - } - out = buff.Bytes() - return -} - func (pt *PlainText) Log(log models.Log) (out []byte, err error) { if len(log.Entries) == 0 { return diff --git a/formatters/plain_test.go b/formatters/plain_test.go index 487550f..e384101 100644 --- a/formatters/plain_test.go +++ b/formatters/plain_test.go @@ -13,7 +13,7 @@ import ( "github.com/stretchr/testify/require" ) -func TestPlainLogs(t *testing.T) { +func TestPlainLog(t *testing.T) { m := []models.Meta{ {"foo", "bar"}, {"baz", 42}, @@ -23,17 +23,11 @@ func TestPlainLogs(t *testing.T) { {Title: "small", Date: time.Now()}, } l := models.Log{"stuff", e} - e2 := models.Entry{ - Title: "three", - Date: time.Now(), - } - l2 := models.Log{"more-stuff", []models.Entry{e2}} - logs := []models.Log{l, l2} f, err := New("plain") require.NoError(t, err) - out, err := f.Logs(logs) + out, err := f.Log(l) require.NoError(t, err) read := bytes.NewReader(out) @@ -73,24 +67,6 @@ func TestPlainLogs(t *testing.T) { line = scan.Text() assert.Equal(t, "Date: "+e[1].Date.Format(tools.DateFormat), line) - scan.Scan() - scan.Scan() - line = scan.Text() - assert.Equal(t, l2.Name, line) - - scan.Scan() - line = scan.Text() - assert.Equal(t, "#######", line) - - scan.Scan() - scan.Scan() - line = scan.Text() - assert.Equal(t, "Title: "+e2.Title, line) - - scan.Scan() - line = scan.Text() - assert.Equal(t, "Date: "+e2.Date.Format(tools.DateFormat), line) - more := scan.Scan() assert.False(t, more) } @@ -100,13 +76,6 @@ func TestPlainName(t *testing.T) { assert.Equal(t, "plain", f.Name()) } -func TestPlainLogNone(t *testing.T) { - f, _ := New("plain") - out, err := f.Logs([]models.Log{}) - assert.NoError(t, err) - assert.Len(t, out, 0) -} - func TestPlainLogNoEntries(t *testing.T) { f, _ := New("plain") out, err := f.Log(models.Log{Name: "foo"}) diff --git a/go.mod b/go.mod index b67cb17..4928514 100644 --- a/go.mod +++ b/go.mod @@ -5,10 +5,10 @@ go 1.21.5 require ( github.com/BurntSushi/toml v1.3.2 github.com/caarlos0/env/v10 v10.0.0 - github.com/markusmobius/go-dateparser v1.2.3 + github.com/markusmobius/go-dateparser v1.2.1 github.com/mitchellh/mapstructure v1.5.0 github.com/spf13/cobra v1.8.0 - github.com/stretchr/testify v1.9.0 + github.com/stretchr/testify v1.8.4 ) require ( @@ -25,7 +25,9 @@ require ( github.com/tetratelabs/wazero v1.2.1 // indirect github.com/wasilibs/go-re2 v1.3.0 // indirect golang.org/x/exp v0.0.0-20220321173239-a90fa8a75705 // indirect - golang.org/x/text v0.14.0 // indirect + golang.org/x/text v0.10.0 // indirect gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 // indirect gopkg.in/yaml.v3 v3.0.1 // indirect ) + +replace github.com/markusmobius/go-dateparser => github.com/goodevilgenius/go-dateparser v1.2.2 diff --git a/go.sum b/go.sum index f782cde..350aa50 100644 --- a/go.sum +++ b/go.sum @@ -8,6 +8,8 @@ github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc h1:U9qPSI2PIWSS1 github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/elliotchance/pie/v2 v2.7.0 h1:FqoIKg4uj0G/CrLGuMS9ejnFKa92lxE1dEgBD3pShXg= github.com/elliotchance/pie/v2 v2.7.0/go.mod h1:18t0dgGFH006g4eVdDtWfgFZPQEgl10IoEO8YWEq3Og= +github.com/goodevilgenius/go-dateparser v1.2.2 h1:Up9KokPx/h07mesQGAZQg3Xi/8yrDVn1638h3k/lRyk= +github.com/goodevilgenius/go-dateparser v1.2.2/go.mod h1:5xYsZ1h7iB3sE1BSu8bkjYpbFST7EU1/AFxcyO3mgYg= github.com/hablullah/go-hijri v1.0.2 h1:drT/MZpSZJQXo7jftf5fthArShcaMtsal0Zf/dnmp6k= github.com/hablullah/go-hijri v1.0.2/go.mod h1:OS5qyYLDjORXzK4O1adFw9Q5WfhOcMdAKglDkcTxgWQ= github.com/hablullah/go-juliandays v1.0.0 h1:A8YM7wIj16SzlKT0SRJc9CD29iiaUzpBLzh5hr0/5p0= @@ -22,8 +24,6 @@ github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY= github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE= github.com/magefile/mage v1.14.0 h1:6QDX3g6z1YvJ4olPhT1wksUcSa/V0a1B+pJb73fBjyo= github.com/magefile/mage v1.14.0/go.mod h1:z5UZb/iS3GoOSn0JgWuiw7dxlurVYTu+/jHXqQg881A= -github.com/markusmobius/go-dateparser v1.2.3 h1:TvrsIvr5uk+3v6poDjaicnAFJ5IgtFHgLiuMY2Eb7Nw= -github.com/markusmobius/go-dateparser v1.2.3/go.mod h1:cMwQRrBUQlK1UI5TIFHEcvpsMbkWrQLXuaPNMFzuYLk= github.com/mitchellh/mapstructure v1.5.0 h1:jeMsZIYE/09sWLaz43PL7Gy6RuMjD2eJVyuac5Z2hdY= github.com/mitchellh/mapstructure v1.5.0/go.mod h1:bFUtVrKA4DC2yAKiSyO/QUcy7e+RRV2QTWOzhPopBRo= github.com/pkg/diff v0.0.0-20210226163009-20ebb0f2a09e/go.mod h1:pJLUxLENpZxwdsKMEsNbx1VGcRFpLqf3715MtcvvzbA= @@ -36,8 +36,8 @@ github.com/spf13/cobra v1.8.0 h1:7aJaZx1B85qltLMc546zn58BxxfZdR/W22ej9CFoEf0= github.com/spf13/cobra v1.8.0/go.mod h1:WXLWApfZ71AjXPya3WOlMsY9yMs7YeiHhFVlvLyhcho= github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA= github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg= -github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg= -github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= +github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk= +github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo= github.com/tetratelabs/wazero v1.2.1 h1:J4X2hrGzJvt+wqltuvcSjHQ7ujQxA9gb6PeMs4qlUWs= github.com/tetratelabs/wazero v1.2.1/go.mod h1:wYx2gNRg8/WihJfSDxA1TIL8H+GkfLYm+bIfbblu9VQ= github.com/wasilibs/go-re2 v1.3.0 h1:LFhBNzoStM3wMie6rN2slD1cuYH2CGiHpvNL3UtcsMw= @@ -46,8 +46,8 @@ github.com/wasilibs/nottinygc v0.4.0 h1:h1TJMihMC4neN6Zq+WKpLxgd9xCFMw7O9ETLwY2e github.com/wasilibs/nottinygc v0.4.0/go.mod h1:oDcIotskuYNMpqMF23l7Z8uzD4TC0WXHK8jetlB3HIo= golang.org/x/exp v0.0.0-20220321173239-a90fa8a75705 h1:ba9YlqfDGTTQ5aZ2fwOoQ1hf32QySyQkR6ODGDzHlnE= golang.org/x/exp v0.0.0-20220321173239-a90fa8a75705/go.mod h1:lgLbSvA5ygNOMpwM/9anMpWVlVJ7Z+cHWq/eFuinpGE= -golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ= -golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU= +golang.org/x/text v0.10.0 h1:UpjohKhiEgNc0CSauXmwYftY1+LlaC75SJwh0SgCX58= +golang.org/x/text v0.10.0/go.mod h1:TvPlkZtksWOMsz7fbANvkp4WM8x/WCo/om8BMLbz+aE= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 h1:YR8cESwS4TdDjEe65xsg0ogRM/Nc3DYOhEAlW+xobZo= gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= diff --git a/models/entry.go b/models/entry.go index 2a11fd2..5a19933 100644 --- a/models/entry.go +++ b/models/entry.go @@ -16,9 +16,14 @@ import ( const DateFormat = tools.DateFormat type Entry struct { - Title string - Date time.Time - Fields Metas + Title string + Date time.Time + Fields []Meta + skipMissing bool +} + +func PartialEntry() Entry { + return Entry{skipMissing: true} } type metaRes struct { @@ -37,9 +42,9 @@ func (e Entry) getFieldMarshalChan() chan metaRes { defer wg.Done() if m.Key == "json" { if j, ok := m.Value.(json.RawMessage); ok { - sub := Metas{} + sub := Entry{skipMissing: true} json.Unmarshal(j, &sub) - for _, subM := range sub { + for _, subM := range sub.Fields { o, er := subM.MarshalText() ch <- metaRes{o, er} } @@ -155,9 +160,9 @@ func (e *Entry) getFieldUnarshalChan(in []byte) chan Meta { if err == nil { if m.Key == "json" { if j, ok := m.Value.(json.RawMessage); ok { - ms := Metas{} - json.Unmarshal(j, &ms) - for _, subM := range ms { + sub := Entry{skipMissing: true} + json.Unmarshal(j, &sub) + for _, subM := range sub.Fields { ch <- subM } } @@ -186,8 +191,26 @@ func (e Entry) MarshalJSON() ([]byte, error) { out := map[string]any{} out["title"] = e.Title out["date"] = e.Date.Format(time.RFC3339) - for k, v := range e.Fields.Map() { - out[k] = v + for _, f := range e.Fields { + if _, ok := out[f.Key]; !ok { + if f.Key == "json" { + ob := map[string]any{} + if j, ok := f.Value.(json.RawMessage); ok { + json.Unmarshal(j, &ob) + } + // If we couldn't get valid data from there, this will just be empty + for k, v := range ob { + if k != "title" && k != "date" { + out[k] = v + } + } + } else { + out[f.Key] = f.Value + if vt, ok := f.Value.(time.Time); ok { + out[f.Key] = vt.Format(time.RFC3339) + } + } + } } return json.Marshal(out) } @@ -236,16 +259,16 @@ func (e *Entry) UnmarshalJSON(in []byte) error { return newParsingError(err) } title, ok := out["title"].(string) - if !ok || title == "" { + if (!ok || title == "") && !e.skipMissing { return ErrorMissingTitle } e.Title = title dates, ok := out["date"].(string) - if !ok || dates == "" { + if (!ok || dates == "") && !e.skipMissing { return ErrorMissingDate } date, err := tools.ParseDate(dates) - if err != nil { + if err != nil && !e.skipMissing { return newParsingError(err) } e.Date = date diff --git a/models/entry_test.go b/models/entry_test.go index 01c65a7..aefecc9 100644 --- a/models/entry_test.go +++ b/models/entry_test.go @@ -9,6 +9,7 @@ import ( "time" "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" ) // Type assertions @@ -17,6 +18,19 @@ var _ encoding.TextUnmarshaler = new(Entry) var _ json.Marshaler = Entry{} var _ json.Unmarshaler = new(Entry) +func TestPartialEntry(t *testing.T) { + e := PartialEntry() + assert.True(t, e.skipMissing) + err := json.Unmarshal([]byte(`{"a":42}`), &e) + assert.NoError(t, err) + assert.Equal(t, "", e.Title) + assert.Equal(t, time.Time{}, e.Date) + require.Len(t, e.Fields, 1) + f := e.Fields[0] + assert.Equal(t, "a", f.Key) + assert.Equal(t, int64(42), f.Value) +} + func TestEntryMarshal(t *testing.T) { when := time.Now() whens := when.Format(DateFormat) @@ -70,7 +84,7 @@ func TestEntryMarshal(t *testing.T) { func getEntryMarshalTestRunner(title string, date time.Time, fields []Meta, first string, lines []string, err error) func(*testing.T) { return func(t *testing.T) { - en := Entry{title, date, fields} + en := Entry{title, date, fields, false} o, er := en.MarshalText() assert.Equal(t, err, er) if first == "" { @@ -218,7 +232,7 @@ func TestEntryJsonMarshal(t *testing.T) { func getEntryJsonMarshalTestRunner(title string, date time.Time, fields []Meta, out string, err error) func(t *testing.T) { return func(t *testing.T) { - e := Entry{title, date, fields} + e := Entry{title, date, fields, false} o, er := json.Marshal(e) if err == nil { assert.JSONEq(t, out, string(o)) diff --git a/models/meta_test.go b/models/meta_test.go index 2d4cea8..1e0888b 100644 --- a/models/meta_test.go +++ b/models/meta_test.go @@ -13,8 +13,6 @@ import ( // Type assertions var _ encoding.TextMarshaler = Meta{} var _ encoding.TextUnmarshaler = new(Meta) -var _ json.Marshaler = Metas{} -var _ json.Unmarshaler = new(Metas) var skipMarshalTest = errors.New("skip marshal") @@ -99,45 +97,3 @@ func getMetaTestRunner(key string, value any, out string, err error, newVal any) } } } - -func TestMetasJson(t *testing.T) { - ms := Metas{{"me", 41}, {"you", false}} - exp := `{"me":41,"you":false}` - o, err := json.Marshal(ms) - assert.NoError(t, err) - assert.JSONEq(t, exp, string(o)) -} - -func TestMetasJsonUnmarshal(t *testing.T) { - ms := Metas{} - in := `{"me":"cool","you":false}` - err := json.Unmarshal([]byte(in), &ms) - assert.NoError(t, err) - assert.Len(t, ms, 2) - assert.ElementsMatch(t, Metas{ - {"me", "cool"}, - {"you", false}, - }, ms) -} - -func TestMetasJsonError(t *testing.T) { - ms := Metas{} - in := "not json" - err := (&ms).UnmarshalJSON([]byte(in)) - assert.Error(t, err) - assert.Len(t, ms, 0) -} - -func TestMetasAppend(t *testing.T) { - ms := Metas{} - ms = ms.Append("foo", 42) - assert.Len(t, ms, 1) - assert.Equal(t, Meta{"foo", 42}, ms[0]) -} - -func TestMetasAppendTo(t *testing.T) { - ms := &Metas{} - ms.AppendTo("foo", 42) - assert.Len(t, *ms, 1) - assert.Equal(t, Meta{"foo", 42}, (*ms)[0]) -} diff --git a/models/metas.go b/models/metas.go deleted file mode 100644 index 4db9d46..0000000 --- a/models/metas.go +++ /dev/null @@ -1,71 +0,0 @@ -package models - -import ( - "encoding/json" - "time" -) - -// A slice of Meta -type Metas []Meta - -// Returns a single map containing all the Meta. Is useful when encoding to JSON -func (ms Metas) Map() map[string]any { - out := map[string]any{} - for _, f := range ms { - if _, found := out[f.Key]; found || f.Key == "title" || f.Key == "date" { - continue - } - if f.Key == "json" { - ob := map[string]any{} - if j, ok := f.Value.(json.RawMessage); ok { - json.Unmarshal(j, &ob) - } - // If we couldn't get valid data from there, this will just be empty - for k, v := range ob { - if k != "title" && k != "date" { - out[k] = v - } - } - } else { - out[f.Key] = f.Value - if vt, ok := f.Value.(time.Time); ok { - out[f.Key] = vt.Format(time.RFC3339) - } - } - } - return out -} - -// Implements json.Marshaler -func (ms Metas) MarshalJSON() ([]byte, error) { - return json.Marshal(ms.Map()) -} - -// Implements json.Unmarshaler -func (ms *Metas) UnmarshalJSON(in []byte) error { - old := (*ms).Map() - out := map[string]any{} - err := json.Unmarshal(in, &out) - if err != nil { - return err - } - ret := *ms - for k, v := range out { - if _, found := old[k]; k != "title" && k != "date" && !found { - ret = append(ret, Meta{k, v}) - } - } - *ms = ret - return nil -} - -// Returns a new Metas with a new Meta appended -func (ms Metas) Append(k string, v any) Metas { - return append(ms, Meta{k, v}) -} - -// Appends a new Meta to this Metas -func (ms *Metas) AppendTo(k string, v any) { - n := (*ms).Append(k, v) - *ms = n -} diff --git a/tools/parse.go b/tools/parse.go index e69c476..021c6a2 100644 --- a/tools/parse.go +++ b/tools/parse.go @@ -24,7 +24,11 @@ func ParseString(in string) any { if null.MatchString(s) { return nil } else if yesno.MatchString(s) { - return yes.MatchString(s) + if yes.MatchString(s) { + return true + } else { + return false + } } else if i, err := strconv.Atoi(s); err == nil { return i } else if f, err := strconv.ParseFloat(s, 64); err == nil { diff --git a/tools/parse_date.go b/tools/parse_date.go index 0fa117a..d060299 100644 --- a/tools/parse_date.go +++ b/tools/parse_date.go @@ -1,7 +1,6 @@ package tools import ( - "strconv" "time" dp "github.com/markusmobius/go-dateparser" @@ -24,19 +23,6 @@ func ParseDate(in string) (t time.Time, err error) { return MaxTime, nil } - var er error - for _, format := range []string{time.RFC3339, DateFormat} { - if t, er = time.ParseInLocation(format, in, nil); er == nil { - return - } - } - - var ts int64 - if ts, er = strconv.ParseInt(in, 10, 0); er == nil { - t = time.Unix(ts, 0) - return - } - conf := dp.Configuration{ CurrentTime: time.Now().Local(), ReturnTimeAsPeriod: true, @@ -46,11 +32,12 @@ func ParseDate(in string) (t time.Time, err error) { d, err := dp.Parse(&conf, in) t = d.Time if err != nil { + d, err = dp.Parse(&conf, in, DateFormat) + t = d.Time return } y, mon, day, h, loc := t.Year(), t.Month(), t.Day(), t.Hour(), t.Location() - switch d.Period { case date.Second: t = t.Truncate(time.Second) diff --git a/tools/parse_date_test.go b/tools/parse_date_test.go index 3099b88..cfaadd1 100644 --- a/tools/parse_date_test.go +++ b/tools/parse_date_test.go @@ -16,14 +16,14 @@ func TestParseDate(t *testing.T) { y, mon, d, h, loc := now.Year(), now.Month(), now.Day(), now.Hour(), now.Location() sec := now.Truncate(time.Second) today := time.Date(y, mon, d, 0, 0, 0, 0, loc) - tomorrow := time.Date(y, mon, d+1, 0, 0, 0, 0, loc) - yesterday := time.Date(y, mon, d-1, 0, 0, 0, 0, loc) + tomorrow := today.Add(day) + yesterday := today.Add(-day) twoMin := now.Add(2 * time.Minute).Truncate(time.Minute) twoHour := time.Date(y, mon, d, h+2, 0, 0, 0, loc) firstMonth := time.Date(y, mon, 1, 0, 0, 0, 0, loc) firstYear := time.Date(y, 1, 1, 0, 0, 0, 0, loc) exact := "2075-02-12T12:13:54.536-02:00" - exactd, _ := time.ParseInLocation(time.RFC3339, exact, nil) + exactd, _ := time.ParseInLocation(time.RFC3339, exact, time.FixedZone("UTC-02:00", -7200)) var ts int64 = 1708876012 tsd := time.Unix(ts, 0) ent := "February 25, 2024 at 04:00:13AM +0230" diff --git a/tools/write_buffer.go b/tools/write_buffer.go index 8ae9386..e67d219 100644 --- a/tools/write_buffer.go +++ b/tools/write_buffer.go @@ -14,18 +14,6 @@ func WriteValue(buff *bytes.Buffer, val any) (n int, err error) { err = fmt.Errorf("Unsupported type %T", v) case nil: return - case []any: - var o []byte - o, err = json.Marshal(v) - if err == nil { - return buff.Write(o) - } - case map[string]any: - var o []byte - o, err = json.Marshal(v) - if err == nil { - return buff.Write(o) - } case string: return buff.WriteString(v) case int: diff --git a/tools/write_buffer_test.go b/tools/write_buffer_test.go index aa7e203..1a4a103 100644 --- a/tools/write_buffer_test.go +++ b/tools/write_buffer_test.go @@ -30,8 +30,6 @@ func TestWriteBuffer(t *testing.T) { {"json.Number", json.Number("42.13"), "42.13", nil}, {"json.RawMessage", json.RawMessage("{}"), "{}", nil}, {"time", when, when.Format(time.RFC3339), nil}, - {"slice", []any{1, 2, "foo"}, `[1,2,"foo"]`, nil}, - {"map", map[string]any{"baz": 42, "foo": "bar"}, `{"baz":42,"foo":"bar"}`, nil}, {"struct", struct{}{}, "", errors.New("Unsupported type struct {}")}, }