#87 Detect terminal size

nikosportolos · Jun 2, 2023 · d32d4ca · d32d4ca
1 parent c098421
commit d32d4ca
Show file tree

Hide file tree

Showing 7 changed files with 112 additions and 22 deletions.
diff --git a/lib/src/ansix.dart b/lib/src/ansix.dart
@@ -7,6 +7,7 @@ import 'dart:convert';
 import 'package:ansix/ansix.dart';
 import 'package:ansix/src/controller.dart';
 import 'package:ansix/src/formatter/formatter.dart';
+import 'package:ansix/src/system/terminal.dart';
 
 abstract class AnsiX {
   static final AnsiXController _controller = AnsiXController();
@@ -22,6 +23,9 @@ abstract class AnsiX {
   /// Returns the active text formatter.
   static TextFormatter get formatter => _controller.formatter;
 
+  /// Returns the size of the attached terminal.
+  static TerminalSize get size => _controller.terminalSize;
+
   /// Enables ANSI formatting (if supported by the system).
   static void enable() {
     _controller.enable();

diff --git a/lib/src/controller.dart b/lib/src/controller.dart
@@ -3,15 +3,19 @@ import 'package:ansix/src/formatter/formatters.dart';
 import 'package:ansix/src/system/process_manager.dart';
 import 'package:ansix/src/system/terminal.dart';
 
+/// **AnsiXController**
 class AnsiXController {
   AnsiXController({
     final ProcessManager? processManager,
     final AnsiTerminal? terminal,
   })  : _processManager = processManager ?? const ProcessManager(),
-        _terminal = terminal ?? AnsiTerminal();
+        _terminal = terminal ?? AnsiTerminal() {
+    terminalSize = _terminal.size;
+  }
 
   final ProcessManager _processManager;
   final AnsiTerminal _terminal;
+  late final TerminalSize terminalSize;
 
   /// Returns true if ANSI formatting is supported and enabled.
   bool get isEnabled => _isEnabled;

diff --git a/lib/src/system/process_manager.dart b/lib/src/system/process_manager.dart
@@ -2,6 +2,9 @@ import 'package:ansix/src/core/exceptions/exceptions.dart';
 import 'package:ansix/src/system/system.dart';
 import 'package:meta/meta.dart';
 
+/// **ProcessManager**
+///
+/// A library that provides tools and info using bash commands.
 class ProcessManager {
   const ProcessManager({
     final Shell? shell,
@@ -80,6 +83,7 @@ class ProcessManager {
     }
   }
 
+  /// Returns the [TerminalType] of the attached terminal.
   TerminalType determineTerminalType() {
     return _checkIfRunningInBash() ?? _checkIfRunningInPowershell() ?? TerminalType.unknown;
   }

diff --git a/lib/src/system/shell.dart b/lib/src/system/shell.dart
@@ -1,5 +1,8 @@
 import 'dart:io';
 
+/// **Shell**
+///
+/// A library that wraps Dart's [Process] features.
 class Shell {
   const Shell();
 
@@ -16,6 +19,10 @@ class Shell {
   }
 }
 
+/// **ShellCommand**
+///
+/// A class that contains all required information for a
+/// shell command to be executed in the attached terminal.
 class ShellCommand {
   const ShellCommand(
     this.command, {

diff --git a/lib/src/system/terminal.dart b/lib/src/system/terminal.dart
@@ -1,7 +1,29 @@
 import 'dart:io';
 
+/// **TerminalType**
 enum TerminalType { unknown, bash, cmd, powershell }
 
+/// **TerminalSize**
+///
+/// Provides information about the size of the attached terminal.
+class TerminalSize {
+  const TerminalSize({
+    required this.columns,
+    required this.lines,
+  });
+
+  final int columns;
+  final int lines;
+
+  static const TerminalSize $default = TerminalSize(columns: 80, lines: 24);
+
+  @override
+  String toString() => '($columns, $lines)';
+}
+
+/// **AnsiTerminal**
+///
+/// A library that provides information on the attached terminal.
 class AnsiTerminal {
   AnsiTerminal({
     final Stdout? out,
@@ -20,4 +42,21 @@ class AnsiTerminal {
     return stdioType(_stdout) == StdioType.terminal || //
         stdioType(_stdout) == StdioType.pipe;
   }
+
+  /// Returns the [TerminalSize] of the attached terminal.
+  ///
+  /// If no terminal is attached,
+  /// the default terminal size (80, 24) will be returned instead.
+  TerminalSize get size {
+    try {
+      if (_stdout.hasTerminal) {
+        return TerminalSize(
+          columns: _stdout.terminalColumns,
+          lines: _stdout.terminalLines,
+        );
+      }
+    } catch (_) {}
+
+    return TerminalSize.$default;
+  }
 }
diff --git a/test/ansix/mocks.dart b/test/ansix/mocks.dart
@@ -18,6 +18,9 @@ class MockAnsiTerminal extends Mock implements AnsiTerminal {
 
   @override
   bool get runsOnWindows;
+
+  @override
+  TerminalSize get size => TerminalSize.$default;
 }
 
 class MockStdOut extends Mock implements Stdout {

diff --git a/test/system/terminal_test.dart b/test/system/terminal_test.dart
@@ -7,37 +7,66 @@ import 'package:test/test.dart';
 class MockStdOut extends Mock implements Stdout {
   @override
   bool get supportsAnsiEscapes;
+
+  @override
+  bool get hasTerminal;
+
+  @override
+  int get terminalColumns;
+
+  @override
+  int get terminalLines;
 }
 
 void main() {
   final MockStdOut stdOut = MockStdOut();
 
   setUp(() => resetMocktailState());
 
-  IOOverrides.runZoned(
-    () {
-      final AnsiTerminal terminal = AnsiTerminal(out: stdOut);
+  final AnsiTerminal terminal = AnsiTerminal(out: stdOut);
 
-      group('AnsiTerminal', () {
-        test('runsOnWindows', () {
-          expect(terminal.runsOnWindows, Platform.isWindows);
-        });
+  group('AnsiTerminal', () {
+    test('runsOnWindows', () {
+      expect(terminal.runsOnWindows, Platform.isWindows);
+    });
 
-        test('supportsAnsiEscapes=false', () {
-          when(() => stdOut.supportsAnsiEscapes).thenReturn(false);
-          expect(terminal.supportsAnsi, false);
-        });
+    group('supportsAnsiEscapes', () {
+      test('false', () {
+        when(() => stdOut.supportsAnsiEscapes).thenReturn(false);
+        expect(terminal.supportsAnsi, false);
+      });
+
+      test('true', () {
+        when(() => stdOut.supportsAnsiEscapes).thenReturn(true);
+        expect(terminal.supportsAnsi, true);
+      });
+    });
 
-        test('supportsAnsiEscapes=true', () {
-          when(() => stdOut.supportsAnsiEscapes).thenReturn(true);
-          expect(terminal.supportsAnsi, true);
-        });
+    test('attachedToValidStream', () {
+      expect(terminal.attachedToValidStream, false); // TODO
+    });
 
-        test('attachedToValidStream', () {
-          expect(terminal.attachedToValidStream, false); // TODO
-        });
+    group('TerminalSize', () {
+      test('hasTerminal=false (returns default)', () {
+        when(() => stdOut.hasTerminal).thenReturn(false);
+        expect(terminal.size, TerminalSize.$default);
+        expect(
+          terminal.size.toString(),
+          '(${TerminalSize.$default.columns}, ${TerminalSize.$default.lines})',
+        );
+      });
+      test('hasTerminal=true (returns default)', () {
+        when(() => stdOut.hasTerminal).thenReturn(true);
+        expect(terminal.size, TerminalSize.$default);
+      });
+      test('hasTerminal=true', () {
+        const TerminalSize size = TerminalSize(columns: 120, lines: 100);
+        when(() => stdOut.hasTerminal).thenReturn(true);
+        when(() => stdOut.terminalColumns).thenReturn(size.columns);
+        when(() => stdOut.terminalLines).thenReturn(size.lines);
+        expect(terminal.size.columns, size.columns);
+        expect(terminal.size.lines, size.lines);
       });
-    },
-    stdout: () => stdOut,
-  );
+    });
+  });
 }