vim-flavor 2.2.2 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 57987fa1860c780989f297c608ea591c25a68a46
-  data.tar.gz: f904afbd518b37977d0f0be9cf1137dec88e0692
+SHA256:
+  metadata.gz: c4a7e4092417600cbc0307de9313599a143deaca2418cd5ccb16e8959e678d04
+  data.tar.gz: d6f6aa114fdd8f2202436e548694c8e382776ddae31bc3a3f6b2a07b27e880db
 SHA512:
-  metadata.gz: d9d6e2d307622a2a09d17e605b8308d3024a5e2a85406d9f0c3bbbcba3c18e8d385c05bf4bab46cbaf4dd93655b021dbe4df2bb56193c66c4d8f0d44a0780c73
-  data.tar.gz: 26611b3e533b3a771b3e722b62dea4e67f8199039704a990cee311395403282ec4e345deb879a99a29bc914a17c8b3fbdea6025cdf5cf1804163f93900f70705
+  metadata.gz: 638033e0aec514a1586f29e5a758159177fd7931c0709344b8f5ba8a49ce436d8ab15180e2698096c37545caf09f2050bdbfba9d098fec5a7299b4b59e93d2de
+  data.tar.gz: 51a1d6dd6c932d9de194a2f9054bcaf2be0d5228c26e47715793fae8dbf5399acbd82722bae13677bdd44fffe35b2ba03d7b7b1089ca27097d62e8f54ba8b309

data/.travis.yml

@@ -1,6 +1,6 @@
 language: ruby
 rvm:
-  - 2.1.5
+  - 2.5.0
 before_script:
   - git config --global 'user.name' 'Travis CI'
   - git config --global 'user.email' 'user@example.com'

data/README.md

@@ -1,7 +1,7 @@
 # vim-flavor, a tool to manage your favorite Vim plugins
 
 [![Build Status](https://travis-ci.org/kana/vim-flavor.png)](https://travis-ci.org/kana/vim-flavor)
-[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/kana/vim-flavor)
+[![Maintainability](https://api.codeclimate.com/v1/badges/97414d95fb6d19c7fb72/maintainability)](https://codeclimate.com/github/kana/vim-flavor/maintainability)
 
 
 
@@ -10,13 +10,13 @@
 
     cd $YOUR_REPOSITORY_FOR_DOTFILES
 
-    cat >VimFlavor <<'END'
+    cat >Flavorfile <<'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.
+      #   if the flavored plugin declares its dependencies with Flavorfile.
       flavor 'kana/vim-textobj-indent'
 
       # * Declare using git://github.com/vim-scripts/fakeclip.git
@@ -39,17 +39,12 @@
       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.
+    # Fetch the plugins declared in the Flavorfile,
+    # create Flavorfile.lock for a snapshot of all plugins and versions,
+    # then install the plugins into ~/.vim.
     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 add Flavorfile Flavorfile.lock
     git commit -m 'Use vim-flavor to manage my favorite Vim plugins'
 
 See also
@@ -69,8 +64,8 @@ See the LICENSE file for the details.
 
 ## Author
 
-* [Kana Natsuno](http://whileimautomaton.net/)
-  (also known as [@kana1](http://twitter.com/kana1))
+* [Kana Natsuno](https://whileimautomaton.net/)
+  (also known as [@kana1](https://twitter.com/kana1))
 
 
 

data/features/.nav

@@ -11,7 +11,7 @@
 - flavorfile:
 - version_lock.feature
 - caching:
-- resolve_dependencies.feature
+- resolve_dependencies:
 - testing_vim_plugins:
   - typical_usage.feature
   - dependencies.feature
@@ -23,3 +23,4 @@
   - update.feature
   - changing_tracking_branches.feature
   - detect_incompatible_declarations.feature
+- backward_compatibilities:

data/features/backward_compatibilities/flavorfile.feature

@@ -0,0 +1,166 @@
+Feature: Flavorfile
+  In order to gradually update existing Vim plugins,
+  as a lazy Vim user,
+  I want to reuse Vim plugins which contain old name of flavorfiles without problems.
+
+  Scenario: User has old name of flavorfile is warned
+    Given a repository "foo" with versions "1.0.0 1.0.1 1.0.2"
+    And an old name flavorfile with:
+      """ruby
+      flavor '$foo_uri'
+      """
+    When I run `vim-flavor install`
+    Then it should pass with template:
+      """
+      Warning: Rename VimFlavor to Flavorfile.  VimFlavor wll be ignored in future version.
+      Checking versions...
+        Use $foo_uri ... 1.0.2
+      Deploying plugins...
+        $foo_uri 1.0.2 ... done
+      Completed.
+      """
+    And a lockfile is created with:
+      """
+      $foo_uri (1.0.2)
+      """
+    And a flavor "$foo_uri" version "1.0.2" is deployed to "$home/.vim"
+
+  Scenario: User has both new and old name of flavorfile is warned
+    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 a flavorfile with:
+      """ruby
+      flavor '$bar_uri'
+      """
+    And an old name flavorfile with:
+      """ruby
+      flavor '$foo_uri'
+      """
+    When I run `vim-flavor install`
+    Then it should pass with template:
+      """
+      Warning: Delete VimFlavor.  Flavorfile is being read instead.
+      Checking versions...
+        Use $bar_uri ... 2.0.2
+      Deploying plugins...
+        $bar_uri 2.0.2 ... done
+      Completed.
+      """
+    And a lockfile is created with:
+      """
+      $bar_uri (2.0.2)
+      """
+      And a flavor "$foo_uri" is not deployed to "$home/.vim"
+    And a flavor "$bar_uri" version "2.0.2" is deployed to "$home/.vim"
+
+  Scenario: Plugin contains old name of flavorfile is not warned
+    Given a repository "foo" with versions "1.0.0 1.0.1 1.0.2" and an old name flavorfile:
+      """ruby
+      # No dependencies
+      """
+    And a flavorfile with:
+      """ruby
+      flavor '$foo_uri'
+      """
+    When I run `vim-flavor install`
+    Then it should pass with template:
+      """
+      Checking versions...
+        Use $foo_uri ... 1.0.2
+      Deploying plugins...
+        $foo_uri 1.0.2 ... done
+      Completed.
+      """
+    And a lockfile is created with:
+      """
+      $foo_uri (1.0.2)
+      """
+    And a flavor "$foo_uri" version "1.0.2" is deployed to "$home/.vim"
+
+  Scenario: Testing a Vim plugin with old name flavorfile is warned
+    Given a repository "kana/vim-vspec" from offline cache
+    And an old name flavorfile with:
+      """ruby
+      # No dependencies
+      """
+    And a file named "plugin/foo.vim" with:
+      """vim
+      let g:foo = 3
+      """
+    And a file named "t/basics.vim" with:
+      """vim
+      " Tests are written with vim-vspec.
+      runtime! plugin/foo.vim
+      describe 'g:foo'
+        it 'is equal to 3'
+          Expect g:foo == 3
+        end
+      end
+      """
+    When I run `vim-flavor test`
+    Then it should pass with regexp:
+      """
+      -------- Preparing dependencies
+      Warning: Rename VimFlavor to Flavorfile.  VimFlavor wll be ignored in future version.
+      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
+      All tests successful.
+      Files=1, Tests=1,  \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: Testing a Vim plugin with both new and old name flavorfile is warned
+    Given a repository "kana/vim-vspec" from offline cache
+    And a flavorfile with:
+      """ruby
+      # No dependencies
+      """
+    And an old name flavorfile with:
+      """ruby
+      # No dependencies
+      """
+    And a file named "plugin/foo.vim" with:
+      """vim
+      let g:foo = 3
+      """
+    And a file named "t/basics.vim" with:
+      """vim
+      " Tests are written with vim-vspec.
+      runtime! plugin/foo.vim
+      describe 'g:foo'
+        it 'is equal to 3'
+          Expect g:foo == 3
+        end
+      end
+      """
+    When I run `vim-flavor test`
+    Then it should pass with regexp:
+      """
+      -------- Preparing dependencies
+      Warning: Delete VimFlavor.  Flavorfile is being read instead.
+      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
+      All tests successful.
+      Files=1, Tests=1,  \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"

data/features/backward_compatibilities/lockfile.feature

@@ -0,0 +1,22 @@
+Feature: Lockfile
+  In order to avoid unexpected result and confusion,
+  as a lazy Vim user,
+  I want to stop vim-flavor process if obsolete file still exists.
+
+  Scenario: User has old name of lockfile
+    Given a repository "foo" with versions "1.0.0 1.0.1 1.0.2"
+    And a flavorfile with:
+      """ruby
+      flavor '$foo_uri'
+      """
+    And an old name lockfile with:
+      """
+      $foo_uri (1.0.1)
+      """
+    When I run `vim-flavor install`
+    Then it should fail with template:
+      """
+      Error: VimFlavor.lock is no longer used.  Rename it to Flavorfile.lock.
+      """
+    And a lockfile is not created
+    And a flavor "$foo_uri" is not deployed to "$home/.vim"

data/features/branches/changing_tracking_branches.feature

@@ -24,7 +24,6 @@ Feature: Changing tracking branches
         $foo_uri $foo_rev_102 at master ... done
       Completed.
       """
-    And a bootstrap script is created in "$home/.vim"
     And a flavor "$foo_uri" version "1.0.2" is deployed to "$home/.vim"
 
   Scenario: Use a branch instead of a version
@@ -49,7 +48,6 @@ Feature: Changing tracking branches
       """
       $foo_uri ($foo_rev_102 at master)
       """
-    And a bootstrap script is created in "$home/.vim"
     And a flavor "$foo_uri" version "1.0.2" is deployed to "$home/.vim"
 
   Scenario: Use a version instead of a branch
@@ -74,5 +72,4 @@ Feature: Changing tracking branches
       """
       $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/branches/detect_incompatible_declarations.feature

@@ -32,7 +32,6 @@ Feature: Detect incompatible declarations
         $L_uri branch: experimental is required by $B_uri
       Please resolve the conflict.
       """
-    And a bootstrap script is not created in "$home/.vim"
     And a flavor "$A_uri" is not deployed to "$home/.vim"
     And a flavor "$B_uri" is not deployed to "$home/.vim"
     And a flavor "$L_uri" is not deployed to "$home/.vim"
@@ -66,7 +65,6 @@ Feature: Detect incompatible declarations
         $L_uri ~> 0.2 is required by $B_uri
       Please resolve the conflict.
       """
-    And a bootstrap script is not created in "$home/.vim"
     And a flavor "$A_uri" is not deployed to "$home/.vim"
     And a flavor "$B_uri" is not deployed to "$home/.vim"
     And a flavor "$L_uri" is not deployed to "$home/.vim"

data/features/branches/install.feature

@@ -24,7 +24,6 @@ Feature: Install Vim plugins with specific branches
       """
       $foo_uri ($foo_rev_102 at master)
       """
-    And a bootstrap script is created in "$home/.vim"
     And a flavor "$foo_uri" version "1.0.2" is deployed to "$home/.vim"
 
   Scenario: Install a plugin according to a lockfile
@@ -47,5 +46,4 @@ Feature: Install Vim plugins with specific branches
         $foo_uri $foo_rev_102 at master ... skipped (already deployed)
       Completed.
       """
-    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/branches/update.feature

@@ -26,5 +26,4 @@ Feature: Update Vim plugins with specific branches
         $foo_uri $foo_rev_103 at master ... done
       Completed.
       """
-    And a bootstrap script is created in "$home/.vim"
     And a flavor "$foo_uri" version "1.0.3" is deployed to "$home/.vim"

data/features/caching/deployment.feature

@@ -9,6 +9,7 @@ Feature: Deployment
       """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`

data/features/flavorfile/README.md

@@ -1,6 +1,6 @@
 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,
+`vim-flavor` reads a file `Flavorfile` in the current working directory,
 and evaluates it as a flavorfile.
 
 

data/features/flavorfile/comments.feature

@@ -19,5 +19,4 @@ Feature: Comments
     And a lockfile is created with:
       """
       """
-    And a bootstrap script is created in "$home/.vim"
     But a flavor "$foo_uri" is not deployed to "$home/.vim"

data/features/flavorfile/groups.feature

@@ -19,7 +19,6 @@ Feature: Groups
       """
       $foo_uri (1.2)
       """
-    And a bootstrap script is created in "$home/.vim"
     And a flavor "$foo_uri" version "1.2" is deployed to "$home/.vim"
     But a flavor "$bar_uri" is not deployed to "$home/.vim"
 
@@ -35,7 +34,6 @@ Feature: Groups
       """
       $foo_uri (1.2)
       """
-    And a bootstrap script is created in "$home/.vim"
     And a flavor "$foo_uri" version "1.2" is deployed to "$home/.vim"
     But a flavor "$bar_uri" is not deployed to "$home/.vim"
 
@@ -52,6 +50,5 @@ Feature: Groups
     And a lockfile is created with:
       """
       """
-    And a bootstrap script is created in "$home/.vim"
     But a flavor "$foo_uri" is not deployed to "$home/.vim"
     But a flavor "$bar_uri" is not deployed to "$home/.vim"

data/features/flavorfile/repository_name.feature

@@ -16,7 +16,6 @@ Feature: Repository name
       """
       vspec (0.0.4)
       """
-    And a bootstrap script is created in "$home/.vim"
     And a flavor "vspec" version "0.0.4" is deployed to "$home/.vim"
 
   Scenario: Declare using a Vim plugin from GitHub
@@ -32,7 +31,6 @@ Feature: Repository name
       """
       kana/vim-vspec (0.0.4)
       """
-    And a bootstrap script is created in "$home/.vim"
     And a flavor "kana/vim-vspec" version "0.0.4" is deployed to "$home/.vim"
 
   Scenario: Declare using a Vim plugin from an arbitrary URI
@@ -48,5 +46,4 @@ Feature: Repository name
       """
       $vspec_uri (0.0.4)
       """
-    And a bootstrap script is created in "$home/.vim"
     And a flavor "$vspec_uri" version "0.0.4" is deployed to "$home/.vim"

data/features/flavorfile/version_constraint.feature

@@ -3,10 +3,9 @@ Feature: Version constraint
   as a lazy Vim user,
   I want to declare desirable versions of Vim plugins.
 
-  Note that vim-flavor assumes that plugins follow [the versioning policies of
-  RubyGems](http://docs.rubygems.org/read/chapter/7#page26), to determine
-  compatibility of plugins.  See also [Philosophy](../philosophy) for the
-  details.
+  Note that vim-flavor assumes that plugins follow [Semantic Versioning
+  2.0.0](https://semver.org/spec/v2.0.0.html), to determine compatibility of
+  plugins.  See also [Philosophy](../philosophy) for the details.
 
   Background:
     Given a repository "foo" with versions "1.0 1.1 1.2 2.0"
@@ -22,7 +21,6 @@ Feature: Version constraint
       """
       $foo_uri (2.0)
       """
-    And a bootstrap script is created in "$home/.vim"
     And a flavor "$foo_uri" version "2.0" is deployed to "$home/.vim"
 
   Scenario: Declare using a Vim plugin not older than a specific version
@@ -36,7 +34,6 @@ Feature: Version constraint
       """
       $foo_uri (2.0)
       """
-    And a bootstrap script is created in "$home/.vim"
     And a flavor "$foo_uri" version "2.0" is deployed to "$home/.vim"
 
   Scenario: Declare using the latest and compatible version of a Vim plugin
@@ -50,5 +47,4 @@ Feature: Version constraint
       """
       $foo_uri (1.2)
       """
-    And a bootstrap script is created in "$home/.vim"
     And a flavor "$foo_uri" version "1.2" is deployed to "$home/.vim"