Merge pull request #11 from LIM-AeroCloud/rel/0.1.1

Rel/0.1.1

Author: pb866

CHANGELOG.md

@@ -1,9 +1,34 @@
 # Release Notes
 
 This project uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-The format of the release notes follows [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+The format of the release notes follows [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
-## [v0.1.0] - 2025-04-23
+## [v0.1.1] - 2025-05-24
+
+### Added
+
+- Overload Julia's `dirname` with a method for `SFTP` ([#9]).
+
+### Deprecated
+
+- The following methods have been deprecated to avoid type piracy ([#8]):
+  - `pwd(::URI)`
+  - `splitdir(::URI)`
+  - `basename(::URI)`
+- For `joinpath`, the provided method by the `URIs` package is used, an internal `cwd` function
+  replaces `pwd`, `splitdir` and `basename` will be removed without replacement.
+
+### Removed
+
+- The `joinpath(::URI, paths::AbstractString...)` method is directly removed as it seems,
+  previously URIs' `joinpath` method was used anyway ([#8]).
+
+### Fixed
+
+- Ensure all `AbstractString` paths are converted to `String` in function `readdir`
+  for correct processing of the paths ([#10]).
+
+## [v0.1.0] - 2025-05-18
 
 The initial release is based on [SFTPClient (v0.4.4)](https://github.com/stensmo/SFTPClient.jl/releases/tag/0.4.4).
 All changes for this released are documented in respect to this version.
@@ -70,3 +95,7 @@ All changes for this released are documented in respect to this version.
 <!-- Links generated by Changelog.jl -->
 
 [v0.1.0]: https://github.com/LIM-AeroCloud/SFTP.jl/releases/tag/v0.1.0
+[v0.1.1]: https://github.com/LIM-AeroCloud/SFTP.jl/releases/tag/v0.1.1
+[#8]: https://github.com/LIM-AeroCloud/SFTP.jl/issues/8
+[#9]: https://github.com/LIM-AeroCloud/SFTP.jl/issues/9
+[#10]: https://github.com/LIM-AeroCloud/SFTP.jl/issues/10

Project.toml

@@ -1,7 +1,7 @@
 name = "SFTP"
 uuid = "f44f501d-421f-4286-bfa3-132bd4e9b35e"
 authors = ["Peter Bräuer <pb866.git@gmail.com>"]
-version = "0.1.0"
+version = "0.1.1"
 
 [deps]
 Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"

docs/src/filesystem.md

@@ -17,6 +17,10 @@ for more details on the `URI` struct.
 
 ## Navigating server paths
 
+!!! warning "Deprecation warning"
+    The [`pwd`](@ref) method for `URI` structs will be deprecated in v0.2.0 and
+    replaced by and internal `cwd` method to avoid type piracy.
+
 ```@docs
 pwd
 cd(::SFTP.Client, ::AbstractString)
@@ -30,10 +34,21 @@ walkdir(::SFTP.Client, ::AbstractString; kwargs...)
 
 ## Analyse and manipulate server paths
 
+!!! warning "Deprecation warning"
+    All methods using `URI` instead of [`SFTP.Client`](@ref) in [`basename`](@ref)
+    and [`splitdir`](@ref) will be deprecated in v0.2.0 to avoid type piracy.
+
+!!! warning "Known issue"
+    [URIs'](https://github.com/JuliaWeb/URIs.jl.git) `joinpath` method currently
+    assigns two leading slashes (`//`) instead of one, if an absolute path is assigned
+    to an empty URI path. This issue is addressed in
+    [PR #62](https://github.com/JuliaWeb/URIs.jl/pull/62).
+
 ```@docs
-joinpath(::SFTP.Client)
-basename
+joinpath
 splitdir
+dirname
+basename
 ```
 
 ## Getting statistics on path objects

docs/src/release-notes.md

@@ -5,9 +5,34 @@ EditURL = "https://github.com/LIM-AeroCloud/SFTP.jl/blob/master/CHANGELOG.md"
 # Release Notes
 
 This project uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-The format of the release notes follows [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+The format of the release notes follows [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
-## [v0.1.0](https://github.com/LIM-AeroCloud/SFTP.jl/releases/tag/v0.1.0) - 2025-04-23
+## [v0.1.1](https://github.com/LIM-AeroCloud/SFTP.jl/releases/tag/v0.1.1) - 2025-05-24
+
+### Added
+
+- Overload Julia's `dirname` with a method for `SFTP` ([#9](https://github.com/LIM-AeroCloud/SFTP.jl/issues/9)).
+
+### Deprecated
+
+- The following methods have been deprecated to avoid type piracy ([#8](https://github.com/LIM-AeroCloud/SFTP.jl/issues/8)):
+  - `pwd(::URI)`
+  - `splitdir(::URI)`
+  - `basename(::URI)`
+- For `joinpath`, the provided method by the `URIs` package is used, an internal `cwd` function
+  replaces `pwd`, `splitdir` and `basename` will be removed without replacement.
+
+### Removed
+
+- The `joinpath(::URI, paths::AbstractString...)` method is directly removed as it seems,
+  previously URIs' `joinpath` method was used anyway ([#8](https://github.com/LIM-AeroCloud/SFTP.jl/issues/8)).
+
+### Fixed
+
+- Ensure all `AbstractString` paths are converted to `String` in function `readdir`
+  for correct processing of the paths ([#10](https://github.com/LIM-AeroCloud/SFTP.jl/issues/10)).
+
+## [v0.1.0](https://github.com/LIM-AeroCloud/SFTP.jl/releases/tag/v0.1.0) - 2025-05-18
 
 The initial release is based on [SFTPClient (v0.4.4)](https://github.com/stensmo/SFTPClient.jl/releases/tag/0.4.4).
 All changes for this released are documented in respect to this version.

release-scripts/pre-release.jl

@@ -1,25 +1,29 @@
 using Dates
 
+
+"""
+    get_version() -> String
+
+Get the release version from the release branch name.
+"""
+function get_version()
+    # Read current branch name
+    out = Pipe()
+    run(pipeline(ignorestatus(`git rev-parse --abbrev-ref HEAD`), stdout=out))
+    close(out.in)
+    rel = @async String(read(out))
+    rel = String(read(out)) |> chomp
+    return rel[5:end]
+end
+
+
 # Parse main Project.toml
 project = joinpath(@__DIR__, "..", "Project.toml")
 lines = readlines(project)
-# Find Julia version
+# Set release version
 vstring = "version = "
+version = get_version()
 i = findfirst(startswith(vstring), lines)
-vstart, vend = findall(isequal('"'), lines[i])
-vstart += 1
-vend -= 1
-println("current version: ", lines[i][vstart:vend])
-version = VersionNumber(lines[i][vstart:vend])
-
-# Set stable version
-if !isempty(version.prerelease)
-    println("Drop prerelease version ", join(version.prerelease, "."))
-end
-if !isempty(version.build)
-    println("Drop build version ", join(version.build, "."))
-end
-version = string(VersionNumber(version.major, version.minor, version.patch))
 lines[i] = vstring * '"' * version * '"'
 println("set version to ", version)
 

src/SFTP.jl

@@ -12,9 +12,10 @@ include("client.jl")
 include("fileexchange.jl")
 include("filestats.jl")
 include("filesystem.jl")
+include("deprecated.jl")
 
 @static if VERSION ≥ v"1.11"
-    eval(Meta.parse("public Client, StatStruct, download, stat, filemode, ispath, isdir, isfile, islink, pwd, cd, mv, rm, mkdir, mkpath, readdir, walkdir, joinpath, splitdir, basename"))
+    eval(Meta.parse("public Client, StatStruct, download, stat, filemode, ispath, isdir, isfile, islink, pwd, cd, mv, rm, mkdir, mkpath, readdir, walkdir, joinpath, splitdir, dirname, basename"))
 end
 
 export upload, statscan, URI

src/client.jl

@@ -303,13 +303,14 @@ function change_uripath(uri::URI, path::AbstractString...; trailing_slash::Union
         push!(paths, replace(p, Base.Filesystem.path_separator => "/"))
     end
     # Issue with // at the beginning of a path can be resolved by ensuring non-empty paths
+    uri = URI(uri, path = cwd(uri))
     uri = joinpath(uri, paths...)
     uri = if istrue(trailing_slash)
         # Add trailing slash for directories and when flag is true
         joinpath(uri, "")
     elseif isfalse(trailing_slash) && endswith(uri.path, "/")
         # Remove trailing slash when flag is false
-        joinpath(uri, uri.path[1:end-1])
+        joinpath(uri, string(uri.path[1:end-1]))
     else # leave unchanged, when trailing_slash is nothing
         uri
     end

src/deprecated.jl

@@ -0,0 +1,45 @@
+"""
+    pwd(uri::URI) -> String
+
+Return the current path of the `uri`.
+"""
+function Base.pwd(uri::URI)::String
+    Base.depwarn(string("pwd(::URI) is deprecated. It will be removed in v0.2.0 to avoid type piracy. ",
+        "If you rely on this method open an issue or make a pull request to URIs.jl ",
+        "(https://github.com/JuliaWeb/URIs.jl)"), :pwd)
+    isempty(uri.path) ? "/" : string(uri.path)
+end
+
+
+"""
+    splitdir(uri::URI) -> Tuple{URI, String}
+
+Split the `uri` path into a directory and base part. The directory is returned as a `URI` with a
+trailing slash in the path.
+"""
+function Base.splitdir(uri::URI, path::AbstractString=".")::Tuple{URI,String}
+    Base.depwarn(string("splitdir(::URI) is deprecated. It will be removed in v0.2.0 to avoid type piracy. ",
+        "If you rely on this method open an issue or make a pull request to URIs.jl ",
+        "(https://github.com/JuliaWeb/URIs.jl)"), :splitdir)
+    # Join the path with the sftp.uri, ensure no trailing slashes in the path
+    # ℹ First enforce trailing slashes with joinpath(..., ""), then remove the slash with path[1:end-1]
+    path = joinpath(uri, string(path), "").path[1:end-1]
+    # ¡ workaround for URIs joinpath
+    startswith(path, "//") && (path = path[2:end])
+    # Split directory from base name
+    dir, base = splitdir(path)
+    # Convert dir to a URI with trailing slash
+    joinpath(URI(uri; path=dir), ""), base
+end
+
+"""
+    basename(uri::URI) -> String
+
+Return the base name (last non-empty part after a path separator (`/` or `\\` in Windows)) of the `uri` path.
+"""
+function Base.basename(uri::URI, path::AbstractString=".")::String
+    Base.depwarn(string("basename(::URI) is deprecated. It will be removed in v0.2.0 to avoid type piracy. ",
+        "If you rely on this method open an issue or make a pull request to URIs.jl ",
+        "(https://github.com/JuliaWeb/URIs.jl)"), :basename)
+    splitdir(uri, path)[2]
+end

src/fileexchange.jl

@@ -254,14 +254,14 @@ function mkfolder(
         dirs = setdiff(dirs, conflicts)
     elseif istrue(force)
         if isempty(__test__)
-            rm.(sftp, joinpath.(sftp, path, conflicts) .|> pwd, recursive = true, force = true)
+            rm.(sftp, joinpath.(sftp, path, conflicts) .|> cwd, recursive = true, force = true)
         else
             rm.(joinrootpath.(__test__, path, conflicts), recursive=true, force=true)
         end
     end
     # Create missing folders
     if isempty(__test__)
-        mkdir.(sftp, joinpath.(sftp, path, dirs) .|> pwd)
+        mkdir.(sftp, joinpath.(sftp, path, dirs) .|> cwd)
     else
         mkdir.(joinrootpath.(__test__, path, dirs))
     end
@@ -327,10 +327,10 @@ function upload_file(
     ignore_hidden && filter!(!startswith(hide_identifier), files)
     if isnothing(force)
         !isempty(conflicts) && throw(Base.IOError("cannot overwrite existing path(s) \
-            $(join(joinpath.(sftp, dst, files) .|> pwd, ", ", " and "))", -1))
+            $(join(joinpath.(sftp, dst, files) .|> cwd, ", ", " and "))", -1))
     elseif istrue(force)
         if isempty(__test__)
-            rm.(sftp, joinpath.(sftp, dst, conflicts) .|> pwd,
+            rm.(sftp, joinpath.(sftp, dst, conflicts) .|> cwd,
                 recursive = true, force = true)
         else
             rm.(joinrootpath.(__test__, dst, conflicts), recursive=true, force=true)