git-confident 0.0.1

data/README.rdoc

@@ -0,0 +1,61 @@
+= git-confidence - Automate Configuration Backup to a Remote Git repository
+
+* Keep a backup of single files scattered around your file system,
+* Add those files to a Git repository
+* When they change, they get backed up
+* Restore your files
+
+= Requirements
+
+* A remote (preferably non-public) server to push your repository to.
+
+= Multiple Branches for Computers with Similar Configurations
+
+If you are backing up similar configurations from different computers,
+you may want to keep several versions in branches.
+If that is the case, just create the branch locally and check it out.
+
+= Getting Started
+
+== Create a Git Repository of The Files You Want Backed Up
+
+* Create an empty Git repository:
+ $ mkdir ~/my_backup
+ $ git init
+* Add some files, mimicking their full path:
+ $ mkdir -p etc
+ $ cp /etc/hosts etc/
+ $ git add etc/hosts
+* Set up a git repository on your remote server:
+ $ mkdir -p ~/gitpath/my_backup
+ $ cd ~/gitpath/my_backup
+ $ git init --bare
+* Add your remote server as 'origin':
+ $ git remote add origin ssh://my.remote.com/gitpath/my_backup
+* Check commit and push work:
+ $ git commit -m "I'm starting by backing up my /etc/hosts"
+ $ git push
+
+== Set Up a Cron Job
+
+ $ crontab -e
+    13    23     *     *     *     cd ~/my_backup && git-confidence
+
+= Functions
+
+
+= Alternatives
+
+* rsync
+* gitback[http://github.com/brycethornton/gitback] - very similar to this project, but sets up the repository from a config file.
+* Desktop backup systems
+* Time machine (on OS X)
+
+= TODO
+
+Restore:
+
+if options[ :restore ]
+  `rsync -av --no-p --no-g --no-implied-dirs --files-from=- ./ /`
+  exit
+end

data/Rakefile

@@ -0,0 +1,57 @@
+require 'rubygems' if RUBY_VERSION < '1.9'
+require 'rake'
+require 'rake/gempackagetask'
+require 'spec/rake/spectask'
+require 'rake/rdoctask'
+$:.unshift( File.dirname( __FILE__ ) + '/lib' )
+require 'git/confident'
+
+ADMIN_FILES          = FileList[ 'Rakefile', 'README.rdoc' ]
+SOURCE_FILES         = FileList[ 'bin/*', 'lib/**/*.rb' ]
+SPEC_FILES           = FileList[ 'spec/**/*' ]
+RDOC_FILES           = FileList[ 'README.rdoc' ] + SOURCE_FILES
+RDOC_OPTS            = [ '--quiet', '--main', 'README.rdoc', '--inline-source' ]
+
+spec = Gem::Specification.new do |s|
+  s.name             = 'git-confident'
+  s.summary          = 'Automate computer configuration backup'
+  s.description      = 'Provides git-confident'
+  s.version          = Git::Confident::VERSION::STRING
+
+  s.homepage         = 'http://github.com/joeyates/git-confident'
+  s.author           = 'Joe Yates'
+  s.email            = 'joe.g.yates@gmail.com'
+
+  s.files            = ADMIN_FILES +
+                       SOURCE_FILES
+  s.require_paths    = [ 'lib' ]
+  s.add_dependency( 'rake', '>= 0.8.7' )
+  s.add_dependency( 'git', '>= 1.2.5' )
+
+  s.has_rdoc         = true
+  s.rdoc_options     += RDOC_OPTS
+  s.extra_rdoc_files = RDOC_FILES
+
+  s.test_files       = SPEC_FILES
+end
+
+Rake::GemPackageTask.new( spec ) do |pkg|
+end
+
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files       = FileList[ 'spec/**/*_spec.rb' ]
+  t.spec_opts        += [ '--color', '--format specdoc' ]
+end
+
+Spec::Rake::SpecTask.new( 'spec:rcov' ) do |t|
+  t.spec_files       = FileList[ 'spec/**/*_spec.rb' ]
+  t.rcov             = true
+  t.rcov_opts        = [ '--exclude spec' ]
+end
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir      = 'html'
+  rdoc.options       += RDOC_OPTS
+  rdoc.title         = 'Automate computer configuration backup'
+  rdoc.rdoc_files.add RDOC_FILES
+end

data/bin/git-confident

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+
+require 'rubygems' if RUBY_VERSION < '1.9'
+require 'optparse'
+ROOT_PATH = File.dirname( File.expand_path( File.dirname( __FILE__ ) ) )
+LIB_PATH  = File.join( ROOT_PATH, 'lib' )
+$:.unshift( LIB_PATH )
+require 'git/confident'
+
+options = {
+  :restore => false,
+  :commit  => true,
+  :path    => File.expand_path( Dir::pwd ) # Default to current directory
+}
+options[ :path ] = '/Users/joe/setup/client'
+
+OptionParser.new do | opts |
+  opts.banner = "Usage: $0 [options]"
+
+  opts.on("-C", "--no-commit", "Only copy files, do not do a git commit") do
+    options[:commit] = false
+  end
+
+  opts.on("-p", "--path PATH", "The path to the local copy of the repository. Defaults to current directory") do | path |
+    options[ :path ] = File.expand_path( path )
+  end
+
+  opts.on("-r", "--restore", "Restore system files from the repository") do
+    options[ :restore ] = true
+  end
+end.parse!
+
+conf = Git::Confident.new( options[ :path ] )
+conf.local_backup
+conf.commit
+conf.push

data/lib/git/confident.rb

@@ -0,0 +1,45 @@
+require 'rubygems' if RUBY_VERSION < '1.9'
+require 'git'
+
+module Git
+
+  class Confident < ::Git::Base
+
+    module VERSION #:nodoc:
+      MAJOR = 0
+      MINOR = 0
+      TINY  = 1
+ 
+      STRING = [ MAJOR, MINOR, TINY ].join( '.' )
+    end
+
+    def initialize( path )
+      raise "Git repository not found at '#{ path }'" if ! File.directory?( "#{ path }/.git" )
+      @path = path.clone
+      super( { :working_directory => @path } )
+    end
+
+    def files
+      ls_files.keys.sort
+    end
+
+    def local_backup
+      IO.popen( "rsync -av --files-from=- / #{ @path }/", "w+" ) do | pipe |
+        files.each { | pathname | pipe.puts pathname }
+      end
+    end
+
+    def commit
+      needs_commit = status.changed.size > 0
+      return if ! needs_commit
+      add
+      super( "Automatic commit at #{ Time.now }" )
+    end
+
+    def push
+      super( 'origin', lib.branch_current )
+    end
+
+  end
+
+end

data/spec/git_spec.rb

@@ -0,0 +1,29 @@
+require 'rubygems' if RUBY_VERSION < '1.9'
+require 'spec'
+require 'git'
+
+SPEC_PATH = File.expand_path( File.dirname( __FILE__ ) )
+ROOT_PATH = File.dirname( SPEC_PATH )
+require File.join( ROOT_PATH, 'lib', 'git', 'confident' )
+
+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'
+  end
+
+  after( :each ) do
+    `rm -rf '#{ @repo_path }'`
+  end
+
+  it 'lists files' do
+    conf = Git::Confident.new( @repo_path )
+    conf.files.should == [ 'test_file' ]
+  end
+
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification 
+name: git-confident
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Joe Yates
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-02 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 49
+        segments: 
+        - 0
+        - 8
+        - 7
+        version: 0.8.7
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: git
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 1
+        - 2
+        - 5
+        version: 1.2.5
+  type: :runtime
+  version_requirements: *id002
+description: Provides git-confident
+email: joe.g.yates@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- bin/git-confident
+- lib/git/confident.rb
+files: 
+- Rakefile
+- README.rdoc
+- bin/git-confident
+- lib/git/confident.rb
+- spec/git_spec.rb
+has_rdoc: true
+homepage: http://github.com/joeyates/git-confident
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --quiet
+- --main
+- README.rdoc
+- --inline-source
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Automate computer configuration backup
+test_files: 
+- spec/git_spec.rb