diff --git a/README.md b/README.md index 050b9c9..a4e025c 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ import ( "strings" "github.com/clipperhouse/jargon" - "github.com/clipperhouse/jargon/stackoverflow" + "github.com/clipperhouse/jargon/filters/stackoverflow" ) text := `Let’s talk about Ruby on Rails and ASPNET MVC.` @@ -72,17 +72,17 @@ if err := stream.Err(); err != nil { Canonical terms (lemmas) are looked up in token filters. Several are available: -[Stack Overflow technology tags](https://pkg.go.dev/github.com/clipperhouse/jargon/stackoverflow) +[Stack Overflow technology tags](https://pkg.go.dev/github.com/clipperhouse/jargon/filters/stackoverflow) - `Ruby on Rails → ruby-on-rails` - `ObjC → objective-c` -[Contractions](https://pkg.go.dev/github.com/clipperhouse/jargon/contractions) +[Contractions](https://pkg.go.dev/github.com/clipperhouse/jargon/filters/contractions) - `Couldn’t → Could not` -[ASCII fold](https://pkg.go.dev/github.com/clipperhouse/jargon/ascii) +[ASCII fold](https://pkg.go.dev/github.com/clipperhouse/jargon/filters/ascii) - `café → cafe` -[Stem](https://pkg.go.dev/github.com/clipperhouse/jargon/stemmer) +[Stem](https://pkg.go.dev/github.com/clipperhouse/jargon/filters/stemmer) - `Manager|management|manages → manag` To implement your own, see the [Filter type](https://godoc.org/github.com/clipperhouse/jargon/#Filter). diff --git a/cmd/jargon/main.go b/cmd/jargon/main.go index ed155d1..b8fc816 100644 --- a/cmd/jargon/main.go +++ b/cmd/jargon/main.go @@ -9,10 +9,10 @@ import ( "strings" "github.com/clipperhouse/jargon" - "github.com/clipperhouse/jargon/ascii" - "github.com/clipperhouse/jargon/contractions" - "github.com/clipperhouse/jargon/stackoverflow" - "github.com/clipperhouse/jargon/stemmer" + "github.com/clipperhouse/jargon/filters/ascii" + "github.com/clipperhouse/jargon/filters/contractions" + "github.com/clipperhouse/jargon/filters/stackoverflow" + "github.com/clipperhouse/jargon/filters/stemmer" "github.com/spf13/afero" ) @@ -136,7 +136,7 @@ func setInput(c *config, mode os.FileMode, filein string) error { c.Filein = file } - c.Pipedin = (mode & os.ModeCharDevice) == 0 // https://stackoverflow.com/a/43947435/70613 + c.Pipedin = (mode & os.ModeCharDevice) == 0 // https://filters/stackoverflow.com/a/43947435/70613 // If no input, display usage input := c.Pipedin || c.Filein != nil diff --git a/cmd/jargon/main_test.go b/cmd/jargon/main_test.go index 0577001..077bf4c 100644 --- a/cmd/jargon/main_test.go +++ b/cmd/jargon/main_test.go @@ -7,10 +7,10 @@ import ( "testing" "github.com/clipperhouse/jargon" - "github.com/clipperhouse/jargon/ascii" - "github.com/clipperhouse/jargon/contractions" - "github.com/clipperhouse/jargon/stackoverflow" - "github.com/clipperhouse/jargon/stemmer" + "github.com/clipperhouse/jargon/filters/ascii" + "github.com/clipperhouse/jargon/filters/contractions" + "github.com/clipperhouse/jargon/filters/stackoverflow" + "github.com/clipperhouse/jargon/filters/stemmer" "github.com/spf13/afero" ) @@ -172,7 +172,7 @@ func TestFilters(t *testing.T) { } if len(c.Filters) == len(test.filters) { for i := range test.filters { - // https://stackoverflow.com/a/9644797 + // https://filters/stackoverflow.com/a/9644797 // This is not a good test, but perhaps better than nothing // E.g. the pointers to different stemmers are all the same expected := reflect.ValueOf(test.filters[i]).Pointer() diff --git a/example_test.go b/example_test.go index b691b35..93c5c2f 100644 --- a/example_test.go +++ b/example_test.go @@ -6,7 +6,7 @@ import ( "strings" "github.com/clipperhouse/jargon" - "github.com/clipperhouse/jargon/stackoverflow" + "github.com/clipperhouse/jargon/filters/stackoverflow" ) func ExampleTokenize() { diff --git a/ascii/ASCIIFoldingFilter.java b/filters/ascii/ASCIIFoldingFilter.java similarity index 100% rename from ascii/ASCIIFoldingFilter.java rename to filters/ascii/ASCIIFoldingFilter.java diff --git a/ascii/TestASCIIFoldingFilter.java b/filters/ascii/TestASCIIFoldingFilter.java similarity index 100% rename from ascii/TestASCIIFoldingFilter.java rename to filters/ascii/TestASCIIFoldingFilter.java diff --git a/ascii/filter.go b/filters/ascii/filter.go similarity index 100% rename from ascii/filter.go rename to filters/ascii/filter.go diff --git a/ascii/fold.go b/filters/ascii/fold.go similarity index 100% rename from ascii/fold.go rename to filters/ascii/fold.go diff --git a/ascii/fold_test.go b/filters/ascii/fold_test.go similarity index 100% rename from ascii/fold_test.go rename to filters/ascii/fold_test.go diff --git a/contractions/README.md b/filters/contractions/README.md similarity index 79% rename from contractions/README.md rename to filters/contractions/README.md index 7914e6e..7484246 100644 --- a/contractions/README.md +++ b/filters/contractions/README.md @@ -27,7 +27,7 @@ import ( "fmt" "github.com/clipperhouse/jargon" - "github.com/clipperhouse/jargon/contractions" + "github.com/clipperhouse/jargon/filters/contractions" ) var lem = jargon.NewLemmatizer(contractions.Expander) @@ -52,6 +52,6 @@ func main() { ### Implementation -The [Lookup method](https://github.com/clipperhouse/jargon/blob/master/contractions/filter.go#L7) satisfies the [jargon.TokenFilter interface](https://github.com/clipperhouse/jargon/blob/master/filter.go). +The [Lookup method](https://github.com/clipperhouse/jargon/blob/master/filters/contractions/filter.go#L7) satisfies the [jargon.TokenFilter interface](https://github.com/clipperhouse/jargon/blob/master/filter.go). -Here is the [base list of contractions](https://github.com/clipperhouse/jargon/blob/master/contractions/generator.go#L101). Variations (case, apostrophes) are code-generated. +Here is the [base list of contractions](https://github.com/clipperhouse/jargon/blob/master/filters/contractions/generator.go#L101). Variations (case, apostrophes) are code-generated. diff --git a/contractions/filter.go b/filters/contractions/filter.go similarity index 100% rename from contractions/filter.go rename to filters/contractions/filter.go diff --git a/contractions/filter_test.go b/filters/contractions/filter_test.go similarity index 89% rename from contractions/filter_test.go rename to filters/contractions/filter_test.go index 9b1f99f..eaf453c 100644 --- a/contractions/filter_test.go +++ b/filters/contractions/filter_test.go @@ -4,7 +4,7 @@ import ( "testing" "github.com/clipperhouse/jargon" - "github.com/clipperhouse/jargon/contractions" + "github.com/clipperhouse/jargon/filters/contractions" ) func TestContractions(t *testing.T) { diff --git a/contractions/generate/main.go b/filters/contractions/generate/main.go similarity index 100% rename from contractions/generate/main.go rename to filters/contractions/generate/main.go diff --git a/contractions/generate/main_test.go b/filters/contractions/generate/main_test.go similarity index 100% rename from contractions/generate/main_test.go rename to filters/contractions/generate/main_test.go diff --git a/contractions/generated.go b/filters/contractions/generated.go similarity index 100% rename from contractions/generated.go rename to filters/contractions/generated.go diff --git a/nba/filter.go b/filters/nba/filter.go similarity index 86% rename from nba/filter.go rename to filters/nba/filter.go index cd9dd47..df77194 100644 --- a/nba/filter.go +++ b/filters/nba/filter.go @@ -1,6 +1,6 @@ package nba -import "github.com/clipperhouse/jargon/synonyms" +import "github.com/clipperhouse/jargon/filters/synonyms" //go:generate go run generate/main.go diff --git a/nba/filter_test.go b/filters/nba/filter_test.go similarity index 100% rename from nba/filter_test.go rename to filters/nba/filter_test.go diff --git a/nba/generate/main.go b/filters/nba/generate/main.go similarity index 98% rename from nba/generate/main.go rename to filters/nba/generate/main.go index 4735c2e..eae2f00 100644 --- a/nba/generate/main.go +++ b/filters/nba/generate/main.go @@ -10,7 +10,7 @@ import ( "text/template" "github.com/PuerkitoBio/goquery" - "github.com/clipperhouse/jargon/ascii" + "github.com/clipperhouse/jargon/filters/ascii" ) func main() { diff --git a/nba/generated.go b/filters/nba/generated.go similarity index 100% rename from nba/generated.go rename to filters/nba/generated.go diff --git a/sigil/filter.go b/filters/sigil/filter.go similarity index 100% rename from sigil/filter.go rename to filters/sigil/filter.go diff --git a/sigil/filter_test.go b/filters/sigil/filter_test.go similarity index 100% rename from sigil/filter_test.go rename to filters/sigil/filter_test.go diff --git a/stackoverflow/filter.go b/filters/stackoverflow/filter.go similarity index 92% rename from stackoverflow/filter.go rename to filters/stackoverflow/filter.go index 19aeb9f..8ad4e01 100644 --- a/stackoverflow/filter.go +++ b/filters/stackoverflow/filter.go @@ -2,7 +2,7 @@ package stackoverflow import ( - "github.com/clipperhouse/jargon/synonyms" + "github.com/clipperhouse/jargon/filters/synonyms" ) //go:generate go run generate/main.go diff --git a/stackoverflow/filter_test.go b/filters/stackoverflow/filter_test.go similarity index 100% rename from stackoverflow/filter_test.go rename to filters/stackoverflow/filter_test.go diff --git a/stackoverflow/generate/main.go b/filters/stackoverflow/generate/main.go similarity index 100% rename from stackoverflow/generate/main.go rename to filters/stackoverflow/generate/main.go diff --git a/stackoverflow/generated.go b/filters/stackoverflow/generated.go similarity index 100% rename from stackoverflow/generated.go rename to filters/stackoverflow/generated.go diff --git a/stemmer/filter.go b/filters/stemmer/filter.go similarity index 100% rename from stemmer/filter.go rename to filters/stemmer/filter.go diff --git a/stemmer/filter_test.go b/filters/stemmer/filter_test.go similarity index 100% rename from stemmer/filter_test.go rename to filters/stemmer/filter_test.go diff --git a/stopwords/filter.go b/filters/stopwords/filter.go similarity index 100% rename from stopwords/filter.go rename to filters/stopwords/filter.go diff --git a/stopwords/filter_test.go b/filters/stopwords/filter_test.go similarity index 95% rename from stopwords/filter_test.go rename to filters/stopwords/filter_test.go index a54e285..71eb55f 100644 --- a/stopwords/filter_test.go +++ b/filters/stopwords/filter_test.go @@ -4,7 +4,7 @@ import ( "testing" "github.com/clipperhouse/jargon" - "github.com/clipperhouse/jargon/stopwords" + "github.com/clipperhouse/jargon/filters/stopwords" ) func TestCaseSensitive(t *testing.T) { diff --git a/synonyms/filter.go b/filters/synonyms/filter.go similarity index 99% rename from synonyms/filter.go rename to filters/synonyms/filter.go index bde9b35..f7f486e 100644 --- a/synonyms/filter.go +++ b/filters/synonyms/filter.go @@ -7,7 +7,7 @@ import ( "sync" "github.com/clipperhouse/jargon" - "github.com/clipperhouse/jargon/synonyms/trie" + "github.com/clipperhouse/jargon/filters/synonyms/trie" ) // Filter is the data structure of a synonyms filter. Use NewFilter to create. diff --git a/synonyms/filter_test.go b/filters/synonyms/filter_test.go similarity index 100% rename from synonyms/filter_test.go rename to filters/synonyms/filter_test.go diff --git a/synonyms/trie/trie.go b/filters/synonyms/trie/trie.go similarity index 100% rename from synonyms/trie/trie.go rename to filters/synonyms/trie/trie.go diff --git a/twitter/filter.go b/filters/twitter/filter.go similarity index 96% rename from twitter/filter.go rename to filters/twitter/filter.go index 72ca5d4..037eeff 100644 --- a/twitter/filter.go +++ b/filters/twitter/filter.go @@ -5,7 +5,7 @@ import ( "unicode" "unicode/utf8" - "github.com/clipperhouse/jargon/sigil" + "github.com/clipperhouse/jargon/filters/sigil" ) // Handles will identify Twitter-style handles, combining the @ and name into a single token diff --git a/twitter/filter_test.go b/filters/twitter/filter_test.go similarity index 100% rename from twitter/filter_test.go rename to filters/twitter/filter_test.go diff --git a/tokenstream_test.go b/tokenstream_test.go index 3852f28..555839d 100644 --- a/tokenstream_test.go +++ b/tokenstream_test.go @@ -6,7 +6,7 @@ import ( "strings" "github.com/clipperhouse/jargon" - "github.com/clipperhouse/jargon/stackoverflow" + "github.com/clipperhouse/jargon/filters/stackoverflow" ) func ExampleTokenStream_Scan() { diff --git a/web/main.go b/web/main.go index d9eb12c..ce8e7d9 100644 --- a/web/main.go +++ b/web/main.go @@ -10,7 +10,7 @@ import ( "strings" "github.com/clipperhouse/jargon" - "github.com/clipperhouse/jargon/stackoverflow" + "github.com/clipperhouse/jargon/filters/stackoverflow" ) func main() {