Skip to main content

Comprehensive Example

This page provides a single, comprehensive example demonstrating all major features of Zorphy. It mirrors the comprehensive_example.dart file.

Basic Definition & Patching​

@Zorphy(generatePatch: true)
abstract class $User {
  String get name;
  int get age;
  String? get email;
}

// Usage
final user = User(name: 'Alice', age: 30);
final patched = user.patchWithUser(
  patchInput: UserPatch.create()..withName('Bob'),
);

JSON Serialization​

@Zorphy(generateJson: true)
abstract class $Product {
  String get id;
  String get name;
  double get price;
  bool get inStock;
}

// Serialization
final json = product.toJson();
final product2 = Product.fromJson(json);

Sealed Classes & Polymorphism​

@Zorphy(generateJson: true, explicitSubTypes: [$CreditCard, $PayPal])
abstract class $$PaymentMethod {
  String get displayName;
}

@Zorphy(generateJson: true)
abstract class $CreditCard implements $$PaymentMethod {
  String get cardNumber;
  String get expiryDate;
  @override String get displayName => 'Credit Card';
}

Enum Support​

enum UserStatus { active, inactive, suspended, pending }

@Zorphy(generateJson: true)
abstract class $Account {
  String get username;
  UserStatus get status;
  DateTime get createdAt;
}

Function-based CopyWith​

@Zorphy(generateCopyWithFn: true)
abstract class $Counter {
  int get value;
  String get label;
}

// Increment using function
final next = counter.copyWithFn(value: (current) => current + 1);

Nested Objects & Patching​

@Zorphy()
abstract class $Address {
  String get street;
  String get city;
}

@Zorphy()
abstract class $PersonWithAddress {
  String get name;
  $Address get address;
}

// Nested patching
final patched = person.patchWithPersonWithAddress(
  patchInput: PersonWithAddressPatch.create()
    ..withAddressPatch(AddressPatch.create()..withCity('New York')),
);

Self-Referencing Trees​

@Zorphy(generateJson: true)
abstract class $CategoryNode {
  String get id;
  String get name;
  List<$CategoryNode>? get children;
  $CategoryNode? get parent;
}

Multiple Inheritance​

@Zorphy()
abstract class $Timestamped {
  DateTime get createdAt;
  DateTime? get updatedAt;
}

@Zorphy()
abstract class $Identified {
  String get id;
}

@Zorphy()
abstract class $Post implements $Timestamped, $Identified {
  String get title;
  String get content;
}

CompareTo & Diffs​

@Zorphy(generateCompareTo: true, generateJson: true)
abstract class $Document {
  String get title;
  int get version;
}

// Get structural difference
final diff = doc1.compareToDocument(doc2);
// Result: {'version': 2}

Generic Classes​

@Zorphy(generateJson: false)
abstract class $Result<T> {
  bool get success;
  T? get data;
  String? get errorMessage;
}

Explicit Subtypes & changeTo​

@Zorphy(explicitSubTypes: [$Circle, $Rectangle])
abstract class $$Shape {
  String get name;
}

// Convert between subtypes
final rect = circle.changeToRectangle(width: 10.0, height: 15.0);

Constants & Defaults​

@Zorphy()
abstract class $Color {
  int get red;
  int get green;
  int get blue;
  const $Color();
}

@Zorphy()
abstract class $StartupOptions {
  const $StartupOptions();
  Duration? get timeout => Duration(seconds: 5);
}