Replace HslColor for HSLColor from painting (#18)

* Delete hsl_color.dart * Replace HslColor for HSLColor from painting * Remove unused method * Fix not updated line * Remove unused import and export * Fix not updated conversion code * Replace HslColor reference to HSLColor * Fix issues from static analyze * Update HSLColor in readme and CHANGELOG for the changes * feat: added tests for HSL methods
TinyCommunity · Mar 20, 2022 · 2415dbd · 2415dbd
1 parent a481e65
commit 2415dbd
Show file tree

Hide file tree

Showing 8 changed files with 52 additions and 65 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,7 @@
 ## [2.1.0] - TBA
 
 ### Changed
+* `HslColor` class is now deprecated in favor of native `HSLColor` at [PR #18](https://github.com/TinyCommunity/tinycolor2/pull/35)
 * Deprecated TinyColor.fromRGB() at [PR #40](https://github.com/TinyCommunity/tinycolor2/pull/40)
 
 ## [2.0.1] - 2022-03-11

diff --git a/README.md b/README.md
@@ -32,10 +32,10 @@ The package uses [Pigment](https://pub.dartlang.org/packages/pigment) by [Bregy
 TinyColor.fromString('#FE5567');
 ```
 
-### From `HslColor`
+### From `HSLColor`
 
 ```dart
-final HslColor color = HslColor(h: 250, s: 57, l: 30);
+final HSLColor color = HSLColor.fromAHSL(1.0, 250, 57, 30);
 TinyColor.fromHSL(color);
 ```
 

diff --git a/lib/src/color_extension.dart b/lib/src/color_extension.dart
@@ -1,6 +1,5 @@
 import 'package:flutter/painting.dart';
 
-import 'hsl_color.dart';
 import 'tinycolor.dart';
 
 /// Extends the Color class to allow direct TinyColor manipulation natively
@@ -10,7 +9,7 @@ extension TinyColorExtension on Color {
 
   HSVColor toHsv() => TinyColor(this).toHsv();
 
-  HslColor toHsl() => TinyColor(this).toHsl();
+  HSLColor toHsl() => TinyColor(this).toHsl();
 
   /// Lighten the color a given amount, from 0 to 100. Providing 100 will always return white.
   Color lighten([int amount = 10]) => TinyColor(this).lighten(amount).color;

diff --git a/lib/src/conversion.dart b/lib/src/conversion.dart
@@ -2,10 +2,9 @@ import 'dart:math' as math;
 
 import 'package:flutter/painting.dart';
 
-import 'hsl_color.dart';
 import 'util.dart';
 
-HslColor rgbToHsl({
+HSLColor rgbToHsl({
   required double r,
   required double g,
   required double b,
@@ -35,18 +34,16 @@ HslColor rgbToHsl({
   }
 
   h /= 6.0;
-  return HslColor(h: h, s: s, l: l);
+  return HSLColor.fromAHSL(1.0, h, s, l);
 }
 
-Color hslToColor(HslColor hsl) => hslToRgb(hsl);
-
-Color hslToRgb(HslColor hsl) {
+Color hslToRgb(HSLColor hsl) {
   double r;
   double g;
   double b;
-  final double h = bound01(hsl.h, 360.0);
-  final double s = bound01(hsl.s * 100, 100.0);
-  final double l = bound01(hsl.l * 100, 100.0);
+  final double h = bound01(hsl.hue, 360.0);
+  final double s = bound01(hsl.saturation * 100, 100.0);
+  final double l = bound01(hsl.lightness * 100, 100.0);
 
   if (s == 0.0) {
     r = g = b = l;
@@ -58,7 +55,7 @@ Color hslToRgb(HslColor hsl) {
     b = _hue2rgb(p, q, h - 1 / 3);
   }
   return Color.fromARGB(
-    hsl.a.round(),
+    hsl.alpha.round(),
     (r * 255).round(),
     (g * 255).round(),
     (b * 255).round(),

diff --git a/lib/src/hsl_color.dart b/lib/src/hsl_color.dart
diff --git a/lib/src/tinycolor.dart b/lib/src/tinycolor.dart
@@ -1,11 +1,10 @@
 import 'dart:math' as math;
 import 'dart:ui' show Color;
 
-import 'package:flutter/painting.dart' show HSVColor;
+import 'package:flutter/painting.dart' show HSLColor, HSVColor;
 import 'package:pigment/pigment.dart';
 
 import 'conversion.dart';
-import 'hsl_color.dart';
 import 'util.dart';
 
 class TinyColor {
@@ -23,7 +22,7 @@ class TinyColor {
   }) =>
       TinyColor(Color.fromARGB(a, r, g, b));
 
-  factory TinyColor.fromHSL(HslColor hsl) => TinyColor(hslToColor(hsl));
+  factory TinyColor.fromHSL(HSLColor hsl) => TinyColor(hsl.toColor());
 
   factory TinyColor.fromHSV(HSVColor hsv) => TinyColor(hsv.toColor());
 
@@ -51,29 +50,16 @@ class TinyColor {
 
   HSVColor toHsv() => HSVColor.fromColor(_color);
 
-  HslColor toHsl() {
-    final hsl = rgbToHsl(
-      r: _color.red.toDouble(),
-      g: _color.green.toDouble(),
-      b: _color.blue.toDouble(),
-    );
-    return HslColor(
-      h: hsl.h * 360,
-      s: hsl.s,
-      l: hsl.l,
-      a: _color.alpha.toDouble(),
-    );
-  }
+  HSLColor toHsl() => HSLColor.fromColor(_color);
 
   String toHex8() => _color.value.toRadixString(16).padLeft(8, '0');
 
   TinyColor clone() => TinyColor(_color);
 
   TinyColor lighten([int amount = 10]) {
     final hsl = toHsl();
-    hsl.l += amount / 100;
-    hsl.l = clamp01(hsl.l);
-    return TinyColor.fromHSL(hsl);
+    final lightness = clamp01(hsl.lightness + amount / 100);
+    return TinyColor.fromHSL(hsl.withLightness(lightness));
   }
 
   TinyColor brighten([int amount = 10]) {
@@ -106,9 +92,8 @@ class TinyColor {
 
   TinyColor darken([int amount = 10]) {
     final hsl = toHsl();
-    hsl.l -= amount / 100;
-    hsl.l = clamp01(hsl.l);
-    return TinyColor.fromHSL(hsl);
+    final lightness = clamp01(hsl.lightness - amount / 100);
+    return TinyColor.fromHSL(hsl.withLightness(lightness));
   }
 
   TinyColor tint([int amount = 10]) => mix(
@@ -123,25 +108,22 @@ class TinyColor {
 
   TinyColor desaturate([int amount = 10]) {
     final hsl = toHsl();
-    hsl.s -= amount / 100;
-    hsl.s = clamp01(hsl.s);
-    return TinyColor.fromHSL(hsl);
+    final saturation = clamp01(hsl.saturation - amount / 100);
+    return TinyColor.fromHSL(hsl.withSaturation(saturation));
   }
 
   TinyColor saturate([int amount = 10]) {
     final hsl = toHsl();
-    hsl.s += amount / 100;
-    hsl.s = clamp01(hsl.s);
-    return TinyColor.fromHSL(hsl);
+    final saturation = clamp01(hsl.saturation + amount / 100);
+    return TinyColor.fromHSL(hsl.withSaturation(saturation));
   }
 
   TinyColor greyscale() => desaturate(100);
 
   TinyColor spin(double amount) {
     final hsl = toHsl();
-    final hue = (hsl.h + amount) % 360;
-    hsl.h = hue < 0 ? 360 + hue : hue;
-    return TinyColor.fromHSL(hsl);
+    final hue = (hsl.hue + amount) % 360;
+    return TinyColor.fromHSL(hsl.withHue(hue < 0 ? 360 + hue : hue));
   }
 
   TinyColor mix(Color toColor, [int amount = 50]) {
@@ -157,8 +139,8 @@ class TinyColor {
 
   TinyColor complement() {
     final hsl = toHsl();
-    hsl.h = (hsl.h + 180) % 360;
-    return TinyColor.fromHSL(hsl);
+    final hue = (hsl.hue + 180) % 360;
+    return TinyColor.fromHSL(hsl.withHue(hue));
   }
 
   Color get color => _color;

diff --git a/lib/tinycolor2.dart b/lib/tinycolor2.dart
@@ -2,6 +2,5 @@ library tinycolor2;
 
 export 'src/color_extension.dart';
 export 'src/conversion.dart';
-export 'src/hsl_color.dart';
 export 'src/tinycolor.dart';
 export 'src/util.dart';
diff --git a/test/tinycolor_test.dart b/test/tinycolor_test.dart
@@ -1,4 +1,4 @@
-import 'dart:ui' show Color;
+import 'package:flutter/painting.dart' show Color, HSLColor, HSVColor;
 
 import 'package:flutter_test/flutter_test.dart';
 import 'package:tinycolor2/tinycolor2.dart';
@@ -285,4 +285,29 @@ void main() {
       );
     },
   );
+
+  group(
+    "TinyColor HSL",
+    () {
+      final TinyColor color = TinyColor.fromHSL(HSLColor.fromColor(const Color(0xFFFFFFFF)));
+      test(
+        ".color",
+        () {
+          expect(
+            color.color,
+            const Color(0xFFFFFFFF),
+          );
+        },
+      );
+      test(
+        ".toHsl()",
+        () {
+          expect(
+            color.toHsl(),
+            HSLColor.fromColor(const Color(0xFFFFFFFF)),
+          );
+        },
+      );
+    },
+  );
 }