Commit f3069103 authored by Tim Bureck's avatar Tim Bureck

Initial commit

Features
* Simple Application class as the entry point into a terminal application
* Abstract Command class that can be extend and configure itself to accept arguments/options
* Arguments/options framework in order to define and validate command line arguments and options
parents
Pipeline #1 canceled with stages
# Jetbrains IDEs
.idea/
# Created by .ignore support plugin (hsz.mobi)
### VisualStudio template
## 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/master/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/
[Aa][Rr][Mm]/
[Aa][Rr][Mm]64/
bld/
[Bb]in/
[Oo]bj/
[Ll]og/
# 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/
# 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
*.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
# JustCode is a .NET coding add-in
.JustCode
# TeamCity is a build add-in
_TeamCity*
# DotCover is a Code Coverage Tool
*.dotCover
# AxoCover is a Code Coverage Tool
.axoCover/*
!.axoCover/settings.json
# 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 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/
# BeatPulse healthcheck temp database
healthchecksdb
# Backup folder for Package Reference Convert tool in Visual Studio 2017
MigrationBackup/
using System;
using System.Collections.Generic;
using System.Linq;
using TBureck.Terminal.Commands;
using TBureck.Terminal.IO;
namespace TBureck.Terminal
{
public class Application : ICommandContainer
{
public IList<ICommand> Commands { get; }
public Application()
{
this.Commands = new List<ICommand>();
this.Add(new ListCommand(this));
}
public void Add(ICommand command)
{
this.Commands.Add(command);
}
protected virtual ICommand FindCommand(string commandName)
{
ICommand command = this.Commands.FirstOrDefault(c => c.Name == commandName);
if (command == null) {
throw new CommandNotFoundException(commandName);
}
return command;
}
public int Run()
{
return this.Run(new List<string>());
}
public int Run(IList<string> args, IInput input = null, IOutput output = null)
{
if (output == null) {
output = new ConsoleOutput();
}
if (args.Count == 0) {
return 1;
}
if (input == null) {
input = ArgsInput.Of(args.Skip(1).ToList());
}
int exitCode;
try {
// Treat first argument as the command name:
string commandName = args.FirstOrDefault();
ICommand command = this.FindCommand(commandName);
exitCode = command.Execute(input, output);
} catch (Exception e) {
output.WriteLine(e.Message);
exitCode = 1;
}
return exitCode;
}
}
}
\ No newline at end of file
using TBureck.Terminal.IO;
namespace TBureck.Terminal.Commands
{
public class Command : ICommand
{
public string Name { get; protected set; }
public string Description { get; protected set; }
public InputDefinition InputDefinition { get; }
protected Command()
{
this.InputDefinition = new InputDefinition();
// This call of a virtual method is fine, because child classes are supposed to have the chance to
// change their configuration at this place.
// ReSharper disable once VirtualMemberCallInConstructor
this.Configure();
}
public virtual void Configure() { }
public virtual int Execute(IInput input, IOutput output)
{
return 0;
}
protected void AddArgument(
string name,
InputArgumentMode mode = InputArgumentMode.Optional,
string description = "",
string @default = null
) {
this.InputDefinition.AddArgument(InputArgument.Of(name, mode, description, @default));
}
protected void AddOption(
string name,
string shortcut = null,
InputOptionMode mode = InputOptionMode.NoValue,
string description = "",
string @default = null
) {
this.InputDefinition.AddOption(InputOption.Of(name, shortcut, mode, description, @default));
}
}
}
\ No newline at end of file
using System;
namespace TBureck.Terminal.Commands
{
public class CommandNotFoundException : Exception
{
public CommandNotFoundException(string commandName) : base($"Command \"{commandName}\" could not be found.")
{
}
}
}
\ No newline at end of file
using TBureck.Terminal.IO;
namespace TBureck.Terminal.Commands
{
public interface ICommand
{
string Name { get; }
string Description { get; }
InputDefinition InputDefinition { get; }
void Configure();
int Execute(IInput input, IOutput output);
}
}
\ No newline at end of file
using System.Collections.Generic;
namespace TBureck.Terminal.Commands
{
public interface ICommandContainer
{
IList<ICommand> Commands { get; }
}
}
\ No newline at end of file
using System.Collections.Generic;
using TBureck.Terminal.IO;
namespace TBureck.Terminal.Commands
{
public class ListCommand : Command
{
private readonly ICommandContainer _commandContainer;
public ListCommand(ICommandContainer commandContainer)
{
this._commandContainer = commandContainer;
}
public override void Configure()
{
this.Name = "list";
this.Description = "Lists all available commands";
}
public void Execute(IInput input, IOutput output)
{
output.WriteLine("Available commands:");
foreach (ICommand command in this._commandContainer.Commands) {
output.WriteLine($"\t{command.Name}\t\t\t{command.Description}");
}
output.WriteLine($"\t{this.Name}\t\t\t{this.Description}");
}
}
}
\ No newline at end of file
using System;
using System.Collections.Generic;
using System.Linq;
namespace TBureck.Terminal.IO
{
public class ArgsInput : IInput
{
private readonly IList<string> _unparsedArgs;
public IDictionary<string, string> Arguments { get; }
public IDictionary<string, string> Options { get; }
private InputDefinition InputDefinition { get; set; }
private ArgsInput(IList<string> args)
{
this.Arguments = new Dictionary<string, string>();
this.Options = new Dictionary<string, string>();
this._unparsedArgs = args;
}
public void Bind(InputDefinition inputDefinition)
{
this.Arguments.Clear();
this.Options.Clear();
this.InputDefinition = inputDefinition;
this.ParseArgs(this._unparsedArgs);
}
private void ParseArgs(IList<string> args)
{
if (args.Count == 0) {
return;
}
int supportedArguments = this.InputDefinition.ArgumentCount;
int givenArgumentCount = 0;
for (int i = 0; i < args.Count; i++) {
if (args[i].StartsWith("-")) {
InputOption option = args[i].StartsWith("--")
? this.InputDefinition.GetOption(args[i].Substring(2))
: this.InputDefinition.GetOptionForShortcut(args[i].Substring(1));
if (this.ParseOption(option, args.ElementAtOrDefault(i + 1))) {
i += 1;
}
} else {
if (givenArgumentCount >= supportedArguments) {
throw new ArgumentException($"Command does not support {supportedArguments + 1} arguments. Please check your input from \"{args[i]}\".");
}
InputArgument argument = this.InputDefinition.Arguments[givenArgumentCount];
this.Arguments[argument.Name] = args[i];
givenArgumentCount++;
}
}
}
/// <summary>
/// This method will parse an option. It returns true, if the given option reads a value.
/// </summary>
/// <param name="option">The InputOption definition of the option to parse.</param>
/// <param name="possibleValue">The following token representing the possible value of this option.</param>
/// <returns>true, if the value was used. false otherwise.</returns>
private bool ParseOption(InputOption option, string possibleValue)
{
if (option.AcceptsValue) {
this.Options[option.Name] = possibleValue;
return true;
}
this.Options[option.Name] = null;
return false;
}
public static ArgsInput Of(IList<string> args)
{
return new ArgsInput(args);
}
}
}
\ No newline at end of file
using System;
namespace TBureck.Terminal.IO
{
public class ConsoleOutput : IOutput
{
public void WriteLine(string output)
{
Console.WriteLine(output);
}
}
}
\ No newline at end of file
using System.Collections.Generic;
namespace TBureck.Terminal.IO
{
public interface IInput
{
IDictionary<string, string> Arguments { get; }
IDictionary<string, string> Options { get; }
}
}
\ No newline at end of file
namespace TBureck.Terminal.IO
{
public interface IOutput
{
void WriteLine(string output);
}
}
\ No newline at end of file
using System;
using System.Text;
namespace TBureck.Terminal.IO
{
public class InputArgument
{
private string _default;
public string Name { get; }
public InputArgumentMode Mode { get; }
public bool Required => this.Mode == InputArgumentMode.Required;
public string Description { get; }
public string Default