doc

Author: AlexHCJP

.github/workflows/checkout.yml

@@ -0,0 +1,46 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Dart
+
+on:
+  pull_request:
+    branches: [ "main" ]
+    paths:
+      - 'lib/**'
+      - '.github/**'
+  push:
+    branches: [ "main" ]
+    paths:
+      - '.github/**'
+
+jobs:
+  checkout:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+
+      - name: Setup Flutter
+        uses: subosito/flutter-action@v2
+        with:
+          channel: stable
+          flutter-version: 3.24.3
+
+      - name: Install dependencies
+        run: flutter pub get
+
+      - name: Run tests with coverage
+        run: flutter test --coverage
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v4
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+
+      - name: Analyze project source
+        run: flutter analyze --fatal-infos --fatal-warnings lib/ test/
+

README.md

@@ -1,39 +1,164 @@
-<!--
-This README describes the package. If you publish this package to pub.dev,
-this README's contents appear on the landing page for your package.
 
-For information about how to write a good package README, see the guide for
-[writing package pages](https://dart.dev/tools/pub/writing-package-pages).
+# Pike
 
-For general information about developing packages, see the Dart guide for
-[creating packages](https://dart.dev/guides/libraries/create-packages)
-and the Flutter guide for
-[developing packages and plugins](https://flutter.dev/to/develop-packages).
--->
+![Pub Version](https://img.shields.io/pub/v/pike)
+![License](https://img.shields.io/github/license/contributors-company/pike)
+![Issues](https://img.shields.io/github/issues/contributors-company/pike)
+![Coverage](https://img.shields.io/codecov/c/github/contributors-company/pike)
+![Stars](https://img.shields.io/github/stars/contributors-company/pike)
 
-TODO: Put a short description of the package here that helps potential users
-know whether this package might be useful for them.
+`Pike` is a state management library for Flutter based on the **Event-Driven** pattern. It uses event streams to manage state and provides convenient components for interacting with the state, such as `PikeBuilder`, `PikeConsumer`, and `PikeProvider`.
 
 ## Features
 
-TODO: List what your package can do. Maybe include images, gifs, or videos.
+- **State management using events**: The state is updated in response to events.
+- **Components for listening to and displaying state**: `PikeBuilder`, `PikeConsumer`, and `PikeProvider` are used to manage and display state changes.
+- **Customizable event handling**: Allows for custom event handlers and selective state rebuilds.
 
-## Getting started
+## Installation
 
-TODO: List prerequisites and provide or point to information on how to
-start using the package.
+Add `pike` to your `pubspec.yaml` file:
+
+```yaml
+dependencies:
+  pike: ^latest_version
+```
 
 ## Usage
 
-TODO: Include short and useful examples for package users. Add longer examples
-to `/example` folder.
+### Creating a Pike instance
+
+Create a `Pike` instance by passing an initial state:
+
+```dart
+final class MockPike extends Pike<Event, State> {
+  MockPike() : super(InitialState()) {
+    on<Event>((event, emit) => switch(event) {
+      FetchEvent() => _callback(event, emit),
+      FetchWithExceptionEvent() => _callbackA(event, emit),
+    });
+
+  }
+
+  Future<void> _callback(FetchEvent event, Emit<State> emit) async {
+    emit(LoadedState());
+  }
+
+  void _callbackA(FetchWithExceptionEvent event, Emit<State> emit) {
+    emit(ExceptionState());
+  }
+}
+
+// Events
+
+sealed class Event {}
+
+class FetchEvent extends Event {}
+
+class FetchWithExceptionEvent extends Event {}
+
+// States
+
+sealed class State {}
+
+class InitialState extends State {}
+
+class LoadedState extends State {}
+
+class ExceptionState extends State {}
+```
+
+### Adding events
+
+Add events to the `Pike` instance to trigger state changes:
+
+```dart
+pike.add(MyEvent());
+```
+
+### Listening to state changes
+
+Use `PikeBuilder` or `PikeConsumer` to rebuild your widgets when the state changes:
+
+```dart
+PikeBuilder<MyPike, MyState>(
+  builder: (context, state) {
+    return Text('Current State: $state');
+  },
+);
+```
+
+### Providing the Pike instance
+
+Wrap your widget tree with `PikeProvider` to provide the `Pike` instance to the widgets:
+
+```dart
+PikeProvider<MyPike>(
+  pike: pike,
+  child: MyWidget(),
+);
+```
+
+### Custom event handling with `PikeObserver`
+
+You can implement `PikeObserver` to track the lifecycle and events of your `Pike` instances:
+
+```dart
+class MyPikeObserver extends PikeObserver {
+  @override
+  void onCreate<P extends Pike<Object?, Object?>>(P pike) {
+    print("Pike created");
+  }
+
+  @override
+  void onEvent<P extends Pike<Object?, Object?>, Event>(
+    P pike,
+    Event event,
+  ) {
+    print("Event occurred: $event");
+  }
+}
+```
+
+## Components
+
+### `PikeBuilder`
+
+A widget that listens to state changes and rebuilds when the state updates.
+
+```dart
+PikeBuilder<MyPike, MyState>(
+  builder: (context, state) {
+    return Text('Current State: $state');
+  },
+);
+```
+
+### `PikeConsumer`
+
+A widget that listens to state changes and provides a custom listener to trigger side effects.
+
+```dart
+PikeConsumer<MyPike, MyState>(
+  builder: (context, state) {
+    return Text('Current State: $state');
+  },
+  listener: (context, state) {
+    // Handle side effects here
+  },
+);
+```
+
+### `PikeProvider`
+
+A widget that provides a `Pike` instance to its descendants.
 
 ```dart
-const like = 'sample';
+PikeProvider<MyPike>(
+  pike: pike,
+  child: MyWidget(),
+);
 ```
 
-## Additional information
+## Codecov
 
-TODO: Tell users more about the package: where to find more information, how to
-contribute to the package, how to file issues, what response they can expect
-from the package authors, and more.

analysis_options.yaml

@@ -39,7 +39,8 @@ analyzer:
 linter:
   rules:
     # Public packages
-    public_member_api_docs: true
+    ## TODO
+    public_member_api_docs: false
     lines_longer_than_120_chars: true
 
     # Enabling rules

pubspec.yaml

@@ -1,7 +1,26 @@
 name: pike
-description: "A new Flutter project."
+description: "Pike is an event-driven state management library, enabling efficient state updates and handling through events."
 version: 0.0.1
-homepage:
+homepage: https://www.contributors.info/repository/pike
+
+repository: https://github.com/contributors-company/pike
+
+issue_tracker: https://github.com/contributors-company/pike/issues
+
+topics:
+  - pike
+  - state-management
+  - state
+  - event-driven
+
+platforms:
+  android:
+  ios:
+  linux:
+  macos:
+  web:
+  windows:
+
 
 environment:
   sdk: ^3.5.4

test/mocks/mock_pike.dart

@@ -12,12 +12,10 @@ final class MockPike extends Pike<Event, State> {
   }
 
   Future<void> _callback(FetchEvent event, Emit<State> emit) async {
-    print(event);
     emit(LoadedState());
   }
 
   void _callbackA(FetchWithExceptionEvent event, Emit<State> emit) {
-    print(event);
     emit(ExceptionState());
   }
 }