vim-flavor 0.0.1 → 0.0.2

data/README.md

@@ -0,0 +1,198 @@
+# vim-flavor, a tool to manage your favorite Vim plugins
+
+
+
+
+## Set up the tool for a new-style plugin management
+
+### Requirements
+
+* [Git](http://git-scm.com/) 1.7.9 or later
+* [Ruby](http://www.ruby-lang.org/) 1.9.2 or later
+  * Recommendation: Use [RVM](http://beginrescueend.com/) or other tools
+    for ease of installation across different envinronments.
+* [Vim](http://www.vim.org/) 7.3 or later
+  * Note that Vim should be compiled as normal, big or huge version
+    to use most of plugins.
+
+
+### Supported platforms
+
+* Unix-like environments such as Linux, Mac OS X, etc.
+* Though Microsoft Windows is not directly supported,
+  it is possible to manage Vim plugins via Cygwin or other environments.
+
+
+### Installation steps
+
+    gem install vim-flavor
+
+
+
+
+## Typical usage
+
+### Start using vim-flavor
+
+    cd $YOUR_REPOSITORY_FOR_DOTFILES
+
+    cat >VimFlavor <<'END'
+      # * Declare using git://github.com/kana/vim-textobj-indent.git
+      # * vim-flavor fetches git://github.com/$USER/$REPO.git
+      #   if the argument is written in '$USER/$REPO' format.
+      # * kana/vim-textobj-indent requires kana/vim-textobj-user.
+      #   Such dependencies are automatically installed
+      #   if the flavored plugin declares its dependencies with VimFlavor file.
+      #   (FIXME: Resolving dependencies will be implemented later.)
+      flavor 'kana/vim-textobj-indent'
+
+      # * Declare using git://github.com/vim-scripts/fakeclip.git
+      # * vim-flavor fetches git://github.com/vim-scripts/$REPO.git
+      #   if the argument is written in '$REPO' format.
+      flavor 'fakeclip'
+
+      # * Declare using git://github.com/kana/vim-altr.git
+      # * vim-flavor fetches the URI
+      #   if the argument seems to be a URI.
+      flavor 'git://github.com/kana/vim-altr.git'
+
+      # * Declare using kana/vim-smartchr 0.1.0 or later and older than 0.2.0.
+      flavor 'kana/vim-smartchr', '~> 0.1.0'
+
+      # * Declare using kana/vim-smartword 0.1 or later and older than 1.0.
+      flavor 'kana/vim-smartword', '~> 0.1'
+
+      # * Declare using kana/vim-smarttill 0.1.0 or later.
+      flavor 'kana/vim-smarttill', '>= 0.1.0'
+    END
+
+    # Fetch the plugins declared in the VimFlavor,
+    # create VimFlavor.lock for a snapshot of all plugins and versions,
+    # then install the plugins and a bootstrap script into ~/.vim etc.
+    vim-flavor install
+
+    # Add the following line into the first line of your vimrc:
+    #
+    #   runtime flavors/bootstrap.vim
+    vim vimrc
+
+    git add VimFlavor VimFlavor.lock vimrc
+    git commit -m 'Use vim-flavor to manage my favorite Vim plugins'
+
+
+### Upgrade all plugins to the latest version
+
+    vim-flavor upgrade
+
+    git add VimFlavor.lock
+    git commit -m 'Upgrade my favorite Vim plugins'
+
+
+### Add more plugins into your dotfile repository
+
+    cat >>VimFlavor <<'END'
+
+      flavor 'kana/vim-operator-replace'
+
+    END
+
+    # Fetch newly added plugins,
+    # update VimFlavor.lock for the plugins,
+    # then install the plugins into ~/.vim etc.
+    vim-flavor install
+
+    git add VimFlavor VimFlavor.lock
+    git commit -m 'Use kana/vim-operator-replace'
+
+
+### Remove plugins from your dotfile repository
+
+    # Remove declarations of unused plugins from VimFlavor.
+    sed -i~ -e '/vim-smartchr/d' VimFlavor
+
+    # Update VimFlavor.lock for the removed plugins,
+    # then clean up the plugins from ~/.vim etc.
+    vim-flavor install
+
+    git add VimFlavor VimFlavor.lock
+    git commit -m 'Farewell kana/vim-smartchr'
+
+
+
+### Install plugins into a non-standard directory
+
+    vim-flavor install --vimfiles-path=/cygdrive/c/Users/kana/vimfiles
+
+
+### Farewell to vim-flavor
+
+    rm -r ~/.vim-flavor
+    rm -r ~/.vim/flavors  # or ~/vimfiles/flavors etc.
+
+    cd $YOUR_REPOSITORY_FOR_DOTFILES
+    rm VimFlavor VimFlavor.lock
+    git commit -am 'Farewell to vim-flavor'
+
+
+
+
+## Philosophy
+
+I know that there are several implementations for the same purpose and many
+users love them, but all of them do not meet my taste.  That's why I wrote
+vim-flavor.  The philosofy on vim-flavor is as follows:
+
+Whole configuration including *versions of plugins* should be under a version
+control system.  All of existing implementations do not manage versions of
+plugins.  This means that *it's not possible to use the same configuration
+across multiple environments* (the only one exception is using
+[pathogen](https://github.com/tpope/vim-pathogen) with Git submodules,
+but you'll find it's painful to manually manage many plugins).
+
+There should be a standard way to describe proper dependencies of plugins to
+install dependencies without explicit declarations.  Most of existing
+implementations do not resolve dependencies automatically (the only one
+exception is
+[vim-addon-manager](https://github.com/MarcWeber/vim-addon-manager), but it
+doesn't take care about required versions).  The configuration file formats of
+vim-flavor are also used to describe dependencies of plugins with required
+versions.  This means that vim-flavor installs plugins and their dependencies
+automatically (unfortunately this feature is not implemented yet, but it'll be
+available soon).
+
+Any software should have enough and reproducable test cases.
+But existing implementations such as
+[vundle](https://github.com/gmarik/vundle) and
+[neobundle](https://github.com/Shougo/neobundle.vim) are not developed so.
+It's horrible for me.
+
+Installation steps should be small, be reproducable, and not affect existing
+envinronment as less as possible.  Most of existing implementations require to
+manually tweak `~/.vim` etc.  It's painful to set up such stuffs manually
+because a vimfiles path is varied on each platform.
+
+Finally, a tool and files deployed by the tool should be uninstalled easily.
+[Vimana](https://github.com/c9s/Vimana) does not meet this because it directly
+puts files into `~/.vim/colors` etc and it doesn't provide `uninstall`
+command.
+
+
+
+
+## License
+
+vim-flavor is released under the terms of so-called MIT/X license.
+See the LICENSE file for the details.
+
+
+
+
+## Author
+
+* [Kana Natsuno](http://whileimautomaton.net/)
+  (also known as [@kana1](http://twitter.com/kana1))
+
+
+
+
+<!-- vim: set expandtab shiftwidth=4 softtabstop=4 textwidth=78 : -->

data/lib/vim-flavor/version.rb

@@ -1,5 +1,5 @@
 module Vim
   module Flavor
-    VERSION = '0.0.1'
+    VERSION = '0.0.2'
   end
 end

data/lib/vim-flavor.rb

@@ -61,8 +61,17 @@ module Vim
       end
     end
 
-    DOT_PATH = "#{Dir.getwd()}/.vim-flavor"
-    CACHED_REPOS_PATH = "#{DOT_PATH}/repos"
+    class << self
+      @@dot_path = File.expand_path('~/.vim-flavor')
+
+      def dot_path
+        @@dot_path
+      end
+
+      def dot_path= path
+        @@dot_path = path
+      end
+    end
 
     class Flavor
       @@properties = [
@@ -94,7 +103,7 @@ module Vim
 
       def cached_repo_path
         @cached_repo_path ||=
-          "#{CACHED_REPOS_PATH}/#{zapped_repo_dir_name}"
+          "#{Vim::Flavor.dot_path}/repos/#{zapped_repo_dir_name}"
       end
 
       def make_deploy_path(vimfiles_path)

data/spec/facade_spec.rb

@@ -15,8 +15,9 @@ describe Vim::Flavor::Facade do
   end
 
   describe '#load' do
+    with_temporary_directory
+
     before :each do
-      @tmp_path = "#{Vim::Flavor::DOT_PATH}/tmp"
       @facade = described_class.new()
       @facade.flavorfile_path = "#{@tmp_path}/VimFlavor"
       @facade.lockfile_path = "#{@tmp_path}/VimFlavor.lock"
@@ -38,7 +39,6 @@ describe Vim::Flavor::Facade do
       @flavor2d = @flavor2.dup()
       @flavor2d.locked_version = Gem::Version.create('4.5.6')
 
-      FileUtils.mkdir_p(@tmp_path)
       File.open(@facade.flavorfile_path, 'w') do |f|
         f.write(<<-'END')
           flavor 'kana/vim-smartinput'
@@ -58,10 +58,6 @@ describe Vim::Flavor::Facade do
       end
     end
 
-    after :each do
-      FileUtils.rm_rf([Vim::Flavor::DOT_PATH], :secure => true)
-    end
-
     it 'should load both files' do
       @facade.load()
 
@@ -184,16 +180,19 @@ describe Vim::Flavor::Facade do
   end
 
   describe '#create_vim_script_for_bootstrap' do
+    with_temporary_directory
+
     before :each do
       @facade = described_class.new()
-      @home_path = "#{Vim::Flavor::DOT_PATH}"
+      @home_path =
+        if File.symlink?(@tmp_path)
+          File.readlink(@tmp_path)
+        else
+          @tmp_path
+        end
       @vimfiles_path = "#{@home_path}/.vim"
     end
 
-    after :each do
-      FileUtils.rm_rf([Vim::Flavor::DOT_PATH], :secure => true)
-    end
-
     it 'should create a bootstrap script into a given vimfiles path' do
       bootstrap_path = "#{@vimfiles_path.to_flavors_path()}/bootstrap.vim"
 
@@ -213,34 +212,40 @@ describe Vim::Flavor::Facade do
         done
         vim -u NONE -i NONE -e -s -c '
           set nocompatible verbose=1
+          let vimfiles_path = split(&runtimepath, ",")[0]
           source #{@vimfiles_path}/flavors/bootstrap.vim
-          verbose echo &runtimepath
+          for path in split(&runtimepath, ",")
+            if stridx(path, vimfiles_path) == 0
+              echo substitute(path, vimfiles_path, "!", "")
+            endif
+          endfor
           qall!
         ' 2>&1
       }
       rtps =
         _rtp.
-        gsub(/[\r\n]/, '').
-        split(/,/).
-        select {|p| p.start_with?(@home_path)}
+        split(/[\r\n]/).
+        select {|p| p != ''}
       rtps.should == [
-        "#{@home_path}/.vim",
-        "#{@home_path}/.vim/flavors/bar",
-        "#{@home_path}/.vim/flavors/baz",
-        "#{@home_path}/.vim/flavors/foo",
-        "#{@home_path}/.vim/flavors/foo/after",
-        "#{@home_path}/.vim/flavors/baz/after",
-        "#{@home_path}/.vim/flavors/bar/after",
-        "#{@home_path}/.vim/after",
+        '!',
+        '!/flavors/bar',
+        '!/flavors/baz',
+        '!/flavors/foo',
+        '!/flavors/foo/after',
+        '!/flavors/baz/after',
+        '!/flavors/bar/after',
+        '!/after',
       ]
     end
   end
 
   describe '#deploy_flavors' do
+    with_temporary_directory
+
     before :each do
       @facade = described_class.new()
 
-      @test_repo_path = "#{Vim::Flavor::DOT_PATH}/test/origin"
+      @test_repo_path = "#{@tmp_path}/test/origin"
 
       @flavor = Vim::Flavor::Flavor.new()
       @flavor.repo_name = '@test_repo_path'
@@ -249,14 +254,10 @@ describe Vim::Flavor::Facade do
 
       @flavors = [@flavor]
 
-      @vimfiles_path = "#{Vim::Flavor::DOT_PATH}/vimfiles"
+      @vimfiles_path = "#{@tmp_path}/vimfiles"
       @bootstrap_path = "#{@vimfiles_path.to_flavors_path()}/bootstrap.vim"
     end
 
-    after :each do
-      FileUtils.rm_rf([Vim::Flavor::DOT_PATH], :secure => true)
-    end
-
     it 'should replace a given path with given flavors' do
       create_a_test_repo(@test_repo_path)
       @flavors.each do |f|
@@ -293,23 +294,19 @@ describe Vim::Flavor::Facade do
   end
 
   describe '#save_lockfile' do
+    with_temporary_directory
+
     before :each do
-      @tmp_path = "#{Vim::Flavor::DOT_PATH}/tmp"
       @facade = described_class.new()
       @facade.flavorfile_path = "#{@tmp_path}/VimFlavor"
       @facade.lockfile_path = "#{@tmp_path}/VimFlavor.lock"
 
-      FileUtils.mkdir_p(@tmp_path)
       File.open(@facade.flavorfile_path, 'w') do |f|
         f.write(<<-'END')
         END
       end
     end
 
-    after :each do
-      clean_up_stashed_stuffs()
-    end
-
     it 'should save locked flavors' do
       @facade.load()
 
@@ -342,15 +339,15 @@ describe Vim::Flavor::Facade do
   end
 
   describe '#complete_locked_flavors' do
+    with_temporary_directory
+
     before :each do
-      @test_repo_path = "#{Vim::Flavor::DOT_PATH}/test/origin"
-      @tmp_path = "#{Vim::Flavor::DOT_PATH}/tmp"
+      @test_repo_path = "#{@tmp_path}/test/origin"
       @facade = described_class.new()
       @facade.flavorfile_path = "#{@tmp_path}/VimFlavor"
       @facade.lockfile_path = "#{@tmp_path}/VimFlavor.lock"
 
       create_a_test_repo(@test_repo_path)
-      FileUtils.mkdir_p(@tmp_path)
       File.open(@facade.flavorfile_path, 'w') do |f|
         f.write(<<-"END")
           flavor 'file://#{@test_repo_path}', '~> 1.1.1'
@@ -358,10 +355,6 @@ describe Vim::Flavor::Facade do
       end
     end
 
-    after :each do
-      clean_up_stashed_stuffs()
-    end
-
     it 'should complete flavors if they are not locked' do
       @facade.load()
 
@@ -456,16 +449,16 @@ describe Vim::Flavor::Facade do
   end
 
   describe '#install' do
+    with_temporary_directory
+
     before :each do
-      @test_repo_path = "#{Vim::Flavor::DOT_PATH}/test/origin"
-      @tmp_path = "#{Vim::Flavor::DOT_PATH}/tmp"
-      @vimfiles_path = "#{Vim::Flavor::DOT_PATH}/vimfiles"
+      @test_repo_path = "#{@tmp_path}/test/origin"
+      @vimfiles_path = "#{@tmp_path}/vimfiles"
       @facade = described_class.new()
       @facade.flavorfile_path = "#{@tmp_path}/VimFlavor"
       @facade.lockfile_path = "#{@tmp_path}/VimFlavor.lock"
 
       create_a_test_repo(@test_repo_path)
-      FileUtils.mkdir_p(@tmp_path)
       File.open(@facade.flavorfile_path, 'w') do |f|
         f.write(<<-"END")
           flavor 'file://#{@test_repo_path}', '~> 1.1.1'
@@ -473,10 +466,6 @@ describe Vim::Flavor::Facade do
       end
     end
 
-    after :each do
-      clean_up_stashed_stuffs()
-    end
-
     it 'should install Vim plugins according to VimFlavor' do
       File.exists?(@facade.lockfile_path).should be_false
       File.exists?(@vimfiles_path).should be_false
@@ -509,16 +498,16 @@ describe Vim::Flavor::Facade do
   end
 
   describe '#upgrade' do
+    with_temporary_directory
+
     before :each do
-      @test_repo_path = "#{Vim::Flavor::DOT_PATH}/test/origin"
-      @tmp_path = "#{Vim::Flavor::DOT_PATH}/tmp"
-      @vimfiles_path = "#{Vim::Flavor::DOT_PATH}/vimfiles"
+      @test_repo_path = "#{@tmp_path}/test/origin"
+      @vimfiles_path = "#{@tmp_path}/vimfiles"
       @facade = described_class.new()
       @facade.flavorfile_path = "#{@tmp_path}/VimFlavor"
       @facade.lockfile_path = "#{@tmp_path}/VimFlavor.lock"
 
       create_a_test_repo(@test_repo_path)
-      FileUtils.mkdir_p(@tmp_path)
       File.open(@facade.flavorfile_path, 'w') do |f|
         f.write(<<-"END")
           flavor 'file://#{@test_repo_path}', '~> 1.1.1'
@@ -526,10 +515,6 @@ describe Vim::Flavor::Facade do
       end
     end
 
-    after :each do
-      clean_up_stashed_stuffs()
-    end
-
     it 'should upgrade Vim plugins according to VimFlavor' do
       File.exists?(@facade.lockfile_path).should be_false
       File.exists?(@vimfiles_path).should be_false

data/spec/flavor_spec.rb

@@ -20,8 +20,10 @@ describe Vim::Flavor::Flavor do
   end
 
   describe '#clone' do
+    with_temporary_directory
+
     before :each do
-      @test_repo_path = "#{Vim::Flavor::DOT_PATH}/test/origin"
+      @test_repo_path = "#{@tmp_path}/test/origin"
 
       @flavor = described_class.new()
       @flavor.repo_name = '@test_repo_path'
@@ -29,10 +31,6 @@ describe Vim::Flavor::Flavor do
       @flavor.locked_version = '1.0.0'
     end
 
-    after :each do
-      clean_up_stashed_stuffs()
-    end
-
     it 'should clone the repository into a given path' do
       create_a_test_repo(@test_repo_path)
 
@@ -45,8 +43,10 @@ describe Vim::Flavor::Flavor do
   end
 
   describe '#fetch' do
+    with_temporary_directory
+
     before :each do
-      @test_repo_path = "#{Vim::Flavor::DOT_PATH}/test/origin"
+      @test_repo_path = "#{@tmp_path}/test/origin"
 
       @flavor = described_class.new()
       @flavor.repo_name = '@test_repo_path'
@@ -54,10 +54,6 @@ describe Vim::Flavor::Flavor do
       @flavor.locked_version = '1.0.0'
     end
 
-    after :each do
-      clean_up_stashed_stuffs()
-    end
-
     it 'should fail if the repository is not cloned yet' do
       expect {
         @flavor.fetch()
@@ -87,22 +83,20 @@ describe Vim::Flavor::Flavor do
   end
 
   describe '#deploy' do
+    with_temporary_directory
+
     before :each do
-      @test_repo_path = "#{Vim::Flavor::DOT_PATH}/test/origin"
+      @test_repo_path = "#{@tmp_path}/test/origin"
 
       @flavor = described_class.new()
       @flavor.repo_name = '@test_repo_path'
       @flavor.repo_uri = @test_repo_path
       @flavor.locked_version = '1.0.0'
 
-      @vimfiles_path = "#{Vim::Flavor::DOT_PATH}/vimfiles"
+      @vimfiles_path = "#{@tmp_path}/vimfiles"
       @deploy_path = @flavor.make_deploy_path(@vimfiles_path)
     end
 
-    after :each do
-      clean_up_stashed_stuffs()
-    end
-
     it 'should deploy files of a locked version to a given path' do
       create_a_test_repo(@test_repo_path)
       @flavor.clone()
@@ -179,22 +173,20 @@ describe Vim::Flavor::Flavor do
   end
 
   describe '#undeploy' do
+    with_temporary_directory
+
     before :each do
-      @test_repo_path = "#{Vim::Flavor::DOT_PATH}/test/origin"
+      @test_repo_path = "#{@tmp_path}/test/origin"
 
       @flavor = described_class.new()
       @flavor.repo_name = '@test_repo_path'
       @flavor.repo_uri = @test_repo_path
       @flavor.locked_version = '1.0.0'
 
-      @vimfiles_path = "#{Vim::Flavor::DOT_PATH}/vimfiles"
+      @vimfiles_path = "#{@tmp_path}/vimfiles"
       @deploy_path = @flavor.make_deploy_path(@vimfiles_path)
     end
 
-    after :each do
-      clean_up_stashed_stuffs()
-    end
-
     it 'should remove deployed files' do
       create_a_test_repo(@test_repo_path)
       @flavor.clone()
@@ -209,8 +201,10 @@ describe Vim::Flavor::Flavor do
   end
 
   describe '#list_versions' do
+    with_temporary_directory
+
     before :each do
-      @test_repo_path = "#{Vim::Flavor::DOT_PATH}/test/origin"
+      @test_repo_path = "#{@tmp_path}/test/origin"
 
       @flavor = described_class.new()
       @flavor.repo_name = '@test_repo_path'
@@ -218,10 +212,6 @@ describe Vim::Flavor::Flavor do
       @flavor.locked_version = '1.0.0'
     end
 
-    after :each do
-      clean_up_stashed_stuffs()
-    end
-
     it 'should list tags as versions' do
       create_a_test_repo(@test_repo_path)
       @flavor.clone()
@@ -236,8 +226,10 @@ describe Vim::Flavor::Flavor do
   end
 
   describe '#update_locked_version' do
+    with_temporary_directory
+
     before :each do
-      @test_repo_path = "#{Vim::Flavor::DOT_PATH}/test/origin"
+      @test_repo_path = "#{@tmp_path}/test/origin"
 
       @flavor = described_class.new()
       @flavor.repo_name = '@test_repo_path'
@@ -245,10 +237,6 @@ describe Vim::Flavor::Flavor do
       @flavor.locked_version = nil
     end
 
-    after :each do
-      clean_up_stashed_stuffs()
-    end
-
     it 'should update locked_version according to version_contraint' do
       create_a_test_repo(@test_repo_path)
       @flavor.clone()

data/spec/flavorfile_spec.rb

@@ -1,4 +1,5 @@
 require 'bundler/setup'
+require 'spec_helper'
 require 'vim-flavor'
 
 describe Vim::Flavor::FlavorFile do

data/spec/lockfile_spec.rb

@@ -1,14 +1,13 @@
 require 'bundler/setup'
 require 'fileutils'
+require 'spec_helper'
 require 'vim-flavor'
 
 describe Vim::Flavor::LockFile do
-  before :each do
-    @lockfile_path = "#{Vim::Flavor::DOT_PATH}/VimFlavor.lock"
-  end
+  with_temporary_directory
 
-  after :each do
-    FileUtils.rm_rf([Vim::Flavor::DOT_PATH], :secure => true)
+  before :each do
+    @lockfile_path = "#{@tmp_path}/VimFlavor.lock"
   end
 
   it 'should be initialized with a given path and no flavor' do

data/spec/spec_helper.rb

@@ -1,5 +1,8 @@
 require 'bundler/setup'
 require 'fileutils'
+require 'spec_helper'
+require 'tmpdir'
+require 'vim-flavor'
 
 def create_a_test_repo(path)
   system(<<-"END")
@@ -35,6 +38,26 @@ def update_a_test_repo(path)
   END
 end
 
-def clean_up_stashed_stuffs()
-  FileUtils.rm_rf([Vim::Flavor::DOT_PATH], :secure => true)
+def create_temporary_directory()
+  Dir.mktmpdir()
+end
+
+def remove_temporary_directory(path)
+  FileUtils.remove_entry_secure(path)
+end
+
+def with_temporary_directory()
+  before :each do
+    @tmp_path = create_temporary_directory()
+
+    @original_dot_path = Vim::Flavor.dot_path
+    @dot_path = "#{@tmp_path}/.vim-flavor"
+    Vim::Flavor.dot_path = @dot_path
+  end
+
+  after :each do
+    Vim::Flavor.dot_path = @original_dot_path
+
+    remove_temporary_directory(@tmp_path)
+  end
 end

data/spec/versionconstraint_spec.rb

@@ -1,4 +1,5 @@
 require 'bundler/setup'
+require 'spec_helper'
 require 'vim-flavor'
 
 describe Vim::Flavor::VersionConstraint do

metadata

@@ -2,7 +2,7 @@
 name: vim-flavor
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Kana Natsuno
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-24 00:00:00 +09:00
+date: 2012-03-27 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -49,7 +49,7 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE
-- README.asciidoc
+- README.md
 - Rakefile
 - bin/vim-flavor
 - lib/vim-flavor.rb

data/README.asciidoc

@@ -1,142 +0,0 @@
-= vim-flavor: a tool to manage your favorite Vim plugins
-
-
-
-
-== Set up the utility for a new-style plugin management
-
-=== Requirements
-
-* Git 1.7.9 or later
-* Ruby 1.9.2 or later
-* Vim 7.3 or later
-
-
-=== Supported platforms
-
-* Unix-like environments such as Linux, Mac OS X, etc.
-* Though Microsoft Windows is not directly supported,
-  it is possible to manage Vim plugins via Cygwin or other environments.
-
-
-=== Installation steps
-
-----
-gem install vim-flavor
-----
-
-
-
-
-== Start using vim-flavor
-
-----
-cd $YOUR_REPOSITORY_FOR_DOTFILES
-
-cat >VimFlavor <<'END'
-  # * Declare using git://github.com/kana/vim-textobj-indent.git
-  # * vim-flavor fetches a plugin from git://github.com/$USER/$REPO.git
-  #   if the argument is written in '$USER/$REPO' format.
-  # * kana/vim-textobj-indent requires kana/vim-textobj-user.
-  #   Such dependencies are automatically installed
-  #   if the flavored plugin declares its dependencies with VimFlavor file.
-  #   (FIXME: Resolving dependencies will be implemented later.)
-  flavor 'kana/vim-textobj-indent'
-
-  # * Declare using git://github.com/vim-scripts/fakeclip.git
-  # * vim-flavor fetches a plugin from git://github.com/vim-scripts/$REPO.git
-  #   if the argument is written in '$REPO' format.
-  flavor 'fakeclip'
-
-  # * Declare using git://github.com/kana/vim-altr.git
-  # * vim-flavor fetches a plugin from the URI
-  #   if the argument seems to be a URI.
-  flavor 'git://github.com/kana/vim-altr.git'
-
-  # * Declare using kana/vim-smartchr 0.1.0 or later and older than 0.2.0.
-  flavor 'kana/vim-smartchr', '~> 0.1.0'
-
-  # * Declare using kana/vim-smartword 0.1 or later and older than 1.0.
-  flavor 'kana/vim-smartword', '~> 0.1'
-
-  # * Declare using kana/vim-smarttill 0.1.0 or later.
-  flavor 'kana/vim-smarttill', '>= 0.1.0'
-END
-
-# Fetch the plugins declared in the VimFlavor,
-# create VimFlavor.lock for a snapshot of all plugins and versions,
-# then install the plugins and a bootstrap script into ~/.vim etc.
-vim-flavor install
-
-# Add the following line into the first line of your vimrc:
-#
-#   runtime flavors/bootstrap.vim
-vim vimrc
-
-git add VimFlavor VimFlavor.lock vimrc
-git commit -m 'Use vim-flavor to manage my favorite Vim plugins'
-----
-
-
-
-
-== Upgrade all plugins to the latest version
-
-----
-vim-flavor upgrade
-
-git add VimFlavor.lock
-git commit -m 'Upgrade my favorite Vim plugins'
-----
-
-
-
-
-== Add more plugins into your dotfile repository
-
-----
-cat >>VimFlavor <<'END'
-
-  flavor 'kana/vim-operator-replace'
-
-END
-
-# Fetch newly added plugins,
-# update VimFlavor.lock for the plugins,
-# then install the plugins into ~/.vim etc.
-vim-flavor install
-
-git add VimFlavor VimFlavor.lock
-git commit -m 'Use kana/vim-operator-replace'
-----
-
-
-
-
-== Remove plugins from your dotfile repository
-
-----
-# Remove declarations of unused plugins from VimFlavor.
-sed -i~ -e '/vim-smartchr/d' VimFlavor
-
-# Update VimFlavor.lock for the removed plugins,
-# then clean up the plugins from ~/.vim etc.
-vim-flavor install
-
-git add VimFlavor VimFlavor.lock
-git commit -m 'Farewell kana/vim-smartchr'
-----
-
-
-
-
-== Install plugins into a non-standard directory
-
-----
-vim-flavor install --vimfiles-path=/cygdrive/c/Users/kana/vimfiles
-----
-
-
-
-
-// vim: filetype=asciidoc