vagrant-unify 0.0.1

data/.gitignore

@@ -0,0 +1,16 @@
+# OS-specific
+.DS_Store
+
+# Bundler/Rubygems
+*.gem
+.bundle
+pkg/*
+tags
+Gemfile.lock
+
+# Vagrant
+.vagrant
+Vagrantfile
+
+# IDEs
+.project

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.0.1 (11 July 2014)
+
+* Initial release.

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+group :development do
+  gem "vagrant", :git => "git://github.com/mitchellh/vagrant.git"
+end
+
+group :plugins do
+  gemspec
+end

data/LICENSE

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright (c) 2013 Mitchell Hashimoto
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,35 @@
+# Vagrant Unify Plugin
+
+This is a [Vagrant](http://www.vagrantup.com) 1.5+ plugin liberally copy-and-paste'd from
+the [vagrant-unison](https://github.com/mrdavidlaing/vagrant-unison) plugin and
+Vagrant's own rsync plugin. It allows you to configure a set of folders to synchronize
+with Unison or RSync but without the on-startup and automatic sync features of Vagrant's
+synchronized folders and the Unison plugin.
+
+**NOTE:** This plugin requires Vagrant 1.5+.
+
+**NOTE:** In order to use the unify-sync command the [Unison](http://www.cis.upenn.edu/~bcpierce/unison/)
+application must be installed on both the host and guest machines and available on the PATH as `unison`.
+
+## Usage
+
+Install using standard Vagrant 1.1+ plugin installation methods. 
+```
+$ vagrant plugin install vagrant-unify
+```
+After installing, edit your Vagrantfile and add a configuration directive similar to the below:
+```
+Vagrant.configure("2") do |config|
+  config.vm.box = "dummy"
+  config.unify.unify_folder "/home/myuser/project1", "/opt/project1"
+  config.unify.unify_folder "/home/myuser/git/project2", "/opt/project2", exclude: ".git*"
+end
+```
+
+## Syncing folders
+
+Run `vagrant unify-pull` to rsync files from the guest to your local host.
+
+Run `vagrant unify-push` to rsync files from your local host to the guest.
+
+Run `vagrant unify-sync` to Unison files between your local host and the guest.

data/lib/vagrant-unify.rb

@@ -0,0 +1,12 @@
+require "pathname"
+
+require "vagrant-unify/plugin"
+require "vagrant-unify/errors"
+
+module VagrantPlugins
+  module Unify
+    def self.source_root
+      @source_root ||= Pathname.new(File.expand_path("../../", __FILE__))
+    end
+  end
+end

data/lib/vagrant-unify/command-pull.rb

@@ -0,0 +1,47 @@
+require "optparse"
+require "log4r"
+require "vagrant"
+
+require_relative "helper"
+
+module VagrantPlugins
+  module Unify
+    class Command < Vagrant.plugin("2", :command)
+      def self.synopsis
+        I18n.t("vagrant_unify.pull.synopsis")
+      end
+
+      def execute
+        params = OptionParser.new do |o|
+          o.banner = "Usage: vagrant unify-pull [vm-name]"
+          o.separator ""
+        end
+
+        argv = parse_options(params)
+        return if !argv
+
+        error = false
+        with_target_vms do |machine|
+          if !machine.communicate.ready?
+            machine.ui.error(I18n.t("vagrant.rsync_communicator_not_ready"))
+            error = true
+            next
+          end
+
+          machine.config.unify.folders.each { |folder|
+            local_path  = folder.fetch(0, nil)
+            remote_path = folder.fetch(1, nil)
+            opts        = folder.fetch(2, {})
+
+            raise Vagrant::Errors::UnifyConfigError, :err => I18n.t("vagrant_unify.config.local_path_required") if local_path.nil? or local_path.empty?
+            raise Vagrant::Errors::UnifyConfigError, :err => I18n.t("vagrant_unify.config.remote_path_required") if remote_path.nil? or remote_path.empty?
+
+            UnifyHelper.rsync_single(:pull, machine, local_path, remote_path, opts)
+          }
+        end
+
+        return error ? 1 : 0
+      end
+    end
+  end
+end

data/lib/vagrant-unify/command-push.rb

@@ -0,0 +1,47 @@
+require "optparse"
+require "log4r"
+require "vagrant"
+
+require_relative "helper"
+
+module VagrantPlugins
+  module Unify
+    class Command < Vagrant.plugin("2", :command)
+      def self.synopsis
+        I18n.t("vagrant_unify.push.synopsis")
+      end
+
+      def execute
+        params = OptionParser.new do |o|
+          o.banner = "Usage: vagrant unify-push [vm-name]"
+          o.separator ""
+        end
+
+        argv = parse_options(params)
+        return if !argv
+
+        error = false
+        with_target_vms do |machine|
+          if !machine.communicate.ready?
+            machine.ui.error(I18n.t("vagrant.rsync_communicator_not_ready"))
+            error = true
+            next
+          end
+
+          machine.config.unify.folders.each { |folder|
+            local_path  = folder.fetch(0, nil)
+            remote_path = folder.fetch(1, nil)
+            opts        = folder.fetch(2, {})
+
+            raise Vagrant::Errors::UnifyConfigError, :err => I18n.t("vagrant_unify.config.local_path_required") if local_path.nil? or local_path.empty?
+            raise Vagrant::Errors::UnifyConfigError, :err => I18n.t("vagrant_unify.config.remote_path_required") if remote_path.nil? or remote_path.empty?
+
+            UnifyHelper.rsync_single(:push, machine, local_path, remote_path, opts)
+          }
+        end
+
+        return error ? 1 : 0
+      end
+    end
+  end
+end

data/lib/vagrant-unify/command-sync.rb

@@ -0,0 +1,47 @@
+require "optparse"
+require "log4r"
+require "vagrant"
+
+require_relative "helper"
+
+module VagrantPlugins
+  module Unify
+    class Command < Vagrant.plugin("2", :command)
+      def self.synopsis
+        I18n.t("vagrant_unify.sync.synopsis")
+      end
+
+      def execute
+        params = OptionParser.new do |o|
+          o.banner = "Usage: vagrant unify-sync [vm-name]"
+          o.separator ""
+        end
+
+        argv = parse_options(params)
+        return if !argv
+
+        error = false
+        with_target_vms do |machine|
+          if !machine.communicate.ready?
+            machine.ui.error(I18n.t("vagrant.rsync_communicator_not_ready"))
+            error = true
+            next
+          end
+
+          machine.config.unify.folders.each { |folder|
+            local_path  = folder.fetch(0, nil)
+            remote_path = folder.fetch(1, nil)
+            opts        = folder.fetch(2, {})
+
+            raise Vagrant::Errors::UnifyConfigError, :err => I18n.t("vagrant_unify.config.local_path_required") if local_path.nil? or local_path.empty?
+            raise Vagrant::Errors::UnifyConfigError, :err => I18n.t("vagrant_unify.config.remote_path_required") if remote_path.nil? or remote_path.empty?
+
+            UnifyHelper.unison_single(machine, local_path, remote_path, opts)
+          }
+        end
+
+        return error ? 1 : 0
+      end
+    end
+  end
+end

data/lib/vagrant-unify/config.rb

@@ -0,0 +1,17 @@
+require "vagrant"
+
+module VagrantPlugins
+  module Unify
+    class Config < Vagrant.plugin("2", :config)
+      attr_accessor :folders
+
+      def initialize(region_specific=false)
+        @folders = []
+      end
+
+      def unify_folder(local_path, remote_path, opts = {})
+        @folders << [local_path, remote_path, opts]
+      end
+    end
+  end
+end

data/lib/vagrant-unify/errors.rb

@@ -0,0 +1,12 @@
+require "vagrant"
+
+module Vagrant
+  module Errors
+    class UnifyConfigError < VagrantError
+      error_key(:config_error, "vagrant_unify.errors")
+    end
+    class UnifyError < VagrantError
+      error_key(:unify_error, "vagrant_unify.errors")
+    end
+  end
+end

data/lib/vagrant-unify/helper.rb

@@ -0,0 +1,197 @@
+require "fileutils"
+require "vagrant/util/platform"
+require "vagrant/util/subprocess"
+
+module VagrantPlugins
+  module Unify
+    class UnifyHelper
+      def self.init_ops(machine, local_path, remote_path, opts)
+        opts[:hostpath] ||= local_path
+        opts[:guestpath] ||= remote_path
+        opts[:owner] ||= machine.ssh_info[:username]
+        opts[:group] ||= machine.ssh_info[:username]
+        return opts
+      end
+
+      def self.init_paths(machine, local_path, remote_path, cygwinify = false)
+        guestpath = remote_path
+        hostpath  = File.expand_path(local_path, machine.env.root_path)
+        hostpath  = Vagrant::Util::Platform.fs_real_path(hostpath).to_s
+
+        if cygwinify and Vagrant::Util::Platform.windows?
+          hostpath = Vagrant::Util::Platform.cygwin_path(hostpath)
+        end
+
+        if !guestpath.end_with?("/")
+          guestpath += "/"
+        end
+
+        if !hostpath.end_with?("/")
+          hostpath += "/"
+        end
+
+        return [hostpath, guestpath]
+      end
+
+      def self.init_ssh_args(machine)
+        ssh_info = machine.ssh_info
+        proxy_command = ""
+
+        if ssh_info[:proxy_command]
+          proxy_command = "-o ProxyCommand='#{ssh_info[:proxy_command]}' "
+        end
+
+        return [
+          "-p #{ssh_info[:port]} " +
+          proxy_command +
+          "-o StrictHostKeyChecking=no " +
+          "-o UserKnownHostsFile=/dev/null",
+          ssh_info[:private_key_path].map { |p| "-i '#{p}'" },
+        ].flatten.join(" ")
+      end
+
+      def self.init_excludes(opts)
+        excludes = ['.vagrant/', '.DS_Store']
+        excludes += Array(opts[:exclude]).map(&:to_s) if opts[:exclude]
+        excludes.uniq!
+        return excludes
+      end
+
+      def self.pre_sync(machine, hostpath, guestpath, opts)
+        if machine.guest.capability?(:rsync_pre)
+          machine.guest.capability(:rsync_pre, opts)
+        else
+          machine.communicate.sudo("mkdir -p '#{guestpath}'")
+          machine.communicate.sudo("chown #{machine.ssh_info[:username]} '#{guestpath}'")
+        end
+
+        FileUtils.mkdir_p(hostpath)
+      end
+
+      def self.post_sync(machine, opts)
+        if machine.guest.capability?(:rsync_post)
+          machine.guest.capability(:rsync_post, opts)
+        end
+      end
+
+      def self.unison_single(machine, local_path, remote_path, opts)
+        opts = init_ops(machine, local_path, remote_path, opts)
+        hostpath, guestpath = init_paths(machine, local_path, remote_path)
+        ssh_args = init_ssh_args(machine)
+        excludes = init_excludes(opts)
+
+        command = [
+          "unison", "-batch",
+          "-ignore=Name {" + excludes.join(",")  + "}",
+          "-sshargs", ssh_args,
+          hostpath,
+          "ssh://#{machine.ssh_info[:username]}@#{machine.ssh_info[:host]}/#{guestpath}"
+        ]
+
+        command_opts = {}
+        command_opts[:workdir] = machine.env.root_path.to_s
+
+        command = command + [command_opts]
+
+        machine.ui.info(I18n.t(
+          "vagrant_unify.sync.message", guestpath: guestpath, hostpath: hostpath))
+        if excludes.length > 1
+          machine.ui.info(I18n.t(
+            "vagrant_unify.excludes", excludes: excludes.inspect))
+        end
+
+        pre_sync(machine, hostpath, guestpath, opts)
+
+        r = Vagrant::Util::Subprocess.execute(*command)
+        case r.exit_code
+        when 0
+          machine.ui.info(I18n.t("vagrant_unify.unison.success_0"))
+        when 1
+          machine.ui.info(I18n.t("vagrant_unify.unison.success_1"))
+        when 2
+          machine.ui.info(I18n.t("vagrant_unify.unison.success_2"))
+        else
+          raise Vagrant::Errors::UnifyError,
+            :command => command.inspect,
+            :guestpath => guestpath,
+            :hostpath => hostpath,
+            :stderr => r.stderr
+        end
+
+        post_sync(machine, opts)
+      end
+
+      def self.rsync_single(direction, machine, local_path, remote_path, opts)
+        opts = init_ops(machine, local_path, remote_path, opts)
+        hostpath, guestpath = init_paths(machine, local_path, remote_path, true)
+        ssh_args = init_ssh_args(machine)
+        excludes = init_excludes(opts)
+
+        args = nil
+        args = Array(opts[:args]).dup if opts[:args]
+        args ||= ["--verbose", "--archive", "--delete", "-z", "--copy-links"]
+
+        if Vagrant::Util::Platform.windows? && !args.any? { |arg| arg.start_with?("--chmod=") }
+          args << "--chmod=ugo=rwX"
+
+          args << "--no-perms" if args.include?("--archive") || args.include?("-a")
+        end
+
+        args << "--no-owner" unless args.include?("--owner") || args.include?("-o")
+        args << "--no-group" unless args.include?("--group") || args.include?("-g")
+
+        if machine.guest.capability?(:rsync_command)
+          args << "--rsync-path"<< machine.guest.capability(:rsync_command)
+        end
+
+        guest_spec = "#{machine.ssh_info[:username]}@#{machine.ssh_info[:host]}:#{guestpath}"
+        from_path = hostpath
+        to_path = guest_spec
+
+        if :pull.equal?(direction)
+          from_path = guest_spec
+          to_path = hostpath
+        end
+
+        command = [
+          "rsync",
+          args,
+          "-e", "ssh " + ssh_args,
+          excludes.map { |e| ["--exclude", e] },
+          from_path,
+          to_path,
+        ].flatten
+
+        command_opts = {}
+        command_opts[:workdir] = machine.env.root_path.to_s
+
+        command = command + [command_opts]
+
+        if :pull.equal?(direction)
+          machine.ui.info(I18n.t(
+            "vagrant_unify.pull.message", guestpath: guestpath, hostpath: hostpath))
+        else
+          machine.ui.info(I18n.t(
+            "vagrant_unify.push.message", guestpath: guestpath, hostpath: hostpath))
+        end
+        if excludes.length > 1
+          machine.ui.info(I18n.t(
+            "vagrant_unify.excludes", excludes: excludes.inspect))
+        end
+
+        pre_sync(machine, hostpath, guestpath, opts)
+
+        r = Vagrant::Util::Subprocess.execute(*command)
+        if r.exit_code != 0
+          raise Vagrant::Errors::UnifyError,
+            command: command.inspect,
+            guestpath: guestpath,
+            hostpath: hostpath,
+            stderr: r.stderr
+        end
+
+        post_sync(machine, opts)
+      end
+    end
+  end
+end

data/lib/vagrant-unify/plugin.rb

@@ -0,0 +1,75 @@
+begin
+  require "vagrant"
+rescue LoadError
+  raise "The vagrant-unify plugin must be run within Vagrant."
+end
+
+if Vagrant::VERSION < "1.5"
+  raise "The vagrant-unify plugin is only compatible with Vagrant 1.5+"
+end
+
+module VagrantPlugins
+  module Unify
+    class Plugin < Vagrant.plugin("2")
+      name "Unify"
+      description = <<-DESC
+      This plugin syncs files between a local folder and
+      your Vagrant machine via either Unison or RSync
+      DESC
+
+      config "unify" do
+        require_relative "config"
+        Config
+      end
+
+      command "unify-pull" do
+        setup_logging
+        setup_i18n
+
+        require_relative "command-pull"
+        Command
+      end
+
+      command "unify-push" do
+        setup_logging
+        setup_i18n
+
+        require_relative "command-push"
+        Command
+      end
+
+      command "unify-sync" do
+        setup_logging
+        setup_i18n
+
+        require_relative "command-sync"
+        Command
+      end
+
+      def self.setup_i18n
+        I18n.load_path << File.expand_path("locales/en.yml", Unify.source_root)
+        I18n.reload!
+      end
+
+      def self.setup_logging
+        require "log4r"
+
+        level = nil
+        begin
+          level = Log4r.const_get(ENV["VAGRANT_LOG"].upcase)
+        rescue NameError
+          level = nil
+        end
+
+        level = nil if !level.is_a?(Integer)
+
+        if level
+          logger = Log4r::Logger.new("vagrant_unify")
+          logger.outputters = Log4r::Outputter.stderr
+          logger.level = level
+          logger = nil
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-unify/version.rb

@@ -0,0 +1,5 @@
+module VagrantPlugins
+  module Unify
+    VERSION = "0.0.1"
+  end
+end

data/locales/en.yml

@@ -0,0 +1,50 @@
+en:
+  vagrant_unify:
+
+    pull:
+      synopsis: |-
+        rsyncs guest files to host
+      message: |-
+        Unify - pulling [guest]::%{guestpath} --> [host]::%{hostpath}
+
+    push:
+      synopsis: |-
+        rsyncs host files to guest
+      message: |-
+        Unify - pushing [host]::%{hostpath} --> [guest]::%{guestpath}
+
+    sync:
+      synopsis: |-
+        syncs files between host and guest via Unison
+      message: |-
+        Unify - syncing [host]::%{hostpath} <-> [guest]::%{guestpath}
+
+    excludes: |-
+      Excluding: %{excludes}
+
+    unison:
+      success_0: |-
+        Unison completed succesfully
+      success_1: |-
+        Unison completed - all file transfers were successful; some files were skipped
+      success_2: |-
+        Unison completed - non-fatal failures during file transfer
+
+    config:
+      local_path_required: |-
+        Local path is required
+      remote_path_required: |-
+        Remote path is required
+
+    errors:
+      config_error: |-
+        Error in unify configuration: %{err}
+      unify_error: |-
+        There was an error when attemping to unify folders.
+        Please inspect the error message below for more info.
+
+        Host path: %{hostpath}
+        Guest path: %{guestpath}
+        Error: %{stderr}
+        Full command causing error: 
+        %{command}

data/vagrant-unify.gemspec

@@ -0,0 +1,50 @@
+$:.unshift File.expand_path("../lib", __FILE__)
+require "vagrant-unify/version"
+
+Gem::Specification.new do |s|
+  s.name          = "vagrant-unify"
+  s.version       = VagrantPlugins::Unify::VERSION
+  s.platform      = Gem::Platform::RUBY
+  s.authors       = "Ed Toon"
+  s.email         = "edtoon@edtoon"
+  s.homepage      = "https://github.com/edtoon/vagrant-unify"
+  s.summary       = "Vagrant plugin to sync files between a local folder and a Vagrant machine via either Unison or RSync"
+  s.description   = "Vagrant plugin to sync files between a local folder and a Vagrant machine via either Unison or RSync"
+
+  s.required_rubygems_version = ">= 1.3.6"
+
+  # The following block of code determines the files that should be included
+  # in the gem. It does this by reading all the files in the directory where
+  # this gemspec is, and parsing out the ignored files from the gitignore.
+  # Note that the entire gitignore(5) syntax is not supported, specifically
+  # the "!" syntax, but it should mostly work correctly.
+  root_path      = File.dirname(__FILE__)
+  all_files      = Dir.chdir(root_path) { Dir.glob("**/{*,.*}") }
+  all_files.reject! { |file| [".", ".."].include?(File.basename(file)) }
+  gitignore_path = File.join(root_path, ".gitignore")
+  gitignore      = File.readlines(gitignore_path)
+  gitignore.map!    { |line| line.chomp.strip }
+  gitignore.reject! { |line| line.empty? || line =~ /^(#|!)/ }
+
+  unignored_files = all_files.reject do |file|
+    # Ignore any directories, the gemspec only cares about files
+    next true if File.directory?(file)
+
+    # Ignore any paths that match anything in the gitignore. We do
+    # two tests here:
+    #
+    #   - First, test to see if the entire path matches the gitignore.
+    #   - Second, match if the basename does, this makes it so that things
+    #     like '.DS_Store' will match sub-directories too (same behavior
+    #     as git).
+    #
+    gitignore.any? do |ignore|
+      File.fnmatch(ignore, file, File::FNM_PATHNAME) ||
+        File.fnmatch(ignore, File.basename(file), File::FNM_PATHNAME)
+    end
+  end
+
+  s.files         = unignored_files
+  s.executables   = unignored_files.map { |f| f[/^bin\/(.*)/, 1] }.compact
+  s.require_path  = 'lib'
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: vagrant-unify
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Ed Toon
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2014-07-11 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Vagrant plugin to sync files between a local folder and a Vagrant machine via either Unison or RSync
+email: edtoon@edtoon
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- vagrant-unify.gemspec
+- README.md
+- CHANGELOG.md
+- locales/en.yml
+- Gemfile
+- LICENSE
+- lib/vagrant-unify/helper.rb
+- lib/vagrant-unify/plugin.rb
+- lib/vagrant-unify/errors.rb
+- lib/vagrant-unify/config.rb
+- lib/vagrant-unify/version.rb
+- lib/vagrant-unify/command-sync.rb
+- lib/vagrant-unify/command-pull.rb
+- lib/vagrant-unify/command-push.rb
+- lib/vagrant-unify.rb
+- .gitignore
+has_rdoc: true
+homepage: https://github.com/edtoon/vagrant-unify
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Vagrant plugin to sync files between a local folder and a Vagrant machine via either Unison or RSync
+test_files: []
+