Merge branch 'master' into add/yaml-compose

Author: DannyBen

lib/bashly/script/argument.rb

@@ -4,6 +4,10 @@ class Argument < Base
       def usage_string
         required ? name.upcase : "[#{name.upcase}]"
       end
+
+      def verify
+        raise ConfigurationError, "Argument must have a name" unless name
+      end
     end
   end
 end

lib/bashly/script/command.rb

@@ -216,6 +216,7 @@ def user_lib
       # definition.
       def verify
         verify_commands if commands.any?
+        raise ConfigurationError, "Command must have a name" unless name
       end
 
       # Returns an array of all the args with a whitelist

lib/bashly/script/environment_variable.rb

@@ -6,6 +6,10 @@ def usage_string(extended: false)
         result << strings[:required] if required and extended
         result.join " "
       end
+
+      def verify
+        raise ConfigurationError, "EnvironmentVariable must have a name" unless name
+      end
     end
   end
 end

lib/bashly/script/flag.rb

@@ -21,6 +21,11 @@ def usage_string(extended: false)
         result << strings[:required] if required and extended
         result.join " "
       end
+
+      def verify
+        raise ConfigurationError, "Flag must have a long and/or short property" unless short or long
+      end
+
     end
   end
 end

spec/bashly/script/argument_spec.rb

@@ -1,20 +1,35 @@
 require 'spec_helper'
 
 describe Script::Argument do
-  let(:options) { {"name" => "file"} }
-  subject { described_class.new options }
+  let(:fixture) { :basic_argument }
+
+  subject do
+    options = load_fixture('script/arguments')[fixture]
+    described_class.new options
+  end
 
   describe '#usage_string' do
     it "returns a string suitable to be used as a usage pattern" do
       expect(subject.usage_string).to eq "[FILE]"
     end
 
     context "when the argument is required" do
-      let(:options) { {"name" => "file", "required" => true} }
+      let(:fixture) { :required }
+
       it "returns a string suitable to be used as a usage pattern" do
         expect(subject.usage_string).to eq "FILE"
       end
     end
   end
 
+  describe '#verify' do
+    context "when the argument has no name" do
+      let(:fixture) { :invalid_without_name }
+
+      it "raises an error" do
+        expect { subject.verify }.to raise_error(ConfigurationError, /must have a name/)
+      end
+    end
+  end
+
 end

spec/bashly/script/command_spec.rb

@@ -410,6 +410,14 @@
         expect { subject.verify }.to raise_error(ConfigurationError, /cannot be at the same level/)
       end
     end
+
+    context "when the command has no name" do
+      let(:fixture) { :invalid_without_name }
+
+      it "raises an error" do
+        expect { subject.verify }.to raise_error(ConfigurationError, /must have a name/)
+      end
+    end
   end
 
   describe '#whitelisted_args' do
@@ -430,5 +438,4 @@
     end
   end
 
-
 end

spec/bashly/script/flag_spec.rb

@@ -1,8 +1,12 @@
 require 'spec_helper'
 
 describe Script::Flag do
-  let(:options) { {"long" => "--help", "short" => "-h", "help" => "show this help"} }
-  subject { described_class.new options }
+  let(:fixture) { :basic_flag }
+
+  subject do
+    options = load_fixture('script/flags')[fixture]
+    described_class.new options
+  end
 
   describe '#aliases' do
     context "with long and short options" do
@@ -12,14 +16,16 @@
     end
 
     context "with long option only" do
-      let(:options) { {"long" => "--long"} }
+      let(:fixture) { :long_only }
+
       it "returns an array with the long value" do
         expect(subject.aliases).to eq ["--long"]
       end
     end
 
     context "with short option only" do
-      let(:options) { {"short" => "-s"} }
+      let(:fixture) { :short_only }
+
       it "returns an array with the short value" do
         expect(subject.aliases).to eq ["-s"]
       end
@@ -34,14 +40,16 @@
     end
 
     context "with long option only" do
-      let(:options) { {"long" => "-l"} }
+      let(:fixture) { :long_only }
+
       it "returns the long option" do
-        expect(subject.name).to eq "-l"
+        expect(subject.name).to eq "--long"
       end
     end
 
     context "with short option only" do
-      let(:options) { {"short" => "-s"} }
+      let(:fixture) { :short_only }
+
       it "returns the short option" do
         expect(subject.name).to eq "-s"
       end
@@ -61,7 +69,8 @@
       end
 
       context "when the flag is required" do
-        let(:options) { {"long" => "--mandatory", "required" => true} }
+        let(:fixture) { :required }
+
         it "appends (required) to the usage string" do
           expect(subject.usage_string extended: true).to eq "#{subject.usage_string} (required)"
         end        
@@ -70,4 +79,15 @@
     end
   end
 
+  describe '#verify' do
+    context "when the flag has no short or long" do
+      let(:fixture) { :invalid_without_name }
+
+      it "raises an error" do
+        expect { subject.verify }.to raise_error(ConfigurationError, /must have a long and\/or short property/)
+      end
+    end
+  end
+
+
 end

spec/fixtures/script/arguments.yml

@@ -0,0 +1,9 @@
+:basic_argument:
+  name: file
+
+:required:
+  name: file
+  required: true
+
+:invalid_without_name:
+  help: invalid since there is no name

spec/fixtures/script/commands.yml

@@ -71,7 +71,11 @@
   flags:
   - long: --force
 
+:invalid_without_name:
+  help: invalid since there is no name
+
 :default_command:
+  name: cli
   commands:
   - name: get
     default: true
@@ -88,6 +92,7 @@
     long: --vorld
 
 :default_values:
+  name: cli
   args:
   - name: files
     default: "*.jpg"
@@ -98,6 +103,7 @@
     default: png
 
 :whitelist:
+  name: cli
   args:
   - name: region
     allowed: [eu, us]

spec/fixtures/script/flags.yml

@@ -0,0 +1,17 @@
+:basic_flag:
+  long: --help
+  short: -h
+  help: show this help
+
+:long_only:
+  long: --long
+
+:short_only:
+  short: -s
+
+:required:
+  long: --mandatory
+  required: true
+
+:invalid_without_name:
+  help: invalid since there is no name