Merge pull request #6 from Pyratron/command-data

Cyral · Cyral · commit 002106abff7e · 2015-07-30T17:44:50.000-04:00
Command data
diff --git a/DotNET/.nuget/packages.config b/DotNET/.nuget/packages.config
diff --git a/DotNET/Command Parser.sln b/DotNET/Command Parser.sln
@@ -1,17 +1,12 @@
 ﻿
 Microsoft Visual Studio Solution File, Format Version 12.00
-# Visual Studio 2013
-VisualStudioVersion = 12.0.31101.0
+# Visual Studio 14
+VisualStudioVersion = 14.0.23107.0
 MinimumVisualStudioVersion = 10.0.40219.1
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Parser", "Parser\Parser.csproj", "{78DE8E68-61D9-4FB5-B25B-1EC94F96E1FD}"
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Demo", "Demo\Demo.csproj", "{CEF53167-06D5-460D-927C-F5BDF8D08E9B}"
 EndProject
-Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = ".nuget", ".nuget", "{2ACB48F6-5E57-4066-A63D-F7E27A42C946}"
-	ProjectSection(SolutionItems) = preProject
-		.nuget\packages.config = .nuget\packages.config
-	EndProjectSection
-EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Tests", "Tests\Tests.csproj", "{C7AE3472-7138-4FF2-8161-53C7DCD255D4}"
 EndProject
 Global
diff --git a/DotNET/Demo/Program.cs b/DotNET/Demo/Program.cs
@@ -88,7 +88,7 @@ public static void Main()
 
             Parser.AddCommand(Command.Create("Register").AddAlias("register").SetDescription("Create an account")
                 //Note inline action.
-                .SetAction(arguments =>
+                .SetAction((arguments, data) =>
                 {
                     var user = arguments.FromName("username");
                     var email = arguments.FromName("email");
@@ -121,7 +121,7 @@ public static void Main()
                 .AddAlias("god", "godmode")
                 .SetDescription("Disables or enables godmode.")
                 .SetAction(
-                    delegate(Argument[] arguments)
+                    (arguments, data) =>
                     {
                         Console.WriteLine("Godmode turned {0} for {1}", arguments.FromName("status"),
                             arguments.FromName("player"));
@@ -153,7 +153,7 @@ public static void Main()
                 .AddAlias("worth")
                 .SetDescription("Item worth")
                 .SetAction(
-                    delegate(Argument[] arguments)
+                    (arguments, data) =>
                     {
                         var type = arguments.FromName("type");
                         if (type == "hand")
@@ -206,7 +206,7 @@ public static void Main()
             }
         }
 
-        private static void OnMailExecuted(Argument[] args)
+        private static void OnMailExecuted(Argument[] args, object data)
         {
             var type = args.FromName("type");
             switch (type)
@@ -229,22 +229,22 @@ private static void OnMailExecuted(Argument[] args)
             }
         }
 
-        private static void OnGiveExecuted(Argument[] args)
+        private static void OnGiveExecuted(Argument[] args, object data)
         {
             var user = args.FromName("user");
             var item = args.FromName("item");
             var amount = args.FromName("amount");
             Console.WriteLine("User {0} was given {1} of {2}", user, amount, item);
         }
 
-        private static void OnUnbanExecuted(Argument[] args)
+        private static void OnUnbanExecuted(Argument[] args, object data)
         {
             var user = args.FromName("user");
             Console.WriteLine("User {0} was unbanned!", user);
             banned = false;
         }
 
-        private static void OnBanExecuted(Argument[] args)
+        private static void OnBanExecuted(Argument[] args, object data)
         {
             var user = args.FromName("user");
             Console.WriteLine("User {0} was banned!", user);
diff --git a/DotNET/Demo/Properties/AssemblyInfo.cs b/DotNET/Demo/Properties/AssemblyInfo.cs
@@ -5,11 +5,11 @@
 [assembly: AssemblyDescription("Demo application to showcase the Pyratron Command Parser Framework")]
 [assembly: AssemblyCompany("Pyratron Studios")]
 [assembly: AssemblyProduct("Command Parser Demo")]
-[assembly: AssemblyCopyright("Copyright © 2015")]
+[assembly: AssemblyCopyright("Copyright © Pyratron Studios 2015")]
 
 [assembly: ComVisible(false)]
 
 [assembly: Guid("f737eed5-4675-406a-ad8d-dd61da202bbd")]
 
-[assembly: AssemblyVersion("1.2")]
-[assembly: AssemblyFileVersion("1.2")]
+[assembly: AssemblyVersion("1.3")]
+[assembly: AssemblyFileVersion("1.3")]
diff --git a/DotNET/Parser/Command.cs b/DotNET/Parser/Command.cs
@@ -19,7 +19,7 @@ public class Command : IArguable
         /// <summary>
         /// An action to be executed when the command is ran with successful input.
         /// </summary>
-        public Action<Argument[]> Action { get; set; }
+        public Action<Argument[], object> Action { get; set; }
 
         /// <summary>
         /// The strings that will call the command. The first alias is known as the default alias.
@@ -229,9 +229,9 @@ public Command RestrictAccess(int accessLevel)
         /// </summary>
         /// <param name="action">
         /// Action to be ran, which takes a <c>Argument</c> array parameter representing the passed
-        /// input.
+        /// input, as well as any kind of optional data to be sent to the command.
         /// </param>
-        public Command SetAction(Action<Argument[]> action)
+        public Command SetAction(Action<Argument[], object> action)
         {
             if (action == null) throw new ArgumentNullException("action");
 
@@ -240,18 +240,19 @@ public Command SetAction(Action<Argument[]> action)
         }
 
         /// <summary>
-        /// Executes a command with the specified input and an optional access level.
+        /// Executes this command with the specified arguments.
         /// If CanExecute returns false, the command is not run.
         /// </summary>
         /// <param name="arguments">The parsed input</param>
-        public Command Execute(Argument[] arguments)
+        /// <param name="data">Optional data to be passed to the command.</param>
+        public Command Execute(Argument[] arguments, object data = null)
         {
             if (Action == null)
                 throw new InvalidOperationException("The command's action must be defined before calling it.");
 
             if (string.IsNullOrEmpty(CanExecute(this)))
                 //Run the pre-condition, if it passes (returns no error), run the action
-                Action(arguments);
+                Action(arguments, data);
             return this;
         }
 
diff --git a/DotNET/Parser/CommandParser.cs b/DotNET/Parser/CommandParser.cs
@@ -121,6 +121,27 @@ public CommandParser OnError(Action<object, string> callback)
         /// If the input does not start with a prefix, it returns false so the message can be processed further. (As a chat message, for example)
         /// </returns>
         public bool Parse(string input, int accessLevel = 0)
+        {
+            return Parse(input, null, accessLevel);
+        }
+
+        /// <summary>
+        /// Parses text in search of a command (with prefix), and runs it accordingly.
+        /// </summary>
+        /// <remarks>
+        /// Data does not need to be formatted in any way before parsing. Simply pass your input to the function and
+        /// it will determine if it is a valid command, check the command's <c>Command.CanExecute</c> function, and run the
+        /// command.
+        /// Use <c>Arguments[].FromName(...)</c> to get the values of the parsed arguments in the command action.
+        /// </remarks>
+        /// <param name="data">Data to pass to the command. This data can be used by the command when it is executed.</param>
+        /// <param name="input">A string inputted by a user. If the string does not start with the parser prefix, it will return false, otherwise it will parse the command.</param>
+        /// <param name="accessLevel">An optional level to limit executing commands if the user doesn't have permission.</param>
+        /// <returns>
+        /// True if the input is non-empty and starts with the <c>Prefix</c>.
+        /// If the input does not start with a prefix, it returns false so the message can be processed further. (As a chat message, for example)
+        /// </returns>
+        public bool Parse(string input, object data, int accessLevel = 0)
         {
             if (string.IsNullOrEmpty(input))
                 return false;
@@ -130,9 +151,9 @@ public bool Parse(string input, int accessLevel = 0)
             if (!string.IsNullOrEmpty(Prefix))
             {
                 var index = input.IndexOf(Prefix, StringComparison.OrdinalIgnoreCase);
-                if (index == -1)
+                if (index != 0)
                     return false;
-                input = input.Remove(index, Prefix.Length);
+                input = input.Remove(0, Prefix.Length);
             }
             if (string.IsNullOrEmpty(input))
                 return false;
@@ -177,7 +198,7 @@ public bool Parse(string input, int accessLevel = 0)
                 var alias = inputArgs.ElementAt(0).ToLower(); //Preserve the alias typed in.
                 inputArgs.RemoveAt(0); //Remove the command name.
                 if (!ParseArguments(false, alias, command, command, inputArgs, returnArgs))
-                    command.Execute(returnArgs.ToArray()); //Execute the command.
+                    command.Execute(returnArgs.ToArray(), data); //Execute the command.
 
                 //Return argument values back to default.
                 ResetArgs(command);
diff --git a/DotNET/Parser/Properties/AssemblyInfo.cs b/DotNET/Parser/Properties/AssemblyInfo.cs
@@ -2,7 +2,7 @@
 using System.Runtime.InteropServices;
 
 [assembly: AssemblyTitle("Command Parser")]
-[assembly: AssemblyDescription("Simple, lightweight, but powerful command parsing library. Useful for command handling in chat or game applications.")]
+[assembly: AssemblyDescription("Simple, lightweight, and powerful command parsing library. Useful for command handling in chat or game applications.")]
 [assembly: AssemblyCompany("Pyratron Studios")]
 [assembly: AssemblyProduct("Command Parser")]
 [assembly: AssemblyCopyright("Copyright © 2015 Pyratron Studios")]
@@ -11,5 +11,5 @@
 
 [assembly: Guid("a8cce35f-dbe6-4ab6-b340-c10dc7c907e3")]
 
-[assembly: AssemblyVersion("1.2")]
-[assembly: AssemblyFileVersion("1.2")]
+[assembly: AssemblyVersion("1.3")]
+[assembly: AssemblyFileVersion("1.3")]
diff --git a/DotNET/Tests/Properties/AssemblyInfo.cs b/DotNET/Tests/Properties/AssemblyInfo.cs
@@ -11,5 +11,5 @@
 
 [assembly: Guid("ec03b077-6925-4571-ba49-df9371da0941")]
 
-[assembly: AssemblyVersion("1.2")]
-[assembly: AssemblyFileVersion("1.2")]
+[assembly: AssemblyVersion("1.3")]
+[assembly: AssemblyFileVersion("1.3")]
diff --git a/DotNET/Tests/Tests.cs b/DotNET/Tests/Tests.cs
@@ -76,7 +76,7 @@ public void TestArguments()
                 .Create("Test")
                 .AddAlias("test")
                 .AddArgument(Argument.Create("arg"))
-                .SetAction(delegate(Argument[] args) { result = args.FromName("arg"); }));
+                .SetAction(delegate(Argument[] args, object data) { result = args.FromName("arg"); }));
 
             parser.Parse("test " + input);
 
@@ -95,7 +95,7 @@ public void TestDefaultArguments()
                 .Create("Test")
                 .AddAlias("test")
                 .AddArgument(Argument.Create("arg").MakeOptional().SetDefault(10))
-                .SetAction(delegate(Argument[] arguments) { value = int.Parse(arguments.FromName("arg")); }));
+                .SetAction(delegate(Argument[] arguments, object data) { value = int.Parse(arguments.FromName("arg")); }));
 
             //Test specified value
             parser.Parse("test 20");
@@ -239,7 +239,7 @@ public void TestOptionalEnumArguments()
                 .Create("Test")
                 .AddAlias("test")
                 .SetAction(
-                    delegate(Argument[] arguments)
+                    delegate(Argument[] arguments, object data)
                     {
                         arg1 = arguments.FromName("arg1");
                         arg2 = arguments.FromName("arg2");
@@ -285,10 +285,11 @@ public void TestCanExecute()
             var parser = CommandParser.CreateNew().UsePrefix(string.Empty);
 
             parser.AddCommand(Command
-               .Create("Test")
-               .AddAlias("test")
-               .SetAction(obj => ran = true)
-               .SetExecutePredicate(command => canExecute ? string.Empty : "Error"));
+                .Create("Test")
+                .AddAlias("test")
+                .SetAction(delegate { ran = true; }
+                )
+                .SetExecutePredicate(command => canExecute ? string.Empty : "Error"));
 
             //CanExecute true
             parser.Parse("test");
diff --git a/DotNET/Tests/Tests.csproj b/DotNET/Tests/Tests.csproj
@@ -36,12 +36,25 @@
     <StartupObject />
   </PropertyGroup>
   <ItemGroup>
-    <Reference Include="nunit.framework">
+    <Reference Include="nunit.core, Version=2.6.4.14350, Culture=neutral, PublicKeyToken=96d09a1eb7f44a77, processorArchitecture=MSIL">
+      <HintPath>..\packages\NUnitTestAdapter.2.0.0\lib\nunit.core.dll</HintPath>
+      <Private>True</Private>
+    </Reference>
+    <Reference Include="nunit.core.interfaces, Version=2.6.4.14350, Culture=neutral, PublicKeyToken=96d09a1eb7f44a77, processorArchitecture=MSIL">
+      <HintPath>..\packages\NUnitTestAdapter.2.0.0\lib\nunit.core.interfaces.dll</HintPath>
+      <Private>True</Private>
+    </Reference>
+    <Reference Include="nunit.framework, Version=2.6.4.14350, Culture=neutral, PublicKeyToken=96d09a1eb7f44a77, processorArchitecture=MSIL">
       <HintPath>..\packages\NUnit.2.6.4\lib\nunit.framework.dll</HintPath>
+      <Private>True</Private>
+    </Reference>
+    <Reference Include="nunit.util, Version=2.6.4.14350, Culture=neutral, PublicKeyToken=96d09a1eb7f44a77, processorArchitecture=MSIL">
+      <HintPath>..\packages\NUnitTestAdapter.2.0.0\lib\nunit.util.dll</HintPath>
+      <Private>True</Private>
     </Reference>
-    <Reference Include="NUnit.VisualStudio.TestAdapter">
-      <HintPath>..\packages\NUnitTestAdapter.1.2\lib\NUnit.VisualStudio.TestAdapter.dll</HintPath>
-      <Private>False</Private>
+    <Reference Include="NUnit.VisualStudio.TestAdapter, Version=2.0.0.0, Culture=neutral, PublicKeyToken=4cb40d35494691ac, processorArchitecture=MSIL">
+      <HintPath>..\packages\NUnitTestAdapter.2.0.0\lib\NUnit.VisualStudio.TestAdapter.dll</HintPath>
+      <Private>True</Private>
     </Reference>
     <Reference Include="System" />
     <Reference Include="System.Core" />
@@ -51,9 +64,6 @@
     <Compile Include="Tests.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
   </ItemGroup>
-  <ItemGroup>
-    <None Include="packages.config" />
-  </ItemGroup>
   <ItemGroup>
     <ProjectReference Include="..\Parser\Parser.csproj">
       <Project>{78de8e68-61d9-4fb5-b25b-1ec94f96e1fd}</Project>
@@ -63,6 +73,9 @@
   <ItemGroup>
     <Service Include="{82A7F48D-3B50-4B1E-B82E-3ADA8210C358}" />
   </ItemGroup>
+  <ItemGroup>
+    <None Include="packages.config" />
+  </ItemGroup>
   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
   <!-- To modify your build process, add your task inside one of the targets below and uncomment it.
        Other similar extension points exist, see Microsoft.Common.targets.
diff --git a/DotNET/Tests/packages.config b/DotNET/Tests/packages.config
@@ -1,5 +1,5 @@
 ﻿<?xml version="1.0" encoding="utf-8"?>
 <packages>
-  <package id="NUnit" version="2.6.4" targetFramework="net40" />
-  <package id="NUnitTestAdapter" version="1.2" targetFramework="net40" />
+  <package id="NUnit" version="2.6.4" targetFramework="net4" />
+  <package id="NUnitTestAdapter" version="2.0.0" targetFramework="net4" />
 </packages>
diff --git a/Java/Demo/src/com/pyratron/frameworks/commands/demo/Program.java b/Java/Demo/src/com/pyratron/frameworks/commands/demo/Program.java
@@ -17,15 +17,15 @@ public class Program {
     private static CommandParser parser;
 
     public static void main(String[] progArgs) {
-        System.out.println("Welcome to the Pyratron Command Parser Framework Demo\nProgram.cs in the Demo project. contains a short tutorial and many examples.\nType 'list' for commands.\n");
+        System.out.println("Welcome to the Pyratron Command Parser Framework Demo\nProgram.java in the Demo module contains a short tutorial and many examples.\nType 'list' for commands.\n");
         System.out.println("Additional Information: https://www.pyratron.com/projects/command-parser");
 
         /* --------
          * Tutorial
 		 * -------- */
 
         //Create a command parser instance.
-        //Each instance can be built upon right away by using .a(..)
+        //Each instance can be built upon right away by using .addCommand(..)
         parser = CommandParser.createNew().usePrefix("").onError(message -> onParseError(message));
 
         //Add a command via the fluent interface:
@@ -34,7 +34,7 @@ public static void main(String[] progArgs) {
                 .addAlias("ban") //Aliases
                 .addAlias("banuser")
                 .setDescription("Bans a user from the server.") //Description.
-                .setAction(args -> onBanExecuted(args)) //Action to be executed when command is ran with correct parameters. (Of course, can be method, lambda, delegate, etc)
+                .setAction((args, data) -> onBanExecuted(args)) //Action to be executed when command is ran with correct parameters. (Of course, can be method, lambda, delegate, etc)
                 .setExecutePredicate(canExecute -> //Precondition to be checked before executing the command.
                 {
                     //In reality this logic would be more complex but this is just an example.
@@ -52,7 +52,7 @@ public static void main(String[] progArgs) {
                 .create("Give Item")
                 .addAlias("item", "giveitem", "give")  //Note multiple aliases.
                 .setDescription("Gives a user an item.")
-                .setAction(args -> onGiveExecuted(args))
+                .setAction((args, data) -> onGiveExecuted(args))
                 .addArgument(Argument.create("user"))
                 .addArgument(Argument.create("item"))
                 .addArgument(Argument.create("amount")
@@ -63,7 +63,7 @@ public static void main(String[] progArgs) {
                 .create("Register")
                 .addAlias("register")
                 .setDescription("Create an account")
-                .setAction(args -> //Note inline action.
+                .setAction((args, data) -> //Note inline action.
                 {
                     String user = Argument.fromName(args, "username");
                     String email = Argument.fromName(args, "email");
@@ -80,7 +80,7 @@ public static void main(String[] progArgs) {
                 .create("Mail")
                 .addAlias("mail")
                 .setDescription("Allows users to send messages.")
-                .setAction(args -> onMailExecuted(args))
+                .setAction((args, data) -> onMailExecuted(args))
                 .addArgument(Argument.create("type") //Note a deep nesting of arguments.
                         .makeOptional() //Note command options. These turn the "type" argument into an enum style list of values.
                         .addOption(Argument //The user has to type read, clear, or send (Which has it's own nested arguments).
@@ -98,7 +98,7 @@ public static void main(String[] progArgs) {
                 .create("Godmode")
                 .addAlias("god", "godmode")
                 .setDescription("Disables or enables godmode.")
-                .setAction(args ->
+                .setAction((args, data) ->
                         System.out.printf("Godmode turned %1$s for %2$s" + "\r\n", Argument
                                 .fromName(args, "status"), Argument
                                 .fromName(args, "player")))
@@ -118,11 +118,11 @@ public static void main(String[] progArgs) {
                 .create("Command List")
                 .addAlias("list", "commands")
                 .setDescription("Lists commands")
-                .setAction(args ->
+                .setAction((args, data) ->
                         parser.getCommands().stream().forEachOrdered(command -> System.out.println(command.showHelp())))); //Listing of commands
 
         //Another advanced command
-        parser.addCommand(Command.create("Worth").addAlias("worth").setDescription("Item worth").setAction(args ->
+        parser.addCommand(Command.create("Worth").addAlias("worth").setDescription("Item worth").setAction((args, data) ->
         {
             String type = Argument.fromName(args, "type");
             if (type.equals("hand"))
diff --git a/Java/Parser/src/com/pyratron/frameworks/commands/parser/Command.java b/Java/Parser/src/com/pyratron/frameworks/commands/parser/Command.java
diff --git a/Java/Parser/src/com/pyratron/frameworks/commands/parser/CommandParser.java b/Java/Parser/src/com/pyratron/frameworks/commands/parser/CommandParser.java
diff --git a/Java/Parser/src/com/pyratron/frameworks/commands/parser/ValidationRule.java b/Java/Parser/src/com/pyratron/frameworks/commands/parser/ValidationRule.java
diff --git a/Java/Tests/src/com/pyratron/frameworks/commands/tests/Tests.java b/Java/Tests/src/com/pyratron/frameworks/commands/tests/Tests.java

Original file line number	Diff line number	Diff line change
`@@ -88,7 +88,7 @@ public static void Main()`
`88`	`88`
`89`	`89`	`Parser.AddCommand(Command.Create("Register").AddAlias("register").SetDescription("Create an account")`
`90`	`90`	`//Note inline action.`
`91`		`- .SetAction(arguments =>`
	`91`	`+ .SetAction((arguments, data) =>`
`92`	`92`	`{`
`93`	`93`	`var user = arguments.FromName("username");`
`94`	`94`	`var email = arguments.FromName("email");`
`@@ -121,7 +121,7 @@ public static void Main()`
`121`	`121`	`.AddAlias("god", "godmode")`
`122`	`122`	`.SetDescription("Disables or enables godmode.")`
`123`	`123`	`.SetAction(`
`124`		`- delegate(Argument[] arguments)`
	`124`	`+ (arguments, data) =>`
`125`	`125`	`{`
`126`	`126`	`Console.WriteLine("Godmode turned {0} for {1}", arguments.FromName("status"),`
`127`	`127`	`arguments.FromName("player"));`
`@@ -153,7 +153,7 @@ public static void Main()`
`153`	`153`	`.AddAlias("worth")`
`154`	`154`	`.SetDescription("Item worth")`
`155`	`155`	`.SetAction(`
`156`		`- delegate(Argument[] arguments)`
	`156`	`+ (arguments, data) =>`
`157`	`157`	`{`
`158`	`158`	`var type = arguments.FromName("type");`
`159`	`159`	`if (type == "hand")`
`@@ -206,7 +206,7 @@ public static void Main()`
`206`	`206`	`}`
`207`	`207`	`}`
`208`	`208`
`209`		`- private static void OnMailExecuted(Argument[] args)`
	`209`	`+ private static void OnMailExecuted(Argument[] args, object data)`
`210`	`210`	`{`
`211`	`211`	`var type = args.FromName("type");`
`212`	`212`	`switch (type)`
`@@ -229,22 +229,22 @@ private static void OnMailExecuted(Argument[] args)`
`229`	`229`	`}`
`230`	`230`	`}`
`231`	`231`
`232`		`- private static void OnGiveExecuted(Argument[] args)`
	`232`	`+ private static void OnGiveExecuted(Argument[] args, object data)`
`233`	`233`	`{`
`234`	`234`	`var user = args.FromName("user");`
`235`	`235`	`var item = args.FromName("item");`
`236`	`236`	`var amount = args.FromName("amount");`
`237`	`237`	`Console.WriteLine("User {0} was given {1} of {2}", user, amount, item);`
`238`	`238`	`}`
`239`	`239`
`240`		`- private static void OnUnbanExecuted(Argument[] args)`
	`240`	`+ private static void OnUnbanExecuted(Argument[] args, object data)`
`241`	`241`	`{`
`242`	`242`	`var user = args.FromName("user");`
`243`	`243`	`Console.WriteLine("User {0} was unbanned!", user);`
`244`	`244`	`banned = false;`
`245`	`245`	`}`
`246`	`246`
`247`		`- private static void OnBanExecuted(Argument[] args)`
	`247`	`+ private static void OnBanExecuted(Argument[] args, object data)`
`248`	`248`	`{`
`249`	`249`	`var user = args.FromName("user");`
`250`	`250`	`Console.WriteLine("User {0} was banned!", user);`