grsync 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de99ffe827d1c73cbf2cecb80105944f169372f8
-  data.tar.gz: d9b4eabba343b0cf73b1153a1f8b3c001ffeb373
+  metadata.gz: 777a138f95c8f7fc7510a0736a5c6ad1573b8e2a
+  data.tar.gz: 050b44659cd12abe1710f595df19298c5051022f
 SHA512:
-  metadata.gz: da04bdd002f65a2ddd4814b76c36a08bcb40d7d793dd9a1d14501de0c2f1f2d295db36a051e93789389e8198e91f43a03178673e1db45c5d3c8416eb84aa977c
-  data.tar.gz: 8e5d2ff12d81960f4711f5bd3d179d0d88987703fd1179d7968910396db005f504a5b9dd97d933243ea51fe9ead68d82ffe1d84a25163feac47cfac3a5fc909d
+  metadata.gz: 8287076f642834a5e0c35acef50f7b0137184c6ad09103f7b81e08f4c2d6f11ff148b64d0816d83969d31568edfe972a52ecdff73c5e6295681edcad4cd9ae89
+  data.tar.gz: b0d88b97cb46368a8b472849e8b00d8863e5a65734e15b79ca2d63332c69dda5312cc6304e2a12242f1f2a4fe1117248ff9b63a514bdf5ba31a0b8479947304e

data/README.md

@@ -0,0 +1,33 @@
+# grsync
+
+A tool to synchronize local and remote git repositories' code.
+
+# why
+
+Imagine you are developing a project which requires complicated dependencies like databases, third party plugins and other systems' API. All of them make your project hard to develop and test since you are unlikely to run it on your local machine.
+
+One feasible way is to develop and test on your server with all issues resolved. Of course you can mount remote server's disks onto your local machine, write some code and run your tests right on the server but the performance of those mounted disks probably would drive you crazy.
+
+So the approach grsync takes is try to apply all changes you've make on the local git repository to the remote one. Although these two repositories are (and have to be) same project and on the same branch, they may have different code changed. So all grsync do is to sync remote repository to your local one making all your local changes easily available on the remote side.
+
+# how grsync works
+
+Simple. Diff the local git repository and apply all changes on the remote git repository (and a hard reset is done before apply to avoid weird state).
+
+# usage
+
+Options:
+```
+  -l, --local=<s>     local source git repository(e.g. /path/to/repo)
+  -r, --remote=<s>    remote destination git repository(e.g.
+                      username@host:/path/to/repo)
+  -p, --passwd=<s>    password for ssh login
+  -o, --port=<i>      port for ssh login (default: 22)
+  -s, --save          save this synchronization link(not implemented yet)
+  -h, --help          Show this message
+```
+
+Example:
+`grsync --local /home/tom/myproj --remote allen@remotehost:/projects/myproj --passwd hellowld`
+
+The command above synchronizes remote `allen@remotehost:/projects/myproj` to local `/home/tom/myproj`.

data/bin/grsync

@@ -3,6 +3,7 @@
 require 'bundler/setup'
 require 'net/ssh'
 require 'trollop'
+require 'json'
 
 require 'grsync'
 require 'grsync/logger'
@@ -14,6 +15,10 @@ require 'grsync/logger'
 #   --passwd barabara
 #   --port 2222
 
+module GRSync
+    RecordFilePath = '~/.grsync'
+end
+
 # parse arguments
 opts = Trollop::options do
     opt :local, 'local source git repository(e.g. /path/to/repo)', :type => :string
@@ -23,13 +28,64 @@ opts = Trollop::options do
     opt :save, 'save this synchronization link'
 end
 
-local = opts[:local]
-remote_full = opts[:remote] # location with username, host and path
+# if neither local repo or remote repo are given
+# read arguments from the record file
+if opts[:local].nil? and opts[:remote].nil?
+    record_file_path = File.expand_path(GRSync::RecordFilePath)
+    unless File.exist? record_file_path
+        $Log.info 'Run without --local and --remote arguments. ' <<
+                      "Tried to read the record file #{record_file_path} but it's not found."
+        Trollop::die :local, 'must be specified when record file is unavailable'
+    end
+
+    # read meta data from record file
+    record = JSON.parse(File.read(record_file_path))
+    local = record['local']
+    user_name = record['user_name']
+    host = record['host']
+    remote = record['remote']
+    passwd = record['passwd']
+    port = record['port']
+
+# read arguments from command line
+else
+    local = opts[:local]
+    remote_full = opts[:remote] # location with username, host and path
+
+    Trollop::die :local, 'must be specified' if local.nil?
+    Trollop::die :remote, 'must be specified' if remote_full.nil?
+
+    # extract remote, user_name and host from dest_full
+    login_str, remote = remote_full.split ':'
+    if login_str.split('@').size == 2
+        user_name, host = login_str.split('@')
+    else
+        user_name = nil
+        host = login_str
+    end
 
-# since save feature is unimplemented
-# both local and remote option have to be specified for an explicit synchronization
-Trollop::die :local, 'must be specified' if local.nil?
-Trollop::die :remote, 'must be specified' if remote_full.nil?
+    # optional options for login
+    passwd = opts[:passwd] || ''
+    port = opts[:port]
+
+    # save sync meta data into record file if -save flag specified
+    if opts[:save]
+        # collect meta data
+        meta = {
+            :local => local,
+            :user_name => user_name,
+            :host => host,
+            :remote => remote,
+            :passwd => passwd,
+            :port => port
+        }
+
+        # write meta into record file
+        File.open(File.expand_path(GRSync::RecordFilePath), mode='w') do |file|
+            file.write JSON.dump(meta)
+        end
+    end
+end
 
 # local dir must exist
 # always check existence asap
@@ -38,19 +94,6 @@ unless Dir.exist?(File.expand_path(local))
     abort
 end
 
-# extract remote, user_name and host from dest_full
-login_str, remote = remote_full.split ':'
-if login_str.split('@').size == 2
-    user_name, host = login_str.split('@')
-else
-    host = login_str
-    user_name = nil
-end
-
-# optional options for login
-passwd = opts[:passwd] || ''
-port = opts[:port]
-
 # ssh login
 begin
     Net::SSH.start(host, user_name, :password => passwd, :port => port) do |ssh|

data/grsync.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
     spec.authors       = ['luminocean']
     spec.email         = ['luminocean@foxmail.com']
 
-    spec.summary       = 'development code synchronization tool'
+    spec.summary       = 'A tool to synchronize local and remote git repositories\' code'
     spec.files         = `git ls-files`.split("\n")
     spec.bindir        = 'bin'
     spec.executables   = ['grsync']

data/lib/grsync.rb

@@ -33,19 +33,24 @@ module GRSync
         def reset_remote_repo
             @ssh.exec! "cd #{@remote_path} && git reset --hard" do |ch, stream, data|
                 if stream == :stderr and data.to_s != '' # check for nil or ''
-                    raise GitResetException, "reset failed: #{data}"
+                    raise GitResetException, "Reset failed: #{data}"
                 end
             end
         end
 
         def apply_diff_to_remote(diff_text)
+            # remove trailing spaces from diff text
+            # very important because trailing spaces would cause git apply failure
+            no_trailing_diff_text = []
+            diff_text.split("\n").each{|line| no_trailing_diff_text << line.rstrip }
+
             # be careful, string in ruby may not be used safely in shell directly
             # so here's a conversion
-            echoable_text = Shellwords.escape diff_text
+            echoable_text = Shellwords.escape no_trailing_diff_text.join("\n")
 
-            result = @ssh.exec! "cd #{@remote_path} && echo #{echoable_text} | git apply -"
+            result = @ssh.exec! "cd #{@remote_path} && (echo #{echoable_text} | git apply -)"
             # diff fails if something other than empty string returns
-            raise GitDiffApplyException, "apply failed: #{result}" if result != ''
+            raise GitDiffApplyException, "Apply failed: #{result}" if result != ''
         end
 
         # diff the local git repository and returns the diff text for later use

data/lib/grsync/version.rb

@@ -1,3 +1,3 @@
 module GRSync
-  VERSION = '0.0.2'
+  VERSION = '0.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grsync
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - luminocean
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-21 00:00:00.000000000 Z
+date: 2016-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trollop
@@ -76,6 +76,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - Gemfile
+- README.md
 - bin/grsync
 - grsync.gemspec
 - lib/grsync.rb
@@ -104,5 +105,5 @@ rubyforge_project:
 rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
-summary: development code synchronization tool
+summary: A tool to synchronize local and remote git repositories' code
 test_files: []