ref(filter): rename refine pkg to filter (#155)

director.go

@@ -3,8 +3,8 @@ package tv
 import (
 	"io/fs"
 
+	"github.com/snivilised/traverse/internal/feat/filter"
 	"github.com/snivilised/traverse/internal/feat/hiber"
-	"github.com/snivilised/traverse/internal/feat/refine"
 	"github.com/snivilised/traverse/internal/feat/resume"
 	"github.com/snivilised/traverse/internal/feat/sampling"
 	"github.com/snivilised/traverse/internal/kernel"
@@ -29,7 +29,7 @@ func features(o *pref.Options, mediator types.Mediator,
 			// order. How can we decouple ourselves from this
 			// requirement? => the cure is worse than the disease
 			//
-			hiber.IfActive, refine.IfActive, sampling.IfActive,
+			hiber.IfActive, filter.IfActive, sampling.IfActive,
 		}
 	)
 

internal/feat/filter/base.go

@@ -0,0 +1,48 @@
+package filter
+
+import (
+	"github.com/snivilised/traverse/core"
+	"github.com/snivilised/traverse/enums"
+	"github.com/snivilised/traverse/internal/third/lo"
+)
+
+// Base Filter ================================================================
+
+// Base base filter struct.
+type Base struct {
+	name            string
+	pattern         string
+	scope           enums.FilterScope // defines which file system nodes the filter should be applied to
+	negate          bool              // select to define a negative match
+	ifNotApplicable bool
+}
+
+// Description description of the filter
+func (f *Base) Description() string {
+	return f.name
+}
+
+// Source text defining the filter
+func (f *Base) Source() string {
+	return f.pattern
+}
+
+func (f *Base) IsApplicable(node *core.Node) bool {
+	return (f.scope & node.Extension.Scope) > 0
+}
+
+func (f *Base) Scope() enums.FilterScope {
+	return f.scope
+}
+
+func (f *Base) invert(result bool) bool {
+	return lo.Ternary(f.negate, !result, result)
+}
+
+func (f *Base) Validate() error {
+	if f.scope == enums.ScopeUndefined {
+		f.scope = enums.ScopeAll
+	}
+
+	return nil
+}

internal/feat/filter/child.go

@@ -0,0 +1,30 @@
+package filter
+
+import (
+	"github.com/snivilised/traverse/internal/third/lo"
+)
+
+// Child Filter ===============================================================
+
+// Child filter used when subscription is FoldersWithFiles
+type Child struct {
+	Name    string
+	Pattern string
+	Negate  bool
+}
+
+func (f *Child) Description() string {
+	return f.Name
+}
+
+func (f *Child) Validate() error {
+	return nil
+}
+
+func (f *Child) Source() string {
+	return f.Pattern
+}
+
+func (f *Child) invert(result bool) bool {
+	return lo.Ternary(f.Negate, !result, result)
+}

internal/feat/refine/extended-glob.go → internal/feat/filter/extended-glob.go

@@ -1,4 +1,4 @@
-package refine
+package filter
 
 import (
 	"io/fs"
@@ -10,7 +10,7 @@ import (
 )
 
 type ExtendedGlobFilter struct {
-	Filter
+	Base
 	baseGlob     string
 	suffixes     []string
 	anyExtension bool
@@ -75,7 +75,7 @@ func (f *ExtendedGlobFilter) IsMatch(node *core.Node) bool {
 // ChildExtendedGlobFilter ==========================================================
 
 type ChildExtendedGlobFilter struct {
-	ChildFilter
+	Child
 	baseGlob     string
 	exclusion    string
 	suffixes     []string

internal/feat/refine/filter-plugin.go → internal/feat/filter/filter-plugin.go

@@ -1,6 +1,6 @@
-package refine
+package filter
 
-// 📦 pkg: refine - defines filters
+// 📦 pkg: filter - defines filters
 
 import (
 	"github.com/snivilised/traverse/core"

internal/feat/refine/glob.go → internal/feat/filter/glob.go

@@ -1,4 +1,4 @@
-package refine
+package filter
 
 import (
 	"io/fs"
@@ -10,7 +10,7 @@ import (
 
 // GlobFilter wildcard filter.
 type GlobFilter struct {
-	Filter
+	Base
 }
 
 // IsMatch does this node match the filter
@@ -26,7 +26,7 @@ func (f *GlobFilter) IsMatch(node *core.Node) bool {
 // ChildGlobFilter ============================================================
 
 type ChildGlobFilter struct {
-	ChildFilter
+	Child
 }
 
 // Matching returns the collection of files contained within this

internal/feat/refine/new-filter.go → internal/feat/filter/new-filter.go

@@ -1,4 +1,4 @@
-package refine
+package filter
 
 import (
 	"slices"
@@ -56,7 +56,7 @@ func newNodeFilter(def *core.FilterDef,
 		base, exclusion := splitGlob(segments[0])
 
 		filter = &ExtendedGlobFilter{
-			Filter: Filter{
+			Base: Base{
 				name:            def.Description,
 				scope:           def.Scope,
 				pattern:         def.Pattern,
@@ -73,7 +73,7 @@ func newNodeFilter(def *core.FilterDef,
 
 	case enums.FilterTypeRegex:
 		filter = &RegexFilter{
-			Filter: Filter{
+			Base: Base{
 				name:            def.Description,
 				scope:           def.Scope,
 				pattern:         def.Pattern,
@@ -84,7 +84,7 @@ func newNodeFilter(def *core.FilterDef,
 
 	case enums.FilterTypeGlob:
 		filter = &GlobFilter{
-			Filter: Filter{
+			Base: Base{
 				name:            def.Description,
 				scope:           def.Scope,
 				pattern:         def.Pattern,
@@ -186,7 +186,7 @@ func newChildFilter(def *core.ChildFilterDef) (core.ChildTraverseFilter, error)
 		base, exclusion := splitGlob(segments[0])
 
 		filter = &ChildExtendedGlobFilter{
-			ChildFilter: ChildFilter{
+			Child: Child{
 				Name:    def.Description,
 				Pattern: def.Pattern,
 				Negate:  def.Negate,
@@ -201,7 +201,7 @@ func newChildFilter(def *core.ChildFilterDef) (core.ChildTraverseFilter, error)
 
 	case enums.FilterTypeRegex:
 		filter = &ChildRegexFilter{
-			ChildFilter: ChildFilter{
+			Child: Child{
 				Name:    def.Description,
 				Pattern: def.Pattern,
 				Negate:  def.Negate,
@@ -210,7 +210,7 @@ func newChildFilter(def *core.ChildFilterDef) (core.ChildTraverseFilter, error)
 
 	case enums.FilterTypeGlob:
 		filter = &ChildGlobFilter{
-			ChildFilter: ChildFilter{
+			Child: Child{
 				Name:    def.Description,
 				Pattern: def.Pattern,
 				Negate:  def.Negate,
@@ -247,7 +247,7 @@ func newSampleFilter(def *core.SampleFilterDef,
 	}
 
 	base := SampleFilter{
-		Filter: Filter{
+		Base: Base{
 			name:    def.Description,
 			scope:   def.Scope.Scrub(),
 			pattern: def.Pattern,

internal/feat/refine/poly.go → internal/feat/filter/poly.go

@@ -1,4 +1,4 @@
-package refine
+package filter
 
 import (
 	"fmt"

internal/feat/refine/regex.go → internal/feat/filter/regex.go

@@ -1,4 +1,4 @@
-package refine
+package filter
 
 import (
 	"io/fs"
@@ -12,13 +12,13 @@ import (
 
 // RegexFilter regex filter.
 type RegexFilter struct {
-	Filter
+	Base
 	rex *regexp.Regexp
 }
 
 // Validate ensures the filter definition is valid, panics when invalid
 func (f *RegexFilter) Validate() error {
-	if err := f.Filter.Validate(); err != nil {
+	if err := f.Base.Validate(); err != nil {
 		return err
 	}
 
@@ -42,7 +42,7 @@ func (f *RegexFilter) IsMatch(node *core.Node) bool {
 // ChildRegexFilter ===========================================================
 
 type ChildRegexFilter struct {
-	ChildFilter
+	Child
 	rex *regexp.Regexp
 }
 
@@ -76,7 +76,7 @@ type SampleRegexFilter struct {
 
 // Validate ensures the filter definition is valid, panics when invalid
 func (f *SampleRegexFilter) Validate() error {
-	if err := f.Filter.Validate(); err != nil {
+	if err := f.Base.Validate(); err != nil {
 		return err
 	}
 

internal/feat/refine/base.go → internal/feat/filter/sample.go

@@ -1,94 +1,27 @@
-package refine
+package filter
 
 import (
 	"io/fs"
 
-	"github.com/snivilised/traverse/core"
 	"github.com/snivilised/traverse/enums"
 	"github.com/snivilised/traverse/internal/third/lo"
 	"github.com/snivilised/traverse/nfs"
 )
 
-// Filter =====================================================================
-
-// Filter base filter struct.
-type Filter struct {
-	name            string
-	pattern         string
-	scope           enums.FilterScope // defines which file system nodes the filter should be applied to
-	negate          bool              // select to define a negative match
-	ifNotApplicable bool
-}
-
-// Description description of the filter
-func (f *Filter) Description() string {
-	return f.name
-}
-
-// Source text defining the filter
-func (f *Filter) Source() string {
-	return f.pattern
-}
-
-func (f *Filter) IsApplicable(node *core.Node) bool {
-	return (f.scope & node.Extension.Scope) > 0
-}
-
-func (f *Filter) Scope() enums.FilterScope {
-	return f.scope
-}
-
-func (f *Filter) invert(result bool) bool {
-	return lo.Ternary(f.negate, !result, result)
-}
-
-func (f *Filter) Validate() error {
-	if f.scope == enums.ScopeUndefined {
-		f.scope = enums.ScopeAll
-	}
-
-	return nil
-}
-
-// ChildFilter ================================================================
-
-// ChildFilter filter used when subscription is FoldersWithFiles
-type ChildFilter struct {
-	Name    string
-	Pattern string
-	Negate  bool
-}
-
-func (f *ChildFilter) Description() string {
-	return f.Name
-}
-
-func (f *ChildFilter) Validate() error {
-	return nil
-}
-
-func (f *ChildFilter) Source() string {
-	return f.Pattern
-}
-
-func (f *ChildFilter) invert(result bool) bool {
-	return lo.Ternary(f.Negate, !result, result)
-}
-
 // BaseSampleFilter ===========================================================
 type (
 	candidates func(entries []fs.DirEntry) (wanted, others []fs.DirEntry)
 )
 
 type SampleFilter struct {
-	Filter
+	Base
 }
 
 // NewSampleFilter only needs to be called explicitly when defining
 // a custom sample filter.
 func NewSampleFilter(scope enums.FilterScope) SampleFilter {
 	return SampleFilter{
-		Filter: Filter{
+		Base: Base{
 			scope: scope,
 		},
 	}

internal/feat/refine/schemes.go → internal/feat/filter/schemes.go

@@ -1,10 +1,11 @@
-package refine
+package filter
 
 import (
 	"io/fs"
 
 	"github.com/snivilised/traverse/core"
 	"github.com/snivilised/traverse/enums"
+	"github.com/snivilised/traverse/internal/filtering"
 	"github.com/snivilised/traverse/internal/measure"
 	"github.com/snivilised/traverse/internal/third/lo"
 	"github.com/snivilised/traverse/internal/types"
@@ -66,7 +67,7 @@ type nativeScheme struct {
 }
 
 func (f *nativeScheme) create() error {
-	filter, err := newNodeFilter(f.o.Filter.Node, &f.o.Filter)
+	filter, err := filtering.NewNodeFilter(f.o.Filter.Node, &f.o.Filter)
 	if err != nil {
 		return err
 	}