Align features to cover those of old File_Adapter; renaming to File_Adapter

.ci/check-core.yml

@@ -12,10 +12,10 @@ pool:
   vmImage: 'vs2017-win2016'
 
 variables:
-  solution: '**/Filing_Toolkit.sln'
+  solution: '**/File_Toolkit.sln'
   buildPlatform: 'Any CPU'
   buildConfiguration: 'Release'
-  projectName: 'Filing_Toolkit'
+  projectName: 'File_Toolkit'
 
 steps:
 - checkout: self

.ci/check-installer.yml

@@ -12,10 +12,10 @@ pool:
   vmImage: 'vs2017-win2016'
 
 variables:
-  solution: '**/Filing_Toolkit.sln'
+  solution: '**/File_Toolkit.sln'
   buildPlatform: 'Any CPU'
   buildConfiguration: 'Release'
-  projectName: 'Filing_Toolkit'
+  projectName: 'File_Toolkit'
 
 steps:
 - checkout: self

.ci/run-compliance-tests.yml

@@ -12,10 +12,10 @@ pool:
   vmImage: 'vs2017-win2016'
 
 variables:
-  solution: '**/Filing_Toolkit.sln'
+  solution: '**/File_Toolkit.sln'
   buildPlatform: 'Any CPU'
   buildConfiguration: 'Release'
-  projectName: 'Filing_Toolkit'
+  projectName: 'File_Toolkit'
 
 steps:
 - checkout: self

.ci/testSettings.runsettings

@@ -44,7 +44,7 @@
 
   <!-- Parameters used by tests at runtime -->
   <TestRunParameters>
-    <Parameter name="projectName" value="Filing_Toolkit" />
+    <Parameter name="projectName" value="File_Toolkit" />
     <Parameter name="oMName" value="null" />
     <Parameter name="engineName" value="null" />
     <Parameter name="adapterName" value="null" />

Filing_Adapter/AdapterActions/Execute.cs → File_Adapter/AdapterActions/Execute.cs

@@ -20,11 +20,11 @@
  * along with this code. If not, see <https://www.gnu.org/licenses/lgpl-3.0.html>.      
  */
 
-using BH.Engine.Adapters.Filing;
+using BH.Engine.Adapters.File;
 using BH.Engine.Reflection;
 using BH.oM.Adapter;
 using BH.oM.Data.Requests;
-using BH.oM.Adapters.Filing;
+using BH.oM.Adapters.File;
 using System;
 using System.Collections;
 using System.Collections.Generic;
@@ -37,9 +37,9 @@
 using BH.oM.Reflection;
 using BH.oM.Reflection.Attributes;
 
-namespace BH.Adapter.Filing
+namespace BH.Adapter.File
 {
-    public partial class FilingAdapter
+    public partial class FileAdapter
     {
         /***************************************************/
         /**** Methods                                  *****/
@@ -52,7 +52,7 @@ public override oM.Reflection.Output<List<object>, bool> Execute(IExecuteCommand
             if (command == null)
                 return new Output<List<object>, bool>();
 
-            oM.Adapters.Filing.ExecuteConfig executeConfig = actionConfig as oM.Adapters.Filing.ExecuteConfig ?? new ExecuteConfig();
+            oM.Adapters.File.ExecuteConfig executeConfig = actionConfig as oM.Adapters.File.ExecuteConfig ?? new ExecuteConfig();
 
             if (m_Execute_enableWarning && !executeConfig.DisableWarnings)
             {

File_Adapter/AdapterActions/Pull.cs

@@ -0,0 +1,95 @@
+/*
+ * This file is part of the Buildings and Habitats object Model (BHoM)
+ * Copyright (c) 2015 - 2020, the respective contributors. All rights reserved.
+ *
+ * Each contributor holds copyright over their respective contributions.
+ * The project versioning (Git) records all such contribution source information.
+ *                                           
+ *                                                                              
+ * The BHoM is free software: you can redistribute it and/or modify         
+ * it under the terms of the GNU Lesser General Public License as published by  
+ * the Free Software Foundation, either version 3.0 of the License, or          
+ * (at your option) any later version.                                          
+ *                                                                              
+ * The BHoM is distributed in the hope that it will be useful,              
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of               
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the                 
+ * GNU Lesser General Public License for more details.                          
+ *                                                                            
+ * You should have received a copy of the GNU Lesser General Public License     
+ * along with this code. If not, see <https://www.gnu.org/licenses/lgpl-3.0.html>.      
+ */
+
+using BH.Engine.Adapters.File;
+using BH.Engine.Reflection;
+using BH.oM.Adapter;
+using BH.oM.Data.Requests;
+using BH.oM.Adapters.File;
+using System;
+using System.Collections;
+using System.Collections.Generic;
+using System.IO;
+using System.IO.Abstractions;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using BH.Engine.Base;
+
+namespace BH.Adapter.File
+{
+    public partial class FileAdapter
+    {
+        /***************************************************/
+        /**** Methods                                  *****/
+        /***************************************************/
+
+        public override bool SetupPullRequest(object request, out IRequest pullRequest)
+        {
+            pullRequest = request as IRequest;
+
+            // If there is no input request, but a target filepath was specified through the Adapter constructor, use that.
+            if (!string.IsNullOrWhiteSpace(m_defaultFilePath) && (request == null || request is Type))
+            {
+                if (request is Type)
+                {
+                    pullRequest = new FileContentRequest() { File = m_defaultFilePath, Types = new List<Type>() { request as Type } };
+                    BH.Engine.Reflection.Compute.RecordNote($"Type interpreted as new {nameof(FileContentRequest)} targeting the Adapter targetLocation: `{m_defaultFilePath}` and filtering per type `{(request as Type).Name}`.");
+                }
+                else if (request is IEnumerable<Type>)
+                {
+                    pullRequest = new FileContentRequest() { File = m_defaultFilePath, Types = (request as IEnumerable<Type>).ToList() };
+                    BH.Engine.Reflection.Compute.RecordNote($"Type interpreted as new {nameof(FileContentRequest)} targeting the Adapter targetLocation: `{m_defaultFilePath}` and filtering per types: {String.Join(", ",(request as IEnumerable<Type>).Select(t => t.Name))}.");
+                }
+                else
+                {
+                    pullRequest = new FileContentRequest() { File = m_defaultFilePath };
+                    BH.Engine.Reflection.Compute.RecordNote($"Pulling file contents from the Adapter targetLocation: `{m_defaultFilePath}`.");
+                }
+
+                return true;
+            }
+
+            if (request == null && string.IsNullOrWhiteSpace(m_defaultFilePath))
+            {
+                BH.Engine.Reflection.Compute.RecordError($"Please specify a valid Request, or create the {nameof(FileAdapter)} with the constructor that takes inputs to specify a target Location.");
+                return false;
+            }
+
+            if ((request as IRequest) != null && !string.IsNullOrWhiteSpace(m_defaultFilePath))
+            {
+                BH.Engine.Reflection.Compute.RecordWarning($"Both request and targetLocation have been specified. Requests take precedence. Pulling as specified by the input `{request.GetType().Name}`.");
+                return true;
+            }
+
+            return base.SetupPullRequest(request, out pullRequest);
+        }
+
+        public override IEnumerable<object> Pull(IRequest request, PullType pullType = PullType.AdapterDefault, ActionConfig actionConfig = null)
+        {
+            return Read(request as dynamic, actionConfig as PullConfig ?? new PullConfig());
+        }
+
+        /***************************************************/
+
+    }
+}

File_Adapter/AdapterActions/Push.cs

@@ -0,0 +1,171 @@
+/*
+ * This file is part of the Buildings and Habitats object Model (BHoM)
+ * Copyright (c) 2015 - 2020, the respective contributors. All rights reserved.
+ *
+ * Each contributor holds copyright over their respective contributions.
+ * The project versioning (Git) records all such contribution source information.
+ *                                           
+ *                                                                              
+ * The BHoM is free software: you can redistribute it and/or modify         
+ * it under the terms of the GNU Lesser General Public License as published by  
+ * the Free Software Foundation, either version 3.0 of the License, or          
+ * (at your option) any later version.                                          
+ *                                                                              
+ * The BHoM is distributed in the hope that it will be useful,              
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of               
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the                 
+ * GNU Lesser General Public License for more details.                          
+ *                                                                            
+ * You should have received a copy of the GNU Lesser General Public License     
+ * along with this code. If not, see <https://www.gnu.org/licenses/lgpl-3.0.html>.      
+ */
+
+using BH.Engine.Adapters.File;
+using BH.Engine.Reflection;
+using BH.oM.Adapter;
+using BH.oM.Data.Requests;
+using BH.oM.Adapters.File;
+using System;
+using System.Collections;
+using System.Collections.Generic;
+using System.IO;
+using System.IO.Abstractions;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using BH.Engine.Base;
+using BH.oM.Base;
+
+namespace BH.Adapter.File
+{
+    public partial class FileAdapter
+    {
+        /***************************************************/
+        /**** Methods                                  *****/
+        /***************************************************/
+
+        public override bool SetupPushType(PushType pushType, out PushType pt)
+        {
+            pt = pushType;
+
+            if (pushType == PushType.AdapterDefault)
+                pt = m_AdapterSettings.DefaultPushType;
+
+            if (pushType == PushType.FullPush)
+            {
+                BH.Engine.Reflection.Compute.RecordError($"The specified {nameof(PushType)} {nameof(PushType.FullPush)} is not supported.");
+                return false;
+            }
+
+            return true;
+        }
+
+        public override bool SetupPushConfig(ActionConfig actionConfig, out ActionConfig pushConfig)
+        {
+            PushConfig pushCfg = actionConfig as PushConfig ?? new PushConfig();
+            pushConfig = pushCfg;
+
+            if (pushCfg.BeautifyJson && pushCfg.UseDatasetSerialization)
+            {
+                BH.Engine.Reflection.Compute.RecordError($"Input `{nameof(PushConfig.BeautifyJson)}` and `{nameof(PushConfig.UseDatasetSerialization)}` cannot be both set to True.");
+                return false;
+            }
+
+            return true;
+        }
+
+        public override List<object> Push(IEnumerable<object> objects, string tag = "", PushType pushType = PushType.AdapterDefault, ActionConfig actionConfig = null)
+        {
+            PushConfig pushConfig = actionConfig as PushConfig;
+
+            if (string.IsNullOrWhiteSpace(m_defaultFilePath)) // = if we are about to push multiple files/directories
+                if (pushType == PushType.DeleteThenCreate && m_Push_enableDeleteWarning && !pushConfig.DisableWarnings ) 
+                {
+                    BH.Engine.Reflection.Compute.RecordWarning($"You have selected the {nameof(PushType)} {nameof(PushType.DeleteThenCreate)}." +
+                        $"\nThis has the potential of deleting files and folders with their contents." +
+                        $"\nMake sure that you know what you are doing. This warning will not be repeated." +
+                        $"\nRe-enable the component to continue.");
+
+                    m_Push_enableDeleteWarning = false;
+
+                    return new List<object>();
+                }
+
+            List<IResource> createdFiles = new List<IResource>();
+
+            List<IResource> filesOrDirs = objects.OfType<IResource>().Select(fd => fd.GetShallowClone() as IResource).ToList();
+            List<object> remainder = objects.Where(o => !(o is IResource)).ToList();
+
+            if (remainder.Any())
+            {
+                if (filesOrDirs.Any())
+                {
+                    BH.Engine.Reflection.Compute.RecordError($"Input objects are both of type `{nameof(BH.oM.Adapters.File.File)}`/`{nameof(BH.oM.Adapters.File.Directory)}` and generic objects." +
+                      $"\nIn order to push them:" +
+                      $"\n\t- for the `{nameof(BH.oM.Adapters.File.File)}`/`{nameof(BH.oM.Adapters.File.Directory)}` objects, use a Push using a {nameof(FileAdapter)} with no targetLocation input;"+
+                      $"\n\t- for the generic objects, use a Push using a {nameof(FileAdapter)} that specifies a targetLocation.");
+                    return null;
+                }
+                else if (string.IsNullOrWhiteSpace(m_defaultFilePath))
+                {
+                    BH.Engine.Reflection.Compute.RecordError($"To Push objects that are not of type `{nameof(BH.oM.Adapters.File.File)}` or `{nameof(BH.oM.Adapters.File.Directory)}`," +
+                        $"\nyou need to specify a target Location by creating the {nameof(FileAdapter)} through the constructor with inputs.");
+                    return null;
+                }
+            }
+
+            if (m_defaultFilePath != null)
+            {
+                if (filesOrDirs.Any())
+                    BH.Engine.Reflection.Compute.RecordWarning($"A `targetLocation` has been specified in the File_Adapter constructor." +
+                        $"\nObjects of type `{nameof(BH.oM.Adapters.File.File)}` or `{nameof(BH.oM.Adapters.File.Directory)}` will be appended to the file at `targetLocation`." +
+                        $"\nIf you want to target multiple files, you need create the {nameof(FileAdapter)} through the constructor without inputs.");
+            }
+
+            foreach (IResource fileOrDir in filesOrDirs)
+            {
+                if (fileOrDir == null)
+                    continue;
+
+                if (fileOrDir is IFile)
+                {
+                    string extension = Path.GetExtension(fileOrDir.IFullPath());
+
+                    if (string.IsNullOrWhiteSpace(extension))
+                    {
+                        BH.Engine.Reflection.Compute.RecordNote($"File {fileOrDir.IFullPath()} has no extension specified. Defaults to JSON.");
+                        extension = ".json";
+                        fileOrDir.Name += extension;
+                    }
+
+                    if (extension != ".json")
+                    {
+                        BH.Engine.Reflection.Compute.RecordWarning($"Cannot create File {fileOrDir.IFullPath()}. Currently only JSON extension is supported.");
+                        continue;
+                    }
+                }
+
+                IResource created = Create(fileOrDir as dynamic, pushType, pushConfig);
+                createdFiles.Add(created);
+            }
+
+            if (remainder.Any())
+            {
+                string defaultDirectory = Path.GetDirectoryName(m_defaultFilePath);
+                string defaultFileName = Path.GetFileName(m_defaultFilePath);
+
+                FSFile file = CreateFSFile(defaultDirectory, defaultFileName, remainder);
+
+                IResource created = Create(file, pushType, pushConfig);
+
+                if (created != null)
+                    createdFiles.Add(created);
+            }
+
+            return createdFiles.OfType<object>().ToList();
+        }
+
+        /***************************************************/
+
+    }
+}

Filing_Adapter/AdapterActions/Remove.cs → File_Adapter/AdapterActions/Remove.cs

@@ -20,11 +20,11 @@
  * along with this code. If not, see <https://www.gnu.org/licenses/lgpl-3.0.html>.      
  */
 
-using BH.Engine.Adapters.Filing;
+using BH.Engine.Adapters.File;
 using BH.Engine.Reflection;
 using BH.oM.Adapter;
 using BH.oM.Data.Requests;
-using BH.oM.Adapters.Filing;
+using BH.oM.Adapters.File;
 using System;
 using System.Collections;
 using System.Collections.Generic;
@@ -35,9 +35,9 @@
 using System.Threading.Tasks;
 using BH.Engine.Base;
 
-namespace BH.Adapter.Filing
+namespace BH.Adapter.File
 {
-    public partial class FilingAdapter
+    public partial class FileAdapter
     {
         /***************************************************/
         /**** Methods                                  *****/
@@ -52,7 +52,7 @@ public override int Remove(IRequest request, ActionConfig actionConfig = null)
                 return 0;
             }
 
-            oM.Adapters.Filing.RemoveConfig removeConfig = actionConfig as oM.Adapters.Filing.RemoveConfig ?? new RemoveConfig();
+            oM.Adapters.File.RemoveConfig removeConfig = actionConfig as oM.Adapters.File.RemoveConfig ?? new RemoveConfig();
 
             if (m_Remove_enableDeleteWarning && !removeConfig.DisableWarnings)
             {