file-visitor 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.8.0"
+  gem "rdoc", "~> 3.12"
+  gem "jeweler", "~> 1.8.4"
+end

data/Gemfile.lock

@@ -0,0 +1,30 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.5)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jeweler (~> 1.8.4)
+  rdoc (~> 3.12)
+  rspec (~> 2.8.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 bonar
+
+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,19 @@
+= file-visitor
+
+Description goes here.
+
+== Contributing to file-visitor
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2013 bonar. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "file-visitor"
+  gem.homepage = "http://github.com/bonar/file-visitor"
+  gem.license = "MIT"
+  gem.summary = %Q{file path collecting utility}
+  gem.description = %Q{you can collect file paths by mtime/name/ext/block filters.}
+  gem.email = "bonar@me.com"
+  gem.authors = ["bonar"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "file-visitor #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/file/visitor.rb

@@ -0,0 +1,128 @@
+
+require 'file/visitor/filter'
+require 'file/visitor/filter_dispatcher'
+require 'file/visitor/filter/proc'
+
+class File
+  class Visitor
+
+    attr_reader :filters
+    attr_accessor :visit_dot_dir
+
+    FILTER_NS_BASE = File::Visitor::Filter
+
+    def initialize
+      @filters = []
+
+      @visit_dot_dir = false
+    end
+
+    def visit(dir, &handler)
+      visit_with_mode(dir, :file, &handler)
+    end
+
+    def visit_dir(dir, &handler)
+      visit_with_mode(dir, :dir, &handler)
+    end
+
+    def file_list(dir)
+      files = []
+      visit(dir) { |path| files << path }
+      files
+    end
+
+    def dir_list(dir)
+      dirs = []
+      visit_dir(dir) { |path| dirs << path }
+      dirs
+    end
+
+    # 3 ways to register filter
+    #
+    # 1. built-in filter
+    #    filter.add_filter(:mtime, :passed, 30, :days)
+    #
+    # 2. custom filter
+    #    filter.add_filter(my_filter)
+    #    (my_filter must implements match?(path) method)
+    #
+    # 3. block filter
+    #    filter.add_filter do |path|
+    #      # filter operations
+    #    end
+    #
+    def add_filter(*args, &block)
+      # 3. block filter
+      if block_given?
+        filter = File::Visitor::Filter::Proc.new(block)
+        @filters.push(filter)
+        return true
+      end
+
+      # 2. custom filter
+      if (1 == args.size)
+        custom_filter = args.shift
+        unless (custom_filter.respond_to?(:match?))
+          raise ArgumentError,
+            "custom_filter must implement match?()"
+        end
+        @filters.push(custom_filter)
+        return true
+      end
+
+      # 1. built-in filter
+      filter_class = File::Visitor::FilterDispatcher.dispatch(args.shift)
+      @filters.push(filter_class.new(*args))
+      true
+    end
+
+    def target?(path)
+      # all the paths are target when no filters given
+      return true unless @filters
+
+      @filters.each do |filter|
+        return false unless filter.match?(path)
+      end
+      true
+    end
+
+    private
+
+    def dot_dir?(path)
+      basename = File.basename(path)
+      basename == '.' || basename == '..'
+    end
+
+    def assert_directory(dir)
+      unless dir.is_a?(String) && File.directory?(dir)
+        raise ArgumentError, "#{dir} is not directory"
+      end
+    end
+
+    # dir: target directory
+    # mode:
+    #   file - visit all files
+    #   dir  - visit directory only
+    # handler: proc to call
+
+    def visit_with_mode(dir, mode, &handler)
+      assert_directory(dir)
+
+      Dir.entries(dir).each do |entry|
+        next if (dot_dir?(entry) && !@visit_dot_dir)
+
+        abs_path = File.join(dir, entry)
+        if File.directory?(abs_path)
+          mode == :dir && handler.call(abs_path)
+          visit_with_mode(abs_path, mode, &handler)
+        else
+          if mode == :file && target?(abs_path)
+            handler.call(abs_path) 
+          end
+        end
+      end
+    end
+
+  end
+end
+

data/lib/file/visitor/filter.rb

@@ -0,0 +1,10 @@
+
+# create namespace for filters
+
+class File
+  class Visitor
+    class Filter
+    end
+  end
+end
+

data/lib/file/visitor/filter/ext.rb

@@ -0,0 +1,27 @@
+
+require 'file/visitor/filter'
+
+class File::Visitor::Filter::Ext
+
+    def initialize(extstr)
+      if extstr.nil? || !(extstr.is_a?(String) || extstr.is_a?(Symbol))
+        raise ArgumentError, "ext must be Sting/Symbol"
+      end
+      extstr = extstr.to_s
+      unless extstr =~ /\A\./
+        extstr = ".#{extstr}"
+      end
+      @ext = extstr
+    end
+
+    def match?(path)
+      ext = File.extname(path)
+      ext == @ext
+    end
+
+    def to_s
+      "%s[%s]" % [self.class.name, @ext.to_s]
+    end
+
+end
+

data/lib/file/visitor/filter/mtime.rb

@@ -0,0 +1,59 @@
+
+require 'file/visitor/filter'
+require 'file/visitor/time_utils'
+
+class File::Visitor::Filter::Mtime
+  include File::Visitor::TimeUtils
+
+  PASSED_COMPARATOR = {
+    :passed  => :is_older_than,
+    :passed= => :is_older_than=,
+  }
+
+  # Two ways to initialize filter:
+  #   1) File::Visitor::Filter::Mtime.new(
+  #        :younger_than, "2012-01-01")
+  #   2) File::Visitor::Filter::Mtime.new(
+  #        :passed, 30, :days)
+
+  def initialize(*args)
+    comparator  = args.shift
+    target_time = nil
+
+    # case 1)
+    if PASSED_COMPARATOR.keys.include?(comparator)
+      count = args.shift
+      unit  = args.shift
+      target_time = Time.now -
+        unitexp2sec(count, unit)
+      comparator = PASSED_COMPARATOR[comparator]
+    # case 2)
+    else
+      unless COMPARATOR.include?(comparator)
+        raise ArgumentError,
+          "comparator must be in " +
+          COMPARATOR.join(", ")
+      end
+      target_time = args.shift
+      if target_time.is_a?(String)
+        target_time = Time.parse(target_time)
+      end
+      unless target_time.is_a?(Time)
+        raise ArgumentError, "time must be a Time"
+      end
+    end 
+
+    @comparator  = comparator
+    @target_time = target_time
+  end
+
+  def match?(path)
+    compare_time(
+      File.mtime(path),
+      @comparator,
+      @target_time
+    )
+  end
+
+end
+

data/lib/file/visitor/filter/name.rb

@@ -0,0 +1,25 @@
+
+require 'file/visitor/filter'
+
+class File::Visitor::Filter::Name
+
+  def initialize(exp)
+    unless exp.is_a?(String) || exp.is_a?(Regexp)
+      raise ArgumentError, "expression must be String or Regexp"
+    end
+    @exp = exp
+  end
+
+  def match?(path)
+    filename = File.basename(path)
+    return @exp == filename if @exp.is_a?(String)
+    return filename =~ @exp if @exp.is_a?(Regexp)
+    raise RuntimeError, "unexpected exp type: #{@exp.class}"
+  end
+
+  def to_s
+    "%s[%s:%s]" % [self.class.name, @exp.class.name, @exp.to_s]
+  end
+
+end
+

data/lib/file/visitor/filter/proc.rb

@@ -0,0 +1,23 @@
+
+require 'file/visitor/filter'
+
+class File::Visitor::Filter::Proc
+
+  def initialize(custom_proc)
+    unless custom_proc.is_a?(Proc)
+      raise ArgumentError, "Proc instance required"
+    end
+    @proc = custom_proc
+  end
+
+  def match?(path)
+    !!@proc.call(path)
+  end
+
+  def to_s
+    "%s[%s]" % [self.class.name, @proc.object_id]
+  end
+
+end
+
+

data/lib/file/visitor/filter_dispatcher.rb

@@ -0,0 +1,22 @@
+
+require 'file/visitor/filter'
+require 'file/visitor/filter/name'
+require 'file/visitor/filter/ext'
+require 'file/visitor/filter/mtime'
+
+class File::Visitor::FilterDispatcher
+
+  def self.dispatch(filter_name)
+    case filter_name
+    when :name, :filename
+      return File::Visitor::Filter::Name
+    when :ext, :extension, :filetype
+      return File::Visitor::Filter::Ext
+    when :mtime, :modified_time
+      return File::Visitor::Filter::Mtime
+    end
+    raise ArgumentError, "invalid filter name: #{filter_name}"
+  end
+
+end
+