rbsync 0.0.5 → 0.0.6

data/README.rdoc

@@ -1,44 +1,81 @@
 = rbsync
+ Synchronize files src to dest . 
+ this class can sync files and recuresively
+ options are
+ +sync update file only
+ +no overwrite when dist files are newer than src
+ +sync by file digest hash , not useing filename
 
-rbsync is sync files utility
-== usage
-=== mirror files
-同期元と同期先を同じにする
-          require 'rbsync'
-          rsync =RbSync.new
-          rsync.sync( "src", "dest" )
-=== mirror updated only files
-同期先に、同期元と同名のファイルがあったら、更新日時を調べる。新しいモノだけをコピーする．
-          require 'rbsync'
-          rsync =RbSync.new
-          rsync.sync( "src", "dest",{:update=>true} )
-=== using exclude pattern
-同期先と同期元を同じにする，但し、*.rb / *.log の拡張子は除外する．
-          require 'rbsync'
-          rsync =RbSync.new
-          rsync.sync( "src", "dest",{:excludes=>["*.log","*.bak"]} )
-==special usage , sync by file cotetets 
-if directory has a same file with different file name. insted of filename , sync file by file hash
-ディレクトリ内のファイル名をうっかり変えてしまったときに使う．ファイル名でなく、ファイルの中身を比較して同期する．
-          require 'rbsync'
-          rsync =RbSync.new
-          rsync.sync( "src", "dest",{:check_hash=>true} )
-=== directory has very large file ,such as mpeg video
-checking only head of 1024*1024 bytes to distinguish src / dest files.this is for speed up.
-FileUtils::cmp is reading whole file. large file will take time.With :hash_limit_size Rbsync read only head of files for comparing.
-巨大なファイルだと，全部読み込むのに時間が掛かるので、先頭1024*1024 バイトを比較してOKとする.写真とかはコレで十分
-          require 'rbsync'
-          rsync =RbSync.new
-          rsync.sync( "src", "dest",{:check_hash=>true,:hash_limit_size=1024*1024} )
+ == usage
+ === mirror files
+ 同期元と同期先を同じにする
+           require 'rbsync'
+           rsync =RbSync.new
+           rsync.sync( "src", "dest" )
+ === mirror updated only files
+ 同期先に、同期元と同名のファイルがあったら、更新日時を調べる。新しいモノだけをコピーする．
+           require 'rbsync'
+           rsync =RbSync.new
+           rsync.sync( "src", "dest",{:update=>true} )
+ === using exclude pattern
+ 同期先と同期元を同じにする，但し、*.rb / *.log の拡張子は除外する．
+           require 'rbsync'
+           rsync =RbSync.new
+           rsync.sync( "src", "dest",{:excludes=>["*.log","*.bak"]} )
+ == sync by another name  if file name confilicts
+ send src file with anothername. when file name confilicts
+ 名前が衝突した場合で、ファイルを書換える時は，転送元のファイルを別名で転送する
+ windows のファイルコピーっぽい動作
+ before sync
+ |src  | test.txt | 2011-06-14
+ |dest | test.txt | 2011-06-12
+ after sync
+ |src  | test.txt    | 2011-06-14
+ |dest | test(1).txt | 2011-06-14 # same to src
+ |dest | test.txt    | 2011-06-12
+ == sync with backup 
+ 名前が衝突した場合で、ファイルを書換える場合転送先のファイルを別名で保存してから転送する
+ before sync
+ |src  | test.txt | 2011-06-14
+ |dest | test.txt | 2011-06-12
+ after sync
+ |src  | test.txt                   | 2011-06-14
+ |dest | test.txt                   | 2011-06-14 # same to src
+ |dest | test_20110614022255.txt    | 2011-06-12 # moved
 
-=== sync both updated files
-双方向に同期させたい場合は２回起動する．
-          require 'rbsync'
-          rsync =RbSync.new
-          rsync.updated_file_only = true
-          rsync.sync( "src", "dest" )
-          rsync.sync( "dest", "src" )
 
+ ==special usage , sync by file cotetets 
+ if directory has a same file with different file name. insted of filename , sync file by file hash
+ when files are theses,
+  |src| test.txt | "47bce5c74f589f4867dbd57e9ca9f808" |
+  |dst| test.bak | "47bce5c74f589f4867dbd57e9ca9f808" |
+ :check_hash results no effect.
+ ディレクトリ内のファイル名をうっかり変えてしまったときに使う．ファイル名でなく、ファイルの中身を比較して同期する．
+  |src| test.txt | "47bce5c74f589f4867dbd57e9ca9f808" |
+  |dst| test.bak | "47bce5c74f589f4867dbd57e9ca9f808" |
+ の場合何もおきません
+           require 'rbsync'
+           rsync =RbSync.new
+           rsync.sync( "src", "dest",{:check_hash=>true} )
+ === directory has very large file ,such as mpeg video
+ using with :check_hash=>true
+ checking only head of 1024*1024 bytes to distinguish src / dest files.this is for speed up.
+ FileUtils::cmp is reading whole file. large file will take time.With :hash_limit_size Rbsync read only head of files for comparing.
+ 巨大なファイルだと，全部読み込むのに時間が掛かるので、先頭1024*1024 バイトを比較してOKとする.写真とかはコレで十分
+ ファイル名を書換えてしまってコンテンツ内容の比較だけで使う。
+ :check_hash=>true とペアで使います
+           require 'rbsync'
+           rsync =RbSync.new
+           rsync.sync( "src", "dest",{:check_hash=>true,:hash_limit_size=1024*1024} )
+ 
+ === sync both updated files
+ To sync both, call sync methods twice 
+ 双方向に同期させたい場合は２回起動する．
+           require 'rbsync'
+           rsync =RbSync.new
+           rsync.updated_file_only = true
+           rsync.sync( "src", "dest" )
+           rsync.sync( "dest", "src" )# swap src to dest , dest to src
 == Contributing to rbsync
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet

data/VERSION

@@ -1 +1 @@
-0.0.5
+0.0.6

data/lib/rbsync.rb

@@ -1,8 +1,5 @@
 # encoding: utf-8
 
-#rbsyncの改良版。
-# ファイル名でなくハッシュ値を計算してファイルを同期する。
-#ファイルの同期
 
 require 'fileutils'
 
@@ -29,27 +26,60 @@ require 'fileutils'
 #           require 'rbsync'
 #           rsync =RbSync.new
 #           rsync.sync( "src", "dest",{:excludes=>["*.log","*.bak"]} )
+# == sync by another name  if file name confilicts
+# 名前が衝突した場合で、ファイルを書換える時は，転送元のファイルを別名で転送する
+# windows のファイルコピーっぽい動作
+# send src file with anothername.
+# before sync
+# |src  | test.txt | 2011-06-14
+# |dest | test.txt | 2011-06-12
+# after sync
+# |src  | test.txt    | 2011-06-14
+# |dest | test(1).txt | 2011-06-14 # same to src
+# |dest | test.txt    | 2011-06-12
+# == sync with backup 
+# 名前が衝突した場合で、ファイルを書換える場合転送先のファイルを別名で保存してから転送する
+# before sync
+# |src  | test.txt | 2011-06-14
+# |dest | test.txt | 2011-06-12
+# after sync
+# |src  | test.txt                   | 2011-06-14
+# |dest | test.txt                   | 2011-06-14 # same to src
+# |dest | test_20110614022255.txt    | 2011-06-12 # moved
+#
+#
 # ==special usage , sync by file cotetets 
 # if directory has a same file with different file name. insted of filename , sync file by file hash
+# when files are theses,
+#  |src| test.txt | "47bce5c74f589f4867dbd57e9ca9f808" |
+#  |dst| test.bak | "47bce5c74f589f4867dbd57e9ca9f808" |
+# :check_hash results no effect.
 # ディレクトリ内のファイル名をうっかり変えてしまったときに使う．ファイル名でなく、ファイルの中身を比較して同期する．
+#  |src| test.txt | "47bce5c74f589f4867dbd57e9ca9f808" |
+#  |dst| test.bak | "47bce5c74f589f4867dbd57e9ca9f808" |
+# の場合何もおきません
 #           require 'rbsync'
 #           rsync =RbSync.new
 #           rsync.sync( "src", "dest",{:check_hash=>true} )
 # === directory has very large file ,such as mpeg video
+# using with :check_hash=>true
 # checking only head of 1024*1024 bytes to distinguish src / dest files.this is for speed up.
 # FileUtils::cmp is reading whole file. large file will take time.With :hash_limit_size Rbsync read only head of files for comparing.
 # 巨大なファイルだと，全部読み込むのに時間が掛かるので、先頭1024*1024 バイトを比較してOKとする.写真とかはコレで十分
+# ファイル名を書換えてしまってコンテンツ内容の比較だけで使う。
+# :check_hash=>true とペアで使います
 #           require 'rbsync'
 #           rsync =RbSync.new
 #           rsync.sync( "src", "dest",{:check_hash=>true,:hash_limit_size=1024*1024} )
 # 
 # === sync both updated files
+# To sync both, call sync methods twice 
 # 双方向に同期させたい場合は２回起動する．
 #           require 'rbsync'
 #           rsync =RbSync.new
 #           rsync.updated_file_only = true
 #           rsync.sync( "src", "dest" )
-#           rsync.sync( "dest", "src" )
+#           rsync.sync( "dest", "src" )# swap src to dest , dest to src
 class RbSync
   attr_accessor :conf
   def initialize()
@@ -165,10 +195,10 @@ class RbSync
   end
   # compute digest md5 
   # ==limitsize
-  #   If file size is very large.
-  #   And  a few byte head of file  is enough to compare.
-  #   for speedup, setting limit size enable to skipp reading file.
-  #   もしファイルがとても巨大で、かつ、先頭の数キロバイトで十分であれば、limitsize 以降をスキップする
+  #   If file size is very large,
+  #   and a few bytes at head of file is enough to compare.
+  #   for speed-up, Set limit size to enable to avoid reading a whole of file.
+  #   もしファイルがとても巨大で、かつ、先頭の数キロバイトが比較に十分であれば、limitsize 以降をスキップする
   def compute_digest_file(filename, limitsize=nil)
       require 'digest/md5'
       s = %{
@@ -190,11 +220,7 @@ class RbSync
       Digest::MD5.open(filename,limitsize).hexdigest
   end
   
-  # ロジックが長すぎるので短くするか別に分ける．
-  # ロジックのパターン毎に共通化する
-  # ・ディレクトリ内のファイル一覧を作る
-  # ・ファイル一覧を比較する
-  # ・同期するファイル一覧を作って転送する
+  # called from sync
   def sync_normally(src,dest,options={})
     files = self.find_files(src,dest,options)
     puts "同期対象のファイルはありません" if self.debug? && files.size==0
@@ -214,8 +240,8 @@ class RbSync
     pp files                      if files.size != 0 && self.debug?
     return files.size == 0
   end
-  # 別名で名前をつけて転送する
-  def sync_by_anothername(src,dest,options)
+  # 同期先に同名ファイルがあったらファイルを別名にバックアップしてから転送します
+  def sync_with_backup(src,dest,options)
     # 上書き付加の場合
     # 
     #ファイル一覧を取得する
@@ -224,10 +250,44 @@ class RbSync
     files = files.reject{|e|
       FileUtils.cmp(File.expand_path(e,src) , File.expand_path(e,dest))
     }
-    #更新日が当たらしifモノを排除
+    #更新日が当たらしいモノを排除
+    if options[:update] then
+      #更新日が当たらしいモノを排除
+      files = files.reject{|e|
+        File.mtime(File.expand_path(e,src)) < File.mtime(File.expand_path(e,dest))
+      }
+    end
+    #別名をつける
+    files = files.map{|e|
+      extname = File.extname(e)
+      basename = File.basename(e).gsub(extname,"")
+        # 同名のファイルがあった場合
+        # ファイルをリネームする
+        if File.exists?(File.expand_path(e,dest)) then
+            candidate = File.expand_path("#{basename}_#{Time.now.strftime('%Y%m%d%H%M%S')}#{extname}",dest)
+            File.rename( File.expand_path(e,dest),candidate )
+        end
+      [File.expand_path(e,src) , File.expand_path(e,dest)]
+    }
+    #コピーする
+    self.copy_r(files)
+  end
+  # 別名で名前をつけて転送する
+  def sync_by_anothername(src,dest,options)
+    # 上書き付加の場合
+    # 
+    #ファイル一覧を取得する
+    files = find_as_relative(src,options[:excludes])
+    #中身が同じモノを排除
     files = files.reject{|e|
-      File.mtime(File.expand_path(e,src)) < File.mtime(File.expand_path(e,dest))
+      FileUtils.cmp(File.expand_path(e,src) , File.expand_path(e,dest))
     }
+    if options[:update] then
+      #更新日が当たらしいモノを排除
+      files = files.reject{|e|
+        File.mtime(File.expand_path(e,src)) < File.mtime(File.expand_path(e,dest))
+      }
+    end
     #別名をつける
     files = files.map{|e|
       extname = File.extname(e)
@@ -260,6 +320,8 @@ class RbSync
     options[:overwrite]       = false                                         if options[:no_overwrite]
     if options[:rename]
       return self.sync_by_anothername(src,dest,options)
+    elsif options[:backup]
+      return self.sync_with_backup(src,dest,options)
     elsif options[:check_hash]
       return self.sync_by_hash(src,dest,options)
     else
@@ -416,3 +478,26 @@ end
     #p FileUtils.cmp("old/test.txt","new/test(2).txt") == true
   #end
 #end
+#require 'tmpdir'
+#require 'find'
+#require 'pp'
+#Dir.mktmpdir('goo') do |dir|
+  #Dir.chdir dir do 
+    #Dir.mkdir("old")
+    #Dir.mkdir("new")
+    ## 同名のファイルを作って
+    #open("./old/test.txt", "w+"){|f| 10.times{f.puts("test")}}
+    #old_content =open("./old/test.txt", "r").read
+    ## ミラーして
+    #rsync = RbSync.new
+    #rsync.sync("old","new")
+    #p FileUtils.cmp("old/test.txt","new/test.txt") == true
+    #open("./old/test.txt", "w+"){|f| 10.times{f.puts("changed")}}
+    ## バックアップ同期する
+    #rsync.sync("old","new",{:backup => true})
+    #p FileUtils.cmp("old/test.txt","new/test.txt") == true
+    ## バックアップしたファイルがどうなっているか見る
+    #files = Dir.glob "./new/**/*"
+    #p old_content == open((files - ["./new/test.txt"]).first).read
+  #end
+#end

data/rbsync.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rbsync}
-  s.version = "0.0.5"
+  s.version = "0.0.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["takuya"]
-  s.date = %q{2011-06-13}
+  s.date = %q{2011-06-14}
   s.description = %q{rbsync is sync file utility.this can sync directory even if filename differed.checking content insted.}
   s.email = %q{takuya.1st@gmail}
   s.extra_rdoc_files = [

data/test/test_rbsync.rb

@@ -125,4 +125,46 @@ class TestRbsync < Test::Unit::TestCase
       end
     end
   end
+  def test_sync_with_rename
+    Dir.mktmpdir('goo') do |dir|
+        Dir.chdir dir do 
+          Dir.mkdir("old")
+          Dir.mkdir("new")
+          open("./old/test.txt", "w+"){|f| 10.times{f.puts("test")}}
+          rsync = RbSync.new
+          rsync.sync("old","new")
+          assert FileUtils.cmp("old/test.txt","new/test.txt") == true
+          open("./old/test.txt", "w+"){|f| 10.times{f.puts("changed")}}
+          rsync.sync("old","new",{:rename => true})
+          assert FileUtils.cmp("old/test.txt","new/test.txt") == false
+          assert FileUtils.cmp("old/test.txt","new/test(1).txt") == true
+          open("./old/test.txt", "w+"){|f| 10.times{f.puts("changed!!!")}}
+          rsync.sync("old","new",{:rename => true})
+          assert FileUtils.cmp("old/test.txt","new/test(2).txt") == true
+        end
+      end
+    end
+   def test_sync_with_backup
+     Dir.mktmpdir('goo') do |dir|
+      Dir.chdir dir do 
+        Dir.mkdir("old")
+        Dir.mkdir("new")
+        # �����̃t�@�C���������
+        open("./old/test.txt", "w+"){|f| 10.times{f.puts("test")}}
+        old_content =open("./old/test.txt", "r").read
+        # �~���[����
+        rsync = RbSync.new
+        rsync.sync("old","new")
+        assert FileUtils.cmp("old/test.txt","new/test.txt") == true
+        open("./old/test.txt", "w+"){|f| 10.times{f.puts("changed")}}
+        # �o�b�N�A�b�v��������
+        rsync.sync("old","new",{:backup => true})
+        assert FileUtils.cmp("old/test.txt","new/test.txt") == true
+        # �o�b�N�A�b�v�����t�@�C�����ǂ��Ȃ��Ă��邩����
+        files = Dir.glob "./new/**/*"
+        assert old_content == open((files - ["./new/test.txt"]).first).read
+      end
+    end
+  end
+
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rbsync
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: 
   segments: 
   - 0
   - 0
-  - 5
-  version: 0.0.5
+  - 6
+  version: 0.0.6
 platform: ruby
 authors: 
 - takuya
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-13 00:00:00 +09:00
+date: 2011-06-14 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency