Add some specs for improved branch-level coverage (#214)

Author: DannyBen

lib/bashly/script/command.rb

@@ -40,7 +40,7 @@ def args
 
       # Returns a string suitable to be a headline
       def caption_string
-        help ? "#{full_name} - #{summary}" : full_name
+        help.empty? ? full_name : "#{full_name} - #{summary}"
       end
 
       def catch_all

spec/approvals/cli/generate/nested

@@ -0,0 +1,7 @@
+creating user files in spec/tmp/src
+created spec/tmp/src/initialize.sh
+created spec/tmp/src/download_command.sh
+created spec/tmp/src/upload_ftp_command.sh
+created spec/tmp/src/upload_ssh_command.sh
+created spec/tmp/cli
+run spec/tmp/cli --help to test your bash script

spec/bashly/commands/generate_spec.rb

@@ -61,6 +61,19 @@
         expect(File).to exist(cli_script)
       end
     end
+
+    context "with 2 levels of nested commands" do
+      let(:file) { "#{target_dir}/src/upload_command.sh" }
+
+      before do
+        system "cp spec/fixtures/nested.yml #{source_dir}/bashly.yml"
+      end
+
+      it "does not generate the file for the middle command" do
+        expect { subject.run %w[generate] }.to output_approval('cli/generate/nested')
+        expect(File).to_not exist(file)
+      end
+    end
   end
 
   context "with --quiet" do

spec/bashly/extensions/array_spec.rb

@@ -6,5 +6,11 @@
     it "prepends each element with spaces" do
       expect(subject.indent 2).to eq ["  root:", "    indented:"]
     end
+
+    context "when offset is 0" do
+      it "returns the array as is" do
+        expect(subject.indent 0).to eq subject
+      end
+    end
   end
 end

spec/bashly/extensions/string_spec.rb

@@ -3,27 +3,37 @@
 describe String do
   describe '#sanitize_for_print' do
     subject { %Q[this is\na "new line"] }
+    
     it "escapes newlines and quotes" do
       expect(subject.sanitize_for_print).to eq "this is\\na \\\"new line\\\""
     end
   end
 
   describe '#indent' do
     subject { "hello" }
+    
     it "prepends the string with spaces" do
       expect(subject.indent 3).to eq "   hello"
     end
+
+    context "when offset is 0" do
+      it "returns the string as is" do
+        expect(subject.indent 0).to eq subject
+      end
+    end
   end
 
   describe '#wrap' do
     subject { "a long line of text that is going to be wrapped, fingers crossed!" }
+    
     it "wraps the string to the specified length" do
       expect(subject.wrap 30).to eq "a long line of text that is\ngoing to be wrapped, fingers\ncrossed!"
     end
 
     # GH-79
     context "with an uninterrupted string" do
       subject { "a long line of text with a nice uninterrupted-string-like-a-url-for-example" }
+      
       it "does not break the uninterrupted portion" do
         expect(subject.wrap 30).to eq "a long line of text with a\nnice\nuninterrupted-string-like-a-url-for-example"
       end
@@ -84,6 +94,7 @@
 
     context "with a string that contains front matter" do
       subject { "#{front_matter}\n---\n#{rest}" }
+      
       let(:front_matter) { "this is the front matter" }
       let(:rest) { "this is\nthe script" }
 
@@ -94,6 +105,7 @@
 
     context "with a string that contains front matter with a leading separator" do
       subject { "---\n#{front_matter}\n---\n#{rest}" }
+      
       let(:front_matter) { "this is the front matter" }
       let(:rest) { "this is\nthe script" }
 

spec/bashly/script/argument_spec.rb

@@ -21,4 +21,18 @@
       end
     end
   end
+
+  describe '#label' do
+    it "returns a string suitable to be used as a compact usage pattern" do
+      expect(subject.label).to eq "FILE"
+    end
+
+    context "with a repeatable arg" do
+      let(:fixture) { :repeatable }
+
+      it "adds a ... suffix" do
+        expect(subject.label).to eq "FILE..."
+      end
+    end
+  end
 end

spec/bashly/script/base_spec.rb

@@ -10,6 +10,24 @@
     end
   end
 
+  describe '#initialize' do
+    context "with invalid options" do
+      let(:options) { "not-a-hash" }
+      
+      it "raises an error" do
+        expect { subject }.to raise_error(Bashly::Error, /Invalid options/)
+      end
+    end
+  end
+
+  describe '#method_missing' do
+    context "when the method is not a valid option key" do
+      it "raises an error" do
+        expect { subject.no_such_option }.to raise_error(NoMethodError)
+      end
+    end
+  end
+
   describe '#optional' do
     context "when required is false" do
       it "returns true" do

spec/bashly/script/command_spec.rb

@@ -59,6 +59,14 @@
     it "returns a string containing the name and summary" do
       expect(subject.caption_string).to eq "get - get something from somewhere"
     end
+
+    context "when help is not defined" do
+      let(:fixture) { :helpless }
+
+      it "returns the full name only" do
+        expect(subject.caption_string).to eq "helpless"
+      end
+    end
   end
 
   describe '#command_names' do
@@ -320,6 +328,14 @@
         expect(subject.usage_string).to eq "docker [command]"
       end      
     end
+
+    context "when catch_all is enabled" do
+      let(:fixture) { :catch_all }
+
+      it "includes the catch_all usage string" do
+        expect(subject.usage_string).to eq "get [...]"
+      end
+    end
   end
 
   describe '#whitelisted_args' do

spec/bashly/script/flag_spec.rb

@@ -68,13 +68,21 @@
         end
       end
 
-      context "when the flag is required" do
+      context "when the flag is also required" do
         let(:fixture) { :required }
 
         it "appends (required) to the usage string" do
           expect(subject.usage_string extended: true).to eq "#{subject.usage_string} (required)"
         end        
       end
+
+      context "when the flag is also repeatable" do
+        let(:fixture) { :repeatable }
+
+        it "appends (repeatable) to the usage string" do
+          expect(subject.usage_string extended: true).to eq "#{subject.usage_string} (repeatable)"
+        end        
+      end
 
     end
   end

spec/fixtures/nested.yml

@@ -0,0 +1,15 @@
+name: cli
+help: Sample application
+version: 0.1.0
+
+commands:
+- name: download
+  short: d
+  help: Download a file
+
+- name: upload
+  short: u
+  help: Upload a file
+  commands:
+  - name: ftp
+  - name: ssh