Merge pull request #5 from chclaus/feature/refactor-subcommand-and-flags

Feature/refactor subcommand and flags

Author: chclaus

.goreleaser.yml

@@ -32,6 +32,7 @@ archive:
   files:
     - LICENSE.txt
     - README.md
+    - examples/config-sample.yaml
 
 # Homebrew customization
 brew:

README.md

@@ -26,7 +26,7 @@ tools.
 - [License](#license)
 
 # Example
-<img src="demo_v0_2_0.gif?raw=" width="726px"></img>
+<img src="demo_v1_0_0.gif?raw=" width="672px"></img>
 
 ## Installation
 If you've go installed and your `$GOPATH` is set, you can easily install
@@ -111,9 +111,6 @@ Date conversions:
 - time nanos to RFC 3339
 - RFC 3339 to time millis
 
-### Regex command
-TODO
-
 ### HTML command
 Escapes and unescapes HTML
 - transforms a string to an escaped html sequence
@@ -124,18 +121,29 @@ Escapes and unescapes HTML
 Starts a simple web server to serve static content. You can specify
 hostname and port and must set a folder to serve.
 
-
 ## Configuration
 You can configure a some default behaviors of dt to fit your needs.
 Just place a file `.dt.yaml` into your home directory, you can configure
 the following options:
 
 ```yaml
 server:
-  address: 0.0.0.0
-  port: 3000
+  port: 3001
+  address: 127.0.0.1
+uuid:
+  namespace: cacae610-c76a-4736-90ef-0271126b4346
+  version: 4
+base64:
+  encoding: std
+random:
+  algorithm: complex
+  length: 20
+hash:
+  algorithm: bcrypt
+  cost: 12
 ```
 
+For more informations, please take a look in the examples directory.
 
 ## Contributing
 Everyone is welcome to create pull requests for this project. If you're
@@ -146,5 +154,7 @@ If you've got an idea of a function that should find it's way into this
 project, but you won't implement it by yourself, please create a new
 issue.
 
+Please ensure, that all contributions match the MIT license.
+
 ## License
 dt (dev-toolbelt) is released under the MIT license. See [LICENSE.txt](LICENSE.txt)

cmd/base64/base64.go

@@ -43,4 +43,7 @@ var base64Cmd = &cobra.Command{
 
 func init() {
 	cmd.RootCmd.AddCommand(base64Cmd)
+
+	base64Cmd.PersistentFlags().StringP("format", "f", "std",
+		"the encoding format. Possible values are: std, stdRaw, url, urlRaw")
 }

cmd/base64/decode.go

@@ -0,0 +1,80 @@
+// Copyright © 2018 Christian Claus <[email protected]>
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+
+package base64
+
+import (
+	"fmt"
+
+	"encoding/base64"
+	"errors"
+	"github.com/chclaus/dt/utils"
+	"github.com/spf13/cobra"
+	"os"
+)
+
+// decodeCmd represents the std decode command
+var decodeCmd = &cobra.Command{
+	Use:   "decode",
+	Short: "Decodes an encoded base64 string",
+	Long: `Decodes an encoded base64 string. As default, the standard encoding 'std',
+defined in RFC 4648 is used. All possible encodings are:
+
+  std         Uses the standard base64 encoding, as defined in RFC 4648
+  stdRaw      Uses the standard raw, unpadded base64 encoding as defined in RFC 4648 section 3.2
+  url         Uses the alternate base64 encoding defined in RFC 4648. Typically used in URLs and filenames
+  urlRaw      Uses the standard raw, unpadded alternate base64 encoding defined in RFC 4648
+`,
+	Args: func(cmd *cobra.Command, args []string) error {
+		if len(args) != 1 {
+			return errors.New("you have to specify a string which should be decoded")
+		}
+
+		return nil
+	},
+	Run: func(cmd *cobra.Command, args []string) {
+		format := cmd.Flag("format").Value.String()
+		switch format {
+		case "std":
+			fmt.Println(utils.DecodeBase64(base64.StdEncoding, args[0]))
+			break
+		case "stdRaw":
+			fmt.Println(utils.DecodeBase64(base64.RawStdEncoding, args[0]))
+			break
+		case "url":
+			fmt.Println(utils.DecodeBase64(base64.URLEncoding, args[0]))
+			break
+		case "urlRaw":
+			fmt.Println(utils.DecodeBase64(base64.RawURLEncoding, args[0]))
+			break
+		default:
+			fmt.Println(fmt.Errorf("the given format '%s' is unknown.", format))
+			os.Exit(1)
+		}
+	},
+	Example: `dt base64 decode -f std foo
+dt base64 decode -f stdRaw foo
+dt base64 decode -f url foo
+dt base64 decode -f urlRaw foo`,
+}
+
+func init() {
+	base64Cmd.AddCommand(decodeCmd)
+}

cmd/base64/encode.go

@@ -0,0 +1,80 @@
+// Copyright © 2018 Christian Claus <[email protected]>
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+
+package base64
+
+import (
+	"fmt"
+
+	"encoding/base64"
+	"errors"
+	"github.com/chclaus/dt/utils"
+	"github.com/spf13/cobra"
+	"os"
+)
+
+// encodeCmd represents the std encode command
+var encodeCmd = &cobra.Command{
+	Use:   "encode",
+	Short: "Encodes a decoded base64 string",
+	Long: `Encodes a decoded base64 string. As default, the standard encoding 'std',
+defined in RFC 4648 is used. All possible encodings are:
+
+  std         Uses the standard base64 encoding, as defined in RFC 4648
+  stdRaw      Uses the standard raw, unpadded base64 encoding as defined in RFC 4648 section 3.2
+  url         Uses the alternate base64 encoding defined in RFC 4648. Typically used in URLs and filenames
+  urlRaw      Uses the standard raw, unpadded alternate base64 encoding defined in RFC 4648
+`,
+	Args: func(cmd *cobra.Command, args []string) error {
+		if len(args) != 1 {
+			return errors.New("you have to specify a string which should be encoded")
+		}
+
+		return nil
+	},
+	Run: func(cmd *cobra.Command, args []string) {
+		format := cmd.Flag("format").Value.String()
+		switch format {
+		case "std":
+			fmt.Println(utils.EncodeBase64(base64.StdEncoding, args[0]))
+			break
+		case "stdRaw":
+			fmt.Println(utils.EncodeBase64(base64.RawStdEncoding, args[0]))
+			break
+		case "url":
+			fmt.Println(utils.EncodeBase64(base64.URLEncoding, args[0]))
+			break
+		case "urlRaw":
+			fmt.Println(utils.EncodeBase64(base64.RawURLEncoding, args[0]))
+			break
+		default:
+			fmt.Println(fmt.Errorf("the given format '%s' is unknown.", format))
+			os.Exit(1)
+		}
+	},
+	Example: `dt base64 encode -f std foo
+dt base64 encode -f stdRaw foo
+dt base64 encode -f url foo
+dt base64 encode -f urlRaw foo`,
+}
+
+func init() {
+	base64Cmd.AddCommand(encodeCmd)
+}