recls-ruby 2.6.4 → 2.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 518087f6042cc31fe5d05f724d0f16e00d7192fa
-  data.tar.gz: e480c2ce6cf0aab32dc5ab01a1797c6c5fa275c4
+  metadata.gz: ea5f4b792cc0f8882a7a4e9779fd32fb2ce231cd
+  data.tar.gz: 98f5d6b1cae89e306aa303c5e383a2951d7ff09f
 SHA512:
-  metadata.gz: 20fd43b0fff86081eb62e1ea43d889c45bfe0c9add816b70e9d62a568ba2203af551cdaeecbb221bb2d15939a1e31d072f3c4d8f0a4c9a0c86c8cac5bba1ad76
-  data.tar.gz: baa78f624be64f88e3ca5bbc2ec689ac23c7d907bd4ac1dba793816c3d978f70d30891089bf99661c689284093dfde6842640aac5211a1578646573d7baf597e
+  metadata.gz: b403a936e24d295db49df5eae668953325af07df610655858eeb98e61cdf9dca4927354b3b35012e1a7088a8057a1a4f2431a16291bfb88e2acfb3a537b4ce42
+  data.tar.gz: 2f79d4ba659fe1484f74ba0a23653f41fb7aa6e298596e026fe3eebc1b831058d9408b0fd78561192a52dfd1ca114e42ff2f776aa751ef3fc2f974b5898183b6

data/README.md

@@ -1,2 +1,28 @@
 # recls.Ruby
 recls for Ruby
+
+[![Gem Version](https://badge.fury.io/rb/recls-ruby.svg)](https://badge.fury.io/rb/recls-ruby)
+
+## Installation & usage
+
+Install using `gem install recls-ruby` or add it to your `Gemfile`.
+
+## Description
+
+TODO
+
+## Where to get help
+
+[GitHub Page](https://github.com/synesissoftware/recls.Ruby "GitHub Page")
+
+## Contribution guidelines
+
+Defect reports, feature requests, and pull requests are welcome on https://github.com/synesissoftware/recls.Ruby.
+
+## Related projects
+
+**recls.Ruby** is used in the **[libCLImate.Ruby](https://github.com/synesissoftware/libCLImate.Ruby)** library.
+
+## License
+
+**recls.Ruby** is released under the 3-clause BSD license. See LICENSE for details.

data/lib/recls/api.rb

@@ -0,0 +1,51 @@
+# ######################################################################### #
+# File:         recls/api.rb
+#
+# Purpose:      Defines Recls module search functions
+#
+# Created:      9th June 2016
+# Updated:      9th June 2016
+#
+# Author:       Matthew Wilson
+#
+# Copyright (c) 2016, Matthew Wilson and Synesis Software
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# * Redistributions of source code must retain the above copyright notice,
+#   this list of conditions and the following disclaimer.
+#
+# * Redistributions in binary form must reproduce the above copyright notice,
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+#
+# ######################################################################### #
+
+
+require 'recls/file_search'
+
+module Recls
+
+	def self.FileSearch(search_root, patterns, options = {})
+
+		Recls::FileSearch.new(search_root, patterns, options)
+	end
+end
+
+# ############################## end of file ############################# #
+
+

data/lib/recls/{filesearch.rb → file_search.rb}

@@ -1,10 +1,10 @@
 # ######################################################################### #
-# File:         recls/filesearch.rb
+# File:         recls/file_search.rb
 #
 # Purpose:      Defines the Recls::FileSearch class for the recls.Ruby library.
 #
 # Created:      24th July 2012
-# Updated:      29th December 2015
+# Updated:      13th June 2016
 #
 # Author:       Matthew Wilson
 #
@@ -46,11 +46,35 @@ module Recls
 
 		include Enumerable
 
-		def initialize(search_root, patterns, flags)
+		def initialize(search_root, patterns, options={})
+
+			# for backwards compatibility, we allow for options to
+			# be a number
+
+			flags	=	0
+
+			case options
+			when ::NilClass
+
+				options	=	{ flags: 0 }
+			when ::Integer
+
+				flags	=	options
+				options	=	{ flags: flags }
+			when ::Hash
+
+				flags	=	options[:flags] || 0
+			else
+
+				raise ArgumentError, "options parameter must a #{::Hash}, nil, or an integer specifying flags - an instance of #{options.class} given"
+			end
+
 
 			if not search_root
+
 				search_root = '.'
 			else
+
 				search_root = search_root.to_s
 			end
 			search_root = '.' if search_root.empty?
@@ -58,17 +82,21 @@ module Recls
 
 			case	patterns
 			when	NilClass
+
 				patterns = []
 			when	String
+
 				patterns = patterns.split(/[|#{Recls::Ximpl::OS::PATH_SEPARATOR}]/)
 			when	Array
 			else
+
 				patterns = patterns.to_a
 			end
 
 			patterns = [ Recls::WILDCARDS_ALL ] if patterns.empty?
 
 			if(0 == (Recls::TYPEMASK & flags))
+
 				flags |= Recls::FILES
 			end
 
@@ -98,12 +126,15 @@ module Recls
 			flags = @flags
 
 			if(Recls::Ximpl::OS::OS_IS_WINDOWS)
+
 				mask = (Recls::FILES | Recls::DIRECTORIES)
 			else
+
 				mask = (Recls::FILES | Recls::DIRECTORIES | Recls::LINKS | Recls::DEVICES)
 			end
 
 			if(mask == (mask & flags))
+
 				flags = flags & ~Recls::TYPEMASK
 			end
 
@@ -137,13 +168,17 @@ module Recls
 		def FileSearch::stat_or_nil_(path, flags)
 
 			begin
+
 				Recls::Ximpl::FileStat.stat path
 			rescue Errno::ENOENT => x
+
 				nil
 			rescue SystemCallError => x
+
 				# TODO this should be filtered up and/or logged
 
 				if(0 != (STOP_ON_ACCESS_FAILURE & flags))
+
 					raise
 				end
 
@@ -170,6 +205,7 @@ module Recls
 					next if is_dots(name)
 
 					if not name =~ /^#{pattern}$/
+
 						next
 					end
 
@@ -207,7 +243,9 @@ module Recls
 				next if not fs
 
 				if(0 == (Recls::SHOW_HIDDEN & flags))
+
 					if fs.hidden?
+
 						next
 					end
 				end
@@ -230,13 +268,17 @@ module Recls
 			subdirectories.each do |fs|
 
 				if(0 == (Recls::SHOW_HIDDEN & flags))
+
 					if fs.hidden?
+
 						next
 					end
 				end
 
 				if(0 == (Recls::SEARCH_THROUGH_LINKS & flags))
+
 					if File.symlink? fs.path
+
 						next
 					end
 				end

data/lib/recls/foreach.rb

@@ -4,11 +4,11 @@
 # Purpose:      Definition of Recls::foreach() utility function
 #
 # Created:      22nd October 2014
-# Updated:      27th August 2015
+# Updated:      9th June 2016
 #
 # Author:       Matthew Wilson
 #
-# Copyright (c) 2012-2015, Matthew Wilson and Synesis Software
+# Copyright (c) 2012-2016, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -36,7 +36,7 @@
 # ######################################################################### #
 
 
-require 'recls/filesearch'
+require 'recls/file_search'
 
 module Recls
 

data/lib/recls/recls.rb

@@ -4,7 +4,7 @@
 # Purpose:      Main source file for recls library
 #
 # Created:      19th July 2012
-# Updated:      29th December 2015
+# Updated:      9th June 2016
 #
 # Author:       Matthew Wilson
 #
@@ -38,7 +38,8 @@
 
 require 'recls/version'
 
-require 'recls/filesearch'
+require 'recls/api'
+require 'recls/file_search'
 require 'recls/foreach'
 require 'recls/stat'
 require 'recls/util'

data/lib/recls/version.rb

@@ -4,7 +4,7 @@
 # Purpose:      Version for recls library
 #
 # Created:      14th February 2014
-# Updated:      31st May 2016
+# Updated:      9th June 2016
 #
 # Author:       Matthew Wilson
 #
@@ -39,7 +39,7 @@
 module Recls
 
 	# Current version of the recls.Ruby library
-	VERSION				=	'2.6.4'
+	VERSION				=	'2.7.1'
 
 	private
 	VERSION_PARTS_		=	VERSION.split(/[.]/).collect { |n| n.to_i } # :nodoc:

data/test/scratch/test_display_parts.rb

@@ -6,23 +6,29 @@ $:.unshift File.join(File.dirname(__FILE__), '../..', 'lib')
 
 require 'recls'
 
-Recls::FileSearch.new(nil, nil, Recls::FILES | Recls::RECURSIVE).each do |fe|
+root_dir	=	'.'
+patterns	=	Recls::WILDCARDS_ALL
+
+Recls::FileSearch.new(root_dir, patterns, Recls::FILES | Recls::RECURSIVE).each do |fe|
+
+	drive	=	fe.drive || ''
 
 	puts
+	puts "entry:"
 	puts fe.path
 	puts fe.short_path
 	puts fe.directory_path
-	puts fe.drive
-	puts "".ljust(fe.drive.size) + fe.directory
+	puts drive
+	puts "".ljust(drive ? drive.size : 0) + fe.directory
 	puts "".ljust(fe.directory_path.size) + fe.file
-	puts "".ljust(fe.directory_path.size) + fe.file_short_name
+	puts "".ljust(fe.directory_path.size) + "#{fe.file_short_name}"
 	puts "".ljust(fe.directory_path.size) + fe.stem
 	puts "".ljust(fe.directory_path.size + fe.stem.size) + fe.extension
-	n = fe.drive.size
+	n = drive.size
 	fe.directory_parts.each do |part|
 
-	puts "".ljust(n) + part
-	n += part.size
+		puts "".ljust(n) + part
+		n += part.size
 	end
 
 	puts fe.search_directory
@@ -33,8 +39,8 @@ Recls::FileSearch.new(nil, nil, Recls::FILES | Recls::RECURSIVE).each do |fe|
 	n = fe.search_directory.size
 	fe.search_relative_directory_parts.each do |part|
 
-	puts "".ljust(n) + part
-	n += part.size
+		puts "".ljust(n) + part
+		n += part.size
 	end
 end
 

data/test/scratch/test_files_and_directories.rb

@@ -0,0 +1,33 @@
+#!/usr/bin/ruby
+
+#############################################################################
+# File:         ./test/scratch/test_files_and_directories.rb
+#
+# Purpose:      COMPLETE_ME
+#
+# Created:      09 06 2016
+# Updated:      09 06 2016
+#
+# Author:       Matthew Wilson
+#
+# Copyright:    <<TBD>>
+#
+#############################################################################
+
+$:.unshift File.join(File.dirname(__FILE__), '../..', 'lib')
+
+require 'recls'
+
+Recls::FileSearch.new(nil, nil, Recls::FILES | Recls::DIRECTORIES | Recls::RECURSIVE).each do |fe|
+
+	path = fe.search_relative_path
+
+	if fe.directory?
+
+		puts path + '/'
+	else
+
+		puts path
+	end
+end
+

data/test/scratch/test_module_function.rb

@@ -0,0 +1,46 @@
+#!/usr/bin/ruby
+#
+# test Recls entry methods
+
+$:.unshift File.join(File.dirname(__FILE__), '../..', 'lib')
+
+require 'recls'
+
+root_dir	=	'.'
+patterns	=	Recls::WILDCARDS_ALL
+
+Recls.FileSearch(root_dir, patterns, flags: Recls::FILES).each do |fe|
+
+	drive	=	fe.drive || ''
+
+	puts
+	puts "entry:"
+	puts fe.path
+	puts fe.short_path
+	puts fe.directory_path
+	puts drive
+	puts "".ljust(drive ? drive.size : 0) + fe.directory
+	puts "".ljust(fe.directory_path.size) + fe.file
+	puts "".ljust(fe.directory_path.size) + "#{fe.file_short_name}"
+	puts "".ljust(fe.directory_path.size) + fe.stem
+	puts "".ljust(fe.directory_path.size + fe.stem.size) + fe.extension
+	n = drive.size
+	fe.directory_parts.each do |part|
+
+		puts "".ljust(n) + part
+		n += part.size
+	end
+
+	puts fe.search_directory
+	puts "".ljust(fe.search_directory.size) + fe.search_relative_path
+	puts "".ljust(fe.search_directory.size) + fe.search_relative_directory_path
+	puts "".ljust(fe.search_directory.size) + fe.search_relative_directory
+
+	n = fe.search_directory.size
+	fe.search_relative_directory_parts.each do |part|
+
+		puts "".ljust(n) + part
+		n += part.size
+	end
+end
+

data/test/unit/test_all_separately.cmd

@@ -0,0 +1,5 @@
+@echo off
+
+echo Executing all ruby tests, each in a separate process:
+for %i in (*.rb) do @ruby "%i"
+

data/test/unit/test_all_separately.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+
+echo "Executing all ruby tests, each in a separate process:"
+find . -name '*.rb' -depth 1 -exec ruby {} \;
+
+

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: recls-ruby
 version: !ruby/object:Gem::Version
-  version: 2.6.4
+  version: 2.7.1
 platform: ruby
 authors:
 - Matt Wilson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-11 00:00:00.000000000 Z
+date: 2016-06-13 00:00:00.000000000 Z
 dependencies: []
-description: |2+
-
+description: |
+  RECursive LS for Ruby
 email: matthew@recls.org
 executables: []
 extensions: []
@@ -22,8 +22,9 @@ files:
 - examples/show_hidden_files.rb
 - examples/show_readonly_files.rb
 - lib/recls.rb
+- lib/recls/api.rb
 - lib/recls/entry.rb
-- lib/recls/filesearch.rb
+- lib/recls/file_search.rb
 - lib/recls/flags.rb
 - lib/recls/foreach.rb
 - lib/recls/recls.rb
@@ -36,7 +37,9 @@ files:
 - lib/recls/ximpl/windows.rb
 - test/scratch/test_display_parts.rb
 - test/scratch/test_entry.rb
+- test/scratch/test_files_and_directories.rb
 - test/scratch/test_foreach.rb
+- test/scratch/test_module_function.rb
 - test/scratch/test_show_dev_and_ino.rb
 - test/scratch/test_show_hidden.rb
 - test/unit/tc_recls_entries.rb
@@ -45,6 +48,8 @@ files:
 - test/unit/tc_recls_module.rb
 - test/unit/tc_recls_util.rb
 - test/unit/tc_recls_ximpl_util.rb
+- test/unit/test_all_separately.cmd
+- test/unit/test_all_separately.sh
 - test/unit/ts_all.rb
 homepage: http://recls.org/
 licenses: