git-confident 0.0.6 → 0.0.7

data/README.rdoc

@@ -41,6 +41,23 @@ If that is the case, just create the branch locally and check it out.
  $ crontab -e
     13    23     *     *     *     cd ~/my_backup && git-confident
 
+= Advanced Use
+
+== Ignore files and folders
+You can store extra files in your backup repository (like text notes) adding them to a .gcignore file:
+ $ echo SETUP_NOTES >> .gcignore
+ $ git add .gcignore
+so git-confident won't restore them. Similarly to .gitignore behaviour, you can ignore an entire folder
+by adding a .gcignore file inside it.
+
+
+== Folder scan
+git-confident keeps a copy of each file added to git. This is not very useful when you have
+an entire folder to backup. You can track a whole folder using a .gcrecusrive file (acts like .gitignore):
+ $ touch etc/apache2/.gcrecusive
+ $ git add etc/apache2/.gcrecusive
+
+
 = Online
 
 * {Source code}[http://github.com/joeyates/git-confident]

data/lib/git/confident.rb

@@ -1,5 +1,6 @@
 require 'rubygems' if RUBY_VERSION < '1.9'
 require 'git'
+require 'git/elements'
 
 module Git
 
@@ -8,11 +9,13 @@ module Git
     module VERSION #:nodoc:
       MAJOR = 0
       MINOR = 0
-      TINY  = 6
+      TINY  = 7
  
       STRING = [ MAJOR, MINOR, TINY ].join( '.' )
     end
 
+    attr_reader :elements
+
     def initialize( options )
       @path      = options[ :path ].clone
       @no_commit = options[ :no_commit ] ? true : false
@@ -20,21 +23,23 @@ module Git
       raise "Git repository not found at '#{ @path }'" if ! File.directory?( "#{ @path }/.git" )
 
       super( { :working_directory => @path } )
+      @elements = Git::Elements.new( @path )
 
       case options[ :action ]
       when :backup
         backup
       when :list
-        puts files
+        puts "Files:"
+        puts @elements.files
+        puts "Folders:"
+        puts @elements.folders
+        puts "Ignored:"
+        puts @elements.ignored
       when :restore
         restore
       end     
     end
 
-    def files
-      ls_files.keys.sort
-    end
-
     private
 
     def backup
@@ -45,22 +50,22 @@ module Git
     end
 
     def restore
-      IO.popen( "rsync --no-perms --executability --keep-dirlinks --files-from=- #{ @path }/ /", "w+" ) do | pipe |
-        files.each { | pathname | pipe.puts pathname }
+      IO.popen( "rsync --no-perms --executability --keep-dirlinks --delete --files-from=- #{ @path }/ /", "w+" ) do | pipe |
+        (@elements.files + @elements.folders).each { | pathname | pipe.puts pathname }
       end
     end
 
     def local_backup
-      IO.popen( "rsync -av --files-from=- / #{ @path }/", "w+" ) do | pipe |
-        files.each { | pathname | pipe.puts pathname }
+      IO.popen( "rsync -a --recursive --delete --files-from=- / #{ @path }/", "w+" ) do | pipe |
+        (@elements.files + @elements.folders).each { | pathname | pipe.puts pathname }
       end
     end
 
     def commit
-      needs_commit = status.changed.size > 0
+      needs_commit = (status.changed.size + status.untracked.size) > 0
       return if ! needs_commit
       add
-      super( "Automatic commit at #{ Time.now }" )
+      super( "Automatic commit at #{ Time.now }", {:add_all => true} )
     end
 
     def push

data/lib/git/elements.rb

@@ -0,0 +1,69 @@
+require 'rubygems' if RUBY_VERSION < '1.9'
+require 'git'
+
+module Git
+
+  class Elements < Git::Base
+    IGNORE    = 'gcignore'
+    RECURSIVE = 'gcrecursive'
+
+    def initialize( path )
+      @path = path.clone
+      super( { :working_directory => @path } )
+      @gcfiles, @gitfiles = elements_scan
+    end
+
+    def ignored
+      return @ignored if @ignored
+      ignores = @gcfiles.select do | f |
+        File.basename( f ) =~ /^\.#{IGNORE}$/i
+      end
+      @ignored = gcfiles_scan( ignores )
+    end
+
+    def folders
+      return @folders if @folders
+      recursives = @gcfiles.select do | f |
+        File.basename( f ) =~ /^\.#{RECURSIVE}$/i
+      end
+      @folders = gcfiles_scan( recursives ).collect { |f| File.join f, '/' }
+    end
+
+    def files
+      return @files if @files
+      @files = @gitfiles.reject do | f |
+        (ignored + folders).find { |i| f =~ /^#{i}/ }
+      end.sort
+    end
+
+
+    private
+
+    # result[0] = git-confident special files
+    # result[1] = other git tracked files
+    def elements_scan
+      result = ls_files.keys.sort.partition do | f |
+        name = File.basename( f )
+        name =~ /^\.#{IGNORE}$/i or name =~ /^\.#{RECURSIVE}$/i or name =~ /^\.gitignore$/i
+      end
+    end
+
+    def gcfiles_scan( files )
+      files.collect do | file |
+        full_path = File.expand_path( file, @path )
+        relative_path = File.dirname( file )
+
+        next [relative_path] if File.zero?( full_path )
+
+        File.open( full_path ).collect do | line |
+          line.chomp!
+          next if line.empty?
+          next line if relative_path == '.'
+          File.join( relative_path, line )
+        end.compact
+      end.flatten.sort
+    end
+
+  end
+
+end

data/spec/git_spec.rb

@@ -6,24 +6,83 @@ SPEC_PATH = File.expand_path( File.dirname( __FILE__ ) )
 ROOT_PATH = File.dirname( SPEC_PATH )
 require File.join( ROOT_PATH, 'lib', 'git', 'confident' )
 
+Joiner = lambda do |base|
+  lambda do |*others|
+    File.join(base, *others)
+  end
+end
+
 describe 'when handling the repository' do
 
-  before( :each ) do
-    @repo_path = File.join( SPEC_PATH, 'repo' )
-    repo = Git::Base.init( @repo_path )
-    File.open( File.join( @repo_path, 'test_file' ), 'w' ) do | file |
-      file.write "Hello"
-    end
-    repo.add 'test_file'
+  before( :all ) do
+    @backup_path = Joiner[ SPEC_PATH ][ 'gcbkp' ]
+    @source_path = Joiner[ 'tmp' ][ 'gcsrc' ]
+    @backup_join = Joiner[ @backup_path ]
+    @source_join = Joiner[ @source_path ]
+    repo = Git::Base.init( @backup_path )
+
+    test_files = [ 'file',
+                    'folder/file2',
+                    'folder/file3',
+                    'folder/folder2/file4',
+                    'folder/folder2/file5',
+                    'folder/folder3/file6',
+                    'folder/folder3/file7',
+                    'ignore_me' ]
+    FileUtils.mkdir_p( @backup_join[ @source_path, 'folder/folder2' ] )
+    FileUtils.mkdir_p( @backup_join[ @source_path, 'folder/folder3' ] )
+    test_files.each { |tf| File.open( @backup_join[ @source_path, tf ], 'w' ) }
+    File.open( @backup_join[ @source_path, 'folder/folder3/.gcignore' ], 'w' ) { |file| file.write 'file7' }
+    File.open( @backup_join[ '.gcignore' ], 'w' ) { |file| file.write <<ASD
+#{@source_join[ 'ignore_me' ]}
+#{@source_join[ 'wrong_file' ]}
+ASD
+    }
+    File.open( @backup_join[ '.gcrecursive' ], 'w' ) { |file| file.write @source_join[ 'folder/folder2' ] }
+    repo.add '*'
   end
 
-  after( :each ) do
-    `rm -rf '#{ @repo_path }'`
+  after( :all ) do
+    `rm -rf '#{ @backup_path }'`
+    `rm -rf '/#{ @source_path }'`
   end
 
   it 'lists files' do
-    conf = Git::Confident.new( @repo_path )
-    conf.files.should == [ 'test_file' ]
+    conf = Git::Confident.new( :path => @backup_path )
+    expected = [ 'file',
+                 'folder/file2',
+                 'folder/file3',
+                 'folder/folder3/file6' ]
+    conf.elements.files.should == expected.collect { |e| @source_join[ e ] }
+  end
+
+  it 'lists ignored files' do
+    conf = Git::Confident.new( :path => @backup_path )
+    expected = [ 'folder/folder3/file7',
+                 'ignore_me',
+                 'wrong_file' ]
+    conf.elements.ignored.should == expected.collect { |e| @source_join[ e ] }
+  end
+
+  it 'lists recursive folders' do
+    conf = Git::Confident.new( :path => @backup_path )
+    conf.elements.folders.should == [ @source_join[ 'folder/folder2/' ] ]
+  end
+
+  it 'restores backup' do
+    conf = Git::Confident.new( :path => @backup_path, :action => :restore )
+    source_abs_join = Joiner[ '/' + @source_path ]
+    restored = Dir.glob( source_abs_join[ '**/*' ] )
+    expected = [ 'file',
+                 'folder',
+                 'folder/file2',
+                 'folder/file3',
+                 'folder/folder2',
+                 'folder/folder2/file4',
+                 'folder/folder2/file5',
+                 'folder/folder3',
+                 'folder/folder3/file6' ]
+    restored.sort.should == expected.collect { |e| source_abs_join[ e ] }.sort
   end
 
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: git-confident
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: false
   segments: 
   - 0
   - 0
-  - 6
-  version: 0.0.6
+  - 7
+  version: 0.0.7
 platform: ruby
 authors: 
 - Joe Yates
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-23 00:00:00 +01:00
+date: 2010-10-18 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -60,11 +60,13 @@ extra_rdoc_files:
 - README.rdoc
 - bin/git-confident
 - lib/git/confident.rb
+- lib/git/elements.rb
 files: 
 - Rakefile
 - README.rdoc
 - bin/git-confident
 - lib/git/confident.rb
+- lib/git/elements.rb
 - spec/git_spec.rb
 has_rdoc: true
 homepage: http://github.com/joeyates/git-confident