Remove single_file from config, create isPublic() helper function

Author: bokimilinkovic

test-crawler/config.go

@@ -21,7 +21,6 @@ type Config struct {
 	Language   string     `yaml:"lang_mode"`
 	IndentJSON bool       `yaml:"indent_json"`
 	Ignore     []string   `yaml:"ignore"`
-	SingleFile string     `yaml:"single_file"`
 }
 
 const filename string = "config.yaml"

test-crawler/config.yaml

@@ -10,4 +10,3 @@ lang_mode: go
 indent_json: true
 # ignore paths
 ignore: ["extern"]
-single_file: ../repo-to-crawl/venus-gateway/proofevent/proof_event.go # for example, replace with different one

test-crawler/extractor/extractor.go

@@ -253,18 +253,13 @@ func getFunctionNodes(content string, treeCursor *sitter.TreeCursor, parser *a.P
 					policy *types2.ProofRegisterPolicy)
 				(<-chan *types2.RequestEvent, error){...}
 				*********
-				First iteration through children nodes:
-				Child.Type = method_declaration
-				Child.Value = whole function body func(*x)(a,b)c{...}
-
-				child.Child(1) is a first part of function declaration, and has type of parameter_list: (e *ProofEventStream)
-				child.Child(2): has type of field_identifier  and represents function's name: ListenProofEvent
-				child.Child(3): has type parameter_list and represents input parameters:  (ctx context.Context, policy *types2.ProofRegisterPolicy)
-				child.Child(4): has type parameter_list and represent return parameters:  (<-chan *types2.RequestEvent, error)
+				child.Child(1) is a first part of function declaration (e *ProofEventStream)
+				child.Child(2): field_identifier  'ListenProofEvent'
+				child.Child(3): parameter_list:  (ctx context.Context, policy *types2.ProofRegisterPolicy)
+				child.Child(4): parameter_list:  (<-chan *types2.RequestEvent, error)
 			*/
 			if child.Type() == string(METHOD_DECLARATION) {
 				funcName = content[child.Child(2).StartByte():child.Child(2).EndByte()]
-				public := unicode.IsUpper(rune(funcName[0]))
 				params := ""
 				returnValues := ""
 				if child.Child(1).Type() == string(PARAMETER_LIST) {
@@ -275,7 +270,7 @@ func getFunctionNodes(content string, treeCursor *sitter.TreeCursor, parser *a.P
 					Node: child,
 					Function: c.FunctionAnnotation{
 						Name:         funcName,
-						Public:       public,
+						Public:       isPublic(funcName),
 						InputParams:  params,
 						ReturnValues: returnValues,
 					},
@@ -381,3 +376,7 @@ func parseContentForFunctions(content string, cursor *sitter.TreeCursor) ([]c.Fu
 
 	return fnsAnno, nil
 }
+
+func isPublic(funcName string) bool {
+	return unicode.IsUpper(rune(funcName[0]))
+}

test-crawler/main.go

@@ -26,8 +26,8 @@ func main() {
 
 	config := NewConfig()
 
-	// crawlRepoBehaviorsAndSaveToJSON(config)
-	crawlSingleFileForMethods(config)
+	crawlRepoBehaviorsAndSaveToJSON(config)
+	crawlSingleFileForMethods("../repo-to-crawl/system/subsystem/file.go") // // ex: ../repo-to-crawl/venus-gateway/proofevent/proof_event.go
 }
 
 func crawlRepoBehaviorsAndSaveToJSON(config Config) {
@@ -78,8 +78,10 @@ func crawlRepoBehaviorsAndSaveToJSON(config Config) {
 	Save(result, config.OutputMode, config.OutputDir, config.IndentJSON)
 }
 
-func crawlSingleFileForMethods(config Config) {
-	fns, err := extractPublicMethodsFromFile(context.Background(), config.SingleFile)
+// crawlSingleFileForMethods accepts path of single go file,
+// and prints extracted methods out of it.
+func crawlSingleFileForMethods(path string) {
+	fns, err := extractPublicMethodsFromFile(context.Background(), path)
 	if err != nil {
 		fmt.Print(err)
 		os.Exit(1)