Skip to content

Commit 50f8c68

Browse files
sharwellsharwell
committed
Rename method to indicate use only in tests
1 parent a780b34 commit 50f8c68

File tree

3 files changed

+23
-23
lines changed

3 files changed

+23
-23
lines changed

‎StyleCop.Analyzers/StyleCop.Analyzers.Test.CSharp8/Settings/SettingsCSharp8UnitTests.cs‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ public async Task VerifyEditorConfigSettingsAreReadCorrectlyAsync()
5353
";
5454
var context = await this.CreateAnalysisContextFromEditorConfigAsync(settings).ConfigureAwait(false);
5555

56-
var styleCopSettings = context.GetStyleCopSettings(CancellationToken.None);
56+
var styleCopSettings = context.GetStyleCopSettingsInTests(CancellationToken.None);
5757

5858
Assert.Equal("TestCompany", styleCopSettings.DocumentationRules.CompanyName);
5959
Assert.Equal("Custom copyright text.", styleCopSettings.DocumentationRules.GetCopyrightText("unused"));
@@ -80,7 +80,7 @@ public async Task VerifyFileHeaderTemplateFromEditorConfigAsync()
8080
";
8181
var context = await this.CreateAnalysisContextFromEditorConfigAsync(settings).ConfigureAwait(false);
8282

83-
var styleCopSettings = context.GetStyleCopSettings(CancellationToken.None);
83+
var styleCopSettings = context.GetStyleCopSettingsInTests(CancellationToken.None);
8484

8585
Assert.Equal("Line 1\nLine 2.", styleCopSettings.DocumentationRules.GetCopyrightText("unused"));
8686
}
@@ -95,7 +95,7 @@ public async Task VerifyStyleCopDocumentationCopyrightTextFromEditorConfigAsync(
9595
";
9696
var context = await this.CreateAnalysisContextFromEditorConfigAsync(settings).ConfigureAwait(false);
9797

98-
var styleCopSettings = context.GetStyleCopSettings(CancellationToken.None);
98+
var styleCopSettings = context.GetStyleCopSettingsInTests(CancellationToken.None);
9999

100100
Assert.Equal("Line 1\nLine 2.", styleCopSettings.DocumentationRules.GetCopyrightText("unused"));
101101
}
@@ -116,7 +116,7 @@ public async Task VerifyBooleanDocumentationSettingsFromEditorConfigAsync(bool v
116116
";
117117
var context = await this.CreateAnalysisContextFromEditorConfigAsync(settings).ConfigureAwait(false);
118118

119-
var styleCopSettings = context.GetStyleCopSettings(CancellationToken.None);
119+
var styleCopSettings = context.GetStyleCopSettingsInTests(CancellationToken.None);
120120

121121
Assert.Equal(value, styleCopSettings.DocumentationRules.DocumentExposedElements);
122122
Assert.Equal(value, styleCopSettings.DocumentationRules.DocumentInternalElements);
@@ -137,7 +137,7 @@ public async Task VerifySettingsWillUseCompanyNameInDefaultCopyrightTextFromEdit
137137
";
138138
var context = await this.CreateAnalysisContextFromEditorConfigAsync(settings).ConfigureAwait(false);
139139

140-
var styleCopSettings = context.GetStyleCopSettings(CancellationToken.None);
140+
var styleCopSettings = context.GetStyleCopSettingsInTests(CancellationToken.None);
141141

142142
Assert.Equal(companyName, styleCopSettings.DocumentationRules.CompanyName);
143143
Assert.Equal($"Copyright (c) {companyName}. All rights reserved.", styleCopSettings.DocumentationRules.GetCopyrightText("unused"));
@@ -153,7 +153,7 @@ public async Task VerifyCircularReferenceBehaviorFromEditorConfigAsync()
153153
";
154154
var context = await this.CreateAnalysisContextFromEditorConfigAsync(settings).ConfigureAwait(false);
155155

156-
var styleCopSettings = context.GetStyleCopSettings(CancellationToken.None);
156+
var styleCopSettings = context.GetStyleCopSettingsInTests(CancellationToken.None);
157157

158158
Assert.Equal("[CircularReference]", styleCopSettings.DocumentationRules.GetCopyrightText("unused"));
159159
}
@@ -168,7 +168,7 @@ public async Task VerifyInvalidReferenceBehaviorFromEditorConfigAsync()
168168
";
169169
var context = await this.CreateAnalysisContextFromEditorConfigAsync(settings).ConfigureAwait(false);
170170

171-
var styleCopSettings = context.GetStyleCopSettings(CancellationToken.None);
171+
var styleCopSettings = context.GetStyleCopSettingsInTests(CancellationToken.None);
172172

173173
Assert.Equal("[InvalidReference]", styleCopSettings.DocumentationRules.GetCopyrightText("unused"));
174174
}
@@ -191,7 +191,7 @@ public async Task VerifyEditorConfigSettingsReadCorrectlyDirectivePlacementWitho
191191
";
192192
var context = await this.CreateAnalysisContextFromEditorConfigAsync(settings).ConfigureAwait(false);
193193

194-
var styleCopSettings = context.GetStyleCopSettings(CancellationToken.None);
194+
var styleCopSettings = context.GetStyleCopSettingsInTests(CancellationToken.None);
195195

196196
Assert.NotNull(styleCopSettings.OrderingRules);
197197
Assert.Equal(expected, styleCopSettings.OrderingRules.UsingDirectivesPlacement);

‎StyleCop.Analyzers/StyleCop.Analyzers.Test/Settings/SettingsUnitTests.cs‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ public class SettingsUnitTests
2626
[Fact]
2727
public void VerifySettingsDefaults()
2828
{
29-
var styleCopSettings = SettingsHelper.GetStyleCopSettings(default(SyntaxTreeAnalysisContext), CancellationToken.None);
29+
var styleCopSettings = SettingsHelper.GetStyleCopSettingsInTests(default(SyntaxTreeAnalysisContext), CancellationToken.None);
3030

3131
Assert.Equal("PlaceholderCompany", styleCopSettings.DocumentationRules.CompanyName);
3232
Assert.Equal("Copyright (c) PlaceholderCompany. All rights reserved.", styleCopSettings.DocumentationRules.GetCopyrightText("unused"));
@@ -65,7 +65,7 @@ public async Task VerifyDefaultCultureIsReadCorrectlyAsync()
6565
";
6666
var context = await CreateAnalysisContextAsync(settings).ConfigureAwait(false);
6767

68-
var styleCopSettings = context.GetStyleCopSettings(CancellationToken.None);
68+
var styleCopSettings = context.GetStyleCopSettingsInTests(CancellationToken.None);
6969

7070
Assert.Equal("en-US", styleCopSettings.DocumentationRules.DocumentationCulture);
7171
Assert.Same(CultureInfo.InvariantCulture, styleCopSettings.DocumentationRules.DocumentationCultureInfo);
@@ -116,7 +116,7 @@ public async Task VerifySettingsAreReadCorrectlyAsync()
116116
";
117117
var context = await CreateAnalysisContextAsync(settings).ConfigureAwait(false);
118118

119-
var styleCopSettings = context.GetStyleCopSettings(CancellationToken.None);
119+
var styleCopSettings = context.GetStyleCopSettingsInTests(CancellationToken.None);
120120

121121
Assert.Equal("TestCompany", styleCopSettings.DocumentationRules.CompanyName);
122122
Assert.Equal("Custom copyright text.", styleCopSettings.DocumentationRules.GetCopyrightText("unused"));
@@ -159,7 +159,7 @@ public async Task VerifyBooleanDocumentationSettingsAsync(bool value)
159159
";
160160
var context = await CreateAnalysisContextAsync(settings).ConfigureAwait(false);
161161

162-
var styleCopSettings = context.GetStyleCopSettings(CancellationToken.None);
162+
var styleCopSettings = context.GetStyleCopSettingsInTests(CancellationToken.None);
163163

164164
Assert.Equal(value, styleCopSettings.DocumentationRules.DocumentExposedElements);
165165
Assert.Equal(value, styleCopSettings.DocumentationRules.DocumentInternalElements);
@@ -189,7 +189,7 @@ public async Task VerifyDocumentationVariablesAsync()
189189
";
190190
var context = await CreateAnalysisContextAsync(settings).ConfigureAwait(false);
191191

192-
var styleCopSettings = context.GetStyleCopSettings(CancellationToken.None);
192+
var styleCopSettings = context.GetStyleCopSettingsInTests(CancellationToken.None);
193193

194194
Assert.Single(styleCopSettings.DocumentationRules.Variables);
195195
Assert.Equal("value", styleCopSettings.DocumentationRules.Variables["var"]);
@@ -217,7 +217,7 @@ public async Task VerifySettingsWillUseCompanyNameInDefaultCopyrightTextAsync(st
217217
";
218218
var context = await CreateAnalysisContextAsync(settings).ConfigureAwait(false);
219219

220-
var styleCopSettings = context.GetStyleCopSettings(CancellationToken.None);
220+
var styleCopSettings = context.GetStyleCopSettingsInTests(CancellationToken.None);
221221

222222
Assert.Equal(companyName, styleCopSettings.DocumentationRules.CompanyName);
223223
Assert.Equal($"Copyright (c) {companyName}. All rights reserved.", styleCopSettings.DocumentationRules.GetCopyrightText("unused"));
@@ -237,7 +237,7 @@ public async Task VerifyCircularReferenceBehaviorAsync()
237237
";
238238
var context = await CreateAnalysisContextAsync(settings).ConfigureAwait(false);
239239

240-
var styleCopSettings = context.GetStyleCopSettings(CancellationToken.None);
240+
var styleCopSettings = context.GetStyleCopSettingsInTests(CancellationToken.None);
241241

242242
Assert.Equal("[CircularReference]", styleCopSettings.DocumentationRules.GetCopyrightText("unused"));
243243
}
@@ -256,7 +256,7 @@ public async Task VerifyInvalidReferenceBehaviorAsync()
256256
";
257257
var context = await CreateAnalysisContextAsync(settings).ConfigureAwait(false);
258258

259-
var styleCopSettings = context.GetStyleCopSettings(CancellationToken.None);
259+
var styleCopSettings = context.GetStyleCopSettingsInTests(CancellationToken.None);
260260

261261
Assert.Equal("[InvalidReference]", styleCopSettings.DocumentationRules.GetCopyrightText("unused"));
262262
}
@@ -280,7 +280,7 @@ public async Task VerifySettingsSupportsLineCommentsAsync()
280280
";
281281
var context = await CreateAnalysisContextAsync(settings).ConfigureAwait(false);
282282

283-
var styleCopSettings = context.GetStyleCopSettings(CancellationToken.None);
283+
var styleCopSettings = context.GetStyleCopSettingsInTests(CancellationToken.None);
284284

285285
Assert.Equal("TestCompany", styleCopSettings.DocumentationRules.CompanyName);
286286
Assert.Equal("Copyright (c) TestCompany. All rights reserved.", styleCopSettings.DocumentationRules.GetCopyrightText("unused"));
@@ -307,7 +307,7 @@ public async Task VerifySettingsSupportsBlockCommentsAsync()
307307
";
308308
var context = await CreateAnalysisContextAsync(settings).ConfigureAwait(false);
309309

310-
var styleCopSettings = context.GetStyleCopSettings(CancellationToken.None);
310+
var styleCopSettings = context.GetStyleCopSettingsInTests(CancellationToken.None);
311311

312312
Assert.Equal("TestCompany", styleCopSettings.DocumentationRules.CompanyName);
313313
Assert.Equal("Copyright (c) TestCompany. All rights reserved.", styleCopSettings.DocumentationRules.GetCopyrightText("unused"));
@@ -334,7 +334,7 @@ public async Task VerifySettingsSupportsTrailingCommasAsync()
334334
";
335335
var context = await CreateAnalysisContextAsync(settings).ConfigureAwait(false);
336336

337-
var styleCopSettings = context.GetStyleCopSettings(CancellationToken.None);
337+
var styleCopSettings = context.GetStyleCopSettingsInTests(CancellationToken.None);
338338

339339
Assert.Equal("TestCompany", styleCopSettings.DocumentationRules.CompanyName);
340340
Assert.Equal("Copyright (c) TestCompany. All rights reserved.", styleCopSettings.DocumentationRules.GetCopyrightText("unused"));
@@ -357,7 +357,7 @@ public async Task VerifySettingsFileNameSupportsDotPrefixAsync()
357357
";
358358
var context = await CreateAnalysisContextAsync(settings, ".stylecop.json").ConfigureAwait(false);
359359

360-
var styleCopSettings = context.GetStyleCopSettings(CancellationToken.None);
360+
var styleCopSettings = context.GetStyleCopSettingsInTests(CancellationToken.None);
361361

362362
Assert.Equal("TestCompany", styleCopSettings.DocumentationRules.CompanyName);
363363
}
@@ -368,7 +368,7 @@ public async Task VerifyInvalidJsonBehaviorAsync()
368368
var settings = @"This is not a JSON file.";
369369
var context = await CreateAnalysisContextAsync(settings).ConfigureAwait(false);
370370

371-
var styleCopSettings = context.GetStyleCopSettings(CancellationToken.None);
371+
var styleCopSettings = context.GetStyleCopSettingsInTests(CancellationToken.None);
372372

373373
// The result is the same as the default settings.
374374
Assert.Equal("PlaceholderCompany", styleCopSettings.DocumentationRules.CompanyName);
@@ -381,7 +381,7 @@ public async Task VerifyEmptyOrMissingFileAsync()
381381
var settings = string.Empty;
382382
var context = await CreateAnalysisContextAsync(settings).ConfigureAwait(false);
383383

384-
var styleCopSettings = context.GetStyleCopSettings(CancellationToken.None);
384+
var styleCopSettings = context.GetStyleCopSettingsInTests(CancellationToken.None);
385385

386386
// The result is the same as the default settings.
387387
Assert.Equal("PlaceholderCompany", styleCopSettings.DocumentationRules.CompanyName);

‎StyleCop.Analyzers/StyleCop.Analyzers/Settings/SettingsHelper.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ internal static StyleCopSettings GetStyleCopSettings(this SyntaxTreeAnalysisCont
110110
/// <param name="context">The context that will be used to determine the StyleCop settings.</param>
111111
/// <param name="cancellationToken">The cancellation token that the operation will observe.</param>
112112
/// <returns>A <see cref="StyleCopSettings"/> instance that represents the StyleCop settings for the given context.</returns>
113-
internal static StyleCopSettings GetStyleCopSettings(this SyntaxTreeAnalysisContext context, CancellationToken cancellationToken)
113+
internal static StyleCopSettings GetStyleCopSettingsInTests(this SyntaxTreeAnalysisContext context, CancellationToken cancellationToken)
114114
{
115115
var settingsFile = GetSettingsFile(context.Options, ParseJson, cancellationToken);
116116
return GetSettings(context.Options, settingsStorage: new StrongBox<StyleCopSettings>(), context.Tree, settingsFile, DeserializationFailureBehavior.ReturnDefaultSettings);

0 commit comments

Comments
 (0)