extract opts, args and helptext to cmdsutils subpackage

this way we can share the code with the legace commands package and don't have to convert everything

Author: keks

chan.go

@@ -3,6 +3,8 @@ package cmds
 import (
 	"fmt"
 	"io"
+
+	"github.com/ipfs/go-ipfs-cmds/cmdsutil"
 )
 
 func NewChanResponsePair(req *Request) (ResponseEmitter, Response) {
@@ -25,7 +27,7 @@ func NewChanResponsePair(req *Request) (ResponseEmitter, Response) {
 type chanResponse struct {
 	req *Request
 
-	err    *Error
+	err    *cmdsutil.Error
 	length uint64
 
 	ch <-chan interface{}
@@ -35,7 +37,7 @@ func (r *chanResponse) Request() *Request {
 	return r.req
 }
 
-func (r *chanResponse) Error() *Error {
+func (r *chanResponse) Error() *cmdsutil.Error {
 	return r.err
 }
 
@@ -56,18 +58,18 @@ type chanResponseEmitter struct {
 	ch chan<- interface{}
 
 	length *uint64
-	err    **Error
+	err    **cmdsutil.Error
 
 	emitted bool
 }
 
-func (re *chanResponseEmitter) SetError(err interface{}, t ErrorType) {
+func (re *chanResponseEmitter) SetError(err interface{}, t cmdsutil.ErrorType) {
 	// don't change value after emitting
 	if re.emitted {
 		return
 	}
 
-	*re.err = &Error{Message: fmt.Sprint(err), Code: t}
+	*re.err = &cmdsutil.Error{Message: fmt.Sprint(err), Code: t}
 }
 
 func (re *chanResponseEmitter) SetLength(l uint64) {

channelmarshaler.go

@@ -1,5 +1,6 @@
 package cmds
 
+/*
 import "io"
 
 type ChannelMarshaler struct {
@@ -37,3 +38,4 @@ func (cr *ChannelMarshaler) Read(p []byte) (int, error) {
 	}
 	return n, nil
 }
+*/

argument.go renamed to cmdsutil/argument.go

@@ -1,4 +1,4 @@
-package cmds
+package cmdsutil
 
 type ArgumentType int
 

error.go renamed to cmdsutil/error.go

@@ -1,4 +1,4 @@
-package cmds
+package cmdsutil
 
 // ErrorType signfies a category of errors
 type ErrorType uint

cmdsutil/helptext.go

@@ -0,0 +1,18 @@
+package cmdsutil
+
+// HelpText is a set of strings used to generate command help text. The help
+// text follows formats similar to man pages, but not exactly the same.
+type HelpText struct {
+	// required
+	Tagline               string            // used in <cmd usage>
+	ShortDescription      string            // used in DESCRIPTION
+	SynopsisOptionsValues map[string]string // mappings for synopsis generator
+
+	// optional - whole section overrides
+	Usage           string // overrides USAGE section
+	LongDescription string // overrides DESCRIPTION section
+	Options         string // overrides OPTIONS section
+	Arguments       string // overrides ARGUMENTS section
+	Subcommands     string // overrides SUBCOMMANDS section
+	Synopsis        string // overrides SYNOPSIS field
+}

option.go renamed to cmdsutil/option.go

@@ -1,4 +1,4 @@
-package cmds
+package cmdsutil
 
 import (
 	"fmt"
@@ -18,6 +18,8 @@ const (
 	String  = reflect.String
 )
 
+type OptMap map[string]interface{}
+
 // Option is used to specify a field that will be provided by a consumer
 type Option interface {
 	Names() []string            // a list of unique names matched with user-provided flags
@@ -109,75 +111,75 @@ func StringOption(names ...string) Option {
 }
 
 type OptionValue struct {
-	value interface{}
-	found bool
-	def   Option
+	Value      interface{}
+	ValueFound bool
+	Def        Option
 }
 
 // Found returns true if the option value was provided by the user (not a default value)
 func (ov OptionValue) Found() bool {
-	return ov.found
+	return ov.ValueFound
 }
 
 // Definition returns the option definition for the provided value
 func (ov OptionValue) Definition() Option {
-	return ov.def
+	return ov.Def
 }
 
 // value accessor methods, gets the value as a certain type
 func (ov OptionValue) Bool() (value bool, found bool, err error) {
-	if !ov.found && ov.value == nil {
+	if !ov.ValueFound && ov.Value == nil {
 		return false, false, nil
 	}
-	val, ok := ov.value.(bool)
+	val, ok := ov.Value.(bool)
 	if !ok {
 		err = util.ErrCast()
 	}
-	return val, ov.found, err
+	return val, ov.ValueFound, err
 }
 
 func (ov OptionValue) Int() (value int, found bool, err error) {
-	if !ov.found && ov.value == nil {
+	if !ov.ValueFound && ov.Value == nil {
 		return 0, false, nil
 	}
-	val, ok := ov.value.(int)
+	val, ok := ov.Value.(int)
 	if !ok {
 		err = util.ErrCast()
 	}
-	return val, ov.found, err
+	return val, ov.ValueFound, err
 }
 
 func (ov OptionValue) Uint() (value uint, found bool, err error) {
-	if !ov.found && ov.value == nil {
+	if !ov.ValueFound && ov.Value == nil {
 		return 0, false, nil
 	}
-	val, ok := ov.value.(uint)
+	val, ok := ov.Value.(uint)
 	if !ok {
 		err = util.ErrCast()
 	}
-	return val, ov.found, err
+	return val, ov.ValueFound, err
 }
 
 func (ov OptionValue) Float() (value float64, found bool, err error) {
-	if !ov.found && ov.value == nil {
+	if !ov.ValueFound && ov.Value == nil {
 		return 0, false, nil
 	}
-	val, ok := ov.value.(float64)
+	val, ok := ov.Value.(float64)
 	if !ok {
 		err = util.ErrCast()
 	}
-	return val, ov.found, err
+	return val, ov.ValueFound, err
 }
 
 func (ov OptionValue) String() (value string, found bool, err error) {
-	if !ov.found && ov.value == nil {
+	if !ov.ValueFound && ov.Value == nil {
 		return "", false, nil
 	}
-	val, ok := ov.value.(string)
+	val, ok := ov.Value.(string)
 	if !ok {
 		err = util.ErrCast()
 	}
-	return val, ov.found, err
+	return val, ov.ValueFound, err
 }
 
 // Flag names
@@ -195,15 +197,3 @@ var OptionEncodingType = StringOption(EncLong, EncShort, "The encoding type the
 var OptionRecursivePath = BoolOption(RecLong, RecShort, "Add directory paths recursively").Default(false)
 var OptionStreamChannels = BoolOption(ChanOpt, "Stream channel output")
 var OptionTimeout = StringOption(TimeoutOpt, "set a global timeout on the command")
-
-// global options, added to every command
-var globalOptions = []Option{
-	OptionEncodingType,
-	OptionStreamChannels,
-	OptionTimeout,
-}
-
-// the above array of Options, wrapped in a Command
-var globalCommand = &Command{
-	Options: globalOptions,
-}

option_test.go renamed to cmdsutil/option_test.go

@@ -1,4 +1,4 @@
-package cmds
+package cmdsutil
 
 import (
 	"strings"

command.go

@@ -13,6 +13,8 @@ import (
 	"fmt"
 	"reflect"
 
+	"github.com/ipfs/go-ipfs-cmds/cmdsutil"
+
 	oldcmds "github.com/ipfs/go-ipfs/commands"
 	"github.com/ipfs/go-ipfs/path"
 	logging "gx/ipfs/QmSpJByNKFX1sCsHBEp3R73FL4NF6FnQTEGyNAXHm2GS52/go-log"
@@ -24,28 +26,11 @@ var log = logging.Logger("command")
 // It reads from the Request, and writes results to the ResponseEmitter.
 type Function func(Request, ResponseEmitter)
 
-// HelpText is a set of strings used to generate command help text. The help
-// text follows formats similar to man pages, but not exactly the same.
-type HelpText struct {
-	// required
-	Tagline               string            // used in <cmd usage>
-	ShortDescription      string            // used in DESCRIPTION
-	SynopsisOptionsValues map[string]string // mappings for synopsis generator
-
-	// optional - whole section overrides
-	Usage           string // overrides USAGE section
-	LongDescription string // overrides DESCRIPTION section
-	Options         string // overrides OPTIONS section
-	Arguments       string // overrides ARGUMENTS section
-	Subcommands     string // overrides SUBCOMMANDS section
-	Synopsis        string // overrides SYNOPSIS field
-}
-
 // Command is a runnable command, with input arguments and options (flags).
 // It can also have Subcommands, to group units of work into sets.
 type Command struct {
-	Options   []Option
-	Arguments []Argument
+	Options   []cmdsutil.Option
+	Arguments []cmdsutil.Argument
 	PreRun    func(req Request) error
 
 	// Run is the function that processes the request to generate a response.
@@ -55,7 +40,7 @@ type Command struct {
 	Run      interface{}
 	PostRun  interface{}
 	Encoders map[EncodingType]Encoder
-	Helptext HelpText
+	Helptext cmdsutil.HelpText
 
 	// External denotes that a command is actually an external binary.
 	// fewer checks and validations will be performed on such commands.
@@ -170,7 +155,7 @@ func (c *Command) Call(req Request, re ResponseEmitter) error {
 		} else if ch, ok := output.(chan interface{}); ok {
 			output = (<-chan interface{})(ch)
 		} else {
-			re.SetError(ErrIncorrectType, ErrNormal)
+			re.SetError(ErrIncorrectType, cmdsutil.ErrNormal)
 			return ErrIncorrectType
 		}
 
@@ -186,7 +171,7 @@ func (c *Command) Call(req Request, re ResponseEmitter) error {
 			expectedType := reflect.TypeOf(cmd.Type)
 
 			if actualType != expectedType {
-				re.SetError(ErrIncorrectType, ErrNormal)
+				re.SetError(ErrIncorrectType, cmdsutil.ErrNormal)
 				return ErrIncorrectType
 			}
 		}
@@ -195,6 +180,7 @@ func (c *Command) Call(req Request, re ResponseEmitter) error {
 	}
 
 	return nil
+
 }
 
 // Resolve returns the subcommands at the given path
@@ -227,8 +213,8 @@ func (c *Command) Get(path []string) (*Command, error) {
 }
 
 // GetOptions returns the options in the given path of commands
-func (c *Command) GetOptions(path []string) (map[string]Option, error) {
-	options := make([]Option, 0, len(c.Options))
+func (c *Command) GetOptions(path []string) (map[string]cmdsutil.Option, error) {
+	options := make([]cmdsutil.Option, 0, len(c.Options))
 
 	cmds, err := c.Resolve(path)
 	if err != nil {
@@ -240,7 +226,7 @@ func (c *Command) GetOptions(path []string) (map[string]Option, error) {
 		options = append(options, cmd.Options...)
 	}
 
-	optionsMap := make(map[string]Option)
+	optionsMap := make(map[string]cmdsutil.Option)
 	for _, opt := range options {
 		for _, name := range opt.Names() {
 			if _, found := optionsMap[name]; found {
@@ -271,7 +257,7 @@ func (c *Command) CheckArguments(req Request) error {
 		// skip optional argument definitions if there aren't
 		// sufficient remaining values
 		if len(args)-valueIndex <= numRequired && !argDef.Required ||
-			argDef.Type == ArgFile {
+			argDef.Type == cmdsutil.ArgFile {
 			continue
 		}
 
@@ -334,7 +320,7 @@ func (c *Command) ProcessHelp() {
 
 // checkArgValue returns an error if a given arg value is not valid for the
 // given Argument
-func checkArgValue(v string, found bool, def Argument) error {
+func checkArgValue(v string, found bool, def cmdsutil.Argument) error {
 	if def.Variadic && def.SupportsStdin {
 		return nil
 	}
@@ -347,5 +333,17 @@ func checkArgValue(v string, found bool, def Argument) error {
 }
 
 func ClientError(msg string) error {
-	return &Error{Code: ErrClient, Message: msg}
+	return &cmdsutil.Error{Code: cmdsutil.ErrClient, Message: msg}
+}
+
+// global options, added to every command
+var globalOptions = []cmdsutil.Option{
+	cmdsutil.OptionEncodingType,
+	cmdsutil.OptionStreamChannels,
+	cmdsutil.OptionTimeout,
+}
+
+// the above array of Options, wrapped in a Command
+var globalCommand = &Command{
+	Options: globalOptions,
 }