directory_push 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 713af2d1df5f371834bcca64bffff82b116e9a6d
+  data.tar.gz: ecc2f95f17e166f897ad284ab1e2e20294af0e8a
+SHA512:
+  metadata.gz: 496b80ddb9ca54d78fc833f416dd71563424769e1975703ee9fc4c508ba199ac24ead082d384e5e3738fa88d76ca73fe8aa00a5ff0dde1d375cc38b8d87eea33
+  data.tar.gz: 19b30ca77b92136e98d6e75e20d6c0484ad01cf708b80d2e91060c115626d64e11dfe6a792f75644c51c6fadd9d27bfff702b77889df7e6e41117bd337361819

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Dustin Morrill
+
+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,16 @@
+# Directory Push
+
+Pushes changes to files in a directory to a directory on a remote server.
+
+
+## Usage
+
+1. Install this gem with `gem install directory_push`.
+2. Run `directory_push` script.
+
+
+## License
+
+Copyright Dustin Morrill, 2017
+
+MIT License

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/directory_push.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'directory_push/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'directory_push'
+  spec.version       = DirectoryPush::VERSION
+  spec.authors       = ['Dustin Morrill']
+  spec.email         = ['dmorrill10@gmail.com']
+  spec.summary       = 'DirectoryPush: Push file changes to a remote server.'
+  spec.description   = ''
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'guard'
+  spec.add_dependency 'guard-shell'
+  spec.add_dependency 'guard-compat'
+  spec.add_dependency 'highline'
+  spec.add_dependency "rsync"
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+end

data/exe/directory_push

@@ -0,0 +1,89 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'directory_push'
+include DirectoryPush
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: #{__FILE__} [options]"
+
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+
+  options[:directory_path] = nil
+  opts.on(
+    "-d",
+    "--directory-path [PROJECT PATH]",
+    "Path to the directory to push."
+  ) do |d|
+    options[:directory_path] = d
+  end
+
+  options[:pull] = false
+  opts.on(
+    "-l",
+    "--[no-]pull",
+    "Pull changes before pushing. Defaults to #{options[:pull]}"
+  ) do |d|
+    options[:pull] = d
+  end
+
+  options[:path_on_remote] = nil
+  opts.on("-n", "--path-on-remote [PATH]", "Path to the pushed directory on the remote server.") do |d|
+    options[:path_on_remote] = d
+  end
+
+  options[:remote_address] = nil
+  opts.on("-r", "--remote-address [ADDRESS]", "Address to the remote server.") do |d|
+    options[:remote_address] = d
+  end
+
+  options[:user] = Cli::DEFAULT_USER
+  opts.on(
+    "-u",
+    "--user [USER]",
+    %W{The user name to use to login to the remote server. Defaults to "#{options[:user]}".}
+  ) do |d|
+    options[:user] = d
+  end
+
+  options[:rsync_options] = Cli::DEFAULT_RSYNC_OPTIONS
+  opts.on(
+    "-o",
+    "--rsync-options OPTS",
+    Array,
+    %Q{rsync options. Defaults to #{options[:rsync_options]}.}
+  ) { |a| options[:rsync_options] = a.map { |e| e.to_s  } }
+
+  options[:ignore_pattern] = nil
+  opts.on(
+    "-i",
+    "--ignore-pattern [PATTERN]",
+    %W{Pattern describing files that gaurd should ignore during its watch.}
+  ) do |d|
+    options[:ignore_pattern] = d
+  end
+
+  options[:preserve_settings] = true
+  opts.on(
+    "-s",
+    "--[no-]preserve_settings",
+    %W{Preserve the configuration settings and a backup of the remote directory before pushing after exiting. Defaults to #{options[:preserve_settings]}.}
+  ) do |d|
+    options[:preserve_settings] = d
+  end
+end.parse!
+
+Cli.new(
+  options[:directory_path],
+  options[:remote_address],
+  user: options[:user],
+  path_on_remote: options[:path_on_remote],
+  pull: options[:pull],
+  rsync_options: options[:rsync_options],
+  guard_ignore_pattern: options[:ignore_pattern],
+  preserve_settings: options[:preserve_settings]
+).watch

data/lib/directory_push/version.rb

@@ -0,0 +1,3 @@
+module DirectoryPush
+  VERSION = '0.0.1'
+end

data/lib/directory_push.rb

@@ -0,0 +1,251 @@
+require File.expand_path('../directory_push/version', __FILE__)
+require 'highline'
+require 'yaml'
+require 'etc'
+require 'fileutils'
+require 'rsync'
+
+
+module DirectoryPush
+  class Cli
+    attr_reader(
+      :directory_path,
+      :path_on_remote,
+      :user,
+      :remote_address,
+      :rsync_options,
+      :settings_dir_path
+    )
+
+    FILTER_FILE_NAME = '.rsync-filter'
+      DEFAULT_RSYNC_OPTIONS = [
+      '--verbose',
+      '--archive',
+      '--compress',
+      '--progress',
+      %Q{--exclude-from '#{FILTER_FILE_NAME}'},
+      %Q{--timeout '9999'}
+    ]
+    GUARDFILE_TEXT = %q{
+require 'yaml'
+require 'guard/compat/plugin'
+require 'rsync'
+
+config = YAML.load(File.read(File.join(File.dirname(__FILE__), 'config.yml')))
+$rsync_options = config.delete(:rsync)
+$rsync_options << '--delete'
+$source = config.delete(:source)
+ignore_pattern = config.delete(:ignore)
+$remote = %Q{#{config.delete(:user)}@#{config.delete(:remote_address)}:"#{config.delete(:destination)}"}
+
+module ::Guard
+  class DirectoryPush < Plugin
+    private
+    def sync()
+      Compat::UI.info %Q{Guard::DirectoryPush source: "#{$source}", destination: "#{$remote}", options: #{$rsync_options}}
+      result = Rsync.run $source, $remote, $rsync_options
+      if result.success?
+        result.changes.each do |change|
+          Compat::UI.info "#{change.filename} (#{change.summary})"
+        end
+      else
+        Compat::UI.error result.error
+        raise result.error
+      end
+    end
+
+    public
+
+    alias_method :start, :sync
+    alias_method :stop, :sync
+    alias_method :reload, :sync
+    alias_method :run_all, :sync
+    def run_on_additions(paths)
+      Compat::UI.info "Guard::DirectoryPush Files created: #{paths}"
+      sync
+    end
+    def run_on_modifications(paths)
+      Compat::UI.info "Guard::DirectoryPush Files changed: #{paths}"
+      sync
+    end
+    def run_on_removals(paths)
+      Compat::UI.info "Guard::DirectoryPush Files removed: #{paths}"
+      sync
+    end
+  end
+end
+
+config[:verbose] = true
+config[:cli] = '--color'
+config[:sync_on_start] = true
+
+directories [$source]
+guard 'directory-push', config do
+  watch %r{^.+$}
+  if ignore_pattern
+    ignore ignore_pattern
+  end
+end
+}
+
+    DEFAULT_USER = Etc.getlogin
+
+    def initialize(
+        directory_path,
+        remote_address,
+        user: DEFAULT_USER,
+        path_on_remote: nil,
+        pull: false,
+        rsync_options: DEFAULT_RSYNC_OPTIONS,
+        guard_ignore_pattern: nil,
+        preserve_settings: false
+    )
+      if (
+        remote_address.nil? ||
+        remote_address.empty? ||
+        remote_address == '~' ||
+        remote_address == '$HOME'
+      )
+        raise ArgumentError.new(
+          %Q{Remote address, "#{remote_address}", is invalid!}
+        )
+      end
+
+      @directory_path = File.expand_path(directory_path, Dir.pwd)
+      unless File.exists?(@directory_path)
+        raise ArgumentError.new(
+          %Q{Directory "#{@directory_path}" does not exist!}
+        )
+      end
+
+      @user = user
+      if @user.nil? || @user.empty?
+        raise ArgumentError.new(%Q{User "#{@user}" is invalid!.})
+      end
+
+      @remote_address = remote_address
+      @path_on_remote = path_on_remote || @directory_path
+      @terminal = HighLine.new
+      @pull = pull
+      @rsync_options = rsync_options
+      @guard_ignore_pattern = guard_ignore_pattern
+      @preserve_settings = preserve_settings
+      @settings_dir_path = File.join(
+        Dir.pwd,
+        ".#{directory_name}.directory_push-settings"
+      )
+    end
+
+    def pull?() @pull end
+
+    def directory_name() File.basename(@directory_path) end
+
+    def ensure_setting_dir_present()
+      unless File.directory?(settings_dir_path)
+        @terminal.say("Creating settings directory, \"#{settings_dir_path}\".")
+        FileUtils.mkdir(settings_dir_path)
+      end
+    end
+
+    def filter_path() File.join(settings_dir_path, FILTER_FILE_NAME) end
+    def config_path() File.join(settings_dir_path, 'config.yml') end
+    def guardfile_path() File.join(settings_dir_path, 'Guardfile') end
+
+    def ensure_filter_file_present()
+      ensure_setting_dir_present
+      @terminal.say("Creating rsync-filter file")
+      gitignore = File.join(@directory_path, '.gitignore')
+      if File.exists?(gitignore)
+         @terminal.say(
+          %Q{Using "#{gitignore}" as rsync-filter since they have the same format.}
+        )
+        FileUtils.cp(gitignore, filter_path)
+      else
+        FileUtils.touch(filter_path) unless File.exist?(filter_path)
+      end
+    end
+
+    def config()
+      {
+        source: "#{@directory_path}/",
+        user: @user,
+        remote_address: @remote_address,
+        destination: @path_on_remote,
+        rsync: @rsync_options,
+        ignore: @guard_ignore_pattern
+      }
+    end
+
+    def config_to_yml() YAML.dump(config) end
+
+    def ensure_config_file_present()
+      ensure_setting_dir_present
+      unless File.exist?(config_path)
+        @terminal.say %Q{Creating config file in "#{config_path}".}
+        File.open(config_path, 'w') { |f| f.print config_to_yml }
+      end
+    end
+
+    def ensure_guardfile_present()
+      ensure_setting_dir_present
+      unless File.exist?(guardfile_path)
+        @terminal.say %Q{Creating Guardfile in "#{guardfile_path}".}
+        File.open(guardfile_path, 'w') { |f| f.print GUARDFILE_TEXT }
+      end
+    end
+
+    def pull_from_remote(destination)
+      source = "#{@user}@#{@remote_address}:#{@path_on_remote}"
+
+      @terminal.say %Q{Pulling from "#{source}" and replacing the contents of "#{destination}".}
+
+      sync source, destination
+    end
+
+    def sync(source, destination)
+      result = Rsync.run source, destination, @rsync_options
+      if result.success?
+        result.changes.each do |change|
+          @terminal.say "#{change.filename} (#{change.summary})"
+        end
+      else
+        @terminal.say result.error
+      end
+    end
+
+    def backup_dir_path(d)
+      File.join settings_dir_path, "#{File.basename(d)}.bak"
+    end
+
+    def watch()
+      ensure_config_file_present
+      ensure_guardfile_present
+      ensure_filter_file_present
+      Dir.chdir settings_dir_path do |d|
+        if pull?
+          directory_path_bak = backup_dir_path(@directory_path)
+          @terminal.say %Q{Backing up "#{@directory_path}" in "#{directory_path_bak}".}
+          FileUtils.cp_r @directory_path, directory_path_bak
+
+          pull_from_remote @directory_path
+        else
+          source = "#{@user}@#{@remote_address}:#{@path_on_remote}/"
+          source_bak = backup_dir_path(@path_on_remote)
+
+          @terminal.say %Q{Backing up "#{source}" in "#{source_bak}".}
+          sync source, source_bak
+        end
+
+        @terminal.say "Starting Guard"
+        command = "guard"
+        @terminal.say command
+        system command
+      end
+
+      unless @preserve_settings
+        @terminal.say %Q{Removing settings directory, "#{settings_dir_path}".}
+        FileUtils.rm_rf(settings_dir_path)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: directory_push
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dustin Morrill
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-shell
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-compat
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rsync
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- dmorrill10@gmail.com
+executables:
+- directory_push
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- directory_push.gemspec
+- exe/directory_push
+- lib/directory_push.rb
+- lib/directory_push/version.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.6.11
+signing_key: 
+specification_version: 4
+summary: 'DirectoryPush: Push file changes to a remote server.'
+test_files: []