From 0523fa8fe3ae991490d021e5ad5777f4e6cc2250 Mon Sep 17 00:00:00 2001
From: Danny Ben Shitrit <db@dannyben.com>
Date: Wed, 21 Oct 2020 08:22:51 +0000
Subject: [PATCH] - Allow using short name only for flags and change '%{long}'
 in flag translation to '%{name}'

---
 .../custom-strings/src/bashly-strings.yml     |  2 +-
 lib/bashly/models/flag.rb                     |  4 ++++
 lib/bashly/templates/strings.yml              |  2 +-
 lib/bashly/views/flag/case.erb                |  6 ++---
 spec/bashly/models/flag_spec.rb               | 22 +++++++++++++++++++
 5 files changed, 31 insertions(+), 5 deletions(-)

diff --git a/examples/custom-strings/src/bashly-strings.yml b/examples/custom-strings/src/bashly-strings.yml
index dd54bf37..24639ad1 100644
--- a/examples/custom-strings/src/bashly-strings.yml
+++ b/examples/custom-strings/src/bashly-strings.yml
@@ -9,7 +9,7 @@ help_flag_text: Show this helpful help
 version_flag_text: Show version number
 
 # Error messages
-flag_requires_an_argument: "Hey! the flag %{long} requires an argument: %{usage}"
+flag_requires_an_argument: "Hey! the flag %{name} requires an argument: %{usage}"
 missing_required_argument: "Boom! a required argument is missing: %{arg}\\nusage: %{usage}"
 missing_required_flag: "Yo! you forgot a flag: %{usage}"
 
diff --git a/lib/bashly/models/flag.rb b/lib/bashly/models/flag.rb
index 24f815bd..63ee7bd9 100644
--- a/lib/bashly/models/flag.rb
+++ b/lib/bashly/models/flag.rb
@@ -11,6 +11,10 @@ def aliases
         end
       end
 
+      def name
+        long || short
+      end
+
       def usage_string(extended: false)
         result = [aliases.join(", ")]
         result << arg.upcase if arg
diff --git a/lib/bashly/templates/strings.yml b/lib/bashly/templates/strings.yml
index 4b0f1bb5..8448b08f 100644
--- a/lib/bashly/templates/strings.yml
+++ b/lib/bashly/templates/strings.yml
@@ -21,7 +21,7 @@ help_flag_text: Show this help
 version_flag_text: Show version number
 
 # Error messages
-flag_requires_an_argument: "%{long} requires an argument: %{usage}"
+flag_requires_an_argument: "%{name} requires an argument: %{usage}"
 invalid_argument: "invalid argument: %s"
 invalid_flag: "invalid option: %s"
 missing_required_argument: "missing required argument: %{arg}\\nusage: %{usage}"
diff --git a/lib/bashly/views/flag/case.erb b/lib/bashly/views/flag/case.erb
index d57cb817..10ba7249 100644
--- a/lib/bashly/views/flag/case.erb
+++ b/lib/bashly/views/flag/case.erb
@@ -2,15 +2,15 @@
 <%= aliases.join " | " %> )
   <%- if arg -%>
   if [[ $2 && $2 != -* ]]; then
-    args[<%= long %>]="$2"
+    args[<%= name %>]="$2"
     shift
     shift
   else
-    printf "%s\n" "<%= strings[:flag_requires_an_argument] % { long: long, usage: usage_string } %>"
+    printf "%s\n" "<%= strings[:flag_requires_an_argument] % { name: name, usage: usage_string } %>"
     exit 1
   fi
   <%- else -%>
-  args[<%= long %>]=1
+  args[<%= name %>]=1
   shift
   <%- end -%>
   ;;
diff --git a/spec/bashly/models/flag_spec.rb b/spec/bashly/models/flag_spec.rb
index 1daa3da4..8648e750 100644
--- a/spec/bashly/models/flag_spec.rb
+++ b/spec/bashly/models/flag_spec.rb
@@ -26,6 +26,28 @@
     end
   end
 
+  describe '#name' do
+    context "with both short and long options" do
+      it "returns the long option" do
+        expect(subject.name).to eq "--help"
+      end
+    end
+
+    context "with long option only" do
+      let(:options) { {"long" => "-l"} }
+      it "returns the long option" do
+        expect(subject.name).to eq "-l"
+      end
+    end
+
+    context "with short option only" do
+      let(:options) { {"short" => "-s"} }
+      it "returns the short option" do
+        expect(subject.name).to eq "-s"
+      end
+    end
+  end
+
   describe '#usage_string' do
     it "returns a string suitable to be used as a usage pattern" do
       expect(subject.usage_string).to eq "--help, -h"