Merge pull request #173 from DannyBen/add/more-validations

Add validations for flag and arg names

Author: DannyBen

lib/bashly/config_validator.rb

@@ -81,6 +81,8 @@ def assert_arg(key, value)
       assert_boolean "#{key}.required", value['required']
 
       assert_array "#{key}.allowed", value['allowed'], of: :string
+
+      refute value['name'].match(/^-/), "#{key}.name must not start with '-'"
     end
 
     def assert_flag(key, value)
@@ -96,6 +98,10 @@ def assert_flag(key, value)
 
       assert_boolean "#{key}.required", value['required']
       assert_array "#{key}.allowed", value['allowed'], of: :string
+
+      assert value['long'].match(/^--[a-zA-Z0-9_\-]+$/), "#{key}.long must be in the form of '--name'" if value['long']
+      assert value['short'].match(/^-[a-zA-Z0-9]$/), "#{key}.short must be in the form of '-n'" if value['short']
+      refute value['arg'].match(/^-/), "#{key}.arg must not start with '-'" if value['arg']
     end
 
     def assert_env_var(key, value)

spec/approvals/validations/invalid_arg

@@ -0,0 +1 @@
+#<Bashly::ConfigurationError: root.args[0].name must not start with '-'>

spec/approvals/validations/invalid_flag_arg

@@ -0,0 +1 @@
+#<Bashly::ConfigurationError: root.flags[0].arg must not start with '-'>

spec/approvals/validations/invalid_long_flag

@@ -0,0 +1 @@
+#<Bashly::ConfigurationError: root.flags[0].long must be in the form of '--name'>

spec/approvals/validations/invalid_short_flag

@@ -0,0 +1 @@
+#<Bashly::ConfigurationError: root.flags[0].short must be in the form of '-n'>

spec/fixtures/script/validations.yml

@@ -36,3 +36,28 @@
             - name: ok
             - help: invalid since there is no name
 
+:invalid_long_flag:
+  name: invalid
+  help: invalid since the long flag is not in the form of --force
+  flags:
+  - long: force
+
+:invalid_short_flag:
+  name: invalid
+  help: invalid since the short flag is not in the form of -f
+  flags:
+  - short: f
+
+:invalid_flag_arg:
+  name: invalid
+  help: invalid since the flag.arg should not start with --
+  flags:
+  - long: --user
+    arg: --name
+
+:invalid_arg:
+  name: invalid
+  help: invalid since the arg.name should not start with --
+  args:
+  - name: --user
+