From 7a4f707f390d6a965389563cb019224a7da80cfa Mon Sep 17 00:00:00 2001 From: Eero Holmala Date: Tue, 23 Jan 2024 13:32:30 +0200 Subject: [PATCH] Added basic argument parser. Started some class stubs for reading and storing data. Also added README. --- .gitignore | 484 ++++++++++++++++++++++++++++++++++++++++++++++ ArgParser.cs | 25 +++ DataProvider.cs | 21 ++ Fabricator.cs | 105 ++++++++++ IDataSource.cs | 6 + Program.cs | 10 + README.md | 41 ++++ fabricator.csproj | 10 + 8 files changed, 702 insertions(+) create mode 100644 .gitignore create mode 100644 ArgParser.cs create mode 100644 DataProvider.cs create mode 100644 Fabricator.cs create mode 100644 IDataSource.cs create mode 100644 Program.cs create mode 100644 README.md create mode 100644 fabricator.csproj diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..104b544 --- /dev/null +++ b/.gitignore @@ -0,0 +1,484 @@ +## Ignore Visual Studio temporary files, build results, and +## files generated by popular Visual Studio add-ons. +## +## Get latest from `dotnet new gitignore` + +# dotenv files +.env + +# 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 +project.lock.json +project.fragment.lock.json +artifacts/ + +# Tye +.tye/ + +# 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 +*.ncb +*.aps + +# 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 +.idea + +## +## Visual studio for Mac +## + + +# globs +Makefile.in +*.userprefs +*.usertasks +config.make +config.status +aclocal.m4 +install-sh +autom4te.cache/ +*.tar.gz +tarballs/ +test-results/ + +# Mac bundle stuff +*.dmg +*.app + +# content below from: https://github.com/github/gitignore/blob/master/Global/macOS.gitignore +# General +.DS_Store +.AppleDouble +.LSOverride + +# Icon must end with two \r +Icon + + +# Thumbnails +._* + +# Files that might appear in the root of a volume +.DocumentRevisions-V100 +.fseventsd +.Spotlight-V100 +.TemporaryItems +.Trashes +.VolumeIcon.icns +.com.apple.timemachine.donotpresent + +# Directories potentially created on remote AFP share +.AppleDB +.AppleDesktop +Network Trash Folder +Temporary Items +.apdisk + +# content below from: https://github.com/github/gitignore/blob/master/Global/Windows.gitignore +# Windows thumbnail cache files +Thumbs.db +ehthumbs.db +ehthumbs_vista.db + +# Dump file +*.stackdump + +# Folder config file +[Dd]esktop.ini + +# Recycle Bin used on file shares +$RECYCLE.BIN/ + +# Windows Installer files +*.cab +*.msi +*.msix +*.msm +*.msp + +# Windows shortcuts +*.lnk + +# Vim temporary swap files +*.swp diff --git a/ArgParser.cs b/ArgParser.cs new file mode 100644 index 0000000..70a980b --- /dev/null +++ b/ArgParser.cs @@ -0,0 +1,25 @@ +using System.Collections; + +namespace Fab; + +public class ArgParser +{ + + public static FabricatorOptions Parse(string[] args) + { + string command = args[0]; + string data = ""; + Dictionary options = new Dictionary(); + + for(int i = 1; i < args.Length-1;++i) + { + if(args[i].StartsWith("-")) + { + options.Add(args[i],args[i+1]); + } + } + data = args[args.Length-1]; + + return new FabricatorOptions(command, options, data); + } +} \ No newline at end of file diff --git a/DataProvider.cs b/DataProvider.cs new file mode 100644 index 0000000..3e88b72 --- /dev/null +++ b/DataProvider.cs @@ -0,0 +1,21 @@ +namespace Fab; + +public abstract class DataProvider +{ + + private IDataSource? Source { get; set; } + + public DataStore? Store { get; set; } + + public DataProvider(IDataSource? Source) + { + this.Source = Source ?? throw new Exception("No valid data source provided."); + this.Store = Source.ToStore(); + } + + +} + +public class DataStore +{ +} \ No newline at end of file diff --git a/Fabricator.cs b/Fabricator.cs new file mode 100644 index 0000000..b14b67a --- /dev/null +++ b/Fabricator.cs @@ -0,0 +1,105 @@ +namespace Fab; +public class Fabricator +{ + public Fabricator(FabricatorOptions options) + { + System.Console.WriteLine("Command: "+ options.Command); + System.Console.WriteLine("Number: "+ options.Number); + System.Console.Write("Data:\n\t"); + foreach (var datatype in options.Data) + { + System.Console.Write(datatype+" "); + } + System.Console.WriteLine(); + System.Console.WriteLine("File Name: "+ options.FileName); + System.Console.WriteLine("File Format: "+ options.FileFormat); + System.Console.Write("Headers:\n\t"); + foreach (var header in options.Headers) + { + System.Console.Write(header+" "); + } + System.Console.WriteLine(); + System.Console.WriteLine(Environment.GetFolderPath(Environment.SpecialFolder.UserProfile)); + + } +} + +public class FabricatorOptions +{ + + public int Number { get; set; } = 1; + public string Command { get; set; } = ""; + public string FileFormat { get; set; } = "stdout"; + public string FileName { get; set; } = ""; + public string[] Headers { get; set; } = []; + public string[] Data { get; set; } = []; + private readonly string[] AcceptedCommands = { + "gen" + }; + + public FabricatorOptions(string Command, Dictionary options, string data) + { + if(!AcceptedCommands.Contains(Command)){ + //TODO(Eero): Print help page instead. + throw new Exception($"Invalid command: \"{Command}\"."); + } + this.Command = Command; + ParseOptions(options); + Data = ParseData(data); + if(Headers.Length == 0) + ParseDefaultHeaders(); + } + + private void ParseDefaultHeaders() + { + List headerList = new List(); + foreach (var dataType in Data) + { + switch (dataType) + { + case "name": + headerList.Add("Name"); + break; + case "phone": + headerList.Add("PhoneNumber"); + break; + case "address": + headerList.Add("Address"); + break; + default: + throw new Exception($"Invalid data type for data \"{dataType}\""); + } + } + Headers = headerList.ToArray(); + } + + private string[] ParseData(string data) + { + //TODO(Eero): Parse by supported data type + return data.Split(":").ToArray(); + } + + private void ParseOptions(Dictionary options) + { + foreach (var (key, value) in options) + { + switch (key) + { + case "-n": + Number = int.Parse(value); + break; + case "-f": + FileFormat = value.ToLower(); + break; + case "-o": + FileName = value.Trim(); + break; + case "-h": + Headers = value.Split(":").ToArray(); + break; + default: + throw new Exception($"Invalid option \"{key}\"."); + } + } + } +} \ No newline at end of file diff --git a/IDataSource.cs b/IDataSource.cs new file mode 100644 index 0000000..6636d83 --- /dev/null +++ b/IDataSource.cs @@ -0,0 +1,6 @@ +namespace Fab; + +public interface IDataSource +{ + DataStore? ToStore(); +} \ No newline at end of file diff --git a/Program.cs b/Program.cs new file mode 100644 index 0000000..d020b36 --- /dev/null +++ b/Program.cs @@ -0,0 +1,10 @@ +using Fab; + +public class Program +{ + public static void Main(string[] args) + { + var options = ArgParser.Parse(args); + new Fabricator(options); + } +} \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..6c33b0b --- /dev/null +++ b/README.md @@ -0,0 +1,41 @@ +# Fabricator + +## Summary +Fabricator is a data generation tool for myself, but might be useful for others too. This is mainly practice for object oriented programming and I won't attempt to refactor this to anything else. + +## Features + +* [ ] Generate Names +* [ ] Generate Phone +* [ ] Generate Addresses +* [ ] Output to different file formats: + * [ ] CSV + * [ ] JSON + * [ ] XML + * [ ] YAML + * [ ] TOML +* [ ] Cross platform: + * [ ] Windows + * [ ] MacOS + * [ ] Linux + +## Usage + +Basic usage: +```sh +$ fab gen -n 10 -f csv -o output.csv name:phone:address +``` +This will output a CSV file named 'output.csv' with 10 rows randomly of generated data for names, phone numbers and addresses. + +## Building +For debug build run +```sh +dotnet build +``` +Running the tool directly with dotnet i.e. +```sh +dotnet run -- gen -n 10 -f csv -o output.csv name:phone:address +``` + +## Licensing +MIT License \ No newline at end of file diff --git a/fabricator.csproj b/fabricator.csproj new file mode 100644 index 0000000..2150e37 --- /dev/null +++ b/fabricator.csproj @@ -0,0 +1,10 @@ + + + + Exe + net8.0 + enable + enable + + +