vim-flavor 2.2.0 → 4.0.0

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/pack/flavors
 
     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/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,39 +20,42 @@ 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} \
               #{files_or_dirs.shelljoin} }
-        succeeded = system(command)
+        succeeded = system('bash', '-c', command)
         exit(1) unless succeeded
       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

data/lib/vim-flavor/flavor.rb

@@ -25,7 +25,7 @@ module Vim
       end
 
       def cached_version?(version)
-        system <<-"END"
+        system 'bash', '-c', <<-"END"
           {
             cd '#{cached_repo_path}' &&
             git rev-list --quiet '#{version.to_revision}' --
@@ -74,7 +74,7 @@ module Vim
         sh %Q{
           {
             cd '#{cached_repo_path}' &&
-            git fetch origin --tags 'refs/heads/*:refs/remotes/origin/*'
+            git fetch origin --tags '+refs/heads/*:refs/remotes/origin/*'
           } 2>&1
         }
       end

data/lib/vim-flavor/flavorfile.rb

@@ -1,3 +1,5 @@
+require 'pathname'
+
 module Vim
   module Flavor
     class FlavorFile
@@ -16,7 +18,7 @@ module Vim
 
       def self.load_or_new(flavorfile_path)
         ff = new()
-        ff.load(flavorfile_path) if File.exists?(flavorfile_path)
+        ff.load(flavorfile_path) if FileTest.exists?(flavorfile_path)
         ff
       end
 
@@ -26,6 +28,27 @@ module Vim
         ff
       end
 
+      def self.path_from(dir_path, warn)
+        flavorfile_path = dir_path.to_flavorfile_path
+        new_path = Pathname.new(flavorfile_path).relative_path_from(Pathname.getwd())
+        old_path = new_path.dirname() / 'VimFlavor'
+
+        path = if FileTest.exists?(new_path)
+          if warn and FileTest.exists?(old_path)
+            Console::warn "Delete #{old_path}.  #{new_path} is being read instead."
+          end
+          new_path
+        elsif FileTest.exists?(old_path)
+          if warn
+            Console::warn "Rename #{old_path} to #{new_path}.  #{old_path} wll be ignored in future version."
+          end
+          old_path
+        else
+          new_path
+        end
+        path.to_s
+      end
+
       def load(flavorfile_path)
         instance_eval(
           File.open(flavorfile_path, 'r').read(),

data/lib/vim-flavor/lockfile.rb

@@ -1,3 +1,5 @@
+require 'fileutils'
+
 module Vim
   module Flavor
     class LockFile
@@ -7,6 +9,18 @@ module Vim
         l
       end
 
+      def self.path_from(dir_path, error)
+        lockfile_path = dir_path.to_lockfile_path
+        new_path = Pathname.new(lockfile_path).relative_path_from(Pathname.getwd())
+        old_path = new_path.dirname() / 'VimFlavor.lock'
+
+        if error and FileTest.exists?(old_path)
+          Console::error "#{old_path} is no longer used.  Rename it to #{new_path}."
+        end
+
+        new_path.to_s
+      end
+
       def initialize(path)
         @path = path
       end
@@ -38,6 +52,7 @@ module Vim
       end
 
       def save()
+        FileUtils.mkdir_p(File.dirname(@path))
         File.open(@path, 'w') do |io|
           lines = flavors.flat_map {|f| self.class.serialize_lock_status(f)}
           lines.each do |line|

data/lib/vim-flavor/shellutility.rb

@@ -2,7 +2,8 @@ module Vim
   module Flavor
     module ShellUtility
       def sh script
-        output = send(:`, script)
+        output = IO.popen(['bash', '-c', script], 'r', &:read)
+
         if $? == 0
           output
         else

data/lib/vim-flavor/stringextension.rb

@@ -1,24 +1,16 @@
 module Vim
   module Flavor
     module StringExtension
-      def to_bootstrap_path
-        "#{self}/bootstrap.vim"
-      end
-
-      def to_deps_path
-        "#{self}/deps"
-      end
-
       def to_flavorfile_path
-        "#{self}/VimFlavor"
+        "#{self}/Flavorfile"
       end
 
       def to_flavors_path
-        "#{self}/flavors"
+        "#{self}/pack/flavors/start"
       end
 
       def to_lockfile_path
-        "#{self}/VimFlavor.lock"
+        "#{self}/Flavorfile.lock"
       end
 
       def to_stash_path

data/lib/vim-flavor/version.rb

@@ -1,6 +1,6 @@
 module Vim
   module Flavor
-    VERSION = '2.2.0'
+    VERSION = '4.0.0'
 
     class Version
       def self.create(arg)

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/spec/branchversion_spec.rb

@@ -18,10 +18,10 @@ module Vim
       end
 
       it 'is not comparable' do
-        expect {v1 < v2}.to raise_error
-        expect {v1 <= v2}.to raise_error
-        expect {v1 > v2}.to raise_error
-        expect {v1 >= v2}.to raise_error
+        expect {v1 < v2}.to raise_error(NoMethodError)
+        expect {v1 <= v2}.to raise_error(NoMethodError)
+        expect {v1 > v2}.to raise_error(NoMethodError)
+        expect {v1 >= v2}.to raise_error(NoMethodError)
         expect(v1 <=> v2).to be_nil
       end
 

data/spec/stringextension_spec.rb

@@ -3,6 +3,37 @@ require 'spec_helper'
 module Vim
   module Flavor
     describe StringExtension do
+      describe '#to_flavorfile_path' do
+        it 'extends a given path to a flavorfile' do
+          expect('cwd'.to_flavorfile_path).to be == 'cwd/Flavorfile'
+        end
+      end
+
+      describe '#to_flavors_path' do
+        it 'extends a given path to a flavors path' do
+          expect('home/.vim'.to_flavors_path).to be == 'home/.vim/pack/flavors/start'
+        end
+      end
+
+      describe '#to_lockfile_path' do
+        it 'extends a given path to a lockfile' do
+          expect('cwd'.to_lockfile_path).to be == 'cwd/Flavorfile.lock'
+        end
+      end
+
+      describe '#to_stash_path' do
+        it 'extends a given path to a stash path' do
+          expect('home'.to_stash_path).to be == 'home/.vim-flavor'
+          expect('cwd'.to_stash_path).to be == 'cwd/.vim-flavor'
+        end
+      end
+
+      describe '#to_vimfiles_path' do
+        it 'extends a given path to a vimfiles path' do
+          expect('home'.to_vimfiles_path).to be == 'home/.vim'
+        end
+      end
+
       describe '#zap' do
         it 'replace unsafe characters with "_"' do
           expect('fakeclip'.zap).to be == 'fakeclip'

data/vim-flavor.gemspec

@@ -17,12 +17,15 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
+  spec.required_ruby_version = '~> 3.0'
 
-  spec.add_dependency('parslet', '~> 1.7')
-  spec.add_dependency('thor', '~> 0.19')
+  spec.add_dependency('parslet', '>= 1.8', '< 3.0')
+  spec.add_dependency('pastel', '~> 0.7')
+  spec.add_dependency('thor', '>= 0.20', '< 2.0')
 
-  spec.add_development_dependency('aruba', '~> 0.6')
-  spec.add_development_dependency('cucumber', '~> 1.3')
+  spec.add_development_dependency('aruba', '~> 0.14')
+  spec.add_development_dependency('cucumber', '~> 7.0')
   spec.add_development_dependency('pry')
-  spec.add_development_dependency('rspec', '~> 2.99')
+  spec.add_development_dependency('relish', '~> 0.7')
+  spec.add_development_dependency('rspec', '~> 3.7')
 end