Merge pull request #79 from viktomas/core-split

Splitting the `core` package into `files` and `commands`

Author: viktomas

CONTRIBUTING.md

@@ -8,11 +8,12 @@ Why for nomral use it is ok to call `go get` without go modules, if you are goin
 ![godu architecture](godu_architecture.png)
 
 Main things to consider when implementing new functionality is packages, there are 3:
-* `core` - this is the true godu. Everything that does the main job is here. If godu wasn't CLI utility but GUI app, this package would ideally stay untouched
+* `files` - godu's file system representation and algorythms for making and changing the file tree structure
+* `commands` - application state representation and functions to change it, all based on the command design pattern
 * `interactive` - this is functionality connected to UI of the app
 * `main` - this contains main wiring + tcell.Screen related functionality, **this is the only package that is not expected to have 100% test coverage**
 
-#### Before doing significant changes to core (specially changing the main structures like File and State, please consult the change in form of Github Issue
+#### Before doing significant changes to `files` and `commands` packages (specially changing the main structures like File and State, please consult the change in form of Github Issue
 
 ## Main ideas
 ### State is immutable
@@ -22,12 +23,12 @@ Main things to consider when implementing new functionality is packages, there a
 ### the root folder structure should only represent the file system
 You would notice that in `godu.go` we are walking through the whole folder using
 ```
-rootFolder := core.WalkFolder(rootFolderName, ioutil.ReadDir, getIgnoredFolders())
+rootFolder := files.WalkFolder(rootFolderName, ioutil.ReadDir, getIgnoredFolders())
 ```
-The expectation is that the `core.File` structure contains only representation of the file system and it is not going to change after calling `WalkFolder`
+The expectation is that the `files.File` structure contains only representation of the file system and it is not going to change after calling `WalkFolder`
 
 ### Everything that commands do should be represented in State
 When implementing new command please make sure that it's result is captured in a state and that the state is appropriately displayed using `InteractiveFolder` (e.g. highlighting selected line in file column)
 
 ## 100% test coverage
-Expectation is that `core` and `interactive` packages will have 100% test coverage. I'm not a testing nazi but I won't have time to checkout every PR and manually retest it and neither will you. We need to be confident that `godu` still works after merging your (and any subsequent) PR.
+Expectation is that `files`, `commands` and `interactive` packages will have 100% test coverage. I'm not a testing nazi but I won't have time to checkout every PR and manually retest it and neither will you. We need to be confident that `godu` still works after merging your (and any subsequent) PR.

core/command.go renamed to commands/command.go

@@ -1,13 +1,17 @@
-package core
+package commands
 
-import "errors"
+import (
+	"errors"
+
+	"github.com/viktomas/godu/files"
+)
 
 // State represents system configuration after processing user input
 type State struct {
-	Folder      *File
+	Folder      *files.File
 	Selected    int
-	history     map[*File]int // last cursor location in each folder
-	MarkedFiles map[*File]struct{}
+	history     map[*files.File]int // last cursor location in each folder
+	MarkedFiles map[*files.File]struct{}
 }
 
 // Executer represents a user action triggered on a State
@@ -62,7 +66,7 @@ func (e Enter) Execute(oldState State) (State, error) {
 	if len(newFolder.Files) == 0 {
 		return oldState, errors.New("Trying to enter empty file")
 	}
-	newHistory := map[*File]int{}
+	newHistory := map[*files.File]int{}
 	for fp, selected := range oldState.history {
 		newHistory[fp] = selected
 	}
@@ -80,7 +84,7 @@ func (GoBack) Execute(oldState State) (State, error) {
 	if parentFolder == nil {
 		return oldState, errors.New("Trying to go back on root")
 	}
-	newHistory := map[*File]int{}
+	newHistory := map[*files.File]int{}
 	for fp, selected := range oldState.history {
 		newHistory[fp] = selected
 	}

core/command_test.go renamed to commands/command_test.go

@@ -1,13 +1,14 @@
-package core
+package commands
 
 import (
 	"testing"
 
 	"github.com/stretchr/testify/assert"
+	"github.com/viktomas/godu/files"
 )
 
 func TestDownCommand(t *testing.T) {
-	folder := NewTestFolder("a", NewTestFile("b", 50), NewTestFile("c", 50))
+	folder := files.NewTestFolder("a", files.NewTestFile("b", 50), files.NewTestFile("c", 50))
 	initialState := State{
 		Folder: folder,
 	}
@@ -17,7 +18,7 @@ func TestDownCommand(t *testing.T) {
 }
 
 func TestDownCommandFails(t *testing.T) {
-	folder := NewTestFolder("a", NewTestFile("b", 50), NewTestFile("c", 50))
+	folder := files.NewTestFolder("a", files.NewTestFile("b", 50), files.NewTestFile("c", 50))
 	initialState := State{
 		Folder:   folder,
 		Selected: 1,
@@ -28,7 +29,7 @@ func TestDownCommandFails(t *testing.T) {
 }
 
 func TestUpCommand(t *testing.T) {
-	folder := NewTestFolder("a", NewTestFile("b", 50), NewTestFile("c", 50))
+	folder := files.NewTestFolder("a", files.NewTestFile("b", 50), files.NewTestFile("c", 50))
 	initialState := State{
 		Folder:   folder,
 		Selected: 1,
@@ -38,7 +39,7 @@ func TestUpCommand(t *testing.T) {
 }
 
 func TestUpCommandFails(t *testing.T) {
-	folder := NewTestFolder("a", NewTestFile("b", 50), NewTestFile("c", 50))
+	folder := files.NewTestFolder("a", files.NewTestFile("b", 50), files.NewTestFile("c", 50))
 	initialState := State{
 		Folder:   folder,
 		Selected: 0,
@@ -49,28 +50,28 @@ func TestUpCommandFails(t *testing.T) {
 }
 
 func TestEnterCommand(t *testing.T) {
-	folder := NewTestFolder("a", NewTestFile("b", 50), NewTestFolder("c", NewTestFile("d", 50), NewTestFile("e", 50)))
+	folder := files.NewTestFolder("a", files.NewTestFile("b", 50), files.NewTestFolder("c", files.NewTestFile("d", 50), files.NewTestFile("e", 50)))
 	subFolder := folder.Files[1]
-	marked := make(map[*File]struct{})
+	marked := make(map[*files.File]struct{})
 	initialState := State{
 		Folder:      folder,
-		history:     map[*File]int{subFolder: 1},
+		history:     map[*files.File]int{subFolder: 1},
 		Selected:    1,
 		MarkedFiles: marked,
 	}
 	command := Enter{}
 	newState, _ := command.Execute(initialState)
 	expectedState := State{
 		Folder:      subFolder,
-		history:     map[*File]int{folder: 1, subFolder: 1},
+		history:     map[*files.File]int{folder: 1, subFolder: 1},
 		Selected:    1,
 		MarkedFiles: marked,
 	}
 	assert.Equal(t, expectedState, newState)
 }
 
 func TestEnterCommandFails(t *testing.T) {
-	folder := NewTestFolder("a", NewTestFile("b", 50))
+	folder := files.NewTestFolder("a", files.NewTestFile("b", 50))
 	initialState := State{
 		Folder: folder,
 	}
@@ -80,28 +81,28 @@ func TestEnterCommandFails(t *testing.T) {
 }
 
 func TestGoBackCommand(t *testing.T) {
-	folder := NewTestFolder("a", NewTestFile("b", 50), NewTestFolder("c", NewTestFile("d", 50), NewTestFile("e", 50)))
+	folder := files.NewTestFolder("a", files.NewTestFile("b", 50), files.NewTestFolder("c", files.NewTestFile("d", 50), files.NewTestFile("e", 50)))
 	subFolder := folder.Files[1]
-	marked := make(map[*File]struct{})
+	marked := make(map[*files.File]struct{})
 	initialState := State{
 		Folder:      subFolder,
-		history:     map[*File]int{folder: 1},
+		history:     map[*files.File]int{folder: 1},
 		Selected:    1,
 		MarkedFiles: marked,
 	}
 	command := GoBack{}
 	newState, _ := command.Execute(initialState)
 	expectedState := State{
 		Folder:      folder,
-		history:     map[*File]int{folder: 1, subFolder: 1},
+		history:     map[*files.File]int{folder: 1, subFolder: 1},
 		Selected:    1,
 		MarkedFiles: marked,
 	}
 	assert.Equal(t, expectedState, newState)
 }
 
 func TestGoBackOnRoot(t *testing.T) {
-	folder := NewTestFolder("a", NewTestFile("b", 50))
+	folder := files.NewTestFolder("a", files.NewTestFile("b", 50))
 	initialState := State{
 		Folder: folder,
 	}
@@ -111,11 +112,11 @@ func TestGoBackOnRoot(t *testing.T) {
 }
 
 func TestMarkFile(t *testing.T) {
-	folder := NewTestFolder("a", NewTestFile("b", 50))
+	folder := files.NewTestFolder("a", files.NewTestFile("b", 50))
 	initialState := State{
 		Folder:      folder,
 		Selected:    0,
-		MarkedFiles: make(map[*File]struct{}),
+		MarkedFiles: make(map[*files.File]struct{}),
 	}
 	command := Mark{}
 	newState, _ := command.Execute(initialState)

core/processor.go renamed to commands/processor.go

@@ -1,23 +1,25 @@
-package core
+package commands
 
 import (
 	"fmt"
 	"sync"
+
+	"github.com/viktomas/godu/files"
 )
 
 // ProcessFolder removes small files and sorts folder content based on accumulated size
-func ProcessFolder(folder *File, limit int64) error {
-	pruneFolder(folder, limit)
+func ProcessFolder(folder *files.File, limit int64) error {
+	files.PruneSmallFiles(folder, limit)
 	if len(folder.Files) == 0 {
-		return fmt.Errorf("the folder '%s' doesn't contain any files bigger than %dMB", folder.Name, limit/MEGABYTE)
+		return fmt.Errorf("the folder '%s' doesn't contain any files bigger than %dMB", folder.Name, limit/files.MEGABYTE)
 	}
-	SortDesc(folder)
+	files.SortDesc(folder)
 	return nil
 }
 
 // StartProcessing reads user commands and applies them to state
 func StartProcessing(
-	folder *File,
+	folder *files.File,
 	commands <-chan Executer,
 	states chan<- State,
 	lastStateChan chan<- *State,
@@ -26,7 +28,7 @@ func StartProcessing(
 	defer wg.Done()
 	state := State{
 		Folder:      folder,
-		MarkedFiles: make(map[*File]struct{}),
+		MarkedFiles: make(map[*files.File]struct{}),
 	}
 	states <- state
 	for {

core/processor_test.go renamed to commands/processor_test.go

@@ -1,25 +1,26 @@
-package core
+package commands
 
 import (
 	"sync"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
+	"github.com/viktomas/godu/files"
 )
 
 func TestProcessFolder(t *testing.T) {
-	folder := NewTestFolder("a", NewTestFile("b", 10), NewTestFile("c", 50), NewTestFile("d", 70))
+	folder := files.NewTestFolder("a", files.NewTestFile("b", 10), files.NewTestFile("c", 50), files.NewTestFile("d", 70))
 	ProcessFolder(folder, 30)
-	c := &File{"c", nil, 50, false, []*File{}}
-	d := &File{"d", nil, 70, false, []*File{}}
-	a := &File{"a", nil, 130, true, []*File{d, c}}
+	c := &files.File{"c", nil, 50, false, []*files.File{}}
+	d := &files.File{"d", nil, 70, false, []*files.File{}}
+	a := &files.File{"a", nil, 130, true, []*files.File{d, c}}
 	d.Parent = a
 	c.Parent = a
 	assert.Equal(t, a, folder, "ProcessFoler didn't prune and sort folder")
 }
 
 func TestProcessFolderShouldFailWithSmallFiles(t *testing.T) {
-	folder := NewTestFolder("a", NewTestFile("b", 70))
+	folder := files.NewTestFolder("a", files.NewTestFile("b", 70))
 	err := ProcessFolder(folder, 80)
 	assert.NotNil(t, err, "ProcessFolder didn't result in error when run on folder with too small files")
 }
@@ -28,7 +29,7 @@ func TestStartProcessing(t *testing.T) {
 	commands := make(chan Executer)
 	states := make(chan State, 2)
 	lastStateChan := make(chan<- *State, 1)
-	folder := NewTestFolder("a", NewTestFile("b", 10), NewTestFile("c", 50))
+	folder := files.NewTestFolder("a", files.NewTestFile("b", 10), files.NewTestFile("c", 50))
 	var wg sync.WaitGroup
 	wg.Add(1)
 	go StartProcessing(folder, commands, states, lastStateChan, &wg)
@@ -48,7 +49,7 @@ func TestDoesntProcessInvalidCommand(t *testing.T) {
 	lastStateChan := make(chan<- *State, 1)
 	var wg sync.WaitGroup
 	wg.Add(1)
-	folder := NewTestFolder("a", NewTestFile("b", 10), NewTestFile("c", 50))
+	folder := files.NewTestFolder("a", files.NewTestFile("b", 10), files.NewTestFile("c", 50))
 	go StartProcessing(folder, commands, states, lastStateChan, &wg)
 	<-states
 	commands <- Enter{}

core/const.go renamed to files/const.go

@@ -1,7 +1,7 @@
-package core
+package files
 
 const (
-	_ = iota
+	_        = iota
 	KILOBYTE = 1 << (10 * iota)
 	MEGABYTE
 	GIGABYTE

core/file_walker.go renamed to files/file_walker.go

@@ -1,4 +1,4 @@
-package core
+package files
 
 import (
 	"log"

core/file_walker_test.go renamed to files/file_walker_test.go

@@ -1,4 +1,4 @@
-package core
+package files
 
 import (
 	"errors"

core/test_utils.go renamed to files/test_utils.go

@@ -1,4 +1,4 @@
-package core
+package files
 
 // NewTestFolder is providing easy interface to create folders for automated tests
 // Never use in production code!

core/test_utils_test.go renamed to files/test_utils_test.go

@@ -1,4 +1,4 @@
-package core
+package files
 
 import (
 	"testing"