thinning 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in thinning.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Tobias Schwab
+
+MIT License
+
+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.md

@@ -0,0 +1,24 @@
+# Thinning
+
+Thinning helps you clean up backups when you want to keep e.g. hourly backups for a day, daily backups for amonth, etc…
+
+## Installation
+
+    $ gem install thinning
+
+## Usage
+	
+Thinning lists files which should be deleted according to a provided pattern.
+
+The command
+
+	thinning --hourly=24 --daily=14
+	
+will give you a list with all files which do not match the proivided pattern.
+
+In real world thinning could be used inside a cronjob like this:
+
+	find /path/to/backups/mysql/ -size +1G -name "*.sql.gz" | thinning --hourly=24 --daily=14 | xargs rm
+
+## License
+Thinning is released under the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/thinning

@@ -0,0 +1,48 @@
+#!/usr/bin/env ruby
+require "optparse"
+$:.push(File.expand_path("../../lib", __FILE__))
+require "thinning"
+require "thinning/file"
+require "thinning/cleaner"
+
+HOUR = 3600
+DAY = 24 * HOUR
+WEEK = 7 * DAY
+MONTH = 30 * DAY
+
+pattern = {}
+opts = OptionParser.new do |o|
+  o.on("-h HOURS", "--hourly", Integer, "hours to keep 1 file per hour") do |value|
+    pattern[:hourly] = value * HOUR
+  end
+
+  o.on("-d DAYS", "--daily", Integer, "days to keep 1 file per day") do |value|
+    pattern[:daily] = value * DAY
+  end
+
+  o.on("-w WEEKS", "--weekly", Integer, "weeks to keep 1 file per week") do |value|
+    pattern[:weekly] = value * WEEK
+  end
+
+  o.on("-m MONTHS", "--monthly", Integer, "months to keep 1 file per month") do |value|
+    pattern[:monthly] = value * MONTH
+  end
+end
+
+opts.parse(ARGV)
+
+abort opts.to_s if pattern.empty?
+if $stdin.tty?
+  $stderr.puts "ERROR: list of file must be provided though STDIN"
+  abort opts.to_s
+end
+
+def files_from_stream(stream)
+  STDIN.readlines.map(&:strip).map { |path| Thinning::File.new(path, File.mtime(path)) }
+end
+
+$stderr.puts "using pattern #{pattern.inspect}"
+
+Thinning::Cleaner.new(files_from_stream($stdin), pattern).files_to_delete.each do |file|
+  puts file.path
+end

data/lib/thinning/cleaner.rb

@@ -0,0 +1,55 @@
+module Thinning
+  class Cleaner
+    def initialize(files, pattern, now = Time.now)
+      @files = files
+      @pattern = pattern
+      @now = now
+    end
+
+    def files_to_delete
+      self.class.select_files_to_delete(@files, timestamps)
+    end
+
+    private
+
+    def timestamps
+      self.class.timestamps_for_pattern(@pattern, @now)
+    end
+
+    class << self
+      HOUR = 3600
+      DAY = 24 * HOUR
+
+      TYPE_MAPPING = {
+        :hourly => 1 * HOUR,
+        :daily=> 24 * HOUR,
+        :weekly => 7 * DAY,
+        :monthly => 30 * DAY,
+        :yearly => 365 * DAY
+      }
+
+      def select_files_to_delete(files, timestamps)
+        tmp_file = files.clone
+        timestamps.each do |ts|
+          if file = tmp_file.sort_by { |f| (f.timestamp - ts).abs }.first
+            tmp_file.delete(file)
+          end
+        end
+        tmp_file
+      end
+
+      def timestamps_for_pattern(pattern, now = Time.now)
+        stamps = []
+        pattern.each_pair do |type, duration|
+          current = now
+          step = TYPE_MAPPING.fetch(type)
+          while current > now - duration
+            stamps << current
+            current -= step
+          end
+        end
+        stamps.uniq
+      end
+    end
+  end
+end

data/lib/thinning/file.rb

@@ -0,0 +1,10 @@
+module Thinning
+  class File
+    attr_reader :path, :timestamp
+
+    def initialize(path, timestamp)
+      @path = path
+      @timestamp = timestamp
+    end
+  end
+end

data/lib/thinning/version.rb

@@ -0,0 +1,3 @@
+module Thinning
+  VERSION = "0.1.0"
+end

data/lib/thinning.rb

@@ -0,0 +1,8 @@
+require "thinning/version"
+
+module Thinning
+  # Your code goes here...
+end
+
+require "thinning/file"
+require "thinning/cleaner"

data/spec/lib/thinning/cleaner_spec.rb

@@ -0,0 +1,107 @@
+require "spec_helper"
+require "time"
+require "thinning"
+
+describe "Thinning::Cleaner" do
+  it "can be initialized" do
+    Thinning::Cleaner.new([], {}, Time.now)
+    Thinning::Cleaner.new([], {})
+  end
+
+  describe "#files_to_delete" do
+    it "returns the correct files" do
+      file01 = new_file("2012-01-01T03:00:00Z") # delte because too old
+      file02 = new_file("2012-01-02T03:00:00Z")
+      file03 = new_file("2012-01-03T03:00:00Z")
+      file04 = new_file("2012-01-04T03:00:00Z")
+      file05 = new_file("2012-01-05T03:00:00Z")
+      file06 = new_file("2012-01-06T03:00:00Z")
+      file07 = new_file("2012-01-07T02:00:00Z") # delete because not best matching
+      file08 = new_file("2012-01-07T03:00:00Z")
+      file09 = new_file("2012-01-08T01:00:00Z") # delete because 3 hours ago
+      file10 = new_file("2012-01-08T02:00:00Z")
+      file11 = new_file("2012-01-08T03:00:00Z")
+
+      files = [file01, file02, file03, file04, file05, file06, file07, file08, file09, file10, file11]
+
+      now = Time.parse("2012-01-08T03:00:00Z")
+
+      cleaner = Thinning::Cleaner.new(files, { hourly: 2 * 3600, daily: 7 * 24 * 3600 }, now)
+
+      cleaner.send(:timestamps).count.should == 8
+      to_delete = cleaner.files_to_delete.should
+      to_delete.should == [
+        file01, file07, file09
+      ]
+    end
+  end
+
+  def new_file(time, path = nil)
+    path ||= "/some/path/#{rand(1000)}"
+    Thinning::File.new(path, Time.parse(time))
+  end
+
+  let(:time) { Time.parse("2012-01-10T00:00:00Z") }
+
+  describe "#timestamps_for_pattern" do
+    it "returns the correct timestamps" do
+      stamps = Thinning::Cleaner.timestamps_for_pattern({ :hourly => 2 * 3600 }, time)
+      stamps.should == [Time.parse("2012-01-10T00:00:00Z"), Time.parse("2012-01-09T23:00Z")]
+    end
+
+    it "returns more complex timestamps" do
+      stamps = Thinning::Cleaner.timestamps_for_pattern({ :hourly => 2 * 3600, daily: 3600 * 24 * 7 }, time)
+      stamps.should == [
+        Time.parse("2012-01-10T00:00:00Z"),
+        Time.parse("2012-01-09T23:00:00Z"),
+        Time.parse("2012-01-09T00:00:00Z"),
+        Time.parse("2012-01-08T00:00:00Z"),
+        Time.parse("2012-01-07T00:00:00Z"),
+        Time.parse("2012-01-06T00:00:00Z"),
+        Time.parse("2012-01-05T00:00:00Z"),
+        Time.parse("2012-01-04T00:00:00Z")
+      ]
+    end
+
+    it "returns the correct pattern for daily" do
+      stamps = Thinning::Cleaner.timestamps_for_pattern({ :daily => 2592000 }, time)
+      stamps.count.should == 30
+    end
+  end
+
+  describe "#select_files_to_delete" do
+    it "returns an array" do
+      files = []
+      timestamps = []
+      now = Time.parse("2012-01-03T00:00:00Z")
+      to_keep = Thinning::Cleaner.select_files_to_delete(files, timestamps)
+      to_keep.should be_kind_of(Array)
+    end
+
+    it "returns the correct files" do
+      file1 = new_file("2012-01-01T00:00:00Z")
+      file2 = new_file("2012-01-01T01:00:00Z")
+      file3 = new_file("2012-01-01T02:00:00Z")
+      file4 = new_file("2012-01-01T03:00:00Z")
+      files = [file1, file2, file3, file4]
+
+      timestamps = [file1.timestamp, file3.timestamp]
+      to_delete = Thinning::Cleaner.select_files_to_delete(files, timestamps)
+      to_delete.should == [file2, file4]
+    end
+
+    it "returns the correct files without exact matches" do
+      file1 = new_file("2012-01-01T23:59:00Z")
+      file2 = new_file("2012-01-02T00:59:00Z")
+      file3 = new_file("2012-01-02T01:59:00Z")
+      file4 = new_file("2012-01-02T02:00:00Z")
+      file5 = new_file("2012-01-02T03:00:00Z")
+      files = [file1, file2, file3, file4]
+
+      timestamps = [file1.timestamp, file4.timestamp]
+      to_delete = Thinning::Cleaner.select_files_to_delete(files, timestamps)
+      to_delete.should == [file2, file3]
+      files.should == [file1, file2, file3, file4]
+    end
+  end
+end

data/spec/lib/thinning/file_spec.rb

@@ -0,0 +1,8 @@
+require "spec_helper"
+require "thinning/file"
+
+describe "Thinning::File" do
+  it "can be initialzied" do
+    file = Thinning::File.new("/path", Time.now)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+RSpec.configure do |c|
+  c.treat_symbols_as_metadata_keys_with_true_values = true
+  c.filter_run :focus => true
+  c.run_all_when_everything_filtered = true
+end
+
+$:.push(File.expand_path("../../lib", __FILE__))
+require "thinning"

data/thinning.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'thinning/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "thinning"
+  gem.version       = Thinning::VERSION
+  gem.authors       = ["Tobias Schwab"]
+  gem.email         = ["tobias.schwab@dynport.de"]
+  gem.summary       = %q{Cleanup backup files}
+  gem.description   = %q{Display a list of files to be deleted by a specific pattern (e.g. keep hourly backups for 1 day, dauly for 90 days, etc)}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.add_dependency "active_support"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "guard"
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: thinning
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Tobias Schwab
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: active_support
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: guard
+  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: Display a list of files to be deleted by a specific pattern (e.g. keep
+  hourly backups for 1 day, dauly for 90 days, etc)
+email:
+- tobias.schwab@dynport.de
+executables:
+- thinning
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/thinning
+- lib/thinning.rb
+- lib/thinning/cleaner.rb
+- lib/thinning/file.rb
+- lib/thinning/version.rb
+- spec/lib/thinning/cleaner_spec.rb
+- spec/lib/thinning/file_spec.rb
+- spec/spec_helper.rb
+- thinning.gemspec
+homepage: ''
+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.23
+signing_key: 
+specification_version: 3
+summary: Cleanup backup files
+test_files:
+- spec/lib/thinning/cleaner_spec.rb
+- spec/lib/thinning/file_spec.rb
+- spec/spec_helper.rb