Initial commit

This commit is contained in:
github-classroom[bot] 2024-10-06 09:57:56 +00:00 committed by GitHub
commit b09e151301
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
8 changed files with 4462 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

25
Pupils.sln Normal file
View file

@ -0,0 +1,25 @@

Microsoft Visual Studio Solution File, Format Version 12.00
# Visual Studio Version 17
VisualStudioVersion = 17.0.32126.317
MinimumVisualStudioVersion = 10.0.40219.1
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Pupils", "Pupils\Pupils.csproj", "{F687519F-3209-44B6-81BF-DDD2466FEEF2}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
Release|Any CPU = Release|Any CPU
EndGlobalSection
GlobalSection(ProjectConfigurationPlatforms) = postSolution
{F687519F-3209-44B6-81BF-DDD2466FEEF2}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{F687519F-3209-44B6-81BF-DDD2466FEEF2}.Debug|Any CPU.Build.0 = Debug|Any CPU
{F687519F-3209-44B6-81BF-DDD2466FEEF2}.Release|Any CPU.ActiveCfg = Release|Any CPU
{F687519F-3209-44B6-81BF-DDD2466FEEF2}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
EndGlobalSection
GlobalSection(ExtensibilityGlobals) = postSolution
SolutionGuid = {B7BD828E-2CBE-4D53-BA50-CC9536773BE0}
EndGlobalSection
EndGlobal

8
Pupils/Model.cs Normal file
View file

@ -0,0 +1,8 @@
namespace Pupils;
public enum AgeType
{
VotingAge,
FullAge,
RetirementAge
}

98
Pupils/Program.cs Normal file
View file

@ -0,0 +1,98 @@
using Pupils;
Console.WriteLine("*** Pupils ***");
var baseYear = DateTime.Now.Year;
var p1 = new Pupil("Horst", "Fuchs",
new DateOnly(baseYear - 72, 04, 17));
var p2 = new Pupil("Susi", "Sorglos",
new DateOnly(baseYear - 15, 11, 08));
var p3 = new Pupil("Max", "Muster",
new DateOnly(baseYear - 16, 08, 30));
var p4 = new Pupil("Petra", "Programmierer",
new DateOnly(baseYear - 51, 11, 08));
p1.ZipCode = 4060;
p2.ZipCode = 4020;
p3.ZipCode = 688;
p4.ZipCode = 5020;
PrintNextSection("Overview");
foreach (var pupil in new[] { p1, p2, p3, p4 })
{
PrintPupilInformation(pupil);
}
PrintNextSection("Age Checks 1");
AgeCheck(p1, AgeType.RetirementAge);
AgeCheck(p2, AgeType.VotingAge);
AgeCheck(p3, AgeType.VotingAge);
AgeCheck(p3, AgeType.FullAge);
AgeCheck(p4, AgeType.FullAge);
AgeCheck(p4, AgeType.RetirementAge);
PrintNextSection("Age Checks 2");
AgeComparison(p1, p2);
AgeComparison(p2, p3);
AgeComparison(p3, p4);
AgeComparison(p4, p1);
PrintNextSection("Location Checks");
LocationComparison(p1, p2);
LocationComparison(p2, p3);
LocationComparison(p3, p4);
LocationComparison(p4, p1);
#region utility methods
void PrintNextSection(string section)
{
Console.WriteLine($"{Environment.NewLine}{section}");
}
void PrintPupilInformation(Pupil pupil)
{
Console.WriteLine($"[#{pupil.Id}] {pupil.FirstName} " +
$"{pupil.LastName} | Age = {pupil.Age}");
}
void AgeCheck(Pupil pupil, AgeType type)
{
var fulfilled = $"{(pupil.IsOfAge(type) ? "has" : "has not")} fulfilled";
Console.WriteLine($"Pupil {pupil.FirstName} {fulfilled} the requirements for {type}");
}
void AgeComparison(Pupil some, Pupil other)
{
// note: we are ignoring pupils of equal age here
if (some.IsOlderThan(other))
{
PrintOlder(some, other);
return;
}
PrintOlder(other, some);
return;
void PrintOlder(Pupil older, Pupil younger)
{
Console.WriteLine($"{older.FirstName} is older than {younger.FirstName}");
}
}
void LocationComparison(Pupil some, Pupil other)
{
if (some.LivesNearby(other))
{
Console.WriteLine($"{some.FirstName} lives near {other.FirstName}");
return;
}
Console.WriteLine($"{some.FirstName} and {other.FirstName} live some way apart");
}
#endregion

11
Pupils/Pupils.csproj Normal file
View file

@ -0,0 +1,11 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<OutputType>Exe</OutputType>
<TargetFramework>net8.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
<TreatWarningsAsErrors>true</TreatWarningsAsErrors>
</PropertyGroup>
</Project>

BIN
pics/sample_run.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 38 KiB

186
readme.adoc Normal file
View file

@ -0,0 +1,186 @@
:sectnums:
:nofooter:
:toc: left
:icons: font
:data-uri:
:stem: latexmath
:source-highlighter: highlightjs
= OOB.01 -- Pupils
Your goal is to implement a `class` which represents a pupil.
Take a look at the following _class diagram_.
[plantuml]
----
@startuml
hide empty methods
class Pupil {
{static} -int _nextId
-DateOnly _dateOfBirth [readonly]
-int? _zipCode
+Pupil(string, string, DateOnly)
+int Age [readonly]
+string FirstName [readonly]
+int Id [readonly]
+string LastName [readonly]
+int? ZipCode
+bool IsOfAge(AgeType)
+bool IsOlderThan(Pupil)
+bool LivesNearby(Pupil)
}
enum AgeType {
VotingAge,
FullAge,
RetirementAge
}
@enduml
----
We will create several _instances_ of the `Pupil` class.
With those we perform some checks and comparisons, e.g. is one person older than the other or who lives nearby.
WARNING: _This_ time you have been provided with a detailed description of all class _members_. In future assignments you'll have to rely on the class diagram and the general task description only.
== Members
[cols="2,1,1,1,1,4"]
|===
|Name |DataType |Nullable |Static |Readonly |Description
|_nextId
|int
|false
|true
|false
a|
* Shared between all instances of the class
* Supplies the next free (incremented) id
** Which is assigned in the _constructor_
|_dateOfBirth
|DateOnly
|false
|false
|true
|The date of birth of the person
|_zipCode
|int
|true
|false
|false
a|
* Backing field for the `ZipCode` property
* Could be omitted in a class diagram, because implementation detail
|Age
|int
|false
|false
|true
|A _computed_ property which returns the current age in years based on the date of birth
|FirstName
|string
|false
|false
|true
|_Getter_ for retrieving the first name of a person
|Id
|int
|false
|false
|true
|_Getter_ for retrieving the unique id of a person
|LastName
|string
|false
|false
|true
|_Getter_ for retrieving the last name of a person
|ZipCode
|int
|true
|false
|false
a|
* Property for the ZIP Code of the pupil's living address
* *Constrained to the stem:[1000 \le x \le 9999] range*
** _Ignore_ invalid values
|===
Do _not_ forget the *visibility*! Some members are private, others public.
In the diagram above private is indicated as a red square and public as a green circle.
== Operations
[cols="1,2,3,5"]
|===
|Name |Input |Output |Description
|`IsOfAge`
|A single `AgeType` value
|A flag indicating if the pupil fulfills the age requirement
a|
* Checks if the age of the pupil _instance_ is high enough to satisfy the requirement of the `AgeType` value passed as parameter
* Thresholds:
** VotingAge = 16
** FullAge = 18
** RetirementAge = 65
|`IsOlderThan`
|A single `Pupil` reference
|A flag indicating if the one pupil is older than the other
|Checks if the `Pupil` _instance_ on which the method has been called is older than the `Pupil` instance passed as parameter
|`LivesNearby`
|A single `Pupil` reference
|A flag indicating if two pupils live near each other
a|
* Compares the ZIP codes of both pupils
** One from the current instance, the other from the passed instance
* If the first two digits match they live near each other
** Examples:
*** 4060 & 4030 => live nearby
*** 4060 & 1010 => don't live nearby
** If one or both pupils don't have a ZIP set (`null`) this method returns false
|===
TIP: Make sure you understand the difference between _value_ & _reference_ parameters! +
If you aren't confident read it up again, this should be clear by now.
== Impl. Requirements for `Pupil`
You have to create and implement the `Pupil` `class` yourself.
Thus, it is not already given in the starter code.
. Create the `class` and implement it (= add members and methods) as described above
** The usual requirements for _good_ & _clean_ code apply of course
. Create unit tests to test all your _public_ methods
** At least one 'happy path' test plus the major edge cases
. Write the XMLDoc for (at least) all your public methods and properties as well as for the `class`
== `Program` & Sample Run
CAUTION: The existence of the `Pupil` `class` (e.g. constructor, properties,...) is _required_ for the business logic to execute => the application will _not_ compile until you have completed `Pupil`. +
If you want to unit test your individual parts (https://en.wikipedia.org/wiki/Test-driven_development[TDD]) you can comment out parts of `Program` to allow your solution to compile.
The main `Program` has already been provided with the starter code.
It performs the following actions:
. It creates several `Pupil` instances
. It sets (valid & invalid) ZIP codes
. It performs several age checks
. It compares the ages of some pupils
. It checks if some pupils live each other
The results are printed to the terminal and should look like this:
image::pics/sample_run.png[Sample Run]