vagrant-bindfs 0.4.14 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 13ab236d53312e92a8d851fa46964c9058fa9a8b
-  data.tar.gz: aa0e37cc87f7e0e707586b38c1cb78d2c90ebccb
+  metadata.gz: 3903f446b7220c7e235c01977a3789744ae0f0ac
+  data.tar.gz: de5fc9b8abfed184d121b2c7fc498cd7de4aa41d
 SHA512:
-  metadata.gz: 2a2b1bdd830b77ec846268f3e9590994e119f93f86861f0d9a27835fe96c277d0857d89bed78fea3bac0befe6640f186f32ae11b7a246751849688b9013fd5fc
-  data.tar.gz: 58e53b1e04a653827eeef66448772346e51098c64ef37a90bcbad6a3b588f59aba4c5c1c1900155f806ccb7da792513faf0ab39c8a9ff10d4ee278e228eb799c
+  metadata.gz: 4a15651cbd0dae8d3047973e20ca341f3511e84a1e713e3ca5e68d02fb6a19b576e0916b6b75db0c3be32288c1ce2dd708e1b5847c1a7924257fe8be504b3c2e
+  data.tar.gz: 360223491717333c79ea2060d52fb3b5e6cb20a57a5dac7b443feda2f1b9c4d5d892ee34e5cb6a1c196c400721cd25ac8c6c2adf0ff442396a047a98c0e3abd6

data/README.md

@@ -42,7 +42,7 @@ config.bindfs.bind_folder "/path/to/source", "/path/to/destination", options
 ```
 
 By default, all folders are binded after folders syncing between host and guest machines.
-You can pass a special `:after` (or `:hook`) option to the bind_folder method to choose when a folder should be binded.
+You can pass a special `:after` option to the bind_folder method to choose when a folder should be binded.
 Supported values are :
 
 * `:synced_folders` (default)
@@ -95,8 +95,6 @@ Both long arguments and shorthand are supported.
 If you set both, shorthand will prevail.
 Long arguments can be written indifferently with underscore ('force_user') or dash ('force-user') and as strings (:'force-user') or symbols (:force_user).
 
-You can overwrite default options _via_ `config.bindfs.default_options`.
-
 vagrant-bindfs detects installed version of bindfs, translate option names when needed and ignore an option if it is not supported.
 As we may have missed something, it will warn you when a binding command fail.
 
@@ -105,12 +103,76 @@ On other system, you'll get warned.
 
 OS X guests may need some specific options. See [bindfs README](https://github.com/mpartel/bindfs#os-x-note) for details.
 
+## Configuration
+
+This plugin supports the following configuration options
+
+### `debug`
+
+Setting `config.bindfs.debug` to true will increase the verbosity level of this plugin in Vagrant output.
+
+### `default_options`
+
+You can overwrite default bindfs options _via_ `config.bindfs.default_options=`.
+
+```ruby
+Vagrant.configure("2") do |config|
+
+  # These values are the default options 
+  config.bindfs.default_options = {
+    force_user:   'vagrant',
+    force_group:  'vagrant',
+    perms:        'u=rwX:g=rD:o=rD'
+  }
+
+end
+```
+
+### `skip_validations`
+
+By default, `vagrant-bindfs` will check if the user and the group set for a binded folder exist on the virtual machine.
+If either one, the other or both of them are missing, it will warn you and not execute any bindfs command for this folder.
+
+To skip these validations, you can add `:user`and/or `:group` to the `config.bindfs.skip_validations` array.
+
+
+```ruby
+Vagrant.configure("2") do |config|
+  
+  config.bindfs.skip_validations << :user
+  
+end
+```
+
+### `bindfs_version` and `install_bindfs_from_source`
+
+By default, if `bindfs` needs to be installed on the virtual machine, `vagrant-bindfs` will install the most recent release available in repositories (_via_ `homebrew` for OS X guests).
+If no version of `bindfs` is found, it will try to install the most recent supported version of `bindfs` from source. (See [lib/vagrant-bindfs/bindfs.rb](https://github.com/gael-ian/vagrant-bindfs/blob/master/lib/vagrant-bindfs/bindfs.rb#L4) for the exact version number).
+
+You can force the plugin to install the version of `bindfs` of your choice with the `bindfs_version` configuration option.
+It will then look for the specified version in repositories and install it if available. If not, it will install it from sources.
+
+You can also force installation from sources with the `install_bindfs_from_source` configuration option.
+This will skip any repositories look up.
+
+```ruby
+Vagrant.configure("2") do |config|
+  
+  # This will force the plugin to install bindfs-1.12.2 from sources
+  config.bindfs.bindfs_version = "1.12.2"
+  config.bindfs.install_bindfs_from_source = true
+  
+end
+```
+
+**This feature only works with exact version match and does not try to resolve dependencies.**
+In particular, Fuse will always be installed from the latest version available in repositories (_via_ Homebrew Cask for OS X guests).
 
 ## Contributing
 
 If you find this plugin useful, we could use a few enhancements!
 In particular, capabilities files for installing vagrant-bindfs on other systems would be useful.
-We could also use some specs…
+We could also use some more specs…
 
 
 ### How to Test Changes

data/Rakefile

@@ -1,20 +1,24 @@
-require "rubygems"
-require "bundler/setup"
-
-#require "rspec/core/rake_task"
+# frozen_string_literal: true
+require 'rubygems'
+require 'bundler/setup'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
 # Immediately sync all stdout
 $stdout.sync = true
 $stderr.sync = true
 
 # Change to the directory of this file
-Dir.chdir(File.expand_path("../", __FILE__))
+Dir.chdir(File.expand_path('../', __FILE__))
 
 # Installs the tasks for gem creation
 Bundler::GemHelper.install_tasks
 
 # Install the `spec` task so that we can run tests
-#RSpec::Core::RakeTask.new
+RSpec::Core::RakeTask.new
+
+# Add Rubocop tasks
+RuboCop::RakeTask.new
 
 # Default task is to run the unit tests
-#task :default => "spec"
+task default: 'spec'

data/Vagrantfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # -*- mode: ruby -*-
 # vi: set ft=ruby :
 
@@ -7,10 +8,10 @@ test_machines = {
   # ubuntu: { box: "bento/ubuntu-16.04" },
   # fedora: { box: "bento/fedora-24"    },
   # redhat: { box: "bento/centos-7.2"   },
-  
+
   # The `vagrant` user group does not exist in this box.
   # suse:   { box: "bento/opensuse-leap-42.1",    args: { group: 'users' } },
-  
+
   # **This box require the Oracle VM VirtualBox Extension Pack for Virtualbox.**
   # The `vagrant` user group does not exist in this box.
   # osx:    { box: "jhcook/osx-elcapitan-10.11",  args: { group: 'staff' } },
@@ -21,16 +22,18 @@ test_machines = {
   # documentation. See https://goo.gl/LbkPVF
 }
 
-require File.expand_path("../test/test_helper", __FILE__)
-
-Vagrant.configure("2") do |config|
+require File.expand_path('../spec/vagrantfile_helper', __FILE__)
 
+Vagrant.configure('2') do |config|
   # Common configuration
-  config.vm.provider "virtualbox" do |vb|
-    vb.memory = 512
+  config.vm.provider 'virtualbox' do |vb|
+    vb.memory = 4096
     vb.cpus = 2
   end
 
+  # For a more detailled output when you test, set this to true.
+  config.bindfs.debug = false
+
   test_machines.each do |distro, options|
     config.vm.define "vagrant-bindfs-test-#{distro}" do |machine|
       machine.vm.box = options[:box]
@@ -38,4 +41,3 @@ Vagrant.configure("2") do |config|
     end
   end
 end
-

data/lib/vagrant-bindfs.rb

@@ -1,22 +1,16 @@
+# frozen_string_literal: true
 begin
-  require "vagrant"
+  require 'vagrant'
 rescue LoadError
-  raise "The Vagrant bindfs plugin must be run within Vagrant"
+  raise 'The Vagrant bindfs plugin must be run within Vagrant'
 end
 
-require "vagrant-bindfs/plugin"
-require "vagrant-bindfs/errors"
-
-require "pathname"
+module VagrantBindfs
+  autoload :Vagrant,      'vagrant-bindfs/vagrant'
+  autoload :Bindfs,       'vagrant-bindfs/bindfs'
+end
 
-module VagrantPlugins
-  module Bindfs
-    
-    def self.source_root
-      @source_root ||= Pathname.new(File.expand_path("../../", __FILE__))
-    end
+I18n.load_path << File.expand_path('../../locales/en.yml', __FILE__)
+I18n.reload!
 
-    I18n.load_path << File.expand_path("locales/en.yml", source_root)
-    I18n.reload!
-  end
-end
+require 'vagrant-bindfs/vagrant/plugin'

data/lib/vagrant-bindfs/bindfs.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+module VagrantBindfs
+  module Bindfs
+    SOURCE_VERSION  = '1.13.4'
+    SOURCE_URLS     = [
+      'http://bindfs.org/downloads/bindfs-%{bindfs_version}.tar.gz',
+      'http://bindfs.dnsalias.net/downloads/bindfs-%{bindfs_version}.tar.gz'
+    ].freeze
+
+    autoload :Command,    'vagrant-bindfs/bindfs/command'
+    autoload :Folder,     'vagrant-bindfs/bindfs/folder'
+    autoload :OptionSet,  'vagrant-bindfs/bindfs/option_set'
+    autoload :Validators, 'vagrant-bindfs/bindfs/validators'
+  end
+end

data/lib/vagrant-bindfs/bindfs/command.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+module VagrantBindfs
+  module Bindfs
+    class Command
+      attr_reader :folder
+
+      def initialize(folder)
+        @folder = folder
+      end
+
+      def to_s
+        ['bindfs', arguments_for(folder.options).join(' '), folder.source, folder.destination].compact.join(' ')
+      end
+
+      protected
+
+      def arguments_for(options)
+        options.each_with_object([]) do |(name, value), args|
+          args << format_argument(name, value) unless value.nil?
+          args
+        end.compact
+      end
+
+      def format_argument(name, value)
+        definition      = argument_definition(name)
+        compatible_name = argument_compatible_name(name)
+
+        if definition['type'] == 'flag' && !!value
+          return "-#{compatible_name}" if definition['long'].empty? # Shorthand only options
+          return "--#{compatible_name}"
+        end
+        if definition['type'] == 'option'
+          return "-#{compatible_name} #{value}" if definition['long'].empty? # Shorthand only options
+          return "--#{compatible_name}=#{value}"
+        end
+      end
+
+      def argument_definition(name)
+        Bindfs::OptionSet.bindfs_options[name]
+      end
+
+      def argument_compatible_name(name)
+        Bindfs::OptionSet.compatible_name_for_version(name, @folder.options.version)
+      end
+    end
+  end
+end

data/lib/vagrant-bindfs/bindfs/folder.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+require 'digest/sha1'
+
+module VagrantBindfs
+  module Bindfs
+    class Folder
+      attr_reader :source
+      attr_reader :destination
+      attr_reader :options
+
+      attr_reader :hook
+
+      def initialize(hook, source, destination, options = {})
+        @hook         = hook
+
+        @source       = source
+        @destination  = destination
+        @options      = Bindfs::OptionSet.new(nil, options)
+      end
+
+      def id
+        @id ||= Digest::SHA1.new.digest(destination)
+      end
+
+      def reverse_merge!(options)
+        @options = Bindfs::OptionSet.new(nil, options).merge(@options)
+      end
+
+      def merge!(options)
+        @options = @options.merge(options)
+      end
+
+      def to_version!(version)
+        @options = @options.to_version(version)
+      end
+    end
+  end
+end

data/lib/vagrant-bindfs/bindfs/option_definitions.json

@@ -0,0 +1,67 @@
+// TODO: Update after each bindfs release
+{
+  // "File" ownership
+  "force-user":               { "long": ["force-user", "user", "owner"], "short": ["u"], "type": "option", "since": "0.0.1"   },
+  "force-group":              { "long": ["force-group", "group"],        "short": ["g"], "type": "option", "since": "0.0.1"   },
+  "perms":                    { "long": ["perms"],                       "short": ["p"], "type": "option", "since": "0.0.1"   },
+  "mirror":                   { "long": ["mirror"],                      "short": ["m"], "type": "option", "since": "0.0.1"   },
+  "mirror-only":              { "long": ["mirror-only"],                 "short": ["M"], "type": "option", "since": "0.0.1"   },
+  "map":                      { "long": ["map"],                         "short": [],    "type": "option", "since": "1.10"    },
+  "uid-offset":               { "long": ["uid-offset"],                  "short": [],    "type": "option", "since": "1.13.2"  },
+  "gid-offset":               { "long": ["gid-offset"],                  "short": [],    "type": "option", "since": "1.13.2"  },
+
+  // File creation policy
+  "create-as-user":           { "long": ["create-as-user"],              "short": [],    "type": "flag",   "since": "0.0.1"   },
+  "create-as-mounter":        { "long": ["create-as-mounter"],           "short": [],    "type": "flag",   "since": "0.0.1"   },
+  "create-for-user":          { "long": ["create-for-user"],             "short": [],    "type": "option", "since": "0.0.1"   },
+  "create-for-group":         { "long": ["create-for-group"],            "short": [],    "type": "option", "since": "0.0.1"   },
+  "create-with-perms":        { "long": ["create-with-perms"],           "short": [],    "type": "option", "since": "0.0.1"   },
+
+  // Chown policy
+  "chown-normal":             { "long": ["chown-normal"],                "short": [],    "type": "flag",   "since": "0.0.1"   },
+  "chown-ignore":             { "long": ["chown-ignore"],                "short": [],    "type": "flag",   "since": "0.0.1"   },
+  "chown-deny":               { "long": ["chown-deny"],                  "short": [],    "type": "flag",   "since": "0.0.1"   },
+
+  // Chgrp policy
+  "chgrp-normal":             { "long": ["chgrp-normal"],                "short": [],    "type": "flag",   "since": "0.0.1"   },
+  "chgrp-ignore":             { "long": ["chgrp-ignore"],                "short": [],    "type": "flag",   "since": "0.0.1"   },
+  "chgrp-deny":               { "long": ["chgrp-deny"],                  "short": [],    "type": "flag",   "since": "0.0.1"   },
+
+  // Chmod policy
+  "chmod-normal":             { "long": ["chmod-normal"],                "short": [],    "type": "flag",   "since": "0.0.1"   },
+  "chmod-ignore":             { "long": ["chmod-ignore"],                "short": [],    "type": "flag",   "since": "0.0.1"   },
+  "chmod-deny":               { "long": ["chmod-deny"],                  "short": [],    "type": "flag",   "since": "0.0.1"   },
+  "chmod-filter":             { "long": ["chmod-filter"],                "short": [],    "type": "option", "since": "1.12.2"  },
+  "chmod-allow-x":            { "long": ["chmod-allow-x"],               "short": [],    "type": "flag",   "since": "0.0.1"   },
+
+  // Extended attribute policy
+  "xattr-none":               { "long": ["xattr-none"],                  "short": [],    "type": "flag",   "since": "0.0.1"   },
+  "xattr-ro":                 { "long": ["xattr-ro"],                    "short": [],    "type": "flag",   "since": "0.0.1"   },
+  "xattr-rw":                 { "long": ["xattr-rw"],                    "short": [],    "type": "flag",   "since": "0.0.1"   },
+
+  // Rate limits
+  "read-rate":                { "long": ["read-rate"],                   "short": [],    "type": "option", "since": "1.12.6"  },
+  "write-rate":               { "long": ["write-rate"],                  "short": [],    "type": "option", "since": "1.12.6"  },
+
+  // Link handling
+  "hide-hard-links":          { "long": ["hide-hard-links"],             "short": [],    "type": "flag",   "since": "1.10"    },
+  "resolve-symlinks":         { "long": ["resolve-symlinks"],            "short": [],    "type": "flag",   "since": "1.13.0"  },
+  "resolve-symlink-policy":   { "long": ["resolve-symlink-policy"],      "short": [],    "type": "option", "since": "1.13.0"  },
+
+  // Multithreading
+  "multithreaded":            { "long": ["multithreaded"],               "short": [],    "type": "flag",   "since": "1.11"    },
+  "enable-lock-forwarding":   { "long": ["enable-lock-forwarding"],      "short": [],    "type": "flag",   "since": "1.13.2"  },
+  "disable-lock-forwarding":  { "long": ["disable-lock-forwarding"],     "short": [],    "type": "flag",   "since": "1.13.2"  },
+
+  // Miscellaneous
+  "no-allow-other":           { "long": ["no-allow-other"],              "short": ["n"], "type": "flag",   "since": "0.0.1"   },
+  "realistic-permissions":    { "long": ["realistic-permissions"],       "short": [],    "type": "flag",   "since": "1.10"    },
+  "ctime-from-mtime":         { "long": ["ctime-from-mtime"],            "short": [],    "type": "flag",   "since": "0.0.1"   },
+  "enabe-ioctl":              { "long": ["enable-ioctl"],                "short": [],    "type": "flag",   "since": "1.13.2"  },
+
+  // FUSE options
+  "o":                        { "long": [],                              "short": ["o"], "type": "option", "since": "0.0.1"   },
+  "r":                        { "long": [],                              "short": ["r"], "type": "flag",   "since": "0.0.1"   },
+  "d":                        { "long": [],                              "short": ["d"], "type": "flag",   "since": "0.0.1"   },
+  "f":                        { "long": [],                              "short": ["f"], "type": "flag",   "since": "0.0.1"   }
+}

data/lib/vagrant-bindfs/bindfs/option_set.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+module VagrantBindfs
+  module Bindfs
+    class OptionSet
+      attr_reader :version
+
+      attr_reader :options
+      attr_reader :invalid_options
+      attr_reader :unsupported_options
+
+      include Enumerable
+      extend Forwardable
+      [:each, :[], :keys, :key?].each do |method|
+        def_delegator :@options, method
+      end
+
+      def initialize(version = nil, options = {})
+        @version              = version
+        @options              = normalize_option_names(options)
+        @invalid_options      = {}
+        @unsupported_options  = {}
+
+        extract_invalid_options!
+        extract_unsupported_options!
+      end
+
+      def merge!(other)
+        other = other.to_version(version) if other.respond_to?(:to_version)
+        @options.merge!(normalize_option_names(other))
+        extract_invalid_options!
+        extract_unsupported_options!
+      end
+
+      def merge(other)
+        dup.tap { |result| result.merge!(other) }
+      end
+
+      def to_version(new_version)
+        self.class.new(new_version, @options.merge(invalid_options).merge(unsupported_options))
+      end
+
+      protected
+
+      def normalize_option_names(options)
+        options.each_with_object({}) do |(key, value), normalized|
+          normalized_key = key.to_s.tr('_', '-')
+          canonical_name = canonical_option_name(normalized_key)
+
+          if normalized.key?(canonical_name)
+            raise VagrantBindfs::Vagrant::ConfigError.new(:conflicting_options, name: canonical_name)
+          end
+
+          normalized[canonical_name] = value
+          normalized
+        end
+      end
+
+      def canonical_option_name(option_name)
+        self.class.bindfs_options.each do |name, definition|
+          return name if definition['short'].include?(option_name)
+          return name if definition['long'].include?(option_name)
+        end
+        option_name
+      end
+
+      def extract_invalid_options!
+        extract_options_by_names!(options.keys - self.class.bindfs_options.keys, @invalid_options)
+      end
+
+      def extract_unsupported_options!
+        extract_options_by_names!(options.keys - self.class.supported_options(version).keys, @unsupported_options)
+      end
+
+      def extract_options_by_names!(names, to)
+        return {} if names.empty?
+        names.each { |name| to[name] = @options.delete(name) }
+      end
+
+      class << self
+        def bindfs_options
+          @bindfs_options ||= JSON.parse(File.read(File.expand_path('../option_definitions.json', __FILE__)))
+        end
+
+        def supported_options(version)
+          bindfs_options.each_with_object({}) do |(name, definition), supported|
+            supported[name] = definition if version.nil? || !version_lower_than(version, definition['since'])
+            supported
+          end
+        end
+
+        def compatible_name_for_version(option_name, version)
+          return 'user'   if option_name == 'force-user' && version_lower_than(version, '1.12')
+          return 'group'  if option_name == 'force-group' && version_lower_than(version, '1.12')
+          option_name
+        end
+
+        protected
+
+        def version_lower_than(version, target)
+          Gem::Version.new(version) < Gem::Version.new(target)
+        end
+      end
+    end
+  end
+end