From 2ae9c3982442215c77bbd38f2d79946ef46db7da Mon Sep 17 00:00:00 2001 From: Elton Minetto Date: Tue, 30 Jun 2020 13:37:51 -0300 Subject: [PATCH] fix: function names --- api/handler/book.go | 10 +++++----- api/middleware/metrics.go | 2 +- domain/entity/book/interface.go | 6 +++--- domain/entity/book/manager.go | 4 ++-- domain/entity/user/interface.go | 6 +++--- domain/entity/user/manager.go | 6 +++--- domain/usecase/loan/usecase.go | 26 +++++++++++++------------- domain/usecase/loan/usecase_test.go | 20 ++++++++++---------- pkg/metric/interface.go | 4 ++-- pkg/metric/prometheus.go | 12 ++++++------ pkg/password/interface.go | 4 ++-- 11 files changed, 50 insertions(+), 50 deletions(-) diff --git a/api/handler/book.go b/api/handler/book.go index afcbd9e..a3947ad 100644 --- a/api/handler/book.go +++ b/api/handler/book.go @@ -163,20 +163,20 @@ func deleteBook(manager book.Manager) http.Handler { } //MakeBookHandlers make url handlers -func MakeBookHandlers(r *mux.Router, n negroni.Negroni, service book.Manager) { +func MakeBookHandlers(r *mux.Router, n negroni.Negroni, manager book.Manager) { r.Handle("/v1/book", n.With( - negroni.Wrap(listBooks(service)), + negroni.Wrap(listBooks(manager)), )).Methods("GET", "OPTIONS").Name("listBooks") r.Handle("/v1/book", n.With( - negroni.Wrap(createBook(service)), + negroni.Wrap(createBook(manager)), )).Methods("POST", "OPTIONS").Name("createBook") r.Handle("/v1/book/{id}", n.With( - negroni.Wrap(getBook(service)), + negroni.Wrap(getBook(manager)), )).Methods("GET", "OPTIONS").Name("getBook") r.Handle("/v1/book/{id}", n.With( - negroni.Wrap(deleteBook(service)), + negroni.Wrap(deleteBook(manager)), )).Methods("DELETE", "OPTIONS").Name("deleteBook") } diff --git a/api/middleware/metrics.go b/api/middleware/metrics.go index 4ea74e6..0d60dbc 100755 --- a/api/middleware/metrics.go +++ b/api/middleware/metrics.go @@ -10,7 +10,7 @@ import ( ) //Metrics to prometheus -func Metrics(mService metric.UseCase) negroni.HandlerFunc { +func Metrics(mService metric.Service) negroni.HandlerFunc { return func(w http.ResponseWriter, r *http.Request, next http.HandlerFunc) { appMetric := metric.NewHTTP(r.URL.Path, r.Method) appMetric.Started() diff --git a/domain/entity/book/interface.go b/domain/entity/book/interface.go index 613ef6d..233e6cb 100644 --- a/domain/entity/book/interface.go +++ b/domain/entity/book/interface.go @@ -16,13 +16,13 @@ type Writer interface { Delete(id entity.ID) error } -//Repository repository interface -type Repository interface { +//repository interface +type repository interface { Reader Writer } //Manager interface type Manager interface { - Repository + repository } diff --git a/domain/entity/book/manager.go b/domain/entity/book/manager.go index e56a3af..893dc2b 100644 --- a/domain/entity/book/manager.go +++ b/domain/entity/book/manager.go @@ -8,11 +8,11 @@ import ( ) type manager struct { - repo Repository + repo repository } //NewManager create new manager -func NewManager(r Repository) *manager { +func NewManager(r repository) *manager { return &manager{ repo: r, } diff --git a/domain/entity/user/interface.go b/domain/entity/user/interface.go index 0fe933d..edecb79 100644 --- a/domain/entity/user/interface.go +++ b/domain/entity/user/interface.go @@ -16,13 +16,13 @@ type Writer interface { Delete(id entity.ID) error } -//Repository repository interface -type Repository interface { +//repository interface +type repository interface { Reader Writer } //Manager interface type Manager interface { - Repository + repository } diff --git a/domain/entity/user/manager.go b/domain/entity/user/manager.go index b6527e0..117c16e 100644 --- a/domain/entity/user/manager.go +++ b/domain/entity/user/manager.go @@ -13,12 +13,12 @@ import ( //manager interface type manager struct { - repo Repository - pwd password.UseCase + repo repository + pwd password.Service } //NewManager create new repository -func NewManager(r Repository, pwd password.UseCase) *manager { +func NewManager(r repository, pwd password.Service) *manager { return &manager{ repo: r, pwd: pwd, diff --git a/domain/usecase/loan/usecase.go b/domain/usecase/loan/usecase.go index b759586..7daa7d0 100644 --- a/domain/usecase/loan/usecase.go +++ b/domain/usecase/loan/usecase.go @@ -8,25 +8,25 @@ import ( ) type usecase struct { - uService user.Repository - bService book.Repository + uManager user.Manager + bManager book.Manager } //NewUseCase create new use case func NewUseCase(u user.Manager, b book.Manager) *usecase { return &usecase{ - uService: u, - bService: b, + uManager: u, + bManager: b, } } //Borrow borrow a book to an user func (s *usecase) Borrow(u *user.User, b *book.Book) error { - u, err := s.uService.Get(u.ID) + u, err := s.uManager.Get(u.ID) if err != nil { return err } - b, err = s.bService.Get(b.ID) + b, err = s.bManager.Get(b.ID) if err != nil { return err } @@ -39,12 +39,12 @@ func (s *usecase) Borrow(u *user.User, b *book.Book) error { } } u.Books = append(u.Books, b.ID) - err = s.uService.Update(u) + err = s.uManager.Update(u) if err != nil { return err } b.Quantity-- - err = s.bService.Update(b) + err = s.bManager.Update(b) if err != nil { return err } @@ -53,12 +53,12 @@ func (s *usecase) Borrow(u *user.User, b *book.Book) error { //Return return a book func (s *usecase) Return(b *book.Book) error { - b, err := s.bService.Get(b.ID) + b, err := s.bManager.Get(b.ID) if err != nil { return err } - all, err := s.uService.List() + all, err := s.uManager.List() if err != nil { return err } @@ -76,14 +76,14 @@ func (s *usecase) Return(b *book.Book) error { if !borrowed { return domain.ErrBookNotBorrowed } - u, err := s.uService.Get(borrowedBy) + u, err := s.uManager.Get(borrowedBy) if err != nil { return err } for i, j := range u.Books { if j == b.ID { u.Books = append(u.Books[:i], u.Books[i+1:]...) - err = s.uService.Update(u) + err = s.uManager.Update(u) if err != nil { return err } @@ -91,7 +91,7 @@ func (s *usecase) Return(b *book.Book) error { } } b.Quantity++ - err = s.bService.Update(b) + err = s.bManager.Update(b) if err != nil { return err } diff --git a/domain/usecase/loan/usecase_test.go b/domain/usecase/loan/usecase_test.go index 78f0f0e..233b02d 100644 --- a/domain/usecase/loan/usecase_test.go +++ b/domain/usecase/loan/usecase_test.go @@ -19,12 +19,12 @@ func Test_Borrow(t *testing.T) { defer controller.Finish() uMock := umock.NewMockManager(controller) bMock := bmock.NewMockManager(controller) - service := NewUseCase(uMock, bMock) + uc := NewUseCase(uMock, bMock) t.Run("user not found", func(t *testing.T) { u := user.NewFixtureUser() b := book.NewFixtureBook() uMock.EXPECT().Get(u.ID).Return(nil, domain.ErrNotFound) - err := service.Borrow(u, b) + err := uc.Borrow(u, b) assert.Equal(t, domain.ErrNotFound, err) }) t.Run("book not found", func(t *testing.T) { @@ -32,7 +32,7 @@ func Test_Borrow(t *testing.T) { b := book.NewFixtureBook() uMock.EXPECT().Get(u.ID).Return(u, nil) bMock.EXPECT().Get(b.ID).Return(nil, domain.ErrNotFound) - err := service.Borrow(u, b) + err := uc.Borrow(u, b) assert.Equal(t, domain.ErrNotFound, err) }) t.Run("not enough books to borrow", func(t *testing.T) { @@ -41,7 +41,7 @@ func Test_Borrow(t *testing.T) { b.Quantity = 0 uMock.EXPECT().Get(u.ID).Return(u, nil) bMock.EXPECT().Get(b.ID).Return(b, nil) - err := service.Borrow(u, b) + err := uc.Borrow(u, b) assert.Equal(t, domain.ErrNotEnoughBooks, err) }) t.Run("book already borrowed", func(t *testing.T) { @@ -51,7 +51,7 @@ func Test_Borrow(t *testing.T) { b.Quantity = 1 uMock.EXPECT().Get(u.ID).Return(u, nil) bMock.EXPECT().Get(b.ID).Return(b, nil) - err := service.Borrow(u, b) + err := uc.Borrow(u, b) assert.Equal(t, domain.ErrBookAlreadyBorrowed, err) }) t.Run("sucess", func(t *testing.T) { @@ -61,7 +61,7 @@ func Test_Borrow(t *testing.T) { bMock.EXPECT().Get(b.ID).Return(b, nil) uMock.EXPECT().Update(u).Return(nil) bMock.EXPECT().Update(b).Return(nil) - err := service.Borrow(u, b) + err := uc.Borrow(u, b) assert.Nil(t, err) }) } @@ -71,11 +71,11 @@ func Test_Return(t *testing.T) { defer controller.Finish() uMock := umock.NewMockManager(controller) bMock := bmock.NewMockManager(controller) - service := NewUseCase(uMock, bMock) + uc := NewUseCase(uMock, bMock) t.Run("book not found", func(t *testing.T) { b := book.NewFixtureBook() bMock.EXPECT().Get(b.ID).Return(nil, domain.ErrNotFound) - err := service.Return(b) + err := uc.Return(b) assert.Equal(t, domain.ErrNotFound, err) }) t.Run("book not borrowed", func(t *testing.T) { @@ -83,7 +83,7 @@ func Test_Return(t *testing.T) { b := book.NewFixtureBook() bMock.EXPECT().Get(b.ID).Return(b, nil) uMock.EXPECT().List().Return([]*user.User{u}, nil) - err := service.Return(b) + err := uc.Return(b) assert.Equal(t, domain.ErrBookNotBorrowed, err) }) t.Run("success", func(t *testing.T) { @@ -95,7 +95,7 @@ func Test_Return(t *testing.T) { uMock.EXPECT().List().Return([]*user.User{u}, nil) uMock.EXPECT().Update(u).Return(nil) bMock.EXPECT().Update(b).Return(nil) - err := service.Return(b) + err := uc.Return(b) assert.Nil(t, err) }) } diff --git a/pkg/metric/interface.go b/pkg/metric/interface.go index b270be3..02a5f98 100755 --- a/pkg/metric/interface.go +++ b/pkg/metric/interface.go @@ -57,8 +57,8 @@ func (h *HTTP) Finished() { h.Duration = time.Since(h.StartedAt).Seconds() } -//UseCase definition -type UseCase interface { +//Service definition +type Service interface { SaveCLI(c *CLI) error SaveHTTP(h *HTTP) } diff --git a/pkg/metric/prometheus.go b/pkg/metric/prometheus.go index 2362d73..f56f1fb 100755 --- a/pkg/metric/prometheus.go +++ b/pkg/metric/prometheus.go @@ -6,14 +6,14 @@ import ( "github.com/prometheus/client_golang/prometheus/push" ) -//Service implements UseCase interface -type Service struct { +//service implements Service interface +type service struct { pHistogram *prometheus.HistogramVec httpRequestHistogram *prometheus.HistogramVec } //NewPrometheusService create a new prometheus service -func NewPrometheusService() (*Service, error) { +func NewPrometheusService() (*service, error) { cli := prometheus.NewHistogramVec(prometheus.HistogramOpts{ Namespace: "pushgateway", Name: "cmd_duration_seconds", @@ -27,7 +27,7 @@ func NewPrometheusService() (*Service, error) { Buckets: prometheus.DefBuckets, }, []string{"handler", "method", "code"}) - s := &Service{ + s := &service{ pHistogram: cli, httpRequestHistogram: http, } @@ -43,13 +43,13 @@ func NewPrometheusService() (*Service, error) { } //SaveCLI send metrics to server -func (s *Service) SaveCLI(c *CLI) error { +func (s *service) SaveCLI(c *CLI) error { gatewayURL := config.PROMETHEUS_PUSHGATEWAY s.pHistogram.WithLabelValues(c.Name).Observe(c.Duration) return push.New(gatewayURL, "cmd_job").Collector(s.pHistogram).Push() } //SaveHTTP send metrics to server -func (s *Service) SaveHTTP(h *HTTP) { +func (s *service) SaveHTTP(h *HTTP) { s.httpRequestHistogram.WithLabelValues(h.Handler, h.Method, h.StatusCode).Observe(h.Duration) } diff --git a/pkg/password/interface.go b/pkg/password/interface.go index ba8c7e3..e1af482 100644 --- a/pkg/password/interface.go +++ b/pkg/password/interface.go @@ -1,7 +1,7 @@ package password -//UseCase interface -type UseCase interface { +//Service interface +type Service interface { Generate(raw string) (string, error) Compare(p1, p2 string) error }