file-visitor 0.1.0 → 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a90c3de765cb74ab492da1d8ded9a60843f268c2
+  data.tar.gz: 6f0df4e777c51f4b87729a4d7038dd039bead761
+SHA512:
+  metadata.gz: 02b9f326d9c5d563836e9bf8609b9a6c0d106a81f65c58e60f667940e70b75eb137291b168354c4421bf92718aa0b4abb2dbe80370af9681d3a237f9b1b1e34a
+  data.tar.gz: 9f1ba5f1bf647649779d154a3d5525c0969d32d60225deb93cafaba10f106b213c4ce76b35d38dd7aeb64df2af301f4c2c043cb1161e069aa92aedd9084fb53d

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/

data/.rspec

@@ -1 +1,2 @@
+--format documentation
 --color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at bonar@me.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -1,12 +1,11 @@
-source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in file-visitor.gemspec
+gemspec
 
-# 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"
+  gem 'rspec-core'
+  gem 'rspec-expectations'
+  gem 'rspec-mocks'
+  gem 'rspec-support'
 end

data/Gemfile.lock

@@ -1,30 +1,39 @@
+PATH
+  remote: .
+  specs:
+    file-visitor (0.1.1)
+
 GEM
-  remote: http://rubygems.org/
+  remote: https://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)
+    diff-lcs (1.2.5)
+    rake (11.1.2)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  jeweler (~> 1.8.4)
-  rdoc (~> 3.12)
-  rspec (~> 2.8.0)
+  bundler
+  file-visitor!
+  rake
+  rspec
+  rspec-core
+  rspec-expectations
+  rspec-mocks
+  rspec-support
+
+BUNDLED WITH
+   1.11.2

data/README.md

@@ -0,0 +1,167 @@
+# File::Visitor
+
+file path collectiong utility
+
+## DESCRIPTION
+
+file-visitor is an alternative way to collecting files.
+We often write code to collect file, like this.
+
+    Dir.glob("/usr/local/lib/*.a")
+
+Dir.glob or UNIX find command is very useful.
+But in the following cases, it is not enough. 
+
+* need to combine various conditions. 
+* need to write the conditions of the file path to collect by ruby. 
+* need to test and reuse conditions. 
+
+file-visitor way to collect files
+
+    require 'file/visitor'
+    
+    visitor = File::Visitor.new
+      
+    # files with extension .log
+    visitor.add_filter(:ext, :log)
+    
+    # and last modified is more than 30 days ago
+    visitor.add_filter(:mtime, :passed, 30, :days)
+
+    # remove all the matched files
+    visitor.visit(root_dir) do |path|
+      FileUtils.rm(path)
+    end
+
+You can add custom filters.
+
+    class BigFileFilter
+     
+      def initialize(size)
+        @size = size
+      end
+    
+      # filter must implement match?(path)
+      def match?(path)
+        File.size(path) > @size
+      end
+    
+    end
+     
+    filter = BigFileFilter(2048)
+    visitor.add_filter(filter)
+
+BigFileFilter is testable and reusable.
+
+### Filters
+
+#### Filename
+
+filename string or regexp.
+
+    visitor.add_filter(:filename, "sample.txt")
+    visitor.add_filter(:filename. /\d{4}\-\d{2}\-\d{2}\.txt/)
+
+#### Extension
+
+file extension sym or string.
+
+    visitor.add_filter(:ext, :txt)
+
+#### Modified time
+
+    # 1. specify Time instance
+    # add_filter(:mtime, comparetor_sym, time)
+    visitor.add_filter(:mtime, :equals_to, Time.parse("2013-01-03 04:59"))
+    visitor.add_filter(:mtime, :is_less_than, Time.parse("2013-01-03 04:59"))
+    
+    # 2 specify number and unit sym
+    # add_filter(:mtime, :passed, number, time_unit)
+    visitor.add_filter(:mtime, :passed, 3, :days)
+
+Comparator syms you can use:
+
+* :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=, :<=)
+
+Time unit
+
+* :sec, :second, :seconds
+* :min, :mins, :minute, :minutes
+* :hour, :hours
+* :day, :days
+* :month, :months (1 month = 30 days)
+* :year, :years
+
+#### Block filter
+
+    visitor.add_filter do |path|
+      # return true/false
+    end
+
+#### custom filter
+
+    class HaveMD5SumFilter
+      def match?(path)
+        File.readable?("#{path}.md5")
+      end
+    end
+  
+    filter = HaveMD5SumFilter.new
+    visitor.add_filter(filter)
+
+filter instance must repond_to :match?.
+
+### methods
+
+#### visit(dir)
+
+Collect files and execute given block.
+
+#### file_list(dir)
+
+Collect files and return path array.
+
+#### target?(path)
+
+return if the given path is target.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'file-visitor'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install file-visitor
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/file-visitor. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -1,49 +1,6 @@
-# encoding: utf-8
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
-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
+RSpec::Core::RakeTask.new(:spec)
 
 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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "file/visitor"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/file-visitor.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'file/visitor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "file-visitor"
+  spec.version       = File::Visitor::VERSION
+  spec.authors       = ["bonar"]
+  spec.email         = ["bonar@me.com"]
+
+  spec.summary       = %q{File path collectiong utility}
+  spec.description   = %q{file-visitor is an alternative way to collecting files.}
+  spec.homepage      = "https://github.com/bonar/file-visitor"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/file/visitor/version.rb

@@ -0,0 +1,5 @@
+class File
+  class Visitor
+    VERSION = "0.1.1"
+  end
+end

metadata

@@ -1,87 +1,77 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: file-visitor
-version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: 
-  segments: 
-  - 0
-  - 1
-  - 0
-  version: 0.1.0
+version: !ruby/object:Gem::Version
+  version: 0.1.1
 platform: ruby
-authors: 
+authors:
 - bonar
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-
-date: 2013-02-04 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2016-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   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 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   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 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   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
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: file-visitor is an alternative way to collecting files.
+email:
+- bonar@me.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- LICENSE.txt
-- README.rdoc
-files: 
-- .document
-- .rspec
+extra_rdoc_files: []
+files:
+- ".document"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
-- VERSION
+- bin/console
+- bin/setup
+- file-visitor.gemspec
 - lib/file/visitor.rb
 - lib/file/visitor/filter.rb
 - lib/file/visitor/filter/ext.rb
@@ -90,50 +80,29 @@ files:
 - 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: 
+- lib/file/visitor/version.rb
+homepage: https://github.com/bonar/file-visitor
+licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  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
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.6.3
 signing_key: 
-specification_version: 3
-summary: file path collecting utility
+specification_version: 4
+summary: File path collectiong utility
 test_files: []
-