Merge pull request #32 from davidovich/fix-scaffold-module-name

remove submodule name in generated go.mod

.gitignore

@@ -1 +1,2 @@
 bin
+build

Makefile

@@ -1,6 +1,12 @@
 SHELL=/bin/bash
 
-HAS_PACKR2	:= $(shell command -v packr2)
+HAS_PACKR2				:= $(shell command -v packr2)
+HAS_GOBIN				:= $(shell command -v gobin)
+HAS_GOCOVERUTIL			:= $(shell command -v gocoverutil)
+
+ifndef HAS_GOBIN
+$(shell GO111MODULE=off go get -u github.com/myitcv/gobin 2>/dev/null)
+endif
 
 export GO111MODULE := on
 
@@ -9,7 +15,10 @@ PACKR_FILE := pkg/scaffold/scaffold-packr.go
 
 ASSETS := $(shell find templates/scaffold)
 
-all: test $(PACK_FILE) $(SCAFFOLD_BIN)
+all: $(PACKR_FILE) test $(SCAFFOLD_BIN)
+
+.PHONY: bin
+bin: $(PACKR_FILE) $(SCAFFOLD_BIN)
 
 .PHONY: $(SCAFFOLD_BIN)
 $(SCAFFOLD_BIN): $(PACKR_FILE)
@@ -22,9 +31,34 @@ ifndef HAS_PACKR2
 endif
 	packr2
 
+GO_TESTS := pkg internal cmd
+COVERAGE := $(foreach t,$(GO_TESTS),build/coverage/report/$(t))
+MERGED_COVERAGE := build/coverage/report/cover.merged.out
+HTML_COVERAGE := build/coverage/html/index.html
+
 .PHONY: test
-test:
-	go test -cover -v ./...
+test: output-coverage
+
+.PHONY: output-coverage
+output-coverage: $(MERGED_COVERAGE) $(HTML_COVERAGE)
+	go tool cover -func=$<
+
+$(MERGED_COVERAGE): $(COVERAGE)
+ifndef HAS_GOCOVERUTIL
+	gobin github.com/AlekSi/[email protected]
+endif
+	$(call msg,Generating merged coverage report)
+	gocoverutil -coverprofile=$@ merge $^
+
+$(HTML_COVERAGE): $(MERGED_COVERAGE)
+	@mkdir -p $(@D)
+	go tool cover -html=$< -o $@
+
+.PHONY: $(COVERAGE)
+$(COVERAGE):
+	@mkdir -p $(@D)
+	$(call msg,--> Testing $(@F)...)
+	go test ./$(@F)/... --cover -coverprofile $@ -v
 
 .PHONY: clean
 clean:

pkg/scaffold/create_test.go

@@ -26,13 +26,13 @@ func TestCreateScaffold(t *testing.T) {
 			desc:    "happy path",
 			args:    []string{".", "example.com/my/assets", "summon"},
 			file:    "go.mod",
-			content: "module example.com/my/assets/summon",
+			content: "module example.com/my/assets",
 		},
 		{
 			desc:    "output dir",
 			args:    []string{"subdir", "example.com/my/assets", "summon"},
 			file:    "subdir/go.mod",
-			content: "module example.com/my/assets/summon",
+			content: "module example.com/my/assets",
 		},
 		{
 			desc:    "non empty dir error",
@@ -51,13 +51,13 @@ func TestCreateScaffold(t *testing.T) {
 				f.Close()
 			},
 			file:    "summon/go.mod",
-			content: "module example.com/my/assets/summon",
+			content: "module example.com/my/assets",
 		},
 		{
 			desc:    "named exe",
 			args:    []string{".", "example.com/my/assets", "my-assets"},
 			file:    "go.mod",
-			content: "module example.com/my/assets/my-assets",
+			content: "module example.com/my/assets",
 		},
 		{
 			desc:     "README rendered contents",

templates/scaffold/Makefile

@@ -11,7 +11,7 @@ all: $(SUMMONER_NAME)/packrd/packed-packr.go bin/$(SUMMONER_NAME)
 
 bin/$(SUMMONER_NAME): $(SUMMON_DEPS)
 	@mkdir -p bin
-	cd $(SUMMONER_NAME) && go build -o ../$@ summon.go
+	go build -o $@ $(SUMMONER_NAME)/summon.go
 
 $(SUMMONER_NAME)/packrd/packed-packr.go: $(ASSETS)
 ifndef HAS_PACKR2
@@ -22,3 +22,4 @@ endif
 .PHONY: clean
 clean:
 	cd $(SUMMONER_NAME) && packr2 clean
+	rm -rf bin

templates/scaffold/README.md

@@ -1,4 +1,4 @@
-Summon Data provider repo
+Summon Data Provider Repo
 =========================
 
 This repository hosts a [{{ .SummonerName }}](https://github.com/davidovich/summon) data
@@ -18,6 +18,15 @@ Summon `some-asset` like so:
 {{ .SummonerName }} some-asset
 ```
 
-By default, summon will instantiate the asset in the .summoned/ directory and return its path. This can be overriden in the `asssets/summon.config.yaml` file or the `-o` flag.
+By default, summon will instantiate the asset in the `.summoned/` directory and return its path. This can be overriden in the `asssets/summon.config.yaml` file or by using the `-o` flag.
 
-Get more help with `{{ .SummonerName }} -h`.
+Get more help with `{{ .SummonerName }} -h`.
+
+Updating assets
+---------------
+
+1) Make modifications (additions, removals) in the assets/ dir
+2) Invoke `make`
+3) Commit changes
+4) Tag with a semantic version (prefix with `v`)
+5) git push --tags

templates/scaffold/go.mod

@@ -1 +1 @@
-module {{ .ModName }}/{{.SummonerName}}
+module {{ .ModName }}