Merge pull request #340 from DannyBen/add/external-libraries

Add support for adding libraries from a custom directory

Author: DannyBen

lib/bashly/commands/add.rb

@@ -3,10 +3,17 @@ module Commands
     class Add < Base
       help 'Add extra features and customization to your script'
 
-      usage 'bashly add LIBRARY [ARGS...] [--force]'
-      usage 'bashly add --list'
+      usage 'bashly add [--source NAME] LIBRARY [ARGS...] [--force]'
+      usage 'bashly add [--source NAME] --list'
       usage 'bashly add (-h|--help)'
 
+      option '-s --source NAME', <<~USAGE
+        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'
+      USAGE
       option '-f --force', 'Overwrite existing files'
       option '-l --list', 'Show available libraries'
 
@@ -22,14 +29,19 @@ def run
 
     private
 
+      def source
+        args['--source']
+      end
+
       def lib_source
-        @lib_source ||= Bashly::LibrarySource.new
+        @lib_source ||= Bashly::LibrarySource.new source
       end
 
       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 word_wrap("  #{config['help']}")
           say ''

lib/bashly/library_source.rb

@@ -4,10 +4,15 @@ class LibrarySource
 
     def initialize(path = nil)
       @path = path || File.expand_path('libraries', __dir__)
+      raise "Cannot find #{config_path}" unless File.exist? config_path
     end
 
     def config
-      @config ||= YAML.properly_load_file("#{path}/libraries.yml")
+      @config ||= YAML.properly_load_file config_path
+    end
+
+    def config_path
+      @config_path ||= "#{path}/libraries.yml"
     end
 
     def libraries

spec/approvals/cli/add/from-extenal-path

@@ -0,0 +1 @@
+created spec/tmp/src/lib/database.sh

spec/approvals/cli/add/help

@@ -1,11 +1,18 @@
 Add extra features and customization to your script
 
 Usage:
-  bashly add LIBRARY [ARGS...] [--force]
-  bashly add --list
+  bashly add [--source NAME] LIBRARY [ARGS...] [--force]
+  bashly add [--source NAME] --list
   bashly add (-h|--help)
 
 Options:
+  -s --source NAME
+    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'
+
   -f --force
     Overwrite existing files
 

spec/approvals/cli/add/list-path

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

spec/approvals/cli/add/usage

@@ -1,4 +1,4 @@
 Usage:
-  bashly add LIBRARY [ARGS...] [--force]
-  bashly add --list
+  bashly add [--source NAME] LIBRARY [ARGS...] [--force]
+  bashly add [--source NAME] --list
   bashly add (-h|--help)

spec/bashly/commands/add_spec.rb

@@ -29,6 +29,13 @@
     it 'shows list of available libraries' do
       expect { subject.execute %w[add --list] }.to output_approval('cli/add/list')
     end
+
+    context 'with --source path' do
+      it 'shows the list from the specified path' do
+        expect { subject.execute %w[add --source spec/fixtures/libraries --list] }
+          .to output_approval('cli/add/list-path')
+      end
+    end
   end
 
   context 'with colors command' do
@@ -184,4 +191,13 @@
       expect(File).to exist(lib_file)
     end
   end
+
+  context 'with a library from an external --source path' do
+    before { reset_tmp_dir create_src: true }
+
+    it 'properly installs the library' do
+      expect { subject.execute %w[add --source spec/fixtures/libraries database] }
+        .to output_approval('cli/add/from-extenal-path')
+    end
+  end
 end

spec/bashly/library_source_spec.rb

@@ -6,6 +6,17 @@
       expect(subject.config).to be_a Hash
       expect(subject.config.keys.first).to eq 'colors'
     end
+
+    context 'with an external path' do
+      subject { described_class.new path }
+
+      let(:path) { 'spec/fixtures/libraries' }
+
+      it 'reads the config from the specified path' do
+        expect(subject.config).to be_a Hash
+        expect(subject.config.keys).to eq ['database']
+      end
+    end
   end
 
   describe '#libraries' do

spec/fixtures/libraries/database/database.sh

@@ -0,0 +1 @@
+# dummy

spec/fixtures/libraries/libraries.yml

@@ -0,0 +1,5 @@
+database:
+  help: Add database utilities
+  files:
+    - source: "database/database.sh"
+      target: "%{user_lib_dir}/database.%{user_ext}"