FEATURE REQUEST: Code Generation

[Arpit1496]

Is it possible to have code generation support for freezer classes to generate data sources boilerplate ?
It would be a good to have feature.

Hi @Arpit1496,

We have checked your query and unfortunately, we are unable to understand your requirement. Therefore, we kindly request that you provide us with more detailed information, including screenshots or screen recordings, so that we may better assist you.

Regards,
Lokesh.

[Arpit1496]

I want to eliminate the boilerplate of having to create a Datasource when I already know my Model classes and want Datagrid for the same. Let me try it with example where I am sharing my "real code" vs the expectations.

### THIS IS MY MODEL CLASS ###

@freezed
@ReactiveFormAnnotation()
@FormGroupAnnotation()
class LocationModel with _$LocationModel {
  const LocationModel._();
  const factory LocationModel({
    @FormControlAnnotation<String>(validators: [requiredValidator])
    required String id,
    @FormControlAnnotation<String>(validators: [requiredValidator])
    required String name,
    @FormControlAnnotation<GeoLocationModel>(validators: [requiredValidator])
    required GeoLocationModel geoLocation,
    @FormControlAnnotation<ThanaModel>(validators: [requiredValidator])
    required ThanaModel thana,
    @FormControlAnnotation<IList<SignalModel>>(validators: [requiredValidator])
    required IList<SignalModel> signals,
    @FormControlAnnotation<LocationConfigModel>(validators: [requiredValidator])
    required LocationConfigModel locationConfig,
  }) = Data;

  factory LocationModel.fromJson(Map<String, Object?> json) =>
      _$LocationModelFromJson(json);

  @override
  String toString() {
    return super.toString();
  }
}

###  THE DATASOURCE FOR THIS MODEL CLASS ###


enum ListLocationModelColumnNames {
  ID,
  NAME,
  GEO_LOCATION,
  THANA,
  SIGNALS,
  LOCATION_CONFIG,
  DATE
}

class ListLocationDataSource extends DataGridSource {
  final List<LocationModel> locations;

  ListLocationDataSource({required this.locations});
  @override
  List<DataGridRow> get rows => locations
      .map(
        (e) => DataGridRow(
          cells: <DataGridCell>[
            DataGridCell<String>(
              columnName: ListLocationModelColumnNames.ID.name,
              value: e.id,
            ),
            DataGridCell<String>(
              columnName: ListLocationModelColumnNames.NAME.name,
              value: e.name,
            ),
            DataGridCell<GeoLocationModel>(
              columnName: ListLocationModelColumnNames.GEO_LOCATION.name,
              value: e.geoLocation,
            ),
            DataGridCell<ThanaModel>(
              columnName: ListLocationModelColumnNames.THANA.name,
              value: e.thana,
            ),
            DataGridCell<IList<SignalModel>>(
              columnName: ListLocationModelColumnNames.SIGNALS.name,
              value: e.signals,
            ),
            DataGridCell<LocationConfigModel>(
              columnName: ListLocationModelColumnNames.LOCATION_CONFIG.name,
              value: e.locationConfig,
            ),
          ],
        ),
      )
      .toList();

  @override
  DataGridRowAdapter buildRow(DataGridRow row) {
    return DataGridRowAdapter(
      cells: row.getCells().map<Widget>((e) {
        return Container(
          alignment: Alignment.center,
          padding: const EdgeInsets.all(8.0),
          child: Text(e.value.toString()),
        );
      }).toList(),
    );
  }
}

###### SFDatagrid Widget ######

 SfDataGrid(
                allowSorting: true,
                allowFiltering: true,
                columnWidthMode: ColumnWidthMode.fill,
                allowMultiColumnSorting: true,
                headerGridLinesVisibility: GridLinesVisibility.both,
                gridLinesVisibility: GridLinesVisibility.horizontal,
                source:
                    ListLocationDataSource(locations: state.locations.unlock),
                columns: <GridColumn>[
                  GridColumn(
                    allowEditing: true,
                    allowFiltering: true,
                    allowSorting: true,
                    columnName: ListLocationModelColumnNames.ID.name,
                    label: Container(
                      padding: const EdgeInsets.all(16.0),
                      alignment: Alignment.center,
                      child: const Text(
                        'ID',
                      ),
                    ),
                  ),
                  GridColumn(
                      allowEditing: true,
                      allowFiltering: true,
                      allowSorting: true,
                      columnName: ListLocationModelColumnNames.NAME.name,
                      label: Container(
                          padding: const EdgeInsets.all(8.0),
                          alignment: Alignment.center,
                          child: const Text('Name'))),
                  GridColumn(
                      allowEditing: true,
                      allowFiltering: true,
                      allowSorting: true,
                      columnName:
                          ListLocationModelColumnNames.GEO_LOCATION.name,
                      label: Container(
                          padding: const EdgeInsets.all(8.0),
                          alignment: Alignment.center,
                          child: const Text(
                            'Geo Location',
                            overflow: TextOverflow.ellipsis,
                          ))),
                  GridColumn(
                      allowEditing: true,
                      allowFiltering: true,
                      allowSorting: true,
                      columnName: ListLocationModelColumnNames.THANA.name,
                      label: Container(
                          padding: const EdgeInsets.all(8.0),
                          alignment: Alignment.center,
                          child: const Text('Thana'))),
                  GridColumn(
                      allowEditing: true,
                      allowFiltering: true,
                      allowSorting: true,
                      columnName: ListLocationModelColumnNames.SIGNALS.name,
                      label: Container(
                          padding: const EdgeInsets.all(8.0),
                          alignment: Alignment.center,
                          child: const Text('Signals'))),
                  GridColumn(
                      allowEditing: true,
                      allowFiltering: true,
                      allowSorting: true,
                      columnName:
                          ListLocationModelColumnNames.LOCATION_CONFIG.name,
                      label: Container(
                          padding: const EdgeInsets.all(8.0),
                          alignment: Alignment.center,
                          child: const Text('Location Config'))),
                ],
              ),


~~~~~~~~~~~~~Expectations ~~~~~~~~~~~~~~~~

1). An annotation to mark a model class as datasource.
2). The code generation should generate the following things for the classes marked as Datasources:
     a). An Enum with All fields Name which can be used as Column Names for typesafety.
     b). A Datasource class with all fields as Columns.
     c). BuildRow method should be overriden to use Switch Case to match the type of value to one of Fields from Model class and should Throw error of unimplmented to allow user to implement it as per there requirements.The toString() is good but gives less control.
     d). A SFDatagrid widget with all names from enum generated above as GridColumns to allow swift development.

3). I am still trying to do a prototype but I am sure I will be able to convert this data source to Default Cartesian Chart. May be we can generate that too in the future. It will be something of sort of a wrapper to change view of Datagrid from list to chart with a switch button above Datagrid.

[Tamilarasan-Paranthaman]

Hi @Arpit1496,

We have considered your request as a feature. We may implement this feature in any of our upcoming releases. At the planning stage for every release cycle, we review all open features and identify features for implementation based on specific parameters including product vision, technological feasibility, and customer interest. We will let you know when this feature is implemented. We appreciate your patience until then.

You can also communicate with us regarding the open features any time using our Feature Report page.

Feedback Link: 52163

Regards,
Tamilarasan

[ashok-kuvaraja]

Hi @Arpit1496,

We are closing this issue now. Please feel free to follow up about this feature through the provided feedback link. If you need any more help, reopen this issue. We are always happy to help you.

Regards,
Ashok K