vagrant-cachier 0.5.1 → 0.6.0

data/lib/vagrant-cachier/plugin.rb

@@ -1,6 +1,7 @@
-require_relative 'provision_ext'
-Vagrant::Action::Builtin::Provision.class_eval do
-  include VagrantPlugins::Cachier::ProvisionExt
+# TODO: Switch to Vagrant.require_version before 1.0.0
+#       see: https://github.com/mitchellh/vagrant/blob/bc55081e9ffaa6820113e449a9f76b293a29b27d/lib/vagrant.rb#L202-L228
+unless Gem::Requirement.new('>= 1.4.0').satisfied_by?(Gem::Version.new(Vagrant::VERSION))
+  raise 'vagrant-cachier requires Vagrant >= 1.4.0 in order to work!'
 end
 
 # Add our custom translations to the load path
@@ -10,87 +11,18 @@ module VagrantPlugins
   module Cachier
     class Plugin < Vagrant.plugin('2')
       name 'vagrant-cachier'
-
       config 'cache' do
         require_relative "config"
         Config
       end
-
-      guest_capability 'linux', 'gemdir' do
-        require_relative 'cap/linux/gemdir'
-        Cap::Linux::Gemdir
-      end
-
-      guest_capability 'linux', 'rvm_path' do
-        require_relative 'cap/linux/rvm_path'
-        Cap::Linux::RvmPath
-      end
-
-      guest_capability 'linux', 'composer_path' do
-        require_relative 'cap/linux/composer_path'
-        Cap::Linux::ComposerPath
-      end
-
-      guest_capability 'linux', 'chef_file_cache_path' do
-        require_relative 'cap/linux/chef_file_cache_path'
-        Cap::Linux::ChefFileCachePath
-      end
-
-      guest_capability 'linux', 'npm_cache_dir' do
-        require_relative 'cap/linux/npm_cache_dir'
-        Cap::Linux::NpmCacheDir
-      end
-
-      guest_capability 'debian', 'apt_cache_dir' do
-        require_relative 'cap/debian/apt_cache_dir'
-        Cap::Debian::AptCacheDir
-      end
-
-      guest_capability 'debian', 'apt_cacher_dir' do
-        require_relative 'cap/debian/apt_cacher_dir'
-        Cap::Debian::AptCacherDir
-      end
-
-      guest_capability 'redhat', 'yum_cache_dir' do
-        require_relative 'cap/redhat/yum_cache_dir'
-        Cap::RedHat::YumCacheDir
-      end
-
-      guest_capability 'suse', 'yum_cache_dir' do
-        # Disable Yum on suse guests
-      end
-
-      guest_capability 'arch', 'pacman_cache_dir' do
-        require_relative 'cap/arch/pacman_cache_dir'
-        Cap::Arch::PacmanCacheDir
-      end
-
-      guest_capability 'suse', 'zypper_cache_dir' do
-        require_relative 'cap/suse/zypper_cache_dir'
-        Cap::SuSE::ZypperCacheDir
-      end
-
-      # TODO: This should be generic, we don't want to hard code every single
-      #       possible provider action class that Vagrant might have
-      ensure_single_cache_root = lambda do |hook|
-        require_relative 'action/ensure_single_cache_root'
-        hook.before VagrantPlugins::ProviderVirtualBox::Action::Boot, Action::EnsureSingleCacheRoot
-
-        if defined?(Vagrant::LXC)
-          # TODO: Require just the boot action file once its "require dependencies" are sorted out
-          require 'vagrant-lxc/action'
-          hook.before Vagrant::LXC::Action::Boot, Action::EnsureSingleCacheRoot
-        end
-      end
-      action_hook 'ensure-single-cache-root-exists-on-up',     :machine_action_up,     &ensure_single_cache_root
-      action_hook 'ensure-single-cache-root-exists-on-reload', :machine_action_reload, &ensure_single_cache_root
-
-      clean_action_hook = lambda do |hook|
-        require_relative 'action/clean'
-        hook.before Vagrant::Action::Builtin::GracefulHalt, Action::Clean
-      end
-      action_hook 'remove-guest-symlinks-on-halt',    :machine_action_halt,    &clean_action_hook
-      action_hook 'remove-guest-symlinks-on-package', :machine_action_package, &clean_action_hook
     end
+
+    # Keep an eye on https://github.com/mitchellh/vagrant/wiki/Available-Vagrant-Plugins#wiki-providers
+    # for more.
+    CLOUD_PROVIDERS = %w( aws cloudstack digitalocean hp joyent openstack rackspace
+                          softlayer proxmox managed )
   end
 end
+
+require_relative "hooks"
+require_relative "capabilities"

data/lib/vagrant-cachier/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module Cachier
-    VERSION = "0.5.1"
+    VERSION = "0.6.0"
   end
 end

data/locales/en.yml

@@ -16,10 +16,6 @@ en:
       scoped cache dirs starting with the 0.3.0 version of the plugin.
     unable_to_ssh: |-
       vagrant-cachier was unable to SSH into the VM to remove symlinks!
-  vagrant:
-    errors:
-      multiple_provider_specific_cache_dirs_found: |-
-        There are multiple provider specific cache dirs for the '%{machine}' machine:
-        %{dirs}
-        Please move one of them up to `%{machine_path}/cache` and remove the others
-        before bringing the machine up again.
+    backed_by_cloud_provider: |-
+      The machine is backed by a cloud provider (%{provider}), caching
+      will be disabled.

data/vagrant-cachier.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = VagrantPlugins::Cachier::VERSION
   spec.authors       = ["Fabio Rehm"]
   spec.email         = ["fgrehm@gmail.com"]
-  spec.description   = %q{Speed up vagrant boxes provisioning}
+  spec.description   = %q{Caffeine reducer}
   spec.summary       = spec.description
   spec.homepage      = "https://github.com/fgrehm/vagrant-cachier"
   spec.license       = "MIT"
@@ -17,4 +17,14 @@ 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.post_install_message = %q{
+  If you are new to vagrant-cachier just follow along with the docs available
+  at http://fgrehm.viewdocs.io/vagrant-cachier.
+
+  If you are a long time user, please note that plugin has gone through many
+  backwards incompatible changes since 0.6.0 so checkout
+  https://github.com/fgrehm/vagrant-cachier/blob/master/CHANGELOG.md
+  before continuing and caching all the things :)
+  }
 end

metadata

@@ -1,23 +1,23 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-cachier
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Fabio Rehm
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-20 00:00:00.000000000 Z
+date: 2014-02-27 00:00:00.000000000 Z
 dependencies: []
-description: Speed up vagrant boxes provisioning
+description: Caffeine reducer
 email:
 - fgrehm@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -29,6 +29,7 @@ files:
 - development/Vagrantfile
 - docs/benchmarks.md
 - docs/buckets/apt-cacher.md
+- docs/buckets/apt-lists.md
 - docs/buckets/apt.md
 - docs/buckets/chef.md
 - docs/buckets/composer.md
@@ -45,10 +46,12 @@ files:
 - docs/usage.md
 - lib/vagrant-cachier.rb
 - lib/vagrant-cachier/action/clean.rb
-- lib/vagrant-cachier/action/ensure_single_cache_root.rb
+- lib/vagrant-cachier/action/configure_bucket_root.rb
+- lib/vagrant-cachier/action/install_buckets.rb
 - lib/vagrant-cachier/bucket.rb
 - lib/vagrant-cachier/bucket/apt.rb
 - lib/vagrant-cachier/bucket/apt_cacher.rb
+- lib/vagrant-cachier/bucket/apt_lists.rb
 - lib/vagrant-cachier/bucket/chef.rb
 - lib/vagrant-cachier/bucket/composer.rb
 - lib/vagrant-cachier/bucket/gem.rb
@@ -60,6 +63,7 @@ files:
 - lib/vagrant-cachier/cap/arch/pacman_cache_dir.rb
 - lib/vagrant-cachier/cap/debian/apt_cache_dir.rb
 - lib/vagrant-cachier/cap/debian/apt_cacher_dir.rb
+- lib/vagrant-cachier/cap/debian/apt_lists_dir.rb
 - lib/vagrant-cachier/cap/linux/chef_file_cache_path.rb
 - lib/vagrant-cachier/cap/linux/composer_path.rb
 - lib/vagrant-cachier/cap/linux/gemdir.rb
@@ -67,10 +71,10 @@ files:
 - lib/vagrant-cachier/cap/linux/rvm_path.rb
 - lib/vagrant-cachier/cap/redhat/yum_cache_dir.rb
 - lib/vagrant-cachier/cap/suse/zypper_cache_dir.rb
+- lib/vagrant-cachier/capabilities.rb
 - lib/vagrant-cachier/config.rb
-- lib/vagrant-cachier/errors.rb
+- lib/vagrant-cachier/hooks.rb
 - lib/vagrant-cachier/plugin.rb
-- lib/vagrant-cachier/provision_ext.rb
 - lib/vagrant-cachier/version.rb
 - locales/en.yml
 - spec/acceptance/fixtures/auto-detect-with-provisioning.rb
@@ -84,26 +88,30 @@ homepage: https://github.com/fgrehm/vagrant-cachier
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: "\n  If you are new to vagrant-cachier just follow along with
+  the docs available\n  at http://fgrehm.viewdocs.io/vagrant-cachier.\n\n  If you
+  are a long time user, please note that plugin has gone through many\n  backwards
+  incompatible changes since 0.6.0 so checkout\n  https://github.com/fgrehm/vagrant-cachier/blob/master/CHANGELOG.md\n
+  \ before continuing and caching all the things :)\n  "
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.5
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Speed up vagrant boxes provisioning
+summary: Caffeine reducer
 test_files:
 - spec/acceptance/fixtures/auto-detect-with-provisioning.rb
 - spec/acceptance/fixtures/auto-detect.rb

data/lib/vagrant-cachier/action/ensure_single_cache_root.rb

@@ -1,64 +0,0 @@
-require_relative '../errors'
-
-module VagrantPlugins
-  module Cachier
-    class Action
-      class EnsureSingleCacheRoot
-        def initialize(app, env)
-          @app = app
-        end
-
-        def call(env)
-          @env = env
-
-          # If the cache is scoped to boxes or the existing cache dirs are not
-          # provider specific, there's nothing we need to do
-          if cache_scoped_to_machine? && provider_specific_cache_dirs.any?
-            ensure_single_cache_root_exists!
-          end
-
-          @app.call(env)
-        end
-
-        def cache_scoped_to_machine?
-          @env[:machine].config.cache.enabled? &&
-            @env[:machine].config.cache.scope.to_sym == :machine
-        end
-
-        def ensure_single_cache_root_exists!
-          if provider_specific_cache_dirs.size > 1
-            cache_dirs = provider_specific_cache_dirs.map do |dir|
-              "  - #{dir.to_s.gsub(/^#{@env[:root_path]}\//, '')}"
-            end
-            machine_path = @env[:machine].data_dir.parent.to_s.gsub(/^#{@env[:root_path]}\//, '')
-            raise Cachier::Errors::MultipleProviderSpecificCacheDirsFound,
-                      machine:      @env[:machine].name,
-                      machine_path: machine_path,
-                      dirs:         cache_dirs.join("\n")
-          else
-            current_path = provider_specific_cache_dirs.first.to_s.gsub(/^#{@env[:root_path]}\//, '')
-            new_path     = @env[:machine].data_dir.parent.join('cache')
-            FileUtils.rm_rf new_path.to_s if new_path.directory?
-
-            new_path = new_path.to_s.gsub(/^#{@env[:root_path]}\//, '')
-            # If we got here there is a single provider specific cacher dir, so
-            # let's be nice with users and just fix it ;)
-            @env[:ui].warn I18n.t('vagrant_cachier.will_fix_machine_cache_dir',
-                                  current_path: current_path,
-                                  new_path:     new_path)
-            FileUtils.mv current_path, new_path
-          end
-        end
-
-        def provider_specific_cache_dirs
-          return @provider_specific_cache_dirs if @provider_specific_cache_dirs
-
-          # By default data_dir points to ./.vagrant/machines/<NAME>/<PROVIDER>,
-          # so we go one directory up
-          machine_dir = @env[:machine].data_dir.parent
-          @provider_specific_cache_dirs = Pathname.glob(machine_dir.join('*/cache'))
-        end
-      end
-    end
-  end
-end

data/lib/vagrant-cachier/errors.rb

@@ -1,9 +0,0 @@
-module VagrantPlugins
-  module Cachier
-    module Errors
-      class MultipleProviderSpecificCacheDirsFound < Vagrant::Errors::VagrantError
-        error_key(:multiple_provider_specific_cache_dirs_found)
-      end
-    end
-  end
-end

data/lib/vagrant-cachier/provision_ext.rb

@@ -1,74 +0,0 @@
-require_relative 'bucket'
-
-module VagrantPlugins
-  module Cachier
-    module ProvisionExt
-      def self.included(base)
-        base.class_eval do
-          def cachier_debug(msg)
-            @logger.debug "[CACHIER] #{msg}"
-          end
-
-          alias :old_call :call
-          def call(env)
-            @env = env
-
-            return old_call(env) unless env[:machine].config.cache.enabled?
-
-            FileUtils.mkdir_p(cache_root.to_s) unless cache_root.exist?
-
-            synced_folder_opts = {id: "vagrant-cache"}
-            if env[:machine].config.cache.enable_nfs
-              # REFACTOR: Drop the `nfs: true` argument once we drop support for Vagrant < 1.4
-              synced_folder_opts.merge!({ nfs: true, type: 'nfs' })
-            end
-            env[:machine].config.vm.synced_folder cache_root, '/tmp/vagrant-cache', synced_folder_opts
-
-            env[:cache_dirs] = []
-
-            old_call(env)
-
-            configure_cache_buckets
-          end
-
-          alias :old_run_provisioner :run_provisioner
-          def run_provisioner(*args)
-            configure_cache_buckets
-            old_run_provisioner(*args)
-          end
-
-          def configure_cache_buckets
-            return unless @env[:machine].config.cache.enabled?
-
-            if @env[:machine].config.cache.auto_detect
-              Bucket.auto_detect(@env)
-            end
-
-            return unless @env[:machine].config.cache.buckets.any?
-
-            @env[:ui].info 'Configuring cache buckets...'
-            cache_config = @env[:machine].config.cache
-            cache_config.buckets.each do |bucket_name, configs|
-              cachier_debug "Installing #{bucket_name} with configs #{configs.inspect}"
-              Bucket.install(bucket_name, @env, configs)
-            end
-
-            data_file = @env[:machine].data_dir.join('cache_dirs')
-            data_file.open('w') { |f| f.print @env[:cache_dirs].uniq.join("\n") }
-          end
-
-          def cache_root
-            @cache_root ||= case @env[:machine].config.cache.scope.to_sym
-              when :box
-                @env[:home_path].join('cache', @env[:machine].box.name)
-              when :machine
-                @env[:machine].data_dir.parent.join('cache')
-              else
-                raise "Unknown cache scope: '#{@env[:machine].config.cache.scope}'"
-            end
-          end
-        end
-      end
-    end
-  end
-end