Initial commit

This commit is contained in:
github-classroom[bot] 2025-02-25 16:55:29 +00:00 committed by GitHub
commit b9c04768e7
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
15 changed files with 4696 additions and 0 deletions

3553
.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,34 @@
<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" />
</ItemGroup>
<ItemGroup>
<PackageReference Include="AwesomeAssertions" Version="8.0.0" />
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.13.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="..\Employees\Employees.csproj" />
</ItemGroup>
</Project>

View file

@ -0,0 +1,21 @@
namespace Employees.Test;
public sealed class ManagerTests
{
[Fact]
public void Construction()
{
const string Name = "Lisa";
const string Department = "Logistics";
const Gender Gender = Gender.Female;
const decimal BaseSalary = 4500.89M;
var manager = new Manager(Name, Gender, Department, BaseSalary);
manager.Name.Should().Be(Name);
manager.Department.Should().Be(Department);
manager.Gender.Should().Be(Gender);
manager.Salary.Should().Be(5401.068M, "managers earn 20% more");
manager.ToString().Should().Be("My name is Lisa and I'm head of the Logistics department");
}
}

View file

@ -0,0 +1,44 @@
namespace Employees.Test;
public sealed class OfficeEmployeeTests
{
[Fact]
public void Construction_Simple()
{
const string Name = "Mia";
const string Department = "Accounting";
const Gender Gender = Gender.Female;
const decimal Salary = 3211.99M;
var employee = new OfficeEmployee(Name, Gender, Department, Salary);
employee.Name.Should().Be(Name);
employee.Department.Should().Be(Department);
employee.Gender.Should().Be(Gender);
employee.ToString().Should()
.Be("My name is Mia, I identify as female and I work at the department Accounting as an employee");
employee.Salary.Should().Be(Salary);
}
[Theory]
[InlineData("T", "too short, at least two characters")]
[InlineData("lo", "has to start uppercase")]
[InlineData("1g", "first character has to be a letter")]
public void Construction_NameInvalid(string name, string reason)
{
var employee = new OfficeEmployee(name, Gender.Divers, "Canteen", 12.34M);
employee.Name
.Should()
.NotBe(name)
.And.Be("ERROR", reason);
}
[Fact]
public void Construction_InvalidSalary()
{
var employee = new OfficeEmployee("Moritz", Gender.Male, "Sales", -123.45M);
employee.Salary.Should().Be(0M, "invalid value, set to zero");
}
}

View file

@ -0,0 +1,104 @@
namespace Employees.Test;
public sealed class WorkerTests
{
[Fact]
public void Construction_Minimal()
{
const string Name = "Sepp";
const Gender Gender = Gender.Divers;
const string Department = "Sawmill";
var worker = new Worker(Name, Gender, Department);
worker.Name.Should().Be(Name);
worker.Gender.Should().Be(Gender);
worker.Department.Should().Be(Department);
worker.ToString()
.Should().Be("My name is Sepp and I work at the department Sawmill as a worker");
worker.Hours.Should().Be(0D, "no value set yet");
worker.HourlyWage.Should().Be(0M, "no value set yet");
}
[Fact]
public void Construction_Full()
{
const double Hours = 34.5D;
const decimal HourlyWage = 112.68M;
var worker = new Worker("Sepp", Gender.Divers, "Sawmill", Hours, HourlyWage);
worker.ToString()
.Should().Be("My name is Sepp and I work at the department Sawmill as a worker",
"not affected by hours or wage");
worker.Hours.Should().Be(Hours);
worker.HourlyWage.Should().Be(HourlyWage);
}
[Theory]
[InlineData(12.34D, 12.34D, "valid value")]
[InlineData(-12.34D, 0D, "invalid value, set to zero")]
[InlineData(17 * 32D, Worker.MaxMonthlyWorkHours, "too big value, set to max")]
public void Hours(double hours, double expectedHours, string reason)
{
var worker = new Worker("Susi", Gender.Divers, "Lasercutting",
hours, 0M);
worker.Hours.Should().Be(expectedHours, reason);
worker.Hours = hours;
worker.Hours.Should().Be(expectedHours, reason);
}
[Theory]
[MemberData(nameof(HourlyWageData))]
public void HourlyWage(decimal hourlyWage, decimal expectedWage, string reason)
{
var worker = new Worker("Susi", Gender.Divers, "Lasercutting",
0D, hourlyWage);
worker.HourlyWage.Should().Be(expectedWage, reason);
worker.HourlyWage = hourlyWage;
worker.HourlyWage.Should().Be(expectedWage, reason);
}
[Theory]
[MemberData(nameof(SalaryData))]
public void Salary(double hours, decimal hourlyWage, decimal expectedSalary, string reason)
{
var worker = new Worker("Susi", Gender.Divers, "Lasercutting")
{
Hours = hours,
HourlyWage = hourlyWage
};
worker.Salary.Should().Be(expectedSalary, reason);
}
[Fact]
public void StringRepresentation()
{
var worker1 = new Worker("Sepp", Gender.Male, "Sawmill");
var worker2 = new Worker("Susi", Gender.Female, "Welding");
worker1.ToString()
.Should().Be("My name is Sepp, I identify as male and I work at the department Sawmill as a worker");
worker2.ToString()
.Should().Be("My name is Susi, I identify as female and I work at the department Welding as a worker");
}
public static TheoryData<decimal, decimal, string> HourlyWageData =>
new()
{
{ 98.79M, 98.79M, "valid value" },
{ -19.99M, 0M, "invalid value, set to zero" }
};
public static TheoryData<double, decimal, decimal, string> SalaryData =>
new()
{
{ 8.5D * 20, 25.29M, 4299.30M, "valid values" },
{ -4D * 30, 10M, 0M, "invalid hours, set to zero so total salary is zero" },
{ 20D * 30, 10M, 4960M, "too many hours, set to max allowed" },
{ 160D, -12M, 0M, "invalid hourly wage, set to zero so total salary is zero" }
};
}

31
Employees.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}") = "Employees", "Employees\Employees.csproj", "{7F30E637-BAFE-42FA-A173-F42B3902ED3B}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Employees.Test", "Employees.Test\Employees.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

70
Employees/Employee.cs Normal file
View file

@ -0,0 +1,70 @@
namespace Employees;
/// <summary>
/// Represents an employee of a company
/// </summary>
public abstract class Employee
{
private readonly string _name = null!;
/// <summary>
/// Creates a new employee
/// </summary>
/// <param name="name">Name of the employee</param>
/// <param name="gender">Gender of the employee</param>
/// <param name="department">Department the employee works at</param>
protected Employee(string name, Gender gender, string department)
{
Name = string.Empty;
Gender = Gender.Divers;
Department = string.Empty;
// TODO
}
/// <summary>
/// Gets the name of the employee
/// </summary>
public string Name
{
get => _name;
private init
{
// TODO
}
}
/// <summary>
/// Gets the department of the employee
/// </summary>
public string Department { get; }
/// <summary>
/// Gets the gender of the employee
/// </summary>
public Gender Gender { get; }
/// <summary>
/// Gets the salary of the employee
/// </summary>
public abstract decimal Salary { get; }
/// <summary>
/// Creates a string representation of the employee with some basic information
/// </summary>
/// <returns>String representation of the employee</returns>
public override string ToString()
{
// TODO
return string.Empty;
}
}
/// <summary>
/// Represents the possible genders for an employee
/// </summary>
public enum Gender
{
Male,
Female,
Divers
}

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>

25
Employees/Manager.cs Normal file
View file

@ -0,0 +1,25 @@
namespace Employees;
/// <summary>
/// Represents an employee who is manager of a department
/// </summary>
/// <inheritdoc cref="OfficeEmployee" />
public sealed class Manager : OfficeEmployee
{
/// <summary>
/// Creates a new manager
/// </summary>
/// <param name="name">Name of the manager</param>
/// <param name="gender">Gender of the manager</param>
/// <param name="department">Department of the manager</param>
/// <param name="monthlySalary">Monthly base salary of the manager</param>
public Manager(string name, Gender gender, string department,
decimal monthlySalary) : base(name, gender, department, monthlySalary) { }
/// <summary>
/// Gets the actual salary for the manger, which is higher than the base salary
/// </summary>
public override decimal Salary => -1M; // TODO
public override string ToString() => string.Empty; // TODO
}

View file

@ -0,0 +1,25 @@
namespace Employees;
/// <summary>
/// Represents an employee who works at an office
/// </summary>
/// <inheritdoc cref="Employee" />
public class OfficeEmployee : Employee
{
/// <summary>
/// Creates a new employee who works at an office
/// </summary>
/// <param name="name">Name of the employee</param>
/// <param name="gender">Gender of the employee</param>
/// <param name="department">Department of the employee</param>
/// <param name="monthlySalary">Monthly salary of the employee; cannot be negative</param>
public OfficeEmployee(string name, Gender gender, string department,
decimal monthlySalary) : base(name, gender, department)
{
// TODO
}
public override decimal Salary { get; }
public override string ToString() => string.Empty; // TODO
}

18
Employees/Program.cs Normal file
View file

@ -0,0 +1,18 @@
using System.Text;
using Employees;
Console.OutputEncoding = Encoding.UTF8;
Console.WriteLine("*** Employees ***");
const string Department = "Development";
var employee1 = new Manager("Hermann", Gender.Male, Department, 3800M);
var employee2 = new OfficeEmployee("Maria", Gender.Female, Department, 3800M);
var employee3 = new Worker("Alex", Gender.Divers, Department, 38.5D * 4, 18.40M);
List<Employee> employees = [employee1, employee2, employee3];
foreach (var employee in employees)
{
Console.WriteLine(employee);
}

63
Employees/Worker.cs Normal file
View file

@ -0,0 +1,63 @@
namespace Employees;
/// <summary>
/// Represents an employee who performs physical labor
/// </summary>
public sealed class Worker : Employee
{
/// <summary>
/// The absolute maximum of hours worked per month
/// </summary>
public const int MaxMonthlyWorkHours = 16 * 31;
private decimal _hourlyWage;
private double _hours;
/// <summary>
/// Creates a new worker.
/// Working hours and hourly wage has to be set additionally for meaningful function.
/// </summary>
/// <param name="name">Name of the worker</param>
/// <param name="gender">Gender of the worker</param>
/// <param name="department">Department the worker works at</param>
public Worker(string name, Gender gender, string department)
: base(name, gender, department) { }
/// <summary>
/// Creates a new worker
/// </summary>
/// <param name="name">Name of the worker</param>
/// <param name="gender">Gender of the worker</param>
/// <param name="department">Department the worker works at</param>
/// <param name="hours">Hours worked per month</param>
/// <param name="hourlyWage">Wage per hour worked</param>
public Worker(string name, Gender gender, string department, double hours, decimal hourlyWage)
: this(name, gender, department)
{
// TODO
}
/// <summary>
/// Gets or sets the monthly worked hours.
/// Cannot be negative or exceed <see cref="MaxMonthlyWorkHours" />.
/// </summary>
public double Hours
{
get => _hours;
set => _hours = -1D; // TODO
}
/// <summary>
/// Gets or sets the wage per hour worked.
/// Cannot be negative.
/// </summary>
public decimal HourlyWage
{
get => _hourlyWage;
set => _hourlyWage = -1M; // TODO
}
public override decimal Salary => -1M; // TODO
public override string ToString() => string.Empty; // TODO
}

BIN
pics/sample_run.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB

110
readme.adoc Normal file
View file

@ -0,0 +1,110 @@
:sectnums:
:nofooter:
:toc: left
:icons: font
:data-uri:
:source-highlighter: highlightjs
:stem: latexmath
= Inh.01 -- Employees
You are going to represent the various employees of a company:
* Workers
* Office employees
** Some are managers
IMPORTANT: This is a rather short assignment -- you are expected to read & understand the code carefully and reflect on how good your understanding of inheritance already is
== Class Descriptions
=== `Employee`
All employees have _common_ properties:
* Name
** Requirements:
*** At least two characters
*** First character is a letter (not a digit) _and_ is uppercase
** If invalid set to 'ERROR'
* Gender
* Department
* Salary
* Can represent themselves as a `string`
But nobody is _just_ an employee => everyone is either a `Worker`, `OfficeEmployee` or `Manager`, so there are _no_ instances of `Employee`.
==== String Representation
* Contains the name and the department the employee works at
* If gender is either male or female this information is added, but omitted for those employees who identify as divers
* Examples:
** `My name is Mia, I identify as female and I work at the department Accounting`
** `My name is Steph and I work at the department Marketing`
=== `Worker`
A worker is an employee which performs physical labor.
* They work a certain amount of hours each month
** This value cannot exceed 16 hours for 31 days a month and can also not be negative
*** Try to use https://learn.microsoft.com/en-us/dotnet/api/system.math.clamp?view=net-7.0[Math.Clamp] here
** You may ignore that months are usually shorter and that people have free weekends
* They get paid a certain amount per hour
** Which cannot be negative either
* Their salary is calculated by multiplying the hours worked by the wage per hour
* The string representation is extended by adding 'as a worker'
** Example: `My name is Max, I identify as male and I work at the department Welding as a worker`
** Do _not_ duplicate the basic part!
TIP: One constructor calls the `base` constructor, but the other one calls another _class_ constructor -- make sure you understand the difference and how the `base` constructor will eventually be called in both cases
=== `OfficeEmployee`
Some employees work at an office.
* An office clerk has a fixed salary per month
** Which cannot be negative
* The string representation is extended by adding 'as an employee'
==== `Manager`
A manager is the head of a department.
* Managers also work at an office
* They have a fixed salary per month, just like regular office employees, but that is increased by 20% to determine their actual salary
** Try to implement this using `base.Salary`
* The string representation is _changed_:
** Does not include gender information
** Example: `My name is Anna and I'm head of the Sales department`
== Tasks
* Try to create the class diagram _before_ looking at the provided starter code
** You need to learn how to turn a pure, textual description of a scenario into a class diagram and then into code => making it easier for yourself by cheating now will make it harder later on
* It is perfectly fine to _revise_ your diagram once you looked at the code and realized you had chosen an incorrect visibility modifier or data type,...
** You'll learn quite a lot about how to make these decisions by actively comparing my choices with the ones you made and trying to figure out how we reached different (or similar) conclusions
=== Class Diagram
* Your first task is to create a UML _class diagram_ for this application.
* Use https://plantuml.com/class-diagram[PlantUML] for this job
* Make sure to use the correct _visibility_ modifiers
* Include all _relationships_
** e.g. 'is a',...
=== Implementation
* Business as usual:
** Implement the application
** Unit Tests have been provided
* Take a detailed look at the provided XMLDoc: what could `<inheritdoc cref="..." />` mean and why do we suddenly need this tag now?
** Internet search is allowed 😉
NOTE: Make sure to carefully check which classes are `abstract` or `sealed` and how the inheritance structure is represented in code -- you'll have to do that by yourself soon
==== Sample Run
Take a look at `Program.cs`: _why_ do we get different outputs despite operating on a `List<Employee>` which only contains objects of type `Employee`?
image::pics/sample_run.png[Sample Run]