initial commit, it does the thing

This commit is contained in:
Lilian Jónsdóttir 2024-06-18 15:21:03 -07:00
commit cc1523034b
9 changed files with 1986 additions and 0 deletions

137
internal/filter/filter.go Normal file
View file

@ -0,0 +1,137 @@
// Package filter filters files based on specific critera
package filter
import (
"fmt"
"path/filepath"
"regexp"
"slices"
"time"
"github.com/ijt/go-anytime"
)
type Filter struct {
on, before, after time.Time
glob, pattern string
filenames []string
matcher *regexp.Regexp
}
func (f *Filter) On() time.Time { return f.on }
func (f *Filter) After() time.Time { return f.after }
func (f *Filter) Before() time.Time { return f.before }
func (f *Filter) Glob() string { return f.glob }
func (f *Filter) Pattern() string { return f.pattern }
func (f *Filter) FileNames() []string { return f.filenames }
func (f *Filter) Match(filename string, modified time.Time) bool {
// on or before/after, not both
if !f.on.IsZero() {
if !same_day(f.on, modified) {
return false
}
} else {
if !f.after.IsZero() && f.after.After(modified) {
return false
}
if !f.before.IsZero() && f.before.Before(modified) {
return false
}
}
if f.has_regex() && !f.matcher.MatchString(filename) {
return false
}
if f.glob != "" {
if match, err := filepath.Match(f.glob, filename); err != nil || !match {
return false
}
}
if len(f.filenames) > 0 && !slices.Contains(f.filenames, filename) {
return false
}
// okay it was good
return true
}
func (f *Filter) SetPattern(pattern string) error {
var err error
f.pattern = pattern
f.matcher, err = regexp.Compile(f.pattern)
return err
}
func (f *Filter) Blank() bool {
t := time.Time{}
return !f.has_regex() &&
f.glob == "" &&
f.after.Equal(t) &&
f.before.Equal(t) &&
f.on.Equal(t) &&
len(f.filenames) == 0
}
func (f *Filter) String() string {
var m string
if f.matcher != nil {
m = f.matcher.String()
}
return fmt.Sprintf("on:'%s' before:'%s' after:'%s' glob:'%s' regex:'%s' filenames:'%v'",
f.on, f.before, f.after,
f.glob, m, f.filenames,
)
}
func (f *Filter) has_regex() bool {
if f.matcher == nil {
return false
}
return f.matcher.String() != ""
}
func New(o, b, a, g, p string, names ...string) (*Filter, error) {
// o b a g p
var (
err error
now = time.Now()
)
f := &Filter{
glob: g,
filenames: append([]string{}, names...),
}
if o != "" {
on, err := anytime.Parse(o, now)
if err != nil {
return &Filter{}, err
}
f.on = on
}
if a != "" {
after, err := anytime.Parse(a, now)
if err != nil {
return &Filter{}, err
}
f.after = after
}
if b != "" {
before, err := anytime.Parse(b, now)
if err != nil {
return &Filter{}, err
}
f.before = before
}
err = f.SetPattern(p)
return f, err
}
func same_day(a, b time.Time) bool {
ay, am, ad := a.Date()
by, bm, bd := b.Date()
return ay == by && am == bm && ad == bd
}

View file

@ -0,0 +1,378 @@
package filter
import (
"fmt"
"testing"
"time"
)
var (
now = time.Now()
yesterday = now.AddDate(0, 0, -1)
ereyesterday = now.AddDate(0, 0, -2)
oneweekago = now.AddDate(0, 0, -7)
twoweeksago = now.AddDate(0, 0, -14)
onemonthago = now.AddDate(0, -1, 0)
twomonthsago = now.AddDate(0, -2, 0)
fourmonthsago = now.AddDate(0, -4, 0)
oneyearago = now.AddDate(-1, 0, 0)
twoyearsago = now.AddDate(-2, 0, 0)
fouryearsago = now.AddDate(-4, 0, 0)
)
type testholder struct {
pattern, glob string
before, after, on string
filenames []string
good, bad []singletest
}
func (t testholder) String() string {
return fmt.Sprintf("pattern:'%s' glob:'%s' filenames:'%v' before:'%s' after:'%s' on:'%s'", t.pattern, t.glob, t.filenames, t.before, t.after, t.on)
}
type singletest struct {
filename string
modified time.Time
}
func (s singletest) String() string {
return fmt.Sprintf("filename:'%s' modified:'%s'", s.filename, s.modified)
}
func testmatch(t *testing.T, testers []testholder) {
const testnamefmt string = "file %s modified on %s"
var (
f *Filter
err error
)
for _, tester := range testers {
f, err = New(tester.on, tester.before, tester.after, tester.glob, tester.pattern, tester.filenames...)
if err != nil {
t.Fatal(err)
}
for _, tst := range tester.good {
t.Run(fmt.Sprintf(testnamefmt+"_good", tst.filename, tst.modified), func(t *testing.T) {
if !f.Match(tst.filename, tst.modified) {
t.Fatalf("(filename:%s modified:%s) didn't match (%s) but should have", tst.filename, tst.modified, tester)
}
})
}
for _, tst := range tester.bad {
t.Run(fmt.Sprintf(testnamefmt+"_bad", tst.filename, tst.modified), func(t *testing.T) {
if f.Match(tst.filename, tst.modified) {
t.Fatalf("(filename:%s modified:%s) matched (%s) but shouldn't have", tst.filename, tst.modified, tester)
}
})
}
}
}
func blankfilename(times ...time.Time) []singletest {
out := make([]singletest, 0, len(times))
for _, time := range times {
out = append(out, singletest{filename: "blank.txt", modified: time})
}
return out
}
func blanktime(filenames ...string) []singletest {
out := make([]singletest, 0, len(filenames))
for _, filename := range filenames {
out = append(out, singletest{filename: filename, modified: time.Time{}})
}
return out
}
func TestFilterOn(t *testing.T) {
testmatch(t, []testholder{
{
on: "2024-02-14",
good: blankfilename(time.Date(2024, 2, 14, 12, 0, 0, 0, time.Local)),
bad: blankfilename(now, now.Add(time.Hour*72), now.Add(-time.Hour*18)),
},
{
on: "yesterday",
good: blankfilename(yesterday),
bad: blankfilename(now, oneweekago, onemonthago, oneyearago, twoweeksago, twomonthsago, twoyearsago),
},
{
on: "one week ago",
good: blankfilename(oneweekago),
bad: blankfilename(now),
},
{
on: "one month ago",
good: blankfilename(onemonthago),
bad: blankfilename(now),
},
{
on: "two months ago",
good: blankfilename(twomonthsago),
bad: blankfilename(now),
},
{
on: "four months ago",
good: blankfilename(fourmonthsago),
bad: blankfilename(now),
},
{
on: "one year ago",
good: blankfilename(oneyearago),
bad: blankfilename(now),
},
{
on: "four years ago",
good: blankfilename(fouryearsago),
bad: blankfilename(now),
},
})
}
func TestFilterAfter(t *testing.T) {
testmatch(t, []testholder{
{
after: "2020-02-14",
good: blankfilename(time.Date(2024, 3, 14, 12, 0, 0, 0, time.Local), now, yesterday),
bad: blankfilename(time.Date(2018, 2, 14, 12, 0, 0, 0, time.Local)),
},
{
after: "yesterday",
good: blankfilename(yesterday, yesterday.AddDate(1, 0, 0), now, now.AddDate(0, 3, 0)),
bad: blankfilename(yesterday.AddDate(-1, 0, 0), yesterday.AddDate(0, 0, -1), ereyesterday),
},
{
after: "one week ago",
good: blankfilename(now),
bad: blankfilename(oneweekago.AddDate(0, 0, -1)),
},
{
after: "one month ago",
good: blankfilename(now, oneweekago, twoweeksago),
bad: blankfilename(onemonthago, twomonthsago, fourmonthsago, oneyearago),
},
{
after: "two months ago",
good: blankfilename(now, onemonthago, oneweekago),
bad: blankfilename(twomonthsago, oneyearago, fourmonthsago),
},
{
after: "four months ago",
good: blankfilename(now, oneweekago, onemonthago, twoweeksago, twomonthsago, onemonthago),
bad: blankfilename(fourmonthsago, oneyearago),
},
{
after: "one year ago",
good: blankfilename(now, onemonthago, twomonthsago, fourmonthsago),
bad: blankfilename(oneyearago, fouryearsago, twoyearsago),
},
{
after: "four years ago",
good: blankfilename(now, twoyearsago, onemonthago, fourmonthsago),
bad: blankfilename(fouryearsago, fouryearsago.AddDate(-1, 0, 0)),
},
})
}
func TestFilterBefore(t *testing.T) {
testmatch(t, []testholder{
{
before: "2024-02-14",
good: blankfilename(time.Date(2020, 2, 14, 12, 0, 0, 0, time.Local), time.Date(1989, 8, 13, 18, 53, 0, 0, time.Local)),
bad: blankfilename(now, now.AddDate(0, 0, 10), now.AddDate(0, -2, 0)),
},
{
before: "yesterday",
good: blankfilename(onemonthago, oneweekago, oneyearago),
bad: blankfilename(now, now.AddDate(0, 0, 1)),
},
{
before: "one week ago",
good: blankfilename(onemonthago, oneyearago, twoweeksago),
bad: blankfilename(yesterday, now),
},
{
before: "one month ago",
good: blankfilename(oneyearago, twomonthsago),
bad: blankfilename(oneweekago, yesterday, now),
},
{
before: "two months ago",
good: blankfilename(fourmonthsago, oneyearago),
bad: blankfilename(onemonthago, oneweekago, yesterday, now),
},
{
before: "four months ago",
good: blankfilename(oneyearago, twoyearsago, fouryearsago),
bad: blankfilename(twomonthsago, onemonthago, oneweekago, yesterday, now),
},
{
before: "one year ago",
good: blankfilename(twoyearsago, fouryearsago),
bad: blankfilename(fourmonthsago, twomonthsago, onemonthago, oneweekago, yesterday, now),
},
{
before: "four years ago",
good: blankfilename(fouryearsago.AddDate(-1, 0, 0), fouryearsago.AddDate(-4, 0, 0)),
bad: blankfilename(oneyearago, fourmonthsago, twomonthsago, onemonthago, oneweekago, yesterday, now),
},
})
}
func TestFilterMatch(t *testing.T) {
testmatch(t, []testholder{
{
pattern: "[Tt]est",
good: blanktime("test", "Test"),
bad: blanktime("TEST", "tEst", "tEST", "TEst"),
},
{
pattern: "^h.*o$",
good: blanktime("hello", "hippo", "how about some pasta with alfredo"),
bad: blanktime("hi", "test", "hellO", "Hello", "oh hello there"),
},
})
}
func TestFilterGlob(t *testing.T) {
testmatch(t, []testholder{
{
glob: "*.txt",
good: blanktime("test.txt", "alsotest.txt"),
bad: blanktime("test.md", "test.go", "test.tar.gz", "testxt", "test.text"),
},
{
glob: "*.tar.*",
good: blanktime("test.tar.gz", "test.tar.xz", "test.tar.zst", "test.tar.bz2"),
bad: blanktime("test.tar", "test.txt", "test.targz", "test.tgz"),
},
{
glob: "pot*o",
good: blanktime("potato", "potdonkeyo", "potesto"),
bad: blanktime("salad", "test", "alsotest"),
},
{
glob: "t?st",
good: blanktime("test", "tast", "tfst", "tnst"),
bad: blanktime("best", "fast", "most", "past"),
},
})
}
func TestFilterFilenames(t *testing.T) {
testmatch(t, []testholder{
{
filenames: []string{"test.txt", "alsotest.txt"},
good: blanktime("test.txt", "alsotest.txt"),
bad: blanktime("test.md", "test.go", "test.tar.gz", "testxt", "test.text"),
},
{
filenames: []string{"test.md", "test.txt"},
good: blanktime("test.txt", "test.md"),
bad: blanktime("alsotest.txt", "test.go", "test.tar.gz", "testxt", "test.text"),
},
{
filenames: []string{"hello.world"},
good: blanktime("hello.world"),
bad: blanktime("test.md", "test.go", "test.tar.gz", "testxt", "test.text", "helloworld", "Hello.world"),
},
})
}
func TestFilterMultipleParameters(t *testing.T) {
testmatch(t, []testholder{
{
pattern: "[Tt]est",
before: "yesterday",
good: []singletest{
{filename: "test", modified: oneweekago},
{filename: "test", modified: twoweeksago},
{filename: "Test", modified: onemonthago},
{filename: "Test", modified: fourmonthsago},
},
bad: []singletest{
{filename: "test", modified: now},
{filename: "salad", modified: oneweekago},
{filename: "holyshit", modified: onemonthago},
},
},
{
glob: "*.tar.*",
before: "yesterday",
after: "one month ago",
good: []singletest{
{filename: "test.tar.xz", modified: oneweekago},
{filename: "test.tar.gz", modified: twoweeksago},
{filename: "test.tar.zst", modified: twoweeksago.AddDate(0, 0, 2)},
{filename: "test.tar.bz2", modified: twoweeksago.AddDate(0, 0, -4)},
},
bad: []singletest{
{filename: "test.tar.gz", modified: oneyearago},
{filename: "test.targz", modified: oneweekago},
{filename: "test.jpg", modified: ereyesterday},
},
},
{
on: "today",
after: "two weeks ago",
before: "one week ago",
good: blankfilename(now, time.Date(now.Year(), now.Month(), now.Day(), 18, 42, 0, 0, time.Local), time.Date(now.Year(), now.Month(), now.Day(), 8, 17, 33, 0, time.Local)),
bad: blankfilename(yesterday, oneweekago, onemonthago, oneyearago),
},
})
}
func TestFilterBlank(t *testing.T) {
var f *Filter
t.Run("new", func(t *testing.T) {
f, _ = New("", "", "", "", "")
if !f.Blank() {
t.Fatalf("filter isn't blank? %s", f)
}
})
t.Run("blank", func(t *testing.T) {
f = &Filter{}
if !f.Blank() {
t.Fatalf("filter isn't blank? %s", f)
}
})
}
func TestFilterNotBlank(t *testing.T) {
var (
f *Filter
testers = []testholder{
{
pattern: "[Ttest]",
},
{
glob: "*test*",
},
{
before: "yesterday",
after: "one week ago",
},
{
on: "2024-06-06",
},
{
filenames: []string{"hello"},
},
{
filenames: []string{""},
},
}
)
for _, tester := range testers {
t.Run("notblank"+tester.String(), func(t *testing.T) {
f, _ = New(tester.on, tester.before, tester.after, tester.glob, tester.pattern, tester.filenames...)
if f.Blank() {
t.Fatalf("filter is blank?? %s", f)
}
})
}
}