dir_r 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9d33dbcd163e86efcee3e334d6ee0d3ba31e4360d93b4318a807c941bab72a56
+  data.tar.gz: f8e68a793609862438eddec5f850167de8faa4c32603a594926617c8cb207b32
+SHA512:
+  metadata.gz: ea6e168330a387413e89aba6873940952d37d59110190586fb68c74f09e7ecc57477e73e0112aecb2eb3fdf833d23a89c5cbac9a302c8a941f0bb973a0eb0c0c
+  data.tar.gz: fa3b30de105b8c769f964c46caa77a90b17a81810d80223aed2eb42849b115292eb4bc1f86c6fa90e897c453e5963e40e2772e91a1d69904903f3da888ffc869

data/History.txt

@@ -0,0 +1,14 @@
+robertburrowes	Tue Nov 3 13:15:06 2020 +1300
+	completing for release
+robertburrowes	Tue Nov 3 13:14:38 2020 +1300
+	test dependency an wikk_json
+robertburrowes	Tue Nov 3 13:08:22 2020 +1300
+	Copied from earlier non-gem code base
+robertburrowes	Tue Nov 3 13:07:36 2020 +1300
+	Set current version
+robertburrowes	Tue Nov 3 13:07:17 2020 +1300
+	Unit tests
+robertburrowes	Tue Nov 3 13:06:25 2020 +1300
+	test directory tree for testing with test_dir_r.rb
+robertburrowes	Sun Nov 1 17:05:48 2020 +1300
+	Empty Gem Project

data/Manifest.txt

@@ -0,0 +1,6 @@
+History.txt
+Manifest.txt
+README.md
+Rakefile
+version
+lib/dir_r.rb

data/README.md

@@ -0,0 +1,56 @@
+# dir_r
+
+* Docs :: https://rbur004.github.io/dir_r/
+* Source :: https://github.com/wikarekare/dir_r
+* Gem :: https://rubygems.org/gems/dir_r
+
+## DESCRIPTION:
+
+Simple recursive walk through a directory, yielding the directory, filename and if the entry is a symbolic link.
+
+## FEATURES/PROBLEMS:
+
+* Symbolic links, that point nowhere, are skipped.
+* Symbolic links, that point to directories, are skipped to avoid loops, double processing, and/or escaping the dir tree.
+
+## SYNOPSIS:
+
+  ```
+   require 'dir_r'
+   DirR.walk_dir(directory: "#{__dir__}/test_dir", walk_sub_directories: true, ignore_symlinks: true) do |dir,fn,link|
+     puts "Directory Path: #{dir} Filename: #{fn} Is a link: #{link}"
+   end
+  ```
+
+## REQUIREMENTS:
+
+* require 'dir_r'
+
+## INSTALL:
+
+* sudo gem install dir_r
+
+## LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2020 FIX
+
+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/Rakefile

@@ -0,0 +1,29 @@
+# -*- ruby -*-
+require 'rubygems'
+require 'hoe'
+Hoe.plugin :yard
+load "#{__dir__}/version"
+
+Hoe.spec PROJECT do 
+  self.readme_file = "README.md"
+  self.developer( "Rob Burrowes","r.burrowes@auckland.ac.nz")
+  remote_rdoc_dir = '' # Release to root
+  
+  self.yard_title = PROJECT
+  self.yard_options = ['--markup', 'markdown', '--protected']
+
+  self.dependency 'wikk_json', ['~> 0.1', '>= 0.1.0'], type=:dev
+end
+
+
+#Validate manfest.txt
+#rake check_manifest
+
+#Local checking. Creates pkg/
+#rake gem
+
+#create doc/
+#rake docs  
+
+#Copy up to rubygem.org
+#rake release VERSION=1.0.1

data/lib/dir_r.rb

@@ -0,0 +1,52 @@
+# Recursive walk through a directory tree
+# There is also Find.find and Dir.glob as alternatives
+# Symbolic links, pointing nowhere, are ignored
+# Symbolic links to directories are ignored
+#  We will process the linked to directory, if it is in this tree;
+#  But we don't want to break out of this tree, and go wondering through the file system.
+# We also ignore special files (i.e. sockets, dev nodes, ...)
+# 
+class DirR
+  VERSION = '1.0.0'
+  # Directory listing. Ignoring symbolic links
+  #
+  # @param directory [String] directory to list
+  # @param walk_sub_directories [Boolean] Recurse through the subdirectories
+  # @param ignore_symlinks [Boolean] Skip over symbolic links to files
+  # @yield [String, String, Boolean] Directory path, Filename, Symbolic Link true/false
+  def self.walk_dir(directory:, walk_sub_directories: true, ignore_symlinks: true, debug: false, &block)
+    puts "In #{directory}" if debug
+    Dir.open(directory).each do |filename|
+      puts " Got: #{filename}" if debug
+      if filename != '.' && filename != '..' #ignore parent, and current directories.
+        qualified_filename =  "#{directory}/#{filename}"
+        begin
+          stat_record =  File.stat(qualified_filename)  #File end
+          lstat_record =  File.lstat(qualified_filename)#Link end 
+        rescue Errno::ENOENT
+          puts "  Skipping #{qualified_filename}" if debug
+          next # Link points nowhere, so we ignore it, rather than stop.
+        end
+        link = lstat_record.symlink? 
+        if stat_record.directory?
+          if !link && walk_sub_directories 
+            #recurse through sub-directories.
+            #don't follow links to directories though, as they could take us anywhere, including looping.
+            walk_dir( directory: qualified_filename,
+                      walk_sub_directories: walk_sub_directories, 
+                      ignore_symlinks: ignore_symlinks, 
+                      debug: debug,
+                      &block
+                    )
+            puts "Back In #{directory}" if debug
+          end
+        elsif stat_record.file? 
+          # Ordinary file and not a link, or we are accepting links
+          if !link || (link && !ignore_symlinks)
+            yield directory, filename, link
+          end
+        end
+      end
+    end
+  end
+end

data/version

@@ -0,0 +1,2 @@
+PROJECT="dir_r"
+VERSION="1.0.0"

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: dir_r
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Rob Burrowes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-11-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hoe-yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+- !ruby/object:Gem::Dependency
+  name: wikk_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.22'
+description: Simple recursive walk through a directory, yielding the directory, filename
+  and if the entry is a symbolic link.
+email:
+- r.burrowes@auckland.ac.nz
+executables: []
+extensions: []
+extra_rdoc_files:
+- History.txt
+- Manifest.txt
+- README.md
+files:
+- History.txt
+- Manifest.txt
+- README.md
+- Rakefile
+- lib/dir_r.rb
+- version
+homepage: https://rbur004.github.io/dir_r/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--markup"
+- markdown
+- "--protected"
+- "--title"
+- dir_r
+- "--quiet"
+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: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Simple recursive walk through a directory, yielding the directory, filename
+  and if the entry is a symbolic link.
+test_files: []