[packages,Publisher] Fixes #421. Publisher.Collation.IncludeAllModulesInNamespace now only includes modules that generate the specified pathkey.

Author: markfinal

Changelog.txt

@@ -1,3 +1,5 @@
+20-Jan-2018 Fixes #421. Publisher.Collation.IncludeAllModulesInNamespace now only includes modules that generate the specified pathkey.
+
 20-Jan-2018 Fixes #420. Container source modules which are passed into C[.Cxx].ConsoleApplication.ExtendSource() should not standalone compile, as there is no guarantee that they have sufficient dependencies in order to compile. The applications consuming them may provide those dependencies.
 
 20-Jan-2018 Fixes #419. Publisher.Collation.IncludeAllModulesInNamespace now includes an optional regular expression filter. By default, the function will match all Bam.Core.Module based classes. Using the filter will then reduce this list down to only those Modules whose name matches the filter.

packages/Publisher/bam/Scripts/CollatedObject.cs

@@ -222,13 +222,20 @@ protected override void
                     throw new Bam.Core.Exception("The publishing directory for '{0}' has yet to be set", this.SourcePath);
                 }
             }
-            this.RegisterGeneratedFile(Key,
-                                       this.CreateTokenizedString("$(0)/#valid($(RenameLeaf),@filename($(1)))",
-                                                                  new[] { this.publishingDirectory, this.SourcePath }));
             if (null != this.sourceModule)
             {
                 this.Requires(this.sourceModule);
+                if (!this.sourceModule.GeneratedPaths.ContainsKey(this.sourcePathKey))
+                {
+                    // this shouldn't happen, but just in case, a sensible error...
+                    throw new Bam.Core.Exception("Unable to locate generated path '{0}' in module '{1}' for collation",
+                        this.sourcePathKey.ToString(),
+                        this.sourceModule.ToString());
+                }
             }
+            this.RegisterGeneratedFile(Key,
+                                       this.CreateTokenizedString("$(0)/#valid($(RenameLeaf),@filename($(1)))",
+                                                                  new[] { this.publishingDirectory, this.SourcePath }));
             this.Ignore = false;
         }
 

packages/Publisher/bam/Scripts/Collation.cs

@@ -410,6 +410,7 @@ public void
         /// namespace, and collate them beside each other.
         /// Each found module will be an anchor. Any shared dependencies should appear once depending on the build mode. IDE
         /// build projects should each have a copy of shared dependencies in order for them to be debuggable.
+        /// Only modules that have generated the specified pathkey will be included.
         /// </summary>
         /// <param name="nameSpace">Namespace containing all modules of interest.</param>
         /// <param name="key">PathKey of the modules that will be collated.</param>
@@ -422,19 +423,26 @@ public void
             Bam.Core.TokenizedString anchorPublishRoot = null,
             System.Text.RegularExpressions.Regex filter = null)
         {
-            var gen = this.GetType().GetMethod("Include", new[] { typeof(Bam.Core.PathKey), typeof(Bam.Core.TokenizedString) });
+            var genericFindReference = typeof(Bam.Core.Graph).GetMethod("FindReferencedModule");
+            var genericInclude = this.GetType().GetMethod("Include", new[] { typeof(Bam.Core.PathKey), typeof(Bam.Core.TokenizedString) });
             var moduleTypes = global::System.Reflection.Assembly.GetExecutingAssembly().GetTypes().Where(
                 item => item.Namespace == nameSpace &&
-                item.IsSubclassOf(typeof(Bam.Core.Module)) &&
-                item != this.GetType());
+                item.IsSubclassOf(typeof(Bam.Core.Module)));
             if (null != filter)
             {
                 moduleTypes = moduleTypes.Where(item => filter.IsMatch(item.Name));
             }
             foreach (var type in moduleTypes)
             {
-                var meth = gen.MakeGenericMethod(new[] { type });
-                meth.Invoke(this, new object[] { key, anchorPublishRoot });
+                var findModule = genericFindReference.MakeGenericMethod(new[] { type });
+                var module = findModule.Invoke(Bam.Core.Graph.Instance, null) as Bam.Core.Module;
+                if (!module.GeneratedPaths.ContainsKey(key))
+                {
+                    continue;
+                }
+
+                var moduleTypeInclude = genericInclude.MakeGenericMethod(new[] { type });
+                moduleTypeInclude.Invoke(this, new object[] { key, anchorPublishRoot });
             }
         }
 
@@ -634,7 +642,7 @@ public Bam.Core.TokenizedString
                         return mod.defaultPublishPath;
                     }
                 }
-                throw new Bam.Core.Exception("Unable to locate publish directory for module {0} with path key {1}", module.ToString(), modulePathKey.ToString());
+                throw new Bam.Core.Exception("Unable to identify a publish directory for module {0} with path key {1}", module.ToString(), modulePathKey.ToString());
             }
 
             /// <summary>