init

Author: connormckelvey

.github/workflows/workflow.yml

@@ -0,0 +1,15 @@
+name: Go Github Mockable
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: 1.18
+      - name: Test
+        run: make test

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Connor McKelvey
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Makefile

@@ -0,0 +1,18 @@
+.PHONY: clean
+clean:
+	find . -name "*.gen.go" -type f -delete
+
+.PHONY: client
+client:
+	go generate .
+
+.PHONY: mocks
+mocks:
+	go generate ./mocks
+
+.PHONY: gen
+gen: clean client mocks
+
+.PHONY: test
+test: gen
+	go test -v ./...

README.md

@@ -0,0 +1,35 @@
+# Go Github Mockable
+
+Go Github Mockable provides an interface-based wrapper for the [Go Github](https://github.com/google/go-github) client, making it possible to generate mocks (also included) for the client using [GoMock](https://github.com/golang/mock). 
+
+## Install
+
+```bash
+$ go get github.com/connormckelvey/go-github-mockable
+```
+
+## Usage
+
+```go
+package main
+
+import (
+    "github.com/google/go-github/v48/github"
+    "github.com/connormckelvey/go-github-mockable"
+)
+
+func main() {
+    gh := github.NewClient(nil)
+    client := gogithubmockable.NewClient(gh)
+
+
+    // Instead of client.Repositories, use client.GetRepositories()
+    c.GetRepositories().Get(context.TODO(), "owner", "repo")
+    ...
+}
+```
+
+## TODO
+
+- Copy GoDoc comments from source (DX)
+- Add names to interface method definitions (DX)