Files
octokit.net/Octokit/Models/Response/TreeItem.cs
Kristian Hellang 5ee4d64046 Add StringEnum to handle unknown enum values returned from API (#1595)
* Added StringEnum<TEnum>

* Added tests

* Make sure the serializer can work with StringEnum

* Use StringEnum for EventInfo.Event

* Add convention test to assert that all Response models use StringEnum<> to wrap enum properties

* Add Stringnum<> to all response types failing convention test

* Handle StringEnum to Enum conversion when Issue response model populates IssueUpdate request model

* Fix unit test

* Refactor SimpleJsonSerializer to expose the DeserializeEnum strategy so it can be used in StringEnum class

* Need to expose/use SerializeEnum functionality too, so we use the correct string representation of enum values that have custom properties (eg ReactionType Plus1 to "+1")

* fix unit tests, since the string is now the "correct" upstream api value

* Add a couple of tests for the Enum serialize/deserialize when underscores, hyphens and custom property attributes are present

* Compare parsed values for equality

* add convention test to ensure enum members all have Parameter property set

* update test to cover implicit conversions too

* this test should work but fails at the moment due to magic hyphen removal in deserializer causing a one way trip from utf-8 to EncodingType.Utf8 with no way to get back

* (unsuccesfully) expand event info test to try to catch more cases of unknown event types

* fix broken integration test while im here

* Fixed build errors after .NET Core merge

* Value -> StringValue, ParsedValue -> Value

* Don't allow StringValue to be null

* Ignore enums not used in request/response models

* Added ParameterAttribute to almost all enum values

* Ignore Language enum

* Fix failing tests

* Fix milestone sort parameter and tests

* whitespace

* fix milestone unit tests

* Fix StringEnum.Equals ... This could've been embarrassing!

* Change SimpleJsonSerializer Enum handling to only use `[Parameter()]` attributes (no more magic removal of hyphen/underscores from strings)

* Tidy up this integration test while im here

* Only test request/response enums in convention test

* Keep skipping Language

* Remove unused method

* Remove excluded enum types

* Removed unnecessary ParameterAttributes

* Remove unused enum

* Add StringEnum test for string-comparison of two invalid values

* Bring back IssueCommentSort and use it in IssueCommentRequest

This reverts commit 38a4a291d1476ef8c992fe0f76956974b6f32a49.

* Use assembly instead of namespace for Octokit check

* Add failing test to reproduce the issue where only the first enum paramter/value was added to the cache

* Fix deserializer enum cache to include all enum members rather than only the first member encountered

* Use a static SimpleJsonSerializer in StringEnum

* Remove serializer instance in StringEnum

* Add some documentation on StringEnum<TEnum>

* Fix parameter value to resolve failing integration test
2017-06-25 19:29:57 +10:00

100 lines
3.0 KiB
C#

using System.Diagnostics;
using System.Diagnostics.CodeAnalysis;
using System.Globalization;
using Octokit.Internal;
namespace Octokit
{
[DebuggerDisplay("{DebuggerDisplay,nq}")]
public class TreeItem
{
public TreeItem() { }
public TreeItem(string path, string mode, TreeType type, int size, string sha, string url)
{
Path = path;
Mode = mode;
Type = type;
Size = size;
Sha = sha;
Url = url;
}
/// <summary>
/// The path for this Tree Item.
/// </summary>
public string Path { get; protected set; }
/// <summary>
/// The mode of this Tree Item.
/// </summary>
public string Mode { get; protected set; }
/// <summary>
/// The type of this Tree Item.
/// </summary>
[SuppressMessage("Microsoft.Naming", "CA1721:PropertyNamesShouldNotMatchGetMethods")]
public StringEnum<TreeType> Type { get; protected set; }
/// <summary>
/// The size of this Tree Item.
/// </summary>
public int Size { get; protected set; }
/// <summary>
/// The SHA of this Tree Item.
/// </summary>
public string Sha { get; protected set; }
/// <summary>
/// The URL of this Tree Item.
/// </summary>
public string Url { get; protected set; }
internal string DebuggerDisplay
{
get { return string.Format(CultureInfo.InvariantCulture, "Sha: {0}, Path: {1}, Type: {2}, Size: {3}", Sha, Path, Type, Size); }
}
}
public enum TreeType
{
[Parameter(Value = "blob")]
Blob,
[Parameter(Value = "tree")]
Tree,
[Parameter(Value = "commit")]
Commit
}
/// <summary>
/// The file mode to associate with a tree item
/// </summary>
public static class FileMode
{
/// <summary>
/// Mark the tree item as a file (applicable to blobs only)
/// </summary>
public const string File = "100644";
/// <summary>
/// Mark the tree item as an executable (applicable to blobs only)
/// </summary>
public const string Executable = "100755";
/// <summary>
/// Mark the tree item as a subdirectory (applicable to trees only)
/// </summary>
public const string Subdirectory = "040000";
/// <summary>
/// Mark the tree item as a submodule (applicable to commits only)
/// </summary>
[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Submodule")]
public const string Submodule = "160000";
/// <summary>
/// Mark the tree item as a symlink (applicable to blobs only)
/// </summary>
[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Symlink")]
public const string Symlink = "120000";
}
}