Skip to content

Commit 75dc940

Browse files
sharpjssharpjs
committed
Rename *ItemBuilder to *Builder.
1 parent d4c8d37 commit 75dc940

File tree

8 files changed

+44
-49
lines changed

8 files changed

+44
-49
lines changed

DependencyQueue.Tests/DependencyQueueItemBuilderTests.cs renamed to DependencyQueue.Tests/DependencyQueueBuilderTests.cs

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
namespace DependencyQueue;
55

66
[TestFixture]
7-
public class DependencyQueueItemBuilderTests
7+
public class DependencyQueueBuilderTests
88
{
99
[Test]
1010
public void Construct_NullQueue()
@@ -21,7 +21,7 @@ public void Construct_Ok()
2121
{
2222
using var queue = new Queue();
2323

24-
var builder = queue.CreateItemBuilder();
24+
var builder = queue.CreateBuilder();
2525

2626
builder.CurrentItem.ShouldBeNull();
2727
builder.Queue .ShouldBeSameAs(queue);
@@ -32,7 +32,7 @@ public void NewItem()
3232
{
3333
using var queue = new Queue();
3434

35-
var builder = queue.CreateItemBuilder();
35+
var builder = queue.CreateBuilder();
3636

3737
var value = new Value();
3838
var item = builder
@@ -51,7 +51,7 @@ public void AddProvides_ParamsArray_NoCurrentItem()
5151
{
5252
using var queue = new Queue();
5353

54-
var builder = queue.CreateItemBuilder();
54+
var builder = queue.CreateBuilder();
5555

5656
Should.Throw<InvalidOperationException>(
5757
() => builder.AddProvides("a", "b")
@@ -63,7 +63,7 @@ public void AddProvides_IEnumerable_NoCurrentItem()
6363
{
6464
using var queue = new Queue();
6565

66-
var builder = queue.CreateItemBuilder();
66+
var builder = queue.CreateBuilder();
6767

6868
Should.Throw<InvalidOperationException>(
6969
() => builder.AddProvides((IEnumerable<string>) ["a", "b"])
@@ -75,7 +75,7 @@ public void AddProvides_ParamsArray_Ok()
7575
{
7676
using var queue = new Queue();
7777

78-
var builder = queue.CreateItemBuilder();
78+
var builder = queue.CreateBuilder();
7979

8080
var item = builder
8181
.NewItem("x", value: new())
@@ -91,7 +91,7 @@ public void AddProvides_IEnumerable_Ok()
9191
{
9292
using var queue = new Queue();
9393

94-
var builder = queue.CreateItemBuilder();
94+
var builder = queue.CreateBuilder();
9595

9696
var item = builder
9797
.NewItem("x", value: new())
@@ -107,7 +107,7 @@ public void AddRequires_ParamsArray_NoCurrentItem()
107107
{
108108
using var queue = new Queue();
109109

110-
var builder = queue.CreateItemBuilder();
110+
var builder = queue.CreateBuilder();
111111

112112
Should.Throw<InvalidOperationException>(
113113
() => builder.AddRequires("a", "b")
@@ -119,7 +119,7 @@ public void AddRequires_IEnumerable_NoCurrentItem()
119119
{
120120
using var queue = new Queue();
121121

122-
var builder = queue.CreateItemBuilder();
122+
var builder = queue.CreateBuilder();
123123

124124
Should.Throw<InvalidOperationException>(
125125
() => builder.AddRequires((IEnumerable<string>) ["a", "b"])
@@ -131,7 +131,7 @@ public void AddRequires_ParamsArray_Ok()
131131
{
132132
using var queue = new Queue();
133133

134-
var builder = queue.CreateItemBuilder();
134+
var builder = queue.CreateBuilder();
135135

136136
var item = builder
137137
.NewItem("x", value: new())
@@ -147,7 +147,7 @@ public void AddRequires_IEnumerable_Ok()
147147
{
148148
using var queue = new Queue();
149149

150-
var builder = queue.CreateItemBuilder();
150+
var builder = queue.CreateBuilder();
151151

152152
var item = builder
153153
.NewItem("x", value: new())
@@ -163,7 +163,7 @@ public void Enqueue_NoCurrentItem()
163163
{
164164
using var queue = new Queue();
165165

166-
var builder = queue.CreateItemBuilder();
166+
var builder = queue.CreateBuilder();
167167

168168
Should.Throw<InvalidOperationException>(
169169
() => builder.Enqueue()
@@ -175,7 +175,7 @@ public void Enqueue_Ok()
175175
{
176176
using var queue = new Queue();
177177

178-
var builder = queue.CreateItemBuilder();
178+
var builder = queue.CreateBuilder();
179179

180180
builder
181181
.NewItem("x", value: new())
@@ -200,7 +200,7 @@ public void Enqueue_WithOutParameter_NoCurrentItem()
200200
{
201201
using var queue = new Queue();
202202

203-
var builder = queue.CreateItemBuilder();
203+
var builder = queue.CreateBuilder();
204204

205205
Should.Throw<InvalidOperationException>(
206206
() => builder.Enqueue(out _)
@@ -212,7 +212,7 @@ public void Enqueue_WithOutParameter__Ok()
212212
{
213213
using var queue = new Queue();
214214

215-
var builder = queue.CreateItemBuilder();
215+
var builder = queue.CreateBuilder();
216216

217217
builder
218218
.NewItem("x", value: new())

‎DependencyQueue.Tests/DependencyQueueTests.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,11 +68,11 @@ public void Construct_ExplicitComparer()
6868
}
6969

7070
[Test]
71-
public void CreateItemBuilder()
71+
public void CreateBuilder()
7272
{
7373
using var queue = new Queue();
7474

75-
var builder = queue.CreateItemBuilder();
75+
var builder = queue.CreateBuilder();
7676

7777
builder .ShouldNotBeNull();
7878
builder.Queue.ShouldBeSameAs(queue);

‎DependencyQueue.Tests/ExampleTests.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ public void Example_Simple()
1818
using var queue = new DependencyQueue<Step>();
1919

2020
// Create a builder for queue items
21-
var builder = queue.CreateItemBuilder();
21+
var builder = queue.CreateBuilder();
2222

2323
// Add items in any order
2424
// First, we know we have to assemble the burger
@@ -78,7 +78,7 @@ public async Task Example_AsyncParallel()
7878
using var queue = new DependencyQueue<Step>();
7979

8080
// Create a builder for queue items
81-
var builder = queue.CreateItemBuilder();
81+
var builder = queue.CreateBuilder();
8282

8383
// Add items in any order
8484
// First, we know we have to assemble the burger

‎DependencyQueue.Tests/TestTypes.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ private static string GenerateName()
6666
=> TestContext.CurrentContext.Random.GetString(6);
6767
}
6868

69-
class Builder : DependencyQueueItemBuilder<Value>
69+
class Builder : DependencyQueueBuilder<Value>
7070
{
7171
internal Builder(Queue queue)
7272
: base(queue)

‎DependencyQueue/DependencyQueue.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ public DependencyQueue(StringComparer? comparer = null)
8686
/// <b>not</b> thread-safe. To enqueue items incrementally in parallel,
8787
/// use one builder per thread.
8888
/// </remarks>
89-
public DependencyQueueItemBuilder<T> CreateItemBuilder()
89+
public DependencyQueueBuilder<T> CreateBuilder()
9090
=> new(this);
9191

9292
/// <summary>
@@ -160,7 +160,7 @@ private static void RequireValidNames(IEnumerable<string> names, string paramete
160160
}
161161
}
162162

163-
// Called by Enqueue and by DependencyQueueItemBuilder
163+
// Called by Enqueue and by DependencyQueueBuilder
164164
internal void Enqueue(DependencyQueueItem<T> item)
165165
{
166166
if (item is null)

DependencyQueue/DependencyQueueItemBuilder.cs renamed to DependencyQueue/DependencyQueueBuilder.cs

Lines changed: 13 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ namespace DependencyQueue;
1414
/// Members of this type are <strong>not</strong> thread-safe. To build
1515
/// items in parallel, use a separate builder for each thread.
1616
/// </remarks>
17-
public class DependencyQueueItemBuilder<T>
17+
public class DependencyQueueBuilder<T>
1818
{
1919
// The current item being built
2020
private DependencyQueueItem<T>? _item;
@@ -23,16 +23,16 @@ public class DependencyQueueItemBuilder<T>
2323
private readonly DependencyQueue<T> _queue;
2424

2525
/// <summary>
26-
/// Initializes a new <see cref="DependencyQueueItemBuilder{T}"/>
27-
/// instance for the specified queue.
26+
/// Initializes a new <see cref="DependencyQueueBuilder{T}"/> instance
27+
/// for the specified queue.
2828
/// </summary>
2929
/// <param name="queue">
3030
/// The queue to which the builder will enqueue items.
3131
/// </param>
3232
/// <exception cref="ArgumentNullException">
3333
/// <paramref name="queue"/> is <see langword="null"/>.
3434
/// </exception>
35-
internal DependencyQueueItemBuilder(DependencyQueue<T> queue)
35+
internal DependencyQueueBuilder(DependencyQueue<T> queue)
3636
{
3737
if (queue is null)
3838
throw Errors.ArgumentNull(nameof(queue));
@@ -75,7 +75,7 @@ internal DependencyQueueItemBuilder(DependencyQueue<T> queue)
7575
/// <exception cref="ArgumentException">
7676
/// <paramref name="name"/> is empty.
7777
/// </exception>
78-
public DependencyQueueItemBuilder<T> NewItem(string name, T value)
78+
public DependencyQueueBuilder<T> NewItem(string name, T value)
7979
{
8080
_item = new(name, value, _queue.Comparer);
8181
return this;
@@ -106,14 +106,14 @@ public DependencyQueueItemBuilder<T> NewItem(string name, T value)
106106
/// The builder does not have a current item.
107107
/// Use <see cref="NewItem"/> to begin building an item.
108108
/// </exception>
109-
public DependencyQueueItemBuilder<T> AddProvides(IEnumerable<string> names)
109+
public DependencyQueueBuilder<T> AddProvides(IEnumerable<string> names)
110110
{
111111
RequireCurrentItem().AddProvides(names);
112112
return this;
113113
}
114114

115115
/// <inheritdoc cref="AddProvides(IEnumerable{string})"/>>
116-
public DependencyQueueItemBuilder<T> AddProvides(params string[] names)
116+
public DependencyQueueBuilder<T> AddProvides(params string[] names)
117117
=> AddProvides((IEnumerable<string>) names);
118118

119119
/// <summary>
@@ -141,14 +141,14 @@ public DependencyQueueItemBuilder<T> AddProvides(params string[] names)
141141
/// The builder does not have a current item.
142142
/// Use <see cref="NewItem"/> to begin building an item.
143143
/// </exception>
144-
public DependencyQueueItemBuilder<T> AddRequires(IEnumerable<string> names)
144+
public DependencyQueueBuilder<T> AddRequires(IEnumerable<string> names)
145145
{
146146
RequireCurrentItem().AddRequires(names);
147147
return this;
148148
}
149149

150150
/// <inheritdoc cref="AddRequires(IEnumerable{string})"/>>
151-
public DependencyQueueItemBuilder<T> AddRequires(params string[] names)
151+
public DependencyQueueBuilder<T> AddRequires(params string[] names)
152152
=> AddRequires((IEnumerable<string>) names);
153153

154154
/// <summary>
@@ -166,17 +166,15 @@ public DependencyQueueItemBuilder<T> AddRequires(params string[] names)
166166
/// The builder does not have a current item.
167167
/// Use <see cref="NewItem"/> to begin building an item.
168168
/// </exception>
169-
public DependencyQueueItemBuilder<T> Enqueue()
170-
{
171-
return Enqueue(out _);
172-
}
169+
public DependencyQueueBuilder<T> Enqueue()
170+
=> Enqueue(out _);
173171

174172
/// <inheritdoc cref="Enqueue()"/>
175173
/// <param name="item">
176174
/// When this method returns, contains the item that was added to the
177175
/// queue.
178176
/// </param>
179-
public DependencyQueueItemBuilder<T> Enqueue(out DependencyQueueItem<T> item)
177+
public DependencyQueueBuilder<T> Enqueue(out DependencyQueueItem<T> item)
180178
{
181179
item = RequireCurrentItem();
182180
_queue.Enqueue(item);
@@ -185,7 +183,5 @@ public DependencyQueueItemBuilder<T> Enqueue(out DependencyQueueItem<T> item)
185183
}
186184

187185
private DependencyQueueItem<T> RequireCurrentItem()
188-
{
189-
return _item ?? throw Errors.BuilderNoCurrentItem();
190-
}
186+
=> _item ?? throw Errors.BuilderNoCurrentItem();
191187
}

‎DependencyQueue/DependencyQueueItem.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ internal DependencyQueueItem(string name, T value, StringComparer comparer)
6464
/// </summary>
6565
internal SortedSet<string> Requires { get; }
6666

67-
// Invoked by DependencyQueue<T> and DependencyQueueItemBuilder<T>
67+
// Invoked by DependencyQueue<T> and DependencyQueueBuilder<T>
6868
internal void AddProvides(IEnumerable<string> names)
6969
{
7070
RequireValidNames(names);
@@ -78,7 +78,7 @@ internal void AddProvides(IEnumerable<string> names)
7878
}
7979
}
8080

81-
// Invoked by DependencyQueue<T> and DependencyQueueItemBuilder<T>
81+
// Invoked by DependencyQueue<T> and DependencyQueueBuilder<T>
8282
internal void AddRequires(IEnumerable<string> names)
8383
{
8484
RequireValidNames(names);

‎README.md‎

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -50,10 +50,10 @@ items: an `Enqueue()` method and a builder pattern.
5050

5151
#### Enqueueing Items With a Builder
5252

53-
To obtain a builder object, call `CreateItemBuilder()`.
53+
To obtain a builder object, call `CreateBuilder()`.
5454

5555
```csharp
56-
var builder = queue.CreateItemBuilder();
56+
var builder = queue.CreateBuilder();
5757
```
5858

5959
The builder uses a fluent interface to build and enqueue an item incrementally.
@@ -97,9 +97,8 @@ builder
9797
.Enqueue();
9898
```
9999

100-
`CreateItemBuilder()` is thread-safe, but the builder object it returns is not.
101-
To build and enqueue items in parallel, create a separate builder for each
102-
thread.
100+
`CreateBuilder()` is thread-safe, but the builder object it returns is not. To
101+
build and enqueue items in parallel, create a separate builder for each thread.
103102

104103
#### Enqueueing Items With the Enqueue Method
105104

@@ -253,8 +252,8 @@ Most members of `DependencyQueue<T>` are thread-safe. Specifically:
253252

254253
- The `Enqueue()` method is thread-safe.
255254

256-
- ⚠ The `CreateItemBuilder()` method is thread-safe, but the object it returns
257-
is **not** thread-safe. Multiple threads can each use their own builder
255+
- ⚠ The `CreateBuilder()` method is thread-safe, but the object it returns is
256+
**not** thread-safe. Multiple threads can each use their own builder
258257
instance to enqueue items in parallel.
259258

260259
- The dequeue methods (`Dequeue()`, `DequeueAsync()`, and `Complete()`)
@@ -286,7 +285,7 @@ not important what a step is. Just imagine that the `Step` class has an
286285
using var queue = new DependencyQueue<Step>();
287286

288287
// Create a builder for queue items
289-
var builder = queue.CreateItemBuilder();
288+
var builder = queue.CreateBuilder();
290289

291290
// Add items in any order
292291
// First, we know we have to assemble the burger

0 commit comments

Comments
 (0)