vim-flavor 2.2.2 → 3.0.0

data/features/testing_vim_plugins/README.md

@@ -3,7 +3,7 @@
 1. Write tests for your Vim plugin with
    [vim-vspec](https://github.com/kana/vim-vspec).
 2. Declare dependencies of your Vim plugin as a [flavorfile](flavorfile), and
-   save it as `VimFlavor` in the root of your Vim plugin.
+   save it as `Flavorfile` in the root of your Vim plugin.
 3. Run `vim-flavor test`.
 
 
@@ -14,15 +14,16 @@
 It is hard to test Vim plugins, because there are a few problems:
 
 * It is hard to write readable and maintainable test code in Vim script, even
-  for skilled users.  Because Vim script is not expressive as script languages
-  like Ruby and others.
+  for skilled users.  Because Vim script is not expressive as other script
+  languages like Ruby.
 * Each test must be run in an isolated environment to guarantee the same
   results for every time and everywhere.  So that all settings including vimrc
-  and plugins must be ignored.  User's viminfo must not be read and written
-  too.
+  and plugins of yours must be ignored.  Your viminfo also must not be read
+  and written to avoid unexpected test failures and unexpectedly overwritten
+  of registers and marks you used.
 * Some plugins require other plugins at runtime.  Such dependencies must be
   resolved, but they must be installed into a temporary place to avoid
-  corrupting user's settings.  And `'runtimepath'` must be configured
+  corrupting your environment.  And `'runtimepath'` must be configured
   carefully for both dependencies and plugins under development.
 
 Therefore it is hard to do right testing for Vim plugins from scratch.  As

data/features/testing_vim_plugins/dependencies.feature

@@ -53,8 +53,8 @@ Feature: Dependencies
       kana/vim-textobj-user \(0\.\d+(\.\d+)?\)
       kana/vim-vspec \(1\.\d+(\.\d+)?\)
       """
-    And a dependency "kana/vim-vspec" is stored in ".vim-flavor/deps"
-    And a dependency "kana/vim-textobj-user" is stored in ".vim-flavor/deps"
+    And a dependency "kana/vim-vspec" is stored in ".vim-flavor/pack/flavors/start"
+    And a dependency "kana/vim-textobj-user" is stored in ".vim-flavor/pack/flavors/start"
 
   Scenario: Update dependencies for testing
     Given a flavorfile with:
@@ -89,7 +89,6 @@ Feature: Dependencies
     When I run `vim-flavor test --update-dependencies`
     Then it should pass with regexp:
       """
-      .*
       -------- Preparing dependencies
       Checking versions...
         Use kana/vim-textobj-user ... 0\.3\.13

data/features/testing_vim_plugins/failures.feature

@@ -45,7 +45,7 @@ Feature: Failures
       -------------------
       t/basics.vim \(Wstat: 0 Tests: 1 Failed: 1\)
         Failed test:  1
-      Files=1, Tests=1,  0 wallclock secs (.*)
+      Files=1, Tests=1,  \d+ wallclock secs .*
       Result: FAIL
       """
     And the output should not contain:
@@ -56,4 +56,4 @@ Feature: Failures
       """
       kana/vim-vspec \(1\.\d+(\.\d+)?\)
       """
-    And a dependency "kana/vim-vspec" is stored in ".vim-flavor/deps"
+    And a dependency "kana/vim-vspec" is stored in ".vim-flavor/pack/flavors/start"

data/features/testing_vim_plugins/specifying_test_scripts.feature

@@ -52,7 +52,7 @@ Feature: Specifying test scripts
       """
       kana/vim-vspec \(1\.\d+(\.\d+)?\)
       """
-    And a dependency "kana/vim-vspec" is stored in ".vim-flavor/deps"
+    And a dependency "kana/vim-vspec" is stored in ".vim-flavor/pack/flavors/start"
 
   Scenario: Running a specific `.vim` test script
     When I run `vim-flavor test spec/basics.vim`
@@ -74,7 +74,7 @@ Feature: Specifying test scripts
       """
       kana/vim-vspec \(1\.\d+(\.\d+)?\)
       """
-    And a dependency "kana/vim-vspec" is stored in ".vim-flavor/deps"
+    And a dependency "kana/vim-vspec" is stored in ".vim-flavor/pack/flavors/start"
 
   Scenario: Running a specific `.t` test script
     When I run `vim-flavor test spec/sh.t`
@@ -96,4 +96,4 @@ Feature: Specifying test scripts
       """
       kana/vim-vspec \(1\.\d+(\.\d+)?\)
       """
-    And a dependency "kana/vim-vspec" is stored in ".vim-flavor/deps"
+    And a dependency "kana/vim-vspec" is stored in ".vim-flavor/pack/flavors/start"

data/features/testing_vim_plugins/typical_usage.feature

@@ -5,12 +5,6 @@ Feature: Typical usage
 
   Background:
     Given a repository "kana/vim-vspec" from offline cache
-
-  Scenario: Testing a Vim plugin without any dependency
-    Given a flavorfile with:
-      """ruby
-      # No dependency
-      """
     And a file named "plugin/foo.vim" with:
       """vim
       let g:foo = 3
@@ -33,6 +27,35 @@ Feature: Typical usage
       echo 'ok 1'
       echo '1..1'
       """
+
+  Scenario: Testing a Vim plugin with no dependencies
+    Given a flavorfile with:
+      """ruby
+      # No dependencies
+      """
+    When I run `vim-flavor test`
+    Then it should pass with regexp:
+      """
+      -------- Preparing dependencies
+      Checking versions...
+        Use kana/vim-vspec ... 1\.\d+(\.\d+)?
+      Deploying plugins...
+        kana/vim-vspec 1\.\d+(\.\d+)? ... done
+      Completed.
+      -------- Testing a Vim plugin
+      t/basics.vim .. ok
+      t/sh.t ........ ok
+      All tests successful.
+      Files=2, Tests=2,  \d+ wallclock secs .*
+      Result: PASS
+      """
+    And a lockfile is created and matches with:
+      """
+      kana/vim-vspec \(1\.\d+(\.\d+)?\)
+      """
+    And a dependency "kana/vim-vspec" is stored in ".vim-flavor/pack/flavors/start"
+
+  Scenario: Assuming no dependencies if flavorfile does not exist
     When I run `vim-flavor test`
     Then it should pass with regexp:
       """
@@ -53,4 +76,4 @@ Feature: Typical usage
       """
       kana/vim-vspec \(1\.\d+(\.\d+)?\)
       """
-    And a dependency "kana/vim-vspec" is stored in ".vim-flavor/deps"
+    And a dependency "kana/vim-vspec" is stored in ".vim-flavor/pack/flavors/start"

data/features/typical_usage/README.md

@@ -26,21 +26,21 @@ and `vim-flavor` does it.
     cd $YOUR_REPOSITORY_FOR_DOTFILES
 
     # Add, delete or change declarations which versions of Vim plugins to use.
-    vim VimFlavor
+    vim Flavorfile
 
-    # Install Vim plugins according to VimFlavor.
+    # Install Vim plugins according to Flavorfile.
     vim-flavor install
 
     # Record changes to the declarations and locked status.
-    git add VimFlavor VimFlavor.lock
+    git add Flavorfile Flavorfile.lock
     git commit -m '...'
 
 
 
 
-## Flavorfile (`VimFlavor`)
+## Flavorfile (`Flavorfile`)
 
-`vim-flavor` reads a file `VimFlavor` in the current working directory.
+`vim-flavor` reads a file `Flavorfile` in the current working directory.
 The file is called a flavorfile.  A flavorfile contains zero or more
 declarations about Vim plugins and which versions of Vim plugins to use.
 
@@ -49,9 +49,9 @@ See also [more details about flavorfile](flavorfile).
 
 
 
-## Lockfile (`VimFlavor.lock`)
+## Lockfile (`Flavorfile.lock`)
 
-`vim-flavor` creates a file `VimFlavor.lock` in the current working directory.
+`vim-flavor` creates a file `Flavorfile.lock` in the current working directory.
 The file is called a lockfile.  A lockfile contains details about installed
 Vim plugins to use the same configuration on every machine.
 

data/features/typical_usage/deploy_to_arbitrary_place.feature

@@ -19,5 +19,4 @@ Feature: Deploy Vim plugins to a non-standard directory
       """
       $foo_uri (1.0.2)
       """
-    And a bootstrap script is created in "my-vimfiles"
     And a flavor "$foo_uri" version "1.0.2" is deployed to "my-vimfiles"

data/features/typical_usage/install_vim_plugins.feature

@@ -21,5 +21,4 @@ Feature: Install Vim plugins
       """
       $foo_uri (1.0.2)
       """
-    And a bootstrap script is created in "$home/.vim"
     And a flavor "$foo_uri" version "1.0.2" is deployed to "$home/.vim"

data/features/typical_usage/uninstall_vim_plugins.feature

@@ -26,6 +26,5 @@ Feature: Uninstall Vim plugins
       """
       $bar_uri (2.0.2)
       """
-    And a bootstrap script is created in "$home/.vim"
     And a flavor "$bar_uri" version "2.0.2" is deployed to "$home/.vim"
     But a flavor "$foo_uri" is not deployed to "$home/.vim"

data/features/typical_usage/update_vim_plugins.feature

@@ -30,7 +30,6 @@ Feature: Update Vim plugins
       $baz_uri (1.0.2)
       $foo_uri (1.0.2)
       """
-    And a bootstrap script is created in "$home/.vim"
     And a flavor "$foo_uri" version "1.0.2" is deployed to "$home/.vim"
     And a flavor "$bar_uri" version "1.0.2" is deployed to "$home/.vim"
     And a flavor "$baz_uri" version "1.0.2" is deployed to "$home/.vim"
@@ -56,7 +55,6 @@ Feature: Update Vim plugins
       $baz_uri (1.0.2)
       $foo_uri (1.0.2)
       """
-    And a bootstrap script is created in "$home/.vim"
     And a flavor "$foo_uri" version "1.0.2" is deployed to "$home/.vim"
     And a flavor "$bar_uri" version "1.0.0" is deployed to "$home/.vim"
     And a flavor "$baz_uri" version "1.0.2" is deployed to "$home/.vim"
@@ -82,7 +80,6 @@ Feature: Update Vim plugins
       $baz_uri (1.0.2)
       $foo_uri (1.0.2)
       """
-    And a bootstrap script is created in "$home/.vim"
     And a flavor "$foo_uri" version "1.0.2" is deployed to "$home/.vim"
     And a flavor "$bar_uri" version "1.0.2" is deployed to "$home/.vim"
     And a flavor "$baz_uri" version "1.0.2" is deployed to "$home/.vim"

data/features/uninstall_vim_flavor.md

@@ -1,11 +1,10 @@
 ## Uninstallation steps
 
-    rm -r ~/.vim-flavor
-    rm -r ~/.vim/flavors  # or ~/vimfiles/flavors etc.
+    rm -rf ~/.vim-flavor
+    rm -rf ~/.vim/flavors  # or ~/vimfiles/flavors etc.
 
     cd $YOUR_REPOSITORY_FOR_DOTFILES
-    rm VimFlavor VimFlavor.lock
-    vim vimrc  # Remove the "runtime flavors/bootstrap.vim" line.
+    rm Flavorfile Flavorfile.lock
     git commit -am 'Farewell to vim-flavor'
 
     gem uninstall vim-flavor

data/features/version_lock.feature

@@ -19,5 +19,4 @@ Feature: Version lock
       """
       $foo_uri (1.0.0)
       """
-    And a bootstrap script is created in "$home/.vim"
     And a flavor "$foo_uri" version "1.0.0" is deployed to "$home/.vim"

data/features/version_tag_format.feature

@@ -26,7 +26,6 @@ Feature: Version tag format
       """
       $foo_uri (1.2.3)
       """
-    And a bootstrap script is created in "$home/.vim"
     And a flavor "$foo_uri" version "1.2.3" is deployed to "$home/.vim"
     When I run `vim-flavor install`
     Then it should pass with template:
@@ -57,7 +56,6 @@ Feature: Version tag format
       """
       $foo_uri (v1.2.3)
       """
-    And a bootstrap script is created in "$home/.vim"
     And a flavor "$foo_uri" version "v1.2.3" is deployed to "$home/.vim"
     When I run `vim-flavor install`
     Then it should pass with template:
@@ -86,7 +84,6 @@ Feature: Version tag format
       There is no valid version
       """
     And a lockfile is not created
-    And a bootstrap script is not created in "$home/.vim"
     And a flavor "$foo_uri" is not deployed to "$home/.vim"
 
   Scenario: Without tags
@@ -106,5 +103,4 @@ Feature: Version tag format
       There is no valid version
       """
     And a lockfile is not created
-    And a bootstrap script is not created in "$home/.vim"
     And a flavor "$foo_uri" is not deployed to "$home/.vim"

data/lib/vim-flavor.rb

@@ -1,4 +1,3 @@
-require 'bundler/setup'
 require 'vim-flavor/enumerableextension'
 
 module Vim
@@ -6,6 +5,7 @@ module Vim
     [
       :BranchVersion,
       :CLI,
+      :Console,
       :Env,
       :Facade,
       :Flavor,

data/lib/vim-flavor/cli.rb

@@ -9,7 +9,7 @@ module Vim
           :banner => 'DIR'
       end
 
-      desc 'install', 'Install Vim plugins according to VimFlavor file.'
+      desc 'install', 'Install Vim plugins according to Flavofile.'
       common_options_to_deploy
       def install
         Facade.new().install(
@@ -18,7 +18,7 @@ module Vim
       end
 
       desc 'update [REPO_NAME...]',
-        'Update Vim plugins according to VimFlavor file.'
+        'Update Vim plugins according to Flavorfile.'
       common_options_to_deploy
       def update(*repo_names)
         Facade.new().update(

data/lib/vim-flavor/console.rb

@@ -0,0 +1,22 @@
+require 'pastel'
+
+module Vim
+  module Flavor
+    module Console
+      class << self
+        private def pastel
+          @pastel ||= Pastel.new(enabled: $stdout.tty?)
+        end
+
+        def warn message
+          puts pastel.yellow("Warning: #{message}")
+        end
+
+        def error message
+          puts pastel.red("Error: #{message}")
+          exit(1)
+        end
+      end
+    end
+  end
+end

data/lib/vim-flavor/facade.rb

@@ -20,28 +20,29 @@ module Vim
       def test(files_or_dirs, options)
         trace "-------- Preparing dependencies\n"
 
-        flavorfile = FlavorFile.load_or_new(Dir.getwd().to_flavorfile_path)
+        flavorfile_path = FlavorFile.path_from(Dir.getwd(), true)
+        flavorfile = FlavorFile.load_or_new(flavorfile_path)
         flavorfile.flavor 'kana/vim-vspec', '~> 1.5', :group => :development unless
           flavorfile.flavor_table.has_key?('kana/vim-vspec')
-        lockfile = LockFile.load_or_new(Dir.getwd().to_lockfile_path)
+        lockfile_path = LockFile.path_from(Dir.getwd(), true)
+        lockfile = LockFile.load_or_new(lockfile_path)
+        flavors_path = Dir.getwd().to_stash_path.to_flavors_path
 
         refresh_flavors(
           options[:update_dependencies] ? :update : :install,
           flavorfile,
           lockfile,
           [:runtime, :development],
-          Dir.getwd().to_stash_path.to_deps_path
+          flavors_path
         )
 
         trace "-------- Testing a Vim plugin\n"
 
-        this_path = Dir.getwd()
-        deps_path = this_path.to_stash_path.to_deps_path
-        runner = "#{deps_path}/#{'kana/vim-vspec'.zap}/bin/prove-vspec"
+        runner = "#{flavors_path}/#{'kana/vim-vspec'.zap}/bin/prove-vspec"
         plugin_paths = lockfile.flavors.map {|f|
-          "#{deps_path}/#{f.repo_name.zap}"
+          "#{flavors_path}/#{f.repo_name.zap}"
         }
-        runtime_paths = ([this_path] + plugin_paths).flat_map {|p| ['-d', p]}
+        runtime_paths = ([Dir.getwd()] + plugin_paths).flat_map {|p| ['-d', p]}
         command =
           %Q{ '#{runner}' \
               #{runtime_paths.flat_map {|p| ['-d', p]}.shelljoin} \
@@ -51,8 +52,10 @@ module Vim
       end
 
       def install_or_update(mode, vimfiles_path)
-        flavorfile = FlavorFile.load(Dir.getwd().to_flavorfile_path)
-        lockfile = LockFile.load_or_new(Dir.getwd().to_lockfile_path)
+        flavorfile_path = FlavorFile.path_from(Dir.getwd(), true)
+        flavorfile = FlavorFile.load_or_new(flavorfile_path)
+        lockfile_path = LockFile.path_from(Dir.getwd(), true)
+        lockfile = LockFile.load_or_new(lockfile_path)
         refresh_flavors(
           mode,
           flavorfile,
@@ -175,7 +178,8 @@ module Vim
 
       def complete_a_flavor_dependencies(nf, locked_flavor_table, mode, groups, level)
         nf.checkout()
-        ff = FlavorFile.load_or_new(nf.cached_repo_path.to_flavorfile_path)
+        flavorfile_path = FlavorFile.path_from(nf.cached_repo_path, false)
+        ff = FlavorFile.load_or_new(flavorfile_path)
         complete_flavors(ff.flavor_table, locked_flavor_table, mode, groups, level + 1, nf.repo_name)
       end
 
@@ -183,7 +187,8 @@ 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)
+        lockfile_path = LockFile.path_from(a_flavors_path, false)
+        deployment_memo = LockFile.load_or_new(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
@@ -193,8 +198,6 @@ module Vim
           :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} ..."}.
         on_failure {trace " failed\n"}.
@@ -228,40 +231,6 @@ module Vim
         deployment_memo.save()
       end
 
-      def create_vim_script_for_bootstrap(flavors_path)
-        bootstrap_path = flavors_path.to_bootstrap_path
-        FileUtils.mkdir_p(File.dirname(bootstrap_path))
-        File.open(bootstrap_path, 'w') do |f|
-          f.write(<<-'END')
-            function! s:bootstrap()
-              let current_rtp = &runtimepath
-              let current_rtps = split(current_rtp, ',')
-              set runtimepath&
-              let default_rtp = &runtimepath
-              let default_rtps = split(default_rtp, ',')
-              let user_dir = default_rtps[0]
-              let user_after_dir = default_rtps[-1]
-              let base_rtps =
-              \ filter(copy(current_rtps),
-              \        'v:val !=# user_dir && v:val !=# user_after_dir')
-              let flavor_dirs =
-              \ filter(split(glob(user_dir . '/flavors/*'), '\n'),
-              \        'isdirectory(v:val)')
-              let new_rtps =
-              \ []
-              \ + [user_dir]
-              \ + flavor_dirs
-              \ + base_rtps
-              \ + map(reverse(copy(flavor_dirs)), 'v:val . "/after"')
-              \ + [user_after_dir]
-              let &runtimepath = join(new_rtps, ',')
-            endfunction
-
-            call s:bootstrap()
-          END
-        end
-      end
-
       def trace message
         print message
       end