vim-flavor 2.2.2 → 4.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 57987fa1860c780989f297c608ea591c25a68a46
-  data.tar.gz: f904afbd518b37977d0f0be9cf1137dec88e0692
+SHA256:
+  metadata.gz: 75d0bb94ee0f8229e9d2500cdd40d17315585d4fe0d5fa70b3f3ae2fa2216dda
+  data.tar.gz: 02a54ee18922bb471666736b55b4bc783b9581b1ff35b94f5534ce9f91051a0b
 SHA512:
-  metadata.gz: d9d6e2d307622a2a09d17e605b8308d3024a5e2a85406d9f0c3bbbcba3c18e8d385c05bf4bab46cbaf4dd93655b021dbe4df2bb56193c66c4d8f0d44a0780c73
-  data.tar.gz: 26611b3e533b3a771b3e722b62dea4e67f8199039704a990cee311395403282ec4e345deb879a99a29bc914a17c8b3fbdea6025cdf5cf1804163f93900f70705
+  metadata.gz: 2ad9d76f9f2fc93b088cc2b8f9cecf5d351f027cead304e42adbd60d04ff567b4a767249f81b56c42e157fdf123ab3a280d37920efc4fa7e290790f2dbdf1187
+  data.tar.gz: 535d9dc0232e83c642afce3d6a608875738021ddbd12f113a64b7b4e99ed7fa3722f8772161bee025facaef3eeb42fb338fce9c9abb0fdb4255ced75ac94c2a6

data/.github/dependabot.yml

@@ -0,0 +1,12 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "bundler" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"
+    versioning-strategy: increase

data/.github/workflows/ci.yml

@@ -0,0 +1,35 @@
+name: CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+  schedule:
+    - cron: 0 0 * * *
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        fetch-depth: 0 # t/blame.vim requires all commits.
+        submodules: true
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Set up Vim
+      uses: thinca/action-setup-vim@v1
+      with:
+        vim_version: ${{ github.event_name == 'schedule' && 'head' || 'v8.2.3446' }}
+        vim_type: vim
+        download: never # For some reason 'available' doesn't build from source as a fallback.
+    - name: Set up Git
+      run: |
+        git config --global user.email 'ci@example.com'
+        git config --global user.name 'CI'
+        git config --global init.defaultBranch 'master'
+    - name: Run tests
+      run: rake ci

data/.gitmodules

@@ -1,6 +1,6 @@
 [submodule "vendor/kana/vim-vspec"]
 	path = vendor/kana/vim-vspec
-	url = git://github.com/kana/vim-vspec
+	url = https://github.com/kana/vim-vspec
 [submodule "vendor/kana/vim-textobj-user"]
 	path = vendor/kana/vim-textobj-user
-	url = git://github.com/kana/vim-textobj-user
+	url = https://github.com/kana/vim-textobj-user

data/.ruby-version

@@ -0,0 +1 @@
+3.0.2

data/CHANGELOG.md

@@ -0,0 +1,178 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+
+
+
+## [Unreleased](https://github.com/kana/vim-flavor/compare/v4.0.2...master)
+
+
+
+
+## [4.0.2](https://github.com/kana/vim-flavor/compare/v4.0.1...v4.0.2) - 2022-01-11
+
+### Fixed
+
+* Remove deprecated usage of `.exists?` style methods ([#66](https://github.com/kana/vim-flavor/pull/66))
+
+
+
+
+## [4.0.1](https://github.com/kana/vim-flavor/compare/v4.0.0...v4.0.1) - 2021-11-02
+
+### Changed
+
+* **BREAKING**: Use `https://github.com/...` instead of `git://github.com/...`
+  to clone Vim plugin repositories.  This change is required because
+  [GitHub deprecates `git://`](https://github.blog/2021-09-01-improving-git-protocol-security-github/)
+  since 2021-11-02.
+
+  This is a breaking change if you installed Vim plugins with vim-flavor v4.0.0
+  or older.  You'll see the following error in that case:
+
+      fatal: remote error:
+        The unauthenticated git protocol on port 9418 is no longer supported.
+
+  There are two ways to fix this errors:
+
+  (A) Delete local clones:
+
+      rm -rf ~/.vim-flavor
+
+  (B) Change `remote.origin.url` of each local clone:
+
+      for d in ~/.vim-flavor/repos/*/
+      do
+        cd "$d" &&
+          git config remote.origin.url "$(git config remote.origin.url | sed 's!^git://!https://!')"
+      done
+
+### Fixed
+
+- Update some tests not to fail with `vX.X.X` style version tags.
+
+
+
+
+## [4.0.0](https://github.com/kana/vim-flavor/compare/v3.0.0...v4.0.0) - 2021-09-22
+
+### Changed
+
+* **BREAKING**: Ruby 3.0 or later is required now.
+
+
+
+
+## [3.0.0](https://github.com/kana/vim-flavor/compare/v2.2.2...v3.0.0) - 2018-03-24
+
+### Improved
+
+* Steps to start using vim-flavor are simplified.  Especially, it is not
+  necessary to edit vimrc.
+
+### Changed
+
+* **BREAKING**: Vim 8.0 or later is required now.
+* **BREAKING**: 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.
+
+
+
+
+## [2.2.2](https://github.com/kana/vim-flavor/compare/v2.2.1...v2.2.2) - 2018-01-31
+
+### Fixed
+
+* Fixed `install`, `update` and `test` to work even if these commands are
+  invoked from non-bash shell.
+
+
+
+
+## [2.2.1](https://github.com/kana/vim-flavor/compare/v2.2.0...v2.2.1) - 2015-04-24
+
+### Fixed
+
+* Fixed not to fail fetching repositories which have non-fastforward updates.
+
+
+
+
+## [2.2.0](https://github.com/kana/vim-flavor/compare/v2.1.1...v2.2.0) - 2015-04-18
+
+### Improved
+
+* `test` runs `*.vim` and `*.t` in a single step, to get a simplified result.
+* `test` uses [vim-vspec](https://github.com/kana/vim-vspec) 1.5 or later by
+  default.
+* `test` supports `--update-dependencies` to update dependencies before running
+  tests.
+
+
+
+
+## [2.1.1](https://github.com/kana/vim-flavor/compare/2.1.0...v2.1.1) - 2015-02-25
+
+### Improved
+
+* `install` and `update` skip checking versions of plugins which are
+  development dependencies.
+
+
+
+
+## [2.1.0](https://github.com/kana/vim-flavor/compare/2.0.0...2.1.0) - 2014-04-19
+
+### Improved
+
+* `update` command is added.  It is an alias of existing `upgrade` command.
+  Now it is recommended to use `update` rather than `upgrade`.
+  `upgrade` will be removed in a future version.
+* `update` and `upgrade` learned to update specific plugins if repository names
+  are given as command-line arguments.
+
+
+
+
+## [2.0.0](https://github.com/kana/vim-flavor/compare/1.1.5...2.0.0) - 2014-03-10
+
+### Improved
+
+* [Branches](./branches) are supported.
+
+### Changed
+
+* **BREAKING**: Ruby 2.0.0 or later is required now.

data/README.md

@@ -1,76 +1,164 @@
 # 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)
+[![CI](https://github.com/kana/vim-flavor/actions/workflows/ci.yml/badge.svg)](https://github.com/kana/vim-flavor/actions/workflows/ci.yml)
+[![Maintainability](https://api.codeclimate.com/v1/badges/97414d95fb6d19c7fb72/maintainability)](https://codeclimate.com/github/kana/vim-flavor/maintainability)
 
 
 
 
-## Getting started
+# Getting started
 
-    cd $YOUR_REPOSITORY_FOR_DOTFILES
+## Create `Flavorfile`
 
-    cat >VimFlavor <<'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.
-      flavor 'kana/vim-textobj-indent'
+This file contains a set of declarations about what Vim plugins you want to
+install.  For example:
 
-      # * Declare using git://github.com/vim-scripts/fakeclip.git
-      # * vim-flavor fetches git://github.com/vim-scripts/$REPO.git
-      #   if the argument is written in '$REPO' format.
-      flavor 'fakeclip'
+```ruby
+# Install a Vim plugin from `https://github.com/kana/vim-textobj-indent`.
+#
+# Note that kana/vim-textobj-indent requires kana/vim-textobj-user.
+# Such dependencies are automatically installed if the former plugin
+# declares its dependencies with Flavorfile.
+flavor 'kana/vim-textobj-indent'
 
-      # * Declare using git://github.com/kana/vim-altr.git
-      # * vim-flavor fetches the URI
-      #   if the argument seems to be a URI.
-      flavor 'git://github.com/kana/vim-altr.git'
+# Install a Vim plugin from `https://github.com/vim-scripts/fakeclip`.
+flavor 'fakeclip'
 
-      # * Declare using kana/vim-smartchr 0.1.0 or later and older than 0.2.0.
-      flavor 'kana/vim-smartchr', '~> 0.1.0'
+# Install a Vim plugin from the specified URI.
+flavor 'https://github.com/kana/vim-altr.git'
 
-      # * Declare using kana/vim-smartword 0.1 or later and older than 1.0.
-      flavor 'kana/vim-smartword', '~> 0.1'
+# You can also specify which version of Vim plugin should be installed.
+# For example:
+flavor 'kana/vim-smartword', '~> 0.1'    # 0.1 or later, but older than 0.2
+flavor 'kana/vim-smartchr',  '~> 0.2.4'  # 0.2.4 or later, but older than 0.3.0
+flavor 'kana/vim-smarttill', '>= 0.3.6'  # 0.3.6 or later
 
-      # * Declare using kana/vim-smarttill 0.1.0 or later.
-      flavor 'kana/vim-smarttill', '>= 0.1.0'
-    END
+# vim-flavor, by design, requires Vim plugins to follow semantic versioning
+# and to create version tags (like `v1.2.3`) in their repositories.
+#
+# For repositories without versioning, branches can be specified.
+flavor 'chriskempson/base16-vim', branch: 'master'
+```
 
-    # 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.
-    vim-flavor install
+## Install Vim plugins (for the first time)
 
-    # Add the following line into the first line of your vimrc:
-    #
-    #   runtime flavors/bootstrap.vim
-    vim vimrc
+Run the following command:
 
-    git add VimFlavor VimFlavor.lock vimrc
-    git commit -m 'Use vim-flavor to manage my favorite Vim plugins'
+```bash
+vim-flavor install
+```
 
-See also
-[the documentation on relish](https://www.relishapp.com/kana/vim-flavor) or
-`features/` directory for the details.
+This command does the following stuffs:
 
+1. Fetches Vim plugins declared in the `Flavorfile`.
+2. Creates `Flavorfile.lock` file.  It contains information about what
+   versions of plugins to be installed.
+3. Copies the fetched plugins into `~/.vim/pack/flavors/start`, then updates
+   help tags for each plugin.
 
+It's recommended to commit `Flavorfile` and `Flavorfile.lock` after
+installation.
 
+```bash
+git add Flavorfile Flavorfile.lock
+git commit -m 'Use vim-flavor to manage my favorite Vim plugins'
+```
 
-## License
+## Install Vim plugins (from another machine)
+
+Suppose that you work with several PCs and/or servers, and you want to use the
+same configuration, including Vim plugins, on all of them.
+
+Firstly, let's synchronize your configuration files:
+
+```bash
+cd ~/your/dotfiles/repository
+git pull
+```
+
+Now you have the same `Flavorfile` and `Flavorfile.lock` created by the
+previous step.
+
+Then run the following command:
+
+```bash
+vim-flavor install
+```
+
+This time `vim-flavor` installs the same versions of Vim plugins as recorded
+in `Flavorfile.lock`, even if newer versions are available.
+
+## Update Vim plugins
+
+To update Vim plugins, run the following command:
+
+```bash
+vim-flavor update
+```
+
+This is similar to `vim-flavor install`, but vim-flavor tries checking and
+installing newer versions of Vim plugins.
+
+This command usually updates `Flavorfile.lock`.  So that you have to commit it
+again.
+
+```bash
+git add Flavorfile.lock
+git commit -m 'Update Vim plugins'
+```
+
+
+
+
+# References
+
+See [`features/`](./features) directory for the details.
+The same [documents](https://www.relishapp.com/kana/vim-flavor) are available
+also on relish.
+
+
+
+
+# Changelog
+
+See [CHANGELOG.md](./CHANGELOG.md).
+
+
+
+
+# License
 
 vim-flavor is released under the terms of MIT license.
-See the LICENSE file for the details.
+See the [LICENSE](./LICENSE) file for the details.
+
+
+
+
+# Development
+
+## Set up
+
+1. Install [rbenv](https://github.com/rbenv/rbenv).
+2. Run the following commands in your clone of vim-flavor repository:
+
+   ```bash
+   git submodule update --init
+   rbenv install
+   bundle install
+   ```
+
+## Run tests
+
+```bash
+rake test
+```
 
 
 
 
-## Author
+# Author
 
-* [Kana Natsuno](http://whileimautomaton.net/)
-  (also known as [@kana1](http://twitter.com/kana1))
+* [kana](https://github.com/kana)
 
 
 

data/Rakefile

@@ -1,6 +1,12 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
 
+task :ci => [:dump, :test]
+
+task :dump do
+  sh 'vim --version'
+end
+
 task :test => [:spec, :cucumber]
 
 task :spec do
@@ -10,3 +16,8 @@ end
 task :cucumber do
   sh 'bundle exec cucumber --format=progress'
 end
+
+task :update_online_documents do
+  # Only authorized members can push to relish.
+  sh 'bundle exec relish push kana/vim-flavor'
+end

data/config/cucumber.yml

@@ -0,0 +1 @@
+default: --publish-quiet

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 ... v?\d+\.\d+(\.\d+)?
+      Deploying plugins...
+        kana/vim-vspec v?\d+.\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 \(v?\d+.\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 ... v?\d+.\d+(\.\d+)?
+      Deploying plugins...
+        kana/vim-vspec v?\d+.\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 \(v?\d+.\d+(\.\d+)?\)
+      """
+    And a dependency "kana/vim-vspec" is stored in ".vim-flavor/pack/flavors/start"