dated_backup 0.1.0 → 0.2.0

data/lib/dated_backup/dsl/main.rb

@@ -0,0 +1,41 @@
+
+module DatedBackup
+  class DSL
+    module Main
+
+      attr_reader :hash, :procs
+
+      def initialize
+        @hash = {}
+        @procs = {}
+      end
+
+      def before &blk
+        raise_without_block &blk
+        @procs[:before] = blk
+      end
+
+      def after &blk
+        raise_without_block &blk
+        @procs[:after] = blk
+      end
+
+      def method_missing sym, *args
+        if RSYNC_OPTIONS.include?(sym)
+          @hash[sym] = args
+        else
+          raise InvalidKeyError, "The key '#{sym}' is not a recognized expression"
+        end
+      end
+
+    protected
+
+      def raise_without_block &blk
+        raise NoBlockGiven, "A block (do...end) must be given" if !block_given?
+      end
+
+      RSYNC_OPTIONS = [:source, :sources, :destination, :options, :user_domain]
+
+    end      
+  end
+end

data/lib/dated_backup/dsl/time_extensions.rb

@@ -0,0 +1,122 @@
+
+module DatedBackup
+  class DSL
+    
+    # After a run through the DSL,
+    # the TimeExtensions#kept method should contain an array
+    # of all of the items to keep.  Each item will be a hash
+    # with two keys: a :constraint key, which contains a 
+    # range of Times (from oldest to newest), and a :scope
+    # key, which will indicate whether the backup to look
+    # at is a weekly, monthly, etc.  If no :scope key is given,
+    # then all of the backups in the time range given by
+    # the :constraint key will be assumed to be kept.
+    module TimeExtensions
+
+      attr_reader :last_time, :time_range
+      attr_reader :kept
+
+      def initialize
+        @kept = []
+        @time_range = {}
+        @last_time = nil      
+      end
+
+      def backup  *args;   return self; end
+      def from    *args;   return self; end
+
+      alias :backups :backup
+
+      TimeSymbol.valid_symbols.each do |sym|
+        time_sym = TimeSymbol.new sym
+        
+        define_method time_sym.singular do |*args|
+          self.send :time_component, time_sym.singular
+        end        
+        
+        alias_method time_sym.plural, time_sym.singular
+        
+        define_method time_sym.adverb do
+          @time_range[:scope] = time_sym.adverb
+        end
+      end
+
+
+      def this arg, now=Time.now
+        set_time_range :this, now
+      end
+
+      def last arg, now=Time.now
+        set_time_range :last, now
+      end
+
+      def keep arg, now=Time.now
+        all(self, now) unless time_range[:constraint]
+
+        @kept << time_range
+        reset_times
+        self
+      end
+
+      def all arg=self, now=Time.now
+        @time_range[:constraint] = Time.epoch...now
+        self
+      end
+
+    protected
+
+
+      def set_time_range sym, now
+        if sym == :last
+          year, month, week, day = now.last_year, now.last_month, now.last_week, now.yesterday
+        elsif sym == :this
+          add_end_of_star_singletons(now)
+
+          # This is another little trick.  Normally we would just call the methods
+          # below something like: Time.now.beginning_of_year...Time.now.end_of_year
+          year, month, week, day = now, now, now, now
+        end
+
+        @time_range[:constraint] = 
+          case last_time
+          when :year
+            year.beginning_of_year...year.end_of_year
+          when :month
+            month.beginning_of_month...month.end_of_month
+          when :week
+            week.beginning_of_week...week.end_of_week
+          when :day
+            day.beginning_of_day...day.end_of_day
+          end
+
+        self
+      end
+
+      # This method adds the end_of_* methods to the object passed in.  They are used in the default case
+      # of the modifyer being "this" and not "last".  In the 'this' case, the time
+      # *is* now, so end_of_* (end_of_year, end_of_day), etc. should *NOT* need to be called
+      # (and in fact, we do not want them to be called, because that would represent
+      # some time period in the future).  Those methods are overrided to return self
+      def add_end_of_star_singletons(now)
+        class << now
+          [:end_of_year, :end_of_month, :end_of_week, :end_of_day].each do |end_of|
+            define_method end_of do
+              return self
+            end
+          end
+        end      
+      end
+
+      def time_component(type)
+        @last_time = type
+        self
+      end
+
+      def reset_times
+        @time_range = {}
+        @last_time = nil      
+      end
+    end
+    
+  end
+end

data/lib/dated_backup/dsl.rb

@@ -0,0 +1,4 @@
+
+require File.dirname(__FILE__) + "/dsl/execution_context"
+require File.dirname(__FILE__) + "/dsl/main"
+require File.dirname(__FILE__) + "/dsl/time_extensions"

data/lib/dated_backup/extensions/array.rb

@@ -0,0 +1,27 @@
+
+class Array
+  def car
+    first
+  end
+  
+  def cdr
+    self.[](1..self.length)
+  end
+  
+  def to_backup_set
+    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

@@ -0,0 +1,10 @@
+
+class TimeSymbolError < RuntimeError;           end
+
+class DatedBackupError < RuntimeError;          end
+
+class DirectoryError < DatedBackupError;        end
+class InvalidDirectoryError < DirectoryError;   end
+class NoBlockGiven < DatedBackupError;          end
+class InvalidKeyError < DatedBackupError;       end
+

data/lib/dated_backup/extensions/string.rb

@@ -0,0 +1,8 @@
+
+class String
+  def to_time
+    string = self.dup
+    string.sub!(/^(.*?)([\d\-\h\m\s]+)(.*?)$/) { $2 }
+    Time.gm(*(string.split('-').map { |element| element.sub /h|m|s/, ''}))
+  end
+end

data/lib/dated_backup/extensions/time.rb

@@ -0,0 +1,50 @@
+require 'active_support/core_ext/time/calculations'
+require 'active_support/core_ext/numeric/time'
+
+class Time
+  class << self
+    include ActiveSupport::CoreExtensions::Time::Calculations::ClassMethods  	
+    
+    def epoch
+      Time.at(0)
+    end
+    
+  end
+  
+  include ActiveSupport::CoreExtensions::Time::Calculations
+  
+  def end_of_day
+    tomorrow.beginning_of_day - 1
+  end
+  
+  def end_of_month
+    next_month.beginning_of_month - 1
+  end
+  
+  def end_of_year
+    next_year.beginning_of_year - 1
+  end
+  
+  def end_of_week
+    next_week.beginning_of_week - 1
+  end
+  
+  def last_week
+    1.week.ago.beginning_of_week
+  end
+  
+  alias :at_end_of_week  :end_of_week
+  alias :at_end_of_month :end_of_month
+  alias :at_end_of_day   :end_of_day
+  alias :at_end_of_year  :end_of_year
+  
+  def week
+    beginning_of_week...end_of_week
+  end
+  
+end
+
+class Fixnum
+  include ActiveSupport::CoreExtensions::Numeric::Time
+end
+

data/lib/dated_backup/extensions/time_symbol.rb

@@ -0,0 +1,54 @@
+
+# Used to change the the TimeSymbols (:year, :month, :day, and :week) into the
+# various natural language forms (the symbols singular, plural, and adverb).  
+# Initialize with the singular symbol name, or call TimeSymbol.valid_symbols
+# to give an array of valid symbols.
+class TimeSymbol
+  VALID_TIME_COMPONENTS = [:year, :month, :week, :day]
+  
+  class << self
+    def all
+      VALID_TIME_COMPONENTS.dup
+    end
+    
+    alias :valid_symbols :all
+  end
+  
+  def initialize(sym)
+    if VALID_TIME_COMPONENTS.include? sym
+      @sym = sym
+    else
+      raise TimeSymbolError, "The symbol given must be a valid TimeSymbol (:year, :month, :week, or :day)"
+    end
+  end
+  
+  def singular
+    @sym
+  end
+  
+  def plural
+    "#{@sym}s".to_sym
+  end
+  
+  def adverb
+    if @sym == :day
+      :daily
+    else
+      "#{@sym}ly".to_sym
+    end
+  end
+  
+  def to_sym
+    @sym.to_sym
+  end
+  
+  def to_s
+    @sym.to_s
+  end
+  
+  def inspect
+    @sym.inspect
+  end
+end
+
+TimeSymbols = TimeSymbol.all

data/lib/dated_backup/extensions.rb

@@ -0,0 +1,6 @@
+
+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"

data/lib/dated_backup.rb

@@ -1,2 +1,22 @@
+# DatedBackup, A snapshot backup utility
+# Copyright (C) Scott Taylor (scott@railsnewbie.com), 2007
+# 
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+# 
 
-require File.dirname(__FILE__) + "/dated_backup/dated_backup"
+
+require 'rubygems'
+require File.dirname(__FILE__) + "/dated_backup/extensions"
+require File.dirname(__FILE__) + "/dated_backup/dsl"
+require File.dirname(__FILE__) + "/dated_backup/core"

metadata

@@ -3,9 +3,9 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: dated_backup
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
-date: 2007-07-09 00:00:00 -04:00
-summary: Incremental Backups Using Rsync
+  version: 0.2.0
+date: 2007-08-02 00:00:00 -04:00
+summary: Incremental Dated Backups Using Rsync
 require_paths: 
 - lib
 email: scott@railsnewbie.com
@@ -15,7 +15,7 @@ description:
 autorequire: 
 default_executable: 
 bindir: bin
-has_rdoc: false
+has_rdoc: true
 required_ruby_version: !ruby/object:Gem::Version::Requirement 
   requirements: 
   - - ">"
@@ -29,24 +29,61 @@ post_install_message:
 authors: 
 - Scott Taylor
 files: 
+- bin/dbackup
 - lib/dated_backup
-- lib/dated_backup/command_line.rb
-- lib/dated_backup/dated_backup.rb
+- lib/dated_backup/core
+- lib/dated_backup/core/backup_remover.rb
+- lib/dated_backup/core/backup_set.rb
+- lib/dated_backup/core/command_line.rb
+- lib/dated_backup/core/dated_backup.rb
+- lib/dated_backup/core/tasks.rb
+- lib/dated_backup/core/warnings.rb
+- lib/dated_backup/core.rb
+- lib/dated_backup/dsl
+- lib/dated_backup/dsl/execution_context.rb
+- lib/dated_backup/dsl/main.rb
+- lib/dated_backup/dsl/time_extensions.rb
+- lib/dated_backup/dsl.rb
+- lib/dated_backup/extensions
+- lib/dated_backup/extensions/array.rb
+- lib/dated_backup/extensions/error.rb
+- lib/dated_backup/extensions/string.rb
+- lib/dated_backup/extensions/time.rb
+- lib/dated_backup/extensions/time_symbol.rb
+- lib/dated_backup/extensions.rb
 - lib/dated_backup.rb
-- example_scripts/example.com.rb
-- example_scripts/local_etc_backup.rb
-- example_scripts/samba_shares.rb
+- example_configs/example.com
+- example_configs/local_etc_backup
+- example_configs/samba_shares
+- README
+- COPYRIGHT
+- RELEASES
+- CHANGELOG
 test_files: []
 
 rdoc_options: []
 
-extra_rdoc_files: []
-
-executables: []
-
+extra_rdoc_files: 
+- example_configs/example.com
+- example_configs/local_etc_backup
+- example_configs/samba_shares
+- README
+- COPYRIGHT
+- RELEASES
+- CHANGELOG
+executables: 
+- dbackup
 extensions: []
 
 requirements: []
 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.4.2
+    version: 

data/example_scripts/local_etc_backup.rb

@@ -1,10 +0,0 @@
-#!/usr/bin/env ruby
-
-# A script to back up etc, locally, in /root/etc_backup
-
-require "dated_backup"
-
-DatedBackup.new(
-  :source => "/etc",
-  :destination => "/root/etc_backup"
-).run

data/lib/dated_backup/command_line.rb

@@ -1,8 +0,0 @@
-class DatedBackup
-  module CommandLine
-    def execute(cmd)
-      puts "* running: #{cmd}"
-      puts %x(#{cmd})
-    end
-  end  
-end

data/lib/dated_backup/dated_backup.rb

@@ -1,80 +0,0 @@
-require File.dirname(__FILE__) + "/command_line"
-
-class DatedBackup    
-  
-  include DatedBackup::CommandLine
-  
-  attr_accessor :source, :destination, :opts, :backup_root, :user_domain
-  
-  def initialize(h={})
-    @backup_root = h[:destination]
-    @opts = h[:options] || ""
-    @user_domain = h[:user_domain]
-    @destination = generate_backup_filename
-    
-    @sources = h[:sources] || [h[:source]]
-    
-    if @user_domain
-      @sources.map! { |src| "#{@user_domain}:#{src}" }
-    end
-    
-  end
-  
-  # create the first backup, if non-existent  
-  # otherwise cp -al (or # replace cp -al a b with cd a && find . -print | cpio -dpl ../b )
-  # and then create the backup of the dirs using rsync -a --delete
-  # the files, in the end, should be read only and undeletable
-  def run                               
-    create_main_backup_directory                     
-    cp_last_backup_to_new_backup unless Dir.glob("#{@backup_root}/*").empty?
-    create_backup
-    #set_permissions(dest)
-  end
-  
-  def create_backup 
-    @sources.each do |source|        
-      cmd = "rsync -a --delete #{opts} #{source} #{@destination}"
-      execute(cmd)
-      puts "\n\n"
-    end
-  end
-
-  def cp_last_backup_to_new_backup
-    last_backup_dir = find_last_backup_filename
-    
-    cmd = "cp -al #{last_backup_dir} #{@destination}"
-    execute(cmd)
-  end           
-  
-  def create_main_backup_directory
-    begin
-      unless File.exists? backup_root
-        puts "* Creating main backup directory #{backup_root}"
-        Dir.mkdir backup_root 
-      end
-    rescue Errno::EACCES => e
-      puts "-- Exiting script because main directory could not be created. \n   Error Message: #{e}"
-      exit
-    end
-  end
-  
-  #def set_permissions(file, permission="400", user="root", group="root")
-  #  cmd = "chmod -R #{permission} #{file}"
-  #  execute(cmd)
-  #  cmd = "chown -R #{user}:#{group} #{file}"
-  #  execute(cmd)
-  #end
-
-private
-
-  def generate_backup_filename
-    timestamp = Time.now.strftime "%Y-%m-%d-%Hh-%Mm-%Ss"
-    "#{@backup_root}/#{timestamp}"
-  end                         
-
-  def find_last_backup_filename
-    Dir.glob("#{@backup_root}/*").sort.last
-  end
-end
-
-