add specs for git-sourced libs

Author: DannyBen

lib/bashly/commands/add.rb

@@ -11,8 +11,9 @@ class Add < Base
         Specify a different libraries source. NAME can be:
 
         * Path to a local libraries directory
-        * Github repository, in the form of 'github:user/repo'
-        * Remote git repository, in the form of 'git:clone_url.git'
+        * GitHub (HTTPS) repository:  github:user/repo[//path@ref]
+        * GitHub (SSH) repository:    github-ssh:user/repo[//path@ref]
+        * Remote git repository:      git:repo-url.git[//path@ref]
       USAGE
       option '-f --force', 'Overwrite existing files'
       option '-l --list', 'Show available libraries'

lib/bashly/library_source.rb

@@ -1,3 +1,5 @@
+require 'fileutils'
+
 module Bashly
   class LibrarySource
     attr_reader :uri
@@ -46,7 +48,7 @@ def path
     def git_clone
       dir = Dir.mktmpdir 'bashly-libs-'
       safe_run "git clone --depth 1 #{git_specs[:url]} #{dir}"
-      safe_run "git checkout #{git_specs[:ref]}" if git_specs[:ref]
+      safe_run %[git -C "#{dir}" checkout #{git_specs[:ref]}] if git_specs[:ref]
 
       "#{dir}#{git_specs[:path]}"
     end
@@ -67,7 +69,7 @@ def git_specs
     end
 
     def safe_run(cmd)
-      raise "Failed running command:\nm`#{cmd}`" unless system cmd
+      raise "Failed running command:\nm`#{cmd}`" unless system "#{cmd} > /dev/null 2>&1"
     end
 
     def transform_github_uri

spec/approvals/cli/add/help

@@ -10,8 +10,9 @@ Options:
     Specify a different libraries source. NAME can be:
 
     * Path to a local libraries directory
-    * Github repository, in the form of 'github:user/repo'
-    * Remote git repository, in the form of 'git:clone_url.git'
+    * GitHub (HTTPS) repository:  github:user/repo[//path@ref]
+    * GitHub (SSH) repository:    github-ssh:user/repo[//path@ref]
+    * Remote git repository:      git:repo-url.git[//path@ref]
 
   -f --force
     Overwrite existing files

spec/bashly/library_source_spec.rb

@@ -1,6 +1,60 @@
 require 'spec_helper'
 
 describe LibrarySource do
+  subject { described_class.new uri }
+
+  let(:uri) { nil }
+
+  after(:all) { described_class.new.cleanup }
+
+  describe '#uri' do
+    context 'when it starts with github:' do
+      let(:uri) { 'github:user/repo//the-path@the-ref' }
+
+      it 'is transformed to git over https' do
+        expect(subject.uri).to eq 'git:https://github.com/user/repo.git//the-path@the-ref'
+      end
+    end
+
+    context 'when it starts with github-ssh:' do
+      let(:uri) { 'github-ssh:user/repo//the-path@the-ref' }
+
+      it 'is transformed to git over ssh' do
+        expect(subject.uri).to eq 'git:git@github.com:user/repo.git//the-path@the-ref'
+      end
+    end
+  end
+
+  describe '#git?' do
+    it 'returns false' do
+      expect(subject).not_to be_git
+    end
+
+    context 'when the uri starts with git:' do
+      let(:uri) { 'git:/repo' }
+
+      it 'returns true' do
+        expect(subject).to be_git
+      end
+    end
+
+    context 'when the uri starts with github:' do
+      let(:uri) { 'github:/repo' }
+
+      it 'returns true' do
+        expect(subject).to be_git
+      end
+    end
+
+    context 'when the uri starts with github-ssh:' do
+      let(:uri) { 'github-ssh:/repo' }
+
+      it 'returns true' do
+        expect(subject).to be_git
+      end
+    end
+  end
+
   describe '#config' do
     it 'returns the contents of the libraries.yml file' do
       expect(subject.config).to be_a Hash
@@ -19,6 +73,28 @@
     end
   end
 
+  describe '#config_path' do
+    it 'returns the path to libraries.yml' do
+      expect(subject.config_path).to eq "#{subject.uri}/libraries.yml"
+    end
+
+    context 'with a git source' do
+      let(:uri) { 'github:dannyben/bashly//spec/fixtures/libraries@0058d77' }
+
+      it 'clones the repo to a temp directory and returns its path' do
+        expect(subject.config_path).to match %r{/tmp/bashly-libs-.*/spec/fixtures/libraries/libraries.yml}
+      end
+    end
+
+    context 'with a directory that does not contain libraries.yml' do
+      let(:uri) { 'spec' }
+
+      it 'raises an error' do
+        expect { subject.config_path }.to raise_error('Cannot find spec/libraries.yml')
+      end
+    end
+  end
+
   describe '#libraries' do
     it 'returns a hash' do
       expect(subject.libraries).to be_a Hash
@@ -35,4 +111,11 @@
       expect(subject.libraries.values.map(&:class).uniq).to eq [Library]
     end
   end
+
+  describe '#cleanup' do
+    it 'remoces all /tmp/bashly-libs-* directories' do
+      expect(FileUtils).to receive(:rm_rf).with("#{Dir.tmpdir}/bashly-libs-*")
+      subject.cleanup
+    end
+  end
 end