dated_backup 0.2.0 → 0.2.1

data/CHANGELOG

@@ -1,17 +1,27 @@
 trunk:
+
+= Rel 0.2.1
+* Rakfile's redundancies removed and generally cleaned up
+* Regression test finally fixed String#to_time bug
+* Error raising on String#to_time
+* Testing added for bin/dbackup
+* Errors now subclass from StandardError (not RuntimeError)
+* Time#each_day_in_month added
+
+= Rel 0.2
 [2007.08.01]
-- many misc. bug fixes
-- documentation added in README file
-- Backup Deletion now seems to work (almost too well)
-- warnings turned off for DSL
+* many misc. bug fixes
+* documentation added in README file
+* Backup Deletion now seems to work (almost too well)
+* warnings turned off for DSL
 
 [2007.07.21]
-- removed dependency on GNU cp, so now we can DatedBackup on Mac OS X
-- outputting of deleted directories
-- fixed small bugs
+* removed dependency on GNU cp, so now we can DatedBackup on Mac OS X
+* outputting of deleted directories
+* fixed small bugs
 
 [2007.07.25]
-- ExecutionContext class added, so now the separate parts of the DSL
+* ExecutionContext class added, so now the separate parts of the DSL
   can execute in separate contexts.  The Execution Contexts
   will execute the DSL in an anonymous class + instance, so methods
   used to run the DSL do not need be included.  The DSL's themselves
@@ -19,22 +29,23 @@ trunk:
   Work still needs to be done on calling these, both from the initial
   call in /bin, and later on in the DatedBackup class.
   
-- Any number of scripts can now be passed to the dbackup command line
+* Any number of scripts can now be passed to the dbackup command line
   utility.  So specify the scripts one after another:
   dbackup script1 script2 script3
   
 [2007.07.20]
-- Added basic DSL configuration, so no more rake for config files
+* Added basic DSL configuration, so no more rake for config files
   Documentation via Rake, Rcov, and the spec reports are now
   available in doc/
   specs have been added, and code coverage is now at 100%
   
 [2007.07.15]
-- YAML support.  Now all configuration files are written in yaml, and
+* YAML support.  Now all configuration files are written in yaml, and
   should be loaded by running dbackup config_file.yaml
 
 [2007.07.12] 
-- Command line runner, dbackup added to bin.  Scripts can now be called
+* Command line runner, dbackup added to bin.  Scripts can now be called
   with the dbackup script_name.  Scripts no longer have to include
   the requirement of the gem, be executable, or end in .rb syntax.
 
+= 0.1

data/README

@@ -22,12 +22,12 @@ option to simulate the hard-link method.
 
 == Backup Assumptions
 
-* Your backup *server* is POSIX compliant (a modern day UNIX - Linux, *BSD, Mac OS X)
-* You would like to perform incremental snapshots with timestamps
+  * Your backup *server* is POSIX compliant (a modern day UNIX - Linux, *BSD, Mac OS X)
+  * You would like to perform incremental snapshots with timestamps
 
 = Installation:
 
-* sudo gem install 'datedbackup' --include-dependencies
+  * sudo gem install 'dated_backup' --include-dependencies
 
 == Dependencies
 
@@ -36,7 +36,8 @@ Dated Backup has the following dependencies:
   * Ruby
   * Rubygems
   * Rails' 'ActiveSupport' gem
-  * A copy of rsync, which supports the --link-dest option.  
+  * A copy of rsync, which supports the --link-dest option (version 2.5.7 or greater).
+  * A POSIX-like (Linux, BSD*, Mac OS X, Solaris) OS to store the backups  
 
 Rsync is not required on the machine to be backed up - only on the machine which stores
 the backup.  
@@ -49,11 +50,11 @@ directory (or remote location), and the local destination directory.  These two
 parameters are the only requirements for a backup configuration file to be valid.  
 The script can be run with the executable dbackup:
 
-% dbackup my_script
+<tt>$ dbackup my_script</tt>
 
 Other scripts can be run sequentially by listing them in order:
 
-% dbackup my_first_script my_second_script
+<tt>$ dbackup my_first_script my_second_script</tt>
 
 All of the configuration occurs in the configuration file.
 
@@ -90,14 +91,14 @@ feed into rsync.  It too, is optional.
 
 It is very convenient, and often necessary to perform something before or after a backup script
 runs.  Any actions must be inside a 'before' or 'after' block:
+  
+  before do
+    # ...some before action here
+  end
 
-before do
- ...some before action here
-end
-
-after {
-  ..some other action here
-}
+  after {
+    # ...some other action here
+  }
 
 You have the pick of do...end, or { ... }, thanks to Matz.  No doubt, this will be familiar to any
 Ruby programmer.
@@ -115,13 +116,13 @@ directory.
 The remove_old block takes several different natural language time forms.  All of the statements inside
 a remove_old block must begin with 'keep'.  An example would work best to illustrate how to use this:
 
-after do
-  remove_old do
-    keep this months backups
-    keep last months backups
-    keep monthly backups
+  after do
+    remove_old do
+      keep this months backups
+      keep last months backups
+      keep monthly backups
+    end
   end
-end
 
 This says the following: After the backup runs, remove all backups that do not conform to the criteria
 given.  The first line will save all backups which have occured this month, regardless of what time 
@@ -135,14 +136,14 @@ according to the month)
 A few things should be notice here: These config files read very easily, so don't let them fool you.  
 They will delete your backups, forever lost.  I've already burned myself with the following: 
 
-after {
-  remove_old {
-    keep this weeks backups 
-    keep last weeks backups 
-    keep weekly backups from this month # or: keep this months weekly backups
-    keep monthly backups # or: keep all monthly backups
+  after {
+    remove_old {
+      keep this weeks backups 
+      keep last weeks backups 
+      keep weekly backups from this month # or: keep this months weekly backups
+      keep monthly backups # or: keep all monthly backups
+    }
   }
-}
 
 After a month of backups, the month rolled over, and the next backup on the first of the month deleted
 all backups, except the one just performed, and the one from the last day of the month before.  
@@ -175,12 +176,19 @@ The config file shown above should give you some hints on the possibilities.  He
 
 Some other keywords, such as 'yesterday', and 'today' will be added in subsequent releases.
 
-And finally, a final warning: If a remove_old block is given, but no keep rules are given, every backup
+And finally, a warning: If a remove_old block is given, but no keep rules are given, every backup
 will be deleted!  This may change in a subsequent release, but for now, beware!
 
 
+= License
+
+Dated Backup is released under the GNU GPL.  This means that you can use it for no charge as an individual
+or business.  It also means that if you are a hacker, you can modify it at your will.
+The license is attached under 'COPYRIGHT'.
+
+
 = Contributions
 
 If you are interested in contributing code or documentation, please contact me, 
-Scott Taylor, at scott AT railsnewbie DOT com.
+Scott Taylor, at scott AT railsnewbie DOT com.  I'm also up for hire (hint, hint).
 

data/RELEASES

@@ -1,21 +1,23 @@
+= 0.2.1
+
+* Major DSL/Time bug-fix (String#to_time bug, fixed in revision 169)
+* Documentation updates
 
 = 0.2.0
-=======
 
-- A Script Runner/binary has been added (dbackup)
-- A DSL has been added for configuring backups
-- Removal of old backups can now be specified in the DSL, using
+* A Script Runner/binary has been added (dbackup)
+* A DSL has been added for configuring backups
+* Removal of old backups can now be specified in the DSL, using
   natural language forms
-- Before + After actions for the script runner
-- RSpec + RCov = Bug free code
-- Documentation added in the README file
-- Developer Documentation in Rake and RSpec Report
-- A series of example config files have been attached for Documentation
-- Root backup directories are now created automatically
-- Removed dependency on GNU's cp, so now this utility can be used
+* Before + After actions in the DSL
+* RSpec + RCov = Bug free code
+* Documentation added in the README file
+* Developer Documentation in Rake and RSpec Report
+* A series of example config files have been attached for Documentation
+* Root backup directories are now created automatically
+* Removed dependency on GNU's cp, so now this utility can be used
   on any *NIX, including Mac OS X
 
 = 0.1.0
-=======
 
-- Initial Release
+* Initial Release

data/bin/dbackup

@@ -19,4 +19,4 @@
 
 require File.dirname(__FILE__) + "/../lib/dated_backup"
 
-DatedBackup::ExecutionContext.new :main, *ARGV
+DatedBackup::ExecutionContext.new(:main, *ARGV)

data/example_configs/local_etc_backup

@@ -1,4 +1,4 @@
-# A script to back up etc, locally, in /root/etc_backup
+# A script to back up /etc locally in /root/etc_backup
 
 source        '/etc'
 destination   '/root/etc_backup'

data/lib/dated_backup/core/dated_backup.rb

@@ -46,8 +46,7 @@ module DatedBackup
   private
 
     def generate_backup_filename
-      timestamp = Time.now.strftime "%Y-%m-%d-%Hh-%Mm-%Ss"
-      "#{@backup_root}/#{timestamp}"
+      "#{@backup_root}/#{Time.now.to_string}"
     end                         
 
   protected

data/lib/dated_backup/dsl/execution_context.rb

@@ -2,6 +2,14 @@
 module DatedBackup
   class ExecutionContext
 
+    module ExecutionContextHelper
+      def anonymous_instance_loading_module(mod)
+        klass = Class.new
+        klass.send(:include, mod)
+        klass.new
+      end
+    end
+
     def initialize(name, *params, &blk)  
       DatedBackup::Warnings.execute_silently do
         if name == :main
@@ -16,10 +24,11 @@ module DatedBackup
     
     class Main
       class << self
+
+        include ExecutionContextHelper
+
         def load(filename)
-          klass = Class.new
-          klass.send(:include, DSL::Main)
-          instance = klass.new          
+          instance = anonymous_instance_loading_module(DSL::Main)         
           
           File.open filename, "r" do |file|
             instance.instance_eval file.read
@@ -37,17 +46,16 @@ module DatedBackup
     end
 
     class Around
+      
+      include ExecutionContextHelper
+
       def initialize(around=self, &blk)
         around.instance_eval &blk
       end
 
       def remove_old(&blk)
-        klass = Class.new
-        klass.send(:include, DSL::TimeExtensions)
-        instance = klass.new
-
+        instance = anonymous_instance_loading_module(DSL::TimeExtensions)
         instance.instance_eval &blk
-        
         Core::BackupRemover.remove!(Main.instance.backup_root, instance.kept)
       end
     end

data/lib/dated_backup/extensions.rb

@@ -3,4 +3,5 @@ require File.dirname(__FILE__) + "/extensions/array"
 require File.dirname(__FILE__) + "/extensions/time"
 require File.dirname(__FILE__) + "/extensions/error"
 require File.dirname(__FILE__) + "/extensions/time_symbol"
-require File.dirname(__FILE__) + "/extensions/string"
+require File.dirname(__FILE__) + "/extensions/string"
+require File.dirname(__FILE__) + "/extensions/reverse_sorted_unique_array"

data/lib/dated_backup/extensions/array.rb

@@ -12,16 +12,3 @@ class Array
     DatedBackup::Core::BackupSet.new(self)
   end
 end
-
-# A subclass of Array, but it calls uniq!, sort!, and reverse!
-# (in that order) after the instance is created
-class ReverseSortedUniqueArray < Array
-  
-  def initialize *args, &blk
-    super *args, &blk
-    uniq!
-    sort!
-    reverse!
-  end    
-  
-end

data/lib/dated_backup/extensions/error.rb

@@ -1,10 +1,12 @@
 
-class TimeSymbolError < RuntimeError;           end
-
-class DatedBackupError < RuntimeError;          end
-
-class DirectoryError < DatedBackupError;        end
-class InvalidDirectoryError < DirectoryError;   end
-class NoBlockGiven < DatedBackupError;          end
-class InvalidKeyError < DatedBackupError;       end
+# Base Class Errors
+class TimeSymbolError < StandardError; end
+class StringToTimeConversionError < StandardError; end
+
+# DatedBackup Errors
+class DatedBackupError < StandardError; end
+class DirectoryError < DatedBackupError; end
+class InvalidDirectoryError < DirectoryError; end
+class NoBlockGiven < DatedBackupError; end
+class InvalidKeyError < DatedBackupError; end
 

data/lib/dated_backup/extensions/reverse_sorted_unique_array.rb

@@ -0,0 +1,14 @@
+
+
+# A subclass of Array, but it calls uniq!, sort!, and reverse!
+# (in that order) after the instance is created
+class ReverseSortedUniqueArray < Array
+  
+  def initialize *args, &blk
+    super *args, &blk
+    uniq!
+    sort!
+    reverse!
+  end    
+  
+end

data/lib/dated_backup/extensions/string.rb

@@ -1,8 +1,21 @@
 
 class String
+  # This must take a time in a format similar to the
+  # format generated the Time.to_string.  The format should be like this:
+  # .+2007-07-01-00m-00h-00s.+
+  # Any number of charachters can come before or after the time format
+  # string.  A TimeException will be raised if the string does not 
+  # conform to the time format.
   def to_time
-    string = self.dup
-    string.sub!(/^(.*?)([\d\-\h\m\s]+)(.*?)$/) { $2 }
-    Time.gm(*(string.split('-').map { |element| element.sub /h|m|s/, ''}))
+    if self =~ /(\d{4}\-\d{2}-\d{2}-\d{2}h\-\d{2}m-\d{2}s)/  
+      begin
+        time_array = $1.gsub(/h|m|s/, '').split '-'
+        Time.gm(*time_array)
+      rescue 
+        raise StringToTimeConversionError, "The string cannot be a converted to a valid time (it is out of range)"
+      end
+    else
+      raise StringToTimeConversionError, "The string cannot be converted to a time object"
+    end
   end
 end

data/lib/dated_backup/extensions/time.rb

@@ -42,6 +42,20 @@ class Time
     beginning_of_week...end_of_week
   end
   
+  def each_day_in_month
+    1.upto(days_in_month) do |day_num|
+      yield beginning_of_month + (day_num - 1).day
+    end
+  end
+  
+  def days_in_month
+    self.class.days_in_month(self.month, self.year)
+  end
+  
+  def to_string
+    strftime("%Y-%m-%d-%Hh-%Mm-%Ss")
+  end
+  
 end
 
 class Fixnum

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: dated_backup
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
-date: 2007-08-02 00:00:00 -04:00
+  version: 0.2.1
+date: 2007-08-06 00:00:00 -04:00
 summary: Incremental Dated Backups Using Rsync
 require_paths: 
 - lib
@@ -47,6 +47,7 @@ files:
 - lib/dated_backup/extensions
 - lib/dated_backup/extensions/array.rb
 - lib/dated_backup/extensions/error.rb
+- lib/dated_backup/extensions/reverse_sorted_unique_array.rb
 - lib/dated_backup/extensions/string.rb
 - lib/dated_backup/extensions/time.rb
 - lib/dated_backup/extensions/time_symbol.rb