Move the LinkExtractor interface to the models package

thewizardplusplus · thewizardplusplus · commit e5dc2e617605 · 2021-02-16T23:00:00.000+03:00
diff --git a/crawl.go b/crawl.go
@@ -9,13 +9,6 @@ import (
 	syncutils "github.com/thewizardplusplus/go-sync-utils"
 )
 
-//go:generate mockery --name=LinkExtractor --inpackage --case=underscore --testonly
-
-// LinkExtractor ...
-type LinkExtractor interface {
-	ExtractLinks(ctx context.Context, threadID int, link string) ([]string, error)
-}
-
 //go:generate mockery --name=LinkChecker --inpackage --case=underscore --testonly
 
 // LinkChecker ...
@@ -32,7 +25,7 @@ type LinkHandler interface {
 
 // CrawlDependencies ...
 type CrawlDependencies struct {
-	LinkExtractor LinkExtractor
+	LinkExtractor models.LinkExtractor
 	LinkChecker   LinkChecker
 	LinkHandler   LinkHandler
 	Logger        log.Logger
diff --git a/crawl_test.go b/crawl_test.go
@@ -29,7 +29,7 @@ func TestCrawl(test *testing.T) {
 				bufferSize:        1000,
 				links:             []string{"http://example.com/"},
 				dependencies: CrawlDependencies{
-					LinkExtractor: func() LinkExtractor {
+					LinkExtractor: func() models.LinkExtractor {
 						threadIDChecker := mock.MatchedBy(func(threadID int) bool {
 							return threadID >= 0 && threadID < 10
 						})
@@ -108,7 +108,7 @@ func TestCrawl(test *testing.T) {
 				bufferSize:        0,
 				links:             []string{"http://example.com/"},
 				dependencies: CrawlDependencies{
-					LinkExtractor: func() LinkExtractor {
+					LinkExtractor: func() models.LinkExtractor {
 						threadIDChecker := mock.MatchedBy(func(threadID int) bool {
 							return threadID >= 0 && threadID < 10
 						})
diff --git a/extractors/delayed_extractor.go b/extractors/delayed_extractor.go
@@ -5,22 +5,22 @@ import (
 	"sync"
 	"time"
 
-	crawler "github.com/thewizardplusplus/go-crawler"
+	"github.com/thewizardplusplus/go-crawler/models"
 )
 
 // DelayingExtractor ...
 type DelayingExtractor struct {
 	timestamps    sync.Map // map[threadID]time.Time
 	minimalDelay  time.Duration
 	sleeper       SleepHandler
-	linkExtractor crawler.LinkExtractor
+	linkExtractor models.LinkExtractor
 }
 
 // NewDelayingExtractor ...
 func NewDelayingExtractor(
 	minimalDelay time.Duration,
 	sleeper SleepHandler,
-	linkExtractor crawler.LinkExtractor,
+	linkExtractor models.LinkExtractor,
 ) *DelayingExtractor {
 	return &DelayingExtractor{
 		minimalDelay:  minimalDelay,
diff --git a/extractors/delayed_extractor_test.go b/extractors/delayed_extractor_test.go
@@ -10,7 +10,7 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/mock"
 	"github.com/stretchr/testify/require"
-	crawler "github.com/thewizardplusplus/go-crawler"
+	"github.com/thewizardplusplus/go-crawler/models"
 )
 
 func TestNewDelayingExtractor(test *testing.T) {
@@ -32,7 +32,7 @@ func TestDelayingExtractor_ExtractLinks(test *testing.T) {
 	type fields struct {
 		minimalDelay  time.Duration
 		sleeper       Sleeper
-		linkExtractor crawler.LinkExtractor
+		linkExtractor models.LinkExtractor
 	}
 	type args struct {
 		ctx      context.Context
@@ -53,7 +53,7 @@ func TestDelayingExtractor_ExtractLinks(test *testing.T) {
 			fields: fields{
 				minimalDelay: 100 * time.Millisecond,
 				sleeper:      new(MockSleeper),
-				linkExtractor: func() LinkExtractor {
+				linkExtractor: func() models.LinkExtractor {
 					extractor := new(MockLinkExtractor)
 					extractor.
 						On("ExtractLinks", context.Background(), 23, "http://example.com/").
@@ -85,7 +85,7 @@ func TestDelayingExtractor_ExtractLinks(test *testing.T) {
 
 					return sleeper
 				}(),
-				linkExtractor: func() LinkExtractor {
+				linkExtractor: func() models.LinkExtractor {
 					extractor := new(MockLinkExtractor)
 					extractor.
 						On("ExtractLinks", context.Background(), 23, "http://example.com/").
@@ -110,7 +110,7 @@ func TestDelayingExtractor_ExtractLinks(test *testing.T) {
 			fields: fields{
 				minimalDelay: 100 * time.Millisecond,
 				sleeper:      new(MockSleeper),
-				linkExtractor: func() LinkExtractor {
+				linkExtractor: func() models.LinkExtractor {
 					extractor := new(MockLinkExtractor)
 					extractor.
 						On("ExtractLinks", context.Background(), 23, "http://example.com/").
diff --git a/extractors/mock_gen.go b/extractors/mock_gen.go
@@ -4,7 +4,7 @@ import (
 	"time"
 
 	"github.com/go-log/log"
-	crawler "github.com/thewizardplusplus/go-crawler"
+	"github.com/thewizardplusplus/go-crawler/models"
 	httputils "github.com/thewizardplusplus/go-http-utils"
 )
 
@@ -25,7 +25,7 @@ type HTTPClient interface {
 // It's used only for mock generating.
 //
 type LinkExtractor interface {
-	crawler.LinkExtractor
+	models.LinkExtractor
 }
 
 //go:generate mockery --name=Logger --inpackage --case=underscore --testonly
diff --git a/extractors/repeating_extractor.go b/extractors/repeating_extractor.go
@@ -5,15 +5,15 @@ import (
 	"time"
 
 	"github.com/go-log/log"
-	crawler "github.com/thewizardplusplus/go-crawler"
+	"github.com/thewizardplusplus/go-crawler/models"
 )
 
 // SleepHandler ...
 type SleepHandler func(duration time.Duration)
 
 // RepeatingExtractor ...
 type RepeatingExtractor struct {
-	LinkExtractor crawler.LinkExtractor
+	LinkExtractor models.LinkExtractor
 	RepeatCount   int
 	RepeatDelay   time.Duration
 	Logger        log.Logger
diff --git a/extractors/repeating_extractor_test.go b/extractors/repeating_extractor_test.go
@@ -9,12 +9,12 @@ import (
 	"github.com/go-log/log"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/mock"
-	crawler "github.com/thewizardplusplus/go-crawler"
+	"github.com/thewizardplusplus/go-crawler/models"
 )
 
 func TestRepeatingExtractor_ExtractLinks(test *testing.T) {
 	type fields struct {
-		LinkExtractor crawler.LinkExtractor
+		LinkExtractor models.LinkExtractor
 		RepeatCount   int
 		RepeatDelay   time.Duration
 		Logger        log.Logger
@@ -36,7 +36,7 @@ func TestRepeatingExtractor_ExtractLinks(test *testing.T) {
 		{
 			name: "success on the first repeat",
 			fields: fields{
-				LinkExtractor: func() LinkExtractor {
+				LinkExtractor: func() models.LinkExtractor {
 					extractor := new(MockLinkExtractor)
 					extractor.
 						On("ExtractLinks", context.Background(), 23, "http://example.com/").
@@ -61,7 +61,7 @@ func TestRepeatingExtractor_ExtractLinks(test *testing.T) {
 		{
 			name: "success on the last repeat",
 			fields: fields{
-				LinkExtractor: func() LinkExtractor {
+				LinkExtractor: func() models.LinkExtractor {
 					var repeat int
 
 					extractor := new(MockLinkExtractor)
@@ -125,7 +125,7 @@ func TestRepeatingExtractor_ExtractLinks(test *testing.T) {
 		{
 			name: "error",
 			fields: fields{
-				LinkExtractor: func() LinkExtractor {
+				LinkExtractor: func() models.LinkExtractor {
 					extractor := new(MockLinkExtractor)
 					extractor.
 						On("ExtractLinks", context.Background(), 23, "http://example.com/").
diff --git a/handle_links_test.go b/handle_links_test.go
@@ -37,7 +37,7 @@ func TestHandleLinksConcurrently(test *testing.T) {
 				}(),
 				dependencies: HandleLinkDependencies{
 					CrawlDependencies: CrawlDependencies{
-						LinkExtractor: func() LinkExtractor {
+						LinkExtractor: func() models.LinkExtractor {
 							threadIDChecker := mock.MatchedBy(func(threadID int) bool {
 								return threadID >= 0 && threadID < 10
 							})
@@ -170,7 +170,7 @@ func TestHandleLinks(test *testing.T) {
 				}(),
 				dependencies: HandleLinkDependencies{
 					CrawlDependencies: CrawlDependencies{
-						LinkExtractor: func() LinkExtractor {
+						LinkExtractor: func() models.LinkExtractor {
 							extractor := new(MockLinkExtractor)
 							extractor.
 								On("ExtractLinks", context.Background(), 23, "http://example.com/").
@@ -281,7 +281,7 @@ func TestHandleLink(test *testing.T) {
 				link:     "http://example.com/",
 				dependencies: HandleLinkDependencies{
 					CrawlDependencies: CrawlDependencies{
-						LinkExtractor: func() LinkExtractor {
+						LinkExtractor: func() models.LinkExtractor {
 							extractor := new(MockLinkExtractor)
 							extractor.
 								On("ExtractLinks", context.Background(), 23, "http://example.com/").
@@ -344,7 +344,7 @@ func TestHandleLink(test *testing.T) {
 				link:     "http://example.com/",
 				dependencies: HandleLinkDependencies{
 					CrawlDependencies: CrawlDependencies{
-						LinkExtractor: func() LinkExtractor {
+						LinkExtractor: func() models.LinkExtractor {
 							extractor := new(MockLinkExtractor)
 							extractor.
 								On("ExtractLinks", context.Background(), 23, "http://example.com/").
@@ -407,7 +407,7 @@ func TestHandleLink(test *testing.T) {
 				link:     "http://example.com/",
 				dependencies: HandleLinkDependencies{
 					CrawlDependencies: CrawlDependencies{
-						LinkExtractor: func() LinkExtractor {
+						LinkExtractor: func() models.LinkExtractor {
 							extractor := new(MockLinkExtractor)
 							extractor.
 								On("ExtractLinks", context.Background(), 23, "http://example.com/").
diff --git a/mock_gen.go b/mock_gen.go
@@ -2,9 +2,20 @@ package crawler
 
 import (
 	"github.com/go-log/log"
+	"github.com/thewizardplusplus/go-crawler/models"
 	syncutils "github.com/thewizardplusplus/go-sync-utils"
 )
 
+//go:generate mockery --name=LinkExtractor --inpackage --case=underscore --testonly
+
+// LinkExtractor ...
+//
+// It's used only for mock generating.
+//
+type LinkExtractor interface {
+	models.LinkExtractor
+}
+
 //go:generate mockery --name=Waiter --inpackage --case=underscore --testonly
 
 // Waiter ...
diff --git a/models/models.go b/models/models.go
@@ -1,7 +1,16 @@
 package models
 
+import (
+	"context"
+)
+
 // SourcedLink ...
 type SourcedLink struct {
 	SourceLink string
 	Link       string
 }
+
+// LinkExtractor ...
+type LinkExtractor interface {
+	ExtractLinks(ctx context.Context, threadID int, link string) ([]string, error)
+}

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@ import (`
`4`	`4`	`"time"`
`5`	`5`
`6`	`6`	`"github.com/go-log/log"`
`7`		`- crawler "github.com/thewizardplusplus/go-crawler"`
	`7`	`+ "github.com/thewizardplusplus/go-crawler/models"`
`8`	`8`	`httputils "github.com/thewizardplusplus/go-http-utils"`
`9`	`9`	`)`
`10`	`10`
`@@ -25,7 +25,7 @@ type HTTPClient interface {`
`25`	`25`	`// It's used only for mock generating.`
`26`	`26`	`//`
`27`	`27`	`type LinkExtractor interface {`
`28`		`- crawler.LinkExtractor`
	`28`	`+ models.LinkExtractor`
`29`	`29`	`}`
`30`	`30`
`31`	`31`	`//go:generate mockery --name=Logger --inpackage --case=underscore --testonly`