Heavy repository package

A brick that generates a repository package with an api client, data persistence and more..

How to use 🚀

mason make heavy_repository_package --package_name=MyRepository --package_description=Description --flutter=true --analysis=true

Variables ✨

Bricks Used 🧱

Outputs 📦

.
├── .json_models
│   └── response.jsonc
├── lib
│   ├── my_repository.dart
│   └── src
│       ├── client
│       │   ├── my_repository_client.dart
│       │   └── my_repository_client.g.dart
│       ├── models
│       │   ├── models.dart
│       │   └── user
│       │       ├── data.dart
│       │       ├── data.freezed.dart
│       │       ├── data.g.dart
│       │       ├── user.dart
│       │       ├── user.freezed.dart
│       │       └── user.g.dart
│       ├── i_my_repository.dart
│       └── my_repository.dart
├── README.md
├── analysis_options.yaml
├── pubspec.lock
├── pubspec.yaml
└── test
    └── src
        └── my_repository_test.dart

Json Models

This template assumes you use Json-to-Dart-Model to generate json models from reference files in the .json_models folder.

[
    {
        "__className": "user",
        "__path": "/lib/src/models/user",
        "status": "success",
        "message": "",
        "data": {
            "firstName": "prince",
            "lastName": "nna"
        }
    }
]

Client

This template also assumes that you use Dio as your HTTP adapter and Retrofit as your request generator. The client file is a retrofit class for all your network requests.

import 'package:dio/dio.dart';
import 'package:my_repository/my_repository.dart';
import 'package:retrofit/retrofit.dart';

part 'my_repository_client.g.dart';

@RestApi()
abstract class MyRepositoryClient {
  factory MyRepositoryClient(Dio dio, {String baseUrl}) = _MyRepositoryClient;

  @GET('/user/me')
  Future<User> getUser();
}

Repository

This template assumes you prefer to use functional programming types and methods such as the Either type to handle errors, instead of the traditional try-catch system.

It also assumes that you use stash to cache responses from the Client.

import 'package:dio/dio.dart';
import 'package:fpdart/fpdart.dart';
import 'package:my_repository/my_repository.dart';
import 'package:my_repository/src/client/my_repository_client.dart';
import 'package:rxdart/rxdart.dart';
import 'package:stash/stash_api.dart';

part 'i_my_repository.dart';

/// {@template my_repository}
/// MyRepository description
/// {@endtemplate}
class MyRepository implements IMyRepository {
  /// {@macro my_repository}
  MyRepository({
    required Cache<User> cache,
    MyRepositoryClient? client,
  })  : _cache = cache,
        _client = client ?? MyRepositoryClient(Dio());

  final Cache<User> _cache;
  final MyRepositoryClient _client;

  @override
  TaskEither<String, User> meUser() {
    //TODO: Add Logic
    return TaskEither<String, User>.tryCatch(
      () async {
        final response = await _client.getUser();
        // Store response in cache
        await _cache.put(IMyRepository.cacheKey, response);

        return response;
      },
      (error, stackTrace) => 'error',
    );
  }

  /// Cached data.
  @override
  Future<User?> get userData {
    return _cache.get(IMyRepository.cacheKey);
  }
	
  /// Cached data accessible as a stream 
  /// with the value from [userData] injected as the initial data.
  @override
  Stream<User?> get userDataStream async* {
    final initial = await userData;

    yield* _cache
        .on<CacheEntryUpdatedEvent<User>>()
        .map((event) => event.newEntry.value as User?)
        .shareValueSeeded(initial);
  }
}

Sample Usage in App

void main() {
  // Create a store, 
  // you can create multiple caches from one store.
  final store = await newObjectboxLocalCacheStore();
  // Create a cache for users.
  final cache = await store.cache<User>(
      name: 'user',
      fromEncodable: User.fromJson,
  );
  
  // Create a repository with cache.
  final repository = MyRepository(cache: cache);
}

Setup 🧑‍💻

Ensure you have the mason_cli installed.

# 🎯 Activate from https://pub.dev
dart pub global activate mason_cli

# 🍺 Or install from https://brew.sh
brew tap felangel/mason
brew install mason

Installation ☁️

# Install locally
mason add heavy_repository_package

# Install globally
mason add -g heavy_repository_package

Usage 🚀

mason make heavy_repository_package

Variables ✨

Hooks 🪝

• ✅   Pre-Gen
• ✅   Post-Gen

Environment 🌎

mason: "any"

0.1.0

• initial release 🎉

0.1.1

• Minor fixes

0.1.2

• Update docs

The MIT License (MIT) Copyright (c) 2020 Prince Nna

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.