Merge pull request #89 from fabianoflorentino/development

Development to Main

Author: fabianoflorentino

internal/agrupamento_de_dados/constants.go

@@ -29,7 +29,6 @@ const (
 	flagSliceLiteralComposta         string = "--slice-literal-composta"
 	flagSliceForRange                string = "--slice-for-range"
 	flagSliceFatiandoOuDeletando     string = "--slice-fatiando-ou-deletando-de-uma-fatia"
-	flagSliceFatiandoOuDeletandoRes  string = "--slice-fatiando-ou-deletando-de-uma-fatia --resolucao"
 	flagSliceAnexando                string = "--slice-anexando-a-uma-slice"
 	flagSliceMake                    string = "--slice-make"
 	flagSliceMultiDimensional        string = "--slice-multi-dimensional"

internal/agrupamento_de_dados/help.go

@@ -7,8 +7,7 @@
 package agrupamento_de_dados
 
 import (
-	"fmt"
-
+	base "github.com/fabianoflorentino/aprendago/pkg/base_content"
 	"github.com/fabianoflorentino/aprendago/pkg/format"
 )
 
@@ -23,7 +22,6 @@ func Help() {
 		{Flag: flagSliceLiteralComposta, Description: descSliceLiteralComposta},
 		{Flag: flagSliceForRange, Description: descSliceForRange},
 		{Flag: flagSliceFatiandoOuDeletando, Description: descSliceFatiandoOuDeletando},
-		{Flag: flagSliceFatiandoOuDeletandoRes, Description: descSliceFatiandoOuDeletandoRes},
 		{Flag: flagSliceAnexando, Description: descSliceAnexando},
 		{Flag: flagSliceMake, Description: descSliceMake},
 		{Flag: flagSliceMultiDimensional, Description: descSliceMultiDimensional},
@@ -32,6 +30,6 @@ func Help() {
 		{Flag: flagMapsRangeEDeletando, Description: descMapsRangeEDeletando},
 	}
 
-	fmt.Println("Capítulo 8: Agrupamento de Dados")
-	format.PrintHelpMe(h)
+	b := base.New()
+	b.HelpMe("Capítulo 8: Agrupamento de Dados", h)
 }

internal/agrupamento_de_dados/menu.go

@@ -1,49 +1,40 @@
 package agrupamento_de_dados
 
 import (
+	// "go/format" removed as it does not contain MenuOptions
+
+	base "github.com/fabianoflorentino/aprendago/pkg/base_content"
 	"github.com/fabianoflorentino/aprendago/pkg/format"
-	"github.com/fabianoflorentino/aprendago/pkg/logger"
-	"github.com/fabianoflorentino/aprendago/pkg/section"
 )
 
-// menu generates a list of menu options based on the provided menu slice and root directory.
-// It initializes a section using the given root directory and returns a slice of MenuOptions,
-// each containing an option string and an associated execution function.
-//
-// Parameters:
-//   - menu: A slice of strings representing the menu options.
-//   - rootDir: A string representing the root directory for initializing the section.
-//
-// Returns:
-//   - A slice of format.MenuOptions, where each option has an associated execution function.
-//     If an error occurs during section initialization, it logs the error and returns nil.
 func Menu(menu []string) []format.MenuOptions {
-	section, err := section.New(rootDir)
-	if err != nil {
-		logger.New("Error creating section: ", err.Error()).Register()
+	m := base.New()
+
+	newFlag := []string{
+		flagArray,
+		flagSliceLiteralComposta,
+		flagSliceForRange,
+		flagSliceFatiandoOuDeletando,
+		flagSliceAnexando,
+		flagSliceMake,
+		flagSliceMultiDimensional,
+		flagSliceSurpresaArraySubjacente,
+		flagMapsIntroducao,
+		flagMapsRangeEDeletando,
 	}
 
-	return []format.MenuOptions{
-		{Options: flagArray, ExecFunc: func() { sectionsAgrupamentoDeDados(array, section) }},
-		{Options: flagSliceLiteralComposta, ExecFunc: func() { sectionsAgrupamentoDeDados(sliceLiteralComposta, section) }},
-		{Options: flagSliceForRange, ExecFunc: func() { sectionsAgrupamentoDeDados(sliceForRange, section) }},
-		{Options: flagSliceFatiandoOuDeletando, ExecFunc: func() { sectionsAgrupamentoDeDados(sliceFatiandoOuDeletando, section) }},
-		{Options: flagSliceAnexando, ExecFunc: func() { sectionsAgrupamentoDeDados(sliceAnexando, section) }},
-		{Options: flagSliceMake, ExecFunc: func() { sectionsAgrupamentoDeDados(sliceMake, section) }},
-		{Options: flagSliceMultiDimensional, ExecFunc: func() { sectionsAgrupamentoDeDados(sliceMultiDimensional, section) }},
-		{Options: flagSliceSurpresaArraySubjacente, ExecFunc: func() { sectionsAgrupamentoDeDados(sliceSurpresaArraySubjacente, section) }},
-		{Options: flagMapsIntroducao, ExecFunc: func() { sectionsAgrupamentoDeDados(mapsIntroducao, section) }},
-		{Options: flagMapsRangeEDeletando, ExecFunc: func() { sectionsAgrupamentoDeDados(mapsRangeEDeletando, section) }},
+	newExecFunc := []func(){
+		func() { m.SectionFormat(array, m.SectionFactory(rootDir)) },
+		func() { m.SectionFormat(sliceLiteralComposta, m.SectionFactory(rootDir)) },
+		func() { m.SectionFormat(sliceForRange, m.SectionFactory(rootDir)) },
+		func() { m.SectionFormat(sliceFatiandoOuDeletando, m.SectionFactory(rootDir)) },
+		func() { m.SectionFormat(sliceAnexando, m.SectionFactory(rootDir)) },
+		func() { m.SectionFormat(sliceMake, m.SectionFactory(rootDir)) },
+		func() { m.SectionFormat(sliceMultiDimensional, m.SectionFactory(rootDir)) },
+		func() { m.SectionFormat(sliceSurpresaArraySubjacente, m.SectionFactory(rootDir)) },
+		func() { m.SectionFormat(mapsIntroducao, m.SectionFactory(rootDir)) },
+		func() { m.SectionFormat(mapsRangeEDeletando, m.SectionFactory(rootDir)) },
 	}
-}
 
-// sectionsAgrupamentoDeDados formats and processes sections of data under a given title.
-// It utilizes the SectionProvider interface to handle the formatting logic.
-//
-// Parameters:
-//   - title: A string representing the title for the sections.
-//   - sections: An implementation of the section.SectionProvider interface
-//     that provides the functionality to format the sections.
-func sectionsAgrupamentoDeDados(title string, sections section.SectionProvider) {
-	sections.Format(title)
+	return m.Menu(newFlag, newExecFunc)
 }

internal/agrupamento_de_dados/menu_test.go

@@ -20,7 +20,6 @@ func TestMenu(t *testing.T) {
 			flagSliceLiteralComposta,
 			flagSliceForRange,
 			flagSliceFatiandoOuDeletando,
-			flagSliceFatiandoOuDeletandoRes,
 			flagSliceAnexando,
 			flagSliceMake,
 			flagSliceMultiDimensional,

internal/agrupamento_de_dados/topic_test.go

@@ -0,0 +1,37 @@
+package agrupamento_de_dados
+
+import (
+	"os"
+	"testing"
+)
+
+type MockContentsProvider struct {
+	CalledWithRootDir string
+	CalledWithTopics  []string
+}
+
+func (m *MockContentsProvider) TopicsContents(rootDir string, topics []string) {
+	m.CalledWithRootDir = rootDir
+	m.CalledWithTopics = topics
+}
+
+func TestTopicsAgrupamentoDeDados(t *testing.T) {
+	os.Setenv("GOENV", "test")
+
+	rootDir := os.Getenv("GOENV")
+
+	if rootDir != "test" {
+		t.Errorf("Expected rootDir to be 'test', got '%s'", rootDir)
+	}
+
+	mockProvider := &MockContentsProvider{}
+	mockProvider.TopicsContents(rootDir, []string{"topic1", "topic2"})
+
+	if mockProvider.CalledWithRootDir != rootDir {
+		t.Errorf("Expected rootDir to be 'test', got '%s'", mockProvider.CalledWithRootDir)
+	}
+
+	if len(mockProvider.CalledWithTopics) != 2 {
+		t.Errorf("Expected 2 topics, got %d", len(mockProvider.CalledWithTopics))
+	}
+}

internal/agrupamento_de_dados/topics.go

@@ -19,21 +19,6 @@ import (
 func Topics() {
 	fmt.Printf("\nCapítulo 8: Agrupamento de Dados\n")
 
-	content := topic.New()
-	contentsAgrupamentoDeDados(rootDir, content)
-}
-
-// contentsAgrupamentoDeDados processes and organizes the contents of the
-// "agrupamento de dados" (data grouping) topics. It initializes a new
-// topic structure, retrieves the list of topics related to "agrupamento de dados",
-// and populates the topics' contents from the specified root directory.
-func contentsAgrupamentoDeDados(rootDir string, contents topic.ContentsProvider) {
-	contents.TopicsContents(rootDir, listOfTopicsAgrupamentoDeDados())
-}
-
-// listOfTopicsAgrupamentoDeDados returns a slice of strings containing
-// the topics related to "agrupamento de dados" (data grouping) in Go.
-func listOfTopicsAgrupamentoDeDados() []string {
 	list := []string{
 		array,
 		sliceLiteralComposta,
@@ -47,15 +32,6 @@ func listOfTopicsAgrupamentoDeDados() []string {
 		mapsRangeEDeletando,
 	}
 
-	return listOfTopics(list)
-}
-
-// listOfTopics takes a slice of strings as input and returns a new slice of strings.
-// The returned slice is initialized with a capacity of 10 and contains all the elements
-// from the input slice.
-func listOfTopics(inputList []string) []string {
-	outputList := make([]string, 0, 10)
-	outputList = append(outputList, inputList...)
-
-	return outputList
+	content := topic.New()
+	content.TopicsContents(rootDir, content.ListOfTopics(list, 10))
 }

internal/agrupamento_de_dados/topics_test.go

@@ -0,0 +1,99 @@
+// Package basecontent provides foundational structures and functionalities
+// that can be extended or embedded by other types to enable shared behavior
+// and common operations. It includes utilities for generating menu options,
+// formatting sections, and creating section instances, making it a versatile
+// component for building modular and reusable Go applications.
+package basecontent
+
+import (
+	"fmt"
+
+	"github.com/fabianoflorentino/aprendago/pkg/format"
+	"github.com/fabianoflorentino/aprendago/pkg/logger"
+	"github.com/fabianoflorentino/aprendago/pkg/section"
+)
+
+// MenuOptions defines an interface for handling menu options.
+// It provides a method to generate a list of menu options based on a flag
+// and a corresponding function to execute for the selected option.
+//
+// Menu takes two parameters:
+// - optionFlag: A string representing the flag or identifier for the menu option.
+// - optionFunc: A function to be executed when the menu option is selected.
+//
+// The method returns a slice of format.MenuOptions, representing the available menu options.
+type MenuOptions interface {
+	Menu(optionFlag string, optionFunc func()) []format.MenuOptions
+}
+
+type HelpMe interface {
+	BuildHelpMe(title string, helpString []format.HelpMe)
+}
+
+// BaseContent represents a foundational structure or entity that can be
+// extended or embedded by other types to provide shared functionality
+// or common behavior.
+type BaseContent struct{}
+
+// New creates and returns a new instance of BaseContent.
+// This function initializes a BaseContent struct with default values.
+func New() *BaseContent {
+	return &BaseContent{}
+}
+
+// Menu generates a list of menu options based on the provided flags and corresponding functions.
+// Each menu option is represented as a format.MenuOptions object.
+//
+// Parameters:
+//   - optionFlags: A slice of strings representing the flags or labels for the menu options.
+//   - optionFuncs: A slice of functions corresponding to each menu option, defining the actions to be executed.
+//
+// Returns:
+//   - A slice of format.MenuOptions containing the generated menu options.
+func (b *BaseContent) Menu(optionFlags []string, optionFuncs []func()) []format.MenuOptions {
+	menuOptions := []format.MenuOptions{}
+
+	for i := 0; i < len(optionFlags) && i < len(optionFuncs); i++ {
+		menuOptions = append(menuOptions, format.MenuOptions{Options: optionFlags[i], ExecFunc: optionFuncs[i]})
+	}
+
+	return menuOptions
+}
+
+// SectionFormat formats a section with the given title and applies it to the BaseContent.
+// It takes a title string and a pointer to a Section object as parameters.
+// The function modifies the BaseContent based on the provided section details.
+func (b *BaseContent) SectionFormat(title string, section *section.Section) {
+	section.Format(title)
+}
+
+// SectionFactory creates and returns a new Section instance based on the provided root directory.
+// It utilizes the BaseContent receiver to configure or initialize the Section as needed.
+//
+// Parameters:
+//   - rootDir: The root directory path used to initialize the Section.
+//
+// Returns:
+//   - A pointer to a Section instance configured with the given root directory.
+func (b *BaseContent) SectionFactory(rootDir string) *section.Section {
+	section, err := section.New(rootDir)
+	if err != nil {
+		logger.New("Error creating section: ", err.Error()).Register()
+		return nil
+	}
+
+	return section
+}
+
+// HelpMe prints a title and a formatted help message to the console.
+// It takes a title string and a slice of format.HelpMe objects, which
+// are used to generate the help message.
+//
+// Parameters:
+//   - title: A string representing the title to be printed.
+//   - helpString: A slice of format.HelpMe objects containing the help
+//     information to be formatted and displayed.
+func (b *BaseContent) HelpMe(title string, helpString []format.HelpMe) {
+	fmt.Println(title)
+	format.PrintHelpMe(helpString)
+}