Simplify class names by dropping/replacing Boustro

Author: Jjagg

example/lib/main.dart

@@ -142,7 +142,7 @@ class _HomeScreenState extends State<HomeScreen> {
                     Navigator.of(context)
                         .push<void>(MaterialPageRoute<void>(builder: (context) {
                       return Scaffold(
-                        body: BoustroView(
+                        body: DocumentView(
                           document: controller.toDocument(),
                         ),
                       );
@@ -155,7 +155,7 @@ class _HomeScreenState extends State<HomeScreen> {
           body: Column(
             children: [
               Expanded(
-                child: BoustroEditor(
+                child: DocumentEditor(
                   controller: controller,
                 ),
               ),

packages/boustro/lib/src/convert/convert_delta.dart

@@ -98,9 +98,9 @@ TextAttributeDeltaCodec deltaBoolAttributeCodec(
   );
 }
 
-/// Convert a boustro document to or from a list of insert operations in Quill's
+/// Convert a document to or from a list of insert operations in Quill's
 /// delta format.
-class BoustroDocumentDeltaConverter extends Codec<BoustroDocument, List<Op>> {
+class BoustroDocumentDeltaConverter extends Codec<Document, List<Op>> {
   /// Create a delta converter
   BoustroDocumentDeltaConverter(
     List<TextAttributeDeltaCodec> attributeCodecs,
@@ -132,16 +132,16 @@ class BoustroDocumentDeltaConverter extends Codec<BoustroDocument, List<Op>> {
   final Map<Type, EmbedEncoder> embedEncoders;
 
   @override
-  Converter<List<Op>, BoustroDocument> get decoder =>
+  Converter<List<Op>, Document> get decoder =>
       BoustroDocumentDeltaDecoder(attributeDecoders, embedDecoders);
 
   @override
-  Converter<BoustroDocument, List<Op>> get encoder =>
+  Converter<Document, List<Op>> get encoder =>
       BoustroDocumentDeltaEncoder(attributeEncoder, embedEncoders);
 }
 
-/// Encodes a boustro document to a list of Quill delta insert operations.
-class BoustroDocumentDeltaEncoder extends Converter<BoustroDocument, List<Op>> {
+/// Encodes a document to a list of Quill delta insert operations.
+class BoustroDocumentDeltaEncoder extends Converter<Document, List<Op>> {
   /// Create an encoder.
   const BoustroDocumentDeltaEncoder(
     this.attributeEncoder,
@@ -155,17 +155,17 @@ class BoustroDocumentDeltaEncoder extends Converter<BoustroDocument, List<Op>> {
   final Map<Type, EmbedEncoder> embedEncoders;
 
   @override
-  List<Op> convert(BoustroDocument input) {
+  List<Op> convert(Document input) {
     throw UnimplementedError();
   }
 }
 
-/// Convert a list of Quill delta format insert operations to a boustro
+/// Convert a list of Quill delta format insert operations to a
 /// document.
 ///
 /// Throws [ArgumentError] when an attribute is encountered with no entry in
 /// [attributeCodecs].
-class BoustroDocumentDeltaDecoder extends Converter<List<Op>, BoustroDocument> {
+class BoustroDocumentDeltaDecoder extends Converter<List<Op>, Document> {
   /// Create a decoder.
   const BoustroDocumentDeltaDecoder(
     this.attributeCodecs,
@@ -179,10 +179,10 @@ class BoustroDocumentDeltaDecoder extends Converter<List<Op>, BoustroDocument> {
   final Map<String, EmbedDecoder> embedDecoders;
 
   @override
-  BoustroDocument convert(List<Op> input) {
+  Document convert(List<Op> input) {
     // First group or split ops by lines (\n) because each line maps to a
     // BoustroParagraph.
-    final paragraphs = <BoustroParagraph>[];
+    final paragraphs = <Paragraph>[];
     for (final line in _groupByLines(input)) {
       final first = line.ops.firstOrNull;
       if (first is InsertObjectOp) {
@@ -204,7 +204,7 @@ class BoustroDocumentDeltaDecoder extends Converter<List<Op>, BoustroDocument> {
       }
     }
 
-    return BoustroDocument(paragraphs.build());
+    return Document(paragraphs.build());
   }
 
   Iterable<_DeltaLine> _groupByLines(List<Op> ops) sync* {
@@ -258,7 +258,7 @@ class BoustroDocumentDeltaDecoder extends Converter<List<Op>, BoustroDocument> {
     }
   }
 
-  BoustroLine _opsToLine(_DeltaLine line) {
+  TextLine _opsToLine(_DeltaLine line) {
     final buffer = StringBuffer();
     final segments = <AttributeSegment>[];
 
@@ -295,7 +295,7 @@ class BoustroDocumentDeltaDecoder extends Converter<List<Op>, BoustroDocument> {
 
     final text =
         segments.fold<String>('', (str, segment) => str + segment.text.string);
-    return BoustroLine(text: text, spans: spans);
+    return TextLine(text: text, spans: spans);
   }
 }
 

packages/boustro/lib/src/document.dart

@@ -7,35 +7,35 @@ import 'package:flutter_spanned_controller/flutter_spanned_controller.dart';
 
 import 'scope.dart';
 
-/// Rich text represented as a list of [BoustroParagraph]s.
+/// Rich text represented as a list of [Paragraph]s.
 @immutable
-class BoustroDocument {
-  /// Create a new boustro document.
-  const BoustroDocument(this.paragraphs);
+class Document {
+  /// Create a new document.
+  const Document(this.paragraphs);
 
   /// The list of paragraphs in this document.
-  final BuiltList<BoustroParagraph> paragraphs;
+  final BuiltList<Paragraph> paragraphs;
 }
 
-/// A paragraph in a [BoustroDocument]. Is either a [BoustroLine] for rich text,
+/// A paragraph in a [Document]. Is either a [TextLine] for rich text,
 /// or a [ParagraphEmbed] for other content.
 @immutable
-abstract class BoustroParagraph {
-  const BoustroParagraph._();
+abstract class Paragraph {
+  const Paragraph._();
 
-  /// Execute [line] if this is a [BoustroLine] and [embed] if this is a
+  /// Execute [line] if this is a [TextLine] and [embed] if this is a
   /// [ParagraphEmbed].
   T match<T>({
-    required T Function(BoustroLine) line,
+    required T Function(TextLine) line,
     required T Function(ParagraphEmbed) embed,
   });
 }
 
-/// Immutable representation of a line of rich text in a [BoustroDocument].
+/// Immutable representation of a line of rich text in a [Document].
 @immutable
-class BoustroLine extends BoustroParagraph with EquatableMixin {
-  /// Create a boustro line.
-  BoustroLine({
+class TextLine extends Paragraph with EquatableMixin {
+  /// Create a line of rich text.
+  TextLine({
     required String text,
     required SpanList spans,
     List<LineModifier>? modifiers,
@@ -45,8 +45,8 @@ class BoustroLine extends BoustroParagraph with EquatableMixin {
           modifiers: modifiers?.build() ?? BuiltList<LineModifier>(),
         );
 
-  /// Create a boustro line with the text and spans of [string].
-  BoustroLine.fromSpanned({
+  /// Create a line with the text and spans of [string].
+  TextLine.fromSpanned({
     required SpannedString string,
     List<LineModifier>? modifiers,
   }) : this.built(
@@ -55,8 +55,8 @@ class BoustroLine extends BoustroParagraph with EquatableMixin {
           modifiers: modifiers?.build() ?? BuiltList<LineModifier>(),
         );
 
-  /// Create a boustro line with directly initialized fields.
-  BoustroLine.built({
+  /// Create a line with directly initialized fields.
+  TextLine.built({
     required this.text,
     required this.spans,
     required this.modifiers,
@@ -76,7 +76,7 @@ class BoustroLine extends BoustroParagraph with EquatableMixin {
 
   @override
   T match<T>({
-    required T Function(BoustroLine) line,
+    required T Function(TextLine) line,
     required T Function(ParagraphEmbed) embed,
   }) =>
       line(this);
@@ -92,13 +92,13 @@ class BoustroLine extends BoustroParagraph with EquatableMixin {
 
 /// Interface for paragraph embeds.
 @immutable
-abstract class ParagraphEmbed extends BoustroParagraph {
+abstract class ParagraphEmbed extends Paragraph {
   /// Constant base constructor for implementations.
   const ParagraphEmbed() : super._();
 
   @override
   T match<T>({
-    required T Function(BoustroLine) line,
+    required T Function(TextLine) line,
     required T Function(ParagraphEmbed) embed,
   }) =>
       embed(this);
@@ -110,9 +110,9 @@ abstract class ParagraphEmbed extends BoustroParagraph {
   });
 }
 
-/// Builds a [BoustroDocument]. Can be used fluently with cascades.
+/// Builds a [Document]. Can be used fluently with cascades.
 class DocumentBuilder {
-  final List<BoustroParagraph> _paragraphs = [];
+  final List<Paragraph> _paragraphs = [];
   final SpannedStringBuilder _lineBuilder = SpannedStringBuilder();
 
   /// Add a line of rich text to the document.
@@ -122,7 +122,7 @@ class DocumentBuilder {
   ]) {
     build(_lineBuilder);
     final str = _lineBuilder.build();
-    final line = BoustroLine.fromSpanned(string: str, modifiers: modifiers);
+    final line = TextLine.fromSpanned(string: str, modifiers: modifiers);
     _paragraphs.add(line);
   }
 
@@ -134,8 +134,8 @@ class DocumentBuilder {
   /// Finishes building and returns the created document.
   ///
   /// The builder will be reset and can be reused.
-  BoustroDocument build() {
-    final doc = BoustroDocument(_paragraphs.build());
+  Document build() {
+    final doc = Document(_paragraphs.build());
     _paragraphs.clear();
     return doc;
   }

packages/boustro/lib/src/scope.dart

@@ -5,21 +5,21 @@ import 'document.dart';
 import 'widgets/document_controller.dart';
 import 'widgets/editor.dart';
 
-/// Inherited widget that carries information about a boustro document.
+/// Inherited widget that carries information about a document.
 @immutable
 class BoustroScope extends InheritedWidget {
-  /// Create a scope for an editable document with a document controller.
+  /// Create a scope for an editable document with a [DocumentController].
   const BoustroScope.editable({
     Key? key,
     required DocumentController this.controller,
     required Widget child,
   })   : document = null,
         super(key: key, child: child);
 
-  /// Create a scope for a read-only document with a boustro document controller.
+  /// Create a scope for a read-only document with a [Document].
   const BoustroScope.readonly({
     Key? key,
-    required BoustroDocument this.document,
+    required Document this.document,
     required Widget child,
   })   : controller = null,
         super(key: key, child: child);
@@ -28,9 +28,9 @@ class BoustroScope extends InheritedWidget {
   /// used.
   final DocumentController? controller;
 
-  /// Document of the [BoustroView]. Null if [BoustroScope.readonly] was
+  /// Document of the [DocumentView]. Null if [BoustroScope.readonly] was
   /// used.
-  final BoustroDocument? document;
+  final Document? document;
 
   /// True if [BoustroScope.editable] was used, false if [BoustroScope.readonly]
   /// was used.
@@ -39,7 +39,7 @@ class BoustroScope extends InheritedWidget {
   /// Call [editable] if [isEditable] is true or [readonly] if it is not.
   T match<T>({
     required T Function(DocumentController) editable,
-    required T Function(BoustroDocument) readonly,
+    required T Function(Document) readonly,
   }) {
     return isEditable ? editable(controller!) : readonly(document!);
   }
@@ -81,7 +81,7 @@ class BoustroScope extends InheritedWidget {
       ..add(DiagnosticsProperty<bool>('isEditable', isEditable))
       ..add(DiagnosticsProperty<DocumentController?>('controller', controller,
           defaultValue: null))
-      ..add(DiagnosticsProperty<BoustroDocument?>('document', document,
+      ..add(DiagnosticsProperty<Document?>('document', document,
           defaultValue: null));
   }
 }

packages/boustro/lib/src/widgets/document_controller.dart

@@ -7,7 +7,7 @@ import 'package:flutter_spanned_controller/flutter_spanned_controller.dart';
 import '../document.dart';
 import 'editor.dart';
 
-/// Holds state for a paragraph of a boustro document.
+/// Holds state for a paragraph of a document.
 @immutable
 abstract class ParagraphState {
   /// Create a paragraph.
@@ -34,7 +34,7 @@ abstract class ParagraphState {
 
 /// Holds focus node and state for a line of text.
 ///
-/// This is the editable variant of [BoustroLine].
+/// This is the editable variant of [TextLine].
 @immutable
 class LineState extends ParagraphState {
   /// Create a text line.
@@ -91,7 +91,7 @@ class LineState extends ParagraphState {
       line(this);
 }
 
-/// Holds [FocusNode] and content for a boustro embed.
+/// Holds [FocusNode] and content for an embed.
 @immutable
 class EmbedState extends ParagraphState {
   /// Create an embed.
@@ -111,7 +111,7 @@ class EmbedState extends ParagraphState {
       embed(this);
 }
 
-/// Manages the contents of a [BoustroEditor].
+/// Manages the contents of a [DocumentEditor].
 ///
 /// Keeps track of the state of its paragraphs and editor:
 ///
@@ -130,7 +130,7 @@ class DocumentController extends ValueNotifier<BuiltList<ParagraphState>> {
   /// Create a document controller.
   DocumentController({
     ScrollController? scrollController,
-    Iterable<BoustroParagraph>? paragraphs,
+    Iterable<Paragraph>? paragraphs,
     this.attributeTheme,
   })  : scrollController = scrollController ?? ScrollController(),
         super(BuiltList()) {
@@ -221,7 +221,7 @@ class DocumentController extends ValueNotifier<BuiltList<ParagraphState>> {
       final nextLine = t.collapse(end: indexAfterNewline);
       insertLine(
         lineIndex + 1,
-        BoustroLine.built(
+        TextLine.built(
           text: nextLine.text,
           spans: nextLine.spans,
           modifiers: currentLine.modifiers,
@@ -247,27 +247,27 @@ class DocumentController extends ValueNotifier<BuiltList<ParagraphState>> {
     );
   }
 
-  /// Get the contents of this controller represented as a boustro document.
-  BoustroDocument toDocument() {
+  /// Get the contents of this controller represented as a document.
+  Document toDocument() {
     final paragraphs = this
         .paragraphs
-        .map((p) => p.match<BoustroParagraph>(
+        .map((p) => p.match<Paragraph>(
               line: (l) =>
-                  BoustroLine.fromSpanned(string: l.controller.spannedString),
+                  TextLine.fromSpanned(string: l.controller.spannedString),
               // TODO need a controller to modify embed state.
               embed: (e) => e.content,
             ))
         .toBuiltList();
-    return BoustroDocument(paragraphs);
+    return Document(paragraphs);
   }
 
   /// Add a line after all existing paragraphs.
-  LineState appendLine([BoustroLine? line]) {
+  LineState appendLine([TextLine? line]) {
     return insertLine(paragraphs.length, line);
   }
 
   /// Insert a line at [index].
-  LineState insertLine(int index, [BoustroLine? line]) {
+  LineState insertLine(int index, [TextLine? line]) {
     final spanController = SpannedTextEditingController(
       processTextValue: _processTextValue,
       text: line?.text.string,