recls-ruby 2.13.1 → 2.13.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0da3b80a1f5ba1babc0fdfbd56abf30433e53d39f2996fe2661d0142ad4b386d
-  data.tar.gz: 47fca376aac5eb7559fe2b7e014b8a79d23bc828fcbd999b75ce133a52a4e255
+  metadata.gz: 59eb42b0b882edabe96abf491f8a44947a84c8a2b721a16d0a1c785d4037397e
+  data.tar.gz: 51f05e185bf3e51a3c1badf5653431ee2d8e554f8d298a191b60f813b73022c3
 SHA512:
-  metadata.gz: b1c79afd72e02b47c8c9ce9291c08d1c825e96e5e66a826a36a004c08774b82e77aa5610edc0c986ebfa28b10c95f5baea75ed9bdfba12ac35a36a377fd7b747
-  data.tar.gz: dcdfee4db3cddd95879d7faf833def2daea1cdc8d91809981dfbbb3703dacc37ce77b4c1671b33dafb60d7ec446ffee6afe3a389b5de97d4063b157c5ace4b63
+  metadata.gz: b627bb5850d768f90001ff0192b0b1f8f2d09d04d9a3fd04ae96952297056b8728a68592205c39158647c6564ba450872623c14899c09f3c87dd99dda122ec9a
+  data.tar.gz: 74a224e1269bd4484a794a02f165b65138437b8790038cb3156f4147c4f66b08f7bfe29990228ae050be6bf89a504c487c79ccc8d2451fa496e6aa86f79cafa8

data/lib/recls/combine_paths_1.rb

@@ -4,11 +4,11 @@
 # Purpose:  Definition of Recls::compare_paths() for Ruby 1.x
 #
 # Created:  17th February 2014
-# Updated:  21st April 2024
+# Updated:  9th January 2025
 #
 # Author:   Matthew Wilson
 #
-# Copyright (c) 2019-2024, Matthew Wilson and Synesis Information Systems
+# Copyright (c) 2019-2025, Matthew Wilson and Synesis Information Systems
 # Copyright (c) 2014-2019, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
@@ -45,7 +45,16 @@ require 'recls/ximpl/util'
 
 module Recls
 
-  # Combines paths
+  # Combines paths, optionally canonicalising them.
+  #
+  # Unlike `File::join()`, this method takes account of relative vs absolute
+  # elements in the sequence. Specifically, the rightmost non-relative
+  # element, if it exists, anchors the combination, such that any arguments
+  # to the left are ignored. Furthermore, any entries (of type
+  # `Recls::Entry`) in the sequence are given special treatment as follows:
+  # - a rightmost `#file?` or `#device?` is returned as the complete result;
+  # - a rightmost `#directory?` causes all prior elements to be ignored and
+  #   may be combined with subsequent elements;
   #
   # === Signature
   #
@@ -60,7 +69,22 @@ module Recls
 
     raise ArgumentError, 'must specify one or more path elements' if paths.empty?
 
-    ix_last_entry = paths.rindex { |path| ::Recls::Entry === path } and return paths[ix_last_entry]
+    ix_last_entry = paths.rindex { |path| ::Recls::Entry === path }
+
+    if ix_last_entry
+
+      fe = paths[ix_last_entry]
+
+      if fe.directory?
+
+        paths = paths[ix_last_entry..]
+      else
+
+        return fe
+      end
+    end
+
+    paths = paths.map { |path| path.to_str }
 
     return Recls::Ximpl.combine_paths paths, {}
   end

data/lib/recls/combine_paths_2plus.rb

@@ -4,11 +4,11 @@
 # Purpose:  Definition of Recls::compare_paths() for Ruby 2+
 #
 # Created:  17th February 2014
-# Updated:  21st April 2024
+# Updated:  9th January 2025
 #
 # Author:   Matthew Wilson
 #
-# Copyright (c) 2019-2024, Matthew Wilson and Synesis Information Systems
+# Copyright (c) 2019-2025, Matthew Wilson and Synesis Information Systems
 # Copyright (c) 2014-2019, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
@@ -45,7 +45,16 @@ require 'recls/ximpl/util'
 
 module Recls
 
-  # Combines paths, optionally canonicalising them
+  # Combines paths, optionally canonicalising them.
+  #
+  # Unlike `File::join()`, this method takes account of relative vs absolute
+  # elements in the sequence. Specifically, the rightmost non-relative
+  # element, if it exists, anchors the combination, such that any arguments
+  # to the left are ignored. Furthermore, any entries (of type
+  # `Recls::Entry`) in the sequence are given special treatment as follows:
+  # - a rightmost `#file?` or `#device?` is returned as the complete result;
+  # - a rightmost `#directory?` causes all prior elements to be ignored and
+  #   may be combined with subsequent elements;
   #
   # === Signature
   #
@@ -66,7 +75,22 @@ module Recls
 
     raise ArgumentError, 'must specify one or more path elements' if paths.empty?
 
-    ix_last_entry = paths.rindex { |path| ::Recls::Entry === path } and return paths[ix_last_entry]
+    ix_last_entry = paths.rindex { |path| ::Recls::Entry === path }
+
+    if ix_last_entry
+
+      fe = paths[ix_last_entry]
+
+      if fe.directory?
+
+        paths = paths[ix_last_entry..]
+      else
+
+        return fe
+      end
+    end
+
+    paths = paths.map { |path| path.to_str }
 
     return Recls::Ximpl.combine_paths paths, options
   end

data/lib/recls/entry.rb

@@ -4,11 +4,11 @@
 # Purpose:  Defines the Recls::Entry class for the recls.Ruby library.
 #
 # Created:  24th July 2012
-# Updated:  21st April 2024
+# Updated:  9th January 2025
 #
 # Author:   Matthew Wilson
 #
-# Copyright (c) 2019-2024, Matthew Wilson and Synesis Information Systems
+# Copyright (c) 2019-2025, Matthew Wilson and Synesis Information Systems
 # Copyright (c) 2012-2019, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
@@ -64,6 +64,7 @@ module Recls
     def initialize(path, file_stat, search_dir, flags)
 
       @file_stat    = file_stat
+      @flags        = flags
 
       @path         = Recls::Ximpl.absolute_path path
       @short_path   = nil
@@ -104,6 +105,8 @@ module Recls
         @short_path       = @file_stat.short_path
         @file_short_name  = Recls::Ximpl::Util.split_path(@short_path)[2]
       else
+
+        ;
       end
     end
 
@@ -237,9 +240,13 @@ module Recls
     # indicates whether the given entry represents a directory
     def directory?
 
-      return false if @file_stat.nil?
+      if @file_stat.nil?
 
-      @file_stat.directory?
+        (Recls::DETAILS_LATER | Recls::DIRECTORIES) == ((Recls::DETAILS_LATER | Recls::DIRECTORIES) & @flags)
+      else
+
+        @file_stat.directory?
+      end
     end
 
     alias_method :dir?, :directory?
@@ -247,9 +254,13 @@ module Recls
     # indicates whether the given entry represents a file
     def file?
 
-      return false if @file_stat.nil?
+      if @file_stat.nil?
+
+        (Recls::DETAILS_LATER | Recls::FILES) == ((Recls::DETAILS_LATER | Recls::FILES) & @flags)
+      else
 
-      @file_stat.file?
+        @file_stat.file?
+      end
     end
 
     # indicates whether the given entry represents a link

data/lib/recls/version.rb

@@ -4,7 +4,7 @@
 # Purpose:  Version for recls library
 #
 # Created:  14th February 2014
-# Updated:  2nd April 2024
+# Updated:  24th April 2025
 #
 # Author:   Matthew Wilson
 #
@@ -43,7 +43,7 @@
 module Recls
 
   # Current version of the recls.Ruby library
-  VERSION           = '2.13.1'
+  VERSION           = '2.13.2'
 
   private
   # @!visibility private

data/lib/recls/ximpl/util.rb

@@ -780,7 +780,7 @@ module Recls
       raise ArgumentError, "`paths` must be an instance of `::Array`" if $DEBUG && !paths.is_a?(::Array)
       raise ArgumentError, "`paths` elements must be instances of `::String`" if $DEBUG && paths.any? { |s| !s.is_a?(::String) }
 
-      abs_ix  = 0
+      abs_ix = 0
 
       paths = paths.map { |path| '~' == path[0].to_s ? File.expand_path(path) : path }
 

data/test/unit/tc_recls_util.rb

@@ -13,115 +13,6 @@ end
 require 'test/unit'
 
 
-class Test_combine_paths < Test::Unit::TestCase
-
-  def test_nil_nil
-
-    if RUBY_VERSION >= '2'
-
-      assert_raise_with_message(::ArgumentError, /must specify one or more path elements/) { Recls.combine_paths(nil, nil) }
-    else
-
-      assert_raise(::ArgumentError) { Recls.combine_paths(nil, nil) }
-    end
-  end
-
-  def test_origin_nil
-
-    strings = [
-
-      'abc',
-      'abc/def',
-      'abc/def/ghi.ext',
-    ]
-
-    strings.each do |s|
-
-      assert_equal s, Recls.combine_paths(nil, s)
-    end
-  end
-
-  def test_path_nil
-
-    strings = [
-
-      'abc',
-      'abc/def',
-      'abc/def/ghi.ext',
-    ]
-
-    strings.each do |s|
-
-      assert_equal s, Recls.combine_paths(s, nil)
-    end
-  end
-
-  def test_both_relative
-
-    assert_equal 'abc/def', Recls.combine_paths('abc', 'def')
-    assert_equal 'abc/def', Recls.combine_paths('abc/', 'def')
-    assert_equal 'abc/def/ghi', Recls.combine_paths('abc/def', 'ghi')
-    assert_equal 'abc/def/ghi', Recls.combine_paths('abc/def/', 'ghi')
-    assert_equal 'abc/def/ghi', Recls.combine_paths('abc', 'def/ghi')
-    assert_equal 'abc/def/ghi', Recls.combine_paths('abc/', 'def/ghi')
-    assert_equal 'abc/./def/ghi', Recls.combine_paths('abc/.', 'def/ghi')
-    assert_equal 'abc/./def/ghi', Recls.combine_paths('abc/./', 'def/ghi')
-
-    if RUBY_VERSION >= '2'
-
-      assert_equal 'abc/./def/ghi', Recls.combine_paths('abc/.', 'def/ghi', clean_path: false)
-      assert_equal 'abc/./def/ghi', Recls.combine_paths('abc/./', 'def/ghi', clean: false)
-      assert_equal 'abc/def/ghi', Recls.combine_paths('abc/.', 'def/ghi', clean_path: true)
-      assert_equal 'abc/def/ghi', Recls.combine_paths('abc/./', 'def/ghi', clean: true)
-      assert_equal 'abc/def/ghi', Recls.combine_paths('abc/./.', 'def/ghi', clean_path: true)
-      assert_equal 'abc/../def/ghi', Recls.combine_paths('abc/..', 'def/ghi')
-      assert_equal 'def/ghi', Recls.combine_paths('abc/..', 'def/ghi', clean_path: true)
-    end
-  end
-
-  def test_multiple_relative
-
-    if RUBY_VERSION >= '2'
-
-      assert_equal 'a/b/c/d/e/f/g', Recls.combine_paths('a', 'b', 'c', 'd/e/f/', 'g', clean: false)
-      assert_equal 'a/b/c/d/e/f/g', Recls.combine_paths('a', 'b', 'c', 'd/e/f/', 'g', clean: true)
-
-      assert_equal 'a/b/c/../d/e/f/g', Recls.combine_paths('a', 'b', 'c', '..', 'd/e/f/', 'g', clean: false)
-      assert_equal 'a/b/d/e/f/g', Recls.combine_paths('a', 'b', 'c', '..', 'd/e/f/', 'g/', clean: true)
-      assert_equal 'a/b/d/e/f/g/', Recls.combine_paths('a', 'b', 'c', '..', 'd/e/f/', 'g/', canonicalise: true)
-    end
-  end
-
-  def test_various_absolute_placings
-
-    assert_equal '/a/b/c/d/e/f/g', Recls.combine_paths('/', 'a', 'b', 'c', 'd/e', 'f/g')
-
-    assert_equal '/b/c/d/e/f/g', Recls.combine_paths('/', 'a', '/b', 'c', 'd/e', 'f/g')
-
-    assert_equal '/c/d/e/f/g', Recls.combine_paths('/', 'a', 'b', '/c', 'd/e', 'f/g')
-
-    assert_equal '/d/e/f/g', Recls.combine_paths('/', 'a', 'b', 'c', '/d/e', 'f/g')
-
-    assert_equal '/f/g', Recls.combine_paths('/', 'a', 'b', 'c', 'd/e', '/f/g')
-    assert_equal '/f/g/', Recls.combine_paths('/', 'a', 'b', 'c', 'd/e', '/f/g/')
-
-    if RUBY_VERSION >= '2'
-
-      assert_equal '/f/g', Recls.combine_paths('/', 'a', 'b', 'c', 'd/e', '/f/g/', clean: true)
-      assert_equal '/f/g/', Recls.combine_paths('/', 'a', 'b', 'c', 'd/e', '/f/g/', canonicalise: true)
-    end
-  end
-
-  def test_combining_with_entries
-
-    f_g = Recls.stat('/f/g', Recls::DETAILS_LATER)
-    b = Recls.stat('b', Recls::DETAILS_LATER)
-
-    assert_equal '/f/g', Recls.combine_paths('/', 'a', 'b', 'c', 'd/e', f_g)
-    assert_equal '/f/g', Recls.combine_paths('/', 'a', b, 'c', 'd/e', f_g)
-  end
-end
-
 class Test_canonicalise_path < Test::Unit::TestCase
 
   def test_nil

data/test/unit/util/tc_combine_paths.rb

@@ -0,0 +1,158 @@
+#! /usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), '../../..', 'lib')
+
+require 'recls'
+
+require 'xqsr3/extensions/test/unit'
+require 'test/unit'
+
+require 'fileutils'
+
+
+class Test_combine_paths < Test::Unit::TestCase
+
+  def test_nil_nil
+
+    if RUBY_VERSION >= '2'
+
+      assert_raise_with_message(::ArgumentError, /must specify one or more path elements/) { Recls.combine_paths(nil, nil) }
+    else
+
+      assert_raise(::ArgumentError) { Recls.combine_paths(nil, nil) }
+    end
+  end
+
+  def test_origin_nil
+
+    strings = [
+
+      'abc',
+      'abc/def',
+      'abc/def/ghi.ext',
+    ]
+
+    strings.each do |s|
+
+      assert_equal s, Recls.combine_paths(nil, s)
+    end
+  end
+
+  def test_path_nil
+
+    strings = [
+
+      'abc',
+      'abc/def',
+      'abc/def/ghi.ext',
+    ]
+
+    strings.each do |s|
+
+      assert_equal s, Recls.combine_paths(s, nil)
+    end
+  end
+
+  def test_both_relative
+
+    assert_equal 'abc/def', Recls.combine_paths('abc', 'def')
+    assert_equal 'abc/def', Recls.combine_paths('abc/', 'def')
+    assert_equal 'abc/def/ghi', Recls.combine_paths('abc/def', 'ghi')
+    assert_equal 'abc/def/ghi', Recls.combine_paths('abc/def/', 'ghi')
+    assert_equal 'abc/def/ghi', Recls.combine_paths('abc', 'def/ghi')
+    assert_equal 'abc/def/ghi', Recls.combine_paths('abc/', 'def/ghi')
+    assert_equal 'abc/./def/ghi', Recls.combine_paths('abc/.', 'def/ghi')
+    assert_equal 'abc/./def/ghi', Recls.combine_paths('abc/./', 'def/ghi')
+
+    if RUBY_VERSION >= '2'
+
+      assert_equal 'abc/./def/ghi', Recls.combine_paths('abc/.', 'def/ghi', clean_path: false)
+      assert_equal 'abc/./def/ghi', Recls.combine_paths('abc/./', 'def/ghi', clean: false)
+      assert_equal 'abc/def/ghi', Recls.combine_paths('abc/.', 'def/ghi', clean_path: true)
+      assert_equal 'abc/def/ghi', Recls.combine_paths('abc/./', 'def/ghi', clean: true)
+      assert_equal 'abc/def/ghi', Recls.combine_paths('abc/./.', 'def/ghi', clean_path: true)
+      assert_equal 'abc/../def/ghi', Recls.combine_paths('abc/..', 'def/ghi')
+      assert_equal 'def/ghi', Recls.combine_paths('abc/..', 'def/ghi', clean_path: true)
+    end
+  end
+
+  def test_multiple_relative
+
+    if RUBY_VERSION >= '2'
+
+      assert_equal 'a/b/c/d/e/f/g', Recls.combine_paths('a', 'b', 'c', 'd/e/f/', 'g', clean: false)
+      assert_equal 'a/b/c/d/e/f/g', Recls.combine_paths('a', 'b', 'c', 'd/e/f/', 'g', clean: true)
+
+      assert_equal 'a/b/c/../d/e/f/g', Recls.combine_paths('a', 'b', 'c', '..', 'd/e/f/', 'g', clean: false)
+      assert_equal 'a/b/d/e/f/g', Recls.combine_paths('a', 'b', 'c', '..', 'd/e/f/', 'g/', clean: true)
+      assert_equal 'a/b/d/e/f/g/', Recls.combine_paths('a', 'b', 'c', '..', 'd/e/f/', 'g/', canonicalise: true)
+    end
+  end
+
+  def test_various_absolute_placings
+
+    assert_equal '/a/b/c/d/e/f/g', Recls.combine_paths('/', 'a', 'b', 'c', 'd/e', 'f/g')
+
+    assert_equal '/b/c/d/e/f/g', Recls.combine_paths('/', 'a', '/b', 'c', 'd/e', 'f/g')
+
+    assert_equal '/c/d/e/f/g', Recls.combine_paths('/', 'a', 'b', '/c', 'd/e', 'f/g')
+
+    assert_equal '/d/e/f/g', Recls.combine_paths('/', 'a', 'b', 'c', '/d/e', 'f/g')
+
+    assert_equal '/f/g', Recls.combine_paths('/', 'a', 'b', 'c', 'd/e', '/f/g')
+    assert_equal '/f/g/', Recls.combine_paths('/', 'a', 'b', 'c', 'd/e', '/f/g/')
+
+    if RUBY_VERSION >= '2'
+
+      assert_equal '/f/g', Recls.combine_paths('/', 'a', 'b', 'c', 'd/e', '/f/g/', clean: true)
+      assert_equal '/f/g/', Recls.combine_paths('/', 'a', 'b', 'c', 'd/e', '/f/g/', canonicalise: true)
+    end
+  end
+
+  def test_combining_with_entries
+
+    f_g = Recls.stat('/f/g', Recls::DETAILS_LATER | Recls::DIRECTORIES)
+    b = Recls.stat('b', Recls::DETAILS_LATER | Recls::DIRECTORIES)
+    root_b = Recls.stat('/b', Recls::DETAILS_LATER | Recls::DIRECTORIES)
+
+    assert_equal '/a/b/c/d/e/f/g', Recls.combine_paths('/', 'a', 'b', 'c', 'd/e', 'f/g')
+    assert_equal '/f/g', Recls.combine_paths('/', 'a', 'b', 'c', 'd/e', '/f/g')
+
+    assert_equal '/f/g', Recls.combine_paths('/', 'a', 'b', 'c', 'd/e', f_g)
+    assert_equal '/f/g', Recls.combine_paths('/', 'a', b, 'c', 'd/e', f_g)
+  end
+
+  def test_combining_with_entries_that_exist
+
+    fe_this_file = Recls.stat(__FILE__)
+    fe_this_dir = Recls.stat(File.dirname(__FILE__))
+
+    assert_true fe_this_file.file?
+    assert_false fe_this_file.directory?
+
+    assert_true fe_this_dir.directory?
+    assert_false fe_this_dir.file?
+
+    assert_equal fe_this_file.to_s, Recls.combine_paths(fe_this_file)
+    assert_equal fe_this_file.to_s, Recls.combine_paths(nil, fe_this_file)
+    assert_equal fe_this_file.to_s, Recls.combine_paths('abc', fe_this_file)
+    assert_equal fe_this_file.to_s, Recls.combine_paths(fe_this_file)
+    assert_equal fe_this_file.to_s, Recls.combine_paths(fe_this_file, nil)
+    assert_equal fe_this_file.to_s, Recls.combine_paths(fe_this_file, '')
+    assert_equal fe_this_file.to_s, Recls.combine_paths(fe_this_file, 'abc')
+    assert_equal fe_this_file.to_s, Recls.combine_paths('abc', fe_this_file, 'abc')
+
+    assert_equal fe_this_dir.to_s, Recls.combine_paths(fe_this_dir)
+    assert_equal fe_this_dir.to_s, Recls.combine_paths(nil, fe_this_dir)
+    assert_equal fe_this_dir.to_s, Recls.combine_paths('abc', fe_this_dir)
+    assert_equal fe_this_dir.to_s, Recls.combine_paths(fe_this_dir)
+    assert_equal fe_this_dir.to_s, Recls.combine_paths(fe_this_dir, nil)
+    assert_equal "#{fe_this_dir.to_s}/", Recls.combine_paths(fe_this_dir, '')
+    assert_equal "#{fe_this_dir.to_s}/abc", Recls.combine_paths(fe_this_dir, 'abc')
+    assert_equal "#{fe_this_dir.to_s}/abc", Recls.combine_paths('abc', fe_this_dir, 'abc')
+  end
+end
+
+
+# ############################## end of file ############################# #
+

data/test/unit/util/ts_all.rb

@@ -0,0 +1,22 @@
+#! /usr/bin/env ruby
+#
+# executes all other tests
+
+this_dir = File.expand_path(File.dirname(__FILE__))
+
+# all tc_*rb in current directory
+Dir[File.join(this_dir, 'tc_*rb')].each do |file|
+
+  $stderr.puts "requiring file '#{file}'" if $DEBUG
+
+  require file
+end
+
+# all ts_*rb in immediate sub-directories
+Dir[File.join(this_dir, '*', 'ts_*rb')].each do |file|
+
+  $stderr.puts "requiring file '#{file}'" if $DEBUG
+
+  require file
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recls-ruby
 version: !ruby/object:Gem::Version
-  version: 2.13.1
+  version: 2.13.2
 platform: ruby
 authors:
 - Matt Wilson
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-02 00:00:00.000000000 Z
+date: 2025-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: xqsr3
@@ -26,7 +26,7 @@ dependencies:
         version: '0.31'
 description: 'RECursive LS for Ruby
 
-  '
+'
 email: matthew@synesis.com.au
 executables: []
 extensions: []
@@ -79,11 +79,13 @@ files:
 - test/unit/test_all_separately.cmd
 - test/unit/test_all_separately.sh
 - test/unit/ts_all.rb
+- test/unit/util/tc_combine_paths.rb
+- test/unit/util/ts_all.rb
 homepage: http://github.com/synesissoftware/recls.Ruby
 licenses:
 - BSD-3-Clause
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -98,8 +100,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: recls.Ruby
 test_files: []