パッケージ、リポジトリ、アプリカテゴリを検索

パッケージ詳細v1.2.0

functional_data

`function_data_generator` パッケージで生成されたコード用のレンズ用のアノテーションとヘルパー。

AndroidiOSWebmacOSWindowsLinux
30日間ダウンロード
18.1万
いいね数
19
Pub ポイント
150

パッケージをインストール

flutter pub add functional_data

パッケージ概要

公開情報に基づく選定ガイドです。参考としてご利用ください。

FunctionalData は、ネストされたデータ構造にアクセスおよび変更するための関数型プログラミングコンストラクトである「レンズ」を作成するためのアノテーションとユーティリティヘルパーを提供する Dart パッケージです。`function_data_generator` コードジェネレーターと連携して、ボイラープレートフリーで不変なデータクラスを自動生成し、強力な更新機能を備えています。このパッケージは、ミューテーションなしに深くネストされたオブジェクトに対して安全かつ合成可能な更新を可能にし、Flutter および Dart アプリケーションにおける関数型プログラミングの原則を推進します。状態管理やデータ変換ワークフローに最適です。

用途

  • 不変状態の更新
  • ネストされたデータ操作
  • Flutter アプリにおける状態管理
  • 関数型プログラミングパターン
  • データクラスのコード生成

主な機能

  • 自動レンズ生成
  • 不変性のサポート
  • 深くネストされた更新
  • 型安全な変換
  • コードジェネレーターとの統合

適している対象

  • 関数型プログラミングを使用する開発者
  • 複雑な状態を持つFlutterアプリ
  • 不変性を優先するチーム
  • コード生成ワークフロー
  • データ集約型アプリケーション

注意事項

  • `function_data_generator`が必要です
  • レンズの学習曲線
  • 制限された実行時リフレクション
  • 単純なデータモデルには適していません
  • 追加のビルド手順が必要です

元の README

関連するソースリポジトリの README 原文のスナップショットです。最新の内容はリポジトリをご覧ください。

Functional Data

Build

Simple and non-intrusive code generator for boilerplate of data types. The package generates a simple mixin with operator==, hashCode, copyWith, toString, as well as lenses.

Boiler plate

Because the boiler plate is generated as a mixin, it is minimally intrusive on the interface of the class. You only have to provide a constructor with named arguments for all fields and extend the generated mixin.

@FunctionalData()
class Person extends $Person {
  final String name;
  final int age;

  const Person({this.name, this.age});

  const Person.anonymous() : this(name: "John Doe", age: null);

  int get ageInDays => numberOfDaysInMostYears * age;

  static const numberOfDaysInMostYears = 356;
}

Because of this design, you have complete control over the class. You can, for example, add named constructors or methods to the class like you're used to.

Lenses

For every class, lenses are generated for all fields which allow viewing a field or creating a new instance of the classes with that field modified in some way. For example, the lens of Person's name is Person$.name. To focus a lens on a specific instance use its of method:

final teacher = Person(name: "Arthur", age: 53);

print(Person$.name.of(teacher).value);
// -> "Arthur"

print(Person$.age.of(teacher).update(60);
// -> Person(name: "Arthur", age: 60)

print(Person$.name.of(teacher).map((name) => name.toUpperCase()));
// -> Person(name: "ARTHUR", age: 53)

This isn't very exciting yet. The power of lenses comes to light when you combine them. It allows you to easily create a copy of a large nested data structure with one of the fields in a leaf modified. Two lenses can be chained using then.

class Course extends $Course {
  final String name;
  final List<Person> students;

  const Course({this.students});
}

final programming = Course(name: "Programming 101", students: [Person(name: "Jane", age: 21), Person(name: "Tom", age: 20)]);

final firstStudentsName = Course$.students.then(List$.first<Person>()).then(Person$.name);

print(firstStudentsName.of(programming).update("Marcy"));
// -> Course(students: [Person(name: "Marcy", age: 21), Person(name: "Tom", age: 20)]

Compare this with the alternative:

final firstStudent = programming.students.first;
final updatedFirstStudent = Person(name: "Marcy", age: firstStudent.age);
final updatedStudents = [updatedFirstStudent] + programming.students.skip(1);
final updatedCourse = Course(name: programming.name, students: updatedStudents);

This is much less readable and error prone. Imagine what happens when one of the classes gains a field.

Full example:
// lens.dart
import 'package:collection/collection.dart';

import 'package:functional_data/functional_data.dart';

part 'lens.g.dart';

// Only requirement is that it has a constructor with named arguments for all fields
@FunctionalData()
class Foo extends $Foo {
  final int number;
  final String name;

  const Foo({this.number, this.name});
}

@FunctionalData()
class Bar extends $Bar {
  final Foo foo;

  @CustomEquality(DeepCollectionEquality())
  final List<Foo> foos;

  final String driver;

  const Bar({this.foo, this.foos, this.driver});
}

void main() {
  final foo = Foo(number: 42, name: "Marvin");
  final bar = Bar(foo: foo, foos: [Foo(number: 101, name: "One"), Foo(number: 102, name: "Two")], driver: "One");

  final fooName = Bar$.foo.then(Foo$.name);
  // print(fooName.map((name) => name.toUpperCase(), bar));
  print(fooName.of(bar).map((name) => name.toUpperCase()));
  // Bar(foo: Foo(number: 42, name: MARVIN), foos: [Foo(number: 101, name: One), Foo(number: 102, name: Two)], driver: One)

  final firstFooName = Bar$.foos.then(List$.atIndex<Foo>(0)).then(Foo$.name);
  // print(firstFooName.update(bar, "Twee"));
  print(firstFooName.of(bar).update("Twee"));
  // Bar(foo: Foo(number: 42, name: Marvin), foos: [Foo(number: 101, name: Twee), Foo(number: 102, name: Two)], driver: One)

  final nameOfFooNamedTwo = Bar$.foos.then(List$.where<Foo>((foo) => foo.name == "Two")).then(Foo$.name);
  print(nameOfFooNamedTwo.update(bar, "Due"));
  // Bar(foo: Foo(number: 42, name: Marvin), foos: [Foo(number: 101, name: One), Foo(number: 102, name: Due)], driver: One)

  final driversNumber =
      Bar$.foos.thenWithContext((bar) => List$.where<Foo>((foo) => foo.name == bar.driver).then(Foo$.number));
  print(driversNumber.of(bar).value);
  // 101
}

Code generation configuration

Class level configuration

To specify which features should be generated for the class, you can send arguments to @FunctionalData generator.

Example:

@FunctionalData(
  generateCopy: false,
  generateLenses: false,
)
class Foo extends _$Foo {}
Project level configuration

To specify which features should be generated for you whole project, create a file called functional_data_options.yaml in the root of your project. Class specific arguments will override the project level configuration.

Example with all possible configurations:

generateCopyWith: false
generateCopyUsing: false
generateLenses: false

Contributing

Setup

This project uses melos to manage all the packages inside this repo.

  1. Install melos via the top level workspace dart pub get.
  2. Setup melos to point to the dependencies in your local folder: melos bootstrap

Testing the Code generator:

  • Either run melos generate:dart in the top level folder, or dart run build_runner build in the example folder.

カテゴリー

依存関係

依存関係一覧 2 件

ソースリポジトリ

このパッケージを使用しているプロジェクト