Strip redundant package name from automated use case name (#6)

swaggest · Sep 8, 2021 · fe22fff · fe22fff
1 parent 5c4080c
commit fe22fff
Show file tree

Hide file tree

Showing 11 changed files with 122 additions and 25 deletions.
diff --git a/.github/workflows/cloc.yml b/.github/workflows/cloc.yml
@@ -0,0 +1,36 @@
+# This script is provided by github.com/bool64/dev.
+name: cloc
+on:
+  pull_request:
+jobs:
+  cloc:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+        with:
+          path: pr
+      - name: Checkout base code
+        uses: actions/checkout@v2
+        with:
+          ref: ${{ github.event.pull_request.base.sha }}
+          path: base
+      - name: Count Lines Of Code
+        id: loc
+        run: |
+          curl -OL https://github.com/vearutop/sccdiff/releases/download/v1.0.1/linux_amd64.tar.gz && tar xf linux_amd64.tar.gz
+          OUTPUT=$(cd pr && ../sccdiff -basedir ../base)
+          OUTPUT="${OUTPUT//'%'/'%25'}"
+          OUTPUT="${OUTPUT//$'\n'/'%0A'}"
+          OUTPUT="${OUTPUT//$'\r'/'%0D'}"
+          echo "::set-output name=diff::$OUTPUT"
+
+      - name: Comment Code Lines
+        uses: marocchino/sticky-pull-request-comment@v2
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          header: LOC
+          message: |
+            ### Lines Of Code
+
+            ${{ steps.loc.outputs.diff }}
diff --git a/.github/workflows/golangci-lint.yml b/.github/workflows/golangci-lint.yml
@@ -1,3 +1,4 @@
+# This script is provided by github.com/bool64/dev.
 name: lint
 on:
   push:
@@ -14,10 +15,10 @@ jobs:
     steps:
       - uses: actions/checkout@v2
       - name: golangci-lint
-        uses: golangci/[email protected].1
+        uses: golangci/[email protected].2
         with:
           # Required: the version of golangci-lint is required and must be specified without patch version: we always use the latest patch version.
-          version: v1.38.0
+          version: v1.41.1
 
           # Optional: working directory, useful for monorepos
           # working-directory: somedir

diff --git a/.github/workflows/gorelease.yml b/.github/workflows/gorelease.yml
@@ -0,0 +1,45 @@
+# This script is provided by github.com/bool64/dev.
+name: gorelease
+on:
+  pull_request:
+env:
+  GO111MODULE: "on"
+jobs:
+  gorelease:
+    strategy:
+      matrix:
+        go-version: [ 1.17.x ]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Install Go
+        uses: actions/setup-go@v2
+        with:
+          go-version: ${{ matrix.go-version }}
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Gorelease cache
+        uses: actions/cache@v2
+        with:
+          path: |
+            ~/go/bin/gorelease
+          key: ${{ runner.os }}-gorelease
+      - name: Gorelease
+        id: gorelease
+        run: |
+          test -e ~/go/bin/gorelease || go install golang.org/x/exp/cmd/gorelease@latest
+          OUTPUT=$(gorelease || exit 0)
+          OUTPUT="${OUTPUT//'%'/'%25'}"
+          OUTPUT="${OUTPUT//$'\n'/'%0A'}"
+          OUTPUT="${OUTPUT//$'\r'/'%0D'}"
+          echo "::set-output name=report::$OUTPUT"
+      - name: Comment Report
+        uses: marocchino/sticky-pull-request-comment@v2
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          header: gorelease
+          message: |
+            ### API Changes
+
+            <pre>
+            ${{ steps.gorelease.outputs.report }}
+            </pre>
diff --git a/.github/workflows/test-unit.yml b/.github/workflows/test-unit.yml
@@ -1,3 +1,4 @@
+# This script is provided by github.com/bool64/dev.
 name: test-unit
 on:
   push:
@@ -12,7 +13,7 @@ jobs:
   test:
     strategy:
       matrix:
-        go-version: [ 1.12.x, 1.13.x, 1.14.x, 1.15.x, 1.16.x ]
+        go-version: [ 1.13.x, 1.14.x, 1.15.x, 1.16.x, 1.17.x ]
     runs-on: ubuntu-latest
     steps:
       - name: Install Go
@@ -34,25 +35,24 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-go-cache
       - name: Restore base test coverage
-        if: matrix.go-version == '1.16.x'
+        if: matrix.go-version == '1.17.x'
         uses: actions/cache@v2
         with:
           path: |
             unit-base.txt
           # Use base sha for PR or new commit hash for master/main push in test result key.
           key: ${{ runner.os }}-unit-test-coverage-${{ (github.event.pull_request.base.sha != github.event.after) && github.event.pull_request.base.sha || github.event.after }}
       - name: Checkout base code
-        if: matrix.go-version == '1.16.x' && env.RUN_BASE_COVERAGE == 'on' && steps.benchmark-base.outputs.cache-hit != 'true' && github.event.pull_request.base.sha != ''
+        if: matrix.go-version == '1.17.x' && env.RUN_BASE_COVERAGE == 'on' && steps.benchmark-base.outputs.cache-hit != 'true' && github.event.pull_request.base.sha != ''
         uses: actions/checkout@v2
         with:
           ref: ${{ github.event.pull_request.base.sha }}
           path: __base
       - name: Run test for base code
-        if: matrix.go-version == '1.16.x' && env.RUN_BASE_COVERAGE == 'on' && steps.benchmark-base.outputs.cache-hit != 'true' && github.event.pull_request.base.sha != ''
+        if: matrix.go-version == '1.17.x' && env.RUN_BASE_COVERAGE == 'on' && steps.benchmark-base.outputs.cache-hit != 'true' && github.event.pull_request.base.sha != ''
         run: |
           cd __base
-          make test-unit
-          go tool cover -func=./unit.coverprofile | sed -e 's/.go:[0-9]*:\t/.go\t/g' | sed -e 's/\t\t*/\t/g'  > ../unit-base.txt
+          make | grep test-unit && (make test-unit && go tool cover -func=./unit.coverprofile | sed -e 's/.go:[0-9]*:\t/.go\t/g' | sed -e 's/\t\t*/\t/g'  > ../unit-base.txt) || echo "No test-unit in base"
       - name: Test
         id: test
         run: |
@@ -69,7 +69,7 @@ jobs:
         if: ${{ github.ref == 'refs/heads/master' || github.ref == 'refs/heads/main' }}
         run: cp unit.txt unit-base.txt
       - name: Comment Test Coverage
-        if: matrix.go-version == '1.16.x'
+        if: matrix.go-version == '1.17.x'
         uses: marocchino/sticky-pull-request-comment@v2
         with:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -85,7 +85,7 @@ jobs:
             </details>
 
       - name: Upload code coverage
-        if: matrix.go-version == '1.16.x'
+        if: matrix.go-version == '1.17.x'
         uses: codecov/codecov-action@v1
         with:
           file: ./unit.coverprofile

diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,5 @@
 /.idea
-/coverage.txt
-/unit.coverprofile
+/*.coverprofile
+/.vscode
+/bench-*.txt
+/vendor
diff --git a/.golangci.yml b/.golangci.yml
@@ -28,8 +28,11 @@ linters:
     - paralleltest
     - forbidigo
     - exhaustivestruct
-    - interfacer
+    - interfacer # deprecated
     - forcetypeassert
+    - scopelint # deprecated
+    - ifshort # too many false positives
+    - golint # deprecated
 
 issues:
   exclude-use-default: false

diff --git a/Makefile b/Makefile
@@ -1,4 +1,4 @@
-#GOLANGCI_LINT_VERSION := "v1.38.0" # Optional configuration to pinpoint golangci-lint version.
+#GOLANGCI_LINT_VERSION := "v1.41.1" # Optional configuration to pinpoint golangci-lint version.
 
 # The head of Makefile determines location of dev-go to include standard targets.
 GO ?= go
@@ -32,5 +32,7 @@ endif
 -include $(DEVGO_PATH)/makefiles/test-unit.mk
 -include $(DEVGO_PATH)/makefiles/reset-ci.mk
 
+# Add your custom targets here.
+
 ## Run tests
 test: test-unit
diff --git a/go.mod b/go.mod
@@ -3,6 +3,6 @@ module github.com/swaggest/usecase
 go 1.12
 
 require (
-	github.com/bool64/dev v0.1.25
+	github.com/bool64/dev v0.1.41
 	github.com/stretchr/testify v1.4.0
 )
diff --git a/go.sum b/go.sum
@@ -1,5 +1,5 @@
-github.com/bool64/dev v0.1.25 h1:iSfcaS1FP6F2TlMI1daAvqk6PYl23XDf6oZu7WRXB8Y=
-github.com/bool64/dev v0.1.25/go.mod h1:cTHiTDNc8EewrQPy3p1obNilpMpdmlUesDkFTF2zRWU=
+github.com/bool64/dev v0.1.41 h1:L554LCQZc3d7mtcdPUgDbSrCVbr48/30zgu0VuC/FTA=
+github.com/bool64/dev v0.1.41/go.mod h1:cTHiTDNc8EewrQPy3p1obNilpMpdmlUesDkFTF2zRWU=
 github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=

diff --git a/interactor.go b/interactor.go
@@ -100,6 +100,7 @@ type Info struct {
 var (
 	_ HasTags           = Info{}
 	_ HasTitle          = Info{}
+	_ HasName           = Info{}
 	_ HasDescription    = Info{}
 	_ HasIsDeprecated   = Info{}
 	_ HasExpectedErrors = Info{}
@@ -184,6 +185,10 @@ func NewIOI(input, output interface{}, interact Interact) IOInteractor {
 
 	u.name, u.title = callerFunc()
 
+	u.name = strings.TrimPrefix(u.name, "internal/")
+	u.name = strings.TrimPrefix(u.name, "usecase.")
+	u.name = strings.TrimPrefix(u.name, "./main.")
+
 	return u
 }
 

diff --git a/wrap.go b/wrap.go
@@ -14,15 +14,18 @@ type Middleware interface {
 type ErrorCatcher func(ctx context.Context, input interface{}, err error)
 
 // Wrap implements Middleware.
-func (e ErrorCatcher) Wrap(interactor Interactor) Interactor {
-	return Interact(func(ctx context.Context, input, output interface{}) error {
-		err := interactor.Interact(ctx, input, output)
-		if err != nil {
-			e(ctx, input, err)
-		}
+func (e ErrorCatcher) Wrap(u Interactor) Interactor {
+	return &wrappedInteractor{
+		Interactor: Interact(func(ctx context.Context, input, output interface{}) error {
+			err := u.Interact(ctx, input, output)
+			if err != nil {
+				e(ctx, input, err)
+			}
 
-		return err
-	})
+			return err
+		}),
+		wrapped: u,
+	}
 }
 
 // MiddlewareFunc makes Middleware from function.