From 3da8cf9bb63ec5763e886a64c6e1e47d00331f72 Mon Sep 17 00:00:00 2001 From: zyrouge Date: Tue, 31 Oct 2023 13:35:31 +0530 Subject: [PATCH] refactor: sora module --- LICENSE | 5 +- README.md | 4 +- modules/anime/animepahe_com/module.dart | 2 +- modules/anime/animepahe_com/test.dart | 12 +- modules/anime/gogoanime_bid/module.dart | 2 +- modules/anime/gogoanime_bid/test.dart | 12 +- modules/anime/hanime_tv/module.dart | 2 +- modules/anime/hanime_tv/test.dart | 12 +- modules/manga/fanfox_net/module.dart | 2 +- modules/manga/fanfox_net/test.dart | 12 +- modules/manga/mangadex_org/module.dart | 2 +- modules/manga/mangadex_org/test.dart | 12 +- modules/manga/mangasee123_com/module.dart | 2 +- modules/manga/mangasee123_com/test.dart | 12 +- modules/manga/readm_org/module.dart | 2 +- modules/manga/readm_org/test.dart | 12 +- packages/sora_builder/LICENSE | 673 ++++++++++++++++++ packages/sora_builder/analysis_options.yaml | 1 + packages/sora_builder/lib/actions/build.dart | 123 ++++ .../sora_builder/lib/actions/exports.dart | 2 + packages/sora_builder/lib/actions/test.dart | 200 ++++++ packages/sora_builder/lib/core/exports.dart | 3 + packages/sora_builder/lib/core/module.dart | 102 +++ packages/sora_builder/lib/core/paths.dart | 24 + packages/sora_builder/lib/core/urls.dart | 4 + packages/sora_builder/lib/sora_builder.dart | 6 + .../sora_builder/lib}/utils/emojis.dart | 0 packages/sora_builder/lib/utils/exports.dart | 1 + packages/sora_builder/pubspec.lock | 278 ++++++++ packages/sora_builder/pubspec.yaml | 31 + pubspec.lock | 21 +- pubspec.yaml | 11 +- store/build.dart | 124 +--- store/core/module.dart | 119 +--- store/core/modules.dart | 17 +- ...les_exported.dart => modules_exports.dart} | 0 store/core/paths.dart | 9 + store/core/urls.dart | 18 + store/helpers/mono_test.dart | 21 + store/test.dart | 235 +----- store/utils/constants.dart | 12 - store/utils/paths.dart | 21 - store/utils/runner.dart | 36 - 43 files changed, 1569 insertions(+), 630 deletions(-) create mode 100644 packages/sora_builder/LICENSE create mode 100644 packages/sora_builder/analysis_options.yaml create mode 100644 packages/sora_builder/lib/actions/build.dart create mode 100644 packages/sora_builder/lib/actions/exports.dart create mode 100644 packages/sora_builder/lib/actions/test.dart create mode 100644 packages/sora_builder/lib/core/exports.dart create mode 100644 packages/sora_builder/lib/core/module.dart create mode 100644 packages/sora_builder/lib/core/paths.dart create mode 100644 packages/sora_builder/lib/core/urls.dart create mode 100644 packages/sora_builder/lib/sora_builder.dart rename {store => packages/sora_builder/lib}/utils/emojis.dart (100%) create mode 100644 packages/sora_builder/lib/utils/exports.dart create mode 100644 packages/sora_builder/pubspec.lock create mode 100644 packages/sora_builder/pubspec.yaml rename store/core/{modules_exported.dart => modules_exports.dart} (100%) create mode 100644 store/core/paths.dart create mode 100644 store/core/urls.dart create mode 100644 store/helpers/mono_test.dart delete mode 100644 store/utils/constants.dart delete mode 100644 store/utils/paths.dart delete mode 100644 store/utils/runner.dart diff --git a/LICENSE b/LICENSE index cb00959..f251021 100644 --- a/LICENSE +++ b/LICENSE @@ -631,8 +631,7 @@ to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. - - Copyright (C) 2022 yukino-org + Sora Copyright (C) 2023 yukino-org This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by @@ -652,7 +651,7 @@ Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: - Tenka Modules Copyright (C) 2022 Yukino Org + Sora Copyright (C) 2023 yukino-org This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. diff --git a/README.md b/README.md index e697dfe..e13af30 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,9 @@ By using this project, you agree to the [usage policy](https://yukino-org.github.io/wiki/tenka/disclaimer/). [![License: GPL v3](https://img.shields.io/badge/License-GPL_v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) -[![Test Modules](https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2Fyukino-org%2Fsora%2Fsummary%2Fbadge.json)](https://github.com/yukino-org/sora/actions/workflows/test-modules.yml) +[![Deploy](https://github.com/yukino-org/sora/actions/workflows/deploy.yml/badge.svg)](https://github.com/yukino-org/sora/actions/workflows/deploy.yml) +[![Test Modules](https://github.com/yukino-org/sora/actions/workflows/test-modules.yml/badge.svg)](https://github.com/yukino-org/sora/actions/workflows/test-modules.yml) +[![Test Modules Summary](https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2Fyukino-org%2Fsora%2Fsummary%2Fbadge.json)](https://github.com/yukino-org/sora/actions/workflows/test-modules.yml) ## Anime diff --git a/modules/anime/animepahe_com/module.dart b/modules/anime/animepahe_com/module.dart index aa1e233..40e75b9 100644 --- a/modules/anime/animepahe_com/module.dart +++ b/modules/anime/animepahe_com/module.dart @@ -2,7 +2,7 @@ import 'package:tenka/tenka.dart'; import 'package:tenka_dev_tools/test/anime.dart'; import '../../../store/core/module.dart'; -class AnimePahe extends SAnimeModule { +class AnimePahe extends $AnimeModule { @override String id() => 'animepahe_com'; diff --git a/modules/anime/animepahe_com/test.dart b/modules/anime/animepahe_com/test.dart index 68c53ea..ebbf0fe 100644 --- a/modules/anime/animepahe_com/test.dart +++ b/modules/anime/animepahe_com/test.dart @@ -1,14 +1,6 @@ -import 'package:tenka/tenka.dart'; -import 'package:tenka_dev_tools/tenka_dev_tools.dart'; -import '../../../store/core/module.dart'; -import '../../../store/test.dart'; +import '../../../store/helpers/mono_test.dart'; import 'module.dart'; Future main() async { - final SAnimeModule module = AnimePahe(); - final TenkaMetadata config = await module.config(); - final MockedAnimeExtractor mocked = module.mock(); - await STester.runProcedure( - () => mocked.run(config.source as TenkaLocalFileDS), - ); + await $test(AnimePahe()); } diff --git a/modules/anime/gogoanime_bid/module.dart b/modules/anime/gogoanime_bid/module.dart index 8782c28..86d6a33 100644 --- a/modules/anime/gogoanime_bid/module.dart +++ b/modules/anime/gogoanime_bid/module.dart @@ -2,7 +2,7 @@ import 'package:tenka/tenka.dart'; import 'package:tenka_dev_tools/test/anime.dart'; import '../../../store/core/module.dart'; -class GogoAnime extends SAnimeModule { +class GogoAnime extends $AnimeModule { @override String id() => 'gogoanime_bid'; diff --git a/modules/anime/gogoanime_bid/test.dart b/modules/anime/gogoanime_bid/test.dart index 9825e05..7033eb8 100644 --- a/modules/anime/gogoanime_bid/test.dart +++ b/modules/anime/gogoanime_bid/test.dart @@ -1,14 +1,6 @@ -import 'package:tenka/tenka.dart'; -import 'package:tenka_dev_tools/tenka_dev_tools.dart'; -import '../../../store/core/module.dart'; -import '../../../store/test.dart'; +import '../../../store/helpers/mono_test.dart'; import 'module.dart'; Future main() async { - final SAnimeModule module = GogoAnime(); - final TenkaMetadata config = await module.config(); - final MockedAnimeExtractor mocked = module.mock(); - await STester.runProcedure( - () => mocked.run(config.source as TenkaLocalFileDS), - ); + await $test(GogoAnime()); } diff --git a/modules/anime/hanime_tv/module.dart b/modules/anime/hanime_tv/module.dart index e78a630..b414622 100644 --- a/modules/anime/hanime_tv/module.dart +++ b/modules/anime/hanime_tv/module.dart @@ -2,7 +2,7 @@ import 'package:tenka/tenka.dart'; import 'package:tenka_dev_tools/test/anime.dart'; import '../../../store/core/module.dart'; -class HAnime extends SAnimeModule { +class HAnime extends $AnimeModule { @override String id() => 'hanime_tv'; diff --git a/modules/anime/hanime_tv/test.dart b/modules/anime/hanime_tv/test.dart index 7bd30e2..37e5b64 100644 --- a/modules/anime/hanime_tv/test.dart +++ b/modules/anime/hanime_tv/test.dart @@ -1,14 +1,6 @@ -import 'package:tenka/tenka.dart'; -import 'package:tenka_dev_tools/tenka_dev_tools.dart'; -import '../../../store/core/module.dart'; -import '../../../store/test.dart'; +import '../../../store/helpers/mono_test.dart'; import 'module.dart'; Future main() async { - final SAnimeModule module = HAnime(); - final TenkaMetadata config = await module.config(); - final MockedAnimeExtractor mocked = module.mock(); - await STester.runProcedure( - () => mocked.run(config.source as TenkaLocalFileDS), - ); + await $test(HAnime()); } diff --git a/modules/manga/fanfox_net/module.dart b/modules/manga/fanfox_net/module.dart index 3cbf4ea..89afe18 100644 --- a/modules/manga/fanfox_net/module.dart +++ b/modules/manga/fanfox_net/module.dart @@ -2,7 +2,7 @@ import 'package:tenka/tenka.dart'; import 'package:tenka_dev_tools/tenka_dev_tools.dart'; import '../../../store/core/module.dart'; -class FanFox extends SMangaModule { +class FanFox extends $MangaModule { @override String id() => 'fanfox_net'; diff --git a/modules/manga/fanfox_net/test.dart b/modules/manga/fanfox_net/test.dart index 6c0723e..9531218 100644 --- a/modules/manga/fanfox_net/test.dart +++ b/modules/manga/fanfox_net/test.dart @@ -1,14 +1,6 @@ -import 'package:tenka/tenka.dart'; -import 'package:tenka_dev_tools/tenka_dev_tools.dart'; -import '../../../store/core/module.dart'; -import '../../../store/test.dart'; +import '../../../store/helpers/mono_test.dart'; import 'module.dart'; Future main() async { - final SMangaModule module = FanFox(); - final TenkaMetadata config = await module.config(); - final MockedMangaExtractor mocked = module.mock(); - await STester.runProcedure( - () => mocked.run(config.source as TenkaLocalFileDS), - ); + $test(FanFox()); } diff --git a/modules/manga/mangadex_org/module.dart b/modules/manga/mangadex_org/module.dart index 0bbbfbf..06b2159 100644 --- a/modules/manga/mangadex_org/module.dart +++ b/modules/manga/mangadex_org/module.dart @@ -2,7 +2,7 @@ import 'package:tenka/tenka.dart'; import 'package:tenka_dev_tools/tenka_dev_tools.dart'; import '../../../store/core/module.dart'; -class MangaDex extends SMangaModule { +class MangaDex extends $MangaModule { @override String id() => 'mangadex_org'; diff --git a/modules/manga/mangadex_org/test.dart b/modules/manga/mangadex_org/test.dart index 9be2185..f3524b8 100644 --- a/modules/manga/mangadex_org/test.dart +++ b/modules/manga/mangadex_org/test.dart @@ -1,14 +1,6 @@ -import 'package:tenka/tenka.dart'; -import 'package:tenka_dev_tools/tenka_dev_tools.dart'; -import '../../../store/core/module.dart'; -import '../../../store/test.dart'; +import '../../../store/helpers/mono_test.dart'; import 'module.dart'; Future main() async { - final SMangaModule module = MangaDex(); - final TenkaMetadata config = await module.config(); - final MockedMangaExtractor mocked = module.mock(); - await STester.runProcedure( - () => mocked.run(config.source as TenkaLocalFileDS), - ); + $test(MangaDex()); } diff --git a/modules/manga/mangasee123_com/module.dart b/modules/manga/mangasee123_com/module.dart index 147b289..340eefd 100644 --- a/modules/manga/mangasee123_com/module.dart +++ b/modules/manga/mangasee123_com/module.dart @@ -2,7 +2,7 @@ import 'package:tenka/tenka.dart'; import 'package:tenka_dev_tools/tenka_dev_tools.dart'; import '../../../store/core/module.dart'; -class MangaSee123 extends SMangaModule { +class MangaSee123 extends $MangaModule { @override String id() => 'mangasee123_com'; diff --git a/modules/manga/mangasee123_com/test.dart b/modules/manga/mangasee123_com/test.dart index 1a19ba5..3d4bc10 100644 --- a/modules/manga/mangasee123_com/test.dart +++ b/modules/manga/mangasee123_com/test.dart @@ -1,14 +1,6 @@ -import 'package:tenka/tenka.dart'; -import 'package:tenka_dev_tools/tenka_dev_tools.dart'; -import '../../../store/core/module.dart'; -import '../../../store/test.dart'; +import '../../../store/helpers/mono_test.dart'; import 'module.dart'; Future main() async { - final SMangaModule module = MangaSee123(); - final TenkaMetadata config = await module.config(); - final MockedMangaExtractor mocked = module.mock(); - await STester.runProcedure( - () => mocked.run(config.source as TenkaLocalFileDS), - ); + $test(MangaSee123()); } diff --git a/modules/manga/readm_org/module.dart b/modules/manga/readm_org/module.dart index e5d7adc..01d1908 100644 --- a/modules/manga/readm_org/module.dart +++ b/modules/manga/readm_org/module.dart @@ -2,7 +2,7 @@ import 'package:tenka/tenka.dart'; import 'package:tenka_dev_tools/tenka_dev_tools.dart'; import '../../../store/core/module.dart'; -class ReadM extends SMangaModule { +class ReadM extends $MangaModule { @override String id() => 'readm_org'; diff --git a/modules/manga/readm_org/test.dart b/modules/manga/readm_org/test.dart index c555ee5..7726a8b 100644 --- a/modules/manga/readm_org/test.dart +++ b/modules/manga/readm_org/test.dart @@ -1,14 +1,6 @@ -import 'package:tenka/tenka.dart'; -import 'package:tenka_dev_tools/tenka_dev_tools.dart'; -import '../../../store/core/module.dart'; -import '../../../store/test.dart'; +import '../../../store/helpers/mono_test.dart'; import 'module.dart'; Future main() async { - final SMangaModule module = ReadM(); - final TenkaMetadata config = await module.config(); - final MockedMangaExtractor mocked = module.mock(); - await STester.runProcedure( - () => mocked.run(config.source as TenkaLocalFileDS), - ); + $test(ReadM()); } diff --git a/packages/sora_builder/LICENSE b/packages/sora_builder/LICENSE new file mode 100644 index 0000000..f251021 --- /dev/null +++ b/packages/sora_builder/LICENSE @@ -0,0 +1,673 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + +Copyright (C) 2007 Free Software Foundation, Inc. +Everyone is permitted to copy and distribute verbatim copies +of this license document, but changing it is not allowed. + + Preamble + +The GNU General Public License is a free, copyleft license for +software and other kinds of works. + +The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + +When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + +To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + +For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + +Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + +For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + +Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + +Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + +The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + +0. Definitions. + +"This License" refers to version 3 of the GNU General Public License. + +"Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + +"The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + +To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + +A "covered work" means either the unmodified Program or a work based +on the Program. + +To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + +To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + +An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + +1. Source Code. + +The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + +A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + +The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + +The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + +The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + +The Corresponding Source for a work in source code form is that +same work. + +2. Basic Permissions. + +All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + +You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + +Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + +3. Protecting Users' Legal Rights From Anti-Circumvention Law. + +No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + +When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + +4. Conveying Verbatim Copies. + +You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + +You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + +5. Conveying Modified Source Versions. + +You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + +A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + +6. Conveying Non-Source Forms. + +You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + +A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + +A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + +"Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + +If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + +The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + +Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + +7. Additional Terms. + +"Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + +When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + +Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + +All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + +If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + +Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + +8. Termination. + +You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + +However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + +Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + +9. Acceptance Not Required for Having Copies. + +You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + +10. Automatic Licensing of Downstream Recipients. + +Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + +An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + +You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + +11. Patents. + +A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + +A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + +Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + +In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + +If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + +If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + +A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + +Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + +12. No Surrender of Others' Freedom. + +If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + +13. Use with the GNU Affero General Public License. + +Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + +14. Revised Versions of this License. + +The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + +If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + +Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + +15. Disclaimer of Warranty. + +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + +16. Limitation of Liability. + +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + +17. Interpretation of Sections 15 and 16. + +If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + +To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + Sora Copyright (C) 2023 yukino-org + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + +If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Sora Copyright (C) 2023 yukino-org + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + +You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + +The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/packages/sora_builder/analysis_options.yaml b/packages/sora_builder/analysis_options.yaml new file mode 100644 index 0000000..d89ffa6 --- /dev/null +++ b/packages/sora_builder/analysis_options.yaml @@ -0,0 +1 @@ +include: package:devx/analysis_options.yaml \ No newline at end of file diff --git a/packages/sora_builder/lib/actions/build.dart b/packages/sora_builder/lib/actions/build.dart new file mode 100644 index 0000000..86d24a3 --- /dev/null +++ b/packages/sora_builder/lib/actions/build.dart @@ -0,0 +1,123 @@ +import 'dart:convert'; +import 'dart:io'; +import 'dart:typed_data'; +import 'package:crypto/crypto.dart'; +import 'package:path/path.dart' as p; +import 'package:tenka/tenka.dart'; +import 'package:tenka_dev_tools/tenka_dev_tools.dart'; +import 'package:utilx/utils.dart'; +import '../core/exports.dart'; + +class SoraBuilder { + SoraBuilder({ + required this.modules, + required this.paths, + required this.urls, + }); + + final SoraModules modules; + final SoraPaths paths; + final SoraUrls urls; + final DateTime now = DateTime.now(); + + Future initialize() async { + await TenkaDevEnvironment.prepare(); + } + + Future build() async { + await FSUtils.recreateDirectory(Directory(paths.storeOutputDir)); + await FSUtils.recreateDirectory(Directory(paths.storeOutputDataDir)); + + final TenkaStore store = TenkaStore( + baseURL: urls.storeBaseUrl(), + modules: {}, + builtAt: now, + ); + for (final SoraBaseModule x in >[ + ...modules.anime, + ...modules.manga, + ]) { + await _loadMetadata(store, x); + } + + final String storeJson = json.encode(store.toJson()); + final File storeFile = File(paths.storeOutputJsonPath); + await storeFile.writeAsString(storeJson); + + final String storeChecksum = sha256.convert(storeJson.codeUnits).toString(); + final File storeChecksumFile = File(paths.storeOutputChecksumPath); + await storeChecksumFile.writeAsString(storeChecksum); + } + + Future dispose() async { + await TenkaDevEnvironment.dispose(); + } + + Future _loadMetadata( + final TenkaStore store, + final SoraBaseModule x, + ) async { + final SoraGeneratedConfig? generatedConfig = await x.generatedConfig(); + final TenkaMetadata config = await x.config(); + final TenkaBase64DS nSource; + try { + final BeizeProgramConstant program = await TenkaCompiler.compile( + config.source as TenkaLocalFileDS, + ); + final List serialized = program.serialize(); + final String jsonified = json.encode(serialized); + nSource = TenkaBase64DS(Uint8List.fromList(utf8.encode(jsonified))); + } catch (err) { + throw Exception('Failed to compile module: ${x.id()}\n$err'); + } + + final String distSourceBasename = '${config.id}.s.dat'; + final String distSourcePath = + p.join(paths.storeOutputDataDir, distSourceBasename); + final String distSourceSubPath = + p.relative(distSourcePath, from: paths.storeOutputDir); + await nSource.toLocalFile( + TenkaLocalFileDSConverter.converter.fromFullPath(distSourcePath), + ); + + final TenkaBase64DS nThumbnail = await TenkaBase64DSConverter.converter + .fromLocalFile(config.thumbnail as TenkaLocalFileDS); + final String distThumbnailBasename = '${config.id}.png'; + final String distThumbnailPath = + p.join(paths.storeOutputDataDir, distThumbnailBasename); + final String distThumbnailSubPath = + p.relative(distThumbnailPath, from: paths.storeOutputDir); + await nThumbnail.toLocalFile( + TenkaLocalFileDSConverter.converter.fromFullPath(distThumbnailPath), + ); + + final String nSha = sha256.convert(nSource.data).toString(); + final TenkaVersion nVersion = generatedConfig != null + ? TenkaVersion.parse(generatedConfig.version) + : TenkaVersion(now.year, now.month, 0); + if (generatedConfig != null && generatedConfig.sha != nSha) { + nVersion.increment(); + } + final SoraGeneratedConfig nGeneratedConfig = SoraGeneratedConfig( + version: nVersion.toString(), + sha: nSha, + ); + final File generatedConfigFile = + File(paths.getGeneratedConfigPath(x.dir())); + await generatedConfigFile + .writeAsString(json.encode(nGeneratedConfig.toJson())); + + final TenkaMetadata nMetadata = TenkaMetadata( + id: config.id, + name: config.name, + type: config.type, + author: config.author, + source: TenkaCloudDS('/$distSourceSubPath'), + thumbnail: TenkaCloudDS('/$distThumbnailSubPath'), + nsfw: config.nsfw, + version: nVersion, + deprecated: config.deprecated, + ); + store.modules[nMetadata.id] = nMetadata; + } +} diff --git a/packages/sora_builder/lib/actions/exports.dart b/packages/sora_builder/lib/actions/exports.dart new file mode 100644 index 0000000..13ae904 --- /dev/null +++ b/packages/sora_builder/lib/actions/exports.dart @@ -0,0 +1,2 @@ +export 'build.dart'; +export 'test.dart'; diff --git a/packages/sora_builder/lib/actions/test.dart b/packages/sora_builder/lib/actions/test.dart new file mode 100644 index 0000000..0008898 --- /dev/null +++ b/packages/sora_builder/lib/actions/test.dart @@ -0,0 +1,200 @@ +// ignore_for_file: avoid_print + +import 'dart:convert'; +import 'dart:io'; +import 'package:path/path.dart' as p; +import 'package:tenka/tenka.dart'; +import 'package:tenka_dev_tools/tenka_dev_tools.dart'; +import 'package:utilx/utils.dart'; +import '../core/exports.dart'; +import '../utils/exports.dart'; + +class SoraTester { + SoraTester({ + required this.modules, + required this.paths, + required this.urls, + }); + + final SoraModules modules; + final SoraPaths paths; + final SoraUrls urls; + + final Map> animeResults = + >{}; + final Map> mangaResults = + >{}; + + Future test() async { + for (final SoraAnimeModule x in modules.anime) { + final TenkaMetadata config = await x.config(); + final TenkaLocalFileDS source = config.source as TenkaLocalFileDS; + final MockedAnimeExtractor mocked = x.mock(); + await _test(TenkaType.anime, source, () => mocked.run(source)); + } + for (final SoraMangaModule x in modules.manga) { + final TenkaMetadata config = await x.config(); + final TenkaLocalFileDS source = config.source as TenkaLocalFileDS; + final MockedMangaExtractor mocked = x.mock(); + await _test(TenkaType.manga, source, () => mocked.run(source)); + } + } + + Future _test( + final TenkaType type, + final TenkaLocalFileDS source, + final Future> Function() fn, + ) async { + final String k = + '${Colorize(p.basename(p.dirname(source.root))).cyan()} ${Colorize('(${source.fullPath})').darkGray()}'; + print('Testing: $k'); + final Map result = await fn(); + switch (type) { + case TenkaType.anime: + animeResults[source.fullPath] = result; + break; + + case TenkaType.manga: + mangaResults[source.fullPath] = result; + break; + } + print('Tested: $k'); + } + + Future finish() async { + print( + 'Full Summary: [${Colorize('+$passed').green()} ${Colorize('-$failed').red()}]', + ); + for (final MapEntry> x + in allResults.entries) { + print( + ' ${Colorize('*').darkGray()} ${Colorize(_getModuleNameFromPath(x.key)).cyan()} ${Colorize('(${x.key})').darkGray()}', + ); + for (final MapEntry y in x.value.entries) { + print( + ' ${Colorize('*').darkGray()} ${Colorize('${y.key}()').cyan()}: ${y.value.success ? Colorize('P').green() : Colorize('F').red()}', + ); + } + } + + await FSUtils.ensureDirectory(Directory(paths.summaryOutputDir)); + final File summaryReadmeFile = File(paths.summaryOutputReadmePath); + await summaryReadmeFile.writeAsString(summary); + + final File summaryBadgeFile = File(paths.summaryOutputBadgePath); + await summaryBadgeFile.writeAsString( + json.encode({ + 'schemaVersion': 1, + 'label': 'test-modules', + 'message': '$passed passed, $failed failed', + 'color': '4b3fd1', + }), + ); + } + + String _getModuleNameFromPath(final String fullPath) => + p.basename(p.dirname(p.dirname(fullPath))); + + String _getValueFromBenchmarks(final Benchmarks result) => + '${Emojis.fromBool(result.success)} (${result.time.elapsed}ms)'; + + String _createMarkdownTable( + final Map cols, + final List> data, + ) { + const String seperator = ' | '; + const String line = '---'; + + return ''' +$seperator ${cols.values.join(seperator)} $seperator +$seperator ${List.filled(cols.length, line).join(seperator)} $seperator +$seperator ${data.map((final Map x) => cols.keys.map((final String y) => x[y]).join(seperator)).join('\n')} $seperator +''' + .trim(); + } + + String _getMarkdownURLFromPath(final String fullPath) { + final String name = _getModuleNameFromPath(fullPath); + final String rPath = p.relative(fullPath, from: paths.rootDir()); + final String url = + '${urls.repositoryUrl()}/$rPath'.replaceAll(RegExp(r'\\'), '/'); + + return '[$name]($url)'; + } + + Map> get allResults => + >{ + ...animeResults, + ...mangaResults, + }; + + int get passed => allResults.values.fold( + 0, + (final int value, final Map x) => + value + x.values.where((final Benchmarks x) => x.success).length, + ); + + int get failed => allResults.values.fold( + 0, + (final int value, final Map x) => + value + x.values.where((final Benchmarks x) => !x.success).length, + ); + + String get summary { + final String animeTable = _createMarkdownTable( + { + 'name': 'Name', + 'search': '`search`', + 'getInfo': '`getInfo`', + 'getSource': '`getSource`', + }, + animeResults.entries + .map( + (final MapEntry> x) => + { + 'name': _getMarkdownURLFromPath(x.key), + 'search': _getValueFromBenchmarks(x.value['search']!), + 'getInfo': _getValueFromBenchmarks(x.value['getInfo']!), + 'getSource': _getValueFromBenchmarks(x.value['getSource']!), + }, + ) + .toList(), + ); + + final String mangaTable = _createMarkdownTable( + { + 'name': 'Name', + 'search': '`search`', + 'getInfo': '`getInfo`', + 'getChapter': '`getChapter`', + 'getPage': '`getPage`', + }, + mangaResults.entries + .map( + (final MapEntry> x) => + { + 'name': _getMarkdownURLFromPath(x.key), + 'search': _getValueFromBenchmarks(x.value['search']!), + 'getInfo': _getValueFromBenchmarks(x.value['getInfo']!), + 'getChapter': _getValueFromBenchmarks(x.value['getChapter']!), + 'getPage': _getValueFromBenchmarks(x.value['getPage']!), + }, + ) + .toList(), + ); + + return ''' +# 👨‍⚕️ Modules Checkup + +Last checked at ${DateTime.now().toUtc()} (UTC). + +## Anime + +$animeTable + +## Manga + +$mangaTable +'''; + } +} diff --git a/packages/sora_builder/lib/core/exports.dart b/packages/sora_builder/lib/core/exports.dart new file mode 100644 index 0000000..f39ba17 --- /dev/null +++ b/packages/sora_builder/lib/core/exports.dart @@ -0,0 +1,3 @@ +export 'module.dart'; +export 'paths.dart'; +export 'urls.dart'; diff --git a/packages/sora_builder/lib/core/module.dart b/packages/sora_builder/lib/core/module.dart new file mode 100644 index 0000000..f91e490 --- /dev/null +++ b/packages/sora_builder/lib/core/module.dart @@ -0,0 +1,102 @@ +import 'dart:convert'; +import 'dart:io'; +import 'package:tenka/tenka.dart'; +import 'package:tenka_dev_tools/tenka_dev_tools.dart'; +import 'package:utilx/utils.dart'; +import 'paths.dart'; + +class SoraGeneratedConfig { + const SoraGeneratedConfig({ + required this.version, + required this.sha, + }); + + final String version; + final String sha; + + JsonMap toJson() => { + r'$note': 'This is a generated file, do not edit this.', + 'version': version, + 'sha': sha, + }; + + static Future fromFile(final String path) async { + final File file = File(path); + if (!(await file.exists())) { + return null; + } + final String content = await File(path).readAsString(); + final JsonMap json = jsonDecode(content) as JsonMap; + return SoraGeneratedConfig( + version: json['version'] as String, + sha: json['sha'] as String, + ); + } +} + +abstract class SoraBaseModule { + String id(); + String name(); + String author(); + TenkaType type(); + bool nsfw(); + SoraPaths paths(); + String dir(); + + Future generatedConfig() async { + final String generatedConfigPath = _paths.getGeneratedConfigPath(dir()); + return SoraGeneratedConfig.fromFile(generatedConfigPath); + } + + Future config() async { + final SoraGeneratedConfig? generated = await generatedConfig(); + final TenkaMetadata metadata = TenkaMetadata( + id: id(), + name: name(), + type: type(), + author: author(), + source: TenkaLocalFileDSConverter.converter + .fromFullPath(_paths.getModuleMainScriptFile(_dir)), + thumbnail: TenkaLocalFileDSConverter.converter + .fromFullPath(_paths.getModuleLogoFile(_dir)), + nsfw: nsfw(), + version: generated != null + ? TenkaVersion.parse(generated.version) + : TenkaVersion(0, 0, 0), + deprecated: false, + ); + return metadata; + } + + T mock(); + + // i'm sorry, i had to + SoraPaths get _paths => paths(); + String get _dir => dir(); +} + +abstract class SoraAnimeModule extends SoraBaseModule { + @override + TenkaType type() => TenkaType.anime; + + @override + String dir() => _paths.getAnimeModuleDir(id()); +} + +abstract class SoraMangaModule extends SoraBaseModule { + @override + TenkaType type() => TenkaType.manga; + + @override + String dir() => _paths.getMangaModuleDir(id()); +} + +class SoraModules { + const SoraModules({ + required this.anime, + required this.manga, + }); + + final List anime; + final List manga; +} diff --git a/packages/sora_builder/lib/core/paths.dart b/packages/sora_builder/lib/core/paths.dart new file mode 100644 index 0000000..bae3ac2 --- /dev/null +++ b/packages/sora_builder/lib/core/paths.dart @@ -0,0 +1,24 @@ +import 'package:path/path.dart' as p; + +abstract class SoraPaths { + String rootDir(); + + String getAnimeModuleDir(final String id) => p.join(animeModulesDir, id); + String getMangaModuleDir(final String id) => p.join(mangaModulesDir, id); + String getGeneratedConfigPath(final String dir) => p.join(dir, '_data.json'); + String getModuleMainScriptFile(final String dir) => + p.join(dir, 'src/main.beize'); + String getModuleLogoFile(final String dir) => p.join(dir, 'logo.png'); + + String get _rootDir => rootDir(); + String get modulesDir => p.join(_rootDir, 'modules'); + String get animeModulesDir => p.join(modulesDir, 'anime'); + String get mangaModulesDir => p.join(modulesDir, 'manga'); + String get storeOutputDir => p.join(_rootDir, 'dist'); + String get storeOutputDataDir => p.join(storeOutputDir, 'data'); + String get storeOutputJsonPath => p.join(storeOutputDir, 'store.json'); + String get storeOutputChecksumPath => p.join(storeOutputDir, 'store.sha256'); + String get summaryOutputDir => p.join(_rootDir, 'dist-summary'); + String get summaryOutputReadmePath => p.join(summaryOutputDir, 'README.md'); + String get summaryOutputBadgePath => p.join(summaryOutputDir, 'badge.json'); +} diff --git a/packages/sora_builder/lib/core/urls.dart b/packages/sora_builder/lib/core/urls.dart new file mode 100644 index 0000000..c22c059 --- /dev/null +++ b/packages/sora_builder/lib/core/urls.dart @@ -0,0 +1,4 @@ +abstract class SoraUrls { + String repositoryUrl(); + String storeBaseUrl(); +} diff --git a/packages/sora_builder/lib/sora_builder.dart b/packages/sora_builder/lib/sora_builder.dart new file mode 100644 index 0000000..7fd8449 --- /dev/null +++ b/packages/sora_builder/lib/sora_builder.dart @@ -0,0 +1,6 @@ +// ignore: unnecessary_library_directive +library sora_builder; + +export 'actions/exports.dart'; +export 'core/exports.dart'; +export 'utils/exports.dart'; diff --git a/store/utils/emojis.dart b/packages/sora_builder/lib/utils/emojis.dart similarity index 100% rename from store/utils/emojis.dart rename to packages/sora_builder/lib/utils/emojis.dart diff --git a/packages/sora_builder/lib/utils/exports.dart b/packages/sora_builder/lib/utils/exports.dart new file mode 100644 index 0000000..cbba51c --- /dev/null +++ b/packages/sora_builder/lib/utils/exports.dart @@ -0,0 +1 @@ +export 'emojis.dart'; diff --git a/packages/sora_builder/pubspec.lock b/packages/sora_builder/pubspec.lock new file mode 100644 index 0000000..35e547c --- /dev/null +++ b/packages/sora_builder/pubspec.lock @@ -0,0 +1,278 @@ +# Generated by pub +# See https://dart.dev/tools/pub/glossary#lockfile +packages: + args: + dependency: transitive + description: + name: args + sha256: eef6c46b622e0494a36c5a12d10d77fb4e855501a91c1b9ef9339326e58f0596 + url: "https://pub.dev" + source: hosted + version: "2.4.2" + asn1lib: + dependency: transitive + description: + name: asn1lib + sha256: "21afe4333076c02877d14f4a89df111e658a6d466cbfc802eb705eb91bd5adfd" + url: "https://pub.dev" + source: hosted + version: "1.5.0" + async: + dependency: transitive + description: + name: async + sha256: "947bfcf187f74dbc5e146c9eb9c0f10c9f8b30743e341481c1e2ed3ecc18c20c" + url: "https://pub.dev" + source: hosted + version: "2.11.0" + beize_compiler: + dependency: transitive + description: + path: "packages/beize_compiler" + ref: HEAD + resolved-ref: "4750cdcd5e6b28ccc8949dc60498418b3988e263" + url: "https://github.com/zyrouge/beize.git" + source: git + version: "0.0.0" + beize_shared: + dependency: transitive + description: + path: "packages/beize_shared" + ref: HEAD + resolved-ref: "4750cdcd5e6b28ccc8949dc60498418b3988e263" + url: "https://github.com/zyrouge/beize.git" + source: git + version: "0.0.0" + beize_vm: + dependency: transitive + description: + path: "packages/beize_vm" + ref: HEAD + resolved-ref: "4750cdcd5e6b28ccc8949dc60498418b3988e263" + url: "https://github.com/zyrouge/beize.git" + source: git + version: "0.0.0" + clock: + dependency: transitive + description: + name: clock + sha256: cb6d7f03e1de671e34607e909a7213e31d7752be4fb66a86d29fe1eb14bfb5cf + url: "https://pub.dev" + source: hosted + version: "1.1.1" + collection: + dependency: transitive + description: + name: collection + sha256: ee67cb0715911d28db6bf4af1026078bd6f0128b07a5f66fb2ed94ec6783c09a + url: "https://pub.dev" + source: hosted + version: "1.18.0" + colorize: + dependency: transitive + description: + name: colorize + sha256: "584746cd6ba1cba0633b6720f494fe6f9601c4170f0666c1579d2aa2a61071ba" + url: "https://pub.dev" + source: hosted + version: "3.0.0" + convert: + dependency: transitive + description: + name: convert + sha256: "0f08b14755d163f6e2134cb58222dd25ea2a2ee8a195e53983d57c075324d592" + url: "https://pub.dev" + source: hosted + version: "3.1.1" + crypto: + dependency: "direct main" + description: + name: crypto + sha256: ff625774173754681d66daaf4a448684fb04b78f902da9cb3d308c19cc5e8bab + url: "https://pub.dev" + source: hosted + version: "3.0.3" + csslib: + dependency: transitive + description: + name: csslib + sha256: "706b5707578e0c1b4b7550f64078f0a0f19dec3f50a178ffae7006b0a9ca58fb" + url: "https://pub.dev" + source: hosted + version: "1.0.0" + devx: + dependency: "direct dev" + description: + path: "." + ref: dart_devx + resolved-ref: b337c5c4f10c4a23a626a1e8de5cf93f7fd57231 + url: "https://github.com/yukino-org/packages.git" + source: git + version: "0.0.0" + encrypt: + dependency: transitive + description: + name: encrypt + sha256: "62d9aa4670cc2a8798bab89b39fc71b6dfbacf615de6cf5001fb39f7e4a996a2" + url: "https://pub.dev" + source: hosted + version: "5.0.3" + html: + dependency: transitive + description: + name: html + sha256: "3a7812d5bcd2894edf53dfaf8cd640876cf6cef50a8f238745c8b8120ea74d3a" + url: "https://pub.dev" + source: hosted + version: "0.15.4" + http: + dependency: transitive + description: + name: http + sha256: "759d1a329847dd0f39226c688d3e06a6b8679668e350e2891a6474f8b4bb8525" + url: "https://pub.dev" + source: hosted + version: "1.1.0" + http_parser: + dependency: transitive + description: + name: http_parser + sha256: "2aa08ce0341cc9b354a498388e30986515406668dbcc4f7c950c3e715496693b" + url: "https://pub.dev" + source: hosted + version: "4.0.2" + intl: + dependency: "direct dev" + description: + name: intl + sha256: "3bc132a9dbce73a7e4a21a17d06e1878839ffbf975568bc875c60537824b0c4d" + url: "https://pub.dev" + source: hosted + version: "0.18.1" + js: + dependency: transitive + description: + name: js + sha256: f2c445dce49627136094980615a031419f7f3eb393237e4ecd97ac15dea343f3 + url: "https://pub.dev" + source: hosted + version: "0.6.7" + lint: + dependency: transitive + description: + name: lint + sha256: f4bd4dbaa39f4ae8836f2d1275f2f32bc68b3a8cce0a0735dd1f7a601f06682a + url: "https://pub.dev" + source: hosted + version: "2.1.2" + meta: + dependency: transitive + description: + name: meta + sha256: d584fa6707a52763a52446f02cc621b077888fb63b93bbcb1143a7be5a0c0c04 + url: "https://pub.dev" + source: hosted + version: "1.11.0" + path: + dependency: "direct main" + description: + name: path + sha256: "8829d8a55c13fc0e37127c29fedf290c102f4e40ae94ada574091fe0ff96c917" + url: "https://pub.dev" + source: hosted + version: "1.8.3" + pointycastle: + dependency: transitive + description: + name: pointycastle + sha256: "7c1e5f0d23c9016c5bbd8b1473d0d3fb3fc851b876046039509e18e0c7485f2c" + url: "https://pub.dev" + source: hosted + version: "3.7.3" + source_span: + dependency: transitive + description: + name: source_span + sha256: "53e943d4206a5e30df338fd4c6e7a077e02254531b138a15aec3bd143c1a8b3c" + url: "https://pub.dev" + source: hosted + version: "1.10.0" + string_scanner: + dependency: transitive + description: + name: string_scanner + sha256: "556692adab6cfa87322a115640c11f13cb77b3f076ddcc5d6ae3c20242bedcde" + url: "https://pub.dev" + source: hosted + version: "1.2.0" + tenka: + dependency: "direct main" + description: + path: "." + ref: dart_tenka + resolved-ref: "99668f89bbfcc63aaaf6d1c04c9447e22805cbc7" + url: "https://github.com/yukino-org/packages.git" + source: git + version: "1.0.5" + tenka_dev_tools: + dependency: "direct main" + description: + path: "." + ref: dart_tenka_dev_tools + resolved-ref: "50558a82f039a7878edbb35aede96899ab66ddee" + url: "https://github.com/yukino-org/packages.git" + source: git + version: "0.0.0" + tenka_runtime: + dependency: transitive + description: + path: "." + ref: dart_tenka_runtime + resolved-ref: f935c7923d639d7cf3204ed20cf7e4524db7d801 + url: "https://github.com/yukino-org/packages.git" + source: git + version: "0.0.0" + term_glyph: + dependency: transitive + description: + name: term_glyph + sha256: a29248a84fbb7c79282b40b8c72a1209db169a2e0542bce341da992fe1bc7e84 + url: "https://pub.dev" + source: hosted + version: "1.2.1" + typed_data: + dependency: transitive + description: + name: typed_data + sha256: facc8d6582f16042dd49f2463ff1bd6e2c9ef9f3d5da3d9b087e244a7b564b3c + url: "https://pub.dev" + source: hosted + version: "1.3.2" + utilx: + dependency: "direct main" + description: + path: "." + ref: dart_utilx + resolved-ref: "7b2ddc4c01806acf239b47eba3bda5e59f983f5c" + url: "https://github.com/yukino-org/packages.git" + source: git + version: "0.0.0" + yaml: + dependency: transitive + description: + name: yaml + sha256: "75769501ea3489fca56601ff33454fe45507ea3bfb014161abc3b43ae25989d5" + url: "https://pub.dev" + source: hosted + version: "3.1.2" + zlint: + dependency: transitive + description: + path: "." + ref: main + resolved-ref: "9a635be15e5dead4913b1231fe9e53c060a13640" + url: "https://github.com/zyrouge/dart_zlint.git" + source: git + version: "0.0.0" +sdks: + dart: ">=3.0.0 <4.0.0" diff --git a/packages/sora_builder/pubspec.yaml b/packages/sora_builder/pubspec.yaml new file mode 100644 index 0000000..bafa15a --- /dev/null +++ b/packages/sora_builder/pubspec.yaml @@ -0,0 +1,31 @@ +name: sora_builder +description: "🏗️ Sora Store Builder" +version: 0.0.0 + +publish_to: none + +environment: + sdk: ">=2.18.0 <3.0.0" + +dependencies: + crypto: ^3.0.3 + path: ^1.8.0 + tenka: + git: + url: https://github.com/yukino-org/packages.git + ref: dart_tenka + tenka_dev_tools: + git: + url: https://github.com/yukino-org/packages.git + ref: dart_tenka_dev_tools + utilx: + git: + url: https://github.com/yukino-org/packages.git + ref: dart_utilx + +dev_dependencies: + devx: + git: + url: https://github.com/yukino-org/packages.git + ref: dart_devx + intl: ^0.18.1 diff --git a/pubspec.lock b/pubspec.lock index 35e547c..ae9eedf 100644 --- a/pubspec.lock +++ b/pubspec.lock @@ -85,7 +85,7 @@ packages: source: hosted version: "3.1.1" crypto: - dependency: "direct main" + dependency: transitive description: name: crypto sha256: ff625774173754681d66daaf4a448684fb04b78f902da9cb3d308c19cc5e8bab @@ -141,14 +141,6 @@ packages: url: "https://pub.dev" source: hosted version: "4.0.2" - intl: - dependency: "direct dev" - description: - name: intl - sha256: "3bc132a9dbce73a7e4a21a17d06e1878839ffbf975568bc875c60537824b0c4d" - url: "https://pub.dev" - source: hosted - version: "0.18.1" js: dependency: transitive description: @@ -174,7 +166,7 @@ packages: source: hosted version: "1.11.0" path: - dependency: "direct main" + dependency: transitive description: name: path sha256: "8829d8a55c13fc0e37127c29fedf290c102f4e40ae94ada574091fe0ff96c917" @@ -189,6 +181,13 @@ packages: url: "https://pub.dev" source: hosted version: "3.7.3" + sora_builder: + dependency: "direct main" + description: + path: "packages/sora_builder" + relative: true + source: path + version: "0.0.0" source_span: dependency: transitive description: @@ -249,7 +248,7 @@ packages: source: hosted version: "1.3.2" utilx: - dependency: "direct main" + dependency: transitive description: path: "." ref: dart_utilx diff --git a/pubspec.yaml b/pubspec.yaml index 7fc0a32..b644131 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -1,5 +1,5 @@ name: sora -description: "⚡ Officially maintained Tenka modules by Yukino." +description: "⚡ Officially maintained Tenka modules by Yukino" version: 0.0.0 publish_to: none @@ -8,8 +8,8 @@ environment: sdk: ">=2.18.0 <3.0.0" dependencies: - crypto: ^3.0.3 - path: ^1.8.0 + sora_builder: + path: ./packages/sora_builder tenka: git: url: https://github.com/yukino-org/packages.git @@ -18,14 +18,9 @@ dependencies: git: url: https://github.com/yukino-org/packages.git ref: dart_tenka_dev_tools - utilx: - git: - url: https://github.com/yukino-org/packages.git - ref: dart_utilx dev_dependencies: devx: git: url: https://github.com/yukino-org/packages.git ref: dart_devx - intl: ^0.18.1 diff --git a/store/build.dart b/store/build.dart index 9c60984..119765a 100644 --- a/store/build.dart +++ b/store/build.dart @@ -1,122 +1,14 @@ -import 'dart:convert'; -import 'dart:io'; -import 'dart:typed_data'; -import 'package:crypto/crypto.dart'; -import 'package:path/path.dart' as p; -import 'package:tenka/tenka.dart'; -import 'package:tenka_dev_tools/tenka_dev_tools.dart'; -import 'package:utilx/utils.dart'; -import 'core/module.dart'; +import 'package:sora_builder/sora_builder.dart'; import 'core/modules.dart'; -import 'utils/constants.dart'; -import 'utils/paths.dart'; - -class SBuilder { - final DateTime now = DateTime.now(); - - final Map modules = {}; - final Map clonedRepos = {}; - - Future initialize() async { - await TenkaDevEnvironment.prepare(); - } - - Future build() async { - await FSUtils.recreateDirectory(Directory(Paths.distDir)); - await FSUtils.recreateDirectory(Directory(Paths.distDataDir)); - - final List> storeModules = >[ - ...SModules.anime, - ...SModules.manga, - ]; - for (final SBaseModule x in storeModules) { - await _loadMetadata(x); - } - - final TenkaStore store = TenkaStore( - baseURL: Constants.ghDistBranchRawURL, - modules: modules, - builtAt: now, - ); - final String storeJson = json.encode(store.toJson()); - await File(p.join(Paths.distDir, 'store.json')).writeAsString(storeJson); - final String storeChecksum = sha256.convert(storeJson.codeUnits).toString(); - await File(p.join(Paths.distDir, 'store.sha256')) - .writeAsString(storeChecksum); - } - - Future dispose() async { - await TenkaDevEnvironment.dispose(); - } - - Future _loadMetadata(final SBaseModule x) async { - final SGeneratedConfig? generatedConfig = await x.generatedConfig(); - final TenkaMetadata config = await x.config(); - final TenkaBase64DS nSource; - try { - final BeizeProgramConstant program = await TenkaCompiler.compile( - config.source as TenkaLocalFileDS, - ); - final List serialized = program.serialize(); - final String jsonified = json.encode(serialized); - nSource = TenkaBase64DS(Uint8List.fromList(utf8.encode(jsonified))); - } catch (err) { - throw Exception('Failed to compile module: ${x.id()}\n$err'); - } - - final String distSourceBasename = '${config.id}.s.dat'; - final String distSourcePath = p.join(Paths.distDataDir, distSourceBasename); - final String distSourceSubPath = - p.relative(distSourcePath, from: Paths.distDir); - await nSource.toLocalFile( - TenkaLocalFileDSConverter.converter.fromFullPath(distSourcePath), - ); - - final TenkaBase64DS nThumbnail = await TenkaBase64DSConverter.converter - .fromLocalFile(config.thumbnail as TenkaLocalFileDS); - final String distThumbnailBasename = '${config.id}.png'; - final String distThumbnailPath = - p.join(Paths.distDataDir, distThumbnailBasename); - final String distThumbnailSubPath = - p.relative(distThumbnailPath, from: Paths.distDir); - await nThumbnail.toLocalFile( - TenkaLocalFileDSConverter.converter.fromFullPath(distThumbnailPath), - ); - - final String nSha = sha256.convert(nSource.data).toString(); - final TenkaVersion nVersion = generatedConfig != null - ? TenkaVersion.parse(generatedConfig.version) - : TenkaVersion(now.year, now.month, 0); - if (generatedConfig != null && generatedConfig.sha != nSha) { - nVersion.increment(); - } - final SGeneratedConfig nGeneratedConfig = SGeneratedConfig( - version: nVersion.toString(), - sha: nSha, - ); - final File generatedConfigFile = File( - p.join(x.dir(), SBaseModule.generatedConfigFileBasename), - ); - await generatedConfigFile - .writeAsString(json.encode(nGeneratedConfig.toJson())); - - final TenkaMetadata nMetadata = TenkaMetadata( - id: config.id, - name: config.name, - type: config.type, - author: config.author, - source: TenkaCloudDS('/$distSourceSubPath'), - thumbnail: TenkaCloudDS('/$distThumbnailSubPath'), - nsfw: config.nsfw, - version: nVersion, - deprecated: config.deprecated, - ); - modules[nMetadata.id] = nMetadata; - } -} +import 'core/paths.dart'; +import 'core/urls.dart'; Future main() async { - final SBuilder builder = SBuilder(); + final SoraBuilder builder = SoraBuilder( + modules: $modules, + paths: $paths, + urls: $urls, + ); await builder.initialize(); await builder.build(); await builder.dispose(); diff --git a/store/core/module.dart b/store/core/module.dart index 3ed44a7..c149b0f 100644 --- a/store/core/module.dart +++ b/store/core/module.dart @@ -1,120 +1,19 @@ -import 'dart:convert'; -import 'dart:io'; -import 'package:path/path.dart' as p; -import 'package:tenka/tenka.dart'; -import 'package:tenka_dev_tools/tenka_dev_tools.dart'; -import 'package:utilx/utils.dart'; -import '../utils/paths.dart'; +import 'package:sora_builder/sora_builder.dart'; +import 'paths.dart'; +import 'urls.dart'; -class SGeneratedConfig { - const SGeneratedConfig({ - required this.version, - required this.sha, - }); - - final String version; - final String sha; - - JsonMap toJson() => { - r'$note': 'This is a generated file, do not edit this.', - 'version': version, - 'sha': sha, - }; - - static Future fromFile(final String path) async { - final File file = File(path); - if (!(await file.exists())) { - return null; - } - final String content = await File(path).readAsString(); - final JsonMap json = jsonDecode(content) as JsonMap; - return SGeneratedConfig( - version: json['version'] as String, - sha: json['sha'] as String, - ); - } -} - -abstract class SBaseModule { - String id(); - String name(); - bool nsfw(); - String dir(); - - Future generatedConfig() async { - final SGeneratedConfig? generatedConfig = await SGeneratedConfig.fromFile( - p.join(dir(), generatedConfigFileBasename), - ); - return generatedConfig; - } - - Future config(); - T mock(); - - static const String generatedConfigFileBasename = '_data.json'; - static const String srcDirBasename = 'src'; - static const String mainScriptFileBasename = 'main.beize'; - static const String iconFileBasename = 'logo.png'; -} - -abstract class SAnimeModule extends SBaseModule { +abstract class $AnimeModule extends SoraAnimeModule { @override - String dir() => Paths.getAnimeModuleDir(id()); + String author() => $urls.ghUsername; @override - Future config() async { - final String dir = this.dir(); - final SGeneratedConfig? generated = await generatedConfig(); - final TenkaMetadata metadata = TenkaMetadata( - id: id(), - name: name(), - type: TenkaType.anime, - author: 'yukino-org', - source: TenkaLocalFileDS( - root: p.join(dir, SBaseModule.srcDirBasename), - file: SBaseModule.mainScriptFileBasename, - ), - thumbnail: TenkaLocalFileDS( - root: dir, - file: SBaseModule.iconFileBasename, - ), - nsfw: nsfw(), - version: generated != null - ? TenkaVersion.parse(generated.version) - : TenkaVersion(0, 0, 0), - deprecated: false, - ); - return metadata; - } + SoraPaths paths() => $paths; } -abstract class SMangaModule extends SBaseModule { +abstract class $MangaModule extends SoraMangaModule { @override - String dir() => Paths.getMangaModuleDir(id()); + String author() => $urls.ghUsername; @override - Future config() async { - final String dir = this.dir(); - final SGeneratedConfig? generated = await generatedConfig(); - final TenkaMetadata metadata = TenkaMetadata( - id: id(), - name: name(), - type: TenkaType.manga, - author: 'yukino-org', - source: TenkaLocalFileDS( - root: p.join(dir, SBaseModule.srcDirBasename), - file: SBaseModule.mainScriptFileBasename, - ), - thumbnail: TenkaLocalFileDS( - root: dir, - file: SBaseModule.iconFileBasename, - ), - nsfw: nsfw(), - version: generated != null - ? TenkaVersion.parse(generated.version) - : TenkaVersion(0, 0, 0), - deprecated: false, - ); - return metadata; - } + SoraPaths paths() => $paths; } diff --git a/store/core/modules.dart b/store/core/modules.dart index 5cd7316..363fa10 100644 --- a/store/core/modules.dart +++ b/store/core/modules.dart @@ -1,16 +1,15 @@ -import './modules_exported.dart'; -import 'module.dart'; +import 'package:sora_builder/sora_builder.dart'; +import 'modules_exports.dart'; -abstract class SModules { - static final List anime = [ +final SoraModules $modules = SoraModules( + anime: [ AnimePahe(), GogoAnime(), HAnime(), - ]; - - static final List manga = [ + ], + manga: [ FanFox(), MangaDex(), MangaSee123(), - ]; -} + ], +); diff --git a/store/core/modules_exported.dart b/store/core/modules_exports.dart similarity index 100% rename from store/core/modules_exported.dart rename to store/core/modules_exports.dart diff --git a/store/core/paths.dart b/store/core/paths.dart new file mode 100644 index 0000000..f7e0bdf --- /dev/null +++ b/store/core/paths.dart @@ -0,0 +1,9 @@ +import 'dart:io'; +import 'package:sora_builder/sora_builder.dart'; + +class _Paths extends SoraPaths { + @override + String rootDir() => Directory.current.path; +} + +final _Paths $paths = _Paths(); diff --git a/store/core/urls.dart b/store/core/urls.dart new file mode 100644 index 0000000..049e369 --- /dev/null +++ b/store/core/urls.dart @@ -0,0 +1,18 @@ +import 'package:sora_builder/sora_builder.dart'; + +class _Urls extends SoraUrls { + final String ghUsername = 'yukino-org'; + final String ghReponame = 'sora'; + final String ghMainBranch = 'main'; + final String ghDistBranch = 'dist'; + + @override + String repositoryUrl() => + 'https://github.com/$ghUsername/$ghReponame/tree/$ghMainBranch'; + + @override + String storeBaseUrl() => + 'https://raw.githubusercontent.com/$ghUsername/$ghReponame/$ghDistBranch'; +} + +final _Urls $urls = _Urls(); diff --git a/store/helpers/mono_test.dart b/store/helpers/mono_test.dart new file mode 100644 index 0000000..4224ec8 --- /dev/null +++ b/store/helpers/mono_test.dart @@ -0,0 +1,21 @@ +import 'package:sora_builder/sora_builder.dart'; +import 'package:tenka/tenka.dart'; +import '../core/paths.dart'; +import '../core/urls.dart'; + +Future $test(final SoraBaseModule module) async { + final SoraTester tester = SoraTester( + modules: SoraModules( + anime: [ + if (module.type() == TenkaType.anime) module as SoraAnimeModule, + ], + manga: [ + if (module.type() == TenkaType.manga) module as SoraMangaModule, + ], + ), + paths: $paths, + urls: $urls, + ); + await tester.test(); + await tester.finish(); +} diff --git a/store/test.dart b/store/test.dart index 96130d0..e01152a 100644 --- a/store/test.dart +++ b/store/test.dart @@ -1,231 +1,14 @@ -// ignore_for_file: avoid_print - -import 'dart:convert'; -import 'dart:io'; -import 'package:intl/intl.dart'; -import 'package:path/path.dart' as p; -import 'package:tenka/tenka.dart'; -import 'package:tenka_dev_tools/tenka_dev_tools.dart'; -import 'package:utilx/utils.dart'; -import 'core/module.dart'; +import 'package:sora_builder/sora_builder.dart'; import 'core/modules.dart'; -import 'utils/constants.dart'; -import 'utils/emojis.dart'; -import 'utils/paths.dart'; -import 'utils/runner.dart'; - -class STester { - final Map> animeResults = - >{}; - - final Map> mangaResults = - >{}; - - Future run( - final TenkaType type, - final TenkaLocalFileDS source, - final Future> Function() fn, - ) async { - final String k = - '${Colorize(p.basename(p.dirname(source.root))).cyan()} ${Colorize('(${Paths.pretty(source.fullPath)})').darkGray()}'; - - print('Testing: $k'); - - final Map result = await fn(); - switch (type) { - case TenkaType.anime: - animeResults[source.fullPath] = result; - break; - - case TenkaType.manga: - mangaResults[source.fullPath] = result; - break; - } - - print('Tested: $k'); - } - - Future finish() async { - print( - 'Full Summary: [${Colorize('+$passed').green()} ${Colorize('-$failed').red()}]', - ); - - for (final MapEntry> x in results.entries) { - print( - ' ${Colorize('*').darkGray()} ${Colorize(_getModuleNameFromPath(x.key)).cyan()} ${Colorize('(${Paths.pretty(x.key)})').darkGray()}', - ); - - for (final MapEntry y in x.value.entries) { - print( - ' ${Colorize('*').darkGray()} ${Colorize('${y.key}()').cyan()}: ${y.value.success ? Colorize('P').green() : Colorize('F').red()}', - ); - } - } - - final File summaryReadmeFile = File(Paths.summaryReadme); - await FSUtils.ensureFile(summaryReadmeFile); - await summaryReadmeFile.writeAsString(summary); - - final File summaryBadgeFile = File(Paths.summaryBadge); - await FSUtils.ensureFile(summaryBadgeFile); - await summaryBadgeFile.writeAsString( - jsonEncode({ - 'schemaVersion': 1, - 'label': 'test-modules', - 'message': '$passed passed, $failed failed', - 'color': '4b3fd1', - }), - ); - } - - String _getModuleNameFromPath(final String fullPath) => - p.basename(p.dirname(p.dirname(fullPath))); - - String _getValueFromBenchmarks(final Benchmarks result) => - '${Emojis.fromBool(result.success)} (${result.time.elapsed}ms)'; - - String _createMarkdownTable( - final Map cols, - final List> data, - ) { - const String seperator = ' | '; - const String line = '---'; - - return ''' -$seperator ${cols.values.join(seperator)} $seperator -$seperator ${List.filled(cols.length, line).join(seperator)} $seperator -$seperator ${data.map((final Map x) => cols.keys.map((final String y) => x[y]).join(seperator)).join('\n')} $seperator -''' - .trim(); - } - - String _getMarkdownURLFromPath(final String fullPath) { - final String name = _getModuleNameFromPath(fullPath); - final String rPath = p.relative(fullPath, from: Paths.rootDir); - final String url = - '${Constants.ghMainBranchURL}/$rPath'.replaceAll(RegExp(r'\\'), '/'); - - return '[$name]($url)'; - } - - Map> get results => - >{ - ...animeResults, - ...mangaResults, - }; - - int get passed => results.values.fold( - 0, - (final int value, final Map x) => - value + x.values.where((final Benchmarks x) => x.success).length, - ); - - int get failed => results.values.fold( - 0, - (final int value, final Map x) => - value + x.values.where((final Benchmarks x) => !x.success).length, - ); - - String get summary { - final String animeTable = _createMarkdownTable( - { - 'name': 'Name', - 'search': '`search`', - 'getInfo': '`getInfo`', - 'getSource': '`getSource`', - }, - animeResults.entries - .map( - (final MapEntry> x) => - { - 'name': _getMarkdownURLFromPath(x.key), - 'search': _getValueFromBenchmarks(x.value['search']!), - 'getInfo': _getValueFromBenchmarks(x.value['getInfo']!), - 'getSource': _getValueFromBenchmarks(x.value['getSource']!), - }, - ) - .toList(), - ); - - final String mangaTable = _createMarkdownTable( - { - 'name': 'Name', - 'search': '`search`', - 'getInfo': '`getInfo`', - 'getChapter': '`getChapter`', - 'getPage': '`getPage`', - }, - mangaResults.entries - .map( - (final MapEntry> x) => - { - 'name': _getMarkdownURLFromPath(x.key), - 'search': _getValueFromBenchmarks(x.value['search']!), - 'getInfo': _getValueFromBenchmarks(x.value['getInfo']!), - 'getChapter': _getValueFromBenchmarks(x.value['getChapter']!), - 'getPage': _getValueFromBenchmarks(x.value['getPage']!), - }, - ) - .toList(), - ); - - return ''' -# 👨‍⚕️ Tenka Modules Checkup - -Last checked at ${DateFormat('dd/MM/yyyy hh:mm a').format(DateTime.now().toUtc())} (UTC). - -## Anime - -$animeTable - -## Manga - -$mangaTable -'''; - } - - static Future runProcedure(final Future Function() fn) async { - await TenkaDevEnvironment.prepare(); - await fn(); - await TenkaDevEnvironment.dispose(); - } -} +import 'core/paths.dart'; +import 'core/urls.dart'; Future main(final List args) async { - final bool ci = args.contains('--ci'); - final STester tester = STester(); - final List Function()> fns = Function()>[ - ...SModules.anime.map( - (final SAnimeModule x) => () async { - final TenkaMetadata config = await x.config(); - final TenkaLocalFileDS source = config.source as TenkaLocalFileDS; - final MockedAnimeExtractor mocked = x.mock(); - return tester.run( - TenkaType.anime, - source, - () => mocked.run(source), - ); - }, - ), - ...SModules.manga.map( - (final SMangaModule x) => () async { - final TenkaMetadata config = await x.config(); - final TenkaLocalFileDS source = config.source as TenkaLocalFileDS; - final MockedMangaExtractor mocked = x.mock(); - return tester.run( - TenkaType.manga, - source, - () => mocked.run(source), - ); - }, - ), - ]; - await STester.runProcedure(() async { - if (ci) { - await Runner.parallel(fns, concurrent: 3); - } else { - await Runner.sequencial(fns); - } - }); + final SoraTester tester = SoraTester( + modules: $modules, + paths: $paths, + urls: $urls, + ); + await tester.test(); await tester.finish(); } diff --git a/store/utils/constants.dart b/store/utils/constants.dart deleted file mode 100644 index 8f07b06..0000000 --- a/store/utils/constants.dart +++ /dev/null @@ -1,12 +0,0 @@ -abstract class Constants { - static const String ghUserName = 'yukino-org'; - static const String ghRepoName = 'sora'; - static const String ghMainBranch = 'main'; - static const String ghDistBranch = 'dist'; - - static const String ghMainBranchURL = - 'https://github.com/$ghUserName/$ghRepoName/tree/$ghMainBranch'; - - static const String ghDistBranchRawURL = - 'https://raw.githubusercontent.com/$ghUserName/$ghRepoName/$ghDistBranch'; -} diff --git a/store/utils/paths.dart b/store/utils/paths.dart deleted file mode 100644 index 9dcf3f1..0000000 --- a/store/utils/paths.dart +++ /dev/null @@ -1,21 +0,0 @@ -import 'dart:io'; -import 'package:path/path.dart' as p; - -abstract class Paths { - static final String rootDir = Directory.current.path; - static final String animeDir = p.join(rootDir, 'modules/anime'); - static final String mangaDir = p.join(rootDir, 'modules/manga'); - - static final String distDir = p.join(rootDir, 'dist'); - static final String distDataDir = p.join(distDir, 'data'); - - static final String summaryDir = p.join(rootDir, 'dist-summary'); - static final String summaryReadme = p.join(summaryDir, 'README.md'); - static final String summaryBadge = p.join(summaryDir, 'badge.json'); - - static String getAnimeModuleDir(final String id) => p.join(animeDir, id); - static String getMangaModuleDir(final String id) => p.join(mangaDir, id); - - static String pretty(final String path) => - p.normalize(path).replaceAll(RegExp(r'[\\/]'), '/'); -} diff --git a/store/utils/runner.dart b/store/utils/runner.dart deleted file mode 100644 index 1a68b3b..0000000 --- a/store/utils/runner.dart +++ /dev/null @@ -1,36 +0,0 @@ -import 'package:utilx/utils.dart'; - -abstract class Runner { - static Future> sequencial( - final List Function()> fns, - ) async { - final List results = []; - for (final Future Function() x in fns) { - results.add(await x()); - } - return results; - } - - static Future> parallel( - final List Function()> fns, { - final int concurrent = -1, - }) async { - final List Function()>> chunks = concurrent > 0 - ? ListUtils.chunk(fns, concurrent) - : Function()>>[fns]; - - final List> results = await sequencial( - chunks - .map( - (final List Function()> x) => - () => Future.wait(x.map((final Future Function() y) => y())), - ) - .toList(), - ); - - return results.fold>( - [], - (final List value, final List x) => value..addAll(x), - ); - } -}