refactor: rename UsageInPercentage to Weight (#77) (#90)

* refactor: rename UsageInPercentage to Weight (#77)

Signed-off-by: Luca Stocchi <lstocchi@redhat.com>

* update doc

Signed-off-by: Luca Stocchi <lstocchi@redhat.com>

README.md

@@ -45,7 +45,9 @@ The result is an ordered list of information for each language detected in the s
 - *name*: the name of the detected language
 - *framework*: a list of detected frameworks (Quarkus, Flash,...) used by the application
 - *tools*: a list of tools (Maven,...) used by the application
-- *usageInPercentage*: a double value that represents the language weight compared to the others.
+- *weight*: a double value that represents the language weight compared to the others.
+
+NOTE: the sum of all weights can be over 100 because a file may be associated to multiple languages and Alizer may not be able to detect it precisely. E.g. a SQL script could be associated to SPLPL, TSQL, PLSQL languages so Alizer will return all 3 with the same weight.
 
 ### Devfile selection
 

go/README.md

@@ -24,7 +24,9 @@ The result is an ordered (sorted by usage) list of informations for each languag
 - *Aliases*: other names which identify the detected language
 - *Framework*: a list of detected frameworks (Quarkus, Flash,...) used by the application
 - *Tools*: a list of tools (Maven,...) used by the application
-- *UsageInPercentage*: a double value that represents the language weight compared to the others.
+- *Weight*: a double value that represents the language weight compared to the others.
+
+NOTE: the sum of all weights can be over 100 because a file may be associated to multiple languages and Alizer may not be able to detect it precisely. E.g. a SQL script could be associated to SPLPL, TSQL, PLSQL so Alizer will print out all 3 languages with the same weight.
 
 To analyze your source code with Alizer, just import it and use the recognizer:
 

go/pkg/apis/model/model.go

@@ -11,12 +11,12 @@
 package model
 
 type Language struct {
-	Name              string
-	Aliases           []string
-	UsageInPercentage float64
-	Frameworks        []string
-	Tools             []string
-	CanBeComponent    bool
+	Name           string
+	Aliases        []string
+	Weight         float64
+	Frameworks     []string
+	Tools          []string
+	CanBeComponent bool
 }
 
 type Component struct {

go/pkg/apis/recognizer/language_recognizer.go

@@ -25,8 +25,8 @@ import (
 )
 
 type languageItem struct {
-	item       langfile.LanguageItem
-	percentage int
+	item   langfile.LanguageItem
+	weight int
 }
 
 func Analyze(path string) ([]model.Language, error) {
@@ -58,8 +58,8 @@ func Analyze(path string) ([]model.Language, error) {
 					}
 				}
 				tmpLanguageItem := languageItem{languageFileItem, 0}
-				percentage := languagesDetected[tmpLanguageItem.item.Name].percentage + extensionsGrouped[extension]
-				tmpLanguageItem.percentage = percentage
+				weight := languagesDetected[tmpLanguageItem.item.Name].weight + extensionsGrouped[extension]
+				tmpLanguageItem.weight = weight
 				languagesDetected[tmpLanguageItem.item.Name] = tmpLanguageItem
 				extensionHasProgrammingLanguage = true
 			}
@@ -72,16 +72,16 @@ func Analyze(path string) ([]model.Language, error) {
 
 	var languagesFound []model.Language
 	for name, item := range languagesDetected {
-		tmpPercentage := float64(item.percentage) / float64(totalProgrammingOccurrences)
-		tmpPercentage = float64(int(tmpPercentage*10000)) / 10000
-		if tmpPercentage > 0.02 {
+		tmpWeight := float64(item.weight) / float64(totalProgrammingOccurrences)
+		tmpWeight = float64(int(tmpWeight*10000)) / 10000
+		if tmpWeight > 0.02 {
 			tmpLanguage := model.Language{
-				Name:              name,
-				Aliases:           item.item.Aliases,
-				UsageInPercentage: tmpPercentage * 100,
-				Frameworks:        []string{},
-				Tools:             []string{},
-				CanBeComponent:    item.item.Component}
+				Name:           name,
+				Aliases:        item.item.Aliases,
+				Weight:         tmpWeight * 100,
+				Frameworks:     []string{},
+				Tools:          []string{},
+				CanBeComponent: item.item.Component}
 			langEnricher := enricher.GetEnricherByLanguage(name)
 			if langEnricher != nil {
 				langEnricher.DoEnrichLanguage(&tmpLanguage, &paths)
@@ -91,7 +91,7 @@ func Analyze(path string) ([]model.Language, error) {
 	}
 
 	sort.SliceStable(languagesFound, func(i, j int) bool {
-		return languagesFound[i].UsageInPercentage > languagesFound[j].UsageInPercentage
+		return languagesFound[i].Weight > languagesFound[j].Weight
 	})
 
 	return languagesFound, nil

go/test/apis/devfile_recognizer_test.go

@@ -40,7 +40,7 @@ func TestDetectDjangoDevfileUsingLanguages(t *testing.T) {
 			Aliases: []string{
 				"python3",
 			},
-			UsageInPercentage: 88.23,
+			Weight: 88.23,
 			Frameworks: []string{
 				"Django",
 			},
@@ -52,10 +52,10 @@ func TestDetectDjangoDevfileUsingLanguages(t *testing.T) {
 			Aliases: []string{
 				"sh",
 			},
-			UsageInPercentage: 11.77,
-			Frameworks:        []string{},
-			Tools:             []string{},
-			CanBeComponent:    false,
+			Weight:         11.77,
+			Frameworks:     []string{},
+			Tools:          []string{},
+			CanBeComponent: false,
 		},
 	}
 	detectDevFileUsingLanguages(t, "", languages, "python-django")