From ec372e8a6240f60609699ffb628ccf3db40b451a Mon Sep 17 00:00:00 2001 From: Jason Lenz Date: Thu, 16 Dec 2021 19:21:04 -0600 Subject: [PATCH] Clean up unnecessary files --- LICENSE | 2 +- Makefile | 57 -------------------------- README.md | 2 +- template/Makefile.got | 35 ---------------- template/README.md | 19 --------- template/README.md.got | 92 ------------------------------------------ 6 files changed, 2 insertions(+), 205 deletions(-) delete mode 100644 Makefile delete mode 100644 template/Makefile.got delete mode 100644 template/README.md delete mode 100644 template/README.md.got diff --git a/LICENSE b/LICENSE index d6331cf..c775eb8 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ -Copyright (c) 2020 Jason T. Lenz. All rights reserved. +Copyright (c) 2021 Jason T. Lenz. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are diff --git a/Makefile b/Makefile deleted file mode 100644 index f5e43d7..0000000 --- a/Makefile +++ /dev/null @@ -1,57 +0,0 @@ -.POSIX: - -PNAME = chunkio - -RTEMPLATE ?= ../repo-template - -all: check - -.DEFAULT_GOAL := all - -.PHONY: all - -#---Golang Library Section--- - -GO ?= go -GOFLAGS ?= -GOSRC != find . -name '*.go' - -check: $(GOSRC) - $(GO) test $(GOFLAGS) - -.PHONY: check - -#---Generate Main Documents--- - -regenDocMain: - pgot -i ":$(RTEMPLATE)" -o README.md template/README.md.got - pgot -i ":$(RTEMPLATE)" -o LICENSE $(RTEMPLATE)/LICENSE.src/BSD-2-clause.got - -.PHONY: regenDocMain - -#---Generate Makefile--- - -regenMakefile: - pgot -i ":$(RTEMPLATE)" -o Makefile template/Makefile.got - -.PHONY: regenMakefile - -#---Lint Helper Target--- - -lint: - @find . -path ./.git -prune -or \ - -type f -and -not -name 'Makefile' \ - -exec grep -Hn '' '{}' ';' - -.PHONY: lint - -#---TODO Helper Target--- - -todo: - @find . -path ./.git -prune -or \ - -type f -and -not -name 'Makefile' \ - -exec grep -Hn TODO '{}' ';' - -.PHONY: todo - -# vim:set noet tw=80: diff --git a/README.md b/README.md index 92ddfc3..350419f 100644 --- a/README.md +++ b/README.md @@ -77,7 +77,7 @@ func ExampleUppercase() { ## Running the tests ``` -$ make check +$ go test ``` ## Contributing diff --git a/template/Makefile.got b/template/Makefile.got deleted file mode 100644 index d4b47ee..0000000 --- a/template/Makefile.got +++ /dev/null @@ -1,35 +0,0 @@ -;;; -{ - "pgotInclude" : [ - "global.got", - "Makefile.src/mk-goLib.got", - "Makefile.src/mk-docMain.got", - "Makefile.src/mk-mkFile.got", - "Makefile.src/mk-lint.got", - "Makefile.src/mk-todo.got" - ] -} -;;; -.POSIX: - -PNAME = chunkio - -RTEMPLATE ?= ../repo-template - -all: check - -.DEFAULT_GOAL := all - -.PHONY: all - -{{template "mk-goLib" .}} - -{{template "mk-docMain" .}} - -{{template "mk-mkFile" .}} - -{{template "mk-lint" .}} - -{{template "mk-todo" .}} - -# vim:set noet tw=80: diff --git a/template/README.md b/template/README.md deleted file mode 100644 index 4840eac..0000000 --- a/template/README.md +++ /dev/null @@ -1,19 +0,0 @@ -# Purpose - -This "template" folder contains templates and associates scripts to generate -standard repository files such as README.md and LICENSE. This is primarily -used by the author to ensure consistency across repositories and can safely be -ignored by most end users and contributors. - -# Usage - -If you do desire to use or process templates in this folder make sure you have -cloned the git repository at . -The cloned "repo-template" respository should ideally exist one level outside -this repository root. I.E. ../repo-template - -Once this is in place you can regenerate the documents from templates using the -following command from the main repository folder: - - $ make regenMakefile - $ make regenDocMain diff --git a/template/README.md.got b/template/README.md.got deleted file mode 100644 index 138efea..0000000 --- a/template/README.md.got +++ /dev/null @@ -1,92 +0,0 @@ -;;; -{ - "rname": "chunkio", - "pgotInclude": [ "README.src/all.got" ] -} -;;; -# {{.rname}} - -**{{.rname}}** is a golang package that provides functionality for transparently -reading a subset of a stream containing a user defined ending byte sequence. -When the byte sequence is reached an EOF is returned. This sub stream can be -accessed or passed to other routines as standard Reader objects. - -## Interface - -### Variables - -```text -var ErrInvalidKey = errors.New("{{.rname}}: invalid key definition") -``` - -### Types - -```text -type Reader struct { - // Has unexported fields. -} - Reader implements {{.rname}} functionality wrapped around an io.Reader object - -func NewReader(rd io.Reader) *Reader - NewReader creates a new chunk reader - -func (c *Reader) GetErr() error - GetErr returns the error status for the current active {{.rname}} stream - -func (c *Reader) GetKey() []byte - GetKey returns the key for the current active {{.rname}} stream - -func (c *Reader) Read(p []byte) (int, error) - Read implements the standard Reader interface allowing {{.rname}} to be used - anywhere a standard Reader can be used. Read reads data into p. It returns - the number of bytes read into p. The bytes are taken from at most one Read - on the underlying Reader, hence n may be less than len(p). When the key is - reached (EOF for the stream chunk), the count will be zero and err will be - io.EOF. If the key has been set to nil, the Read function performs exactly - like the underlying stream Read function (no key scanning). - -func (c *Reader) Reset() - Reset puts the {{.rname}} stream back into a readable state. This can be used - when the end of a chunk is reached to enable reading the next chunk. - -func (c *Reader) SetKey(key []byte) error - SetKey updates the search key. The search key can also be cleared by - providing a nil key. -``` - -## Example usage. - -```go -import ( - "bytes" - "fmt" - "io/ioutil" - "git.lenzplace.org/lenzj/{{.rname}}" - "strings" -) - -func ExampleUppercase() { - example := []byte("the quick {U}brown fox jumps{R} over the lazy dog") - cio := {{.rname}}.NewReader(bytes.NewReader(example)) - cio.SetKey([]byte("{U}")) - s1, _ := ioutil.ReadAll(cio) - cio.Reset() - cio.SetKey([]byte("{R}")) - s2, _ := ioutil.ReadAll(cio) - cio.Reset() - s3, _ := ioutil.ReadAll(cio) - fmt.Print(string(s1)+strings.ToUpper(string(s2))+string(s3)) - // Output: the quick BROWN FOX JUMPS over the lazy dog -} -``` - -## Running the tests - -``` -$ make check -``` - -{{template "rd-contributing" .}} -{{template "rd-versioning" .}} -{{template "rd-license" .}} -{{- /* vim:set ts=4 sw=4 et tw=80: */ -}}