recls-ruby 2.10.1 → 2.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 785232a003d05a8f1ee53424529140c7a82f625d1d703abd7b1e786fbfabf5ed
-  data.tar.gz: 6139a8d63001ce68ce089aa096f6556c990d3f07314505907e6b12de6bfc9291
+SHA1:
+  metadata.gz: a1b0ed5f508ef5e3a29ac1f5de51d5d6cee84ba1
+  data.tar.gz: 0deb1a1f4551f35cc8c25acba091e30eaa630109
 SHA512:
-  metadata.gz: 445f4717838f796f7f77502933fe864889b12b142c96c33dabf2326b5957e27b062679823cac8d483ae20436e5be93f6009f2e1a1f90f04ef6c70fb00da076fe
-  data.tar.gz: 794ec502431b8fd6c65d43a07a114225648b91abd4e17d941ecf8a071d2d7e3440d1ac5ace64be205da82baa2ce3dfb13fccf19f1a26560649290aa6211375a9
+  metadata.gz: 6852f4c312ef0dc49c6d8027df2655217cfe1587ea2cf95b8030f5986b2e1ecfbc84c6a325c565718fffc8161231d3415a3a1c292dfae2744fd986a89fe546e5
+  data.tar.gz: 9cba60e7075ffb6d3da1ceefc597c54953e23f8fe41d4d5cea4a20840dd9b037c60471d3ddbbf188d9045018cfede80a7d88fd56ba758814814abfae0e26cc1e

data/README.md

@@ -27,6 +27,17 @@ Install using `gem install recls-ruby` or add it to your `Gemfile`.
 
 ## Components
 
+The main components of **recls.Ruby** are:
+
+* the ``Recls`` module; and
+* the ``Recls::Entry`` class
+
+### The ``Recls`` module
+
+T.B.C.
+
+### The ``Recls::Entry`` class
+
 T.B.C.
 
 ## Examples

data/examples/find_files_and_directories.recursive.md

@@ -18,11 +18,11 @@ Recls.file_rsearch(nil, nil, Recls::FILES).each { |fe| puts "\t#{fe.search_relat
 puts
 
 puts "directories under current directory:"
-Recls.file_rsearch(nil, nil, Recls::DIRECTORIES).each { |fe| puts "\t#{fe.search_relative_path}" }
+Recls.file_rsearch(nil, nil, Recls::DIRECTORIES | Recls::MARK_DIRECTORIES).each { |fe| puts "\t#{fe.search_relative_path}" }
 puts
 
 puts "files and directories under current directory:"
-Recls.file_rsearch(nil, nil, Recls::DIRECTORIES | Recls::FILES).each { |fe| puts "\t#{fe.search_relative_path}" }
+Recls.file_rsearch(nil, nil, Recls::DIRECTORIES | Recls::FILES | Recls::MARK_DIRECTORIES).each { |fe| puts "\t#{fe.search_relative_path}" }
 puts
 ```
 
@@ -33,12 +33,13 @@ the ```Recls.file_rsearch()``` module method, passing FILES, DIRECTORIES, and
 FILES|DIRECTORIES, respectively. For each search, a simple block is
 presented, which takes a single-parameter of the file-entry (of type
 ``Recls::Entry``) from which the ``#search_relative_path`` instance
-attribute is used to display the relative path.
+attribute is used to display the relative path. For clarity, directories are
+marked with trailing slashes.
 
 ## Example results
 
 ```
-files in current directory:
+files under current directory:
 	build_gem.cmd
 	build_gem.sh
 	CHANGES.md
@@ -47,6 +48,7 @@ files in current directory:
 	LICENSE
 	Rakefile
 	README.md
+	recls-ruby-2.10.1.gem
 	recls.gemspec
 	run_all_unit_tests.sh
 	doc/CHANGES_md.html
@@ -104,7 +106,6 @@ files in current directory:
 	doc/Recls/Entry.html
 	examples/find_files_and_directories.md
 	examples/find_files_and_directories.rb
-	examples/find_files_and_directories.recursive.
 	examples/find_files_and_directories.recursive.md
 	examples/find_files_and_directories.recursive.rb
 	examples/show_hidden_files.md
@@ -130,6 +131,8 @@ files in current directory:
 	lib/recls/ximpl/windows.rb
 	old-gems/recls-2.6.3.gem
 	old-gems/recls-ruby-2.10.0.gem
+	test/fixtures/readonly/file-1
+	test/fixtures/readonly/file-2
 	test/scratch/test_display_parts.rb
 	test/scratch/test_entry.rb
 	test/scratch/test_files_and_directories.rb
@@ -147,51 +150,55 @@ files in current directory:
 	test/unit/test_all_separately.sh
 	test/unit/ts_all.rb
 
-directories in current directory:
-	doc
-	examples
-	lib
-	old-gems
-	test
-	doc/css
-	doc/examples
-	doc/fonts
-	doc/images
-	doc/js
-	doc/Recls
-	lib/recls
-	lib/recls/ximpl
-	test/scratch
-	test/unit
+directories under current directory:
+	doc/
+	examples/
+	lib/
+	old-gems/
+	test/
+	doc/css/
+	doc/examples/
+	doc/fonts/
+	doc/images/
+	doc/js/
+	doc/Recls/
+	lib/recls/
+	lib/recls/ximpl/
+	test/fixtures/
+	test/scratch/
+	test/unit/
+	test/fixtures/hidden/
+	test/fixtures/readonly/
 
-files and directories in current directory:
+files and directories under current directory:
 	build_gem.cmd
 	build_gem.sh
 	CHANGES.md
-	doc
-	examples
+	doc/
+	examples/
 	EXAMPLES.md
 	generate_rdoc.sh
-	lib
+	lib/
 	LICENSE
-	old-gems
+	old-gems/
 	Rakefile
 	README.md
+	recls-ruby-2.10.1.gem
 	recls.gemspec
 	run_all_unit_tests.sh
-	test
+	test/
 	doc/CHANGES_md.html
 	doc/created.rid
-	doc/css
-	doc/examples
+	doc/css/
+	doc/examples/
 	doc/EXAMPLES_md.html
-	doc/fonts
-	doc/images
+	doc/fonts/
+	doc/images/
 	doc/index.html
-	doc/js
+	doc/js/
 	doc/LICENSE.html
 	doc/README_md.html
-	doc/Recls
+	doc/Recls/
 	doc/Recls.html
 	doc/table_of_contents.html
 	doc/css/fonts.css
@@ -241,14 +248,13 @@ files and directories in current directory:
 	doc/Recls/Entry.html
 	examples/find_files_and_directories.md
 	examples/find_files_and_directories.rb
-	examples/find_files_and_directories.recursive.
 	examples/find_files_and_directories.recursive.md
 	examples/find_files_and_directories.recursive.rb
 	examples/show_hidden_files.md
 	examples/show_hidden_files.rb
 	examples/show_readonly_files.md
 	examples/show_readonly_files.rb
-	lib/recls
+	lib/recls/
 	lib/recls.rb
 	lib/recls/api.rb
 	lib/recls/combine_paths_1.rb
@@ -262,15 +268,20 @@ files and directories in current directory:
 	lib/recls/stat.rb
 	lib/recls/util.rb
 	lib/recls/version.rb
-	lib/recls/ximpl
+	lib/recls/ximpl/
 	lib/recls/ximpl/os.rb
 	lib/recls/ximpl/unix.rb
 	lib/recls/ximpl/util.rb
 	lib/recls/ximpl/windows.rb
 	old-gems/recls-2.6.3.gem
 	old-gems/recls-ruby-2.10.0.gem
-	test/scratch
-	test/unit
+	test/fixtures/
+	test/scratch/
+	test/unit/
+	test/fixtures/hidden/
+	test/fixtures/readonly/
+	test/fixtures/readonly/file-1
+	test/fixtures/readonly/file-2
 	test/scratch/test_display_parts.rb
 	test/scratch/test_entry.rb
 	test/scratch/test_files_and_directories.rb
@@ -290,3 +301,4 @@ files and directories in current directory:
 ```
 
 
+

data/examples/find_files_and_directories.recursive.rb

@@ -9,11 +9,11 @@ Recls.file_rsearch(nil, nil, Recls::FILES).each { |fe| puts "\t#{fe.search_relat
 puts
 
 puts "directories under current directory:"
-Recls.file_rsearch(nil, nil, Recls::DIRECTORIES).each { |fe| puts "\t#{fe.search_relative_path}" }
+Recls.file_rsearch(nil, nil, Recls::DIRECTORIES | Recls::MARK_DIRECTORIES).each { |fe| puts "\t#{fe.search_relative_path}" }
 puts
 
 puts "files and directories under current directory:"
-Recls.file_rsearch(nil, nil, Recls::DIRECTORIES | Recls::FILES).each { |fe| puts "\t#{fe.search_relative_path}" }
+Recls.file_rsearch(nil, nil, Recls::DIRECTORIES | Recls::FILES | Recls::MARK_DIRECTORIES).each { |fe| puts "\t#{fe.search_relative_path}" }
 puts
 
 

data/lib/recls/entry.rb

@@ -4,10 +4,11 @@
 # Purpose:      Defines the Recls::Entry class for the recls.Ruby library.
 #
 # Created:      24th July 2012
-# Updated:      14th April 2019
+# Updated:      25th May 2020
 #
 # Author:       Matthew Wilson
 #
+# Copyright (c) 2019-2020, Matthew Wilson and Synesis Information Systems
 # Copyright (c) 2012-2019, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
@@ -247,6 +248,8 @@ module Recls
 			@file_stat.directory?
 		end
 
+		alias_method :dir?, :directory?
+
 		# indicates whether the given entry represents a file
 		def file?
 

data/lib/recls/foreach.rb

@@ -4,7 +4,7 @@
 # Purpose:      Definition of Recls::foreach() utility function
 #
 # Created:      22nd October 2014
-# Updated:      14th April 2019
+# Updated:      26th May 2020
 #
 # Author:       Matthew Wilson
 #
@@ -113,12 +113,15 @@ module Recls
 
 		case	args.length
 		when	1
+
 			raise ArgumentError "Single argument must be of type #{Recls::FileSearch}" unless args[0].kind_of? Recls::FileSearch
 
 			fs = args[0]
 		when	3
+
 			fs = Recls::FileSearch.new(args[0], args[1], args[2])
 		else
+
 			raise ArgumentError "Function requires single argument (#{Recls::FileSearch}) or three arguments (directory, patterns, flags)"
 		end
 

data/lib/recls/version.rb

@@ -4,10 +4,11 @@
 # Purpose:      Version for recls library
 #
 # Created:      14th February 2014
-# Updated:      14th April 2019
+# Updated:      25th May 2020
 #
 # Author:       Matthew Wilson
 #
+# Copyright (c) 2019-2020, Matthew Wilson and Synesis Information Systems
 # Copyright (c) 2012-2019, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
@@ -44,7 +45,7 @@ class Object; end # :nodoc:
 module Recls
 
 	# Current version of the recls.Ruby library
-	VERSION				=	'2.10.1'
+	VERSION				=	'2.11.0'
 
 	private
 	VERSION_PARTS_		=	VERSION.split(/[.]/).collect { |n| n.to_i } # :nodoc:

data/test/scratch/test_entry.rb

@@ -45,6 +45,7 @@ puts "\t#{'f.exist?'.ljust(20)}\t#{f.exist?}"
 puts "\t#{'f.hidden?'.ljust(20)}\t#{f.hidden?}"
 puts "\t#{'f.readonly?'.ljust(20)}\t#{f.readonly?}"
 puts "\t#{'f.directory?'.ljust(20)}\t#{f.directory?}"
+puts "\t#{'f.dir?'.ljust(20)}\t#{f.dir?}"
 puts "\t#{'f.file?'.ljust(20)}\t#{f.file?}"
 puts "\t#{'f.socket?'.ljust(20)}\t#{f.socket?}"
 

data/test/scratch/test_pattern_arrays.rb

@@ -0,0 +1,32 @@
+#! /usr/bin/env ruby
+#
+# test Recls entry methods showing parts
+
+$:.unshift File.join(File.dirname(__FILE__), '../..', 'lib')
+
+require 'recls'
+
+root_dir	=	File.join(File.dirname(__FILE__), '../..')
+patterns_a	=	%w{ *.rb *.md }
+patterns_s	=	patterns_a.join('|')
+
+
+puts
+puts "Searching for pattern string '#{patterns_s}':"
+
+Recls::FileSearch.new(root_dir, patterns_s, Recls::FILES | Recls::RECURSIVE).each do |fe|
+
+	puts fe.search_relative_path
+end
+
+
+
+puts
+puts "Searching for pattern array '#{patterns_a}':"
+
+Recls::FileSearch.new(root_dir, patterns_a, Recls::FILES | Recls::RECURSIVE).each do |fe|
+
+	puts fe.search_relative_path
+end
+
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recls-ruby
 version: !ruby/object:Gem::Version
-  version: 2.10.1
+  version: 2.11.0
 platform: ruby
 authors:
 - Matt Wilson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-14 00:00:00.000000000 Z
+date: 2020-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: xqsr3
@@ -24,9 +24,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.31'
-description: 'RECursive LS for Ruby
-
-'
+description: |
+  RECursive LS for Ruby
 email: matthew@synesis.com.au
 executables: []
 extensions: []
@@ -67,6 +66,7 @@ files:
 - test/scratch/test_files_and_directories.rb
 - test/scratch/test_foreach.rb
 - test/scratch/test_module_function.rb
+- test/scratch/test_pattern_arrays.rb
 - test/scratch/test_show_dev_and_ino.rb
 - test/scratch/test_show_hidden.rb
 - test/unit/tc_recls_entries.rb
@@ -97,7 +97,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubyforge_project: 
+rubygems_version: 2.2.5
 signing_key: 
 specification_version: 4
 summary: recls.Ruby