Improved code to get rid of warnings, prepared release of 0.2.4

sandreas · sandreas · commit 421506fd4b6b · 2024-12-29T06:04:28.000+01:00
diff --git a/tone.Tests/tone.Tests.csproj b/tone.Tests/tone.Tests.csproj
@@ -15,7 +15,7 @@
         <PackageReference Include="Sandreas.Files" Version="1.1.2" />
         <PackageReference Include="Spectre.Console.Cli" Version="0.49.1" />
         <PackageReference Include="xunit" Version="2.9.2" />
-        <PackageReference Include="xunit.runner.visualstudio" Version="2.8.2">
+        <PackageReference Include="xunit.runner.visualstudio" Version="3.0.0">
             <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
             <PrivateAssets>all</PrivateAssets>
         </PackageReference>
diff --git a/tone/Commands/MergeCommand.cs b/tone/Commands/MergeCommand.cs
@@ -1,4 +1,4 @@
-namespace tone.Commands;
+// namespace tone.Commands;
 
 // [Command("merge")]
 // public class MergeCommand : ICommand
diff --git a/tone/Commands/Settings/SplitCommandSettings.cs b/tone/Commands/Settings/SplitCommandSettings.cs
@@ -1,6 +1,4 @@
-using System;
 using Spectre.Console.Cli;
-using tone.Interceptors;
 
 namespace tone.Commands.Settings;
 
diff --git a/tone/Commands/Settings/TagSettingsBase.cs b/tone/Commands/Settings/TagSettingsBase.cs
@@ -14,12 +14,12 @@ public class TagSettingsBase : CommandSettingsBase,
     IMetadata, 
     ICoverTaggerSettings, 
     IToneJsonTaggerSettings, 
-    IIdTaggerSettings, 
     IPathPatternSettings, 
     IChptFmtNativeTaggerSettings, 
     IFfmetadataTaggerSettings,
     IRemoveTaggerSettings, 
     ITaggerOrderSettings, 
+    // IIdTaggerSettings, // IScriptSettings already implements IIdTaggerSettings 
     IScriptSettings,
     IPrependMovementToDescriptionTaggerSettings
 {
diff --git a/tone/Common/StringParser/Token.cs b/tone/Common/StringParser/Token.cs
@@ -1,5 +1,4 @@
 using System;
-using System.Text;
 
 namespace tone.Common.StringParser;
 
diff --git a/tone/Directives/LinqExtensions.cs b/tone/Directives/LinqExtensions.cs
@@ -1,6 +1,4 @@
 using System.Collections.Generic;
-using System.Linq;
-using System.Threading.Tasks;
 
 namespace tone.Directives;
 
diff --git a/tone/Interceptors/CommandSettingsProvider.cs b/tone/Interceptors/CommandSettingsProvider.cs
@@ -1,8 +1,6 @@
 using System;
 using System.Collections.Generic;
-using System.Linq;
 using Spectre.Console.Cli;
-using tone.Metadata.Taggers;
 
 namespace tone.Interceptors;
 
diff --git a/tone/Metadata/Taggers/ChptFmtNativeTagger.cs b/tone/Metadata/Taggers/ChptFmtNativeTagger.cs
@@ -16,7 +16,7 @@ public ChptFmtNativeTagger(IFileSystem? fileSystem, ChptFmtNativeMetadataFormat
     {
     }
 
-    protected override string? BuildPreferredFileName(IFileInfo audioFile) => ConcatPreferredFileName(audioFile, DefaultFileSuffix);
+    protected override string BuildPreferredFileName(IFileInfo audioFile) => ConcatPreferredFileName(audioFile, DefaultFileSuffix);
 
     protected override bool FilterCallback(IFileInfo f) => f.Name.EndsWith(DefaultFileSuffix);
 
diff --git a/tone/Metadata/Taggers/CoverTagger.cs b/tone/Metadata/Taggers/CoverTagger.cs
@@ -26,7 +26,7 @@ public class CoverTagger: INamedTagger
     public CoverTagger(IFileSystem fs, IEnumerable<string> covers, bool autoload=false)
     {
         _fs = fs;
-        _covers = covers.Select(f => fs.FileInfo.FromFileName(f)).ToList();
+        _covers = covers.Select(f => fs.FileInfo.New(f)).ToList();
         _autoload = autoload;
     }
     
diff --git a/tone/Metadata/Taggers/FfmetadataTagger.cs b/tone/Metadata/Taggers/FfmetadataTagger.cs
@@ -15,7 +15,7 @@ public FfmetadataTagger(IFileSystem? fileSystem, FfmetadataFormat parser, string
     {
     }
 
-    protected override string? BuildPreferredFileName(IFileInfo audioFile) => ConcatPreferredFileName(audioFile, DefaultFileSuffix);
+    protected override string BuildPreferredFileName(IFileInfo audioFile) => ConcatPreferredFileName(audioFile, DefaultFileSuffix);
 
     protected override bool FilterCallback(IFileInfo f) => f.Name.EndsWith(DefaultFileSuffix) || f.Name.EndsWith(".ffmetadata");
 
diff --git a/tone/Metadata/Taggers/IFileSystemExtensions.cs b/tone/Metadata/Taggers/IFileSystemExtensions.cs
@@ -12,10 +12,10 @@ public static class FileSystemExtensions
     public static IDirectoryInfo GetContainingDirectory(this IFileSystem fs, string path) {
         var attr = fs.File.GetAttributes(path);
         if ((attr & FileAttributes.Directory) != FileAttributes.Directory) {
-            path = fs.Path.GetDirectoryName(path);
+            path = fs.Path.GetDirectoryName(path) ?? path;
         }
 
-        return fs.DirectoryInfo.FromDirectoryName(path);
+        return fs.DirectoryInfo.New(path);
     }
     
     public static IEnumerable<IFileInfo> FindMatchingFiles(this IFileSystem fs, string path, string fileNameSuffix, string fileNamePrefix="")
@@ -29,14 +29,14 @@ public static IEnumerable<IFileInfo> FindMatchingFiles(this IFileSystem fs, stri
             {
                 newFileNamePrefix = fs.Path.GetFileNameWithoutExtension(path) + ".";
             }
-            path = fs.Path.GetDirectoryName(path);
-            result.AddRange(fs.Directory.EnumerateFiles(path).Where(f => f.StartsWith(newFileNamePrefix) && f.EndsWith(fileNameSuffix)).Select(f => fs.FileInfo.FromFileName(f)));
+            path = fs.Path.GetDirectoryName(path) ?? path;
+            result.AddRange(fs.Directory.EnumerateFiles(path).Where(f => f.StartsWith(newFileNamePrefix) && f.EndsWith(fileNameSuffix)).Select(f => fs.FileInfo.New(f)));
             if (result.Count > 0)
             {
                 return result;
             }
         }
         
-        return fs.Directory.EnumerateFiles(path).Where(f => (fileNamePrefix == "" || f.StartsWith(fileNamePrefix)) && f.EndsWith(fileNameSuffix)).Select(f => fs.FileInfo.FromFileName(f));
+        return fs.Directory.EnumerateFiles(path).Where(f => (fileNamePrefix == "" || f.StartsWith(fileNamePrefix)) && f.EndsWith(fileNameSuffix)).Select(f => fs.FileInfo.New(f));
     }
 }
diff --git a/tone/Metadata/Taggers/IdTaggerComposite.cs b/tone/Metadata/Taggers/IdTaggerComposite.cs
@@ -51,7 +51,7 @@ public async Task<Status<string>> UpdateAsync(IMetadata metadata, IMetadata? ori
             if (tagger.SupportsId(Id))
             {
                 tagger.Id = Id;
-                var result = await tagger.UpdateAsync(metadata);
+                _ = await tagger.UpdateAsync(metadata);
             }
         }
 
@@ -70,7 +70,7 @@ private Result<string, string> ResolveScriptedId(IMetadata metadata)
             _jint.SetValue("metadata", metadata);
             return Ok(_jint.Evaluate("return " + Id).AsString());
         }
-        catch (Exception e)
+        catch (Exception)
         {
             return Error("Id could not be resolved: " + Id);
         }
diff --git a/tone/Metadata/Taggers/IdTaggers/Audible/AudibleMetadataResponse.cs b/tone/Metadata/Taggers/IdTaggers/Audible/AudibleMetadataResponse.cs
@@ -4,6 +4,6 @@ namespace tone.Metadata.Taggers.IdTaggers.Audible;
 
 public class AudibleMetadataResponse
 {
-    public Product Product { get; set; }
-    
+    public Product Product { get; set; } = new();
+
 }
diff --git a/tone/Metadata/Taggers/IdTaggers/ScriptIdTagger.cs b/tone/Metadata/Taggers/IdTaggers/ScriptIdTagger.cs
@@ -1,5 +1,4 @@
 using System.Collections.Generic;
-using System.Linq;
 using Jint;
 
 namespace tone.Metadata.Taggers.IdTaggers;
diff --git a/tone/Metadata/Taggers/ToneJsonTagger.cs b/tone/Metadata/Taggers/ToneJsonTagger.cs
@@ -26,14 +26,14 @@ public class ToneJsonTagger : INamedTagger
     public ToneJsonTagger(IFileSystem fs, IEnumerable<string> toneJsonFiles, bool autoload = false)
     {
         _fs = fs;
-        _toneJsonFiles = toneJsonFiles.Select(f => fs.FileInfo.FromFileName(f)).ToList();
+        _toneJsonFiles = toneJsonFiles.Select(f => fs.FileInfo.New(f)).ToList();
         _autoload = autoload;
     }
 
     public ToneJsonTagger(IFileSystem fs, IToneJsonTaggerSettings settings)
     {
         _fs = fs;
-        _toneJsonFiles = settings.ToneJsonFiles.Select(f => fs.FileInfo.FromFileName(f)).ToList();
+        _toneJsonFiles = settings.ToneJsonFiles.Select(f => fs.FileInfo.New(f)).ToList();
         _autoload = settings.AutoImportToneJson;
     }
 
diff --git a/tone/Metadata/ToneJsonAudio.cs b/tone/Metadata/ToneJsonAudio.cs
@@ -1,18 +1,17 @@
-using ATL;
 using Sandreas.AudioMetadata;
 
 namespace tone.Metadata;
 
 public class ToneJsonAudio
 {
     public int Bitrate { get; set; }
-    public string Format { get; set; }
-    public string FormatShort { get; set; }
+    public string Format { get; set; } = "";
+    public string FormatShort { get; set; } = "";
 
     public double SampleRate { get; set; }
     public double Duration { get; set; }
     public bool Vbr { get; set; }
     public object? Channels { get; set; }
     public object? Frames { get; set; }
-    public MetadataSpecification[] MetaFormat { get; set; }
+    public MetadataSpecification[] MetaFormat { get; set; } = System.Array.Empty<MetadataSpecification>();
 }
diff --git a/tone/Metadata/ToneJsonContractResolver.cs b/tone/Metadata/ToneJsonContractResolver.cs
@@ -1,8 +1,6 @@
 using System;
-using System.Collections.Generic;
 using System.Linq;
 using System.Reflection;
-using ATL;
 using Newtonsoft.Json;
 using Newtonsoft.Json.Serialization;
 using Sandreas.AudioMetadata;
diff --git a/tone/Metadata/ToneJsonFile.cs b/tone/Metadata/ToneJsonFile.cs
@@ -1,5 +1,4 @@
 using System;
-using ATL;
 
 namespace tone.Metadata;
 
@@ -9,6 +8,6 @@ public class ToneJsonFile
     public DateTime Created { get; set; } 
     public DateTime Modified { get; set; }
     public DateTime Accessed { get; set; }
-    public string Path { get; set; }
-    public string Name { get; set; }
+    public string Path { get; set; } = "";
+    public string Name { get; set; } = "";
 }
diff --git a/tone/Program.cs b/tone/Program.cs
@@ -101,7 +101,7 @@
         {
             new StringEnumConverter { NamingStrategy = new CamelCaseNamingStrategy() }
         },
-        Formatting = Formatting.Indented,
+        Formatting = Formatting.Indented
     });
     services.AddSingleton<ChptFmtNativeSerializer>();
     services.AddSingleton<FfmetadataSerializer>();
@@ -116,24 +116,26 @@
         var startupErrorsService = s.GetRequiredService<StartupErrorService>();
         var settings = settingsProvider.Get<IPathPatternSettings>();
         var pathPatterns = new List<(string, Grok)>();
-        if (settings != null)
+        if (settings == null)
         {
-            var customPatterns = settings.PathPatternExtension.Concat(new[]
-            {
-                "NOTDIRSEP [^/\\\\]*",
-                "PARTNUMBER \\b[0-9-.,IVXLCDM]+\\b"
-            });
+            return new PathPatternMatcher(pathPatterns);
+        }
 
-            var grokDefinitions = patternService.Build(settings.PathPattern, customPatterns);
-            if (grokDefinitions)
-            {
-                pathPatterns = grokDefinitions.Value.ToList();
-            }
-            else
-            {
-                startupErrorsService.Errors.Add((ReturnCode.GeneralError,
-                    "Could not parse `--path-pattern`: " + grokDefinitions.Error));
-            }
+        string[] predefinedPatterns = {
+            @"NOTDIRSEP [^/\\]*",
+            @"PARTNUMBER \b[0-9-.,IVXLCDM]+\b"
+        };
+        var customPatterns = settings.PathPatternExtension.Concat(predefinedPatterns);
+
+        var grokDefinitions = patternService.Build(settings.PathPattern, customPatterns);
+        if (grokDefinitions)
+        {
+            pathPatterns = grokDefinitions.Value.ToList();
+        }
+        else
+        {
+            startupErrorsService.Errors.Add((ReturnCode.GeneralError,
+                "Could not parse `--path-pattern`: " + grokDefinitions.Error));
         }
 
         return new PathPatternMatcher(pathPatterns);
@@ -151,10 +153,9 @@
         });
     });
 
-    services.AddSingleton<AudibleIdTaggerSettings>(_ => new AudibleIdTaggerSettings(){
+    services.AddSingleton<AudibleIdTaggerSettings>(_ => new AudibleIdTaggerSettings {
         MetadataUrlTemplate = Environment.GetEnvironmentVariable("PILABOR_AUDIBLE_METADATA_URL_TEMPLATE") ?? "",
-        ChaptersUrlTemplate = Environment.GetEnvironmentVariable("PILABOR_AUDIBLE_CHAPTERS_URL_TEMPLATE") ?? "",
-        
+        ChaptersUrlTemplate = Environment.GetEnvironmentVariable("PILABOR_AUDIBLE_CHAPTERS_URL_TEMPLATE") ?? ""
     });
     services.AddHttpClient<AudibleIdTagger>();
     
@@ -230,7 +231,7 @@
         config.UseStrictParsing();
         config.CaseSensitivity(CaseSensitivity.None);
         config.SetApplicationName("tone");
-        config.SetApplicationVersion("0.2.3");
+        config.SetApplicationVersion("0.2.4");
         config.ValidateExamples();
         config.AddCommand<DumpCommand>("dump")
             .WithDescription("dump metadata for files and directories (directories are traversed recursively)")
@@ -266,7 +267,7 @@
 }
 catch (Exception e)
 {
-    if (e is CommandParseException { Pretty: { } } ce)
+    if (e is CommandParseException { Pretty: not null } ce)
     {
         AnsiConsole.Write(ce.Pretty);
     }
diff --git a/tone/Services/DirectoryLoaderService.cs b/tone/Services/DirectoryLoaderService.cs
@@ -155,18 +155,20 @@ public IEnumerable<AudioBookPackage> BuildPackages(IEnumerable<IFileInfo> files,
             // find baseDir by going up until the pattern does not match any more
             var grokPattern = grokPatternContainer.patternAsString;
             var baseDir = file.Directory;
-            while(pathMatcher.TryMatchSinglePattern(baseDir.Parent.FullName, out var grokPatternContainer2) && grokPatternContainer2.patternAsString == grokPattern)
+            var parent = baseDir?.Parent;
+            var parentFullName = parent?.FullName ?? "";
+            while(pathMatcher.TryMatchSinglePattern(parentFullName, out var grokPatternContainer2) && grokPatternContainer2.patternAsString == grokPattern)
             {
-                baseDir = baseDir.Parent;
-                if(baseDir.Root.FullName == baseDir.FullName)
+                baseDir = baseDir?.Parent;
+                if(baseDir?.Root.FullName == baseDir?.FullName)
                 {
                     break;
                 }        
             }
 
             var identifier = string.Join(",",grokResult.Select(r => r.Key+"="+r.Value));
             
-            var existingDirectoryPackage = packages.FirstOrDefault(p => p.Id == identifier && p.BaseDirectory?.FullName == baseDir.FullName);
+            var existingDirectoryPackage = packages.FirstOrDefault(p => p.Id == identifier && p.BaseDirectory?.FullName == baseDir?.FullName);
             if (existingDirectoryPackage == null)
             {
                 packages.Add(new AudioBookPackage
diff --git a/tone/Services/JavaScriptApi.cs b/tone/Services/JavaScriptApi.cs
@@ -31,10 +31,9 @@ public JavaScriptApi()
         // fallback "dummy" constructor in case of missing prerequisites
         _jint = new Engine();
         _tagger = new TaggerComposite();
-        _idTagger = new IdTaggerComposite(_jint, null);
+        _idTagger = new IdTaggerComposite(_jint);
         _fs = new FileSystem();
         _http = new HttpClient();
-        
     }
     public JavaScriptApi(Engine jint, FileSystem fs, HttpClient http, TaggerComposite tagger, IdTaggerComposite idTagger, IScriptSettings scriptSettings)
     {
@@ -81,15 +80,21 @@ private string _fetch(string url, FetchData fetchData, object? data=null)
                 return await response.Content.ReadAsStringAsync().ConfigureAwait(false);
             }
 
-            var destinationFile = _fs.FileInfo.FromFileName(fetchData.DownloadPath);
+            var destinationFile = _fs.FileInfo.New(fetchData.DownloadPath);
+
             if(destinationFile.Exists && !fetchData.Overwrite)
             {
                 return "";
             }  
             
             if(!_fs.Directory.Exists(destinationFile.DirectoryName))
             {
-                _fs.Directory.CreateDirectory(destinationFile.DirectoryName);
+                var dirname = destinationFile.DirectoryName;
+                if (dirname is null)
+                {
+                    return "";
+                }
+                _fs.Directory.CreateDirectory(dirname);
             }
             
             await _fs.File.WriteAllBytesAsync(destinationFile.FullName, await response.Content.ReadAsByteArrayAsync());
@@ -113,12 +118,12 @@ private HttpRequestMessage BuildRequestMessage(string url, object? data, FetchDa
         var httpRequestMessage = new HttpRequestMessage
         {
             Method = HttpMethod.Get,
-            RequestUri = new Uri(url),
+            RequestUri = new Uri(url)
             
         };
 
         if(data != null){
-            httpRequestMessage = new HttpRequestMessage()        {
+            httpRequestMessage = new HttpRequestMessage {
                 Method = ConvertStringToHttpMethod(fetchData.Method),
                 RequestUri = new Uri(url),
                 Content = new StringContent(fetchData.Body)
@@ -167,7 +172,7 @@ public TimeSpan CreateDateTime(int milliseconds)
         return TimeSpan.FromMilliseconds(milliseconds);
     }
     public ChapterInfo CreateChapter(string title, uint start, uint length, PictureInfo? picture=null, string subtitle="",string uniqueId="")    {
-        return new ChapterInfo()
+        return new ChapterInfo
         {
             Title = title,
             StartTime = start,
diff --git a/tone/Tokenizers/FfmetadataTokenizer.cs b/tone/Tokenizers/FfmetadataTokenizer.cs
diff --git a/tone/doc/release/release-notes-v0.2.4.md b/tone/doc/release/release-notes-v0.2.4.md
diff --git a/tone/tone.csproj b/tone/tone.csproj

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-namespace tone.Commands;`
	`1`	`+// namespace tone.Commands;`
`2`	`2`
`3`	`3`	`// [Command("merge")]`
`4`	`4`	`// public class MergeCommand : ICommand`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`using System;`
`2`		`-using System.Text;`
`3`	`2`
`4`	`3`	`namespace tone.Common.StringParser;`
`5`	`4`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ public ChptFmtNativeTagger(IFileSystem? fileSystem, ChptFmtNativeMetadataFormat`
`16`	`16`	`{`
`17`	`17`	`}`
`18`	`18`
`19`		`- protected override string? BuildPreferredFileName(IFileInfo audioFile) => ConcatPreferredFileName(audioFile, DefaultFileSuffix);`
	`19`	`+ protected override string BuildPreferredFileName(IFileInfo audioFile) => ConcatPreferredFileName(audioFile, DefaultFileSuffix);`
`20`	`20`
`21`	`21`	`protected override bool FilterCallback(IFileInfo f) => f.Name.EndsWith(DefaultFileSuffix);`
`22`	`22`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ public class CoverTagger: INamedTagger`
`26`	`26`	`public CoverTagger(IFileSystem fs, IEnumerable<string> covers, bool autoload=false)`
`27`	`27`	`{`
`28`	`28`	`_fs = fs;`
`29`		`- _covers = covers.Select(f => fs.FileInfo.FromFileName(f)).ToList();`
	`29`	`+ _covers = covers.Select(f => fs.FileInfo.New(f)).ToList();`
`30`	`30`	`_autoload = autoload;`
`31`	`31`	`}`
`32`	`32`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ public FfmetadataTagger(IFileSystem? fileSystem, FfmetadataFormat parser, string`
`15`	`15`	`{`
`16`	`16`	`}`
`17`	`17`
`18`		`- protected override string? BuildPreferredFileName(IFileInfo audioFile) => ConcatPreferredFileName(audioFile, DefaultFileSuffix);`
	`18`	`+ protected override string BuildPreferredFileName(IFileInfo audioFile) => ConcatPreferredFileName(audioFile, DefaultFileSuffix);`
`19`	`19`
`20`	`20`	`protected override bool FilterCallback(IFileInfo f) => f.Name.EndsWith(DefaultFileSuffix) \|\| f.Name.EndsWith(".ffmetadata");`
`21`	`21`