file-visitor 0.1.0

data/lib/file/visitor/time_utils.rb

@@ -0,0 +1,94 @@
+
+require "time"
+
+class File
+  class Visitor
+  end
+end
+
+module File::Visitor::TimeUtils
+
+  UNIT_SEC = {
+    :sec   => 1,
+    :min   => 60,
+    :hour  => 60 * 60,
+    :day   => 60 * 60 * 24,
+    :month => 60 * 60 * 24 * 31,
+    :year  => 60 * 60 * 24 * 365
+  }
+  # aliases
+  UNIT_SEC.merge!({
+    :secs    => UNIT_SEC[:sec],
+    :second  => UNIT_SEC[:sec],
+    :seconds => UNIT_SEC[:sec],
+    :mins    => UNIT_SEC[:min],
+    :minute  => UNIT_SEC[:min],
+    :minutes => UNIT_SEC[:min],
+    :hours   => UNIT_SEC[:hour],
+    :days    => UNIT_SEC[:day],
+    :months  => UNIT_SEC[:month],
+    :years   => UNIT_SEC[:year],
+  })
+
+  COMPARATOR = [
+    :equals_to,
+    :==,
+    :is_greater_than,
+    :is_younger_than,
+    :>,
+    :is_greater_than=,
+    :is_younger_than=,
+    :>=,
+    :is_less_than,
+    :is_older_than,
+    :<,
+    :is_less_than=,
+    :is_older_than=,
+    :<=,
+  ]
+
+  def unitexp2sec(count, unit_name)
+    if (!count.is_a?(Fixnum) || count < 0)
+      raise ArgumentError,
+        "time count must be positive fixnum: #{count}"
+    end
+    if !UNIT_SEC[unit_name]
+      raise ArgumentError, "unknown time unit: #{unit_name}"
+    end
+    count * UNIT_SEC[unit_name]
+  end
+
+  def compare_time(time1, comparator, time2)
+    time1 = to_time(time1)
+    time2 = to_time(time2)
+
+    unless COMPARATOR.include?(comparator)
+      raise ArgumentError,
+        "invalid comparator: #{comparator.to_s}"
+    end
+
+    case comparator
+    when :equals_to, :==
+      return time1 == time2
+    when :is_greater_than, :is_younger_than, :>
+      return time1 > time2
+    when :is_greater_than=, :is_younger_than=, :>=
+      return time1 >= time2
+    when :is_less_than, :is_older_than, :<
+      return time1 < time2
+    when :is_less_than=, :is_older_than=, :<=
+      return time1 <= time2
+    else
+      raise RuntimeError,
+        "invalid comparator: #{comparator.to_s}"
+    end
+  end
+
+  def to_time(time)
+    return time if time.is_a?(Time)
+    return Time.parse(time) if time.is_a?(String)
+    raise ArgumentError, "invalid time: #{time.inspect}"
+  end
+
+end
+

data/spec/integration/use_case_spec.rb

@@ -0,0 +1,62 @@
+
+require 'file/visitor'
+require 'spec_utils'
+
+describe 'use case test' do
+  include SpecUtils
+
+  before(:each) do
+    setup_test_dir
+  end
+
+  context "collect log file" do
+
+    before(:each) do
+      @path1 = create_file(['log', '2013-01'], '2013-01-01.log', 'a')
+      @path2 = create_file(['log', '2013-02'], '2013-02-02.log', 'b')
+      @path3 = create_file(['log', '2013-02'], '2013-02-03.log', 'c')
+      @path4 = create_file(['log', '2013-01'], '2013-01-03.txt', 'd')
+    end
+
+    it 'removes 2013-02 logs' do
+      visitor = File::Visitor.new
+      visitor.add_filter(:ext, :log)
+      visitor.add_filter { |path| path =~ /2013\-02/ }
+
+      FileUtils.stub!(:rm).with(@path2)
+      FileUtils.stub!(:rm).with(@path3) 
+
+      visitor.visit(test_dir) do |path|
+        FileUtils.rm(path)
+      end
+    end
+
+    it 'removes old logs' do
+      time1 = Time.parse("2013-01-01 00:00:00")
+      time2 = Time.parse("2013-01-02 00:00:00")
+      time3 = Time.parse("2013-01-03 00:00:00")
+      time4 = Time.parse("2013-01-04 00:00:00")
+
+      File.utime(time1, time1, @path1)
+      File.utime(time2, time2, @path2)
+      File.utime(time3, time3, @path3)
+      File.utime(time4, time4, @path4)
+
+      Time.stub!(:now).and_return(Time.parse("2013-01-04 22:00:00"))
+
+      visitor = File::Visitor.new
+      visitor.add_filter(:mtime, :passed, 1, :day)
+
+      visitor.file_list(test_dir).should == [@path1, @path2, @path3]
+
+      visitor.add_filter(:mtime, :passed, 2, :days)
+      visitor.file_list(test_dir).should == [@path1, @path2]
+
+      visitor.add_filter(:mtime, :passed, 3, :days)
+      visitor.file_list(test_dir).should == [@path1]
+    end
+
+  end
+
+end
+

data/spec/lib/file/vistor/filter/ext_spec.rb

@@ -0,0 +1,23 @@
+
+require 'file/visitor/filter/ext'
+
+describe File::Visitor::Filter::Ext do
+
+  it 'can be created with String/Symbol' do
+    filter = File::Visitor::Filter::Ext.new(:txt)
+    filter = File::Visitor::Filter::Ext.new("txt")
+  end
+
+  it 'can match filename extention' do
+    filter = File::Visitor::Filter::Ext.new(:txt)
+    filter.match?("/path/to/file.txt").should be_true
+    filter.match?("/path/to/file.dat").should be_false
+  end
+
+  it 'can be stringified' do
+    filter = File::Visitor::Filter::Ext.new(:jpg)
+    filter.to_s.should == "File::Visitor::Filter::Ext[.jpg]"
+  end
+
+end
+

data/spec/lib/file/vistor/filter/mtime_spec.rb

@@ -0,0 +1,116 @@
+
+require 'file/visitor/filter/mtime'
+require 'spec_helper'
+require 'fileutils'
+require 'time'
+
+describe File::Visitor::Filter::Mtime do
+
+   before(:each) do
+     @ns = File::Visitor::Filter::Mtime
+     cleanup_spec_data_dir
+   end
+
+   after(:each) do
+     cleanup_spec_data_dir
+   end
+
+   it "can be created with comparator/target_time" do
+    filter = @ns.new(:equals_to, Time.now)
+    filter.should be_a @ns
+   end
+
+   context ":passed" do
+
+     it ":passed initialize" do
+       Time.stub!(:now).and_return(
+         Time.parse("2013-01-05 05:00"))
+
+       filter1 = @ns.new(:passed, 2, :days)
+
+       file1 = spec_data_create("file1")
+       file2 = spec_data_create("file2")
+       file3 = spec_data_create("file3")
+       file4 = spec_data_create("file4")
+
+       time1 = Time.parse("2013-01-03 04:59")
+       time2 = Time.parse("2013-01-03 05:00")
+       time3 = Time.parse("2013-01-03 05:01")
+       time4 = Time.parse("2013-01-04 05:00")
+
+       File.utime(time1, time1, file1)
+       File.utime(time2, time2, file2)
+       File.utime(time3, time3, file3)
+       File.utime(time4, time4, file4)
+
+       filter1.match?(file1).should be_true
+       filter1.match?(file2).should be_false
+       filter1.match?(file3).should be_false
+       filter1.match?(file4).should be_false
+
+       filter2 = @ns.new(:passed=, 2, :days)
+       filter2.match?(file1).should be_true
+       filter2.match?(file2).should be_true
+       filter2.match?(file3).should be_false
+       filter2.match?(file4).should be_false
+     end
+
+   end
+
+   it "raises error with invalid comparator" do
+     expect { @ns.new(:invalid, Time.now) }.to \
+       raise_error(ArgumentError, %r/comparator must/)
+   end
+
+   it "raises error with non-Time instance" do
+     expect { @ns.new(:equals_to, :now) }.to \
+       raise_error(ArgumentError, %r/time must be/)
+   end
+
+   context "match?" do
+
+     before(:each) do
+       @file1 = spec_data_create("file1")
+       @file2 = spec_data_create("file2")
+       @file3 = spec_data_create("file3")
+       @file4 = spec_data_create("file4")
+
+       @time1 = Time.parse("2013-01-05 00:00")
+       @time2 = Time.parse("2013-01-06 00:00")
+       @time3 = Time.parse("2013-01-07 00:00")
+       @time4 = Time.parse("2013-01-08 00:00")
+
+       File.utime(@time1, @time1, @file1)
+       File.utime(@time2, @time2, @file2)
+       File.utime(@time3, @time3, @file3)
+       File.utime(@time4, @time4, @file4)
+     end
+
+     it "supports eq filter" do
+       filter = @ns.new(:equals_to, @time2)
+       filter.match?(@file1).should be_false
+       filter.match?(@file2).should be_true
+       filter.match?(@file3).should be_false
+       filter.match?(@file4).should be_false
+     end
+
+     it "supports lt filter" do
+       filter = @ns.new(:is_less_than, @time2)
+       filter.match?(@file1).should be_true
+       filter.match?(@file2).should be_false
+       filter.match?(@file3).should be_false
+       filter.match?(@file4).should be_false
+     end
+
+     it "supports gt filter" do
+       filter = @ns.new(:is_greater_than, @time2)
+       filter.match?(@file1).should be_false
+       filter.match?(@file2).should be_false
+       filter.match?(@file3).should be_true
+       filter.match?(@file4).should be_true
+     end
+
+   end
+
+end
+

data/spec/lib/file/vistor/filter/name_spec.rb

@@ -0,0 +1,40 @@
+
+require 'file/visitor/filter/name'
+
+describe File::Visitor::Filter::Name do
+
+  it 'can be created with new()' do
+    filter = File::Visitor::Filter::Name.new('hoge')
+  end
+
+  it 'can match filename string' do
+    filter = File::Visitor::Filter::Name.new('file')
+
+    filter.match?("/path/to/file").should be_true
+    filter.match?("file").should be_true
+
+    filter.match?("file.txt").should be_false
+    filter.match?(".file").should be_false
+  end
+
+  it 'can match filename regexp' do
+    filter = File::Visitor::Filter::Name.new(/file\.\w+/)
+
+    filter.match?("/path/to/file.txt").should be_true
+    filter.match?("/path/to/xxx_file.txt").should be_true
+    filter.match?("file.jpg").should be_true
+
+    filter.match?("/path/to/file").should be_false
+  end
+
+  it 'can be stringified' do
+    str1 = File::Visitor::Filter::Name.new("strfilter").to_s
+    str2 = File::Visitor::Filter::Name.new(/filename\.\w+/).to_s
+
+    str1.should be_a String
+    str2.should be_a String
+
+    str1.should_not == str2
+  end
+
+end

data/spec/lib/file/vistor/filter/proc_spec.rb

@@ -0,0 +1,36 @@
+
+require 'file/visitor/filter/proc'
+
+describe File::Visitor::Filter::Proc do
+
+  it 'can be created with new()' do
+    filter = File::Visitor::Filter::Proc.new(proc { |path| true })
+  end
+
+  it 'raises error when non-proc instance given' do
+    expect {
+      filter = File::Visitor::Filter::Proc.new(true)
+    }.to raise_error(ArgumentError, /Proc instance required/)
+  end
+
+  it 'can match path with custom proc' do
+    filter = File::Visitor::Filter::Proc.new(proc { |path| 
+      path =~ /log/
+    })
+    filter.match?("/tmp/hoge/fuga.log").should be_true
+    filter.match?("/tmp/log/fuga.txt").should be_true
+    filter.match?("/tmp/hoge/fuga").should be_false
+  end
+  
+  it 'can be stringified' do
+    filter1 = File::Visitor::Filter::Proc.new(proc { true })
+    filter2 = File::Visitor::Filter::Proc.new(proc { false })
+
+    filter1.to_s.should be_a String
+    filter2.to_s.should be_a String
+
+    filter1.to_s.should_not == filter2.to_s
+  end
+
+end
+

data/spec/lib/file/vistor/filter_dispatcher_spec.rb

@@ -0,0 +1,26 @@
+
+require 'file/visitor/filter_dispatcher'
+
+describe File::Visitor::FilterDispatcher do
+
+  it "dispatches filter classname" do
+    File::Visitor::FilterDispatcher.dispatch(:name)\
+      .should == File::Visitor::Filter::Name
+    File::Visitor::FilterDispatcher.dispatch(:filename)\
+      .should == File::Visitor::Filter::Name
+
+    File::Visitor::FilterDispatcher.dispatch(:ext)\
+      .should == File::Visitor::Filter::Ext
+    File::Visitor::FilterDispatcher.dispatch(:extension)\
+      .should == File::Visitor::Filter::Ext
+    File::Visitor::FilterDispatcher.dispatch(:filetype)\
+      .should == File::Visitor::Filter::Ext
+
+    File::Visitor::FilterDispatcher.dispatch(:mtime)\
+      .should == File::Visitor::Filter::Mtime
+    File::Visitor::FilterDispatcher.dispatch(:modified_time)\
+      .should == File::Visitor::Filter::Mtime
+  end
+
+end
+

data/spec/lib/file/vistor/filter_spec.rb

@@ -0,0 +1,12 @@
+
+require 'file/visitor/filter'
+
+describe File::Visitor::Filter do
+
+  it "create filter namespace" do
+    File::Visitor::Filter.should_not be_nil
+
+  end
+
+end
+

data/spec/lib/file/vistor/time_utils_spec.rb

@@ -0,0 +1,156 @@
+
+require 'file/visitor/time_utils'
+
+describe File::Visitor::TimeUtils do
+  include File::Visitor::TimeUtils
+
+  describe 'unitexp2sec' do
+
+    it "returns seconds with unit string of time" do
+      unitexp2sec(1, :sec).should == 1
+      unitexp2sec(2, :sec).should == 2
+      unitexp2sec(3, :sec).should == 3
+
+      unitexp2sec(1, :min).should == 60
+      unitexp2sec(2, :min).should == 120
+      unitexp2sec(3, :min).should == 180
+
+      unitexp2sec(1, :hour).should == 60 * 60 * 1
+      unitexp2sec(2, :hour).should == 60 * 60 * 2
+      unitexp2sec(3, :hour).should == 60 * 60 * 3
+    end
+
+    it "returns seconds with unit string aliases" do
+      unitexp2sec(1, :second).should == 1
+      unitexp2sec(2, :seconds).should == 2
+      unitexp2sec(3, :secs).should == 3
+
+      unitexp2sec(1, :mins).should == 60
+      unitexp2sec(2, :minute).should == 120
+      unitexp2sec(3, :minutes).should == 180
+
+      unitexp2sec(1, :hours).should == 60 * 60 * 1
+      unitexp2sec(2, :days).should == 60 * 60 * 24 * 2
+      unitexp2sec(3, :months).should == 60 * 60 * 24 * 31 * 3
+    end
+
+    it "raises error with invalid count" do
+      expect { unitexp2sec(nil, :day) }.to \
+        raise_error(ArgumentError, %r/time count must be/)
+      expect { unitexp2sec(-1, :day) }.to \
+        raise_error(ArgumentError, %r/time count must be/)
+    end
+
+    it "raises error with invalid unit name" do
+      expect { unitexp2sec(1 , :nichi) }.to \
+        raise_error(ArgumentError, %r/unknown time unit/)
+    end
+
+  end
+
+  describe 'compare_time' do
+
+    it "supports equals_to" do
+      compare_time(
+        '2011-12-01 00:00:04',
+        :equals_to,
+        '2011-12-01 00:00:05'
+      ).should be_false
+
+      compare_time(
+        '2011-12-01 00:00:05',
+        :equals_to,
+        '2011-12-01 00:00:05'
+      ).should be_true
+
+      compare_time(
+        '2011-12-01 00:00:05',
+        :equals_to,
+        '2011-12-01 00:00:06'
+      ).should be_false
+    end
+
+    it "supports is_greater_than" do
+      compare_time(
+        '2011-12-01 00:00:04',
+        :is_greater_than,
+        '2011-12-01 00:00:05'
+      ).should be_false
+
+      compare_time(
+        '2011-12-01 00:00:05',
+        :is_greater_than,
+        '2011-12-01 00:00:05'
+      ).should be_false
+
+      compare_time(
+        '2011-12-01 00:00:06',
+        :is_greater_than,
+        '2011-12-01 00:00:05'
+      ).should be_true
+    end
+
+    it "supports is_greater_than=" do
+      compare_time(
+        '2011-12-01 00:00:04',
+        :is_greater_than=,
+        '2011-12-01 00:00:05'
+      ).should be_false
+
+      compare_time(
+        '2011-12-01 00:00:05',
+        :is_greater_than=,
+        '2011-12-01 00:00:05'
+      ).should be_true
+
+      compare_time(
+        '2011-12-01 00:00:06',
+        :is_greater_than=,
+        '2011-12-01 00:00:05'
+      ).should be_true
+    end
+
+    it "supports is_less_than" do
+      compare_time(
+        '2011-12-01 00:00:04',
+        :is_less_than,
+        '2011-12-01 00:00:05'
+      ).should be_true
+
+      compare_time(
+        '2011-12-01 00:00:05',
+        :is_less_than,
+        '2011-12-01 00:00:05'
+      ).should be_false
+
+      compare_time(
+        '2011-12-01 00:00:06',
+        :is_less_than,
+        '2011-12-01 00:00:05'
+      ).should be_false
+    end
+
+    it "supports is_less_than=" do
+      compare_time(
+        '2011-12-01 00:00:04',
+        :is_less_than=,
+        '2011-12-01 00:00:05'
+      ).should be_true
+
+      compare_time(
+        '2011-12-01 00:00:05',
+        :is_less_than=,
+        '2011-12-01 00:00:05'
+      ).should be_true
+
+      compare_time(
+        '2011-12-01 00:00:06',
+        :is_less_than=,
+        '2011-12-01 00:00:05'
+      ).should be_false
+    end
+
+  end
+
+end
+