Merge branch 'refs/heads/develop'

Author: GeekTree0101

.github/workflows/go.yml

@@ -1,8 +1,9 @@
 name: Go
 
 on:
+  pull_request:
   push:
-    branches: [ develop ]
+    branches: [ master ]
 
 jobs:
 

README.md

@@ -5,10 +5,16 @@
 [![Go](https://github.com/GeekTree0101/clean-swift-scaffold/actions/workflows/go.yml/badge.svg?branch=develop)](https://github.com/GeekTree0101/clean-swift-scaffold/actions/workflows/go.yml)
 
 
-### Basic Usage
+## Overview
 
+#### Run
 <img height=300pt src="https://github.com/GeekTree0101/clean-swift-scaffold/blob/develop/res/example.png" />
 
+#### Output
+<img height=300pt src="https://github.com/GeekTree0101/clean-swift-scaffold/blob/develop/res/output.png" />
+
+## Basic Usage
+
 #### make config.yaml
 ```yaml
 target_project_name: Miro // target project name
@@ -54,4 +60,4 @@ flag list
 ```
 
 - Please set the name and directory of the configuration file freely. Instead, please enter the correct path on -c/--config flag.
-- Default values of source & test directoly flag follow the configuration file.
+- Default values of source & test directoly flag follow the configuration file.

internal/converter/copyright.go

@@ -0,0 +1,43 @@
+package converter
+
+import (
+	"os/exec"
+	"os/user"
+	"strings"
+)
+
+type Copyright interface {
+	Get() (string, error)
+}
+
+type CopyrightImpl struct {
+}
+
+func (c CopyrightImpl) Get() (string, error) {
+
+	gitUsername, err := c.getGitUsername()
+
+	if err == nil {
+		return gitUsername, nil
+	}
+
+	user, err := user.Current()
+
+	if err == nil {
+		return user.Username, nil
+	}
+
+	return "", err
+}
+
+func (c CopyrightImpl) getGitUsername() (string, error) {
+
+	gitCmd := exec.Command("git", "config", "--global", "user.name")
+	nameBytes, err := gitCmd.Output()
+
+	if err == nil && len(nameBytes) > 0 {
+		return strings.Trim(string(nameBytes), "\n"), nil
+	}
+
+	return "", err
+}

internal/converter/copyright_test.go

@@ -0,0 +1,41 @@
+package converter_test
+
+import (
+	"testing"
+
+	"github.com/Geektree0101/clean-swift-scaffold/internal/converter"
+)
+
+// MARK: - Test Double
+
+type CopyrightStub struct {
+	GetSuccessStub string
+	GetErrorStub   error
+}
+
+func (c CopyrightStub) Get() (string, error) {
+
+	return c.GetSuccessStub, c.GetErrorStub
+}
+
+// MARK: - Test Case
+
+func TestCopyright(t *testing.T) {
+
+	t.Run("get copyright", func(t *testing.T) {
+		// given
+		sut := converter.CopyrightImpl{}
+
+		// when
+		out, err := sut.Get()
+
+		// then
+		if err != nil {
+			t.Error(err)
+		}
+
+		if len(out) == 0 {
+			t.Errorf("output should be longer than 0, output: %s", out)
+		}
+	})
+}

internal/converter/header.go

@@ -10,19 +10,22 @@ import (
 )
 
 type HeaderConverter struct {
-	targetProjectName string
-	copyright         string
-	date              time.Time
+	copyright             Copyright
+	targetProjectName     string
+	copyrightDefaultValue string
+	date                  time.Time
 }
 
 func NewHeaderConverter(
+	copyright Copyright,
 	config *model.Config,
 	date time.Time) *HeaderConverter {
 
 	return &HeaderConverter{
-		targetProjectName: config.TargetProjectName,
-		copyright:         config.Copyright,
-		date:              date,
+		copyright:             copyright,
+		targetProjectName:     config.TargetProjectName,
+		copyrightDefaultValue: config.Copyright,
+		date:                  date,
 	}
 }
 
@@ -34,12 +37,18 @@ func (header *HeaderConverter) Render(source string, sceneName string) string {
 
 	dateStr := fmt.Sprintf("%d/%d/%d", day, month, year)
 
+	copyright, err := header.copyright.Get()
+
+	if err != nil {
+		copyright = header.copyrightDefaultValue
+	}
+
 	var replacedSource string = source
 	replacedSource = strings.ReplaceAll(replacedSource, "__SCENE_NAME__", sceneName)
 	replacedSource = strings.ReplaceAll(replacedSource, "__TARGET_PROJECT_NAME__", header.targetProjectName)
 	replacedSource = strings.ReplaceAll(replacedSource, "__DATE__", dateStr)
 	replacedSource = strings.ReplaceAll(replacedSource, "__YEAR__", strconv.Itoa(year))
-	replacedSource = strings.ReplaceAll(replacedSource, "__COPYRIGHT__", header.copyright)
+	replacedSource = strings.ReplaceAll(replacedSource, "__COPYRIGHT__", copyright)
 
 	return replacedSource
 }

internal/converter/header_test.go

@@ -40,12 +40,19 @@ func TestHeader(t *testing.T) {
 		// given
 		config := model.Config{
 			TargetProjectName: "Miro",
-			Copyright:         "Geektree0101",
+			Copyright:         "David Ha",
 			TemplatePath:      "",
 		}
 
 		date := time.Date(2020, 10, 12, 0, 0, 0, 0, time.UTC)
-		sut := converter.NewHeaderConverter(&config, date)
+		sut := converter.NewHeaderConverter(
+			CopyrightStub{
+				GetSuccessStub: "Geektree0101",
+				GetErrorStub:   nil,
+			},
+			&config,
+			date,
+		)
 
 		usecaseName := "ArticleDetail"
 

internal/converter/source_test.go

@@ -15,14 +15,18 @@ func createSource() *converter.SourceConverter {
 
 	config := &model.Config{
 		TargetProjectName: "Miro",
-		Copyright:         "Geektree0101",
+		Copyright:         "David Ha",
 		TemplatePath:      "../../templates",
 		SourceDir:         "./Playground/Sources",
 		TestDir:           "./Playground/Tests",
 		Indentation:       2,
 	}
 
 	header := converter.NewHeaderConverter(
+		CopyrightStub{
+			GetSuccessStub: "Geektree0101",
+			GetErrorStub:   nil,
+		},
 		config,
 		date,
 	)

internal/gen/generator.go

@@ -48,6 +48,7 @@ func (gen *Generator) Run() error {
 		gen.flag.Name,
 		strings.Split(gen.flag.UsecasesString, ","),
 		converter.NewHeaderConverter(
+			converter.CopyrightImpl{},
 			config,
 			today,
 		),

res/example.png

@@ -41,31 +41,19 @@ func NewRunnerCommand(use string) *cobra.Command {
 		Short: "generate source & unit tests files",
 		Run: func(cmd *cobra.Command, args []string) {
 
-			fmt.Printf("\033[32m%s\033[0m\n", logo)
-
 			if len(name) == 0 {
 				fmt.Println("[Error] invalid usecase name\033[0m")
 				return
 			}
 
-			gen := gen.NewGenerator(
-				gen.Genflag{
-					Name:           name,
-					UsecasesString: usecasesString,
-					SourceDir:      sourceDir,
-					TestDir:        testDir,
-					ConfigFilePath: configFilePath,
-				},
+			run(
+				name,
+				usecasesString,
+				sourceDir,
+				testDir,
+				configFilePath,
 			)
 
-			err := gen.Run()
-
-			if err != nil {
-				fmt.Printf("\033[31m[Error] failed to generate: %s\n\033[0m", err.Error())
-			} else {
-				fmt.Printf("\033[32m[Log] Done!\n\n\033[0m")
-			}
-
 		},
 	}
 
@@ -78,3 +66,74 @@ func NewRunnerCommand(use string) *cobra.Command {
 
 	return genCmd
 }
+
+// Procedural runner command
+// name: the prefix of the scene/screen
+// usecases
+// config path
+func NewProceduralRunnerCommand(use string) *cobra.Command {
+
+	var name string
+	var usecasesString string
+	var configFilePath string
+
+	genCmd := &cobra.Command{
+		Use:   use,
+		Short: "generate source & unit tests files",
+		Run: func(cmd *cobra.Command, args []string) {
+
+			fmt.Println("Please enter the prefix of the scene/screen.")
+			fmt.Println("example: ArticleDetail or ChatList or UserList and so on")
+			fmt.Print("insert: ")
+			fmt.Scanln(&name)
+
+			fmt.Println("\nPlease enter usecases")
+			fmt.Println("example: Fetch,Delete,Update")
+			fmt.Print("insert: ")
+			fmt.Scanln(&usecasesString)
+
+			fmt.Println("\nPlease enter the config file")
+			fmt.Println("example: ./some_path/some_config.yaml")
+			fmt.Print("insert: ")
+			fmt.Scanln(&configFilePath)
+
+			run(
+				name,
+				usecasesString,
+				"", // unused
+				"", // unused
+				configFilePath,
+			)
+		},
+	}
+	return genCmd
+}
+
+func run(
+	name string,
+	usecasesString string,
+	sourceDir string,
+	testDir string,
+	configFilePath string,
+) {
+
+	fmt.Printf("\033[32m%s\033[0m\n", logo)
+
+	gen := gen.NewGenerator(
+		gen.Genflag{
+			Name:           name,
+			UsecasesString: usecasesString,
+			SourceDir:      sourceDir,
+			TestDir:        testDir,
+			ConfigFilePath: configFilePath,
+		},
+	)
+
+	err := gen.Run()
+
+	if err != nil {
+		fmt.Printf("\033[31m[Error] failed to generate: %s\n\033[0m", err.Error())
+	} else {
+		fmt.Printf("\033[32m[Log] Done!\n\n\033[0m")
+	}
+}

res/output.png

@@ -27,7 +27,7 @@ final class __SCENE_NAME__PresenterTests: XCTestCase {
   override func setUp() {
     self.presenter = __SCENE_NAME__Presenter()
     self.display = __SCENE_NAME__DisplaySpy()
-    self.presenter.view = self.display
+    self.presenter.viewController = self.display
   }
 }
 

runner.go

@@ -37,7 +37,7 @@ final class ArticleDetailPresenterTests: XCTestCase {
   override func setUp() {
     self.presenter = ArticleDetailPresenter()
     self.display = ArticleDetailDisplaySpy()
-    self.presenter.view = self.display
+    self.presenter.viewController = self.display
   }
 }