summaryrefslogtreecommitdiff
path: root/src/SMAPI.Toolkit/Serialization/Converters/SemanticVersionConverter.cs
blob: c32c3185088058dddd6f47b92cf28cea1a572266 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
using System;
using Newtonsoft.Json;
using Newtonsoft.Json.Linq;

namespace StardewModdingAPI.Toolkit.Serialization.Converters
{
    /// <summary>Handles deserialization of <see cref="ISemanticVersion"/>.</summary>
    internal class SemanticVersionConverter : JsonConverter
    {
        /*********
        ** Fields
        *********/
        /// <summary>Whether to allow non-standard extensions to semantic versioning.</summary>
        protected bool AllowNonStandard { get; set; }


        /*********
        ** Accessors
        *********/
        /// <summary>Get whether this converter can read JSON.</summary>
        public override bool CanRead { get; } = true;

        /// <summary>Get whether this converter can write JSON.</summary>
        public override bool CanWrite { get; } = true;


        /*********
        ** Public methods
        *********/
        /// <summary>Get whether this instance can convert the specified object type.</summary>
        /// <param name="objectType">The object type.</param>
        public override bool CanConvert(Type objectType)
        {
            return typeof(ISemanticVersion).IsAssignableFrom(objectType);
        }

        /// <summary>Reads the JSON representation of the object.</summary>
        /// <param name="reader">The JSON reader.</param>
        /// <param name="objectType">The object type.</param>
        /// <param name="existingValue">The object being read.</param>
        /// <param name="serializer">The calling serializer.</param>
        public override object? ReadJson(JsonReader reader, Type objectType, object? existingValue, JsonSerializer serializer)
        {
            string path = reader.Path;
            switch (reader.TokenType)
            {
                case JsonToken.StartObject:
                    return this.ReadObject(JObject.Load(reader));

                case JsonToken.String:
                    return this.ReadString(JToken.Load(reader).Value<string>(), path);

                default:
                    throw new SParseException($"Can't parse {nameof(ISemanticVersion)} from {reader.TokenType} node (path: {reader.Path}).");
            }
        }

        /// <summary>Writes the JSON representation of the object.</summary>
        /// <param name="writer">The JSON writer.</param>
        /// <param name="value">The value.</param>
        /// <param name="serializer">The calling serializer.</param>
        public override void WriteJson(JsonWriter writer, object? value, JsonSerializer serializer)
        {
            writer.WriteValue(value?.ToString());
        }


        /*********
        ** Private methods
        *********/
        /// <summary>Read a JSON object.</summary>
        /// <param name="obj">The JSON object to read.</param>
        private ISemanticVersion ReadObject(JObject obj)
        {
            int major = obj.ValueIgnoreCase<int>(nameof(ISemanticVersion.MajorVersion));
            int minor = obj.ValueIgnoreCase<int>(nameof(ISemanticVersion.MinorVersion));
            int patch = obj.ValueIgnoreCase<int>(nameof(ISemanticVersion.PatchVersion));
            string? prereleaseTag = obj.ValueIgnoreCase<string>(nameof(ISemanticVersion.PrereleaseTag));

            return new SemanticVersion(major, minor, patch, prereleaseTag: prereleaseTag);
        }

        /// <summary>Read a JSON string.</summary>
        /// <param name="str">The JSON string value.</param>
        /// <param name="path">The path to the current JSON node.</param>
        private ISemanticVersion? ReadString(string str, string path)
        {
            if (string.IsNullOrWhiteSpace(str))
                return null;
            if (!SemanticVersion.TryParse(str, allowNonStandard: this.AllowNonStandard, out ISemanticVersion? version))
                throw new SParseException($"Can't parse semantic version from invalid value '{str}', should be formatted like 1.2, 1.2.30, or 1.2.30-beta (path: {path}).");
            return version;
        }
    }
}