bump to v2.2.2

- [resp for #7] `NewOverlappedRingBuffer` returns `RichOverlappedRingBuffer[T]` now, which gives some new alternatives apis of `Enqueue` so that you can collect `overwrites` and `size` from the returning data.
  > The legacy codes keep its stable with the original `Enqueue`.
  > For a normal ringbuf, non-overlapped, nothing's changed since the current capacity (size) is not a very important value for measuring.
  > If not, issue me.

Author: hedzr

.github/workflows/go.yml

@@ -39,7 +39,7 @@ jobs:
         run: |
           for GOOS in $(go tool dist list|awk -F'/' '{print $1}'|sort -u); do
             echo -e "\n\nTESTING FOR $GOOS ...\n"
-            go test -v -race ./...
+            go test -v -race -test.short ./...
           done
 
   coverage:
@@ -70,75 +70,6 @@ jobs:
           path-to-profile: profile.cov
           parallel: true
 
-  #  build:
-  #    #env:
-  #    #  GOPATH: ${{ github.workspace }}
-  #    #  GO111MODULE: off
-  #    runs-on: ubuntu-latest
-  #    steps:
-  #      - name: Install Go
-  #        uses: actions/setup-go@v2
-  #        with:
-  #          go-version: 1.18.x
-  #      - name: Checkout code
-  #        uses: actions/checkout@v2
-  #        #with:
-  #        #  path: ./src/github.com/${{ github.repository }}
-  #      - uses: actions/cache@v2
-  #        with:
-  #          path: ~/go/pkg/mod
-  #          key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
-  #          restore-keys: |
-  #            ${{ runner.os }}-go-
-  #      - name: Build
-  #        run: |
-  #          for dir in cmdr std; do
-  #            for GOOS in windows linux darwin; do
-  #              for GOARCH in amd64; do
-  #                suf=; if [[ $GOOS == "windows" ]]; then suf=".exe"; fi
-  #                go build -v -o bin/tcp-tool-$dir-$GOOS-$GOARCH$suf ./examples/$dir
-  #                gzip bin/tcp-tool-$dir-$GOOS-$GOARCH$suf
-  #              done
-  #            done
-  #          done
-  #      - name: upload artifacts
-  #        uses: actions/upload-artifact@master
-  #        if:   startsWith(github.ref, 'refs/tags/v')
-  #        with:
-  #          name: binaries
-  #          path: bin/
-  #
-  #      - name: Upload binaries to release
-  #        uses: svenstaro/upload-release-action@v2
-  #        if:   startsWith(github.ref, 'refs/tags/v')
-  #        with:
-  #          repo_token: ${{ secrets.GITHUB_TOKEN }}
-  #          file: bin/*
-  #          tag: ${{ github.ref }}
-  #          overwrite: true
-  #          file_glob: true
-  #          #body:
-  ##      - name: Create Release
-  ##        id: create_release
-  ##        uses: actions/create-release@v1
-  ##        env:
-  ##          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-  ##        with:
-  ##          tag_name: ${{ github.ref }}
-  ##          release_name: Release ${{ github.ref }}
-  ##          draft: false
-  ##          prerelease: false
-  ##      - name: Upload Release Asset
-  ##        id: upload-release-asset
-  ##        uses: actions/upload-release-asset@v1
-  ##        env:
-  ##          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-  ##        with:
-  ##          upload_url: ${{ steps.create_release.outputs.upload_url }} # This pulls from the CREATE RELEASE step above, referencing it's ID to get its outputs object, which include a `upload_url`. See this blog post for more info: https://jasonet.co/posts/new-features-of-github-actions/#passing-data-to-future-steps
-  ##          asset_path: bin/*
-  ##          asset_name: my-artifact.zip
-  ##          asset_content_type: application/zip
-
   # notifies coveralls that all test jobs are finished
   finish-coverage:
     name: Finish Coverage

.gitignore

@@ -6,6 +6,7 @@ tools/bgo/go.work
 go.work
 .local/
 lint.txt
+logs/
 
 *.code-workspace
 

README.md

@@ -18,6 +18,13 @@ MPMC (multiple producers and multiple consumers) enabled.
 
 ## History
 
+### v2.2.2
+
+- [resp for #7] `NewOverlappedRingBuffer` returns `RichOverlappedRingBuffer[T]` now, which gives some new alternatives apis of `Enqueue` so that you can collect `overwrites` and `size` from the returning data.
+  > The legacy codes keep its stable with the original `Enqueue`.
+  > For a normal ringbuf, non-overlapped, nothing's changed since the current capacity (size) is not a very important value for measuring.
+  > If not, issue me.
+
 ### v2.2.1
 
 - security updates
@@ -124,22 +131,22 @@ The following codes is for v1, needed for rewriting
 ```go
 func newRes() *Res{...}
 
-var rb fast.RingBuffer
+var rb mpmc.RingBuffer
 
 func initFunc() (err error) {
   const maxSize = 16
 
-  if rb = fast.New(uint32(maxSize)); rb == nil {
-  err = errors.New("cannot create fast.RingBuffer")
-  return
- }
+  if rb = mpmc.New(uint32(maxSize)); rb == nil {
+    err = errors.New("cannot create mpmc.RingBuffer")
+    return
+  }
 
-    // CapReal() will be available since v0.8.8, or replace it with Cap() - 1
- for i := uint32(0); i < rb.CapReal(); i++ {
-  if err = rb.Enqueue(newRes()); err != nil {
-   return
+  // CapReal() will be available since v0.8.8, or replace it with Cap() - 1
+  for i := uint32(0); i < rb.CapReal(); i++ {
+    if err = rb.Enqueue(newRes()); err != nil {
+      return
+    }
   }
- }
 }
 
 func loopFor() {
@@ -162,15 +169,15 @@ allows us to overwrite the head element if putting new element into a **full** r
 
 ```go
 func testStringRB() {
- var err error
- var rb = ringbuf.NewOverlappedRingBuffer[string](80)
- err = rb.Enqueue("abcde")
- errChk(err)
-
- var item string
- item, err = rb.Dequeue()
- errChk(err)
- fmt.Printf("dequeue ok: %v\n", item)
+  var err error
+  var rb = ringbuf.NewOverlappedRingBuffer[string](80)
+  err = rb.Enqueue("abcde")
+  errChk(err)
+
+  var item string
+  item, err = rb.Dequeue()
+  errChk(err)
+  fmt.Printf("dequeue ok: %v\n", item)
 }
 ```
 
@@ -181,7 +188,3 @@ Welcome
 ## LICENSE
 
 Apache 2.0
-
-<!--
-[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fhedzr%2Fgo-ringbuf.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fhedzr%2Fgo-ringbuf?ref=badge_large)
--->

doc.go

@@ -9,7 +9,7 @@ const (
 	// AppName const
 	AppName = "ringbuf"
 	// Version const
-	Version = "2.2.1"
+	Version = "2.2.2"
 	// VersionInt const
-	VersionInt = 0x020201
+	VersionInt = 0x020202
 )