wojteninho / scanner Goto Github PK

Say we want to filter first 100 files from a particular directory. I would love to do it as easy as:

s := NewBuilder().
     Files().
     In("/my/photos").
     Limit(100)    
     MustBuild()

for item := range MustScan(s.Scan(context.TODO())) {
    ...
}

Behind the scenes, it should be the new Scanner implementation called LimitScanner which is not a self-sufficient scanner, but act as a wrapper above the concrete scanner.

basicScanner := NewBasicScanner(WithDir("/my/photos"))
limitScanner := NewLimitScanner(basicScanner, 100)

To get familiar with the idea of wrappers check out available wrappers implementations.

Happy to see PR with this feature :-)

What I have in my mind is to have an easy way to filter out files by modification date.
Say for instance we want to filter out files modified since yesterday:

yesterday := time.Now().AddDate(0, 0, -1)

s := NewBuilder().
     Files().
     In("/my/photos").
     Modified(After(yesterday))    
     MustBuild()

for item := range MustScan(s.Scan(context.TODO())) {
    ...
}

Another example is:

yesterday := time.Now().AddDate(0, 0, -1)

s := NewBuilder().
     Files().
     In("/my/photos").
     Modified(Before(yesterday))    
     MustBuild()

One more could be the between two dates:

twoDaysAgo := time.Now().AddDate(0, 0, -2)
yesterday := time.Now().AddDate(0, 0, -1)

s := NewBuilder().
     Files().
     In("/my/photos").
     Modified(Between(twoDaysAgo, yesterday))    
     MustBuild()

Behind the scenes it should be the new implementation of Filter interface, and in the builder calling Modified(...) we should add one more filter.

Check how we eventually combine multiple filters here. Filters comes so far from calls to either Files() or Directories() or Match(...).

Happy to discuss further 😄 👍

My use case recently was to iterate through a set of pre-known files and directories. It would be handy to have:

filesScanner := MustScanner(NewFilesScanner(WithFiles("first.go", "second.go")))
dirScanner := MustScanner(NewBasicScanner(WithDirectory("/your/directory/to/scan")))

multiScanner := NewMultiScanner(filesScanner, dirScanner)

FilesScanner should act as a adapter basically to give a way to iterate through fixed set of files following the same interface as the other concrete implementations of Scanner interface.

https://www.codacy.com/

https://www.appveyor.com/

We are all developers, we don't like to write documentation. But every package is as good as its documentation... According to the Go Report missing go doc is a weakness of the package.

Happy to see an improvement in this area 👍