rename to signals

Will try to grab: https://pub.dev/packages/signals

Author: rodydavis

CHANGELOG.md

@@ -1,3 +1,5 @@
 ## 0.0.1
 
-* TODO: Describe initial release.
+- Adding `computed`, `effect`, `signal`
+- Adding tests
+- Adding web example

example/pubspec.lock

@@ -177,13 +177,6 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "3.0.3"
-  dart_signals:
-    dependency: "direct main"
-    description:
-      path: ".."
-      relative: true
-    source: path
-    version: "0.0.1"
   dart_style:
     dependency: transitive
     description:
@@ -392,6 +385,13 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "1.0.4"
+  signals:
+    dependency: "direct main"
+    description:
+      path: ".."
+      relative: true
+    source: path
+    version: "0.0.1"
   source_maps:
     dependency: transitive
     description:

example/pubspec.yaml

@@ -7,7 +7,7 @@ environment:
   sdk: ^3.1.3
 
 dependencies:
-  dart_signals:
+  signals:
     path: ..
 
 dev_dependencies:

example/web/main.dart

@@ -1,6 +1,6 @@
 import 'dart:html';
 
-import 'package:dart_signals/dart_signals.dart';
+import 'package:signals/signals.dart';
 
 typedef Task = ({String title, bool completed});
 
@@ -12,10 +12,10 @@ void main() {
   final taskFilter = document.getElementById("taskFilter")!;
   final taskCounter = document.getElementById("taskCounter")!;
 
-  final tasks = createSignal<List<Task>>([]);
-  final filter = createSignal("all");
+  final tasks = signal<List<Task>>([]);
+  final filter = signal("all");
 
-  final filteredTasks = createComputed(() {
+  final filteredTasks = computed(() {
     final currentFilter = filter.value;
     final currentTasks = tasks.value;
     if (currentFilter == "all") {
@@ -27,15 +27,15 @@ void main() {
     }
   });
 
-  final taskCount = createComputed(() {
+  final taskCount = computed(() {
     return tasks.value.length;
   });
 
-  final activeTaskCount = createComputed(() {
+  final activeTaskCount = computed(() {
     return tasks.value.where((task) => !task.completed).length;
   });
 
-  final completedTaskCount = createComputed(() {
+  final completedTaskCount = computed(() {
     return tasks.value.where((task) => task.completed).length;
   });
 
@@ -54,7 +54,7 @@ void main() {
     filter.value = target.value ?? '';
   });
 
-  createEffect(() {
+  effect(() {
     final currentTasks = filteredTasks.value;
     todoList.innerHtml = "";
     for (var index = 0; index < currentTasks.length; index++) {
@@ -78,7 +78,7 @@ void main() {
     }
   });
 
-  createEffect(() {
+  effect(() {
     taskCounter.text = '''
         Total: ${taskCount.value}, 
         Active: ${activeTaskCount.value}, 

lib/dart_signals.dart

@@ -0,0 +1,36 @@
+library dart_signals;
+
+import 'src/signals.dart';
+export 'src/signals.dart';
+
+/// Creates a [Signal] with the given [initialValue].
+///
+/// ```dart
+/// final count = signal(0);
+/// final multiplier = signal(2);
+/// ```
+Signal<T> signal<T>(T initialValue) {
+  return Signal<T>(initialValue);
+}
+
+/// Creates a [Computed] with the given [computeFn].
+/// 
+/// ```dart
+/// final multipliedCount = computed(() {
+///  return count.value * multiplier.value;
+/// });
+Computed<T> computed<T>(ComputedCallback<T> computeFn) {
+  return Computed<T>(computeFn);
+}
+
+/// Creates an [Effect] with the given [effectFn].
+/// 
+/// ```dart
+/// effect(() {
+///  print(
+///   'Effect called: Count is ${count.value} and multiplier is ${multiplier.value}');
+/// });
+/// ```
+Effect effect(EffectCallback effectFn) {
+  return Effect(effectFn);
+}

lib/signals.dart

@@ -1,4 +1,4 @@
-part of '../dart_signals.dart';
+part of 'signals.dart';
 
 typedef ComputedCallback<T> = T Function();
 
@@ -40,6 +40,3 @@ class Computed<T> extends _Notifier implements _Listenable {
   }
 }
 
-Computed<T> createComputed<T>(ComputedCallback<T> computeFn) {
-  return Computed<T>(computeFn);
-}

lib/src/computed.dart

@@ -1,7 +1,9 @@
-part of '../dart_signals.dart';
+part of 'signals.dart';
 
 typedef EffectCallback = void Function();
 
+final _effectQueue = Queue<Effect>();
+
 class Effect implements _Listenable {
   Effect(this._effectFn) {
     _isStale = true;
@@ -35,7 +37,3 @@ void _executeEffects() {
     effect._execute();
   }
 }
-
-Effect createEffect(EffectCallback effectFn) {
-  return Effect(effectFn);
-}

lib/src/effect.dart

@@ -1,4 +1,6 @@
-part of '../dart_signals.dart';
+part of 'signals.dart';
+
+_Listenable? _currentAccessed;
 
 abstract class _Listenable {
   void _update();

lib/src/listenable.dart

@@ -1,4 +1,4 @@
-part of '../dart_signals.dart';
+part of 'signals.dart';
 
 class Signal<T> extends _Notifier {
   Signal(this._value);
@@ -21,6 +21,3 @@ class Signal<T> extends _Notifier {
   }
 }
 
-Signal<T> createSignal<T>(T initialValue) {
-  return Signal<T>(initialValue);
-}

lib/src/signal.dart

@@ -0,0 +1,8 @@
+import 'dart:collection';
+
+part 'listenable.dart';
+part 'signal.dart';
+part 'computed.dart';
+part 'effect.dart';
+
+

lib/src/signals.dart

@@ -1,4 +1,4 @@
-name: dart_signals
+name: signals
 description: Signal, Computed and Effect built with dart
 version: 0.0.1
 

pubspec.yaml

@@ -1,19 +1,19 @@
 import 'package:test/test.dart';
 
-import 'package:dart_signals/dart_signals.dart';
+import 'package:signals/signals.dart';
 
 void main() {
   test('init', () {
     // Create signals
-    final count = createSignal(0);
-    final multiplier = createSignal(2);
+    final count = signal(0);
+    final multiplier = signal(2);
 
     // Creating a computed value
-    final multipliedCount = createComputed(() {
+    final multipliedCount = computed(() {
       return count.value * multiplier.value;
     });
 
-    createEffect(() {
+    effect(() {
       print(
           'Effect called: Count is ${count.value} and multiplier is ${multiplier.value}');
     });