adding -r --raw flag (#16)

.assets/tests/expected_result.yml

@@ -1,3 +1,5 @@
+author: Julien Neuhart
+comment: A simple file for testing purpose
 usa:
   info: Some satellites launched by the USA (1950s)
   satellites:

.assets/tests/template.yml

@@ -1,3 +1,5 @@
+author: {{ .RawData.author }}
+comment: {{ .RawData.comment }}
 usa:
   info: {{ .EnvFiles.default.USA }}
   satellites:

.assets/tests/template_many.yml

@@ -1,3 +1,5 @@
+author: {{ .RawData.author }}
+comment: {{ .RawData.comment }}
 usa:
   info: {{ .EnvFiles.usa.USA }}
   satellites:

README.md

@@ -114,6 +114,17 @@ As you can see, it works the same way as the `-v` flag:
 * with mapping, your data will be accessible in your template through `{{ .EnvFiles.my_key.my_data }}`.
 * otherwise through `{{ .EnvFiles.default.my_data }}`.
 
+##### `-r --raw`
+
+The flag `-r` allows you to specify data directly from the CLI.
+
+```
+orbit generate [...] -r=key_1=value_1
+orbit generate [...] -r=key_1=value_1;key_2=value_2
+```
+
+Your data will be accessible in your template through `{{ .RawData.my_key }}`.
+
 ##### `-s --silent`
 
 Disables the notifications.
@@ -247,6 +258,12 @@ The flag `-e` allows you to specify one or many *.env* files.
 
 It works the same as the `-e` flag from the `generate` command.
 
+##### `-r --raw`
+
+The flag `-r` allows you to specify data directly from the CLI.
+
+It works the same as the `-r` flag from the `generate` command.
+
 ##### `-s --silent`
 
 Disables the notifications.

commands/generate.go

@@ -40,7 +40,7 @@ If no output file is given, prints the result to Stdout.
 */
 func generate(cmd *cobra.Command, args []string) error {
 	// first, let's instantiate our Orbit context.
-	ctx, err := context.NewOrbitContext(templateFilePath, ValuesFiles, EnvFiles)
+	ctx, err := context.NewOrbitContext(templateFilePath, ValuesFiles, EnvFiles, RawData)
 	if err != nil {
 		return err
 	}

commands/root.go

@@ -14,6 +14,9 @@ var (
 	// EnvFiles is the path or a map of paths of .env files listing values used in a data-driven template.
 	EnvFiles string
 
+	// RawData are a map of values used in a data-driven template.
+	RawData string
+
 	// silent disables the notifications if true.
 	silent bool
 
@@ -32,6 +35,7 @@ var (
 
 func init() {
 	RootCmd.PersistentFlags().StringVarP(&ValuesFiles, "values", "v", "", "specify a YAML file or a map of YAML files listing values used in the template")
-	RootCmd.PersistentFlags().StringVarP(&EnvFiles, "env", "e", "", "specify a .env file or a map of .env files listing values used in the the template")
+	RootCmd.PersistentFlags().StringVarP(&EnvFiles, "env", "e", "", "specify a .env file or a map of .env files listing values used in the template")
+	RootCmd.PersistentFlags().StringVarP(&RawData, "raw", "r", "", "specify a map of values used in the template")
 	RootCmd.PersistentFlags().BoolVarP(&silent, "silent", "s", false, "disable the notifications")
 }

commands/run.go

@@ -37,7 +37,7 @@ func run(cmd *cobra.Command, args []string) error {
 	}
 
 	// alright, let's instantiate our Orbit context...
-	ctx, err := context.NewOrbitContext(configFilePath, ValuesFiles, EnvFiles)
+	ctx, err := context.NewOrbitContext(configFilePath, ValuesFiles, EnvFiles, RawData)
 	if err != nil {
 		return err
 	}

context/context.go

@@ -29,6 +29,9 @@ type (
 		// EnvFiles map contains pairs from .env files.
 		EnvFiles map[string]map[string]string
 
+		// RawData contains data past directly in the CLI.
+		RawData map[string]string
+
 		// Os is the OS name at runtime.
 		Os string
 	}
@@ -46,7 +49,7 @@ type (
 )
 
 // NewOrbitContext instantiates a new OrbitContext.
-func NewOrbitContext(templateFilePath string, valuesFiles string, envFiles string) (*OrbitContext, error) {
+func NewOrbitContext(templateFilePath string, valuesFiles string, envFiles string, rawData string) (*OrbitContext, error) {
 	// as the data-driven template is mandatory, we must check its validity.
 	if templateFilePath == "" || !helpers.FileExists(templateFilePath) {
 		return nil, fmt.Errorf("template file \"%s\" does not exist", templateFilePath)
@@ -78,6 +81,16 @@ func NewOrbitContext(templateFilePath string, valuesFiles string, envFiles strin
 		ctx.EnvFiles = data
 	}
 
+	// checks if raw data have been specified.
+	if rawData != "" {
+		data, err := getRawDataMap(rawData)
+		if err != nil {
+			return nil, err
+		}
+
+		ctx.RawData = data
+	}
+
 	return ctx, nil
 }
 
@@ -166,3 +179,20 @@ func getFilesMap(s string) ([]*OrbitFileMap, error) {
 
 	return filesMap, nil
 }
+
+// getRawDataMap reads a string and populates a map of strings.
+func getRawDataMap(s string) (map[string]string, error) {
+	parts := strings.Split(s, ";")
+
+	rawDataMap := make(map[string]string)
+	for _, part := range parts {
+		data := strings.Split(part, "=")
+		if len(data) != 2 {
+			return rawDataMap, fmt.Errorf("unable to process the raw data \"%s\"", s)
+		}
+
+		rawDataMap[data[0]] = data[1]
+	}
+
+	return rawDataMap, nil
+}

generator/generator_test.go

@@ -33,16 +33,17 @@ func init() {
 	manyTmpl := helpers.Abs("../.assets/tests/template_many.yml")
 	values := helpers.Abs("../.assets/tests/values.yml")
 	envFile := helpers.Abs("../.assets/tests/.env")
+	rawData := "author=Julien Neuhart;comment=A simple file for testing purpose"
 
 	// last but not least, creates our OrbitGenerator instances.
-	ctx, err := context.NewOrbitContext(defaultTmpl, values, envFile)
+	ctx, err := context.NewOrbitContext(defaultTmpl, values, envFile, rawData)
 	if err != nil {
 		panic(err)
 	}
 
 	defaultGenerator = NewOrbitGenerator(ctx)
 
-	ctx, err = context.NewOrbitContext(manyTmpl, "ru,"+values+";usa,"+values, "ru,"+envFile+";usa,"+envFile)
+	ctx, err = context.NewOrbitContext(manyTmpl, "ru,"+values+";usa,"+values, "ru,"+envFile+";usa,"+envFile, rawData)
 	if err != nil {
 		panic(err)
 	}

runner/runner_test.go

@@ -14,7 +14,7 @@ var testRunner *OrbitRunner
 func init() {
 	config := helpers.Abs("../.assets/tests/orbit.yml")
 
-	ctx, err := context.NewOrbitContext(config, "", "")
+	ctx, err := context.NewOrbitContext(config, "", "", "")
 	if err != nil {
 		panic(err)
 	}