Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions examples/example/lib/gen/assets.gen.dart
Original file line number Diff line number Diff line change
Expand Up @@ -359,6 +359,7 @@ class SvgGenImage {
AlignmentGeometry alignment = Alignment.center,
bool allowDrawingOutsideViewBox = false,
WidgetBuilder? placeholderBuilder,
_svg.SvgErrorWidgetBuilder? errorBuilder,
String? semanticsLabel,
bool excludeFromSemantics = false,
_svg.SvgTheme? theme,
Expand Down Expand Up @@ -395,6 +396,7 @@ class SvgGenImage {
alignment: alignment,
allowDrawingOutsideViewBox: allowDrawingOutsideViewBox,
placeholderBuilder: placeholderBuilder,
errorBuilder: errorBuilder,
semanticsLabel: semanticsLabel,
excludeFromSemantics: excludeFromSemantics,
colorFilter: colorFilter ??
Expand Down
2 changes: 2 additions & 0 deletions examples/example_resources/lib/gen/assets.gen.dart
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,7 @@ class SvgGenImage {
AlignmentGeometry alignment = Alignment.center,
bool allowDrawingOutsideViewBox = false,
WidgetBuilder? placeholderBuilder,
_svg.SvgErrorWidgetBuilder? errorBuilder,
String? semanticsLabel,
bool excludeFromSemantics = false,
_svg.SvgTheme? theme,
Expand Down Expand Up @@ -230,6 +231,7 @@ class SvgGenImage {
alignment: alignment,
allowDrawingOutsideViewBox: allowDrawingOutsideViewBox,
placeholderBuilder: placeholderBuilder,
errorBuilder: errorBuilder,
semanticsLabel: semanticsLabel,
excludeFromSemantics: excludeFromSemantics,
colorFilter: colorFilter ??
Expand Down
3 changes: 3 additions & 0 deletions packages/core/lib/generators/assets_generator.dart
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,9 @@ Future<String> generateAssets(
SvgIntegration(
config.packageParameterLiteral,
parseMetadata: config.flutterGen.parseMetadata,
resolvedVersion: config.integrationResolvedVersions[SvgIntegration],
resolvedVersionConstraint:
config.integrationResolvedVersionConstraints[SvgIntegration],
),
if (config.flutterGen.integrations.rive)
RiveIntegration(
Expand Down
38 changes: 35 additions & 3 deletions packages/core/lib/generators/integrations/svg_integration.dart
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,45 @@ import 'dart:io';

import 'package:flutter_gen_core/generators/integrations/integration.dart';
import 'package:flutter_gen_core/utils/log.dart';
import 'package:pub_semver/pub_semver.dart'
show Version, VersionConstraint, VersionRange;
import 'package:vector_graphics_compiler/vector_graphics_compiler.dart';

class SvgIntegration extends Integration {
SvgIntegration(
String packageName, {
super.parseMetadata,
}) : super(packageName);
Version? resolvedVersion,
VersionConstraint? resolvedVersionConstraint,
}) : supportsErrorBuilder = _resolveErrorBuilderSupport(
resolvedVersion,
resolvedVersionConstraint,
),
super(packageName);

/// The minimum flutter_svg version that provides `SvgPicture.errorBuilder`.
static final errorBuilderMinimumSupportVersion = Version(2, 0, 17);

/// Whether the generated `svg()` exposes `errorBuilder`.
final bool supportsErrorBuilder;

static bool _resolveErrorBuilderSupport(
Version? resolvedVersion,
VersionConstraint? resolvedVersionConstraint,
) {
// Resolve by version.
if (resolvedVersion != null) {
return resolvedVersion >= errorBuilderMinimumSupportVersion;
}
// Resolve by version constraint.
if (resolvedVersionConstraint != null) {
return resolvedVersionConstraint.allowsAny(
VersionRange(min: errorBuilderMinimumSupportVersion, includeMin: true),
);
}
// Use the latest version as the fallback.
return true;
}

String get packageExpression => isPackage ? ' = package' : '';

Expand Down Expand Up @@ -54,7 +86,7 @@ ${isPackage ? "\n static const String package = '$packageName';" : ''}
AlignmentGeometry alignment = Alignment.center,
bool allowDrawingOutsideViewBox = false,
WidgetBuilder? placeholderBuilder,
String? semanticsLabel,
${supportsErrorBuilder ? '_svg.SvgErrorWidgetBuilder? errorBuilder,\n ' : ''}String? semanticsLabel,
bool excludeFromSemantics = false,
_svg.SvgTheme? theme,
_svg.ColorMapper? colorMapper,
Expand Down Expand Up @@ -90,7 +122,7 @@ ${isPackage ? "\n static const String package = '$packageName';" : ''}
alignment: alignment,
allowDrawingOutsideViewBox: allowDrawingOutsideViewBox,
placeholderBuilder: placeholderBuilder,
semanticsLabel: semanticsLabel,
${supportsErrorBuilder ? 'errorBuilder: errorBuilder,\n ' : ''}semanticsLabel: semanticsLabel,
excludeFromSemantics: excludeFromSemantics,
colorFilter: colorFilter ?? (color == null ? null : ColorFilter.mode(color, colorBlendMode)),
clipBehavior: clipBehavior,
Expand Down
60 changes: 60 additions & 0 deletions packages/core/test/assets_gen_integrations_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,66 @@ void main() {
);
});

test('SvgIntegration errorBuilder resolution with resolvedVersion', () {
// Test with version < 2.0.17 (should not expose errorBuilder)
final oldIntegration = SvgIntegration(
'',
resolvedVersion: Version(2, 0, 16),
);
expect(oldIntegration.supportsErrorBuilder, isFalse);
expect(oldIntegration.classOutput.contains('errorBuilder'), isFalse);

// Test with version >= 2.0.17 (should expose errorBuilder)
final supportedIntegration = SvgIntegration(
'',
resolvedVersion: Version(2, 0, 17),
);
expect(supportedIntegration.supportsErrorBuilder, isTrue);
expect(
supportedIntegration.classOutput.contains(
'_svg.SvgErrorWidgetBuilder? errorBuilder,',
),
isTrue,
);
expect(
supportedIntegration.classOutput.contains(
'errorBuilder: errorBuilder,',
),
isTrue,
);
});

test('SvgIntegration errorBuilder resolution with version constraint', () {
// Test with constraint that allows 2.0.17 (should expose errorBuilder)
final allowsSupported = SvgIntegration(
'',
resolvedVersionConstraint: VersionConstraint.parse('^2.0.0'),
);
expect(allowsSupported.supportsErrorBuilder, isTrue);

// Test with constraint that excludes 2.0.17 (should not expose errorBuilder)
final excludesSupported = SvgIntegration(
'',
resolvedVersionConstraint: VersionConstraint.parse('>=2.0.0 <2.0.17'),
);
expect(excludesSupported.supportsErrorBuilder, isFalse);
expect(excludesSupported.classOutput.contains('errorBuilder'), isFalse);
});

test('SvgIntegration errorBuilder resolution priority and fallback', () {
// resolvedVersion should take priority over resolvedVersionConstraint
final integration = SvgIntegration(
'',
resolvedVersion: Version(2, 0, 9),
resolvedVersionConstraint: VersionConstraint.parse('^2.0.0'),
);
expect(integration.supportsErrorBuilder, isFalse);

// Test with no version information (should expose errorBuilder as fallback)
final fallbackIntegration = SvgIntegration('');
expect(fallbackIntegration.supportsErrorBuilder, isTrue);
});

test('Assets with Rive integrations on pubspec.yaml', () async {
const pubspec = 'test_resources/pubspec_assets_rive_integrations.yaml';
await expectedAssetsGen(pubspec);
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.