squidex/src/Squidex.Domain.Apps.Core.Model/Schemas/Schema.cs

// ==========================================================================
//  Schema.cs
//  Squidex Headless CMS
// ==========================================================================
//  Copyright (c) Squidex Group
//  All rights reserved.
// ==========================================================================

using System;
using System.Collections.Generic;
using System.Collections.Immutable;
using System.Diagnostics.Contracts;
using System.Linq;
using Squidex.Infrastructure;

namespace Squidex.Domain.Apps.Core.Schemas
{
    public sealed class Schema : Cloneable<Schema>
    {
        private readonly string name;
        private ImmutableArray<Field> fieldsOrdered = ImmutableArray<Field>.Empty;
        private ImmutableDictionary<long, Field> fieldsById;
        private ImmutableDictionary<string, Field> fieldsByName;
        private SchemaProperties properties;
        private bool isPublished;

        public string Name
        {
            get { return name; }
        }

        public bool IsPublished
        {
            get { return isPublished; }
        }

        public IReadOnlyList<Field> Fields
        {
            get { return fieldsOrdered; }
        }

        public IReadOnlyDictionary<long, Field> FieldsById
        {
            get
            {
                if (fieldsById == null)
                {
                    if (fieldsOrdered.Length == 0)
                    {
                        fieldsById = ImmutableDictionary<long, Field>.Empty;
                    }
                    else
                    {
                        fieldsById = fieldsOrdered.ToImmutableDictionary(x => x.Id);
                    }
                }

                return fieldsById;
            }
        }

        public IReadOnlyDictionary<string, Field> FieldsByName
        {
            get
            {
                if (fieldsByName == null)
                {
                    if (fieldsOrdered.Length == 0)
                    {
                        fieldsByName = ImmutableDictionary<string, Field>.Empty;
                    }
                    else
                    {
                        fieldsByName = fieldsOrdered.ToImmutableDictionary(x => x.Name);
                    }
                }

                return fieldsByName;
            }
        }

        public SchemaProperties Properties
        {
            get { return properties; }
        }

        public Schema(string name, SchemaProperties properties = null)
        {
            Guard.NotNullOrEmpty(name, nameof(name));

            this.name = name;

            this.properties = properties ?? new SchemaProperties();
            this.properties.Freeze();
        }

        public Schema(string name, Field[] fields, SchemaProperties properties, bool isPublished)
            : this(name, properties)
        {
            Guard.NotNullOrEmpty(name, nameof(name));
            Guard.NotNull(fields, nameof(fields));

            this.isPublished = isPublished;

            fieldsOrdered = ImmutableArray.Create(fields);
        }

        protected override void OnCloned()
        {
            fieldsById = null;
            fieldsByName = null;
        }

        [Pure]
        public Schema Update(SchemaProperties newProperties)
        {
            Guard.NotNull(newProperties, nameof(newProperties));

            return Clone(clone =>
            {
                clone.properties = newProperties;
                clone.properties.Freeze();
            });
        }

        [Pure]
        public Schema UpdateField(long fieldId, FieldProperties newProperties)
        {
            return UpdateField(fieldId, field =>
            {
                return field.Update(newProperties);
            });
        }

        [Pure]
        public Schema LockField(long fieldId)
        {
            return UpdateField(fieldId, field =>
            {
                return field.Lock();
            });
        }

        [Pure]
        public Schema DisableField(long fieldId)
        {
            return UpdateField(fieldId, field =>
            {
                return field.Disable();
            });
        }

        [Pure]
        public Schema EnableField(long fieldId)
        {
            return UpdateField(fieldId, field =>
            {
                return field.Enable();
            });
        }

        [Pure]
        public Schema HideField(long fieldId)
        {
            return UpdateField(fieldId, field =>
            {
                return field.Hide();
            });
        }

        [Pure]
        public Schema ShowField(long fieldId)
        {
            return UpdateField(fieldId, field =>
            {
                return field.Show();
            });
        }

        [Pure]
        public Schema Publish()
        {
            return Clone(clone =>
            {
                clone.isPublished = true;
            });
        }

        [Pure]
        public Schema Unpublish()
        {
            return Clone(clone =>
            {
                clone.isPublished = false;
            });
        }

        [Pure]
        public Schema DeleteField(long fieldId)
        {
            if (!FieldsById.TryGetValue(fieldId, out var field))
            {
                return this;
            }

            return Clone(clone =>
            {
                clone.fieldsOrdered = fieldsOrdered.Remove(field);
            });
        }

        [Pure]
        public Schema ReorderFields(List<long> ids)
        {
            Guard.NotNull(ids, nameof(ids));

            if (ids.Count != fieldsOrdered.Length || ids.Any(x => !FieldsById.ContainsKey(x)))
            {
                throw new ArgumentException("Ids must cover all fields.", nameof(ids));
            }

            return Clone(clone =>
            {
                clone.fieldsOrdered = fieldsOrdered.OrderBy(f => ids.IndexOf(f.Id)).ToImmutableArray();
            });
        }

        [Pure]
        public Schema AddField(Field field)
        {
            Guard.NotNull(field, nameof(field));

            if (FieldsByName.ContainsKey(field.Name) || FieldsById.ContainsKey(field.Id))
            {
                throw new ArgumentException($"A field with name '{field.Name}' and id {field.Id} already exists.", nameof(field));
            }

            return Clone(clone =>
            {
                clone.fieldsOrdered = clone.fieldsOrdered.Add(field);
            });
        }

        [Pure]
        public Schema UpdateField(long fieldId, Func<Field, Field> updater)
        {
            Guard.NotNull(updater, nameof(updater));

            if (!FieldsById.TryGetValue(fieldId, out var field))
            {
                return this;
            }

            return Clone(clone =>
            {
                clone.fieldsOrdered = clone.fieldsOrdered.Replace(field, updater(field));
            });
        }
    }
}