8000 PortToDocs: Add methods that either collect files automatically, or allow passing documents manually by carlossanlop · Pull Request #110 · dotnet/api-docs-sync · GitHub
[go: up one dir, main page]
Skip to content

PortToDocs: Add methods that either collect files automatically, or allow passing documents manually #110

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 17, 2022
Merged

PortToDocs: Add methods that either collect files automatically, or allow passing documents manually #110

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f09ecd3
PortToDocs: Add public method to collect files automatically, include…
carlossanlop Mar 15, 2022
4ee9bab
Apply some minor Roslyn suggestions.
carlossanlop Mar 15, 2022
7d6b8ea
Rename method in tests that ports from file to file.
carlossanlop Mar 15, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/PortToDocs/src/app/PortToDocs.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ public static void Main(string[] args)
{
Configuration config = Configuration.GetCLIArguments(args);
ToDocsPorter porter = new(config);
porter.CollectFiles();
porter.Start();
}
}
Expand Down
79 changes: 19 additions & 60 deletions src/PortToDocs/src/libraries/Docs/DocsCommentsContainer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,28 +15,10 @@ internal class DocsCommentsContainer
{
private Configuration Config { get; set; }

private XDocument? xDoc = null;

public readonly Dictionary<string, DocsType> Types = new();
public readonly Dictionary<string, DocsMember> Members = new();

public DocsCommentsContainer(Configuration config)
{
Config = config;
}

public void CollectFiles()
{
Log.Info("Looking for Docs xml files...");

foreach (FileInfo fileInfo in EnumerateFiles())
{
LoadFile(fileInfo);
}

Log.Success("Finished looking for Docs xml files.");
Log.Line();
}
public DocsCommentsContainer(Configuration config) => Config = config;

public void Save()
{
Expand All @@ -51,7 +33,7 @@ public void Save()
}

List<string> savedFiles = new();
foreach (var type in Types.Values.Where(x => x.Changed))
foreach (DocsType type in Types.Values.Where(x => x.Changed))
{
Log.Info(false, $"Saving changes for {type.FilePath} ... ");

Expand Down Expand Up @@ -95,23 +77,11 @@ public void Save()
}
}

private bool HasAllowedDirName(DirectoryInfo dirInfo)
{
return !Configuration.ForbiddenBinSubdirectories.Contains(dirInfo.Name) && !dirInfo.Name.EndsWith(".Tests");
}

private bool HasAllowedFileName(FileInfo fileInfo)
{
return !fileInfo.Name.StartsWith("ns-") &&
fileInfo.Name != "index.xml" &&
fileInfo.Name != "_filter.xml";
}

private IEnumerable<FileInfo> EnumerateFiles()
internal IEnumerable<FileInfo> EnumerateFiles()
{
// Union avoids duplication
var includedAssembliesAndNamespaces = Config.IncludedAssemblies.Union(Config.IncludedNamespaces);
var excludedAssembliesAndNamespaces = Config.ExcludedAssemblies.Union(Config.ExcludedNamespaces);
IEnumerable<string> includedAssembliesAndNamespaces = Config.IncludedAssemblies.Union(Config.IncludedNamespaces);
IEnumerable<string> excludedAssembliesAndNamespaces = Config.ExcludedAssemblies.Union(Config.ExcludedNamespaces);

foreach (DirectoryInfo rootDir in Config.DirsDocsXml)
{
Expand Down Expand Up @@ -164,32 +134,14 @@ private IEnumerable<FileInfo> EnumerateFiles()
}
}

private void LoadFile(FileInfo fileInfo)
internal void LoadDocsFile(XDocument xDoc, string filePath, Encoding encoding)
{
Encoding? encoding = null;
try
{
var utf8NoBom = new UTF8Encoding(encoderShouldEmitUTF8Identifier: false);
var utf8Bom = new UTF8Encoding(encoderShouldEmitUTF8Identifier: true);
using (StreamReader sr = new(fileInfo.FullName, utf8NoBom, detectEncodingFromByteOrderMarks: true))
{
xDoc = XDocument.Load(sr);
encoding = sr.CurrentEncoding;
}

}
catch (Exception ex)
{
Log.Error($"Failed to load '{fileInfo.FullName}'. {ex}");
return;
}

if (IsXmlMalformed(xDoc, fileInfo.FullName))
if (IsXmlMalformed(xDoc, filePath))
{
return;
}

DocsType docsType = new DocsType(fileInfo.FullName, xDoc, xDoc.Root!, encoding);
DocsType docsType = new(filePath, xDoc, xDoc.Root!, encoding);

bool add = false;
bool addedAsInterface = false;
Expand All @@ -208,7 +160,6 @@ private void LoadFile(FileInfo fileInfo)
// Interface files start with I, and have an 2nd alphabetic character
addedAsInterface = docsType.Name.Length >= 2 && docsType.Name[0] == 'I' && docsType.Name[1] >= 'A' && docsType.Name[1] <= 'Z';
add |= addedAsInterface;

}

bool containsAllowedAssembly = docsType.AssemblyInfos.Any(assemblyInfo =>
Expand Down Expand Up @@ -246,13 +197,13 @@ private void LoadFile(FileInfo fileInfo)
{
foreach (XElement xeMember in xeMembers.Elements("Member"))
{
DocsMember member = new DocsMember(fileInfo.FullName, docsType, xeMember);
DocsMember member = new(filePath, docsType, xeMember);
totalMembersAdded++;
Members.TryAdd(member.DocId, member); // is it OK this encounters duplicates?
}
}

string message = $"Type '{docsType.DocId}' added with {totalMembersAdded} member(s) included: {fileInfo.FullName}";
string message = $"Type '{docsType.DocId}' added with {totalMembersAdded} member(s) included: {filePath}";
if (addedAsInterface)
{
Log.Magenta("[Interface] - " + message);
Expand All @@ -268,7 +219,15 @@ private void LoadFile(FileInfo fileInfo)
}
}

private bool IsXmlMalformed(XDocument? xDoc, string fileName)
private static bool HasAllowedDirName(DirectoryInfo dirInfo) =>
!Configuration.ForbiddenBinSubdirectories.Contains(dirInfo.Name) && !dirInfo.Name.EndsWith(".Tests", StringComparison.InvariantCultureIgnoreCase);

private static bool HasAllowedFileName(FileInfo fileInfo) =>
!fileInfo.Name.StartsWith("ns-") &&
fileInfo.Name != "index.xml" &&
fileInfo.Name != "_filter.xml";

private static bool IsXmlMalformed(XDocument? xDoc, string fileName)
{
if (xDoc == null)
{
Expand Down
53 changes: 12 additions & 41 deletions src/PortToDocs/src/libraries/IntelliSenseXml/IntelliSenseXmlCommentsContainer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
using System.Diagnostics.CodeAnalysis;
using System.IO;
using System.Linq;
using System.Xml;
using System.Xml.Linq;

/*
Expand Down Expand Up @@ -36,30 +35,12 @@ internal class IntelliSenseXmlCommentsContainer
{
private Configuration Config { get; set; }

private XDocument? xDoc = null;

// The IntelliSense xml files do not separate types from members, like ECMA xml files do - Everything is a member.
public Dictionary<string, IntelliSenseXmlMember> Members = new();

public IntelliSenseXmlCommentsContainer(Configuration config)
{
Config = config;
}

public void CollectFiles()
{
Log.Info("Looking for IntelliSense xml files...");

foreach (FileInfo fileInfo in EnumerateFiles())
{
LoadFile(fileInfo, printSuccess: true);
}

Log.Success("Finished looking for IntelliSense xml files.");
Log.Line();
}
public IntelliSenseXmlCommentsContainer(Configuration config) => Config = config;

private IEnumerable<FileInfo> EnumerateFiles()
internal IEnumerable<FileInfo> EnumerateFiles()
{
foreach (DirectoryInfo dirInfo in Config.DirsIntelliSense)
{
Expand All @@ -85,19 +66,9 @@ private IEnumerable<FileInfo> EnumerateFiles()
}
}

private void LoadFile(FileInfo fileInfo, bool printSuccess)
internal void LoadIntellisenseXmlFile(XDocument xDoc, string filePath)
{
try
{
xDoc = XDocument.Load(fileInfo.FullName);
}
catch (Exception ex)
{
Log.Error($"Failed to load '{fileInfo.FullName}'. {ex}");
return;
}

if (!TryGetAssemblyName(xDoc, fileInfo.FullName, out string? assembly))
if (!TryGetAssemblyName(xDoc, filePath, out string? assembly))
{
return;
}
Expand All @@ -107,15 +78,15 @@ private void LoadFile(FileInfo fileInfo, bool printSuccess)
{
foreach (XElement xeMember in xeMembers.Elements("member"))
{
IntelliSenseXmlMember member = new IntelliSenseXmlMember(xeMember, assembly);
IntelliSenseXmlMember member = new(xeMember, assembly);

if (Config.IncludedAssemblies.Any(included => member.Assembly.StartsWith(included)) &&
!Config.ExcludedAssemblies.Any(excluded => member.Assembly.StartsWith(excluded)))
if (Config.IncludedAssemblies.Any(included => member.Assembly.StartsWith(included, StringComparison.InvariantCultureIgnoreCase)) &&
!Config.ExcludedAssemblies.Any(excluded => member.Assembly.StartsWith(excluded, StringComparison.InvariantCultureIgnoreCase)))
{
// No namespaces provided by the user means they want to port everything from that assembly
if (!Config.IncludedNamespaces.Any() ||
(Config.IncludedNamespaces.Any(included => member.Namespace.StartsWith(included)) &&
!Config.ExcludedNamespaces.Any(excluded => member.Namespace.StartsWith(excluded))))
(Config.IncludedNamespaces.Any(included => member.Namespace.StartsWith(included, StringComparison.InvariantCultureIgnoreCase)) &&
!Config.ExcludedNamespaces.Any(excluded => member.Namespace.StartsWith(excluded, StringComparison.InvariantCultureIgnoreCase))))
{
totalAdded++;
Members.TryAdd(member.Name, member); // is it OK this encounters duplicates?
Expand All @@ -124,14 +95,14 @@ private void LoadFile(FileInfo fileInfo, bool printSuccess)
}
}

if (printSuccess && totalAdded > 0)
if (totalAdded > 0)
{
Log.Success($"{totalAdded} IntelliSense xml member(s) added from xml file '{fileInfo.FullName}'");
Log.Success($"{totalAdded} IntelliSense xml member(s) added from xml file '{filePath}'");
}
}

// Verifies the file is properly formed while attempting to retrieve the assembly name.
private bool TryGetAssemblyName(XDocument? xDoc, string fileName, [NotNullWhen(returnValue: true)] out string? assembly)
private static bool TryGetAssemblyName(XDocument? xDoc, string fileName, [NotNullWhen(returnValue: true)] out string? assembly)
{
assembly = null;

Expand Down
65 changes: 62 additions & 3 deletions src/PortToDocs/src/libraries/ToDocsPorter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text;
using System.Xml.Linq;
using ApiDocsSync.Libraries.Docs;
using ApiDocsSync.Libraries.IntelliSenseXml;
Expand Down Expand Up @@ -32,19 +34,76 @@ public ToDocsPorter(Configuration config)

}

public void Start()
public void CollectFiles()
{
IntelliSenseXmlComments.CollectFiles();
Log.Info("Looking for IntelliSense xml files...");
foreach (FileInfo fileInfo in IntelliSenseXmlComments.EnumerateFiles())
{
XDocument? xDoc = null;
try
{
xDoc = XDocument.Load(fileInfo.FullName);
}
catch (Exception ex)
{
Log.Error($"Failed to load '{fileInfo.FullName}'. {ex}");
}

if (xDoc != null)
{
IntelliSenseXmlComments.LoadIntellisenseXmlFile(xDoc, fileInfo.FullName);
}
}
Log.Success("Finished looking for IntelliSense xml files.");
Log.Line();

Log.Info("Looking for Docs xml files...");
foreach (FileInfo fileInfo in DocsComments.EnumerateFiles())
{
XDocument? xDoc = null;
Encoding? encoding = null;
try
{
var utf8NoBom = new UTF8Encoding(encoderShouldEmitUTF8Identifier: false);
var utf8Bom = new UTF8Encoding(encoderShouldEmitUTF8Identifier: true);
using (StreamReader sr = new(fileInfo.FullName, utf8NoBom, detectEncodingFromByteOrderMarks: true))
{
xDoc = XDocument.Load(sr);
encoding = sr.CurrentEncoding;
}
}
catch (Exception ex)
{
Log.Error($"Failed to load '{fileInfo.FullName}'. {ex}");
}

if (xDoc != null && encoding != null)
{
DocsComments.LoadDocsFile(xDoc, fileInfo.FullName, encoding);
}
}
Log.Success("Finished looking for Docs xml files.");
Log.Line();
}

public void LoadIntellisenseXmlFile(XDocument xDoc, string filePath) =>
IntelliSenseXmlComments.LoadIntellisenseXmlFile(xDoc, filePath);

public void LoadDocsFile(XDocument xDoc, string filePath, Encoding encoding) =>
DocsComments.LoadDocsFile(xDoc, filePath, encoding);

public void Start()
{
if (!IntelliSenseXmlComments.Members.Any())
{
Log.Error("No IntelliSense xml comments found.");
return;
}

DocsComments.CollectFiles();
if (!DocsComments.Types.Any())
{
Log.Error("No Docs Type APIs found.");
return;
}

PortMissingComments();
Expand Down
Loading
0