Skip to content

Commit 99e037d

Browse files
SimonCroppSimonCropp
authored
rename RegisterFileConverter to RegisterStreamConverter (#1448)
1 parent cc768de commit 99e037d

14 files changed

Lines changed: 104 additions & 65 deletions

File tree

‎docs/converter.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -101,16 +101,16 @@ canConvert: (target, context) => Equals(target.RawFormat, ImageFormat.Tiff),
101101
<!-- endSnippet -->
102102

103103

104-
### Expression converter
104+
### Stream Conversion
105105

106106
This sample uses a extension approach. So the converter acts on a file or stream based on the extension (configured or detected).
107107

108-
<!-- snippet: RegisterFileConverterExtension -->
109-
<a id='snippet-RegisterFileConverterExtension'></a>
108+
<!-- snippet: RegisterStreamConverterExtension -->
109+
<a id='snippet-RegisterStreamConverterExtension'></a>
110110
```cs
111-
VerifierSettings.RegisterFileConverter(
111+
VerifierSettings.RegisterStreamConverter(
112112
fromExtension: "tif",
113-
conversion: (stream, settings) =>
113+
conversion: (name, stream, settings) =>
114114
{
115115
using var image = Image.FromStream(stream);
116116
var pages = image.GetFrameCount(FrameDimension.Page);
@@ -134,7 +134,7 @@ VerifierSettings.RegisterFileConverter(
134134
targets);
135135
});
136136
```
137-
<sup><a href='/src/Verify.Tests/Snippets/ConverterSnippets.cs#L56-L83' title='Snippet source file'>snippet source</a> | <a href='#snippet-RegisterFileConverterExtension' title='Start of snippet'>anchor</a></sup>
137+
<sup><a href='/src/Verify.Tests/Snippets/ConverterSnippets.cs#L56-L83' title='Snippet source file'>snippet source</a> | <a href='#snippet-RegisterStreamConverterExtension' title='Start of snippet'>anchor</a></sup>
138138
<!-- endSnippet -->
139139

140140
<!-- snippet: FileConverterExtensionVerify -->

‎docs/mdsource/converter.source.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,11 @@ Note that this sample also uses the optional `canConvert` to ensure that only `I
4141
snippet: ConverterCanConvert
4242

4343

44-
### Expression converter
44+
### Stream Conversion
4545

4646
This sample uses a extension approach. So the converter acts on a file or stream based on the extension (configured or detected).
4747

48-
snippet: RegisterFileConverterExtension
48+
snippet: RegisterStreamConverterExtension
4949

5050
snippet: FileConverterExtensionVerify
5151

‎src/StrictJsonTests/Tests.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,9 +96,9 @@ public Task WithInfo() =>
9696

9797
[ModuleInitializer]
9898
public static void WithInfoInit() =>
99-
VerifierSettings.RegisterFileConverter(
99+
VerifierSettings.RegisterStreamConverter(
100100
"foo",
101-
(_, _) =>
101+
(_, _, _) =>
102102
{
103103
var info = new
104104
{

‎src/Verify.Tests/Converters/ExtensionConverterTests.EnsureInputs.verified.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
content

‎src/Verify.Tests/Converters/ExtensionConverterTests.cs‎

Lines changed: 46 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
{
33
[ModuleInitializer]
44
public static void RecursiveInit() =>
5-
VerifierSettings.RegisterFileConverter(
5+
VerifierSettings.RegisterStreamConverter(
66
"recursive",
7-
(_, _) =>
7+
(_, _, _) =>
88
new(
99
"recursiveInfo",
1010
[
@@ -20,18 +20,18 @@ public Task Recursive() =>
2020
[ModuleInitializer]
2121
public static void NestedInit()
2222
{
23-
VerifierSettings.RegisterFileConverter(
23+
VerifierSettings.RegisterStreamConverter(
2424
"level1",
25-
(stream, _) =>
25+
(_, stream, _) =>
2626
new(
2727
"level1Info",
2828
[
2929
new("txt", "text from level1"),
3030
new("level2", stream)
3131
]));
32-
VerifierSettings.RegisterFileConverter(
32+
VerifierSettings.RegisterStreamConverter(
3333
"level2",
34-
async (stream, _) =>
34+
async (_, stream, _) =>
3535
new(
3636
"level2Info",
3737
[
@@ -56,19 +56,38 @@ public Task NestedTarget()
5656

5757
[ModuleInitializer]
5858
public static void TextSplitInit() =>
59-
VerifierSettings.RegisterFileConverter(
59+
VerifierSettings.RegisterStreamConverter(
6060
"split",
61-
(stream, _) => new(null, "txt", stream));
61+
(_, stream, _) => new(null, "txt", stream));
6262

6363
[Fact]
6464
public Task TextSplit() =>
6565
Verify(IoHelpers.OpenRead("sample.split"), "txt");
6666

67+
[ModuleInitializer]
68+
public static void InitEnsureInputs() =>
69+
VerifierSettings.RegisterStreamConverter(
70+
"EnsureInputs",
71+
(name, stream, context) =>
72+
{
73+
Assert.Equal("name", name);
74+
Assert.NotNull(stream);
75+
Assert.NotNull(context);
76+
return new(null, "txt", "content");
77+
});
78+
79+
[Fact]
80+
public Task EnsureInputs()
81+
{
82+
var stream = new MemoryStream([1]);
83+
return Verify(new Target("EnsureInputs", stream, "name"));
84+
}
85+
6786
[ModuleInitializer]
6887
public static void ExtensionConversionStringBuilderInit() =>
69-
VerifierSettings.RegisterFileConverter(
88+
VerifierSettings.RegisterStreamConverter(
7089
"ExtensionConversionStringBuilder",
71-
(_, _) => new(null, "txt", new StringBuilder("Foo")));
90+
(_, _, _) => new(null, "txt", new StringBuilder("Foo")));
7291

7392
[Fact]
7493
public Task ExtensionConversionStringBuilder() =>
@@ -77,10 +96,10 @@ public Task ExtensionConversionStringBuilder() =>
7796

7897
[ModuleInitializer]
7998
public static void ExtensionConversionMultipleTargetsInit() =>
80-
VerifierSettings.RegisterFileConverter(
99+
VerifierSettings.RegisterStreamConverter(
81100
"ExtensionConversionMultipleTargets",
82-
new Conversion<Stream>(
83-
(_, _) =>
101+
new StreamConversion(
102+
(_, _, _) =>
84103
{
85104
var targets = new Target[]
86105
{
@@ -101,10 +120,10 @@ public Task ExtensionConversionMultipleTargets() =>
101120

102121
[ModuleInitializer]
103122
public static void ExtensionConversionNamedTargetInit() =>
104-
VerifierSettings.RegisterFileConverter(
123+
VerifierSettings.RegisterStreamConverter(
105124
"ExtensionConversionNamedTarget",
106-
new Conversion<Stream>(
107-
(_, _) =>
125+
new StreamConversion(
126+
(_, _, _) =>
108127
{
109128
var targets = new Target[]
110129
{
@@ -120,10 +139,10 @@ public Task ExtensionConversionNamedTarget() =>
120139

121140
[ModuleInitializer]
122141
public static void ExtensionConversionNamedMixedTargetInit() =>
123-
VerifierSettings.RegisterFileConverter(
142+
VerifierSettings.RegisterStreamConverter(
124143
"ExtensionConversionNamedMixedTarget",
125-
new Conversion<Stream>(
126-
(_, _) =>
144+
new StreamConversion(
145+
(_, _, _) =>
127146
{
128147
var targets = new Target[]
129148
{
@@ -139,29 +158,29 @@ public Task ExtensionConversionNamedMixedTarget() =>
139158

140159
[ModuleInitializer]
141160
public static void ExtensionConversionInit() =>
142-
VerifierSettings.RegisterFileConverter(
161+
VerifierSettings.RegisterStreamConverter(
143162
"ExtensionConversion",
144-
(_, _) => new(null, "txt", "Foo"));
163+
(_, _, _) => new(null, "txt", "Foo"));
145164

146165
[Fact]
147166
public Task ExtensionConversion() =>
148167
Verify(new MemoryStream([1]), "ExtensionConversion");
149168

150169
[ModuleInitializer]
151170
public static void AsyncExtensionConversionInit() =>
152-
VerifierSettings.RegisterFileConverter(
171+
VerifierSettings.RegisterStreamConverter(
153172
"AsyncExtensionConversion",
154-
(_, _) => Task.FromResult(new ConversionResult(null, "txt", "Foo")));
173+
(_, _, _) => Task.FromResult(new ConversionResult(null, "txt", "Foo")));
155174

156175
[Fact]
157176
public Task AsyncExtensionConversion() =>
158177
Verify(new MemoryStream([1]), "AsyncExtensionConversion");
159178

160179
[ModuleInitializer]
161180
public static void WithInfoInit() =>
162-
VerifierSettings.RegisterFileConverter(
181+
VerifierSettings.RegisterStreamConverter(
163182
"WithInfo",
164-
(_, _) =>
183+
(_, _, _) =>
165184
{
166185
var info = new
167186
{
@@ -176,9 +195,9 @@ public Task WithInfo() =>
176195

177196
[ModuleInitializer]
178197
public static void WithInfoAndBinaryInit() =>
179-
VerifierSettings.RegisterFileConverter(
198+
VerifierSettings.RegisterStreamConverter(
180199
"WithInfoAndBinary",
181-
(stream, _) =>
200+
(_, stream, _) =>
182201
{
183202
var info = new
184203
{

‎src/Verify.Tests/InnerVerifyTests/InnerVerifyTests.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,9 @@ public async Task VerifyExternalFileLocked()
3434

3535
[ModuleInitializer]
3636
public static void Init() =>
37-
VerifierSettings.RegisterFileConverter(
37+
VerifierSettings.RegisterStreamConverter(
3838
"innersplit",
39-
(stream, _) =>
39+
(_, stream, _) =>
4040
{
4141
var reader = new StreamReader(stream);
4242
return new(

‎src/Verify.Tests/Snippets/ConverterSnippets.cs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,11 +53,11 @@ public async Task Type()
5353

5454
[ModuleInitializer]
5555
public static void ExtensionInit() =>
56-
#region RegisterFileConverterExtension
56+
#region RegisterStreamConverterExtension
5757

58-
VerifierSettings.RegisterFileConverter(
58+
VerifierSettings.RegisterStreamConverter(
5959
fromExtension: "tif",
60-
conversion: (stream, settings) =>
60+
conversion: (name, stream, settings) =>
6161
{
6262
using var image = Image.FromStream(stream);
6363
var pages = image.GetFrameCount(FrameDimension.Page);

‎src/Verify.Tests/VerifyDirectoryTests.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ public Task WithDirectoryWithInfo() =>
2828

2929
[ModuleInitializer]
3030
public static void Init() =>
31-
VerifierSettings.RegisterFileConverter(
31+
VerifierSettings.RegisterStreamConverter(
3232
"VerifyDirectoryTests",
33-
(_, _) =>
33+
(_, _, _) =>
3434
new(
3535
"info from FileConverter",
3636
[new("txt", "text from FileConverter")]));

‎src/Verify.Xunit.Tests/Tests.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,9 @@ public Task WithTargets() =>
4949

5050
[ModuleInitializer]
5151
public static void InitWithTargetsAndConverter() =>
52-
VerifierSettings.RegisterFileConverter(
52+
VerifierSettings.RegisterStreamConverter(
5353
"WithTargetsAndConverter",
54-
(_, _) =>
54+
(_, _, _) =>
5555
new(
5656
"theInfo",
5757
[new("txt", "text from converter")]));

‎src/Verify.XunitV3.Tests/Tests.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,9 +56,9 @@ public Task WithTargets() =>
5656

5757
[ModuleInitializer]
5858
public static void InitWithTargetsAndConverter() =>
59-
VerifierSettings.RegisterFileConverter(
59+
VerifierSettings.RegisterStreamConverter(
6060
"WithTargetsAndConverter",
61-
(_, _) =>
61+
(_, _, _) =>
6262
new(
6363
"theInfo",
6464
[new("txt", "text from converter")]));

0 commit comments

Comments
 (0)