clean_files 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 37dff8ca32b3bb5589f6da10f5f432b6ee451915
-  data.tar.gz: 440c67a524f989b7fda79b8f476eac4e4351cf74
+  metadata.gz: c64267955da36b6816003e6e589ff0d14225e8ba
+  data.tar.gz: e57e92355da67ce51b39f4c7df3131d99d3c7191
 SHA512:
-  metadata.gz: e50503dc029b2af56a3b94d713b767c41859b42176e91c97ba2e5a924e60a513a1dbfc5e54395e2bcb3be8733f84770b40d082623cf6f76b6239fa172cbe5fcb
-  data.tar.gz: 7a85cdae3fdbd4a1c5d135a8b5cb1932726524fb4479c23a43ec5ce31d0df3bd89fc370dbf2d84314c64055f1eca8a1078c251e15635158c1d39992ccc50a5ae
+  metadata.gz: b527857e49d5497b7d5ea76f9e2574f9fbd0caaa2ea86d5b9ec64a0c4f8822f7457ed099ffcdd22e5f9ee9ffeafef285bd8b87ad2fa491d94f68c1c189ad41b5
+  data.tar.gz: b999c2eb25042e65f4fc7a0b1f582b478360c7d21c29f4d8893edea2a789dcf971f07d59adfec976a59b066d07355488219103d87658a7215b7f1e78c4395be1

data/bin/clean_files

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

data/clean_files.gemspec

@@ -2,21 +2,23 @@
 
 Gem::Specification.new do |s|
   s.name                      = "clean_files"
-  s.version                   = "1.0.1"
+  s.version                   = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors                   = ["Tor Erik Linnerud"]
-  s.date                      = %q{2009-05-05}
-  s.default_executable        = %q{clean_files}
-  s.email                     = %q{torerik.linnerud@alphasights.com}
+  s.date                      = "2009-05-05"
+  s.default_executable        = "clean_files"
+  s.email                     = "torerik.linnerud@alphasights.com"
   s.executables               = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   s.test_files                = s.files.grep(%r{^(test|spec|features)/})
   s.files                     = `git ls-files`.split($/)
   s.has_rdoc                  = true
-  s.homepage                  = %q{http://github.com/alphasights/clean-files}
+  s.homepage                  = "http://github.com/alphasights/clean_files"
   s.require_paths             = ["lib"]
-  s.summary                   = %q{Executable to delete files which fit certain criteria}
+  s.summary                   = "Executable to delete files which fit certain criteria"
+  s.description               = "Executable to delete files which fit certain criteria e.g. you can delete files older than 1 month keeping one weekly file"
   s.test_files                = s.files.grep(%r{^(test|spec|features)/})
+  s.license                   = 'MIT'
 
   s.add_dependency 'rake'
   s.add_dependency 'rspec'

data/lib/clean_files/cleaner.rb

@@ -0,0 +1,69 @@
+require 'active_support/core_ext'
+
+module CleanFiles
+  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]
+
+    SimpleFile = Struct.new(:path, :stat) do
+      delegate :ctime, :file?, :directory?, :to => :stat
+    end
+
+    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
+      if paths.any?{|path| path.include?('*')}
+        paths.map!{|path| Dir.glob(path)}
+        paths.flatten!
+      end
+      @_files ||= paths.map do |file_path|
+        begin
+          SimpleFile.new(file_path, File.stat(file_path))
+        rescue Errno::EOPNOTSUPP
+          nil
+        rescue Errno::ENOENT => e
+          puts e.to_s
+          exit -2
+        end
+      end.compact.select do |file|
+        file.file? || (options[:recursive] && file.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
+end

data/lib/clean_files/runner.rb

@@ -0,0 +1,90 @@
+require 'optparse'
+require 'active_support'
+require 'fileutils'
+
+require 'clean_files/cleaner'
+
+module CleanFiles
+  class Runner
+    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)
+
+        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
+end

data/lib/clean_files.rb

@@ -1,91 +1,4 @@
-require 'optparse'
-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
+require 'clean_files/runner'
 
+module CleanFiles
 end

data/spec/cleaner_spec.rb

@@ -1,117 +1,119 @@
 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
+
+module CleanFiles
+  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
-    
-    def inspect
-      ctime.to_s(:short)
+
+    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
-    
-    def stat
-      stat = Object.new
-      def stat.file?
-        true
+
+    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
-      stat
+
+      def inspect
+        ctime.to_s(:short)
+      end
+
+      def stat
+        stat = Object.new
+        def stat.file?
+          true
+        end
+        stat
+      end
+
+      alias path inspect
     end
-    
-    alias path inspect
-  end
 
-  def mock_files(*ctimes)
-    ctimes.map do |ctime|
-      if ctime.is_a?(String)
-        ctime = "1 May #{ctime}" unless ctime =~ /\d\d /
-        ctime = "May #{ctime} 2009" unless ctime =~  /\d{2}/
-        ctime = Time.parse(ctime)
+    def mock_files(*ctimes)
+      ctimes.map do |ctime|
+        if ctime.is_a?(String)
+          ctime = "1 May #{ctime}" unless ctime =~ /\d\d /
+          ctime = "May #{ctime} 2009" unless ctime =~  /\d{2}/
+          ctime = Time.parse(ctime)
+        end
+        MockFile.new(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
+
+    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
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: clean_files
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Tor Erik Linnerud
@@ -66,7 +66,8 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description: Executable to delete files which fit certain criteria e.g. you can delete
+  files older than 1 month keeping one weekly file
 email: torerik.linnerud@alphasights.com
 executables: []
 extensions: []
@@ -80,15 +81,17 @@ files:
 - Gemfile.lock
 - LICENSE
 - README.rdoc
-- VERSION.yml
 - bin/clean_files
+- clean_files-1.0.1.gem
 - clean_files.gemspec
 - lib/clean_files.rb
-- lib/cleaner.rb
+- lib/clean_files/cleaner.rb
+- lib/clean_files/runner.rb
 - spec/cleaner_spec.rb
 - spec/spec_helper.rb
-homepage: http://github.com/alphasights/clean-files
-licenses: []
+homepage: http://github.com/alphasights/clean_files
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options:

data/VERSION.yml

@@ -1,4 +0,0 @@
---- 
-:major: 1
-:minor: 0
-:patch: 1

data/lib/cleaner.rb

@@ -1,66 +0,0 @@
-require 'active_support/core_ext'
-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]
-
-  SimpleFile = Struct.new(:path, :stat) do
-    delegate :ctime, :file?, :directory?, :to => :stat
-  end
-
-  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
-    if paths.any?{|path| path.include?('*')}
-      paths.map!{|path| Dir.glob(path)}
-      paths.flatten!
-    end
-    @_files ||= paths.map do |file_path|
-      begin
-        SimpleFile.new(file_path, File.stat(file_path))
-      rescue Errno::EOPNOTSUPP
-        nil
-      rescue Errno::ENOENT => e
-        puts e.to_s
-        exit -2
-      end
-    end.compact.select do |file|
-      file.file? || (options[:recursive] && file.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