Merge pull request #23 from mqkotoo/session/10

Session/10

analysis_options.yaml

@@ -8,5 +8,8 @@ analyzer:
   errors:
     # riverpod_generatorの影響でg.dartの末尾に不要な指定がつくので記載
     duplicate_ignore: ignore
+    # @visibleForTestingアノテーションがついたメンバが参照されるとエラーにする
+    invalid_use_of_visible_for_testing_member: error
+
   plugins:
     - custom_lint

lib/model/weather_condition.dart

@@ -1,3 +1,4 @@
+import 'package:flutter/foundation.dart';
 import 'package:flutter_svg/svg.dart';
 import 'package:flutter_training/gen/assets.gen.dart';
 
@@ -8,12 +9,19 @@ enum WeatherCondition {
 }
 
 extension WeatherSvgImage on WeatherCondition {
+  @visibleForTesting
+  static const sunnyLabel = 'Sunny image';
+  @visibleForTesting
+  static const cloudyLabel = 'Cloudy image';
+  @visibleForTesting
+  static const rainyLabel = 'Rainy image';
+
   SvgPicture get svgImage => switch (this) {
         WeatherCondition.sunny =>
-          Assets.images.sunny.svg(semanticsLabel: 'Sunny image'),
+          Assets.images.sunny.svg(semanticsLabel: sunnyLabel),
         WeatherCondition.cloudy =>
-          Assets.images.cloudy.svg(semanticsLabel: 'Cloudy image'),
+          Assets.images.cloudy.svg(semanticsLabel: cloudyLabel),
         WeatherCondition.rainy =>
-          Assets.images.rainy.svg(semanticsLabel: 'Rainy image')
+          Assets.images.rainy.svg(semanticsLabel: rainyLabel)
       };
 }

lib/service/weather_service.dart

@@ -3,6 +3,7 @@ import 'dart:convert';
 import 'package:flutter_training/model/weather_forecast.dart';
 import 'package:flutter_training/model/weather_request.dart';
 import 'package:flutter_training/utils/api/result.dart';
+import 'package:flutter_training/utils/error/error_message.dart';
 import 'package:freezed_annotation/freezed_annotation.dart';
 import 'package:riverpod_annotation/riverpod_annotation.dart';
 import 'package:yumemi_weather/yumemi_weather.dart';
@@ -39,14 +40,18 @@ class WeatherService {
     } on YumemiWeatherError catch (e) {
       return switch (e) {
         YumemiWeatherError.invalidParameter =>
-          const Failure<WeatherForecast, String>('パラメータが有効ではありません。'),
+          const Failure<WeatherForecast, String>(ErrorMessage.invalidParameter),
         YumemiWeatherError.unknown =>
-          const Failure<WeatherForecast, String>('予期せぬエラーが発生しました。')
+          const Failure<WeatherForecast, String>(ErrorMessage.unknown)
       };
     } on CheckedFromJsonException catch (_) {
-      return const Failure<WeatherForecast, String>('不適切なデータを取得しました。');
+      return const Failure<WeatherForecast, String>(
+        ErrorMessage.receiveInvalidData,
+      );
     } on FormatException catch (_) {
-      return const Failure<WeatherForecast, String>('不適切なデータを取得しました。');
+      return const Failure<WeatherForecast, String>(
+        ErrorMessage.receiveInvalidData,
+      );
     }
   }
 }

lib/utils/error/error_message.dart

@@ -0,0 +1,10 @@
+import 'package:flutter/material.dart';
+
+@immutable
+class ErrorMessage {
+  const ErrorMessage._();
+
+  static const invalidParameter = 'パラメータが有効ではありません。';
+  static const unknown = '予期せぬエラーが発生しました。';
+  static const receiveInvalidData = '不適切なデータを取得しました。';
+}

lib/view/weather_view/component/weather_forecast_panel.dart

@@ -6,6 +6,11 @@ import 'package:flutter_training/state/weather_state_notifier.dart';
 class WeatherForecastPanel extends ConsumerWidget {
   const WeatherForecastPanel({super.key});
 
+  @visibleForTesting
+  static final minTempKey = UniqueKey();
+  @visibleForTesting
+  static final maxTempKey = UniqueKey();
+
   @override
   Widget build(BuildContext context, WidgetRef ref) {
     final textTheme = Theme.of(context).textTheme;
@@ -28,6 +33,7 @@ class WeatherForecastPanel extends ConsumerWidget {
                 style: textTheme.labelLarge!.copyWith(
                   color: Colors.blue,
                 ),
+                key: minTempKey,
               ),
             ),
             Expanded(
@@ -37,6 +43,7 @@ class WeatherForecastPanel extends ConsumerWidget {
                 style: textTheme.labelLarge!.copyWith(
                   color: Colors.red,
                 ),
+                key: maxTempKey,
               ),
             ),
           ],

lib/view/weather_view/weather_page.dart

@@ -7,6 +7,11 @@ import 'package:flutter_training/view/weather_view/component/weather_forecast_pa
 class WeatherPage extends ConsumerWidget {
   const WeatherPage({super.key});
 
+  @visibleForTesting
+  static final closeButtonKey = UniqueKey();
+  @visibleForTesting
+  static final reloadButton = UniqueKey();
+
   @override
   Widget build(BuildContext context, WidgetRef ref) {
     void onReloaded(WeatherRequest request) {
@@ -36,8 +41,9 @@ class WeatherPage extends ConsumerWidget {
                       children: [
                         Expanded(
                           child: TextButton(
-                            child: const Text('Close'),
                             onPressed: () => Navigator.pop(context),
+                            key: closeButtonKey,
+                            child: const Text('Close'),
                           ),
                         ),
                         Expanded(
@@ -50,6 +56,7 @@ class WeatherPage extends ConsumerWidget {
                                 ),
                               );
                             },
+                            key: reloadButton,
                             child: const Text('Reload'),
                           ),
                         ),

test/model/weather_forecast_test.dart

@@ -5,17 +5,11 @@ import 'package:flutter_training/model/weather_condition.dart';
 import 'package:flutter_training/model/weather_forecast.dart';
 import 'package:freezed_annotation/freezed_annotation.dart';
 
+import '../utils/dummy_data.dart';
+
 void main() {
   test('success case: fromJson', () {
-    const jsonData = '''
-        {
-          "weather_condition": "cloudy",
-          "max_temperature": 25, 
-          "min_temperature": 7,
-          "date": "2023-09-19 10:24:31.877"
-        }
-        ''';
-    final data = jsonDecode(jsonData) as Map<String, dynamic>;
+    final data = jsonDecode(validJsonData) as Map<String, dynamic>;
     final result = WeatherForecast.fromJson(data);
 
     expect(

test/service/weather_service_test.dart

@@ -5,21 +5,14 @@ import 'package:flutter_training/model/weather_forecast.dart';
 import 'package:flutter_training/model/weather_request.dart';
 import 'package:flutter_training/service/weather_service.dart';
 import 'package:flutter_training/utils/api/result.dart';
+import 'package:flutter_training/utils/error/error_message.dart';
 import 'package:mockito/annotations.dart';
 import 'package:mockito/mockito.dart';
 import 'package:yumemi_weather/yumemi_weather.dart';
 
+import '../utils/dummy_data.dart';
 import 'weather_service_test.mocks.dart';
 
-const jsonData = '''
-        {
-          "weather_condition": "cloudy",
-          "max_temperature": 25, 
-          "min_temperature": 7,
-          "date": "2023-09-19T00:00:00.000"
-        }
-        ''';
-
 final request = WeatherRequest(
   area: 'Nagoya',
   date: DateTime(2023, 9, 19),
@@ -42,7 +35,7 @@ void main() {
   });
 
   test('success case', () {
-    when(mockClient.fetchWeather(any)).thenReturn(jsonData);
+    when(mockClient.fetchWeather(any)).thenReturn(validJsonData);
 
     final result = container.read(weatherServiceProvider).fetchWeather(request);
 
@@ -55,7 +48,7 @@ void main() {
           weatherCondition: WeatherCondition.cloudy,
           maxTemperature: 25,
           minTemperature: 7,
-          date: DateTime(2023, 9, 19),
+          date: DateTime(2023, 9, 19, 10, 24, 31, 877),
         ),
       ),
     );
@@ -74,7 +67,7 @@ void main() {
         isA<Failure<WeatherForecast, String>>().having(
           (error) => error.exception,
           'error message',
-          'パラメータが有効ではありません。',
+          ErrorMessage.invalidParameter,
         ),
       );
     });
@@ -90,7 +83,7 @@ void main() {
         isA<Failure<WeatherForecast, String>>().having(
           (error) => error.exception,
           'error message',
-          '予期せぬエラーが発生しました。',
+          ErrorMessage.unknown,
         ),
       );
     });

test/state/weather_state_notifier_test.dart

@@ -5,32 +5,14 @@ import 'package:flutter_training/model/weather_forecast.dart';
 import 'package:flutter_training/model/weather_request.dart';
 import 'package:flutter_training/service/weather_service.dart';
 import 'package:flutter_training/state/weather_state_notifier.dart';
+import 'package:flutter_training/utils/error/error_message.dart';
 import 'package:mockito/annotations.dart';
 import 'package:mockito/mockito.dart';
 import 'package:yumemi_weather/yumemi_weather.dart';
 
+import '../utils/dummy_data.dart';
 import 'weather_state_notifier_test.mocks.dart';
 
-const jsonData = '''
-        {
-          "weather_condition": "cloudy",
-          "max_temperature": 25, 
-          "min_temperature": 7,
-          "date": "2023-09-19T00:00:00.000"
-        }
-        ''';
-
-const invalidJsonDataForCheckedFromJsonException = '''
-        {
-          "weather_condition": "thunder",
-          "max_temperature": 25.0, 
-          "min_temperature": 7,
-          "date": "2023-09-19T00:00:00.000"
-        }
-        ''';
-
-const invalidJsonDataForFormatException = '{invalid json data}';
-
 final request = WeatherRequest(
   area: 'Nagoya',
   date: DateTime(2023, 9, 19),
@@ -53,7 +35,7 @@ void main() {
   });
 
   test('success case: getWeather()', () {
-    when(mockClient.fetchWeather(any)).thenReturn(jsonData);
+    when(mockClient.fetchWeather(any)).thenReturn(validJsonData);
 
     //　天気の取得処理を実行して、結果をstateに流す
     container
@@ -68,7 +50,7 @@ void main() {
         weatherCondition: WeatherCondition.cloudy,
         maxTemperature: 25,
         minTemperature: 7,
-        date: DateTime(2023, 9, 19),
+        date: DateTime(2023, 9, 19, 10, 24, 31, 877),
       ),
     );
   });
@@ -92,7 +74,7 @@ void main() {
 
       //取得はできてない
       expect(weatherState, null);
-      expect(errorMessage, '予期せぬエラーが発生しました。');
+      expect(errorMessage, ErrorMessage.unknown);
     });
 
     test('invalidParameter error is thrown', () {
@@ -114,10 +96,10 @@ void main() {
 
       //取得はできてない
       expect(weatherState, null);
-      expect(errorMessage, 'パラメータが有効ではありません。');
+      expect(errorMessage, ErrorMessage.invalidParameter);
     });
 
-    test('CheckedFromJsonException error is thrown', () {
+    test('fromJson error case: CheckedFromJsonException should be thrown.', () {
       when(mockClient.fetchWeather(any))
           .thenReturn(invalidJsonDataForCheckedFromJsonException);
 
@@ -136,7 +118,7 @@ void main() {
 
       //取得はできてない
       expect(weatherState, null);
-      expect(errorMessage, '不適切なデータを取得しました。');
+      expect(errorMessage, ErrorMessage.receiveInvalidData);
     });
 
     test('received data is not in JSON format', () {
@@ -158,7 +140,7 @@ void main() {
 
       //取得はできてない
       expect(weatherState, null);
-      expect(errorMessage, '不適切なデータを取得しました。');
+      expect(errorMessage, ErrorMessage.receiveInvalidData);
     });
   });
 }

test/utils/dummy_data.dart

@@ -0,0 +1,46 @@
+const validJsonData = '''
+        {
+          "weather_condition": "cloudy",
+          "max_temperature": 25, 
+          "min_temperature": 7,
+          "date": "2023-09-19 10:24:31.877"
+        }
+        ''';
+
+const sunnyWeatherJsonData = '''
+        {
+          "weather_condition": "sunny",
+          "max_temperature": 30, 
+          "min_temperature": 0,
+          "date": "2023-09-19 10:24:31.877"
+        }
+        ''';
+
+const cloudyWeatherJsonData = '''
+        {
+          "weather_condition": "cloudy",
+          "max_temperature": 25, 
+          "min_temperature": 7,
+          "date": "2023-09-19 10:24:31.877"
+        }
+        ''';
+
+const rainyWeatherJsonData = '''
+        {
+          "weather_condition": "rainy",
+          "max_temperature": 44, 
+          "min_temperature": -22,
+          "date": "2023-09-19 10:24:31.877"
+        }
+        ''';
+
+const invalidJsonDataForCheckedFromJsonException = '''
+        {
+          "weather_condition": "thunder",
+          "max_temperature": 25.0, 
+          "min_temperature": 7,
+          "date": "2023-09-19T00:00:00.000"
+        }
+        ''';
+
+const invalidJsonDataForFormatException = '{invalid json data}';

test/utils/utils.dart

@@ -0,0 +1,19 @@
+import 'package:flutter/material.dart';
+
+import 'package:flutter_test/flutter_test.dart';
+
+final binding = TestWidgetsFlutterBinding.ensureInitialized();
+
+//初期状態は横画面判定になっているので縦画面に設定する
+void setDisplaySize({
+  Size size = const Size(390, 844),
+}) {
+  binding.platformDispatcher.implicitView!.physicalSize = size;
+  binding.platformDispatcher.implicitView!.devicePixelRatio = 1;
+}
+
+//デバイスサイズ設定の破棄
+void teardownDisplaySize() {
+  binding.platformDispatcher.implicitView!.resetPhysicalSize();
+  binding.platformDispatcher.implicitView!.resetDevicePixelRatio();
+}