vim-flavor 2.2.2 → 3.0.0

data/features/install_vim_flavor.md

@@ -1,10 +1,10 @@
 ## Required softwares
 
-* [Git](http://git-scm.com/) 1.7.9 or later
-* [Ruby](http://www.ruby-lang.org/) 2.0.0 or later
-  * Recommendation: Use [RVM](http://beginrescueend.com/) or other tools
+* [Git](https://git-scm.com/) 2.10.1 or later
+* [Ruby](https://www.ruby-lang.org/) 2.5.0 or later
+  * Recommendation: Use [RVM](https://rvm.io/) or other tools
     for ease of installation across different envinronments.
-* [Vim](http://www.vim.org/) 7.3 or later
+* [Vim](https://www.vim.org/) 8.0 or later
   * Note that Vim should be compiled as normal, big or huge version
     to use most of plugins.
 
@@ -26,14 +26,8 @@
 
     cd $YOUR_REPOSITORY_FOR_DOTFILES
 
-    # Add the following line into the first line of your vimrc:
-    #
-    #   runtime flavors/bootstrap.vim
-    vim vimrc
-
-    touch VimFlavor VimFlavor.lock
-
-    git add VimFlavor VimFlavor.lock vimrc
+    touch Flavorfile Flavorfile.lock
+    git add Flavorfile Flavorfile.lock
     git commit -m 'Use vim-flavor to manage my favorite Vim plugins'
 
 

data/features/news.md

@@ -1,3 +1,47 @@
+## vim-flavor 3.0.0
+
+### Enhancements
+
+* Steps to start using vim-flavor are simplified.  Especially, it is not
+  necessary to edit vimrc.
+
+### Incompatible changes
+
+* Vim 8.0 or later is required now.
+* Deployment format is changed.  It might be necessary to manually delete some
+  directories and files.  See also the follwoing migration guide.
+* The name of configuration file is changed.
+  * Old name is `VimFlavor`.
+  * New name is `Flavorfile`.
+  * Note that old name is still supported for backward compatibility.  Old
+    name file is used if there is no new name file.  But it is highly
+    recommended to rename.
+* The name of lock file is changed.
+  * Old name is `VimFlavor.lock`.
+  * New name is `Flavorfile.lock`.
+  * To avoid unexpected result and confusion, vim-flavor stops its process as
+    soon as possible if old name lockfile exists.
+
+### Migration guide from version 2
+
+* Delete `~/.vim/flavors` directory.
+* Delete `runtime flavors/bootstrap.vim` line from your vimrc.
+* In your dotfiles repository:
+  * Rename `VimFlavor` as `Flavorfile`.
+  * Rename `VimFlavor.lock` as `Flavorfile.lock`.
+* If you use vim-flavor for Vim plugin development, do the following steps in
+  that Vim plugin repository:
+  * Update `Gemfile` to uses vim-flavor 3.0 or later,
+    e.g., `gem 'vim-flavor', '~> 3.0'`.
+  * Rename `VimFlavor` as `Flavorfile`.
+  * Delete `.vim-flavor` directory.  It is used to stash runtime dependencies to
+    run tests for your Vim plugin.
+  * Note that you must not commit `Flavorfile.lock` for your Vim plugin.  It
+    makes your plugin hard to use with other plugins.
+
+
+
+
 ## vim-flavor 2.2.2
 
 ### Bug Fixes

data/features/philosophy.md

@@ -8,11 +8,11 @@ vim-flavor can install plugins which meet the following conditions:
   This is an intentional design.  Because:
   * [vim-scripts.org](http://vim-scripts.org/) provides
     [comprehensive Git mirrors](https://github.com/vim-scripts) for
-    [plugins uploaded to www.vim.org](http://www.vim.org/scripts/index.php).
+    [plugins uploaded to www.vim.org](https://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 policies of
-  RubyGems](http://docs.rubygems.org/read/chapter/7#page26) and have "version"
+* Plugins must follow [Semantic Versioning
+  2.0.0](https://semver.org/spec/v2.0.0.html) 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,
@@ -35,7 +35,7 @@ vim-flavor can install plugins which meet the following conditions:
   * 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
+    [a.vim](https://www.vim.org/scripts/script.php?script_id=31) and
     [its mirror](https://github.com/vim-scripts/a.vim).)
   * Other Git repositories might not have proper directory structures.
     Such plugins are not ready to use for everyone.

data/features/resolve_dependencies/README.md

@@ -14,12 +14,13 @@ overlooked.
 
 So that `vim-flavor` automatically resolves dependencies of Vim plugins.  If
 a plugin declares its dependencies as a [flavorfile](flavorfile) and saves it
-as `VimFlavor`, `vim-flavor` reads the file and automatically installs
+as `Flavorfile`, `vim-flavor` reads the file and automatically installs
 dependencies according to the file.
 
 `vim-flavor` also takes care about versions of Vim plugins.  If two plugins
-require the same plugin but required versions are not compatible to others,
-installation will be stopped to avoid using Vim with a broken configuration.
+require the same plugin but required versions are not compatible to each
+other, installation will be stopped to avoid using Vim with a broken
+configuration.
 
 
 

data/features/resolve_dependencies/basics.feature

@@ -34,7 +34,6 @@ Feature: Resolve dependencies of Vim plugins
       $foo_uri (1.1)
       $qux_uri (2.1)
       """
-    And a bootstrap script is created in "$home/.vim"
     And a flavor "$foo_uri" version "1.1" is deployed to "$home/.vim"
     And a flavor "$bar_uri" version "2.1" is deployed to "$home/.vim"
     And a flavor "$qux_uri" version "2.1" is deployed to "$home/.vim"
@@ -72,7 +71,6 @@ Feature: Resolve dependencies of Vim plugins
       $foo_uri (1.1)
       $qux_uri (1.1)
       """
-    And a bootstrap script is created in "$home/.vim"
     And a flavor "$foo_uri" version "1.1" is deployed to "$home/.vim"
     And a flavor "$bar_uri" version "2.1" is deployed to "$home/.vim"
     And a flavor "$qux_uri" version "1.1" is deployed to "$home/.vim"
@@ -112,7 +110,6 @@ Feature: Resolve dependencies of Vim plugins
       $foo_uri (2.1)
       $qux_uri (2.1)
       """
-    And a bootstrap script is created in "$home/.vim"
     And a flavor "$foo_uri" version "2.1" is deployed to "$home/.vim"
     And a flavor "$bar_uri" version "2.1" is deployed to "$home/.vim"
     And a flavor "$qux_uri" version "2.1" is deployed to "$home/.vim"
@@ -145,6 +142,5 @@ Feature: Resolve dependencies of Vim plugins
       $bar_uri (2.1)
       $foo_uri (2.1)
       """
-    And a bootstrap script is created in "$home/.vim"
     And a flavor "$foo_uri" version "2.1" is deployed to "$home/.vim"
     And a flavor "$bar_uri" version "2.1" is deployed to "$home/.vim"

data/features/resolve_dependencies/upgrade_outdated_dependencies.feature

@@ -40,7 +40,6 @@ Feature: Update outdated dependencies of Vim plugins
       $B_uri (0.0)
       $L_uri (0.4)
       """
-    And a bootstrap script is created in "$home/.vim"
     And a flavor "$A_uri" version "0.0" is deployed to "$home/.vim"
     And a flavor "$B_uri" version "0.0" is deployed to "$home/.vim"
     And a flavor "$L_uri" version "0.4" is deployed to "$home/.vim"
@@ -81,7 +80,6 @@ Feature: Update outdated dependencies of Vim plugins
       $L_uri (0.5)
       $X_uri (0.0)
       """
-    And a bootstrap script is created in "$home/.vim"
     And a flavor "$A_uri" version "0.0" is deployed to "$home/.vim"
     And a flavor "$B_uri" version "0.0" is deployed to "$home/.vim"
     And a flavor "$L_uri" version "0.5" is deployed to "$home/.vim"

data/features/resolve_dependencies/version_conflict.feature

@@ -31,7 +31,6 @@ Feature: Version conflict
         $foo_uri ~> 2.0 is required by $qux_uri
       Please resolve the conflict.
       """
-    And a bootstrap script is not created in "$home/.vim"
     And a flavor "$foo_uri" is not deployed to "$home/.vim"
     And a flavor "$bar_uri" is not deployed to "$home/.vim"
     And a flavor "$qux_uri" is not deployed to "$home/.vim"
@@ -59,6 +58,5 @@ Feature: Version conflict
         $foo_uri >= 2.0 is required by you
       Please resolve the conflict.
       """
-    And a bootstrap script is not created in "$home/.vim"
     And a flavor "$foo_uri" is not deployed to "$home/.vim"
     And a flavor "$bar_uri" is not deployed to "$home/.vim"

data/features/step_definitions/cli_steps.rb

@@ -7,7 +7,12 @@ Then 'it should pass' do
 end
 
 Then /^it should (pass|fail) with template:$/ do |pass_fail, template|
-  self.__send__("assert_#{pass_fail}ing_with", expand(template))
+  expect(last_command_started).to have_output(an_output_string_including(expand(template)))
+  if pass_fail == 'pass'
+    expect(last_command_started).to be_successfully_executed
+  else
+    expect(last_command_started).not_to be_successfully_executed
+  end
 end
 
 When /^I run `(.*)` \(variables expanded\)$/ do |command|

data/features/step_definitions/dependency_steps.rb

@@ -1,5 +1,6 @@
 Then /^a dependency "(.*)" is stored in "(.*)"$/ do |repo_name, deps_path|
+  cache_path = "#{deps_path}/#{repo_name.zap}"
   steps %Q{
-    Then a directory named "#{deps_path}/#{repo_name.zap}" should exist
+    Then a directory named "#{path_for_step(cache_path)}" should exist
   }
 end

data/features/step_definitions/directory_steps.rb

@@ -1,5 +1,5 @@
 When /^I delete the directory "([^"]*)"$/ do |dir_name|
-  in_current_dir do
+  cd('.') do
     # FileUtils#rmdir cannot delete non-empty directories.
     # TODO: Use aruba's "I remove the directory" step.
     #       Currently its implementation cannot delete git repositories.

data/features/step_definitions/file_steps.rb

@@ -1,9 +1,9 @@
 Given /^an executable file named "(.*)" with:$/ do |file_path, content|
   steps %Q{
-    Given a file named "#{file_path}" with:
+    Given a file named "#{path_for_step(file_path)}" with:
       """
       #{content}
       """
   }
-  File.chmod(0755, File.join([current_dir, file_path]))
+  File.chmod(0755, File.join([expand_path('.'), file_path]))
 end

data/features/step_definitions/flavor_steps.rb

@@ -18,7 +18,11 @@ Given /^the repository "([^"]*)" has versions "([^"]*)"$/ do |basename, versions
 end
 
 Given /^the repository "([^"]*)" has versions "([^"]*)" and a flavorfile:$/ do |basename, versions, flavorfile_content|
-  add_new_versions_to_repo(basename, versions, flavorfile_content)
+  add_new_versions_to_repo(basename, versions, flavorfile_content, :new)
+end
+
+Given /^the repository "([^"]*)" has versions "([^"]*)" and an old name flavorfile:$/ do |basename, versions, flavorfile_content|
+  add_new_versions_to_repo(basename, versions, flavorfile_content, :old)
 end
 
 Given /^a (?:(?:GitHub|local) )?repository "([^"]*)" with versions "([^"]*)"$/ do |basename, versions|
@@ -38,6 +42,16 @@ Given /^a (?:(?:GitHub|local) )?repository "([^"]*)" with versions "([^"]*)" and
   }
 end
 
+Given /^a (?:(?:GitHub|local) )?repository "([^"]*)" with versions "([^"]*)" and an old name flavorfile:$/ do |basename, versions, flavorfile_content|
+  steps %Q{
+    Given a repository "#{basename}"
+    And the repository "#{basename}" has versions "#{versions}" and an old name flavorfile:
+      """
+      #{flavorfile_content}
+      """
+  }
+end
+
 Given /^"([^"]*)" version "([^"]*)" is released$/ do |basename, version|
   steps %Q{
     Given the repository "#{basename}" has versions "#{version}"
@@ -58,21 +72,22 @@ Given /^a repository "([^"]*)" from offline cache$/ do |repo_name|
   repository_path = make_repo_path(repo_name).sub(expand('$tmp/'), '')
   sh <<-"END"
     {
-      git clone --quiet --no-checkout 'vendor/#{repo_name}' '#{current_dir}/#{repository_path}'
+      git clone --quiet --no-checkout 'vendor/#{repo_name}' '#{expand_path('.')}/#{repository_path}'
     } >/dev/null
   END
 end
 
 Given /^I disable network to the original repository of "([^"]*)"$/ do |basename|
   steps %Q{
-    Given I delete the directory "#{make_repo_path(basename)}"
+    Given I delete the directory "#{path_for_step(make_repo_path(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))
+  file_path = "#{flavor_path}/#{file_name}"
   steps %Q{
-    When I write to "#{flavor_path}/#{file_name}" with:
+    When I write to "#{path_for_step(file_path)}" with:
       """
       """
   }
@@ -82,24 +97,24 @@ Then /^a flavor "([^"]*)" version "([^"]*)" is deployed to "([^"]*)"$/ do |v_rep
   flavor_path = make_flavor_path(expand(v_vimfiles_path), expand(v_repo_name))
   basename = expand(v_repo_name).split('/').last.sub(/^vim-/, '')
   steps %Q{
-    Then the file "#{flavor_path}/doc/#{basename}.txt" should contain:
+    Then the file "#{path_for_step(flavor_path)}/doc/#{basename}.txt" should contain:
       """
       *#{basename}* #{version}
       """
-    Then a file named "#{flavor_path}/doc/tags" should exist
+    Then a file named "#{path_for_step(flavor_path)}/doc/tags" should exist
   }
 end
 
 Then /^a flavor "([^"]*)" is not deployed to "([^"]*)"$/ do |v_repo_name, v_vimfiles_path|
   flavor_path = make_flavor_path(expand(v_vimfiles_path), expand(v_repo_name))
   steps %Q{
-    Then a directory named "#{flavor_path}" should not exist
+    Then a directory named "#{path_for_step(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')
+  expect(system <<-"END").to equal(p != 'not')
     {
       cd '#{d}' &&
       git rev-list --quiet '#{version}'
@@ -109,7 +124,8 @@ 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))
+  file_path = "#{flavor_path}/#{file_name}"
   steps %Q{
-    Then a file named "#{flavor_path}/#{file_name}" #{should} exist
+    Then a file named "#{path_for_step(file_path)}" #{should} exist
   }
 end

data/features/step_definitions/flavorfile_steps.rb

@@ -1,6 +1,15 @@
 Given 'a flavorfile with:' do |content|
   steps %Q{
-    Given a file named "#{'.'.to_flavorfile_path}" with:
+    Given a file named "#{path_for_step(expand_path('.').to_flavorfile_path)}" with:
+      """
+      #{expand(content)}
+      """
+  }
+end
+
+Given 'an old name flavorfile with:' do |content|
+  steps %Q{
+    Given a file named "#{path_for_step("#{expand_path('.')}/VimFlavor")}" with:
       """
       #{expand(content)}
       """

data/features/step_definitions/lockfile_steps.rb

@@ -1,6 +1,15 @@
 Given 'a lockfile with:' do |content|
   steps %Q{
-    Given a file named "#{'.'.to_lockfile_path}" with:
+    Given a file named "#{path_for_step(expand_path('.').to_lockfile_path)}" with:
+      """
+      #{expand(content)}
+      """
+  }
+end
+
+Given 'an old name lockfile with:' do |content|
+  steps %Q{
+    Given a file named "#{path_for_step("#{expand_path('.')}/VimFlavor.lock")}" with:
       """
       #{expand(content)}
       """
@@ -18,7 +27,7 @@ end
 
 Given 'I delete the lockfile' do
   steps %Q{
-    Given I remove the file "#{'.'.to_lockfile_path}"
+    Given I remove the file "#{path_for_step(expand_path('.').to_lockfile_path)}"
   }
 end
 
@@ -34,7 +43,7 @@ end
 Then /^(?:a|the) lockfile is (?:created|updated) with:$/ do |content|
   # For some reason, Cucumber drops the last newline from every docstring...
   steps %Q{
-    Then the file "#{'.'.to_lockfile_path}" should contain exactly:
+    Then the file "#{path_for_step(expand_path('.').to_lockfile_path)}" should contain exactly:
       """
       #{content == '' ? '' : expand(content) + "\n"}
       """
@@ -42,11 +51,11 @@ Then /^(?:a|the) lockfile is (?:created|updated) with:$/ do |content|
 end
 
 Then /^(?:a|the) lockfile is (?:created|updated) and matches with:$/ do |content|
-  check_file_content('.'.to_lockfile_path, /#{content}/, true)
+  expect(path_for_step(expand_path('.').to_lockfile_path)).to have_file_content(/#{content}/)
 end
 
 Then /^(?:a|the) lockfile is not created$/ do
   steps %Q{
-    Then a file named "#{'.'.to_lockfile_path}" should not exist
+    Then a file named "#{path_for_step(expand_path('.').to_lockfile_path)}" should not exist
   }
 end

data/features/support/env.rb

@@ -1,13 +1,17 @@
 require 'aruba/api'
 require 'aruba/cucumber'
 require 'fileutils'
+require 'pathname'
 require 'vim-flavor'
 
 class FakeUserEnvironment
   include Vim::Flavor::ShellUtility
 
-  def add_new_versions_to_repo(basename, versions, flavorfile_content = nil)
+  def add_new_versions_to_repo(basename, versions, flavorfile_content = nil, naming_style = :new)
     repository_path = make_repo_path(basename)
+    flavorfile_path = naming_style == :new ?
+      repository_path.to_flavorfile_path :
+      "#{repository_path}/VimFlavor"
     doc_name = basename.split('/').last.sub(/^vim-/, '')
     sh <<-"END"
       {
@@ -19,10 +23,10 @@ class FakeUserEnvironment
           git add doc
           #{
             %Q{
-              cat <<'FF' >#{'.'.to_flavorfile_path}
+              cat <<'FF' >#{flavorfile_path}
 #{expand(flavorfile_content)}
 FF
-              git add #{'.'.to_flavorfile_path}
+              git add #{flavorfile_path}
             } if flavorfile_content
           }
           git commit -m "Version $v"
@@ -44,6 +48,16 @@ FF
     }
   end
 
+  def path_for_step(path)
+    cwd = Pathname.new(expand_path('.'))
+    pathd = Pathname.new(path)
+    if not pathd.absolute?
+      pathd = cwd + pathd
+    end
+
+    pathd.relative_path_from(cwd).to_s
+  end
+
   def make_cached_repo_path(repo_name, stash_path)
     "#{stash_path}/repos/#{repo_name.zap}"
   end
@@ -68,22 +82,18 @@ end
 Before do
   variable_table['version'] = Vim::Flavor::VERSION
 
-  variable_table['tmp'] = File.absolute_path(current_dir)
+  variable_table['tmp'] = File.absolute_path(expand_path('.'))
 
   steps %Q{
     Given a directory named "home"
   }
-  variable_table['home'] = File.absolute_path(File.join([current_dir, 'home']))
+  variable_table['home'] = File.absolute_path(File.join([expand_path('.'), 'home']))
 
   @aruba_timeout_seconds = 5
-end
 
-Aruba.configure do |config|
-  config.before_cmd do |cmd|
-    set_env 'VIM_FLAVOR_HOME', variable_table['home']
-    set_env 'VIM_FLAVOR_GITHUB_URI_PREFIX', expand('file://$tmp/repos/')
-    set_env 'VIM_FLAVOR_GITHUB_URI_SUFFIX', ''
-  end
+  set_environment_variable 'VIM_FLAVOR_HOME', variable_table['home']
+  set_environment_variable 'VIM_FLAVOR_GITHUB_URI_PREFIX', expand('file://$tmp/repos/')
+  set_environment_variable 'VIM_FLAVOR_GITHUB_URI_SUFFIX', ''
 end
 
 World do