Initial commit

Author: jaredLunde

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/workflows/pr.yml

@@ -0,0 +1,28 @@
+name: Pull request
+on:
+  pull_request:
+    branches:
+      - main
+jobs:
+  vet:
+    name: Vet
+    runs-on: ubuntu-latest
+    concurrency:
+      group: ${{ github.head_ref }}-vet
+      cancel-in-progress: true
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
+      - name: Setup asdf
+        uses: asdf-vm/actions/install@v3
+      - name: Install dependencies
+        run: go mod download
+      - name: Add asdf shims to PATH
+        run: |
+          echo "${HOME}/.asdf/shims" >> $GITHUB_PATH
+      - name: Lint
+        run: go vet ./...
+      - name: Run tests
+        run: go test -v ./... -bench=. -benchmem

.tool-versions

@@ -0,0 +1 @@
+golang 1.19

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+jared@flexstack.com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -0,0 +1,54 @@
+# Contribute
+
+> A guide for contributing to `uuid`
+
+## Getting Started
+
+1. [Install asdf](https://asdf-vm.com/guide/getting-started.html) - A CLI tool that can manage multiple
+   language runtime versions on a per-project basis
+
+3. Clone the repo and open in VSCode
+
+```sh
+git clone https://github.com/flexstack/uuid
+code uuid
+```
+
+4. Install the project's dependencies
+
+```sh
+asdf install
+go mod download
+```
+
+## Development
+
+Vet code
+```sh
+go vet ./...
+```
+
+Run tests
+```sh
+go test -v ./... -bench=. -benchmem
+```
+
+## Open an issue
+
+If you find a bug or want to request a new feature, please open an issue.
+
+## Submit a pull request
+
+Before submitting a feature pull request, it is important to open an issue to discuss what you plan to work on to ensure success in releasing your changes.
+For small bug fixes or improvements, go ahead and submit a pull request without an issue.
+
+1. Fork the repo
+2. Create a new branch (`git checkout -b feature/my-feature`)
+3. Make your changes
+4. Commit your changes (`git commit -am 'Add my feature'`)
+5. Push to the branch (`git push origin feature/my-feature`)
+6. Create a new Pull Request
+
+## License
+
+MIT

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 FlexStack
+Copyright (c) 2024 FlexStack Contributors. All rights reserved.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,2 +1,58 @@
 # uuid
-Faster v4 and v7 UUIDs in Go
+
+Faster, more flexible v4 and v7 UUIDs in Go
+
+## Features
+
+- [x] Generate and parse v4 and v7 UUIDs
+- [x] Canonical, hash, and base58 encoding
+- [x] Select a default string format (i.e. base58, hash, canonical)
+- [x] SQL scanning and JSON marshaling
+- [x] The fastest UUID parsing available in Golang
+
+## Installation
+
+```bash
+go get github.com/flexstack/uuid
+```
+
+## Usage
+
+```go
+import "github.com/flexstack/uuid"
+
+// Optionally set a default format
+uuid.DefaultFormat = uuid.FormatBase58
+
+// Generate a new v4 UUID
+u := uuid.Must(uuid.NewV4())
+
+// Generate a new v7 UUID
+u := uuid.Must(uuid.NewV7())
+
+// Parse a UUID
+u, err := uuid.FromString("6ba7b810-9dad-11d1-80b4-00c04fd430c8")
+
+// Parse a UUID from a byte slice
+u, err := uuid.FromBytes([]byte{0x6b, 0xa7, 0xb8, 0x10, 0x9d, 0xad, 0x11, 0xd1, 0x80, 0xb4, 0x00, 0xc0, 0x4f, 0xd4, 0x30, 0xc8})
+
+// Scan a SQL UUID
+var u uuid.UUID
+err := db.QueryRow("SELECT id FROM users WHERE email = $1", email).Scan(&u)
+if u.IsNil() {
+    // Handle nil row
+}
+```
+
+
+## Credit
+
+This package is a fork of [github.com/google/uuid](https://github.com/gofrs/uuid) with the following changes:
+
+- 2x improvement to `FromString`, `UnmarshalText`, and `UnmarshalJSON` performance
+- Adds base58 encoding.
+- Allows people to set a default format (i.e. base58, hash, canonical)
+- Scans nil UUIDs from SQL databases as nil UUIDs (00000000-0000-0000-0000-000000000000) instead of `nil`.
+- Fixes issue with [TimestampFromV7](https://github.com/gofrs/uuid/issues/128) not being spec compliant.
+- Removed v1, v3, v5 UUIDs.
+- Removed support for braced and URN string formats.