Preps for the release 2.0.0

Author: alexei-sintotski

CHANGELOG.md

@@ -1,3 +1,8 @@
+## [2.0.0] - 2019-12-28
+* Migration to Dart 2.7
+* Extension method on String to create PubspecLock from YAML
+* Major refactoring to improve code modularity
+
 ## [1.1.0] - 2019-12-07
 * YAML formatting with json2yaml i.s.o. using ad-hoc YAML generator
 

README.md

@@ -1,33 +1,98 @@
 # pubspec_lock [![Build Status](https://travis-ci.org/alexei-sintotski/pubspec_lock.svg?branch=master)](https://travis-ci.org/alexei-sintotski/pubspec_lock) [![codecov](https://codecov.io/gh/alexei-sintotski/pubspec_lock/branch/master/graph/badge.svg)](https://codecov.io/gh/alexei-sintotski/pubspec_lock) [![pubspec_lock version](https://img.shields.io/pub/v/pubspec_lock?label=pubspec_lock)](https://pub.dev/packages/pubspec_lock)
 Dart library to access and manipulate content of pubpec.lock files
 
-## Class PubspecLock
+The versions 2.x of this package require Dart 2.7.
+Consider version 1.1.0 if you intend to use the package with Dart 2.5 or 2.6.
+
+## Data classes
 
 PubspecLock represents data stored in pubspec.lock files.
-It provides the following facilities:
-- Parser from pubspec.lock YAML string
-- Formatter to pubspec.lock YAML string
-- https://pub.dev/packages/functional_data is used to provide data type facilities
+
+https://pub.dev/packages/functional_data is used to provide data type facilities
 
 ```
 class PubspecLock {
   final Iterable<SdkDependency> sdks;
   final Iterable<PackageDependency> packages;
+}
+```
 
-  const PubspecLock({this.sdks = const {}, this.packages = const {}});
-  factory PubspecLock.loadFromYamlString(String content);
+SdkDependency provides sdk name and version:
 
-  String toYaml();
+```
+@immutable
+@FunctionalData()
+class SdkDependency {
+  /// Default constructor
+  const SdkDependency({
+    @required this.sdk,
+    @required this.version,
+  });
+
+  final String sdk;
+  final String version;
 }
 ```
 
-## Usage
+PackageDependency represents a package dependency, which can be:
+* a hosted dependency,
+* an SDK dependency,
+* a Git dependency, or
+* a path dependency
 
-To use pubspec_lock, add the following dependency to pubspec.yaml:
+Please checkout https://dart.dev/tools/pub/dependencies for details.
+
+https://pub.dev/packages/sum_types is used to deal with variations of different package dependency types in a type-safe and concise manner.
 
 ```
-dependencies:
-  pubspec_lock:
+@immutable
+@SumType()
+class PackageDependency extends _$PackageDependency {
+  const PackageDependency.sdk(SdkPackageDependency sdk) : super(sdk: sdk);
+  const PackageDependency.hosted(HostedPackageDependency hosted) : super(hosted: hosted);
+  const PackageDependency.git(GitPackageDependency git) : super(git: git);
+  const PackageDependency.path(PathPackageDependency path) : super(path: path);
+
+  /// Provides package dependency name
+  String package() => iswitch(
+        sdk: (d) => d.package,
+        hosted: (d) => d.package,
+        git: (d) => d.package,
+        path: (d) => d.package,
+      );
+
+  /// Provides package dependency version
+  String version() => iswitch(
+        sdk: (d) => d.version,
+        hosted: (d) => d.version,
+        git: (d) => d.version,
+        path: (d) => d.version,
+      );
+
+  /// Provides package dependency type -- direct, development, or transitive
+  DependencyType type() => iswitch(
+        sdk: (d) => d.type,
+        hosted: (d) => d.type,
+        git: (d) => d.type,
+        path: (d) => d.type,
+      );
+}
+```
+
+## Import from YAML
+
+The String extension method `loadPubspecLockFromYaml()` can be used to create a PubspecLock instance from a YAML string:
+
+```
+final pubspecLock = File('pubspec.lock').readAsStringSync().loadPubspecLockFromYaml();
+```
+
+## Export to YAML
+
+`PubspecLock.toYamlString()` can be used to export PubspecLock object to a YAML string:
+
+```
+File('pubspec.lock').writeAsStringSync(pubspecLock.toYamlString());
 ```
 
 ## Full example
@@ -39,28 +104,29 @@ import 'dart:io';
 
 import 'package:pubspec_lock/pubspec_lock.dart';
 
+// ignore_for_file: avoid_print
+
 void main() {
-  final fileContent = File('pubspec.lock').readAsStringSync();
-  final pubspecLock = PubspecLock.loadFromYamlString(fileContent);
-  print('Loaded pubspec.lock with '
-        '${pubspecLock.packages.length} package dependencies:');
+  final pubspecLock = File('pubspec.lock').readAsStringSync().loadPubspecLockFromYaml();
+  print('Loaded pubspec.lock with ${pubspecLock.packages.length} package dependencies:');
 
   final depsNotHostedByPubDev = [
     for (final package in pubspecLock.packages)
       if (!isHostedByPubDev(package))
         package
   ];
 
-  if (depsNotHostedByPubDev.isEmpty)
+  if (depsNotHostedByPubDev.isEmpty) {
     print('SUCCESS: All dependencies are hosted by pub.dev');
-  else {
+  } else {
     print('WARNING: Dependencies hosted outside of pub.dev:');
     depsNotHostedByPubDev.forEach(print);
   }
+
+  File('pubspec.lock').writeAsStringSync(pubspecLock.toYamlString());
 }
 
-bool isHostedByPubDev(PackageDependency package) =>
-    package.iswitcho(
+bool isHostedByPubDev(PackageDependency package) => package.iswitcho(
       hosted: (package) => package.url == 'https://pub.dartlang.org',
       otherwise: () => false,
     );

example/main.dart

@@ -18,5 +18,7 @@ void main() {
   }
 }
 
-bool isHostedByPubDev(PackageDependency package) =>
-    package.iswitcho(hosted: (package) => package.url == 'https://pub.dartlang.org', otherwise: () => false);
+bool isHostedByPubDev(PackageDependency package) => package.iswitcho(
+      hosted: (package) => package.url == 'https://pub.dartlang.org',
+      otherwise: () => false,
+    );

lib/src/package_dependency/package_dependency.dart

@@ -35,6 +35,7 @@ import 'sdk_package_dependency/sdk_package_dependency.dart';
 part 'package_dependency.g.dart';
 
 /// Dependency sources as specified by https://dart.dev/tools/pub/dependencies
+@immutable
 @SumType()
 class PackageDependency extends _$PackageDependency {
   const PackageDependency.sdk(SdkPackageDependency sdk) : super(sdk: sdk);

lib/src/pubspec_lock.dart

@@ -41,10 +41,6 @@ part 'pubspec_lock.g.dart';
 // ignore_for_file: avoid_as
 
 /// PubspecLock is a data type representing data stored in pubspec.lock files.
-/// It provides the following facilities:
-/// - Parser from pubspec.lock YAML string
-/// - Formatter to pubspec.lock YAML string
-/// - https://pub.dev/packages/functional_data is used to provide data type facilities
 @immutable
 @FunctionalData()
 class PubspecLock extends $PubspecLock {

pubspec.yaml

@@ -1,6 +1,6 @@
 name: pubspec_lock
 description: Dart library to access and manipulate content of pubpec.lock files
-version: 1.1.0
+version: 2.0.0
 homepage: https://github.com/alexei-sintotski/pubspec_lock
 
 environment: