flutter/lib/models/workouts/set.dart

/*
 * This file is part of wger Workout Manager <https://github.com/wger-project>.
 * Copyright (C) 2020, 2021 wger Team
 *
 * wger Workout Manager is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

import 'package:json_annotation/json_annotation.dart';
import 'package:wger/models/exercises/exercise.dart';
import 'package:wger/models/workouts/setting.dart';

part 'set.g.dart';

@JsonSerializable()
class Set {
  static const DEFAULT_NR_SETS = 4;

  @JsonKey(required: true)
  int? id;

  @JsonKey(required: true)
  late int sets;

  @JsonKey(required: false, name: 'exerciseday')
  late int day;

  @JsonKey(required: true)
  late int order;

  @JsonKey(required: true, defaultValue: '')
  late String comment;

  @JsonKey(includeFromJson: false, includeToJson: false)
  List<Exercise> exerciseBasesObj = [];

  @JsonKey(includeFromJson: false, includeToJson: false)
  List<int> exerciseBasesIds = [];

  @JsonKey(includeFromJson: false, includeToJson: false)
  List<Setting> settings = [];

  /// Computed settings (instead of 4x10 this has [10, 10, 10, 10]), used for
  /// the gym mode where the individual values are used
  @JsonKey(includeFromJson: false, includeToJson: false)
  List<Setting> settingsComputed = [];

  Set({required this.day, required this.sets, required this.order});

  Set.empty();

  Set.withData({
    this.id,
    sets,
    day,
    comment,
    order,
    exercises,
    settings,
    settingsComputed,
  }) {
    this.sets = sets ?? DEFAULT_NR_SETS;
    this.order = order ?? 1;
    this.comment = comment ?? '';
    exerciseBasesObj = exercises ?? [];
    exerciseBasesIds = exerciseBasesObj.map((e) => e.id!).toList();
    this.settings = settings ?? [];
    this.settingsComputed = settingsComputed ?? [];
    if (day != null) {
      this.day = day;
    }
  }

  /// Return only one setting object per exercise, this makes rendering workout
  /// plans easier and the gym mode uses the synthetic settings anyway.
  List<Setting> get settingsFiltered {
    final List<Setting> out = [];

    for (final setting in settings) {
      final foundSettings = out.where(
        (element) => element.exerciseId == setting.exerciseId,
      );

      if (foundSettings.isEmpty) {
        out.add(setting);
      }
    }
    return out;
  }

  void addExerciseBase(Exercise base) {
    exerciseBasesObj.add(base);
    exerciseBasesIds.add(base.id!);
  }

  void removeExercise(Exercise base) {
    exerciseBasesObj.removeWhere((e) => e.id == base.id);
    exerciseBasesIds.removeWhere((e) => e == base.id);
  }

  /// Returns all settings for the given exercise
  List<Setting> filterSettingsByExercise(Exercise exerciseBase) {
    return settings.where((element) => element.exerciseId == exerciseBase.id).toList();
  }

  /// Returns a list with all repetitions for the given exercise
  List<String> getSmartRepr(Exercise exerciseBase) {
    final List<String> out = [];

    final settingList = filterSettingsByExercise(exerciseBase);

    if (settingList.isEmpty) {
      out.add('');
    }

    if (settingList.length == 1) {
      out.add(settingList.first.singleSettingRepText.replaceAll('\n', ''));
    }

    if (settingList.length > 1) {
      for (final setting in settingList) {
        out.add(setting.singleSettingRepText.replaceAll('\n', ''));
      }
    }

    return out;
  }

  /// Returns a string with all repetitions for the given exercise
  String getSmartTextRepr(Exercise execiseBase) {
    return getSmartRepr(execiseBase).join(' – ');
  }

  // Boilerplate
  factory Set.fromJson(Map<String, dynamic> json) => _$SetFromJson(json);

  Map<String, dynamic> toJson() => _$SetToJson(this);
}