hem-tasks-rsync 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 96b11ce518ce92a91f176d63a4d87f2b408ce1fa
+  data.tar.gz: 825a8668a45c01a0d6ec4891b2cde9a5b1a5d688
+SHA512:
+  metadata.gz: 00b691108e3083fe1732616559caed2aa62d0124bfb68a8dab613dbb7bc5f2bd55e269eec2bd9f1702dd03d98f7901bd1cec0f384d161fce4fc784ae3f7c25e5
+  data.tar.gz: 1633488b1b2cb678d41f4ddc58f1b08bff72819215604b3b4aaf8a30c6b61611df241b2503f6e858765e1765916241c8a903b13e27a277c964a693166332211c

data/.rubocop.yml

@@ -0,0 +1,5 @@
+AllCops:
+  TargetRubyVersion: 2.2
+
+Metrics/LineLength:
+  Max: 120

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hem-tasks-rsync.gemspec
+gemspec

data/README.md

@@ -0,0 +1,28 @@
+# Hem::Tasks::Rsync
+
+Contains tasks for [Hem](https://github.com/inviqa/hem) to provide rsync functionality
+for projects
+
+## Installation
+
+Add this line to your application's Hemfile:
+
+```ruby
+plugins do
+  gem 'hem-tasks-rsync'
+end
+```
+
+## Usage
+`hem deps` will give a nice overview of what functionality is provided!
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/inviqa/hem-tasks-rsync. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+task default: :spec

data/hem-tasks-rsync.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'hem/tasks/rsync/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'hem-tasks-rsync'
+  spec.version       = Hem::Tasks::Rsync::VERSION
+  spec.authors       = ['Kieren Evans']
+  spec.email         = ['kevans+hem_tasks@inviqa.com']
+
+  spec.summary       = 'Rsync tasks for Hem'
+  spec.description   = 'Rsync tasks for Hem'
+  spec.homepage      = ''
+  spec.licenses = ['MIT']
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|\.rubocop\.yml|Rakefile)/}) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop', '~> 0.43.0'
+end

data/lib/hem/lib/vm/ReverseCommand.rb

@@ -0,0 +1,65 @@
+#!/usr/bin/env ruby
+# ^ Syntax hint
+
+# Hem
+module Hem
+  # Lib!
+  module Lib
+    # VM!
+    module Vm
+      # Place the ssh configuration within a command, using sprintf
+      class ReverseCommand < Command
+        def to_s
+          ssh_config = ssh_config()
+          ssh_command = ssh_command(ssh_config)
+          pwd_set_command = pwd_set_command()
+          vm_command = vm_command()
+
+          [
+            @pipe,
+            full_command(pwd_set_command, vm_command, ssh_command)
+          ].compact.join(' | ')
+        end
+
+        private
+
+        def ssh_config
+          require 'tempfile'
+
+          config = ::Tempfile.new 'hem_ssh_config'
+          config.write @@vm_inspector.ssh_config
+          config.close
+
+          config
+        end
+
+        def ssh_command(config)
+          psuedo_tty = @opts[:psuedo_tty] ? '-t' : ''
+          [
+            'ssh',
+            "-F #{config.path.shellescape}",
+            psuedo_tty
+          ].reject(&:empty?).join(' ')
+        end
+
+        def pwd_set_command
+          "cd #{@opts[:pwd].shellescape}; exec /bin/bash"
+        end
+
+        def vm_command
+          [
+            @pipe_in_vm.nil? ? nil : @pipe_in_vm.gsub(/(\\+)/, '\\\\\1'),
+            @command
+          ].compact.join(' | ')
+        end
+
+        def full_command(pwd_set_command, vm_command, ssh_command)
+          [
+            pwd_set_command,
+            vm_command.empty? ? nil : (vm_command % ssh_command).shellescape
+          ].compact.join(' -c ') + @opts[:append].shellescape
+        end
+      end
+    end
+  end
+end

data/lib/hem/tasks/rsync/deps.rb

@@ -0,0 +1,59 @@
+#!/usr/bin/env ruby
+# ^ Syntax hint
+
+before 'deps:composer', 'deps:sync:composer_files_to_guest'
+after 'deps:composer', 'deps:sync:reload_or_sync'
+
+namespace :deps do
+  desc 'Syncing dependencies to/from the VM'
+  namespace :sync do
+    desc 'Download the composer.json and lock from the guest to the host'
+    task :composer_files_from_guest do
+      Hem.ui.title 'Downloading composer files to host'
+
+      Rake::Task['vm:rsync_manual'].execute(
+        from_path: File.join(Hem.project_config.vm.project_mount_path, 'composer.json'),
+        to_path: File.join(Hem.project_path, 'composer.json'),
+        is_reverse: true
+      )
+      Rake::Task['vm:rsync_manual'].execute(
+        from_path: File.join(Hem.project_config.vm.project_mount_path, 'composer.lock'),
+        to_path: File.join(Hem.project_path, 'composer.lock'),
+        is_reverse: true
+      )
+      Hem.ui.success 'Downloaded composer files to host'
+    end
+
+    desc 'Upload the composer.json and lock from the host to the guest'
+    task :composer_files_to_guest do
+      Hem.ui.title 'Uploading composer files to guest'
+
+      Rake::Task['vm:upload_root_files_to_guest'].invoke
+
+      Hem.ui.success('Uploaded composer files to guest')
+    end
+
+    desc 'Download the vendor directory from the guest to the host'
+    task :vendor_directory_from_guest do
+      Hem.ui.title 'Downloading vendor directory changes from guest'
+
+      Rake::Task['vm:sync_guest_changes'].execute(
+        from_path: 'vendor/',
+        to_path: 'vendor',
+        deciding_file_path: File.join('vendor', 'autoload.php'),
+        guest_to_host_allowed: false
+      )
+    end
+
+    desc 'Reload the VM to use NFS mounts per directory, or sync rsync mounts if already enabled'
+    task :reload_or_sync do
+      one_mount_point = run 'grep "/vagrant " /proc/mounts || true', capture: true
+      if one_mount_point != ''
+        Rake::Task['vm:reload'].execute
+      else
+        Rake::Task['deps:sync:vendor_directory_from_guest'].execute
+        Rake::Task['vm:rsync_mount_sync'].execute
+      end
+    end
+  end
+end

data/lib/hem/tasks/rsync/version.rb

@@ -0,0 +1,7 @@
+module Hem
+  module Tasks
+    module Rsync
+      VERSION = '1.0.0'.freeze
+    end
+  end
+end

data/lib/hem/tasks/rsync/vm.rb

@@ -0,0 +1,135 @@
+#!/usr/bin/env ruby
+# ^ Syntax hint
+
+after 'vm:reload', 'vm:provision_shell'
+after 'vm:reload', 'vm:upload_root_files_to_guest'
+after 'vm:start', 'vm:provision_shell'
+after 'vm:start', 'vm:upload_root_files_to_guest'
+
+namespace :vm do
+  desc 'Trigger a sync to occur for rsync mountpoints'
+  task :rsync_mount_sync do
+    vagrantfile do
+      Hem.ui.title 'Syncing directories'
+      vagrant_exec 'rsync'
+      Hem.ui.success('Vendor directory synced')
+    end
+  end
+
+  desc 'Rsync any files in the project root the guest'
+  task :upload_root_files_to_guest do
+    one_mount_point = run 'grep "/vagrant " /proc/mounts || true', capture: true
+    next unless one_mount_point == ''
+
+    Hem.ui.title 'Uploading project root files to the guest'
+
+    files = shell "find '#{Hem.project_path}' -type f -maxdepth 1 -print0",
+                  local: true, on: :host, capture: true, pwd: Hem.project_path
+
+    next unless files
+
+    rsync_command = <<-COMMAND
+      find '.' -type f -maxdepth 1 -print0 | \
+      rsync --files-from=- --from0 --human-readable --progress \
+      --verbose --compress --archive --rsh='%s' \
+      '#{Hem.project_path}' 'default:#{Hem.project_config.vm.project_mount_path}'
+      COMMAND
+    args = [rsync_command, { local: true, realtime: true, indent: 2, on: :host, pwd: Hem.project_path }]
+    require_relative File.join('..', '..', 'lib', 'vm', 'ReverseCommand')
+    Hem::Lib::Vm::ReverseCommand.new(*args).run
+
+    Hem.ui.success 'Uploaded project root files to the guest'
+  end
+
+  desc 'Rsync from host to guest, or if in reverse mode, from guest to host'
+  argument :from_path
+  argument :to_path
+  argument 'is_reverse', optional: true, default: false
+  task :rsync_manual do |_task_name, args|
+    from_path = args[:from_path]
+    to_path = args[:to_path]
+
+    Hem.ui.title "Syncing #{from_path} to #{to_path}"
+
+    hostname = 'default'
+    if args[:is_reverse]
+      # '--delete' deliberately skipped. VM should not delete files from the host OS.
+      # Don't want to lose work in case of mistakes
+      remote_file_exists = run "if [ -e '#{from_path}' ]; then echo 1; else echo 0; fi", capture: true
+      rsync_command = if remote_file_exists == '1'
+                        <<-COMMAND
+                          rsync --human-readable --compress --archive --rsh='%s' \
+                          '#{hostname}:#{from_path}' '#{to_path}'
+                          COMMAND
+                      else
+                        "echo 'Failed to find source file, skipping'"
+                      end
+    else
+      rsync_command = <<-COMMAND
+        if [ -e '#{from_path}' ]; then
+          rsync --human-readable --compress --archive --rsh='%s' \
+          '#{from_path}' '#{hostname}:#{to_path}';
+        else
+          echo 'Failed to find source file, skipping';
+        fi
+        COMMAND
+    end
+
+    args = [rsync_command, { local: true, realtime: true, indent: 2, on: :host, pwd: Hem.project_path }]
+    require_relative File.join('..', '..', 'lib', 'vm', 'ReverseCommand')
+    Hem::Lib::Vm::ReverseCommand.new(*args).run
+
+    Hem.ui.success("Synced #{from_path} to #{to_path}")
+  end
+
+  desc 'Sync changes from a guest directory to a host directory if a given file is newer'
+  argument :from_path
+  argument :to_path
+  argument :deciding_file_path
+  argument :guest_to_host_allowed, optional: true, default: true
+  task :sync_guest_changes do |_task_name, args|
+    Hem.ui.title "Determining if #{args[:deciding_file_path]} is newer on the host or guest"
+
+    local_file_path = File.join(Hem.project_path, args[:deciding_file_path])
+    local_file_modified = 0
+    local_file_modified = File.mtime(local_file_path).to_i if File.exist? local_file_path
+
+    remote_file_path = File.join(Hem.project_config.vm.project_mount_path, args[:deciding_file_path])
+    remote_file_modified = run "if [ -e '#{remote_file_path}' ]; then stat -c \%Y '#{remote_file_path}' ; fi",
+                               capture: true
+
+    if local_file_modified.to_i < remote_file_modified.to_i
+      Hem.ui.success("Guest file #{args[:deciding_file_path]} is newer, syncing to host")
+      from_path = File.join(Hem.project_config.vm.project_mount_path, args[:from_path])
+      to_path = File.join(Hem.project_path, args[:to_path])
+
+      Rake::Task['vm:rsync_manual'].execute(
+        from_path: from_path,
+        to_path: to_path,
+        is_reverse: true
+      )
+    elsif args[:guest_to_host_allowed] && local_file_modified.to_i > remote_file_modified.to_i
+      Hem.ui.success("Host file #{args[:deciding_file_path]} is newer, syncing to guest")
+      from_path = File.join(Hem.project_path, args[:to_path])
+      to_path = File.join(Hem.project_config.vm.project_mount_path, args[:from_path])
+
+      Rake::Task['vm:rsync_manual'].execute(
+        from_path: from_path,
+        to_path: to_path
+      )
+    elsif !args[:guest_to_host_allowed]
+      Hem.ui.success('Host is more up to date than the guest but syncing via another method')
+    else
+      Hem.ui.success("Host and guest file #{args[:deciding_file_path]} are up to date, not doing anything")
+    end
+  end
+
+  desc 'Provision VM via files and shell scripts only'
+  task :provision_shell do
+    vagrantfile do
+      Hem.ui.title 'Provisioning VM via files and shell scripts only'
+      vagrant_exec 'provision', '--provision-with', 'shell,file'
+      Hem.ui.separator
+    end
+  end
+end

data/lib/hem/tasks/rsync.rb

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# ^ Syntax hint
+
+require_relative 'rsync/deps'
+require_relative 'rsync/vm'

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: hem-tasks-rsync
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Kieren Evans
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.43.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.43.0
+description: Rsync tasks for Hem
+email:
+- kevans+hem_tasks@inviqa.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- Gemfile
+- README.md
+- Rakefile
+- hem-tasks-rsync.gemspec
+- lib/hem/lib/vm/ReverseCommand.rb
+- lib/hem/tasks/rsync.rb
+- lib/hem/tasks/rsync/deps.rb
+- lib/hem/tasks/rsync/version.rb
+- lib/hem/tasks/rsync/vm.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Rsync tasks for Hem
+test_files: []