vundle-cli 0.0.6 → 0.0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c75d3d265b458ba55a4ce2e79d746650fdb1250
-  data.tar.gz: 4795a1f6a38add4462c5842eb9c364278310d174
+  metadata.gz: c1da6a2d4b8bba91de6d6e04ff69f43871c8c8d0
+  data.tar.gz: f3365cbef0211b7a066ac193972610f3b042a7fd
 SHA512:
-  metadata.gz: 8763579a37533c6b81b12821b84640576818fecbb3fc5f58dadfbdf39a5603f2ab0e3e361197dbbfad07df2b318f586e9f9f96995755815f5848d29bcd45e16e
-  data.tar.gz: 9e4f9f63a71c68db50cd7259c65f6454a6ddb9c64c8904134d642388bb1381e4cd7fd5769ee67b7fb615d2674dd08a2cfc28d5263f2be5841479afb353291ca0
+  metadata.gz: a2eef73a0c08858783fc1eb6d50a8af7f9532eeebe54e91c430f98fa6d7b5c4cbceaa293a3fdfea5eaa94f6bf92b83939d50f58d55c26eabcd6a06780c8cf47b
+  data.tar.gz: 3a64a0c7f55ddf107360633de23084b5cfd8b220ce55752febddd8cdf69558011d4a366e609bd783353f83501abda876e15ca8d99e5483c5651a79a46e93a8f1

data/README.md

@@ -4,15 +4,17 @@ A (tiny) CLI for Vim plugin manager [Vundle](https://github.com/gmarik/Vundle.vi
 
 Available commands:
 
-* `rm` remove a bundle
-* `list` list all installed bundles
-* `find` find an installed bundle
+* `rm` remove a plugin
+* `list` list all installed plugins
+* `find` find an installed plugin
+* `clean` clean up unused plugin related files
 
-`rm` will remove the line `Bundle bundle_name` in your `.vimrc` and look 
-for a configuration file for this bundle in the specified settings directory, 
-then it will ask if you want to remove the file or not.
+`rm` will remove the line `Bundle plugin_name` or `Plugin plugin_name` in your `.vimrc`, 
+delete the configuration file for this plugin in the specified settings directory, 
+and the plugin folder. Before anything is deleted, the command will prompt you 
+for confirmation unless the `--force` switch is on.
 
-I built this so that it's quicker to uninstall a bundle with my particular 
+I built this so that it's quicker to uninstall a plugin with my particular 
 [vim setup](https://github.com/baopham/vim)
 
 ## Installation
@@ -23,7 +25,7 @@ Add this line to your application's Gemfile:
 
 And then execute:
 
-    $ bundle
+    $ vundle
 
 Or install it yourself as:
 
@@ -41,10 +43,11 @@ Or install it yourself as:
 
   **COMMANDS**:
 	
-    find                 Search for an installed bundle  
+    clean                Clean up unused plugin related files
+    find                 Search for an installed plugin  
     help                 Display global or [command] help documentation  
-    list                 List all installed bundles  
-    rm                   Remove a bundle  
+    list                 List all installed plugins  
+    rm                   Remove a plugin  
 
   **GLOBAL OPTIONS**:
 	

data/bin/vundle

@@ -7,35 +7,40 @@ require 'vundle_cli'
 
 program :version, VundleCli::VERSION
 program :description, 'A (tiny) CLI for Vim plugin manager Vundle'
- 
+
 command :rm do |c|
-  c.syntax = 'vundle rm <bundle> [options]'
-  c.summary = 'Remove a bundle'
-  c.description = 'Uninstall a bundle. 
-This will remove the line `Bundle <bundle>` in your .vimrc 
-and will prompt you for confirmation before deleting the bundle\'s config file if found.'
-  c.example 'Remove bundle kien/ctrlp.vim', 'vundle rm kien/ctrlp.vim'
-  c.option '--vimdir vimdir', 'Vim directory. Default to ~/.vim'
+  c.syntax = 'vundle rm <plugin> [options]'
+  c.summary = 'Remove a plugin'
+  c.description = "Uninstall a plugin. 
+The command will remove the line ``Bundle plugin_name'' or ``Plugin plugin_name'' in your ``.vimrc'', 
+delete the configuration file for this plugin in the specified settings directory, and the plugin folder. 
+Before anything is deleted, the command will prompt you for confirmation unless the ``--force'' switch is on."
+  c.example 'Remove plugin kien/ctrlp.vim', 'vundle rm kien/ctrlp.vim'
+  c.example "Or, remove any plugin that has ``ctrlp'' in its name (not recommended, it can be too ambiguous)", 'vundle rm ctrlp'
+  c.option '--vimdir vimdir', 'Vim directory. Default to ~/.vim.'
   c.option '--settings settings_dir', 
-    'Vim settings directory (where you configure your bundles). Default to ~/.vim/settings'
-  c.option '--vimrc vimrc', '.vimrc path. Default to ~/.vimrc'
+    'Vim settings directory (where you configure your plugins). Default to ~/.vim/settings.'
+  c.option '--vimrc vimrc', '.vimrc path. Default to ~/.vimrc.'
+  c.option '-f', '--force', 'Force delete without confirmation. Disabled by default.'
   c.action do |args, options|
-    bundle = args.shift || abort('Bundle argument required.')
+    plugin = args.shift || abort('Plugin argument required.')
     options.default \
       :vimdir => '~/.vim',
       :settings => '~/.vim/settings',
-      :vimrc => '~/.vimrc'
-    runner = VundleCli::Uninstaller.new(options, bundle)
+      :vimrc => '~/.vimrc',
+      :force => false
+    runner = VundleCli::Uninstaller.new(options, plugin)
     runner.rm
+    say_ok "Done!"
   end
 end
 
 command :list do |c|
   c.syntax = 'vundle list [options]'
-  c.summary = 'List all installed bundles'
-  c.description = 'List all installed bundles'
-  c.example '', 'vundle list --vimrc ~/.vimrc'
-  c.option '--vimrc vimrc', '.vimrc path. Default to ~/.vimrc'
+  c.summary = 'List all installed plugins'
+  c.description = 'List all installed plugins'
+  c.example 'List all installed plugins', 'vundle list --vimrc ~/.vimrc'
+  c.option '--vimrc vimrc', '.vimrc path. Default to ~/.vimrc.'
   c.action do |args, options|
     options.default \
       :vimrc => '~/.vimrc'
@@ -45,16 +50,49 @@ command :list do |c|
 end
 
 command :find do |c|
-  c.syntax = 'vundle find bundle [options]'
-  c.summary = 'Search for an installed bundle'
-  c.description = 'Search for an installed bundle'
-  c.example 'Find a bundle that has substring `gist`', 'vundle find gist'
-  c.option '--vimrc vimrc', '.vimrc path. Default to ~/.vimrc'
+  c.syntax = 'vundle find <plugin> [options]'
+  c.summary = 'Search for an installed plugin'
+  c.description = 'Search for an installed plugin'
+  c.example "Find a plugin that has substring ``gist''", 'vundle find gist'
+  c.option '--vimrc vimrc', '.vimrc path. Default to ~/.vimrc.'
   c.action do |args, options|
-    bundle = args.shift || abort('Bundle argument required.')
+    plugin = args.shift || abort('Plugin argument required.')
     options.default \
       :vimrc => '~/.vimrc'
-    finder = VundleCli::Finder.new(options, bundle)
+    finder = VundleCli::Finder.new(options, plugin)
     finder.find
   end
 end
+
+command :clean do |c|
+  c.syntax = 'vundle clean [plugin] [options]'
+  c.summary = 'Clean up unused plugin related files'
+  c.description = "Clean up unused plugin related files (such as plugin folder and config file).
+It will prompt you for confirmation before deleting anything (unless force switch is on). 
+For option ``--all'', the command gets a list of the plugins in your bundle folder (e.g: ~/.vim/bundle) 
+and compare them with the plugins in your vimrc in order to determine which plugins need to be cleaned up."
+  c.example 'Clean all unused plugins', 'vundle clean --all'
+  c.example 'Clean plugin vim-signify', 'vundle clean vim-signify'
+  c.example "Clean any plugins with names that have substring ``dirty''", 'vundle clean dirty'
+  c.option '--vimdir vimdir', 'Vim directory. Default to ~/.vim.'
+  c.option '--settings settings_dir', 
+    'Vim settings directory (where you configure your plugins). Default to ~/.vim/settings.'
+  c.option '--vimrc vimrc', '.vimrc path. Default to ~/.vimrc.'
+  c.option '-a', '--all', 'Delete everything that is not installed in your vimrc. Disabled by default.'
+  c.option '-l', '--list', 'List all unused plugins.'
+  c.option '-f', '--force', 'Force delete files without prompt. Disabled by default.'
+  c.action do |args, options|
+    plugin = args.shift
+    unless options.all or options.list
+      abort('Plugin argument required.') if plugin.nil?
+    end
+    options.default \
+      :vimdir => '~/.vim',
+      :settings => '~/.vim/settings',
+      :vimrc => '~/.vimrc',
+      :force => false
+    cleaner = VundleCli::Cleaner.new(options, plugin)
+    cleaner.clean
+    say_ok "Done!"
+  end
+end

data/lib/vundle_cli.rb

@@ -1,4 +1,6 @@
 require "vundle_cli/version"
 require "vundle_cli/uninstaller"
 require "vundle_cli/finder"
-require "vundle_cli/helpers"
+require "vundle_cli/cleaner"
+require "vundle_cli/helper"
+require "vundle_cli/import"

data/lib/vundle_cli/cleaner.rb

@@ -0,0 +1,67 @@
+module VundleCli
+
+  class Cleaner
+
+    attr_reader :options, :vimdir, :settings_dir, :vimrc, :all, :force, :plugin
+
+    def initialize(options, plugin)
+      @options = options
+      @vimdir = file_validate(options.vimdir, true)
+      @settings_dir = file_validate(options.settings, true)
+      @vimrc = file_validate(options.vimrc)
+      @all = options.all
+      @force = options.force
+      @plugin = plugin
+    end
+
+    def clean
+      if @all or @options.list
+        unused_plugins = get_list
+      end
+
+      if @options.list
+        say "Unused plugins:"
+        say unused_plugins.join("\n") unless unused_plugins.empty?
+        puts_separator
+      end
+      if @all
+        uninstaller = Uninstaller.new(@options)
+        unused_plugins.each do |plugin_name| 
+          say "Cleaning #{plugin_name}..."
+          uninstaller.delete_setting_file(plugin_name)
+          uninstaller.delete_plugin_dir(plugin_name)
+        end
+      elsif not @plugin.nil?
+        # Only clean up unused plugin.
+        open(@vimrc, 'r').each { |l| 
+          next unless l.chomp =~ /(Bundle|Plugin) .*#{Regexp.quote(@plugin)}.*/
+          say_error "Can't clean this plugin since it's installed in your .vimrc. Please use command `rm` to uninstall it."
+          return
+        }
+
+        uninstaller = Uninstaller.new(@options, @plugin)
+        uninstaller.rm(false)
+      end
+    end
+
+    # Get a list of unused plugins.
+    def get_list
+      # Get a list of plugin directories (basenames only).
+      all_plugins = Array.new
+      all_plugins = Dir["#{@vimdir}/bundle/*/"].map { |b|
+        File.basename(b)
+      }
+
+      # Get a list of installed plugins.
+      finder = Finder.new(@options)
+      installed_plugins = Array.new
+      installed_plugins = finder.get_list.map { |b|
+        plugin_base_name(b)
+      }
+
+      all_plugins - installed_plugins
+    end
+
+  end
+
+end

data/lib/vundle_cli/finder.rb

@@ -1,34 +1,40 @@
 module VundleCli
   class Finder
 
-    attr_reader :options
+    attr_reader :options, :vimrc, :plugin
 
-    attr_reader :vimrc
-
-    attr_reader :bundle
-
-    def initialize(options, bundle = '')
+    def initialize(options, plugin = '')
       @options = options
-      @vimrc = Helpers.file_validate(options.vimrc)
-      @bundle = bundle
+      @vimrc = file_validate(options.vimrc)
+      @plugin = plugin
     end
 
-    def list
+    def get_list
+      plugins = Array.new
       open(@vimrc, 'r').each { |l| 
-        matches = l.chomp.match(/^Bundle (\S*)/)
+        matches = l.chomp.match(/^(Bundle|Plugin) (\S*)/)
         if matches
-          puts matches[1].gsub("'", '')
+          plugins << matches[2].gsub(/[',]/, '')
         end
       }
+      plugins
+    end
+
+    def list
+      enable_paging
+      say get_list.join("\n")
     end
 
     def find
-      puts "Searching..."
+      say "Searching..."
       open(@vimrc, 'r').each { |l| 
-        matches = l.chomp.match(/^Bundle (\S*)/)
+        matches = l.chomp.match(/^(Bundle|Plugin) (\S*)/)
         if matches
-          bundle = matches[1].gsub("'", '')
-          puts "Found #{bundle}" if bundle.downcase.include?(@bundle.downcase)
+          plugin = matches[2].gsub(/[',]/, '')
+          if plugin.downcase.include?(@plugin.downcase)
+            say_ok "Found "
+            say plugin
+          end
         end
       }
     end

data/lib/vundle_cli/{helpers.rb → helper.rb}

@@ -1,5 +1,5 @@
 module VundleCli
-  module Helpers
+  module Helper
     module_function
 
     def file_validate(fpath, check_dir = false)
@@ -23,5 +23,28 @@ module VundleCli
 
       fpath
     end
+
+    def plugin_base_name(plugin)
+      File.basename(plugin)
+    end
+
+    # Get the trimmed name of the plugin,
+    # e.g. remove prefix, suffix "vim-", "-vim", ".vim".
+    def plugin_trim_name(plugin_name)
+      plugin_name.gsub(/(vim-|-vim|\.vim)/, '')
+    end
+
+    def puts_separator
+      say "-----------------------------"
+    end
+
+    def agree?(message, color = nil)
+      begin
+        message = $terminal.color(message, color) unless color.nil?
+        agree(message)
+      rescue Interrupt
+        abort("\nAbort.")
+      end
+    end
   end
 end

data/lib/vundle_cli/import.rb

@@ -0,0 +1,3 @@
+require 'vundle_cli'
+
+include VundleCli::Helper

data/lib/vundle_cli/uninstaller.rb

@@ -5,59 +5,99 @@ module VundleCli
 
   class Uninstaller
 
-    attr_reader :options
+    attr_reader :options, :vimdir, :settings_dir, :vimrc, :force, :plugin
 
-    attr_reader :vimdir
-
-    attr_reader :settings_dir
-
-    attr_reader :vimrc
-
-    attr_reader :bundle
-
-    def initialize(options, bundle)
+    def initialize(options, plugin = nil)
       @options = options
-      @vimdir = Helpers.file_validate(options.vimdir, true)
-      @settings_dir = Helpers.file_validate(options.settings, true)
-      @vimrc = Helpers.file_validate(options.vimrc)
-      @bundle = bundle
+      @vimdir = file_validate(options.vimdir, true)
+      @settings_dir = file_validate(options.settings, true)
+      @vimrc = file_validate(options.vimrc)
+      @force = options.force
+      unless plugin.nil?
+        @plugin = plugin
+        abort("Plugin name too ambiguous.") if ambiguous?(plugin)
+      end
     end
 
-    # 1) Remove the line `Bundle bundle` from .vimrc.
+    def ambiguous?(plugin)
+      plugin_name = plugin_base_name(plugin)
+      plugin_trim_name(plugin_name).empty?
+    end
+
+    # 1) Remove the line `Bundle plugin_name` or `Plugin plugin_name` from .vimrc.
     # 2) Look for a file in the settings directory (provided by option --settings)
-    #    with name that includes the bundle name. Then ask if the user wants to remove it.
-    def rm
-      tmp = Tempfile.new("vimrc_tmp")
-      open(@vimrc, 'r').each { |l| 
-        if l.chomp =~ /Bundle .*#{Regexp.quote(@bundle)}.*/
-          puts "Found bundle #{@bundle}, removing it from #{@vimrc}..."
-        else
+    #    with name that includes the plugin name. Then ask if the user wants to remove it.
+    # 3) Remove the plugin directory.
+    def rm(modify_vimrc = true)
+
+      if modify_vimrc
+        say "Searching plugin in #{@vimrc}..."
+        tmp = Tempfile.new("vimrc_tmp")
+        open(@vimrc, 'r').each { |l| 
+          if l.chomp =~ /(Bundle|Plugin) .*#{Regexp.quote(@plugin)}.*/
+            yes = true
+            unless @force
+              yes = agree? "Uninstall #{l.chomp} from vimrc? (y/n) ", :yellow
+            end
+            if yes
+              say_ok "Uninstalling "
+              say l.chomp.gsub(/(Bundle|Plugin|'|,|\s)/, '')
+              next
+            end
+          end
           tmp << l
-        end
-      }
-      tmp.close
-      FileUtils.mv(tmp.path, @vimrc)
+        }
+        tmp.close
+        FileUtils.mv(tmp.path, @vimrc)
+        puts_separator
+      end
 
-      puts "Searching for setting file..."
+      plugin_name = plugin_base_name(@plugin)
 
-      # Get the bundle's main name.
-      # (the provided @bundle usually looks like baopham/trailertrash.vim,
-      # so we trim it down to get "trailertrash" only).
-      bundle_name = @bundle
-      if @bundle.include?("/")
-        bundle_name = @bundle.split("/")[1].sub(/\.vim/, '')
-      end
+      say "Searching for setting file..."
+      delete_setting_file(plugin_name)
+      puts_separator
+      say "Searching for plugin folder..."
+      delete_plugin_dir(plugin_name)
+    end
 
+    def delete_setting_file(plugin_name)
+      trimmed_name = plugin_trim_name(plugin_name)
       Dir.foreach(@settings_dir) do |fname|
-        next unless fname.downcase.include?(bundle_name.downcase)
-        puts "Found #{@settings_dir}/#{fname} setting file. Remove it? (yes/no) "
-        input = STDIN.gets.chomp
-        if input == 'yes'
+        next if fname == '.' or fname == '..'
+        next unless fname.downcase.include?(trimmed_name.downcase)
+        yes = true
+        unless @force
+          yes = agree? "Found #{@settings_dir}/#{fname}. Remove it? (y/n) ", :yellow
+        end
+        if yes
           File.delete("#{@settings_dir}/#{fname}")
-          puts "File deleted."
+          say_ok "---#{@settings_dir}/#{fname} deleted---"
         end
       end
     end
 
+    def delete_plugin_dir(plugin_name)
+      plugin_dir = "#{@vimdir}/bundle/#{plugin_name}"
+      dirs =
+        # If the user uses the exact name of the plugin, remove it.
+        if Dir.exists?(plugin_dir)
+          [plugin_dir]
+        # else, search for plugin folders with substring plugin_name.
+        else
+          Dir["#{@vimdir}/bundle/*#{plugin_name}*"]
+        end
+
+      dirs.each { |b|
+        yes = true
+        unless @force
+          yes = agree? "Found #{b}. Remove it? (y/n) ", :yellow
+        end
+        if yes
+          FileUtils.rm_rf(b)
+          say_ok "---#{b} deleted---"
+        end
+      }
+    end
   end
 end

data/lib/vundle_cli/version.rb

@@ -1,3 +1,3 @@
 module VundleCli
-  VERSION = "0.0.6"
+  VERSION = "0.0.7.1"
 end

data/vundle-cli.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Bao Pham"]
   spec.email         = ["gbaopham@gmail.com"]
   spec.summary       = %q{A tiny CLI for Vim plugin manager Vundle}
-  spec.description   = %q{Available commands: rm, list, find to remove, list and find installed bundles}
+  spec.description   = %q{Available commands: rm, list, find, clean to remove, list, find installed plugins and clean up unused plugins}
   spec.homepage      = "https://github.com/baopham/vundle-cli"
   spec.license       = "MIT"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vundle-cli
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7.1
 platform: ruby
 authors:
 - Bao Pham
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-12 00:00:00.000000000 Z
+date: 2014-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,8 +52,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.2'
-description: 'Available commands: rm, list, find to remove, list and find installed
-  bundles'
+description: 'Available commands: rm, list, find, clean to remove, list, find installed
+  plugins and clean up unused plugins'
 email:
 - gbaopham@gmail.com
 executables:
@@ -68,8 +68,10 @@ files:
 - Rakefile
 - bin/vundle
 - lib/vundle_cli.rb
+- lib/vundle_cli/cleaner.rb
 - lib/vundle_cli/finder.rb
-- lib/vundle_cli/helpers.rb
+- lib/vundle_cli/helper.rb
+- lib/vundle_cli/import.rb
 - lib/vundle_cli/uninstaller.rb
 - lib/vundle_cli/version.rb
 - vundle-cli.gemspec