syc-backup 0.0.6 → 0.0.7

data/README.rdoc

@@ -25,7 +25,7 @@ Create a cron job that is scheduled every day at 2:30
     $ sycbackup -d database -uuser -ppass -f directory,file1 --cron 30,2,*,*,*
 
 If the user or password contains characters as '(' you have to escape
-them. A password like 123(56 has to be provided with pass\"123\\\\(56\".
+them. A password like 123(56 has to be provided with pass\"123\(56\".
 
 == Usage of --override and --no-compress
 Whether the backup directory and the backup files are time stamped depends how

data/doc/Backup/CronEdit.html

@@ -165,6 +165,16 @@ already exist in the crontab they are overridden.</p>
         <dd class="description"><p>Temporary file that holds the entries to be written to the crontab</p>
         
       
+        <dt id="POST_COMMENT">POST_COMMENT
+        
+        <dd class="description"><p>Post comment after the entered command</p>
+        
+      
+        <dt id="PRE_COMMENT">PRE_COMMENT
+        
+        <dd class="description"><p>Pre comment before the entered command</p>
+        
+      
       </dl>
     </section>
     
@@ -198,7 +208,7 @@ and the application exits</p>
 
           
           <div class="method-source-code" id="add_command-source">
-            <pre><span class="ruby-comment"># File lib/backup/cron_edit.rb, line 20</span>
+            <pre><span class="ruby-comment"># File lib/backup/cron_edit.rb, line 25</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">add_command</span>(<span class="ruby-identifier">command</span>, <span class="ruby-identifier">environment</span>=[])
   <span class="ruby-identifier">command</span> = <span class="ruby-identifier">command</span>.<span class="ruby-identifier">strip</span>.<span class="ruby-identifier">squeeze</span>(<span class="ruby-string">&quot; &quot;</span>)
 
@@ -224,7 +234,9 @@ and the application exits</p>
   <span class="ruby-keyword">end</span>
 
   <span class="ruby-keyword">unless</span> <span class="ruby-identifier">entries</span>.<span class="ruby-identifier">include?</span> <span class="ruby-identifier">command</span>
+    <span class="ruby-identifier">entries</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-constant">PRE_COMMENT</span>
     <span class="ruby-identifier">entries</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">command</span>
+    <span class="ruby-identifier">entries</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-constant">POST_COMMENT</span>
 
     <span class="ruby-identifier">cron_entries_file</span> = <span class="ruby-constant">CRON_ENTRIES_FILE</span> 
     <span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">cron_entries_file</span>, <span class="ruby-string">'w'</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span>
@@ -275,7 +287,7 @@ after the values have been written to crontab</p>
 
           
           <div class="method-source-code" id="cleanup-source">
-            <pre><span class="ruby-comment"># File lib/backup/cron_edit.rb, line 123</span>
+            <pre><span class="ruby-comment"># File lib/backup/cron_edit.rb, line 132</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">cleanup</span>
   <span class="ruby-constant">File</span>.<span class="ruby-identifier">delete</span> <span class="ruby-constant">CRON_ENTRIES_FILE</span> <span class="ruby-keyword">if</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exists?</span> <span class="ruby-constant">CRON_ENTRIES_FILE</span>
 <span class="ruby-keyword">end</span></pre>
@@ -310,7 +322,7 @@ crontab call fails the error message and exit status of
 
           
           <div class="method-source-code" id="remove_command-source">
-            <pre><span class="ruby-comment"># File lib/backup/cron_edit.rb, line 75</span>
+            <pre><span class="ruby-comment"># File lib/backup/cron_edit.rb, line 82</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">remove_command</span>(<span class="ruby-identifier">command</span>)
   <span class="ruby-identifier">command</span> = <span class="ruby-identifier">command</span>.<span class="ruby-identifier">strip</span>.<span class="ruby-identifier">squeeze</span>(<span class="ruby-string">&quot; &quot;</span>)
 
@@ -332,9 +344,11 @@ crontab call fails the error message and exit status of
 
   <span class="ruby-identifier">entries</span> = <span class="ruby-identifier">stdout</span>.<span class="ruby-identifier">split</span>(<span class="ruby-regexp">%r\n/</span>).<span class="ruby-identifier">each</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">entry</span><span class="ruby-operator">|</span> <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">strip</span>.<span class="ruby-identifier">squeeze</span>(<span class="ruby-string">&quot; &quot;</span>)}
 
+  <span class="ruby-identifier">entries</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-constant">PRE_COMMENT</span>)
   <span class="ruby-identifier">entries</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">command</span>)
+  <span class="ruby-identifier">entries</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-constant">POST_COMMENT</span>)
 
-  <span class="ruby-identifier">cron_entries_file</span> = <span class="ruby-constant">CRON_ENTRIES_FILE</span> <span class="ruby-comment">#&quot;.cron_entries&quot;</span>
+  <span class="ruby-identifier">cron_entries_file</span> = <span class="ruby-constant">CRON_ENTRIES_FILE</span>
 
   <span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">cron_entries_file</span>, <span class="ruby-string">'w'</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">file</span><span class="ruby-operator">|</span>
     <span class="ruby-identifier">entries</span>.<span class="ruby-identifier">each</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">entry</span><span class="ruby-operator">|</span> <span class="ruby-identifier">file</span>.<span class="ruby-identifier">puts</span> <span class="ruby-identifier">entry</span>}

data/doc/README_rdoc.html

@@ -115,28 +115,43 @@ command is added to crontab.</p>
 <p><a href="Backup.html">Backup</a> a database to the default folder
 _~/backup_</p>
 
-<pre>$ sycup -d database -uuser -ppass</pre>
+<pre>$ sycbackup -d database -uuser -ppass</pre>
 
 <p><a href="Backup.html">Backup</a> a MySQL database, a directory and files to
 the default folder</p>
 
-<pre>$ sycup -d database -uuser -ppass -f directory,file1,file2</pre>
+<pre>$ sycbackup -d database -uuser -ppass -f directory,file1,file2</pre>
 
 <p>Specify a backup folder</p>
 
-<pre>$ sycup backup/folder -d database -uuser -ppass -f directory,file1,file2</pre>
+<pre>$ sycbackup backup/folder -d database -uuser -ppass -f directory,file1,file2</pre>
 
 <p>Override files in the backup folder if they exist</p>
 
-<pre>$ sycup backup/folder --override -f directory,file1,file2</pre>
+<pre>$ sycbackup backup/folder --override -f directory,file1,file2</pre>
 
 <p>Don’t compress the backup</p>
 
-<pre>$ sycup --no-compress -f directory,file1,file2</pre>
+<pre>$ sycbackup --no-compress -f directory,file1,file2</pre>
 
 <p>Create a cron job that is scheduled every day at 2:30</p>
 
-<pre>$ sycup -d database -uuser -ppass -f directory,file1 --cron 30,2,*,*,*</pre>
+<pre>$ sycbackup -d database -uuser -ppass -f directory,file1 --cron 30,2,*,*,*</pre>
+
+<p>If the user or password contains characters as ‘(’ you have to escape them.
+A password like 123(56 has to be provided with pass"123\\(56".</p>
+
+<h2 id="label-Usage+of+--override+and+--no-compress">Usage of –override and –no-compress</h2>
+
+<p>Whether the backup directory and the backup files are time stamped depends
+how –override and –no-compress is set. The results are shown in the table
+below.</p>
+
+<pre>--override      --no-compress     backup directory      backup file(s)
+     0                0            w/o timestamp         w/ timestamp
+     1                0            w/o timestamp         w/ timestamp
+     0                1            w/  timestamp         uncompressed
+     1                1            w/o timestamp         uncompressed</pre>
 
 <h2 id="label-Supported+Platform">Supported Platform</h2>
 
@@ -167,6 +182,10 @@ finish. <em>MySQLBackup</em> needs to run a MySQL database with a database
 
 <p>The test files live in the test folder and begin with test_.</p>
 
+<p>There is a rake file available which can be used to run all tests with</p>
+
+<pre>$ rake test</pre>
+
 <h2 id="label-Links">Links</h2>
 <ul><li><dl class="rdoc-list label-list"><dt><a href="http://sugaryourcoffee.github.com/syc-backup">sugaryourcoffee.github.com/syc-backup</a>
 <dd><ul><li>

data/doc/created.rid

@@ -1,17 +1,17 @@
-Sat, 02 Feb 2013 19:22:09 +0100
-./README.rdoc	Sun, 27 Jan 2013 22:13:29 +0100
+Mon, 04 Feb 2013 22:11:40 +0100
+./README.rdoc	Mon, 04 Feb 2013 22:04:33 +0100
 ./test/test_process.rb	Sat, 02 Feb 2013 16:04:30 +0100
 ./test/test_mysql_backup.rb	Sat, 02 Feb 2013 16:05:39 +0100
-./test/test_options.rb	Sat, 02 Feb 2013 14:21:39 +0100
+./test/test_options.rb	Mon, 04 Feb 2013 21:31:24 +0100
 ./test/test_cron_edit.rb	Sat, 26 Jan 2013 23:41:31 +0100
 ./test/test_environment.rb	Sat, 02 Feb 2013 15:56:51 +0100
 ./test/test_file_backup.rb	Sat, 02 Feb 2013 16:09:39 +0100
-./lib/backup_version.rb	Sat, 02 Feb 2013 17:53:41 +0100
+./lib/backup_version.rb	Mon, 04 Feb 2013 22:05:10 +0100
 ./lib/backup/file_backup.rb	Sat, 02 Feb 2013 17:58:42 +0100
-./lib/backup/process.rb	Mon, 28 Jan 2013 08:46:33 +0100
+./lib/backup/process.rb	Mon, 04 Feb 2013 21:15:51 +0100
 ./lib/backup/mysql_backup.rb	Sun, 27 Jan 2013 22:30:18 +0100
-./lib/backup/options.rb	Sat, 02 Feb 2013 18:13:34 +0100
-./lib/backup/cron_edit.rb	Sat, 02 Feb 2013 18:31:29 +0100
+./lib/backup/options.rb	Mon, 04 Feb 2013 21:37:20 +0100
+./lib/backup/cron_edit.rb	Sat, 02 Feb 2013 21:17:07 +0100
 ./lib/backup/environment.rb	Sat, 02 Feb 2013 15:55:40 +0100
 ./lib/backup/runner.rb	Sat, 02 Feb 2013 15:29:54 +0100
 ./bin/sycbackup	Sun, 27 Jan 2013 13:07:36 +0100

data/doc/table_of_contents.html

@@ -33,6 +33,7 @@
       <li><a href="README_rdoc.html#label-Backup+utility+for+database%2C+folders+and+files">Backup utility for database, folders and files</a>
       <li><a href="README_rdoc.html#label-Install">Install</a>
       <li><a href="README_rdoc.html#label-Usage">Usage</a>
+      <li><a href="README_rdoc.html#label-Usage+of+--override+and+--no-compress">Usage of –override and –no-compress</a>
       <li><a href="README_rdoc.html#label-Supported+Platform">Supported Platform</a>
       <li><a href="README_rdoc.html#label-Notes">Notes</a>
       <li><a href="README_rdoc.html#label-Tests">Tests</a>

data/lib/backup/options.rb

@@ -25,6 +25,9 @@ module Backup
     # Determines whether to compress the backup if not to compress it returns
     # false, otherwise true
     attr_reader :no_compress
+    # Specifies the maximum backup files to keep. Count < 1 means infinite
+    # backup files
+    attr_reader :max_backups
 
     # Takes the arguments from the command line and parses them
     def initialize(argv)
@@ -158,6 +161,12 @@ module Backup
           @cron = validate_cron_values c.split(/ /).slice(0..4)
         end
 
+        opts.on("-m", "--max-backups COUNT", Integer,
+                "The maximum compressed backup files count",
+                "to keep") do |m|
+          @max_backups = m
+        end
+
         opts.on("-v", "--version", "Show version") do |v|
           puts Backup::VERSION
           exit 0

data/lib/backup/process.rb

@@ -14,11 +14,12 @@ module Backup
     # provided the files in the backup folder are overridden. no_compress will
     # prevent compressing the backed up files and will just copy them to the
     # provided backup folder
-    def initialize(backup_folder, files, override, no_compress)
+    def initialize(backup_folder, files, override, no_compress, max_backups = 9)
       @backup_folder = backup_folder
       @files = files
       @override = override
       @no_compress = no_compress
+      @max_backups = max_backups
     end
 
     # Creates the backup of the database and the files. If at least one of the
@@ -36,14 +37,43 @@ module Backup
 
       if @no_compress 
         copy_files 
+        delete_uncompressed_backups
       else
         compress_files_and_copy
+        delete_compressed_backups
       end
 
     end
 
     private
 
+    # Checks if the compressed backups exceed the max backups denoted by 
+    # @max_backups and respectively deletes the oldest files to meet the 
+    # @max_backups count. @max_backups less than 1 is equivalent to infinite 
+    # backup count, so no files will be deleted and 0 is returned otherwise 
+    # the count of files deleted is returned.
+    def delete_compressed_backups
+      return 0 if @max_backups < 1
+
+      pattern = "#{@backup_folder}*-*_syc-backup.tar.gz"
+      files = Dir.glob(pattern).sort_by {|f| File.mtime(f)}
+      
+      file_count_to_delete = [0, files.count-@max_backups].max
+      return 0 if file_count_to_delete == 0
+
+      files.first(file_count_to_delete).each {|f| File.delete f}
+
+      file_count_to_delete
+    end
+
+    # Checks if the uncompressed backups exceed the max backups denoted by 
+    # @max_backups and respectively deletes the oldest files to meet the 
+    # @max_backups count. @max_backups less than 1 is equivalent to infinite 
+    # backup count, so no files will be deleted and 0 is returned otherwise 
+    # the count of files deleted is returned.
+    def delete_uncompressed_backups
+    end
+
     # Checks if files to backup have been provided that don't exist. Returns the
     # inexistent files
     def check_for_inexistent_files

data/lib/backup/runner.rb

@@ -19,7 +19,7 @@ module Backup
     def run
       if @options.cron
         create_cron
-      else
+      elsif @options.database or @options.file
         create_backup
       end
     end
@@ -42,6 +42,7 @@ module Backup
                  ' -u'  + @options.user + 
                  ' -p'  + @options.password if @options.database
       command += ' -f ' + @options.files.join(',') if @options.files
+      command += ' -m ' + @options.max_backups if @options.max_backups
       command += ' --no-compress' if @options.no_compress
       command += ' --override' if @options.override
 
@@ -66,7 +67,8 @@ module Backup
       process = Process.new(@options.backup_folder,
                             files, 
                             @options.override, 
-                            @options.no_compress)
+                            @options.no_compress,
+                            @options.max_backups)
       process.backup
       puts "--> backed up files"
       puts "    #{files.join("\n    ")}"

data/lib/backup_version.rb

@@ -5,5 +5,5 @@
 # per default compressed but this can be ommitted
 module Backup
   # Version of the application
-  VERSION = '0.0.6'
+  VERSION = '0.0.7'
 end

data/sycbackup.gemspec

@@ -4,8 +4,7 @@ require 'backup_version'
 Gem::Specification.new do |s|
   s.name         = "syc-backup"
   s.summary      = %q{Back up a database and files}
-  s.description  = %q{Back up a database and files or schedule cron job 
-                      for backup}
+  s.description  = File.read(File.join(File.dirname(__FILE__), 'README.rdoc'))
   s.requirements = ['No requirements']
   s.version      = Backup::VERSION
   s.author       = "Pierre Sugar"

data/test/test_process.rb

@@ -19,6 +19,7 @@ class TestProcess < Test::Unit::TestCase
     def teardown
       @files.each {|f| File.delete f}
       Dir["test/backup_p/*"].each {|f| File.delete f if File.file? f}
+      FileUtils.remove_dir "test/backup_p" if File.exists? "test/backup_p" 
     end
 
     should "backup files to provided folder without compressing" do
@@ -35,6 +36,35 @@ class TestProcess < Test::Unit::TestCase
       assert_equal 1, Dir["test/backup_p/*.tar.gz"].size
     end
 
+    should "delete backups according to --max-backups" do
+      pro = Backup::Process.new("test/backup_p/", @files, false, false, 3)
+      4.times.with_index do |i|
+        assert_equal i, Dir["test/backup_p/*.tar.gz"].size
+        pro.backup
+        print "."
+        sleep 1
+      end
+      assert_equal 3, Dir["test/backup_p/*.tar.gz"].size
+    end
+    
+    should "don't delete backups due to max backups count < 1" do
+      pro = Backup::Process.new("test/backup_p/", @files, false, false, 0)
+      2.times.with_index do |i|
+        pro.backup
+        print "."
+        sleep 1
+      end
+      assert_equal 2, Dir["test/backup_p/*.tar.gz"].size
+
+      pro = Backup::Process.new("test/backup_p/", @files, false, false, -3)
+      2.times.with_index do |i|
+        pro.backup
+        print "."
+        sleep 1
+      end
+      assert_equal 4, Dir["test/backup_p/*.tar.gz"].size
+    end
+
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: syc-backup
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,17 +9,51 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-04 00:00:00.000000000 Z
+date: 2013-02-07 00:00:00.000000000 Z
 dependencies: []
-description: ! "Back up a database and files or schedule cron job \n                      for
-  backup"
+description: ! "= Backup utility for database, folders and files\nBacks up a MySQL
+  database, folders and files to a default folder (~/backup) or to a specified folder.
+  If the --cron switch is provided the specified database and files are not backed
+  up rather a cron job of the provided command is added to crontab.\n\n== Install\nThe
+  application can be installed with\n    $ gem install syc-backup\n\n== Usage\nBackup
+  a database to the default folder _~/backup_\n    $ sycbackup -d database -uuser
+  -ppass\n\nBackup a MySQL database, a directory and files to the default folder\n
+  \   $ sycbackup -d database -uuser -ppass -f directory,file1,file2\n\nSpecify a
+  backup folder\n    $ sycbackup backup/folder -d database -uuser -ppass -f directory,file1,file2\n\nOverride
+  files in the backup folder if they exist\n    $ sycbackup backup/folder --override
+  -f directory,file1,file2\n\nDon't compress the backup\n    $ sycbackup --no-compress
+  -f directory,file1,file2\n\nCreate a cron job that is scheduled every day at 2:30\n
+  \   $ sycbackup -d database -uuser -ppass -f directory,file1 --cron 30,2,*,*,*\n\nIf
+  the user or password contains characters as '(' you have to escape\nthem. A password
+  like 123(56 has to be provided with pass\\\"123\\(56\\\".\n\n== Usage of --override
+  and --no-compress\nWhether the backup directory and the backup files are time stamped
+  depends how\n--override and --no-compress is set. The results are shown in the table
+  below.\n\n    --override      --no-compress     backup directory      backup file(s)\n
+  \        0                0            w/o timestamp         w/ timestamp\n         1
+  \               0            w/o timestamp         w/ timestamp\n         0                1
+  \           w/  timestamp         uncompressed\n         1                1            w/o
+  timestamp         uncompressed\n\n== Supported Platform\nsyc-backup has been tested
+  with 1.9.3\n\n== Notes\nThe application backs up the MySQL database with _mysqldump_.
+  The dumpfile has the form yyyymmdd-HHMMSS_databasename.sql. After the files are
+  backed up the dumpfile will be deleted.\n\nIf the --no-compress is provided the
+  files are copied to the backup folder. Otherwise they are compressed with _tar cfz
+  YYYYmmdd-HHMMSS_syc-backup.tar.gz_.\n\nIf the --override switch is not provided
+  the backup directory will be added a timestamp. So if you create a cron job you
+  should every now and then delete obsolete backup folders.\n\nThe source contains
+  lib/backup/file_backup.rb which is not used in the application.\n    \n== Tests\nThe
+  tests create folders and files and will be deleted after the tests finish. _MySQLBackup_
+  needs to run a MySQL database with a database _test_ and a user _user_ with the
+  password _pass_.\n\nThe test files live in the test folder and begin with test_.\n\nThere
+  is a rake file available which can be used to run all tests with\n    $ rake test\n\n==
+  Links\n* [http://sugaryourcoffee.github.com/syc-backup] - RubyDoc\n* [http://www.github.com/sugaryourcoffee/syc-backup]
+  - Source code on GitHub\n* [http://syc.dyndns.org/drupal/content/backup-drupal-database]
+  - Development notebook\n* [https://rubygems.org/gems/syc-backup] - RubyGems\n"
 email: pierre@sugaryourcoffee.de
 executables:
 - sycbackup
 extensions: []
 extra_rdoc_files: []
 files:
-- syc-backup-0.0.5.gem
 - README.rdoc
 - test/test_process.rb
 - test/test_mysql_backup.rb
@@ -86,6 +120,7 @@ files:
 - doc/rdoc.css
 - doc/TestMySQLBackup.html
 - doc/TestOptions.html
+- syc-backup-0.0.6.gem
 - bin/sycbackup
 - Rakefile
 homepage: http://syc.dyndns.org/drupal