vim-flavor 0.0.4 → 1.0.0

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+script: rake test

data/README.md

@@ -1,83 +1,5 @@
 # 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
-
-
-### Installable plugins
-
-Not all Vim plugins can be installed with vim-flavor.
-vim-flavor can install plugins which meet the following conditions:
-
-* Plugins must have dedicated Git repositories.
-  vim-flavor does not support other version control systems.
-  This is an intentional design.  Because:
-  * [vim-scripts.org](http://vim-scripts.org/) provides
-    [a comprehensive Git mirrors](https://github.com/vim-scripts) for
-    [plugins uploaded to www.vim.org](http://www.vim.org/scripts/index.php).
-  * Experimental plugins which are not uploaded to www.vim.org
-    are usually found in [GitHub](https://github.com/).
-* Plugins must follow [the versioning pocilies of
-  RubyGems](http://docs.rubygems.org/read/chapter/7#page26) and have "version"
-  tags in their repositories.  For example, if there is the version 1.2.3 of
-  a plugin, its repository must have the tag `1.2.3`, and the files of the
-  version 1.2.3 can be checked out via the tag `1.2.3`.  In other words,
-  plugins which do not have proper tags are not installabe.
-  This is an intentional design.  Because:
-  * It's not possible to determine whether two versions are compatible or not
-    without "version" tags.  Compatibility is a big problem to resolve
-    dependencies of plugins.  For example, if plugin A requires plugin X 1.2.3
-    or later while plugin B requires plugin X 2.0 or later, it's not possible
-    to use A and B at the same time.  Such problems should be detected before
-    installing plugins.
-  * Git mirrors by vim-scripts.org are tagged with version numbers.
-  * Some Git repositories might not have "version" tags.
-    Such plugins are not ready to use for everyone.
-    So that it should not be installable.
-* Plugins must have proper directory structures.
-  For example, directories such as `autoload`, `syntax` etc should exist in
-  the roots of plugins.
-  This is an intentional design.  Because:
-  * Git mirrors by vim-scripts.org have proper directory structures even if
-    the original plugins are uploaded to www.vim.org without proper directory
-    structures.  (A good example is
-    [a.vim](http://www.vim.org/scripts/script.php?script_id=31) and
-    [its mirror](https://github.com/vim-scripts/a.vim).)
-  * Other Git repositoris might not have proper directory structures.
-    Such plugins are not ready to use for everyone.
-    So that it should not be installable.
-
-
-
-
-## Typical usage
-
-### Start using vim-flavor
-
     cd $YOUR_REPOSITORY_FOR_DOTFILES
 
     cat >VimFlavor <<'END'
@@ -123,102 +45,9 @@ vim-flavor can install plugins which meet the following conditions:
     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.
+See also
+[the documentation on relish](https://www.relishapp.com/kana/vim-flavor) or
+`features/` directory for the details.
 
 
 

data/Rakefile

@@ -1,2 +1,12 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
+
+task :test => [:spec, :cucumber]
+
+task :spec do
+  sh 'bundle exec rspec'
+end
+
+task :cucumber do
+  sh 'bundle exec cucumber --format=progress'
+end

data/features/.nav

@@ -0,0 +1,12 @@
+- philosophy.md
+- install_vim_flavor.md (Install vim-flavor)
+- uninstall_vim_flavor.md (Uninstall vim-flavor)
+- typical_usage:
+  - install_vim_plugins.feature
+  - upgrade_vim_plugins.feature
+  - uninstall_vim_plugins.feature
+  - deploy_to_arbitrary_place.feature
+- flavorfile:
+- version_lock.feature
+- caching.feature
+- resolve_dependencies.feature

data/features/README.md

@@ -0,0 +1,17 @@
+vim-flavor is a tool to manage Vim plugins.
+
+
+
+
+## Issues
+
+Both vim-flavor and its documentation are
+[open source](https://github.com/kana/vim-flavor), and work in progress.
+If you find it incomplete or confusing,
+please [submit an issue](https://github.com/kana/vim-flavor/issues), or,
+better yet, [a pull request](https://github.com/kana/vim-flavor/pulls).
+
+
+
+
+<!-- vim: set expandtab shiftwidth=4 softtabstop=4 textwidth=78 : -->

data/features/caching.feature

@@ -0,0 +1,50 @@
+Feature: Caching
+  In order to finish deployment as fast as possible,
+  as a lazy Vim user,
+  I want to cache repositories of plugins which are installed before.
+
+  Background:
+    Given a temporary directory called 'tmp'
+    And a home directory called 'home' in '$tmp/home'
+    And a repository 'foo' with versions '1.0.0 1.0.1 1.0.2'
+    And flavorfile
+      """ruby
+      flavor '$foo_uri', '~> 1.0'
+      """
+    And I run `vim-flavor install`
+    And I disable network to the original repository of 'foo'
+
+  Scenario: Install plugins - locked and compatible with new flavorfile
+    Given I delete '$home/.vim'
+    When I run `vim-flavor install` again
+    Then I get lockfile
+      """
+      $foo_uri (1.0.2)
+      """
+    And I get flavor '$foo_uri' with '1.0.2' in '$home/.vim'
+
+  Scenario: Install plugins - locked but incompatible with new flavorfile
+    Given I edit flavorfile as
+      """ruby
+      flavor '$foo_uri', '~> 2.0'
+      """
+    When I run `vim-flavor install` but
+    Then it fails with messages like
+      """
+      fatal: \S+ does not appear to be a git repository
+      """
+
+  Scenario: Install plugins - not locked
+    Given I delete lockfile
+    When I run `vim-flavor install` but
+    Then it fails with messages like
+      """
+      fatal: \S+ does not appear to be a git repository
+      """
+
+  Scenario: Upgrading plugins
+    When I run `vim-flavor upgrade` but
+    Then it fails with messages like
+      """
+      fatal: \S+ does not appear to be a git repository
+      """

data/features/command_line/README.md

@@ -0,0 +1,9 @@
+The `vim-flavor` command comes with a few subcommands and options.
+For a full list of available subcommands, try the `help` subcommand:
+
+    $ vim-flavor help
+
+
+
+
+<!-- vim: set expandtab shiftwidth=4 softtabstop=4 textwidth=78 : -->

data/features/command_line/progress_messages.feature

@@ -0,0 +1,44 @@
+Feature: Progress messages
+  In order to know what is going on,
+  as a lazy Vim user,
+  I want to see messages about the current progress.
+
+  Background:
+    Given a temporary directory called 'tmp'
+    And a home directory called 'home' in '$tmp/home'
+
+  Scenario: Install Vim plugins successfully
+    Given a repository 'foo' with versions '1.0.0 1.0.1 1.0.2'
+    And a repository 'bar' with versions '2.0.0 2.0.1 2.0.2'
+    And flavorfile
+      """ruby
+      flavor '$foo_uri', '~> 1.0'
+      flavor '$bar_uri'
+      """
+    When I run `vim-flavor install`
+    Then it outputs progress like
+      """
+      Checking versions...
+        Use $bar_uri ... 2.0.2
+        Use $foo_uri ... 1.0.2
+      Deploying plugins...
+        $bar_uri 2.0.2 ... done
+        $foo_uri 1.0.2 ... done
+      Completed.
+      """
+
+  Scenario: Install Vim plugins which are not existing
+    Given flavorfile
+      """ruby
+      flavor 'no-such-plugin'
+      """
+    When I run `vim-flavor install` but
+    Then it fails with messages like
+      """
+      fatal: '\S+' does not appear to be a git repository
+      """
+    And it outputs progress like
+      """
+      Checking versions...
+        Use no-such-plugin ... failed
+      """

data/features/flavorfile/README.md

@@ -0,0 +1,9 @@
+Flavorfile is a DSL to declare which versions of Vim plugins to use.
+Whenever `vim-flavor` is invoked to manage Vim plugins,
+`vim-flavor` reads a file `VimFlavor` in the current working directory,
+and evaluates it as a flavorfile.
+
+
+
+
+<!-- vim: set expandtab shiftwidth=4 softtabstop=4 textwidth=78 : -->

data/features/flavorfile/comments.feature

@@ -0,0 +1,24 @@
+Feature: Comments
+  In order to remind notable points,
+  as a lazy Vim user,
+  I want to leave comments in my flavorfile.
+
+  Background:
+    Given a temporary directory called 'tmp'
+    And a home directory called 'home' in '$tmp/home'
+    And a repository 'foo' with versions '1.0 1.1 1.2 2.0'
+
+  Scenario: Comment out declarations
+    Given flavorfile
+      """ruby
+      # Since flavorfile is parsed as a Ruby script,
+      # you can comment out arbitrary lines like this.
+
+      # flavor '$foo_uri', '~> 1.0'
+      """
+    When I run `vim-flavor install`
+    Then I get lockfile
+      """
+      """
+    And I get a bootstrap script in '$home/.vim'
+    But I don't have flavor '$foo_uri' in '$home/.vim'

data/features/flavorfile/repository_name.feature

@@ -0,0 +1,53 @@
+Feature: Repository name
+  In order to keep flavorfile terse and readable,
+  as a lazy Vim user,
+  I also want to use shorthands for frequently used repositories.
+
+  Background:
+    Given a temporary directory called 'tmp'
+    And a home directory called 'home' in '$tmp/home'
+
+  Scenario: Declare using a Vim plugin from www.vim.org
+    Given a repository 'vim-scripts/vspec' with versions '0.0.4 1.2.0'
+    And flavorfile
+      """ruby
+      # Fetch the plugin from git://github.com/vim-scripts/vspec.git
+      flavor 'vspec', '~> 0.0'
+      """
+    When I run `vim-flavor install`
+    Then I get lockfile
+      """
+      vspec (0.0.4)
+      """
+    And I get a bootstrap script in '$home/.vim'
+    And I get flavor 'vspec' with '0.0.4' in '$home/.vim'
+
+  Scenario: Declare using a Vim plugin from GitHub
+    Given a repository 'kana/vim-vspec' with versions '0.0.4 1.2.0'
+    And flavorfile
+      """ruby
+      # Fetch the plugin from git://github.com/kana/vim-vspec.git
+      flavor 'kana/vim-vspec', '~> 0.0'
+      """
+    When I run `vim-flavor install`
+    Then I get lockfile
+      """
+      kana/vim-vspec (0.0.4)
+      """
+    And I get a bootstrap script in '$home/.vim'
+    And I get flavor 'kana/vim-vspec' with '0.0.4' in '$home/.vim'
+
+  Scenario: Declare using a Vim plugin from an arbitrary URI
+    Given a repository 'vspec' with versions '0.0.4 1.2.0'
+    And flavorfile
+      """ruby
+      # Fetch the plugin from the URI.
+      flavor '$vspec_uri', '~> 0.0'
+      """
+    When I run `vim-flavor install`
+    Then I get lockfile
+      """
+      $vspec_uri (0.0.4)
+      """
+    And I get a bootstrap script in '$home/.vim'
+    And I get flavor '$vspec_uri' with '0.0.4' in '$home/.vim'

data/features/flavorfile/version_constraint.feature

@@ -0,0 +1,52 @@
+Feature: Version constraint
+  In order to use Vim plugins which are compatible with my configuration,
+  as a lazy Vim user,
+  I want to declare desirable versions of Vim plugins.
+
+  Note that vim-flavor assumes that plugins follow [the versioning pocilies of
+  RubyGems](http://docs.rubygems.org/read/chapter/7#page26), to determine
+  compatibility of plugins.  See also [Philosophy](philosophy) for the details.
+
+  Background:
+    Given a temporary directory called 'tmp'
+    And a home directory called 'home' in '$tmp/home'
+    And a repository 'foo' with versions '1.0 1.1 1.2 2.0'
+
+  Scenario: Declare using the latest version of a Vim plugin
+    Given flavorfile
+      """ruby
+      flavor '$foo_uri'
+      """
+    When I run `vim-flavor install`
+    Then I get lockfile
+      """
+      $foo_uri (2.0)
+      """
+    And I get a bootstrap script in '$home/.vim'
+    And I get flavor '$foo_uri' with '2.0' in '$home/.vim'
+
+  Scenario: Declare using a Vim plugin not older than a specific version
+    Given flavorfile
+      """ruby
+      flavor '$foo_uri', '>= 1.1'
+      """
+    When I run `vim-flavor install`
+    Then I get lockfile
+      """
+      $foo_uri (2.0)
+      """
+    And I get a bootstrap script in '$home/.vim'
+    And I get flavor '$foo_uri' with '2.0' in '$home/.vim'
+
+  Scenario: Declare using the latest and compatible version of a Vim plugin
+    Given flavorfile
+      """ruby
+      flavor '$foo_uri', '~> 1.0'
+      """
+    When I run `vim-flavor install`
+    Then I get lockfile
+      """
+      $foo_uri (1.2)
+      """
+    And I get a bootstrap script in '$home/.vim'
+    And I get flavor '$foo_uri' with '1.2' in '$home/.vim'