Merge pull request #90 from fabianoflorentino/development

Refactor Package Documentation

Author: fabianoflorentino

.gitignore

@@ -1,5 +1,6 @@
 .env
 .DS_Store
-tree.log
+**.log
 log/*.log
 *.out
+**.html

README.md

@@ -193,8 +193,8 @@ Outline do Curso por Capítulo
 │   │   ├── menu.go
 │   │   ├── menu_test.go
 │   │   ├── overview.yml
-│   │   ├── topics.go
-│   │   └── topics_test.go
+│   │   ├── topic_test.go
+│   │   └── topics.go
 │   ├── aplicacoes
 │   │   ├── constants.go
 │   │   ├── examples.go
@@ -316,6 +316,9 @@ Outline do Curso por Capítulo
 ├── log
 │   └── development.log
 ├── pkg
+│   ├── base_content
+│   │   ├── base_content.go
+│   │   └── base_content_test.go
 │   ├── format
 │   │   ├── helpme.go
 │   │   ├── menu_options.go
@@ -340,7 +343,7 @@ Outline do Curso por Capítulo
 │       └── trim.go
 └── tree.log
 
-44 directories, 123 files
+45 directories, 125 files
 ```
 
 ## Licença

internal/agrupamento_de_dados/help_test.go

@@ -0,0 +1,27 @@
+package agrupamento_de_dados
+
+import (
+	"os"
+	"testing"
+)
+
+func TestHelp(t *testing.T) {
+	var err error
+
+	oldStdout := os.Stdout
+	defer func() { os.Stdout = oldStdout }()
+
+	nullFile, err := os.OpenFile(os.DevNull, os.O_WRONLY, 0)
+	if err != nil {
+		t.Fatalf("failed to open null device: %v", err)
+	}
+	defer nullFile.Close()
+
+	os.Stdout = nullFile
+
+	Help()
+
+	if err != nil {
+		t.Errorf("Help() failed: %v", err)
+	}
+}

internal/agrupamento_de_dados/menu_test.go

@@ -1,100 +1,122 @@
 package agrupamento_de_dados
 
 import (
+	"os"
 	"testing"
 
-	"github.com/fabianoflorentino/aprendago/pkg/section"
+	base "github.com/fabianoflorentino/aprendago/pkg/base_content"
 )
 
 func TestMenu(t *testing.T) {
-	// Create a new section with a root directory.
-	_, err := section.New(rootDir)
+	var err error
+
+	oldStdout := os.Stdout
+	defer func() { os.Stdout = oldStdout }()
+
+	nullFile, err := os.OpenFile(os.DevNull, os.O_WRONLY, 0)
 	if err != nil {
-		t.Errorf("Error creating section: %v", err)
+		t.Fatalf("failed to open null device: %v", err)
 	}
+	defer nullFile.Close()
 
-	// Create a slice of MenuOptions.
-	menuOptions := Menu(
-		[]string{
-			flagArray,
-			flagSliceLiteralComposta,
-			flagSliceForRange,
-			flagSliceFatiandoOuDeletando,
-			flagSliceAnexando,
-			flagSliceMake,
-			flagSliceMultiDimensional,
-			flagSliceSurpresaArraySubjacente,
-			flagMapsIntroducao,
-		})
+	os.Stdout = nullFile
 
-	// Check if the menuOptions slice has the expected length.
-	if len(menuOptions) != 10 {
-		t.Errorf("Expected menuOptions length of 10, got %v", len(menuOptions))
-	}
+	t.Run("TestMenuOptionsLengthAndContent", func(t *testing.T) {
+		// Create a slice of MenuOptions.
+		menuOptions := Menu(
+			[]string{
+				flagArray,
+				flagSliceLiteralComposta,
+				flagSliceForRange,
+				flagSliceFatiandoOuDeletando,
+				flagSliceAnexando,
+				flagSliceMake,
+				flagSliceMultiDimensional,
+				flagSliceSurpresaArraySubjacente,
+				flagMapsIntroducao,
+			})
 
-	// Check if the menuOptions slice has the expected options.
-	expectedOptions := []string{
-		"--array",
-		"--slice-literal-composta",
-		"--slice-for-range",
-		"--slice-fatiando-ou-deletando-de-uma-fatia",
-		"--slice-anexando-a-uma-slice",
-		"--slice-make",
-		"--slice-multi-dimensional",
-		"--slice-a-surpresa-do-array-subjacente",
-		"--maps-introducao",
-		"--maps-range-e-deletando",
-	}
+		// Check if the menuOptions slice has the expected length.
+		if len(menuOptions) != 10 {
+			t.Errorf("Expected menuOptions length of 10, got %v", len(menuOptions))
+		}
+	})
 
-	for i, option := range menuOptions {
-		if option.Options != expectedOptions[i] {
-			t.Errorf("Expected option %v to be %v, got %v", i, expectedOptions[i], option.Options)
+	t.Run("TestMenuOptionsContent", func(t *testing.T) {
+		menuOptions := Menu(
+			[]string{
+				flagArray,
+				flagSliceLiteralComposta,
+				flagSliceForRange,
+				flagSliceFatiandoOuDeletando,
+				flagSliceAnexando,
+				flagSliceMake,
+				flagSliceMultiDimensional,
+				flagSliceSurpresaArraySubjacente,
+				flagMapsIntroducao,
+			})
+
+		expectedOptions := []string{
+			"--array",
+			"--slice-literal-composta",
+			"--slice-for-range",
+			"--slice-fatiando-ou-deletando-de-uma-fatia",
+			"--slice-anexando-a-uma-slice",
+			"--slice-make",
+			"--slice-multi-dimensional",
+			"--slice-a-surpresa-do-array-subjacente",
+			"--maps-introducao",
+			"--maps-range-e-deletando",
 		}
-	}
 
-	// Check if the menuOptions slice has the expected execution functions.
-	for i, option := range menuOptions {
-		switch i {
-		case 0:
-			if option.ExecFunc == nil {
-				t.Errorf("Expected option %v to have a non-nil execution function", i)
-			}
-		case 1:
-			if option.ExecFunc == nil {
-				t.Errorf("Expected option %v to have a non-nil execution function", i)
-			}
-		case 2:
-			if option.ExecFunc == nil {
-				t.Errorf("Expected option %v to have a non-nil execution function", i)
-			}
-		case 3:
-			if option.ExecFunc == nil {
-				t.Errorf("Expected option %v to have a non-nil execution function", i)
-			}
-		case 4:
-			if option.ExecFunc == nil {
-				t.Errorf("Expected option %v to have a non-nil execution function", i)
-			}
-		case 5:
-			if option.ExecFunc == nil {
-				t.Errorf("Expected option %v to have a non-nil execution function", i)
-			}
-		case 6:
-			if option.ExecFunc == nil {
-				t.Errorf("Expected option %v to have a non-nil execution function", i)
-			}
-		case 7:
-			if option.ExecFunc == nil {
-				t.Errorf("Expected option %v to have a non-nil execution function", i)
+		for i, option := range menuOptions {
+			if option.Options != expectedOptions[i] {
+				t.Errorf("Expected option %v to be %v, got %v", i, expectedOptions[i], option.Options)
 			}
-		case 8:
+		}
+	})
+
+	t.Run("TestMenuOptionsExecutionFunctions", func(t *testing.T) {
+		menuOptions := Menu(
+			[]string{
+				flagArray,
+				flagSliceLiteralComposta,
+				flagSliceForRange,
+				flagSliceFatiandoOuDeletando,
+				flagSliceAnexando,
+				flagSliceMake,
+				flagSliceMultiDimensional,
+				flagSliceSurpresaArraySubjacente,
+				flagMapsIntroducao,
+			})
+
+		for i, option := range menuOptions {
 			if option.ExecFunc == nil {
 				t.Errorf("Expected option %v to have a non-nil execution function", i)
 			}
-		case 9:
-			if option.ExecFunc == nil {
-				t.Errorf("Expected option %v to have a non-nil execution function", i)
+		}
+
+		m := base.New()
+		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)) },
+		}
+
+		for i, execFunc := range newExecFunc {
+			if menuOptions[i].ExecFunc == nil || execFunc == nil {
+				t.Errorf("Execution function for option %v is nil", i)
+			} else {
+				menuOptions[i].ExecFunc()
+				execFunc()
 			}
 		}
-	}
+	})
 }

…ternal/agrupamento_de_dados/constants.go …l/agrupamento_de_dados/static_content.gointernal/agrupamento_de_dados/constants.go renamed to internal/agrupamento_de_dados/static_content.go internal/agrupamento_de_dados/constants.go renamed to internal/agrupamento_de_dados/static_content.go

@@ -1,11 +1,5 @@
 package agrupamento_de_dados
 
-// rootDir represents the relative path to the directory where data grouping topics are stored.
-// This constant is used to reference the internal directory structure within the project.
-const (
-	rootDir = "internal/agrupamento_de_dados"
-)
-
 // The following constants define the names of various topics related to data grouping in Go.
 // Each constant corresponds to a specific topic and provides a human-readable name for it.
 const (
@@ -52,3 +46,26 @@ const (
 	descMapsIntroducao               string = "Apresenta o tópico Maps: introdução."
 	descMapsRangeEDeletando          string = "Apresenta o tópico Maps: Range e Deletando."
 )
+
+// rootDir represents the relative path to the directory where data grouping topics are stored.
+// This constant is used to reference the internal directory structure within the project.
+var (
+	rootDir = "internal/agrupamento_de_dados"
+)
+
+// topics is a slice of strings that contains a list of topic identifiers.
+// Each identifier represents a specific topic related to data grouping concepts in Go.
+var (
+	topics = []string{
+		array,
+		sliceLiteralComposta,
+		sliceForRange,
+		sliceFatiandoOuDeletando,
+		sliceAnexando,
+		sliceMake,
+		sliceMultiDimensional,
+		sliceSurpresaArraySubjacente,
+		mapsIntroducao,
+		mapsRangeEDeletando,
+	}
+)

internal/agrupamento_de_dados/topic_test.go

@@ -5,33 +5,25 @@ import (
 	"testing"
 )
 
-type MockContentsProvider struct {
-	CalledWithRootDir string
-	CalledWithTopics  []string
+func init() {
+	rootDir = "./"
 }
 
-func (m *MockContentsProvider) TopicsContents(rootDir string, topics []string) {
-	m.CalledWithRootDir = rootDir
-	m.CalledWithTopics = topics
-}
-
-func TestTopicsAgrupamentoDeDados(t *testing.T) {
-	os.Setenv("GOENV", "test")
+func TestTopics(t *testing.T) {
+	oldStdout := os.Stdout
+	defer func() { os.Stdout = oldStdout }()
 
-	rootDir := os.Getenv("GOENV")
-
-	if rootDir != "test" {
-		t.Errorf("Expected rootDir to be 'test', got '%s'", rootDir)
+	nullFile, err := os.OpenFile(os.DevNull, os.O_WRONLY, 0)
+	if err != nil {
+		t.Fatalf("failed to open null device: %v", err)
 	}
+	defer nullFile.Close()
 
-	mockProvider := &MockContentsProvider{}
-	mockProvider.TopicsContents(rootDir, []string{"topic1", "topic2"})
+	os.Stdout = nullFile
 
-	if mockProvider.CalledWithRootDir != rootDir {
-		t.Errorf("Expected rootDir to be 'test', got '%s'", mockProvider.CalledWithRootDir)
-	}
+	Topics()
 
-	if len(mockProvider.CalledWithTopics) != 2 {
-		t.Errorf("Expected 2 topics, got %d", len(mockProvider.CalledWithTopics))
+	if err != nil {
+		t.Errorf("Topics() failed: %v", err)
 	}
 }

internal/agrupamento_de_dados/topics.go

@@ -8,30 +8,13 @@ and display the sections and help information.
 package agrupamento_de_dados
 
 import (
-	"fmt"
-
 	"github.com/fabianoflorentino/aprendago/pkg/topic"
 )
 
 // AgrupamentoDeDados prints a header and executes a series of sections related to data grouping in Go.
 // Each section is executed by calling the executeSection function with a specific topic name.
 // The topics covered include arrays, slices (with various operations), and maps.
 func Topics() {
-	fmt.Printf("\nCapítulo 8: Agrupamento de Dados\n")
-
-	list := []string{
-		array,
-		sliceLiteralComposta,
-		sliceForRange,
-		sliceFatiandoOuDeletando,
-		sliceAnexando,
-		sliceMake,
-		sliceMultiDimensional,
-		sliceSurpresaArraySubjacente,
-		mapsIntroducao,
-		mapsRangeEDeletando,
-	}
-
-	content := topic.New()
-	content.TopicsContents(rootDir, content.ListOfTopics(list, 10))
+	t := topic.New()
+	t.TopicConstructor(rootDir, "Capítulo 8: Agrupamento de Dados", topics, t)
 }