file-visitor 0.1.0

data/spec/lib/file/vistor_spec.rb

@@ -0,0 +1,197 @@
+
+require 'file/visitor'
+require 'spec_utils'
+
+describe File::Visitor do
+  include SpecUtils
+
+  before(:each) do
+    setup_test_dir
+    @visitor = File::Visitor.new
+  end
+
+  after(:all) do
+    clear_test_dir
+  end
+
+  it 'can be created with new()' do
+    visitor = File::Visitor.new
+    visitor.should be_a File::Visitor
+  end
+
+  describe 'file/directory traversal' do
+
+    it 'raises error on non-dir argument' do
+      expect { @visitor.visit(nil) }.to raise_error(ArgumentError)
+      expect { @visitor.visit(1) }.to raise_error(ArgumentError)
+      expect { @visitor.visit_dir(nil) }.to raise_error(ArgumentError)
+      expect { @visitor.visit_dir(1) }.to raise_error(ArgumentError)
+    end
+
+    it 'can visit given directory' do
+      create_file(['dir1'], 'file1', 'a')
+      create_file(['dir1'], 'file2', 'b')
+      create_file(['dir1'], 'file3', 'c')
+
+      files = []
+      @visitor.visit(test_dir) do |path|
+        files.push File.basename(path)
+      end
+
+      files.size.should == 3
+      files[0].should == "file1"
+      files[1].should == "file2"
+      files[2].should == "file3"
+    end
+
+    it 'can visit sibling directories' do
+      create_file(['dir1'], 'file10', 'a')
+      create_file(['dir2'], 'file11', 'b')
+      create_file(['dir3'], 'file12', 'c')
+
+      files = []
+      @visitor.visit(test_dir) do |path|
+        files.push File.basename(path)
+      end
+
+      files.size.should == 3
+      files[0].should == "file10"
+      files[1].should == "file11"
+      files[2].should == "file12"
+    end
+
+    it 'can visit deep directories' do
+      create_file(['sub'], 'file20', 'a')
+      create_file(['sub', 'subsub'], 'file21', 'b')
+      create_file(['sub', 'subsub', 'subsubsub'], 'file22', 'c')
+
+      files = []
+      @visitor.visit(test_dir) do |path|
+        files.push File.basename(path)
+      end
+
+      files.size.should == 3
+      files[0].should == "file20"
+      files[1].should == "file21"
+      files[2].should == "file22"
+    end
+
+    it 'return empty array when no target files' do
+      files = []
+      @visitor.visit(test_dir) do |path|
+        files.push File.basename(path)
+      end
+      files.should be_empty
+    end
+
+    it 'can do dir-only traversal' do
+      create_file(['dir1'], 'file', 'a')
+      create_file(['dir2-1'], 'file', 'a')
+      create_file(['dir2-1', 'dir2-2'], 'file', 'a')
+
+      dirs = []
+      @visitor.visit_dir(test_dir) do |path|
+        File.directory?(path).should be_true
+        dirs.push File.basename(path)
+      end
+
+      dirs.size.should == 3
+      dirs[0].should == "dir1"
+      dirs[1].should == "dir2-1"
+      dirs[2].should == "dir2-2"
+    end
+
+  end
+
+  it 'it can get files list' do
+    create_file(['dir1'], 'file1', 'a')
+    create_file(['dir2'], 'file2', 'b')
+    create_file(['dir2'], 'file3', 'c')
+
+    files = @visitor.file_list(test_dir)
+    files.size.should == 3
+
+    File.exist?(files[0]).should be_true
+    File.exist?(files[1]).should be_true
+    File.exist?(files[2]).should be_true
+
+    File.basename(files[0]).should == "file1"
+    File.basename(files[1]).should == "file2"
+    File.basename(files[2]).should == "file3"
+  end
+
+  it 'can get dir list' do
+    create_file(['dir1'], 'file1', 'a')
+    create_file(['dir2'], 'file2', 'b')
+    create_file(['dir2'], 'file3', 'c')
+
+    dirs = @visitor.dir_list(test_dir)
+    dirs.size.should == 2
+
+    File.directory?(dirs[0]).should be_true
+    File.directory?(dirs[1]).should be_true
+
+    File.basename(dirs[0]).should == "dir1"
+    File.basename(dirs[1]).should == "dir2"
+  end
+
+  context "filters registration" do
+
+    before(:each) do
+    end
+
+    it 'built-in filter' do
+      @visitor.add_filter(:name, '2013-01-01.log')
+      @visitor.filters.size.should == 1
+      @visitor.filters[0].should be_a File::Visitor::Filter::Name
+    end
+
+    it 'custom filter' do
+      class ValidCustomFilter
+        def match?
+          true
+        end
+      end
+      @visitor.add_filter(ValidCustomFilter.new)
+      @visitor.filters.size.should == 1
+      @visitor.filters[0].should be_a ValidCustomFilter
+    end
+
+    it "add custom filter fails on invalid class" do
+      class BrokenCustomFilter
+        # match? not implemented
+      end
+      expect {
+        @visitor.add_filter(BrokenCustomFilter.new)
+      }.to raise_error(ArgumentError, /must implement match\?\(\)/)
+    end
+
+    it 'block filter' do
+      @visitor.add_filter do |path|
+        path =~ /\./
+      end
+      @visitor.filters.size.should == 1
+      @visitor.filters[0].should be_a File::Visitor::Filter::Proc
+    end
+
+  end
+
+  describe "target?" do
+
+    it "all the paths are target, when no filters" do
+      @visitor.target?("/tmp").should be_true
+    end
+
+    it "filter AND combination" do
+      @visitor.add_filter(:ext, :txt)
+      @visitor.add_filter { |path| path =~ /feb/ }
+      
+      @visitor.target?("/tmp/2013-jan.txt").should be_false
+      @visitor.target?("/tmp/2013-feb.txt").should be_true
+      @visitor.target?("/tmp/2013-mar.txt").should be_false
+    end
+
+  end
+
+end
+

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+
+def spec_data_dir
+  data_dir = File.join(
+    File.dirname(__FILE__), "data_for_spec")
+  unless File.directory?(data_dir)
+    FileUtils.mkdir(data_dir)
+  end
+  data_dir
+end
+
+def cleanup_spec_data_dir
+  return unless File.directory?(spec_data_dir)
+  FileUtils.rm_rf(spec_data_dir)
+end
+
+def spec_data_create(filename)
+  path = File.join(spec_data_dir, filename)
+  file = File.open(path, "w") do |file|
+    file.puts "test"
+  end
+  path
+end
+

data/spec/spec_utils.rb

@@ -0,0 +1,33 @@
+
+require 'fileutils'
+
+module SpecUtils
+
+  def test_dir
+    File.join(File.dirname(__FILE__), 'data_for_test')
+  end
+
+  def clear_test_dir
+    FileUtils.rm_rf(test_dir)
+  end
+
+  def setup_test_dir
+    clear_test_dir
+    FileUtils.mkdir_p(test_dir)
+  end
+
+  def create_dir(dirs)
+    dirs.unshift test_dir
+    FileUtils.mkdir_p(File.join(dirs))
+  end
+
+  def create_file(dirs, filename, content)
+    dir  = create_dir(dirs)
+    path = File.join(dir, filename)
+    File.open(path, 'w') do |file|
+      file.puts content
+    end
+    path
+  end
+
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification 
+name: file-visitor
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- bonar
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-02-04 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 47
+        segments: 
+        - 2
+        - 8
+        - 0
+        version: 2.8.0
+  version_requirements: *id001
+  name: rspec
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 3
+        - 12
+        version: "3.12"
+  version_requirements: *id002
+  name: rdoc
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 63
+        segments: 
+        - 1
+        - 8
+        - 4
+        version: 1.8.4
+  version_requirements: *id003
+  name: jeweler
+  prerelease: false
+description: you can collect file paths by mtime/name/ext/block filters.
+email: bonar@me.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/file/visitor.rb
+- lib/file/visitor/filter.rb
+- lib/file/visitor/filter/ext.rb
+- lib/file/visitor/filter/mtime.rb
+- lib/file/visitor/filter/name.rb
+- lib/file/visitor/filter/proc.rb
+- lib/file/visitor/filter_dispatcher.rb
+- lib/file/visitor/time_utils.rb
+- spec/integration/use_case_spec.rb
+- spec/lib/file/vistor/filter/ext_spec.rb
+- spec/lib/file/vistor/filter/mtime_spec.rb
+- spec/lib/file/vistor/filter/name_spec.rb
+- spec/lib/file/vistor/filter/proc_spec.rb
+- spec/lib/file/vistor/filter_dispatcher_spec.rb
+- spec/lib/file/vistor/filter_spec.rb
+- spec/lib/file/vistor/time_utils_spec.rb
+- spec/lib/file/vistor_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/spec_utils.rb
+homepage: http://github.com/bonar/file-visitor
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: file path collecting utility
+test_files: []
+