Cleaning

Author: tjayrush

docs/content/data-model/chaindata.md

@@ -150,21 +150,21 @@ The following commands produce and manage Logs:
 
 Logs consist of the following fields:
 
-| Field            | Description                                                                | Type                                    |
-| ---------------- | -------------------------------------------------------------------------- | --------------------------------------- |
-| blockNumber      | the number of the block                                                    | blknum                                  |
-| transactionIndex | the zero-indexed position of the transaction in the block                  | txnum                                   |
-| logIndex         | the zero-indexed position of this log relative to the block                | lognum                                  |
-| timestamp        | the timestamp of the block this log appears in                             | timestamp                               |
-| date             | the timestamp as a date (calculated)                                       | datetime                                |
-| address          | the smart contract that emitted this log                                   | address                                 |
-| topics           | first topic event signature up to 3 additional index parameters may appear | topic[]                                 |
-| data             | any remaining un-indexed parameters to the event                           | bytes                                   |
-| transactionHash  | the hash of the transction                                                 | hash                                    |
-| blockHash        | the hash of the block                                                      | hash                                    |
-| articulatedLog   | a human-readable version of the topic and data fields                      | [Function](/data-model/other/#function) |
-| compressedLog    | a truncated, more readable version of the articulation (calculated)        | string                                  |
-| isNFT            | true if the log is an NFT transfer (calculated)                            | bool                                    |
+| Field            | Description                                                                                       | Type                                    |
+| ---------------- | ------------------------------------------------------------------------------------------------- | --------------------------------------- |
+| blockNumber      | the number of the block                                                                           | blknum                                  |
+| transactionIndex | the zero-indexed position of the transaction in the block                                         | txnum                                   |
+| logIndex         | the zero-indexed position of this log relative to the block                                       | lognum                                  |
+| timestamp        | the timestamp of the block this log appears in                                                    | timestamp                               |
+| date             | the timestamp as a date (calculated)                                                              | datetime                                |
+| address          | the smart contract that emitted this log                                                          | address                                 |
+| topics           | the first topic hashes event signature of the log, up to 3 additional index parameters may appear | topic[]                                 |
+| data             | any remaining un-indexed parameters to the event                                                  | bytes                                   |
+| transactionHash  | the hash of the transction                                                                        | hash                                    |
+| blockHash        | the hash of the block                                                                             | hash                                    |
+| articulatedLog   | a human-readable version of the topic and data fields                                             | [Function](/data-model/other/#function) |
+| compressedLog    | a truncated, more readable version of the articulation (calculated)                               | string                                  |
+| isNFT            | true if the log is an NFT transfer (calculated)                                                   | bool                                    |
 
 ## Trace
 

src/dev_tools/goMaker/README.md

@@ -1,11 +1,11 @@
-## goMaker
+# goMaker
 
 `goMaker` is development-only tool that aids in various aspects of building TrueBlocks. The program is
 disabled for most users, but for core developers it can be used to automatically generate help files,
 API interface specs, command line options parsers and many of the test case files. Generally, regular
 users will not use `goMaker`.
 
-### Usage
+## Usage
 
 `Usage:`    goMaker
 `Purpose:`  Automatically writes files for various purposes.
@@ -56,7 +56,7 @@ with the following fields:
   - `note` - a note (used for documentation only, this appears in the notes section of the READMEs)
   - `alias` - an alias (used for the Hugo website only, this aliases old pages)
 
-### Notes on Data Models
+## Notes on Data Models
 
 The `goMaker` program also generates a huge number of source code files and documentation related to the various data models produced or consumed by the various TrueBlocks tools. These data models are stored in `.toml` files in the `./src/dev_tools/goMaker/templates/classDefinitions` folder and the model's fields (in a `.csv`) are stored in a subfolder called `fields`. There are two files for each data model (a `.toml` and a `.csv`) names identically to the data model's name.
 
@@ -75,10 +75,10 @@ The `.toml` file contains the following fields:
 | cache_by     | the fields by which to identify cache items                                      | (one of \[ `address` \| `address,block` \| `address,block,fourbyte` \| `address,tx` \| `block` \| `tx` \] |
 | cache_type   | one of \[ `cacheable` \| `marshal_only` \]                                       |                                                                                              |
 
-### Notes on Templates
+## Notes on Templates
 
 The `./src/dev_tools/goMaker/templates` folder also contains a number of templates used by the `goMaker` program. The names of these templates corresponds to the location in the repo's paths the generated files will be written. For example, the `./sdk_route.go.tmpl` writes files to the `./sdk` folder. The filename of the file is `<route>.go` where `<route>` is the route of the subcommand. The template name may contain the word "route" or the word "type" which is sequentially replaced with either the routes or the data model types.
 
-### Fin
+## Fin
 
 Enough already. Experiment if you must.

src/dev_tools/goMaker/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "goMaker",
+  "version": "1.0.0",
+  "description": "A development tool that aids in various aspects of building TrueBlocks by automatically generating help files, API interface specs, command line options parsers and test case files",
+  "main": "main.go",
+  "scripts": {
+    "build": "mkdir -p bin && go build -o bin/goMaker main.go",
+    "deploy": "yarn build && cp bin/goMaker /usr/local/bin/ && echo '✅ Installed to /usr/local/bin/goMaker' && which goMaker && echo '✅ Installation verified'",
+    "lint": "golangci-lint run && markdownlint README.md",
+    "clean": "rm -rf bin/",
+    "test": "go test ./..."
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/TrueBlocks/trueblocks-minidapps.git"
+  },
+  "keywords": [
+    "go",
+    "trueblocks",
+    "codegen",
+    "development-tool",
+    "code-generation",
+    "template",
+    "cli"
+  ],
+  "author": "TrueBlocks",
+  "license": "GPL-3.0",
+  "bugs": {
+    "url": "https://github.com/TrueBlocks/trueblocks-minidapps/issues"
+  },
+  "homepage": "https://github.com/TrueBlocks/trueblocks-minidapps#readme",
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "devDependencies": {
+    "markdownlint-cli": "^0.45.0"
+  }
+}

src/dev_tools/goMaker/types/code_writer.go

@@ -67,6 +67,7 @@ func WriteCode(existingFn, newCode string) (bool, error) {
 		return false, fmt.Errorf("error applying template: %v %s", err, existingFn)
 	}
 
+	existingFn = strings.Replace(existingFn, "/Users/jrush/Development", "./", 1)
 	msg := LogMessage{
 		MessageType: "Progress",
 		Message:     existingFn,

src/dev_tools/goMaker/types/load.go

@@ -104,8 +104,19 @@ func (cb *CodeBase) LoadStructures(thePath string, callBack func(*Structure, *an
 				f.Facets[i].NormalizeActions()
 			}
 			for i := range f.Facets {
-				// TODO: BOGUS - THIS SHOULD SPLIT AND KEEP THE LAST ITEM ONLY
-				f.Facets[i].Store = strings.ReplaceAll(f.Facets[i].Store, "dalle.", "")
+				// Parse store into StoreSource and StoreName
+				if strings.Contains(f.Facets[i].Store, ".") {
+					parts := strings.Split(f.Facets[i].Store, ".")
+					if len(parts) >= 2 {
+						f.Facets[i].StoreSource = parts[0]
+						f.Facets[i].StoreName = parts[1]
+					}
+				} else {
+					// Default to "sdk" if no prefix specified
+					f.Facets[i].StoreSource = "sdk"
+					f.Facets[i].StoreName = f.Facets[i].Store
+				}
+				f.Facets[i].Store = "NOT NEEDED AFTER LOAD - THIS MESSAGE PROVES IT"
 			}
 			for i := 0; i < len(f.Facets); i++ {
 				if len(f.Facets[i].DisplayName) == 0 {
@@ -117,7 +128,6 @@ func (cb *CodeBase) LoadStructures(thePath string, callBack func(*Structure, *an
 			structMap[mapKey] = f.Settings
 		}
 		return nil
-
 	}); err != nil {
 		return err
 	}

src/dev_tools/goMaker/types/types_codebase.go

@@ -212,19 +212,19 @@ func (cb *CodeBase) Validate() error {
 	for _, st := range cb.Structures {
 		for _, f := range st.Facets {
 			pwd, _ := os.Getwd()
-			tomlFile := filepath.Join(pwd, "code_gen/templates/classDefinitions", strings.ToLower(f.Store)+".toml")
-			csvFile := filepath.Join(pwd, "code_gen/templates/classDefinitions/fields", strings.ToLower(f.Store)+".csv")
+			tomlFile := filepath.Join(pwd, "code_gen/templates/classDefinitions", strings.ToLower(f.StoreName)+".toml")
+			csvFile := filepath.Join(pwd, "code_gen/templates/classDefinitions/fields", strings.ToLower(f.StoreName)+".csv")
 
-			if !structureNames[f.Store] {
+			if !structureNames[f.StoreName] {
 				var msg string
 				if !file.FileExists(tomlFile) {
-					msg = fmt.Sprintf("facet store %s in structure %s not found. Missing .toml file? %s.", f.Store, st.Class, tomlFile)
+					msg = fmt.Sprintf("facet store %s in structure %s not found. Missing .toml file? %s.", f.StoreName, st.Class, tomlFile)
 					logger.InfoBR("TOML file missing:", tomlFile)
 				} else {
 					logger.InfoBR("TOML file found:", tomlFile)
 				}
 				if !file.FileExists(csvFile) {
-					msg = fmt.Sprintf("facet store %s in structure %s not found. Missing .csv file? %s.", f.Store, st.Class, csvFile)
+					msg = fmt.Sprintf("facet store %s in structure %s not found. Missing .csv file? %s.", f.StoreName, st.Class, csvFile)
 					logger.InfoBR("CSV file missing:", csvFile)
 				} else {
 					logger.InfoBR("CSV file found:", csvFile)
@@ -241,7 +241,6 @@ func (cb *CodeBase) Validate() error {
 	}
 
 	return nil
-
 }
 
 func (op *Option) Stripped() string {

src/dev_tools/goMaker/types/types_command.go

@@ -517,6 +517,9 @@ func (c *Command) HelpIntro() string {
 	if tmpl == "" {
 		logger.Fatal("Could not read template file: ", readmePath)
 	}
+	if err := ValidateTemplate(tmpl, readmePath); err != nil {
+		logger.Fatal(err)
+	}
 	return strings.Trim(c.executeTemplate(tmplName, tmpl), ws)
 }
 

src/dev_tools/goMaker/types/types_facet.go

@@ -8,7 +8,9 @@ import (
 type Facet struct {
 	DisplayName string          `toml:"display_name" json:"display_name"`
 	Name        string          `json:"name"`
-	Store       string          `json:"store"`
+	Store       string          `json:"store"` // This will be parsed into StoreName and StoreSource
+	StoreName   string          `json:"storeName"`
+	StoreSource string          `json:"storeSource"`
 	Actions     []string        `toml:"actions" json:"actions"`
 	Confirms    map[string]bool `json:"-" toml:"-"` // actions requiring confirmation (parsed from -confirm suffix)
 	ViewType    string          `toml:"viewType" json:"viewType"`
@@ -32,7 +34,10 @@ func (f *Facet) SingleStore() string {
 	if f == nil {
 		return ""
 	}
-	return Singular(f.Store)
+	if f.StoreName != "Dresses" {
+		return Singular(f.StoreName)
+	}
+	return f.StoreName
 }
 
 func (f *Facet) ValidateViewType() error {

src/dev_tools/goMaker/types/types_member.go

@@ -597,3 +597,66 @@ func (m *Member) Align() string {
 func (m *Member) ReadOnly() bool {
 	return m.UiType() == "address"
 }
+
+// GetFormatter returns the appropriate formatter string for this field
+func (m *Member) GetFormatter() string {
+	name := m.Name
+	fieldType := m.Type
+	description := m.Description
+
+	// Handle "no formatter" cases
+	if strings.HasPrefix(name, "n") ||
+		strings.HasSuffix(name, "Bytes") ||
+		strings.Contains(name, "Per") {
+		return ""
+	}
+
+	// Handle specific types
+	switch fieldType {
+	case "address":
+		return "address"
+	case "ether":
+		return "ether"
+	case "wei", "int256", "uint256":
+		if strings.HasSuffix(name, "Eth") {
+			return "ether"
+		}
+		return "wei"
+	case "blkrange":
+		return "blkrange"
+	case "timestamp":
+		return "datetime"
+	case "hash", "ipfshash":
+		return "hash"
+	case "bool":
+		// Boolean formatter only if name doesn't start with "is" or "has"
+		if !strings.HasPrefix(name, "is") && !strings.HasPrefix(name, "has") {
+			return "boolean"
+		}
+	}
+
+	// Handle name patterns
+	if strings.HasSuffix(name, "Eth") {
+		return "ether"
+	}
+	if strings.HasSuffix(name, "num") || strings.HasSuffix(fieldType, "num") || name == "count" {
+		return "number"
+	}
+	if strings.HasPrefix(fieldType, "uint") || strings.HasPrefix(fieldType, "float") {
+		return "number"
+	}
+	if strings.HasSuffix(strings.ToLower(name), "url") {
+		return "url"
+	}
+	if name == "fileName" || strings.HasSuffix(name, "Path") || name == "path" {
+		return "path"
+	}
+	if strings.HasSuffix(name, "Date") {
+		return "datetime"
+	}
+	if name == "size" && strings.Contains(description, "on disc") {
+		return "calc.fileSize"
+	}
+
+	return ""
+}

src/dev_tools/goMaker/types/types_notes.go

@@ -21,6 +21,9 @@ func (c *Command) HelpNotes() string {
 		if tmpl == "" {
 			logger.Fatal("Could not read template file: ", readmePath)
 		}
+		if err := ValidateTemplate(tmpl, readmePath); err != nil {
+			logger.Fatal(err)
+		}
 		return "\n\n" + strings.Trim(c.executeTemplate(tmplName, tmpl), ws)
 	}
 	return ""