vrundler 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f8954ad00769ec2555b8a9d5db526fd2a32ccb4f
-  data.tar.gz: 0146d8ef94910acaee4a4f7c8bab63bb90d70083
+  metadata.gz: bc16e0478c13b0f4ca818a2583069d0dc96ffcad
+  data.tar.gz: 2539adf0f7d0e9c56e417fc261a1a9e44186f090
 SHA512:
-  metadata.gz: dde94e0a7ce644c9c44e1ff148dfdf507c7cb9ef8e75f5a9e13000e8c88ec8794237774f6b799469c86386509aafe0241352086f9501d256e6c8dde34ca86b19
-  data.tar.gz: 9866b34f3a6c599640880fa90ae2a3e9b28583ea732545ea0ad1f4b04e054cd2e58b9c1b6ef0ec05692c6c187fc7c0227d2139335a5b27f9c022f85a9bc69b32
+  metadata.gz: 8f81220e382d572975bb81c788035a0020829049a29f46de9cfda2a36cd0964bcfc9778ca35676c1267de815c7706c3680a3c24aad491ca481bca248dce8be04
+  data.tar.gz: a59da74923ede561571435ae4965ff778bb658e3afbbbd762f353c33b6c9ef836773cb0a1e6e1edd449476d6e1f50a3059c9331a9cb416d1b70c44bd186fabcb

data/{LICENSE → LICENSE.md}

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2012 - 2014 Jean-Paul Sylvain Boodhoo
+Copyright (c) 2014 Jean-Paul Sylvain Boodhoo
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,7 +1,184 @@
 #VRundler
 
-This project is a a simple utility that I wrote to manage my vim plugin ecosystem.
+##Description
 
-#Usage
+vrundler is a simple tool for managing your vim plugin management using ruby.
 
-TODO
+##Installation
+
+```bash
+gem install vrundler
+```
+
+##Usage and documentation
+
+Create a configuration file for VRundler that allows you to specify the bundles you want vim to use. The following code is a configuration file that uses all of the features of vrundler:
+
+```ruby
+# Specify the path where you want your bundles installed
+bundles_dir '/Users/developwithpassion/.vim_runtime/bundle'
+
+# A github group allows you to specify a github user name
+github 'vim-scripts' do
+
+# A bundle is a named vim plugin repo for the user, you can specify
+# multiple by separating each plugin with a comma, this is useful if you are
+# getting multiple plugins from a single author, you can also specify each plugin
+# with separate calls to: bundle '[PLUGIN]'
+  bundle 'dbext.vim',
+         'vimgrep.vim'
+end
+
+github :altercation do
+  bundle 'vim-colors-solarized'
+end
+
+github :benmills do
+  bundle 'vimux'
+end
+
+github :developwithpassion do
+  bundle 'TwitVim'
+end
+
+# A symlink bundle is just a vim plugin that is on your local file system somewhere 
+# and you want it symlinked into your vim bundle folder, the first argument is 
+# the name the symlink will be given in your plugin folder
+symlink :dwp_vim_general, '/to_backup/repositories/open_source/dwp_vim_general'
+
+github :ecomba do
+  bundle 'vim-ruby-refactoring'
+end
+
+github :elzr do
+  bundle 'vim-json'
+end
+
+github :ervandew do
+  bundle 'supertab'
+end
+
+github :nanotech do
+  bundle 'jellybeans.vim'
+end
+
+github :kana do
+  bundle 'vim-fakeclip'
+end
+
+github :kien do
+  bundle 'ctrlp.vim'
+end
+
+github :MarcWeber do
+  bundle 'vim-addon-mw-utils'
+end
+
+github :scrooloose do
+  bundle 'syntastic' , 
+    'nerdtree'
+end
+
+github :jistr do
+  bundle 'vim-nerdtree-tabs'
+end
+
+github :sukima do
+  bundle 'xmledit'
+end
+
+github :timcharper do
+  bundle 'textile.vim'
+end
+
+github :thoughtbot do
+  bundle 'vim-rspec'
+end
+
+github :pangloss do
+  bundle 'vim-javascript'
+end
+
+github :SirVer do
+  bundle 'ultisnips'
+end
+
+github :tomtom do
+  bundle 'tcomment_vim', 
+    'tlib_vim'
+end
+
+github :tpope do
+  bundle 'vim-cucumber', 
+    'vim-endwise', 
+    'vim-fugitive', 
+    'vim-git', 
+    'vim-haml', 
+    'vim-markdown', 
+    'vim-rails', 
+    'vim-repeat',
+    'vim-surround', 
+    'vim-vividchalk'
+end
+
+github :Lokaltog do
+  bundle 'vim-distinguished'
+end
+
+github :Valloric do
+  bundle 'YouCompleteMe' do |b, context|
+    b.after_download do 
+      Dir.chdir(context.output_folder(b)) do
+        system("git submodule update --init --recursive && ./install.sh")
+      end
+    end
+  end
+  bundle 'MatchTagAlways'
+end
+
+github 'vim-ruby' do
+  bundle 'vim-ruby'
+end
+
+
+# A vimscripts group allows you to pull down individual script files from vimscripts.org
+vimscripts do
+  
+  # when you define a group inside a vimscripts section, the first arugment specifies
+  # what type of plugin the script is
+  group :plugins do
+    script 'IndexedSearch', 7062
+    script 'autotag', 12473
+    script 'DirDiff', 13435
+  end
+
+  group :syntax do
+    script 'jquery', 12276
+  end
+end
+
+# A vimzips group allows you to pull down individual zip files from vimscripts.org
+vimzips do
+  zip :vimgrep, 3407 
+  zip :bufexplorer, 20953
+end
+```
+
+With the configuration file in place, if you are in the folder that contains the configuration file, you can just run: 
+
+
+```bash
+vrundler install
+```
+
+If not, you will need to provide a path to the configuration file as an argument:
+
+```bash
+vrundler install --config_file=PATH_TO_YOUR_CONFIG_FILE
+```
+
+##License
+
+Released under the MIT License. See the [LICENSE][] file for further details.
+
+[license]: LICENSE.md

data/bin/vrundler

@@ -4,13 +4,13 @@ require 'thor'
 require 'vrundler'
 
 class CLI < Thor
-  class_option :vrundles_file, type: :string, default: "VRundles"
+  class_option :config_file, type: :string, default: "VRundles"
 
   desc 'install', 'Installs the vim bundles you have specified in your VRundles file'
   def install
-    ensure_vrundles_file_provided
+    ensure_config_file_provided
 
-    load vrundles_file
+    load config_file
     
     Dir.chdir Bundles.bundles_dir do
       Bundles.unpack_all_bundles
@@ -18,17 +18,17 @@ class CLI < Thor
   end
 
   no_commands do
-    def vrundles_file?
-      File.exist?(vrundles_file)
+    def config_file?
+      File.exist?(config_file)
     end
 
-    def vrundles_file
-      options[:vrundles_file]
+    def config_file
+      options[:config_file]
     end
 
-    def ensure_vrundles_file_provided
-      unless vrundles_file?
-        puts "You need to run this when you are in a folder that contains a VRundlesFile. Or specify a path to a valid VRundler configuration file using --vrundles_file=FILE"
+    def ensure_config_file_provided
+      unless config_file?
+        puts "You need to run this when you are in a folder that contains a VRundlesFile. Or specify a path to a valid VRundler configuration file using --config_file=FILE"
         exit
       end
     end

data/lib/vrundler/version.rb

@@ -1,3 +1,3 @@
 module VRundler
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vrundler
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Develop With Passion®
@@ -34,7 +34,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - Gemfile
-- LICENSE
+- LICENSE.md
 - README.md
 - Rakefile
 - bin/vrundler