Commit allHEADmaster

3 files changed, 329 insertions, 0 deletions

diff --git a/go.mod b/go.mod
new file mode 100644
index 0000000..8c3687a
--- /dev/null
+++ b/go.mod
@@ -0,0 +1,24 @@
+module bt_missing
+
+go 1.19
+
+require (
+	badtudexo v0.0.0-00010101000000-000000000000
+	github.com/xuri/excelize/v2 v2.7.0
+	saggytrousers v0.0.0-00010101000000-000000000000
+)
+
+require (
+	github.com/mohae/deepcopy v0.0.0-20170929034955-c48cc78d4826 // indirect
+	github.com/richardlehane/mscfb v1.0.4 // indirect
+	github.com/richardlehane/msoleps v1.0.3 // indirect
+	github.com/xuri/efp v0.0.0-20220603152613-6918739fd470 // indirect
+	github.com/xuri/nfp v0.0.0-20220409054826-5e722a1d9e22 // indirect
+	golang.org/x/crypto v0.5.0 // indirect
+	golang.org/x/net v0.5.0 // indirect
+	golang.org/x/text v0.6.0 // indirect
+)
+
+replace saggytrousers => ../saggytrousers
+
+replace badtudexo => ../badtudexo
diff --git a/go.sum b/go.sum
new file mode 100644
index 0000000..657b670
--- /dev/null
+++ b/go.sum
@@ -0,0 +1,69 @@
+github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/mohae/deepcopy v0.0.0-20170929034955-c48cc78d4826 h1:RWengNIwukTxcDr9M+97sNutRR1RKhG96O6jWumTTnw=
+github.com/mohae/deepcopy v0.0.0-20170929034955-c48cc78d4826/go.mod h1:TaXosZuwdSHYgviHp1DAtfrULt5eUgsSMsZf+YrPgl8=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/richardlehane/mscfb v1.0.4 h1:WULscsljNPConisD5hR0+OyZjwK46Pfyr6mPu5ZawpM=
+github.com/richardlehane/mscfb v1.0.4/go.mod h1:YzVpcZg9czvAuhk9T+a3avCpcFPMUWm7gK3DypaEsUk=
+github.com/richardlehane/msoleps v1.0.1/go.mod h1:BWev5JBpU9Ko2WAgmZEuiz4/u3ZYTKbjLycmwiWUfWg=
+github.com/richardlehane/msoleps v1.0.3 h1:aznSZzrwYRl3rLKRT3gUk9am7T/mLNSnJINvN0AQoVM=
+github.com/richardlehane/msoleps v1.0.3/go.mod h1:BWev5JBpU9Ko2WAgmZEuiz4/u3ZYTKbjLycmwiWUfWg=
+github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
+github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+github.com/stretchr/testify v1.8.0 h1:pSgiaMZlXftHpm5L7V1+rVB+AZJydKsMxsQBIJw4PKk=
+github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
+github.com/xuri/efp v0.0.0-20220603152613-6918739fd470 h1:6932x8ltq1w4utjmfMPVj09jdMlkY0aiA6+Skbtl3/c=
+github.com/xuri/efp v0.0.0-20220603152613-6918739fd470/go.mod h1:ybY/Jr0T0GTCnYjKqmdwxyxn2BQf2RcQIIvex5QldPI=
+github.com/xuri/excelize/v2 v2.6.1/go.mod h1:tL+0m6DNwSXj/sILHbQTYsLi9IF4TW59H2EF3Yrx1AU=
+github.com/xuri/excelize/v2 v2.7.0 h1:Hri/czwyRCW6f6zrCDWXcXKshlq4xAZNpNOpdfnFhEw=
+github.com/xuri/excelize/v2 v2.7.0/go.mod h1:ebKlRoS+rGyLMyUx3ErBECXs/HNYqyj+PbkkKRK5vSI=
+github.com/xuri/nfp v0.0.0-20220409054826-5e722a1d9e22 h1:OAmKAfT06//esDdpi/DZ8Qsdt4+M5+ltca05dA5bG2M=
+github.com/xuri/nfp v0.0.0-20220409054826-5e722a1d9e22/go.mod h1:WwHg+CVyzlv/TX9xqBFXEZAuxOPxn2k1GNHwG41IIUQ=
+github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY=
+golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
+golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
+golang.org/x/crypto v0.0.0-20220817201139-bc19a97f63c8/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4=
+golang.org/x/crypto v0.5.0 h1:U/0M97KRkSFvyD/3FSmdP5W5swImpNgle/EHFhOsQPE=
+golang.org/x/crypto v0.5.0/go.mod h1:NK/OQwhpMQP3MwtdjgLlYHnH9ebylxKWv3e0fK+mkQU=
+golang.org/x/image v0.0.0-20220413100746-70e8d0d3baa9/go.mod h1:023OzeP/+EPmXeapQh35lcL3II3LrY8Ic+EFFKVhULM=
+golang.org/x/image v0.0.0-20220902085622-e7cb96979f69 h1:Lj6HJGCSn5AjxRAH2+r35Mir4icalbqku+CLUtjnvXY=
+golang.org/x/image v0.0.0-20220902085622-e7cb96979f69/go.mod h1:doUCurBvlfPMKfmIpRIywoHmhN3VyhnoFDbvIEWF4hY=
+golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4=
+golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
+golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg=
+golang.org/x/net v0.0.0-20211112202133-69e39bad7dc2/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
+golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c=
+golang.org/x/net v0.0.0-20220812174116-3211cb980234/go.mod h1:YDH+HFinaLZZlnHAfSS6ZXJJ9M9t4Dl22yv3iI2vPwk=
+golang.org/x/net v0.5.0 h1:GyT4nK/YDHSqa1c4753ouYCDajOYKTja9Xb/OHtgvSw=
+golang.org/x/net v0.5.0/go.mod h1:DivGGAXEgPSlEBzxGzZI+ZLohi+xUj054jfeKui00ws=
+golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
+golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
+golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
+golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.0.0-20220728004956-3c1f35247d10/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.4.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
+golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
+golang.org/x/term v0.4.0/go.mod h1:9P2UbLfCdcvo3p/nzKvsmas4TnlujnuoV9hGgYzW1lQ=
+golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
+golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
+golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
+golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
+golang.org/x/text v0.6.0 h1:3XmdazWV+ubf7QgHSTWeykHOci5oeekaGJBLkrkaw4k=
+golang.org/x/text v0.6.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8=
+golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
+golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
+golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc=
+golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
+gopkg.in/yaml.v3 v3.0.0/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
diff --git a/main.go b/main.go
new file mode 100644
index 0000000..faeaf3b
--- /dev/null
+++ b/main.go
@@ -0,0 +1,236 @@
+package main
+
+// Takes one file as the `src` and another as the `check` (passed via -c). 
+// Ensures that all entries in `check` are in `src`, returning as missing all 
+// entries in `check` that are missing from `src`.
+// To check all that are in `src` missing in `check`, you can firstly simply 
+// switch around the order of parameters, or otherwise use bt-present, which 
+// returns either a true or false that all entries on `src` are on `check`, 
+// which could be used to weed out any incorrect values on `src`. 
+
+import (
+	bt "badtudexo"
+	st "saggytrousers"
+	xl "github.com/xuri/excelize/v2"
+	"os"
+	"fmt"
+)
+
+func usage() {
+	fmt.Println(
+`bt-missing: check whether entries on check are missing on src.
+
+You must pass two files: a source file (src, passed as an argument) and
+a check file (check, passed with --check). This script will iterate 
+over all entries in the check file, and output all which are missing on 
+the source file. 
+
+This script has fundmentally two uses. 
+
+The first is: given a larger file, check all which are _not_ on the 
+smaller file. To perform this, run:
+    bt-missing -c large.xlsx small.xlsx
+
+The second is: expand the output of bt-present. bt-present returns a 
+boolean whether all entries on the source file are present in the 
+check file. If bt-present returns false, you may wish to get the 
+entries that are missing. To do this, invoke bt-missing with the 
+positions of the arguments reversed:
+    bt-present -c check.xlsx src.xlsx
+    bt-missing -c src.xlsx check.xlsx
+This can be a little confusing - if in doubt, just switch them around 
+and see whichever one looks right! 
+
+You may specify the sheet and the columns to check against as flags 
+here so you do not need to specify them when the script is running. 
+
+You can additionally specify an output file with -o or --output; the 
+output of this command will be copied into the output file. 
+
+If the specific sheets and columns are known, it can help to pass them 
+as flags, saving you to have to confirm them when the program is 
+running.
+
+Flags:
+-h, --help	Display this help message.
+-c, --check	The file to check against; you must pass this. 
+-ss, --ssheet	The sheet to check against (for src).
+-cs, --csheet	The sheet to check against (for check).
+-sc, --scolumn	The column to check against (for src) as a string (i.e. not an index)
+-cc, --ccolumn	The column to check against (for check) as a string (i.e. not an index)
+-o, --output	The path of an output file to store the output in. 
+-q, --quiet	Be quiet: do not return the results to stdout. 
+		This means this script does not show if there are any 
+		missing unless you also pass -o. 
+`)
+	os.Exit(0)
+}
+
+func parseArgs(args []string) {
+	var check bool = false
+
+	for i := 0; i < len(args); i++ {
+		arg := args[i]
+		switch arg {
+		case "-h", "--help", "help":
+			usage()
+		case "-c", "--check", "--ck":
+			i++
+			g_ckfile = args[i]
+			check = true
+		case "-cs", "--csheet", "--check-sheet", "--ck-sheet":
+			i++
+			g_cksheet = args[i]
+		case "-cc", "--ccolumn", "--check-column", "--ck-column":
+			i++
+			g_ckcol = args[i]
+		case "-ss", "--ssheet", "--source-sheet", "--src-sheet": 
+			i++
+			g_srcsheet = args[i]
+		case "-sc", "--scolumn", "--source-column", "--src-column":
+			i++
+			g_srccol = args[i]
+		case "-o", "--out", "--output":
+			i++
+			g_out = args[i]
+		case "-q", "--quiet": // Do not print to stdout.
+			quiet = true
+
+		default:
+			g_srcfile = arg
+		}
+	}
+
+	if !check {
+		fmt.Println("You need to pass --check.")
+		os.Exit(-1)
+	}
+
+	if quiet && g_out == "" {
+		fmt.Println("You must pass --output if you pass -quiet.")
+		os.Exit(-1)
+	}
+}
+
+// Global Variables
+var g_ckfile string 
+var g_cksheet string
+var g_ckcol string
+var g_srcfile string
+var g_srcsheet string
+var g_srccol string
+var g_out string
+var quiet bool = false
+
+func main() {
+	args := os.Args
+	parseArgs(args)
+
+/* Open the check and source files. */
+	// Load check file. 
+	ck, err := xl.OpenFile(g_ckfile)
+	if err != nil {
+		fmt.Println("Could not open check file.")
+		return
+	}
+	// Load src file. 
+	src, err := xl.OpenFile(g_srcfile)
+	if err != nil {
+		fmt.Println("Could not open src file.")
+		return
+	}
+
+/* Select the sheet and the column to operate on for the two files. */
+	fmt.Println("Load the check file (you may be asked questions here.)")
+	cksheet := st.SelectSheet(ck, g_cksheet)
+	ckcol := st.SelectHeader(ck, cksheet, g_ckcol, /* exact: */ false) 
+
+
+	fmt.Println("------ ------")
+	fmt.Println("Load the source file now (you may be asked questions here.)")
+	fmt.Println("------ ------")
+	srcsheet := st.SelectSheet(src, g_srcsheet)
+	srccol := st.SelectHeader(src, srcsheet, g_srccol, /* exact: */ false)
+
+/* Grab the columns of each files which are to be processed with. */
+	ckrows, err := ck.GetCols(cksheet)
+	if err != nil {
+		fmt.Printf("Could not get the rows of sheet %s of the checkfile.\n", g_cksheet)
+		return
+	} 
+	srcrows, err := src.GetCols(srcsheet) 
+	if err != nil {
+		fmt.Printf("Could not get the rows of sheet %s of the sourcefile.\n", g_srcsheet)
+		return
+	}
+	ckrow  := ckrows[ckcol]
+	srcrow := srcrows[srccol]
+
+	// Output what is checked against what. 
+
+
+	// Actually, like, do the checks. 
+	missing := bt.Missing(ckrow, srcrow)
+
+	// Write the output to stdout and to a file if -o passed.
+	printOutput(missing, g_out, cksheet, srcsheet, ckcol, srccol)
+}
+
+func writeBoth(quiet, write bool, file *os.File, str, errstr string) {
+	if !quiet { fmt.Printf(str) }
+	if write {
+		_, err := file.WriteString(str)
+		if err != nil {
+			fmt.Printf("Could not write to file %d", errstr)
+		}
+	}
+}
+
+func printOutput[T comparable](missing []bt.MissingValue[T], outputFile string,
+				cksheet, srcsheet string,
+				ckcol, srccol int) {
+
+/* Determine whether to write to an --out file and open it if we are. */
+	writeFile := false
+	out, err := os.Create(outputFile)
+	if outputFile != "" && err != nil {
+		fmt.Println("Cannot open file to output.")
+	} else {
+		writeFile = true 
+	}
+
+/* The data which was checked against. */
+	writeBoth(quiet, writeFile, out, "--- Check File Information  ---\n", "check file info")
+	writeBoth(quiet, writeFile, out, fmt.Sprintf("Filename: %s\n", g_ckfile), "check filename")
+	writeBoth(quiet, writeFile, out, fmt.Sprintf("Sheet:    %s\n", cksheet), "check sheet")
+	writeBoth(quiet, writeFile, out, fmt.Sprintf("Column:   %d\n", ckcol), "check column")
+
+	writeBoth(quiet, writeFile, out, "--- Source File Information ---\n", "source file info")
+	writeBoth(quiet, writeFile, out, fmt.Sprintf("Filename: %s\n", g_srcfile), "check filename")
+	writeBoth(quiet, writeFile, out, fmt.Sprintf("Sheet:    %s\n", srcsheet), "source sheet")
+	writeBoth(quiet, writeFile, out, fmt.Sprintf("Column:   %d\n", srccol), "source column")
+
+
+/* Write all missing entries. */
+	for _, m := range missing {
+		str := fmt.Sprintf("Missing: \"%s\" at index %d.\n", m.Value, m.Index)
+		if !quiet { fmt.Printf(str) }
+		if writeFile {
+			_, err := out.WriteString(str)
+			if err != nil {
+				fmt.Printf("Cannot write missing entry %d to file\n", m.Index)
+			}
+		}
+	}
+
+/* Write total missing entries. */
+	str := fmt.Sprintf("Total Missing: %d\n", len(missing))
+	if !quiet { fmt.Printf(str) }
+	if writeFile {
+		_, err := out.WriteString(str)
+		if err != nil {
+			fmt.Printf("Could not write total missing to file.")
+		}
+	}
+
+}