MrZ's go-cache

:bookmark_tabs: Cache dependency management on-top of the famous redigo package

Description

Features: - Cache Dependencies Between Keys (toggle functionality) - Connect via URL - Better Pool Management & Creation - Register Scripts - Helper Methods (Get, Set, HashGet, etc) - Basic Lock/Release (from bgentry lock.go)

Programming language: Go

License: Apache License 2.0

Tags: Go Tools     Cache     Redis     Go     Golang     Dependencies     Lock     Redigo    

Latest version: v0.1.7

README

go-cache

Simple cache dependency system on-top of the famous redigo package

Table of Contents

• Installation
• Documentation
• Examples & Tests
• Benchmarks
• Code Standards
• Usage
• Maintainers
• Contributing
• License

Installation

go-cache requires a supported release of Go and redis. ```shell script go get -u github.com/mrz1836/go-cache

<br/>

## Documentation
View the generated [documentation](https://pkg.go.dev/github.com/mrz1836/go-cache?tab=doc)

[![GoDoc](https://godoc.org/github.com/mrz1836/go-cache?status.svg&style=flat)](https://pkg.go.dev/github.com/mrz1836/go-cache?tab=doc)

### Features
- Better Pool Management & Creation
- Get Connection with Context
- Cache Dependencies Between Keys (toggle functionality)
- [NewRelic](https://newrelic.com) automatic segment support
- Test Coverage (mock redis & real redis)
- Register Scripts
- Helper Methods (Get, Set, HashGet, etc)
- Basic Lock/Release (from [bgentry lock.go](https://gist.github.com/bgentry/6105288))
- Connect via URL (deprecated)

<details>
<summary><strong><code>Library Deployment</code></strong></summary>
<br/>

[goreleaser](https://github.com/goreleaser/goreleaser) for easy binary or library deployment to Github and can be installed via: `brew install goreleaser`.

The [.goreleaser.yml](.goreleaser.yml) file is used to configure [goreleaser](https://github.com/goreleaser/goreleaser).

Use `make release-snap` to create a snapshot version of the release, and finally `make release` to ship to production.
</details>

<details>
<summary><strong><code>Makefile Commands</code></strong></summary>
<br/>

View all `makefile` commands
```shell script
make help

List of all current commands:

all                  Runs multiple commands
clean                Remove previous builds and any test cache data
clean-mods           Remove all the Go mod cache
coverage             Shows the test coverage
diff                 Show the git diff
generate             Runs the go generate command in the base of the repo
godocs               Sync the latest tag with GoDocs
help                 Show this help message
install              Install the application
install-go           Install the application (Using Native Go)
lint                 Run the golangci-lint application (install if not found)
release              Full production release (creates release in Github)
release              Runs common.release then runs godocs
release-snap         Test the full release (build binaries)
release-test         Full production test release (everything except deploy)
replace-version      Replaces the version in HTML/JS (pre-deploy)
tag                  Generate a new tag and push (tag version=0.0.0)
tag-remove           Remove a tag if found (tag-remove version=0.0.0)
tag-update           Update an existing tag to current commit (tag-update version=0.0.0)
test                 Runs lint and ALL tests
test-ci              Runs all tests via CI (exports coverage)
test-ci-no-race      Runs all tests via CI (no race) (exports coverage)
test-ci-short        Runs unit tests via CI (exports coverage)
test-no-lint         Runs just tests
test-short           Runs vet, lint and tests (excludes integration tests)
test-unit            Runs tests and outputs coverage
uninstall            Uninstall the application (and remove files)
update-linter        Update the golangci-lint package (macOS only)
vet                  Run the Go vet application

Package Dependencies

• Gary Burd's Redigo
• Rafael Justo's redigomock
• NewRelic's go-agent

Examples & Tests

All unit tests and [examples](examples) run via Github Actions and uses Go version 1.15.x. View the [configuration file](.github/workflows/run-tests.yml).

Run all tests (including integration tests) ```shell script make test

Run tests (excluding integration tests)
```shell script
make test-short

Benchmarks

Run the Go benchmarks: ```shell script make bench

<br/>

## Code Standards
Read more about this Go project's [code standards](CODE_STANDARDS.md).

<br/>

## Usage
View the [examples](examples)

<br/>

## Maintainers
| [<img src="https://github.com/mrz1836.png" height="50" alt="MrZ" />](https://github.com/mrz1836) |
|:---:|
| [MrZ](https://github.com/mrz1836) |

<br/>

## Contributing
View the [contributing guidelines](CONTRIBUTING.md) and follow the [code of conduct](CODE_OF_CONDUCT.md).

### How can I help?
All kinds of contributions are welcome :raised_hands:! 
The most basic way to show your support is to star :star2: the project, or to raise issues :speech_balloon:. 
You can also support this project by [becoming a sponsor on GitHub](https://github.com/sponsors/mrz1836) :clap: 
or by making a [**bitcoin donation**](https://mrz1818.com/?tab=tips&utm_source=github&utm_medium=sponsor-link&utm_campaign=go-cache&utm_term=go-cache&utm_content=go-cache) to ensure this journey continues indefinitely! :rocket:

[![Stars](https://img.shields.io/github/stars/mrz1836/go-cache?label=Please%20like%20us&style=social)](https://github.com/mrz1836/go-cache/stargazers)

<br/>

## License

[![License](https://img.shields.io/github/license/mrz1836/go-cache.svg?style=flat)](LICENSE)