vim-flavor 1.0.2 → 1.0.3

data/features/.nav

@@ -9,7 +9,7 @@
 - command_line:
 - flavorfile:
 - version_lock.feature
-- caching.feature
+- caching:
 - resolve_dependencies.feature
 - testing_vim_plugins:
   - typical_usage.feature

data/features/caching/README.md

@@ -0,0 +1,13 @@
+It would be better to install/upgrade Vim plugins as fast as possible.
+Since `vim-flavor` manages Vim plugins with Git, it has to clone each plugin's
+repository at first, and it also has to fetch changes from time to time.
+But network access is typically time-consuming.
+
+Therefore `vim-flavor` caches fetched stuffs.  The cache is stored in
+`~/.vim-flavor`.  When `vim-flavor` needs to deploy plugins, it avoids network
+access as much as possible.
+
+
+
+
+<!-- vim: set expandtab shiftwidth=4 softtabstop=4 textwidth=78 : -->

data/features/{caching.feature → caching/basics.feature}

@@ -1,4 +1,4 @@
-Feature: Caching
+Feature: Basics
   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.

data/features/caching/deployment.feature

@@ -0,0 +1,63 @@
+Feature: Deployment
+  In order to finish deployment as fast as possible,
+  as a lazy Vim user,
+  I want to skip plugins which are already deployed with proper versions.
+
+  Background:
+    Given a repository "foo" with versions "1.0 1.1 1.2"
+    And a flavorfile with:
+      """ruby
+      flavor '$foo_uri', '~> 1.0'
+      """
+  Scenario: Deploy plugins which are not deployed yet
+    Given a flavor "$foo_uri" is not deployed to "$home/.vim"
+    When I run `vim-flavor install`
+    Then it should pass with template:
+      """
+      Checking versions...
+        Use $foo_uri ... 1.2
+      Deploying plugins...
+        $foo_uri 1.2 ... done
+      Completed.
+      """
+    And a flavor "$foo_uri" version "1.2" is deployed to "$home/.vim"
+
+  Scenario: Skip plugins which are already deployed with proper versions
+    Given I run `vim-flavor install`
+    And a flavor "$foo_uri" version "1.2" is deployed to "$home/.vim"
+    When I create a file named "abc" in "$foo_uri" deployed to "$home/.vim"
+    And I run `vim-flavor install`
+    Then it should pass with template:
+      """
+      Checking versions...
+        Use $foo_uri ... 1.2
+      Deploying plugins...
+        $foo_uri 1.2 ... skipped (already deployed)
+      Completed.
+      """
+    And a flavor "$foo_uri" version "1.2" is deployed to "$home/.vim"
+    And a file named "abc" should exist in "$foo_uri" deployed to "$home/.vim"
+
+  Scenario: Redeploy plugins if their versions differ from deployed ones
+    Given a lockfile with:
+      """
+      $foo_uri (1.0)
+      """
+    And I run `vim-flavor install`
+    And a flavor "$foo_uri" version "1.0" is deployed to "$home/.vim"
+    When I create a file named "abc" in "$foo_uri" deployed to "$home/.vim"
+    And I edit the lockfile as:
+      """
+      $foo_uri (1.1)
+      """
+    And I run `vim-flavor install`
+    Then it should pass with template:
+      """
+      Checking versions...
+        Use $foo_uri ... 1.1
+      Deploying plugins...
+        $foo_uri 1.1 ... done
+      Completed.
+      """
+    And a flavor "$foo_uri" version "1.1" is deployed to "$home/.vim"
+    And a file named "abc" should not exist in "$foo_uri" deployed to "$home/.vim"

data/features/caching/edge_cases.feature

@@ -0,0 +1,32 @@
+Feature: Edge cases
+  In order to use the same configuration across multiple environments,
+  as a lazy Vim user,
+  I want to properly update cached repositories of plugins.
+
+  Scenario: Using `vim-flavor` on multiple environments
+    Given a repository "foo" with versions "1.0 1.1 1.2"
+    And a flavorfile with:
+      """ruby
+      flavor '$foo_uri', '~> 1.0'
+      """
+    And I run `vim-flavor install`
+    And a lockfile is created with:
+      """
+      $foo_uri (1.2)
+      """
+    And a flavor "$foo_uri" version "1.2" is deployed to "$home/.vim"
+    And "foo" version "1.3" is released
+    And "foo" version "1.4" is released
+    And I copy a new lockfile from another machine with:
+      """
+      $foo_uri (1.3)
+      """
+    And "$foo_uri" version "1.3" is not cached
+    When I run `vim-flavor install`
+    Then it should pass
+    And the lockfile is updated with:
+      """
+      $foo_uri (1.3)
+      """
+    And a flavor "$foo_uri" version "1.3" is deployed to "$home/.vim"
+    And "$foo_uri" version "1.3" is cached

data/features/step_definitions/flavor_steps.rb

@@ -19,6 +19,23 @@ Given /^a (?:(?:GitHub|local) )?repository "(.+)" with versions "(.+)"$/ do |bas
   END
 end
 
+Given /^"(.+)" version "(.+)" is released$/ do |basename, version|
+  repository_path = make_repo_path(basename)
+  doc_name = basename.split('/').last.sub(/^vim-/, '')
+  sh <<-"END"
+    {
+      cd '#{repository_path}' &&
+      for v in #{version}
+      do
+        echo "*#{doc_name}* $v" >'doc/#{doc_name}.txt'
+        git add doc
+        git commit -m "Version $v"
+        git tag -m "Version $v" "$v"
+      done
+    } >/dev/null
+  END
+end
+
 Given /^a repository "(.+)" from offline cache$/ do |repo_name|
   repository_path = make_repo_path(repo_name).sub(expand('$tmp/'), '')
   sh <<-"END"
@@ -34,6 +51,15 @@ Given /^I disable network to the original repository of "(.+)"$/ do |basename|
   }
 end
 
+When /^I create a file named "(.+?)" in "(.+?)" deployed to "(.+?)"$/ do |file_name, v_repo_name, v_vimfiles_path|
+  flavor_path = make_flavor_path(expand(v_vimfiles_path), expand(v_repo_name))
+  steps %Q{
+    When I write to "#{flavor_path}/#{file_name}" with:
+      """
+      """
+  }
+end
+
 Then /^a flavor "(.+)" version "(.+)" is deployed to "(.+)"$/ do |v_repo_name, version, v_vimfiles_path|
   flavor_path = make_flavor_path(expand(v_vimfiles_path), expand(v_repo_name))
   basename = expand(v_repo_name).split('/').last.sub(/^vim-/, '')
@@ -52,3 +78,20 @@ Then /^a flavor "(.+)" is not deployed to "(.+)"$/ do |v_repo_name, v_vimfiles_p
     Then a directory named "#{flavor_path}" should not exist
   }
 end
+
+Then /^"(.+)" version "(.+)" is (?:(not) )?cached$/ do |v_repo_name, version, p|
+  d = make_cached_repo_path(expand(v_repo_name), expand('$home').to_stash_path)
+  (system <<-"END").should == (p != 'not')
+    {
+      cd '#{d}' &&
+      git rev-list --quiet '#{version}'
+    } >/dev/null 2>&1
+  END
+end
+
+Then /^a file named "(.+?)" (should(?: not)?) exist in "(.+?)" deployed to "(.+?)"$/ do |file_name, should, v_repo_name, v_vimfiles_path|
+  flavor_path = make_flavor_path(expand(v_vimfiles_path), expand(v_repo_name))
+  steps %Q{
+    Then a file named "#{flavor_path}/#{file_name}" #{should} exist
+  }
+end

data/features/step_definitions/lockfile_steps.rb

@@ -7,12 +7,30 @@ Given 'a lockfile with:' do |content|
   }
 end
 
+Given 'I copy a new lockfile from another machine with:' do |content|
+  steps %Q{
+    Given a lockfile with:
+      """
+      #{content}
+      """
+  }
+end
+
 Given 'I delete the lockfile' do
   steps %Q{
     Given I remove the file "#{'.'.to_lockfile_path}"
   }
 end
 
+When 'I edit the lockfile as:' do |content|
+  steps %Q{
+    Given a lockfile with:
+      """
+      #{content}
+      """
+  }
+end
+
 Then /^(?:a|the) lockfile is (?:created|updated) with:$/ do |content|
   # For some reason, Cucumber drops the last newline from every docstring...
   steps %Q{

data/features/support/env.rb

@@ -12,6 +12,10 @@ class FakeUserEnvironment
     }
   end
 
+  def make_cached_repo_path(repo_name, stash_path)
+    "#{stash_path}/repos/#{repo_name.zap}"
+  end
+
   def make_flavor_path(vimfiles_path, repo_name)
     "#{vimfiles_path.to_flavors_path}/#{repo_name.zap}"
   end

data/lib/vim-flavor/facade.rb

@@ -54,6 +54,12 @@ module Vim
           nf.clone() unless already_cached
 
           if mode == :install and lf and nf.satisfied_with?(lf)
+            if not nf.cached_version?(lf.locked_version)
+              nf.fetch()
+              if not nf.cached_version?(lf.locked_version)
+                raise RuntimeError, "#{nf.repo_name} is locked to #{lf.locked_version}, but no such version exists"
+              end
+            end
             nf.use_specific_version(lf.locked_version)
           else
             nf.fetch() if already_cached
@@ -70,21 +76,49 @@ module Vim
         trace "Deploying plugins...\n"
 
         a_flavors_path = File.absolute_path(flavors_path)
+        deployment_memo = LockFile.load_or_new(a_flavors_path.to_lockfile_path)
 
+        # To uninstall flavors which were deployed by vim-flavor 1.0.2 or
+        # older, the whole deployed flavors have to be removed.  Because
+        # deployment_memo is recorded since 1.0.3.
         FileUtils.rm_rf(
           [a_flavors_path],
           :secure => true
-        )
+        ) if deployment_memo.flavors.empty?
 
         create_vim_script_for_bootstrap(a_flavors_path)
 
         flavors.
         before_each {|f| trace "  #{f.repo_name} #{f.locked_version} ..."}.
-        after_each {|f| trace " done\n"}.
         on_failure {trace " failed\n"}.
         each do |f|
-          f.deploy(a_flavors_path)
+          df = deployment_memo.flavor_table[f.repo_name]
+          deployed_version = (df and df.locked_version)
+          if f.locked_version == deployed_version
+            trace " skipped (already deployed)\n"
+          else
+            FileUtils.rm_rf(
+              [f.make_deployment_path(a_flavors_path)],
+              :secure => true
+            )
+            f.deploy(a_flavors_path)
+            trace " done\n"
+          end
         end
+
+        deployment_memo.flavors.each do |df|
+          if flavors.all? {|f| f.repo_name != df.repo_name}
+            trace "  #{df.repo_name} ..."
+            FileUtils.rm_rf(
+              [df.make_deployment_path(a_flavors_path)],
+              :secure => true
+            )
+            trace " uninstalled\n"
+          end
+        end
+
+        deployment_memo.flavors = flavors
+        deployment_memo.save()
       end
 
       def create_vim_script_for_bootstrap(flavors_path)

data/lib/vim-flavor/flavor.rb

@@ -21,11 +21,24 @@ module Vim
         Dir.exists?(cached_repo_path)
       end
 
+      def cached_version?(version)
+        system <<-"END"
+          {
+            cd '#{cached_repo_path}' &&
+            git rev-list --quiet '#{version}'
+          } >/dev/null 2>&1
+        END
+      end
+
       def cached_repo_path
         @cached_repo_path ||=
           "#{ENV['HOME'].to_stash_path}/repos/#{@repo_name.zap}"
       end
 
+      def make_deployment_path(flavors_path)
+        "#{flavors_path}/#{repo_name.zap}"
+      end
+
       def self.github_repo_uri(user, repo)
         p = (ENV['VIM_FLAVOR_GITHUB_URI_PREFIX'] ||= 'git://github.com/')
         s = (ENV['VIM_FLAVOR_GITHUB_URI_SUFFIX'] ||= '.git')
@@ -66,7 +79,7 @@ module Vim
       end
 
       def deploy(flavors_path)
-        deployment_path = "#{flavors_path}/#{repo_name.zap}"
+        deployment_path = make_deployment_path(flavors_path)
         sh %Q[
           {
             cd '#{cached_repo_path}' &&

data/lib/vim-flavor/lockfile.rb

@@ -19,6 +19,10 @@ module Vim
         flavor_table.values.sort_by {|f| f.repo_name}
       end
 
+      def flavors=(fs)
+        flavor_table.replace(Hash[fs.map {|f| [f.repo_name, f]}])
+      end
+
       def load()
         s = File.open(@path, 'r') {|io| io.read()}
         @flavor_table =

data/lib/vim-flavor/version.rb

@@ -1,5 +1,5 @@
 module Vim
   module Flavor
-    VERSION = '1.0.2'
+    VERSION = '1.0.3'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vim-flavor
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-06 00:00:00.000000000 Z
+date: 2012-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parslet
@@ -110,7 +110,10 @@ files:
 - bin/vim-flavor
 - features/.nav
 - features/README.md
-- features/caching.feature
+- features/caching/README.md
+- features/caching/basics.feature
+- features/caching/deployment.feature
+- features/caching/edge_cases.feature
 - features/command_line/README.md
 - features/command_line/progress_messages.feature
 - features/flavorfile/README.md
@@ -188,7 +191,10 @@ specification_version: 3
 summary: A tool to manage your favorite Vim plugins
 test_files:
 - features/README.md
-- features/caching.feature
+- features/caching/README.md
+- features/caching/basics.feature
+- features/caching/deployment.feature
+- features/caching/edge_cases.feature
 - features/command_line/README.md
 - features/command_line/progress_messages.feature
 - features/flavorfile/README.md