Skip to content
This repository was archived by the owner on Nov 20, 2018. It is now read-only.

Commit e7e7032

Browse files
committed
Change method names and signatures to match wrapped types.
1 parent 539287d commit e7e7032

File tree

17 files changed

+89
-91
lines changed

17 files changed

+89
-91
lines changed

src/Microsoft.AspNet.Html.Abstractions/HtmlContentBuilderExtensions.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -305,7 +305,7 @@ public string Format(string format, object arg, IFormatProvider formatProvider)
305305
var result = customFormatter.Format(format, arg, _formatProvider);
306306
if (result != null)
307307
{
308-
return _encoder.HtmlEncode(result);
308+
return _encoder.Encode(result);
309309
}
310310
}
311311

@@ -319,7 +319,7 @@ public string Format(string format, object arg, IFormatProvider formatProvider)
319319
var result = formattable.ToString(format, _formatProvider);
320320
if (result != null)
321321
{
322-
return _encoder.HtmlEncode(result);
322+
return _encoder.Encode(result);
323323
}
324324
}
325325

@@ -329,7 +329,7 @@ public string Format(string format, object arg, IFormatProvider formatProvider)
329329
var result = arg.ToString();
330330
if (result != null)
331331
{
332-
return _encoder.HtmlEncode(result);
332+
return _encoder.Encode(result);
333333
}
334334
}
335335

src/Microsoft.Extensions.BufferedHtmlContent.Sources/BufferedHtmlContent.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ public void WriteTo(TextWriter writer, IHtmlEncoder encoder)
8686
var entryAsString = entry as string;
8787
if (entryAsString != null)
8888
{
89-
encoder.HtmlEncode(entryAsString, writer);
89+
encoder.Encode(entryAsString, writer);
9090
}
9191
else
9292
{

src/Microsoft.Extensions.WebEncoders.Core/EncoderExtensions.cs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ public static class EncoderExtensions
1818
/// The encoded value is also safe for inclusion inside an HTML attribute
1919
/// as long as the attribute value is surrounded by single or double quotes.
2020
/// </remarks>
21-
public static void HtmlEncode(this IHtmlEncoder htmlEncoder, string value, TextWriter output)
21+
public static void Encode(this IHtmlEncoder htmlEncoder, string value, TextWriter output)
2222
{
2323
if (htmlEncoder == null)
2424
{
@@ -27,23 +27,23 @@ public static void HtmlEncode(this IHtmlEncoder htmlEncoder, string value, TextW
2727

2828
if (!String.IsNullOrEmpty(value))
2929
{
30-
htmlEncoder.HtmlEncode(value, 0, value.Length, output);
30+
htmlEncoder.Encode(output, value, 0, value.Length);
3131
}
3232
}
3333

3434
/// <summary>
3535
/// JavaScript-escapes a string and writes the result to the supplied output.
3636
/// </summary>
37-
public static void JavaScriptStringEncode(this IJavaScriptStringEncoder javaScriptStringEncoder, string value, TextWriter output)
37+
public static void Encode(this IJavaScriptEncoder javaScriptEncoder, string value, TextWriter output)
3838
{
39-
if (javaScriptStringEncoder == null)
39+
if (javaScriptEncoder == null)
4040
{
41-
throw new ArgumentNullException(nameof(javaScriptStringEncoder));
41+
throw new ArgumentNullException(nameof(javaScriptEncoder));
4242
}
4343

4444
if (!String.IsNullOrEmpty(value))
4545
{
46-
javaScriptStringEncoder.JavaScriptStringEncode(value, 0, value.Length, output);
46+
javaScriptEncoder.Encode(output, value, 0, value.Length);
4747
}
4848
}
4949

@@ -54,7 +54,7 @@ public static void JavaScriptStringEncode(this IJavaScriptStringEncoder javaScri
5454
/// The encoded value is safe for use in the segment, query, or
5555
/// fragment portion of a URI.
5656
/// </remarks>
57-
public static void UrlEncode(this IUrlEncoder urlEncoder, string value, TextWriter output)
57+
public static void Encode(this IUrlEncoder urlEncoder, string value, TextWriter output)
5858
{
5959
if (urlEncoder == null)
6060
{
@@ -63,7 +63,7 @@ public static void UrlEncode(this IUrlEncoder urlEncoder, string value, TextWrit
6363

6464
if (!String.IsNullOrEmpty(value))
6565
{
66-
urlEncoder.UrlEncode(value, 0, value.Length, output);
66+
urlEncoder.Encode(output, value, 0, value.Length);
6767
}
6868
}
6969
}

src/Microsoft.Extensions.WebEncoders.Core/EncoderServiceProviderExtensions.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,15 @@ public static IHtmlEncoder GetHtmlEncoder(this IServiceProvider serviceProvider)
2323
}
2424

2525
/// <summary>
26-
/// Retrieves an <see cref="IJavaScriptStringEncoder"/> from an <see cref="IServiceProvider"/>.
26+
/// Retrieves an <see cref="IJavaScriptEncoder"/> from an <see cref="IServiceProvider"/>.
2727
/// </summary>
2828
/// <remarks>
2929
/// This method is guaranteed never to return null.
3030
/// It will return a default encoder instance if <paramref name="serviceProvider"/> does not contain one or is null.
3131
/// </remarks>
32-
public static IJavaScriptStringEncoder GetJavaScriptStringEncoder(this IServiceProvider serviceProvider)
32+
public static IJavaScriptEncoder GetJavaScriptEncoder(this IServiceProvider serviceProvider)
3333
{
34-
return (IJavaScriptStringEncoder)serviceProvider?.GetService(typeof(IJavaScriptStringEncoder)) ?? JavaScriptEncoderWrapper.Default;
34+
return (IJavaScriptEncoder)serviceProvider?.GetService(typeof(IJavaScriptEncoder)) ?? JavaScriptEncoderWrapper.Default;
3535
}
3636

3737
/// <summary>

src/Microsoft.Extensions.WebEncoders.Core/HtmlEncoderWrapper.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,17 +27,17 @@ public HtmlEncoderWrapper(TextEncoderSettings settings)
2727

2828
public static HtmlEncoderWrapper Default { get; } = new HtmlEncoderWrapper(HtmlEncoder.Default);
2929

30-
public string HtmlEncode(string value)
30+
public string Encode(string value)
3131
{
3232
return _encoder.Encode(value);
3333
}
3434

35-
public void HtmlEncode(string value, int startIndex, int charCount, TextWriter output)
35+
public void Encode(TextWriter output, string value, int startIndex, int charCount)
3636
{
3737
_encoder.Encode(output, value, startIndex, charCount);
3838
}
3939

40-
public void HtmlEncode(char[] value, int startIndex, int charCount, TextWriter output)
40+
public void Encode(TextWriter output, char[] value, int startIndex, int charCount)
4141
{
4242
_encoder.Encode(output, value, startIndex, charCount);
4343
}

src/Microsoft.Extensions.WebEncoders.Core/IHtmlEncoder.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ public interface IHtmlEncoder
1818
/// The encoded value is also appropriately encoded for inclusion inside an HTML attribute
1919
/// as long as the attribute value is surrounded by single or double quotes.
2020
/// </remarks>
21-
void HtmlEncode(char[] value, int startIndex, int charCount, TextWriter output);
21+
void Encode(TextWriter output, char[] value, int startIndex, int charCount);
2222

2323
/// <summary>
2424
/// HTML-encodes a given input string.
@@ -30,7 +30,7 @@ public interface IHtmlEncoder
3030
/// The return value is also appropriately encoded for inclusion inside an HTML attribute
3131
/// as long as the attribute value is surrounded by single or double quotes.
3232
/// </remarks>
33-
string HtmlEncode(string value);
33+
string Encode(string value);
3434

3535
/// <summary>
3636
/// HTML-encodes a given input string and writes the result to the
@@ -40,6 +40,6 @@ public interface IHtmlEncoder
4040
/// The encoded value is also appropriately encoded for inclusion inside an HTML attribute
4141
/// as long as the attribute value is surrounded by single or double quotes.
4242
/// </remarks>
43-
void HtmlEncode(string value, int startIndex, int charCount, TextWriter output);
43+
void Encode(TextWriter output, string value, int startIndex, int charCount);
4444
}
4545
}

src/Microsoft.Extensions.WebEncoders.Core/IJavaScriptStringEncoder.cs renamed to src/Microsoft.Extensions.WebEncoders.Core/IJavaScriptEncoder.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ namespace Microsoft.Extensions.WebEncoders
88
/// <summary>
99
/// Provides services for JavaScript-escaping strings.
1010
/// </summary>
11-
public interface IJavaScriptStringEncoder
11+
public interface IJavaScriptEncoder
1212
{
1313
/// <summary>
1414
/// JavaScript-escapes a character array and writes the result to the
@@ -17,7 +17,7 @@ public interface IJavaScriptStringEncoder
1717
/// <remarks>
1818
/// The encoded value is appropriately encoded for inclusion inside a quoted JSON string.
1919
/// </remarks>
20-
void JavaScriptStringEncode(char[] value, int startIndex, int charCount, TextWriter output);
20+
void Encode(TextWriter output, char[] value, int startIndex, int charCount);
2121

2222
/// <summary>
2323
/// JavaScript-escapes a given input string.
@@ -26,7 +26,7 @@ public interface IJavaScriptStringEncoder
2626
/// The JavaScript-escaped value, or null if the input string was null.
2727
/// The encoded value is appropriately encoded for inclusion inside a quoted JSON string.
2828
/// </returns>
29-
string JavaScriptStringEncode(string value);
29+
string Encode(string value);
3030

3131
/// <summary>
3232
/// JavaScript-escapes a given input string and writes the
@@ -35,6 +35,6 @@ public interface IJavaScriptStringEncoder
3535
/// <remarks>
3636
/// The encoded value is appropriately encoded for inclusion inside a quoted JSON string.
3737
/// </remarks>
38-
void JavaScriptStringEncode(string value, int startIndex, int charCount, TextWriter output);
38+
void Encode(TextWriter output, string value, int startIndex, int charCount);
3939
}
4040
}

src/Microsoft.Extensions.WebEncoders.Core/IUrlEncoder.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ public interface IUrlEncoder
1818
/// The encoded value is appropriately encoded for inclusion in the segment, query, or
1919
/// fragment portion of a URI.
2020
/// </remarks>
21-
void UrlEncode(char[] value, int startIndex, int charCount, TextWriter output);
21+
void Encode(TextWriter output, char[] value, int startIndex, int charCount);
2222

2323
/// <summary>
2424
/// URL-escapes a given input string.
@@ -30,7 +30,7 @@ public interface IUrlEncoder
3030
/// The return value is appropriately encoded for inclusion in the segment, query, or
3131
/// fragment portion of a URI.
3232
/// </remarks>
33-
string UrlEncode(string value);
33+
string Encode(string value);
3434

3535
/// <summary>
3636
/// URL-escapes a string and writes the result to the supplied output.
@@ -39,6 +39,6 @@ public interface IUrlEncoder
3939
/// The encoded value is appropriately encoded for inclusion in the segment, query, or
4040
/// fragment portion of a URI.
4141
/// </remarks>
42-
void UrlEncode(string value, int startIndex, int charCount, TextWriter output);
42+
void Encode(TextWriter output, string value, int startIndex, int charCount);
4343
}
4444
}

src/Microsoft.Extensions.WebEncoders.Core/JavaScriptEncoderWrapper.cs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
namespace Microsoft.Extensions.WebEncoders
88
{
9-
public class JavaScriptEncoderWrapper : IJavaScriptStringEncoder
9+
public class JavaScriptEncoderWrapper : IJavaScriptEncoder
1010
{
1111
private JavaScriptEncoder _encoder;
1212

@@ -25,19 +25,19 @@ public JavaScriptEncoderWrapper(TextEncoderSettings settings)
2525
_encoder = JavaScriptEncoder.Create(settings);
2626
}
2727

28-
public static IJavaScriptStringEncoder Default { get; } = new JavaScriptEncoderWrapper(JavaScriptEncoder.Default);
28+
public static IJavaScriptEncoder Default { get; } = new JavaScriptEncoderWrapper(JavaScriptEncoder.Default);
2929

30-
public string JavaScriptStringEncode(string value)
30+
public string Encode(string value)
3131
{
3232
return _encoder.Encode(value);
3333
}
3434

35-
public void JavaScriptStringEncode(string value, int startIndex, int charCount, TextWriter output)
35+
public void Encode(TextWriter output, string value, int startIndex, int charCount)
3636
{
3737
_encoder.Encode(output, value, startIndex, charCount);
3838
}
3939

40-
public void JavaScriptStringEncode(char[] value, int startIndex, int charCount, TextWriter output)
40+
public void Encode(TextWriter output, char[] value, int startIndex, int charCount)
4141
{
4242
_encoder.Encode(output, value, startIndex, charCount);
4343
}

src/Microsoft.Extensions.WebEncoders.Core/UrlEncoderWrapper.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,17 +28,17 @@ public UrlEncoderWrapper(TextEncoderSettings settings)
2828

2929
public static IUrlEncoder Default { get; } = new UrlEncoderWrapper(UrlEncoder.Default);
3030

31-
public string UrlEncode(string value)
31+
public string Encode(string value)
3232
{
3333
return _encoder.Encode(value);
3434
}
3535

36-
public void UrlEncode(string value, int startIndex, int charCount, TextWriter output)
36+
public void Encode(TextWriter output, string value, int startIndex, int charCount)
3737
{
3838
_encoder.Encode(output, value, startIndex, charCount);
3939
}
4040

41-
public void UrlEncode(char[] value, int startIndex, int charCount, TextWriter output)
41+
public void Encode(TextWriter output, char[] value, int startIndex, int charCount)
4242
{
4343
_encoder.Encode(output, value, startIndex, charCount);
4444
}

0 commit comments

Comments
 (0)