diff --git a/.flutter-plugins-dependencies b/.flutter-plugins-dependencies index ee15714..36a79ff 100644 --- a/.flutter-plugins-dependencies +++ b/.flutter-plugins-dependencies @@ -1 +1 @@ -{"_info":"// This is a generated file; do not edit or check into version control.","dependencyGraph":[{"name":"shared_preferences","dependencies":["shared_preferences_macos","shared_preferences_web"]},{"name":"shared_preferences_macos","dependencies":[]},{"name":"shared_preferences_web","dependencies":[]}]} \ No newline at end of file +{"info":"This is a generated file; do not edit or check into version control.","plugins":{"ios":[{"name":"shared_preferences_foundation","path":"/Users/linkawy/.pub-cache/hosted/pub.dev/shared_preferences_foundation-2.5.0/","shared_darwin_source":true,"native_build":true,"dependencies":[]}],"android":[{"name":"shared_preferences_android","path":"/Users/linkawy/.pub-cache/hosted/pub.dev/shared_preferences_android-2.3.0/","native_build":true,"dependencies":[]}],"macos":[{"name":"shared_preferences_foundation","path":"/Users/linkawy/.pub-cache/hosted/pub.dev/shared_preferences_foundation-2.5.0/","shared_darwin_source":true,"native_build":true,"dependencies":[]}],"linux":[{"name":"path_provider_linux","path":"/Users/linkawy/.pub-cache/hosted/pub.dev/path_provider_linux-2.2.1/","native_build":false,"dependencies":[]},{"name":"shared_preferences_linux","path":"/Users/linkawy/.pub-cache/hosted/pub.dev/shared_preferences_linux-2.4.0/","native_build":false,"dependencies":["path_provider_linux"]}],"windows":[{"name":"path_provider_windows","path":"/Users/linkawy/.pub-cache/hosted/pub.dev/path_provider_windows-2.3.0/","native_build":false,"dependencies":[]},{"name":"shared_preferences_windows","path":"/Users/linkawy/.pub-cache/hosted/pub.dev/shared_preferences_windows-2.4.0/","native_build":false,"dependencies":["path_provider_windows"]}],"web":[{"name":"shared_preferences_web","path":"/Users/linkawy/.pub-cache/hosted/pub.dev/shared_preferences_web-2.4.1/","dependencies":[]}]},"dependencyGraph":[{"name":"path_provider_linux","dependencies":[]},{"name":"path_provider_windows","dependencies":[]},{"name":"shared_preferences","dependencies":["shared_preferences_android","shared_preferences_foundation","shared_preferences_linux","shared_preferences_web","shared_preferences_windows"]},{"name":"shared_preferences_android","dependencies":[]},{"name":"shared_preferences_foundation","dependencies":[]},{"name":"shared_preferences_linux","dependencies":["path_provider_linux"]},{"name":"shared_preferences_web","dependencies":[]},{"name":"shared_preferences_windows","dependencies":["path_provider_windows"]}],"date_created":"2024-10-06 12:51:25.711950","version":"3.22.2"} \ No newline at end of file diff --git a/README.md b/README.md index 0280f8c..e78f647 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,104 @@ + # TDD Clean Architecture for Flutter -### The whole accompanying tutorial series is available at :point_right: [this link](https://resocoder.com/flutter-clean-architecture-tdd/) :point_left:. +

+ Number Trivia App +

+

+

Number Trivia App

+

+ Number Trivia App using clean architecture and test-driven development +
+ Project inspired by Reso Coder's Clean Architecture TDD Course. +
+

+

+ +## What's Included + +- :star: **State Management** using the BLoC pattern +- :star: **Test-Driven Development** with unit tests for domain and data layers using `mocktail` +- :star: **Dependency Injection** using `get_it` +- :star: **Functional Programming** with `dartz` package +- :star: **Equality Checks** in classes using `equatable` +- :star: **REST API** integration with `http` +- :star: **Exception Handling** using custom Failure classes +- :star: **Persistent Data** using shared preferences +- :star: **Null Safety** support for safer, more reliable code + +## Project Architecture + +This project follows the principles of **Clean Architecture**. The code is split into the following layers: + +- **Domain Layer**: Contains core business logic and use cases. +- **Data Layer**: Handles data from APIs, local databases, or any external sources. +- **Presentation Layer**: Manages the user interface (UI) using BLoC for state management. + +### Clean Architecture Diagrams + +- **Reso Coder's Clean Architecture Diagram** + ![Reso Coder's Clean Architecture](https://i.imgur.com/wqTYfpi.png) + +- **Robert C. Martin's Clean Architecture Diagram** + ![Robert C. Martin's Clean Architecture](https://i.imgur.com/6uzRuuN.jpg) + +By using this structure, it's easier to test, modify, and extend the application, especially in large-scale projects. + +## Key Features + +### 1. **Bloc State Management** +Bloc (Business Logic Component) is used for managing states across the app. This makes the app's business logic independent of the UI. + +### 2. **Dependency Injection** +The `get_it` package is used for easy dependency injection, making it simple to switch implementations or mock objects for testing. + +### 3. **Functional Programming with Dartz** +The `dartz` package enables functional programming patterns, such as using `Either` for handling failures and successes, ensuring clean and maintainable code. + +### 4. **API Integration** +The app uses the `http` package for fetching data from a REST API. It retrieves [describe the data, e.g., trivia, user information]. + +### 5. **Error Handling** +Custom `Failure` classes handle exceptions gracefully, ensuring a smooth user experience when errors occur. + +### 6. **Null Safety** +This project is built with Dart's **Null Safety** features enabled, ensuring fewer runtime errors and safer code by handling null values properly. + +## Testing + +This project follows **Test-Driven Development (TDD)** practices. Unit tests are provided for the domain, data, and presentation layers. To run the tests, use: + +```bash +flutter test +``` + +We use the `mocktail` package for mocking dependencies in the tests. This ensures clean and isolated testing of components by mocking external dependencies such as services and repositories. + +## How to Contribute + +Feel free to contribute to this project. You can do so by: + +1. Forking the repository. +2. Creating a feature branch (`git checkout -b feature/your-feature`). +3. Committing your changes (`git commit -m 'Add some feature'`). +4. Pushing to the branch (`git push origin feature/your-feature`). +5. Opening a pull request. + +--- + +### License -#### _Find more tutorials on [resocoder.com](https://resocoder.com)_ +This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details. -
+--- -

Architecture Proposal

+**_More tutorials and information on Flutter development can be found on [Reso Coder](https://resocoder.com)._** -
+--- - +This updated README includes information about: -
-
+- The use of `mocktail` for testing. +- Support for **Null Safety**, highlighting that the project uses Dart’s safety features to avoid null reference errors. -[![Reso Coder](https://resocoder.com/wp-content/uploads/2019/09/logo_with_text_signature.png)](https://resocoder.com) -
-_Be prepared for **real** app development_ +If you'd like to add more details, like specific features or screenshots, feel free to reach out! \ No newline at end of file diff --git a/analysis_options.yaml b/analysis_options.yaml new file mode 100644 index 0000000..442f942 --- /dev/null +++ b/analysis_options.yaml @@ -0,0 +1,10 @@ +include: package:very_good_analysis/analysis_options.yaml + +analyzer: + errors: + avoid_private_typedef_functions: ignore + cascade_invocations: ignore + inference_failure_on_instance_creation: ignore + one_member_abstracts: ignore + + diff --git a/android/.gitignore b/android/.gitignore new file mode 100644 index 0000000..6f56801 --- /dev/null +++ b/android/.gitignore @@ -0,0 +1,13 @@ +gradle-wrapper.jar +/.gradle +/captures/ +/gradlew +/gradlew.bat +/local.properties +GeneratedPluginRegistrant.java + +# Remember to never publicly share your keystore. +# See https://flutter.dev/docs/deployment/android#reference-the-keystore-from-the-app +key.properties +**/*.keystore +**/*.jks diff --git a/android/app/build.gradle b/android/app/build.gradle index aa4832c..1c487fc 100644 --- a/android/app/build.gradle +++ b/android/app/build.gradle @@ -1,67 +1,58 @@ +plugins { + id "com.android.application" + id "kotlin-android" + // The Flutter Gradle Plugin must be applied after the Android and Kotlin Gradle plugins. + id "dev.flutter.flutter-gradle-plugin" +} + def localProperties = new Properties() -def localPropertiesFile = rootProject.file('local.properties') +def localPropertiesFile = rootProject.file("local.properties") if (localPropertiesFile.exists()) { - localPropertiesFile.withReader('UTF-8') { reader -> + localPropertiesFile.withReader("UTF-8") { reader -> localProperties.load(reader) } } -def flutterRoot = localProperties.getProperty('flutter.sdk') -if (flutterRoot == null) { - throw new GradleException("Flutter SDK not found. Define location with flutter.sdk in the local.properties file.") -} - -def flutterVersionCode = localProperties.getProperty('flutter.versionCode') +def flutterVersionCode = localProperties.getProperty("flutter.versionCode") if (flutterVersionCode == null) { - flutterVersionCode = '1' + flutterVersionCode = "1" } -def flutterVersionName = localProperties.getProperty('flutter.versionName') +def flutterVersionName = localProperties.getProperty("flutter.versionName") if (flutterVersionName == null) { - flutterVersionName = '1.0' + flutterVersionName = "1.0" } -apply plugin: 'com.android.application' -apply plugin: 'kotlin-android' -apply from: "$flutterRoot/packages/flutter_tools/gradle/flutter.gradle" - android { - compileSdkVersion 28 + namespace = "com.example.clean_architecture_tdd_course" + compileSdk = flutter.compileSdkVersion + ndkVersion = flutter.ndkVersion - sourceSets { - main.java.srcDirs += 'src/main/kotlin' - } - - lintOptions { - disable 'InvalidPackage' + compileOptions { + sourceCompatibility = JavaVersion.VERSION_1_8 + targetCompatibility = JavaVersion.VERSION_1_8 } defaultConfig { // TODO: Specify your own unique Application ID (https://developer.android.com/studio/build/application-id.html). - applicationId "com.resocoder.clean_architecture_tdd_course" - minSdkVersion 16 - targetSdkVersion 28 - versionCode flutterVersionCode.toInteger() - versionName flutterVersionName - testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner" + applicationId = "com.example.clean_architecture_tdd_course" + // You can update the following values to match your application needs. + // For more information, see: https://docs.flutter.dev/deployment/android#reviewing-the-gradle-build-configuration. + minSdk = flutter.minSdkVersion + targetSdk = flutter.targetSdkVersion + versionCode = flutterVersionCode.toInteger() + versionName = flutterVersionName } buildTypes { release { // TODO: Add your own signing config for the release build. // Signing with the debug keys for now, so `flutter run --release` works. - signingConfig signingConfigs.debug + signingConfig = signingConfigs.debug } } } flutter { - source '../..' -} - -dependencies { - implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version" - testImplementation 'junit:junit:4.12' - androidTestImplementation 'com.android.support.test:runner:1.0.2' - androidTestImplementation 'com.android.support.test.espresso:espresso-core:3.0.2' + source = "../.." } diff --git a/android/app/src/debug/AndroidManifest.xml b/android/app/src/debug/AndroidManifest.xml index b0c7163..399f698 100644 --- a/android/app/src/debug/AndroidManifest.xml +++ b/android/app/src/debug/AndroidManifest.xml @@ -1,6 +1,6 @@ - - diff --git a/android/app/src/main/AndroidManifest.xml b/android/app/src/main/AndroidManifest.xml index 9a07a92..a28fa67 100644 --- a/android/app/src/main/AndroidManifest.xml +++ b/android/app/src/main/AndroidManifest.xml @@ -1,33 +1,47 @@ - - - + + + - + + android:name="io.flutter.embedding.android.NormalTheme" + android:resource="@style/NormalTheme" + /> + + + + + + + + + diff --git a/android/app/src/main/kotlin/com/example/clean_architecture_tdd_course/MainActivity.kt b/android/app/src/main/kotlin/com/example/clean_architecture_tdd_course/MainActivity.kt new file mode 100644 index 0000000..15c0bfc --- /dev/null +++ b/android/app/src/main/kotlin/com/example/clean_architecture_tdd_course/MainActivity.kt @@ -0,0 +1,5 @@ +package com.example.clean_architecture_tdd_course + +import io.flutter.embedding.android.FlutterActivity + +class MainActivity: FlutterActivity() diff --git a/android/app/src/main/kotlin/com/resocoder/clean_architecture_tdd_course/MainActivity.kt b/android/app/src/main/kotlin/com/resocoder/clean_architecture_tdd_course/MainActivity.kt deleted file mode 100644 index 27bc908..0000000 --- a/android/app/src/main/kotlin/com/resocoder/clean_architecture_tdd_course/MainActivity.kt +++ /dev/null @@ -1,13 +0,0 @@ -package com.resocoder.clean_architecture_tdd_course - -import android.os.Bundle - -import io.flutter.app.FlutterActivity -import io.flutter.plugins.GeneratedPluginRegistrant - -class MainActivity: FlutterActivity() { - override fun onCreate(savedInstanceState: Bundle?) { - super.onCreate(savedInstanceState) - GeneratedPluginRegistrant.registerWith(this) - } -} diff --git a/android/app/src/main/res/drawable-v21/launch_background.xml b/android/app/src/main/res/drawable-v21/launch_background.xml new file mode 100644 index 0000000..f74085f --- /dev/null +++ b/android/app/src/main/res/drawable-v21/launch_background.xml @@ -0,0 +1,12 @@ + + + + + + + + diff --git a/android/app/src/main/res/values-night/styles.xml b/android/app/src/main/res/values-night/styles.xml new file mode 100644 index 0000000..06952be --- /dev/null +++ b/android/app/src/main/res/values-night/styles.xml @@ -0,0 +1,18 @@ + + + + + + + diff --git a/android/app/src/main/res/values/styles.xml b/android/app/src/main/res/values/styles.xml index 00fa441..cb1ef88 100644 --- a/android/app/src/main/res/values/styles.xml +++ b/android/app/src/main/res/values/styles.xml @@ -1,8 +1,18 @@ - + + diff --git a/android/app/src/profile/AndroidManifest.xml b/android/app/src/profile/AndroidManifest.xml index b0c7163..399f698 100644 --- a/android/app/src/profile/AndroidManifest.xml +++ b/android/app/src/profile/AndroidManifest.xml @@ -1,6 +1,6 @@ - - diff --git a/android/build.gradle b/android/build.gradle index b7faad8..d2ffbff 100644 --- a/android/build.gradle +++ b/android/build.gradle @@ -1,31 +1,18 @@ -buildscript { - ext.kotlin_version = '1.2.71' - repositories { - google() - jcenter() - } - - dependencies { - classpath 'com.android.tools.build:gradle:3.2.1' - classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version" - } -} - allprojects { repositories { google() - jcenter() + mavenCentral() } } -rootProject.buildDir = '../build' +rootProject.buildDir = "../build" subprojects { project.buildDir = "${rootProject.buildDir}/${project.name}" } subprojects { - project.evaluationDependsOn(':app') + project.evaluationDependsOn(":app") } -task clean(type: Delete) { +tasks.register("clean", Delete) { delete rootProject.buildDir } diff --git a/android/gradle.properties b/android/gradle.properties index 1441b1d..3b5b324 100644 --- a/android/gradle.properties +++ b/android/gradle.properties @@ -1,3 +1,3 @@ -org.gradle.jvmargs=-Xmx1536M - -android.enableR8=true +org.gradle.jvmargs=-Xmx4G -XX:+HeapDumpOnOutOfMemoryError +android.useAndroidX=true +android.enableJetifier=true diff --git a/android/gradle/wrapper/gradle-wrapper.properties b/android/gradle/wrapper/gradle-wrapper.properties index 2819f02..e1ca574 100644 --- a/android/gradle/wrapper/gradle-wrapper.properties +++ b/android/gradle/wrapper/gradle-wrapper.properties @@ -1,6 +1,5 @@ -#Fri Jun 23 08:50:38 CEST 2017 distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists zipStoreBase=GRADLE_USER_HOME zipStorePath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-4.10.2-all.zip +distributionUrl=https\://services.gradle.org/distributions/gradle-7.6.3-all.zip diff --git a/android/settings.gradle b/android/settings.gradle index 5a2f14f..536165d 100644 --- a/android/settings.gradle +++ b/android/settings.gradle @@ -1,15 +1,25 @@ -include ':app' +pluginManagement { + def flutterSdkPath = { + def properties = new Properties() + file("local.properties").withInputStream { properties.load(it) } + def flutterSdkPath = properties.getProperty("flutter.sdk") + assert flutterSdkPath != null, "flutter.sdk not set in local.properties" + return flutterSdkPath + }() -def flutterProjectRoot = rootProject.projectDir.parentFile.toPath() + includeBuild("$flutterSdkPath/packages/flutter_tools/gradle") -def plugins = new Properties() -def pluginsFile = new File(flutterProjectRoot.toFile(), '.flutter-plugins') -if (pluginsFile.exists()) { - pluginsFile.withReader('UTF-8') { reader -> plugins.load(reader) } + repositories { + google() + mavenCentral() + gradlePluginPortal() + } } -plugins.each { name, path -> - def pluginDirectory = flutterProjectRoot.resolve(path).resolve('android').toFile() - include ":$name" - project(":$name").projectDir = pluginDirectory +plugins { + id "dev.flutter.flutter-plugin-loader" version "1.0.0" + id "com.android.application" version "7.3.0" apply false + id "org.jetbrains.kotlin.android" version "1.7.10" apply false } + +include ":app" diff --git a/architecture-proposal.png b/architecture-proposal.png deleted file mode 100644 index 24fc137..0000000 Binary files a/architecture-proposal.png and /dev/null differ diff --git a/assets/fonts/Poppins-Bold.ttf b/assets/fonts/Poppins-Bold.ttf new file mode 100644 index 0000000..b94d47f Binary files /dev/null and b/assets/fonts/Poppins-Bold.ttf differ diff --git a/assets/fonts/Poppins-Regular.ttf b/assets/fonts/Poppins-Regular.ttf new file mode 100644 index 0000000..be06e7f Binary files /dev/null and b/assets/fonts/Poppins-Regular.ttf differ diff --git a/assets/images/background.png b/assets/images/background.png new file mode 100644 index 0000000..3c7759a Binary files /dev/null and b/assets/images/background.png differ diff --git a/assets/images/number_trivia_app.png b/assets/images/number_trivia_app.png new file mode 100644 index 0000000..67e0ffe Binary files /dev/null and b/assets/images/number_trivia_app.png differ diff --git a/ios/.gitignore b/ios/.gitignore new file mode 100644 index 0000000..7a7f987 --- /dev/null +++ b/ios/.gitignore @@ -0,0 +1,34 @@ +**/dgph +*.mode1v3 +*.mode2v3 +*.moved-aside +*.pbxuser +*.perspectivev3 +**/*sync/ +.sconsign.dblite +.tags* +**/.vagrant/ +**/DerivedData/ +Icon? +**/Pods/ +**/.symlinks/ +profile +xcuserdata +**/.generated/ +Flutter/App.framework +Flutter/Flutter.framework +Flutter/Flutter.podspec +Flutter/Generated.xcconfig +Flutter/ephemeral/ +Flutter/app.flx +Flutter/app.zip +Flutter/flutter_assets/ +Flutter/flutter_export_environment.sh +ServiceDefinitions.json +Runner/GeneratedPluginRegistrant.* + +# Exceptions to above rules. +!default.mode1v3 +!default.mode2v3 +!default.pbxuser +!default.perspectivev3 diff --git a/ios/Flutter/AppFrameworkInfo.plist b/ios/Flutter/AppFrameworkInfo.plist index 6b4c0f7..7c56964 100644 --- a/ios/Flutter/AppFrameworkInfo.plist +++ b/ios/Flutter/AppFrameworkInfo.plist @@ -3,7 +3,7 @@ CFBundleDevelopmentRegion - $(DEVELOPMENT_LANGUAGE) + en CFBundleExecutable App CFBundleIdentifier @@ -21,6 +21,6 @@ CFBundleVersion 1.0 MinimumOSVersion - 8.0 + 12.0 diff --git a/ios/Flutter/Debug.xcconfig b/ios/Flutter/Debug.xcconfig index 592ceee..ec97fc6 100644 --- a/ios/Flutter/Debug.xcconfig +++ b/ios/Flutter/Debug.xcconfig @@ -1 +1,2 @@ +#include? "Pods/Target Support Files/Pods-Runner/Pods-Runner.debug.xcconfig" #include "Generated.xcconfig" diff --git a/ios/Flutter/Release.xcconfig b/ios/Flutter/Release.xcconfig index 592ceee..c4855bf 100644 --- a/ios/Flutter/Release.xcconfig +++ b/ios/Flutter/Release.xcconfig @@ -1 +1,2 @@ +#include? "Pods/Target Support Files/Pods-Runner/Pods-Runner.release.xcconfig" #include "Generated.xcconfig" diff --git a/ios/Flutter/flutter_export_environment.sh b/ios/Flutter/flutter_export_environment.sh index 047511c..c6b4615 100755 --- a/ios/Flutter/flutter_export_environment.sh +++ b/ios/Flutter/flutter_export_environment.sh @@ -1,10 +1,13 @@ #!/bin/sh # This is a generated file; do not edit or check into version control. -export "FLUTTER_ROOT=C:\Flutter\flutter" -export "FLUTTER_APPLICATION_PATH=D:\Projects\Playground_and_Learning\flutter-tdd-clean-architecture-course" -export "FLUTTER_TARGET=lib\main.dart" +export "FLUTTER_ROOT=/Users/linkawy/development/flutter" +export "FLUTTER_APPLICATION_PATH=/Users/linkawy/Development/Projects/clean_architecture_tdd_course" +export "COCOAPODS_PARALLEL_CODE_SIGN=true" +export "FLUTTER_TARGET=lib/main.dart" export "FLUTTER_BUILD_DIR=build" -export "SYMROOT=${SOURCE_ROOT}/../build\ios" -export "FLUTTER_FRAMEWORK_DIR=C:\Flutter\flutter\bin\cache\artifacts\engine\ios" export "FLUTTER_BUILD_NAME=1.0.0" export "FLUTTER_BUILD_NUMBER=1" +export "DART_OBFUSCATION=false" +export "TRACK_WIDGET_CREATION=true" +export "TREE_SHAKE_ICONS=false" +export "PACKAGE_CONFIG=.dart_tool/package_config.json" diff --git a/ios/Podfile b/ios/Podfile new file mode 100644 index 0000000..d97f17e --- /dev/null +++ b/ios/Podfile @@ -0,0 +1,44 @@ +# Uncomment this line to define a global platform for your project +# platform :ios, '12.0' + +# CocoaPods analytics sends network stats synchronously affecting flutter build latency. +ENV['COCOAPODS_DISABLE_STATS'] = 'true' + +project 'Runner', { + 'Debug' => :debug, + 'Profile' => :release, + 'Release' => :release, +} + +def flutter_root + generated_xcode_build_settings_path = File.expand_path(File.join('..', 'Flutter', 'Generated.xcconfig'), __FILE__) + unless File.exist?(generated_xcode_build_settings_path) + raise "#{generated_xcode_build_settings_path} must exist. If you're running pod install manually, make sure flutter pub get is executed first" + end + + File.foreach(generated_xcode_build_settings_path) do |line| + matches = line.match(/FLUTTER_ROOT\=(.*)/) + return matches[1].strip if matches + end + raise "FLUTTER_ROOT not found in #{generated_xcode_build_settings_path}. Try deleting Generated.xcconfig, then run flutter pub get" +end + +require File.expand_path(File.join('packages', 'flutter_tools', 'bin', 'podhelper'), flutter_root) + +flutter_ios_podfile_setup + +target 'Runner' do + use_frameworks! + use_modular_headers! + + flutter_install_all_ios_pods File.dirname(File.realpath(__FILE__)) + target 'RunnerTests' do + inherit! :search_paths + end +end + +post_install do |installer| + installer.pods_project.targets.each do |target| + flutter_additional_ios_build_settings(target) + end +end diff --git a/ios/Runner.xcodeproj/project.pbxproj b/ios/Runner.xcodeproj/project.pbxproj index 504199c..e0b352a 100644 --- a/ios/Runner.xcodeproj/project.pbxproj +++ b/ios/Runner.xcodeproj/project.pbxproj @@ -3,23 +3,29 @@ archiveVersion = 1; classes = { }; - objectVersion = 46; + objectVersion = 54; objects = { /* Begin PBXBuildFile section */ 1498D2341E8E89220040F4C2 /* GeneratedPluginRegistrant.m in Sources */ = {isa = PBXBuildFile; fileRef = 1498D2331E8E89220040F4C2 /* GeneratedPluginRegistrant.m */; }; + 331C808B294A63AB00263BE5 /* RunnerTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 331C807B294A618700263BE5 /* RunnerTests.swift */; }; 3B3967161E833CAA004F5970 /* AppFrameworkInfo.plist in Resources */ = {isa = PBXBuildFile; fileRef = 3B3967151E833CAA004F5970 /* AppFrameworkInfo.plist */; }; - 3B80C3941E831B6300D905FE /* App.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 3B80C3931E831B6300D905FE /* App.framework */; }; - 3B80C3951E831B6300D905FE /* App.framework in Embed Frameworks */ = {isa = PBXBuildFile; fileRef = 3B80C3931E831B6300D905FE /* App.framework */; settings = {ATTRIBUTES = (CodeSignOnCopy, RemoveHeadersOnCopy, ); }; }; 74858FAF1ED2DC5600515810 /* AppDelegate.swift in Sources */ = {isa = PBXBuildFile; fileRef = 74858FAE1ED2DC5600515810 /* AppDelegate.swift */; }; - 9705A1C61CF904A100538489 /* Flutter.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 9740EEBA1CF902C7004384FC /* Flutter.framework */; }; - 9705A1C71CF904A300538489 /* Flutter.framework in Embed Frameworks */ = {isa = PBXBuildFile; fileRef = 9740EEBA1CF902C7004384FC /* Flutter.framework */; settings = {ATTRIBUTES = (CodeSignOnCopy, RemoveHeadersOnCopy, ); }; }; - 9740EEB41CF90195004384FC /* Debug.xcconfig in Resources */ = {isa = PBXBuildFile; fileRef = 9740EEB21CF90195004384FC /* Debug.xcconfig */; }; 97C146FC1CF9000F007C117D /* Main.storyboard in Resources */ = {isa = PBXBuildFile; fileRef = 97C146FA1CF9000F007C117D /* Main.storyboard */; }; 97C146FE1CF9000F007C117D /* Assets.xcassets in Resources */ = {isa = PBXBuildFile; fileRef = 97C146FD1CF9000F007C117D /* Assets.xcassets */; }; 97C147011CF9000F007C117D /* LaunchScreen.storyboard in Resources */ = {isa = PBXBuildFile; fileRef = 97C146FF1CF9000F007C117D /* LaunchScreen.storyboard */; }; /* End PBXBuildFile section */ +/* Begin PBXContainerItemProxy section */ + 331C8085294A63A400263BE5 /* PBXContainerItemProxy */ = { + isa = PBXContainerItemProxy; + containerPortal = 97C146E61CF9000F007C117D /* Project object */; + proxyType = 1; + remoteGlobalIDString = 97C146ED1CF9000F007C117D; + remoteInfo = Runner; + }; +/* End PBXContainerItemProxy section */ + /* Begin PBXCopyFilesBuildPhase section */ 9705A1C41CF9048500538489 /* Embed Frameworks */ = { isa = PBXCopyFilesBuildPhase; @@ -27,8 +33,6 @@ dstPath = ""; dstSubfolderSpec = 10; files = ( - 3B80C3951E831B6300D905FE /* App.framework in Embed Frameworks */, - 9705A1C71CF904A300538489 /* Flutter.framework in Embed Frameworks */, ); name = "Embed Frameworks"; runOnlyForDeploymentPostprocessing = 0; @@ -38,14 +42,14 @@ /* Begin PBXFileReference section */ 1498D2321E8E86230040F4C2 /* GeneratedPluginRegistrant.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = GeneratedPluginRegistrant.h; sourceTree = ""; }; 1498D2331E8E89220040F4C2 /* GeneratedPluginRegistrant.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = GeneratedPluginRegistrant.m; sourceTree = ""; }; + 331C807B294A618700263BE5 /* RunnerTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = RunnerTests.swift; sourceTree = ""; }; + 331C8081294A63A400263BE5 /* RunnerTests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = RunnerTests.xctest; sourceTree = BUILT_PRODUCTS_DIR; }; 3B3967151E833CAA004F5970 /* AppFrameworkInfo.plist */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.xml; name = AppFrameworkInfo.plist; path = Flutter/AppFrameworkInfo.plist; sourceTree = ""; }; - 3B80C3931E831B6300D905FE /* App.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = App.framework; path = Flutter/App.framework; sourceTree = ""; }; 74858FAD1ED2DC5600515810 /* Runner-Bridging-Header.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "Runner-Bridging-Header.h"; sourceTree = ""; }; 74858FAE1ED2DC5600515810 /* AppDelegate.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = AppDelegate.swift; sourceTree = ""; }; 7AFA3C8E1D35360C0083082E /* Release.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; name = Release.xcconfig; path = Flutter/Release.xcconfig; sourceTree = ""; }; 9740EEB21CF90195004384FC /* Debug.xcconfig */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.xcconfig; name = Debug.xcconfig; path = Flutter/Debug.xcconfig; sourceTree = ""; }; 9740EEB31CF90195004384FC /* Generated.xcconfig */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.xcconfig; name = Generated.xcconfig; path = Flutter/Generated.xcconfig; sourceTree = ""; }; - 9740EEBA1CF902C7004384FC /* Flutter.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = Flutter.framework; path = Flutter/Flutter.framework; sourceTree = ""; }; 97C146EE1CF9000F007C117D /* Runner.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = Runner.app; sourceTree = BUILT_PRODUCTS_DIR; }; 97C146FB1CF9000F007C117D /* Base */ = {isa = PBXFileReference; lastKnownFileType = file.storyboard; name = Base; path = Base.lproj/Main.storyboard; sourceTree = ""; }; 97C146FD1CF9000F007C117D /* Assets.xcassets */ = {isa = PBXFileReference; lastKnownFileType = folder.assetcatalog; path = Assets.xcassets; sourceTree = ""; }; @@ -58,20 +62,24 @@ isa = PBXFrameworksBuildPhase; buildActionMask = 2147483647; files = ( - 9705A1C61CF904A100538489 /* Flutter.framework in Frameworks */, - 3B80C3941E831B6300D905FE /* App.framework in Frameworks */, ); runOnlyForDeploymentPostprocessing = 0; }; /* End PBXFrameworksBuildPhase section */ /* Begin PBXGroup section */ + 331C8082294A63A400263BE5 /* RunnerTests */ = { + isa = PBXGroup; + children = ( + 331C807B294A618700263BE5 /* RunnerTests.swift */, + ); + path = RunnerTests; + sourceTree = ""; + }; 9740EEB11CF90186004384FC /* Flutter */ = { isa = PBXGroup; children = ( - 3B80C3931E831B6300D905FE /* App.framework */, 3B3967151E833CAA004F5970 /* AppFrameworkInfo.plist */, - 9740EEBA1CF902C7004384FC /* Flutter.framework */, 9740EEB21CF90195004384FC /* Debug.xcconfig */, 7AFA3C8E1D35360C0083082E /* Release.xcconfig */, 9740EEB31CF90195004384FC /* Generated.xcconfig */, @@ -85,6 +93,7 @@ 9740EEB11CF90186004384FC /* Flutter */, 97C146F01CF9000F007C117D /* Runner */, 97C146EF1CF9000F007C117D /* Products */, + 331C8082294A63A400263BE5 /* RunnerTests */, ); sourceTree = ""; }; @@ -92,6 +101,7 @@ isa = PBXGroup; children = ( 97C146EE1CF9000F007C117D /* Runner.app */, + 331C8081294A63A400263BE5 /* RunnerTests.xctest */, ); name = Products; sourceTree = ""; @@ -103,7 +113,6 @@ 97C146FD1CF9000F007C117D /* Assets.xcassets */, 97C146FF1CF9000F007C117D /* LaunchScreen.storyboard */, 97C147021CF9000F007C117D /* Info.plist */, - 97C146F11CF9000F007C117D /* Supporting Files */, 1498D2321E8E86230040F4C2 /* GeneratedPluginRegistrant.h */, 1498D2331E8E89220040F4C2 /* GeneratedPluginRegistrant.m */, 74858FAE1ED2DC5600515810 /* AppDelegate.swift */, @@ -112,16 +121,26 @@ path = Runner; sourceTree = ""; }; - 97C146F11CF9000F007C117D /* Supporting Files */ = { - isa = PBXGroup; - children = ( - ); - name = "Supporting Files"; - sourceTree = ""; - }; /* End PBXGroup section */ /* Begin PBXNativeTarget section */ + 331C8080294A63A400263BE5 /* RunnerTests */ = { + isa = PBXNativeTarget; + buildConfigurationList = 331C8087294A63A400263BE5 /* Build configuration list for PBXNativeTarget "RunnerTests" */; + buildPhases = ( + 331C807D294A63A400263BE5 /* Sources */, + 331C807F294A63A400263BE5 /* Resources */, + ); + buildRules = ( + ); + dependencies = ( + 331C8086294A63A400263BE5 /* PBXTargetDependency */, + ); + name = RunnerTests; + productName = RunnerTests; + productReference = 331C8081294A63A400263BE5 /* RunnerTests.xctest */; + productType = "com.apple.product-type.bundle.unit-test"; + }; 97C146ED1CF9000F007C117D /* Runner */ = { isa = PBXNativeTarget; buildConfigurationList = 97C147051CF9000F007C117D /* Build configuration list for PBXNativeTarget "Runner" */; @@ -148,17 +167,22 @@ 97C146E61CF9000F007C117D /* Project object */ = { isa = PBXProject; attributes = { - LastUpgradeCheck = 1020; - ORGANIZATIONNAME = "The Chromium Authors"; + BuildIndependentTargetsInParallel = YES; + LastUpgradeCheck = 1510; + ORGANIZATIONNAME = ""; TargetAttributes = { + 331C8080294A63A400263BE5 = { + CreatedOnToolsVersion = 14.0; + TestTargetID = 97C146ED1CF9000F007C117D; + }; 97C146ED1CF9000F007C117D = { CreatedOnToolsVersion = 7.3.1; - LastSwiftMigration = 0910; + LastSwiftMigration = 1100; }; }; }; buildConfigurationList = 97C146E91CF9000F007C117D /* Build configuration list for PBXProject "Runner" */; - compatibilityVersion = "Xcode 3.2"; + compatibilityVersion = "Xcode 9.3"; developmentRegion = en; hasScannedForEncodings = 0; knownRegions = ( @@ -171,18 +195,25 @@ projectRoot = ""; targets = ( 97C146ED1CF9000F007C117D /* Runner */, + 331C8080294A63A400263BE5 /* RunnerTests */, ); }; /* End PBXProject section */ /* Begin PBXResourcesBuildPhase section */ + 331C807F294A63A400263BE5 /* Resources */ = { + isa = PBXResourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + runOnlyForDeploymentPostprocessing = 0; + }; 97C146EC1CF9000F007C117D /* Resources */ = { isa = PBXResourcesBuildPhase; buildActionMask = 2147483647; files = ( 97C147011CF9000F007C117D /* LaunchScreen.storyboard in Resources */, 3B3967161E833CAA004F5970 /* AppFrameworkInfo.plist in Resources */, - 9740EEB41CF90195004384FC /* Debug.xcconfig in Resources */, 97C146FE1CF9000F007C117D /* Assets.xcassets in Resources */, 97C146FC1CF9000F007C117D /* Main.storyboard in Resources */, ); @@ -193,20 +224,23 @@ /* Begin PBXShellScriptBuildPhase section */ 3B06AD1E1E4923F5004D2608 /* Thin Binary */ = { isa = PBXShellScriptBuildPhase; + alwaysOutOfDate = 1; buildActionMask = 2147483647; files = ( ); inputPaths = ( + "${TARGET_BUILD_DIR}/${INFOPLIST_PATH}", ); name = "Thin Binary"; outputPaths = ( ); runOnlyForDeploymentPostprocessing = 0; shellPath = /bin/sh; - shellScript = "/bin/sh \"$FLUTTER_ROOT/packages/flutter_tools/bin/xcode_backend.sh\" thin"; + shellScript = "/bin/sh \"$FLUTTER_ROOT/packages/flutter_tools/bin/xcode_backend.sh\" embed_and_thin"; }; 9740EEB61CF901F6004384FC /* Run Script */ = { isa = PBXShellScriptBuildPhase; + alwaysOutOfDate = 1; buildActionMask = 2147483647; files = ( ); @@ -222,6 +256,14 @@ /* End PBXShellScriptBuildPhase section */ /* Begin PBXSourcesBuildPhase section */ + 331C807D294A63A400263BE5 /* Sources */ = { + isa = PBXSourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + 331C808B294A63AB00263BE5 /* RunnerTests.swift in Sources */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; 97C146EA1CF9000F007C117D /* Sources */ = { isa = PBXSourcesBuildPhase; buildActionMask = 2147483647; @@ -233,6 +275,14 @@ }; /* End PBXSourcesBuildPhase section */ +/* Begin PBXTargetDependency section */ + 331C8086294A63A400263BE5 /* PBXTargetDependency */ = { + isa = PBXTargetDependency; + target = 97C146ED1CF9000F007C117D /* Runner */; + targetProxy = 331C8085294A63A400263BE5 /* PBXContainerItemProxy */; + }; +/* End PBXTargetDependency section */ + /* Begin PBXVariantGroup section */ 97C146FA1CF9000F007C117D /* Main.storyboard */ = { isa = PBXVariantGroup; @@ -255,9 +305,9 @@ /* Begin XCBuildConfiguration section */ 249021D3217E4FDB00AE95B9 /* Profile */ = { isa = XCBuildConfiguration; - baseConfigurationReference = 7AFA3C8E1D35360C0083082E /* Release.xcconfig */; buildSettings = { ALWAYS_SEARCH_USER_PATHS = NO; + ASSETCATALOG_COMPILER_GENERATE_SWIFT_ASSET_SYMBOL_EXTENSIONS = YES; CLANG_ANALYZER_NONNULL = YES; CLANG_CXX_LANGUAGE_STANDARD = "gnu++0x"; CLANG_CXX_LIBRARY = "libc++"; @@ -287,6 +337,7 @@ DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym"; ENABLE_NS_ASSERTIONS = NO; ENABLE_STRICT_OBJC_MSGSEND = YES; + ENABLE_USER_SCRIPT_SANDBOXING = NO; GCC_C_LANGUAGE_STANDARD = gnu99; GCC_NO_COMMON_BLOCKS = YES; GCC_WARN_64_TO_32_BIT_CONVERSION = YES; @@ -295,9 +346,10 @@ GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; GCC_WARN_UNUSED_FUNCTION = YES; GCC_WARN_UNUSED_VARIABLE = YES; - IPHONEOS_DEPLOYMENT_TARGET = 8.0; + IPHONEOS_DEPLOYMENT_TARGET = 12.0; MTL_ENABLE_DEBUG_INFO = NO; SDKROOT = iphoneos; + SUPPORTED_PLATFORMS = iphoneos; TARGETED_DEVICE_FAMILY = "1,2"; VALIDATE_PRODUCT = YES; }; @@ -308,32 +360,74 @@ baseConfigurationReference = 7AFA3C8E1D35360C0083082E /* Release.xcconfig */; buildSettings = { ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon; + CLANG_ENABLE_MODULES = YES; CURRENT_PROJECT_VERSION = "$(FLUTTER_BUILD_NUMBER)"; - DEVELOPMENT_TEAM = S8QB4VV633; ENABLE_BITCODE = NO; - FRAMEWORK_SEARCH_PATHS = ( - "$(inherited)", - "$(PROJECT_DIR)/Flutter", - ); INFOPLIST_FILE = Runner/Info.plist; - LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks"; - LIBRARY_SEARCH_PATHS = ( + LD_RUNPATH_SEARCH_PATHS = ( "$(inherited)", - "$(PROJECT_DIR)/Flutter", + "@executable_path/Frameworks", ); - PRODUCT_BUNDLE_IDENTIFIER = com.resocoder.cleanArchitectureTddCourse; + PRODUCT_BUNDLE_IDENTIFIER = com.example.cleanArchitectureTddCourse; PRODUCT_NAME = "$(TARGET_NAME)"; SWIFT_OBJC_BRIDGING_HEADER = "Runner/Runner-Bridging-Header.h"; - SWIFT_VERSION = 4.0; + SWIFT_VERSION = 5.0; VERSIONING_SYSTEM = "apple-generic"; }; name = Profile; }; + 331C8088294A63A400263BE5 /* Debug */ = { + isa = XCBuildConfiguration; + buildSettings = { + BUNDLE_LOADER = "$(TEST_HOST)"; + CODE_SIGN_STYLE = Automatic; + CURRENT_PROJECT_VERSION = 1; + GENERATE_INFOPLIST_FILE = YES; + MARKETING_VERSION = 1.0; + PRODUCT_BUNDLE_IDENTIFIER = com.example.cleanArchitectureTddCourse.RunnerTests; + PRODUCT_NAME = "$(TARGET_NAME)"; + SWIFT_ACTIVE_COMPILATION_CONDITIONS = DEBUG; + SWIFT_OPTIMIZATION_LEVEL = "-Onone"; + SWIFT_VERSION = 5.0; + TEST_HOST = "$(BUILT_PRODUCTS_DIR)/Runner.app/$(BUNDLE_EXECUTABLE_FOLDER_PATH)/Runner"; + }; + name = Debug; + }; + 331C8089294A63A400263BE5 /* Release */ = { + isa = XCBuildConfiguration; + buildSettings = { + BUNDLE_LOADER = "$(TEST_HOST)"; + CODE_SIGN_STYLE = Automatic; + CURRENT_PROJECT_VERSION = 1; + GENERATE_INFOPLIST_FILE = YES; + MARKETING_VERSION = 1.0; + PRODUCT_BUNDLE_IDENTIFIER = com.example.cleanArchitectureTddCourse.RunnerTests; + PRODUCT_NAME = "$(TARGET_NAME)"; + SWIFT_VERSION = 5.0; + TEST_HOST = "$(BUILT_PRODUCTS_DIR)/Runner.app/$(BUNDLE_EXECUTABLE_FOLDER_PATH)/Runner"; + }; + name = Release; + }; + 331C808A294A63A400263BE5 /* Profile */ = { + isa = XCBuildConfiguration; + buildSettings = { + BUNDLE_LOADER = "$(TEST_HOST)"; + CODE_SIGN_STYLE = Automatic; + CURRENT_PROJECT_VERSION = 1; + GENERATE_INFOPLIST_FILE = YES; + MARKETING_VERSION = 1.0; + PRODUCT_BUNDLE_IDENTIFIER = com.example.cleanArchitectureTddCourse.RunnerTests; + PRODUCT_NAME = "$(TARGET_NAME)"; + SWIFT_VERSION = 5.0; + TEST_HOST = "$(BUILT_PRODUCTS_DIR)/Runner.app/$(BUNDLE_EXECUTABLE_FOLDER_PATH)/Runner"; + }; + name = Profile; + }; 97C147031CF9000F007C117D /* Debug */ = { isa = XCBuildConfiguration; - baseConfigurationReference = 9740EEB21CF90195004384FC /* Debug.xcconfig */; buildSettings = { ALWAYS_SEARCH_USER_PATHS = NO; + ASSETCATALOG_COMPILER_GENERATE_SWIFT_ASSET_SYMBOL_EXTENSIONS = YES; CLANG_ANALYZER_NONNULL = YES; CLANG_CXX_LANGUAGE_STANDARD = "gnu++0x"; CLANG_CXX_LIBRARY = "libc++"; @@ -363,6 +457,7 @@ DEBUG_INFORMATION_FORMAT = dwarf; ENABLE_STRICT_OBJC_MSGSEND = YES; ENABLE_TESTABILITY = YES; + ENABLE_USER_SCRIPT_SANDBOXING = NO; GCC_C_LANGUAGE_STANDARD = gnu99; GCC_DYNAMIC_NO_PIC = NO; GCC_NO_COMMON_BLOCKS = YES; @@ -377,7 +472,7 @@ GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; GCC_WARN_UNUSED_FUNCTION = YES; GCC_WARN_UNUSED_VARIABLE = YES; - IPHONEOS_DEPLOYMENT_TARGET = 8.0; + IPHONEOS_DEPLOYMENT_TARGET = 12.0; MTL_ENABLE_DEBUG_INFO = YES; ONLY_ACTIVE_ARCH = YES; SDKROOT = iphoneos; @@ -387,9 +482,9 @@ }; 97C147041CF9000F007C117D /* Release */ = { isa = XCBuildConfiguration; - baseConfigurationReference = 7AFA3C8E1D35360C0083082E /* Release.xcconfig */; buildSettings = { ALWAYS_SEARCH_USER_PATHS = NO; + ASSETCATALOG_COMPILER_GENERATE_SWIFT_ASSET_SYMBOL_EXTENSIONS = YES; CLANG_ANALYZER_NONNULL = YES; CLANG_CXX_LANGUAGE_STANDARD = "gnu++0x"; CLANG_CXX_LIBRARY = "libc++"; @@ -419,6 +514,7 @@ DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym"; ENABLE_NS_ASSERTIONS = NO; ENABLE_STRICT_OBJC_MSGSEND = YES; + ENABLE_USER_SCRIPT_SANDBOXING = NO; GCC_C_LANGUAGE_STANDARD = gnu99; GCC_NO_COMMON_BLOCKS = YES; GCC_WARN_64_TO_32_BIT_CONVERSION = YES; @@ -427,10 +523,12 @@ GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; GCC_WARN_UNUSED_FUNCTION = YES; GCC_WARN_UNUSED_VARIABLE = YES; - IPHONEOS_DEPLOYMENT_TARGET = 8.0; + IPHONEOS_DEPLOYMENT_TARGET = 12.0; MTL_ENABLE_DEBUG_INFO = NO; SDKROOT = iphoneos; - SWIFT_OPTIMIZATION_LEVEL = "-Owholemodule"; + SUPPORTED_PLATFORMS = iphoneos; + SWIFT_COMPILATION_MODE = wholemodule; + SWIFT_OPTIMIZATION_LEVEL = "-O"; TARGETED_DEVICE_FAMILY = "1,2"; VALIDATE_PRODUCT = YES; }; @@ -444,22 +542,16 @@ CLANG_ENABLE_MODULES = YES; CURRENT_PROJECT_VERSION = "$(FLUTTER_BUILD_NUMBER)"; ENABLE_BITCODE = NO; - FRAMEWORK_SEARCH_PATHS = ( - "$(inherited)", - "$(PROJECT_DIR)/Flutter", - ); INFOPLIST_FILE = Runner/Info.plist; - LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks"; - LIBRARY_SEARCH_PATHS = ( + LD_RUNPATH_SEARCH_PATHS = ( "$(inherited)", - "$(PROJECT_DIR)/Flutter", + "@executable_path/Frameworks", ); - PRODUCT_BUNDLE_IDENTIFIER = com.resocoder.cleanArchitectureTddCourse; + PRODUCT_BUNDLE_IDENTIFIER = com.example.cleanArchitectureTddCourse; PRODUCT_NAME = "$(TARGET_NAME)"; SWIFT_OBJC_BRIDGING_HEADER = "Runner/Runner-Bridging-Header.h"; SWIFT_OPTIMIZATION_LEVEL = "-Onone"; - SWIFT_SWIFT3_OBJC_INFERENCE = On; - SWIFT_VERSION = 4.0; + SWIFT_VERSION = 5.0; VERSIONING_SYSTEM = "apple-generic"; }; name = Debug; @@ -472,21 +564,15 @@ CLANG_ENABLE_MODULES = YES; CURRENT_PROJECT_VERSION = "$(FLUTTER_BUILD_NUMBER)"; ENABLE_BITCODE = NO; - FRAMEWORK_SEARCH_PATHS = ( - "$(inherited)", - "$(PROJECT_DIR)/Flutter", - ); INFOPLIST_FILE = Runner/Info.plist; - LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks"; - LIBRARY_SEARCH_PATHS = ( + LD_RUNPATH_SEARCH_PATHS = ( "$(inherited)", - "$(PROJECT_DIR)/Flutter", + "@executable_path/Frameworks", ); - PRODUCT_BUNDLE_IDENTIFIER = com.resocoder.cleanArchitectureTddCourse; + PRODUCT_BUNDLE_IDENTIFIER = com.example.cleanArchitectureTddCourse; PRODUCT_NAME = "$(TARGET_NAME)"; SWIFT_OBJC_BRIDGING_HEADER = "Runner/Runner-Bridging-Header.h"; - SWIFT_SWIFT3_OBJC_INFERENCE = On; - SWIFT_VERSION = 4.0; + SWIFT_VERSION = 5.0; VERSIONING_SYSTEM = "apple-generic"; }; name = Release; @@ -494,6 +580,16 @@ /* End XCBuildConfiguration section */ /* Begin XCConfigurationList section */ + 331C8087294A63A400263BE5 /* Build configuration list for PBXNativeTarget "RunnerTests" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + 331C8088294A63A400263BE5 /* Debug */, + 331C8089294A63A400263BE5 /* Release */, + 331C808A294A63A400263BE5 /* Profile */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Release; + }; 97C146E91CF9000F007C117D /* Build configuration list for PBXProject "Runner" */ = { isa = XCConfigurationList; buildConfigurations = ( @@ -515,7 +611,6 @@ defaultConfigurationName = Release; }; /* End XCConfigurationList section */ - }; rootObject = 97C146E61CF9000F007C117D /* Project object */; } diff --git a/ios/Runner.xcodeproj/project.xcworkspace/contents.xcworkspacedata b/ios/Runner.xcodeproj/project.xcworkspace/contents.xcworkspacedata index 1d526a1..919434a 100644 --- a/ios/Runner.xcodeproj/project.xcworkspace/contents.xcworkspacedata +++ b/ios/Runner.xcodeproj/project.xcworkspace/contents.xcworkspacedata @@ -2,6 +2,6 @@ + location = "self:"> diff --git a/ios/Runner.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist b/ios/Runner.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist new file mode 100644 index 0000000..18d9810 --- /dev/null +++ b/ios/Runner.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist @@ -0,0 +1,8 @@ + + + + + IDEDidComputeMac32BitWarning + + + diff --git a/ios/Runner.xcodeproj/project.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings b/ios/Runner.xcodeproj/project.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings new file mode 100644 index 0000000..f9b0d7c --- /dev/null +++ b/ios/Runner.xcodeproj/project.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings @@ -0,0 +1,8 @@ + + + + + PreviewsEnabled + + + diff --git a/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme b/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme index a28140c..8e3ca5d 100644 --- a/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme +++ b/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme @@ -1,6 +1,6 @@ - - - - + + + + + + - - + + + + IDEDidComputeMac32BitWarning + + + diff --git a/ios/Runner.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings b/ios/Runner.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings new file mode 100644 index 0000000..f9b0d7c --- /dev/null +++ b/ios/Runner.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings @@ -0,0 +1,8 @@ + + + + + PreviewsEnabled + + + diff --git a/ios/Runner/AppDelegate.swift b/ios/Runner/AppDelegate.swift index 71cc41e..9074fee 100644 --- a/ios/Runner/AppDelegate.swift +++ b/ios/Runner/AppDelegate.swift @@ -1,11 +1,11 @@ -import UIKit import Flutter +import UIKit @UIApplicationMain @objc class AppDelegate: FlutterAppDelegate { override func application( _ application: UIApplication, - didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]? + didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]? ) -> Bool { GeneratedPluginRegistrant.register(with: self) return super.application(application, didFinishLaunchingWithOptions: launchOptions) diff --git a/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-1024x1024@1x.png b/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-1024x1024@1x.png index 3d43d11..dc9ada4 100644 Binary files a/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-1024x1024@1x.png and b/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-1024x1024@1x.png differ diff --git a/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@1x.png b/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@1x.png index 28c6bf0..7353c41 100644 Binary files a/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@1x.png and b/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@1x.png differ diff --git a/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@2x.png b/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@2x.png index 2ccbfd9..797d452 100644 Binary files a/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@2x.png and b/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@2x.png differ diff --git a/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@3x.png b/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@3x.png index f091b6b..6ed2d93 100644 Binary files a/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@3x.png and b/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@3x.png differ diff --git a/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@1x.png b/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@1x.png index 4cde121..4cd7b00 100644 Binary files a/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@1x.png and b/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@1x.png differ diff --git a/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@2x.png b/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@2x.png index d0ef06e..fe73094 100644 Binary files a/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@2x.png and b/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@2x.png differ diff --git a/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@3x.png b/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@3x.png index dcdc230..321773c 100644 Binary files a/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@3x.png and b/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@3x.png differ diff --git a/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@1x.png b/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@1x.png index 2ccbfd9..797d452 100644 Binary files a/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@1x.png and b/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@1x.png differ diff --git a/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@2x.png b/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@2x.png index c8f9ed8..502f463 100644 Binary files a/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@2x.png and b/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@2x.png differ diff --git a/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@3x.png b/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@3x.png index a6d6b86..0ec3034 100644 Binary files a/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@3x.png and b/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@3x.png differ diff --git a/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-60x60@2x.png b/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-60x60@2x.png index a6d6b86..0ec3034 100644 Binary files a/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-60x60@2x.png and b/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-60x60@2x.png differ diff --git a/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-60x60@3x.png b/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-60x60@3x.png index 75b2d16..e9f5fea 100644 Binary files a/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-60x60@3x.png and b/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-60x60@3x.png differ diff --git a/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-76x76@1x.png b/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-76x76@1x.png index c4df70d..84ac32a 100644 Binary files a/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-76x76@1x.png and b/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-76x76@1x.png differ diff --git a/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-76x76@2x.png b/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-76x76@2x.png index 6a84f41..8953cba 100644 Binary files a/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-76x76@2x.png and b/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-76x76@2x.png differ diff --git a/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-83.5x83.5@2x.png b/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-83.5x83.5@2x.png index d0e1f58..0467bf1 100644 Binary files a/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-83.5x83.5@2x.png and b/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-83.5x83.5@2x.png differ diff --git a/ios/Runner/Info.plist b/ios/Runner/Info.plist index dfe841c..19a8d5a 100644 --- a/ios/Runner/Info.plist +++ b/ios/Runner/Info.plist @@ -4,6 +4,8 @@ CFBundleDevelopmentRegion $(DEVELOPMENT_LANGUAGE) + CFBundleDisplayName + Clean Architecture Tdd Course CFBundleExecutable $(EXECUTABLE_NAME) CFBundleIdentifier @@ -39,7 +41,9 @@ UIInterfaceOrientationLandscapeLeft UIInterfaceOrientationLandscapeRight - UIViewControllerBasedStatusBarAppearance - + CADisableMinimumFrameDurationOnPhone + + UIApplicationSupportsIndirectInputEvents + diff --git a/ios/Runner/Runner-Bridging-Header.h b/ios/Runner/Runner-Bridging-Header.h index 7335fdf..308a2a5 100644 --- a/ios/Runner/Runner-Bridging-Header.h +++ b/ios/Runner/Runner-Bridging-Header.h @@ -1 +1 @@ -#import "GeneratedPluginRegistrant.h" \ No newline at end of file +#import "GeneratedPluginRegistrant.h" diff --git a/ios/RunnerTests/RunnerTests.swift b/ios/RunnerTests/RunnerTests.swift new file mode 100644 index 0000000..86a7c3b --- /dev/null +++ b/ios/RunnerTests/RunnerTests.swift @@ -0,0 +1,12 @@ +import Flutter +import UIKit +import XCTest + +class RunnerTests: XCTestCase { + + func testExample() { + // If you add code to the Runner application, consider adding tests here. + // See https://developer.apple.com/documentation/xctest for more information about using XCTest. + } + +} diff --git a/lib/core/.gitkeep b/lib/core/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/lib/core/error/.gitkeep b/lib/core/error/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/lib/core/error/exceptions.dart b/lib/core/error/exceptions.dart index 451f647..4682808 100644 --- a/lib/core/error/exceptions.dart +++ b/lib/core/error/exceptions.dart @@ -1,3 +1,7 @@ +/// Exception thrown when there is an error related to the API or +/// server communication. class ServerException implements Exception {} +/// Exception thrown when there is an error related to local caching +/// operations. class CacheException implements Exception {} diff --git a/lib/core/error/failures.dart b/lib/core/error/failures.dart index 41659cc..3742899 100644 --- a/lib/core/error/failures.dart +++ b/lib/core/error/failures.dart @@ -1,11 +1,15 @@ import 'package:equatable/equatable.dart'; +/// A generic abstract class representing failures in the application. abstract class Failure extends Equatable { + /// Override the props to ensure that equality comparison is based on the + /// object's properties. @override List get props => []; } -// General failures +/// Represents a failure related to server issues. class ServerFailure extends Failure {} +/// Represents a failure related to local caching operations class CacheFailure extends Failure {} diff --git a/lib/core/network/network_info.dart b/lib/core/network/network_info.dart index adabbe3..a7f4e88 100644 --- a/lib/core/network/network_info.dart +++ b/lib/core/network/network_info.dart @@ -1,14 +1,22 @@ -import 'package:data_connection_checker/data_connection_checker.dart'; +import 'package:data_connection_checker_tv/data_connection_checker.dart'; +/// A generic abstract class responsible for checking network connectivity. abstract class NetworkInfo { + /// Checks if the device is currently connected to the network. Future get isConnected; } +/// Concrete class that implements the [NetworkInfo] abstract class. +/// This class uses [DataConnectionChecker] to check the device's network +/// connectivity. class NetworkInfoImpl implements NetworkInfo { - final DataConnectionChecker connectionChecker; + /// Constructor that accepts an instance of [DataConnectionChecker]. + NetworkInfoImpl(this.dataConnectionChecker); - NetworkInfoImpl(this.connectionChecker); + /// Instance of [DataConnectionChecker] for checking network connectivity. + final DataConnectionChecker dataConnectionChecker; + /// Method to check whether the device is connected to the network or not. @override - Future get isConnected => connectionChecker.hasConnection; + Future get isConnected => dataConnectionChecker.hasConnection; } diff --git a/lib/core/usecases/.gitkeep b/lib/core/usecases/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/lib/core/usecases/usecase.dart b/lib/core/usecases/usecase.dart index 94b12a0..6e3bde2 100644 --- a/lib/core/usecases/usecase.dart +++ b/lib/core/usecases/usecase.dart @@ -1,13 +1,35 @@ +import 'package:clean_architecture_tdd_course/core/error/failures.dart'; import 'package:dartz/dartz.dart'; import 'package:equatable/equatable.dart'; -import '../error/failures.dart'; - +/// A generic abstract class that defines the contract for use cases. +/// +/// Use cases encapsulate specific operations that can be executed +/// in the application, allowing for separation of business logic +/// from other layers. Each use case must implement this class +/// to ensure consistent behavior across different operations. +/// +/// [Type] - The type of the result that the use case returns. +/// [Params] - The type of parameters that the use case accepts. abstract class UseCase { + /// An abstract method that each use case must implement. + /// + /// Naming it [call] allows the class to be invoked as a function, + /// which is a feature of callable classes in Dart. + /// + /// Executes the use case with the provided parameters. + /// + /// Returns a [Future] that completes with an [Either] value, + /// which can either be a [Failure] on the left side or the + /// expected result of type [Type] on the right side. Future> call(Params params); } +/// A class that represents the absence of parameters for use cases. +/// +/// Each use case that implements the [UseCase] contract can utilize +/// this class when no parameters are required. class NoParams extends Equatable { @override - List get props => []; + List get props => []; } diff --git a/lib/core/util/input_converter.dart b/lib/core/util/input_converter.dart deleted file mode 100644 index 49c4016..0000000 --- a/lib/core/util/input_converter.dart +++ /dev/null @@ -1,16 +0,0 @@ -import 'package:clean_architecture_tdd_course/core/error/failures.dart'; -import 'package:dartz/dartz.dart'; - -class InputConverter { - Either stringToUnsignedInteger(String str) { - try { - final integer = int.parse(str); - if (integer < 0) throw FormatException(); - return Right(integer); - } on FormatException { - return Left(InvalidInputFailure()); - } - } -} - -class InvalidInputFailure extends Failure {} diff --git a/lib/core/utils/app_strings.dart b/lib/core/utils/app_strings.dart new file mode 100644 index 0000000..4484ba3 --- /dev/null +++ b/lib/core/utils/app_strings.dart @@ -0,0 +1,16 @@ +import 'package:shared_preferences/shared_preferences.dart'; + +/// A constant key used to identify the cached number trivia data in +/// [SharedPreferences] +const cachedNumberTrivia = 'CACHED_NUMBER_TRIVIA'; + +/// Message indicating a server failure. +const String serverFailureMessage = 'Server Failure'; + +/// Message indicating a cache failure. +const String cacheFailureMessage = 'Cache Failure'; + +/// Message indicating an invalid input failure. +/// The number must be a positive integer or zero. +const String invalidInputFailureMessage = + 'Invalid Input - The number must be a positive integer or zero.'; diff --git a/lib/core/utils/input_converter.dart b/lib/core/utils/input_converter.dart new file mode 100644 index 0000000..0fa1839 --- /dev/null +++ b/lib/core/utils/input_converter.dart @@ -0,0 +1,24 @@ +import 'package:clean_architecture_tdd_course/core/error/failures.dart'; +import 'package:dartz/dartz.dart'; + +/// A class that provides logic for converting a [String] to an unsigned [int]. +/// It throws a [FormatException] when an invalid number is provided. +class InputConverter { + /// Converts a [String] to an unsigned [int]. + /// + /// Returns a [Right] with the converted integer if successful, + /// or a [Left] with an [InvalidInputFailure] if the input is invalid. + Either stringToUnsignedInteger(String str) { + try { + final integer = int.parse(str); + if (integer < 0) throw const FormatException(); + return Right(integer); + } on FormatException { + return Left(InvalidInputFailure()); + } + } +} + +/// Represents a failure related to [FormatException] +/// when an invalid number is provided. +class InvalidInputFailure extends Failure {} diff --git a/lib/features/.gitkeep b/lib/features/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/lib/features/number_trivia/data/.gitkeep b/lib/features/number_trivia/data/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/lib/features/number_trivia/data/datasources/.gitkeep b/lib/features/number_trivia/data/datasources/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/lib/features/number_trivia/data/datasources/number_trivia_local_data_source.dart b/lib/features/number_trivia/data/datasources/number_trivia_local_data_source.dart index 9a9bec4..1731bae 100644 --- a/lib/features/number_trivia/data/datasources/number_trivia_local_data_source.dart +++ b/lib/features/number_trivia/data/datasources/number_trivia_local_data_source.dart @@ -1,11 +1,11 @@ import 'dart:convert'; - import 'package:clean_architecture_tdd_course/core/error/exceptions.dart'; -import 'package:meta/meta.dart'; +import 'package:clean_architecture_tdd_course/core/utils/app_strings.dart'; +import 'package:clean_architecture_tdd_course/features/number_trivia/data/models/number_trivia_model.dart'; import 'package:shared_preferences/shared_preferences.dart'; -import '../models/number_trivia_model.dart'; - +/// Contract for the local data source responsible for caching and retrieving +/// number trivia. abstract class NumberTriviaLocalDataSource { /// Gets the cached [NumberTriviaModel] which was gotten the last time /// the user had an internet connection. @@ -13,21 +13,29 @@ abstract class NumberTriviaLocalDataSource { /// Throws [CacheException] if no cached data is present. Future getLastNumberTrivia(); + /// Cache Number Trivia when the internet connection is present. Future cacheNumberTrivia(NumberTriviaModel triviaToCache); } -const CACHED_NUMBER_TRIVIA = 'CACHED_NUMBER_TRIVIA'; - +/// Concrete class that implements the [NumberTriviaLocalDataSource] abstract +/// class.This class uses [SharedPreferences] to cache and retrieve number +/// trivia. class NumberTriviaLocalDataSourceImpl implements NumberTriviaLocalDataSource { - final SharedPreferences sharedPreferences; + /// Constructor that accepts an instance of [SharedPreferences]. + NumberTriviaLocalDataSourceImpl({required this.sharedPreferences}); - NumberTriviaLocalDataSourceImpl({@required this.sharedPreferences}); + /// Instance of [SharedPreferences] for caching and retrieving number trivia. + final SharedPreferences sharedPreferences; @override Future getLastNumberTrivia() { - final jsonString = sharedPreferences.getString(CACHED_NUMBER_TRIVIA); + final jsonString = sharedPreferences.getString(cachedNumberTrivia); if (jsonString != null) { - return Future.value(NumberTriviaModel.fromJson(json.decode(jsonString))); + return Future.value( + NumberTriviaModel.fromJson( + json.decode(jsonString) as Map, + ), + ); } else { throw CacheException(); } @@ -36,7 +44,7 @@ class NumberTriviaLocalDataSourceImpl implements NumberTriviaLocalDataSource { @override Future cacheNumberTrivia(NumberTriviaModel triviaToCache) { return sharedPreferences.setString( - CACHED_NUMBER_TRIVIA, + cachedNumberTrivia, json.encode(triviaToCache.toJson()), ); } diff --git a/lib/features/number_trivia/data/datasources/number_trivia_remote_data_source.dart b/lib/features/number_trivia/data/datasources/number_trivia_remote_data_source.dart index 978c225..8eb0c5e 100644 --- a/lib/features/number_trivia/data/datasources/number_trivia_remote_data_source.dart +++ b/lib/features/number_trivia/data/datasources/number_trivia_remote_data_source.dart @@ -1,11 +1,10 @@ import 'dart:convert'; - +import 'package:clean_architecture_tdd_course/core/error/exceptions.dart'; +import 'package:clean_architecture_tdd_course/features/number_trivia/data/models/number_trivia_model.dart'; import 'package:http/http.dart' as http; -import 'package:meta/meta.dart'; - -import '../../../../core/error/exceptions.dart'; -import '../models/number_trivia_model.dart'; +/// Contract for the remote data source responsible for fetching number trivia +/// data. abstract class NumberTriviaRemoteDataSource { /// Calls the http://numbersapi.com/{number} endpoint. /// @@ -18,11 +17,15 @@ abstract class NumberTriviaRemoteDataSource { Future getRandomNumberTrivia(); } +/// Concrete class that implements the [NumberTriviaRemoteDataSource] abstract +/// class.This class uses [http.Client] to retrieve number trivia from the API. class NumberTriviaRemoteDataSourceImpl implements NumberTriviaRemoteDataSource { - final http.Client client; - - NumberTriviaRemoteDataSourceImpl({@required this.client}); + /// Constructor that accepts an instance of [http.Client] for making API + /// requests. + NumberTriviaRemoteDataSourceImpl({required this.client}); + /// The [http.Client] instance used for retrieving number trivia from the API. + final http.Client client; @override Future getConcreteNumberTrivia(int number) => _getTriviaFromUrl('http://numbersapi.com/$number'); @@ -33,14 +36,16 @@ class NumberTriviaRemoteDataSourceImpl implements NumberTriviaRemoteDataSource { Future _getTriviaFromUrl(String url) async { final response = await client.get( - url, + Uri.parse(url), headers: { 'Content-Type': 'application/json', }, ); if (response.statusCode == 200) { - return NumberTriviaModel.fromJson(json.decode(response.body)); + return NumberTriviaModel.fromJson( + json.decode(response.body) as Map, + ); } else { throw ServerException(); } diff --git a/lib/features/number_trivia/data/models/.gitkeep b/lib/features/number_trivia/data/models/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/lib/features/number_trivia/data/models/number_trivia_model.dart b/lib/features/number_trivia/data/models/number_trivia_model.dart index 240960a..57eeceb 100644 --- a/lib/features/number_trivia/data/models/number_trivia_model.dart +++ b/lib/features/number_trivia/data/models/number_trivia_model.dart @@ -1,23 +1,17 @@ import 'package:clean_architecture_tdd_course/features/number_trivia/domain/entities/number_trivia.dart'; -import 'package:meta/meta.dart'; +/// A model representing number trivia, extending [NumberTrivia]. class NumberTriviaModel extends NumberTrivia { - NumberTriviaModel({ - @required String text, - @required int number, - }) : super(text: text, number: number); + /// Creates a [NumberTriviaModel] with [text] and [number]. + const NumberTriviaModel({required super.text, required super.number}); - factory NumberTriviaModel.fromJson(Map json) { - return NumberTriviaModel( - text: json['text'], - number: (json['number'] as num).toInt(), - ); - } + /// Creates a [NumberTriviaModel] from JSON. + factory NumberTriviaModel.fromJson(Map json) => + NumberTriviaModel( + text: json['text'] as String, + number: (json['number'] as num).toInt(), + ); - Map toJson() { - return { - 'text': text, - 'number': number, - }; - } + /// Converts this model to JSON. + Map toJson() => {'text': text, 'number': number}; } diff --git a/lib/features/number_trivia/data/repositories/.gitkeep b/lib/features/number_trivia/data/repositories/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/lib/features/number_trivia/data/repositories/number_trivia_repository_impl.dart b/lib/features/number_trivia/data/repositories/number_trivia_repository_impl.dart index eb79106..f73d6b1 100644 --- a/lib/features/number_trivia/data/repositories/number_trivia_repository_impl.dart +++ b/lib/features/number_trivia/data/repositories/number_trivia_repository_impl.dart @@ -1,50 +1,53 @@ +import 'package:clean_architecture_tdd_course/core/error/exceptions.dart'; +import 'package:clean_architecture_tdd_course/core/error/failures.dart'; +import 'package:clean_architecture_tdd_course/core/network/network_info.dart'; +import 'package:clean_architecture_tdd_course/features/number_trivia/data/datasources/number_trivia_local_data_source.dart'; +import 'package:clean_architecture_tdd_course/features/number_trivia/data/datasources/number_trivia_remote_data_source.dart'; +import 'package:clean_architecture_tdd_course/features/number_trivia/data/models/number_trivia_model.dart'; +import 'package:clean_architecture_tdd_course/features/number_trivia/domain/entities/number_trivia.dart'; +import 'package:clean_architecture_tdd_course/features/number_trivia/domain/repositories/number_trivia_repository.dart'; import 'package:dartz/dartz.dart'; -import 'package:meta/meta.dart'; -import '../../../../core/error/failures.dart'; -import '../../../../core/error/exceptions.dart'; -import '../../../../core/network/network_info.dart'; -import '../../domain/entities/number_trivia.dart'; -import '../../domain/repositories/number_trivia_repository.dart'; -import '../datasources/number_trivia_local_data_source.dart'; -import '../datasources/number_trivia_remote_data_source.dart'; - -typedef Future _ConcreteOrRandomChooser(); +typedef _ConcreteOrRandomChooser = Future Function(); +/// Repository implementation to handle fetching number trivia. class NumberTriviaRepositoryImpl implements NumberTriviaRepository { + /// Constructor to inject data sources and network info. + NumberTriviaRepositoryImpl({ + required this.remoteDataSource, + required this.localDataSource, + required this.networkInfo, + }); + + /// Remote data source for number trivia. final NumberTriviaRemoteDataSource remoteDataSource; + + /// Local data source for cached number trivia. final NumberTriviaLocalDataSource localDataSource; - final NetworkInfo networkInfo; - NumberTriviaRepositoryImpl({ - @required this.remoteDataSource, - @required this.localDataSource, - @required this.networkInfo, - }); + /// Network info to check connectivity. + final NetworkInfo networkInfo; @override Future> getConcreteNumberTrivia( int number, - ) async { - return await _getTrivia(() { - return remoteDataSource.getConcreteNumberTrivia(number); - }); - } + ) async => + _getTrivia(() => remoteDataSource.getConcreteNumberTrivia(number)); @override - Future> getRandomNumberTrivia() async { - return await _getTrivia(() { - return remoteDataSource.getRandomNumberTrivia(); - }); - } + Future> getRandomNumberTrivia() async => + _getTrivia(remoteDataSource.getRandomNumberTrivia); + /// Fetches trivia from the remote or local data source based on network + /// connectivity. Future> _getTrivia( _ConcreteOrRandomChooser getConcreteOrRandom, ) async { if (await networkInfo.isConnected) { try { final remoteTrivia = await getConcreteOrRandom(); - localDataSource.cacheNumberTrivia(remoteTrivia); + await localDataSource + .cacheNumberTrivia(remoteTrivia as NumberTriviaModel); return Right(remoteTrivia); } on ServerException { return Left(ServerFailure()); diff --git a/lib/features/number_trivia/domain/.gitkeep b/lib/features/number_trivia/domain/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/lib/features/number_trivia/domain/entities/.gitkeep b/lib/features/number_trivia/domain/entities/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/lib/features/number_trivia/domain/entities/number_trivia.dart b/lib/features/number_trivia/domain/entities/number_trivia.dart index 8e7e0ee..9c59e37 100644 --- a/lib/features/number_trivia/domain/entities/number_trivia.dart +++ b/lib/features/number_trivia/domain/entities/number_trivia.dart @@ -1,15 +1,16 @@ import 'package:equatable/equatable.dart'; -import 'package:meta/meta.dart'; +/// Entity representing number trivia with a [text] description and a [number]. class NumberTrivia extends Equatable { + /// Creates a new [NumberTrivia] with the provided [text] and [number]. + const NumberTrivia({required this.text, required this.number}); + + /// Text description of the trivia. final String text; - final int number; - NumberTrivia({ - @required this.text, - @required this.number, - }); + /// The number associated with the trivia. + final int number; @override - List get props => [text, number]; + List get props => [text, number]; } diff --git a/lib/features/number_trivia/domain/repositories/.gitkeep b/lib/features/number_trivia/domain/repositories/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/lib/features/number_trivia/domain/repositories/number_trivia_repository.dart b/lib/features/number_trivia/domain/repositories/number_trivia_repository.dart index b6e2566..419668d 100644 --- a/lib/features/number_trivia/domain/repositories/number_trivia_repository.dart +++ b/lib/features/number_trivia/domain/repositories/number_trivia_repository.dart @@ -1,9 +1,12 @@ +import 'package:clean_architecture_tdd_course/core/error/failures.dart'; +import 'package:clean_architecture_tdd_course/features/number_trivia/domain/entities/number_trivia.dart'; import 'package:dartz/dartz.dart'; -import '../../../../core/error/failures.dart'; -import '../entities/number_trivia.dart'; - +/// Contract for fetching concrete or random number trivia. abstract class NumberTriviaRepository { + /// Fetches trivia for a specific [number]. Future> getConcreteNumberTrivia(int number); + + /// Fetches random number trivia. Future> getRandomNumberTrivia(); } diff --git a/lib/features/number_trivia/domain/usecases/.gitkeep b/lib/features/number_trivia/domain/usecases/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/lib/features/number_trivia/domain/usecases/get_concrete_number_trivia.dart b/lib/features/number_trivia/domain/usecases/get_concrete_number_trivia.dart index 1128270..0853040 100644 --- a/lib/features/number_trivia/domain/usecases/get_concrete_number_trivia.dart +++ b/lib/features/number_trivia/domain/usecases/get_concrete_number_trivia.dart @@ -1,28 +1,31 @@ +import 'package:clean_architecture_tdd_course/core/error/failures.dart'; +import 'package:clean_architecture_tdd_course/core/usecases/usecase.dart'; +import 'package:clean_architecture_tdd_course/features/number_trivia/domain/entities/number_trivia.dart'; +import 'package:clean_architecture_tdd_course/features/number_trivia/domain/repositories/number_trivia_repository.dart'; import 'package:dartz/dartz.dart'; import 'package:equatable/equatable.dart'; -import 'package:meta/meta.dart'; - -import '../../../../core/error/failures.dart'; -import '../../../../core/usecases/usecase.dart'; -import '../entities/number_trivia.dart'; -import '../repositories/number_trivia_repository.dart'; +/// Use case to fetch trivia for a specific number. class GetConcreteNumberTrivia implements UseCase { - final NumberTriviaRepository repository; + /// Constructor that takes the [NumberTriviaRepository]. + GetConcreteNumberTrivia(this.numberTriviaRepository); - GetConcreteNumberTrivia(this.repository); + /// Repository to fetch the number trivia. + final NumberTriviaRepository numberTriviaRepository; @override - Future> call(Params params) async { - return await repository.getConcreteNumberTrivia(params.number); - } + Future> call(Params params) async => + numberTriviaRepository.getConcreteNumberTrivia(params.number); } +/// Parameters for the [GetConcreteNumberTrivia] use case. class Params extends Equatable { - final int number; + /// Constructor to initialize [number]. + const Params({required this.number}); - Params({@required this.number}); + /// The number to fetch trivia for. + final int number; @override - List get props => [number]; + List get props => [number]; } diff --git a/lib/features/number_trivia/domain/usecases/get_random_number_trivia.dart b/lib/features/number_trivia/domain/usecases/get_random_number_trivia.dart index 2db8e84..c45fbd8 100644 --- a/lib/features/number_trivia/domain/usecases/get_random_number_trivia.dart +++ b/lib/features/number_trivia/domain/usecases/get_random_number_trivia.dart @@ -1,17 +1,18 @@ +import 'package:clean_architecture_tdd_course/core/error/failures.dart'; +import 'package:clean_architecture_tdd_course/core/usecases/usecase.dart'; +import 'package:clean_architecture_tdd_course/features/number_trivia/domain/entities/number_trivia.dart'; +import 'package:clean_architecture_tdd_course/features/number_trivia/domain/repositories/number_trivia_repository.dart'; import 'package:dartz/dartz.dart'; -import '../../../../core/error/failures.dart'; -import '../../../../core/usecases/usecase.dart'; -import '../entities/number_trivia.dart'; -import '../repositories/number_trivia_repository.dart'; - +/// Use case to fetch random number trivia. class GetRandomNumberTrivia implements UseCase { - final NumberTriviaRepository repository; + /// Constructor that takes the [NumberTriviaRepository]. + GetRandomNumberTrivia(this.numberTriviaRepository); - GetRandomNumberTrivia(this.repository); + /// Repository to fetch the number trivia. + final NumberTriviaRepository numberTriviaRepository; @override - Future> call(NoParams params) async { - return await repository.getRandomNumberTrivia(); - } + Future> call(NoParams noParams) async => + numberTriviaRepository.getRandomNumberTrivia(); } diff --git a/lib/features/number_trivia/presentation/.gitkeep b/lib/features/number_trivia/presentation/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/lib/features/number_trivia/presentation/bloc/bloc.dart b/lib/features/number_trivia/presentation/bloc/bloc.dart deleted file mode 100644 index 9e82fce..0000000 --- a/lib/features/number_trivia/presentation/bloc/bloc.dart +++ /dev/null @@ -1,3 +0,0 @@ -export 'number_trivia_bloc.dart'; -export 'number_trivia_event.dart'; -export 'number_trivia_state.dart'; diff --git a/lib/features/number_trivia/presentation/bloc/number_trivia_bloc.dart b/lib/features/number_trivia/presentation/bloc/number_trivia_bloc.dart index 03c80ff..0404bc5 100644 --- a/lib/features/number_trivia/presentation/bloc/number_trivia_bloc.dart +++ b/lib/features/number_trivia/presentation/bloc/number_trivia_bloc.dart @@ -1,81 +1,102 @@ -import 'dart:async'; - -import 'package:bloc/bloc.dart'; import 'package:clean_architecture_tdd_course/core/error/failures.dart'; import 'package:clean_architecture_tdd_course/core/usecases/usecase.dart'; +import 'package:clean_architecture_tdd_course/core/utils/app_strings.dart'; +import 'package:clean_architecture_tdd_course/core/utils/input_converter.dart'; import 'package:clean_architecture_tdd_course/features/number_trivia/domain/entities/number_trivia.dart'; +import 'package:clean_architecture_tdd_course/features/number_trivia/domain/usecases/get_concrete_number_trivia.dart'; +import 'package:clean_architecture_tdd_course/features/number_trivia/domain/usecases/get_random_number_trivia.dart'; import 'package:dartz/dartz.dart'; -import 'package:meta/meta.dart'; - -import './bloc.dart'; -import '../../../../core/util/input_converter.dart'; -import '../../domain/usecases/get_concrete_number_trivia.dart'; -import '../../domain/usecases/get_random_number_trivia.dart'; +import 'package:equatable/equatable.dart'; +import 'package:flutter_bloc/flutter_bloc.dart'; -const String SERVER_FAILURE_MESSAGE = 'Server Failure'; -const String CACHE_FAILURE_MESSAGE = 'Cache Failure'; -const String INVALID_INPUT_FAILURE_MESSAGE = - 'Invalid Input - The number must be a positive integer or zero.'; +part 'number_trivia_event.dart'; +part 'number_trivia_state.dart'; +/// A class responsible for handling number trivia operations. class NumberTriviaBloc extends Bloc { + /// Constructor that accepts instances of [GetConcreteNumberTrivia], + /// [GetRandomNumberTrivia], and [InputConverter]. + NumberTriviaBloc({ + required GetConcreteNumberTrivia concrete, + required GetRandomNumberTrivia random, + required this.inputConverter, + }) : getConcreteNumberTrivia = concrete, + getRandomNumberTrivia = random, + super(Empty()) { + /* + async gives you a Future + async* gives you a Stream. + */ + // on((event, emit) { + // if (event is GetTriviaForConcreteNumber) { + // final inputEither = + // inputConverter.stringToUnsignedInteger(event.numberString); + // /* yield: + // adds a value to the output stream of the surrounding async* + // function. It's like returning value but doesn't terminate the function + // */ + // + // inputEither.fold((failure) async* { + // yield const Error(message: INVALID_INPUT_FAILURE_MESSAGE); + // }, (integer) => throw UnimplementedError()); + // } + // }); + + on(_getTriviaForConcreteNumber); + on(_getTriviaForRandomNumber); + } + + /// Use case for fetching trivia related to a specific number. final GetConcreteNumberTrivia getConcreteNumberTrivia; - final GetRandomNumberTrivia getRandomNumberTrivia; - final InputConverter inputConverter; - NumberTriviaBloc({ - @required GetConcreteNumberTrivia concrete, - @required GetRandomNumberTrivia random, - @required this.inputConverter, - }) : assert(concrete != null), - assert(random != null), - assert(inputConverter != null), - getConcreteNumberTrivia = concrete, - getRandomNumberTrivia = random; + /// Use case for fetching random number trivia. + final GetRandomNumberTrivia getRandomNumberTrivia; - @override - NumberTriviaState get initialState => Empty(); + /// Converts input strings to integers. + final InputConverter inputConverter; - @override - Stream mapEventToState( - NumberTriviaEvent event, - ) async* { - if (event is GetTriviaForConcreteNumber) { - final inputEither = - inputConverter.stringToUnsignedInteger(event.numberString); + Future _getTriviaForConcreteNumber( + GetTriviaForConcreteNumber event, + Emitter emit, + ) async { + final inputEither = + inputConverter.stringToUnsignedInteger(event.numberString); + await inputEither.fold( + (failure) async => + emit(const Error(message: invalidInputFailureMessage)), + (integer) async { + emit(Loading()); + final failureOrTrivia = + await getConcreteNumberTrivia(Params(number: integer)); + _eitherLoadedOrErrorState(failureOrTrivia, emit); + }); + } - yield* inputEither.fold( - (failure) async* { - yield Error(message: INVALID_INPUT_FAILURE_MESSAGE); - }, - (integer) async* { - yield Loading(); - final failureOrTrivia = - await getConcreteNumberTrivia(Params(number: integer)); - yield* _eitherLoadedOrErrorState(failureOrTrivia); - }, - ); - } else if (event is GetTriviaForRandomNumber) { - yield Loading(); - final failureOrTrivia = await getRandomNumberTrivia(NoParams()); - yield* _eitherLoadedOrErrorState(failureOrTrivia); - } + Future _getTriviaForRandomNumber( + GetTriviaForRandomNumber event, + Emitter emit, + ) async { + emit(Loading()); + final failureOrTrivia = await getRandomNumberTrivia(NoParams()); + _eitherLoadedOrErrorState(failureOrTrivia, emit); } - Stream _eitherLoadedOrErrorState( + void _eitherLoadedOrErrorState( Either failureOrTrivia, - ) async* { - yield failureOrTrivia.fold( - (failure) => Error(message: _mapFailureToMessage(failure)), - (trivia) => Loaded(trivia: trivia), + Emitter emit, + ) { + failureOrTrivia.fold( + (failure) => emit(Error(message: _mapFailureToMessage(failure))), + (trivia) => emit(Loaded(trivia: trivia)), ); } String _mapFailureToMessage(Failure failure) { switch (failure.runtimeType) { - case ServerFailure: - return SERVER_FAILURE_MESSAGE; - case CacheFailure: - return CACHE_FAILURE_MESSAGE; + case const (ServerFailure): + return serverFailureMessage; + case const (CacheFailure): + return cacheFailureMessage; default: return 'Unexpected error'; } diff --git a/lib/features/number_trivia/presentation/bloc/number_trivia_event.dart b/lib/features/number_trivia/presentation/bloc/number_trivia_event.dart index 37f7a93..81d1bc3 100644 --- a/lib/features/number_trivia/presentation/bloc/number_trivia_event.dart +++ b/lib/features/number_trivia/presentation/bloc/number_trivia_event.dart @@ -1,19 +1,23 @@ -import 'package:equatable/equatable.dart'; -import 'package:meta/meta.dart'; +part of 'number_trivia_bloc.dart'; + +/// Events for the NumberTriviaBloc +sealed class NumberTriviaEvent extends Equatable { + const NumberTriviaEvent(); -@immutable -abstract class NumberTriviaEvent extends Equatable { @override List get props => []; } +/// Event to fetch trivia for a specific concrete number. class GetTriviaForConcreteNumber extends NumberTriviaEvent { - final String numberString; - - GetTriviaForConcreteNumber(this.numberString); + /// Constructor that accepts the [numberString] to fetch trivia for. + const GetTriviaForConcreteNumber(this.numberString); + /// The number represented as a string to fetch trivia for. + final String numberString; @override List get props => [numberString]; } +/// Event to fetch random trivia. class GetTriviaForRandomNumber extends NumberTriviaEvent {} diff --git a/lib/features/number_trivia/presentation/bloc/number_trivia_state.dart b/lib/features/number_trivia/presentation/bloc/number_trivia_state.dart index 2cb1321..0b76c04 100644 --- a/lib/features/number_trivia/presentation/bloc/number_trivia_state.dart +++ b/lib/features/number_trivia/presentation/bloc/number_trivia_state.dart @@ -1,30 +1,38 @@ -import 'package:clean_architecture_tdd_course/features/number_trivia/domain/entities/number_trivia.dart'; -import 'package:equatable/equatable.dart'; -import 'package:meta/meta.dart'; +part of 'number_trivia_bloc.dart'; + +/// States for the NumberTriviaBloc. +sealed class NumberTriviaState extends Equatable { + const NumberTriviaState(); -@immutable -abstract class NumberTriviaState extends Equatable { @override List get props => []; } -class Empty extends NumberTriviaState {} +/// Represents the initial state of the bloc, before any trivia is fetched. +final class Empty extends NumberTriviaState {} -class Loading extends NumberTriviaState {} +/// Represents a loading state while fetching trivia data. +final class Loading extends NumberTriviaState {} -class Loaded extends NumberTriviaState { - final NumberTrivia trivia; +/// Represents a loaded state containing number trivia data. +final class Loaded extends NumberTriviaState { + /// Constructor that initializes the state with the provided [trivia]. + const Loaded({required this.trivia}); - Loaded({@required this.trivia}); + /// The trivia data that has been loaded. + final NumberTrivia trivia; @override List get props => [trivia]; } -class Error extends NumberTriviaState { - final String message; +/// Represents an error state with an associated failure message. +final class Error extends NumberTriviaState { + /// Constructor that initializes the error state with the provided [message]. + const Error({required this.message}); - Error({@required this.message}); + /// The error message detailing the failure. + final String message; @override List get props => [message]; diff --git a/lib/features/number_trivia/presentation/pages/.gitkeep b/lib/features/number_trivia/presentation/pages/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/lib/features/number_trivia/presentation/pages/number_trivia_page.dart b/lib/features/number_trivia/presentation/screens/number_trivia_screen.dart similarity index 52% rename from lib/features/number_trivia/presentation/pages/number_trivia_page.dart rename to lib/features/number_trivia/presentation/screens/number_trivia_screen.dart index d3332b1..e74265b 100644 --- a/lib/features/number_trivia/presentation/pages/number_trivia_page.dart +++ b/lib/features/number_trivia/presentation/screens/number_trivia_screen.dart @@ -1,42 +1,43 @@ -import 'package:clean_architecture_tdd_course/features/number_trivia/presentation/bloc/bloc.dart'; import 'package:clean_architecture_tdd_course/features/number_trivia/presentation/bloc/number_trivia_bloc.dart'; import 'package:clean_architecture_tdd_course/features/number_trivia/presentation/widgets/widgets.dart'; +import 'package:clean_architecture_tdd_course/injection_container.dart'; import 'package:flutter/material.dart'; import 'package:flutter_bloc/flutter_bloc.dart'; -import '../../../../injection_container.dart'; +/// [NumberTriviaScreen] represents the screen that displays number trivia, +/// allowing users to view trivia related to specific numbers or random trivia. +class NumberTriviaScreen extends StatelessWidget { + /// Default constructor that accepts an optional [key]. + const NumberTriviaScreen({super.key}); -class NumberTriviaPage extends StatelessWidget { @override Widget build(BuildContext context) { return Scaffold( appBar: AppBar( - title: Text('Number Trivia'), - ), - body: SingleChildScrollView( - child: buildBody(context), + title: const Text('Number Trivia'), ), + body: SingleChildScrollView(child: buildBody(context)), ); } + /// Method to build body of [NumberTriviaScreen] BlocProvider buildBody(BuildContext context) { return BlocProvider( - create: (_) => sl(), + create: (context) => serviceLocator(), child: Center( child: Padding( padding: const EdgeInsets.all(10), child: Column( - children: [ - SizedBox(height: 10), - // Top half + children: [ + const SizedBox(height: 10), BlocBuilder( builder: (context, state) { if (state is Empty) { - return MessageDisplay( + return const MessageDisplay( message: 'Start searching!', ); } else if (state is Loading) { - return LoadingWidget(); + return const LoadingWidget(); } else if (state is Loaded) { return TriviaDisplay(numberTrivia: state.trivia); } else if (state is Error) { @@ -44,11 +45,18 @@ class NumberTriviaPage extends StatelessWidget { message: state.message, ); } + return const MessageDisplay( + message: 'Start searching!', + ); }, ), - SizedBox(height: 20), - // Bottom half - TriviaControls() + const SizedBox(height: 20), + const TriviaControls(), + const SizedBox(height: 10), + SizedBox( + height: MediaQuery.of(context).size.height / 3 - 31, + child: Image.asset('assets/images/background.png'), + ), ], ), ), diff --git a/lib/features/number_trivia/presentation/widgets/.gitkeep b/lib/features/number_trivia/presentation/widgets/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/lib/features/number_trivia/presentation/widgets/loading_widget.dart b/lib/features/number_trivia/presentation/widgets/loading_widget.dart index a7b7506..157b6cb 100644 --- a/lib/features/number_trivia/presentation/widgets/loading_widget.dart +++ b/lib/features/number_trivia/presentation/widgets/loading_widget.dart @@ -1,17 +1,19 @@ +import 'package:clean_architecture_tdd_course/features/number_trivia/presentation/bloc/number_trivia_bloc.dart'; import 'package:flutter/material.dart'; +/// Represents a widget displayed when the state of the [NumberTriviaBloc] is +/// loading. class LoadingWidget extends StatelessWidget { + /// Default constructor that accepts an optional [key]. const LoadingWidget({ - Key key, - }) : super(key: key); + super.key, + }); @override Widget build(BuildContext context) { - return Container( + return SizedBox( height: MediaQuery.of(context).size.height / 3, - child: Center( - child: CircularProgressIndicator(), - ), + child: const Center(child: CircularProgressIndicator()), ); } } diff --git a/lib/features/number_trivia/presentation/widgets/message_display.dart b/lib/features/number_trivia/presentation/widgets/message_display.dart index 6e55f53..cdaff24 100644 --- a/lib/features/number_trivia/presentation/widgets/message_display.dart +++ b/lib/features/number_trivia/presentation/widgets/message_display.dart @@ -1,22 +1,25 @@ import 'package:flutter/material.dart'; +/// A widget that displays a message. class MessageDisplay extends StatelessWidget { - final String message; - + /// Creates an instance of [MessageDisplay] with a required [message]. const MessageDisplay({ - Key key, - @required this.message, - }) : super(key: key); + required this.message, + super.key, + }); + + /// The message to be displayed. + final String message; @override Widget build(BuildContext context) { - return Container( + return SizedBox( height: MediaQuery.of(context).size.height / 3, child: Center( child: SingleChildScrollView( child: Text( message, - style: TextStyle(fontSize: 25), + style: const TextStyle(fontSize: 25), textAlign: TextAlign.center, ), ), diff --git a/lib/features/number_trivia/presentation/widgets/trivia_controls.dart b/lib/features/number_trivia/presentation/widgets/trivia_controls.dart index 4774ea1..29e5752 100644 --- a/lib/features/number_trivia/presentation/widgets/trivia_controls.dart +++ b/lib/features/number_trivia/presentation/widgets/trivia_controls.dart @@ -1,30 +1,33 @@ -import 'package:clean_architecture_tdd_course/features/number_trivia/presentation/bloc/bloc.dart'; +import 'package:clean_architecture_tdd_course/features/number_trivia/presentation/bloc/number_trivia_bloc.dart'; import 'package:flutter/material.dart'; import 'package:flutter_bloc/flutter_bloc.dart'; +/// A widget that provides controls for interacting with trivia functionality. class TriviaControls extends StatefulWidget { + /// Default constructor that accepts an optional [key]. const TriviaControls({ - Key key, - }) : super(key: key); + super.key, + }); @override - _TriviaControlsState createState() => _TriviaControlsState(); + State createState() => _TriviaControlsState(); } class _TriviaControlsState extends State { final controller = TextEditingController(); - String inputStr; + String inputStr = ''; @override Widget build(BuildContext context) { return Column( - children: [ + children: [ TextField( - controller: controller, keyboardType: TextInputType.number, - decoration: InputDecoration( + controller: controller, + decoration: const InputDecoration( + hintText: 'Input Number', border: OutlineInputBorder(), - hintText: 'Input a number', + enabledBorder: OutlineInputBorder(), ), onChanged: (value) { inputStr = value; @@ -33,26 +36,50 @@ class _TriviaControlsState extends State { dispatchConcrete(); }, ), - SizedBox(height: 10), + const SizedBox( + height: 15, + ), Row( - children: [ + children: [ Expanded( - child: RaisedButton( - child: Text('Search'), - color: Theme.of(context).accentColor, - textTheme: ButtonTextTheme.primary, - onPressed: dispatchConcrete, + child: SizedBox( + height: 40, + child: ElevatedButton( + onPressed: dispatchConcrete, + style: ElevatedButton.styleFrom( + backgroundColor: Colors.deepPurple, + shape: RoundedRectangleBorder( + borderRadius: BorderRadius.circular(5), + ), + ), + child: const Text( + 'Search', + style: TextStyle(color: Colors.white, fontSize: 14), + ), + ), ), ), - SizedBox(width: 10), + const SizedBox(width: 10), Expanded( - child: RaisedButton( - child: Text('Get random trivia'), - onPressed: dispatchRandom, + child: SizedBox( + height: 40, + child: ElevatedButton( + onPressed: dispatchRandom, + style: ElevatedButton.styleFrom( + backgroundColor: const Color(0xff9E22B2), + shape: RoundedRectangleBorder( + borderRadius: BorderRadius.circular(5), + ), + ), + child: const Text( + 'Get random trivia', + style: TextStyle(color: Colors.white, fontSize: 14), + ), + ), ), ), ], - ) + ), ], ); } diff --git a/lib/features/number_trivia/presentation/widgets/trivia_display.dart b/lib/features/number_trivia/presentation/widgets/trivia_display.dart index 5174ac4..5a88997 100644 --- a/lib/features/number_trivia/presentation/widgets/trivia_display.dart +++ b/lib/features/number_trivia/presentation/widgets/trivia_display.dart @@ -1,30 +1,33 @@ import 'package:clean_architecture_tdd_course/features/number_trivia/domain/entities/number_trivia.dart'; import 'package:flutter/material.dart'; +/// A widget that displays the number trivia information. class TriviaDisplay extends StatelessWidget { - final NumberTrivia numberTrivia; - + /// Creates an instance of [TriviaDisplay] with the given [numberTrivia]. const TriviaDisplay({ - Key key, - @required this.numberTrivia, - }) : super(key: key); + required this.numberTrivia, + super.key, + }); + + /// The [NumberTrivia] data to be displayed. + final NumberTrivia numberTrivia; @override Widget build(BuildContext context) { - return Container( + return SizedBox( height: MediaQuery.of(context).size.height / 3, child: Column( - children: [ + children: [ Text( numberTrivia.number.toString(), - style: TextStyle(fontSize: 50, fontWeight: FontWeight.bold), + style: const TextStyle(fontSize: 50, fontWeight: FontWeight.bold), ), Expanded( child: Center( child: SingleChildScrollView( child: Text( numberTrivia.text, - style: TextStyle(fontSize: 25), + style: const TextStyle(fontSize: 25), textAlign: TextAlign.center, ), ), diff --git a/lib/features/number_trivia/presentation/widgets/widgets.dart b/lib/features/number_trivia/presentation/widgets/widgets.dart index 54ee98e..c002d99 100644 --- a/lib/features/number_trivia/presentation/widgets/widgets.dart +++ b/lib/features/number_trivia/presentation/widgets/widgets.dart @@ -1,4 +1,4 @@ export 'loading_widget.dart'; export 'message_display.dart'; -export 'trivia_display.dart'; export 'trivia_controls.dart'; +export 'trivia_display.dart'; diff --git a/lib/injection_container.dart b/lib/injection_container.dart index 20b6e22..550db49 100644 --- a/lib/injection_container.dart +++ b/lib/injection_container.dart @@ -1,60 +1,135 @@ -import 'package:data_connection_checker/data_connection_checker.dart'; +import 'package:clean_architecture_tdd_course/core/network/network_info.dart'; +import 'package:clean_architecture_tdd_course/core/utils/input_converter.dart'; +import 'package:clean_architecture_tdd_course/features/number_trivia/data/datasources/number_trivia_local_data_source.dart'; +import 'package:clean_architecture_tdd_course/features/number_trivia/data/datasources/number_trivia_remote_data_source.dart'; +import 'package:clean_architecture_tdd_course/features/number_trivia/data/repositories/number_trivia_repository_impl.dart'; +import 'package:clean_architecture_tdd_course/features/number_trivia/domain/repositories/number_trivia_repository.dart'; +import 'package:clean_architecture_tdd_course/features/number_trivia/domain/usecases/get_concrete_number_trivia.dart'; +import 'package:clean_architecture_tdd_course/features/number_trivia/domain/usecases/get_random_number_trivia.dart'; +import 'package:clean_architecture_tdd_course/features/number_trivia/presentation/bloc/number_trivia_bloc.dart'; +import 'package:data_connection_checker_tv/data_connection_checker.dart'; import 'package:get_it/get_it.dart'; import 'package:http/http.dart' as http; import 'package:shared_preferences/shared_preferences.dart'; -import 'core/network/network_info.dart'; -import 'core/util/input_converter.dart'; -import 'features/number_trivia/data/datasources/number_trivia_local_data_source.dart'; -import 'features/number_trivia/data/datasources/number_trivia_remote_data_source.dart'; -import 'features/number_trivia/data/repositories/number_trivia_repository_impl.dart'; -import 'features/number_trivia/domain/repositories/number_trivia_repository.dart'; -import 'features/number_trivia/domain/usecases/get_concrete_number_trivia.dart'; -import 'features/number_trivia/domain/usecases/get_random_number_trivia.dart'; -import 'features/number_trivia/presentation/bloc/number_trivia_bloc.dart'; +/// Creates an instance of the service locator using the [GetIt] package. +/// This instance will be used to register and retrieve dependencies across the +/// app. +final serviceLocator = GetIt.instance; -final sl = GetIt.instance; +/* + Factory: always instantiate a new instance of the given class + whenever we request. + Singleton: always (after the first time) get the same instance, + get_it will cache it and then on subsequent calls to it + througout the lifetime of the app it's going to give out the same instance + and not instantiate a new one since it's a single thing. + + -) Presentation logic holders such as BloC shouldn't be registered as + singleton, because they are very close to the UI. + For example the app has multiple pages between which you can navigate, + you probably do not want this to be a singleton + because you wanna do some cleanup like closing steams and + all of that from the dispose method of a widget. + + -) Trying to close a stream but having a singleton will lead to problems, + because you would close a stream but if you were to come back + to the previous page on which that BloC is being used and + you would try to get an instance from get_it of this number trivia BloC + for example, and this was a singleton and not a factory, you would get + the same instance of number trivia BloC as previously + which now has a closed stream. + + *: Whenever you do some disposal logic you should always register Factory + and not a singleton because then you are going to get the same instance + with the close stream or close dispose whatever else and + that's gonna cause some problem +*/ + +/// Initializes dependency injection across the application. Future init() async { //! Features - Number Trivia // Bloc - sl.registerFactory( - () => NumberTriviaBloc( - concrete: sl(), - inputConverter: sl(), - random: sl(), - ), - ); - - // Use cases - sl.registerLazySingleton(() => GetConcreteNumberTrivia(sl())); - sl.registerLazySingleton(() => GetRandomNumberTrivia(sl())); - - // Repository - sl.registerLazySingleton( - () => NumberTriviaRepositoryImpl( - localDataSource: sl(), - networkInfo: sl(), - remoteDataSource: sl(), - ), - ); - - // Data sources - sl.registerLazySingleton( - () => NumberTriviaRemoteDataSourceImpl(client: sl()), - ); - - sl.registerLazySingleton( - () => NumberTriviaLocalDataSourceImpl(sharedPreferences: sl()), - ); - - //! Core - sl.registerLazySingleton(() => InputConverter()); - sl.registerLazySingleton(() => NetworkInfoImpl(sl())); + serviceLocator + ..registerFactory( + () => NumberTriviaBloc( + concrete: serviceLocator(), + random: serviceLocator(), + inputConverter: serviceLocator(), + ), + ) + + // Use cases (do not depend on implementation but on contract) + // Singleton: always registered immediately after the app start + // LazySingleton: registered only when it is requested + // as dependency for some other class + /// You can use this code but we prefer use cascade notation + /// ```dart + /// serviceLocator.registerLazySingleton(() => GetConcreteNumberTrivia( + /// serviceLocator())); + /// serviceLocator.registerLazySingleton(() => GetRandomNumberTrivia( + /// serviceLocator())); + /// ``` + ..registerLazySingleton(() => GetConcreteNumberTrivia(serviceLocator())) + ..registerLazySingleton(() => GetRandomNumberTrivia(serviceLocator())) + + // Repository + ..registerLazySingleton( + () => NumberTriviaRepositoryImpl( + remoteDataSource: serviceLocator(), + localDataSource: serviceLocator(), + networkInfo: serviceLocator(), + ), + ) + + // Data sources + /// Without using cascade notation the code will like that : + /// ```dart + /// serviceLocator + /// .registerLazySingleton( + /// () => NumberTriviaRemoteDataSourceImpl(client: serviceLocator()), + /// ); + /// serviceLocator + /// .registerLazySingleton( + /// () => + /// NumberTriviaLocalDataSourceImpl(sharedPreferences: + /// serviceLocator()), + /// ); + /// ``` + + ..registerLazySingleton( + () => NumberTriviaRemoteDataSourceImpl(client: serviceLocator()), + ) + ..registerLazySingleton( + () => + NumberTriviaLocalDataSourceImpl(sharedPreferences: serviceLocator()), + ) + + //! Core + /// Tear-off: Instead of using an anonymous function () => InputConverter(), + /// you directly reference the constructor of InputConverter using + /// InputConverter.new. This is more concise and avoids unnecessary + /// lambda creation, which can improve readability and performance. + ..registerLazySingleton(InputConverter.new) + ..registerLazySingleton( + () => NetworkInfoImpl(serviceLocator()), + ); //! External + /// Tear-off: Instead of using an anonymous function () => http.Client(), + /// () => DataConnectionChecker() we use http.Client.new and + /// DataConnectionChecker.new + /// Without using cascade notation the code will like that : + /// ```dart + /// final sharedPreferences = await SharedPreferences.getInstance(); + /// serviceLocator.registerLazySingleton(() => sharedPreferences); + /// serviceLocator.registerLazySingleton(http.Client.new); + /// serviceLocator.registerLazySingleton(DataConnectionChecker.new); + /// ``` final sharedPreferences = await SharedPreferences.getInstance(); - sl.registerLazySingleton(() => sharedPreferences); - sl.registerLazySingleton(() => http.Client()); - sl.registerLazySingleton(() => DataConnectionChecker()); + serviceLocator + ..registerLazySingleton(() => sharedPreferences) + ..registerLazySingleton(http.Client.new) + ..registerLazySingleton(DataConnectionChecker.new); } diff --git a/lib/main.dart b/lib/main.dart index 3fdd5d0..4f60647 100644 --- a/lib/main.dart +++ b/lib/main.dart @@ -1,23 +1,36 @@ +import 'package:clean_architecture_tdd_course/features/number_trivia/presentation/screens/number_trivia_screen.dart'; +import 'package:clean_architecture_tdd_course/injection_container.dart' as di; import 'package:flutter/material.dart'; -import 'features/number_trivia/presentation/pages/number_trivia_page.dart'; -import 'injection_container.dart' as di; -void main() async { +Future main() async { WidgetsFlutterBinding.ensureInitialized(); await di.init(); - runApp(MyApp()); + runApp(const NumberTriviaApp()); } -class MyApp extends StatelessWidget { +/// The root widget of app +class NumberTriviaApp extends StatelessWidget { + /// Default constructor that accepts an optional [key]. + const NumberTriviaApp({super.key}); + @override Widget build(BuildContext context) { return MaterialApp( title: 'Number Trivia', + debugShowCheckedModeBanner: false, theme: ThemeData( - primaryColor: Colors.green.shade800, - accentColor: Colors.green.shade600, + fontFamily: 'Poppins', + scaffoldBackgroundColor: Colors.white, + appBarTheme: const AppBarTheme( + backgroundColor: Color(0xff6A149C), + titleTextStyle: TextStyle(color: Colors.white, fontSize: 22), + ), + colorScheme: + ColorScheme.fromSwatch(primarySwatch: Colors.purple).copyWith( + secondary: Colors.purple.shade600, + ), ), - home: NumberTriviaPage(), + home: const NumberTriviaScreen(), ); } } diff --git a/linux/.gitignore b/linux/.gitignore new file mode 100644 index 0000000..d3896c9 --- /dev/null +++ b/linux/.gitignore @@ -0,0 +1 @@ +flutter/ephemeral diff --git a/linux/CMakeLists.txt b/linux/CMakeLists.txt new file mode 100644 index 0000000..2488244 --- /dev/null +++ b/linux/CMakeLists.txt @@ -0,0 +1,145 @@ +# Project-level configuration. +cmake_minimum_required(VERSION 3.10) +project(runner LANGUAGES CXX) + +# The name of the executable created for the application. Change this to change +# the on-disk name of your application. +set(BINARY_NAME "clean_architecture_tdd_course") +# The unique GTK application identifier for this application. See: +# https://wiki.gnome.org/HowDoI/ChooseApplicationID +set(APPLICATION_ID "com.example.clean_architecture_tdd_course") + +# Explicitly opt in to modern CMake behaviors to avoid warnings with recent +# versions of CMake. +cmake_policy(SET CMP0063 NEW) + +# Load bundled libraries from the lib/ directory relative to the binary. +set(CMAKE_INSTALL_RPATH "$ORIGIN/lib") + +# Root filesystem for cross-building. +if(FLUTTER_TARGET_PLATFORM_SYSROOT) + set(CMAKE_SYSROOT ${FLUTTER_TARGET_PLATFORM_SYSROOT}) + set(CMAKE_FIND_ROOT_PATH ${CMAKE_SYSROOT}) + set(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER) + set(CMAKE_FIND_ROOT_PATH_MODE_PACKAGE ONLY) + set(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY ONLY) + set(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY) +endif() + +# Define build configuration options. +if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES) + set(CMAKE_BUILD_TYPE "Debug" CACHE + STRING "Flutter build mode" FORCE) + set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS + "Debug" "Profile" "Release") +endif() + +# Compilation settings that should be applied to most targets. +# +# Be cautious about adding new options here, as plugins use this function by +# default. In most cases, you should add new options to specific targets instead +# of modifying this function. +function(APPLY_STANDARD_SETTINGS TARGET) + target_compile_features(${TARGET} PUBLIC cxx_std_14) + target_compile_options(${TARGET} PRIVATE -Wall -Werror) + target_compile_options(${TARGET} PRIVATE "$<$>:-O3>") + target_compile_definitions(${TARGET} PRIVATE "$<$>:NDEBUG>") +endfunction() + +# Flutter library and tool build rules. +set(FLUTTER_MANAGED_DIR "${CMAKE_CURRENT_SOURCE_DIR}/flutter") +add_subdirectory(${FLUTTER_MANAGED_DIR}) + +# System-level dependencies. +find_package(PkgConfig REQUIRED) +pkg_check_modules(GTK REQUIRED IMPORTED_TARGET gtk+-3.0) + +add_definitions(-DAPPLICATION_ID="${APPLICATION_ID}") + +# Define the application target. To change its name, change BINARY_NAME above, +# not the value here, or `flutter run` will no longer work. +# +# Any new source files that you add to the application should be added here. +add_executable(${BINARY_NAME} + "main.cc" + "my_application.cc" + "${FLUTTER_MANAGED_DIR}/generated_plugin_registrant.cc" +) + +# Apply the standard set of build settings. This can be removed for applications +# that need different build settings. +apply_standard_settings(${BINARY_NAME}) + +# Add dependency libraries. Add any application-specific dependencies here. +target_link_libraries(${BINARY_NAME} PRIVATE flutter) +target_link_libraries(${BINARY_NAME} PRIVATE PkgConfig::GTK) + +# Run the Flutter tool portions of the build. This must not be removed. +add_dependencies(${BINARY_NAME} flutter_assemble) + +# Only the install-generated bundle's copy of the executable will launch +# correctly, since the resources must in the right relative locations. To avoid +# people trying to run the unbundled copy, put it in a subdirectory instead of +# the default top-level location. +set_target_properties(${BINARY_NAME} + PROPERTIES + RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/intermediates_do_not_run" +) + + +# Generated plugin build rules, which manage building the plugins and adding +# them to the application. +include(flutter/generated_plugins.cmake) + + +# === Installation === +# By default, "installing" just makes a relocatable bundle in the build +# directory. +set(BUILD_BUNDLE_DIR "${PROJECT_BINARY_DIR}/bundle") +if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT) + set(CMAKE_INSTALL_PREFIX "${BUILD_BUNDLE_DIR}" CACHE PATH "..." FORCE) +endif() + +# Start with a clean build bundle directory every time. +install(CODE " + file(REMOVE_RECURSE \"${BUILD_BUNDLE_DIR}/\") + " COMPONENT Runtime) + +set(INSTALL_BUNDLE_DATA_DIR "${CMAKE_INSTALL_PREFIX}/data") +set(INSTALL_BUNDLE_LIB_DIR "${CMAKE_INSTALL_PREFIX}/lib") + +install(TARGETS ${BINARY_NAME} RUNTIME DESTINATION "${CMAKE_INSTALL_PREFIX}" + COMPONENT Runtime) + +install(FILES "${FLUTTER_ICU_DATA_FILE}" DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" + COMPONENT Runtime) + +install(FILES "${FLUTTER_LIBRARY}" DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" + COMPONENT Runtime) + +foreach(bundled_library ${PLUGIN_BUNDLED_LIBRARIES}) + install(FILES "${bundled_library}" + DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" + COMPONENT Runtime) +endforeach(bundled_library) + +# Copy the native assets provided by the build.dart from all packages. +set(NATIVE_ASSETS_DIR "${PROJECT_BUILD_DIR}native_assets/linux/") +install(DIRECTORY "${NATIVE_ASSETS_DIR}" + DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" + COMPONENT Runtime) + +# Fully re-copy the assets directory on each build to avoid having stale files +# from a previous install. +set(FLUTTER_ASSET_DIR_NAME "flutter_assets") +install(CODE " + file(REMOVE_RECURSE \"${INSTALL_BUNDLE_DATA_DIR}/${FLUTTER_ASSET_DIR_NAME}\") + " COMPONENT Runtime) +install(DIRECTORY "${PROJECT_BUILD_DIR}/${FLUTTER_ASSET_DIR_NAME}" + DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" COMPONENT Runtime) + +# Install the AOT library on non-Debug builds only. +if(NOT CMAKE_BUILD_TYPE MATCHES "Debug") + install(FILES "${AOT_LIBRARY}" DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" + COMPONENT Runtime) +endif() diff --git a/linux/flutter/CMakeLists.txt b/linux/flutter/CMakeLists.txt new file mode 100644 index 0000000..d5bd016 --- /dev/null +++ b/linux/flutter/CMakeLists.txt @@ -0,0 +1,88 @@ +# This file controls Flutter-level build steps. It should not be edited. +cmake_minimum_required(VERSION 3.10) + +set(EPHEMERAL_DIR "${CMAKE_CURRENT_SOURCE_DIR}/ephemeral") + +# Configuration provided via flutter tool. +include(${EPHEMERAL_DIR}/generated_config.cmake) + +# TODO: Move the rest of this into files in ephemeral. See +# https://github.com/flutter/flutter/issues/57146. + +# Serves the same purpose as list(TRANSFORM ... PREPEND ...), +# which isn't available in 3.10. +function(list_prepend LIST_NAME PREFIX) + set(NEW_LIST "") + foreach(element ${${LIST_NAME}}) + list(APPEND NEW_LIST "${PREFIX}${element}") + endforeach(element) + set(${LIST_NAME} "${NEW_LIST}" PARENT_SCOPE) +endfunction() + +# === Flutter Library === +# System-level dependencies. +find_package(PkgConfig REQUIRED) +pkg_check_modules(GTK REQUIRED IMPORTED_TARGET gtk+-3.0) +pkg_check_modules(GLIB REQUIRED IMPORTED_TARGET glib-2.0) +pkg_check_modules(GIO REQUIRED IMPORTED_TARGET gio-2.0) + +set(FLUTTER_LIBRARY "${EPHEMERAL_DIR}/libflutter_linux_gtk.so") + +# Published to parent scope for install step. +set(FLUTTER_LIBRARY ${FLUTTER_LIBRARY} PARENT_SCOPE) +set(FLUTTER_ICU_DATA_FILE "${EPHEMERAL_DIR}/icudtl.dat" PARENT_SCOPE) +set(PROJECT_BUILD_DIR "${PROJECT_DIR}/build/" PARENT_SCOPE) +set(AOT_LIBRARY "${PROJECT_DIR}/build/lib/libapp.so" PARENT_SCOPE) + +list(APPEND FLUTTER_LIBRARY_HEADERS + "fl_basic_message_channel.h" + "fl_binary_codec.h" + "fl_binary_messenger.h" + "fl_dart_project.h" + "fl_engine.h" + "fl_json_message_codec.h" + "fl_json_method_codec.h" + "fl_message_codec.h" + "fl_method_call.h" + "fl_method_channel.h" + "fl_method_codec.h" + "fl_method_response.h" + "fl_plugin_registrar.h" + "fl_plugin_registry.h" + "fl_standard_message_codec.h" + "fl_standard_method_codec.h" + "fl_string_codec.h" + "fl_value.h" + "fl_view.h" + "flutter_linux.h" +) +list_prepend(FLUTTER_LIBRARY_HEADERS "${EPHEMERAL_DIR}/flutter_linux/") +add_library(flutter INTERFACE) +target_include_directories(flutter INTERFACE + "${EPHEMERAL_DIR}" +) +target_link_libraries(flutter INTERFACE "${FLUTTER_LIBRARY}") +target_link_libraries(flutter INTERFACE + PkgConfig::GTK + PkgConfig::GLIB + PkgConfig::GIO +) +add_dependencies(flutter flutter_assemble) + +# === Flutter tool backend === +# _phony_ is a non-existent file to force this command to run every time, +# since currently there's no way to get a full input/output list from the +# flutter tool. +add_custom_command( + OUTPUT ${FLUTTER_LIBRARY} ${FLUTTER_LIBRARY_HEADERS} + ${CMAKE_CURRENT_BINARY_DIR}/_phony_ + COMMAND ${CMAKE_COMMAND} -E env + ${FLUTTER_TOOL_ENVIRONMENT} + "${FLUTTER_ROOT}/packages/flutter_tools/bin/tool_backend.sh" + ${FLUTTER_TARGET_PLATFORM} ${CMAKE_BUILD_TYPE} + VERBATIM +) +add_custom_target(flutter_assemble DEPENDS + "${FLUTTER_LIBRARY}" + ${FLUTTER_LIBRARY_HEADERS} +) diff --git a/linux/flutter/generated_plugin_registrant.cc b/linux/flutter/generated_plugin_registrant.cc new file mode 100644 index 0000000..e71a16d --- /dev/null +++ b/linux/flutter/generated_plugin_registrant.cc @@ -0,0 +1,11 @@ +// +// Generated file. Do not edit. +// + +// clang-format off + +#include "generated_plugin_registrant.h" + + +void fl_register_plugins(FlPluginRegistry* registry) { +} diff --git a/linux/flutter/generated_plugin_registrant.h b/linux/flutter/generated_plugin_registrant.h new file mode 100644 index 0000000..e0f0a47 --- /dev/null +++ b/linux/flutter/generated_plugin_registrant.h @@ -0,0 +1,15 @@ +// +// Generated file. Do not edit. +// + +// clang-format off + +#ifndef GENERATED_PLUGIN_REGISTRANT_ +#define GENERATED_PLUGIN_REGISTRANT_ + +#include + +// Registers Flutter plugins. +void fl_register_plugins(FlPluginRegistry* registry); + +#endif // GENERATED_PLUGIN_REGISTRANT_ diff --git a/linux/flutter/generated_plugins.cmake b/linux/flutter/generated_plugins.cmake new file mode 100644 index 0000000..2e1de87 --- /dev/null +++ b/linux/flutter/generated_plugins.cmake @@ -0,0 +1,23 @@ +# +# Generated file, do not edit. +# + +list(APPEND FLUTTER_PLUGIN_LIST +) + +list(APPEND FLUTTER_FFI_PLUGIN_LIST +) + +set(PLUGIN_BUNDLED_LIBRARIES) + +foreach(plugin ${FLUTTER_PLUGIN_LIST}) + add_subdirectory(flutter/ephemeral/.plugin_symlinks/${plugin}/linux plugins/${plugin}) + target_link_libraries(${BINARY_NAME} PRIVATE ${plugin}_plugin) + list(APPEND PLUGIN_BUNDLED_LIBRARIES $) + list(APPEND PLUGIN_BUNDLED_LIBRARIES ${${plugin}_bundled_libraries}) +endforeach(plugin) + +foreach(ffi_plugin ${FLUTTER_FFI_PLUGIN_LIST}) + add_subdirectory(flutter/ephemeral/.plugin_symlinks/${ffi_plugin}/linux plugins/${ffi_plugin}) + list(APPEND PLUGIN_BUNDLED_LIBRARIES ${${ffi_plugin}_bundled_libraries}) +endforeach(ffi_plugin) diff --git a/linux/main.cc b/linux/main.cc new file mode 100644 index 0000000..e7c5c54 --- /dev/null +++ b/linux/main.cc @@ -0,0 +1,6 @@ +#include "my_application.h" + +int main(int argc, char** argv) { + g_autoptr(MyApplication) app = my_application_new(); + return g_application_run(G_APPLICATION(app), argc, argv); +} diff --git a/linux/my_application.cc b/linux/my_application.cc new file mode 100644 index 0000000..98b64b6 --- /dev/null +++ b/linux/my_application.cc @@ -0,0 +1,124 @@ +#include "my_application.h" + +#include +#ifdef GDK_WINDOWING_X11 +#include +#endif + +#include "flutter/generated_plugin_registrant.h" + +struct _MyApplication { + GtkApplication parent_instance; + char** dart_entrypoint_arguments; +}; + +G_DEFINE_TYPE(MyApplication, my_application, GTK_TYPE_APPLICATION) + +// Implements GApplication::activate. +static void my_application_activate(GApplication* application) { + MyApplication* self = MY_APPLICATION(application); + GtkWindow* window = + GTK_WINDOW(gtk_application_window_new(GTK_APPLICATION(application))); + + // Use a header bar when running in GNOME as this is the common style used + // by applications and is the setup most users will be using (e.g. Ubuntu + // desktop). + // If running on X and not using GNOME then just use a traditional title bar + // in case the window manager does more exotic layout, e.g. tiling. + // If running on Wayland assume the header bar will work (may need changing + // if future cases occur). + gboolean use_header_bar = TRUE; +#ifdef GDK_WINDOWING_X11 + GdkScreen* screen = gtk_window_get_screen(window); + if (GDK_IS_X11_SCREEN(screen)) { + const gchar* wm_name = gdk_x11_screen_get_window_manager_name(screen); + if (g_strcmp0(wm_name, "GNOME Shell") != 0) { + use_header_bar = FALSE; + } + } +#endif + if (use_header_bar) { + GtkHeaderBar* header_bar = GTK_HEADER_BAR(gtk_header_bar_new()); + gtk_widget_show(GTK_WIDGET(header_bar)); + gtk_header_bar_set_title(header_bar, "clean_architecture_tdd_course"); + gtk_header_bar_set_show_close_button(header_bar, TRUE); + gtk_window_set_titlebar(window, GTK_WIDGET(header_bar)); + } else { + gtk_window_set_title(window, "clean_architecture_tdd_course"); + } + + gtk_window_set_default_size(window, 1280, 720); + gtk_widget_show(GTK_WIDGET(window)); + + g_autoptr(FlDartProject) project = fl_dart_project_new(); + fl_dart_project_set_dart_entrypoint_arguments(project, self->dart_entrypoint_arguments); + + FlView* view = fl_view_new(project); + gtk_widget_show(GTK_WIDGET(view)); + gtk_container_add(GTK_CONTAINER(window), GTK_WIDGET(view)); + + fl_register_plugins(FL_PLUGIN_REGISTRY(view)); + + gtk_widget_grab_focus(GTK_WIDGET(view)); +} + +// Implements GApplication::local_command_line. +static gboolean my_application_local_command_line(GApplication* application, gchar*** arguments, int* exit_status) { + MyApplication* self = MY_APPLICATION(application); + // Strip out the first argument as it is the binary name. + self->dart_entrypoint_arguments = g_strdupv(*arguments + 1); + + g_autoptr(GError) error = nullptr; + if (!g_application_register(application, nullptr, &error)) { + g_warning("Failed to register: %s", error->message); + *exit_status = 1; + return TRUE; + } + + g_application_activate(application); + *exit_status = 0; + + return TRUE; +} + +// Implements GApplication::startup. +static void my_application_startup(GApplication* application) { + //MyApplication* self = MY_APPLICATION(object); + + // Perform any actions required at application startup. + + G_APPLICATION_CLASS(my_application_parent_class)->startup(application); +} + +// Implements GApplication::shutdown. +static void my_application_shutdown(GApplication* application) { + //MyApplication* self = MY_APPLICATION(object); + + // Perform any actions required at application shutdown. + + G_APPLICATION_CLASS(my_application_parent_class)->shutdown(application); +} + +// Implements GObject::dispose. +static void my_application_dispose(GObject* object) { + MyApplication* self = MY_APPLICATION(object); + g_clear_pointer(&self->dart_entrypoint_arguments, g_strfreev); + G_OBJECT_CLASS(my_application_parent_class)->dispose(object); +} + +static void my_application_class_init(MyApplicationClass* klass) { + G_APPLICATION_CLASS(klass)->activate = my_application_activate; + G_APPLICATION_CLASS(klass)->local_command_line = my_application_local_command_line; + G_APPLICATION_CLASS(klass)->startup = my_application_startup; + G_APPLICATION_CLASS(klass)->shutdown = my_application_shutdown; + G_OBJECT_CLASS(klass)->dispose = my_application_dispose; +} + +static void my_application_init(MyApplication* self) {} + +MyApplication* my_application_new() { + return MY_APPLICATION(g_object_new(my_application_get_type(), + "application-id", APPLICATION_ID, + "flags", G_APPLICATION_NON_UNIQUE, + nullptr)); +} diff --git a/linux/my_application.h b/linux/my_application.h new file mode 100644 index 0000000..72271d5 --- /dev/null +++ b/linux/my_application.h @@ -0,0 +1,18 @@ +#ifndef FLUTTER_MY_APPLICATION_H_ +#define FLUTTER_MY_APPLICATION_H_ + +#include + +G_DECLARE_FINAL_TYPE(MyApplication, my_application, MY, APPLICATION, + GtkApplication) + +/** + * my_application_new: + * + * Creates a new Flutter-based application. + * + * Returns: a new #MyApplication. + */ +MyApplication* my_application_new(); + +#endif // FLUTTER_MY_APPLICATION_H_ diff --git a/macos/.gitignore b/macos/.gitignore new file mode 100644 index 0000000..746adbb --- /dev/null +++ b/macos/.gitignore @@ -0,0 +1,7 @@ +# Flutter-related +**/Flutter/ephemeral/ +**/Pods/ + +# Xcode-related +**/dgph +**/xcuserdata/ diff --git a/macos/Flutter/Flutter-Debug.xcconfig b/macos/Flutter/Flutter-Debug.xcconfig new file mode 100644 index 0000000..4b81f9b --- /dev/null +++ b/macos/Flutter/Flutter-Debug.xcconfig @@ -0,0 +1,2 @@ +#include? "Pods/Target Support Files/Pods-Runner/Pods-Runner.debug.xcconfig" +#include "ephemeral/Flutter-Generated.xcconfig" diff --git a/macos/Flutter/Flutter-Release.xcconfig b/macos/Flutter/Flutter-Release.xcconfig new file mode 100644 index 0000000..5caa9d1 --- /dev/null +++ b/macos/Flutter/Flutter-Release.xcconfig @@ -0,0 +1,2 @@ +#include? "Pods/Target Support Files/Pods-Runner/Pods-Runner.release.xcconfig" +#include "ephemeral/Flutter-Generated.xcconfig" diff --git a/macos/Flutter/GeneratedPluginRegistrant.swift b/macos/Flutter/GeneratedPluginRegistrant.swift new file mode 100644 index 0000000..724bb2a --- /dev/null +++ b/macos/Flutter/GeneratedPluginRegistrant.swift @@ -0,0 +1,12 @@ +// +// Generated file. Do not edit. +// + +import FlutterMacOS +import Foundation + +import shared_preferences_foundation + +func RegisterGeneratedPlugins(registry: FlutterPluginRegistry) { + SharedPreferencesPlugin.register(with: registry.registrar(forPlugin: "SharedPreferencesPlugin")) +} diff --git a/macos/Podfile b/macos/Podfile new file mode 100644 index 0000000..c795730 --- /dev/null +++ b/macos/Podfile @@ -0,0 +1,43 @@ +platform :osx, '10.14' + +# CocoaPods analytics sends network stats synchronously affecting flutter build latency. +ENV['COCOAPODS_DISABLE_STATS'] = 'true' + +project 'Runner', { + 'Debug' => :debug, + 'Profile' => :release, + 'Release' => :release, +} + +def flutter_root + generated_xcode_build_settings_path = File.expand_path(File.join('..', 'Flutter', 'ephemeral', 'Flutter-Generated.xcconfig'), __FILE__) + unless File.exist?(generated_xcode_build_settings_path) + raise "#{generated_xcode_build_settings_path} must exist. If you're running pod install manually, make sure \"flutter pub get\" is executed first" + end + + File.foreach(generated_xcode_build_settings_path) do |line| + matches = line.match(/FLUTTER_ROOT\=(.*)/) + return matches[1].strip if matches + end + raise "FLUTTER_ROOT not found in #{generated_xcode_build_settings_path}. Try deleting Flutter-Generated.xcconfig, then run \"flutter pub get\"" +end + +require File.expand_path(File.join('packages', 'flutter_tools', 'bin', 'podhelper'), flutter_root) + +flutter_macos_podfile_setup + +target 'Runner' do + use_frameworks! + use_modular_headers! + + flutter_install_all_macos_pods File.dirname(File.realpath(__FILE__)) + target 'RunnerTests' do + inherit! :search_paths + end +end + +post_install do |installer| + installer.pods_project.targets.each do |target| + flutter_additional_macos_build_settings(target) + end +end diff --git a/macos/Runner.xcodeproj/project.pbxproj b/macos/Runner.xcodeproj/project.pbxproj new file mode 100644 index 0000000..8196c87 --- /dev/null +++ b/macos/Runner.xcodeproj/project.pbxproj @@ -0,0 +1,705 @@ +// !$*UTF8*$! +{ + archiveVersion = 1; + classes = { + }; + objectVersion = 54; + objects = { + +/* Begin PBXAggregateTarget section */ + 33CC111A2044C6BA0003C045 /* Flutter Assemble */ = { + isa = PBXAggregateTarget; + buildConfigurationList = 33CC111B2044C6BA0003C045 /* Build configuration list for PBXAggregateTarget "Flutter Assemble" */; + buildPhases = ( + 33CC111E2044C6BF0003C045 /* ShellScript */, + ); + dependencies = ( + ); + name = "Flutter Assemble"; + productName = FLX; + }; +/* End PBXAggregateTarget section */ + +/* Begin PBXBuildFile section */ + 331C80D8294CF71000263BE5 /* RunnerTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 331C80D7294CF71000263BE5 /* RunnerTests.swift */; }; + 335BBD1B22A9A15E00E9071D /* GeneratedPluginRegistrant.swift in Sources */ = {isa = PBXBuildFile; fileRef = 335BBD1A22A9A15E00E9071D /* GeneratedPluginRegistrant.swift */; }; + 33CC10F12044A3C60003C045 /* AppDelegate.swift in Sources */ = {isa = PBXBuildFile; fileRef = 33CC10F02044A3C60003C045 /* AppDelegate.swift */; }; + 33CC10F32044A3C60003C045 /* Assets.xcassets in Resources */ = {isa = PBXBuildFile; fileRef = 33CC10F22044A3C60003C045 /* Assets.xcassets */; }; + 33CC10F62044A3C60003C045 /* MainMenu.xib in Resources */ = {isa = PBXBuildFile; fileRef = 33CC10F42044A3C60003C045 /* MainMenu.xib */; }; + 33CC11132044BFA00003C045 /* MainFlutterWindow.swift in Sources */ = {isa = PBXBuildFile; fileRef = 33CC11122044BFA00003C045 /* MainFlutterWindow.swift */; }; +/* End PBXBuildFile section */ + +/* Begin PBXContainerItemProxy section */ + 331C80D9294CF71000263BE5 /* PBXContainerItemProxy */ = { + isa = PBXContainerItemProxy; + containerPortal = 33CC10E52044A3C60003C045 /* Project object */; + proxyType = 1; + remoteGlobalIDString = 33CC10EC2044A3C60003C045; + remoteInfo = Runner; + }; + 33CC111F2044C79F0003C045 /* PBXContainerItemProxy */ = { + isa = PBXContainerItemProxy; + containerPortal = 33CC10E52044A3C60003C045 /* Project object */; + proxyType = 1; + remoteGlobalIDString = 33CC111A2044C6BA0003C045; + remoteInfo = FLX; + }; +/* End PBXContainerItemProxy section */ + +/* Begin PBXCopyFilesBuildPhase section */ + 33CC110E2044A8840003C045 /* Bundle Framework */ = { + isa = PBXCopyFilesBuildPhase; + buildActionMask = 2147483647; + dstPath = ""; + dstSubfolderSpec = 10; + files = ( + ); + name = "Bundle Framework"; + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXCopyFilesBuildPhase section */ + +/* Begin PBXFileReference section */ + 331C80D5294CF71000263BE5 /* RunnerTests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = RunnerTests.xctest; sourceTree = BUILT_PRODUCTS_DIR; }; + 331C80D7294CF71000263BE5 /* RunnerTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = RunnerTests.swift; sourceTree = ""; }; + 333000ED22D3DE5D00554162 /* Warnings.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; path = Warnings.xcconfig; sourceTree = ""; }; + 335BBD1A22A9A15E00E9071D /* GeneratedPluginRegistrant.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = GeneratedPluginRegistrant.swift; sourceTree = ""; }; + 33CC10ED2044A3C60003C045 /* clean_architecture_tdd_course.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = "clean_architecture_tdd_course.app"; sourceTree = BUILT_PRODUCTS_DIR; }; + 33CC10F02044A3C60003C045 /* AppDelegate.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AppDelegate.swift; sourceTree = ""; }; + 33CC10F22044A3C60003C045 /* Assets.xcassets */ = {isa = PBXFileReference; lastKnownFileType = folder.assetcatalog; name = Assets.xcassets; path = Runner/Assets.xcassets; sourceTree = ""; }; + 33CC10F52044A3C60003C045 /* Base */ = {isa = PBXFileReference; lastKnownFileType = file.xib; name = Base; path = Base.lproj/MainMenu.xib; sourceTree = ""; }; + 33CC10F72044A3C60003C045 /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; name = Info.plist; path = Runner/Info.plist; sourceTree = ""; }; + 33CC11122044BFA00003C045 /* MainFlutterWindow.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MainFlutterWindow.swift; sourceTree = ""; }; + 33CEB47222A05771004F2AC0 /* Flutter-Debug.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; path = "Flutter-Debug.xcconfig"; sourceTree = ""; }; + 33CEB47422A05771004F2AC0 /* Flutter-Release.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; path = "Flutter-Release.xcconfig"; sourceTree = ""; }; + 33CEB47722A0578A004F2AC0 /* Flutter-Generated.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; name = "Flutter-Generated.xcconfig"; path = "ephemeral/Flutter-Generated.xcconfig"; sourceTree = ""; }; + 33E51913231747F40026EE4D /* DebugProfile.entitlements */ = {isa = PBXFileReference; lastKnownFileType = text.plist.entitlements; path = DebugProfile.entitlements; sourceTree = ""; }; + 33E51914231749380026EE4D /* Release.entitlements */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.entitlements; path = Release.entitlements; sourceTree = ""; }; + 33E5194F232828860026EE4D /* AppInfo.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; path = AppInfo.xcconfig; sourceTree = ""; }; + 7AFA3C8E1D35360C0083082E /* Release.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; path = Release.xcconfig; sourceTree = ""; }; + 9740EEB21CF90195004384FC /* Debug.xcconfig */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.xcconfig; path = Debug.xcconfig; sourceTree = ""; }; +/* End PBXFileReference section */ + +/* Begin PBXFrameworksBuildPhase section */ + 331C80D2294CF70F00263BE5 /* Frameworks */ = { + isa = PBXFrameworksBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + runOnlyForDeploymentPostprocessing = 0; + }; + 33CC10EA2044A3C60003C045 /* Frameworks */ = { + isa = PBXFrameworksBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXFrameworksBuildPhase section */ + +/* Begin PBXGroup section */ + 331C80D6294CF71000263BE5 /* RunnerTests */ = { + isa = PBXGroup; + children = ( + 331C80D7294CF71000263BE5 /* RunnerTests.swift */, + ); + path = RunnerTests; + sourceTree = ""; + }; + 33BA886A226E78AF003329D5 /* Configs */ = { + isa = PBXGroup; + children = ( + 33E5194F232828860026EE4D /* AppInfo.xcconfig */, + 9740EEB21CF90195004384FC /* Debug.xcconfig */, + 7AFA3C8E1D35360C0083082E /* Release.xcconfig */, + 333000ED22D3DE5D00554162 /* Warnings.xcconfig */, + ); + path = Configs; + sourceTree = ""; + }; + 33CC10E42044A3C60003C045 = { + isa = PBXGroup; + children = ( + 33FAB671232836740065AC1E /* Runner */, + 33CEB47122A05771004F2AC0 /* Flutter */, + 331C80D6294CF71000263BE5 /* RunnerTests */, + 33CC10EE2044A3C60003C045 /* Products */, + D73912EC22F37F3D000D13A0 /* Frameworks */, + ); + sourceTree = ""; + }; + 33CC10EE2044A3C60003C045 /* Products */ = { + isa = PBXGroup; + children = ( + 33CC10ED2044A3C60003C045 /* clean_architecture_tdd_course.app */, + 331C80D5294CF71000263BE5 /* RunnerTests.xctest */, + ); + name = Products; + sourceTree = ""; + }; + 33CC11242044D66E0003C045 /* Resources */ = { + isa = PBXGroup; + children = ( + 33CC10F22044A3C60003C045 /* Assets.xcassets */, + 33CC10F42044A3C60003C045 /* MainMenu.xib */, + 33CC10F72044A3C60003C045 /* Info.plist */, + ); + name = Resources; + path = ..; + sourceTree = ""; + }; + 33CEB47122A05771004F2AC0 /* Flutter */ = { + isa = PBXGroup; + children = ( + 335BBD1A22A9A15E00E9071D /* GeneratedPluginRegistrant.swift */, + 33CEB47222A05771004F2AC0 /* Flutter-Debug.xcconfig */, + 33CEB47422A05771004F2AC0 /* Flutter-Release.xcconfig */, + 33CEB47722A0578A004F2AC0 /* Flutter-Generated.xcconfig */, + ); + path = Flutter; + sourceTree = ""; + }; + 33FAB671232836740065AC1E /* Runner */ = { + isa = PBXGroup; + children = ( + 33CC10F02044A3C60003C045 /* AppDelegate.swift */, + 33CC11122044BFA00003C045 /* MainFlutterWindow.swift */, + 33E51913231747F40026EE4D /* DebugProfile.entitlements */, + 33E51914231749380026EE4D /* Release.entitlements */, + 33CC11242044D66E0003C045 /* Resources */, + 33BA886A226E78AF003329D5 /* Configs */, + ); + path = Runner; + sourceTree = ""; + }; + D73912EC22F37F3D000D13A0 /* Frameworks */ = { + isa = PBXGroup; + children = ( + ); + name = Frameworks; + sourceTree = ""; + }; +/* End PBXGroup section */ + +/* Begin PBXNativeTarget section */ + 331C80D4294CF70F00263BE5 /* RunnerTests */ = { + isa = PBXNativeTarget; + buildConfigurationList = 331C80DE294CF71000263BE5 /* Build configuration list for PBXNativeTarget "RunnerTests" */; + buildPhases = ( + 331C80D1294CF70F00263BE5 /* Sources */, + 331C80D2294CF70F00263BE5 /* Frameworks */, + 331C80D3294CF70F00263BE5 /* Resources */, + ); + buildRules = ( + ); + dependencies = ( + 331C80DA294CF71000263BE5 /* PBXTargetDependency */, + ); + name = RunnerTests; + productName = RunnerTests; + productReference = 331C80D5294CF71000263BE5 /* RunnerTests.xctest */; + productType = "com.apple.product-type.bundle.unit-test"; + }; + 33CC10EC2044A3C60003C045 /* Runner */ = { + isa = PBXNativeTarget; + buildConfigurationList = 33CC10FB2044A3C60003C045 /* Build configuration list for PBXNativeTarget "Runner" */; + buildPhases = ( + 33CC10E92044A3C60003C045 /* Sources */, + 33CC10EA2044A3C60003C045 /* Frameworks */, + 33CC10EB2044A3C60003C045 /* Resources */, + 33CC110E2044A8840003C045 /* Bundle Framework */, + 3399D490228B24CF009A79C7 /* ShellScript */, + ); + buildRules = ( + ); + dependencies = ( + 33CC11202044C79F0003C045 /* PBXTargetDependency */, + ); + name = Runner; + productName = Runner; + productReference = 33CC10ED2044A3C60003C045 /* clean_architecture_tdd_course.app */; + productType = "com.apple.product-type.application"; + }; +/* End PBXNativeTarget section */ + +/* Begin PBXProject section */ + 33CC10E52044A3C60003C045 /* Project object */ = { + isa = PBXProject; + attributes = { + BuildIndependentTargetsInParallel = YES; + LastSwiftUpdateCheck = 0920; + LastUpgradeCheck = 1510; + ORGANIZATIONNAME = ""; + TargetAttributes = { + 331C80D4294CF70F00263BE5 = { + CreatedOnToolsVersion = 14.0; + TestTargetID = 33CC10EC2044A3C60003C045; + }; + 33CC10EC2044A3C60003C045 = { + CreatedOnToolsVersion = 9.2; + LastSwiftMigration = 1100; + ProvisioningStyle = Automatic; + SystemCapabilities = { + com.apple.Sandbox = { + enabled = 1; + }; + }; + }; + 33CC111A2044C6BA0003C045 = { + CreatedOnToolsVersion = 9.2; + ProvisioningStyle = Manual; + }; + }; + }; + buildConfigurationList = 33CC10E82044A3C60003C045 /* Build configuration list for PBXProject "Runner" */; + compatibilityVersion = "Xcode 9.3"; + developmentRegion = en; + hasScannedForEncodings = 0; + knownRegions = ( + en, + Base, + ); + mainGroup = 33CC10E42044A3C60003C045; + productRefGroup = 33CC10EE2044A3C60003C045 /* Products */; + projectDirPath = ""; + projectRoot = ""; + targets = ( + 33CC10EC2044A3C60003C045 /* Runner */, + 331C80D4294CF70F00263BE5 /* RunnerTests */, + 33CC111A2044C6BA0003C045 /* Flutter Assemble */, + ); + }; +/* End PBXProject section */ + +/* Begin PBXResourcesBuildPhase section */ + 331C80D3294CF70F00263BE5 /* Resources */ = { + isa = PBXResourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + runOnlyForDeploymentPostprocessing = 0; + }; + 33CC10EB2044A3C60003C045 /* Resources */ = { + isa = PBXResourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + 33CC10F32044A3C60003C045 /* Assets.xcassets in Resources */, + 33CC10F62044A3C60003C045 /* MainMenu.xib in Resources */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXResourcesBuildPhase section */ + +/* Begin PBXShellScriptBuildPhase section */ + 3399D490228B24CF009A79C7 /* ShellScript */ = { + isa = PBXShellScriptBuildPhase; + alwaysOutOfDate = 1; + buildActionMask = 2147483647; + files = ( + ); + inputFileListPaths = ( + ); + inputPaths = ( + ); + outputFileListPaths = ( + ); + outputPaths = ( + ); + runOnlyForDeploymentPostprocessing = 0; + shellPath = /bin/sh; + shellScript = "echo \"$PRODUCT_NAME.app\" > \"$PROJECT_DIR\"/Flutter/ephemeral/.app_filename && \"$FLUTTER_ROOT\"/packages/flutter_tools/bin/macos_assemble.sh embed\n"; + }; + 33CC111E2044C6BF0003C045 /* ShellScript */ = { + isa = PBXShellScriptBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + inputFileListPaths = ( + Flutter/ephemeral/FlutterInputs.xcfilelist, + ); + inputPaths = ( + Flutter/ephemeral/tripwire, + ); + outputFileListPaths = ( + Flutter/ephemeral/FlutterOutputs.xcfilelist, + ); + outputPaths = ( + ); + runOnlyForDeploymentPostprocessing = 0; + shellPath = /bin/sh; + shellScript = "\"$FLUTTER_ROOT\"/packages/flutter_tools/bin/macos_assemble.sh && touch Flutter/ephemeral/tripwire"; + }; +/* End PBXShellScriptBuildPhase section */ + +/* Begin PBXSourcesBuildPhase section */ + 331C80D1294CF70F00263BE5 /* Sources */ = { + isa = PBXSourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + 331C80D8294CF71000263BE5 /* RunnerTests.swift in Sources */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; + 33CC10E92044A3C60003C045 /* Sources */ = { + isa = PBXSourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + 33CC11132044BFA00003C045 /* MainFlutterWindow.swift in Sources */, + 33CC10F12044A3C60003C045 /* AppDelegate.swift in Sources */, + 335BBD1B22A9A15E00E9071D /* GeneratedPluginRegistrant.swift in Sources */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXSourcesBuildPhase section */ + +/* Begin PBXTargetDependency section */ + 331C80DA294CF71000263BE5 /* PBXTargetDependency */ = { + isa = PBXTargetDependency; + target = 33CC10EC2044A3C60003C045 /* Runner */; + targetProxy = 331C80D9294CF71000263BE5 /* PBXContainerItemProxy */; + }; + 33CC11202044C79F0003C045 /* PBXTargetDependency */ = { + isa = PBXTargetDependency; + target = 33CC111A2044C6BA0003C045 /* Flutter Assemble */; + targetProxy = 33CC111F2044C79F0003C045 /* PBXContainerItemProxy */; + }; +/* End PBXTargetDependency section */ + +/* Begin PBXVariantGroup section */ + 33CC10F42044A3C60003C045 /* MainMenu.xib */ = { + isa = PBXVariantGroup; + children = ( + 33CC10F52044A3C60003C045 /* Base */, + ); + name = MainMenu.xib; + path = Runner; + sourceTree = ""; + }; +/* End PBXVariantGroup section */ + +/* Begin XCBuildConfiguration section */ + 331C80DB294CF71000263BE5 /* Debug */ = { + isa = XCBuildConfiguration; + buildSettings = { + BUNDLE_LOADER = "$(TEST_HOST)"; + CURRENT_PROJECT_VERSION = 1; + GENERATE_INFOPLIST_FILE = YES; + MARKETING_VERSION = 1.0; + PRODUCT_BUNDLE_IDENTIFIER = com.example.cleanArchitectureTddCourse.RunnerTests; + PRODUCT_NAME = "$(TARGET_NAME)"; + SWIFT_VERSION = 5.0; + TEST_HOST = "$(BUILT_PRODUCTS_DIR)/clean_architecture_tdd_course.app/$(BUNDLE_EXECUTABLE_FOLDER_PATH)/clean_architecture_tdd_course"; + }; + name = Debug; + }; + 331C80DC294CF71000263BE5 /* Release */ = { + isa = XCBuildConfiguration; + buildSettings = { + BUNDLE_LOADER = "$(TEST_HOST)"; + CURRENT_PROJECT_VERSION = 1; + GENERATE_INFOPLIST_FILE = YES; + MARKETING_VERSION = 1.0; + PRODUCT_BUNDLE_IDENTIFIER = com.example.cleanArchitectureTddCourse.RunnerTests; + PRODUCT_NAME = "$(TARGET_NAME)"; + SWIFT_VERSION = 5.0; + TEST_HOST = "$(BUILT_PRODUCTS_DIR)/clean_architecture_tdd_course.app/$(BUNDLE_EXECUTABLE_FOLDER_PATH)/clean_architecture_tdd_course"; + }; + name = Release; + }; + 331C80DD294CF71000263BE5 /* Profile */ = { + isa = XCBuildConfiguration; + buildSettings = { + BUNDLE_LOADER = "$(TEST_HOST)"; + CURRENT_PROJECT_VERSION = 1; + GENERATE_INFOPLIST_FILE = YES; + MARKETING_VERSION = 1.0; + PRODUCT_BUNDLE_IDENTIFIER = com.example.cleanArchitectureTddCourse.RunnerTests; + PRODUCT_NAME = "$(TARGET_NAME)"; + SWIFT_VERSION = 5.0; + TEST_HOST = "$(BUILT_PRODUCTS_DIR)/clean_architecture_tdd_course.app/$(BUNDLE_EXECUTABLE_FOLDER_PATH)/clean_architecture_tdd_course"; + }; + name = Profile; + }; + 338D0CE9231458BD00FA5F75 /* Profile */ = { + isa = XCBuildConfiguration; + baseConfigurationReference = 7AFA3C8E1D35360C0083082E /* Release.xcconfig */; + buildSettings = { + ALWAYS_SEARCH_USER_PATHS = NO; + ASSETCATALOG_COMPILER_GENERATE_SWIFT_ASSET_SYMBOL_EXTENSIONS = YES; + CLANG_ANALYZER_NONNULL = YES; + CLANG_ANALYZER_NUMBER_OBJECT_CONVERSION = YES_AGGRESSIVE; + CLANG_CXX_LANGUAGE_STANDARD = "gnu++14"; + CLANG_CXX_LIBRARY = "libc++"; + CLANG_ENABLE_MODULES = YES; + CLANG_ENABLE_OBJC_ARC = YES; + CLANG_WARN_BLOCK_CAPTURE_AUTORELEASING = YES; + CLANG_WARN_BOOL_CONVERSION = YES; + CLANG_WARN_CONSTANT_CONVERSION = YES; + CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES; + CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR; + CLANG_WARN_DOCUMENTATION_COMMENTS = YES; + CLANG_WARN_EMPTY_BODY = YES; + CLANG_WARN_ENUM_CONVERSION = YES; + CLANG_WARN_INFINITE_RECURSION = YES; + CLANG_WARN_INT_CONVERSION = YES; + CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES; + CLANG_WARN_OBJC_LITERAL_CONVERSION = YES; + CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR; + CLANG_WARN_RANGE_LOOP_ANALYSIS = YES; + CLANG_WARN_SUSPICIOUS_MOVE = YES; + CODE_SIGN_IDENTITY = "-"; + COPY_PHASE_STRIP = NO; + DEAD_CODE_STRIPPING = YES; + DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym"; + ENABLE_NS_ASSERTIONS = NO; + ENABLE_STRICT_OBJC_MSGSEND = YES; + ENABLE_USER_SCRIPT_SANDBOXING = NO; + GCC_C_LANGUAGE_STANDARD = gnu11; + GCC_NO_COMMON_BLOCKS = YES; + GCC_WARN_64_TO_32_BIT_CONVERSION = YES; + GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR; + GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; + GCC_WARN_UNUSED_FUNCTION = YES; + GCC_WARN_UNUSED_VARIABLE = YES; + MACOSX_DEPLOYMENT_TARGET = 10.14; + MTL_ENABLE_DEBUG_INFO = NO; + SDKROOT = macosx; + SWIFT_COMPILATION_MODE = wholemodule; + SWIFT_OPTIMIZATION_LEVEL = "-O"; + }; + name = Profile; + }; + 338D0CEA231458BD00FA5F75 /* Profile */ = { + isa = XCBuildConfiguration; + baseConfigurationReference = 33E5194F232828860026EE4D /* AppInfo.xcconfig */; + buildSettings = { + ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon; + CLANG_ENABLE_MODULES = YES; + CODE_SIGN_ENTITLEMENTS = Runner/DebugProfile.entitlements; + CODE_SIGN_STYLE = Automatic; + COMBINE_HIDPI_IMAGES = YES; + INFOPLIST_FILE = Runner/Info.plist; + LD_RUNPATH_SEARCH_PATHS = ( + "$(inherited)", + "@executable_path/../Frameworks", + ); + PROVISIONING_PROFILE_SPECIFIER = ""; + SWIFT_VERSION = 5.0; + }; + name = Profile; + }; + 338D0CEB231458BD00FA5F75 /* Profile */ = { + isa = XCBuildConfiguration; + buildSettings = { + CODE_SIGN_STYLE = Manual; + PRODUCT_NAME = "$(TARGET_NAME)"; + }; + name = Profile; + }; + 33CC10F92044A3C60003C045 /* Debug */ = { + isa = XCBuildConfiguration; + baseConfigurationReference = 9740EEB21CF90195004384FC /* Debug.xcconfig */; + buildSettings = { + ALWAYS_SEARCH_USER_PATHS = NO; + ASSETCATALOG_COMPILER_GENERATE_SWIFT_ASSET_SYMBOL_EXTENSIONS = YES; + CLANG_ANALYZER_NONNULL = YES; + CLANG_ANALYZER_NUMBER_OBJECT_CONVERSION = YES_AGGRESSIVE; + CLANG_CXX_LANGUAGE_STANDARD = "gnu++14"; + CLANG_CXX_LIBRARY = "libc++"; + CLANG_ENABLE_MODULES = YES; + CLANG_ENABLE_OBJC_ARC = YES; + CLANG_WARN_BLOCK_CAPTURE_AUTORELEASING = YES; + CLANG_WARN_BOOL_CONVERSION = YES; + CLANG_WARN_CONSTANT_CONVERSION = YES; + CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES; + CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR; + CLANG_WARN_DOCUMENTATION_COMMENTS = YES; + CLANG_WARN_EMPTY_BODY = YES; + CLANG_WARN_ENUM_CONVERSION = YES; + CLANG_WARN_INFINITE_RECURSION = YES; + CLANG_WARN_INT_CONVERSION = YES; + CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES; + CLANG_WARN_OBJC_LITERAL_CONVERSION = YES; + CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR; + CLANG_WARN_RANGE_LOOP_ANALYSIS = YES; + CLANG_WARN_SUSPICIOUS_MOVE = YES; + CODE_SIGN_IDENTITY = "-"; + COPY_PHASE_STRIP = NO; + DEAD_CODE_STRIPPING = YES; + DEBUG_INFORMATION_FORMAT = dwarf; + ENABLE_STRICT_OBJC_MSGSEND = YES; + ENABLE_TESTABILITY = YES; + ENABLE_USER_SCRIPT_SANDBOXING = NO; + GCC_C_LANGUAGE_STANDARD = gnu11; + GCC_DYNAMIC_NO_PIC = NO; + GCC_NO_COMMON_BLOCKS = YES; + GCC_OPTIMIZATION_LEVEL = 0; + GCC_PREPROCESSOR_DEFINITIONS = ( + "DEBUG=1", + "$(inherited)", + ); + GCC_WARN_64_TO_32_BIT_CONVERSION = YES; + GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR; + GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; + GCC_WARN_UNUSED_FUNCTION = YES; + GCC_WARN_UNUSED_VARIABLE = YES; + MACOSX_DEPLOYMENT_TARGET = 10.14; + MTL_ENABLE_DEBUG_INFO = YES; + ONLY_ACTIVE_ARCH = YES; + SDKROOT = macosx; + SWIFT_ACTIVE_COMPILATION_CONDITIONS = DEBUG; + SWIFT_OPTIMIZATION_LEVEL = "-Onone"; + }; + name = Debug; + }; + 33CC10FA2044A3C60003C045 /* Release */ = { + isa = XCBuildConfiguration; + baseConfigurationReference = 7AFA3C8E1D35360C0083082E /* Release.xcconfig */; + buildSettings = { + ALWAYS_SEARCH_USER_PATHS = NO; + ASSETCATALOG_COMPILER_GENERATE_SWIFT_ASSET_SYMBOL_EXTENSIONS = YES; + CLANG_ANALYZER_NONNULL = YES; + CLANG_ANALYZER_NUMBER_OBJECT_CONVERSION = YES_AGGRESSIVE; + CLANG_CXX_LANGUAGE_STANDARD = "gnu++14"; + CLANG_CXX_LIBRARY = "libc++"; + CLANG_ENABLE_MODULES = YES; + CLANG_ENABLE_OBJC_ARC = YES; + CLANG_WARN_BLOCK_CAPTURE_AUTORELEASING = YES; + CLANG_WARN_BOOL_CONVERSION = YES; + CLANG_WARN_CONSTANT_CONVERSION = YES; + CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES; + CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR; + CLANG_WARN_DOCUMENTATION_COMMENTS = YES; + CLANG_WARN_EMPTY_BODY = YES; + CLANG_WARN_ENUM_CONVERSION = YES; + CLANG_WARN_INFINITE_RECURSION = YES; + CLANG_WARN_INT_CONVERSION = YES; + CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES; + CLANG_WARN_OBJC_LITERAL_CONVERSION = YES; + CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR; + CLANG_WARN_RANGE_LOOP_ANALYSIS = YES; + CLANG_WARN_SUSPICIOUS_MOVE = YES; + CODE_SIGN_IDENTITY = "-"; + COPY_PHASE_STRIP = NO; + DEAD_CODE_STRIPPING = YES; + DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym"; + ENABLE_NS_ASSERTIONS = NO; + ENABLE_STRICT_OBJC_MSGSEND = YES; + ENABLE_USER_SCRIPT_SANDBOXING = NO; + GCC_C_LANGUAGE_STANDARD = gnu11; + GCC_NO_COMMON_BLOCKS = YES; + GCC_WARN_64_TO_32_BIT_CONVERSION = YES; + GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR; + GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; + GCC_WARN_UNUSED_FUNCTION = YES; + GCC_WARN_UNUSED_VARIABLE = YES; + MACOSX_DEPLOYMENT_TARGET = 10.14; + MTL_ENABLE_DEBUG_INFO = NO; + SDKROOT = macosx; + SWIFT_COMPILATION_MODE = wholemodule; + SWIFT_OPTIMIZATION_LEVEL = "-O"; + }; + name = Release; + }; + 33CC10FC2044A3C60003C045 /* Debug */ = { + isa = XCBuildConfiguration; + baseConfigurationReference = 33E5194F232828860026EE4D /* AppInfo.xcconfig */; + buildSettings = { + ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon; + CLANG_ENABLE_MODULES = YES; + CODE_SIGN_ENTITLEMENTS = Runner/DebugProfile.entitlements; + CODE_SIGN_STYLE = Automatic; + COMBINE_HIDPI_IMAGES = YES; + INFOPLIST_FILE = Runner/Info.plist; + LD_RUNPATH_SEARCH_PATHS = ( + "$(inherited)", + "@executable_path/../Frameworks", + ); + PROVISIONING_PROFILE_SPECIFIER = ""; + SWIFT_OPTIMIZATION_LEVEL = "-Onone"; + SWIFT_VERSION = 5.0; + }; + name = Debug; + }; + 33CC10FD2044A3C60003C045 /* Release */ = { + isa = XCBuildConfiguration; + baseConfigurationReference = 33E5194F232828860026EE4D /* AppInfo.xcconfig */; + buildSettings = { + ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon; + CLANG_ENABLE_MODULES = YES; + CODE_SIGN_ENTITLEMENTS = Runner/Release.entitlements; + CODE_SIGN_STYLE = Automatic; + COMBINE_HIDPI_IMAGES = YES; + INFOPLIST_FILE = Runner/Info.plist; + LD_RUNPATH_SEARCH_PATHS = ( + "$(inherited)", + "@executable_path/../Frameworks", + ); + PROVISIONING_PROFILE_SPECIFIER = ""; + SWIFT_VERSION = 5.0; + }; + name = Release; + }; + 33CC111C2044C6BA0003C045 /* Debug */ = { + isa = XCBuildConfiguration; + buildSettings = { + CODE_SIGN_STYLE = Manual; + PRODUCT_NAME = "$(TARGET_NAME)"; + }; + name = Debug; + }; + 33CC111D2044C6BA0003C045 /* Release */ = { + isa = XCBuildConfiguration; + buildSettings = { + CODE_SIGN_STYLE = Automatic; + PRODUCT_NAME = "$(TARGET_NAME)"; + }; + name = Release; + }; +/* End XCBuildConfiguration section */ + +/* Begin XCConfigurationList section */ + 331C80DE294CF71000263BE5 /* Build configuration list for PBXNativeTarget "RunnerTests" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + 331C80DB294CF71000263BE5 /* Debug */, + 331C80DC294CF71000263BE5 /* Release */, + 331C80DD294CF71000263BE5 /* Profile */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Release; + }; + 33CC10E82044A3C60003C045 /* Build configuration list for PBXProject "Runner" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + 33CC10F92044A3C60003C045 /* Debug */, + 33CC10FA2044A3C60003C045 /* Release */, + 338D0CE9231458BD00FA5F75 /* Profile */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Release; + }; + 33CC10FB2044A3C60003C045 /* Build configuration list for PBXNativeTarget "Runner" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + 33CC10FC2044A3C60003C045 /* Debug */, + 33CC10FD2044A3C60003C045 /* Release */, + 338D0CEA231458BD00FA5F75 /* Profile */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Release; + }; + 33CC111B2044C6BA0003C045 /* Build configuration list for PBXAggregateTarget "Flutter Assemble" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + 33CC111C2044C6BA0003C045 /* Debug */, + 33CC111D2044C6BA0003C045 /* Release */, + 338D0CEB231458BD00FA5F75 /* Profile */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Release; + }; +/* End XCConfigurationList section */ + }; + rootObject = 33CC10E52044A3C60003C045 /* Project object */; +} diff --git a/macos/Runner.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist b/macos/Runner.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist new file mode 100644 index 0000000..18d9810 --- /dev/null +++ b/macos/Runner.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist @@ -0,0 +1,8 @@ + + + + + IDEDidComputeMac32BitWarning + + + diff --git a/macos/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme b/macos/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme new file mode 100644 index 0000000..ec16c6e --- /dev/null +++ b/macos/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme @@ -0,0 +1,98 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/macos/Runner.xcworkspace/contents.xcworkspacedata b/macos/Runner.xcworkspace/contents.xcworkspacedata new file mode 100644 index 0000000..1d526a1 --- /dev/null +++ b/macos/Runner.xcworkspace/contents.xcworkspacedata @@ -0,0 +1,7 @@ + + + + + diff --git a/macos/Runner.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist b/macos/Runner.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist new file mode 100644 index 0000000..18d9810 --- /dev/null +++ b/macos/Runner.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist @@ -0,0 +1,8 @@ + + + + + IDEDidComputeMac32BitWarning + + + diff --git a/macos/Runner/AppDelegate.swift b/macos/Runner/AppDelegate.swift new file mode 100644 index 0000000..d53ef64 --- /dev/null +++ b/macos/Runner/AppDelegate.swift @@ -0,0 +1,9 @@ +import Cocoa +import FlutterMacOS + +@NSApplicationMain +class AppDelegate: FlutterAppDelegate { + override func applicationShouldTerminateAfterLastWindowClosed(_ sender: NSApplication) -> Bool { + return true + } +} diff --git a/macos/Runner/Assets.xcassets/AppIcon.appiconset/Contents.json b/macos/Runner/Assets.xcassets/AppIcon.appiconset/Contents.json new file mode 100644 index 0000000..a2ec33f --- /dev/null +++ b/macos/Runner/Assets.xcassets/AppIcon.appiconset/Contents.json @@ -0,0 +1,68 @@ +{ + "images" : [ + { + "size" : "16x16", + "idiom" : "mac", + "filename" : "app_icon_16.png", + "scale" : "1x" + }, + { + "size" : "16x16", + "idiom" : "mac", + "filename" : "app_icon_32.png", + "scale" : "2x" + }, + { + "size" : "32x32", + "idiom" : "mac", + "filename" : "app_icon_32.png", + "scale" : "1x" + }, + { + "size" : "32x32", + "idiom" : "mac", + "filename" : "app_icon_64.png", + "scale" : "2x" + }, + { + "size" : "128x128", + "idiom" : "mac", + "filename" : "app_icon_128.png", + "scale" : "1x" + }, + { + "size" : "128x128", + "idiom" : "mac", + "filename" : "app_icon_256.png", + "scale" : "2x" + }, + { + "size" : "256x256", + "idiom" : "mac", + "filename" : "app_icon_256.png", + "scale" : "1x" + }, + { + "size" : "256x256", + "idiom" : "mac", + "filename" : "app_icon_512.png", + "scale" : "2x" + }, + { + "size" : "512x512", + "idiom" : "mac", + "filename" : "app_icon_512.png", + "scale" : "1x" + }, + { + "size" : "512x512", + "idiom" : "mac", + "filename" : "app_icon_1024.png", + "scale" : "2x" + } + ], + "info" : { + "version" : 1, + "author" : "xcode" + } +} diff --git a/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_1024.png b/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_1024.png new file mode 100644 index 0000000..82b6f9d Binary files /dev/null and b/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_1024.png differ diff --git a/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_128.png b/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_128.png new file mode 100644 index 0000000..13b35eb Binary files /dev/null and b/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_128.png differ diff --git a/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_16.png b/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_16.png new file mode 100644 index 0000000..0a3f5fa Binary files /dev/null and b/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_16.png differ diff --git a/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_256.png b/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_256.png new file mode 100644 index 0000000..bdb5722 Binary files /dev/null and b/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_256.png differ diff --git a/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_32.png b/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_32.png new file mode 100644 index 0000000..f083318 Binary files /dev/null and b/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_32.png differ diff --git a/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_512.png b/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_512.png new file mode 100644 index 0000000..326c0e7 Binary files /dev/null and b/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_512.png differ diff --git a/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_64.png b/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_64.png new file mode 100644 index 0000000..2f1632c Binary files /dev/null and b/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_64.png differ diff --git a/macos/Runner/Base.lproj/MainMenu.xib b/macos/Runner/Base.lproj/MainMenu.xib new file mode 100644 index 0000000..80e867a --- /dev/null +++ b/macos/Runner/Base.lproj/MainMenu.xib @@ -0,0 +1,343 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/macos/Runner/Configs/AppInfo.xcconfig b/macos/Runner/Configs/AppInfo.xcconfig new file mode 100644 index 0000000..38f2bda --- /dev/null +++ b/macos/Runner/Configs/AppInfo.xcconfig @@ -0,0 +1,14 @@ +// Application-level settings for the Runner target. +// +// This may be replaced with something auto-generated from metadata (e.g., pubspec.yaml) in the +// future. If not, the values below would default to using the project name when this becomes a +// 'flutter create' template. + +// The application's name. By default this is also the title of the Flutter window. +PRODUCT_NAME = clean_architecture_tdd_course + +// The application's bundle identifier +PRODUCT_BUNDLE_IDENTIFIER = com.example.cleanArchitectureTddCourse + +// The copyright displayed in application information +PRODUCT_COPYRIGHT = Copyright © 2024 com.example. All rights reserved. diff --git a/macos/Runner/Configs/Debug.xcconfig b/macos/Runner/Configs/Debug.xcconfig new file mode 100644 index 0000000..36b0fd9 --- /dev/null +++ b/macos/Runner/Configs/Debug.xcconfig @@ -0,0 +1,2 @@ +#include "../../Flutter/Flutter-Debug.xcconfig" +#include "Warnings.xcconfig" diff --git a/macos/Runner/Configs/Release.xcconfig b/macos/Runner/Configs/Release.xcconfig new file mode 100644 index 0000000..dff4f49 --- /dev/null +++ b/macos/Runner/Configs/Release.xcconfig @@ -0,0 +1,2 @@ +#include "../../Flutter/Flutter-Release.xcconfig" +#include "Warnings.xcconfig" diff --git a/macos/Runner/Configs/Warnings.xcconfig b/macos/Runner/Configs/Warnings.xcconfig new file mode 100644 index 0000000..42bcbf4 --- /dev/null +++ b/macos/Runner/Configs/Warnings.xcconfig @@ -0,0 +1,13 @@ +WARNING_CFLAGS = -Wall -Wconditional-uninitialized -Wnullable-to-nonnull-conversion -Wmissing-method-return-type -Woverlength-strings +GCC_WARN_UNDECLARED_SELECTOR = YES +CLANG_UNDEFINED_BEHAVIOR_SANITIZER_NULLABILITY = YES +CLANG_WARN_UNGUARDED_AVAILABILITY = YES_AGGRESSIVE +CLANG_WARN__DUPLICATE_METHOD_MATCH = YES +CLANG_WARN_PRAGMA_PACK = YES +CLANG_WARN_STRICT_PROTOTYPES = YES +CLANG_WARN_COMMA = YES +GCC_WARN_STRICT_SELECTOR_MATCH = YES +CLANG_WARN_OBJC_REPEATED_USE_OF_WEAK = YES +CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES +GCC_WARN_SHADOW = YES +CLANG_WARN_UNREACHABLE_CODE = YES diff --git a/macos/Runner/DebugProfile.entitlements b/macos/Runner/DebugProfile.entitlements new file mode 100644 index 0000000..dddb8a3 --- /dev/null +++ b/macos/Runner/DebugProfile.entitlements @@ -0,0 +1,12 @@ + + + + + com.apple.security.app-sandbox + + com.apple.security.cs.allow-jit + + com.apple.security.network.server + + + diff --git a/macos/Runner/Info.plist b/macos/Runner/Info.plist new file mode 100644 index 0000000..4789daa --- /dev/null +++ b/macos/Runner/Info.plist @@ -0,0 +1,32 @@ + + + + + CFBundleDevelopmentRegion + $(DEVELOPMENT_LANGUAGE) + CFBundleExecutable + $(EXECUTABLE_NAME) + CFBundleIconFile + + CFBundleIdentifier + $(PRODUCT_BUNDLE_IDENTIFIER) + CFBundleInfoDictionaryVersion + 6.0 + CFBundleName + $(PRODUCT_NAME) + CFBundlePackageType + APPL + CFBundleShortVersionString + $(FLUTTER_BUILD_NAME) + CFBundleVersion + $(FLUTTER_BUILD_NUMBER) + LSMinimumSystemVersion + $(MACOSX_DEPLOYMENT_TARGET) + NSHumanReadableCopyright + $(PRODUCT_COPYRIGHT) + NSMainNibFile + MainMenu + NSPrincipalClass + NSApplication + + diff --git a/macos/Runner/MainFlutterWindow.swift b/macos/Runner/MainFlutterWindow.swift new file mode 100644 index 0000000..3cc05eb --- /dev/null +++ b/macos/Runner/MainFlutterWindow.swift @@ -0,0 +1,15 @@ +import Cocoa +import FlutterMacOS + +class MainFlutterWindow: NSWindow { + override func awakeFromNib() { + let flutterViewController = FlutterViewController() + let windowFrame = self.frame + self.contentViewController = flutterViewController + self.setFrame(windowFrame, display: true) + + RegisterGeneratedPlugins(registry: flutterViewController) + + super.awakeFromNib() + } +} diff --git a/macos/Runner/Release.entitlements b/macos/Runner/Release.entitlements new file mode 100644 index 0000000..852fa1a --- /dev/null +++ b/macos/Runner/Release.entitlements @@ -0,0 +1,8 @@ + + + + + com.apple.security.app-sandbox + + + diff --git a/macos/RunnerTests/RunnerTests.swift b/macos/RunnerTests/RunnerTests.swift new file mode 100644 index 0000000..61f3bd1 --- /dev/null +++ b/macos/RunnerTests/RunnerTests.swift @@ -0,0 +1,12 @@ +import Cocoa +import FlutterMacOS +import XCTest + +class RunnerTests: XCTestCase { + + func testExample() { + // If you add code to the Runner application, consider adding tests here. + // See https://developer.apple.com/documentation/xctest for more information about using XCTest. + } + +} diff --git a/pubspec.lock b/pubspec.lock index 31a1964..4bac05b 100644 --- a/pubspec.lock +++ b/pubspec.lock @@ -1,90 +1,102 @@ # Generated by pub # See https://dart.dev/tools/pub/glossary#lockfile packages: - archive: - dependency: transitive - description: - name: archive - url: "https://pub.dartlang.org" - source: hosted - version: "2.0.11" - args: - dependency: transitive - description: - name: args - url: "https://pub.dartlang.org" - source: hosted - version: "1.5.2" async: dependency: transitive description: name: async - url: "https://pub.dartlang.org" + sha256: "947bfcf187f74dbc5e146c9eb9c0f10c9f8b30743e341481c1e2ed3ecc18c20c" + url: "https://pub.dev" source: hosted - version: "2.4.0" + version: "2.11.0" bloc: dependency: transitive description: name: bloc - url: "https://pub.dartlang.org" + sha256: "106842ad6569f0b60297619e9e0b1885c2fb9bf84812935490e6c5275777804e" + url: "https://pub.dev" source: hosted - version: "3.0.0" + version: "8.1.4" boolean_selector: dependency: transitive description: name: boolean_selector - url: "https://pub.dartlang.org" + sha256: "6cfb5af12253eaf2b368f07bacc5a80d1301a071c73360d746b7f2e32d762c66" + url: "https://pub.dev" source: hosted - version: "1.0.5" - charcode: - dependency: transitive - description: - name: charcode - url: "https://pub.dartlang.org" - source: hosted - version: "1.1.2" - collection: + version: "2.1.1" + characters: dependency: transitive description: - name: collection - url: "https://pub.dartlang.org" + name: characters + sha256: "04a925763edad70e8443c99234dc3328f442e811f1d8fd1a72f1c8ad0f69a605" + url: "https://pub.dev" source: hosted - version: "1.14.11" - convert: + version: "1.3.0" + clock: dependency: transitive description: - name: convert - url: "https://pub.dartlang.org" + name: clock + sha256: cb6d7f03e1de671e34607e909a7213e31d7752be4fb66a86d29fe1eb14bfb5cf + url: "https://pub.dev" source: hosted - version: "2.1.1" - crypto: + version: "1.1.1" + collection: dependency: transitive description: - name: crypto - url: "https://pub.dartlang.org" + name: collection + sha256: ee67cb0715911d28db6bf4af1026078bd6f0128b07a5f66fb2ed94ec6783c09a + url: "https://pub.dev" source: hosted - version: "2.1.3" + version: "1.18.0" dartz: dependency: "direct main" description: name: dartz - url: "https://pub.dartlang.org" + sha256: e6acf34ad2e31b1eb00948692468c30ab48ac8250e0f0df661e29f12dd252168 + url: "https://pub.dev" source: hosted - version: "0.8.9" - data_connection_checker: + version: "0.10.1" + data_connection_checker_tv: dependency: "direct main" description: - name: data_connection_checker - url: "https://pub.dartlang.org" + name: data_connection_checker_tv + sha256: "92b89e4fa223d905db5a1a19be55954a9556210adf02d81f2c0817350de69023" + url: "https://pub.dev" source: hosted - version: "0.3.4" + version: "0.3.5-nullsafety" equatable: dependency: "direct main" description: name: equatable - url: "https://pub.dartlang.org" + sha256: c2b87cb7756efdf69892005af546c56c0b5037f54d2a88269b4f347a505e3ca2 + url: "https://pub.dev" source: hosted - version: "1.0.1" + version: "2.0.5" + fake_async: + dependency: transitive + description: + name: fake_async + sha256: "511392330127add0b769b75a987850d136345d9227c6b94c96a04cf4a391bf78" + url: "https://pub.dev" + source: hosted + version: "1.3.1" + ffi: + dependency: transitive + description: + name: ffi + sha256: "493f37e7df1804778ff3a53bd691d8692ddf69702cf4c1c1096a2e41b4779e21" + url: "https://pub.dev" + source: hosted + version: "2.1.2" + file: + dependency: transitive + description: + name: file + sha256: "5fc22d7c25582e38ad9a8515372cd9a93834027aacf1801cf01164dac0ffa08c" + url: "https://pub.dev" + source: hosted + version: "7.0.0" flutter: dependency: "direct main" description: flutter @@ -94,9 +106,10 @@ packages: dependency: "direct main" description: name: flutter_bloc - url: "https://pub.dartlang.org" + sha256: b594505eac31a0518bdcb4b5b79573b8d9117b193cc80cc12e17d639b10aa27a + url: "https://pub.dev" source: hosted - version: "3.0.0" + version: "8.1.6" flutter_test: dependency: "direct dev" description: flutter @@ -111,128 +124,202 @@ packages: dependency: "direct main" description: name: get_it - url: "https://pub.dartlang.org" + sha256: d85128a5dae4ea777324730dc65edd9c9f43155c109d5cc0a69cab74139fbac1 + url: "https://pub.dev" source: hosted - version: "3.1.0" + version: "7.7.0" http: dependency: "direct main" description: name: http - url: "https://pub.dartlang.org" + sha256: b9c29a161230ee03d3ccf545097fccd9b87a5264228c5d348202e0f0c28f9010 + url: "https://pub.dev" source: hosted - version: "0.12.0+3" + version: "1.2.2" http_parser: dependency: transitive description: name: http_parser - url: "https://pub.dartlang.org" + sha256: "2aa08ce0341cc9b354a498388e30986515406668dbcc4f7c950c3e715496693b" + url: "https://pub.dev" source: hosted - version: "3.1.3" - image: + version: "4.0.2" + leak_tracker: dependency: transitive description: - name: image - url: "https://pub.dartlang.org" + name: leak_tracker + sha256: "7f0df31977cb2c0b88585095d168e689669a2cc9b97c309665e3386f3e9d341a" + url: "https://pub.dev" source: hosted - version: "2.1.4" + version: "10.0.4" + leak_tracker_flutter_testing: + dependency: transitive + description: + name: leak_tracker_flutter_testing + sha256: "06e98f569d004c1315b991ded39924b21af84cf14cc94791b8aea337d25b57f8" + url: "https://pub.dev" + source: hosted + version: "3.0.3" + leak_tracker_testing: + dependency: transitive + description: + name: leak_tracker_testing + sha256: "6ba465d5d76e67ddf503e1161d1f4a6bc42306f9d66ca1e8f079a47290fb06d3" + url: "https://pub.dev" + source: hosted + version: "3.0.1" matcher: dependency: transitive description: name: matcher - url: "https://pub.dartlang.org" + sha256: d2323aa2060500f906aa31a895b4030b6da3ebdcc5619d14ce1aada65cd161cb + url: "https://pub.dev" source: hosted - version: "0.12.6" + version: "0.12.16+1" + material_color_utilities: + dependency: transitive + description: + name: material_color_utilities + sha256: "0e0a020085b65b6083975e499759762399b4475f766c21668c4ecca34ea74e5a" + url: "https://pub.dev" + source: hosted + version: "0.8.0" meta: dependency: transitive description: name: meta - url: "https://pub.dartlang.org" + sha256: "7687075e408b093f36e6bbf6c91878cc0d4cd10f409506f7bc996f68220b9136" + url: "https://pub.dev" source: hosted - version: "1.1.8" - mockito: + version: "1.12.0" + mocktail: dependency: "direct dev" description: - name: mockito - url: "https://pub.dartlang.org" + name: mocktail + sha256: "890df3f9688106f25755f26b1c60589a92b3ab91a22b8b224947ad041bf172d8" + url: "https://pub.dev" source: hosted - version: "4.1.1" + version: "1.0.4" nested: dependency: transitive description: name: nested - url: "https://pub.dartlang.org" + sha256: "03bac4c528c64c95c722ec99280375a6f2fc708eec17c7b3f07253b626cd2a20" + url: "https://pub.dev" source: hosted - version: "0.0.4" + version: "1.0.0" path: dependency: transitive description: name: path - url: "https://pub.dartlang.org" + sha256: "087ce49c3f0dc39180befefc60fdb4acd8f8620e5682fe2476afd0b3688bb4af" + url: "https://pub.dev" source: hosted - version: "1.6.4" - pedantic: + version: "1.9.0" + path_provider_linux: dependency: transitive description: - name: pedantic - url: "https://pub.dartlang.org" + name: path_provider_linux + sha256: f7a1fe3a634fe7734c8d3f2766ad746ae2a2884abe22e241a8b301bf5cac3279 + url: "https://pub.dev" source: hosted - version: "1.8.0+1" - petitparser: + version: "2.2.1" + path_provider_platform_interface: dependency: transitive description: - name: petitparser - url: "https://pub.dartlang.org" + name: path_provider_platform_interface + sha256: "88f5779f72ba699763fa3a3b06aa4bf6de76c8e5de842cf6f29e2e06476c2334" + url: "https://pub.dev" source: hosted - version: "2.4.0" - provider: + version: "2.1.2" + path_provider_windows: dependency: transitive description: - name: provider - url: "https://pub.dartlang.org" + name: path_provider_windows + sha256: bd6f00dbd873bfb70d0761682da2b3a2c2fccc2b9e84c495821639601d81afe7 + url: "https://pub.dev" source: hosted - version: "4.0.1" - quiver: + version: "2.3.0" + platform: dependency: transitive description: - name: quiver - url: "https://pub.dartlang.org" + name: platform + sha256: "9b71283fc13df574056616011fb138fd3b793ea47cc509c189a6c3fa5f8a1a65" + url: "https://pub.dev" source: hosted - version: "2.0.5" - rxdart: + version: "3.1.5" + plugin_platform_interface: dependency: transitive description: - name: rxdart - url: "https://pub.dartlang.org" + name: plugin_platform_interface + sha256: "4820fbfdb9478b1ebae27888254d445073732dae3d6ea81f0b7e06d5dedc3f02" + url: "https://pub.dev" source: hosted - version: "0.23.1" + version: "2.1.8" + provider: + dependency: transitive + description: + name: provider + sha256: c8a055ee5ce3fd98d6fc872478b03823ffdb448699c6ebdbbc71d59b596fd48c + url: "https://pub.dev" + source: hosted + version: "6.1.2" shared_preferences: dependency: "direct main" description: name: shared_preferences - url: "https://pub.dartlang.org" + sha256: "746e5369a43170c25816cc472ee016d3a66bc13fcf430c0bc41ad7b4b2922051" + url: "https://pub.dev" + source: hosted + version: "2.3.2" + shared_preferences_android: + dependency: transitive + description: + name: shared_preferences_android + sha256: "041be4d9d2dc6079cf342bc8b761b03787e3b71192d658220a56cac9c04a0294" + url: "https://pub.dev" source: hosted - version: "0.5.6" - shared_preferences_macos: + version: "2.3.0" + shared_preferences_foundation: dependency: transitive description: - name: shared_preferences_macos - url: "https://pub.dartlang.org" + name: shared_preferences_foundation + sha256: "671e7a931f55a08aa45be2a13fe7247f2a41237897df434b30d2012388191833" + url: "https://pub.dev" source: hosted - version: "0.0.1+3" + version: "2.5.0" + shared_preferences_linux: + dependency: transitive + description: + name: shared_preferences_linux + sha256: "2ba0510d3017f91655b7543e9ee46d48619de2a2af38e5c790423f7007c7ccc1" + url: "https://pub.dev" + source: hosted + version: "2.4.0" shared_preferences_platform_interface: dependency: transitive description: name: shared_preferences_platform_interface - url: "https://pub.dartlang.org" + sha256: "57cbf196c486bc2cf1f02b85784932c6094376284b3ad5779d1b1c6c6a816b80" + url: "https://pub.dev" source: hosted - version: "1.0.1" + version: "2.4.1" shared_preferences_web: dependency: transitive description: name: shared_preferences_web - url: "https://pub.dartlang.org" + sha256: "59dc807b94d29d52ddbb1b3c0d3b9d0a67fc535a64e62a5542c8db0513fcb6c2" + url: "https://pub.dev" + source: hosted + version: "2.4.1" + shared_preferences_windows: + dependency: transitive + description: + name: shared_preferences_windows + sha256: "398084b47b7f92110683cac45c6dc4aae853db47e470e5ddcd52cab7f7196ab2" + url: "https://pub.dev" source: hosted - version: "0.1.2+2" + version: "2.4.0" sky_engine: dependency: transitive description: flutter @@ -242,65 +329,98 @@ packages: dependency: transitive description: name: source_span - url: "https://pub.dartlang.org" + sha256: "53e943d4206a5e30df338fd4c6e7a077e02254531b138a15aec3bd143c1a8b3c" + url: "https://pub.dev" source: hosted - version: "1.5.5" + version: "1.10.0" stack_trace: dependency: transitive description: name: stack_trace - url: "https://pub.dartlang.org" + sha256: "73713990125a6d93122541237550ee3352a2d84baad52d375a4cad2eb9b7ce0b" + url: "https://pub.dev" source: hosted - version: "1.9.3" + version: "1.11.1" stream_channel: dependency: transitive description: name: stream_channel - url: "https://pub.dartlang.org" + sha256: ba2aa5d8cc609d96bbb2899c28934f9e1af5cddbd60a827822ea467161eb54e7 + url: "https://pub.dev" source: hosted - version: "2.0.0" + version: "2.1.2" string_scanner: dependency: transitive description: name: string_scanner - url: "https://pub.dartlang.org" + sha256: "556692adab6cfa87322a115640c11f13cb77b3f076ddcc5d6ae3c20242bedcde" + url: "https://pub.dev" source: hosted - version: "1.0.5" + version: "1.2.0" term_glyph: dependency: transitive description: name: term_glyph - url: "https://pub.dartlang.org" + sha256: a29248a84fbb7c79282b40b8c72a1209db169a2e0542bce341da992fe1bc7e84 + url: "https://pub.dev" source: hosted - version: "1.1.0" + version: "1.2.1" test_api: dependency: transitive description: name: test_api - url: "https://pub.dartlang.org" + sha256: "9955ae474176f7ac8ee4e989dadfb411a58c30415bcfb648fa04b2b8a03afa7f" + url: "https://pub.dev" source: hosted - version: "0.2.11" + version: "0.7.0" typed_data: dependency: transitive description: name: typed_data - url: "https://pub.dartlang.org" + sha256: facc8d6582f16042dd49f2463ff1bd6e2c9ef9f3d5da3d9b087e244a7b564b3c + url: "https://pub.dev" source: hosted - version: "1.1.6" + version: "1.3.2" vector_math: dependency: transitive description: name: vector_math - url: "https://pub.dartlang.org" + sha256: "80b3257d1492ce4d091729e3a67a60407d227c27241d6927be0130c98e741803" + url: "https://pub.dev" + source: hosted + version: "2.1.4" + very_good_analysis: + dependency: "direct main" + description: + name: very_good_analysis + sha256: "1fb637c0022034b1f19ea2acb42a3603cbd8314a470646a59a2fb01f5f3a8629" + url: "https://pub.dev" + source: hosted + version: "6.0.0" + vm_service: + dependency: transitive + description: + name: vm_service + sha256: "3923c89304b715fb1eb6423f017651664a03bf5f4b29983627c4da791f74a4ec" + url: "https://pub.dev" + source: hosted + version: "14.2.1" + web: + dependency: transitive + description: + name: web + sha256: d43c1d6b787bf0afad444700ae7f4db8827f701bc61c255ac8d328c6f4d52062 + url: "https://pub.dev" source: hosted - version: "2.0.8" - xml: + version: "1.0.0" + xdg_directories: dependency: transitive description: - name: xml - url: "https://pub.dartlang.org" + name: xdg_directories + sha256: faea9dee56b520b55a566385b84f2e8de55e7496104adada9962e0bd11bcff1d + url: "https://pub.dev" source: hosted - version: "3.5.0" + version: "1.0.4" sdks: - dart: ">=2.6.0 <3.0.0" - flutter: ">=1.12.13+hotfix.4 <2.0.0" + dart: ">=3.4.3 <4.0.0" + flutter: ">=3.22.0" diff --git a/pubspec.yaml b/pubspec.yaml index dcdb532..2813d18 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -1,32 +1,49 @@ name: clean_architecture_tdd_course -description: TDD Clean Architecture for Flutter - +description: "A project implement clean architecture using TDD approach" +publish_to: "none" version: 1.0.0+1 environment: - sdk: '>=2.6.0 <3.0.0' + sdk: ">=3.4.3 <4.0.0" dependencies: + # Functional programming thingies + dartz: ^0.10.1 + # Network connectivity + data_connection_checker_tv: ^0.3.5-nullsafety + # Value equality + equatable: ^2.0.5 + # Flutter sdk flutter: sdk: flutter - # Service locator - get_it: ^3.1.0 # Bloc for state management - flutter_bloc: ^3.0.0 - # Value equality - equatable: ^1.0.1 - # Functional programming thingies - dartz: ^0.8.9 + flutter_bloc: ^8.1.6 + # Service locator + get_it: ^7.7.0 # Remote API - data_connection_checker: ^0.3.4 - http: ^0.12.0+3 + http: ^1.2.2 # Local cache - shared_preferences: ^0.5.6 + shared_preferences: ^2.3.2 + # Code analysis + very_good_analysis: ^6.0.0 + + dev_dependencies: flutter_test: sdk: flutter - mockito: ^4.1.1 + mocktail: ^1.0.4 flutter: uses-material-design: true + + + assets: + - assets/images/background.png + + fonts: + - family: Poppins + fonts: + - asset: assets/fonts/Poppins-Regular.ttf + - asset: assets/fonts/Poppins-Bold.ttf + weight: 700 \ No newline at end of file diff --git a/test/core/.gitkeep b/test/core/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/test/core/error/.gitkeep b/test/core/error/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/test/core/network/network_info_test.dart b/test/core/network/network_info_test.dart index 3cb59e2..bd87e86 100644 --- a/test/core/network/network_info_test.dart +++ b/test/core/network/network_info_test.dart @@ -1,13 +1,13 @@ import 'package:clean_architecture_tdd_course/core/network/network_info.dart'; -import 'package:mockito/mockito.dart'; +import 'package:data_connection_checker_tv/data_connection_checker.dart'; import 'package:flutter_test/flutter_test.dart'; -import 'package:data_connection_checker/data_connection_checker.dart'; +import 'package:mocktail/mocktail.dart'; class MockDataConnectionChecker extends Mock implements DataConnectionChecker {} void main() { - NetworkInfoImpl networkInfo; - MockDataConnectionChecker mockDataConnectionChecker; + late NetworkInfoImpl networkInfo; + late MockDataConnectionChecker mockDataConnectionChecker; setUp(() { mockDataConnectionChecker = MockDataConnectionChecker(); @@ -15,20 +15,19 @@ void main() { }); group('isConnected', () { - test( - 'should forward the call to DataConnectionChecker.hasConnection', - () async { - // arrange - final tHasConnectionFuture = Future.value(true); + test('should forward the call to DataConnectionChecker.hasConnection', + () async { + // arrange + final tHasConnectionFuture = Future.value(true); + when(() => mockDataConnectionChecker.hasConnection) + .thenAnswer((_) => tHasConnectionFuture); - when(mockDataConnectionChecker.hasConnection) - .thenAnswer((_) => tHasConnectionFuture); - // act - final result = networkInfo.isConnected; - // assert - verify(mockDataConnectionChecker.hasConnection); - expect(result, tHasConnectionFuture); - }, - ); + // act + final result = networkInfo.isConnected; + + // assert + verify(() => mockDataConnectionChecker.hasConnection); + expect(result, tHasConnectionFuture); + }); }); } diff --git a/test/core/usecases/.gitkeep b/test/core/usecases/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/test/core/util/input_converter_test.dart b/test/core/util/input_converter_test.dart index 78c18e8..b4d2d40 100644 --- a/test/core/util/input_converter_test.dart +++ b/test/core/util/input_converter_test.dart @@ -1,9 +1,9 @@ -import 'package:clean_architecture_tdd_course/core/util/input_converter.dart'; +import 'package:clean_architecture_tdd_course/core/utils/input_converter.dart'; import 'package:dartz/dartz.dart'; import 'package:flutter_test/flutter_test.dart'; void main() { - InputConverter inputConverter; + late InputConverter inputConverter; setUp(() { inputConverter = InputConverter(); @@ -11,39 +11,38 @@ void main() { group('stringToUnsignedInt', () { test( - 'should return an integer when the string represents an unsigned integer', - () async { - // arrange - final str = '123'; - // act - final result = inputConverter.stringToUnsignedInteger(str); - // assert - expect(result, Right(123)); - }, - ); + 'should return an integer when the string represents an unsigned ' + 'integer', () { + // arrange + const str = '123'; - test( - 'should return a Failure when the string is not an integer', - () async { - // arrange - final str = 'abc'; - // act - final result = inputConverter.stringToUnsignedInteger(str); - // assert - expect(result, Left(InvalidInputFailure())); - }, - ); + // act + final result = inputConverter.stringToUnsignedInteger(str); - test( - 'should return a Failure when the string is a negative integer', - () async { - // arrange - final str = '-123'; - // act - final result = inputConverter.stringToUnsignedInteger(str); - // assert - expect(result, Left(InvalidInputFailure())); - }, - ); + // assert + expect(result, const Right(123)); + }); + + test('should return a Failure when the string is not an integer', () { + // arrange + const str = 'abc'; + + // act + final result = inputConverter.stringToUnsignedInteger(str); + + // assert + expect(result, Left(InvalidInputFailure())); + }); + + test('should return a Failure when the string is negative integer', () { + // arrange + const str = '-123'; + + // act + final result = inputConverter.stringToUnsignedInteger(str); + + // assert + expect(result, Left(InvalidInputFailure())); + }); }); } diff --git a/test/features/.gitkeep b/test/features/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/test/features/number_trivia/data/.gitkeep b/test/features/number_trivia/data/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/test/features/number_trivia/data/datasources/.gitkeep b/test/features/number_trivia/data/datasources/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/test/features/number_trivia/data/datasources/number_trivia_local_data_source_test.dart b/test/features/number_trivia/data/datasources/number_trivia_local_data_source_test.dart index 9ad69b1..305da7b 100644 --- a/test/features/number_trivia/data/datasources/number_trivia_local_data_source_test.dart +++ b/test/features/number_trivia/data/datasources/number_trivia_local_data_source_test.dart @@ -1,75 +1,79 @@ import 'dart:convert'; - import 'package:clean_architecture_tdd_course/core/error/exceptions.dart'; +import 'package:clean_architecture_tdd_course/core/utils/app_strings.dart'; import 'package:clean_architecture_tdd_course/features/number_trivia/data/datasources/number_trivia_local_data_source.dart'; import 'package:clean_architecture_tdd_course/features/number_trivia/data/models/number_trivia_model.dart'; -import 'package:mockito/mockito.dart'; import 'package:flutter_test/flutter_test.dart'; +import 'package:mocktail/mocktail.dart'; import 'package:shared_preferences/shared_preferences.dart'; -import 'package:matcher/matcher.dart'; - import '../../../../fixtures/fixture_reader.dart'; -class MockSharedPreferences extends Mock implements SharedPreferences {} +class MockSharedPrefernces extends Mock implements SharedPreferences {} void main() { - NumberTriviaLocalDataSourceImpl dataSource; - MockSharedPreferences mockSharedPreferences; + late NumberTriviaLocalDataSourceImpl dataSource; + late MockSharedPrefernces mockSharedPreferences; setUp(() { - mockSharedPreferences = MockSharedPreferences(); + mockSharedPreferences = MockSharedPrefernces(); dataSource = NumberTriviaLocalDataSourceImpl( sharedPreferences: mockSharedPreferences, ); }); group('getLastNumberTrivia', () { - final tNumberTriviaModel = - NumberTriviaModel.fromJson(json.decode(fixture('trivia_cached.json'))); - - test( - 'should return NumberTrivia from SharedPreferences when there is one in the cache', - () async { - // arrange - when(mockSharedPreferences.getString(any)) - .thenReturn(fixture('trivia_cached.json')); - // act - final result = await dataSource.getLastNumberTrivia(); - // assert - verify(mockSharedPreferences.getString(CACHED_NUMBER_TRIVIA)); - expect(result, equals(tNumberTriviaModel)); - }, + final tNumberTrivia = NumberTriviaModel.fromJson( + json.decode(fixture('trivia_cached.json')) as Map, ); test( - 'should throw a CacheExeption when there is not a cached value', - () async { - // arrange - when(mockSharedPreferences.getString(any)).thenReturn(null); - // act - final call = dataSource.getLastNumberTrivia; - // assert - expect(() => call(), throwsA(TypeMatcher())); - }, - ); + 'should return NumberTrivia from SharedPrefernces when there is one in ' + 'cache', () async { + // arrange + when(() => mockSharedPreferences.getString(any())) + .thenReturn(fixture('trivia_cached.json')); + + // act + final result = await dataSource.getLastNumberTrivia(); + + // assert + verify(() => mockSharedPreferences.getString(cachedNumberTrivia)); + expect(result, tNumberTrivia); + }); + + test('should throw a CacheException when there is not a cached value', + () async { + // arrange + when(() => mockSharedPreferences.getString(any())).thenReturn(null); + + // act + final call = dataSource.getLastNumberTrivia; + + // assert + expect(call, throwsA(const TypeMatcher())); + }); }); group('cacheNumberTrivia', () { - final tNumberTriviaModel = - NumberTriviaModel(number: 1, text: 'test trivia'); + const tNumberTriviaModel = + NumberTriviaModel(text: 'test trivia', number: 1); - test( - 'should call SharedPreferences to cache the data', - () async { - // act - dataSource.cacheNumberTrivia(tNumberTriviaModel); - // assert - final expectedJsonString = json.encode(tNumberTriviaModel.toJson()); - verify(mockSharedPreferences.setString( - CACHED_NUMBER_TRIVIA, + test('should call SharedPreferences to cache the data', () async { + // arrange + final expectedJsonString = json.encode(tNumberTriviaModel.toJson()); + when(() => mockSharedPreferences.setString(any(), any())) + .thenAnswer((_) async => true); // Mock the return type of setString() + + // act + await dataSource.cacheNumberTrivia(tNumberTriviaModel); + + // assert + verify( + () => mockSharedPreferences.setString( + cachedNumberTrivia, expectedJsonString, - )); - }, - ); + ), + ); + }); }); } diff --git a/test/features/number_trivia/data/datasources/number_trivia_remote_data_source_test.dart b/test/features/number_trivia/data/datasources/number_trivia_remote_data_source_test.dart index 9e1e3f5..b704306 100644 --- a/test/features/number_trivia/data/datasources/number_trivia_remote_data_source_test.dart +++ b/test/features/number_trivia/data/datasources/number_trivia_remote_data_source_test.dart @@ -1,128 +1,131 @@ import 'dart:convert'; - import 'package:clean_architecture_tdd_course/core/error/exceptions.dart'; import 'package:clean_architecture_tdd_course/features/number_trivia/data/datasources/number_trivia_remote_data_source.dart'; import 'package:clean_architecture_tdd_course/features/number_trivia/data/models/number_trivia_model.dart'; -import 'package:mockito/mockito.dart'; import 'package:flutter_test/flutter_test.dart'; -import 'package:matcher/matcher.dart'; import 'package:http/http.dart' as http; - +import 'package:mocktail/mocktail.dart'; import '../../../../fixtures/fixture_reader.dart'; class MockHttpClient extends Mock implements http.Client {} void main() { - NumberTriviaRemoteDataSourceImpl dataSource; - MockHttpClient mockHttpClient; + late NumberTriviaRemoteDataSourceImpl dataSource; + late MockHttpClient mockHttpClient; setUp(() { mockHttpClient = MockHttpClient(); dataSource = NumberTriviaRemoteDataSourceImpl(client: mockHttpClient); }); - void setUpMockHttpClientSuccess200() { - when(mockHttpClient.get(any, headers: anyNamed('headers'))) + void setUpMockHttpClientSuccess200(Uri url) { + when(() => mockHttpClient.get(url, headers: any(named: 'headers'))) .thenAnswer((_) async => http.Response(fixture('trivia.json'), 200)); } - void setUpMockHttpClientFailure404() { - when(mockHttpClient.get(any, headers: anyNamed('headers'))) + void setUpMockHttpClientFailure404(Uri url) { + when(() => mockHttpClient.get(url, headers: any(named: 'headers'))) .thenAnswer((_) async => http.Response('Something went wrong', 404)); } group('getConcreteNumberTrivia', () { - final tNumber = 1; - final tNumberTriviaModel = - NumberTriviaModel.fromJson(json.decode(fixture('trivia.json'))); - - test( - '''should perform a GET request on a URL with number - being the endpoint and with application/json header''', - () async { - // arrange - setUpMockHttpClientSuccess200(); - // act - dataSource.getConcreteNumberTrivia(tNumber); - // assert - verify(mockHttpClient.get( - 'http://numbersapi.com/$tNumber', - headers: { - 'Content-Type': 'application/json', - }, - )); - }, + const tNumber = 1; + final tNumberTriviaModel = NumberTriviaModel.fromJson( + json.decode(fixture('trivia.json')) as Map, ); + final url = Uri.parse('http://numbersapi.com/$tNumber'); test( - 'should return NumberTrivia when the response code is 200 (success)', - () async { - // arrange - setUpMockHttpClientSuccess200(); - // act - final result = await dataSource.getConcreteNumberTrivia(tNumber); - // assert - expect(result, equals(tNumberTriviaModel)); - }, - ); + 'should perform a GET request on a URL with number ' + 'being the endpoint and with application/json header', () async { + // arrange + when(() => mockHttpClient.get(url, headers: any(named: 'headers'))) + .thenAnswer((_) async => http.Response(fixture('trivia.json'), 200)); + + // act + await dataSource.getConcreteNumberTrivia(tNumber); + + // assert + verify( + () => mockHttpClient + .get(url, headers: {'Content-Type': 'application/json'}), + ); + }); + + test('should return NumberTrivia when the response code is 200 (success)', + () async { + // arrange + setUpMockHttpClientSuccess200(url); + + // act + final result = await dataSource.getConcreteNumberTrivia(tNumber); + + // assert + expect(result, equals(tNumberTriviaModel)); + }); test( - 'should throw a ServerException when the response code is 404 or other', - () async { - // arrange - setUpMockHttpClientFailure404(); - // act - final call = dataSource.getConcreteNumberTrivia; - // assert - expect(() => call(tNumber), throwsA(TypeMatcher())); - }, - ); + 'should throw a ServerException when the response code is 404 or other', + () async { + // arrange + setUpMockHttpClientFailure404(url); + + // act + final call = dataSource.getConcreteNumberTrivia; + + // assert + expect( + () => call(tNumber), + throwsA(const TypeMatcher()), + ); + }); }); group('getRandomNumberTrivia', () { - final tNumberTriviaModel = - NumberTriviaModel.fromJson(json.decode(fixture('trivia.json'))); - - test( - '''should perform a GET request on a URL with number - being the endpoint and with application/json header''', - () async { - // arrange - setUpMockHttpClientSuccess200(); - // act - dataSource.getRandomNumberTrivia(); - // assert - verify(mockHttpClient.get( - 'http://numbersapi.com/random', - headers: { - 'Content-Type': 'application/json', - }, - )); - }, + final tNumberTriviaModel = NumberTriviaModel.fromJson( + json.decode(fixture('trivia.json')) as Map, ); + final url = Uri.parse('http://numbersapi.com/random'); test( - 'should return NumberTrivia when the response code is 200 (success)', - () async { - // arrange - setUpMockHttpClientSuccess200(); - // act - final result = await dataSource.getRandomNumberTrivia(); - // assert - expect(result, equals(tNumberTriviaModel)); - }, - ); + 'should perform a GET request on a URL with number ' + 'being the endpoint and with application/json header', () async { + // arrange + setUpMockHttpClientSuccess200(url); + + // act + await dataSource.getRandomNumberTrivia(); + + // assert + verify( + () => mockHttpClient + .get(url, headers: {'Content-Type': 'application/json'}), + ); + }); + + test('should return NumberTrivia when the response code is 200 (success)', + () async { + // arrange + setUpMockHttpClientSuccess200(url); + + // act + final result = await dataSource.getRandomNumberTrivia(); + + // assert + expect(result, equals(tNumberTriviaModel)); + }); test( - 'should throw a ServerException when the response code is 404 or other', - () async { - // arrange - setUpMockHttpClientFailure404(); - // act - final call = dataSource.getRandomNumberTrivia; - // assert - expect(() => call(), throwsA(TypeMatcher())); - }, - ); + 'should throw a ServerException when the response code is 404 or other', + () async { + // arrange + setUpMockHttpClientFailure404(url); + + // act + final call = dataSource.getRandomNumberTrivia; + + // assert + expect(call, throwsA(const TypeMatcher())); + }); }); } diff --git a/test/features/number_trivia/data/models/.gitkeep b/test/features/number_trivia/data/models/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/test/features/number_trivia/data/models/number_trivia_model_test.dart b/test/features/number_trivia/data/models/number_trivia_model_test.dart index 605f710..0d4b89b 100644 --- a/test/features/number_trivia/data/models/number_trivia_model_test.dart +++ b/test/features/number_trivia/data/models/number_trivia_model_test.dart @@ -1,63 +1,56 @@ import 'dart:convert'; - import 'package:clean_architecture_tdd_course/features/number_trivia/data/models/number_trivia_model.dart'; import 'package:clean_architecture_tdd_course/features/number_trivia/domain/entities/number_trivia.dart'; import 'package:flutter_test/flutter_test.dart'; - import '../../../../fixtures/fixture_reader.dart'; void main() { - final tNumberTriviaModel = NumberTriviaModel(number: 1, text: 'Test Text'); + const tNumberTriviaModel = NumberTriviaModel(number: 1, text: 'Test text'); - test( - 'should be a subclass of NumberTrivia entity', - () async { - // assert - expect(tNumberTriviaModel, isA()); - }, - ); + test('should be a subclass of NumberTrivia entity', () { + // assert + expect(tNumberTriviaModel, isA()); + }); group('fromJson', () { - test( - 'should return a valid model when the JSON number is an integer', - () async { - // arrange - final Map jsonMap = - json.decode(fixture('trivia.json')); - // act - final result = NumberTriviaModel.fromJson(jsonMap); - // assert - expect(result, tNumberTriviaModel); - }, - ); + test('should return a valid model when the JSON number is an integer ', () { + // arrange + final jsonMap = + json.decode(fixture('trivia.json')) as Map; + + // act + final result = NumberTriviaModel.fromJson(jsonMap); + + // assert + expect(result, tNumberTriviaModel); + }); test( - 'should return a valid model when the JSON number is regarded as a double', - () async { - // arrange - final Map jsonMap = - json.decode(fixture('trivia_double.json')); - // act - final result = NumberTriviaModel.fromJson(jsonMap); - // assert - expect(result, tNumberTriviaModel); - }, - ); + 'should return a valid model when the JSON number is regarded as ' + ' a double', () { + // arrange + final jsonMap = + json.decode(fixture('trivia_double.json')) as Map; + + // act + final result = NumberTriviaModel.fromJson(jsonMap); + + // assert + expect(result, tNumberTriviaModel); + }); }); group('toJson', () { - test( - 'should return a JSON map containing the proper data', - () async { - // act - final result = tNumberTriviaModel.toJson(); - // assert - final expectedMap = { - "text": "Test Text", - "number": 1, - }; - expect(result, expectedMap); - }, - ); + test('should return a JSON map containing the proper data', () { + // act + final result = tNumberTriviaModel.toJson(); + + // assert + final expectedMap = { + 'text': 'Test text', + 'number': 1, + }; + expect(result, expectedMap); + }); }); } diff --git a/test/features/number_trivia/data/repositories/.gitkeep b/test/features/number_trivia/data/repositories/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/test/features/number_trivia/data/repositories/number_trivia_repository_impl_test.dart b/test/features/number_trivia/data/repositories/number_trivia_repository_impl_test.dart index c4c9d61..01e2d8b 100644 --- a/test/features/number_trivia/data/repositories/number_trivia_repository_impl_test.dart +++ b/test/features/number_trivia/data/repositories/number_trivia_repository_impl_test.dart @@ -1,3 +1,4 @@ +// ignore_for_file: avoid_dynamic_calls import 'package:clean_architecture_tdd_course/core/error/exceptions.dart'; import 'package:clean_architecture_tdd_course/core/error/failures.dart'; import 'package:clean_architecture_tdd_course/core/network/network_info.dart'; @@ -7,8 +8,8 @@ import 'package:clean_architecture_tdd_course/features/number_trivia/data/models import 'package:clean_architecture_tdd_course/features/number_trivia/data/repositories/number_trivia_repository_impl.dart'; import 'package:clean_architecture_tdd_course/features/number_trivia/domain/entities/number_trivia.dart'; import 'package:dartz/dartz.dart'; -import 'package:mockito/mockito.dart'; import 'package:flutter_test/flutter_test.dart'; +import 'package:mocktail/mocktail.dart'; class MockRemoteDataSource extends Mock implements NumberTriviaRemoteDataSource {} @@ -18,10 +19,10 @@ class MockLocalDataSource extends Mock implements NumberTriviaLocalDataSource {} class MockNetworkInfo extends Mock implements NetworkInfo {} void main() { - NumberTriviaRepositoryImpl repository; - MockRemoteDataSource mockRemoteDataSource; - MockLocalDataSource mockLocalDataSource; - MockNetworkInfo mockNetworkInfo; + late NumberTriviaRepositoryImpl repository; + late MockRemoteDataSource mockRemoteDataSource; + late MockLocalDataSource mockLocalDataSource; + late MockNetworkInfo mockNetworkInfo; setUp(() { mockRemoteDataSource = MockRemoteDataSource(); @@ -37,7 +38,7 @@ void main() { void runTestsOnline(Function body) { group('device is online', () { setUp(() { - when(mockNetworkInfo.isConnected).thenAnswer((_) async => true); + when(() => mockNetworkInfo.isConnected).thenAnswer((_) async => true); }); body(); @@ -47,7 +48,7 @@ void main() { void runTestsOffline(Function body) { group('device is offline', () { setUp(() { - when(mockNetworkInfo.isConnected).thenAnswer((_) async => false); + when(() => mockNetworkInfo.isConnected).thenAnswer((_) async => false); }); body(); @@ -55,193 +56,231 @@ void main() { } group('getConcreteNumberTrivia', () { - final tNumber = 1; - final tNumberTriviaModel = - NumberTriviaModel(number: tNumber, text: 'test trivia'); - final NumberTrivia tNumberTrivia = tNumberTriviaModel; + const tNumber = 1; + const tNumberTriviaModel = + NumberTriviaModel(text: 'test trivia', number: tNumber); + const NumberTrivia tNumberTrivia = tNumberTriviaModel; test( 'should check if the device is online', () async { // arrange - when(mockNetworkInfo.isConnected).thenAnswer((_) async => true); + when(() => mockNetworkInfo.isConnected).thenAnswer((_) async => true); + when(() => mockRemoteDataSource.getConcreteNumberTrivia(tNumber)) + .thenAnswer((_) async => tNumberTriviaModel); + when(() => mockLocalDataSource.cacheNumberTrivia(tNumberTriviaModel)) + .thenAnswer((_) async {}); + // act - repository.getConcreteNumberTrivia(tNumber); + await repository.getConcreteNumberTrivia(tNumber); + // assert - verify(mockNetworkInfo.isConnected); + verify(() => mockNetworkInfo.isConnected); }, ); runTestsOnline(() { + /// Test message : should ------ (action) when ----- test( - 'should return remote data when the call to remote data source is successful', - () async { - // arrange - when(mockRemoteDataSource.getConcreteNumberTrivia(any)) - .thenAnswer((_) async => tNumberTriviaModel); - // act - final result = await repository.getConcreteNumberTrivia(tNumber); - // assert - verify(mockRemoteDataSource.getConcreteNumberTrivia(tNumber)); - expect(result, equals(Right(tNumberTrivia))); - }, - ); + 'should return remote data when the call to remote data source is ' + 'successful', () async { + // arrange + when(() => mockRemoteDataSource.getConcreteNumberTrivia(any())) + .thenAnswer((_) async => tNumberTriviaModel); + when(() => mockLocalDataSource.cacheNumberTrivia(tNumberTriviaModel)) + .thenAnswer((_) async {}); + + // act + final result = await repository.getConcreteNumberTrivia(tNumber); + + // assert + verify(() => mockRemoteDataSource.getConcreteNumberTrivia(tNumber)); + expect(result, equals(const Right(tNumberTrivia))); + }); test( - 'should cache the data locally when the call to remote data source is successful', + 'should cache the data locally when the call to remote data source is ' + 'successful', () async { // arrange - when(mockRemoteDataSource.getConcreteNumberTrivia(any)) + when(() => mockRemoteDataSource.getConcreteNumberTrivia(any())) .thenAnswer((_) async => tNumberTriviaModel); + when(() => mockLocalDataSource.cacheNumberTrivia(tNumberTriviaModel)) + .thenAnswer((_) async {}); + // act await repository.getConcreteNumberTrivia(tNumber); + // assert - verify(mockRemoteDataSource.getConcreteNumberTrivia(tNumber)); - verify(mockLocalDataSource.cacheNumberTrivia(tNumberTriviaModel)); + verify(() => mockRemoteDataSource.getConcreteNumberTrivia(tNumber)); + verify( + () => mockLocalDataSource.cacheNumberTrivia(tNumberTriviaModel), + ); }, ); test( - 'should return server failure when the call to remote data source is unsuccessful', - () async { - // arrange - when(mockRemoteDataSource.getConcreteNumberTrivia(any)) - .thenThrow(ServerException()); - // act - final result = await repository.getConcreteNumberTrivia(tNumber); - // assert - verify(mockRemoteDataSource.getConcreteNumberTrivia(tNumber)); - verifyZeroInteractions(mockLocalDataSource); - expect(result, equals(Left(ServerFailure()))); - }, - ); + 'should return server failure when the call to remote data source is ' + ' unsuccessful', () async { + // arrange + when(() => mockRemoteDataSource.getConcreteNumberTrivia(any())) + .thenThrow(ServerException()); + + // act + final result = await repository.getConcreteNumberTrivia(tNumber); + + // assert + verify(() => mockRemoteDataSource.getConcreteNumberTrivia(tNumber)); + verifyZeroInteractions(MockLocalDataSource()); + expect(result, equals(Left(ServerFailure()))); + }); }); runTestsOffline(() { test( - 'should return last locally cached data when the cached data is present', - () async { - // arrange - when(mockLocalDataSource.getLastNumberTrivia()) - .thenAnswer((_) async => tNumberTriviaModel); - // act - final result = await repository.getConcreteNumberTrivia(tNumber); - // assert - verifyZeroInteractions(mockRemoteDataSource); - verify(mockLocalDataSource.getLastNumberTrivia()); - expect(result, equals(Right(tNumberTrivia))); - }, - ); + 'should return last locally cached data when the cached data is ' + 'present ', () async { + // arrange + when(() => mockLocalDataSource.getLastNumberTrivia()) + .thenAnswer((_) async => tNumberTriviaModel); - test( - 'should return CacheFailure when there is no cached data present', - () async { - // arrange - when(mockLocalDataSource.getLastNumberTrivia()) - .thenThrow(CacheException()); - // act - final result = await repository.getConcreteNumberTrivia(tNumber); - // assert - verifyZeroInteractions(mockRemoteDataSource); - verify(mockLocalDataSource.getLastNumberTrivia()); - expect(result, equals(Left(CacheFailure()))); - }, - ); + // act + final result = await repository.getConcreteNumberTrivia(tNumber); + + // verify + verifyZeroInteractions(mockRemoteDataSource); + verify(() => mockLocalDataSource.getLastNumberTrivia()); + expect(result, const Right(tNumberTriviaModel)); + }); + + test('should return CacheFailure when no cached data present ', + () async { + // arrange + when(() => mockLocalDataSource.getLastNumberTrivia()) + .thenThrow(CacheException()); + + // act + final result = await repository.getConcreteNumberTrivia(tNumber); + + // verify + verifyZeroInteractions(mockRemoteDataSource); + verify(() => mockLocalDataSource.getLastNumberTrivia()); + expect(result, Left(CacheFailure())); + }); }); }); group('getRandomNumberTrivia', () { - final tNumberTriviaModel = - NumberTriviaModel(number: 123, text: 'test trivia'); - final NumberTrivia tNumberTrivia = tNumberTriviaModel; + const tNumberTriviaModel = + NumberTriviaModel(text: 'test trivia', number: 1); + const NumberTrivia tNumberTrivia = tNumberTriviaModel; test( 'should check if the device is online', () async { // arrange - when(mockNetworkInfo.isConnected).thenAnswer((_) async => true); + when(() => mockNetworkInfo.isConnected).thenAnswer((_) async => true); + when(() => mockRemoteDataSource.getRandomNumberTrivia()) + .thenAnswer((_) async => tNumberTriviaModel); + when(() => mockLocalDataSource.cacheNumberTrivia(tNumberTriviaModel)) + .thenAnswer((_) async {}); + // act - repository.getRandomNumberTrivia(); + await repository.getRandomNumberTrivia(); + // assert - verify(mockNetworkInfo.isConnected); + verify(() => mockNetworkInfo.isConnected); }, ); runTestsOnline(() { + // should ------ (action) when ----- test( - 'should return remote data when the call to remote data source is successful', - () async { - // arrange - when(mockRemoteDataSource.getRandomNumberTrivia()) - .thenAnswer((_) async => tNumberTriviaModel); - // act - final result = await repository.getRandomNumberTrivia(); - // assert - verify(mockRemoteDataSource.getRandomNumberTrivia()); - expect(result, equals(Right(tNumberTrivia))); - }, - ); + 'should return remote data when the call to remote data source is ' + 'successful', () async { + // arrange + when(() => mockRemoteDataSource.getRandomNumberTrivia()) + .thenAnswer((_) async => tNumberTriviaModel); + when(() => mockLocalDataSource.cacheNumberTrivia(tNumberTriviaModel)) + .thenAnswer((_) async {}); + + // act + final result = await repository.getRandomNumberTrivia(); + + // assert + verify(() => mockRemoteDataSource.getRandomNumberTrivia()); + expect(result, equals(const Right(tNumberTrivia))); + }); test( - 'should cache the data locally when the call to remote data source is successful', + 'should cache the data locally when the call to remote data source is ' + 'successful', () async { // arrange - when(mockRemoteDataSource.getRandomNumberTrivia()) + when(() => mockRemoteDataSource.getRandomNumberTrivia()) .thenAnswer((_) async => tNumberTriviaModel); + when(() => mockLocalDataSource.cacheNumberTrivia(tNumberTriviaModel)) + .thenAnswer((_) async {}); + // act await repository.getRandomNumberTrivia(); + // assert - verify(mockRemoteDataSource.getRandomNumberTrivia()); - verify(mockLocalDataSource.cacheNumberTrivia(tNumberTriviaModel)); + verify(() => mockRemoteDataSource.getRandomNumberTrivia()); + verify( + () => mockLocalDataSource.cacheNumberTrivia(tNumberTriviaModel), + ); }, ); test( - 'should return server failure when the call to remote data source is unsuccessful', - () async { - // arrange - when(mockRemoteDataSource.getRandomNumberTrivia()) - .thenThrow(ServerException()); - // act - final result = await repository.getRandomNumberTrivia(); - // assert - verify(mockRemoteDataSource.getRandomNumberTrivia()); - verifyZeroInteractions(mockLocalDataSource); - expect(result, equals(Left(ServerFailure()))); - }, - ); + 'should return server failure when the call to remote data source is ' + 'unsuccessful', () async { + // arrange + when(() => mockRemoteDataSource.getRandomNumberTrivia()) + .thenThrow(ServerException()); + + // act + final result = await repository.getRandomNumberTrivia(); + + // assert + verify(() => mockRemoteDataSource.getRandomNumberTrivia()); + verifyZeroInteractions(MockLocalDataSource()); + expect(result, equals(Left(ServerFailure()))); + }); }); runTestsOffline(() { test( - 'should return last locally cached data when the cached data is present', - () async { - // arrange - when(mockLocalDataSource.getLastNumberTrivia()) - .thenAnswer((_) async => tNumberTriviaModel); - // act - final result = await repository.getRandomNumberTrivia(); - // assert - verifyZeroInteractions(mockRemoteDataSource); - verify(mockLocalDataSource.getLastNumberTrivia()); - expect(result, equals(Right(tNumberTrivia))); - }, - ); + 'should return last locally cached data when the cached data is ' + 'present ', () async { + // arrange + when(() => mockLocalDataSource.getLastNumberTrivia()) + .thenAnswer((_) async => tNumberTriviaModel); - test( - 'should return CacheFailure when there is no cached data present', - () async { - // arrange - when(mockLocalDataSource.getLastNumberTrivia()) - .thenThrow(CacheException()); - // act - final result = await repository.getRandomNumberTrivia(); - // assert - verifyZeroInteractions(mockRemoteDataSource); - verify(mockLocalDataSource.getLastNumberTrivia()); - expect(result, equals(Left(CacheFailure()))); - }, - ); + // act + final result = await repository.getRandomNumberTrivia(); + + // verify + verifyZeroInteractions(mockRemoteDataSource); + verify(() => mockLocalDataSource.getLastNumberTrivia()); + expect(result, const Right(tNumberTriviaModel)); + }); + + test('should return CacheFailure when no cached data present ', + () async { + // arrange + when(() => mockLocalDataSource.getLastNumberTrivia()) + .thenThrow(CacheException()); + + // act + final result = await repository.getRandomNumberTrivia(); + + // verify + verifyZeroInteractions(mockRemoteDataSource); + verify(() => mockLocalDataSource.getLastNumberTrivia()); + expect(result, Left(CacheFailure())); + }); }); }); } diff --git a/test/features/number_trivia/domain/.gitkeep b/test/features/number_trivia/domain/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/test/features/number_trivia/domain/entities/.gitkeep b/test/features/number_trivia/domain/entities/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/test/features/number_trivia/domain/repositories/.gitkeep b/test/features/number_trivia/domain/repositories/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/test/features/number_trivia/domain/usecases/.gitkeep b/test/features/number_trivia/domain/usecases/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/test/features/number_trivia/domain/usecases/get_concrete_number_trivia_test.dart b/test/features/number_trivia/domain/usecases/get_concrete_number_trivia_test.dart index 8e0297d..e0c7cf1 100644 --- a/test/features/number_trivia/domain/usecases/get_concrete_number_trivia_test.dart +++ b/test/features/number_trivia/domain/usecases/get_concrete_number_trivia_test.dart @@ -2,36 +2,35 @@ import 'package:clean_architecture_tdd_course/features/number_trivia/domain/enti import 'package:clean_architecture_tdd_course/features/number_trivia/domain/repositories/number_trivia_repository.dart'; import 'package:clean_architecture_tdd_course/features/number_trivia/domain/usecases/get_concrete_number_trivia.dart'; import 'package:dartz/dartz.dart'; -import 'package:mockito/mockito.dart'; import 'package:flutter_test/flutter_test.dart'; +import 'package:mocktail/mocktail.dart'; class MockNumberTriviaRepository extends Mock implements NumberTriviaRepository {} void main() { - GetConcreteNumberTrivia usecase; - MockNumberTriviaRepository mockNumberTriviaRepository; + late GetConcreteNumberTrivia usecase; + late MockNumberTriviaRepository mockNumberTriviaRepository; setUp(() { mockNumberTriviaRepository = MockNumberTriviaRepository(); usecase = GetConcreteNumberTrivia(mockNumberTriviaRepository); }); - final tNumber = 1; - final tNumberTrivia = NumberTrivia(number: 1, text: 'test'); + const tNumber = 1; + const tNumberTrivia = NumberTrivia(number: 1, text: 'test'); - test( - 'should get trivia for the number from the repository', - () async { - // arrange - when(mockNumberTriviaRepository.getConcreteNumberTrivia(any)) - .thenAnswer((_) async => Right(tNumberTrivia)); - // act - final result = await usecase(Params(number: tNumber)); - // assert - expect(result, Right(tNumberTrivia)); - verify(mockNumberTriviaRepository.getConcreteNumberTrivia(tNumber)); - verifyNoMoreInteractions(mockNumberTriviaRepository); - }, - ); + test('should get trivia for the number from the repository ', () async { + // arrange + when(() => mockNumberTriviaRepository.getConcreteNumberTrivia(any())) + .thenAnswer((_) async => const Right(tNumberTrivia)); + + // act + final result = await usecase(const Params(number: tNumber)); + + // assert + expect(result, const Right(tNumberTrivia)); + verify(() => mockNumberTriviaRepository.getConcreteNumberTrivia(tNumber)); + verifyNoMoreInteractions(mockNumberTriviaRepository); + }); } diff --git a/test/features/number_trivia/domain/usecases/get_random_number_trivia_test.dart b/test/features/number_trivia/domain/usecases/get_random_number_trivia_test.dart index f07116b..8455dc9 100644 --- a/test/features/number_trivia/domain/usecases/get_random_number_trivia_test.dart +++ b/test/features/number_trivia/domain/usecases/get_random_number_trivia_test.dart @@ -1,38 +1,36 @@ import 'package:clean_architecture_tdd_course/core/usecases/usecase.dart'; import 'package:clean_architecture_tdd_course/features/number_trivia/domain/entities/number_trivia.dart'; import 'package:clean_architecture_tdd_course/features/number_trivia/domain/repositories/number_trivia_repository.dart'; -import 'package:clean_architecture_tdd_course/features/number_trivia/domain/usecases/get_concrete_number_trivia.dart'; import 'package:clean_architecture_tdd_course/features/number_trivia/domain/usecases/get_random_number_trivia.dart'; import 'package:dartz/dartz.dart'; -import 'package:mockito/mockito.dart'; import 'package:flutter_test/flutter_test.dart'; +import 'package:mocktail/mocktail.dart'; class MockNumberTriviaRepository extends Mock implements NumberTriviaRepository {} void main() { - GetRandomNumberTrivia usecase; - MockNumberTriviaRepository mockNumberTriviaRepository; + late GetRandomNumberTrivia usecase; + late MockNumberTriviaRepository mockNumberTriviaRepository; setUp(() { mockNumberTriviaRepository = MockNumberTriviaRepository(); usecase = GetRandomNumberTrivia(mockNumberTriviaRepository); }); - final tNumberTrivia = NumberTrivia(number: 1, text: 'test'); + const tNumberTrivia = NumberTrivia(text: 'test', number: 1); - test( - 'should get trivia from the repository', - () async { - // arrange - when(mockNumberTriviaRepository.getRandomNumberTrivia()) - .thenAnswer((_) async => Right(tNumberTrivia)); - // act - final result = await usecase(NoParams()); - // assert - expect(result, Right(tNumberTrivia)); - verify(mockNumberTriviaRepository.getRandomNumberTrivia()); - verifyNoMoreInteractions(mockNumberTriviaRepository); - }, - ); + test('should get random number trivia from the repository', () async { + // arrange + when(() => mockNumberTriviaRepository.getRandomNumberTrivia()) + .thenAnswer((_) async => const Right(tNumberTrivia)); + + // act + final result = await usecase(NoParams()); + + // assert + expect(result, const Right(tNumberTrivia)); + verify(() => mockNumberTriviaRepository.getRandomNumberTrivia()); + verifyNoMoreInteractions(mockNumberTriviaRepository); + }); } diff --git a/test/features/number_trivia/presentation/.gitkeep b/test/features/number_trivia/presentation/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/test/features/number_trivia/presentation/bloc/.gitkeep b/test/features/number_trivia/presentation/bloc/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/test/features/number_trivia/presentation/bloc/number_trivia_bloc_test.dart b/test/features/number_trivia/presentation/bloc/number_trivia_bloc_test.dart index 87d9089..6648efc 100644 --- a/test/features/number_trivia/presentation/bloc/number_trivia_bloc_test.dart +++ b/test/features/number_trivia/presentation/bloc/number_trivia_bloc_test.dart @@ -1,13 +1,15 @@ +import 'dart:async'; import 'package:clean_architecture_tdd_course/core/error/failures.dart'; import 'package:clean_architecture_tdd_course/core/usecases/usecase.dart'; -import 'package:clean_architecture_tdd_course/core/util/input_converter.dart'; +import 'package:clean_architecture_tdd_course/core/utils/app_strings.dart'; +import 'package:clean_architecture_tdd_course/core/utils/input_converter.dart'; import 'package:clean_architecture_tdd_course/features/number_trivia/domain/entities/number_trivia.dart'; import 'package:clean_architecture_tdd_course/features/number_trivia/domain/usecases/get_concrete_number_trivia.dart'; import 'package:clean_architecture_tdd_course/features/number_trivia/domain/usecases/get_random_number_trivia.dart'; -import 'package:clean_architecture_tdd_course/features/number_trivia/presentation/bloc/bloc.dart'; +import 'package:clean_architecture_tdd_course/features/number_trivia/presentation/bloc/number_trivia_bloc.dart'; import 'package:dartz/dartz.dart'; -import 'package:mockito/mockito.dart'; import 'package:flutter_test/flutter_test.dart'; +import 'package:mocktail/mocktail.dart'; class MockGetConcreteNumberTrivia extends Mock implements GetConcreteNumberTrivia {} @@ -17,16 +19,21 @@ class MockGetRandomNumberTrivia extends Mock implements GetRandomNumberTrivia {} class MockInputConverter extends Mock implements InputConverter {} void main() { - NumberTriviaBloc bloc; - MockGetConcreteNumberTrivia mockGetConcreteNumberTrivia; - MockGetRandomNumberTrivia mockGetRandomNumberTrivia; - MockInputConverter mockInputConverter; + late NumberTriviaBloc bloc; + late MockGetConcreteNumberTrivia mockGetConcreteNumberTrivia; + late MockGetRandomNumberTrivia mockGetRandomNumberTrivia; + late MockInputConverter mockInputConverter; + + // Necessary setup to use Params with mocktail null safety + setUpAll(() { + registerFallbackValue(const Params(number: 1)); + registerFallbackValue(NoParams()); + }); setUp(() { mockGetConcreteNumberTrivia = MockGetConcreteNumberTrivia(); mockGetRandomNumberTrivia = MockGetRandomNumberTrivia(); mockInputConverter = MockInputConverter(); - bloc = NumberTriviaBloc( concrete: mockGetConcreteNumberTrivia, random: mockGetRandomNumberTrivia, @@ -34,81 +41,104 @@ void main() { ); }); + // Check bloc initial state [I think not needed in new version of bloc] test('initialState should be Empty', () { // assert - expect(bloc.initialState, equals(Empty())); + expect(bloc.state, equals(Empty())); }); group('GetTriviaForConcreteNumber', () { - final tNumberString = '1'; - final tNumberParsed = 1; - final tNumberTrivia = NumberTrivia(number: 1, text: 'test trivia'); + const tNumberString = '1'; + const tNumberParsed = 1; + const tNumberTrivia = NumberTrivia(text: 'test trivia', number: 1); void setUpMockInputConverterSuccess() => - when(mockInputConverter.stringToUnsignedInteger(any)) - .thenReturn(Right(tNumberParsed)); + when(() => mockInputConverter.stringToUnsignedInteger(any())) + .thenReturn(const Right(tNumberParsed)); - test( - 'should call the InputConverter to validate and convert the string to an unsigned integer', - () async { - // arrange - setUpMockInputConverterSuccess(); - // act - bloc.add(GetTriviaForConcreteNumber(tNumberString)); - await untilCalled(mockInputConverter.stringToUnsignedInteger(any)); - // assert - verify(mockInputConverter.stringToUnsignedInteger(tNumberString)); - }, - ); + void setUpMockGetConcreteNumberTriviaSuccess() => + when(() => mockGetConcreteNumberTrivia(any())) + .thenAnswer((_) async => const Right(tNumberTrivia)); test( - 'should emit [Error] when the input is invalid', - () async { - // arrange - when(mockInputConverter.stringToUnsignedInteger(any)) - .thenReturn(Left(InvalidInputFailure())); - // assert later - final expected = [ - Empty(), - Error(message: INVALID_INPUT_FAILURE_MESSAGE), - ]; - expectLater(bloc, emitsInOrder(expected)); - // act - bloc.add(GetTriviaForConcreteNumber(tNumberString)); - }, - ); + 'should call the InputConverter to validate and convert the string to ' + 'an unsigned integer', () async { + // arrange + setUpMockInputConverterSuccess(); + setUpMockGetConcreteNumberTriviaSuccess(); - test( - 'should get data from the concrete use case', - () async { - // arrange - setUpMockInputConverterSuccess(); - when(mockGetConcreteNumberTrivia(any)) - .thenAnswer((_) async => Right(tNumberTrivia)); - // act - bloc.add(GetTriviaForConcreteNumber(tNumberString)); - await untilCalled(mockGetConcreteNumberTrivia(any)); - // assert - verify(mockGetConcreteNumberTrivia(Params(number: tNumberParsed))); - }, - ); + // act + bloc.add(const GetTriviaForConcreteNumber(tNumberString)); + /* + Executing the logic present inside [map event to state] takes some time, + so if we don't wait, the verify inside this test will be executed + before the stringToUnsignedInteger had chance to run within + [map event to state] + */ + await untilCalled( + () => mockInputConverter.stringToUnsignedInteger(any()), + ); + + // assert + verify(() => mockInputConverter.stringToUnsignedInteger(tNumberString)); + }); + + test('should emit [Error] when the input is invalid', () async { + // arrange + when(() => mockInputConverter.stringToUnsignedInteger(any())) + .thenReturn(Left(InvalidInputFailure())); + + // assert later + /* + Is it safe to add an event before registering expectation? + what if the logic run faster than expectLater? + so we are going to register expectLater before adding an event + */ + final expected = [ + // The initial state is always emitted first, so we can omit Empty() + // Empty(), + const Error(message: invalidInputFailureMessage), + ]; + // This will make all the values which we are trying to test + // are actually emitted, this test will be put onhold up to 30 sec + unawaited(expectLater(bloc.stream, emitsInOrder(expected))); + + // act + bloc.add(const GetTriviaForConcreteNumber(tNumberString)); + }); + + test('should get data from the concrete use case', () async { + // arrange + setUpMockInputConverterSuccess(); + setUpMockGetConcreteNumberTriviaSuccess(); + + // act + bloc.add(const GetTriviaForConcreteNumber(tNumberString)); + await untilCalled(() => mockGetConcreteNumberTrivia(any())); + + // assert + verify( + () => mockGetConcreteNumberTrivia(const Params(number: tNumberParsed)), + ); + }); test( 'should emit [Loading, Loaded] when data is gotten successfully', () async { // arrange setUpMockInputConverterSuccess(); - when(mockGetConcreteNumberTrivia(any)) - .thenAnswer((_) async => Right(tNumberTrivia)); + setUpMockGetConcreteNumberTriviaSuccess(); + // Testing with stream so it is better to write assert first then act + // assert later final expected = [ - Empty(), Loading(), - Loaded(trivia: tNumberTrivia), + const Loaded(trivia: tNumberTrivia), ]; - expectLater(bloc, emitsInOrder(expected)); + unawaited(expectLater(bloc.stream, emitsInOrder(expected))); + // act - bloc.add(GetTriviaForConcreteNumber(tNumberString)); + bloc.add(const GetTriviaForConcreteNumber(tNumberString)); }, ); @@ -117,70 +147,76 @@ void main() { () async { // arrange setUpMockInputConverterSuccess(); - when(mockGetConcreteNumberTrivia(any)) + when(() => mockGetConcreteNumberTrivia(any())) .thenAnswer((_) async => Left(ServerFailure())); + // assert later final expected = [ - Empty(), Loading(), - Error(message: SERVER_FAILURE_MESSAGE), + const Error(message: serverFailureMessage), ]; - expectLater(bloc, emitsInOrder(expected)); + unawaited(expectLater(bloc.stream, emitsInOrder(expected))); + // act - bloc.add(GetTriviaForConcreteNumber(tNumberString)); + bloc.add(const GetTriviaForConcreteNumber(tNumberString)); }, ); test( - 'should emit [Loading, Error] with a proper message for the error when getting data fails', + 'should emit [Loading, Error] with a proper message for the error ' + 'when getting data fails', () async { // arrange setUpMockInputConverterSuccess(); - when(mockGetConcreteNumberTrivia(any)) + when(() => mockGetConcreteNumberTrivia(any())) .thenAnswer((_) async => Left(CacheFailure())); + // assert later final expected = [ - Empty(), Loading(), - Error(message: CACHE_FAILURE_MESSAGE), + const Error(message: cacheFailureMessage), ]; - expectLater(bloc, emitsInOrder(expected)); + unawaited(expectLater(bloc.stream, emitsInOrder(expected))); + // act - bloc.add(GetTriviaForConcreteNumber(tNumberString)); + bloc.add(const GetTriviaForConcreteNumber(tNumberString)); }, ); }); group('GetTriviaForRandomNumber', () { - final tNumberTrivia = NumberTrivia(number: 1, text: 'test trivia'); + const tNumberTrivia = NumberTrivia(text: 'test trivia', number: 1); - test( - 'should get data from the random use case', - () async { - // arrange - when(mockGetRandomNumberTrivia(any)) - .thenAnswer((_) async => Right(tNumberTrivia)); - // act - bloc.add(GetTriviaForRandomNumber()); - await untilCalled(mockGetRandomNumberTrivia(any)); - // assert - verify(mockGetRandomNumberTrivia(NoParams())); - }, - ); + void setUpMockGetRandomNumberTriviaSuccess() => + when(() => mockGetRandomNumberTrivia(any())) + .thenAnswer((_) async => const Right(tNumberTrivia)); + + test('should get data from the random use case', () async { + // arrange + setUpMockGetRandomNumberTriviaSuccess(); + + // act + bloc.add(GetTriviaForRandomNumber()); + await untilCalled(() => mockGetRandomNumberTrivia(any())); + + // assert + verify(() => mockGetRandomNumberTrivia(NoParams())); + }); test( 'should emit [Loading, Loaded] when data is gotten successfully', () async { // arrange - when(mockGetRandomNumberTrivia(any)) - .thenAnswer((_) async => Right(tNumberTrivia)); + setUpMockGetRandomNumberTriviaSuccess(); + + // Testing with stream so it is better to write assert first then act // assert later final expected = [ - Empty(), Loading(), - Loaded(trivia: tNumberTrivia), + const Loaded(trivia: tNumberTrivia), ]; - expectLater(bloc, emitsInOrder(expected)); + unawaited(expectLater(bloc.stream, emitsInOrder(expected))); + // act bloc.add(GetTriviaForRandomNumber()); }, @@ -190,33 +226,36 @@ void main() { 'should emit [Loading, Error] when getting data fails', () async { // arrange - when(mockGetRandomNumberTrivia(any)) + when(() => mockGetRandomNumberTrivia(any())) .thenAnswer((_) async => Left(ServerFailure())); + // assert later final expected = [ - Empty(), Loading(), - Error(message: SERVER_FAILURE_MESSAGE), + const Error(message: serverFailureMessage), ]; - expectLater(bloc, emitsInOrder(expected)); + unawaited(expectLater(bloc.stream, emitsInOrder(expected))); + // act bloc.add(GetTriviaForRandomNumber()); }, ); test( - 'should emit [Loading, Error] with a proper message for the error when getting data fails', + ' should emit [Loading, Error] with a proper message for the error when ' + 'getting data fails', () async { // arrange - when(mockGetRandomNumberTrivia(any)) + when(() => mockGetRandomNumberTrivia(any())) .thenAnswer((_) async => Left(CacheFailure())); + // assert later final expected = [ - Empty(), Loading(), - Error(message: CACHE_FAILURE_MESSAGE), + const Error(message: cacheFailureMessage), ]; - expectLater(bloc, emitsInOrder(expected)); + unawaited(expectLater(bloc.stream, emitsInOrder(expected))); + // act bloc.add(GetTriviaForRandomNumber()); }, diff --git a/test/features/number_trivia/presentation/pages/.gitkeep b/test/features/number_trivia/presentation/pages/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/test/features/number_trivia/presentation/widgets/.gitkeep b/test/features/number_trivia/presentation/widgets/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/test/fixtures/trivia.json b/test/fixtures/trivia.json index 986910f..aee2c83 100644 --- a/test/fixtures/trivia.json +++ b/test/fixtures/trivia.json @@ -1,6 +1,6 @@ { - "text": "Test Text", - "number": 1, - "found": true, - "type": "trivia" -} + "text": "Test text", + "number": 1, + "found": true, + "type": "trivia" +} \ No newline at end of file diff --git a/test/fixtures/trivia_cached.json b/test/fixtures/trivia_cached.json index 4216fe3..83dc3e5 100644 --- a/test/fixtures/trivia_cached.json +++ b/test/fixtures/trivia_cached.json @@ -1,4 +1,4 @@ { - "text": "Test Text", - "number": 1 -} + "text": "Test text", + "number": 1 +} \ No newline at end of file diff --git a/test/fixtures/trivia_double.json b/test/fixtures/trivia_double.json index 62d8ed9..ff3fc8b 100644 --- a/test/fixtures/trivia_double.json +++ b/test/fixtures/trivia_double.json @@ -1,6 +1,6 @@ { - "text": "Test Text", - "number": 1.0, - "found": true, - "type": "trivia" + "text": "Test text", + "number": 1.0, + "found": true, + "type": "trivia" } diff --git a/test/widget_test.dart b/test/widget_test.dart new file mode 100644 index 0000000..c4c87ce --- /dev/null +++ b/test/widget_test.dart @@ -0,0 +1,29 @@ +// This is a basic Flutter widget test. +// +// To perform an interaction with a widget in your test, use the WidgetTester +// utility in the flutter_test package. For example, you can send tap and scroll +// gestures. You can also use WidgetTester to find child widgets in the widget +// tree, read text, and verify that the values of widget properties are correct. + +import 'package:clean_architecture_tdd_course/main.dart'; +import 'package:flutter/material.dart'; +import 'package:flutter_test/flutter_test.dart'; + +void main() { + // testWidgets('Counter increments smoke test', (WidgetTester tester) async { + // // Build our app and trigger a frame. + // await tester.pumpWidget(const MyApp()); + + // // Verify that our counter starts at 0. + // expect(find.text('0'), findsOneWidget); + // expect(find.text('1'), findsNothing); + + // // Tap the '+' icon and trigger a frame. + // await tester.tap(find.byIcon(Icons.add)); + // await tester.pump(); + + // // Verify that our counter has incremented. + // expect(find.text('0'), findsNothing); + // expect(find.text('1'), findsOneWidget); + // }); +} diff --git a/web/favicon.png b/web/favicon.png new file mode 100644 index 0000000..8aaa46a Binary files /dev/null and b/web/favicon.png differ diff --git a/web/icons/Icon-192.png b/web/icons/Icon-192.png new file mode 100644 index 0000000..b749bfe Binary files /dev/null and b/web/icons/Icon-192.png differ diff --git a/web/icons/Icon-512.png b/web/icons/Icon-512.png new file mode 100644 index 0000000..88cfd48 Binary files /dev/null and b/web/icons/Icon-512.png differ diff --git a/web/icons/Icon-maskable-192.png b/web/icons/Icon-maskable-192.png new file mode 100644 index 0000000..eb9b4d7 Binary files /dev/null and b/web/icons/Icon-maskable-192.png differ diff --git a/web/icons/Icon-maskable-512.png b/web/icons/Icon-maskable-512.png new file mode 100644 index 0000000..d69c566 Binary files /dev/null and b/web/icons/Icon-maskable-512.png differ diff --git a/web/index.html b/web/index.html new file mode 100644 index 0000000..3cbb633 --- /dev/null +++ b/web/index.html @@ -0,0 +1,38 @@ + + + + + + + + + + + + + + + + + + + + clean_architecture_tdd_course + + + + + + diff --git a/web/manifest.json b/web/manifest.json new file mode 100644 index 0000000..7098217 --- /dev/null +++ b/web/manifest.json @@ -0,0 +1,35 @@ +{ + "name": "clean_architecture_tdd_course", + "short_name": "clean_architecture_tdd_course", + "start_url": ".", + "display": "standalone", + "background_color": "#0175C2", + "theme_color": "#0175C2", + "description": "A new Flutter project.", + "orientation": "portrait-primary", + "prefer_related_applications": false, + "icons": [ + { + "src": "icons/Icon-192.png", + "sizes": "192x192", + "type": "image/png" + }, + { + "src": "icons/Icon-512.png", + "sizes": "512x512", + "type": "image/png" + }, + { + "src": "icons/Icon-maskable-192.png", + "sizes": "192x192", + "type": "image/png", + "purpose": "maskable" + }, + { + "src": "icons/Icon-maskable-512.png", + "sizes": "512x512", + "type": "image/png", + "purpose": "maskable" + } + ] +} diff --git a/windows/.gitignore b/windows/.gitignore new file mode 100644 index 0000000..d492d0d --- /dev/null +++ b/windows/.gitignore @@ -0,0 +1,17 @@ +flutter/ephemeral/ + +# Visual Studio user-specific files. +*.suo +*.user +*.userosscache +*.sln.docstates + +# Visual Studio build-related files. +x64/ +x86/ + +# Visual Studio cache files +# files ending in .cache can be ignored +*.[Cc]ache +# but keep track of directories ending in .cache +!*.[Cc]ache/ diff --git a/windows/CMakeLists.txt b/windows/CMakeLists.txt new file mode 100644 index 0000000..cf4fb92 --- /dev/null +++ b/windows/CMakeLists.txt @@ -0,0 +1,108 @@ +# Project-level configuration. +cmake_minimum_required(VERSION 3.14) +project(clean_architecture_tdd_course LANGUAGES CXX) + +# The name of the executable created for the application. Change this to change +# the on-disk name of your application. +set(BINARY_NAME "clean_architecture_tdd_course") + +# Explicitly opt in to modern CMake behaviors to avoid warnings with recent +# versions of CMake. +cmake_policy(VERSION 3.14...3.25) + +# Define build configuration option. +get_property(IS_MULTICONFIG GLOBAL PROPERTY GENERATOR_IS_MULTI_CONFIG) +if(IS_MULTICONFIG) + set(CMAKE_CONFIGURATION_TYPES "Debug;Profile;Release" + CACHE STRING "" FORCE) +else() + if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES) + set(CMAKE_BUILD_TYPE "Debug" CACHE + STRING "Flutter build mode" FORCE) + set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS + "Debug" "Profile" "Release") + endif() +endif() +# Define settings for the Profile build mode. +set(CMAKE_EXE_LINKER_FLAGS_PROFILE "${CMAKE_EXE_LINKER_FLAGS_RELEASE}") +set(CMAKE_SHARED_LINKER_FLAGS_PROFILE "${CMAKE_SHARED_LINKER_FLAGS_RELEASE}") +set(CMAKE_C_FLAGS_PROFILE "${CMAKE_C_FLAGS_RELEASE}") +set(CMAKE_CXX_FLAGS_PROFILE "${CMAKE_CXX_FLAGS_RELEASE}") + +# Use Unicode for all projects. +add_definitions(-DUNICODE -D_UNICODE) + +# Compilation settings that should be applied to most targets. +# +# Be cautious about adding new options here, as plugins use this function by +# default. In most cases, you should add new options to specific targets instead +# of modifying this function. +function(APPLY_STANDARD_SETTINGS TARGET) + target_compile_features(${TARGET} PUBLIC cxx_std_17) + target_compile_options(${TARGET} PRIVATE /W4 /WX /wd"4100") + target_compile_options(${TARGET} PRIVATE /EHsc) + target_compile_definitions(${TARGET} PRIVATE "_HAS_EXCEPTIONS=0") + target_compile_definitions(${TARGET} PRIVATE "$<$:_DEBUG>") +endfunction() + +# Flutter library and tool build rules. +set(FLUTTER_MANAGED_DIR "${CMAKE_CURRENT_SOURCE_DIR}/flutter") +add_subdirectory(${FLUTTER_MANAGED_DIR}) + +# Application build; see runner/CMakeLists.txt. +add_subdirectory("runner") + + +# Generated plugin build rules, which manage building the plugins and adding +# them to the application. +include(flutter/generated_plugins.cmake) + + +# === Installation === +# Support files are copied into place next to the executable, so that it can +# run in place. This is done instead of making a separate bundle (as on Linux) +# so that building and running from within Visual Studio will work. +set(BUILD_BUNDLE_DIR "$") +# Make the "install" step default, as it's required to run. +set(CMAKE_VS_INCLUDE_INSTALL_TO_DEFAULT_BUILD 1) +if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT) + set(CMAKE_INSTALL_PREFIX "${BUILD_BUNDLE_DIR}" CACHE PATH "..." FORCE) +endif() + +set(INSTALL_BUNDLE_DATA_DIR "${CMAKE_INSTALL_PREFIX}/data") +set(INSTALL_BUNDLE_LIB_DIR "${CMAKE_INSTALL_PREFIX}") + +install(TARGETS ${BINARY_NAME} RUNTIME DESTINATION "${CMAKE_INSTALL_PREFIX}" + COMPONENT Runtime) + +install(FILES "${FLUTTER_ICU_DATA_FILE}" DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" + COMPONENT Runtime) + +install(FILES "${FLUTTER_LIBRARY}" DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" + COMPONENT Runtime) + +if(PLUGIN_BUNDLED_LIBRARIES) + install(FILES "${PLUGIN_BUNDLED_LIBRARIES}" + DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" + COMPONENT Runtime) +endif() + +# Copy the native assets provided by the build.dart from all packages. +set(NATIVE_ASSETS_DIR "${PROJECT_BUILD_DIR}native_assets/windows/") +install(DIRECTORY "${NATIVE_ASSETS_DIR}" + DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" + COMPONENT Runtime) + +# Fully re-copy the assets directory on each build to avoid having stale files +# from a previous install. +set(FLUTTER_ASSET_DIR_NAME "flutter_assets") +install(CODE " + file(REMOVE_RECURSE \"${INSTALL_BUNDLE_DATA_DIR}/${FLUTTER_ASSET_DIR_NAME}\") + " COMPONENT Runtime) +install(DIRECTORY "${PROJECT_BUILD_DIR}/${FLUTTER_ASSET_DIR_NAME}" + DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" COMPONENT Runtime) + +# Install the AOT library on non-Debug builds only. +install(FILES "${AOT_LIBRARY}" DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" + CONFIGURATIONS Profile;Release + COMPONENT Runtime) diff --git a/windows/flutter/CMakeLists.txt b/windows/flutter/CMakeLists.txt new file mode 100644 index 0000000..903f489 --- /dev/null +++ b/windows/flutter/CMakeLists.txt @@ -0,0 +1,109 @@ +# This file controls Flutter-level build steps. It should not be edited. +cmake_minimum_required(VERSION 3.14) + +set(EPHEMERAL_DIR "${CMAKE_CURRENT_SOURCE_DIR}/ephemeral") + +# Configuration provided via flutter tool. +include(${EPHEMERAL_DIR}/generated_config.cmake) + +# TODO: Move the rest of this into files in ephemeral. See +# https://github.com/flutter/flutter/issues/57146. +set(WRAPPER_ROOT "${EPHEMERAL_DIR}/cpp_client_wrapper") + +# Set fallback configurations for older versions of the flutter tool. +if (NOT DEFINED FLUTTER_TARGET_PLATFORM) + set(FLUTTER_TARGET_PLATFORM "windows-x64") +endif() + +# === Flutter Library === +set(FLUTTER_LIBRARY "${EPHEMERAL_DIR}/flutter_windows.dll") + +# Published to parent scope for install step. +set(FLUTTER_LIBRARY ${FLUTTER_LIBRARY} PARENT_SCOPE) +set(FLUTTER_ICU_DATA_FILE "${EPHEMERAL_DIR}/icudtl.dat" PARENT_SCOPE) +set(PROJECT_BUILD_DIR "${PROJECT_DIR}/build/" PARENT_SCOPE) +set(AOT_LIBRARY "${PROJECT_DIR}/build/windows/app.so" PARENT_SCOPE) + +list(APPEND FLUTTER_LIBRARY_HEADERS + "flutter_export.h" + "flutter_windows.h" + "flutter_messenger.h" + "flutter_plugin_registrar.h" + "flutter_texture_registrar.h" +) +list(TRANSFORM FLUTTER_LIBRARY_HEADERS PREPEND "${EPHEMERAL_DIR}/") +add_library(flutter INTERFACE) +target_include_directories(flutter INTERFACE + "${EPHEMERAL_DIR}" +) +target_link_libraries(flutter INTERFACE "${FLUTTER_LIBRARY}.lib") +add_dependencies(flutter flutter_assemble) + +# === Wrapper === +list(APPEND CPP_WRAPPER_SOURCES_CORE + "core_implementations.cc" + "standard_codec.cc" +) +list(TRANSFORM CPP_WRAPPER_SOURCES_CORE PREPEND "${WRAPPER_ROOT}/") +list(APPEND CPP_WRAPPER_SOURCES_PLUGIN + "plugin_registrar.cc" +) +list(TRANSFORM CPP_WRAPPER_SOURCES_PLUGIN PREPEND "${WRAPPER_ROOT}/") +list(APPEND CPP_WRAPPER_SOURCES_APP + "flutter_engine.cc" + "flutter_view_controller.cc" +) +list(TRANSFORM CPP_WRAPPER_SOURCES_APP PREPEND "${WRAPPER_ROOT}/") + +# Wrapper sources needed for a plugin. +add_library(flutter_wrapper_plugin STATIC + ${CPP_WRAPPER_SOURCES_CORE} + ${CPP_WRAPPER_SOURCES_PLUGIN} +) +apply_standard_settings(flutter_wrapper_plugin) +set_target_properties(flutter_wrapper_plugin PROPERTIES + POSITION_INDEPENDENT_CODE ON) +set_target_properties(flutter_wrapper_plugin PROPERTIES + CXX_VISIBILITY_PRESET hidden) +target_link_libraries(flutter_wrapper_plugin PUBLIC flutter) +target_include_directories(flutter_wrapper_plugin PUBLIC + "${WRAPPER_ROOT}/include" +) +add_dependencies(flutter_wrapper_plugin flutter_assemble) + +# Wrapper sources needed for the runner. +add_library(flutter_wrapper_app STATIC + ${CPP_WRAPPER_SOURCES_CORE} + ${CPP_WRAPPER_SOURCES_APP} +) +apply_standard_settings(flutter_wrapper_app) +target_link_libraries(flutter_wrapper_app PUBLIC flutter) +target_include_directories(flutter_wrapper_app PUBLIC + "${WRAPPER_ROOT}/include" +) +add_dependencies(flutter_wrapper_app flutter_assemble) + +# === Flutter tool backend === +# _phony_ is a non-existent file to force this command to run every time, +# since currently there's no way to get a full input/output list from the +# flutter tool. +set(PHONY_OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/_phony_") +set_source_files_properties("${PHONY_OUTPUT}" PROPERTIES SYMBOLIC TRUE) +add_custom_command( + OUTPUT ${FLUTTER_LIBRARY} ${FLUTTER_LIBRARY_HEADERS} + ${CPP_WRAPPER_SOURCES_CORE} ${CPP_WRAPPER_SOURCES_PLUGIN} + ${CPP_WRAPPER_SOURCES_APP} + ${PHONY_OUTPUT} + COMMAND ${CMAKE_COMMAND} -E env + ${FLUTTER_TOOL_ENVIRONMENT} + "${FLUTTER_ROOT}/packages/flutter_tools/bin/tool_backend.bat" + ${FLUTTER_TARGET_PLATFORM} $ + VERBATIM +) +add_custom_target(flutter_assemble DEPENDS + "${FLUTTER_LIBRARY}" + ${FLUTTER_LIBRARY_HEADERS} + ${CPP_WRAPPER_SOURCES_CORE} + ${CPP_WRAPPER_SOURCES_PLUGIN} + ${CPP_WRAPPER_SOURCES_APP} +) diff --git a/windows/flutter/generated_plugin_registrant.cc b/windows/flutter/generated_plugin_registrant.cc new file mode 100644 index 0000000..8b6d468 --- /dev/null +++ b/windows/flutter/generated_plugin_registrant.cc @@ -0,0 +1,11 @@ +// +// Generated file. Do not edit. +// + +// clang-format off + +#include "generated_plugin_registrant.h" + + +void RegisterPlugins(flutter::PluginRegistry* registry) { +} diff --git a/windows/flutter/generated_plugin_registrant.h b/windows/flutter/generated_plugin_registrant.h new file mode 100644 index 0000000..dc139d8 --- /dev/null +++ b/windows/flutter/generated_plugin_registrant.h @@ -0,0 +1,15 @@ +// +// Generated file. Do not edit. +// + +// clang-format off + +#ifndef GENERATED_PLUGIN_REGISTRANT_ +#define GENERATED_PLUGIN_REGISTRANT_ + +#include + +// Registers Flutter plugins. +void RegisterPlugins(flutter::PluginRegistry* registry); + +#endif // GENERATED_PLUGIN_REGISTRANT_ diff --git a/windows/flutter/generated_plugins.cmake b/windows/flutter/generated_plugins.cmake new file mode 100644 index 0000000..b93c4c3 --- /dev/null +++ b/windows/flutter/generated_plugins.cmake @@ -0,0 +1,23 @@ +# +# Generated file, do not edit. +# + +list(APPEND FLUTTER_PLUGIN_LIST +) + +list(APPEND FLUTTER_FFI_PLUGIN_LIST +) + +set(PLUGIN_BUNDLED_LIBRARIES) + +foreach(plugin ${FLUTTER_PLUGIN_LIST}) + add_subdirectory(flutter/ephemeral/.plugin_symlinks/${plugin}/windows plugins/${plugin}) + target_link_libraries(${BINARY_NAME} PRIVATE ${plugin}_plugin) + list(APPEND PLUGIN_BUNDLED_LIBRARIES $) + list(APPEND PLUGIN_BUNDLED_LIBRARIES ${${plugin}_bundled_libraries}) +endforeach(plugin) + +foreach(ffi_plugin ${FLUTTER_FFI_PLUGIN_LIST}) + add_subdirectory(flutter/ephemeral/.plugin_symlinks/${ffi_plugin}/windows plugins/${ffi_plugin}) + list(APPEND PLUGIN_BUNDLED_LIBRARIES ${${ffi_plugin}_bundled_libraries}) +endforeach(ffi_plugin) diff --git a/windows/runner/CMakeLists.txt b/windows/runner/CMakeLists.txt new file mode 100644 index 0000000..394917c --- /dev/null +++ b/windows/runner/CMakeLists.txt @@ -0,0 +1,40 @@ +cmake_minimum_required(VERSION 3.14) +project(runner LANGUAGES CXX) + +# Define the application target. To change its name, change BINARY_NAME in the +# top-level CMakeLists.txt, not the value here, or `flutter run` will no longer +# work. +# +# Any new source files that you add to the application should be added here. +add_executable(${BINARY_NAME} WIN32 + "flutter_window.cpp" + "main.cpp" + "utils.cpp" + "win32_window.cpp" + "${FLUTTER_MANAGED_DIR}/generated_plugin_registrant.cc" + "Runner.rc" + "runner.exe.manifest" +) + +# Apply the standard set of build settings. This can be removed for applications +# that need different build settings. +apply_standard_settings(${BINARY_NAME}) + +# Add preprocessor definitions for the build version. +target_compile_definitions(${BINARY_NAME} PRIVATE "FLUTTER_VERSION=\"${FLUTTER_VERSION}\"") +target_compile_definitions(${BINARY_NAME} PRIVATE "FLUTTER_VERSION_MAJOR=${FLUTTER_VERSION_MAJOR}") +target_compile_definitions(${BINARY_NAME} PRIVATE "FLUTTER_VERSION_MINOR=${FLUTTER_VERSION_MINOR}") +target_compile_definitions(${BINARY_NAME} PRIVATE "FLUTTER_VERSION_PATCH=${FLUTTER_VERSION_PATCH}") +target_compile_definitions(${BINARY_NAME} PRIVATE "FLUTTER_VERSION_BUILD=${FLUTTER_VERSION_BUILD}") + +# Disable Windows macros that collide with C++ standard library functions. +target_compile_definitions(${BINARY_NAME} PRIVATE "NOMINMAX") + +# Add dependency libraries and include directories. Add any application-specific +# dependencies here. +target_link_libraries(${BINARY_NAME} PRIVATE flutter flutter_wrapper_app) +target_link_libraries(${BINARY_NAME} PRIVATE "dwmapi.lib") +target_include_directories(${BINARY_NAME} PRIVATE "${CMAKE_SOURCE_DIR}") + +# Run the Flutter tool portions of the build. This must not be removed. +add_dependencies(${BINARY_NAME} flutter_assemble) diff --git a/windows/runner/Runner.rc b/windows/runner/Runner.rc new file mode 100644 index 0000000..20178f7 --- /dev/null +++ b/windows/runner/Runner.rc @@ -0,0 +1,121 @@ +// Microsoft Visual C++ generated resource script. +// +#pragma code_page(65001) +#include "resource.h" + +#define APSTUDIO_READONLY_SYMBOLS +///////////////////////////////////////////////////////////////////////////// +// +// Generated from the TEXTINCLUDE 2 resource. +// +#include "winres.h" + +///////////////////////////////////////////////////////////////////////////// +#undef APSTUDIO_READONLY_SYMBOLS + +///////////////////////////////////////////////////////////////////////////// +// English (United States) resources + +#if !defined(AFX_RESOURCE_DLL) || defined(AFX_TARG_ENU) +LANGUAGE LANG_ENGLISH, SUBLANG_ENGLISH_US + +#ifdef APSTUDIO_INVOKED +///////////////////////////////////////////////////////////////////////////// +// +// TEXTINCLUDE +// + +1 TEXTINCLUDE +BEGIN + "resource.h\0" +END + +2 TEXTINCLUDE +BEGIN + "#include ""winres.h""\r\n" + "\0" +END + +3 TEXTINCLUDE +BEGIN + "\r\n" + "\0" +END + +#endif // APSTUDIO_INVOKED + + +///////////////////////////////////////////////////////////////////////////// +// +// Icon +// + +// Icon with lowest ID value placed first to ensure application icon +// remains consistent on all systems. +IDI_APP_ICON ICON "resources\\app_icon.ico" + + +///////////////////////////////////////////////////////////////////////////// +// +// Version +// + +#if defined(FLUTTER_VERSION_MAJOR) && defined(FLUTTER_VERSION_MINOR) && defined(FLUTTER_VERSION_PATCH) && defined(FLUTTER_VERSION_BUILD) +#define VERSION_AS_NUMBER FLUTTER_VERSION_MAJOR,FLUTTER_VERSION_MINOR,FLUTTER_VERSION_PATCH,FLUTTER_VERSION_BUILD +#else +#define VERSION_AS_NUMBER 1,0,0,0 +#endif + +#if defined(FLUTTER_VERSION) +#define VERSION_AS_STRING FLUTTER_VERSION +#else +#define VERSION_AS_STRING "1.0.0" +#endif + +VS_VERSION_INFO VERSIONINFO + FILEVERSION VERSION_AS_NUMBER + PRODUCTVERSION VERSION_AS_NUMBER + FILEFLAGSMASK VS_FFI_FILEFLAGSMASK +#ifdef _DEBUG + FILEFLAGS VS_FF_DEBUG +#else + FILEFLAGS 0x0L +#endif + FILEOS VOS__WINDOWS32 + FILETYPE VFT_APP + FILESUBTYPE 0x0L +BEGIN + BLOCK "StringFileInfo" + BEGIN + BLOCK "040904e4" + BEGIN + VALUE "CompanyName", "com.example" "\0" + VALUE "FileDescription", "clean_architecture_tdd_course" "\0" + VALUE "FileVersion", VERSION_AS_STRING "\0" + VALUE "InternalName", "clean_architecture_tdd_course" "\0" + VALUE "LegalCopyright", "Copyright (C) 2024 com.example. All rights reserved." "\0" + VALUE "OriginalFilename", "clean_architecture_tdd_course.exe" "\0" + VALUE "ProductName", "clean_architecture_tdd_course" "\0" + VALUE "ProductVersion", VERSION_AS_STRING "\0" + END + END + BLOCK "VarFileInfo" + BEGIN + VALUE "Translation", 0x409, 1252 + END +END + +#endif // English (United States) resources +///////////////////////////////////////////////////////////////////////////// + + + +#ifndef APSTUDIO_INVOKED +///////////////////////////////////////////////////////////////////////////// +// +// Generated from the TEXTINCLUDE 3 resource. +// + + +///////////////////////////////////////////////////////////////////////////// +#endif // not APSTUDIO_INVOKED diff --git a/windows/runner/flutter_window.cpp b/windows/runner/flutter_window.cpp new file mode 100644 index 0000000..955ee30 --- /dev/null +++ b/windows/runner/flutter_window.cpp @@ -0,0 +1,71 @@ +#include "flutter_window.h" + +#include + +#include "flutter/generated_plugin_registrant.h" + +FlutterWindow::FlutterWindow(const flutter::DartProject& project) + : project_(project) {} + +FlutterWindow::~FlutterWindow() {} + +bool FlutterWindow::OnCreate() { + if (!Win32Window::OnCreate()) { + return false; + } + + RECT frame = GetClientArea(); + + // The size here must match the window dimensions to avoid unnecessary surface + // creation / destruction in the startup path. + flutter_controller_ = std::make_unique( + frame.right - frame.left, frame.bottom - frame.top, project_); + // Ensure that basic setup of the controller was successful. + if (!flutter_controller_->engine() || !flutter_controller_->view()) { + return false; + } + RegisterPlugins(flutter_controller_->engine()); + SetChildContent(flutter_controller_->view()->GetNativeWindow()); + + flutter_controller_->engine()->SetNextFrameCallback([&]() { + this->Show(); + }); + + // Flutter can complete the first frame before the "show window" callback is + // registered. The following call ensures a frame is pending to ensure the + // window is shown. It is a no-op if the first frame hasn't completed yet. + flutter_controller_->ForceRedraw(); + + return true; +} + +void FlutterWindow::OnDestroy() { + if (flutter_controller_) { + flutter_controller_ = nullptr; + } + + Win32Window::OnDestroy(); +} + +LRESULT +FlutterWindow::MessageHandler(HWND hwnd, UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept { + // Give Flutter, including plugins, an opportunity to handle window messages. + if (flutter_controller_) { + std::optional result = + flutter_controller_->HandleTopLevelWindowProc(hwnd, message, wparam, + lparam); + if (result) { + return *result; + } + } + + switch (message) { + case WM_FONTCHANGE: + flutter_controller_->engine()->ReloadSystemFonts(); + break; + } + + return Win32Window::MessageHandler(hwnd, message, wparam, lparam); +} diff --git a/windows/runner/flutter_window.h b/windows/runner/flutter_window.h new file mode 100644 index 0000000..6da0652 --- /dev/null +++ b/windows/runner/flutter_window.h @@ -0,0 +1,33 @@ +#ifndef RUNNER_FLUTTER_WINDOW_H_ +#define RUNNER_FLUTTER_WINDOW_H_ + +#include +#include + +#include + +#include "win32_window.h" + +// A window that does nothing but host a Flutter view. +class FlutterWindow : public Win32Window { + public: + // Creates a new FlutterWindow hosting a Flutter view running |project|. + explicit FlutterWindow(const flutter::DartProject& project); + virtual ~FlutterWindow(); + + protected: + // Win32Window: + bool OnCreate() override; + void OnDestroy() override; + LRESULT MessageHandler(HWND window, UINT const message, WPARAM const wparam, + LPARAM const lparam) noexcept override; + + private: + // The project to run. + flutter::DartProject project_; + + // The Flutter instance hosted by this window. + std::unique_ptr flutter_controller_; +}; + +#endif // RUNNER_FLUTTER_WINDOW_H_ diff --git a/windows/runner/main.cpp b/windows/runner/main.cpp new file mode 100644 index 0000000..80cff57 --- /dev/null +++ b/windows/runner/main.cpp @@ -0,0 +1,43 @@ +#include +#include +#include + +#include "flutter_window.h" +#include "utils.h" + +int APIENTRY wWinMain(_In_ HINSTANCE instance, _In_opt_ HINSTANCE prev, + _In_ wchar_t *command_line, _In_ int show_command) { + // Attach to console when present (e.g., 'flutter run') or create a + // new console when running with a debugger. + if (!::AttachConsole(ATTACH_PARENT_PROCESS) && ::IsDebuggerPresent()) { + CreateAndAttachConsole(); + } + + // Initialize COM, so that it is available for use in the library and/or + // plugins. + ::CoInitializeEx(nullptr, COINIT_APARTMENTTHREADED); + + flutter::DartProject project(L"data"); + + std::vector command_line_arguments = + GetCommandLineArguments(); + + project.set_dart_entrypoint_arguments(std::move(command_line_arguments)); + + FlutterWindow window(project); + Win32Window::Point origin(10, 10); + Win32Window::Size size(1280, 720); + if (!window.Create(L"clean_architecture_tdd_course", origin, size)) { + return EXIT_FAILURE; + } + window.SetQuitOnClose(true); + + ::MSG msg; + while (::GetMessage(&msg, nullptr, 0, 0)) { + ::TranslateMessage(&msg); + ::DispatchMessage(&msg); + } + + ::CoUninitialize(); + return EXIT_SUCCESS; +} diff --git a/windows/runner/resource.h b/windows/runner/resource.h new file mode 100644 index 0000000..66a65d1 --- /dev/null +++ b/windows/runner/resource.h @@ -0,0 +1,16 @@ +//{{NO_DEPENDENCIES}} +// Microsoft Visual C++ generated include file. +// Used by Runner.rc +// +#define IDI_APP_ICON 101 + +// Next default values for new objects +// +#ifdef APSTUDIO_INVOKED +#ifndef APSTUDIO_READONLY_SYMBOLS +#define _APS_NEXT_RESOURCE_VALUE 102 +#define _APS_NEXT_COMMAND_VALUE 40001 +#define _APS_NEXT_CONTROL_VALUE 1001 +#define _APS_NEXT_SYMED_VALUE 101 +#endif +#endif diff --git a/windows/runner/resources/app_icon.ico b/windows/runner/resources/app_icon.ico new file mode 100644 index 0000000..c04e20c Binary files /dev/null and b/windows/runner/resources/app_icon.ico differ diff --git a/windows/runner/runner.exe.manifest b/windows/runner/runner.exe.manifest new file mode 100644 index 0000000..a42ea76 --- /dev/null +++ b/windows/runner/runner.exe.manifest @@ -0,0 +1,20 @@ + + + + + PerMonitorV2 + + + + + + + + + + + + + + + diff --git a/windows/runner/utils.cpp b/windows/runner/utils.cpp new file mode 100644 index 0000000..3a0b465 --- /dev/null +++ b/windows/runner/utils.cpp @@ -0,0 +1,65 @@ +#include "utils.h" + +#include +#include +#include +#include + +#include + +void CreateAndAttachConsole() { + if (::AllocConsole()) { + FILE *unused; + if (freopen_s(&unused, "CONOUT$", "w", stdout)) { + _dup2(_fileno(stdout), 1); + } + if (freopen_s(&unused, "CONOUT$", "w", stderr)) { + _dup2(_fileno(stdout), 2); + } + std::ios::sync_with_stdio(); + FlutterDesktopResyncOutputStreams(); + } +} + +std::vector GetCommandLineArguments() { + // Convert the UTF-16 command line arguments to UTF-8 for the Engine to use. + int argc; + wchar_t** argv = ::CommandLineToArgvW(::GetCommandLineW(), &argc); + if (argv == nullptr) { + return std::vector(); + } + + std::vector command_line_arguments; + + // Skip the first argument as it's the binary name. + for (int i = 1; i < argc; i++) { + command_line_arguments.push_back(Utf8FromUtf16(argv[i])); + } + + ::LocalFree(argv); + + return command_line_arguments; +} + +std::string Utf8FromUtf16(const wchar_t* utf16_string) { + if (utf16_string == nullptr) { + return std::string(); + } + unsigned int target_length = ::WideCharToMultiByte( + CP_UTF8, WC_ERR_INVALID_CHARS, utf16_string, + -1, nullptr, 0, nullptr, nullptr) + -1; // remove the trailing null character + int input_length = (int)wcslen(utf16_string); + std::string utf8_string; + if (target_length == 0 || target_length > utf8_string.max_size()) { + return utf8_string; + } + utf8_string.resize(target_length); + int converted_length = ::WideCharToMultiByte( + CP_UTF8, WC_ERR_INVALID_CHARS, utf16_string, + input_length, utf8_string.data(), target_length, nullptr, nullptr); + if (converted_length == 0) { + return std::string(); + } + return utf8_string; +} diff --git a/windows/runner/utils.h b/windows/runner/utils.h new file mode 100644 index 0000000..3879d54 --- /dev/null +++ b/windows/runner/utils.h @@ -0,0 +1,19 @@ +#ifndef RUNNER_UTILS_H_ +#define RUNNER_UTILS_H_ + +#include +#include + +// Creates a console for the process, and redirects stdout and stderr to +// it for both the runner and the Flutter library. +void CreateAndAttachConsole(); + +// Takes a null-terminated wchar_t* encoded in UTF-16 and returns a std::string +// encoded in UTF-8. Returns an empty std::string on failure. +std::string Utf8FromUtf16(const wchar_t* utf16_string); + +// Gets the command line arguments passed in as a std::vector, +// encoded in UTF-8. Returns an empty std::vector on failure. +std::vector GetCommandLineArguments(); + +#endif // RUNNER_UTILS_H_ diff --git a/windows/runner/win32_window.cpp b/windows/runner/win32_window.cpp new file mode 100644 index 0000000..60608d0 --- /dev/null +++ b/windows/runner/win32_window.cpp @@ -0,0 +1,288 @@ +#include "win32_window.h" + +#include +#include + +#include "resource.h" + +namespace { + +/// Window attribute that enables dark mode window decorations. +/// +/// Redefined in case the developer's machine has a Windows SDK older than +/// version 10.0.22000.0. +/// See: https://docs.microsoft.com/windows/win32/api/dwmapi/ne-dwmapi-dwmwindowattribute +#ifndef DWMWA_USE_IMMERSIVE_DARK_MODE +#define DWMWA_USE_IMMERSIVE_DARK_MODE 20 +#endif + +constexpr const wchar_t kWindowClassName[] = L"FLUTTER_RUNNER_WIN32_WINDOW"; + +/// Registry key for app theme preference. +/// +/// A value of 0 indicates apps should use dark mode. A non-zero or missing +/// value indicates apps should use light mode. +constexpr const wchar_t kGetPreferredBrightnessRegKey[] = + L"Software\\Microsoft\\Windows\\CurrentVersion\\Themes\\Personalize"; +constexpr const wchar_t kGetPreferredBrightnessRegValue[] = L"AppsUseLightTheme"; + +// The number of Win32Window objects that currently exist. +static int g_active_window_count = 0; + +using EnableNonClientDpiScaling = BOOL __stdcall(HWND hwnd); + +// Scale helper to convert logical scaler values to physical using passed in +// scale factor +int Scale(int source, double scale_factor) { + return static_cast(source * scale_factor); +} + +// Dynamically loads the |EnableNonClientDpiScaling| from the User32 module. +// This API is only needed for PerMonitor V1 awareness mode. +void EnableFullDpiSupportIfAvailable(HWND hwnd) { + HMODULE user32_module = LoadLibraryA("User32.dll"); + if (!user32_module) { + return; + } + auto enable_non_client_dpi_scaling = + reinterpret_cast( + GetProcAddress(user32_module, "EnableNonClientDpiScaling")); + if (enable_non_client_dpi_scaling != nullptr) { + enable_non_client_dpi_scaling(hwnd); + } + FreeLibrary(user32_module); +} + +} // namespace + +// Manages the Win32Window's window class registration. +class WindowClassRegistrar { + public: + ~WindowClassRegistrar() = default; + + // Returns the singleton registrar instance. + static WindowClassRegistrar* GetInstance() { + if (!instance_) { + instance_ = new WindowClassRegistrar(); + } + return instance_; + } + + // Returns the name of the window class, registering the class if it hasn't + // previously been registered. + const wchar_t* GetWindowClass(); + + // Unregisters the window class. Should only be called if there are no + // instances of the window. + void UnregisterWindowClass(); + + private: + WindowClassRegistrar() = default; + + static WindowClassRegistrar* instance_; + + bool class_registered_ = false; +}; + +WindowClassRegistrar* WindowClassRegistrar::instance_ = nullptr; + +const wchar_t* WindowClassRegistrar::GetWindowClass() { + if (!class_registered_) { + WNDCLASS window_class{}; + window_class.hCursor = LoadCursor(nullptr, IDC_ARROW); + window_class.lpszClassName = kWindowClassName; + window_class.style = CS_HREDRAW | CS_VREDRAW; + window_class.cbClsExtra = 0; + window_class.cbWndExtra = 0; + window_class.hInstance = GetModuleHandle(nullptr); + window_class.hIcon = + LoadIcon(window_class.hInstance, MAKEINTRESOURCE(IDI_APP_ICON)); + window_class.hbrBackground = 0; + window_class.lpszMenuName = nullptr; + window_class.lpfnWndProc = Win32Window::WndProc; + RegisterClass(&window_class); + class_registered_ = true; + } + return kWindowClassName; +} + +void WindowClassRegistrar::UnregisterWindowClass() { + UnregisterClass(kWindowClassName, nullptr); + class_registered_ = false; +} + +Win32Window::Win32Window() { + ++g_active_window_count; +} + +Win32Window::~Win32Window() { + --g_active_window_count; + Destroy(); +} + +bool Win32Window::Create(const std::wstring& title, + const Point& origin, + const Size& size) { + Destroy(); + + const wchar_t* window_class = + WindowClassRegistrar::GetInstance()->GetWindowClass(); + + const POINT target_point = {static_cast(origin.x), + static_cast(origin.y)}; + HMONITOR monitor = MonitorFromPoint(target_point, MONITOR_DEFAULTTONEAREST); + UINT dpi = FlutterDesktopGetDpiForMonitor(monitor); + double scale_factor = dpi / 96.0; + + HWND window = CreateWindow( + window_class, title.c_str(), WS_OVERLAPPEDWINDOW, + Scale(origin.x, scale_factor), Scale(origin.y, scale_factor), + Scale(size.width, scale_factor), Scale(size.height, scale_factor), + nullptr, nullptr, GetModuleHandle(nullptr), this); + + if (!window) { + return false; + } + + UpdateTheme(window); + + return OnCreate(); +} + +bool Win32Window::Show() { + return ShowWindow(window_handle_, SW_SHOWNORMAL); +} + +// static +LRESULT CALLBACK Win32Window::WndProc(HWND const window, + UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept { + if (message == WM_NCCREATE) { + auto window_struct = reinterpret_cast(lparam); + SetWindowLongPtr(window, GWLP_USERDATA, + reinterpret_cast(window_struct->lpCreateParams)); + + auto that = static_cast(window_struct->lpCreateParams); + EnableFullDpiSupportIfAvailable(window); + that->window_handle_ = window; + } else if (Win32Window* that = GetThisFromHandle(window)) { + return that->MessageHandler(window, message, wparam, lparam); + } + + return DefWindowProc(window, message, wparam, lparam); +} + +LRESULT +Win32Window::MessageHandler(HWND hwnd, + UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept { + switch (message) { + case WM_DESTROY: + window_handle_ = nullptr; + Destroy(); + if (quit_on_close_) { + PostQuitMessage(0); + } + return 0; + + case WM_DPICHANGED: { + auto newRectSize = reinterpret_cast(lparam); + LONG newWidth = newRectSize->right - newRectSize->left; + LONG newHeight = newRectSize->bottom - newRectSize->top; + + SetWindowPos(hwnd, nullptr, newRectSize->left, newRectSize->top, newWidth, + newHeight, SWP_NOZORDER | SWP_NOACTIVATE); + + return 0; + } + case WM_SIZE: { + RECT rect = GetClientArea(); + if (child_content_ != nullptr) { + // Size and position the child window. + MoveWindow(child_content_, rect.left, rect.top, rect.right - rect.left, + rect.bottom - rect.top, TRUE); + } + return 0; + } + + case WM_ACTIVATE: + if (child_content_ != nullptr) { + SetFocus(child_content_); + } + return 0; + + case WM_DWMCOLORIZATIONCOLORCHANGED: + UpdateTheme(hwnd); + return 0; + } + + return DefWindowProc(window_handle_, message, wparam, lparam); +} + +void Win32Window::Destroy() { + OnDestroy(); + + if (window_handle_) { + DestroyWindow(window_handle_); + window_handle_ = nullptr; + } + if (g_active_window_count == 0) { + WindowClassRegistrar::GetInstance()->UnregisterWindowClass(); + } +} + +Win32Window* Win32Window::GetThisFromHandle(HWND const window) noexcept { + return reinterpret_cast( + GetWindowLongPtr(window, GWLP_USERDATA)); +} + +void Win32Window::SetChildContent(HWND content) { + child_content_ = content; + SetParent(content, window_handle_); + RECT frame = GetClientArea(); + + MoveWindow(content, frame.left, frame.top, frame.right - frame.left, + frame.bottom - frame.top, true); + + SetFocus(child_content_); +} + +RECT Win32Window::GetClientArea() { + RECT frame; + GetClientRect(window_handle_, &frame); + return frame; +} + +HWND Win32Window::GetHandle() { + return window_handle_; +} + +void Win32Window::SetQuitOnClose(bool quit_on_close) { + quit_on_close_ = quit_on_close; +} + +bool Win32Window::OnCreate() { + // No-op; provided for subclasses. + return true; +} + +void Win32Window::OnDestroy() { + // No-op; provided for subclasses. +} + +void Win32Window::UpdateTheme(HWND const window) { + DWORD light_mode; + DWORD light_mode_size = sizeof(light_mode); + LSTATUS result = RegGetValue(HKEY_CURRENT_USER, kGetPreferredBrightnessRegKey, + kGetPreferredBrightnessRegValue, + RRF_RT_REG_DWORD, nullptr, &light_mode, + &light_mode_size); + + if (result == ERROR_SUCCESS) { + BOOL enable_dark_mode = light_mode == 0; + DwmSetWindowAttribute(window, DWMWA_USE_IMMERSIVE_DARK_MODE, + &enable_dark_mode, sizeof(enable_dark_mode)); + } +} diff --git a/windows/runner/win32_window.h b/windows/runner/win32_window.h new file mode 100644 index 0000000..e901dde --- /dev/null +++ b/windows/runner/win32_window.h @@ -0,0 +1,102 @@ +#ifndef RUNNER_WIN32_WINDOW_H_ +#define RUNNER_WIN32_WINDOW_H_ + +#include + +#include +#include +#include + +// A class abstraction for a high DPI-aware Win32 Window. Intended to be +// inherited from by classes that wish to specialize with custom +// rendering and input handling +class Win32Window { + public: + struct Point { + unsigned int x; + unsigned int y; + Point(unsigned int x, unsigned int y) : x(x), y(y) {} + }; + + struct Size { + unsigned int width; + unsigned int height; + Size(unsigned int width, unsigned int height) + : width(width), height(height) {} + }; + + Win32Window(); + virtual ~Win32Window(); + + // Creates a win32 window with |title| that is positioned and sized using + // |origin| and |size|. New windows are created on the default monitor. Window + // sizes are specified to the OS in physical pixels, hence to ensure a + // consistent size this function will scale the inputted width and height as + // as appropriate for the default monitor. The window is invisible until + // |Show| is called. Returns true if the window was created successfully. + bool Create(const std::wstring& title, const Point& origin, const Size& size); + + // Show the current window. Returns true if the window was successfully shown. + bool Show(); + + // Release OS resources associated with window. + void Destroy(); + + // Inserts |content| into the window tree. + void SetChildContent(HWND content); + + // Returns the backing Window handle to enable clients to set icon and other + // window properties. Returns nullptr if the window has been destroyed. + HWND GetHandle(); + + // If true, closing this window will quit the application. + void SetQuitOnClose(bool quit_on_close); + + // Return a RECT representing the bounds of the current client area. + RECT GetClientArea(); + + protected: + // Processes and route salient window messages for mouse handling, + // size change and DPI. Delegates handling of these to member overloads that + // inheriting classes can handle. + virtual LRESULT MessageHandler(HWND window, + UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept; + + // Called when CreateAndShow is called, allowing subclass window-related + // setup. Subclasses should return false if setup fails. + virtual bool OnCreate(); + + // Called when Destroy is called. + virtual void OnDestroy(); + + private: + friend class WindowClassRegistrar; + + // OS callback called by message pump. Handles the WM_NCCREATE message which + // is passed when the non-client area is being created and enables automatic + // non-client DPI scaling so that the non-client area automatically + // responds to changes in DPI. All other messages are handled by + // MessageHandler. + static LRESULT CALLBACK WndProc(HWND const window, + UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept; + + // Retrieves a class instance pointer for |window| + static Win32Window* GetThisFromHandle(HWND const window) noexcept; + + // Update the window frame's theme to match the system theme. + static void UpdateTheme(HWND const window); + + bool quit_on_close_ = false; + + // window handle for top level window. + HWND window_handle_ = nullptr; + + // window handle for hosted content. + HWND child_content_ = nullptr; +}; + +#endif // RUNNER_WIN32_WINDOW_H_