initial commit

Author: thisisaaronland

.gitignore

@@ -0,0 +1,6 @@
+*~
+pkg
+src
+bin/index
+bin/index-csv
+bin/pip-server

LICENSE

@@ -0,0 +1,28 @@
+Copyright (c) 2021, City and County of San Francisco, acting by and through its
+Airport Commission ("City"). All rights reserved.
+
+The City and County of San Francisco, acting by and through its Airport
+Commission, created and operates the SFO Museum.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+1.  Redistributions of source code must retain the above copyright notice, this
+    list of conditions and the following disclaimer.
+2.  Redistributions in binary form must reproduce the above copyright notice,
+    this list of conditions and the following disclaimer in the documentation
+    and/or other materials provided with the distribution.
+3.  Neither the name of the City nor the names of its contributors may be used
+    to endorse or promote products derived from this software without specific
+    prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Makefile

@@ -0,0 +1,102 @@
+# go-csvdict
+
+Go package to implement a "dict reader" style CSV parser (on top of the default `encoding/csv` package) to return rows a key-value dictionaries rather than lists.
+
+## Documentation
+
+[![Go Reference](https://pkg.go.dev/badge/github.com/sfomuseum/go-csvdict.svg)](https://pkg.go.dev/github.com/sfomuseum/go-csvdict)
+
+Documentation is incomplete at this time.
+
+## Example
+
+### Reading files
+
+```
+import (
+        "github.com/whosonfirst/go-csvdict"
+	"os"
+)
+
+reader, reader_err := csvdict.NewReaderFromPath("example.csv")
+
+// or maybe you might do
+// reader, err := csvdict.NewReader(os.Stdin)
+
+if err != nil {
+	panic(err)
+}
+
+for {
+	row, err := reader.Read()
+
+	if err == io.EOF {
+		break
+	}
+
+	if err != nil {
+		return err
+	}
+
+	value, ok := row["some-key"]
+
+	// and so on...
+}
+```
+
+### Writing files
+
+```
+import (
+	"github.com/whosonfirst/go-csvdict"
+	"os"
+)
+
+fieldnames := []string{"foo", "bar"}
+
+writer, err := csvdict.NewWriter(os.Stdout, fieldnames)
+
+// or maybe you might do
+// writer, err := csvdict.NewWriterFromPath("new.csv", fieldnames)
+
+if err != nil {
+	panic(err)
+}
+
+writer.WriteHeader()
+
+row := make(map[string]string)
+row["foo"] = "hello"
+row["bar"] = "world"
+
+// See this? "baz" is not included in the list of fieldnames
+// above so it will be silently ignored and excluded from your
+// CSV file. Perhaps it should trigger an error. It doesn't, today...
+
+row["baz"] = "wub wub wub"
+
+writer.WriteRow(row)
+```
+
+## Tools
+
+### wof-csv-filter
+
+Concatenate one or more CSV files ensuring a common set of columns.
+
+```
+./bin/wof-csv-filter -h
+Usage of wof-csv-filter:
+  $> wof-csv-filter -options <files>
+
+Valid options are:
+  -columns string
+    	   Columns to filter on. A value of "-" means the set of unique columns for all CSV files being filtered. (default "-")
+  -out string
+       Where to write the data. A value of "-" means write the data to STDOUT. (default "-")
+```
+
+## See also
+
+* https://golang.org/pkg/encoding/csv/
+* https://docs.python.org/2/library/csv.html

README.md

@@ -0,0 +1,106 @@
+package csvdict
+
+import (
+	"encoding/csv"
+	"io"
+	"os"
+)
+
+type Reader struct {
+	Reader     *csv.Reader
+	Fieldnames []string
+}
+
+type Writer struct {
+	Writer     *csv.Writer
+	Fieldnames []string
+}
+
+func NewReader(fh io.Reader) (*Reader, error) {
+
+	reader := csv.NewReader(fh)
+
+	row, read_err := reader.Read()
+
+	if read_err != nil {
+		return nil, read_err
+	}
+
+	dr := Reader{Reader: reader, Fieldnames: row}
+	return &dr, nil
+}
+
+func NewReaderFromPath(path string) (*Reader, error) {
+
+	fh, err := os.Open(path)
+
+	if err != nil {
+		return nil, err
+	}
+
+	return NewReader(fh)
+}
+
+func (dr Reader) Read() (map[string]string, error) {
+
+	row, err := dr.Reader.Read()
+
+	if err != nil {
+		return nil, err
+	}
+
+	dict := make(map[string]string)
+
+	for i, value := range row {
+		key := dr.Fieldnames[i]
+		dict[key] = value
+	}
+
+	return dict, nil
+}
+
+func NewWriter(fh io.Writer, fieldnames []string) (*Writer, error) {
+
+	writer := csv.NewWriter(fh)
+
+	dw := Writer{Writer: writer, Fieldnames: fieldnames}
+	return &dw, nil
+}
+
+func NewWriterFromPath(path string, fieldnames []string) (*Writer, error) {
+
+	fh, err := os.OpenFile(path, os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0644)
+
+	if err != nil {
+		return nil, err
+	}
+
+	return NewWriter(fh, fieldnames)
+}
+
+func (dw Writer) WriteHeader() {
+	dw.Writer.Write(dw.Fieldnames)
+	dw.Writer.Flush()
+}
+
+// to do - check flags for whether or not to be liberal when missing keys
+// (20160516/thisisaaronland)
+
+func (dw Writer) WriteRow(row map[string]string) {
+
+	out := make([]string, 0)
+
+	for _, k := range dw.Fieldnames {
+
+		v, ok := row[k]
+
+		if !ok {
+			v = ""
+		}
+
+		out = append(out, v)
+	}
+
+	dw.Writer.Write(out)
+	dw.Writer.Flush() // move me somewhere more sensible
+}

csvdict.go

@@ -0,0 +1 @@
+package csvdict

csvdict_test.go

@@ -0,0 +1,67 @@
+// package csvdict implements a "dictionary reader" style CSV parser (on top of the default `encoding/csv` package) to return rows a key-value dictionaries rather than lists.
+// Example
+//
+// Reading files
+//
+//	import (
+//	        "github.com/whosonfirst/go-csvdict"
+//		"os"
+//	)
+//
+//	reader, reader_err := csvdict.NewReaderFromPath("example.csv")
+//
+//	// or maybe you might do
+//	// reader, err := csvdict.NewReader(os.Stdin)
+//
+//	if err != nil {
+//		panic(err)
+//	}
+//
+//	for {
+//		row, err := reader.Read()
+//
+//		if err == io.EOF {
+//			break
+//		}
+//
+//		if err != nil {
+//			return err
+//		}
+//
+//		value, ok := row["some-key"]
+//
+//		// and so on...
+//	}
+//
+// Writing files
+//
+//	import (
+//		"github.com/whosonfirst/go-csvdict"
+//		"os"
+//	)
+//
+//	fieldnames := []string{"foo", "bar"}
+//
+//	writer, err := csvdict.NewWriter(os.Stdout, fieldnames)
+//
+//	// or maybe you might do
+//	// writer, err := csvdict.NewWriterFromPath("new.csv", fieldnames)
+//
+//	if err != nil {
+//		panic(err)
+//	}
+//
+//	writer.WriteHeader()
+//
+//	row := make(map[string]string)
+//	row["foo"] = "hello"
+//	row["bar"] = "world"
+//
+//	// See this? "baz" is not included in the list of fieldnames
+//	// above so it will be silently ignored and excluded from your
+//	// CSV file. Perhaps it should trigger an error. It doesn't, today...
+//
+//	row["baz"] = "wub wub wub"
+//
+//	writer.WriteRow(row)
+package csvdict

doc.go

@@ -0,0 +1,3 @@
+module github.com/sfomuseum/go-csvdict
+
+go 1.12