Add Inspector#export

Author: scottt2

CHANGELOG.md

@@ -1,3 +1,6 @@
+## 2.4.0
+- Added #export to Inspector for easy dumping and sharing of datasets.
+
 ## 2.3.1
 - Made sure to export Inspector...
 

lib/src/inspector.dart

@@ -1,5 +1,6 @@
 import 'dart:io';
 
+import 'package:traindown/src/formatter.dart';
 import 'package:traindown/src/metadata.dart';
 import 'package:traindown/src/movement.dart';
 import 'package:traindown/src/performance.dart';
@@ -20,7 +21,9 @@ class Inspector {
   List<Session> sessions;
   List<String> _extensions = ['.traindown'];
 
-  Inspector(this.sessions, [this._extensions]);
+  Inspector(this.sessions, [this._extensions]) {
+    sessions.sort((a, b) => b.occurred.compareTo(a.occurred));
+  }
 
   /// Convenience constructor for slurping up files.
   factory Inspector.from_files(List<File> files,
@@ -33,6 +36,8 @@ class Inspector {
       }
     }
 
+    inspector.sessions.sort((a, b) => b.occurred.compareTo(a.occurred));
+
     return inspector;
   }
 
@@ -71,6 +76,20 @@ class Inspector {
     return valid;
   }
 
+  /// Export all Sessions as a single Traindown string. Good for dumping
+  /// and sharing.
+  String export(
+      {String indenter = '  ',
+      String linebreaker = '\r\n',
+      String spacer = ' '}) {
+    Formatter formatter =
+        Formatter(indenter: indenter, linebreaker: linebreaker, spacer: spacer);
+    StringBuffer buffer = StringBuffer();
+    sessions.forEach((s) => buffer
+        .write('${formatter.format(s.tokens)}${formatter.linebreaker * 2}'));
+    return buffer.toString().trim();
+  }
+
   /// Map keyed by string that contains all seen values of the given key.
   Map<String, Set<String>> metadataByKey(
       [TraindownScope scope = TraindownScope.session]) {

pubspec.yaml

@@ -1,7 +1,7 @@
 name: traindown
 description: A language to help athletes express their training. Inspired by Markdown.
 homepage: https://www.traindown.com/
-version: 2.3.1
+version: 2.4.0
 environment:
   sdk: ">=2.2.0 <3.0.0"
 dependencies:

test/inspector_test.dart

@@ -225,4 +225,41 @@ void main() {
       expect(subject.validFile(File('./example/example.traindown')), false);
     });
   });
+
+  group('export', () {
+    test('It concats all the strings like a boss', () {
+      List<Token> tokens1 = [
+        Token(TokenType.DateTime, "2020-01-01"),
+        Token(TokenType.MetaKey, "Your"),
+        Token(TokenType.MetaValue, "Mom"),
+        Token(TokenType.MetaKey, "Foo"),
+        Token(TokenType.MetaValue, "Bar"),
+      ];
+      Session session1 = Session(tokens1);
+
+      List<Token> tokens2 = [
+        Token(TokenType.DateTime, "2021-01-01"),
+        Token(TokenType.MetaKey, "Your"),
+        Token(TokenType.MetaValue, "Mom"),
+        Token(TokenType.MetaKey, "Bar"),
+        Token(TokenType.MetaValue, "Baz"),
+      ];
+      Session session2 = Session(tokens2);
+
+      Inspector subject = Inspector([session1, session2]);
+
+      String expected = """
+@ 2021-01-01
+
+# Your: Mom
+# Bar: Baz
+
+@ 2020-01-01
+
+# Your: Mom
+# Foo: Bar""";
+
+      expect(subject.export(linebreaker: '\n'), expected);
+    });
+  });
 }