robinsp-backitup 0.0.1 → 0.0.2

data/Manifest

@@ -1,14 +1,18 @@
 bin/backitup
+sample.backitup
 spec/test-config.backitup
 spec/file_packager_spec.rb
 spec/config_spec.rb
 spec/runner_spec.rb
+spec/file_list_spec.rb
 spec/spec.opts
 spec/spec_helper.rb
 Rakefile
-Manifest
 lib/back_it_up.rb
 lib/back_it_up/config.rb
+lib/back_it_up/file_list.rb
 lib/back_it_up/file_packager.rb
 lib/back_it_up/command.rb
 lib/back_it_up/runner.rb
+README.rdoc
+Manifest

data/README.rdoc

@@ -0,0 +1,37 @@
+= BackItUp
+
+<em>This is still in the workings and right now it is only an advanced zip file creator.</em>
+
+== Install
+
+Add GitHub to your gem sources if you haven't already:
+
+	$ sudo gem sources -a http://gems.github.com
+	 
+Install the gem:	 
+
+	$ sudo gem install robinsp-backitup
+	 
+This should have installed the _backitup_ command. Running 
+
+	$ backitup 
+	
+...should print the usage instructions if everything is set up ok.
+
+== Usage 
+
+Create a backup script looking something like this
+
+	# sample.backitup
+	backup do 
+	  file '/home/robin/backup.this.file'		
+	
+	  dir "~/Desktop/drop-in-me-for-backup"
+		
+	  destination_file "/tmp/backupfile"
+	end
+
+Run *backitup* with your script file as argument
+
+	$ backitup sample.backitup
+	

data/Rakefile

@@ -2,8 +2,8 @@ require 'spec'
 require 'spec/rake/spectask'
 require 'echoe'
 
-Echoe.new('backitup', '0.0.1') do |p|
-  p.description    = "Simple backup"
+Echoe.new('backitup', '0.0.2') do |p|
+  p.description    = "Simple backup tool"
   p.url            = "http://github.com/robinsp/backitup"
   p.author         = "Robin Spainhour"
   p.email          = "robin@robinspainhour.com"

data/backitup.gemspec

@@ -2,24 +2,24 @@
 
 Gem::Specification.new do |s|
   s.name = %q{backitup}
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Robin Spainhour"]
-  s.date = %q{2009-05-27}
+  s.date = %q{2009-05-28}
   s.default_executable = %q{backitup}
-  s.description = %q{Simple backup}
+  s.description = %q{Simple backup tool}
   s.email = %q{robin@robinspainhour.com}
   s.executables = ["backitup"]
-  s.extra_rdoc_files = ["bin/backitup", "lib/back_it_up.rb", "lib/back_it_up/config.rb", "lib/back_it_up/file_packager.rb", "lib/back_it_up/command.rb", "lib/back_it_up/runner.rb"]
-  s.files = ["bin/backitup", "spec/test-config.backitup", "spec/file_packager_spec.rb", "spec/config_spec.rb", "spec/runner_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "Rakefile", "Manifest", "lib/back_it_up.rb", "lib/back_it_up/config.rb", "lib/back_it_up/file_packager.rb", "lib/back_it_up/command.rb", "lib/back_it_up/runner.rb", "backitup.gemspec"]
+  s.extra_rdoc_files = ["bin/backitup", "lib/back_it_up.rb", "lib/back_it_up/config.rb", "lib/back_it_up/file_list.rb", "lib/back_it_up/file_packager.rb", "lib/back_it_up/command.rb", "lib/back_it_up/runner.rb", "README.rdoc"]
+  s.files = ["bin/backitup", "sample.backitup", "spec/test-config.backitup", "spec/file_packager_spec.rb", "spec/config_spec.rb", "spec/runner_spec.rb", "spec/file_list_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "Rakefile", "lib/back_it_up.rb", "lib/back_it_up/config.rb", "lib/back_it_up/file_list.rb", "lib/back_it_up/file_packager.rb", "lib/back_it_up/command.rb", "lib/back_it_up/runner.rb", "README.rdoc", "Manifest", "backitup.gemspec"]
   s.has_rdoc = true
   s.homepage = %q{http://github.com/robinsp/backitup}
-  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Backitup"]
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Backitup", "--main", "README.rdoc"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{backitup}
   s.rubygems_version = %q{1.3.2}
-  s.summary = %q{Simple backup}
+  s.summary = %q{Simple backup tool}
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

data/lib/back_it_up/config.rb

@@ -1,23 +1,62 @@
 module BackItUp
-  class Config
-    attr_reader :files, :dirs, :dest_filename
+  
+  # The backup script should look something like this
+  #
+  #    # sample.backitup
+  #    
+  #    backup do 
+  #    
+  #      file '/home/robin/backup.this.file'   
+  #    
+  #      dir '~/Desktop/drop-in-me-for-backup'
+  #      
+  #      destination_file "/tmp/backupfile"
+  #    end
+  #
+  # This will backup the file <tt>/home/robin/backup.this.file</tt> and all the files
+  # in the <tt>~/Desktop/drop-in-me-for-backup</tt> directory and its sub dirs, and 
+  # place them in <tt>/tmp/backupfile_[date]_time.zip</tt>.
+  module ScriptDSL 
     
-    def initialize(file_handle)
-      @files = []      
-      @dirs = []    
-      
-      file_content = ""
-
-      while l = file_handle.gets do 
-        file_content << l
+    # Starts off the backup script. 
+    #
+    # Usage:
+    #
+    #   backup do 
+    #     # add your files, dirs etc. here...
+    #   end
+    def backup
+      yield
+    end
+    
+    # File or directory name to add to the backup set. The given file name is expanded before 
+    # added to the backup set.
+    # 
+    # It is safer to use single quotes (especially on Windows file systems) as the support
+    # for escape sequences is not as great as double-quoted strings.
+    #
+    #   file '~/importantfile'  # is safer 
+    #   file "~/anotherfile"    # ...than this
+    #
+    def file(filename = nil)
+      unless (filename  == "" || filename == nil)
+        full_name = File.expand_path(filename)
+        
+        if File.exists?(full_name)
+          if File.directory? full_name
+            @dirs << full_name
+          else
+            @files << full_name
+          end
+              
+        else 
+          puts "WARNING: File #{filename} could not be found"    
+        end
       end
       
-      eval(file_content)
     end
     
-    def backup
-      yield
-    end
+    alias_method :dir, :file
     
     # Full path and name of the package file to create.
     # A timestamp will be appended to the filename and the extension is 
@@ -33,23 +72,28 @@ module BackItUp
       @dest_filename = filename
     end
     
-    def file(filename = nil)
+  end
+  
+  
+  class Config
+    include ScriptDSL
+    attr_reader :files, :dirs, :dest_filename
+    
+    def initialize(file_handle)
+      @files = []      
+      @dirs = []    
+      
+      file_content = ""
 
-      unless (filename  == "" || filename == nil)
-        if File.exists?(filename)
-          if File.directory? filename
-            @dirs << filename
-          else
-            @files << filename
-          end
-              
-        else 
-          puts "WARNING: File #{filename} could not be found"    
-        end
+      while l = file_handle.gets do 
+        file_content << l
       end
       
+      eval(file_content)
     end
     
-    alias_method :dir, :file
+    def each_file 
+      FileList.new(@files, @dirs).files.each {|filename| yield filename }
+    end
   end  
 end

data/lib/back_it_up/file_list.rb

@@ -0,0 +1,19 @@
+require 'find'
+
+module BackItUp
+  class FileList
+    attr_reader :files
+    
+    def initialize(files, dirs)
+      @files = []
+      files.each {|f| @files << f }
+      
+      dirs.each do |d| 
+        Find.find(d) do |f|
+          next if File.directory?(f)
+          @files << f
+        end
+      end
+    end
+  end
+end

data/lib/back_it_up/file_packager.rb

@@ -12,25 +12,31 @@ module BackItUp
     end
     
     def package
-      target_filename = create_target_filename
-      
-      prefix = File.basename(target_filename, ".zip")
-      
       Zip::ZipFile.open(target_filename, Zip::ZipFile::CREATE) do |zip|
-        @config.files.each do |filename|
-          zip.add("./#{prefix}#{filename}", filename)
-        end
+        @config.each_file { |filename| zip.add( zip_entry_name(filename), filename ) } 
       end
       
       @produced_file = target_filename
     end
     
     protected 
-    def create_target_filename
-      @config.dest_filename + "_#{timestamp}" + ".zip"
+    def target_filename
+      @target_filename ||= @config.dest_filename + "_#{timestamp}" + ".zip"
     end
     
     private 
+    def zip_entry_name(filename)
+      zip_entry_prefix + replace_win_drive_letter_in(filename)
+    end
+    
+    def replace_win_drive_letter_in(filename)
+      filename.gsub(/^(.):/, '/\1_drive')
+    end
+    
+    def zip_entry_prefix
+      @prefix ||= File.basename(target_filename, ".zip")
+    end
+    
     def timestamp
       Time.now.strftime("%Y%m%d_%H%M%S")
     end

data/lib/back_it_up.rb

@@ -1,3 +1,4 @@
 require 'back_it_up/runner'
 require 'back_it_up/config'
 require 'back_it_up/file_packager'
+require 'back_it_up/file_list'

data/sample.backitup

@@ -0,0 +1,11 @@
+
+# sample.backitup
+
+backup do 
+
+	file '/home/robin/backup.this.file'		
+
+	dir "~/Desktop/drop-in-me-for-backup"
+	
+	destination_file "/tmp/backupfile"
+end

data/spec/config_spec.rb

@@ -16,6 +16,7 @@ describe BackItUp::Config do
     BackItUp::Config.new(File.open(test_file))
   end
   
+  
   describe "" do 
     before do 
       mock_file = mock('mock-file')
@@ -31,6 +32,32 @@ describe BackItUp::Config do
       @config.dirs.should == []
     end
     
+    describe "each_file()" do 
+      before do 
+        @mock_file_list = mock("FileList")
+        @mock_file_list.stubs(:files).returns([])
+        BackItUp::FileList.stubs(:new).returns(@mock_file_list)
+      end
+      
+      it "should create FileList" do 
+        BackItUp::FileList.expects(:new).with(@config.files, @config.dirs).returns(@mock_file_list)
+        @config.each_file
+      end
+      
+      it "should yield all files in FileList" do 
+        expected_files = ["file_one", "file_two", "file_three"]
+        
+        @mock_file_list.expects(:files).returns(expected_files)
+        
+        result = []
+        @config.each_file do |f|
+          result << f
+        end
+        
+        result.should == expected_files
+      end
+    end
+    
     describe "destination_file()" do 
       
       it "should save the filename to dest_filename attribute" do 
@@ -68,6 +95,13 @@ describe BackItUp::Config do
         @config.file(file_name)
       end
       
+      it "should expand paths" do 
+        File.stubs(:exists?).returns(true)
+        File.expects(:expand_path).with("filename").returns("expanded_filename")
+        @config.file("filename")
+        @config.files.pop.should == "expanded_filename"
+      end
+      
       it "should not add non-existning files to files attribute" do 
         file_name = "should-not-exist"
         @config.file(file_name)
@@ -79,6 +113,7 @@ describe BackItUp::Config do
       end
       
       it "should check if file exists" do 
+        File.stubs(:expand_path).with("filename").returns("filename")
         File.expects(:exists?).with("filename").returns(false)
         @config.file("filename")
       end

data/spec/file_list_spec.rb

@@ -0,0 +1,21 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe BackItUp::FileList do 
+  
+  it "should add files passed to initialize to files attribute" do 
+    expected_files = %w{one two three}
+    list = BackItUp::FileList.new(expected_files, [] )
+    list.files.should == expected_files
+  end
+  
+  it "should find all files in dirs passed to initilizer and add to files attribute" do 
+    dirs = %w{dir_one dir_two dir_three}
+    Find.expects(:find).times(3).with { |d| dirs.include? d }.yields("one").then.yields("two").then.yields("three")
+    File.expects(:directory?).times(3).returns(false)
+    
+    list = BackItUp::FileList.new([], dirs)
+    
+    list.files.should == %w{one two three}
+  end
+  
+end

data/spec/file_packager_spec.rb

@@ -14,19 +14,18 @@ describe BackItUp::FilePackager do
   describe "package()" do 
     before do 
       @first_file_to_add = "/etc/passwd"
-      @second_file_to_add = "/etc/httpd/apache.cfg"
       
       @configured_dst_filename = "/backups/a-file-name"
-      mock_config = mock
-      mock_config.stubs(:is_a? => true)
-      mock_config.stubs(:dest_filename).returns(@configured_dst_filename)
-      mock_config.stubs(:files).returns([@first_file_to_add, @second_file_to_add])
+      @mock_config = mock
+      @mock_config.stubs(:is_a? => true)
+      @mock_config.stubs(:dest_filename).returns(@configured_dst_filename)
+      @mock_config.stubs(:each_file).yields(@first_file_to_add)
 
       @mock_zip = mock("mock-zip")
       @mock_zip.stubs(:add)
       Zip::ZipFile.stubs(:open).yields(@mock_zip)
       
-      @packager = BackItUp::FilePackager.new(mock_config)
+      @packager = BackItUp::FilePackager.new(@mock_config)
       
     end
     
@@ -55,11 +54,14 @@ describe BackItUp::FilePackager do
     end
     
     it "should add files to the zip" do 
-      prefix = "./#{File.basename(@configured_dst_filename)}"
-      
+      prefix = "#{File.basename(@configured_dst_filename)}"
       @mock_zip.expects(:add).with( regexp_matches(/^#{prefix}.*#{@first_file_to_add}$/), @first_file_to_add )
-      @mock_zip.expects(:add).with( regexp_matches(/^#{prefix}.*#{@second_file_to_add}$/), @second_file_to_add )
-      
+      @packager.package
+    end
+    
+    it "should strip the drive letter for windows files added to zip" do 
+      @mock_config.stubs(:each_file).yields("C:\temp\myfile")
+      @mock_zip.expects(:add).with( regexp_matches(/\/C_drive/), regexp_matches(/.*/) )
       @packager.package
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: robinsp-backitup
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Robin Spainhour
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-27 00:00:00 -07:00
+date: 2009-05-28 00:00:00 -07:00
 default_executable: backitup
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,7 +22,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
-description: Simple backup
+description: Simple backup tool
 email: robin@robinspainhour.com
 executables: 
 - backitup
@@ -32,24 +32,30 @@ extra_rdoc_files:
 - bin/backitup
 - lib/back_it_up.rb
 - lib/back_it_up/config.rb
+- lib/back_it_up/file_list.rb
 - lib/back_it_up/file_packager.rb
 - lib/back_it_up/command.rb
 - lib/back_it_up/runner.rb
+- README.rdoc
 files: 
 - bin/backitup
+- sample.backitup
 - spec/test-config.backitup
 - spec/file_packager_spec.rb
 - spec/config_spec.rb
 - spec/runner_spec.rb
+- spec/file_list_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 - Rakefile
-- Manifest
 - lib/back_it_up.rb
 - lib/back_it_up/config.rb
+- lib/back_it_up/file_list.rb
 - lib/back_it_up/file_packager.rb
 - lib/back_it_up/command.rb
 - lib/back_it_up/runner.rb
+- README.rdoc
+- Manifest
 - backitup.gemspec
 has_rdoc: true
 homepage: http://github.com/robinsp/backitup
@@ -59,6 +65,8 @@ rdoc_options:
 - --inline-source
 - --title
 - Backitup
+- --main
+- README.rdoc
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -79,6 +87,6 @@ rubyforge_project: backitup
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 3
-summary: Simple backup
+summary: Simple backup tool
 test_files: []