preferences_flags.dart

// Package imports:
import 'package:enum_to_string/enum_to_string.dart';

enum PreferencesFlag {
  // Meta flag concerning the app versioning
  appVersion,
  updateAskedVersion,

  // Schedule flags
  scheduleCalendarFormat,
  scheduleStartWeekday,
  scheduleOtherWeekday,
  scheduleShowTodayBtn,
  scheduleShowWeekEvents,
  scheduleLaboratoryGroup,
  scheduleListView,
  scheduleShowWeekendDays,

  // Locale flag
  locale,

  // Theme flag
  theme,

  // Choose language flag
  languageChoice,

  // Discovery flag
  discoveryDashboard,
  discoverySchedule,
  discoveryStudentGrade,
  discoveryGradeDetails,
  discoveryStudentProfile,
  discoveryETS,
  discoveryMore,

  // Dashboard flags
  broadcastCard,
  aboutUsCard,
  scheduleCard,
  progressBarCard,
  gradesCard,
  progressBarText,
  broadcastChange,

  // Rating flag
  ratingTimer,
  hasRatingBeenRequested,

  // Issues flag
  ghIssues,
}

/// This class can be used instead of the conventional enum to save data to shared Prefs,
/// if your key value should be decided at runtime.
class DynamicPreferencesFlag {
  final String separator;
  String uniqueKey;
  PreferencesFlag groupAssociationFlag;

  DynamicPreferencesFlag(
      {required this.groupAssociationFlag,
      required this.uniqueKey,
      this.separator = "_"});

  String get data => groupAssociationFlag.toString() + separator + uniqueKey;

  @override
  String toString() {
    return EnumToString.convertToString(groupAssociationFlag) +
        separator +
        uniqueKey;
  }

  @override
  bool operator ==(Object other) =>
      other is DynamicPreferencesFlag &&
      groupAssociationFlag == other.groupAssociationFlag &&
      separator == other.separator &&
      uniqueKey == other.uniqueKey;

  @override
  int get hashCode =>
      groupAssociationFlag.hashCode ^ separator.hashCode ^ uniqueKey.hashCode;
}