Merge pull request #341 from DannyBen/add/git-libs

Add support for git-sourced libraries

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'
@@ -25,6 +26,8 @@ def run
         else
           add_lib args['LIBRARY']
         end
+
+        lib_source.cleanup if lib_source.git?
       end
 
     private
@@ -41,8 +44,7 @@ def show_list
         lib_source.config.each do |key, config|
           usage = key
           usage += " #{config['usage']}" if config['usage']
-          usage = "--source #{source} #{usage}" if source
-          say "g`bashly add #{usage}`"
+          say "g`#{usage}`"
           say word_wrap("  #{config['help']}")
           say ''
         end

lib/bashly/library_source.rb

@@ -1,24 +1,83 @@
+require 'fileutils'
+
 module Bashly
   class LibrarySource
-    attr_reader :path
+    attr_reader :uri
 
-    def initialize(path = nil)
-      @path = path || File.expand_path('libraries', __dir__)
-      raise "Cannot find #{config_path}" unless File.exist? config_path
+    def initialize(uri = nil)
+      @uri = uri || File.expand_path('libraries', __dir__)
+      transform_github_uri if /^github(:|-)/.match? @uri
     end
 
-    def config
-      @config ||= YAML.properly_load_file config_path
+    def git?
+      /^(git|github|github-ssh):/.match? uri
     end
 
-    def config_path
-      @config_path ||= "#{path}/libraries.yml"
+    def config
+      @config ||= YAML.properly_load_file config_path
     end
 
     def libraries
       config.to_h do |name, spec|
         [name.to_sym, Library.new(path, spec)]
       end
     end
+
+    def config_path
+      @config_path ||= if File.exist?("#{path}/libraries.yml")
+        "#{path}/libraries.yml"
+      else
+        raise "Cannot find #{path}/libraries.yml"
+      end
+    end
+
+    def cleanup
+      FileUtils.rm_rf(File.join(Dir.tmpdir, 'bashly-libs-*'))
+    end
+
+  private
+
+    def path
+      @path ||= if uri.start_with? 'git:'
+        git_clone
+      else
+        uri
+      end
+    end
+
+    def git_clone
+      dir = Dir.mktmpdir 'bashly-libs-'
+      safe_run "git clone --depth 1 #{git_specs[:url]} #{dir}"
+      safe_run %[git -C "#{dir}" checkout #{git_specs[:ref]}] if git_specs[:ref]
+
+      "#{dir}#{git_specs[:path]}"
+    end
+
+    def git_specs
+      @git_specs ||= begin
+        parts = uri.match(%r{git:(?<url>.*\.git)(?:/)?(?<path>/[^@]+)?@?(?<ref>.*)})
+        raise 'Invalid source' unless parts
+
+        url = parts[:url]
+        raise 'Invalid git URL' unless url
+
+        path = parts[:path]
+        ref = parts[:ref].empty? ? nil : parts[:ref]
+
+        { url: url, path: path, ref: ref }
+      end
+    end
+
+    def safe_run(cmd)
+      raise "Failed running command:\nm`#{cmd}`" unless system "#{cmd} > /dev/null 2>&1"
+    end
+
+    def transform_github_uri
+      if (matches = uri.match(%r{github-ssh:(?<user>[^/]+)/(?<repo>[^/]+)(?<rest>.*)}))
+        @uri = "git:git@github.com:#{matches[:user]}/#{matches[:repo]}.git#{matches[:rest]}"
+      elsif (matches = uri.match(%r{github:(?<user>[^/]+)/(?<repo>[^/]+)(?<rest>.*)}))
+        @uri = "git:https://github.com/#{matches[:user]}/#{matches[:repo]}.git#{matches[:rest]}"
+      end
+    end
   end
 end

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/approvals/cli/add/list

@@ -1,42 +1,42 @@
-bashly add colors
+colors
   Add standard functions for printing colorful and formatted text to the lib
   directory.
 
-bashly add completions [PATH]
+completions [PATH]
   Generate a bash completions function.
 
-bashly add completions_script [PATH]
+completions_script [PATH]
   Generate a standalone bash completions script.
 
-bashly add completions_yaml [PATH]
+completions_yaml [PATH]
   Generate a completions YAML configuration for Completely.
 
-bashly add config
+config
   Add standard functions for handling INI files to the lib directory.
 
-bashly add help
+help
   Add a help command, in addition to the standard --help flag.
 
-bashly add lib
+lib
   Create the lib directory for any additional user scripts.
   All *.sh scripts in this directory will be included in the final bash script.
   Note that if you configured a different partials_extension, then the
   extensions of the files in this directory need to match.
 
-bashly add settings
+settings
   Copy a sample settings.yml file to your project, allowing you to customize
   some bashly options.
 
-bashly add strings
+strings
   Copy an additional configuration file to your project, allowing you to
   customize all the tips and error strings.
 
-bashly add test
+test
   Add approval testing.
 
-bashly add validations
+validations
   Add argument validation functions to the lib directory.
 
-bashly add yaml
+yaml
   Add standard functions for reading YAML files.
 

spec/approvals/cli/add/list-path

@@ -1,3 +1,3 @@
-bashly add --source spec/fixtures/libraries database
+database
   Add database utilities
 

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