roundup 0.1.0

data/CHANGELOG

@@ -0,0 +1,3 @@
+== 0.1.0 (2012-11-04)
+
+* Initial version.

data/README.md

@@ -0,0 +1,22 @@
+# Roundup
+
+* http://github.com/deepfryed/roundup
+
+## Description
+
+A simple snapshot cleaner to keep the right number of historical data backups.
+
+## Synopsis
+
+```ruby
+require 'roundup'
+
+Roundup.new(path: '/path/to/snapshots/**/*.gz', dryrun: false).clean!
+Roundup.new(path: '/path/to/snapshots/**/*.gz').files_to_keep   #=> [Array]
+Roundup.new(path: '/path/to/snapshots/**/*.gz').files_to_remove #=> [Array]
+Roundup.new(path: '/path/to/snapshots/**/*.gz', policy: {hourly: 24, daily: 30, monthly: 12}).clean!
+```
+
+## License
+
+BSD

data/lib/roundup.rb

@@ -0,0 +1,118 @@
+require 'logger'
+require 'fileutils'
+
+class Roundup
+  DEFAULT_POLICY = {:hourly => 48, :daily => 31, :monthly => 12}
+
+  attr_reader :path, :policy, :scanner
+
+  def initialize path, options = {}
+    @path    = path
+    @dryrun  = options.fetch(:dryrun,  true)
+    @verbose = options.fetch(:verbose, false)
+    @policy  = options.fetch(:policy,  DEFAULT_POLICY)
+    @scanner = options.fetch(:scanner, Scanner).new(path)
+  end
+
+  def files_to_keep
+    policy.map {|interval, n| scanner.find(interval).take(n)}.flatten.uniq
+  end
+
+  def files_to_remove
+    files - files_to_keep
+  end
+
+  def clean!
+    remove = files_to_remove
+
+    info 'deleting %d files' % remove.count
+    info remove.join($/) unless remove.empty?
+
+    if dryrun?
+      info 'dry run - so nothing deleted'
+    else
+      FileUtils.rm_f(remove)
+      info 'cleaned!'
+    end
+  end
+
+  private
+
+  def verbose?
+    !!@verbose
+  end
+
+  def logger
+    @logger ||= Logger.new($stdout)
+  end
+
+  def info message
+    logger.info(message) if verbose?
+  end
+
+  def dryrun?
+    @dryrun == true
+  end
+
+  class Scanner
+    DAYS = [nil, 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31]
+
+    attr_reader :path
+
+    def self.custom &block
+      Class.new(self).tap do |klass|
+        klass.send(:define_method, :created_time, &block)
+      end
+    end
+
+    def initialize path
+      @path = path
+    end
+
+    def find interval
+      send(interval)
+    end
+
+    private
+
+    def timeslice
+      time = nil
+      files.sort_by(&method(:created_time)).reverse.each_with_object([]) do |file, keep|
+        created_at = created_time(file)
+        if time.nil? or yield(time, created_at)
+          time  = created_at
+          keep << file
+        end
+      end
+    end
+
+    def hourly
+      timeslice {|a, b| (a - b) >= 3600}
+    end
+
+    def daily
+      timeslice {|a, b| (a - b) >= 86400}
+    end
+
+    def monthly
+      timeslice do |a, b|
+        case
+          when a < b
+            b - DAYS[a.month] * 86400 >= a
+          when a > b
+            a - DAYS[b.month] * 86400 >= b
+          else
+            false
+        end
+      end
+    end
+
+    def files
+      Dir[path]
+    end
+
+    def created_time file
+      File.stat(file).ctime
+    end
+  end # Scanner
+end # Roundup

data/test/helper.rb

@@ -0,0 +1,3 @@
+require 'minitest/mock'
+require 'minitest/autorun'
+require 'roundup'

data/test/test_roundup.rb

@@ -0,0 +1,48 @@
+require 'helper'
+require 'date'
+
+describe 'Roundup' do
+  before do
+    @files   = 10000.times.map {|n| (Time.now - (1800 * n)).strftime('snapshot-%Y%m%d%H%M%S.gz')}
+    @scanner = Roundup::Scanner.custom {|file| DateTime.strptime(file, 'snapshot-%Y%m%d%H%M%S').to_time}
+  end
+
+  it 'should keep hourlies' do
+    Dir.stub(:[], @files) do
+      roundup = Roundup.new('/tmp', policy: {hourly: 24}, scanner: @scanner)
+      roundup.files_to_keep.must_equal @files.select.with_index {|n, i| i.even? && i < 48}
+    end
+  end
+
+  it 'should keep dailies' do
+    Dir.stub(:[], @files) do
+      roundup = Roundup.new('/tmp', policy: {daily: 7}, scanner: @scanner)
+      roundup.files_to_keep.must_equal @files.select.with_index {|n, i| i % 48 == 0}.take(7)
+    end
+  end
+
+  it 'should keep monthlies' do
+    files = %w(
+      snapshot-20121103000000.gz
+      snapshot-20121102000000.gz
+      snapshot-20121101000000.gz
+      snapshot-20121003000000.gz
+      snapshot-20121004000000.gz
+      snapshot-20121002000000.gz
+      snapshot-20120903000000.gz
+      snapshot-20120902000000.gz
+      snapshot-20120901000000.gz
+      snapshot-20120803000000.gz
+      snapshot-20120802000000.gz
+      snapshot-20120801000000.gz
+      snapshot-20120701000000.gz
+      snapshot-20120723000000.gz
+      snapshot-20120725000000.gz
+    )
+
+    Dir.stub(:[], files) do
+      roundup = Roundup.new('/tmp', policy: {monthly: 12}, scanner: @scanner)
+      roundup.files_to_keep.must_equal files.select.with_index {|n, i| i % 3 == 0}
+    end
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: roundup
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Bharanee Rathna
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Clean periodic snaphots while keeping files that matter
+email:
+- deepfryed@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- test/helper.rb
+- test/test_roundup.rb
+- lib/roundup.rb
+- README.md
+- CHANGELOG
+homepage: http://github.com/deepfryed/roundup
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A file system cleaner for periodic snapshots
+test_files: []