walk 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 35dbff654a1f378d8ae59b0784cd69fc0917d5cf
+  data.tar.gz: 04ee5b5848b503b109d38f4e2ed6403e09a166e6
+SHA512:
+  metadata.gz: ffc26b6b715e2635876f4047df805daff356d0a0b4a96a2a5072d710a4d31b5c8e8d45b84cb8f3ddf163f08e9edcbd7638d3569a4ff827b3b3f8ad00a4b2a5c1
+  data.tar.gz: f7a01444325625ea4fd1db51dad507d63f03c652c3c3201015bdcb3cb7b0bb5250256136eabc55f2954ed79a34f398f90696c80a55479eaa7f10f19318da4790

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in walk.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 samonzeweb
+
+MIT License
+
+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.md

@@ -0,0 +1,37 @@
+# Walk
+
+Walk is a simple tool to explore a directory tree, inspired by [python os.walk][1]. For each directory (and subdirectories) it give path, files and directories.
+
+During the exploration, it don't go down into unreadable directories, and ignore content which have disappeared.
+
+Unlike python walk, there is no error callback (now).
+
+## Usage
+
+The Walk.walk function require at least the root of the tree to explore. It can be used with a code block which is called for each directory and receiving 3 arguments : the full path of the current directory, the directories, and the files inside the current directory.
+
+    require 'walk'
+     
+    Walk.walk('/') do |path, dirs, files|
+      puts "In #{path} there are #{dirs.length} directories and #{files.length} files"
+    end
+
+Without a block, Walk.walk return an enumerator :
+
+    require 'walk'
+    
+    # Directories containing a least 10 files
+    puts Walk.walk('/')
+      .select { |path,dirs,files| files.length>=10 }
+      .map { |path,_,_| path }
+
+Optional (keywords) arguments are :
+
+ - topdown : when true (default) the content is returned from top to bottom during tree exploration. When topdown is false, the content is returned beginning with the bottom.
+ - followlinks : when false (default) it doesn't explore subdirectories which are symbolic links. When followlinks is true, it can produce an infinite loop in some cases.
+
+## Licence
+
+Walk is released under the MIT license. See LICENSE.txt file for details.
+
+  [1]: http://docs.python.org/3.3/library/os.html#os.walk

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+
+task :default => :spec
+task :test => :spec
+
+desc "Run all the specs"
+RSpec::Core::RakeTask.new

data/lib/walk.rb

@@ -0,0 +1,84 @@
+require_relative "walk/version"
+
+
+module Walk
+
+
+  CURRENT_DIR = '.'
+  PARENT_DIR  = '..'
+
+
+  def self.walk(root, topdown: true, followlinks: false, &block)
+
+    if block_given?
+      inner_walk(root, topdown, followlinks, &block)
+    else
+      Enumerator.new do |enum|
+        inner_walk(root, topdown, followlinks) do |path, dirs, files|
+          enum << [path, dirs, files]
+        end
+      end      
+    end
+
+  end
+
+
+  def self.inner_walk(root, topdown, followlinks, &block)
+
+    dirs = []
+    files = []
+    path_to_explore = []
+
+    begin
+      Dir.entries(root).each do |entry|
+        
+        next if entry==CURRENT_DIR or entry==PARENT_DIR
+
+        fullpath = File.join(root, entry)
+        is_file, is_dir, go_down = inspect_entry(fullpath, followlinks)
+        files << entry if is_file
+        dirs << entry if is_dir
+        path_to_explore << fullpath if go_down
+
+      end        
+    rescue Errno::ENOENT => e
+      # current dir disappeared since parent scan, it's not an error
+      return
+    end
+
+    yield  root, dirs, files  if topdown
+
+    path_to_explore.each do |fullpath|
+      inner_walk(fullpath, topdown, followlinks, &block)
+    end
+
+    yield  root, dirs, files  unless topdown
+
+  end
+
+
+  def self.inspect_entry(fullpath, followlinks)
+
+    is_file = is_dir = go_down = false
+
+    if File.file?(fullpath)
+      is_file = true
+    elsif File.directory?(fullpath)
+      is_dir = true
+      if (followlinks or not File.symlink?(fullpath)) and
+        File.readable?(fullpath)
+        go_down = true
+      end
+    end
+
+    return is_file, is_dir, go_down
+
+  rescue Errno::ENOENT => e
+    return nil, nil, nil
+  end
+
+  private_class_method :inner_walk
+  private_class_method :inspect_entry
+
+
+end

data/lib/walk/version.rb

@@ -0,0 +1,3 @@
+module Walk
+  VERSION = "0.1.0"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,36 @@
+require 'tmpdir'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+end
+
+
+def create_test_tree
+  tmpdir = Dir.mktmpdir
+  FileUtils.touch File.join(tmpdir, "dummy.txt")
+
+  subdir_1 = File.join(tmpdir, 'subdir_1')
+  Dir.mkdir(subdir_1)
+  FileUtils.touch File.join(subdir_1, "dummy_1.txt")
+  FileUtils.touch File.join(subdir_1, "dummy_2.txt")
+
+  subdir_2 = File.join(tmpdir, 'subdir_2')
+  Dir.mkdir(subdir_2)
+  FileUtils.touch File.join(subdir_1, "dummy.txt")
+
+  tmpdir
+end
+
+
+def remove_test_tree(path)
+  must_begin_with = Dir.tmpdir + File::SEPARATOR
+  raise "Path not in temporary directory !" unless path.index(must_begin_with) == 0
+  FileUtils.rm_r(path)
+end
+
+
+def add_simlink(path)
+  File.symlink File.join(path, 'subdir_2'), File.join(path, 'symlink')
+end
+
+

data/spec/walk_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+require 'walk'
+
+describe Walk do
+
+  before :each do
+    @test_path = create_test_tree
+  end
+
+  after :each do
+    remove_test_tree @test_path
+  end
+
+  it 'should find all files in directory tree' do
+    files_count = 0
+    Walk.walk(@test_path) do |path, subdirs, files|
+      files_count += files.length
+    end
+    expect(files_count).to be == 4
+  end
+
+  it 'should find all directories in directory tree' do
+    dirs_count = 0
+    Walk.walk(@test_path) do |path, subdirs, files|
+      dirs_count += subdirs.length
+    end
+    expect(dirs_count).to be == 2
+  end
+
+  it 'should return an enumerator if no block is passed' do
+    expect(Walk.walk(@test_path)).to be_an(Enumerator)
+  end
+
+  it 'should give same result with enumerator than with block style' do
+    files_count = Walk.walk(@test_path).map { |_,_,f| f.length}.reduce(:+)
+    expect(files_count).to be == 4
+  end  
+
+  it 'should return content from top to bottom by default' do
+    path_order = Walk.walk(@test_path).map { |path,_,_| File.basename(path) }
+    expect(path_order).to be == [File.basename(@test_path), 'subdir_1', 'subdir_2']
+  end
+
+  it 'should return content from bottom to top if speficied' do
+    path_order = Walk.walk(@test_path, topdown: false).map { |path,_,_| File.basename(path) }
+    expect(path_order).to be == ['subdir_1', 'subdir_2', File.basename(@test_path)]
+  end  
+
+  it 'should not explore symlink by default' do
+    add_simlink(@test_path)
+    simlink_found = Walk.walk(@test_path).detect do |path,_,_|
+      File.basename(path) == 'symlink'
+    end
+    expect(simlink_found).to be_nil
+  end
+
+  it 'should explore symlink if needed' do
+    add_simlink(@test_path)
+    simlink_found = Walk.walk(@test_path, followlinks: true).detect do |path,_,_|
+      File.basename(path) == 'symlink'
+    end
+    expect(simlink_found).not_to be_nil 
+  end
+
+  it 'should ignore disapearing entries' do
+    expect {
+      Walk.walk(@test_path) do |path, subdirs, files|
+        if path == @test_path
+          remove_test_tree File.join(@test_path, 'subdir_2')
+        end
+      end
+    }.not_to raise_error()  
+  end
+
+end

data/walk.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'walk/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "walk"
+  spec.version       = Walk::VERSION
+  spec.authors       = ["Samuel GAY"]
+  spec.email         = ["sam.onzeweb@gmail.com"]
+  spec.summary       = 'Directory tree traversal tool inspired by python os.walk'
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.14"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: walk
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Samuel GAY
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  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: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+description: 
+email:
+- sam.onzeweb@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/walk.rb
+- lib/walk/version.rb
+- spec/spec_helper.rb
+- spec/walk_spec.rb
+- walk.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Directory tree traversal tool inspired by python os.walk
+test_files:
+- spec/spec_helper.rb
+- spec/walk_spec.rb