From 3fc386e1ce29f898befcb516fc53a34c33886b29 Mon Sep 17 00:00:00 2001 From: Alejandro Santiago Date: Fri, 29 Sep 2023 11:22:54 +0100 Subject: [PATCH 01/20] feat: included pub_license script --- lib/src/pub_license/pub_license.dart | 102 +++++++++++++++++++++++++++ pubspec.yaml | 2 + 2 files changed, 104 insertions(+) create mode 100644 lib/src/pub_license/pub_license.dart diff --git a/lib/src/pub_license/pub_license.dart b/lib/src/pub_license/pub_license.dart new file mode 100644 index 00000000..8befc81a --- /dev/null +++ b/lib/src/pub_license/pub_license.dart @@ -0,0 +1,102 @@ +/// A Dart script which enables checking a package's license. +/// +/// The script is intented to be used by Very Good CLI to help extracting +/// license information. The existance of this script is likely to be ephemeral +/// It may be obsolete once [pub.dev](https://pub.dev/) exposes stable license +/// information in their official API; you may track the progress [here](https://github.com/dart-lang/pub-dev/issues/4717). +library pub_license; + +import 'package:html/dom.dart' as html_dom; +import 'package:html/parser.dart' as html_parser; +import 'package:http/http.dart' as http; +import 'package:meta/meta.dart'; + +/// The pub.dev [Uri] used to retrieve the license of a package. +Uri _pubPackageLicenseUri(String packageName) => + Uri.parse('https://pub.dev/packages/$packageName/license'); + +/// {@template pub_license_exception} +/// An exception thrown by [PubLicense]. +/// {@endtemplate} +class PubLicenseException implements Exception { + /// {@macro pub_license_exception} + const PubLicenseException(String message) + : message = '[pub_license] $message'; + + /// The exception message. + final String message; +} + +/// {@template pub_license} +/// A Dart package that enables checking pub.dev's hosted packages license. +/// {@endtemplate} +class PubLicense { + /// {@macro pub_license} + PubLicense({ + @visibleForTesting http.Client? client, + }) : _client = client ?? http.Client(); + + final http.Client _client; + + /// Retrieves the license of a package. + /// + /// If the license is not found, an empty [Set] is returned. + /// + /// It may throw a [PubLicenseException] if: + /// * The response from pub.dev is not successful. + /// * The response body cannot be parsed. + Future> getLicense(String packageName) async { + final response = await _client.get(_pubPackageLicenseUri(packageName)); + + if (response.statusCode != 200) { + throw PubLicenseException( + '''Failed to retrieve the license of the package, received status code: ${response.statusCode}''', + ); + } + + late final html_dom.Document document; + try { + document = html_parser.parse(response.body); + } on html_parser.ParseError catch (e) { + throw PubLicenseException( + 'Failed to parse the response body, received error: $e', + ); + } catch (e) { + throw PubLicenseException( + '''An unknown error occurred when trying to parse the response body, received error: $e''', + ); + } + + return _scrapeLicense(document); + } +} + +Set _scrapeLicense(html_dom.Document document) { + final detailInfoBox = document.querySelector('.detail-info-box'); + if (detailInfoBox == null) { + throw const PubLicenseException( + '''Failed to scrape license because `.detail-info-box` was not found.''', + ); + } + + late final String? rawLicenseText; + for (var i = 0; i < detailInfoBox.children.length; i++) { + final child = detailInfoBox.children[i]; + + final headerText = child.text.trim().toLowerCase(); + if (headerText == 'license') { + rawLicenseText = detailInfoBox.children[i + 1].text.trim(); + break; + } + } + if (rawLicenseText == null) { + throw const PubLicenseException( + '''Failed to scrape license because the license header was not found.''', + ); + } + + // FIXME(alestiago): Parse those with more than one license, see: + // https://pub.dev/packages/just_audio/license + final licenseText = rawLicenseText.split('(').first.trim(); + throw UnimplementedError(); +} diff --git a/pubspec.yaml b/pubspec.yaml index e0790c8a..5029fd53 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -15,6 +15,8 @@ dependencies: cli_completion: ^0.4.0 collection: ^1.17.1 glob: ^2.0.2 + html: ^0.15.4 # This dependency is temporary and should be removed once pub_license is obsolete. + http: ^1.1.0 # This dependency is temporary and should be removed once pub_license is obsolete. lcov_parser: ^0.1.2 mason: 0.1.0-dev.51 mason_logger: ^0.2.2 From bf4b6d5ce30283daf9e32315e1e96f3a67a23c9b Mon Sep 17 00:00:00 2001 From: Alejandro Santiago Date: Fri, 29 Sep 2023 11:24:56 +0100 Subject: [PATCH 02/20] included test file --- lib/src/pub_license/pub_license.dart | 2 +- test/src/pub_license/pub_license_test.dart | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) create mode 100644 test/src/pub_license/pub_license_test.dart diff --git a/lib/src/pub_license/pub_license.dart b/lib/src/pub_license/pub_license.dart index 8befc81a..b343778f 100644 --- a/lib/src/pub_license/pub_license.dart +++ b/lib/src/pub_license/pub_license.dart @@ -1,7 +1,7 @@ /// A Dart script which enables checking a package's license. /// /// The script is intented to be used by Very Good CLI to help extracting -/// license information. The existance of this script is likely to be ephemeral +/// license information. The existance of this script is likely to be ephemeral. /// It may be obsolete once [pub.dev](https://pub.dev/) exposes stable license /// information in their official API; you may track the progress [here](https://github.com/dart-lang/pub-dev/issues/4717). library pub_license; diff --git a/test/src/pub_license/pub_license_test.dart b/test/src/pub_license/pub_license_test.dart new file mode 100644 index 00000000..8b137891 --- /dev/null +++ b/test/src/pub_license/pub_license_test.dart @@ -0,0 +1 @@ + From fb5ec54f719ffba9b668a4423d4a11b96e7d926f Mon Sep 17 00:00:00 2001 From: Alejandro Santiago Date: Fri, 29 Sep 2023 11:52:17 +0100 Subject: [PATCH 03/20] fixture generation --- .../generate_pub_license_fixture.dart | 73 ++++++ .../pub_license/fixtures/multipleLicense.html | 231 ++++++++++++++++++ test/src/pub_license/fixtures/noLicense.html | 3 + .../pub_license/fixtures/singleLicense.html | 22 ++ 4 files changed, 329 insertions(+) create mode 100644 test/src/pub_license/fixtures/generate_pub_license_fixture.dart create mode 100644 test/src/pub_license/fixtures/multipleLicense.html create mode 100644 test/src/pub_license/fixtures/noLicense.html create mode 100644 test/src/pub_license/fixtures/singleLicense.html diff --git a/test/src/pub_license/fixtures/generate_pub_license_fixture.dart b/test/src/pub_license/fixtures/generate_pub_license_fixture.dart new file mode 100644 index 00000000..16a57328 --- /dev/null +++ b/test/src/pub_license/fixtures/generate_pub_license_fixture.dart @@ -0,0 +1,73 @@ +/// A small script used to generate the fixture for the pub_license test. +/// +/// Fixtures are simply a temporary snapshot of an HTML response from pub.dev. +/// The generated fixtures allows testing pub_license scraping logic without +/// making a request to pub.dev every time the test is run. +/// +/// To run this script, use the following command: +/// ```bash +/// dart test/src/pub_license/fixtures/generate_pub_license_fixture.dart +/// ``` +/// +/// Or simply use the "Run" CodeLens from VSCode's Dart extension. +library generate_pub_license_fixture; + +// ignore_for_file: avoid_print + +import 'dart:io'; + +import 'package:http/http.dart' as http; +import 'package:path/path.dart' as path; + +/// [Uri] used to test the case where a package has a single license. +final _singleLicenseUri = Uri.parse( + 'https://pub.dev/packages/very_good_cli/license', +); + +/// [Uri] used to test the case where a package has multiple licenses. +final _multipleLicenseUri = Uri.parse( + 'https://pub.dev/packages/just_audio/license', +); + +/// [Uri] used to test the case where a package has no license. +final _noLicenseUri = Uri.parse( + 'https://pub.dev/packages/music_control_notification/license', +); + +Future main() async { + final fixtureUris = { + 'singleLicense': _singleLicenseUri, + 'multipleLicense': _multipleLicenseUri, + 'noLicense': _noLicenseUri, + }; + + final httpClient = http.Client(); + + for (final entry in fixtureUris.entries) { + final name = entry.key; + final uri = entry.value; + + final response = await httpClient.get(uri); + + if (response.statusCode != 200) { + print( + '''Failed to generate a fixture for $name, received status code: ${response.statusCode}''', + ); + continue; + } + + final fixturePath = path.joinAll([ + Directory.current.path, + 'test', + 'src', + 'pub_license', + 'fixtures', + '$name.html', + ]); + File(fixturePath) + ..createSync(recursive: true) + ..writeAsStringSync(response.body); + + print('Fixture generated at $fixturePath'); + } +} diff --git a/test/src/pub_license/fixtures/multipleLicense.html b/test/src/pub_license/fixtures/multipleLicense.html new file mode 100644 index 00000000..1b3902bb --- /dev/null +++ b/test/src/pub_license/fixtures/multipleLicense.html @@ -0,0 +1,231 @@ + +just_audio | Flutter Package

Pub.dev

Searching for packagesPackage scoring and pub points

Flutter

Using packagesDeveloping packages and pluginsPublishing a package

Dart

Using packagesPublishing a package

Pub.dev icon to toggle folding of the section

Searching for packagesPackage scoring and pub points

Flutter icon to toggle folding of the section

Using packagesDeveloping packages and pluginsPublishing a package

Dart icon to toggle folding of the section

Using packagesPublishing a package
large Flutter Favorite logosmall Flutter Favorite logo

just_audio 0.9.35 icon indicating copy to clipboard operation
just_audio: ^0.9.35 copied to clipboard

Published 17 days ago • verified publisher iconryanheise.comDart 3 compatible
SDKFlutter
PlatformAndroidiOSmacOSweb
→

Metadata

A feature-rich audio player for Flutter. Loop, clip and concatenate any sound from any source (asset/file/URL/stream) in a variety of audio formats with gapless playback.

More...

License

MIT License
+
+Copyright (c) 2019-2020 Ryan Heise and the project contributors.
+
+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.
+
+==============================================================================
+
+This software includes the ExoPlayer library which is licensed under the Apache
+License, Version 2.0.
+
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

← Metadata

2987
likes
140
pub points
99%
popularity

Publisher

verified publisher iconryanheise.com

Metadata

A feature-rich audio player for Flutter. Loop, clip and concatenate any sound from any source (asset/file/URL/stream) in a variety of audio formats with gapless playback.

Repository (GitHub)
View/report issues
Contributing

Topics

#audio #sound #player #background

Documentation

API reference

License

Icon for licenses.Apache-2.0, MIT (LICENSE)

Dependencies

async, audio_session, crypto, flutter, just_audio_platform_interface, just_audio_web, meta, path, path_provider, rxdart, uuid

More

Packages that depend on just_audio

Back

\ No newline at end of file diff --git a/test/src/pub_license/fixtures/noLicense.html b/test/src/pub_license/fixtures/noLicense.html new file mode 100644 index 00000000..bd818452 --- /dev/null +++ b/test/src/pub_license/fixtures/noLicense.html @@ -0,0 +1,3 @@ + +music_control_notification | Flutter Package

Pub.dev

Searching for packagesPackage scoring and pub points

Flutter

Using packagesDeveloping packages and pluginsPublishing a package

Dart

Using packagesPublishing a package

Pub.dev icon to toggle folding of the section

Searching for packagesPackage scoring and pub points

Flutter icon to toggle folding of the section

Using packagesDeveloping packages and pluginsPublishing a package

Dart icon to toggle folding of the section

Using packagesPublishing a package

music_control_notification 0.0.1+1 icon indicating copy to clipboard operation
music_control_notification: ^0.0.1+1 copied to clipboard

Published 4 years ago Dart 3 incompatible
[unknown platforms]
→

Metadata

Android通知栏音乐控制

More...

License

TODO: Add your license here.
+

← Metadata

2
likes
20
pub points
0%
popularity

Publisher

unverified uploader

Metadata

Android通知栏音乐控制

Repository (GitHub)
View/report issues

License

Icon for licenses.unknown (LICENSE)

Dependencies

flutter

More

Packages that depend on music_control_notification

Back

\ No newline at end of file diff --git a/test/src/pub_license/fixtures/singleLicense.html b/test/src/pub_license/fixtures/singleLicense.html new file mode 100644 index 00000000..f64e3a38 --- /dev/null +++ b/test/src/pub_license/fixtures/singleLicense.html @@ -0,0 +1,22 @@ + +very_good_cli | Dart Package

Pub.dev

Searching for packagesPackage scoring and pub points

Flutter

Using packagesDeveloping packages and pluginsPublishing a package

Dart

Using packagesPublishing a package

Pub.dev icon to toggle folding of the section

Searching for packagesPackage scoring and pub points

Flutter icon to toggle folding of the section

Using packagesDeveloping packages and pluginsPublishing a package

Dart icon to toggle folding of the section

Using packagesPublishing a package

very_good_cli 0.16.0 icon indicating copy to clipboard operation
very_good_cli: ^0.16.0 copied to clipboard

Published 10 days ago • verified publisher iconverygood.venturesDart 3 compatible
SDKDartFlutter
PlatformAndroidiOSLinuxmacOSwebWindows
→

Metadata

A Very Good Command-Line Interface for Dart created by Very Good Ventures.

More...

License

MIT License
+
+Copyright (c) 2021 Very Good Ventures
+
+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.

← Metadata

514
likes
140
pub points
79%
popularity

Publisher

verified publisher iconverygood.ventures

Metadata

A Very Good Command-Line Interface for Dart created by Very Good Ventures.

Homepage
Repository (GitHub)
View/report issues
Contributing

Topics

#cli #codegen #test #template #boilerplate

Documentation

Documentation
API reference

License

Icon for licenses.MIT (LICENSE)

Dependencies

args, cli_completion, collection, glob, lcov_parser, mason, mason_logger, meta, path, pub_updater, pubspec_parse, stack_trace, universal_io, very_good_test_runner

More

Packages that depend on very_good_cli

Back

\ No newline at end of file From 0089051c5eed2de051c887d39af3476fcbbc03f6 Mon Sep 17 00:00:00 2001 From: Alejandro Santiago Date: Fri, 29 Sep 2023 12:07:02 +0100 Subject: [PATCH 04/20] added fixture tests --- lib/src/pub_license/pub_license.dart | 2 +- test/src/pub_license/pub_license_test.dart | 83 ++++++++++++++++++++++ 2 files changed, 84 insertions(+), 1 deletion(-) diff --git a/lib/src/pub_license/pub_license.dart b/lib/src/pub_license/pub_license.dart index b343778f..2bf35de2 100644 --- a/lib/src/pub_license/pub_license.dart +++ b/lib/src/pub_license/pub_license.dart @@ -98,5 +98,5 @@ Set _scrapeLicense(html_dom.Document document) { // FIXME(alestiago): Parse those with more than one license, see: // https://pub.dev/packages/just_audio/license final licenseText = rawLicenseText.split('(').first.trim(); - throw UnimplementedError(); + return licenseText.split(',').map((e) => e.trim()).toSet(); } diff --git a/test/src/pub_license/pub_license_test.dart b/test/src/pub_license/pub_license_test.dart index 8b137891..ec8253ff 100644 --- a/test/src/pub_license/pub_license_test.dart +++ b/test/src/pub_license/pub_license_test.dart @@ -1 +1,84 @@ +import 'dart:io'; +import 'package:http/http.dart' as http; +import 'package:mocktail/mocktail.dart'; +import 'package:path/path.dart' as path; +import 'package:test/test.dart'; +import 'package:very_good_cli/src/pub_license/pub_license.dart'; + +class _MockClient extends Mock implements http.Client {} + +class _MockResponse extends Mock implements http.Response {} + +void main() { + group('PubLicense', () { + test('can be instantiated', () { + expect(PubLicense(), isA()); + }); + + group('getLicense', () { + late http.Client client; + late http.Response response; + + setUpAll(() { + registerFallbackValue(Uri.parse('https://vgv.dev/')); + }); + + setUp(() { + response = _MockResponse(); + when(() => response.statusCode).thenReturn(200); + + client = _MockClient(); + when(() => client.get(any())).thenAnswer((_) async => response); + }); + + group('returns as expected', () { + String fixturePath(String name) => path.joinAll([ + Directory.current.path, + 'test', + 'src', + 'pub_license', + 'fixtures', + '$name.html', + ]); + + test('when parsing a single license fixture', () async { + final fixture = File(fixturePath('singleLicense')).readAsStringSync(); + when(() => response.body).thenReturn(fixture); + + final pubLicense = PubLicense(client: client); + final license = await pubLicense.getLicense('very_good_cli'); + + expect(license.length, equals(1)); + expect(license.first, equals('MIT')); + }); + + test('when parsing a multiple license fixture', () async { + final fixture = + File(fixturePath('multipleLicense')).readAsStringSync(); + when(() => response.body).thenReturn(fixture); + + final pubLicense = PubLicense(client: client); + final license = await pubLicense.getLicense('just_audio'); + + expect(license.length, equals(2)); + expect(license.first, equals('Apache-2.0')); + expect(license.last, equals('MIT')); + }); + + test('when parsing a no license fixture', () async { + final fixture = File(fixturePath('noLicense')).readAsStringSync(); + when(() => response.body).thenReturn(fixture); + + final pubLicense = PubLicense(client: client); + final license = await pubLicense.getLicense( + 'music_control_notification', + ); + + expect(license.length, equals(1)); + expect(license.first, equals('unknown')); + }); + }); + }); + }); +} From a40d325e881dbb0a0e52c81b6c2927ba3df8208e Mon Sep 17 00:00:00 2001 From: Alejandro Santiago Date: Fri, 29 Sep 2023 12:11:36 +0100 Subject: [PATCH 05/20] documented structure --- lib/src/pub_license/pub_license.dart | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/lib/src/pub_license/pub_license.dart b/lib/src/pub_license/pub_license.dart index 2bf35de2..e5e1a113 100644 --- a/lib/src/pub_license/pub_license.dart +++ b/lib/src/pub_license/pub_license.dart @@ -71,6 +71,24 @@ class PubLicense { } } +/// Scrapes the license from the pub.dev's package license page. +/// +/// It may throw a [PubLicenseException] if: +/// * The detail info box is not found. +/// * The license header is not found. +/// +/// The expected HTML structure is: +/// ```html +/// +/// ``` Set _scrapeLicense(html_dom.Document document) { final detailInfoBox = document.querySelector('.detail-info-box'); if (detailInfoBox == null) { @@ -95,8 +113,6 @@ Set _scrapeLicense(html_dom.Document document) { ); } - // FIXME(alestiago): Parse those with more than one license, see: - // https://pub.dev/packages/just_audio/license final licenseText = rawLicenseText.split('(').first.trim(); return licenseText.split(',').map((e) => e.trim()).toSet(); } From bd094181cc95b3cf0fd6db20403f75df70d17e86 Mon Sep 17 00:00:00 2001 From: Alejandro Santiago Date: Fri, 29 Sep 2023 12:34:37 +0100 Subject: [PATCH 06/20] added tests --- lib/src/pub_license/pub_license.dart | 21 ++- test/src/pub_license/pub_license_test.dart | 169 +++++++++++++++++++-- 2 files changed, 172 insertions(+), 18 deletions(-) diff --git a/lib/src/pub_license/pub_license.dart b/lib/src/pub_license/pub_license.dart index e5e1a113..40527792 100644 --- a/lib/src/pub_license/pub_license.dart +++ b/lib/src/pub_license/pub_license.dart @@ -34,10 +34,25 @@ class PubLicense { /// {@macro pub_license} PubLicense({ @visibleForTesting http.Client? client, - }) : _client = client ?? http.Client(); + @visibleForTesting + html_dom.Document Function( + dynamic input, { + String? encoding, + bool generateSpans, + String? sourceUrl, + })? parse, + }) : _client = client ?? http.Client(), + _parse = parse ?? html_parser.parse; final http.Client _client; + final html_dom.Document Function( + dynamic input, { + String? encoding, + bool generateSpans, + String? sourceUrl, + }) _parse; + /// Retrieves the license of a package. /// /// If the license is not found, an empty [Set] is returned. @@ -56,7 +71,7 @@ class PubLicense { late final html_dom.Document document; try { - document = html_parser.parse(response.body); + document = _parse(response.body); } on html_parser.ParseError catch (e) { throw PubLicenseException( 'Failed to parse the response body, received error: $e', @@ -97,7 +112,7 @@ Set _scrapeLicense(html_dom.Document document) { ); } - late final String? rawLicenseText; + String? rawLicenseText; for (var i = 0; i < detailInfoBox.children.length; i++) { final child = detailInfoBox.children[i]; diff --git a/test/src/pub_license/pub_license_test.dart b/test/src/pub_license/pub_license_test.dart index ec8253ff..9b346e18 100644 --- a/test/src/pub_license/pub_license_test.dart +++ b/test/src/pub_license/pub_license_test.dart @@ -1,5 +1,7 @@ import 'dart:io'; +import 'package:html/dom.dart' as html_dom; +import 'package:html/parser.dart' as html_parser; import 'package:http/http.dart' as http; import 'package:mocktail/mocktail.dart'; import 'package:path/path.dart' as path; @@ -10,28 +12,38 @@ class _MockClient extends Mock implements http.Client {} class _MockResponse extends Mock implements http.Response {} +class _MockParseError extends Mock implements html_parser.ParseError { + @override + String toString({dynamic color}) => super.toString(); +} + +class _MockDocument extends Mock implements html_dom.Document {} + +class _MockElement extends Mock implements html_dom.Element {} + void main() { group('PubLicense', () { - test('can be instantiated', () { - expect(PubLicense(), isA()); - }); + late http.Client client; + late http.Response response; - group('getLicense', () { - late http.Client client; - late http.Response response; + setUpAll(() { + registerFallbackValue(Uri.parse('https://vgv.dev/')); + }); - setUpAll(() { - registerFallbackValue(Uri.parse('https://vgv.dev/')); - }); + setUp(() { + response = _MockResponse(); + when(() => response.statusCode).thenReturn(200); + when(() => response.body).thenReturn(''); - setUp(() { - response = _MockResponse(); - when(() => response.statusCode).thenReturn(200); + client = _MockClient(); + when(() => client.get(any())).thenAnswer((_) async => response); + }); - client = _MockClient(); - when(() => client.get(any())).thenAnswer((_) async => response); - }); + test('can be instantiated', () { + expect(PubLicense(), isA()); + }); + group('getLicense', () { group('returns as expected', () { String fixturePath(String name) => path.joinAll([ Directory.current.path, @@ -79,6 +91,133 @@ void main() { expect(license.first, equals('unknown')); }); }); + + group('throws a PubLicenseException', () { + test('when statusCode is not 200', () async { + when(() => response.statusCode).thenReturn(404); + + final pubLicense = PubLicense(client: client); + + final errorMessage = + '''[pub_license] Failed to retrieve the license of the package, received status code: ${response.statusCode}'''; + await expectLater( + () => pubLicense.getLicense('very_good_cli'), + throwsA( + isA().having( + (exception) => exception.message, + 'message', + equals(errorMessage), + ), + ), + ); + }); + + group('when parsing fails', () { + test('with a ParseError', () async { + final parseError = _MockParseError(); + final pubLicense = PubLicense( + client: client, + parse: (input, {encoding, generateSpans = true, sourceUrl}) => + throw parseError, + ); + + final errorMessage = + '''[pub_license] Failed to parse the response body, received error: $parseError'''; + await expectLater( + () => pubLicense.getLicense('very_good_cli'), + throwsA( + isA().having( + (exception) => exception.message, + 'message', + equals(errorMessage), + ), + ), + ); + }); + + test('with an unexpected error', () async { + const error = 'unexpected error'; + final pubLicense = PubLicense( + client: client, + parse: (input, {encoding, generateSpans = true, sourceUrl}) => + // ignore: only_throw_errors + throw error, + ); + + const errorMessage = + '''[pub_license] An unknown error occurred when trying to parse the response body, received error: $error'''; + await expectLater( + () => pubLicense.getLicense('very_good_cli'), + throwsA( + isA().having( + (exception) => exception.message, + 'message', + equals(errorMessage), + ), + ), + ); + }); + }); + + group('when scraping fails', () { + late html_dom.Document document; + late html_dom.Element element; + + setUp(() { + document = _MockDocument(); + element = _MockElement(); + }); + + test('due to missing `.detail-info-box`', () async { + when(() => document.querySelector('.detail-info-box')) + .thenReturn(null); + + final pubLicense = PubLicense( + client: client, + parse: (input, {encoding, generateSpans = true, sourceUrl}) => + document, + ); + + const errorMessage = + '''[pub_license] Failed to scrape license because `.detail-info-box` was not found.'''; + await expectLater( + () => pubLicense.getLicense('very_good_cli'), + throwsA( + isA().having( + (exception) => exception.message, + 'message', + equals(errorMessage), + ), + ), + ); + }); + + test('due to missing license header', () async { + when(() => document.querySelector('.detail-info-box')) + .thenReturn(element); + when(() => element.children).thenReturn([]); + + final pubLicense = PubLicense( + client: client, + parse: (input, {encoding, generateSpans = true, sourceUrl}) => + document, + ); + + const errorMessage = + '''[pub_license] Failed to scrape license because the license header was not found.'''; + await expectLater( + () => pubLicense.getLicense('very_good_cli'), + throwsA( + isA().having( + (exception) => exception.message, + 'message', + equals(errorMessage), + ), + ), + ); + }); + }); + }); }); }); } From 4674a27fd2a6bcbf63c0e20a6175bf640c0b6c51 Mon Sep 17 00:00:00 2001 From: Alejandro Santiago Date: Fri, 29 Sep 2023 12:37:25 +0100 Subject: [PATCH 07/20] fixed doc typo --- lib/src/pub_license/pub_license.dart | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/src/pub_license/pub_license.dart b/lib/src/pub_license/pub_license.dart index 40527792..4e0c9570 100644 --- a/lib/src/pub_license/pub_license.dart +++ b/lib/src/pub_license/pub_license.dart @@ -28,7 +28,7 @@ class PubLicenseException implements Exception { } /// {@template pub_license} -/// A Dart package that enables checking pub.dev's hosted packages license. +/// Enables checking pub.dev's hosted packages license. /// {@endtemplate} class PubLicense { /// {@macro pub_license} From b3c1ffd36f7530009f23db09f7490c63cc497b77 Mon Sep 17 00:00:00 2001 From: Alejandro Santiago Date: Fri, 29 Sep 2023 12:38:30 +0100 Subject: [PATCH 08/20] improved docs --- lib/src/pub_license/pub_license.dart | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/src/pub_license/pub_license.dart b/lib/src/pub_license/pub_license.dart index 4e0c9570..6e0bbd6f 100644 --- a/lib/src/pub_license/pub_license.dart +++ b/lib/src/pub_license/pub_license.dart @@ -55,7 +55,7 @@ class PubLicense { /// Retrieves the license of a package. /// - /// If the license is not found, an empty [Set] is returned. + /// Some packages may have multiple licenses, hence a [Set] is returned. /// /// It may throw a [PubLicenseException] if: /// * The response from pub.dev is not successful. From c7a6a476c697b55fdc2bad7c82bc18038051005f Mon Sep 17 00:00:00 2001 From: Alejandro Santiago Date: Fri, 29 Sep 2023 12:39:12 +0100 Subject: [PATCH 09/20] moved "it may throw" to end --- lib/src/pub_license/pub_license.dart | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/src/pub_license/pub_license.dart b/lib/src/pub_license/pub_license.dart index 6e0bbd6f..0942758d 100644 --- a/lib/src/pub_license/pub_license.dart +++ b/lib/src/pub_license/pub_license.dart @@ -88,10 +88,6 @@ class PubLicense { /// Scrapes the license from the pub.dev's package license page. /// -/// It may throw a [PubLicenseException] if: -/// * The detail info box is not found. -/// * The license header is not found. -/// /// The expected HTML structure is: /// ```html /// /// ``` +/// +/// It may throw a [PubLicenseException] if: +/// * The detail info box is not found. +/// * The license header is not found. Set _scrapeLicense(html_dom.Document document) { final detailInfoBox = document.querySelector('.detail-info-box'); if (detailInfoBox == null) { From 39d7f3a4b831a67812b6830bbc1c9a0e8ebc41cb Mon Sep 17 00:00:00 2001 From: Alejandro Santiago Date: Fri, 29 Sep 2023 12:40:19 +0100 Subject: [PATCH 10/20] documentation typo --- test/src/pub_license/fixtures/generate_pub_license_fixture.dart | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/src/pub_license/fixtures/generate_pub_license_fixture.dart b/test/src/pub_license/fixtures/generate_pub_license_fixture.dart index 16a57328..e6ce2c25 100644 --- a/test/src/pub_license/fixtures/generate_pub_license_fixture.dart +++ b/test/src/pub_license/fixtures/generate_pub_license_fixture.dart @@ -1,7 +1,7 @@ /// A small script used to generate the fixture for the pub_license test. /// /// Fixtures are simply a temporary snapshot of an HTML response from pub.dev. -/// The generated fixtures allows testing pub_license scraping logic without +/// The generated fixtures allow testing pub_license scraping logic without /// making a request to pub.dev every time the test is run. /// /// To run this script, use the following command: From e743bcdc706b3b4852d06a259dfcf22285c15ea4 Mon Sep 17 00:00:00 2001 From: Alejandro Santiago Date: Fri, 29 Sep 2023 12:40:53 +0100 Subject: [PATCH 11/20] improved docs --- .../src/pub_license/fixtures/generate_pub_license_fixture.dart | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/test/src/pub_license/fixtures/generate_pub_license_fixture.dart b/test/src/pub_license/fixtures/generate_pub_license_fixture.dart index e6ce2c25..0f4591cb 100644 --- a/test/src/pub_license/fixtures/generate_pub_license_fixture.dart +++ b/test/src/pub_license/fixtures/generate_pub_license_fixture.dart @@ -9,7 +9,8 @@ /// dart test/src/pub_license/fixtures/generate_pub_license_fixture.dart /// ``` /// -/// Or simply use the "Run" CodeLens from VSCode's Dart extension. +/// Or simply use the "Run" CodeLens from VSCode's Dart extension if running +/// from VSCode. library generate_pub_license_fixture; // ignore_for_file: avoid_print From c93930b332b3591ee74bc4108e1063048fea8380 Mon Sep 17 00:00:00 2001 From: Alejandro Santiago Date: Fri, 29 Sep 2023 12:44:13 +0100 Subject: [PATCH 12/20] exclude __brick__ from analysis --- analysis_options.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/analysis_options.yaml b/analysis_options.yaml index 8a15d68f..76523654 100644 --- a/analysis_options.yaml +++ b/analysis_options.yaml @@ -2,3 +2,4 @@ include: package:very_good_analysis/analysis_options.5.1.0.yaml analyzer: exclude: - "**/version.dart" + - "/bricks/**/__brick__/**" From 21e0b700cd7bc86f2d44edf760706dce78dd5ce4 Mon Sep 17 00:00:00 2001 From: Alejandro Santiago Date: Fri, 29 Sep 2023 12:49:39 +0100 Subject: [PATCH 13/20] simplified exclude --- analysis_options.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/analysis_options.yaml b/analysis_options.yaml index 76523654..646bccec 100644 --- a/analysis_options.yaml +++ b/analysis_options.yaml @@ -2,4 +2,4 @@ include: package:very_good_analysis/analysis_options.5.1.0.yaml analyzer: exclude: - "**/version.dart" - - "/bricks/**/__brick__/**" + - "bricks/**/__brick__" From 05025cc8f2a67d57665367dea3e004d53321bf66 Mon Sep 17 00:00:00 2001 From: Alejandro Santiago Date: Fri, 29 Sep 2023 12:52:03 +0100 Subject: [PATCH 14/20] change defaults as in dart package --- .github/workflows/very_good_cli.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/very_good_cli.yaml b/.github/workflows/very_good_cli.yaml index 2d1f7705..f0ff7c11 100644 --- a/.github/workflows/very_good_cli.yaml +++ b/.github/workflows/very_good_cli.yaml @@ -31,7 +31,7 @@ jobs: run: flutter pub get - name: Format - run: dart format --set-exit-if-changed . + run: dart format --set-exit-if-changed lib test - name: Analyze run: flutter analyze lib test From 30ca35e55e8473d93e7adee67088f9dfbd34c0ef Mon Sep 17 00:00:00 2001 From: Alejandro Santiago Date: Fri, 29 Sep 2023 12:55:51 +0100 Subject: [PATCH 15/20] improved docs --- lib/src/pub_license/pub_license.dart | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/src/pub_license/pub_license.dart b/lib/src/pub_license/pub_license.dart index 0942758d..e78e2097 100644 --- a/lib/src/pub_license/pub_license.dart +++ b/lib/src/pub_license/pub_license.dart @@ -1,4 +1,4 @@ -/// A Dart script which enables checking a package's license. +/// Enables checking a package's license from pub.dev. /// /// The script is intented to be used by Very Good CLI to help extracting /// license information. The existance of this script is likely to be ephemeral. From b1a38fd35d2e8ae9e99d3fac045aa99bc0894948 Mon Sep 17 00:00:00 2001 From: Alejandro Santiago Date: Fri, 29 Sep 2023 12:56:20 +0100 Subject: [PATCH 16/20] improved docs --- lib/src/pub_license/pub_license.dart | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/src/pub_license/pub_license.dart b/lib/src/pub_license/pub_license.dart index e78e2097..ae340d0e 100644 --- a/lib/src/pub_license/pub_license.dart +++ b/lib/src/pub_license/pub_license.dart @@ -1,6 +1,6 @@ /// Enables checking a package's license from pub.dev. /// -/// The script is intented to be used by Very Good CLI to help extracting +/// This library is intented to be used by Very Good CLI to help extracting /// license information. The existance of this script is likely to be ephemeral. /// It may be obsolete once [pub.dev](https://pub.dev/) exposes stable license /// information in their official API; you may track the progress [here](https://github.com/dart-lang/pub-dev/issues/4717). From d458d6ba28eb546ae8ffc270fecc6fac006c997d Mon Sep 17 00:00:00 2001 From: Alejandro Santiago Date: Fri, 29 Sep 2023 12:56:48 +0100 Subject: [PATCH 17/20] improved docs --- lib/src/pub_license/pub_license.dart | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/lib/src/pub_license/pub_license.dart b/lib/src/pub_license/pub_license.dart index ae340d0e..fd44ac22 100644 --- a/lib/src/pub_license/pub_license.dart +++ b/lib/src/pub_license/pub_license.dart @@ -1,9 +1,10 @@ /// Enables checking a package's license from pub.dev. /// /// This library is intented to be used by Very Good CLI to help extracting -/// license information. The existance of this script is likely to be ephemeral. -/// It may be obsolete once [pub.dev](https://pub.dev/) exposes stable license -/// information in their official API; you may track the progress [here](https://github.com/dart-lang/pub-dev/issues/4717). +/// license information. The existance of this library is likely to be +/// ephemeral. It may be obsolete once [pub.dev](https://pub.dev/) exposes +/// stable license information in their official API; you may track the +/// progress [here](https://github.com/dart-lang/pub-dev/issues/4717). library pub_license; import 'package:html/dom.dart' as html_dom; From a36f5c537ea4815938fd83b8bc7c66f6545752fc Mon Sep 17 00:00:00 2001 From: Alejandro Santiago Date: Fri, 29 Sep 2023 12:58:31 +0100 Subject: [PATCH 18/20] rename to generate_pub_license_fixtures --- ..._license_fixture.dart => generate_pub_license_fixtures.dart} | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) rename test/src/pub_license/fixtures/{generate_pub_license_fixture.dart => generate_pub_license_fixtures.dart} (98%) diff --git a/test/src/pub_license/fixtures/generate_pub_license_fixture.dart b/test/src/pub_license/fixtures/generate_pub_license_fixtures.dart similarity index 98% rename from test/src/pub_license/fixtures/generate_pub_license_fixture.dart rename to test/src/pub_license/fixtures/generate_pub_license_fixtures.dart index 0f4591cb..4396df64 100644 --- a/test/src/pub_license/fixtures/generate_pub_license_fixture.dart +++ b/test/src/pub_license/fixtures/generate_pub_license_fixtures.dart @@ -11,7 +11,7 @@ /// /// Or simply use the "Run" CodeLens from VSCode's Dart extension if running /// from VSCode. -library generate_pub_license_fixture; +library generate_pub_license_fixtures; // ignore_for_file: avoid_print From e69f93db7c35701e11f97718f480035a7d6f2f33 Mon Sep 17 00:00:00 2001 From: Alejandro Santiago Date: Fri, 29 Sep 2023 12:58:47 +0100 Subject: [PATCH 19/20] updated documentation --- .../src/pub_license/fixtures/generate_pub_license_fixtures.dart | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/src/pub_license/fixtures/generate_pub_license_fixtures.dart b/test/src/pub_license/fixtures/generate_pub_license_fixtures.dart index 4396df64..476b70fe 100644 --- a/test/src/pub_license/fixtures/generate_pub_license_fixtures.dart +++ b/test/src/pub_license/fixtures/generate_pub_license_fixtures.dart @@ -6,7 +6,7 @@ /// /// To run this script, use the following command: /// ```bash -/// dart test/src/pub_license/fixtures/generate_pub_license_fixture.dart +/// dart test/src/pub_license/fixtures/generate_pub_license_fixtures.dart /// ``` /// /// Or simply use the "Run" CodeLens from VSCode's Dart extension if running From 3ff0d2646dfa82aed7c75be1bce6899bc96bded7 Mon Sep 17 00:00:00 2001 From: Alejandro Santiago Date: Tue, 3 Oct 2023 14:25:42 +0100 Subject: [PATCH 20/20] refactor: add typedef --- lib/src/pub_license/pub_license.dart | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/lib/src/pub_license/pub_license.dart b/lib/src/pub_license/pub_license.dart index fd44ac22..7a0cf3bd 100644 --- a/lib/src/pub_license/pub_license.dart +++ b/lib/src/pub_license/pub_license.dart @@ -28,6 +28,15 @@ class PubLicenseException implements Exception { final String message; } +/// The function signature for parsing HTML documents. +@visibleForTesting +typedef HtmlDocumentParse = html_dom.Document Function( + dynamic input, { + String? encoding, + bool generateSpans, + String? sourceUrl, +}); + /// {@template pub_license} /// Enables checking pub.dev's hosted packages license. /// {@endtemplate} @@ -35,13 +44,7 @@ class PubLicense { /// {@macro pub_license} PubLicense({ @visibleForTesting http.Client? client, - @visibleForTesting - html_dom.Document Function( - dynamic input, { - String? encoding, - bool generateSpans, - String? sourceUrl, - })? parse, + @visibleForTesting HtmlDocumentParse? parse, }) : _client = client ?? http.Client(), _parse = parse ?? html_parser.parse;