refactor to new comment format (hopefully) complete. various optimizations.

Author: jackman0

README.md

@@ -420,8 +420,8 @@ OpenAPI Tags:
 
 # Code Structure
 
-This tool operates, at least conceptually, in three phases: parsing, extraction,
-and generation.
+This tool operates, at least conceptually, in three phases: detection,
+extraction, and generation.
 
 During the parsing phase, the code project is scanned for comments blocks.
 

intermediate_api.go

@@ -1,71 +1,73 @@
 package main
 
 import (
-	"regexp"
-	"bytes"
-	"bufio"
+	"strings"
 )
 
-
 type ApiIntermediate struct {
 	ApiVersion     string
 	ApiTitle       string
 	ApiDescription string
 	BasePath       string
-	SubApis        []SubApiIntermediate
 }
 
-
 func intermediatateApi(commentBlocks []string) ApiIntermediate {
 
-	// @APIVersion 1.0.0
-	// @APITitle REST API
-	// @APIDescription EMS Rest API
-	// @BasePath /api/v1
-	// @SubApi HealthCheck [/health]
-
-	var (
-		// At the time of writing, IntelliJ erroneously warns on unnecessary
-		// escape sequences. Do not trust IntelliJ.
-		rxApiVersion     *regexp.Regexp = regexp.MustCompile(`@APIVersion\s+([\d\.]+)`)
-		rxApiTitle       *regexp.Regexp = regexp.MustCompile(`@APITitle\s+(.+)`)
-		rxApiDescription *regexp.Regexp = regexp.MustCompile(`@APIDescription\s+(.+)`)
-		rxBasePath       *regexp.Regexp = regexp.MustCompile(`@BasePath\s+([/a-zA-Z0-9-]+)`)
-		rxSubApi         *regexp.Regexp = regexp.MustCompile(`@SubApi\s+([0-9a-zA-Z]+)\s+\[([/a-zA-Z0-9-]+)\]`)
-	)
+	/*
+		OpenAPI API Title:
+			Agame Public API
+		OpenAPI API Description:
+			The Agame Public API is the API that is exposed to the world to facilitate
+			gameplay.
+		OpenAPI API Version:
+			1.0
+		OpenAPI Base Path:
+			/api
+	*/
 
-	var apiIntermediate ApiIntermediate = ApiIntermediate{
-		SubApis: make([]SubApiIntermediate, 0),
-	}
+	var apiIntermediate ApiIntermediate = ApiIntermediate{}
 
 	for _, commentBlock := range commentBlocks {
 
-		b := bytes.NewBufferString(commentBlock)
-		scanner := bufio.NewScanner(b)
-		for scanner.Scan() {
-			line := scanner.Text()
+		sections := parseSections(commentBlock)
+
+		for _, section := range sections {
 
-			switch {
+			//log.Print(section)
 
-			case rxApiDescription.MatchString(line):
-				apiIntermediate.ApiDescription = rxApiDescription.FindStringSubmatch(line)[1]
-			case rxApiTitle.MatchString(line):
-				apiIntermediate.ApiTitle = rxApiTitle.FindStringSubmatch(line)[1]
-			case rxApiVersion.MatchString(line):
-				apiIntermediate.ApiVersion = rxApiVersion.FindStringSubmatch(line)[1]
-			case rxBasePath.MatchString(line):
-				apiIntermediate.BasePath = rxBasePath.FindStringSubmatch(line)[1]
+			title := strings.TrimSpace(section.Title)
+			title = strings.ToLower(title)
 
-			case rxSubApi.MatchString(line):
-				matches := rxSubApi.FindStringSubmatch(line)
-				subApi := SubApiIntermediate{
-					Name: matches[1],
-					Path: matches[2],
+			switch title {
+			case "openapi api title":
+				if l, ok := section.Line(0); ok {
+					apiIntermediate.ApiTitle = l
+				}
+			case "openapi api description":
+				apiIntermediate.ApiDescription = section.Body
+			case "openapi api version":
+				if l, ok := section.Line(0); ok {
+					apiIntermediate.ApiVersion = l
+				}
+			case "openapi base path":
+				if l, ok := section.Line(0); ok {
+					apiIntermediate.BasePath = l
 				}
-				apiIntermediate.SubApis = append(apiIntermediate.SubApis, subApi)
 			}
 		}
 	}
 
 	return apiIntermediate
 }
+
+func getFirstWord(s string) string {
+	words := strings.Split(s, " ")
+	for _, word := range words {
+		word = strings.Trim(word, "\t")
+		if word != "" {
+			return word
+		}
+	}
+
+	return ""
+}

intermediate_definition.go

@@ -3,7 +3,6 @@ package main
 import (
 	"github.com/go-openapi/spec"
 	"github.com/jackmanlabs/errors"
-	"strconv"
 	"strings"
 )
 
@@ -13,10 +12,10 @@ type DefinitionIntermediate struct {
 	EmbeddedTypes  []string
 	Members        map[string]SchemerDefiner // map[name]schemer
 	Name           string
-	PackageName    string   // The actual package name of this type.
-	PackagePath    string   // The actual package path of this type.
-	UnderlyingType string   // This isn't used right now. In our test codebase, non-struct types were never used.
-	Enums          []string // If the underlying type is a primitive type, it's assumed it's an enum type, these being the values.
+	PackageName    string        // The actual package name of this type.
+	PackagePath    string        // The actual package path of this type.
+	UnderlyingType string        // This isn't used right now. In our test codebase, non-struct types were never used.
+	Enums          []interface{} // If the underlying type is a primitive type, it's assumed it's an enum type, these being the values.
 
 	// While it may not strictly be equivalent from a language specification
 	// perspective, we're going to call a non-struct type with an underlying
@@ -55,21 +54,7 @@ func (this *DefinitionIntermediate) Schema() spec.Schema {
 
 	if isPrimitive, t, f := IsPrimitive(this.UnderlyingType); isPrimitive {
 		schema.Typed(t, f)
-		schema.Enum = make([]interface{}, 0)
-
-		for _, enum := range this.Enums {
-			if strings.HasPrefix(enum, "\"") {
-				schema.Enum = append(schema.Enum, strings.Trim(enum, "\""))
-			} else {
-				// store numerical enums as numbers, otherwise strings.
-				if f, err := strconv.ParseFloat(enum, 64); err == nil {
-					schema.Enum = append(schema.Enum, f)
-				} else {
-					enum = strings.Trim(enum, "\"")
-					schema.Enum = append(schema.Enum, enum)
-				}
-			}
-		}
+		schema.Enum = this.Enums
 	} else {
 		schema.Typed("object", "")
 		schema.Required = make([]string, 0)
@@ -126,8 +111,6 @@ func (this *DefinitionIntermediate) DefineDefinitions() error {
 	return nil
 }
 
-
-
 func mergeDefinitions(dst, src *DefinitionIntermediate) {
 	for srcName, srcMember := range src.Members {
 		_, exists := dst.Members[srcName]

intermediate_member.go

@@ -71,6 +71,12 @@ func (this *MemberIntermediate) CanonicalName() string {
 }
 
 func (this *MemberIntermediate) Schema() *spec.Schema {
+
+	// This addresses a response not having a type (no body).
+	if this.Type == "nil" {
+		return nil
+	}
+
 	schema := new(spec.Schema)
 
 	name := this.Name
@@ -81,6 +87,9 @@ func (this *MemberIntermediate) Schema() *spec.Schema {
 	schema.Description = this.Description
 
 	if isPrimitive, t, f := IsPrimitive(this.Type); isPrimitive {
+
+
+
 		schema.Typed(t, f)
 
 		if t == "string" {
@@ -160,7 +169,7 @@ func (this *MemberIntermediate) DefineDefinitions(referringPackage string) error
 
 	goType := this.Type
 
-	if goType == "nil"{
+	if goType == "nil" {
 		return nil
 	}