#38 create date time method

[haterain0203]

Issue

close #38

説明

1. DateTimeのExtensionに現在時刻と比較して以下条件で文字列を返すメソッド追加

• 同じ日付 →「hh:mm」
• 1 日前の日付 →「昨日」
• N (2 <= N <= Nmax) 日前の日付 →「N 日前」（Nmax は 7 にしておく）
• それより昔の日付 →「yyyy年MM月dd日」

2. 上記で追加したメソッドのユニットテストを追加

UI

変更なし

その他

DateTime? も受け付けるべきかどうかは担当者が考えて判断する

DateTime?は許容しない設定とした。
DateTime?になるケースとして、特定のデータの日付情報がオプショナルになっている場合などが想定されるが、そういったデータを使ってこのextensionを呼ぶことはないのでは？と考えた。

と考えたのですが、どうでしょうか・・・？

チェックリスト

• PR の冒頭に関連する Issue 番号を記載しましたか？
• 本 PR の変更に関して、エディタや IDE で意図しない警告は増えていませんか？（lint 警告やタイポなど）
• Issue の完了の定義は満たせていますか？

[kosukesaigusa]

doc string を書いているのはとても素晴らしいと思います！（たとえば例とかも書いちゃっていいかもですね、Chat GPT にこの実装をまるっと投げて、doc string 書いてください、とか言うと結構いい仕事してくれます）

[haterain0203]

ありがとうございます！

GPT先生の力も借りながら、doc stringを加筆修正しました！

[kosukesaigusa]

このメソッド内の処理を見ると「引数で渡された DateTime が、this と同じ日付か」という処理になっていますね。そうだとしたらメソッド名は _isToday ではなく _isSameDay のような名前になるべきだと思います。

_isToday のメソッド名通り、「this が今日かどうか」というメソッドにしたいのなら、DateTime now は外から渡すのではなく、_isToday の処理内部にあるべきだと思います！

意図しているのはどちらでしょうか？（実装するときに、doc comment に「「引数で渡された DateTime が、this と同じ日付かどうかの真偽値を返す」とか「「this が今日かどうかの真偽値を返す」とかを、事前に書く癖をつけると、自分のやりたいこと・意図を明確にしたコードを書けるようなり、doc comment もついて一石二鳥だと思います！）

[haterain0203]

確かにーーーーとなりました・・・

「this が今日かどうか」というメソッドにしたいという意図だったので、修正しました。
加えて、doc stringも追加しました。

実装するときに、doc comment に「「引数で渡された DateTime が、this と同じ日付かどうかの真偽値を返す」とか「「this が今日かどうかの真偽値を返す」とかを、事前に書く癖をつけると、自分のやりたいこと・意図を明確にしたコードを書けるようなり、doc comment もついて一石二鳥だと思います！

意識していきます！！！！

[kosukesaigusa]

_isToday と同様。

• 「引数で渡された DateTime が、this の 1 日前の日付か」
• 「this が昨日かどうか」

を考えて同様の修正をお願いします！

[haterain0203]

_isToday同様に、「this が昨日かどうか」が意図だったので修正しました。

[kosukesaigusa]

_isToday と同様。DateTime now を外から渡すので意図どおりか確かめる。

[haterain0203]

_isTodayと同様に修正しました。

[kosukesaigusa]

2 と 7 がいわゆるマジックナンバーになっているので、次のようなリファクタを見当してください：

extension DateTimeExtension on DateTime {
  /// 適切な変数名にする。適切な doc comment を書く。
  static const _a = 2;

  /// 適切な変数名にする。適切な doc comment を書く。
  static const _b = 7;
  
  // ... 省略

  /// 現在と比較して [_a] 日 〜 [_b] 日前ならその数字を、そうでなければnullを返す
  int? _daysBefore(DateTime now) {
    final differece = now.difference(this).inDays;
    if (differece >= _a && differece <= _b) {
      return differece;
    }
    return null;
  }
}

あと、differece がタイポです。エディタのタイポの警告は出ていませんか？（必要ならタイポチェックの設定をすることを強く勧めます）

[haterain0203]

こちらもありがとうございます！
マジックナンバーにならないよう以後留意します！

定数名など問題ないかご確認お願いします🙇‍♂️

タイポの件、失礼しました（前回も同じタイポの指摘を受けたので反省してます）
先ほどタイポチェックの拡張機能を入れました・・・！

[kosukesaigusa]

DateTime?は許容しない設定とした。DateTime?になるケースとして、特定のデータの日付情報がオプショナルになっている場合などが想定されるが、そういったデータを使ってこのextensionを呼ぶことはないのでは？と考えた。

特に Firestore を使っているとその Timestamp 型のフィールドが Dart では null 許容の DateTime? になるのはよくあるので、そういうときは一律で空文字を返すのも有りかもと思いつつでした。が、使う側で DateTime? の null チェックをしてから使用するでもいいと思うので、本件この方針で了解しました！

[haterain0203]

DateTime?は許容しない設定とした。DateTime?になるケースとして、特定のデータの日付情報がオプショナルになっている場合などが想定されるが、そういったデータを使ってこのextensionを呼ぶことはないのでは？と考えた。

特に Firestore を使っているとその Timestamp 型のフィールドが Dart では null 許容の DateTime? になるのはよくあるので、そういうときは一律で空文字を返すのも有りかもと思いつつでした。が、使う側で DateTime? の null チェックをしてから使用するでもいいと思うので、本件この方針で了解しました！

確かに、Firestoreはnull 許容の DateTime? になるのはよくありましたね・・・
今回はこのままで良いとのこと承知しました！
ちなみに、、、どちらで対応するのが一般的とかあるのでしょうか？

[kosukesaigusa]

確かに、Firestoreはnull 許容の DateTime? になるのはよくありましたね・・・
今回はこのままで良いとのこと承知しました！
ちなみに、、、どちらで対応するのが一般的とかあるのでしょうか？

「DateTime? が null だったら空文字を返す」（Firestore の Timestamp は FieldValue.serverTimestamp() を使用すると一瞬 null になることを意識しちゃっている）は、「いっぱんてな DateTime に関する機能」としてはちょっと乱暴な気もするので、FUKU さんの今回の提案の方がいいなと思いました！

[kosukesaigusa]

修正ありがとうございました！！Approved!