Initial release

[bkrukowski]

Summary by Sourcery

Introduce the 'slice' package, providing a wrapper for slices with intuitive operations and comprehensive test coverage. Set up CI workflows for testing and linting.

New Features:

• Introduce a new package 'slice' that provides a wrapper for slices, allowing intuitive operations like push, pop, shift, unshift, delete, insert, clone, and more.

CI:

• Add a GitHub Actions workflow for running tests across multiple Go versions (1.18 to 1.23) and reporting test coverage.
• Add a GitHub Actions workflow for running golangci-lint on push and pull request events.

Tests:

• Add comprehensive tests for the 'slice' package, covering various operations like push, pop, shift, unshift, delete, insert, clone, and shuffle.
• Introduce benchmark tests for 'Unshift' and 'Filter' operations in the 'slice' package.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request implements a new Go package called "slice" that provides a wrapper for slices with various utility methods. The package includes a main slice.go file with the core functionality, test files, benchmarks, CI configurations, and supporting files for different Go versions.

Architecture diagram for CI/CD pipeline

graph TD;
    A[Push to main branch] -->|Triggers| B[GitHub Actions]
    B --> C[Build Job]
    C -->|Runs on| D[Ubuntu Latest]
    C --> E[Set up Go 1.x]
    C --> F[Check out code]
    C --> G[Test]
    C --> H[Test coverage]
    C --> I[Send coverage]
    B --> J[Lint Job]
    J -->|Runs on| D
    J --> E
    J --> F
    J --> K[Golangci-lint]

Loading

Class diagram for the Slice package

classDiagram
    class Slice {
        +FromRaw(T[] in) Slice[T]
        +Raw() T[]
        +Empty() bool
        +Shift() (T, bool)
        +Unshift(T... v)
        +Pop() (T, bool)
        +Push(T... v)
        +DeleteOne(int index) bool
        +Delete(int index, int length) bool
        +Insert(int index, T... v) bool
        +Clone() Slice[T]
        +Cap() int
        +Len() int
        +ExtendCap(int i)
        +Filter(func(int, T) bool)
        +Get(int index) (T, bool)
        +Reverse()
        +Sort(func(T, T) int)
        +Shuffle(func(int) int)
    }
    Slice <|-- FromRaw
    Slice <|-- Raw
    Slice <|-- Empty
    Slice <|-- Shift
    Slice <|-- Unshift
    Slice <|-- Pop
    Slice <|-- Push
    Slice <|-- DeleteOne
    Slice <|-- Delete
    Slice <|-- Insert
    Slice <|-- Clone
    Slice <|-- Cap
    Slice <|-- Len
    Slice <|-- ExtendCap
    Slice <|-- Filter
    Slice <|-- Get
    Slice <|-- Reverse
    Slice <|-- Sort
    Slice <|-- Shuffle
    note for Slice "A wrapper for slices with utility methods"

Loading

File-Level Changes

Change	Details	Files
Implement the main Slice type and its methods	Define the Slice type as a generic wrapper for any slice Implement methods like Push, Pop, Shift, Unshift, Delete, Insert, Clone, Filter, etc. Add utility methods like Empty, Cap, Len, ExtendCap, Get, Reverse, Sort, and Shuffle	slice.go
Create comprehensive test suite	Implement example-based tests in example_test.go Add unit tests in slice_test.go Include benchmarks in benchmark_test.go	example_test.go slice_test.go benchmark_test.go
Set up CI/CD pipeline	Configure GitHub Actions for running tests across multiple Go versions Set up golangci-lint for code quality checks	.github/workflows/tests.yml .github/workflows/golangci-lint.yml
Ensure compatibility with different Go versions	Implement version-specific sorting logic Add a polyfill for the 'clear' function	slice_sort_old.go slice_sort_1.21.go clear_polyfill.go
Set up project configuration	Initialize go.mod file Create Makefile for common development tasks	go.mod Makefile

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time. You can also use
  this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @bkrukowski - I've reviewed your changes - here's some feedback:

Overall Comments:

• Excellent initial release with comprehensive features, thorough testing, and good documentation. The use of generics and attention to compatibility across Go versions is commendable.

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟡 Complexity: 1 issue found
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}