Support for publish_to field

Author: alexei-sintotski

lib/src/internal/load_from_yaml.dart

@@ -63,6 +63,7 @@ PubspecYaml loadFromYaml(String content) {
     executables: jsonMap.containsKey(Tokens.executables) && jsonMap[Tokens.executables] != null
         ? _loadExecutables(jsonMap[Tokens.executables] as Map<String, dynamic>)
         : {},
+    publishTo: Optional(jsonMap[Tokens.publishTo] as String),
     customFields: Map<String, dynamic>.fromEntries(jsonMap.entries.where((entry) => !_knownTokens.contains(entry.key))),
   );
 }
@@ -156,4 +157,5 @@ const _knownTokens = [
   Tokens.devDependencies,
   Tokens.dependencyOverrides,
   Tokens.environment,
+  Tokens.publishTo,
 ];

lib/src/internal/tokens.dart

@@ -43,4 +43,5 @@ class Tokens {
   static const devDependencies = 'dev_dependencies';
   static const dependencyOverrides = 'dependency_overrides';
   static const environment = 'environment';
+  static const publishTo = 'publish_to';
 }

lib/src/internal/yaml_formatter.dart

@@ -56,6 +56,7 @@ String _packageMetadataToYaml(PubspecYaml pubspecYaml) => json2yaml(<String, dyn
       if (pubspecYaml.repository.hasValue) Tokens.repository: pubspecYaml.repository.valueOr(() => ''),
       if (pubspecYaml.issueTracker.hasValue) Tokens.issueTracker: pubspecYaml.issueTracker.valueOr(() => ''),
       if (pubspecYaml.documentation.hasValue) Tokens.documentation: pubspecYaml.documentation.valueOr(() => ''),
+      if (pubspecYaml.publishTo.hasValue) Tokens.publishTo: pubspecYaml.publishTo.valueOr(() => ''),
     }, yamlStyle: YamlStyle.pubspecYaml);
 
 String _dependenciesToYaml(

lib/src/pubspec_yaml.dart

@@ -54,6 +54,7 @@ class PubspecYaml extends $PubspecYaml {
     this.repository = const Optional.none(),
     this.issueTracker = const Optional.none(),
     this.documentation = const Optional.none(),
+    this.publishTo = const Optional.none(),
     this.dependencies = const [],
     this.devDependencies = const [],
     this.dependencyOverrides = const [],
@@ -95,6 +96,12 @@ class PubspecYaml extends $PubspecYaml {
   ///https://dart.dev/tools/pub/pubspec#documentation
   final Optional<String> documentation;
 
+  /// This setting can be used to specify a custom pub package server to publish.
+  /// The default uses the pub.dev site.
+  /// Specify none to prevent a package from being published.
+  /// https://dart.dev/tools/pub/pubspec#publish_to
+  final Optional<String> publishTo;
+
   /// Regular dependencies that anyone using the package will also need
   /// https://dart.dev/tools/pub/pubspec#dependencies
   /// https://dart.dev/tools/pub/dependencies

lib/src/pubspec_yaml.g.dart

@@ -0,0 +1,55 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2019 Alexei Sintotski
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ *
+ */
+
+import 'package:pubspec_yaml/src/pubspec_yaml.dart';
+import 'package:test/test.dart';
+
+void main() {
+  group('given pubspec.yaml with publish_to specification', () {
+    final pubspecYaml = PubspecYaml.loadFromYamlString(pubspecYamlWithPublishToSpec);
+
+    group('$PubspecYaml.loadFromYamlString', () {
+      test('produces object with publish_to data', () {
+        expect(pubspecYaml.publishTo.valueOr(() => ''), publishTo);
+      });
+      test('produces object without custom fields', () {
+        expect(pubspecYaml.customFields, isEmpty);
+      });
+    });
+
+    group('$PubspecYaml.toYamlString', () {
+      final outputYaml = pubspecYaml.toYamlString();
+      test('produces string equivalent to the input', () {
+        expect(outputYaml, pubspecYamlWithPublishToSpec);
+      });
+    });
+  });
+}
+
+const publishTo = 'none';
+const pubspecYamlWithPublishToSpec = '''
+name: pubspec_yaml
+publish_to: $publishTo
+''';