Merge pull request #11 from VGVentures/feat/character-theming

feat: add theming for different characters

.github/workflows/pinball_theme.yaml

@@ -0,0 +1,18 @@
+name: pinball_theme
+
+on:
+  push:
+    paths:
+      - "packages/pinball_theme/**"
+      - ".github/workflows/pinball_theme.yaml"
+
+  pull_request:
+    paths:
+      - "packages/pinball_theme/**"
+      - ".github/workflows/pinball_theme.yaml"
+
+jobs:
+  build:
+    uses: VeryGoodOpenSource/very_good_workflows/.github/workflows/flutter_package.yml@v1
+    with:
+      working_directory: packages/pinball_theme

lib/theme/cubit/theme_cubit.dart

@@ -0,0 +1,13 @@
+import 'package:bloc/bloc.dart';
+import 'package:equatable/equatable.dart';
+import 'package:pinball_theme/pinball_theme.dart';
+
+part 'theme_state.dart';
+
+class ThemeCubit extends Cubit<ThemeState> {
+  ThemeCubit() : super(const ThemeState.initial());
+
+  void characterSelected(CharacterTheme characterTheme) {
+    emit(ThemeState(PinballTheme(characterTheme: characterTheme)));
+  }
+}

lib/theme/cubit/theme_state.dart

@@ -0,0 +1,13 @@
+part of 'theme_cubit.dart';
+
+class ThemeState extends Equatable {
+  const ThemeState(this.theme);
+
+  const ThemeState.initial()
+      : theme = const PinballTheme(characterTheme: DashTheme());
+
+  final PinballTheme theme;
+
+  @override
+  List<Object> get props => [theme];
+}

lib/theme/theme.dart

@@ -0,0 +1 @@
+export 'cubit/theme_cubit.dart';

packages/pinball_theme/.gitignore

@@ -0,0 +1,39 @@
+# Miscellaneous
+*.class
+*.log
+*.pyc
+*.swp
+.DS_Store
+.atom/
+.buildlog/
+.history
+.svn/
+
+# IntelliJ related
+*.iml
+*.ipr
+*.iws
+.idea/
+
+# VSCode related
+.vscode/
+
+# Flutter/Dart/Pub related
+**/doc/api/
+**/ios/Flutter/.last_build_id
+.dart_tool/
+.flutter-plugins
+.flutter-plugins-dependencies
+.packages
+.pub-cache/
+.pub/
+/build/
+
+# Web related
+lib/generated_plugin_registrant.dart
+
+# Symbolication related
+app.*.symbols
+
+# Obfuscation related
+app.*.map.json

packages/pinball_theme/README.md

@@ -0,0 +1,11 @@
+# pinball_theme
+
+[![style: very good analysis][very_good_analysis_badge]][very_good_analysis_link]
+[![License: MIT][license_badge]][license_link]
+
+Package containing themes for pinball game.
+
+[license_badge]: https://img.shields.io/badge/license-MIT-blue.svg
+[license_link]: https://opensource.org/licenses/MIT
+[very_good_analysis_badge]: https://img.shields.io/badge/style-very_good_analysis-B22C89.svg
+[very_good_analysis_link]: https://pub.dev/packages/very_good_analysis

packages/pinball_theme/analysis_options.yaml

@@ -0,0 +1 @@
+include: package:very_good_analysis/analysis_options.2.4.0.yaml

packages/pinball_theme/lib/pinball_theme.dart

@@ -0,0 +1,4 @@
+library pinball_theme;
+
+export 'src/pinball_theme.dart';
+export 'src/themes/themes.dart';

packages/pinball_theme/lib/src/pinball_theme.dart

@@ -0,0 +1,23 @@
+import 'package:equatable/equatable.dart';
+import 'package:pinball_theme/pinball_theme.dart';
+
+/// {@template pinball_theme}
+/// Defines all theme assets and attributes.
+///
+/// Game components should have a getter specified here to load their
+/// corresponding assets for the game.
+/// {@endtemplate}
+class PinballTheme extends Equatable {
+  /// {@macro pinball_theme}
+  const PinballTheme({
+    required CharacterTheme characterTheme,
+  }) : _characterTheme = characterTheme;
+
+  final CharacterTheme _characterTheme;
+
+  /// [CharacterTheme] for the chosen character.
+  CharacterTheme get characterTheme => _characterTheme;
+
+  @override
+  List<Object?> get props => [_characterTheme];
+}

packages/pinball_theme/lib/src/themes/android_theme.dart

@@ -0,0 +1,13 @@
+import 'package:flutter/material.dart';
+import 'package:pinball_theme/pinball_theme.dart';
+
+/// {@template android_theme}
+/// Defines Android character theme assets and attributes.
+/// {@endtemplate}
+class AndroidTheme extends CharacterTheme {
+  /// {@macro android_theme}
+  const AndroidTheme();
+
+  @override
+  Color get ballColor => Colors.green;
+}

packages/pinball_theme/lib/src/themes/character_theme.dart

@@ -0,0 +1,19 @@
+import 'package:equatable/equatable.dart';
+import 'package:flutter/material.dart';
+
+/// {@template character_theme}
+/// Base class for creating character themes.
+///
+/// Character specific game components should have a getter specified here to
+/// load their corresponding assets for the game.
+/// {@endtemplate}
+abstract class CharacterTheme extends Equatable {
+  /// {@macro character_theme}
+  const CharacterTheme();
+
+  /// Ball color for this theme.
+  Color get ballColor;
+
+  @override
+  List<Object?> get props => [ballColor];
+}

packages/pinball_theme/lib/src/themes/dash_theme.dart

@@ -0,0 +1,13 @@
+import 'package:flutter/material.dart';
+import 'package:pinball_theme/pinball_theme.dart';
+
+/// {@template dash_theme}
+/// Defines Dash character theme assets and attributes.
+/// {@endtemplate}
+class DashTheme extends CharacterTheme {
+  /// {@macro dash_theme}
+  const DashTheme();
+
+  @override
+  Color get ballColor => Colors.blue;
+}

packages/pinball_theme/lib/src/themes/dino_theme.dart

@@ -0,0 +1,13 @@
+import 'package:flutter/material.dart';
+import 'package:pinball_theme/pinball_theme.dart';
+
+/// {@template dino_theme}
+/// Defines Dino character theme assets and attributes.
+/// {@endtemplate}
+class DinoTheme extends CharacterTheme {
+  /// {@macro dino_theme}
+  const DinoTheme();
+
+  @override
+  Color get ballColor => Colors.grey;
+}

packages/pinball_theme/lib/src/themes/sparky_theme.dart

@@ -0,0 +1,13 @@
+import 'package:flutter/material.dart';
+import 'package:pinball_theme/pinball_theme.dart';
+
+/// {@template sparky_theme}
+/// Defines Sparky character theme assets and attributes.
+/// {@endtemplate}
+class SparkyTheme extends CharacterTheme {
+  /// {@macro sparky_theme}
+  const SparkyTheme();
+
+  @override
+  Color get ballColor => Colors.orange;
+}

packages/pinball_theme/lib/src/themes/themes.dart

@@ -0,0 +1,5 @@
+export 'android_theme.dart';
+export 'character_theme.dart';
+export 'dash_theme.dart';
+export 'dino_theme.dart';
+export 'sparky_theme.dart';

packages/pinball_theme/pubspec.yaml

@@ -0,0 +1,17 @@
+name: pinball_theme
+description: Package containing themes for pinball game.
+version: 1.0.0+1
+publish_to: none
+
+environment:
+  sdk: ">=2.16.0 <3.0.0"
+
+dependencies:
+  equatable: ^2.0.3
+  flutter:
+    sdk: flutter
+
+dev_dependencies:
+  flutter_test:
+    sdk: flutter
+  very_good_analysis: ^2.4.0

packages/pinball_theme/test/src/pinball_theme_test.dart

@@ -0,0 +1,28 @@
+// ignore_for_file: prefer_const_constructors
+
+import 'package:flutter_test/flutter_test.dart';
+import 'package:pinball_theme/pinball_theme.dart';
+
+void main() {
+  group('PinballTheme', () {
+    const characterTheme = SparkyTheme();
+
+    test('can be instantiated', () {
+      expect(PinballTheme(characterTheme: characterTheme), isNotNull);
+    });
+
+    test('supports value equality', () {
+      expect(
+        PinballTheme(characterTheme: characterTheme),
+        equals(PinballTheme(characterTheme: characterTheme)),
+      );
+    });
+
+    test('characterTheme is correct', () {
+      expect(
+        PinballTheme(characterTheme: characterTheme).characterTheme,
+        equals(characterTheme),
+      );
+    });
+  });
+}

packages/pinball_theme/test/src/themes/android_theme_test.dart

@@ -0,0 +1,21 @@
+// ignore_for_file: prefer_const_constructors
+
+import 'package:flutter/material.dart';
+import 'package:flutter_test/flutter_test.dart';
+import 'package:pinball_theme/pinball_theme.dart';
+
+void main() {
+  group('AndroidTheme', () {
+    test('can be instantiated', () {
+      expect(AndroidTheme(), isNotNull);
+    });
+
+    test('supports value equality', () {
+      expect(AndroidTheme(), equals(AndroidTheme()));
+    });
+
+    test('ballColor is correct', () {
+      expect(AndroidTheme().ballColor, equals(Colors.green));
+    });
+  });
+}

packages/pinball_theme/test/src/themes/dash_theme_test.dart

@@ -0,0 +1,21 @@
+// ignore_for_file: prefer_const_constructors
+
+import 'package:flutter/material.dart';
+import 'package:flutter_test/flutter_test.dart';
+import 'package:pinball_theme/pinball_theme.dart';
+
+void main() {
+  group('DashTheme', () {
+    test('can be instantiated', () {
+      expect(DashTheme(), isNotNull);
+    });
+
+    test('supports value equality', () {
+      expect(DashTheme(), equals(DashTheme()));
+    });
+
+    test('ballColor is correct', () {
+      expect(DashTheme().ballColor, equals(Colors.blue));
+    });
+  });
+}

packages/pinball_theme/test/src/themes/dino_theme_test.dart

@@ -0,0 +1,21 @@
+// ignore_for_file: prefer_const_constructors
+
+import 'package:flutter/material.dart';
+import 'package:flutter_test/flutter_test.dart';
+import 'package:pinball_theme/pinball_theme.dart';
+
+void main() {
+  group('DinoTheme', () {
+    test('can be instantiated', () {
+      expect(DinoTheme(), isNotNull);
+    });
+
+    test('supports value equality', () {
+      expect(DinoTheme(), equals(DinoTheme()));
+    });
+
+    test('ballColor is correct', () {
+      expect(DinoTheme().ballColor, equals(Colors.grey));
+    });
+  });
+}

packages/pinball_theme/test/src/themes/sparky_theme_test.dart

@@ -0,0 +1,21 @@
+// ignore_for_file: prefer_const_constructors
+
+import 'package:flutter/material.dart';
+import 'package:flutter_test/flutter_test.dart';
+import 'package:pinball_theme/pinball_theme.dart';
+
+void main() {
+  group('SparkyTheme', () {
+    test('can be instantiated', () {
+      expect(SparkyTheme(), isNotNull);
+    });
+
+    test('supports value equality', () {
+      expect(SparkyTheme(), equals(SparkyTheme()));
+    });
+
+    test('ballColor is correct', () {
+      expect(SparkyTheme().ballColor, equals(Colors.orange));
+    });
+  });
+}

pubspec.lock

@@ -324,6 +324,13 @@ packages:
       url: "https://pub.dartlang.org"
     source: hosted
     version: "1.8.0"
+  pinball_theme:
+    dependency: "direct main"
+    description:
+      path: "packages/pinball_theme"
+      relative: true
+    source: path
+    version: "1.0.0+1"
   pool:
     dependency: transitive
     description:

pubspec.yaml

@@ -18,6 +18,8 @@ dependencies:
   flutter_localizations:
     sdk: flutter
   intl: ^0.17.0
+  pinball_theme:
+    path: packages/pinball_theme
 
 dev_dependencies:
   bloc_test: ^9.0.2

test/theme/cubit/theme_cubit_test.dart

@@ -0,0 +1,22 @@
+import 'package:bloc_test/bloc_test.dart';
+import 'package:flutter_test/flutter_test.dart';
+import 'package:pinball/theme/theme.dart';
+import 'package:pinball_theme/pinball_theme.dart';
+
+void main() {
+  group('ThemeCubit', () {
+    test('initial state has Dash character theme', () {
+      final themeCubit = ThemeCubit();
+      expect(themeCubit.state.theme.characterTheme, equals(const DashTheme()));
+    });
+
+    blocTest<ThemeCubit, ThemeState>(
+      'charcterSelected emits selected character theme',
+      build: ThemeCubit.new,
+      act: (bloc) => bloc.characterSelected(const SparkyTheme()),
+      expect: () => [
+        const ThemeState(PinballTheme(characterTheme: SparkyTheme())),
+      ],
+    );
+  });
+}

test/theme/cubit/theme_state_test.dart

@@ -0,0 +1,19 @@
+// ignore_for_file: prefer_const_constructors
+
+import 'package:flutter_test/flutter_test.dart';
+import 'package:pinball/theme/theme.dart';
+
+void main() {
+  group('ThemeState', () {
+    test('can be instantiated', () {
+      expect(const ThemeState.initial(), isNotNull);
+    });
+
+    test('supports value equality', () {
+      expect(
+        ThemeState.initial(),
+        equals(const ThemeState.initial()),
+      );
+    });
+  });
+}