toreriklinnerud-clean-files 1.0.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 AlphaSights Ltd
+
+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,46 @@
+== Synopsis
+
+Executable to delete files fitting certain criteria. 
+
+The intended purpose is to delete backups older than a certain date,
+whilst keeping hourly, daily or weekly and so on backups. 
+
+Specifying an option like --hourly will keep the first file of the hour
+and delete the rest of the files created within the same hour, 
+provided that the those files were created before the threshold date.
+
+The executable does not itself create any backups, it is only 
+intended for cleaning up existing ones.
+
+== Usage
+
+  clean-files file_paths [options]
+
+For help use: clean-files -h
+== Options
+
+  -v, --verbose     Print name of files deleted
+  -p, --pretend     Implies -v, only prints what files would have been deleted
+  -r, --recursive   Delete directories as well as files
+  -t, --threshold   Time ago in days for when to start deleting files
+                    File newer than this date are never deleted. 
+                    The default is 30 days.
+                 
+                    For example: 
+
+                   -t 10 or --threshold=30
+                
+  -H, --hourly      Keep hourly files
+  -D, --daily       Keep daily files
+  -W, --weekly      Keep weekly files
+  -M, --monthly     Keep monthly files
+  -Y, --yearly      Keep yearly files
+
+== Examples
+
+  clean_files /backups/sql/*.sql --threshold 60 --daily
+  clean_files /Users/me/Downloads/* --pretend --verbose --recursive -t 10
+
+== Copyright
+
+Copyright (c) 2009 AlphaSights Ltd. See LICENSE for details.

data/bin/clean_files

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby 
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '/../lib'))
+require 'clean_files'
+
+app = CleanFiles.new(ARGV)
+app.run

data/lib/clean_files.rb

@@ -0,0 +1,92 @@
+require 'optparse' 
+require 'rdoc/usage'
+require 'active_support'
+require 'fileutils'
+
+require 'cleaner'
+
+class CleanFiles
+  VERSION = '0.1.0'
+  
+  attr_reader :options
+
+  def initialize(arguments)
+    @arguments = arguments
+    
+    # Set defaults
+    @options = Hash.new
+    @options[:threshold] = 1.month.ago
+  end
+
+  # Parse options, check arguments, then process the command
+  def run
+        
+    if parsed_options? && arguments_valid? 
+      Cleaner.new(@options.delete(:paths), @options).start
+    else
+      output_usage
+    end
+      
+  end
+  
+  protected
+  
+    def parsed_options?
+      
+      # Specify options
+      opts = OptionParser.new 
+      opts.on('-h', '--help')       { output_help }
+      opts.on('-v', '--verbose')    { @options[:verbose] = true }
+      opts.on('-d', '--pretend')    { @options[:pretend] = true 
+                                      @options[:verbose] = true }
+      opts.on('-r', '--recursive')  {@options[:recursive] = true }
+      
+      opts.on('-t', '--treshold [DAYS]')   do |days| 
+        raise OptionParser::InvalidOption unless days.to_i > 0 || days == "0"
+        @options[:threshold] = days.to_i.send(:days).ago
+      end
+      
+      Cleaner::VALID_INTERVALS.each do |interval|
+        opts.on("-#{interval.to_s.first.upcase}", "--#{interval}") {@options[interval] =  true}
+      end
+      return false unless opts.parse!(@arguments)
+      
+      @options[:paths] = @arguments.dup
+
+      true      
+    end
+
+    def arguments_valid?
+      @options[:paths].present?
+    end
+    
+    def output_help
+      rdoc
+      exit -1
+    end
+    
+    def output_usage
+      rdoc('Usage', 'Options')
+      exit -1
+    end
+    
+    def rdoc(*sections)
+      readme_path = File.join(File.dirname(__FILE__), '/../README.rdoc')
+      comment = File.read(readme_path)
+      
+      markup = SM::SimpleMarkup.new
+      flow_convertor = SM::ToFlow.new
+      flow = markup.convert(comment, flow_convertor)
+      format = "plain"
+      
+      unless sections.empty?
+        flow = RDoc.extract_sections(flow, sections)
+      end
+      
+      options = RI::Options.instance
+          
+      formatter = options.formatter.new(options, "")
+      formatter.display_flow(flow)
+    end
+        
+end

data/lib/cleaner.rb

@@ -0,0 +1,58 @@
+class Cleaner
+  
+  attr_reader :paths, :options
+  
+  VALID_OPTIONS    = [:threshold, :pretend, :verbose, :recursive]
+  VALID_INTERVALS  = [:hourly, :daily, :weekly, :monthly, :yearly]
+  TIME_INTERVALS   = [:hour,   :day,   :cweek, :month, :year]
+  
+  def initialize(paths, options = {})
+    @paths = [paths].flatten
+    @options = options.reverse_merge(:threshold => 30.days.ago)
+    options.assert_valid_keys(VALID_OPTIONS + VALID_INTERVALS)
+    given_intervals = VALID_INTERVALS & options.keys
+    if given_intervals.present?
+      lowest_selected_position = VALID_INTERVALS.index(given_intervals.first)
+      @key_intervals = TIME_INTERVALS[lowest_selected_position..-1]
+    end
+  end
+  
+  def start
+    files = files_to_delete.map(&:path)
+    puts files.join("\n") if options[:verbose]
+    FileUtils.rm_rf(files, :noop => !!options[:pretend])
+  end
+  
+  def files
+    @_files ||= paths.map do |file_path| 
+      begin 
+        File.new(file_path)
+      rescue Errno::EOPNOTSUPP
+        nil
+      rescue Errno::ENOENT => e
+        puts e.to_s
+        exit -2
+      end
+    end.compact.select do |file|
+      file.stat.file? || (options[:recursive] && file.stat.directory?)
+    end.sort_by(&:ctime)
+  end
+  
+  def files_to_delete
+    files_before_threshold - files_to_preserve
+  end
+  
+  def files_before_threshold
+    files.select{|file| file.ctime < options[:threshold]}
+  end
+  
+  def files_to_preserve
+    return [] if @key_intervals.nil?
+    files_before_threshold.group_by do |file|
+      cdate = file.ctime.to_datetime
+      @key_intervals.map{|interval| cdate.send(interval)}
+    end.map do |_, files|
+      files.first
+    end
+  end
+end

data/spec/cleaner_spec.rb

@@ -0,0 +1,117 @@
+require File.join(File.dirname(__FILE__), '/spec_helper')
+  
+describe Cleaner do
+  
+  it 'find files older than threshold' do
+    cleaner = Cleaner.new('/path', :threshold => 5.days.ago)
+    cleaner.should_receive(:files).and_return(mock_files(7.days.ago, 4.days.ago))
+    cleaner.files_before_threshold.should == mock_files(7.days.ago)
+  end
+  
+  it 'deletes files' do
+     cleaner = Cleaner.new('/path')
+     files = mock_files(3.days.ago, 2.days.ago, 7.days.ago)
+     cleaner.should_receive(:files_to_delete).and_return(files)
+     FileUtils.should_receive(:rm_rf).with(files.map(&:path), :noop => false)
+     cleaner.start
+  end
+  
+  it 'does not delete any files if specifying pretend => true' do
+     cleaner = Cleaner.new('/path', :pretend => true)
+     files = mock_files(3.days.ago, 2.days.ago, 7.days.ago)
+     cleaner.should_receive(:files_to_delete).and_return(files)
+     FileUtils.should_receive(:rm_rf).with(files.map(&:path), :noop => true)
+     cleaner.start
+  end
+  
+  it 'has has files to delete' do 
+    cleaner = Cleaner.new('/path')
+    cleaner.should_receive(:files_before_threshold).and_return(mock_files('12:00', '13:00'))
+    cleaner.should_receive(:files_to_preserve).and_return(mock_files('13:00'))
+    cleaner.files_to_delete.should == mock_files('12:00')
+  end
+  
+  it 'prints name of file to be deleted if specifying verbose => true' do
+     cleaner = Cleaner.new('/path', :verbose => true)
+     files = mock_files('00:50', '13:30')
+     cleaner.should_receive(:files_to_delete).and_return(files)
+     FileUtils.should_receive(:rm_rf).with(files.map(&:path), :noop => false)
+     cleaner.should_receive(:puts).with("01 May 00:50\n01 May 13:30")
+     cleaner.start
+  end
+  
+  it 'preserves the first file of the hour' do
+    should_preserve(:hourly, 
+      '12:05' => true, 
+      '12:10' => false,
+      '13:15' => true,
+      '13:16' => false)
+  end
+  
+  it 'preserves the first file of the day' do
+    should_preserve(:daily, 
+      '01 10:00' => true, 
+      '01 12:00' => false, 
+      '02 00:00' => true, 
+      '02 00:01' => false)
+  end
+  
+  it 'preserves the first file of the week' do
+    should_preserve(:weekly,
+      'Sun Jan 02 03:40 00' => true, 
+      'Tue Jan 04 03:40 00' => true, 
+      'Wed Jan 05 03:40 00' => false)
+  end
+  
+  it 'preserves the first file of the month' do
+    should_preserve(:monthly, 
+      'Sun Jan 02 12:00 00' => true, 
+      'Tue Feb 01 12:00 00' => true, 
+      'Wed Feb 02 12:00 00' => false)            
+  end
+  
+  it 'preserves the first file of the year' do
+    should_preserve(:yearly, 
+      'Sun Jan 02 03:40 01' => true, 
+      'Tue Jan 04 03:40 02' => true, 
+      'Wed Jan 05 03:40 02' => false)
+  end
+  
+  MockFile = Struct.new(:ctime) do
+    def ==(other)
+      (ctime.to_i - other.ctime.to_i) < 2
+    end
+    
+    def inspect
+      ctime.to_s(:short)
+    end
+    
+    def stat
+      stat = Object.new
+      def stat.file?
+        true
+      end
+      stat
+    end
+    
+    alias path inspect
+  end
+
+  def mock_files(*ctimes)
+    ctimes.map do |ctime|
+      if ctime.is_a?(String)
+        ctime = "1 #{ctime}" unless ctime =~ /\d\d /
+        ctime = "May #{ctime} 2009" unless ctime =~  /\d{2}/
+        ctime = Time.parse(ctime)
+      end
+      MockFile.new(ctime)
+    end
+  end
+  
+  def should_preserve(interval, files)
+    cleaner = Cleaner.new('/path', interval => true)
+    cleaner.should_receive(:files_before_threshold).and_return(mock_files(*files.keys.sort))
+    expected_files = files.select{|_, select| select == true}.map{|file, _| file}
+    cleaner.files_to_preserve.to_set.should == mock_files(*expected_files).to_set
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'spec'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'clean_files'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: toreriklinnerud-clean-files
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Tor Erik Linnerud
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-05 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: torerik.linnerud@alphasights.com
+executables: 
+- clean_files
+- clean_files
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- bin/clean_files
+- lib/clean_files.rb
+- lib/cleaner.rb
+- spec/cleaner_spec.rb
+- spec/spec_helper.rb
+- LICENSE
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/alphasights/clean-files
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Executable to delete files which fit certain criteria
+test_files: 
+- spec/cleaner_spec.rb
+- spec/spec_helper.rb