entangler 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d318a183e429b424739510c6387797f1662ca70d
-  data.tar.gz: 85e3be687d52b674b03fe019c4b5a23b0e2a8eee
+  metadata.gz: 9903130b1c46dd5555b89bfeaca78446d9326108
+  data.tar.gz: eaab17609bbbbcfb18f48a52558114096a5f2a8b
 SHA512:
-  metadata.gz: 87f64fef3ac2ab2c405b0c889959cdd4d611632d60503be33d68ba54692221a4a7b00235b4383d5d5064318f032b0d942c39a77bcef1e22938a2e28d927706e0
-  data.tar.gz: 9c0fb5dabbeddaf2eb9c94e06cf5fc185e53ade82b98ecc00ae1b00f8771b217fa92dfc68b060a249bdce61dee9c2bdd981a498d7cf1effe6b75e8cbf20e1f49
+  metadata.gz: 1ff26850233910d6a3f0868571f3e6c8c69ef371417784d62cda84e48d7026052245ba4ddddbcb708ec9ef1ef1299c0bdb9ee6f6cb6698f61ce6a9c3863825bd
+  data.tar.gz: ef43547587b7ed6085a630eb82cd9a57ec7d282a7924af8dda5efda5d13b2b5fd96688e7460a8d09e29bacb4137b5759df61c334e9abfde4e72fb4fd9ab66059

data/README.md

@@ -18,7 +18,7 @@ $ entangler master /some/base/path user@remote:/some/remote/path
 
 ```
 $ entangler -h
-Entangler v1.0.2
+Entangler v1.1.0
 
 Usage:
    entangler master <base_dir> <remote_user>@<remote_host>:<remote_base_dir> [options]
@@ -30,6 +30,7 @@ Options:
     -p, --port PORT                  Overwrite the SSH port (usually 22)
                                      (doesn't do anything in slave mode)
     -v, --verbose                    Log Debug lines
+    -q, --quiet                      Don't log to stdout in master process
         --version                    Show version number
     -h, --help                       Show this message
 ```

data/entangler.gemspec

@@ -1,4 +1,3 @@
-# coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'entangler/version'
@@ -14,15 +13,16 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/daveallie/entangler'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files         = Dir['lib/**/*'] + Dir['exe/**/*'] + %w[CODE_OF_CONDUCT.md LICENSE.txt README.md
+                                                              Gemfile entangler.gemspec]
   spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.executables   = ['entangler']
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'bundler', '~> 1.13'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '~> 0.46'
+  spec.add_development_dependency 'rubocop', '~> 0.49.1'
   spec.add_dependency 'listen', '~> 3.1'
-  spec.add_dependency 'to_regexp', '~> 0.2'
+  spec.add_dependency 'to_regexp', '~> 0.2.0'
 end

data/exe/entangler

@@ -4,6 +4,18 @@ require 'optparse'
 require 'to_regexp'
 
 options = {}
+def bool_opt(opts, key, *args)
+  opts.on(*args) do
+    options[key] = true
+  end
+end
+
+def value_opt(opts, key, *args)
+  opts.on(*args) do |val|
+    options[key] = val
+  end
+end
+
 OptionParser.new do |opts|
   opts.banner = %(Entangler v#{Entangler::VERSION}
 
@@ -20,13 +32,10 @@ Usage:
     options[:ignore] << ignore
   end
 
-  opts.on('-p', '--port PORT', 'Overwrite the SSH port (usually 22)', "(doesn't do anything in slave mode)") do |port|
-    options[:port] = port
-  end
-
-  opts.on('-v', '--verbose', 'Log Debug lines') do
-    options[:verbose] = true
-  end
+  value_opt(opts, :port, '-p', '--port PORT', 'Overwrite the SSH port (usually 22)',
+            "(doesn't do anything in slave mode)")
+  bool_opt(opts, :verbose, '-v', '--verbose', 'Log Debug lines')
+  bool_opt(opts, :quiet, '-q', '--quiet', "Don't log to stdout in master process")
 
   opts.on_tail('--version', 'Show version number') do
     puts Entangler::VERSION
@@ -40,7 +49,7 @@ Usage:
 end.parse!
 
 mode = ARGV.shift
-unless mode && %w(master slave).include?(mode)
+unless mode && %w[master slave].include?(mode)
   puts "Mode unknown, please read help:\nentangler -h"
   exit 1
 end
@@ -103,6 +112,7 @@ if options[:ignore]
   end
 end
 
+opts[:quiet] = options[:quiet]
 opts[:verbose] = options[:verbose]
 
 begin

data/lib/entangler.rb

@@ -1,5 +1,6 @@
 require_relative 'entangler/version'
 require_relative 'entangler/errors'
+require_relative 'entangler/logger'
 require_relative 'entangler/entangled_file'
 
 module Entangler

data/lib/entangler/executor/base.rb

@@ -2,11 +2,13 @@ require 'logger'
 require 'fileutils'
 require 'thread'
 require_relative 'background/base'
+require_relative 'validation/base'
 
 module Entangler
   module Executor
     class Base
       include Entangler::Executor::Background::Base
+      include Entangler::Executor::Validation::Base
 
       attr_reader :base_dir
 
@@ -20,6 +22,7 @@ module Entangler
         @opts[:ignore] << /^\.entangler.*/
 
         validate_opts
+        Entangler::Logger.create_log_dir(base_dir)
       end
 
       def generate_abs_path(rel_path)
@@ -44,36 +47,16 @@ module Entangler
 
       protected
 
-      def validate_opts; end
-
       def send_to_remote(msg = {})
         Marshal.dump(msg, @remote_writer)
       end
 
       def logger
-        FileUtils.mkdir_p log_dir
-        @logger ||= begin
-          l = Logger.new(File.join(log_dir, 'entangler.log'))
-          l.level = @opts[:verbose] ? Logger::DEBUG : Logger::INFO
-          l.formatter = logger_formatter
-          l
-        end
-      end
-
-      def logger_formatter
-        proc do |severity, datetime, _, msg|
-          date_format = datetime.strftime('%Y-%m-%d %H:%M:%S')
-          "[#{date_format}] #{severity.rjust(5)}: #{msg}\n"
-        end
-      end
-
-      def log_dir
-        File.join(base_dir, '.entangler', 'log')
+        @logger ||= Entangler::Logger.new(log_outputs, @opts[:verbose])
       end
 
-      def validate_base_dir(base_dir)
-        raise Entangler::ValidationError, "Base directory doesn't exist" unless File.exist?(base_dir)
-        raise Entangler::ValidationError, 'Base directory is a file' unless File.directory?(base_dir)
+      def log_outputs
+        [Entangler::Logger.log_file_path(base_dir)]
       end
     end
   end

data/lib/entangler/executor/helpers.rb

@@ -0,0 +1,11 @@
+module Entangler
+  module Helper
+    def self.with_temp_file(name: 'tmp_file', contents: nil)
+      t = Tempfile.new(name)
+      t.puts(contents) unless contents.nil?
+      t.close
+      yield t
+      t.unlink
+    end
+  end
+end

data/lib/entangler/executor/master.rb

@@ -1,9 +1,12 @@
+require_relative 'helpers'
 require_relative 'background/master'
+require_relative 'validation/master'
 
 module Entangler
   module Executor
     class Master < Base
       include Entangler::Executor::Background::Master
+      include Entangler::Executor::Validation::Master
 
       def run
         perform_initial_rsync
@@ -16,64 +19,17 @@ module Entangler
 
       private
 
-      def validate_opts
-        super
-        if @opts[:remote_mode]
-          @opts[:remote_port] ||= '22'
-          validate_remote_opts
-        else
-          validate_local_opts
-        end
-      end
-
-      def validate_local_opts
-        unless File.exist?(@opts[:remote_base_dir])
-          raise Entangler::ValidationError, "Destination directory doesn't exist"
-        end
-        unless File.directory?(@opts[:remote_base_dir])
-          raise Entangler::ValidationError, 'Destination directory is a file'
-        end
-        @opts[:remote_base_dir] = File.realpath(File.expand_path(@opts[:remote_base_dir]))
-        return unless @opts[:remote_base_dir] == base_dir
-        raise Entangler::ValidationError, "Destination directory can't be the same as the base directory"
-      end
-
-      def validate_remote_opts
-        keys = @opts.keys
-        raise Entangler::ValidationError, 'Missing remote base dir' unless keys.include?(:remote_base_dir)
-        raise Entangler::ValidationError, 'Missing remote user' unless keys.include?(:remote_user)
-        raise Entangler::ValidationError, 'Missing remote host' unless keys.include?(:remote_host)
-        validate_remote_base_dir
-        validate_remote_entangler_version
-      end
-
-      def validate_remote_base_dir
-        res = `#{generate_ssh_command("[[ -d '#{@opts[:remote_base_dir]}' ]] && echo 'ok' || echo 'missing'")}`
-        raise Entangler::ValidationError, 'Cannot connect to remote' if res.empty?
-        raise Entangler::ValidationError, 'Remote base dir invalid' unless res.strip == 'ok'
-      end
-
-      def validate_remote_entangler_version
-        return unless @opts[:remote_mode]
-        res = `#{generate_ssh_command('source ~/.rvm/environments/default && entangler --version')}`
-        remote_version = Gem::Version.new(res.strip)
-        local_version = Gem::Version.new(Entangler::VERSION)
-        return unless major_version_mismatch?(local_version, remote_version)
-        msg = 'Entangler version too far apart, please update either local or remote Entangler.' \
-              " Local version is #{local_version} and remote version is #{remote_version}."
-        raise Entangler::VersionMismatchError, msg
-      end
-
-      def major_version_mismatch?(version1, version2)
-        version1.segments[0] != version2.segments[0] ||
-          (version1.segments[0].zero? && version1 != version2) ||
-          ((version1.prerelease? || version2.prerelease?) && version1 != version2)
+      def log_outputs
+        outs = [Entangler::Logger.log_file_path(base_dir)]
+        outs << STDOUT unless @opts[:quiet]
       end
 
       def perform_initial_rsync
         logger.info 'Running initial sync'
-        IO.popen(rsync_cmd_string).each do |line|
-          logger.debug line.chomp
+        with_temp_rsync_ignores do |file_path|
+          IO.popen(rsync_cmd_string(file_path)).each do |line|
+            logger.debug line.chomp
+          end
         end
         logger.debug 'Initial sync complete'
       end
@@ -107,12 +63,17 @@ module Entangler
         "#{@opts[:remote_user]}@#{@opts[:remote_host]}"
       end
 
-      def rsync_cmd_string
-        exclude_args = find_rsync_ignore_folders.map { |path| "--exclude #{path}" }.join(' ')
+      def with_temp_rsync_ignores
+        Entangler::Helper.with_temp_file(name: 'rsync_ignores', contents: find_rsync_ignore_folders.join("\n")) do |f|
+          yield f.path
+        end
+      end
+
+      def rsync_cmd_string(rsync_ignores_file_path)
         remote_path = @opts[:remote_mode] ? "#{@opts[:remote_user]}@#{@opts[:remote_host]}:" : ''
         remote_path += "#{@opts[:remote_base_dir]}/"
 
-        cmd = "rsync -azv #{exclude_args}"
+        cmd = "rsync -azv --exclude-from #{rsync_ignores_file_path}"
         cmd += " -e \"ssh -p #{@opts[:remote_port]}\"" if @opts[:remote_mode]
         cmd + " --delete #{base_dir}/ #{remote_path}"
       end

data/lib/entangler/executor/slave.rb

@@ -10,8 +10,7 @@ module Entangler
 
         @remote_reader = STDIN
         @remote_writer = STDOUT
-        FileUtils.mkdir_p log_dir
-        $stderr.reopen(File.join(log_dir, 'entangler.err'), 'w')
+        $stderr.reopen(File.join(Entangler::Logger.log_file_path(base_dir, 'entangler.err')), 'w')
       end
     end
   end

data/lib/entangler/executor/validation/base.rb

@@ -0,0 +1,16 @@
+module Entangler
+  module Executor
+    module Validation
+      module Base
+        protected
+
+        def validate_opts; end
+
+        def validate_base_dir(base_dir)
+          raise Entangler::ValidationError, "Base directory doesn't exist" unless File.exist?(base_dir)
+          raise Entangler::ValidationError, 'Base directory is a file' unless File.directory?(base_dir)
+        end
+      end
+    end
+  end
+end

data/lib/entangler/executor/validation/master.rb

@@ -0,0 +1,63 @@
+module Entangler
+  module Executor
+    module Validation
+      module Master
+        private
+
+        def validate_opts
+          super
+          if @opts[:remote_mode]
+            @opts[:remote_port] ||= '22'
+            validate_remote_opts
+          else
+            validate_local_opts
+          end
+        end
+
+        def validate_local_opts
+          unless File.exist?(@opts[:remote_base_dir])
+            raise Entangler::ValidationError, "Destination directory doesn't exist"
+          end
+          unless File.directory?(@opts[:remote_base_dir])
+            raise Entangler::ValidationError, 'Destination directory is a file'
+          end
+          @opts[:remote_base_dir] = File.realpath(File.expand_path(@opts[:remote_base_dir]))
+          return unless @opts[:remote_base_dir] == base_dir
+          raise Entangler::ValidationError, "Destination directory can't be the same as the base directory"
+        end
+
+        def validate_remote_opts
+          keys = @opts.keys
+          raise Entangler::ValidationError, 'Missing remote base dir' unless keys.include?(:remote_base_dir)
+          raise Entangler::ValidationError, 'Missing remote user' unless keys.include?(:remote_user)
+          raise Entangler::ValidationError, 'Missing remote host' unless keys.include?(:remote_host)
+          validate_remote_base_dir
+          validate_remote_entangler_version
+        end
+
+        def validate_remote_base_dir
+          res = `#{generate_ssh_command("[[ -d '#{@opts[:remote_base_dir]}' ]] && echo 'ok' || echo 'missing'")}`
+          raise Entangler::ValidationError, 'Cannot connect to remote' if res.empty?
+          raise Entangler::ValidationError, 'Remote base dir invalid' unless res.strip == 'ok'
+        end
+
+        def validate_remote_entangler_version
+          return unless @opts[:remote_mode]
+          res = `#{generate_ssh_command('source ~/.rvm/environments/default && entangler --version')}`
+          remote_version = Gem::Version.new(res.strip)
+          local_version = Gem::Version.new(Entangler::VERSION)
+          return unless major_version_mismatch?(local_version, remote_version)
+          msg = 'Entangler version too far apart, please update either local or remote Entangler.' \
+              " Local version is #{local_version} and remote version is #{remote_version}."
+          raise Entangler::VersionMismatchError, msg
+        end
+
+        def major_version_mismatch?(version1, version2)
+          version1.segments[0] != version2.segments[0] ||
+            (version1.segments[0].zero? && version1 != version2) ||
+            ((version1.prerelease? || version2.prerelease?) && version1 != version2)
+        end
+      end
+    end
+  end
+end

data/lib/entangler/logger.rb

@@ -0,0 +1,38 @@
+require 'fileutils'
+require 'logger'
+
+module Entangler
+  class Logger
+    def self.create_log_dir(base_dir)
+      FileUtils.mkdir_p(File.dirname(log_file_path(base_dir)))
+    end
+
+    def self.log_file_path(base_dir, log_file_name = 'entangler.log')
+      File.join(base_dir, '.entangler', 'log', log_file_name)
+    end
+
+    def initialize(outputs, verbose = false)
+      @loggers = Array(outputs).map do |output|
+        logger = ::Logger.new(output)
+
+        logger.level = verbose ? ::Logger::DEBUG : ::Logger::INFO
+        logger.formatter = proc do |severity, datetime, _, msg|
+          date_format = datetime.strftime('%Y-%m-%d %H:%M:%S')
+          "[#{date_format}] #{severity.rjust(5)}: #{msg}\n"
+        end
+
+        logger
+      end
+    end
+
+    def level=(level)
+      @loggers.each { |logger| logger.level = level }
+    end
+
+    ::Logger::Severity.constants.each do |level|
+      define_method(level.downcase) do |*args|
+        @loggers.each { |logger| logger.send(level.downcase, *args) }
+      end
+    end
+  end
+end

data/lib/entangler/version.rb

@@ -1,3 +1,3 @@
 module Entangler
-  VERSION = '1.0.2'.freeze
+  VERSION = '1.1.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: entangler
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Dave Allie
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-22 00:00:00.000000000 Z
+date: 2017-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '1.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '1.13'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.46'
+        version: 0.49.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.46'
+        version: 0.49.1
 - !ruby/object:Gem::Dependency
   name: listen
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: 0.2.0
 description: Two way file syncer using platform native notify.
 email:
 - dave@daveallie.com
@@ -102,17 +102,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
 - entangler.gemspec
 - exe/entangler
 - lib/entangler.rb
@@ -121,8 +114,12 @@ files:
 - lib/entangler/executor/background/base.rb
 - lib/entangler/executor/background/master.rb
 - lib/entangler/executor/base.rb
+- lib/entangler/executor/helpers.rb
 - lib/entangler/executor/master.rb
 - lib/entangler/executor/slave.rb
+- lib/entangler/executor/validation/base.rb
+- lib/entangler/executor/validation/master.rb
+- lib/entangler/logger.rb
 - lib/entangler/version.rb
 homepage: https://github.com/daveallie/entangler
 licenses:
@@ -144,7 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Two way file syncer using platform native notify.

data/.gitignore

@@ -1,11 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-/log/
-*.gem

data/.rspec

@@ -1,2 +0,0 @@
---format documentation
---color

data/.rubocop.yml

@@ -1,9 +0,0 @@
-AllCops:
-  DisplayCopNames: true
-  ExtraDetails: true
-
-Metrics/LineLength:
-  Max: 120
-
-Style/Documentation:
-  Enabled: false

data/.travis.yml

@@ -1,20 +0,0 @@
-sudo: false
-language: ruby
-os:
-  - linux
-  - osx
-rvm:
-  - 2.3.3
-  - ruby-head
-matrix:
-  include:
-  - os: osx
-    rvm: 2.2.5
-  - os: linux
-    rvm: 2.2.6
-  allow_failures:
-    - rvm: ruby-head
-before_install:
-  - gem install bundler -v 1.13.6
-install:
-  - bundle install --jobs=3 --retry=3

data/Rakefile

@@ -1,8 +0,0 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-require 'rubocop/rake_task'
-
-RuboCop::RakeTask.new(:rubocop)
-RSpec::Core::RakeTask.new(:spec)
-
-task default: [:rubocop, :spec]

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'bundler/setup'
-require 'entangler'
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require 'irb'
-IRB.start

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here