Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/s0punk/flutter_fit_utils
A flutter package to easily manage data in and out of repositories. This package is the core of it's environement.
https://github.com/s0punk/flutter_fit_utils
Last synced: 29 days ago
JSON representation
A flutter package to easily manage data in and out of repositories. This package is the core of it's environement.
- Host: GitHub
- URL: https://github.com/s0punk/flutter_fit_utils
- Owner: s0punk
- License: mit
- Created: 2024-05-18T19:32:06.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-09-24T18:06:20.000Z (about 2 months ago)
- Last Synced: 2024-10-03T08:24:09.029Z (about 1 month ago)
- Language: Dart
- Homepage: https://pub.dev/packages/flutter_fit_utils
- Size: 341 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
A flutter package to easily manage data in and out of repositories.
This package is the core of it's environement. To know about other packages related to flutter_fit_utils, see the diagram below.
## Features
Use this package to:
- Get a uniform way of reading and writing data with Models.
- Create a repository and a service for your data with a single line of code.
- Get access to extensions for multiple flutter base classes.
Here are the supported repositories:
- Firebase Firestore
- Hive
- Firebase Remote Config (Read Only)
- shared_preferences
- Firebase Storage (soon)
## Getting started
- Go inside your pubspec.yaml file
- Add this line under the dependencies:
```
flutter_fit_utils: ^2.0.0
```
- Get dependencies
```
flutter pub get
```
## Usage
### Creating a model
Make a class Modelable so it can be managed by a service and sent to a repository. For example:
```dart
import 'package:flutter_fit_utils/flutter_fit_utils.dart';
/// Example user class.
class User extends Modelable {
static const String _nameKey = "name";
/// User's last name.
final String name;
/// Creates a new user.
const User({this.name = "", super.id, super.userId});
/// Creates an invalid user.
const User.invalid() : name = "", super.invalid();
/// Creates a user from a [Model].
User.fromModel(super.model) :
name = model.data[_nameKey].toString(),
super.fromModel();
@override
User copyWith({String? id, String? userId, bool? invalid, String? name}) => User(
name: name ?? this.name,
id: id ?? this.id,
userId: userId ?? this.userId,
);
@override
Model toModel() => Model(
id: id,
userId: userId,
data: {
_nameKey: name,
},
);
}
```
If creating an entire class is too much for your use case, this package offers extensions to convert primitive types to Models:
```dart
final int myValue = 1;
/// Write.
final Model model = myValue.toModel();
/// Read.
final int otherValue = intFromModel(model);
```
Here are the supported types:
- int
- double
- num
- bool
- String
- List (Of Modelable objects)
- Map
### Managing your model with a service
You can create a service for your model with a single line of code:
```dart
import 'package:flutter_fit_utils/flutter_fit_utils.dart';
final Service service = FirestoreService("my_user_collection", User.fromModel);
```
This example automatically uses a FirestoreCollection repository. In the case of FirestoreCollection, the only thing you have to do
is go to your Firebase project, and create a new collection "my_user_collection" in your database.
If you want more control over your service, you can also create a custom one:
```dart
import 'package:flutter_fit_utils/flutter_fit_utils.dart';
final class CustomUserService extends Service {
CustomUserService(super.repositoryId, super.fromModelFactory) {
repository = FirestoreCollection(collectionId: repositoryId);
}
@override
Future> getAll({String? userId, Where? where, String? orderBy, bool descending = true}) async {
// Implement your custom logic...
}
}
```
Note that you can override any function of the base Service class.
## Additional information
Feel free to [give any feedback](https://github.com/s0punk/flutter_fit_utils/issues) ! This package is also open to contributions.