surrender 0.8.2 → 0.8.3

data/README.md

@@ -22,7 +22,7 @@ Or install it yourself as:
 
 Acts as a filter, returning files which should be removed from a backup scheme:
 
-    $ find /var/backup/database -type f | sort | surrender --most-recent=7 --weekly=5 --monthly=12 --yearly=2 | xargs rm
+    $ find /var/backup/database -type f | sort | surrender --most-recent=7 --weekly=5 --monthly=12 --yearly=2 | xargs rm --verbose
 
 Would keep the most recent 7 files, irrespective of their dates, the 5 most recent
 weekly backups, the 12 most recent monthly backups, and the 2 most recent yearly
@@ -45,6 +45,32 @@ STDOUT, implying the file must be kept.
 Incidentally, all parameters to surrender are optional. The default values are the ones expressed above.
 surrender uses a constant amount of memory, related to the total number of files in the input stream.
 
+## Viewing the inner workings
+
+If you pass the `--verbose` option, Surrender will tell you how it arrived at it's decision:
+
+    $ for DATE in 2013-12-{10..20} ; do echo "backup.${DATE}.tar.gz" ; done | RUBYOPT=-Ilib bin/surrender --verbose
+    "backup.2013-12-10.tar.gz": most recent=delete, weekly=delete, monthly=delete, yearly=delete
+    "backup.2013-12-11.tar.gz": most recent=delete, weekly=delete, monthly=delete, yearly=delete
+    "backup.2013-12-12.tar.gz": most recent=delete, weekly=delete, monthly=delete, yearly=delete
+    "backup.2013-12-13.tar.gz": most recent=delete, weekly=delete, monthly=delete, yearly=delete
+    "backup.2013-12-14.tar.gz": most recent=keep, weekly=keep, monthly=delete, yearly=delete
+    "backup.2013-12-15.tar.gz": most recent=keep, weekly=delete, monthly=delete, yearly=delete
+    "backup.2013-12-16.tar.gz": most recent=keep, weekly=delete, monthly=delete, yearly=delete
+    "backup.2013-12-17.tar.gz": most recent=keep, weekly=delete, monthly=delete, yearly=delete
+    "backup.2013-12-18.tar.gz": most recent=keep, weekly=delete, monthly=delete, yearly=delete
+    "backup.2013-12-19.tar.gz": most recent=keep, weekly=delete, monthly=delete, yearly=delete
+    "backup.2013-12-20.tar.gz": most recent=keep, weekly=keep, monthly=keep, yearly=keep
+    backup.2013-12-10.tar.gz
+    backup.2013-12-11.tar.gz
+    backup.2013-12-12.tar.gz
+    backup.2013-12-13.tar.gz
+
+In this example, you can see that the `backup.2013-12-10.tar.gz` file was voted to be deleted by all
+policies, while `backup.2013-12-14.tar.gz` was voted to be kept by the most recent and weekly policies.
+
+The `--verbose` flag outputs to STDERR, keeping STDOUT clean.
+
 ## Contributing
 
 1. Fork it

data/bin/surrender

@@ -11,6 +11,8 @@ options = ARGV.each_with_object(Surrender::DEFAULT_ARGUMENTS.dup) do |arg, memo|
     memo[:monthly] = Integer($1)
   when /^--yearly=(\d+)$/
     memo[:yearly] = Integer($1)
+  when /^--verbose$/
+    memo[:verbose] = true
   else
     raise ArgumentError, "Unknown option #{arg.inspect}"
   end

data/lib/surrender/bucket_policy.rb

@@ -7,6 +7,10 @@ module Surrender
 
     attr_reader :count, :memo
 
+    def name
+      self.class.name.sub("Policy", "").sub("Surrender::", "").downcase
+    end
+
     def add(filename, date)
       memo[bucket(date)] = filename
       memo.delete(memo.keys.first) if memo.size > count

data/lib/surrender/most_recent_policy.rb

@@ -7,6 +7,10 @@ module Surrender
 
     attr_reader :count, :memo
 
+    def name
+      "most recent"
+    end
+
     def add(filename, _)
       memo << filename
       memo.shift if memo.size > count

data/lib/surrender/version.rb

@@ -1,3 +1,3 @@
 module Surrender
-  VERSION = "0.8.2"
+  VERSION = "0.8.3"
 end

data/lib/surrender.rb

@@ -7,6 +7,7 @@ require "date"
 
 module Surrender
   DEFAULT_ARGUMENTS = {
+    verbose: false,
     most_recent: 7,
     weekly: 5,
     monthly: 12,
@@ -21,6 +22,8 @@ module Surrender
     extra_keys = options.keys - DEFAULT_ARGUMENTS.keys
     raise ArgumentError, "Unknown keys: #{extra_keys.inspect} -- won't proceed" unless extra_keys.empty?
 
+    verbose = options[:verbose]
+
     policies = [
       Surrender::MostRecentPolicy.new(options.fetch(:most_recent)),
       Surrender::WeeklyPolicy.new(options.fetch(:weekly)),
@@ -41,6 +44,13 @@ module Surrender
     end
 
     deleteable = valid_filenames.select do |filename|
+      if verbose then
+        message = policies.map do |policy|
+          "#{policy.name}=#{policy.deleteable?(filename) ? "delete" : "keep"}"
+        end.join(", ")
+        STDERR.puts "#{filename.inspect}: #{message}"
+      end
+
       policies.all?{|policy| policy.deleteable?(filename)}
     end
 

data/spec/monthly_policy_spec.rb

@@ -5,6 +5,8 @@ describe Surrender::MonthlyPolicy do
   context "when count = 3" do
     subject { Surrender::MonthlyPolicy.new(3) }
 
+    it { subject.name.should == "monthly" }
+
     it "keeps the latest backup of the last three months" do
       subject.add "a", Date.new(2013, 3, 1)
       subject.add "b", Date.new(2013, 3, 15)

data/spec/most_recent_policy_spec.rb

@@ -5,6 +5,8 @@ describe Surrender::MostRecentPolicy do
   context "when count = 1" do
     subject { Surrender::MostRecentPolicy.new(1) }
 
+    it { subject.name.should == "most recent" }
+
     it "keeps the last entry only" do
       filename1 = "/var/backups/20130801.sql.gz"
       subject.add filename1, Date.new(2013, 8, 1)

data/spec/weekly_policy_spec.rb

@@ -5,6 +5,8 @@ describe Surrender::WeeklyPolicy do
   context "when count = 1" do
     subject { Surrender::WeeklyPolicy.new(1) }
 
+    it { subject.name.should == "weekly" }
+
     it "keeps the last filename per week" do
       subject.add "a", Date.new(2013, 8, 4)
       subject.deleteable?("a").should == false

data/spec/yearly_policy_spec.rb

@@ -5,6 +5,8 @@ describe Surrender::YearlyPolicy do
   context "when count = 2" do
     subject { Surrender::YearlyPolicy.new(2) }
 
+    it { subject.name.should == "yearly" }
+
     it "keeps the most recent filename of the last two years" do
       subject.add "a", Date.new(2011,  8, 9)
       subject.add "b", Date.new(2011,  9, 9)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: surrender
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.8.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-15 00:00:00.000000000 Z
+date: 2014-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -90,7 +90,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1928710586624369307
+      hash: 715898748471192036
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -99,7 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1928710586624369307
+      hash: 715898748471192036
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25