Merge pull request #282 from DannyBen/add/command-function

Add command function directive

Author: DannyBen

lib/bashly/config_validator.rb

@@ -119,6 +119,7 @@ def assert_command(key, value)
       assert_optional_string "#{key}.footer", value['footer']
       assert_optional_string "#{key}.group", value['group']
       assert_optional_string "#{key}.filename", value['filename']
+      assert_optional_string "#{key}.function", value['function']
 
       assert_boolean "#{key}.private", value['private']
       assert_boolean "#{key}.default", value['default']
@@ -142,6 +143,10 @@ def assert_command(key, value)
       assert_uniq "#{key}.flags", value['flags'], 'short'
       assert_uniq "#{key}.args", value['args'], 'name'
 
+      if value['function']
+        assert value['function'].match(/^[a-z0-9_]+$/), "#{key}.function must contain lowercase alphanumeric characters and underscores only" 
+      end
+
       if value['default']
         assert value['args'], "#{key}.default makes no sense without args"
       end

lib/bashly/script/command.rb

@@ -9,7 +9,7 @@ def option_keys
             alias args catch_all commands completions
             default dependencies environment_variables examples
             extensible expose filename filters flags
-            footer group help name
+            footer function group help name
             private version
             short
           ]
@@ -168,7 +168,7 @@ def flags
 
       # Returns a unique name, suitable to be used in a bash function
       def function_name
-        full_name.to_underscore
+        options['function'] || full_name.to_underscore
       end
 
       # Returns the name of the command, including its parent name (in case

spec/approvals/validations/command_function

@@ -0,0 +1 @@
+#<Bashly::ConfigurationError: root.function must contain lowercase alphanumeric characters and underscores only>

spec/bashly/script/command_spec.rb

@@ -220,6 +220,14 @@
     it "returns the full name underscored" do
       expect(subject.function_name).to eq "docker_container_run"
     end
+
+    context "when function is provided by the user's config" do
+      let(:fixture) { :custom_function }
+
+      it "returns the requested function name" do
+        expect(subject.function_name).to eq "my_custom_function"
+      end
+    end
   end
 
   describe '#full_name' do

spec/fixtures/script/commands.yml

@@ -102,6 +102,10 @@
   name: run
   filename: ops/run_command.sh
 
+:custom_function:
+  name: run
+  function: my_custom_function
+
 :custom_header:
   name: check
 

spec/fixtures/script/validations.yml

@@ -86,6 +86,11 @@
   help: command.filters should be an array of strings
   filters: [1, 2]
 
+:command_function:
+  name: invalid
+  help: command.function must match /[a-z0-9_]+/
+  function: myCamelCaseFunction
+
 :command_version:
   name: invalid
   help: version should be a string or a number