feat(int64): add support for managing int64 (#1)

* feat(int64): add support for managing int64

enables pointer and deref of int64 values

Signed-off-by: Jason Field <jason@avon-lea.co.uk>

* ci(actions): add basic actions for sanity checking

Signed-off-by: Jason Field <jason@avon-lea.co.uk>

---------

Signed-off-by: Jason Field <jason@avon-lea.co.uk>

Author: xorima

.github/workflows/build-test.yaml

@@ -0,0 +1,36 @@
+---
+name: build-and-test
+
+"on":
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  build-and-test:
+    name: build-and-test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: 1.19
+
+      - name: Build
+        run: go build -v ./...
+
+      - name: Test
+        run: go test -v ./...
+  golangci:
+    name: lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/setup-go@v3
+        with:
+          go-version: 1.19
+      - uses: actions/checkout@v3
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v3

.github/workflows/generic-linters.yaml

@@ -0,0 +1,26 @@
+---
+name: generic-linters
+
+"on":
+  push:
+    branches:
+      - main
+  pull_request:
+
+
+jobs:
+  yamllint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v3
+      - name: Run yaml Lint
+        uses: actionshub/yamllint@main
+
+  mdl:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v3
+      - name: Run Markdown Lint
+        uses: actionshub/markdownlint@main

.github/workflows/sec-code-scanning.yaml

@@ -0,0 +1,51 @@
+---
+name: "Code Scanning - Action"
+
+"on":
+  push:
+    branches:
+      - main
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches:
+      - main
+  schedule:
+    - cron: '0 17 * * 5'
+
+jobs:
+  codeQL:
+    # CodeQL runs on ubuntu-latest, windows-latest, and macos-latest
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+        with:
+          # Must fetch at least the immediate parents so that if this is
+          # a pull request then we can checkout the head of the pull request.
+          # Only include this option if you are running this workflow on pull requests.
+          fetch-depth: 2
+
+      # If this run was triggered by a pull request event then checkout
+      # the head of the pull request instead of the merge commit.
+      # Only include this step if you are running this workflow on pull requests.
+      - run: git checkout HEAD^2
+        if: ${{ github.event_name == 'pull_request' }}
+
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v2
+        # Override language selection by uncommenting this and choosing your languages
+        with:
+          languages: 'go'
+
+      - name: Set up Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: 1.19
+
+      - name: Build
+        run: go build -v ./...
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v2

.mdlrc

@@ -0,0 +1 @@
+rules "~MD013"

.yamllint

@@ -0,0 +1,13 @@
+---
+extends: default
+rules:
+  line-length:
+    max: 256
+    level: warning
+  document-start: disable
+  braces:
+    forbid: false
+    min-spaces-inside: 0
+    max-spaces-inside: 1
+    min-spaces-inside-empty: -1
+    max-spaces-inside-empty: -1

README.md

@@ -1,4 +1,3 @@
-# pointerhelpers
+# pointer helpers
 
 Go repo to hold all the helpers for pointers to save rewriting the same code every time
-

int64.go

@@ -0,0 +1,31 @@
+package pointerhelpers
+
+// Int64Helper contains all Int64 related
+// pointer helpers
+type Int64Helper struct {
+}
+
+// Int64 returns a pointer to the int64 value passed in.
+func Int64(v int64) *int64 {
+	return &v
+}
+
+// Int64 returns a pointer to the int64 value passed in.
+func (i *Int64Helper) Int64(v int64) *int64 {
+	return Int64(v)
+}
+
+// Int64Value returns the value of the int64 pointer passed in or
+// 0 if the pointer is nil.
+func Int64Value(v *int64) int64 {
+	if v != nil {
+		return *v
+	}
+	return 0
+}
+
+// Int64Value returns the value of the int64 pointer passed in or
+// 0 if the pointer is nil.
+func (i *Int64Helper) Int64Value(v *int64) int64 {
+	return Int64Value(v)
+}

int64_test.go

@@ -0,0 +1,28 @@
+package pointerhelpers
+
+import (
+	"github.com/stretchr/testify/assert"
+	"testing"
+)
+
+func TestInt(t *testing.T) {
+	h := StringHelper{}
+	want := "foo"
+	got := h.String(want)
+	assert.EqualValues(t, want, *got)
+}
+
+func TestStringValue(t *testing.T) {
+	t.Run("when nil returns empty string", func(t *testing.T) {
+		h := StringHelper{}
+		want := ""
+		got := h.StringValue(nil)
+		assert.Equal(t, want, got)
+	})
+	t.Run("when set returns the given string", func(t *testing.T) {
+		h := StringHelper{}
+		want := "foobar"
+		got := h.StringValue(String(want))
+		assert.Equal(t, want, got)
+	})
+}

string_test.go

@@ -5,26 +5,23 @@ import (
 	"testing"
 )
 
-// testify
-
-func TestString(t *testing.T) {
-	h := StringHelper{}
-	want := "foo"
-	got := h.String(want)
+func TestInt64(t *testing.T) {
+	h := Int64Helper{}
+	want := int64(42)
+	got := h.Int64(want)
 	assert.EqualValues(t, want, *got)
 }
 
-func TestStringValue(t *testing.T) {
-	t.Run("when nil returns empty string", func(t *testing.T) {
-		h := StringHelper{}
-		want := ""
-		got := h.StringValue(nil)
-		assert.Equal(t, want, got)
+func TestInt64Value(t *testing.T) {
+	t.Run("when nil returns 0", func(t *testing.T) {
+		h := Int64Helper{}
+		got := h.Int64Value(nil)
+		assert.Equal(t, int64(0), got)
 	})
-	t.Run("when set returns the given string", func(t *testing.T) {
-		h := StringHelper{}
-		want := "foobar"
-		got := h.StringValue(String(want))
-		assert.Equal(t, want, got)
+	t.Run("when set returns the given int64", func(t *testing.T) {
+		h := Int64Helper{}
+		want := h.Int64(int64(42))
+		got := h.Int64Value(want)
+		assert.Equal(t, *want, got)
 	})
 }

types.go

@@ -4,4 +4,5 @@ package pointerhelpers
 // in this module to enable easier composition outside of this package
 type PointerHelper struct {
 	StringHelper
+	Int64Helper
 }