spkersten / dart_functional_data Goto Github PK

View Code? Open in Web Editor NEW

41.0 4.0 15.0 142 KB

Simple and non-intrusive code generator for lenses and boilerplate of data types

Home Page: https://pub.dev/packages/functional_data

License: MIT License

Dart 100.00%

dart flutter-package flutter functional lenses code-generator boilerplate

dart_functional_data's People

Contributors

Stargazers

Watchers

Forkers

miguelcmedeiros modulovalue derolf remonh87 resideo kika arturaz samuelokellogum tadasvalaitiz gabrielgarciagava thomasmaloney-wk doris962 ened

dart_functional_data's Issues

The type of `other` in the generated equality method is dynamic

This leads to type errors when the equality class specified with CustomEquality has specific types:

error: The argument type 'dynamic' can't be assigned to the parameter type 'int'. (argument_type_not_assignable at ...)

Generics are not passed on

@FunctionalData()
class Generic<T> extends $Generic<T> {
    final T generic;

    const Generic({
        @required this.generic,
    });
}

generates:

abstract class $Generic {
  T get generic;
  const $Generic();
  Generic copyWith({T generic}) => Generic(generic: generic ?? this.generic);
  String toString() => "Generic(generic: $generic)";
  bool operator ==(dynamic other) =>
      other.runtimeType == runtimeType && generic == other.generic;
  @override
  int get hashCode {
    var result = 17;
    result = 37 * result + generic.hashCode;
    return result;
  }
}

But it should generate:

abstract class $Generic<T> {
  T get generic;
  const $Generic();
  Generic<T> copyWith({T generic}) => Generic(generic: generic ?? this.generic);
  ...
}

Problem with static const fields

When i try do something like
static const _minCnt = 1;
static const _maxCnt = 6;

class Model extends $Model {
  static const _minCnt = 1;
  static const _maxCnt = 6;
...

i got errorous implementation :

abstract class $Model {
  int get _minCnt;
  int get _maxCnt;
  const $Model();
  Model copyWith(
          {int _minCnt,
          int _maxCnt,

Class can't be used as mixin because it declares constructor...

in your sample:

@FunctionalData()
class Foo with $Foo {
  final int number;
  final String name;

  // Can't be const because of mixin
  Foo({this.number, this.name});
}

in real life i got error Class can't be used as mixin because it declares constructor...

@immutable
@FunctionalData()
class Base with $Base{
  final int uid;
  final int editTime;

  Base({this.uid, this.editTime});
}

Possible to generate `merge` and `apply` methods too?

Hi! First off, I love this package. It has solved so many problems for me.

My current use case is when a user signs in, I have their configuration for the app saved in Firebase. If it's their first time signing in, I have to populate it with reasonable empty fields. This is what that currently looks like:

// Configuration extends $Configuration and also uses json_serializable
//
// Inside document.get().then((snapshot) =>
final empty = Configuration.empty();

if (snapshot.exists) {
  final configuration = Configuration.fromJson(snapshot.data);

  await configurationDocument.setData(
    Configuration(
      primaryColor: configuration.primaryColor ?? empty.primaryColor,
      // A lot more fields . . .
    ).toJson(),
  );
} else {
  await configurationDocument.setData(empty.toJson());
}

With merge I think could just say something like:

await configurationDocument.setData(
  configuration.merge(empty).toJson()
);

Incorrect code generated for function type with only named parameters

void Function(, {String interactionType}) apply;

Data generated violates 2 lint errors

When I generate code for the following class

@FunctionalData()
class Bar extends $Bar{
  Bar({this.foo});

  final String foo;
}

It results in:

// GENERATED CODE - DO NOT MODIFY BY HAND

part of 'bar.dart';

// **************************************************************************
// FunctionalDataGenerator
// **************************************************************************

// ignore_for_file: join_return_with_assignment
// ignore_for_file: avoid_classes_with_only_static_members
// ignore_for_file: non_constant_identifier_names
// ignore_for_file: avoid_equals_and_hash_code_on_mutable_classes
abstract class $Bar {
  const $Bar();
  String get foo;
  Bar copyWith({String foo}) => Bar(foo: foo ?? this.foo);
  @override
  String toString() => "Bar(foo: $foo)";
  @override
  bool operator ==(dynamic other) =>
      other.runtimeType == runtimeType && foo == other.foo;
  @override
  int get hashCode {
    var result = 17;
    result = 37 * result + foo.hashCode;
    return result;
  }
}

class Bar$ {
  static final foo =
      Lens<Bar, String>((s_) => s_.foo, (s_, foo) => s_.copyWith(foo: foo));
}

This generated code has 2 violations to dart lint.

prefer_single_quotes (toString method)
always_specify_types (Lenses and hashcode)

I will submit a pr that will fix this.

Flutter types typed as dynamic

There's a weird bug that occurs when using flutter types.

...
import 'package:functional_data/functional_data.dart';
import 'package:flutter/material.dart';
...

part 'blend_mode.g.dart';

@FunctionalData()
class BlendModeData extends $BlendModeData {

    final BlendMode mode;

    const BlendModeData({
        @required this.mode,
    });

    const BlendModeData.deflt() : mode = BlendMode.srcOver;
}

would lead to

// GENERATED CODE - DO NOT MODIFY BY HAND

part of 'blend_mode.dart';

// **************************************************************************
// FunctionalDataGenerator
// **************************************************************************

abstract class $BlendModeData {
  dynamic get mode;
  const $BlendModeData();
  BlendModeData copyWith({dynamic mode}) =>
      BlendModeData(mode: mode ?? this.mode);
  String toString() => "BlendModeData(mode: $mode)";
  bool operator ==(dynamic other) =>
      other.runtimeType == runtimeType && mode == other.mode;
  @override
  int get hashCode {
    var result = 17;
    result = 37 * result + mode.hashCode;
    return result;
  }
}

class BlendModeData$ {
  static final mode = Lens<BlendModeData, dynamic>(
      (s_) => s_.mode, (s_, mode) => s_.copyWith(mode: mode));
}

Where mode should not be dynamic but BlendMode.

Everything works fine with non-flutter types.
Am I doing something wrong or is this a real issue?

Support constructors with positional arguments

Collections are incorrect in equals.

=() generates incorrect code for collection so

@FunctionalData()
class MyList extends $MyList{
  final List<int> items;

  MyList({this.items});
}


  test('list test', (){

    final list1 = MyList(items: [1,2,3]);
    final list2 = MyList(items: [1,2,3]);
    expect(list2, equals(list1));

  });

makes error.

It's all because of incorrect collection equality, see https://stackoverflow.com/questions/10404516/how-can-i-compare-lists-for-equality-in-dart

Generics are ignored

For a class like:

class Holder<T>{
   final T t;
   Holder(this.t);
}

The generated Lenses remove the type parameter. It would be nice to have a lens of type Lens<Holder<T>,T> but instead we get Lens<Holder,T> which does not compile.

Could the generated class keep private with the original class?

The original class _ViewModel is private, but the generated class is $_ViewModel, which is not private. It lead to name conflict when export multiple modules that have the same class _ViewModel, but this should be ok.

copyWith handles nulls incorrectly

hi,

final copyWith = '$className copyWith({${fields.map((f) => '${f.type} ${f.name}').join(', ')}}) => $className(${fields.map((f) => '${f.name}: ${f.name} ?? this.${f.name}').join(', ')});';

Generated code doesn't update nullable properties. E.g. x.copyWith(myProp: null) ignores myProp.