Skip to content

Commit

Permalink
Documentation and intellisense improvements. Fix bug with assembly lo…
Browse files Browse the repository at this point in the history 
…ading and plugins.
  • Loading branch information
@erdomke
erdomke committed Jun 23, 2021
1 parent 21151c6 commit c3f0d18
Show file tree
Hide file tree
Showing 37 changed files with 1,115 additions and 387 deletions.
158 changes: 158 additions & 0 deletions InnovatorAdmin.Api/Documentation/ActionDocumentation.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,158 @@
<?xml version="1.0" encoding="utf-8" ?>
<methods>
<method name="add">
<summary>Add an item to the database</summary>
<param name="@do_skipOnAfterAdd"><datatype type="boolean" />If <c>1</c> then don't run <c>onAfterAdd</c> server events. Default is <c>0</c>.</param>
<param name="@serverEvents"><datatype type="boolean" />If <c>0</c> then disable server events when running the <c>doGetItem</c> only. <c>onBefore/AfterAdd</c> events are not disabled. Default is <c>1</c>.</param>
</method>
<method name="AddItem">
<inheritdoc cref="add" />
</method>
<method name="copy">
<summary>Create a copy of the specified item. Used when copying relationships in the relationships grid</summary>
<param name="@do_add"><datatype type="boolean" />Whether or not to add the item to the database</param>
<param name="@do_lock"><datatype type="boolean" />Whether or not to keep the item locked when the operation is complete</param>
</method>
<method name="copyAsIs">
<summary>Create a copy of the specified item. Used with the <c>Save As...</c> menu item</summary>
<param name="@lock_related"><datatype type="boolean" /></param>
<param name="@do_lock"><datatype type="boolean" />Whether or not to keep the item locked when the operation is complete</param>
<param name="@useInputProperties"><datatype type="boolean" /></param>
</method>
<method name="copyAsNew">
<inheritdoc cref="copyAsIs" />
</method>
<method name="EmailItem">
<param name="___aras_email_identity_name___"><datatype type="itemname[Identity]" />The name of the identity to send to</param>
<param name="___aras_email_item___/Item[@type='EMail Message'][subject][body_plain][body_html][from_user][query_string]">The e-mail item to send</param>
</method>
<method name="get">
<summary>Queries the database to return information about the specified items</summary>
<param name="@select"><datatype type="selectlist" />A comma-delimited list of property names (column names) to return</param>
<param name="@orderBy"><datatype type="orderBy" />A comma-delimited list of property names (column names) specifying the order of the results</param>
<param name="@page"><datatype type="integer" />The page number for the results set.</param>
<param name="@pagesize"><datatype type="integer" />The number of results to include in a page.</param>
<param name="@maxRecords"><datatype type="integer" />The absolute maximum Items to be searched in the database.</param>
<param name="@levels"><datatype type="integer" />The item configuration depth to be returned</param>
<param name="@serverEvents"><datatype type="boolean" />If <c>0</c> then disable the server events improving performance. Default is <c>1</c></param>
<param name="@isCriteria"><datatype type="boolean" />If <c>0</c> then include the nested structure for the Item configuration in the response but don't use it as search criteria. Default is <c>1</c>, which uses the nested structure in the request as search criteria.</param>
<param name="@related_expand"><datatype type="boolean" />If <c>0</c> then do not expand item properties, instead, only return the ID.</param>
<param name="@language"><datatype type="string" />A comma-delimited list of language codes</param>
<param name="@queryType"><datatype type="enum[Effective|Latest|Released]" />Defines which version of a versionable item to return based on the <c>queryDate</c></param>
<param name="@queryDate"><datatype type="date" />Date to use when searching for versionable items</param>
<param name="@relas_only"><datatype type="boolean" />If <c>1</c>, only return the contents of the <c>&lt;Relationships&gt;</c> tag and not the parent item. Default is <c>0</c>.</param>
<param name="@stdProps"><datatype type="boolean" />Whether to include standard system properties. Default is <c>1</c>. If <c>0</c>, properties such as <c>config_id</c>, <c>created_by_id</c>, <c>current_state</c>, <c>modified_by_id</c>, and <c>permission_id</c> are not returned.</param>
<param name="@expand"><datatype type="boolean" /></param>
<param name="@config_path"><datatype type="string" /></param>
<param name="@where"><datatype type="whereclause" /></param>
<param name="@returnMode"><datatype type="enum[itemsOnly|countOnly]" />Whether to return just the items or the count of items.</param>
</method>
<method name="create">
<summary>Acts as a <c>get</c> if the Item exists, otherwise acts as an <c>add</c>.</summary>
<inheritdoc cref="get" />
<inheritdoc cref="add" />
</method>
<method name="getItemAllVersions">
<summary>Returns all versions of the item with the specified ID.</summary>
<inheritdoc cref="get" />
</method>
<method name="GetItemConfig">
<inheritdoc cref="get" />
</method>
<method name="getItemLastVersion">
<inheritdoc cref="get" />
</method>
<method name="getItemRelationships">
<inheritdoc cref="get" />
</method>
<method name="GetItemRepeatConfig">
<inheritdoc cref="get" />
<summary>Add an item to the database</summary>
<param name="@resolution"><datatype type="enum[AsSaved|Released|Current]" />Determines how to resolve a versionable structure</param>
<param name="Relationships/Item[@repeatTimes][@repeatProp]">
<datatype path="@repeatTimes" type="integer" />
<datatype path="@repeatProp" type="string" />
</param>
</method>
<method name="recache">
<inheritdoc cref="get" />
</method>
<method name="getPermissions">
<summary>Determine if the current user has the specified permissions</summary>
<param name="@access_type"><datatype type="enum[can_add|can_delete|can_get|can_update|can_discover|can_change_access]" />Permission to check for</param>
</method>
<method name="GetPermissionsClause">
<param name="tablename"><datatype type="itemname[ItemType]" /></param>
<param name="allownulls"><datatype type="boolean" /></param>
</method>
<method name="edit">
<param name="@version"><datatype type="boolean" />If <c>0</c> then don't version an Item on update. Default is <c>1</c>, which is version the Item (if it's a versionable Item) on update.</param>
<param name="@serverEvents"><datatype type="boolean" />If <c>0</c> then disable the server events improving performance. Default is <c>1</c>. Only <c>update</c> events are disabled, <c>lock</c> events can be executed if using <c>edit</c>.</param>
<param name="@where"><datatype type="whereclause" /></param>
</method>
<method name="delete">
<param name="@where"><datatype type="whereclause" /></param>
</method>
<method name="purge">
<inheritdoc cref="delete" />
</method>
<method name="merge">
<param name="@do_skipOnAfterAdd"><datatype type="boolean" />If <c>1</c> then don't run <c>onAfterAdd</c> server events. Default is <c>0</c>.</param>
<param name="@version"><datatype type="boolean" />If <c>0</c> then don't version an Item on update. Default is <c>1</c>, which is version the Item (if it's a versionable Item) on update.</param>
<param name="@serverEvents"><datatype type="boolean" />If <c>0</c> then disable the server events improving performance. Default is <c>1</c>. Only <c>update</c> events are disabled, <c>lock</c> events can be executed if using <c>edit</c>.</param>
<param name="@where"><datatype type="whereclause" /></param>
</method>
<method name="update">
<param name="@version"><datatype type="boolean" />If <c>0</c> then don't version an Item on update. Default is <c>1</c>, which is version the Item (if it's a versionable Item) on update.</param>
<param name="@serverEvents"><datatype type="boolean" />If <c>0</c> then disable the server events improving performance. Default is <c>1</c>. Only <c>update</c> events are disabled, <c>lock</c> events can be executed if using <c>edit</c>.</param>
<param name="@where"><datatype type="whereclause" /></param>
</method>
<method name="AddHistory">
<param name="action"></param>
<param name="filename"></param>
<param name="form_name"></param>
</method>
<method name="GetItemsForStructureBrowser">
<param name="Item"></param>
</method>
<method name="instantiateWorkflow">
<param name="WorkflowMap"><datatype type="item[Workflow Map]" />The workflow map to instantiate</param>
</method>
<method name="promoteItem">
<param name="state"><datatype type="string" /></param>
<param name="comments"><datatype type="string" /></param>
</method>
<method name="Run Report">
<param name="report_name"><datatype type="string" /></param>
<param name="AML/Item"></param>
</method>
<method name="SQL Process">
<param name="name"><datatype type="string" /></param>
<param name="PROCESS"></param>
<param name="ARG1"></param>
<param name="ARG2"></param>
<param name="ARG3"></param>
<param name="ARG4"></param>
<param name="ARG5"></param>
<param name="ARG6"></param>
<param name="ARG7"></param>
<param name="ARG8"></param>
<param name="ARG9"></param>
</method>

<method name="ES_Search">
<param name="query_text"><datatype type="string"/>The search text</param>
<param name="start"><datatype type="integer"/>How many results to offset (Default is <c>0</c>)</param>
<param name="rows"><datatype type="integer"/>Number of results to return</param>
<param name="Relationships/Item[@type='Facet'][solr_name][name][Relationships/Item[@type='FacetValue'][value][is_selected]]"></param>
</method>
<method name="GetCommandBarItems">
<param name="item_id"><datatype type="string"/>Context item ID</param>
<param name="item_type_id"><datatype type="item[itemtype]"/>Item type ID</param>
<param name="location_name"><datatype type="itemname[cui_Location]"/>Location</param>
<param name="item_classification"><datatype type="string"/></param>
</method>
<method name="PE_GetResolvedStructure">
<inheritdoc cref="GetItemRepeatConfig" />
</method>
</methods>
7 changes: 4 additions & 3 deletions ...rAdmin.Api/Documentation/IEntityWriter.cs → ...rAdmin.Api/Documentation/DiagramFormat.cs
View file
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace InnovatorAdmin.Documentation
{
public interface IEntityWriter
public enum DiagramFormat
{
void Write(EntityDiagram diagram, TextWriter writer);
PlantUml,
Png,
Svg
}
}
2 changes: 1 addition & 1 deletion InnovatorAdmin.Api/Documentation/Document.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ public static Document FromItemType(ItemType itemType, DocumentOptions options,
document.SubTitle = "RelationshipType";
var label = itemType.Label ?? itemType.TabLabel;
if (!string.IsNullOrEmpty(label) && !string.Equals(label, itemType.Name, StringComparison.OrdinalIgnoreCase))
document.SubTitle = "(" + label + ") " + document.SubTitle;
document.Title += " (" + label + ")";

var typeDescripPara = new Paragraph();
if (!string.IsNullOrEmpty(itemType.Description))
Expand Down
14 changes: 14 additions & 0 deletions InnovatorAdmin.Api/Documentation/DocumentOutput.cs
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace InnovatorAdmin.Documentation
{
public enum DocumentOutput
{
Diagram,
Markdown
}
}
125 changes: 125 additions & 0 deletions InnovatorAdmin.Api/Documentation/DocumentationWriter.cs
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace InnovatorAdmin.Documentation
{
public class DocumentationWriter
{
public DiagramFormat Format { get; set; }
public DocumentOutput Output { get; set; }
public HttpImageWriter ImageWriter { get; set; }

public async Task WriteAsync(PackageMetadataProvider metadata, Stream stream)
{
var entityDiagram = EntityDiagram.FromTypes(metadata.ItemTypes, metadata.Title);
ImageWriter = ImageWriter ?? new HttpImageWriter();
ImageWriter.Format = Format.ToString().ToLowerInvariant();
ImageWriter.Writer = ImageWriter.Writer ?? new PlantUmlWriter();

if (Output == DocumentOutput.Markdown)
{
using (var writer = new StreamWriter(stream))
{
writer.WriteLine("# Data Model");
writer.WriteLine();
await WriteDiagramMarkdown(entityDiagram, writer);
writer.WriteLine();

var mdWriter = new MarkdownVisitor(writer);
var itemTypes = OrderTypes(metadata.ItemTypes.Where(i => !i.IsUiOnly).OrderBy(i => i.Name)).ToList();
foreach (var itemType in itemTypes)
{
mdWriter.Visit(Document.FromItemType(itemType, new DocumentOptions()
{
IncludeCrossReferenceLinks = false,
IncludeCoreProperties = false
}, metadata));
}

writer.WriteLine();
foreach (var group in metadata.Diagrams.GroupBy(d => d.Type))
{
writer.WriteLine("# " + group.Key);
writer.WriteLine();
foreach (var diagram in group)
{
var name = diagram.Name;
if (!string.IsNullOrEmpty(diagram.Label) && !string.Equals(diagram.Label, diagram.Name, StringComparison.OrdinalIgnoreCase))
name += $" ({diagram.Label})";
writer.WriteLine("## " + name);
writer.WriteLine();
await WriteDiagramMarkdown(diagram, writer);
writer.WriteLine();
}
}
}
}
else
{
if (Format == DiagramFormat.PlantUml)
{
await entityDiagram.WriteAsync(ImageWriter.Writer, new StreamWriter(stream));
}
else
{
ImageWriter.Format = Format.ToString().ToLowerInvariant();
await entityDiagram.WriteAsync(ImageWriter, stream);
}
}
}

private IEnumerable<ItemType> OrderTypes(IEnumerable<ItemType> itemTypes)
{
if (!itemTypes.Any())
return Enumerable.Empty<ItemType>();

var initial = itemTypes.Where(i => !i.IsUiOnly).OrderBy(i => i.Name).ToList();
var result = new List<ItemType>();
var stack = new Stack<ItemType>();
stack.Push(initial.FirstOrDefault(i => !i.IsRelationship)
?? initial.First());
while (stack.Count > 0)
{
var curr = stack.Peek();
result.Add(curr);
initial.Remove(curr);

var next = initial.FirstOrDefault(i => curr.Relationships.Contains(i));
while (stack.Count > 0 && next == null)
{
stack.Pop();
if (stack.Count == 0)
next = initial.FirstOrDefault(i => !i.IsRelationship);
else
next = initial.FirstOrDefault(i => stack.Peek().Relationships.Contains(i));
}
if (next != null)
stack.Push(next);
}
return result;
}

private async Task WriteDiagramMarkdown(IDiagram diagram, TextWriter writer)
{
if (Format == DiagramFormat.PlantUml)
{
writer.WriteLine("```plantuml");
await diagram.WriteAsync(ImageWriter.Writer, writer);
writer.WriteLine();
writer.WriteLine("```");
}
else
{
writer.Write("![");
writer.Write(diagram.GetType().Name);
writer.Write("](");
writer.Write(await ImageWriter.GetUrl(diagram));
writer.Write(")");
}
}
}
}
9 changes: 8 additions & 1 deletion InnovatorAdmin.Api/Documentation/EntityDiagram.cs
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
using Innovator.Client;
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace InnovatorAdmin.Documentation
{
public class EntityDiagram
public class EntityDiagram : IDiagram
{
public List<EntityAssociation> Associations { get; } = new List<EntityAssociation>();
public List<Entity> Entities { get; } = new List<Entity>();
Expand Down Expand Up @@ -141,5 +143,10 @@ private static void BuildClassificationNote(ClassNode node, int indent, StringBu
BuildClassificationNote(child, indent + 1, builder);
}
}

public Task WriteAsync<T>(IDiagramWriter<T> writer, T target)
{
return writer.WriteAsync(this, target);
}
}
}
Loading

0 comments on commit c3f0d18

Please sign in to comment.