BadScript2.Settings.BadSettingsReader Class Reference

Reads a JSON file and returns the resulting BadSettings Object. More...

Public Member Functions
	BadSettingsReader (BadSettings rootSettings, IFileSystem mFileSystem, params string[] sourceFiles)
	Constructs a new BadSettingsReader.
BadSettings	ReadSettings ()
	Returns a new Instance of BadSettings with all source files loaded.

Private Member Functions
JToken	ReadJsonFile (string fileName)
	Parses a JSON File and returns the resulting JObject.
void	ReadDynamicSettings (BadSettings settings)
	Processes Dynamic Include Statements inside a settings object.

Static Private Member Functions
static BadSettings	CreateSettings (JToken? token, string path)
	Creates a Settings Object from a JToken.

Private Attributes
readonly IFileSystem	m_FileSystem
readonly BadSettings	m_RootSettings
	The Root Settings Object that all other Settings are added into.
readonly string[]	m_SourceFiles
	The Source Files that are used to read the Settings.

Detailed Description

Reads a JSON file and returns the resulting BadSettings Object.

Definition at line 11 of file BadSettingsReader.cs.

Constructor & Destructor Documentation

BadSettingsReader()

BadScript2.Settings.BadSettingsReader.BadSettingsReader	(	BadSettings	rootSettings,
		IFileSystem	mFileSystem,
		params string[]	sourceFiles
	)

Constructs a new BadSettingsReader.

Parameters

rootSettings	Root Settings Object
sourceFiles	List of Source Files

Definition at line 30 of file BadSettingsReader.cs.

    {
        m_SourceFiles = sourceFiles;
        m_RootSettings = rootSettings;
        m_FileSystem = mFileSystem;
    }

Member Function Documentation

CreateSettings()

static BadSettings BadScript2.Settings.BadSettingsReader.CreateSettings ( JToken?  token, string  path  )

staticprivate

Creates a Settings Object from a JToken.

Parameters

token

JToken to convert

Returns

BadSettings Instance

Definition at line 83 of file BadSettingsReader.cs.

    {
        if (token is
            not { Type: JTokenType.Object })
        {
            return new BadSettings(token, path);
        }
 
        Dictionary<string, BadSettings> settings = new Dictionary<string, BadSettings>();
        JObject obj = (JObject)token;
 
        foreach (KeyValuePair<string, JToken?> keyValuePair in obj)
        {
            settings.Add(keyValuePair.Key, CreateSettings(keyValuePair.Value, path));
        }
 
        return new BadSettings(settings, path);
    }

ReadDynamicSettings()

void BadScript2.Settings.BadSettingsReader.ReadDynamicSettings ( BadSettings  settings )

private

Processes Dynamic Include Statements inside a settings object.

Parameters

settings

Settings object to process

Definition at line 107 of file BadSettingsReader.cs.

    {
        BadLogger.Log("Processing Dynamic Includes", "SettingsReader");
        BadSettings? elems = settings.FindProperty("SettingsBuilder.Include");
        string[]? includes = elems?.GetValue<string[]>();
 
        if (includes == null)
        {
            return;
        }
 
        elems?.SetValue(null);
 
        do
        {
            List<BadSettings> setting = new List<BadSettings>();
 
            foreach (string include in includes)
            {
                if (include.Contains('*'))
                {
                    bool allDirs = include.Contains("**");
 
                    string[] parts = include.Split(new[] { '*' },
                                                   StringSplitOptions.RemoveEmptyEntries
                                                  );
                    string path = parts[0];
                    string extension = parts[1];
 
                    IEnumerable<string> files = m_FileSystem.GetFiles(path,
                                                                      extension,
                                                                      allDirs
                                                                     );
 
                    setting.AddRange(files.Select(f =>
                                                  {
                                                      BadLogger.Log("Reading settings from file: " + f,
                                                                    "SettingsReader"
                                                                   );
 
                                                      return CreateSettings(ReadJsonFile(f), f);
                                                  }
                                                 )
                                    );
                }
                else
                {
                    BadLogger.Log("Reading settings from file: " + include, "SettingsReader");
                    setting.Add(CreateSettings(ReadJsonFile(include), include));
                }
            }
 
            settings.Populate(true, setting.ToArray());
 
            BadLogger.Log("Resolving environment variables", "SettingsReader");
            BadSettings.ResolveEnvironmentVariables(settings);
 
            elems = settings.FindProperty("SettingsBuilder.Include");
            includes = elems?.GetValue<string[]>();
        }
        while (includes != null);
 
        settings.RemoveProperty("SettingsBuilder");
    }

ReadJsonFile()

JToken BadScript2.Settings.BadSettingsReader.ReadJsonFile ( string  fileName )

private

Parses a JSON File and returns the resulting JObject.

Parameters

fileName

Source File

Returns

Definition at line 70 of file BadSettingsReader.cs.

    {
        string json = m_FileSystem.ReadAllText(fileName);
        JToken token = JToken.Parse(json);
 
        return token;
    }

ReadSettings()

BadSettings BadScript2.Settings.BadSettingsReader.ReadSettings

(

)

Returns a new Instance of BadSettings with all source files loaded.

Returns

BadSettings Instance

Definition at line 41 of file BadSettingsReader.cs.

    {
        List<BadSettings> settings = new List<BadSettings> { m_RootSettings };
 
        Queue<string> files = new Queue<string>(m_SourceFiles);
 
        while (files.Count != 0)
        {
            string file = files.Dequeue();
            BadLogger.Log("Reading settings from file: " + file, "SettingsReader");
            settings.Add(CreateSettings(ReadJsonFile(file), file));
        }
 
        BadSettings s = new BadSettings(string.Empty);
        s.Populate(true, settings.ToArray());
 
        BadLogger.Log("Resolving environment variables", "SettingsReader");
        BadSettings.ResolveEnvironmentVariables(s);
 
        ReadDynamicSettings(s);
 
        return s;
    }

Member Data Documentation

m_FileSystem

readonly IFileSystem BadScript2.Settings.BadSettingsReader.m_FileSystem

private

Definition at line 13 of file BadSettingsReader.cs.

m_RootSettings

readonly BadSettings BadScript2.Settings.BadSettingsReader.m_RootSettings

private

The Root Settings Object that all other Settings are added into.

Definition at line 18 of file BadSettingsReader.cs.

m_SourceFiles

readonly string [] BadScript2.Settings.BadSettingsReader.m_SourceFiles

private

The Source Files that are used to read the Settings.

Definition at line 23 of file BadSettingsReader.cs.

---

The documentation for this class was generated from the following file:

• src/BadScript2/Settings/BadSettingsReader.cs