Topic Mapping Service Update (3.6)

Ignia.Topics.Data.Caching/CachedTopicRepository.cs

@@ -7,6 +7,7 @@
 using System.Diagnostics.Contracts;
 using Ignia.Topics.Collections;
 using Ignia.Topics.Repositories;
+using Ignia.Topics.Querying;
 
 namespace Ignia.Topics.Data.Caching {
 
@@ -50,6 +51,11 @@ public CachedTopicRepository(ITopicRepository dataProvider) : base() {
       \-----------------------------------------------------------------------------------------------------------------------*/
       _dataProvider = dataProvider;
 
+      /*------------------------------------------------------------------------------------------------------------------------
+      | Ensure topics are loaded
+      \-----------------------------------------------------------------------------------------------------------------------*/
+      _cache = _dataProvider.Load();
+
     }
 
     /*==========================================================================================================================
@@ -64,54 +70,35 @@ public CachedTopicRepository(ITopicRepository dataProvider) : base() {
     | METHOD: LOAD
     \-------------------------------------------------------------------------------------------------------------------------*/
     /// <summary>
-    ///   Loads a topic (and, optionally, all of its descendents) based on the specified unique identifier.
+    ///   Loads a topic (and, optionally, all of its descendants) based on the specified unique identifier.
     /// </summary>
     /// <param name="topicId">The topic identifier.</param>
     /// <param name="isRecursive">Determines whether or not to recurse through and load a topic's children.</param>
     /// <returns>A topic object.</returns>
     public override Topic Load(int topicId, bool isRecursive = true) {
 
       /*------------------------------------------------------------------------------------------------------------------------
-      | Validate contracts
+      | Handle request for entire tree
       \-----------------------------------------------------------------------------------------------------------------------*/
-      Contract.Ensures(Contract.Result<Topic>() != null);
-
-      /*------------------------------------------------------------------------------------------------------------------------
-      | Ensure topics are loaded
-      \-----------------------------------------------------------------------------------------------------------------------*/
-      if (_cache == null) {
-        _cache = _dataProvider.Load();
+      if (topicId < 0) {
+        return _cache;
       }
 
       /*------------------------------------------------------------------------------------------------------------------------
-      | Lookup by TopicId
+      | Recursive search
       \-----------------------------------------------------------------------------------------------------------------------*/
-      if (topicId >= 0) {
-        return GetTopic(_cache, topicId);
-      }
-
-      /*------------------------------------------------------------------------------------------------------------------------
-      | Return entire cache
-      \-----------------------------------------------------------------------------------------------------------------------*/
-      return _cache;
+      return _cache.FindFirst(t => t.Id.Equals(topicId));
 
     }
 
     /// <summary>
-    ///   Loads a topic (and, optionally, all of its descendents) based on the specified key name.
+    ///   Loads a topic (and, optionally, all of its descendants) based on the specified key name.
     /// </summary>
     /// <param name="topicKey">The topic key.</param>
     /// <param name="isRecursive">Determines whether or not to recurse through and load a topic's children.</param>
     /// <returns>A topic object.</returns>
     public override Topic Load(string topicKey = null, bool isRecursive = true) {
 
-      /*------------------------------------------------------------------------------------------------------------------------
-      | Ensure topics are loaded
-      \-----------------------------------------------------------------------------------------------------------------------*/
-      if (_cache == null) {
-        _cache = _dataProvider.Load();
-      }
-
       /*------------------------------------------------------------------------------------------------------------------------
       | Lookup by TopicKey
       \-----------------------------------------------------------------------------------------------------------------------*/
@@ -142,45 +129,6 @@ public override Topic Load(string topicKey = null, bool isRecursive = true) {
     /*==========================================================================================================================
     | METHOD: GET TOPIC
     \-------------------------------------------------------------------------------------------------------------------------*/
-    /// <summary>
-    ///   Retrieves a topic object based on the current topic scope and the specified integer identifier.
-    /// </summary>
-    /// <remarks>
-    ///   If the specified ID does not match the identifier for the current topic, its children will be searched.
-    /// </remarks>
-    /// <param name="sourceTopic">The root topic to search from.</param>
-    /// <param name="topicId">The integer identifier for the topic.</param>
-    /// <returns>The topic or null, if the topic is not found.</returns>
-    /// <requires description="The topicId is expected to be a positive integer." exception="T:System.ArgumentException">
-    ///   topicId &lt;= 0
-    /// </requires>
-    private Topic GetTopic(Topic sourceTopic, int topicId) {
-
-      /*------------------------------------------------------------------------------------------------------------------------
-      | Validate input
-      \-----------------------------------------------------------------------------------------------------------------------*/
-      Contract.Requires<ArgumentException>(topicId >= 0, "The topicId is expected to be a non-negative integer.");
-
-      /*------------------------------------------------------------------------------------------------------------------------
-      | Return if current
-      \-----------------------------------------------------------------------------------------------------------------------*/
-      if (sourceTopic.Id == topicId) return sourceTopic;
-
-      /*------------------------------------------------------------------------------------------------------------------------
-      | Iterate through children
-      \-----------------------------------------------------------------------------------------------------------------------*/
-      foreach (var childTopic in sourceTopic.Children) {
-        var foundTopic = GetTopic(childTopic, topicId);
-        if (foundTopic != null) return foundTopic;
-      }
-
-      /*------------------------------------------------------------------------------------------------------------------------
-      | Return null if not found
-      \-----------------------------------------------------------------------------------------------------------------------*/
-      return null;
-
-    }
-
     /// <summary>
     ///   Retrieves a topic object based on the specified partial or full (prefixed) topic key.
     /// </summary>
@@ -211,7 +159,7 @@ private Topic GetTopic(Topic sourceTopic, string uniqueKey) {
       | Provide implicit root
       >-------------------------------------------------------------------------------------------------------------------------
       | ###NOTE JJC080313: While a root topic is required by the data structure, it should be implicit from the perspective of
-      | the calling application.  A developer should be able to call GetTopic("Namepace:TopicPath") to get to a topic, without
+      | the calling application.  A developer should be able to call GetTopic("Namespace:TopicPath") to get to a topic, without
       | needing to be aware of the root.
       \-----------------------------------------------------------------------------------------------------------------------*/
       if (
@@ -261,8 +209,8 @@ private Topic GetTopic(Topic sourceTopic, string uniqueKey) {
     /// <param name="isDraft">Boolean indicator as to the topic's publishing status.</param>
     /// <returns>The integer return value from the execution of the <c>topics_UpdateTopic</c> stored procedure.</returns>
     /// <exception cref="Exception">
-    ///   The Content Type <c>topic.Attributes.GetValue(ContentType, Page)</c> referenced by <c>topic.Key</c> could not be found under
-    ///   Configuration:ContentTypes. There are <c>TopicRepository.ContentTypes.Count</c> ContentTypes in the Repository.
+    ///   The Content Type <c>topic.Attributes.GetValue(ContentType, Page)</c> referenced by <c>topic.Key</c> could not be found
+    ///   under Configuration:ContentTypes. There are <c>TopicRepository.ContentTypes.Count</c> ContentTypes in the Repository.
     /// </exception>
     /// <exception cref="Exception">
     ///   Failed to save Topic <c>topic.Key</c> (<c>topic.Id</c>) via

Ignia.Topics.Data.Caching/Ignia.Topics.Data.Caching.csproj

@@ -10,7 +10,7 @@
     <AppDesignerFolder>Properties</AppDesignerFolder>
     <RootNamespace>Ignia.Topics.Data.Caching</RootNamespace>
     <AssemblyName>Ignia.Topics.Data.Caching</AssemblyName>
-    <TargetFrameworkVersion>v4.5</TargetFrameworkVersion>
+    <TargetFrameworkVersion>v4.7</TargetFrameworkVersion>
     <FileAlignment>512</FileAlignment>
     <NuGetPackageImportStamp>
     </NuGetPackageImportStamp>
@@ -45,6 +45,17 @@
     <CodeContractsBeingOptimisticOnExternal>True</CodeContractsBeingOptimisticOnExternal>
     <CodeContractsRuntimeCheckingLevel>Full</CodeContractsRuntimeCheckingLevel>
     <CodeContractsAnalysisWarningLevel>0</CodeContractsAnalysisWarningLevel>
+    <TargetFrameworkProfile />
+    <ShouldCreateLogs>True</ShouldCreateLogs>
+    <AdvancedSettingsExpanded>False</AdvancedSettingsExpanded>
+    <UpdateAssemblyVersion>True</UpdateAssemblyVersion>
+    <UpdateAssemblyFileVersion>True</UpdateAssemblyFileVersion>
+    <UpdateAssemblyInfoVersion>False</UpdateAssemblyInfoVersion>
+    <AssemblyVersionSettings>None.None.Increment.None</AssemblyVersionSettings>
+    <UpdatePackageVersion>False</UpdatePackageVersion>
+    <AssemblyInfoVersionType>SettingsVersion</AssemblyInfoVersionType>
+    <InheritWinAppVersionFrom>None</InheritWinAppVersionFrom>
+    <AssemblyFileVersionSettings>None.None.Increment.None</AssemblyFileVersionSettings>
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
     <DebugSymbols>true</DebugSymbols>
@@ -66,6 +77,8 @@
     <CodeContractsNecessaryEnsures>False</CodeContractsNecessaryEnsures>
     <CodeContractsShowSquigglies>False</CodeContractsShowSquigglies>
     <CodeContractsReferenceAssembly>%28none%29</CodeContractsReferenceAssembly>
+    <RunCodeAnalysis>true</RunCodeAnalysis>
+    <LangVersion>latest</LangVersion>
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
     <DebugType>pdbonly</DebugType>

Ignia.Topics.Data.Caching/Properties/AssemblyInfo.cs

@@ -1,36 +1,29 @@
-using System.Reflection;
-using System.Runtime.CompilerServices;
+/*==============================================================================================================================
+| Author        Ignia, LLC
+| Client        Ignia, LLC
+| Project       Topics Library
+\=============================================================================================================================*/
+using System;
+using System.Reflection;
 using System.Runtime.InteropServices;
 
-// General Information about an assembly is controlled through the following 
-// set of attributes. Change these attribute values to modify the information
-// associated with an assembly.
-[assembly: AssemblyTitle("Ignia.Topics.Data.Caching")]
-[assembly: AssemblyDescription("")]
+/*==============================================================================================================================
+| DEFINE ASSEMBLY ATTRIBUTES
+>===============================================================================================================================
+| Declare and define attributes used in the compiling of the finished assembly.
+\-----------------------------------------------------------------------------------------------------------------------------*/
+[assembly: AssemblyCompany("Ignia, LLC")]
+[assembly: AssemblyCopyright("Copyright © 2018 Ignia, LLC")]
+[assembly: AssemblyProduct("Ignia OnTopic Library")]
+[assembly: AssemblyTitle("OnTopic Cached Repository")]
+[assembly: AssemblyDescription("Provides a caching decorator for ITopicRepository implementations.")]
 [assembly: AssemblyConfiguration("")]
-[assembly: AssemblyCompany("")]
-[assembly: AssemblyProduct("Ignia.Topics.Data.Caching")]
-[assembly: AssemblyCopyright("Copyright ©  2017")]
 [assembly: AssemblyTrademark("")]
 [assembly: AssemblyCulture("")]
-
-// Setting ComVisible to false makes the types in this assembly not visible 
-// to COM components.  If you need to access a type in this assembly from 
-// COM, set the ComVisible attribute to true on that type.
 [assembly: ComVisible(false)]
-
-// The following GUID is for the ID of the typelib if this project is exposed to COM
+[assembly: AssemblyVersion("3.6.1762.0")]
+[assembly: AssemblyFileVersion("3.5.1794.0")]
+[assembly: CLSCompliant(true)]
 [assembly: Guid("206b7f91-ca25-4e9d-9576-60d2e54a2c0a")]
 
-// Version information for an assembly consists of the following four values:
-//
-//      Major Version
-//      Minor Version 
-//      Build Number
-//      Revision
-//
-// You can specify all the values or you can default the Build and Revision Numbers 
-// by using the '*' as shown below:
-// [assembly: AssemblyVersion("1.0.*")]
-[assembly: AssemblyVersion("2.0.0.0")]
-[assembly: AssemblyFileVersion("2.0.0.0")]
+

Ignia.Topics.Data.Sql.Database/Ignia.Topics.Data.Sql.Database.sqlproj

@@ -17,7 +17,7 @@
     <ModelCollation>1033,CI</ModelCollation>
     <DefaultFileStructure>BySchemaAndSchemaType</DefaultFileStructure>
     <DeployToDatabase>True</DeployToDatabase>
-    <TargetFrameworkVersion>v4.5</TargetFrameworkVersion>
+    <TargetFrameworkVersion>v4.7</TargetFrameworkVersion>
     <TargetLanguage>CS</TargetLanguage>
     <AppDesignerFolder>Properties</AppDesignerFolder>
     <SqlServerVerification>False</SqlServerVerification>
@@ -27,6 +27,7 @@
     <DefaultFilegroup>PRIMARY</DefaultFilegroup>
     <GenerateCreateScript>False</GenerateCreateScript>
     <DacApplicationName>OnTopic</DacApplicationName>
+    <TargetFrameworkProfile />
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
     <OutputPath>bin\Release\</OutputPath>

Ignia.Topics.Data.Sql.Database/README.md

@@ -5,7 +5,7 @@ The `Ignia.Topics.Data.Sql.Database` provides a default schema for supporting th
 
 ## Tables
 The following is a summary of the most relevant tables. 
-- **[`topics_Topics`](dbo/Tables/topics_Topics.sql)**: Represents the core hiearchy of topics, encoded in a nested set format.
+- **[`topics_Topics`](dbo/Tables/topics_Topics.sql)**: Represents the core hierarchy of topics, encoded in a nested set format.
 - **[`topics_TopicAttributes`](dbo/Tables/topics_Topics.sql)**: Represents key/value pairs of topic attributes, including historical versions.
 - **[`topics_Blob`](dbo/Tables/topics_Blob.sql)**: Represents an XML-based blob of non-indexed attributes, which are too long for `topics_TopicAttributes`.
 - **[`topics_Relationships`](dbo/Tables/topics_Relationships.sql)**: Represents relationships between topics, segmented by namespace. 
@@ -24,7 +24,7 @@ The following is a summary of the most relevant stored procedures.
 - **[`topics_CreateTopic`](dbo/Stored%20Procedures/topics_CreateTopic.sql)**: Creates a new topic based on a `@ParentId`, an array of `@Attributes`, and an XML `@Blob`. Returns a new `@@Identity`.
 - **[`topics_DeleteTopic`](dbo/Stored%20Procedures/topics_DeleteTopic.sql)**: Deletes an existing topic based on a `@Id`.
 - **[`topics_MoveTopic`](dbo/Stored%20Procedures/topics_MoveTopic.sql)**: Moves an existing topic based on an `@Id`, `@ParentId`, and `@SiblingId`.
-- **[`topics_UpdateTopic`](dbo/Stored%20Procedures/topics_UpdateTopic.sql)**: Updates an existing topic based on an `@Id`, an array of `@Attributes`, and a `@Blob`. Optionally deletes all relationships; these will need to be readded using `topics_PersistRelations`. Old attributes are persisted as previous versions.
+- **[`topics_UpdateTopic`](dbo/Stored%20Procedures/topics_UpdateTopic.sql)**: Updates an existing topic based on an `@Id`, an array of `@Attributes`, and a `@Blob`. Optionally deletes all relationships; these will need to be re-added using `topics_PersistRelations`. Old attributes are persisted as previous versions.
 - **[`topics_PersistRelations`](dbo/Stored%20Procedures/topics_PersistRelations.sql)**: Associates a relationship with a topic based on a `@Source_TopicId`, array of `@Target_TopicIds`, and `@RelationshipTypeID` (which can be any string label).
 
 ## Views

Ignia.Topics.Data.Sql.Database/dbo/Stored Procedures/topics_CreateTopic.sql

@@ -3,7 +3,7 @@
 --
 -- Purpose	Creates a new topic.
 --
--- History	Casey Margell		04062009  Initial Creation baseaed on code from Celko's Sql For Smarties.
+-- History	Casey Margell		04062009  Initial Creation based on code from Celko's SQL For Smarties.
 --		Jeremy Caney		05282010  Reformatted code and refactored identifiers for improved readability.
 --		Katherine Trunkey	08142014  Updated topic_TopicAttributes insertion script to use uncommon, multi-character delimiters
 --						  rather than a colon and semicolon in order to provide better escaping safety for @Attributes.

Ignia.Topics.Data.Sql.Database/dbo/Stored Procedures/topics_GetTopics.sql

@@ -4,7 +4,7 @@
 -- Purpose	Gets the tree of current topics rooted FROM the provided TopicID.  If no TopicID is provided then the sproc returns everything
 --		under the topic with the lowest id.
 --
--- History      Casey Margell		04062009  Initial Creation baseaed on code FROM Celko's Sql For Smarties.
+-- History      Casey Margell		04062009  Initial Creation based on code FROM Celko's SQL For Smarties.
 --		Jeremy Caney		07192009  Added support for AttributeID lookup.
 --		Jeremy Caney		05282010  Reformatted code AND refactored identifiers for improved readability.
 --		Jeremy Caney		06072010  Added support for blob fields.

Ignia.Topics.Data.Sql.Database/dbo/Stored Procedures/topics_MoveTopic.sql

@@ -8,7 +8,7 @@
 --              Hedley Robertson	07062010  Added support for SiblingID (Ordering)
 --              Hedley Robertson	08122010  Inline test cases, debugging statements and check for re-parenting;
 --						  now avoids moving item to start of SET when sibling move requested
---						  and parentid has not changed
+--						  and ParentId has not changed
 --              Hedley Robertson	08172010  Rebuilt with externalized MoveSubTree function
 --		Jeremy Caney		09222014  Updated logic for ParentID attribute to be based on Key, not ID
 --		Jeremy Caney		12092017  Refactored based on Celko's alternative formulation.
@@ -124,7 +124,7 @@ SET			@Offset =
 -- MOVE SOURCE RANGE TO INSERTION POINT
 -----------------------------------------------------------------------------------------------------------------------------------------------
 -- The basic idea behind moving nodes is that we're going to a) shift the target subtree (@Parent) by the delta (@Offset) between its original
--- position (@OriginalLeft, @OriginalRight) and the the target location (@InsertionPoint), while b) closing the gap left behind by shifting all
+-- position (@OriginalLeft, @OriginalRight) and the target location (@InsertionPoint), while b) closing the gap left behind by shifting all
 -- intermediate nodes by the width of the target subtree (@OriginalRange).
 -----------------------------------------------------------------------------------------------------------------------------------------------
 -- EXAMPLE: If we're moving a target subtree of width 12 down 26 nodes, then we'd a) subtract 26 (the @Offset) from all nodes between RangeLeft