Add .cd helper command and .ls helper command

Not use fmt.Errorf

Author: nao1215

.octocov.yml

@@ -1,7 +1,7 @@
 # generated by octocov init
 coverage:
   if: true
-  acceptable: 83%
+  acceptable: 80%
   exclude:
     - "**/interactor/mock/*.go"
     - "**/infrastructure/mock/*.go"

README.md

@@ -102,20 +102,22 @@ sqly v0.10.0
 enter "SQL query" or "sqly command that begins with a dot".
 .help print usage, .exit exit sqly.
 
-sqly (mode: table) >
+sqly:~/github/github.com/nao1215/sqly(table)$ 
 ```
 
 The sqly shell functions similarly to a common SQL client (e.g., `sqlite3` command or `mysql` command). The sqly shell has helper commands that begin with a dot. The sqly-shell also supports command history, and input completion.  
 
 The sqly-shell has the following helper commands:
 
 ```shell
-sqly (mode: table) > .help
+sqly:~/github/github.com/nao1215/sqly(table)$ .help
+        .cd: change directory
       .dump: dump db table to file in a format according to output mode (default: csv)
       .exit: exit sqly
     .header: print table header
       .help: print help message
     .import: import file(s)
+        .ls: print directory contents
       .mode: change output mode
        .pwd: print current working directory
     .tables: print tables
@@ -151,6 +153,9 @@ $ sqly --sql "SELECT * FROM user" --output=test.csv testdata/user.csv
 |Ctrl + K	|Cut the line after the cursor to the clipboard|
 |Ctrl + U	|Cut the line before the cursor to the clipboard|
 |Ctrl + L	|Clear the screen|  
+|TAB        |Completion|
+|↑          |Previous command|
+|↓          |Next command|
 
 ## Benchmark
 CPU: AMD Ryzen 5 3400G with Radeon Vega Graphics  

di/wire_gen.go

@@ -4,21 +4,31 @@ The sqly shell functions similarly to a common SQL client (e.g., `sqlite3` comma
 The sqly-shell has the following helper commands:
 
 ```shell
-sqly (mode: table) > .help
+sqly:~/github/github.com/nao1215/sqly(table)$ .help
+        .cd: change directory
       .dump: dump db table to file in a format according to output mode (default: csv)
       .exit: exit sqly
     .header: print table header
       .help: print help message
     .import: import file(s)
+        .ls: print directory contents
       .mode: change output mode
        .pwd: print current working directory
     .tables: print tables
 ```
 
+### cd command
+
+```shell
+sqly:~/github/github.com/nao1215/sqly(table)$ .cd
+sqly:~(table)$ .cd Desktop
+sqly:Desktop(table)$ 
+```
+
 ### dump command
 
 ```shell
-sqly (mode: table) > .dump
+sqly:~/github/github.com/nao1215/sqly(table)$ .dump
 [Usage]
   .dump TABLE_NAME FILE_PATH
 [Note]
@@ -29,23 +39,23 @@ sqly (mode: table) > .dump
 ### exit command
 
 ```shell
-sqly (mode: table) > .exit
+sqly:~/github/github.com/nao1215/sqly(table)$.exit
 
 # the sqly shell is closed
 ```
 
 ### header command
 
 ```shell
-sqly (mode: table) > .header
+sqly:~/github/github.com/nao1215/sqly(table)$ .header
 [Usage]
   .header TABLE_NAME
 ```
 
 ### import command
 
 ```shell
-sqly (mode: table) > .import
+sqly:~/github/github.com/nao1215/sqly(table)$ .import
 [Usage]
   .import FILE_PATH(S) [--sheet=SHEET_NAME]
 
@@ -55,10 +65,21 @@ sqly (mode: table) > .import
   - If import an Excel file, specify the sheet name with --sheet
 ```
 
+### ls command
+
+ls command call the `ls` command or `dir` command in the shell.
+
+```shell
+sqly:~/github/github.com/nao1215/sqly/di(table)$ .ls
+合計 8
+-rw-rw-r-- 1 nao nao  661  2月  3 13:09 wire.go
+-rw-rw-r-- 1 nao nao 2292  2月  7 10:40 wire_gen.go
+```
+
 ### mode command
 
 ```shell
-sqly (mode: table) > .mode
+sqly:~/github/github.com/nao1215/sqly(table)$ .mode
 [Usage]
   .mode OUTPUT_MODE   ※ current mode=table
 [Output mode list]
@@ -74,13 +95,23 @@ sqly (mode: table) > .mode
 ### pwd command
 
 ```shell
-sqly (mode: table) > .pwd
+sqly:~/github/github.com/nao1215/sqly(table)$ .pwd
 /home/nao
 ```
 
 ### tables command
 
 ```shell
-sqly (mode: table) > .tables
+sqly:~/github/github.com/nao1215/sqly(table)$ .tables
 there is no table. use .import for importing file
+
+sqly:~/github/github.com/nao1215/sqly(table)$  .import actor.csv
+sqly:~/github/github.com/nao1215/sqly(table)$  .import numeric.csv
+sqly:~/github/github.com/nao1215/sqly(table)$  .tables
++------------+
+| TABLE NAME |
++------------+
+| actor      |
+| numeric    |
++------------+
 ```

doc/pages/markdown/sqly_helper_command.md

@@ -5,22 +5,22 @@ The sqly-shell also supports command history, and input completion.
 
 ```shell
 $ sqly 
-sqly v0.10.0
+sqly v0.11.0
 
 enter "SQL query" or "sqly command that begins with a dot".
 .help print usage, .exit exit sqly.
 
-sqly (mode: table) > .import actor.csv
-sqly (mode: table) > .import numeric.csv
-sqly (mode: table) > .tables
+sqly:~/github/github.com/nao1215/sqly(table)$  .import actor.csv
+sqly:~/github/github.com/nao1215/sqly(table)$  .import numeric.csv
+sqly:~/github/github.com/nao1215/sqly(table)$  .tables
 +------------+
 | TABLE NAME |
 +------------+
 | actor      |
 | numeric    |
 +------------+
 
-sqly (mode: table) > SELECT actor, best_movie FROM actor LIMIT 3
+sqly:~/github/github.com/nao1215/sqly(table)$  SELECT actor, best_movie FROM actor LIMIT 3
 +-------------------+------------------------------+
 |       actor       |          best_movie          |
 +-------------------+------------------------------+
@@ -29,10 +29,10 @@ sqly (mode: table) > SELECT actor, best_movie FROM actor LIMIT 3
 | Morgan Freeman    | The Dark Knight              |
 +-------------------+------------------------------+
 
-sqly (mode: table) > .mode ltsv
+sqly:~/github/github.com/nao1215/sqly(table)$  .mode ltsv
 Change output mode from table to ltsv
 
-sqly (mode: ltsv) > SELECT actor, best_movie FROM actor LIMIT 3
+sqly:~/github/github.com/nao1215/sqly(ltsv)$  SELECT actor, best_movie FROM actor LIMIT 3
 actor:Harrison Ford     best_movie:Star Wars: The Force Awakens
 actor:Samuel L. Jackson best_movie:The Avengers
 actor:Morgan Freeman    best_movie:The Dark Knight

doc/pages/markdown/sqly_shell.md

@@ -0,0 +1,31 @@
+package shell
+
+import (
+	"context"
+	"errors"
+	"os"
+)
+
+// cdCommand change directory.
+// If there is no argument, change to the home directory.
+// If there is one argument, change to the specified directory.
+// If there are multiple arguments, return an error.
+func (c CommandList) cdCommand(_ context.Context, s *Shell, argv []string) error {
+	if len(argv) == 0 {
+		home := os.Getenv("HOME")
+		if err := os.Chdir(home); err != nil {
+			return err
+		}
+		s.state.cwd = home
+		return nil
+	}
+	if len(argv) > 1 {
+		return errors.New("too many arguments")
+	}
+
+	if err := os.Chdir(argv[0]); err != nil {
+		return err
+	}
+	s.state.cwd = argv[0]
+	return nil
+}

shell/cd.go

@@ -26,11 +26,13 @@ type CommandList map[string]command
 // NewCommands return *CommandList that set sqly helper commands.
 func NewCommands() CommandList {
 	c := CommandList{}
+	c[".cd"] = command{execute: c.cdCommand, name: ".cd", description: "change directory"}
 	c[".dump"] = command{execute: c.dumpCommand, name: ".dump", description: "dump db table to file in a format according to output mode (default: csv)"}
 	c[".exit"] = command{execute: c.exitCommand, name: ".exit", description: "exit sqly"}
 	c[".header"] = command{execute: c.headerCommand, name: ".header", description: "print table header"}
 	c[".help"] = command{execute: c.helpCommand, name: ".help", description: "print help message"}
 	c[".import"] = command{execute: c.importCommand, name: ".import", description: "import file(s)"}
+	c[".ls"] = command{execute: c.lsCommand, name: ".ls", description: "print directory contents"}
 	c[".mode"] = command{execute: c.modeCommand, name: ".mode", description: "change output mode"}
 	c[".tables"] = command{execute: c.tablesCommand, name: ".tables", description: "print tables"}
 	c[".pwd"] = command{execute: c.pwdCommand, name: ".pwd", description: "print current working directory"}

shell/command.go

@@ -0,0 +1,48 @@
+package shell
+
+import (
+	"context"
+	"errors"
+	"fmt"
+	"os"
+	"os/exec"
+	"runtime"
+)
+
+// lsCommand list files and directories.
+// If there is no argument, list the files and directories in the current directory.
+// If there is one argument, list the files and directories in the specified directory.
+// If there are multiple arguments, return an error.
+func (c CommandList) lsCommand(_ context.Context, _ *Shell, argv []string) error {
+	path, err := func() (string, error) {
+		if len(argv) == 0 {
+			return ".", nil
+		}
+		if len(argv) > 1 {
+			return "", errors.New("too many arguments")
+		}
+		return argv[0], nil
+	}()
+	if err != nil {
+		return err
+	}
+
+	if err := func() error {
+		if _, err := os.Stat(path); os.IsNotExist(err) {
+			return fmt.Errorf("no such file or directory: %s", path)
+		}
+
+		var cmd *exec.Cmd
+		if runtime.GOOS == "windows" {
+			cmd = exec.Command("cmd", "/c", "dir", "/q", path)
+		} else {
+			cmd = exec.Command("ls", "-l", path)
+		}
+		cmd.Stdout = os.Stdout
+		cmd.Stderr = os.Stderr
+		return cmd.Run()
+	}(); err != nil {
+		return err
+	}
+	return nil
+}

shell/ls.go

@@ -34,6 +34,34 @@ type Shell struct {
 	config   *config.Config
 	commands CommandList
 	usecases Usecases
+	state    *state
+}
+
+// state is shell state.
+type state struct {
+	// cwd is current working directory.
+	cwd string
+}
+
+// newState return *state.
+func newState() (*state, error) {
+	dir, err := os.Getwd()
+	if err != nil {
+		return nil, err
+	}
+	return &state{
+		cwd: dir,
+	}, nil
+}
+
+// shortCWD return short current working directory.
+// If current working directory is home directory, return "~".
+func (s *state) shortCWD() string {
+	home := os.Getenv("HOME")
+	if s.cwd == home {
+		return "~"
+	}
+	return strings.Replace(s.cwd, home, "~", 1)
 }
 
 // NewShell return *Shell.
@@ -42,13 +70,18 @@ func NewShell(
 	cfg *config.Config,
 	cmds CommandList,
 	usecases Usecases,
-) *Shell {
+) (*Shell, error) {
+	state, err := newState()
+	if err != nil {
+		return nil, err
+	}
 	return &Shell{
 		argument: arg,
 		config:   cfg,
 		commands: cmds,
 		usecases: usecases,
-	}
+		state:    state,
+	}, nil
 }
 
 // Run start sqly shell.
@@ -138,7 +171,7 @@ func (s *Shell) prompt(ctx context.Context) (string, error) {
 
 	return prompt.Input(
 		func() string {
-			return fmt.Sprintf("sqly (mode: %s) > ", s.argument.Output.Mode)
+			return fmt.Sprintf("sqly:%s(%s)$ ", s.state.shortCWD(), s.argument.Output.Mode)
 		}(),
 		func(d prompt.Document) []prompt.Suggest {
 			return s.completer(ctx, d)
@@ -190,6 +223,7 @@ func (s *Shell) completer(ctx context.Context, d prompt.Document) []prompt.Sugge
 		{Text: "tsv", Description: "sqly command argument: tsv output format"},
 		{Text: "ltsv", Description: "sqly command argument: ltsv output format"},
 		{Text: "json", Description: "sqly command argument: json output format"},
+		{Text: "excel", Description: "sqly command argument: excel output format"},
 	}
 
 	for _, v := range s.commands {

shell/shell.go

@@ -791,7 +791,12 @@ func newShell(t *testing.T, args []string) (*Shell, func(), error) {
 	historyRepository := persistence.NewHistoryRepository(historyDB)
 	historyInteractor := interactor.NewHistoryInteractor(historyRepository)
 	usecases := NewUsecases(csvInteractor, tsvInteractor, ltsvInteractor, jsonInteractor, sqLite3Interactor, historyInteractor, excelInteractor)
-	shellShell := NewShell(arg, configConfig, commandList, usecases)
+	shellShell, err := NewShell(arg, configConfig, commandList, usecases)
+	if err != nil {
+		cleanup2()
+		cleanup()
+		return nil, nil, err
+	}
 	return shellShell, func() {
 		cleanup2()
 		cleanup()