// 悪い例
import 'package:test/test.dart';

test('String', () {
  var string = 'foo,bar,baz';
  expect(string.split(','), equals(['foo', 'bar', 'baz']));

  string = '  foo ';
  expect(string.trim(), equals('foo'));
});


// 良い例
// String グループ内でそれぞれのテストが単一の概念に焦点を当てている
// テストの意図がより明確になり、テストの失敗時に問題を特定しやすくなる
import 'package:test/test.dart';

group('String', () {
  test('.split() splits the string on the delimiter', () {
    const string = 'foo,bar,baz';
    expect(string.split(','), equals(['foo', 'bar', 'baz']));
  });

  test('.trim() removes surrounding whitespace', () {
    const string = '  foo ';
    expect(string.trim(), equals('foo'));
  });
});

// 悪い例
// エラーを単にコンソールに出力するだけでは、エラーが他の出力と混在して見落とされる可能性がある
// try/catchでコードを囲むということは、そこでエラーが発生する可能性があると思っているということであり、その場合の対処方法やコードパスを用意するべき
try {
  functionThatMightThrow();
} catch (error) {
  print(error);
}


// 良い例
// onキーワードを使用して特定の例外タイプをキャッチしている
try {
  functionThatMightThrow();
} on Exception catch (e, s) {
  // Option 1:
  log('Error description...', error: e, stackTrace: s);
  // Option 2:
  notifyUserOfError(e, s);
  // Option 3:
  reportErrorToService(e, s);
}

// 悪い例
// Futureやthenを使用する場合、エラーの処理を忘れないようにする
functionThatMightThrow().then((value) {
  // ...
}).onError((e, s) {
  print(e);
});


// 良い例
// エラーハンドラーでは、エラーが発生した際に行うべき対応を行う
functionThatMightThrow().then((value) {
  // ...
}).onError((e, s) {
  // Option 1:
  log('Error description...', error: e, stackTrace: s);
  // Option 2:
  notifyUserOfError(e, s);
  // Option 3:
  reportErrorToService(e, s);
});

// 悪い例
const DAYS_IN_WEEK = 7;

const Bands = ['AC/DC', 'Led Zeppelin', 'The Beatles'];

void restore_database() {}

class animal {}

typedef predicate<T> = bool Function(T value);


// 良い例
// 一貫性のあるフォーマットを保持する

// 定数名にlowerCamelCaseを使用
const daysInWeek = 7;
const bands = ['AC/DC', 'Led Zeppelin', 'The Beatles'];

// 関数名にはlowerCamelCaseを使用
void restoreDatabase() {}

// クラス、列挙型、typedef、および型パラメータにはUpperCamelCaseを使用
class Animal {}
typedef Predicate<T> = bool Function(T value);

// 悪い例
// 関数呼び出し元と呼び出し先は近くに配置すべき
// 呼び出し元を呼び出し先の直上に配置するのが望ましい
class Smartphone {
  // ...

  String getOS() {
    // ...
  }

  void showPlatform() {
    final os = getOS();
    final chipset = getChipset();
    // ...
  }

  String getResolution() {
    // ...
  }

  void showSpecifications() {
    showPlatform();
    showDisplay();
  }

  String getChipset() {
    // ...
  }

  void showDisplay() {
    final resolution = getResolution();
    // ...
  }
}


// 良い例
// showSpecifications() が showPlatform() と showDisplay() を呼び出しているので、showSpecifications() の近くに配置
// 呼び出し元と呼び出し先が近くにあると、コードが読みやすくなる
class Smartphone {
  // ...

  void showSpecifications() {
    showPlatform();
    showDisplay();
  }

  void showPlatform() {
    final os = getOS();
    final chipset = getChipset();
    // ...
  }

  String getOS() {
    // ...
  }

  String getChipset() {
    // ...
  }

  void showDisplay() {
    final resolution = getResolution();
    // ...
  }

  String getResolution() {
    // ...
  }
}

// 悪い例
// 良いコードは自己説明的であるべき
List<String> getCitiesNames(List<String> cities) {
  // Cities names list
  final citiesNames = <String>[];

  // Loop through every city
  for (final city in cities) {
    // Gets only the string before the comma
    final filteredCityName = city.split(',')[0];

    // Add the filtered city name
    citiesNames.add(filteredCityName);
  }

  // Returns the cities names list
  return citiesNames;
}


// 良い例
// 不要なコメントを削除
// ビジネスロジックの複雑さを説明するためにのみ使用すべきであり、明らかなコードではコメントは不要
List<String> getCitiesNames(List<String> cities) {
  final citiesNames = <String>[];

  for (final city in cities) {
    // Gets only the string before the comma
    final filteredCityName = city.split(',')[0];

    citiesNames.add(filteredCityName);
  }

  return citiesNames;
}

// 悪い例
doStuff();
// doOtherStuff();
// doSomeMoreStuff();
// doSoMuchStuff();


// 良い例
// 古いコードはバージョン管理システムの履歴に残しておくべき
// コメントアウトされたコードを残すことは避ける
doStuff();