Rakish.Core/Locations.cs @@ -4,4 +4,5 @@ */obj/* *resharper.user* *.suo -*.resharper \ No newline at end of file +*.resharper +*.csproj.user \ No newline at end of file .gitignore @@ -45,6 +45,7 @@ <Reference Include="System.Xml" /> </ItemGroup> <ItemGroup> + <Compile Include="Locations.cs" /> <Compile Include="Recipe.cs" /> <Compile Include="Task.cs" /> <Compile Include="TaskAttribute.cs" /> Rakish.Core/Rakish.Core.csproj @@ -2,108 +2,216 @@ using System; using System.Collections.Generic; using System.IO; using System.Reflection; +using System.Linq; namespace Rakish.Core { + + + + /// <summary> + /// + /// </summary> public class RecipeFinder { - public IList<Recipe> FindRecipesInAssemblies() + + //scanning directories + //loading assemblies + //building tree of recipes + //reflecting on types + + private string[] startDirs; + + public RecipeFinder() { - var startDir = Environment.CurrentDirectory; - return FindRecipesInAssemblies(startDir); + } + public RecipeFinder(params string[] startDirs) : this() + { + this.startDirs = startDirs; - public IList<Recipe> FindRecipesInAssemblies(params string[] startDirs) + if(startDirs == null) + { + Locations.StartDirs = new string[] { Environment.CurrentDirectory }; + this.startDirs = Locations.StartDirs; + } + + + } + //TODO: Too many variables + public IList<Recipe> FindRecipesInFiles() { var recipeClasses = new List<Recipe>(); + + //TODO: Fix this + Locations.StartDirs = startDirs; - foreach(var startDir in startDirs) + foreach (var startDir in startDirs) { - FileInfo[] possibleContainers = GetPossibleContainers(startDir); + FileInfo[] dlls = FindAllDlls(startDir); + var loadedAssemblies = PreLoadAssembliesToPreventAssemblyNotFoundError(dlls); - foreach(var assemblyFile in possibleContainers) - { - FindRecipesInAssembly(assemblyFile, recipeClasses); - } + foreach(var assembly in loadedAssemblies) + FindRecipesInAssembly(assembly, recipeClasses); + } return recipeClasses.AsReadOnly(); } - private static void FindRecipesInAssembly(FileInfo file, List<Recipe> recipeClasses) + private List<Assembly> PreLoadAssembliesToPreventAssemblyNotFoundError(FileInfo[] dllFile) { - var loaded = Assembly.LoadFrom(file.FullName); + var loaded = new List<Assembly>(); + + foreach (var dll in dllFile) + //loading the core twice is BAD because "if(blah is RecipeAttribute)" etc will always fail + if(! dll.Name.StartsWith("Rakish.Core")) + loaded.Add(Assembly.LoadFrom(dll.FullName)); + + return loaded; + } + + private static void FindRecipesInAssembly(Assembly loaded, List<Recipe> recipeClasses) + { var types = loaded.GetTypes(); + foreach(var type in types) - { FindRecipeInType(type, recipeClasses); - } + } - private static void FindRecipeInType(Type type, List<Recipe> recipeClasses) + + public static RecipeAttribute GetRecipeAttributeOrNull(Type type) { - var atts = type.GetCustomAttributes(true); + //get recipe attributes for type + var atts = type.GetCustomAttributes(typeof(RecipeAttribute), true); + + //should only be one per type + if (atts.Length > 1) + throw new Exception("Expected only 1 recipe attribute, but got more"); + + //return if none, we'll skip this class + if (atts.Length == 0) + return null; - foreach(var att in atts) + var recipeAtt = atts[0] as RecipeAttribute; + + //throw if bad case. Should cast fine (if not, then might indicate 2 of the same assembly is loaded) + if (recipeAtt == null) + throw new Exception("Casting error for RecipeAttribute. Same assembly loaded more than once?"); + + return recipeAtt; + } + + //TODO: FindRecipeInType is Too long and + //TODO: too many IL Instructions + //TODO: Nesting is too deep + //TODO: Not enough comments + //TODO: Too many variables + // + private static void FindRecipeInType(Type type, List<Recipe> manifest) + { + //find the attribute on the assembly if there is one + var recipeAtt = GetRecipeAttributeOrNull(type); + + //if not found, return + if (recipeAtt == null) return; + + //create recipe details from attribute + Recipe recipe = CreateRecipeFromAttribute(type, recipeAtt); + + //add to manifest + manifest.Add(recipe); + + //trawl through and add the tasks + AddTasksToRecipe(type, recipe); + + } + + private static Recipe CreateRecipeFromAttribute(Type type, RecipeAttribute recipeAtt) + { + return new Recipe + { + Class = type, + Name = String.IsNullOrEmpty(recipeAtt.Name) ? type.Name.Replace("Recipe","").ToLower() : recipeAtt.Name + }; + } + + private static void AddTasksToRecipe(Type type, Recipe recipe) + { + //loop through methods in class + foreach(var method in type.GetMethods(BindingFlags.Instance | BindingFlags.Public | BindingFlags.DeclaredOnly )) { - var recipeAtt = att as RecipeAttribute; + //get the custom attributes on the method + var foundAttributes = method.GetCustomAttributes(typeof(TaskAttribute), false); + + if(foundAttributes.Length > 1) + throw new Exception("Should only be one task attribute on a method"); - if (recipeAtt == null) + //if none, skp to the next method + if (foundAttributes.Length == 0) continue; + + var taskAttribute = foundAttributes[0] as TaskAttribute; + + if (taskAttribute == null) + throw new Exception("couldn't cast TaskAttribute correctly, more that one assembly loaded?"); + + //get the task based on attribute contents + Task t = CreateTaskFromAttribute(method, taskAttribute); - var recipe = new Recipe { Class = type, Name = String.IsNullOrEmpty(recipeAtt.Name) ? type.Name.Replace("Recipe","").ToLower() : recipeAtt.Name }; - recipeClasses.Add(recipe); - - foreach(var method in type.GetMethods(BindingFlags.Instance | BindingFlags.Public | BindingFlags.DeclaredOnly)) - { - var taskAttributes = method.GetCustomAttributes(true); - foreach(var taskAttribute in taskAttributes) - { - var ta = taskAttribute as TaskAttribute; - - if (ta == null) - continue; - - Task t = new Task(); - - if(! String.IsNullOrEmpty(ta.Name)) - { - t.Name = ta.Name; - } - else - { - t.Name = method.Name.Replace("Task", "").ToLower(); - } - - t.Method = method; - - if(! String.IsNullOrEmpty(ta.Help)) - { - t.Description = ta.Help; - } - else - { - t.Description = "No description"; - } - - foreach(string methodName in ta.After) - { - var dependee = type.GetMethod(methodName); - if(dependee == null) throw new Exception(String.Format("No dependee method {0}",methodName)); - t.DependsOnMethods.Add(dependee); - } - - recipe.Tasks.Add(t); - - } - } + //build list of dependent tasks + CreateDependentTasks(type, taskAttribute, t); + + //add the task to the recipe + recipe.Tasks.Add(t); } } - private FileInfo[] GetPossibleContainers(string startDir) + private static void CreateDependentTasks(Type type, TaskAttribute taskAttribute, Task t) { - return new DirectoryInfo(startDir) + foreach(string methodName in taskAttribute.After) + { + var dependee = type.GetMethod(methodName); + if(dependee == null) throw new Exception(String.Format("No dependee method {0}",methodName)); + t.DependsOnMethods.Add(dependee); + } + } + + private static Task CreateTaskFromAttribute(MethodInfo method, TaskAttribute ta) + { + Task t = new Task(); + + if(! String.IsNullOrEmpty(ta.Name)) + t.Name = ta.Name; + else + t.Name = method.Name.Replace("Task", "").ToLower(); + + + t.Method = method; + + if(! String.IsNullOrEmpty(ta.Help)) + t.Description = ta.Help; + else + t.Description = "No description"; + return t; + } + + private FileInfo[] FindAllDlls(string startDir) + { + + var found = new DirectoryInfo(startDir) .GetFiles("*.dll", SearchOption.AllDirectories); + + var deduped = new List<FileInfo>(); + + foreach(var fileInfo in found) + if(! fileInfo.Directory.FullName.Contains("\\obj\\")) + deduped.Add(fileInfo); + + return deduped.ToArray(); + + } } } \ No newline at end of file Rakish.Core/RecipeFinder.cs @@ -6,6 +6,13 @@ namespace Rakish.Core { public class TaskRunner { + private RecipeFinder finder; + + public TaskRunner(RecipeFinder aFinder) + { + finder = aFinder; + } + public void Run(Recipe recipe, Task task) { var recipeInstance = Activator.CreateInstance(recipe.Class); @@ -13,10 +20,11 @@ namespace Rakish.Core task.Method.Invoke(recipeInstance, null); } + //TODO: Run is Too long + //TODO: Nesting depth is too deep public void Run(string recipeName, string taskName) { - var finder = new RecipeFinder(); - var found = finder.FindRecipesInAssemblies(); + var found = finder.FindRecipesInFiles(); foreach(var r in found) { @@ -42,7 +50,7 @@ namespace Rakish.Core // { // var manifest = new RunManifest(); // var finder = new RecipeFinder(); -// var found = finder.FindRecipesInAssemblies(); +// var found = finder.FindRecipesInFiles(); // // foreach (var r in found) // { Rakish.Core/TaskRunner.cs @@ -10,8 +10,8 @@ namespace Rakish.Runner { public static void Main(string[] args) { - var finder = new RecipeFinder(); - var found = finder.FindRecipesInAssemblies(); + var finder = new RecipeFinder(Environment.CurrentDirectory); + var found = finder.FindRecipesInFiles(); if(args.Length > 0) { @@ -22,7 +22,7 @@ namespace Rakish.Runner } var parts = args[0].Split(':'); - var runner = new TaskRunner(); + var runner = new TaskRunner(finder); if(parts.Length == 2) runner.Run(parts[0],parts[1]); Rakish.Runner/Program.cs @@ -64,7 +64,7 @@ </Target> --> <PropertyGroup> - <PostBuildEvent>copy "$(TargetPath)" "$(SolutionDir)rakish.exe" -copy "$(TargetDir)"*.dll "$(SolutionDir)"</PostBuildEvent> + <PostBuildEvent>copy "$(TargetPath)" "C:\Program Files\Rakish\rakish.exe" +copy "$(TargetDir)"*.dll "C:\Program Files\Rakish"</PostBuildEvent> </PropertyGroup> </Project> \ No newline at end of file Rakish.Runner/Rakish.Runner.csproj @@ -46,15 +46,17 @@ namespace Rakish.Test [Task(Name="stats", Help="Lists line counts for all types of files")] public void Stats() { - string rootDir = Environment.CurrentDirectory;// +"..\\..\\..\\..\\"; + string rootDir = Locations.StartDirs[0]; + Console.WriteLine(rootDir); var count = new Dictionary<string, long>() { { "lines", 0 }, { "classes", 0 }, { "files", 0 }, { "enums", 0 }, { "methods", 0 } }; GetLineCount(rootDir, "*.cs", count); Console.WriteLine("c# Files:\t\t{0}", count["files"]); Console.WriteLine("c# Classes: \t{0}", count["classes"]); - Console.WriteLine("c# Methods:\t\t{0}", count["methods"]); + Console.WriteLine("c# Methods: \t{0}", count["methods"]); Console.WriteLine("c# Lines:\t\t{0}", count["lines"]); + Console.WriteLine("Avg Methods Per Class:\t\t{0}", count["methods"]/count["classes"]); } @@ -72,13 +74,13 @@ namespace Rakish.Test var line = r.ReadLine(); while(line != null) { - if (fileFilter == "*.cs" && Regex.Match(line, ".+public|private|internal|protected.+class.+").Length > 0) + if (fileFilter == "*.cs" && Regex.Match(line, ".+[public|private|internal|protected].+class.+").Length > 0) counts["classes"] += 1; - if (fileFilter == "*.cs" && Regex.Match(line, ".+public|private|internal|protected.+enum.+").Length > 0) + if (fileFilter == "*.cs" && Regex.Match(line, ".+[public|private|internal|protected].+enum.+").Length > 0) counts["enums"] += 1; - if (fileFilter == "*.cs" && Regex.Match(line, ".+public|private|internal|protected.+\\(.*\\).+").Length > 0) + if (fileFilter == "*.cs" && Regex.Match(line, ".+[public|private|internal|protected].+\\(.*\\).+").Length > 0) counts["methods"] += 1; counts["lines"] += 1; Rakish.Test/DemoRecipe.cs @@ -10,18 +10,23 @@ namespace Rakish.Test [TestFixture] public class RecipeDiscoveryFixture { - readonly RecipeFinder finder = new RecipeFinder(); + private RecipeFinder finder; IList<Recipe> found; [SetUp] public void Before_Each_Test_Is_Run() { - found = finder.FindRecipesInAssemblies(); + finder = new RecipeFinder(Environment.CurrentDirectory + "..\\..\\..\\..\\"); + found = finder.FindRecipesInFiles(); } [Test] public void Can_Discover_Recipes() { + foreach(var r in found) + { + Console.WriteLine(r.Name); + } Assert.AreEqual(3, found.Count); } @@ -46,7 +51,7 @@ namespace Rakish.Test public void Can_Run_Task() { var recipeInfo = found[1]; - var runner = new TaskRunner(); + var runner = new TaskRunner(finder); runner.Run(recipeInfo, recipeInfo.Tasks[0]); Assert.AreEqual("TEST", AppDomain.CurrentDomain.GetData("TEST")); } @@ -54,7 +59,7 @@ namespace Rakish.Test [Test] public void Can_Run_Task_By_Name() { - var runner = new TaskRunner(); + var runner = new TaskRunner(finder); runner.Run("demo","list"); Assert.AreEqual("LIST", AppDomain.CurrentDomain.GetData("TEST")); runner.Run("demo", "stats"); @@ -79,7 +84,7 @@ namespace Rakish.Test [Test] public void Functions_Are_Called_In_Correct_Order_With_Dependencies() { - var runner = new TaskRunner(); + var runner = new TaskRunner(finder); runner.Run("demo2", "one"); } @@ -87,7 +92,7 @@ namespace Rakish.Test [Test] public void Can_Infer_Recipe_Category_And_Task_Name() { - var runner = new TaskRunner(); + var runner = new TaskRunner(finder); runner.Run("demo3", "hello"); } Rakish.Test/RecipeDiscoveryFixture.cs 13bb6224c2022d508e890404cb6d25f414603971 Tobin tobin@tobinharris.com http://github.com/tobinharris/golem/commit/e68f88f96b7d7c8e8239a6b2ed720b3bd8cbc1f3 e68f88f96b7d7c8e8239a6b2ed720b3bd8cbc1f3 2008-09-20T01:41:28-07:00 2008-09-20T01:41:28-07:00 refactoring 16e3b04e26a37c3de89e4e6809d6cf330e79426f Tobin tobin@tobinharris.com