feat(search): add optional setting that formats each search result on…

… a single line, Part II
hopeseekr-contribs · Nov 5, 2021 · 22c165a · 22c165a
1 parent 1c238dd
commit 22c165a
Show file tree

Hide file tree

Showing 14 changed files with 450 additions and 59 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -70,15 +70,10 @@ All code should be formatted through `go fmt`. This tool will automatically
 format code for you. We recommend, however, that you write code in the proper
 style and use `go fmt` only to catch mistakes.
 
-`make lint` will check your code against `go fmt`. You may need to install
-[`golangci-lint`] as a dependency.
-
 Use [pre-commit](https://pre-commit.com/) to validate your commits against the various
 linters configured for this repository.
 
 ### Testing
 
 Run `make test` to test Yay. This command will verify that the code is
 formatted correctly, run the code through `go vet`, and run unit tests.
-
-[`golangci-lint`]: https://github.com/golangci/golangci-lint
diff --git a/cmd.go b/cmd.go
@@ -5,6 +5,7 @@ import (
 	"context"
 	"fmt"
 	"net/http"
+	"os"
 	"strings"
 
 	alpm "github.com/Jguer/go-alpm/v2"
@@ -99,6 +100,8 @@ Permanent configuration options:
     --nocleanafter        Do not remove package sources after successful build
     --bottomup            Shows AUR's packages first and then repository's
     --topdown             Shows repository's packages first and then AUR's
+    --singlelineresults   List each search result on its own line
+    --doublelineresults   List each search result on two lines, like pacman
 
     --devel               Check development packages during sysupgrade
     --nodevel             Do not check development packages
@@ -119,8 +122,6 @@ Permanent configuration options:
     --nocombinedupgrade   Perform the repo upgrade and AUR upgrade separately
     --batchinstall        Build multiple AUR packages then install them together
     --nobatchinstall      Build and install each AUR package one by one
-    --singlelineresults   List each search result on its own line
-    --doublelineresults   List each search result on two lines, like pacman
 
     --sudo                <file>  sudo command to use
     --sudoflags           <flags> Pass arguments to sudo
@@ -356,11 +357,11 @@ func handleRemove(ctx context.Context, cmdArgs *parser.Arguments, localCache *vc
 
 // NumberMenu presents a CLI for selecting packages to install.
 func displayNumberMenu(ctx context.Context, pkgS []string, dbExecutor db.Executor, cmdArgs *parser.Arguments) error {
-	queryBuilder := query.NewSourceQueryBuilder(config.SortMode, config.SortBy, config.Runtime.Mode, config.SearchBy)
+	queryBuilder := query.NewSourceQueryBuilder(config.SortMode, config.SortBy, config.Runtime.Mode, config.SearchBy, config.SingleLineResults)
 
 	queryBuilder.Execute(ctx, dbExecutor, config.Runtime.AURClient, pkgS)
 
-	if err := queryBuilder.Results(dbExecutor, query.NumberMenu); err != nil {
+	if err := queryBuilder.Results(os.Stdout, dbExecutor, query.NumberMenu); err != nil {
 		return err
 	}
 

diff --git a/completions/bash b/completions/bash
@@ -70,13 +70,13 @@ _yay() {
   common=('arch cachedir color config confirm dbpath debug gpgdir help hookdir logfile
           noconfirm noprogressbar noscriptlet quiet root verbose
           makepkg pacman git gpg gpgflags config requestsplitn sudoloop nosudoloop
-          redownload noredownload redownloadall rebuild rebuildall rebuildtree norebuild
-          sortby answerclean answerdiff answeredit answerupgrade noanswerclean noanswerdiff
+          redownload noredownload redownloadall rebuild rebuildall rebuildtree norebuild sortby
+          singlelineresults doublelineresults answerclean answerdiff answeredit answerupgrade noanswerclean noanswerdiff
           noansweredit noanswerupgrade cleanmenu diffmenu editmenu upgrademenu cleanafter nocleanafter
           nocleanmenu nodiffmenu noupgrademenu provides noprovides pgpfetch nopgpfetch
           useask nouseask combinedupgrade nocombinedupgrade aur repo makepkgconf
           nomakepkgconf askremovemake removemake noremovemake completioninterval aururl
-          searchby batchinstall nobatchinstall singlelineresults doublelineresults'
+          searchby batchinstall nobatchinstall'
     'b d h q r v')
   yays=('clean gendb' 'c')
   show=('complete defaultconfig currentconfig stats news' 'c d g s w')

diff --git a/completions/fish b/completions/fish
@@ -218,6 +218,8 @@ complete -c $progname -n "not $noopt" -l removemake -d 'Remove make deps after i
 complete -c $progname -n "not $noopt" -l noremovemake -d 'Do not remove make deps after install' -f
 complete -c $progname -n "not $noopt" -l topdown -d 'Shows repository packages first and then aur' -f
 complete -c $progname -n "not $noopt" -l bottomup -d 'Shows aur packages first and then repository' -f
+complete -c $progname -n "not $noopt" -l singlelineresults -d 'List each search result on its own line' -f
+complete -c $progname -n "not $noopt" -l doublelineresults -d 'List each search result on two lines, like pacman' -f
 complete -c $progname -n "not $noopt" -l devel -d 'Check -git/-svn/-hg development version' -f
 complete -c $progname -n "not $noopt" -l nodevel -d 'Disable development version checking' -f
 complete -c $progname -n "not $noopt" -l cleanafter -d 'Clean package sources after successful build' -f
@@ -237,8 +239,6 @@ complete -c $progname -n "not $noopt" -l combinedupgrade -d 'Refresh then perfor
 complete -c $progname -n "not $noopt" -l nocombinedupgrade -d 'Perform the repo upgrade and AUR upgrade separately' -f
 complete -c $progname -n "not $noopt" -l batchinstall -d 'Build multiple AUR packages then install them together' -f
 complete -c $progname -n "not $noopt" -l nobatchinstall -d 'Build and install each AUR package one by one' -f
-complete -c $progname -n "not $noopt" -l singlelineresults -d 'List each search result on its own line' -f
-complete -c $progname -n "not $noopt" -l doublelineresults -d 'List each search result on two lines, like pacman' -f
 complete -c $progname -n "not $noopt" -l rebuild -d 'Always build target packages' -f
 complete -c $progname -n "not $noopt" -l rebuildall -d 'Always build all AUR packages' -f
 complete -c $progname -n "not $noopt" -l rebuildtree -d 'Always build all AUR packages even if installed' -f

diff --git a/completions/zsh b/completions/zsh
@@ -79,6 +79,8 @@ _pacman_opts_common=(
 
 	'--bottomup[Show AUR packages first]'
 	'--topdown[Show repository packages first]'
+	'--singlelineresults[List each search result on its own line]'
+	'--doublelineresults[List each search result on two lines, like pacman]'
 	'--devel[Check -git/-svn/-hg development version]'
 	'--nodevel[Disable development version checking]'
 	'--cleanafter[Clean package sources after successful build]'
@@ -108,8 +110,6 @@ _pacman_opts_common=(
 	'--sortby[Sort AUR results by a specific field during search]'
 	'--batchinstall[Build multiple AUR packages then install them together]'
 	'--nobatchinstall[Build and install each AUR package one by one]'
-	'--singlelineresults[List each search result on its own line]'
-	'--doublelineresults[List each search result on two lines, like pacman]'
 )
 
 # options for passing to _arguments: options for --upgrade commands

diff --git a/doc/yay.8 b/doc/yay.8
@@ -335,6 +335,16 @@ Display repository packages first and then AUR packages.
 .B \-\-bottomup
 Show AUR packages first and then repository packages.
 
+.TP
+.B \-\-singlelineresults
+Override pacman's usual double-line search result format and list each result
+on its own line.
+
+.TP
+.B \-\-doublelineresults
+Follow pacman's double-line search result format and list each result using
+two lines.
+
 .TP
 .B \-\-devel
 During sysupgrade also check AUR development packages for updates. Currently
@@ -449,16 +459,6 @@ another package, install all the packages in the install queue.
 .B \-\-nobatchinstall
 Always install AUR packages immediately after building them.
 
-.TP
-.B \-\-singlelineresults
-Override pacman's usual double-line search result format and list each result
-on its own line.
-
-.TP
-.B \-\-doublelineresults
-Follow pacman's double-line search result format and list each result using
-two lines.
-
 .TP
 .B \-\-rebuild
 Always build target packages even when a copy is available in cache.

diff --git a/go.sum b/go.sum
@@ -34,12 +34,8 @@ golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJ
 golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.0.0-20210809222454-d867a43fc93e h1:WUoyKPm6nCo1BnNUvPGnFG3T5DUVem42yDJZZ4CNxMA=
-golang.org/x/sys v0.0.0-20210809222454-d867a43fc93e/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20211007075335-d3039528d8ac h1:oN6lz7iLW/YC7un8pq+9bOLyXrprv2+DKfkJY+2LJJw=
 golang.org/x/sys v0.0.0-20211007075335-d3039528d8ac/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/term v0.0.0-20210615171337-6886f2dfbf5b h1:9zKuko04nR4gjZ4+DNjHqRlAJqbJETHwiNKDqTfOjfE=
-golang.org/x/term v0.0.0-20210615171337-6886f2dfbf5b/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
 golang.org/x/term v0.0.0-20210927222741-03fcf44c2211 h1:JGgROgKl9N8DuW20oFS5gxc+lE67/N3FcwmBPMe7ArY=
 golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=

diff --git a/pkg/db/mock/executor.go b/pkg/db/mock/executor.go
@@ -0,0 +1,105 @@
+package mock
+
+import (
+	"time"
+
+	"github.com/Jguer/yay/v11/pkg/db"
+
+	"github.com/Jguer/go-alpm/v2"
+)
+
+type (
+	IPackage = alpm.IPackage
+	Depend   = alpm.Depend
+	Upgrade  = db.Upgrade
+)
+
+type DBExecutor struct{}
+
+func (t DBExecutor) AlpmArchitectures() ([]string, error) {
+	panic("implement me")
+}
+
+func (t DBExecutor) BiggestPackages() []IPackage {
+	panic("implement me")
+}
+
+func (t DBExecutor) Cleanup() {
+	panic("implement me")
+}
+
+func (t DBExecutor) IsCorrectVersionInstalled(s, s2 string) bool {
+	panic("implement me")
+}
+
+func (t DBExecutor) LastBuildTime() time.Time {
+	panic("implement me")
+}
+
+func (t DBExecutor) LocalPackage(s string) IPackage {
+	return nil
+}
+
+func (t DBExecutor) LocalPackages() []IPackage {
+	panic("implement me")
+}
+
+func (t DBExecutor) LocalSatisfierExists(s string) bool {
+	panic("implement me")
+}
+
+func (t DBExecutor) PackageConflicts(iPackage IPackage) []Depend {
+	panic("implement me")
+}
+
+func (t DBExecutor) PackageDepends(iPackage IPackage) []Depend {
+	panic("implement me")
+}
+
+func (t DBExecutor) PackageGroups(iPackage IPackage) []string {
+	return []string{}
+}
+
+func (t DBExecutor) PackageOptionalDepends(iPackage IPackage) []Depend {
+	panic("implement me")
+}
+
+func (t DBExecutor) PackageProvides(iPackage IPackage) []Depend {
+	panic("implement me")
+}
+
+func (t DBExecutor) PackagesFromGroup(s string) []IPackage {
+	panic("implement me")
+}
+
+func (t DBExecutor) RefreshHandle() error {
+	panic("implement me")
+}
+
+func (t DBExecutor) RepoUpgrades(b bool) ([]Upgrade, error) {
+	panic("implement me")
+}
+
+func (t DBExecutor) Repos() []string {
+	panic("implement me")
+}
+
+func (t DBExecutor) SatisfierFromDB(s, s2 string) IPackage {
+	panic("implement me")
+}
+
+func (t DBExecutor) SyncPackage(s string) IPackage {
+	panic("implement me")
+}
+
+func (t DBExecutor) SyncPackages(s ...string) []IPackage {
+	panic("implement me")
+}
+
+func (t DBExecutor) SyncSatisfier(s string) IPackage {
+	panic("implement me")
+}
+
+func (t DBExecutor) SyncSatisfierExists(s string) bool {
+	panic("implement me")
+}
diff --git a/pkg/db/mock/repo.go b/pkg/db/mock/repo.go
@@ -9,7 +9,7 @@ import (
 type Package struct {
 	PBase         string
 	PBuildDate    time.Time
-	PDB           alpm.IDB
+	PDB           *DB
 	PDescription  string
 	PISize        int64
 	PName         string
@@ -186,3 +186,16 @@ func (p *Package) SyncNewVersion(l alpm.IDBList) alpm.IPackage {
 func (p *Package) Type() string {
 	panic("not implemented") // TODO: Implement
 }
+
+type DB struct {
+	alpm.IDB
+	name string
+}
+
+func NewDB(name string) *DB {
+	return &DB{name: name}
+}
+
+func (d *DB) Name() string {
+	return d.name
+}
diff --git a/pkg/query/source.go b/pkg/query/source.go
@@ -2,6 +2,7 @@ package query
 
 import (
 	"context"
+	"io"
 	"sort"
 	"strings"
 
@@ -28,18 +29,26 @@ const (
 type SourceQueryBuilder struct {
 	repoQuery
 	aurQuery
-	sortMode   int
-	sortBy     string
-	targetMode parser.TargetMode
-	searchBy   string
+	sortMode          int
+	sortBy            string
+	targetMode        parser.TargetMode
+	searchBy          string
+	singleLineResults bool
 }
 
-func NewSourceQueryBuilder(sortMode int, sortBy string, targetMode parser.TargetMode, searchBy string) *SourceQueryBuilder {
+func NewSourceQueryBuilder(
+	sortMode int,
+	sortBy string,
+	targetMode parser.TargetMode,
+	searchBy string,
+	singleLineResults bool,
+) *SourceQueryBuilder {
 	return &SourceQueryBuilder{
-		sortMode:   sortMode,
-		sortBy:     sortBy,
-		targetMode: targetMode,
-		searchBy:   searchBy,
+		sortMode:          sortMode,
+		sortBy:            sortBy,
+		targetMode:        targetMode,
+		searchBy:          searchBy,
+		singleLineResults: singleLineResults,
 	}
 }
 
@@ -62,27 +71,27 @@ func (s *SourceQueryBuilder) Execute(ctx context.Context, dbExecutor db.Executor
 	}
 }
 
-func (s *SourceQueryBuilder) Results(dbExecutor db.Executor, verboseSearch SearchVerbosity) error {
+func (s *SourceQueryBuilder) Results(w io.Writer, dbExecutor db.Executor, verboseSearch SearchVerbosity) error {
 	if s.aurQuery == nil && s.repoQuery == nil {
 		return ErrNoQuery{}
 	}
 
 	switch s.sortMode {
 	case settings.TopDown:
 		if s.targetMode.AtLeastRepo() {
-			s.repoQuery.printSearch(dbExecutor, verboseSearch, s.sortMode)
+			s.repoQuery.printSearch(w, dbExecutor, verboseSearch, s.sortMode, s.singleLineResults)
 		}
 
 		if s.targetMode.AtLeastAUR() {
-			s.aurQuery.printSearch(1, dbExecutor, verboseSearch, s.sortMode)
+			s.aurQuery.printSearch(w, 1, dbExecutor, verboseSearch, s.sortMode, s.singleLineResults)
 		}
 	case settings.BottomUp:
 		if s.targetMode.AtLeastAUR() {
-			s.aurQuery.printSearch(1, dbExecutor, verboseSearch, s.sortMode)
+			s.aurQuery.printSearch(w, 1, dbExecutor, verboseSearch, s.sortMode, s.singleLineResults)
 		}
 
 		if s.targetMode.AtLeastRepo() {
-			s.repoQuery.printSearch(dbExecutor, verboseSearch, s.sortMode)
+			s.repoQuery.printSearch(w, dbExecutor, verboseSearch, s.sortMode, s.singleLineResults)
 		}
 	default:
 		return ErrInvalidSortMode{}