Enabled StyleCop and added StyleCop dependency as git module

ParTech · Mar 10, 2014 · 2552412 · 2552412
1 parent 4d057c7
commit 2552412
Show file tree

Hide file tree

Showing 16 changed files with 212 additions and 188 deletions.
diff --git a/.gitmodules b/.gitmodules
@@ -0,0 +1,4 @@
+[submodule "References/StyleCop"]
+	path = References/StyleCop
+	url = https://github.com/ParTech/StyleCop-Dependency.git
+	branch = master
diff --git a/References/StyleCop b/References/StyleCop
diff --git a/Source/ParTech.Modules.UrlRewriter/Commands/ClearCache.cs b/Source/ParTech.Modules.UrlRewriter/Commands/ClearCache.cs
@@ -1,13 +1,12 @@
-using ParTech.Modules.UrlRewriter.Events;
-using ParTech.Modules.UrlRewriter.Pipelines;
-using Sitecore;
-using Sitecore.Events;
-using Sitecore.Shell.Applications.Dialogs.ProgressBoxes;
-using Sitecore.Shell.Framework.Commands;
-using Sitecore.Web.UI.Sheer;
-
-namespace ParTech.Modules.UrlRewriter.Commands
+namespace ParTech.Modules.UrlRewriter.Commands
 {
+    using ParTech.Modules.UrlRewriter.Events;
+    using Sitecore;
+    using Sitecore.Eventing;
+    using Sitecore.Events;
+    using Sitecore.Shell.Framework.Commands;
+    using Sitecore.Web.UI.Sheer;
+
     /// <summary>
     /// Clear the URL Rewriter cache by adding a ClearCacheEvent to the EventQueue.
     /// </summary>
@@ -39,7 +38,7 @@ public void Confirm(ClientPipelineArgs args)
                 Event.RaiseEvent("urlrewriter:clearcache", new ClearCacheEventArgs(new ClearCacheEvent()));
 
                 // Add a ClearCacheEvent to the EventQueue to clear the cache on all instances.
-                Sitecore.Eventing.EventManager.QueueEvent<ClearCacheEvent>(new ClearCacheEvent(), true, false);
+                EventManager.QueueEvent(new ClearCacheEvent(), true, false);
             }
         }
     }

diff --git a/Source/ParTech.Modules.UrlRewriter/Events/ClearCacheEvent.cs b/Source/ParTech.Modules.UrlRewriter/Events/ClearCacheEvent.cs
@@ -1,7 +1,7 @@
-using System.Runtime.Serialization;
-
-namespace ParTech.Modules.UrlRewriter.Events
+namespace ParTech.Modules.UrlRewriter.Events
 {
+    using System.Runtime.Serialization;
+
     /// <summary>
     /// Represents the ClearCache event in the EventQueue.
     /// </summary>

diff --git a/Source/ParTech.Modules.UrlRewriter/Events/ClearCacheEventArgs.cs b/Source/ParTech.Modules.UrlRewriter/Events/ClearCacheEventArgs.cs
@@ -1,17 +1,17 @@
-using System;
-using Sitecore.Events;
-
-namespace ParTech.Modules.UrlRewriter.Events
+namespace ParTech.Modules.UrlRewriter.Events
 {
+    using System;
+    using Sitecore.Events;
+
     /// <summary>
     /// EventArgs for ClearCacheEvent
     /// </summary>
     public class ClearCacheEventArgs : EventArgs, IPassNativeEventArgs
     {
         /// <summary>
-        /// Initializes a new instance of the <see cref="ClearCacheEventArgs" /> class.
+        /// Initializes a new instance of the <see cref="ClearCacheEventArgs"/> class.
         /// </summary>
-        /// <param name="e">/param>
+        /// <param name="e">The event.</param>
         public ClearCacheEventArgs(ClearCacheEvent e)
         {
         }

diff --git a/Source/ParTech.Modules.UrlRewriter/Events/ClearCacheEventHandler.cs b/Source/ParTech.Modules.UrlRewriter/Events/ClearCacheEventHandler.cs
@@ -1,9 +1,9 @@
-using System;
-using ParTech.Modules.UrlRewriter.Pipelines;
-using Sitecore.Events;
-
-namespace ParTech.Modules.UrlRewriter.Events
+namespace ParTech.Modules.UrlRewriter.Events
 {
+    using System;
+    using ParTech.Modules.UrlRewriter.Pipelines;
+    using Sitecore.Events;
+
     /// <summary>
     /// Handles cache clearing for the URL Rewriter.
     /// </summary>

diff --git a/Source/ParTech.Modules.UrlRewriter/Hooks/ClearCacheHook.cs b/Source/ParTech.Modules.UrlRewriter/Hooks/ClearCacheHook.cs
@@ -1,10 +1,10 @@
-using System;
-using ParTech.Modules.UrlRewriter.Events;
-using Sitecore.Eventing;
-using Sitecore.Events.Hooks;
-
-namespace ParTech.Modules.UrlRewriter.Hooks
+namespace ParTech.Modules.UrlRewriter.Hooks
 {
+    using System;
+    using ParTech.Modules.UrlRewriter.Events;
+    using Sitecore.Eventing;
+    using Sitecore.Events.Hooks;
+
     /// <summary>
     /// Hook that subscribes the ClearCacheEvent to the EventQueue.
     /// </summary>

diff --git a/Source/ParTech.Modules.UrlRewriter/ItemIds.cs b/Source/ParTech.Modules.UrlRewriter/ItemIds.cs
@@ -1,37 +1,12 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using Sitecore.Data;
-
-namespace ParTech.Modules.UrlRewriter
+namespace ParTech.Modules.UrlRewriter
 {
+    using Sitecore.Data;
+
     /// <summary>
     /// References to Sitecore item ID's that belong to the Url Rewriter module.
     /// </summary>
     public static class ItemIds
     {
-        /// <summary>
-        /// References to Sitecore templates that belong to the Url Rewriter module.
-        /// </summary>
-        public static class Templates
-        {
-            /// <summary>
-            /// Gets the ID for the Hostname Rewrite Rule template.
-            /// </summary>
-            public static readonly ID HostNameRewriteRule = new ID("{C0884868-FE60-4AD3-91DD-A5DB6DC1FA16}");
-
-            /// <summary>
-            /// Gets the ID for the URL Rewrite Rule template.
-            /// </summary>
-            public static readonly ID UrlRewriteRule = new ID("{24DB2387-14C3-46E3-B9B0-362E0D787424}");
-
-            /// <summary>
-            /// Gets the ID for the Rewrite Rules Folder template.
-            /// </summary>
-            public static readonly ID RewriteRulesFolder = new ID("{CBF22343-A180-46E9-B20D-329C9382E10C}");
-        }
-
         /// <summary>
         /// References to Sitecore fields that belong to the Url Rewriter module.
         /// </summary>
@@ -57,5 +32,26 @@ public static class Fields
             /// </summary>
             public static readonly ID TargetHostName = new ID("{BE421AF4-DA73-4F12-89B5-2FBEFF6B7633}");
         }
+
+        /// <summary>
+        /// References to Sitecore templates that belong to the Url Rewriter module.
+        /// </summary>
+        public static class Templates
+        {
+            /// <summary>
+            /// Gets the ID for the Hostname Rewrite Rule template.
+            /// </summary>
+            public static readonly ID HostNameRewriteRule = new ID("{C0884868-FE60-4AD3-91DD-A5DB6DC1FA16}");
+
+            /// <summary>
+            /// Gets the ID for the URL Rewrite Rule template.
+            /// </summary>
+            public static readonly ID UrlRewriteRule = new ID("{24DB2387-14C3-46E3-B9B0-362E0D787424}");
+
+            /// <summary>
+            /// Gets the ID for the Rewrite Rules Folder template.
+            /// </summary>
+            public static readonly ID RewriteRulesFolder = new ID("{CBF22343-A180-46E9-B20D-329C9382E10C}");
+        }
     }
 }
diff --git a/Source/ParTech.Modules.UrlRewriter/Logging.cs b/Source/ParTech.Modules.UrlRewriter/Logging.cs
@@ -1,11 +1,7 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using Sitecore.Diagnostics;
-
-namespace ParTech.Modules.UrlRewriter
+namespace ParTech.Modules.UrlRewriter
 {
+    using Sitecore.Diagnostics;
+
     /// <summary>
     /// Provides methods for writing messages to the Sitecore log.
     /// </summary>
@@ -36,4 +32,4 @@ public static void LogInfo(string message, object owner)
             Log.Info(string.Format(logMessageFormat, message), owner);
         }
     }
-}
+}
diff --git a/Source/ParTech.Modules.UrlRewriter/Models/HostNameRewriteRule.cs b/Source/ParTech.Modules.UrlRewriter/Models/HostNameRewriteRule.cs
@@ -1,13 +1,9 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Text.RegularExpressions;
-using Sitecore.Data;
-using Sitecore.Data.Items;
-
-namespace ParTech.Modules.UrlRewriter.Models
+namespace ParTech.Modules.UrlRewriter.Models
 {
+    using System.Text.RegularExpressions;
+    using Sitecore.Data;
+    using Sitecore.Data.Items;
+
     /// <summary>
     /// Represents a domain rewriting rule.
     /// </summary>
@@ -86,4 +82,4 @@ public bool Validate()
             return true;
         }
     }
-}
+}
diff --git a/Source/ParTech.Modules.UrlRewriter/Models/UrlRewriteRule.cs b/Source/ParTech.Modules.UrlRewriter/Models/UrlRewriteRule.cs
@@ -1,12 +1,9 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using Sitecore.Data;
-using Sitecore.Data.Items;
-
-namespace ParTech.Modules.UrlRewriter.Models
+namespace ParTech.Modules.UrlRewriter.Models
 {
+    using System;
+    using Sitecore.Data;
+    using Sitecore.Data.Items;
+
     /// <summary>
     /// Represents a URL rewriting rule.
     /// </summary>
@@ -19,7 +16,7 @@ public class UrlRewriteRule
         /// Expected format is a relative or absolute URL (including protocol and hostname) and optionally a querystring.
         /// e.g. /myfolder/mypage.html or http://www.mydomain.com/myfolder/mypage.html
         /// </remarks>
-        private string sourceUrl;
+        private readonly string sourceUrl;
 
         /// <summary>
         /// Sitecore field value for the target URL.
@@ -28,7 +25,7 @@ public class UrlRewriteRule
         /// Expected format is a relative or absolute URL (including protocol and hostname) and optionally a querystring.
         /// e.g. /myfolder/mypage.html or http://www.mydomain.com/myfolder/mypage.html
         /// </remarks>
-        private string targetUrl;
+        private readonly string targetUrl;
 
         /// <summary>
         /// Initializes a new instance of the <see cref="UrlRewriteRule" /> class.
@@ -58,7 +55,7 @@ public Uri GetSourceUrl(Uri requestUrl)
 
             if (!Uri.IsWellFormedUriString(absoluteSourceUrl, UriKind.Absolute))
             {
-                Logging.LogError(string.Format("Source URL '{0}' defined in rewrite rule item '{1}' is not well formed.", absoluteSourceUrl, ItemId), this);
+                Logging.LogError(string.Format("Source URL '{0}' defined in rewrite rule item '{1}' is not well formed.", absoluteSourceUrl, this.ItemId), this);
                 return default(Uri);
             }
 
@@ -76,13 +73,13 @@ public Uri GetTargetUrl(Uri requestUrl)
 
             if (!Uri.IsWellFormedUriString(absoluteTargetUrl, UriKind.Absolute))
             {
-                Logging.LogError(string.Format("Target URL '{0}' defined in rewrite rule item '{1}' is not well formed.", absoluteTargetUrl, ItemId), this);
+                Logging.LogError(string.Format("Target URL '{0}' defined in rewrite rule item '{1}' is not well formed.", absoluteTargetUrl, this.ItemId), this);
                 return default(Uri);
             }
 
             return new Uri(absoluteTargetUrl);
         }
-        
+
         /// <summary>
         /// Validate the values of this rule and write an error to the Sitecore log if it's invalid.
         /// </summary>

diff --git a/Source/ParTech.Modules.UrlRewriter/ParTech.Modules.UrlRewriter.csproj b/Source/ParTech.Modules.UrlRewriter/ParTech.Modules.UrlRewriter.csproj
@@ -12,6 +12,7 @@
     <TargetFrameworkVersion>v4.0</TargetFrameworkVersion>
     <FileAlignment>512</FileAlignment>
     <TargetFrameworkProfile />
+    <StyleCopTreatErrorsAsWarnings>false</StyleCopTreatErrorsAsWarnings>
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
     <DebugSymbols>true</DebugSymbols>
@@ -63,6 +64,7 @@
     <Compile Include="UrlRewriterException.cs" />
   </ItemGroup>
   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
+  <Import Project="$(SolutionDir)..\References\StyleCop\MSBuild\StyleCop.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.
   <Target Name="BeforeBuild">

diff --git a/Source/ParTech.Modules.UrlRewriter/Pipelines/ApplyHelpNotifications.cs b/Source/ParTech.Modules.UrlRewriter/Pipelines/ApplyHelpNotifications.cs
@@ -1,20 +1,24 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Web;
-using Sitecore.Pipelines.GetContentEditorWarnings;
-
-namespace ParTech.Modules.UrlRewriter.Pipelines
+namespace ParTech.Modules.UrlRewriter.Pipelines
 {
+    using System.Linq;
+    using System.Web;
+    using Sitecore.Pipelines.GetContentEditorWarnings;
+
     /// <summary>
     /// Implements an instruction manual on rewrite rules by adding Content Editor warnings when editing rewrite rule items.
     /// </summary>
     public class ApplyHelpNotifications
     {
-        private readonly string urlHelpHideStateCookieName = "url-rewrite-help-hide";
+        /// <summary>
+        /// The cookie name for the cookie that tracks the state of the hostname rewrite rule instructions.
+        /// </summary>
         private readonly string hostNameHelpHideStateCookieName = "hostname-rewrite-help-hide";
 
+        /// <summary>
+        /// The cookie name for the cookie that tracks the state of the url rewrite rule instructions.
+        /// </summary>
+        private readonly string urlHelpHideStateCookieName = "url-rewrite-help-hide";
+
         /// <summary>
         /// Process the pipeline processor.
         /// </summary>
@@ -164,4 +168,4 @@ private string GetHideLink(string cookieName)
                     [Hide instructions]</a>";
         }
     }
-}
+}