backup_cleaner 1.0.0.pre1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Brian Alexander
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,17 @@
+= backup_cleaner
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Brian Alexander. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "backup_cleaner"
+    gem.summary = %Q{A command-line script for cleaning up old backups}
+    gem.description = %Q{A command-line script for cleaning up old backups}
+    gem.email = "balexand@gmail.com"
+    gem.homepage = "http://github.com/balexand/backup_cleaner"
+    gem.authors = ["Brian Alexander"]
+    gem.add_dependency "activesupport", ">= 3.0.0"
+    gem.add_dependency "trollop", ">= 0"
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "backup_cleaner #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0.pre1

data/backup_cleaner.gemspec

@@ -0,0 +1,64 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{backup_cleaner}
+  s.version = "1.0.0.pre1"
+
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Brian Alexander"]
+  s.date = %q{2010-10-09}
+  s.default_executable = %q{backup_cleaner}
+  s.description = %q{A command-line script for cleaning up old backups}
+  s.email = %q{balexand@gmail.com}
+  s.executables = ["backup_cleaner"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "backup_cleaner.gemspec",
+     "bin/backup_cleaner",
+     "lib/backup_cleaner.rb",
+     "lib/backup_cleaner/cli.rb",
+     "test/helper.rb",
+     "test/test_backup_cleaner.rb"
+  ]
+  s.homepage = %q{http://github.com/balexand/backup_cleaner}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A command-line script for cleaning up old backups}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_backup_cleaner.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 3.0.0"])
+      s.add_runtime_dependency(%q<trollop>, [">= 0"])
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 3.0.0"])
+      s.add_dependency(%q<trollop>, [">= 0"])
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 3.0.0"])
+    s.add_dependency(%q<trollop>, [">= 0"])
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

data/bin/backup_cleaner

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# run this script with --help for instructions
+
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
+
+require 'backup_cleaner'
+require 'backup_cleaner/cli'
+
+BackupCleaner::Cli.run

data/lib/backup_cleaner/cli.rb

@@ -0,0 +1,39 @@
+require 'backup_cleaner'
+require 'trollop'
+
+module BackupCleaner
+  module Cli
+    def self.run
+      opts = Trollop::options do
+        banner <<-EOS
+Cleans up backup files or folders within the specified folder. The names of these files/folders must include the backup date \
+in a format like: YYYY-MM-DD. Any files/folders with names not matching this pattern will be left untouched. Between \
+today and <days> days ago, all backups will be kept. Between today and <weeks> weeks ago, weekly backups will be kept. For \
+all time, monthly backups will be kept. For weekly/monthly backups, the earliest available backup from the week/month will \
+be kept. For example, if daily backups are present then weekly backups will be from Sunday and monthly backups will be from\
+the 1st of the month.
+
+This script can also handle backups from multiple projects in one directory as long as they are named differently. If files \
+named aaa-2010-01-01.tar.gz and 2010-01-01.bbb.tar.bz2 exist then both will be kept. When comparing the names, only letters \
+are considered. For example, aaa-2010-01-01.tar.gz and aaa-2010-01-01.12.12.12.tar.gz.2 are considered to be from the same \
+backup project and unless these backups are from the last <days> days, one will be deleted.
+
+Usage:
+      clean_backups.rb [options] <folder>
+
+where [options] are:
+  EOS
+
+        opt :days, "Number of days for which to keep daily backups", :type => :int, :default => 14
+        opt :weeks, "Number of weeks for which to keep weekly backups", :type => :int, :default => 8
+        opt :dry_run, "Don't really delete anything, just print out what would have been deleted", :short => :n
+      end
+
+      folder = ARGV.shift
+      Trollop::die "No folder specified" unless folder
+
+      # clean the backups
+      BackupCleaner.clean_backups(folder, opts)
+    end
+  end
+end

data/lib/backup_cleaner.rb

@@ -0,0 +1,69 @@
+require 'active_support/time'
+require 'fileutils'
+require 'set'
+
+module BackupCleaner
+  DATE_PATTERN = /^(.*)(\d{4}[-\.]\d{2}[-\.]\d{2})(.*)$/
+
+  Entry = Struct.new :name, :date, :prefix, :suffix
+  GroupKey = Struct.new :date_property, :prefix, :suffix
+
+  def self.clean_backups(folder, opts = {})
+    days = opts[:days]
+    weeks = opts[:weeks]
+    dry_run = opts[:dry_run]
+
+    raise ArgumentError, "'days' option must have an integer value" unless days.is_a? Integer
+    raise ArgumentError, "'weeks' option must have an integer value" unless weeks.is_a? Integer
+    raise ArgumentError, "#{folder} should be a directory" unless File.directory? folder
+
+    entries = Dir.entries(folder).select { |name| DATE_PATTERN =~ name }.collect do |name|
+      m = DATE_PATTERN.match(name)
+      Entry.new(name, Date.parse(m[2]), m[1].gsub(/[^A-Za-z]/, ''), m[3].gsub(/[^A-Za-z]/, ''))
+    end
+
+    weekly_keepers = Set.new(first_by_date_property(entries, :week_ordering_number))
+    monthly_keepers = Set.new(first_by_date_property(entries, :month_ordering_number))
+
+    entries.each do |entry|
+        unless entry.date >= days.days.ago.to_date ||
+             (week_ordering_number(entry.date) >= week_ordering_number(weeks.weeks.ago.to_date) && weekly_keepers.member?(entry)) ||
+             monthly_keepers.member?(entry)
+        if dry_run
+          puts "pretending to delete (dry_run) #{entry.name}"
+        else
+          puts "deleting #{entry.name}"
+          FileUtils.rm_rf(File.join(folder, entry.name))
+        end
+      end
+    end
+  end
+
+  def self.first_by_date_property(entries, property_name)
+    # group entries by the specified date property plus file name prefix and suffix
+    groups = {}
+    entries.each do |entry|
+      group_key = GroupKey.new send(property_name, entry.date), entry.prefix, entry.suffix
+      groups[group_key] = {} unless groups.has_key? group_key
+      groups[group_key].merge!({entry.date => entry})
+    end
+
+    # return the earliest date in each group
+    groups.values.collect do |group|
+      group[group.keys.sort.first]
+    end
+  end
+  private_class_method :first_by_date_property
+
+  def self.week_ordering_number(date)
+    # cweek considers weeks to start on Monday; adjust so week starts on Sunday
+    date += 1.day if date.wday == 0
+    date.cweek + date.cwyear * 100
+  end
+  private_class_method :week_ordering_number
+
+  def self.month_ordering_number(date)
+    date.month + date.year * 100
+  end
+  private_class_method :month_ordering_number
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'backup_cleaner'
+
+class Test::Unit::TestCase
+end

data/test/test_backup_cleaner.rb

@@ -0,0 +1,108 @@
+require 'helper'
+require 'backup_cleaner'
+require 'mocha'
+
+class TestBackupCleaner < Test::Unit::TestCase
+
+  should "raise ArgumentError if invalid args passed to constructor" do
+    valid_opts = {:days => 14, :weeks => 2, :dry_run => true}
+    valid_folder = File.expand_path(Dir.pwd)
+
+    BackupCleaner.clean_backups(valid_folder, valid_opts)
+
+    # folder doesn't exist
+    assert_raises(ArgumentError) do
+      BackupCleaner.clean_backups('/paththatdoesntexist-asoiugsaoifaweasfoo', valid_opts)
+    end
+
+    # folder should be a String, not NilClass
+    assert_raises(TypeError) do
+      BackupCleaner.clean_backups(nil, valid_opts)
+    end
+
+    # missing days
+    assert_raises(ArgumentError) do
+      BackupCleaner.clean_backups(valid_folder, valid_opts.reject {|k,v| k == :days})
+    end
+
+    # days of invalid type
+    assert_raises(ArgumentError) do
+      BackupCleaner.clean_backups(valid_folder, valid_opts.merge(:days => "3"))
+    end
+
+    # missing weeks
+    assert_raises(ArgumentError) do
+      BackupCleaner.clean_backups(valid_folder, valid_opts.reject {|k,v| k == :weeks})
+    end
+
+    # weeks of invalid type
+    assert_raises(ArgumentError) do
+      BackupCleaner.clean_backups(valid_folder, valid_opts.merge(:weeks => nil))
+    end
+  end
+
+  should "clean correct backups" do
+    folder = "/foo/bar"
+
+    # mock todays date
+    fake_today_time = Time.parse("1981-12-18")
+    fake_today = fake_today_time.to_date
+    Time.expects(:current).at_least_once.returns(fake_today_time)
+
+    # create mock entries in a directory
+    entries = (0..180).collect {|i| "aaa-#{(fake_today-i).strftime('%Y-%m-%d')}.tar.gz"}
+    entries += ["1980-03-03-foo.tar.bz2", "1980-03-20-foo.tar.bz2",
+                "1980-03-03-bar.tar.bz2", "1980-03-20-bar.tar.bz2", "1980.03.21.2.bar.tar.bz2.3", "1981-03-15-bar.tar.bz2",
+                "nodate.txt"]
+    Dir.expects(:entries).once.with(folder).returns(entries)
+    File.expects(:directory?).at_least_once.with(folder).returns(true)
+
+    # we expect this list of entries to be deleted
+    dates_to_delete =
+      (22..30).collect {|i| "1981-06-%02d" % i} +
+      (2..31).collect {|i| "1981-07-%02d" % i} +
+      (2..31).collect {|i| "1981-08-%02d" % i} +
+      (2..30).collect {|i| "1981-09-%02d" % i} +
+      (2..31).collect {|i| "1981-10-%02d" % i} +
+      (2..7).collect {|i| "1981-11-%02d" % i} +
+      (9..14).collect {|i| "1981-11-%02d" % i} +
+      (16..21).collect {|i| "1981-11-%02d" % i} +
+      (23..28).collect {|i| "1981-11-%02d" % i} +
+      ["1981-11-30"] +
+      (2..3).collect {|i| "1981-12-%02d" % i}
+
+    entries_to_delete = dates_to_delete.collect {|date| "aaa-#{date}.tar.gz"}
+
+    entries_to_delete += ["1980-03-20-foo.tar.bz2", "1980-03-20-bar.tar.bz2", "1980.03.21.2.bar.tar.bz2.3"]
+
+    entries_to_delete.each do |entry|
+      FileUtils.expects(:rm_rf).with(File.join(folder, entry)).once
+    end
+
+    backup_cleaner = BackupCleaner.clean_backups(folder, :days => 14, :weeks => 5)
+  end
+
+  should "not delete anything if :dry_run specified" do
+    folder = "/foo/bar"
+    entries = ["1980-03-03-bar.tar.bz2", "1980-03-20-bar.tar.bz2"]
+    Dir.expects(:entries).once.with(folder).returns(entries)
+    File.expects(:directory?).at_least_once.with(folder).returns(true)
+
+    # assert that nothing is deleted
+    FileUtils.expects(:rm_rf).never
+
+    backup_cleaner = BackupCleaner.clean_backups(folder, :days => 14, :weeks => 5, :dry_run => true)
+  end
+
+  should "return correct week number if week_ordering_number is called" do
+    # make private method public for testing
+    BackupCleaner.class_eval "public_class_method :week_ordering_number"
+
+    assert BackupCleaner.week_ordering_number(Date.new(2010, 12, 26)) == 201052
+    assert BackupCleaner.week_ordering_number(Date.new(2011, 01, 01)) == 201052
+    2.upto(8) {|i| assert BackupCleaner.week_ordering_number(Date.new(2011, 1, i)) == 201101}
+    assert BackupCleaner.week_ordering_number(Date.new(2011, 1, 9)) == 201102
+
+    BackupCleaner.class_eval "private_class_method :week_ordering_number"
+  end
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification 
+name: backup_cleaner
+version: !ruby/object:Gem::Version 
+  hash: -1876988176
+  prerelease: true
+  segments: 
+  - 1
+  - 0
+  - 0
+  - pre1
+  version: 1.0.0.pre1
+platform: ruby
+authors: 
+- Brian Alexander
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-09 00:00:00 -07:00
+default_executable: backup_cleaner
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: trollop
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: A command-line script for cleaning up old backups
+email: balexand@gmail.com
+executables: 
+- backup_cleaner
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- backup_cleaner.gemspec
+- bin/backup_cleaner
+- lib/backup_cleaner.rb
+- lib/backup_cleaner/cli.rb
+- test/helper.rb
+- test/test_backup_cleaner.rb
+has_rdoc: true
+homepage: http://github.com/balexand/backup_cleaner
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 25
+      segments: 
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A command-line script for cleaning up old backups
+test_files: 
+- test/helper.rb
+- test/test_backup_cleaner.rb