add support Tag.Required

dotnetcore · Mar 19, 2019 · 3efed8a · 3efed8a
1 parent 4a5cc47
commit 3efed8a
Show file tree

Hide file tree

Showing 36 changed files with 70 additions and 25 deletions.
diff --git a/build/version.props b/build/version.props
@@ -2,7 +2,7 @@
 	<PropertyGroup>
 		<VersionMajor>4</VersionMajor>
 		<VersionMinor>0</VersionMinor>
-		<VersionPatch>0-rc3</VersionPatch>
+		<VersionPatch>0-rc4</VersionPatch>
 		<VersionPrefix>$(VersionMajor).$(VersionMinor).$(VersionPatch)</VersionPrefix>
 	</PropertyGroup>
 </Project>
diff --git a/doc/SmartSqlMap-v4.xsd b/doc/SmartSqlMap-v4.xsd
@@ -221,6 +221,7 @@
       </xs:sequence>
       <xs:attribute name="Prepend" type="xs:string" use="optional" />
       <xs:attribute name="Property" type="xs:string" use="required" />
+      <xs:attribute name="Required" type="xs:boolean" use="optional" />
     </xs:complexType>
   </xs:element>
   <xs:element name="IsEmpty">
@@ -250,6 +251,7 @@
       </xs:choice>
       <xs:attribute name="Prepend" type="xs:string" use="optional" />
       <xs:attribute name="Property" type="xs:string" use="required" />
+      <xs:attribute name="Required" type="xs:boolean" use="optional" />
     </xs:complexType>
   </xs:element>
   <xs:element name="IsEqual">
@@ -279,6 +281,7 @@
       </xs:choice>
       <xs:attribute name="Prepend" type="xs:string" use="optional" />
       <xs:attribute name="Property" type="xs:string" use="required" />
+      <xs:attribute name="Required" type="xs:boolean" use="optional" />
       <xs:attribute name="CompareValue" type="xs:string" use="required" />
     </xs:complexType>
   </xs:element>
@@ -309,6 +312,7 @@
       </xs:choice>
       <xs:attribute name="Prepend" type="xs:string" use="optional" />
       <xs:attribute name="Property" type="xs:string" use="required" />
+      <xs:attribute name="Required" type="xs:boolean" use="optional" />
       <xs:attribute name="CompareValue" type="xs:string" use="required" />
     </xs:complexType>
   </xs:element>
@@ -339,6 +343,7 @@
       </xs:choice>
       <xs:attribute name="Prepend" type="xs:string" use="optional" />
       <xs:attribute name="Property" type="xs:string" use="required" />
+      <xs:attribute name="Required" type="xs:boolean" use="optional" />
       <xs:attribute name="CompareValue" type="xs:string" use="required" />
     </xs:complexType>
   </xs:element>
@@ -369,6 +374,7 @@
       </xs:choice>
       <xs:attribute name="Prepend" type="xs:string" use="optional" />
       <xs:attribute name="Property" type="xs:string" use="required" />
+      <xs:attribute name="Required" type="xs:boolean" use="optional" />
       <xs:attribute name="CompareValue" type="xs:string" use="required" />
     </xs:complexType>
   </xs:element>
@@ -399,6 +405,7 @@
       </xs:choice>
       <xs:attribute name="Prepend" type="xs:string" use="optional" />
       <xs:attribute name="Property" type="xs:string" use="required" />
+      <xs:attribute name="Required" type="xs:boolean" use="optional" />
       <xs:attribute name="CompareValue" type="xs:string" use="required" />
     </xs:complexType>
   </xs:element>
@@ -429,6 +436,7 @@
       </xs:choice>
       <xs:attribute name="Prepend" type="xs:string" use="optional" />
       <xs:attribute name="Property" type="xs:string" use="required" />
+      <xs:attribute name="Required" type="xs:boolean" use="optional" />
     </xs:complexType>
   </xs:element>
   <xs:element name="IsNotEqual">
@@ -458,6 +466,7 @@
       </xs:choice>
       <xs:attribute name="Prepend" type="xs:string" use="optional" />
       <xs:attribute name="Property" type="xs:string" use="required" />
+      <xs:attribute name="Required" type="xs:boolean" use="optional" />
       <xs:attribute name="CompareValue" type="xs:string" use="required" />
     </xs:complexType>
   </xs:element>
@@ -488,6 +497,7 @@
       </xs:choice>
       <xs:attribute name="Prepend" type="xs:string" use="optional" />
       <xs:attribute name="Property" type="xs:string" use="required" />
+      <xs:attribute name="Required" type="xs:boolean" use="optional" />
     </xs:complexType>
   </xs:element>
   <xs:element name="IsNull">
@@ -517,6 +527,7 @@
       </xs:choice>
       <xs:attribute name="Prepend" type="xs:string" use="optional" />
       <xs:attribute name="Property" type="xs:string" use="required" />
+      <xs:attribute name="Required" type="xs:boolean" use="optional" />
     </xs:complexType>
   </xs:element>
   <xs:element name="IsTrue">
@@ -546,6 +557,7 @@
       </xs:choice>
       <xs:attribute name="Prepend" type="xs:string" use="optional" />
       <xs:attribute name="Property" type="xs:string" use="required" />
+      <xs:attribute name="Required" type="xs:boolean" use="optional" />
     </xs:complexType>
   </xs:element>
   <xs:element name="IsFalse">
@@ -575,6 +587,7 @@
       </xs:choice>
       <xs:attribute name="Prepend" type="xs:string" use="optional" />
       <xs:attribute name="Property" type="xs:string" use="required" />
+      <xs:attribute name="Required" type="xs:boolean" use="optional" />
     </xs:complexType>
   </xs:element>
   <xs:element name="IsProperty">
@@ -638,6 +651,7 @@
     <xs:complexType mixed="true">
       <xs:attribute name="Prepend" type="xs:string" use="optional" />
       <xs:attribute name="Property" type="xs:string" use="required" />
+      <xs:attribute name="Required" type="xs:boolean" use="optional" />
     </xs:complexType>
   </xs:element>
   <xs:element name="Dynamic">
@@ -748,6 +762,7 @@
       </xs:choice>
       <xs:attribute name="Prepend" type="xs:string" use="optional" />
       <xs:attribute name="Property" type="xs:string" use="required" />
+      <xs:attribute name="Required" type="xs:boolean" use="optional" />
       <xs:attribute name="Open" type="xs:string" use="required" />
       <xs:attribute name="Separator" type="xs:string" use="required" />
       <xs:attribute name="Close" type="xs:string" use="required" />

diff --git a/src/SmartSql/Configuration/Tags/For.cs b/src/SmartSql/Configuration/Tags/For.cs
@@ -16,7 +16,7 @@ public class For : Tag
 
         public override bool IsCondition(RequestContext context)
         {
-            var reqVal = GetPropertyValue(context);
+            var reqVal = EnsurePropertyValue(context);
             if (reqVal == null) { return false; }
             if (reqVal is IEnumerable)
             {
@@ -27,7 +27,7 @@ public override bool IsCondition(RequestContext context)
         public override void BuildChildSql(RequestContext context)
         {
             context.SqlBuilder.Append(Open);
-            var reqVal = (GetPropertyValue(context) as IEnumerable).GetEnumerator();
+            var reqVal = (EnsurePropertyValue(context) as IEnumerable).GetEnumerator();
             reqVal.MoveNext();
             if (string.IsNullOrEmpty(Key))
             {
@@ -47,7 +47,7 @@ public override void BuildChildSql(RequestContext context)
         }
         private void BuildItemSql(string itemSqlStr, RequestContext context)
         {
-            var reqVal = (GetPropertyValue(context) as IEnumerable);
+            var reqVal = (EnsurePropertyValue(context) as IEnumerable);
             int item_index = 0;
             string dbPrefix = GetDbProviderPrefix(context);
             foreach (var itemVal in reqVal)

diff --git a/src/SmartSql/Configuration/Tags/IsEmpty.cs b/src/SmartSql/Configuration/Tags/IsEmpty.cs
@@ -10,7 +10,7 @@ public class IsEmpty : Tag
     {
         public override bool IsCondition(RequestContext context)
         {
-            Object reqVal = GetPropertyValue(context);
+            Object reqVal = EnsurePropertyValue(context);
             if (reqVal == null)
             {
                 return true;

diff --git a/src/SmartSql/Configuration/Tags/IsEqual.cs b/src/SmartSql/Configuration/Tags/IsEqual.cs
@@ -9,7 +9,7 @@ public class IsEqual : StringCompareTag
     {
         public override bool IsCondition(RequestContext context)
         {
-            var reqVal = GetPropertyValue(context);
+            var reqVal = EnsurePropertyValue(context);
             if (reqVal == null) { return false; }
             string reqValStr = string.Empty;
             if (reqVal is Enum)

diff --git a/src/SmartSql/Configuration/Tags/IsFalse.cs b/src/SmartSql/Configuration/Tags/IsFalse.cs
@@ -8,7 +8,7 @@ public class IsFalse : Tag
     {
         public override bool IsCondition(RequestContext context)
         {
-            Object reqVal = GetPropertyValue(context);
+            Object reqVal = EnsurePropertyValue(context);
             if (reqVal is Boolean)
             {
                 return (bool)reqVal == false;

diff --git a/src/SmartSql/Configuration/Tags/IsGreaterEqual.cs b/src/SmartSql/Configuration/Tags/IsGreaterEqual.cs
@@ -9,7 +9,7 @@ public class IsGreaterEqual : NumericalCompareTag
     {
         public override bool IsCondition(RequestContext context)
         {
-            Object reqVal = GetPropertyValue(context);
+            Object reqVal = EnsurePropertyValue(context);
             if (reqVal == null) { return false; }
             Decimal reqValNum = 0M;
             if (reqVal is Enum)

diff --git a/src/SmartSql/Configuration/Tags/IsGreaterThan.cs b/src/SmartSql/Configuration/Tags/IsGreaterThan.cs
@@ -9,7 +9,7 @@ public class IsGreaterThan : NumericalCompareTag
     {
         public override bool IsCondition(RequestContext context)
         {
-            Object reqVal = GetPropertyValue(context);
+            Object reqVal = EnsurePropertyValue(context);
             if (reqVal == null) { return false; }
 
             Decimal reqValNum = 0M;

diff --git a/src/SmartSql/Configuration/Tags/IsLessEqual.cs b/src/SmartSql/Configuration/Tags/IsLessEqual.cs
@@ -9,7 +9,7 @@ public class IsLessEqual : NumericalCompareTag
     {
         public override bool IsCondition(RequestContext context)
         {
-            Object reqVal = GetPropertyValue(context);
+            Object reqVal = EnsurePropertyValue(context);
             if (reqVal == null) { return false; }
             Decimal reqValNum = 0M;
             if (reqVal is Enum)

diff --git a/src/SmartSql/Configuration/Tags/IsLessThan.cs b/src/SmartSql/Configuration/Tags/IsLessThan.cs
@@ -8,7 +8,7 @@ public class IsLessThan : NumericalCompareTag
     {
         public override bool IsCondition(RequestContext context)
         {
-            Object reqVal = GetPropertyValue(context);
+            Object reqVal = EnsurePropertyValue(context);
             if (reqVal == null) { return false; }
             Decimal reqValNum = 0M;
             if (reqVal is Enum)

diff --git a/src/SmartSql/Configuration/Tags/IsNotEmpty.cs b/src/SmartSql/Configuration/Tags/IsNotEmpty.cs
@@ -10,7 +10,7 @@ public class IsNotEmpty : Tag
     {
         public override bool IsCondition(RequestContext context)
         {
-            Object reqVal = GetPropertyValue(context);
+            Object reqVal = EnsurePropertyValue(context);
             if (reqVal == null)
             {
                 return false;

diff --git a/src/SmartSql/Configuration/Tags/IsNotEqual.cs b/src/SmartSql/Configuration/Tags/IsNotEqual.cs
@@ -9,7 +9,7 @@ public class IsNotEqual : StringCompareTag
     {
         public override bool IsCondition(RequestContext context)
         {
-            Object reqVal = GetPropertyValue(context);
+            Object reqVal = EnsurePropertyValue(context);
             if (reqVal == null) { return false; }
             string reqValStr = string.Empty;
             if (reqVal is Enum)

diff --git a/src/SmartSql/Configuration/Tags/IsNotNull.cs b/src/SmartSql/Configuration/Tags/IsNotNull.cs
@@ -8,7 +8,7 @@ public class IsNotNull : Tag
     {
         public override bool IsCondition(RequestContext context)
         {
-            Object reqVal = GetPropertyValue(context);
+            Object reqVal = EnsurePropertyValue(context);
             return reqVal != null;
         }
     }

diff --git a/src/SmartSql/Configuration/Tags/IsNull.cs b/src/SmartSql/Configuration/Tags/IsNull.cs
@@ -8,7 +8,7 @@ public class IsNull : Tag
     {
         public override bool IsCondition(RequestContext context)
         {
-            Object reqVal = GetPropertyValue(context);
+            Object reqVal = EnsurePropertyValue(context);
             return reqVal == null;
         }
     }

diff --git a/src/SmartSql/Configuration/Tags/IsTrue.cs b/src/SmartSql/Configuration/Tags/IsTrue.cs
@@ -6,7 +6,7 @@ public class IsTrue : Tag
     {
         public override bool IsCondition(RequestContext context)
         {
-            Object reqVal = GetPropertyValue(context);
+            Object reqVal = EnsurePropertyValue(context);
             if (reqVal is Boolean)
             {
                 return (bool)reqVal == true;

diff --git a/src/SmartSql/Configuration/Tags/Placeholder.cs b/src/SmartSql/Configuration/Tags/Placeholder.cs
@@ -10,7 +10,7 @@ public override void BuildSql(RequestContext context)
         {
             if (IsCondition(context))
             {
-                Object reqVal = GetPropertyValue(context);
+                Object reqVal = EnsurePropertyValue(context);
                 context.SqlBuilder.Append($"{Prepend}{reqVal}");
             }
         }

diff --git a/src/SmartSql/Configuration/Tags/Switch.cs b/src/SmartSql/Configuration/Tags/Switch.cs
@@ -7,6 +7,7 @@ public class Switch : Tag
     {
         public override bool IsCondition(RequestContext context)
         {
+            EnsurePropertyValue(context);
             return true;
         }
         public override void BuildSql(RequestContext context)
@@ -35,7 +36,7 @@ public class Case : StringCompareTag
         {
             public override bool IsCondition(RequestContext context)
             {
-                var reqVal = GetPropertyValue(context);
+                var reqVal = EnsurePropertyValue(context);
                 if (reqVal == null) { return false; }
                 string reqValStr = string.Empty;
                 if (reqVal is Enum)

diff --git a/src/SmartSql/Configuration/Tags/Tag.cs b/src/SmartSql/Configuration/Tags/Tag.cs
@@ -1,4 +1,5 @@
-using System;
+using SmartSql.Exceptions;
+using System;
 using System.Collections.Generic;
 
 namespace SmartSql.Configuration.Tags
@@ -7,6 +8,7 @@ public abstract class Tag : ITag
     {
         public virtual String Prepend { get; set; }
         public String Property { get; set; }
+        public bool Required { get; set; }
         public IList<ITag> ChildTags { get; set; }
         public ITag Parent { get; set; }
         public Statement Statement { get; set; }
@@ -45,9 +47,13 @@ protected virtual String GetDbProviderPrefix(RequestContext context)
             return context.ExecutionContext.SmartSqlConfig.Settings.ParameterPrefix;
         }
 
-        protected virtual Object GetPropertyValue(RequestContext context)
+        protected virtual Object EnsurePropertyValue(RequestContext context)
         {
-            context.Parameters.TryGetParameterValue(Property, out object paramVal);
+            var existProperty = context.Parameters.TryGetParameterValue(Property, out object paramVal);
+            if (Required && !existProperty)
+            {
+                throw new SmartSqlException($"Statement:{Statement.FullSqlId} Tag:{Property} Required fail.");
+            }
             return paramVal;
         }
     }

diff --git a/src/SmartSql/Configuration/Tags/TagBuilders/AbstractTagBuilder.cs b/src/SmartSql/Configuration/Tags/TagBuilders/AbstractTagBuilder.cs
@@ -8,9 +8,10 @@ namespace SmartSql.Configuration.Tags.TagBuilders
 {
     public abstract class AbstractTagBuilder : ITagBuilder
     {
-        private const String PREPEND = "Prepend";
-        private const String PROPERTY = "Property";
-        private const String COMPARE_VALUE = "CompareValue";
+        private const String PREPEND = nameof(Tag.Prepend);
+        private const String PROPERTY = nameof(Tag.Property);
+        private const String REQUIRED = nameof(Tag.Required);
+        private const String COMPARE_VALUE = nameof(NumericalCompareTag.CompareValue);
         public abstract ITag Build(XmlNode xmlNode, Statement statement);
 
         public String GetXmlAttributeValue(XmlNode xmlNode, string attributeName)
@@ -22,7 +23,7 @@ public Decimal GetXmlAttributeValueAsDecimal(XmlNode xmlNode, string attributeNa
             string strVal = GetXmlAttributeValue(xmlNode, attributeName);
             if (!Decimal.TryParse(strVal, out decimal decimalVal))
             {
-                throw new SmartSqlException();
+                throw new SmartSqlException($"can not convert {strVal} to decimal from xml-node:{xmlNode.Value}.");
             }
             return decimalVal;
         }
@@ -35,6 +36,11 @@ public String GetProperty(XmlNode xmlNode)
         {
             return GetXmlAttributeValue(xmlNode, PROPERTY);
         }
+        public bool GetRequired(XmlNode xmlNode)
+        {
+            xmlNode.Attributes.TryGetValueAsBoolean(REQUIRED, out var requiredVal);
+            return requiredVal;
+        }
         public String GetCompareValue(XmlNode xmlNode)
         {
             return GetXmlAttributeValue(xmlNode, COMPARE_VALUE);

diff --git a/src/SmartSql/Configuration/Tags/TagBuilders/ForBuilder.cs b/src/SmartSql/Configuration/Tags/TagBuilders/ForBuilder.cs
@@ -13,6 +13,7 @@ public override ITag Build(XmlNode xmlNode, Statement statement)
             {
                 Property = GetProperty(xmlNode),
                 Prepend = GetPrepend(xmlNode),
+                Required = GetRequired(xmlNode),
                 Open = GetXmlAttributeValue(xmlNode, nameof(For.Open)),
                 Close = GetXmlAttributeValue(xmlNode, nameof(For.Close)),
                 Separator = GetXmlAttributeValue(xmlNode, nameof(For.Separator)),

diff --git a/src/SmartSql/Configuration/Tags/TagBuilders/IsEmptyBuilder.cs b/src/SmartSql/Configuration/Tags/TagBuilders/IsEmptyBuilder.cs
@@ -13,6 +13,7 @@ public override ITag Build(XmlNode xmlNode, Statement statement)
             {
                 Property = GetProperty(xmlNode),
                 Prepend = GetPrepend(xmlNode),
+                Required = GetRequired(xmlNode),
                 ChildTags = new List<ITag>(),
                 Statement = statement
             };

diff --git a/src/SmartSql/Configuration/Tags/TagBuilders/IsEqualBuilder.cs b/src/SmartSql/Configuration/Tags/TagBuilders/IsEqualBuilder.cs
@@ -13,6 +13,7 @@ public override ITag Build(XmlNode xmlNode, Statement statement)
             {
                 Property = GetProperty(xmlNode),
                 Prepend = GetPrepend(xmlNode),
+                Required = GetRequired(xmlNode),
                 CompareValue = GetCompareValue(xmlNode),
                 ChildTags = new List<ITag>(),
                 Statement = statement

diff --git a/src/SmartSql/Configuration/Tags/TagBuilders/IsFalseBuilder.cs b/src/SmartSql/Configuration/Tags/TagBuilders/IsFalseBuilder.cs
@@ -13,6 +13,7 @@ public override ITag Build(XmlNode xmlNode, Statement statement)
             {
                 Property = GetProperty(xmlNode),
                 Prepend = GetPrepend(xmlNode),
+                Required = GetRequired(xmlNode),
                 ChildTags = new List<ITag>(),
                 Statement = statement
             };

diff --git a/src/SmartSql/Configuration/Tags/TagBuilders/IsGreaterEqualBuilder.cs b/src/SmartSql/Configuration/Tags/TagBuilders/IsGreaterEqualBuilder.cs
@@ -13,6 +13,7 @@ public override ITag Build(XmlNode xmlNode, Statement statement)
             {
                 Property = GetProperty(xmlNode),
                 Prepend = GetPrepend(xmlNode),
+                Required = GetRequired(xmlNode),
                 CompareValue = GetCompareValueAsDecimal(xmlNode),
                 ChildTags = new List<ITag>(),
                 Statement = statement