alexenko
/
ProSol.Html.TagsProvider
1
0
Fork 0
Code Issues 2 Pull Requests Packages Projects Releases 1 Wiki Activity

refactoring #6 (#7) 

refactoring #6

Co-authored-by: Alexander Kozachenko <119358312+Alex-Kozachenko@users.noreply.github.com>
Reviewed-on: #7
This commit is contained in:
Alexander Kozachenko 2023-12-08 01:46:37 +00:00
parent 2314cf58ab
commit 5598d0f898
10 changed files with 113 additions and 111 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
pack/package.nuspec
View File

@ -3,7 +3,7 @@
<metadata>
<id>ProSol.Html.TagsProvider</id>
<title>ProSol.Html.TagsProvider</title>
<version>2.0.0-rc1.4</version>
<version>2.0.0-rc2.0</version>
<authors>Alex Kozachenko</authors>
<owners>Alex Kozachenko</owners>
<requireLicenseAcceptance>false</requireLicenseAcceptance>
@ -15,7 +15,7 @@
</description>
<dependencies>
<group targetFramework="net8.0" >
<dependency id="ProSol.Messaging" version="4.0.0-rc.6.*" />
<dependency id="ProSol.Messaging" version="4.0.0-rc.9.0" />
</group>
</dependencies>
<tags> tool extraction web html observer observer-pattern design-patterns </tags>

18
src/Messaging/IPublisherExtensions.cs
View File

@ -1,20 +1,18 @@
using ProSol.Html.Contracts.Data;
using ProSol.Messaging;
using ProSol.Messaging.Subscriptions;
using ProSol.Messaging.Filtering;
namespace ProSol.Html.Messaging;
public static class IPublisherExtensions
{
public static IPublisher Subscribe(
this IPublisher publisher,
IPipelineSubscriber<TagsProviderMessage> subscriber,
params string[] tagNames)
=> publisher.Subscribe(subscriber, x => tagNames.Contains(x.CurrentTag.TagInfo.Name));
public static IPublisher<TagsProviderMessage> Filter(
this IPublisher<TagsProviderMessage> publisher,
string tagName)
=> publisher.Filter([tagName]);
public static IPublisher Subscribe(
this IPublisher publisher,
ISubscriber<TagsProviderMessage> subscriber,
public static IPublisher<TagsProviderMessage> Filter(
this IPublisher<TagsProviderMessage> publisher,
params string[] tagNames)
=> publisher.Subscribe(subscriber, x => tagNames.Contains(x.CurrentTag.TagInfo.Name));
=> publisher.Filter(x => tagNames.Contains(x.CurrentTag.TagInfo.Name));
}

2
src/ProSol.Html.csproj
View File

@ -7,7 +7,7 @@
</PropertyGroup>
<ItemGroup>
<PackageReference Include="ProSol.Messaging" Version="4.0.0-rc.7.4" />
<PackageReference Include="ProSol.Messaging" Version="4.0.0-rc.9.0" />
</ItemGroup>
</Project>

10
src/TagsProvider.cs
View File

@ -10,10 +10,9 @@ namespace ProSol.Html;
/// <remarks>
/// Push-notification happens only when the closing tag met, so it contains the full data on tag.
/// </remarks>
public class TagsProvider : IPublisher
public class TagsProvider : PipelineMessagePublisher<TagsProviderMessage>
{
readonly HistoryTracker historyTracker = new();
readonly PipelineMessagePublisher<TagsProviderMessage> publisher = new();
public void Process(ReadOnlySpan<char> html)
{
@ -26,12 +25,9 @@ public class TagsProvider : IPublisher
charsProcessed += Proceed(currentHtml);
} while (charsProcessed < html.Length);
publisher.Complete();
base.Complete();
}
public IDisposable Subscribe(ISubscriber observer)
=> publisher.Subscribe(observer);
void Process(ReadOnlySpan<char> currentHtml, int charsProcessed)
{
if (TagDetector.Detect(currentHtml) != TagKind.Closing)
@ -69,7 +65,7 @@ public class TagsProvider : IPublisher
[..history],
value);
publisher.Publish(message);
base.Publish(message);
}
static int Proceed(ReadOnlySpan<char> currentHtml)

15
tests/KnownIssues/TagProcessorBase_KnownIssues.cs
View File

@ -1,18 +1,23 @@
using ProSol.Html.Tests.TestHelpers;
using ProSol.Html.Contracts.Data;
using ProSol.Messaging;
using ProSol.Messaging.Translating;
namespace ProSol.Html.Tests.KnownIssues;
public class TagsProvider_KnownIssues
{
private TagsProvider tagsProvider;
private TagsProviderListener listener;
private DataSubscriber<ProcessedTag> processedTagsListener;
[SetUp]
public void Setup()
{
tagsProvider = new();
listener = new();
listener.Subscribe(tagsProvider);
processedTagsListener = new();
tagsProvider
.Translate<TagsProviderMessage, ProcessedTag>(x => x.CurrentTag)
.Subscribe(processedTagsListener);
}
[Test]
@ -24,6 +29,6 @@ public class TagsProvider_KnownIssues
{
var html = "<br />";
tagsProvider.Process(html);
Assert.That(listener.ProcessedTags, Has.Length.EqualTo(0));
Assert.That(processedTagsListener.Messages, Has.Length.EqualTo(0));
}
}

53
tests/TagsProvider_FiltersSubscribers_Tests.cs
View File

@ -1,5 +1,8 @@
using ProSol.Html.Tests.TestHelpers;
using ProSol.Html.Messaging;
using ProSol.Messaging.Filtering;
using ProSol.Messaging.Translating;
using ProSol.Html.Contracts.Data;
using ProSol.Messaging;
namespace ProSol.Html.Tests;
@ -9,12 +12,6 @@ public class TagsProvider_FiltersSubscribers_Tests
[Test]
public void Process_Single_Named_Tag()
{
var expected = new string[] { "Rock", "Paper", "Scissors" };
var tagsProvider = new TagsProvider();
var listener = new TagsProviderListener();
tagsProvider.Subscribe(listener, "li");
var html = """
<ul>
<li>Rock</li>
@ -22,38 +19,42 @@ public class TagsProvider_FiltersSubscribers_Tests
<li>Scissors</li>
</ul>
""";
var expected = new string[] { "Rock", "Paper", "Scissors" };
var tagsProvider = new TagsProvider();
var data = new DataSubscriber<string>();
tagsProvider
.Filter("li")
.Translate<TagsProviderMessage, ProcessedTag>(x => x.CurrentTag)
.Translate<ProcessedTag, string>(x => html[x.InnerTextRange])
.Subscribe(data);
tagsProvider.Process(html);
var result = GetText(listener, html);
Assert.That(result, Is.EquivalentTo(expected));
Assert.That(data.Messages, Is.EquivalentTo(expected));
}
[Test]
public void Process_Multiple_Named_Tag()
{
var expected = new string[] { "Terminal", "tasks", "any", "close" };
var tagsProvider = new TagsProvider();
var listener = new TagsProviderListener();
tagsProvider.Subscribe(listener, "i", "b");
var html = """
<b>Terminal</b> will be reused by <b>tasks</b>, press <i>any</i> key to <i>close</i> it.
""";
var expected = new string[] { "Terminal", "tasks", "any", "close" };
var tagsProvider = new TagsProvider();
var data = new DataSubscriber<string>();
tagsProvider
.Filter("i", "b")
.Translate<TagsProviderMessage, ProcessedTag>(x => x.CurrentTag)
.Translate<ProcessedTag, string>(x => html[x.InnerTextRange])
.Subscribe(data);
tagsProvider.Process(html);
var result = GetText(listener, html);
Assert.That(result, Is.EquivalentTo(expected));
}
static string[] GetText(TagsProviderListener listener, string html)
{
return listener.ProcessedTags
.Select(x => html[x.InnerTextRange]
.ToString())
.ToArray();
Assert.That(data.Messages, Is.EquivalentTo(expected));
}
}

32
tests/TagsProvider_MessageHistory_Tests.cs
View File

@ -1,19 +1,24 @@
using System.Collections.Immutable;
using ProSol.Html;
using ProSol.Html.Tests.TestHelpers;
using ProSol.Html.Contracts.Data;
using ProSol.Messaging;
using ProSol.Messaging.Translating;
namespace ProSol.Html.Tests;
public class TagsProvider_MessageHistory_Tests
{
private TagsProvider tagsProvider;
private TagsProviderListener listener;
private DataSubscriber<string> tagNamesListener;
[SetUp]
public void Setup()
{
tagsProvider = new();
listener = new();
listener.Subscribe(tagsProvider);
tagNamesListener = new();
tagsProvider
.Translate<TagsProviderMessage, string>(x => x.CurrentTag.TagInfo.Name)
.Subscribe(tagNamesListener);
}
[Test]
@ -23,10 +28,9 @@ public class TagsProvider_MessageHistory_Tests
var html = $"<main> <div> <p>{text}</p> </div> </main>";
tagsProvider.Process(html);
var names = tagNamesListener.Messages;
Assert.Multiple( () => {
var names = listener.Messages
.Select(x => x.CurrentTag.TagInfo.Name)
.ToArray();
Assert.That(names[0], Is.EqualTo("p"));
Assert.That(names[1], Is.EqualTo("div"));
Assert.That(names[2], Is.EqualTo("main"));
@ -38,14 +42,20 @@ public class TagsProvider_MessageHistory_Tests
{
var text = "LoremIpsum";
var html = $"<main> <div> <p>{text}</p> </div> </main>";
var tagsHistoryListener = new DataSubscriber<ImmutableArray<TagInfo>>();
tagsProvider
.Translate<TagsProviderMessage, ImmutableArray<TagInfo>>(x => x.TagsHistory)
.Subscribe(tagsHistoryListener);
tagsProvider.Process(html);
Assert.That(listener.Messages[0].CurrentTag.TagInfo.Name,
Is.EqualTo("p"));
var names = tagNamesListener.Messages;
Assert.That(names[0], Is.EqualTo("p"));
Assert.Multiple( () => {
var deepestHistory = listener.Messages[0]
.TagsHistory
var deepestHistory = tagsHistoryListener.Messages[0]
.Select(x => x.Name)
.ToArray();
Assert.That(deepestHistory[0], Is.EqualTo("main"));

35
tests/TagsProvider_MultipleTags_Tests.cs
View File

@ -1,5 +1,7 @@
using ProSol.Html.Tests.TestHelpers;
using ProSol.Html.Messaging;
using ProSol.Messaging;
using ProSol.Html.Contracts.Data;
using ProSol.Messaging.Translating;
namespace ProSol.Html.Tests;
@ -11,10 +13,14 @@ public class TagsProvider_MultipleTags_Tests
var html = $"<main> <div> <p>LoremIpsum</p> </div> </main>";
var tagsProvider = new TagsProvider();
var listener = new TagsProviderListener();
tagsProvider.Subscribe(listener);
var data = new DataSubscriber<ProcessedTag>();
tagsProvider
.Translate<TagsProviderMessage, ProcessedTag>(x => x.CurrentTag)
.Subscribe(data);
tagsProvider.Process(html);
var result = listener.ProcessedTags;
var result = data.Messages;
Assert.Multiple(() =>
{
@ -32,10 +38,14 @@ public class TagsProvider_MultipleTags_Tests
var html = $"<main> <div> <p>LoremIpsum</p> </div> </main>";
var tagsProvider = new TagsProvider();
var listener = new TagsProviderListener();
tagsProvider.Subscribe(listener);
var data = new DataSubscriber<ProcessedTag>();
tagsProvider
.Translate<TagsProviderMessage, ProcessedTag>(x => x.CurrentTag)
.Subscribe(data);
tagsProvider.Process(html);
var result = listener.ProcessedTags;
var result = data.Messages;
Assert.Multiple(() =>
{
@ -59,10 +69,15 @@ public class TagsProvider_MultipleTags_Tests
""";
var tagsProvider = new TagsProvider();
var listener = new TagsProviderListener();
tagsProvider.Subscribe(listener, "b");
var data = new DataSubscriber<ProcessedTag>();
tagsProvider
.Filter("b")
.Translate<TagsProviderMessage, ProcessedTag>(x => x.CurrentTag)
.Subscribe(data);
tagsProvider.Process(html);
var result = listener.ProcessedTags;
var result = data.Messages;
Assert.Multiple(() =>
{

24
tests/TagsProvider_SingleTag_Tests.cs
View File

@ -1,20 +1,24 @@
using ProSol.Html;
using ProSol.Html.Tests.TestHelpers;
using ProSol.Html.Contracts.Data;
using ProSol.Messaging;
using ProSol.Messaging.Translating;
namespace ProSol.Html.Tests;
public class TagsProvider_SingleTag_Tests
{
private TagsProvider tagsProvider;
private TagsProviderListener listener;
private DataSubscriber<ProcessedTag> processedTagsListener;
[SetUp]
public void Setup()
{
tagsProvider = new();
listener = new();
listener.Subscribe(tagsProvider);
processedTagsListener = new();
tagsProvider
.Translate<TagsProviderMessage, ProcessedTag>(x => x.CurrentTag)
.Subscribe(processedTagsListener);
}
[Test]
@ -23,7 +27,8 @@ public class TagsProvider_SingleTag_Tests
var html = "<main></main>";
tagsProvider.Process(html);
var result = listener.ProcessedTags;
var result = processedTagsListener.Messages;
Assert.Multiple(() =>
{
@ -45,7 +50,8 @@ public class TagsProvider_SingleTag_Tests
var html = "<main>Lorem</main>";
tagsProvider.Process(html);
var result = listener.ProcessedTags;
var result = processedTagsListener.Messages;
Assert.Multiple(() =>
{
@ -69,7 +75,8 @@ public class TagsProvider_SingleTag_Tests
var html = "<main id='idmain' class='bar buzz' data-id=id data-value=\"value\">Lorem</main>";
tagsProvider.Process(html);
var result = listener.ProcessedTags;
var result = processedTagsListener.Messages;
Assert.Multiple(() =>
{
@ -101,7 +108,8 @@ public class TagsProvider_SingleTag_Tests
var html = "<div>\r\n<!-- <div> Ignored </div> -->\r\n</div>";
tagsProvider.Process(html);
var result = listener.ProcessedTags;
var result = processedTagsListener.Messages;
Assert.Multiple(() =>
{

31
tests/TestHelpers/TagsProviderListener.cs
View File

@ -1,31 +0,0 @@
using ProSol.Html.Contracts.Data;
using ProSol.Messaging;
namespace ProSol.Html.Tests.TestHelpers;
internal class TagsProviderListener : ISubscriber<TagsProviderMessage>
{
IDisposable? unsubscriber;
HashSet<TagsProviderMessage> messages = new();
public ProcessedTag[] ProcessedTags =>
[.. messages
.Select(x => x.CurrentTag)];
public TagsProviderMessage[] Messages => [.. messages];
public void Subscribe(TagsProvider source)
{
source.Subscribe(this);
}
public void OnCompleted()
{
unsubscriber?.Dispose();
}
public void OnNext(TagsProviderMessage value)
{
messages.Add(value);
}
}