1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
use crate::sequence::helper::*;
use std::convert::From;
use std::convert::TryFrom;
use super::*;

/// ```rust
/// use letter_sequence::SequenceBuilder;
/// use std::convert::TryFrom;
///
/// let mut seq = SequenceBuilder::try_from("Z")
///   .unwrap()
/// 	.upper()
/// 	.build()
/// 	.unwrap();
/// // First call to .next() returns starting element
/// let elem = seq.next().unwrap();
/// assert_eq!( elem.to_string(), "Z" );
/// let elem = seq.next().unwrap();
/// assert_eq!( elem.to_string(), "AA" );
/// let elem = seq.next().unwrap();
/// assert_eq!( elem.to_string(), "AB" );
/// let elem = seq.next().unwrap();
/// assert_eq!( elem.to_string(), "AC" );
/// ```
///
/// This time with .max_render_capacity() set, and lowercase
/// ```rust
/// use letter_sequence::SequenceBuilder;
/// use std::convert::TryFrom;
///
/// let mut seq = SequenceBuilder::try_from('y')
///   .unwrap()
/// 	.lower()
/// 	.max_render_capacity(1)
/// 	.build()
/// 	.unwrap();
/// let elem = seq.next().unwrap();
/// assert_eq!( elem.to_string(), "y"  );
/// let elem = seq.next().unwrap();
/// assert_eq!( elem.to_string(), "z"  );
/// // Without .max_render_capacity(1) this would return "aa"
/// let elem = seq.next();
/// assert_eq!( elem, None  );
/// ```
///
/// Also boring number sequence
/// ```rust
/// use letter_sequence::SequenceBuilder;
/// use std::convert::TryFrom;
///
/// let mut seq = SequenceBuilder::from(102)
/// 	.numeric()
/// 	.build()
/// 	.unwrap();
/// let elem = seq.next();
/// let elem = seq.next().unwrap();
/// assert_eq!( elem.to_string(), "103" );
/// ```
///
/// You can also set the step!
/// ```rust
/// use letter_sequence::SequenceBuilder;
/// use std::convert::TryFrom;
/// 
/// let mut seq = SequenceBuilder::from(0)
/// 	.numeric()
/// 	.step(2)
/// 	.build()
/// 	.unwrap();
/// let elem = seq.next().unwrap();
/// assert_eq!( elem.to_string(), "0"  );
/// let elem = seq.next().unwrap();
/// assert_eq!( elem.to_string(), "2"  );
/// let elem = seq.next().unwrap();
/// assert_eq!( elem.to_string(), "4"  );
///
/// let mut seq = SequenceBuilder::try_from("A")
///   .unwrap()
/// 	.step(2)
/// 	.upper()
/// 	.build()
/// 	.unwrap();
/// let elem = seq.next().unwrap();
/// assert_eq!( elem.to_string(), "A" );
/// let elem = seq.next().unwrap();
/// assert_eq!( elem.to_string(), "C" );
/// let elem = seq.next().unwrap();
/// assert_eq!( elem.to_string(), "E" );
/// ```
#[derive(Debug)]
pub struct SequenceBuilder {
	start: u64,
	step: u32,
	inclusive: bool,
	renderer: SeqRendererBuilder,
	min_render_length: Option<u8>,
	end: Option<u64>
}

impl Default for SequenceBuilder {
	fn default() -> Self {
		Self {
			start: 0,
			step: 1,
			end: None,
			inclusive: false,
			renderer: Default::default(),
			min_render_length: Default::default(),
		}
	}
}

impl SequenceBuilder {
	pub fn new() -> Self {
		Self { ..Default::default() }
	}


	/// Sets the end, default half-open (exclusive end), see .inclusive()
	pub fn end(mut self, end: u64) -> Self {
		self.end = Some(end);
		self
	}
	
	/// Sets the start
	pub fn start(mut self, start: u64) -> Self {
		self.start = start;
		self
	}
	
	/// Sets the increment to step to
	pub fn step(mut self, step: u32) -> Self {
		self.step = step;
		self
	}


	/// Limits the chacters in rendered output, incrementing past limit generates
	/// error. default: unlimited
	///
	/// ```rust
	/// use letter_sequence::{ SequenceBuilder, SequenceError };
	/// use std::convert::TryFrom;
	/// let mut seq = SequenceBuilder::try_from("y").unwrap().max_render_capacity(1).build().unwrap();
	/// let elem = seq.next().unwrap();
	/// assert_eq!( elem.to_string(), "y" );
	/// let elem = seq.next().unwrap();
	/// assert_eq!( elem.to_string(), "z" );
	/// assert_eq!( seq.next(), None );
	/// assert_eq!( seq.next(), None );
	/// ```
	pub fn max_render_capacity(mut self, chars: u8) -> Self {
		self.renderer = self.renderer.capacity(chars);
		self
	}

	/// Limits the minimum width of the rendered output, this only works on
	/// numeric which effectively zero-pads the output.
	pub fn min_render_length(mut self, chars: u8) -> Self {
		self.min_render_length = Some(chars);
		self
	}

	/// This is the default: a half-open range that excludes the end
	pub fn exclusive(mut self) -> Self {
		self.inclusive = false;
		self
	}
	
	/// Close the range, include the end
	pub fn inclusive(mut self) -> Self {
		self.inclusive = true;
		self
	}
	
	/// Render the sequence in lowercase
	pub fn lower(mut self) -> Self {
		self.renderer = SeqRendererBuilder::lower();
		self
	}
	/// Render the sequence in uppercase, default
	pub fn upper(mut self) -> Self {
		self.renderer = SeqRendererBuilder::upper();
		self
	}
	/// Render the sequence in digits
	pub fn numeric(mut self) -> Self {
		self.renderer = SeqRendererBuilder::numeric();
		self
	}

	pub fn build(self) -> Result<Sequence, SequenceError> {
		let renderer = self.renderer.build()?;

		// You can't really pad alpha-numerics because A is not 0.
		match (renderer.display(), self.min_render_length) {
			(RenderDisplay::Upper | RenderDisplay::Lower, Some(_)) => return Err(SequenceError::PaddingAlpha),
			_ => ()
		};

		let end = match (self.end, self.inclusive) {
			(Some(end), true) => Some(end + 1),
			(Some(end), false) => Some(end),
			_ => None
		};
		let seq = Sequence {
			end,
			step: self.step,
			start: self.start,
			renderer,
			.. Default::default()
		};
		Ok(seq)
	}
}

impl From<u64> for SequenceBuilder {
	fn from(start: u64) -> Self {
		Self::new().start(start)
	}
}

/// ```rust
/// // use letter_sequence::SequenceBuilder;
/// // use std::convert::TryFrom;
///	// assert_eq!(
///	// 	SequenceBuilder::try_from("00001")
///	// 		.unwrap()
///	// 		.build()
///	// 		.unwrap()
///	// 		.to_string(),
///	// 	"1"
///	// );
///	// assert_eq!(
///	// 	SequenceBuilder::try_from("00001")
///	// 		.unwrap()
///	// 		.upper()
///	// 		.build()
///	// 		.unwrap()
///	// 		.to_string(),
///	// 	"B"
///	// );
/// ```
impl TryFrom<&str> for SequenceBuilder {
	type Error = SequenceError;
	fn try_from(value: &str) -> Result<Self, Self::Error> {
		let first_char = value
			.chars()
			.next()
			.ok_or_else( || SequenceError::EmptyString )?
		;

		match renderer::RenderDisplay::try_from(first_char)? {
			renderer::RenderDisplay::Numeric => Ok(
				Self::new().start(value.parse::<u64>()?).numeric()
			),
			renderer::RenderDisplay::Upper => Ok(
				Self::new().start(string_to_int(&value)?).upper()
			),
			renderer::RenderDisplay::Lower => Ok(
				Self::new().start(string_to_int(&value)?).lower()
			)
		}
	}
}

impl TryFrom<(&str, &str)> for SequenceBuilder {
	type Error = SequenceError;
	fn try_from((start, end): (&str, &str)) -> Result<Self, Self::Error> {
		let first_char = start
			.chars()
			.next()
			.ok_or_else( || SequenceError::EmptyString )?
		;

		let builder = match renderer::RenderDisplay::try_from(first_char)? {
			renderer::RenderDisplay::Numeric => {
				Self::new()
					.start(start.parse::<u64>()?)
					.end(end.parse::<u64>()?)
					.numeric()
			},
			renderer::RenderDisplay::Upper => {
				Self::new()
					.start(string_to_int(&start)?)
					.end(string_to_int(&end)?)
					.upper()
			},
			renderer::RenderDisplay::Lower => {
				Self::new()
					.start(string_to_int(&start)?)
					.end(string_to_int(&end)?)
					.lower()
			}
		};

		Ok(builder)
	}
}

impl TryFrom<char> for SequenceBuilder {
	type Error = SequenceError;
	fn try_from(value: char) -> Result<Self, Self::Error> {
		Ok(Self::new().start(char_to_int(value)? as u64))
	}
}

#[cfg(test)]
mod test {
	use super::*;

	/// Test violations of the max_render_capacity system, ensure we return an error
	fn max_render_capacity() {
		// Test link between max_alpha(chars) and the OutOfRange
		for limit in 1..10 {
			let max = crate::sequence::renderer::max_alpha(limit);
			let mut seq = SequenceBuilder::new().start(max)
				.upper()
				.max_render_capacity(limit)
				.build()
				.unwrap();
			let render_as = "Z".repeat(limit as usize);
			let elem = seq.next().unwrap();
			assert_eq!( elem.to_string(), render_as );
			let elem = seq.next();
			assert_eq!( elem, None );
			assert_eq!( seq.next(), None )
		}

		// Test max_numeric(chars) + 1 throws OutOfRange
		for limit in 1..10 {
			let max = crate::sequence::renderer::max_numeric(limit);
			let mut seq = SequenceBuilder::new().start(max).numeric().max_render_capacity(limit).build().unwrap();
			let render_as = "9".repeat(limit as usize);
			assert_eq!( seq.to_string(), render_as, "Render {} as {}", max, render_as );
			assert_eq!(
				seq.next(),
				None,
				"Throw error with numeric char limit of {} which can only represent {}",
					limit,
					max
			);
			assert_eq!( seq.next(), None )
		}
	}

	/// Test that the first element renders properly with .upper() .lower() and .numeric()
	#[test]
	fn simple() {
		for c in 'A'..'Z' {
			// upper
			let mut seq = SequenceBuilder::new().start(c as u64 - 'A' as u64).upper().build().unwrap();
			let elem = seq.next().unwrap();
			assert_eq!(
				elem.to_string(),
				c.to_string(),
			);

			// lower
			let mut seq = SequenceBuilder::new().start(c as u64 - 'A' as u64).lower().build().unwrap();
			let elem = seq.next().unwrap();
			assert_eq!(
				elem.to_string(),
				c.to_string().to_lowercase(),
			);
		}

		// numeric
		for i in 1..123_456 {
			let mut seq = SequenceBuilder::new().start(i).numeric().build().unwrap();
			let elem = seq.next().unwrap();
			assert_eq!(
				elem.to_string(),
				i.to_string()
			);
		}
	}

	fn rollover() {
		const A: u32  = 0;
		const Z: u32 = 25;
		for i in A..Z {

			// Easy check for A[A-Z] after Z
			let seq = SequenceBuilder::new().start(Z as u64).upper().build().unwrap();
			let result = format!("A{}", std::char::from_u32('A' as u32 + i).unwrap());
			assert_eq!(
				seq.skip(i as usize + 1).next().unwrap().to_string(),
				result
			);
			
			let mut seq = SequenceBuilder::new().start(Z as u64).upper().build().unwrap();
			assert_eq!(
				seq.nth(i as usize + 1).unwrap().to_string(),
				result,
				".nth({})", i
			);

			let seq = SequenceBuilder::new().start(Z as u64 + 1 + i as u64).lower().build().unwrap();
			assert_eq!(
				seq.to_string(),
				result.to_lowercase()
			);
			
			let mut seq = SequenceBuilder::new().start(A as u64).upper().build().unwrap();
			for len in 1..5 {
				assert_eq!(
					seq.nth(26usize.pow(len as u32) - 1).unwrap().to_string(),
					"A".repeat(len + 1),
				);
			}
			
			let mut seq = SequenceBuilder::new().start(Z as u64).upper().build().unwrap();
			for len in 2..5 {
				assert_eq!(
					seq.nth(26usize.pow(len as u32) - 1).unwrap().to_string(),
					"Z".repeat(len),
				);
			}
		}
	}

}