Initial commit

This commit is contained in:
github-classroom[bot] 2025-04-06 10:48:47 +00:00 committed by GitHub
commit 4dda0d330c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
11 changed files with 4624 additions and 0 deletions

3551
.editorconfig Normal file

File diff suppressed because it is too large Load diff

583
.gitignore vendored Normal file
View file

@ -0,0 +1,583 @@
# Created by https://www.toptal.com/developers/gitignore/api/csharp,visualstudio
# Edit at https://www.toptal.com/developers/gitignore?templates=csharp,visualstudio
### Csharp ###
## Ignore Visual Studio temporary files, build results, and
## files generated by popular Visual Studio add-ons.
##
## Get latest from https://github.com/github/gitignore/blob/main/VisualStudio.gitignore
# User-specific files
*.rsuser
*.suo
*.user
*.userosscache
*.sln.docstates
# User-specific files (MonoDevelop/Xamarin Studio)
*.userprefs
# Mono auto generated files
mono_crash.*
# Build results
[Dd]ebug/
[Dd]ebugPublic/
[Rr]elease/
[Rr]eleases/
x64/
x86/
[Ww][Ii][Nn]32/
[Aa][Rr][Mm]/
[Aa][Rr][Mm]64/
bld/
[Bb]in/
[Oo]bj/
[Ll]og/
[Ll]ogs/
# Visual Studio 2015/2017 cache/options directory
.vs/
# Uncomment if you have tasks that create the project's static files in wwwroot
#wwwroot/
# Visual Studio 2017 auto generated files
Generated\ Files/
# MSTest test Results
[Tt]est[Rr]esult*/
[Bb]uild[Ll]og.*
# NUnit
*.VisualState.xml
TestResult.xml
nunit-*.xml
# Build Results of an ATL Project
[Dd]ebugPS/
[Rr]eleasePS/
dlldata.c
# Benchmark Results
BenchmarkDotNet.Artifacts/
# .NET Core
project.lock.json
project.fragment.lock.json
artifacts/
# ASP.NET Scaffolding
ScaffoldingReadMe.txt
# StyleCop
StyleCopReport.xml
# Files built by Visual Studio
*_i.c
*_p.c
*_h.h
*.ilk
*.meta
*.obj
*.iobj
*.pch
*.pdb
*.ipdb
*.pgc
*.pgd
*.rsp
*.sbr
*.tlb
*.tli
*.tlh
*.tmp
*.tmp_proj
*_wpftmp.csproj
*.log
*.tlog
*.vspscc
*.vssscc
.builds
*.pidb
*.svclog
*.scc
# Chutzpah Test files
_Chutzpah*
# Visual C++ cache files
ipch/
*.aps
*.ncb
*.opendb
*.opensdf
*.sdf
*.cachefile
*.VC.db
*.VC.VC.opendb
# Visual Studio profiler
*.psess
*.vsp
*.vspx
*.sap
# Visual Studio Trace Files
*.e2e
# TFS 2012 Local Workspace
$tf/
# Guidance Automation Toolkit
*.gpState
# ReSharper is a .NET coding add-in
_ReSharper*/
*.[Rr]e[Ss]harper
*.DotSettings.user
# TeamCity is a build add-in
_TeamCity*
# DotCover is a Code Coverage Tool
*.dotCover
# AxoCover is a Code Coverage Tool
.axoCover/*
!.axoCover/settings.json
# Coverlet is a free, cross platform Code Coverage Tool
coverage*.json
coverage*.xml
coverage*.info
# Visual Studio code coverage results
*.coverage
*.coveragexml
# NCrunch
_NCrunch_*
.*crunch*.local.xml
nCrunchTemp_*
# MightyMoose
*.mm.*
AutoTest.Net/
# Web workbench (sass)
.sass-cache/
# Installshield output folder
[Ee]xpress/
# DocProject is a documentation generator add-in
DocProject/buildhelp/
DocProject/Help/*.HxT
DocProject/Help/*.HxC
DocProject/Help/*.hhc
DocProject/Help/*.hhk
DocProject/Help/*.hhp
DocProject/Help/Html2
DocProject/Help/html
# Click-Once directory
publish/
# Publish Web Output
*.[Pp]ublish.xml
*.azurePubxml
# Note: Comment the next line if you want to checkin your web deploy settings,
# but database connection strings (with potential passwords) will be unencrypted
*.pubxml
*.publishproj
# Microsoft Azure Web App publish settings. Comment the next line if you want to
# checkin your Azure Web App publish settings, but sensitive information contained
# in these scripts will be unencrypted
PublishScripts/
# NuGet Packages
*.nupkg
# NuGet Symbol Packages
*.snupkg
# The packages folder can be ignored because of Package Restore
**/[Pp]ackages/*
# except build/, which is used as an MSBuild target.
!**/[Pp]ackages/build/
# Uncomment if necessary however generally it will be regenerated when needed
#!**/[Pp]ackages/repositories.config
# NuGet v3's project.json files produces more ignorable files
*.nuget.props
*.nuget.targets
# Microsoft Azure Build Output
csx/
*.build.csdef
# Microsoft Azure Emulator
ecf/
rcf/
# Windows Store app package directories and files
AppPackages/
BundleArtifacts/
Package.StoreAssociation.xml
_pkginfo.txt
*.appx
*.appxbundle
*.appxupload
# Visual Studio cache files
# files ending in .cache can be ignored
*.[Cc]ache
# but keep track of directories ending in .cache
!?*.[Cc]ache/
# Others
ClientBin/
~$*
*~
*.dbmdl
*.dbproj.schemaview
*.jfm
*.pfx
*.publishsettings
orleans.codegen.cs
# Including strong name files can present a security risk
# (https://github.com/github/gitignore/pull/2483#issue-259490424)
#*.snk
# Since there are multiple workflows, uncomment next line to ignore bower_components
# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622)
#bower_components/
# RIA/Silverlight projects
Generated_Code/
# Backup & report files from converting an old project file
# to a newer Visual Studio version. Backup files are not needed,
# because we have git ;-)
_UpgradeReport_Files/
Backup*/
UpgradeLog*.XML
UpgradeLog*.htm
ServiceFabricBackup/
*.rptproj.bak
# SQL Server files
*.mdf
*.ldf
*.ndf
# Business Intelligence projects
*.rdl.data
*.bim.layout
*.bim_*.settings
*.rptproj.rsuser
*- [Bb]ackup.rdl
*- [Bb]ackup ([0-9]).rdl
*- [Bb]ackup ([0-9][0-9]).rdl
# Microsoft Fakes
FakesAssemblies/
# GhostDoc plugin setting file
*.GhostDoc.xml
# Node.js Tools for Visual Studio
.ntvs_analysis.dat
node_modules/
# Visual Studio 6 build log
*.plg
# Visual Studio 6 workspace options file
*.opt
# Visual Studio 6 auto-generated workspace file (contains which files were open etc.)
*.vbw
# Visual Studio 6 auto-generated project file (contains which files were open etc.)
*.vbp
# Visual Studio 6 workspace and project file (working project files containing files to include in project)
*.dsw
*.dsp
# Visual Studio 6 technical files
# Visual Studio LightSwitch build output
**/*.HTMLClient/GeneratedArtifacts
**/*.DesktopClient/GeneratedArtifacts
**/*.DesktopClient/ModelManifest.xml
**/*.Server/GeneratedArtifacts
**/*.Server/ModelManifest.xml
_Pvt_Extensions
# Paket dependency manager
.paket/paket.exe
paket-files/
# FAKE - F# Make
.fake/
# CodeRush personal settings
.cr/personal
# Python Tools for Visual Studio (PTVS)
__pycache__/
*.pyc
# Cake - Uncomment if you are using it
# tools/**
# !tools/packages.config
# Tabs Studio
*.tss
# Telerik's JustMock configuration file
*.jmconfig
# BizTalk build output
*.btp.cs
*.btm.cs
*.odx.cs
*.xsd.cs
# OpenCover UI analysis results
OpenCover/
# Azure Stream Analytics local run output
ASALocalRun/
# MSBuild Binary and Structured Log
*.binlog
# NVidia Nsight GPU debugger configuration file
*.nvuser
# MFractors (Xamarin productivity tool) working folder
.mfractor/
# Local History for Visual Studio
.localhistory/
# Visual Studio History (VSHistory) files
.vshistory/
# BeatPulse healthcheck temp database
healthchecksdb
# Backup folder for Package Reference Convert tool in Visual Studio 2017
MigrationBackup/
# Ionide (cross platform F# VS Code tools) working folder
.ionide/
# Fody - auto-generated XML schema
FodyWeavers.xsd
# VS Code files for those working on multiple tools
.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json
*.code-workspace
# Local History for Visual Studio Code
.history/
# Windows Installer files from build outputs
*.cab
*.msi
*.msix
*.msm
*.msp
# JetBrains Rider
*.sln.iml
### VisualStudio ###
# User-specific files
# User-specific files (MonoDevelop/Xamarin Studio)
# Mono auto generated files
# Build results
# Visual Studio 2015/2017 cache/options directory
# Uncomment if you have tasks that create the project's static files in wwwroot
# Visual Studio 2017 auto generated files
# MSTest test Results
# NUnit
# Build Results of an ATL Project
# Benchmark Results
# .NET Core
# ASP.NET Scaffolding
# StyleCop
# Files built by Visual Studio
# Chutzpah Test files
# Visual C++ cache files
# Visual Studio profiler
# Visual Studio Trace Files
# TFS 2012 Local Workspace
# Guidance Automation Toolkit
# ReSharper is a .NET coding add-in
# TeamCity is a build add-in
# DotCover is a Code Coverage Tool
# AxoCover is a Code Coverage Tool
# Coverlet is a free, cross platform Code Coverage Tool
# Visual Studio code coverage results
# NCrunch
# MightyMoose
# Web workbench (sass)
# Installshield output folder
# DocProject is a documentation generator add-in
# Click-Once directory
# Publish Web Output
# Note: Comment the next line if you want to checkin your web deploy settings,
# but database connection strings (with potential passwords) will be unencrypted
# Microsoft Azure Web App publish settings. Comment the next line if you want to
# checkin your Azure Web App publish settings, but sensitive information contained
# in these scripts will be unencrypted
# NuGet Packages
# NuGet Symbol Packages
# The packages folder can be ignored because of Package Restore
# except build/, which is used as an MSBuild target.
# Uncomment if necessary however generally it will be regenerated when needed
# NuGet v3's project.json files produces more ignorable files
# Microsoft Azure Build Output
# Microsoft Azure Emulator
# Windows Store app package directories and files
# Visual Studio cache files
# files ending in .cache can be ignored
# but keep track of directories ending in .cache
# Others
# Including strong name files can present a security risk
# (https://github.com/github/gitignore/pull/2483#issue-259490424)
# Since there are multiple workflows, uncomment next line to ignore bower_components
# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622)
# RIA/Silverlight projects
# Backup & report files from converting an old project file
# to a newer Visual Studio version. Backup files are not needed,
# because we have git ;-)
# SQL Server files
# Business Intelligence projects
# Microsoft Fakes
# GhostDoc plugin setting file
# Node.js Tools for Visual Studio
# Visual Studio 6 build log
# Visual Studio 6 workspace options file
# Visual Studio 6 auto-generated workspace file (contains which files were open etc.)
# Visual Studio 6 auto-generated project file (contains which files were open etc.)
# Visual Studio 6 workspace and project file (working project files containing files to include in project)
# Visual Studio 6 technical files
# Visual Studio LightSwitch build output
# Paket dependency manager
# FAKE - F# Make
# CodeRush personal settings
# Python Tools for Visual Studio (PTVS)
# Cake - Uncomment if you are using it
# tools/**
# !tools/packages.config
# Tabs Studio
# Telerik's JustMock configuration file
# BizTalk build output
# OpenCover UI analysis results
# Azure Stream Analytics local run output
# MSBuild Binary and Structured Log
# NVidia Nsight GPU debugger configuration file
# MFractors (Xamarin productivity tool) working folder
# Local History for Visual Studio
# Visual Studio History (VSHistory) files
# BeatPulse healthcheck temp database
# Backup folder for Package Reference Convert tool in Visual Studio 2017
# Ionide (cross platform F# VS Code tools) working folder
# Fody - auto-generated XML schema
# VS Code files for those working on multiple tools
# Local History for Visual Studio Code
# Windows Installer files from build outputs
# JetBrains Rider
### VisualStudio Patch ###
# Additional files built by Visual Studio
# End of https://www.toptal.com/developers/gitignore/api/csharp,visualstudio

View file

@ -0,0 +1,151 @@
using System.Collections;
namespace DigitSequence.Test;
public sealed class DigitEnumeratorTests
{
[Fact]
public void Simple()
{
var enumerator = new DigitEnumerator(123);
// we cannot check Current value, because it is - according to the spec - currently in an
// undefined (in the sense of 'any value') state since MoveNext has never been called
enumerator.MoveNext().Should().BeTrue("there are more digits");
enumerator.Current.Should().Be(1, "the first digit is 1");
enumerator.MoveNext().Should().BeTrue("there are still more digits");
enumerator.Current.Should().Be(2, "the second digit is 2");
enumerator.MoveNext().Should().BeTrue("there is one more digit");
enumerator.Current.Should().Be(3, "the third digit is 3");
enumerator.MoveNext().Should().BeFalse("exhausted");
// we cannot check Current value, because it is - according to the spec - now in an
// undefined (in the sense of 'any value') state since MoveNext returned false
}
[Fact]
public void NegativeNumber()
{
var enumerator = new DigitEnumerator(-654);
enumerator.MoveNext().Should().BeTrue("there are more digits");
enumerator.Current.Should().Be(6, "negative number turned into positive");
enumerator.MoveNext().Should().BeTrue();
enumerator.Current.Should().Be(5);
enumerator.MoveNext().Should().BeTrue();
enumerator.Current.Should().Be(4);
enumerator.MoveNext().Should().BeFalse("exhausted");
}
[Fact]
public void SingleDigit()
{
var enumerator = new DigitEnumerator(6);
enumerator.MoveNext().Should().BeTrue("one digit present");
enumerator.Current.Should().Be(6, "the only digit is 6");
enumerator.MoveNext().Should().BeFalse("no more digits");
}
[Fact]
public void SingleDigit_Zero()
{
var enumerator = new DigitEnumerator(0);
enumerator.MoveNext().Should().BeTrue("zero is a valid digit");
enumerator.Current.Should().Be(0, "the only digit is 0");
enumerator.MoveNext().Should().BeFalse("no more digits");
}
[Fact]
public void ContainsZero()
{
var enumerator = new DigitEnumerator(504);
enumerator.MoveNext().Should().BeTrue();
enumerator.Current.Should().Be(5);
enumerator.MoveNext().Should().BeTrue("there are still more digits");
enumerator.Current.Should().Be(0, "zero is a valid digit");
enumerator.MoveNext().Should().BeTrue();
enumerator.Current.Should().Be(4);
enumerator.MoveNext().Should().BeFalse();
}
[Fact]
public void ContainsZero_Multiple()
{
var enumerator = new DigitEnumerator(5004);
enumerator.MoveNext().Should().BeTrue();
enumerator.Current.Should().Be(5);
enumerator.MoveNext().Should().BeTrue();
enumerator.Current.Should().Be(0, "zero is a valid digit");
enumerator.MoveNext().Should().BeTrue();
enumerator.Current.Should().Be(0, "zero is a valid digit");
enumerator.MoveNext().Should().BeTrue();
enumerator.Current.Should().Be(4);
enumerator.MoveNext().Should().BeFalse();
}
[Fact]
public void ContainsZero_Multiple_EndsWith()
{
var enumerator = new DigitEnumerator(500);
enumerator.MoveNext().Should().BeTrue();
enumerator.Current.Should().Be(5);
enumerator.MoveNext().Should().BeTrue();
enumerator.Current.Should().Be(0, "zero is a valid digit");
enumerator.MoveNext().Should().BeTrue();
enumerator.Current.Should().Be(0, "zero is a valid digit");
enumerator.MoveNext().Should().BeFalse();
}
[Fact]
public void Reset()
{
var enumerator = new DigitEnumerator(45678);
enumerator.MoveNext().Should().BeTrue();
enumerator.MoveNext().Should().BeTrue();
enumerator.Current.Should().Be(5);
enumerator.Reset();
enumerator.MoveNext().Should().BeTrue();
enumerator.Current.Should().Be(4);
while (enumerator.MoveNext())
{
// loop to end
}
enumerator.Reset();
for (var i = 0; i < 3; i++)
{
enumerator.MoveNext();
}
(enumerator as IEnumerator).Current.Should().NotBeNull()
.And.BeOfType<int>()
.And.Be(6);
}
}

View file

@ -0,0 +1,37 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<TargetFramework>net9.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
<TreatWarningsAsErrors>true</TreatWarningsAsErrors>
<IsPackable>false</IsPackable>
</PropertyGroup>
<ItemGroup>
<Using Include="FluentAssertions" />
<Using Include="Xunit" />
<Using Include="NSubstitute" />
</ItemGroup>
<ItemGroup>
<PackageReference Include="AwesomeAssertions" Version="8.0.2" />
<PackageReference Include="HTLLeonding.Utility.LeoAnalyzers" Version="1.0.2" />
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.13.0" />
<PackageReference Include="NSubstitute" Version="5.3.0" />
<PackageReference Include="xunit" Version="2.9.3" />
<PackageReference Include="xunit.runner.visualstudio" Version="3.0.2">
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
<PrivateAssets>all</PrivateAssets>
</PackageReference>
<PackageReference Include="coverlet.collector" Version="6.0.4">
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
<PrivateAssets>all</PrivateAssets>
</PackageReference>
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\DigitSequence\DigitSequence.csproj" />
</ItemGroup>
</Project>

View file

@ -0,0 +1,81 @@
using System.Collections;
namespace DigitSequence.Test;
public sealed class DigitsTests
{
[Fact]
public void NegativeValue()
{
var digits = new Digits(-350);
digits.ToString().Should().Be("350", "negative numbers are turned into positive");
}
[Fact]
public void Enumeration()
{
var digits = new Digits(220056010);
int[] digitsArray = [2, 2, 0, 0, 5, 6, 0, 1, 0];
digits.Should<Digits>().BeAssignableTo<IEnumerable<int>>();
var idx = 0;
foreach (int digit in digits)
{
digit.Should().Be(digitsArray[idx++]);
}
IEnumerator<int> enumerator1 = digits.GetEnumerator();
enumerator1.Should().BeOfType<DigitEnumerator>();
enumerator1.Dispose();
var enumerator2 = (digits as IEnumerable).GetEnumerator();
enumerator2.Should()
.NotBeNull()
.And.BeOfType<DigitEnumerator>();
((IDisposable) enumerator2).Dispose();
}
[Fact]
public void Comparison()
{
var a = new Digits(890);
var b = new Digits(891);
var c = new Digits(890);
a.Should<Digits>().BeAssignableTo<IComparable<Digits>>();
a.CompareTo(b).Should().BeLessThan(0);
b.CompareTo(a).Should().BeGreaterThan(0);
a.CompareTo(a).Should().Be(0);
b.CompareTo(b).Should().Be(0);
a.CompareTo(c).Should().Be(0);
c.CompareTo(a).Should().Be(0);
a.CompareTo(null).Should().BeGreaterThan(0);
}
[Theory]
[InlineData(123, "123")]
[InlineData(321, "321")]
[InlineData(-45, "45")]
[InlineData(01, "1")]
[InlineData(10, "10")]
public void StringRepresentation(int number, string expected)
{
var digits = new Digits(number);
digits.ToString().Should().Be(expected);
}
[Fact]
public void GetEnumerator_NotShared()
{
var digits = new Digits(123);
IEnumerator<int> enumerator1 = digits.GetEnumerator();
IEnumerator<int> enumerator2 = digits.GetEnumerator();
enumerator1.Should()
.NotBeSameAs(enumerator2, "for each iteration a new enumerator is created");
enumerator1.Dispose();
enumerator2.Dispose();
}
}

31
DigitSequence.sln Normal file
View file

@ -0,0 +1,31 @@

Microsoft Visual Studio Solution File, Format Version 12.00
# Visual Studio Version 17
VisualStudioVersion = 17.4.33103.184
MinimumVisualStudioVersion = 10.0.40219.1
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "DigitSequence", "DigitSequence\DigitSequence.csproj", "{7F30E637-BAFE-42FA-A173-F42B3902ED3B}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "DigitSequence.Test", "DigitSequence.Test\DigitSequence.Test.csproj", "{161D9B2A-4E8B-43B6-A77E-40BED559521F}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
Release|Any CPU = Release|Any CPU
EndGlobalSection
GlobalSection(ProjectConfigurationPlatforms) = postSolution
{7F30E637-BAFE-42FA-A173-F42B3902ED3B}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{7F30E637-BAFE-42FA-A173-F42B3902ED3B}.Debug|Any CPU.Build.0 = Debug|Any CPU
{7F30E637-BAFE-42FA-A173-F42B3902ED3B}.Release|Any CPU.ActiveCfg = Release|Any CPU
{7F30E637-BAFE-42FA-A173-F42B3902ED3B}.Release|Any CPU.Build.0 = Release|Any CPU
{161D9B2A-4E8B-43B6-A77E-40BED559521F}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{161D9B2A-4E8B-43B6-A77E-40BED559521F}.Debug|Any CPU.Build.0 = Debug|Any CPU
{161D9B2A-4E8B-43B6-A77E-40BED559521F}.Release|Any CPU.ActiveCfg = Release|Any CPU
{161D9B2A-4E8B-43B6-A77E-40BED559521F}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
EndGlobalSection
GlobalSection(ExtensibilityGlobals) = postSolution
SolutionGuid = {D322E690-379C-4802-8F7E-1AC6AD090D59}
EndGlobalSection
EndGlobal

View file

@ -0,0 +1,34 @@
using System.Collections;
namespace DigitSequence;
public sealed class DigitEnumerator : IEnumerator<int>
{
// TODO
//private readonly int _number;
public DigitEnumerator(int number)
{
// TODO
}
public bool MoveNext()
{
// TODO
return false;
}
public void Reset()
{
// TODO
}
public int Current => -1; // TODO
object IEnumerator.Current => null!; // TODO
public void Dispose()
{
// TODO ?
}
}

View file

@ -0,0 +1,15 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<OutputType>Exe</OutputType>
<TargetFramework>net9.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
<TreatWarningsAsErrors>true</TreatWarningsAsErrors>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="HTLLeonding.Utility.LeoAnalyzers" Version="1.0.2" />
</ItemGroup>
</Project>

21
DigitSequence/Digits.cs Normal file
View file

@ -0,0 +1,21 @@
using System.Collections;
namespace DigitSequence;
public sealed class Digits(int number) : IEnumerable<int>, IComparable<Digits>
{
// TODO
//private readonly int _number;
public int CompareTo(Digits? other)
{
// TODO
return -1;
}
public IEnumerator<int> GetEnumerator() => null!; // TODO
IEnumerator IEnumerable.GetEnumerator() => null!; // TODO
public override string ToString() => null!; // TODO
}

5
DigitSequence/Program.cs Normal file
View file

@ -0,0 +1,5 @@
using System.Text;
Console.OutputEncoding = Encoding.UTF8;
Console.WriteLine("*** DigitSequence ***");

115
readme.adoc Normal file
View file

@ -0,0 +1,115 @@
:sectnums:
:nofooter:
:toc: left
:icons: font
:data-uri:
:source-highlighter: highlightjs
:stem:
= Int.01 -- Digits Sequence
A simple, first assignment for implementing interfaces.
We did something very similar together in the workshop, so this exercise should be easy to solve for you.
Your task is to implement a class which takes a number and:
. Allows iteration over its digits => `IEnumerable`
. Can compare two digits => `IComparable`
[plantuml]
----
@startuml
hide empty fields
hide empty methods
class Digits <<sealed>> {
-int _number [readonly]
+Digits(int)
+int CompareTo(Digits?)
+IEnumerator<int> GetEnumerator()
+IEnumerator IEnumerable.GetEnumerator()
+string ToString() [override]
}
class DigitEnumerator <<sealed>> {
-int _number [readonly]
+int Current [readonly]
+object IEnumerator.Current [readonly]
+DigitEnumerator(int)
+bool MoveNext()
+void Reset()
+Dispose()
}
interface IEnumerable<int> {
{abstract} +IEnumerator<int> GetEnumerator()
{abstract} +IEnumerator IEnumerable.GetEnumerator()
}
interface IComparable<Digits> {
{abstract} +int CompareTo(Digits?)
}
interface IEnumeratorNG {
{abstract} +object Current [readonly]
{abstract} +bool MoveNext()
{abstract} +void Reset()
}
note bottom: Actual name is just 'IEnumerator'\n using NG postfix due to PlantUML issue
interface IEnumerator<int> {
{abstract} +int Current [readonly]
}
interface IDisposable {
{abstract} +Dispose()
}
IEnumerable <|-- Digits
IComparable <|-- Digits
IEnumerator <|-- DigitEnumerator
IEnumeratorNG <|-- IEnumerator
IDisposable <|-- IEnumerator
@enduml
----
== Implementation Requirements
=== `DigitEnumerator`
* Implements `IEnumerator<int>`
* Negative numbers are simply converted to positive ones
** e.g. -899 => 899
* _Can_ be reset
* `IEnumerator.Current` should be trivial
* `Dispose`
** Part of the `IDisposable` interface we received transitively
** Used to release resources -- will become very important in the future!
** https://learn.microsoft.com/en-us/dotnet/api/system.idisposable?view=net-9.0[Read through the documentation]
** You should now have realized what you have to implement here in this case 😉
* *Important:*
** Relying on the compiler to generate a state machine will not always be possible (in complex scenarios)
** Also, you have to proof that you can do it yourself
** => Implement the enumerator _without_ using `yield`!
* Implement it _without_ using a string!
* Example: Number 91302 => 9, 1, 3, 0, 2
TIP: Some additional, private fields, properties or maybe even methods might be useful
=== `Digits`
* Implements `IEnumerable<int>` & `IComparable<Digits>`
* Negative numbers are simply converted to positive ones
** Same as for the enumerator
* `CompareTo`
** Create a _clean_ implementation which checks for same and null references _before_ doing the actual comparison
* `GetEnumerator` has to make use of `DigitEnumerator`
* `IEnumerable.GetEnumerator` should be trivial
* `ToString`
** Just for good practice make sure the string output if formatted for the _invariant_ culture
== Tasks
. Complete the implementation according to the specified requirements
. Create the XMLDoc for the application -- _think_ which comments are required and which might already be present
NOTE: Unit tests have been provided with the starter code