Clean code (C#)












0














I Want to write clean and easy to maintainable code. What can I improve on below code?



Below is example of my masterdata service, which receive master data as json input, after some validation I need to create/update/delete master data into Cosmos DB.



public class MasterService : IMasterService
{
private readonly IMasterDao masterDataService;
private readonly ILog log;

public MasterService(IMasterDao masterDataService, ILog log)
{
this.log = log;
this.masterDataService = masterDataService;
}

public async Task<bool> UpdateMasterData(string message, string windowsZonesFilePath)
{
this.ValidateArgument<ArgumentException>(() => string.IsNullOrWhiteSpace(message), "Invalid MasterData Message");
Dictionary<string, object> json = JsonConvert.DeserializeObject<Dictionary<string, object>>(message);
this.ValidateArgument<ArgumentException>(() => !json.ContainsKey("OperationType"), "OperationType doesn't exist");
this.ValidateArgument<ArgumentException>(() => !json.ContainsKey("AssetType"), "AssetType doesn't exist");
this.ValidateArgument<ArgumentException>(() => !json.ContainsKey("AssetId"), "AssetId doesn't exist");

string operationType = json["OperationType"].ToString().ToUpper();
string assetType = json["AssetType"].ToString();
string assetId = json["AssetId"].ToString();
//TimeZone only mandatory for Plant asset
if (assetType.Equals("Plant", StringComparison.InvariantCultureIgnoreCase) && json.ContainsKey("PlantAffiliationType")
&& json["PlantAffiliationType"].ToString().Equals("owner", StringComparison.InvariantCultureIgnoreCase))
{
this.ValidateArgument<ArgumentException>(() => !json.ContainsKey("TimeZone"), "TimeZone doesn't exist");
string timeZone = json["TimeZone"].ToString();
string newTimeZone = GetTimeZone(windowsZonesFilePath, timeZone);
json["TimeZone"] = newTimeZone;
}

log.Info($"DATA received for AssetType : {assetType} with AssetId : {assetId} and operationType : {operationType}");

if (!json.Keys.Contains("ApplicationName"))
json.Add("ApplicationName", AMSConstraints.ApplicationName);

JObject newMessage = JObject.Parse(JsonConvert.SerializeObject(json));

if (operationType.Equals(OperationType.New.ToString(), StringComparison.InvariantCultureIgnoreCase))
{
log.Info($"Adding in database");
await this.masterDataService.CreateAsync(newMessage);
return true;
}
else if (operationType.Equals(OperationType.Update.ToString(), StringComparison.InvariantCultureIgnoreCase))
{
log.Info($"Replacing in database");
return await this.masterDataService.UpdateDocumentByAsset(assetId, assetType, newMessage);
}
else if (operationType.Equals(OperationType.Delete.ToString(), StringComparison.InvariantCultureIgnoreCase))
{
log.Info($"Deleting Document");
return await this.masterDataService.DeleteAsset(assetId, assetType);
}
return false;
}

private string GetTimeZone(string filePath, string timeZone)
{
XDocument xdoc = XDocument.Load(filePath);
return xdoc.Descendants("mapZone")
.Where(x => x.Attribute("other").Value.Equals(timeZone, StringComparison.InvariantCultureIgnoreCase))
.Select(x => (string)x.Attribute("type"))
.FirstOrDefault();
}

private void ValidateArgument<exType>(Func<bool> validation, string errorMessage) where exType : Exception
{
if (validation())
{
throw Activator.CreateInstance(typeof(exType), errorMessage) as exType;
}
}
}








share



























    0














    I Want to write clean and easy to maintainable code. What can I improve on below code?



    Below is example of my masterdata service, which receive master data as json input, after some validation I need to create/update/delete master data into Cosmos DB.



    public class MasterService : IMasterService
    {
    private readonly IMasterDao masterDataService;
    private readonly ILog log;

    public MasterService(IMasterDao masterDataService, ILog log)
    {
    this.log = log;
    this.masterDataService = masterDataService;
    }

    public async Task<bool> UpdateMasterData(string message, string windowsZonesFilePath)
    {
    this.ValidateArgument<ArgumentException>(() => string.IsNullOrWhiteSpace(message), "Invalid MasterData Message");
    Dictionary<string, object> json = JsonConvert.DeserializeObject<Dictionary<string, object>>(message);
    this.ValidateArgument<ArgumentException>(() => !json.ContainsKey("OperationType"), "OperationType doesn't exist");
    this.ValidateArgument<ArgumentException>(() => !json.ContainsKey("AssetType"), "AssetType doesn't exist");
    this.ValidateArgument<ArgumentException>(() => !json.ContainsKey("AssetId"), "AssetId doesn't exist");

    string operationType = json["OperationType"].ToString().ToUpper();
    string assetType = json["AssetType"].ToString();
    string assetId = json["AssetId"].ToString();
    //TimeZone only mandatory for Plant asset
    if (assetType.Equals("Plant", StringComparison.InvariantCultureIgnoreCase) && json.ContainsKey("PlantAffiliationType")
    && json["PlantAffiliationType"].ToString().Equals("owner", StringComparison.InvariantCultureIgnoreCase))
    {
    this.ValidateArgument<ArgumentException>(() => !json.ContainsKey("TimeZone"), "TimeZone doesn't exist");
    string timeZone = json["TimeZone"].ToString();
    string newTimeZone = GetTimeZone(windowsZonesFilePath, timeZone);
    json["TimeZone"] = newTimeZone;
    }

    log.Info($"DATA received for AssetType : {assetType} with AssetId : {assetId} and operationType : {operationType}");

    if (!json.Keys.Contains("ApplicationName"))
    json.Add("ApplicationName", AMSConstraints.ApplicationName);

    JObject newMessage = JObject.Parse(JsonConvert.SerializeObject(json));

    if (operationType.Equals(OperationType.New.ToString(), StringComparison.InvariantCultureIgnoreCase))
    {
    log.Info($"Adding in database");
    await this.masterDataService.CreateAsync(newMessage);
    return true;
    }
    else if (operationType.Equals(OperationType.Update.ToString(), StringComparison.InvariantCultureIgnoreCase))
    {
    log.Info($"Replacing in database");
    return await this.masterDataService.UpdateDocumentByAsset(assetId, assetType, newMessage);
    }
    else if (operationType.Equals(OperationType.Delete.ToString(), StringComparison.InvariantCultureIgnoreCase))
    {
    log.Info($"Deleting Document");
    return await this.masterDataService.DeleteAsset(assetId, assetType);
    }
    return false;
    }

    private string GetTimeZone(string filePath, string timeZone)
    {
    XDocument xdoc = XDocument.Load(filePath);
    return xdoc.Descendants("mapZone")
    .Where(x => x.Attribute("other").Value.Equals(timeZone, StringComparison.InvariantCultureIgnoreCase))
    .Select(x => (string)x.Attribute("type"))
    .FirstOrDefault();
    }

    private void ValidateArgument<exType>(Func<bool> validation, string errorMessage) where exType : Exception
    {
    if (validation())
    {
    throw Activator.CreateInstance(typeof(exType), errorMessage) as exType;
    }
    }
    }








    share

























      0












      0








      0







      I Want to write clean and easy to maintainable code. What can I improve on below code?



      Below is example of my masterdata service, which receive master data as json input, after some validation I need to create/update/delete master data into Cosmos DB.



      public class MasterService : IMasterService
      {
      private readonly IMasterDao masterDataService;
      private readonly ILog log;

      public MasterService(IMasterDao masterDataService, ILog log)
      {
      this.log = log;
      this.masterDataService = masterDataService;
      }

      public async Task<bool> UpdateMasterData(string message, string windowsZonesFilePath)
      {
      this.ValidateArgument<ArgumentException>(() => string.IsNullOrWhiteSpace(message), "Invalid MasterData Message");
      Dictionary<string, object> json = JsonConvert.DeserializeObject<Dictionary<string, object>>(message);
      this.ValidateArgument<ArgumentException>(() => !json.ContainsKey("OperationType"), "OperationType doesn't exist");
      this.ValidateArgument<ArgumentException>(() => !json.ContainsKey("AssetType"), "AssetType doesn't exist");
      this.ValidateArgument<ArgumentException>(() => !json.ContainsKey("AssetId"), "AssetId doesn't exist");

      string operationType = json["OperationType"].ToString().ToUpper();
      string assetType = json["AssetType"].ToString();
      string assetId = json["AssetId"].ToString();
      //TimeZone only mandatory for Plant asset
      if (assetType.Equals("Plant", StringComparison.InvariantCultureIgnoreCase) && json.ContainsKey("PlantAffiliationType")
      && json["PlantAffiliationType"].ToString().Equals("owner", StringComparison.InvariantCultureIgnoreCase))
      {
      this.ValidateArgument<ArgumentException>(() => !json.ContainsKey("TimeZone"), "TimeZone doesn't exist");
      string timeZone = json["TimeZone"].ToString();
      string newTimeZone = GetTimeZone(windowsZonesFilePath, timeZone);
      json["TimeZone"] = newTimeZone;
      }

      log.Info($"DATA received for AssetType : {assetType} with AssetId : {assetId} and operationType : {operationType}");

      if (!json.Keys.Contains("ApplicationName"))
      json.Add("ApplicationName", AMSConstraints.ApplicationName);

      JObject newMessage = JObject.Parse(JsonConvert.SerializeObject(json));

      if (operationType.Equals(OperationType.New.ToString(), StringComparison.InvariantCultureIgnoreCase))
      {
      log.Info($"Adding in database");
      await this.masterDataService.CreateAsync(newMessage);
      return true;
      }
      else if (operationType.Equals(OperationType.Update.ToString(), StringComparison.InvariantCultureIgnoreCase))
      {
      log.Info($"Replacing in database");
      return await this.masterDataService.UpdateDocumentByAsset(assetId, assetType, newMessage);
      }
      else if (operationType.Equals(OperationType.Delete.ToString(), StringComparison.InvariantCultureIgnoreCase))
      {
      log.Info($"Deleting Document");
      return await this.masterDataService.DeleteAsset(assetId, assetType);
      }
      return false;
      }

      private string GetTimeZone(string filePath, string timeZone)
      {
      XDocument xdoc = XDocument.Load(filePath);
      return xdoc.Descendants("mapZone")
      .Where(x => x.Attribute("other").Value.Equals(timeZone, StringComparison.InvariantCultureIgnoreCase))
      .Select(x => (string)x.Attribute("type"))
      .FirstOrDefault();
      }

      private void ValidateArgument<exType>(Func<bool> validation, string errorMessage) where exType : Exception
      {
      if (validation())
      {
      throw Activator.CreateInstance(typeof(exType), errorMessage) as exType;
      }
      }
      }








      share













      I Want to write clean and easy to maintainable code. What can I improve on below code?



      Below is example of my masterdata service, which receive master data as json input, after some validation I need to create/update/delete master data into Cosmos DB.



      public class MasterService : IMasterService
      {
      private readonly IMasterDao masterDataService;
      private readonly ILog log;

      public MasterService(IMasterDao masterDataService, ILog log)
      {
      this.log = log;
      this.masterDataService = masterDataService;
      }

      public async Task<bool> UpdateMasterData(string message, string windowsZonesFilePath)
      {
      this.ValidateArgument<ArgumentException>(() => string.IsNullOrWhiteSpace(message), "Invalid MasterData Message");
      Dictionary<string, object> json = JsonConvert.DeserializeObject<Dictionary<string, object>>(message);
      this.ValidateArgument<ArgumentException>(() => !json.ContainsKey("OperationType"), "OperationType doesn't exist");
      this.ValidateArgument<ArgumentException>(() => !json.ContainsKey("AssetType"), "AssetType doesn't exist");
      this.ValidateArgument<ArgumentException>(() => !json.ContainsKey("AssetId"), "AssetId doesn't exist");

      string operationType = json["OperationType"].ToString().ToUpper();
      string assetType = json["AssetType"].ToString();
      string assetId = json["AssetId"].ToString();
      //TimeZone only mandatory for Plant asset
      if (assetType.Equals("Plant", StringComparison.InvariantCultureIgnoreCase) && json.ContainsKey("PlantAffiliationType")
      && json["PlantAffiliationType"].ToString().Equals("owner", StringComparison.InvariantCultureIgnoreCase))
      {
      this.ValidateArgument<ArgumentException>(() => !json.ContainsKey("TimeZone"), "TimeZone doesn't exist");
      string timeZone = json["TimeZone"].ToString();
      string newTimeZone = GetTimeZone(windowsZonesFilePath, timeZone);
      json["TimeZone"] = newTimeZone;
      }

      log.Info($"DATA received for AssetType : {assetType} with AssetId : {assetId} and operationType : {operationType}");

      if (!json.Keys.Contains("ApplicationName"))
      json.Add("ApplicationName", AMSConstraints.ApplicationName);

      JObject newMessage = JObject.Parse(JsonConvert.SerializeObject(json));

      if (operationType.Equals(OperationType.New.ToString(), StringComparison.InvariantCultureIgnoreCase))
      {
      log.Info($"Adding in database");
      await this.masterDataService.CreateAsync(newMessage);
      return true;
      }
      else if (operationType.Equals(OperationType.Update.ToString(), StringComparison.InvariantCultureIgnoreCase))
      {
      log.Info($"Replacing in database");
      return await this.masterDataService.UpdateDocumentByAsset(assetId, assetType, newMessage);
      }
      else if (operationType.Equals(OperationType.Delete.ToString(), StringComparison.InvariantCultureIgnoreCase))
      {
      log.Info($"Deleting Document");
      return await this.masterDataService.DeleteAsset(assetId, assetType);
      }
      return false;
      }

      private string GetTimeZone(string filePath, string timeZone)
      {
      XDocument xdoc = XDocument.Load(filePath);
      return xdoc.Descendants("mapZone")
      .Where(x => x.Attribute("other").Value.Equals(timeZone, StringComparison.InvariantCultureIgnoreCase))
      .Select(x => (string)x.Attribute("type"))
      .FirstOrDefault();
      }

      private void ValidateArgument<exType>(Func<bool> validation, string errorMessage) where exType : Exception
      {
      if (validation())
      {
      throw Activator.CreateInstance(typeof(exType), errorMessage) as exType;
      }
      }
      }






      c#





      share












      share










      share



      share










      asked 5 mins ago









      Pankaj Rawat

      1127




      1127






















          0






          active

          oldest

          votes











          Your Answer





          StackExchange.ifUsing("editor", function () {
          return StackExchange.using("mathjaxEditing", function () {
          StackExchange.MarkdownEditor.creationCallbacks.add(function (editor, postfix) {
          StackExchange.mathjaxEditing.prepareWmdForMathJax(editor, postfix, [["\$", "\$"]]);
          });
          });
          }, "mathjax-editing");

          StackExchange.ifUsing("editor", function () {
          StackExchange.using("externalEditor", function () {
          StackExchange.using("snippets", function () {
          StackExchange.snippets.init();
          });
          });
          }, "code-snippets");

          StackExchange.ready(function() {
          var channelOptions = {
          tags: "".split(" "),
          id: "196"
          };
          initTagRenderer("".split(" "), "".split(" "), channelOptions);

          StackExchange.using("externalEditor", function() {
          // Have to fire editor after snippets, if snippets enabled
          if (StackExchange.settings.snippets.snippetsEnabled) {
          StackExchange.using("snippets", function() {
          createEditor();
          });
          }
          else {
          createEditor();
          }
          });

          function createEditor() {
          StackExchange.prepareEditor({
          heartbeatType: 'answer',
          autoActivateHeartbeat: false,
          convertImagesToLinks: false,
          noModals: true,
          showLowRepImageUploadWarning: true,
          reputationToPostImages: null,
          bindNavPrevention: true,
          postfix: "",
          imageUploader: {
          brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
          contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
          allowUrls: true
          },
          onDemand: true,
          discardSelector: ".discard-answer"
          ,immediatelyShowMarkdownHelp:true
          });


          }
          });














          draft saved

          draft discarded


















          StackExchange.ready(
          function () {
          StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fcodereview.stackexchange.com%2fquestions%2f211011%2fclean-code-c%23new-answer', 'question_page');
          }
          );

          Post as a guest















          Required, but never shown

























          0






          active

          oldest

          votes








          0






          active

          oldest

          votes









          active

          oldest

          votes






          active

          oldest

          votes
















          draft saved

          draft discarded




















































          Thanks for contributing an answer to Code Review Stack Exchange!


          • Please be sure to answer the question. Provide details and share your research!

          But avoid



          • Asking for help, clarification, or responding to other answers.

          • Making statements based on opinion; back them up with references or personal experience.


          Use MathJax to format equations. MathJax reference.


          To learn more, see our tips on writing great answers.





          Some of your past answers have not been well-received, and you're in danger of being blocked from answering.


          Please pay close attention to the following guidance:


          • Please be sure to answer the question. Provide details and share your research!

          But avoid



          • Asking for help, clarification, or responding to other answers.

          • Making statements based on opinion; back them up with references or personal experience.


          To learn more, see our tips on writing great answers.




          draft saved


          draft discarded














          StackExchange.ready(
          function () {
          StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fcodereview.stackexchange.com%2fquestions%2f211011%2fclean-code-c%23new-answer', 'question_page');
          }
          );

          Post as a guest















          Required, but never shown





















































          Required, but never shown














          Required, but never shown












          Required, but never shown







          Required, but never shown

































          Required, but never shown














          Required, but never shown












          Required, but never shown







          Required, but never shown







          Popular posts from this blog

          404 Error Contact Form 7 ajax form submitting

          How to know if a Active Directory user can login interactively

          TypeError: fit_transform() missing 1 required positional argument: 'X'