Compare commits

..

8 Commits

53 changed files with 2828 additions and 0 deletions

7
packages/wyatt_i18n/.gitignore vendored Normal file
View File

@ -0,0 +1,7 @@
# https://dart.dev/guides/libraries/private-files
# Created by `dart pub`
.dart_tool/
# Avoid committing pubspec.lock for library packages; see
# https://dart.dev/guides/libraries/private-files#pubspeclock.
pubspec.lock

View File

@ -0,0 +1,24 @@
/*
* Copyright (C) 2022 WYATT GROUP
* Please see the AUTHORS file for details.
*
* 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
* 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 <https://www.gnu.org/licenses/>.
*/
{
"recommendations": [
"psioniq.psi-header",
"blaugold.melos-code"
]
}

34
packages/wyatt_i18n/.vscode/launch.json vendored Normal file
View File

@ -0,0 +1,34 @@
/*
* Copyright (C) 2023 WYATT GROUP
* Please see the AUTHORS file for details.
*
* 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
* 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 <https://www.gnu.org/licenses/>.
*/
{
// Use IntelliSense to learn about possible attributes.
// Hover to view descriptions of existing attributes.
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
"version": "0.2.0",
"configurations": [
{
"name": "Launch Example",
"request": "launch",
"type": "dart",
"cwd": "example/",
"program": "lib/main.dart",
"flutterMode": "debug"
},
]
}

View File

@ -0,0 +1,72 @@
{
"dart.runPubGetOnPubspecChanges": "never",
"bloc.newCubitTemplate.type": "equatable",
"psi-header.changes-tracking": {
"isActive": true
},
"psi-header.config": {
"blankLinesAfter": 1,
"forceToTop": true
},
"psi-header.lang-config": [
{
"beforeHeader": [
"# -*- coding:utf-8 -*-",
"#!/usr/bin/env python3"
],
"begin": "###",
"end": "###",
"language": "python",
"prefix": "# "
},
{
"beforeHeader": [
"#!/usr/bin/env sh",
""
],
"language": "shellscript",
"begin": "",
"end": "",
"prefix": "# "
},
{
"begin": "",
"end": "",
"language": "dart",
"prefix": "// "
},
{
"begin": "",
"end": "",
"language": "yaml",
"prefix": "# "
},
{
"begin": "<!--",
"end": "-->",
"language": "markdown",
},
],
"psi-header.templates": [
{
"language": "*",
"template": [
"Copyright (C) <<year>> WYATT GROUP",
"Please see the AUTHORS file for details.",
"",
"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",
"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 <https://www.gnu.org/licenses/>."
],
}
],
}

View File

@ -0,0 +1,7 @@
# Below is a list of people and organizations that have contributed
# to this project. Names should be added to the list like so:
#
# Name/Organization <email address>
Wyatt Group S.A.S
Hugo Pointcheval <hugo.pointcheval@wyatt-studio.fr>

View File

@ -0,0 +1,3 @@
## 1.0.0
- Initial version.

674
packages/wyatt_i18n/LICENSE Normal file
View File

@ -0,0 +1,674 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
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.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
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 <https://www.gnu.org/licenses/>.
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:
<program> Copyright (C) <year> <name of author>
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
<https://www.gnu.org/licenses/>.
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
<https://www.gnu.org/licenses/why-not-lgpl.html>.

View File

@ -0,0 +1,50 @@
<!--
* Copyright (C) 2023 WYATT GROUP
* Please see the AUTHORS file for details.
*
* 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
* 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 <https://www.gnu.org/licenses/>.
-->
# Flutter - Wyatt I18n
<p align="left">
<a href="https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages/src/branch/master/packages/wyatt_analysis"><img src="https://img.shields.io/badge/Style-Wyatt%20Analysis-blue.svg?style=flat-square" alt="Style: Wyatt Analysis" /></a>
<img src="https://img.shields.io/badge/SDK-Flutter-blue?style=flat-square" alt="SDK: Flutter" />
</p>
A package by wyatt studio
## Features
TODO: List what your package can do. Maybe include images, gifs, or videos.
## Getting started
TODO: List prerequisites and provide or point to information on how to
start using the package.
## Usage
TODO: Include short and useful examples for package users. Add longer examples
to `/example` folder.
```dart
const like = 'sample';
```
## Additional information
TODO: Tell users more about the package: where to find more information, how to
contribute to the package, how to file issues, what response they can expect
from the package authors, and more.

View File

@ -0,0 +1,25 @@
include: package:wyatt_analysis/analysis_options.flutter.yaml
analyzer:
plugins:
- dart_code_metrics
dart_code_metrics:
anti-patterns:
- long-method
- long-parameter-list
metrics:
cyclomatic-complexity: 20
maximum-nesting-level: 5
number-of-parameters: 4
source-lines-of-code: 50
metrics-exclude:
- test/**
rules:
- newline-before-return
- no-boolean-literal-compare
- no-empty-block
- prefer-trailing-comma
- prefer-conditional-expressions
- no-equal-then-else
- avoid-border-all
- prefer-const-border-radius
- prefer-using-list-view

44
packages/wyatt_i18n/example/.gitignore vendored Normal file
View File

@ -0,0 +1,44 @@
# Miscellaneous
*.class
*.log
*.pyc
*.swp
.DS_Store
.atom/
.buildlog/
.history
.svn/
migrate_working_dir/
# IntelliJ related
*.iml
*.ipr
*.iws
.idea/
# The .vscode folder contains launch configuration and tasks you configure in
# VS Code which you may wish to be included in version control, so this line
# is commented out by default.
#.vscode/
# Flutter/Dart/Pub related
**/doc/api/
**/ios/Flutter/.last_build_id
.dart_tool/
.flutter-plugins
.flutter-plugins-dependencies
.packages
.pub-cache/
.pub/
/build/
# Symbolication related
app.*.symbols
# Obfuscation related
app.*.map.json
# Android Studio will place build artifacts here
/android/app/debug
/android/app/profile
/android/app/release

View File

@ -0,0 +1,30 @@
# This file tracks properties of this Flutter project.
# Used by Flutter tool to assess capabilities and perform upgrades etc.
#
# This file should be version controlled.
version:
revision: b06b8b2710955028a6b562f5aa6fe62941d6febf
channel: stable
project_type: app
# Tracks metadata for the flutter migrate command
migration:
platforms:
- platform: root
create_revision: b06b8b2710955028a6b562f5aa6fe62941d6febf
base_revision: b06b8b2710955028a6b562f5aa6fe62941d6febf
- platform: web
create_revision: b06b8b2710955028a6b562f5aa6fe62941d6febf
base_revision: b06b8b2710955028a6b562f5aa6fe62941d6febf
# User provided section
# List of Local paths (relative to this file) that should be
# ignored by the migrate tool.
#
# Files that are not part of the templates will be ignored by default.
unmanaged_files:
- 'lib/main.dart'
- 'ios/Runner.xcodeproj/project.pbxproj'

View File

@ -0,0 +1,16 @@
# example
A new Flutter project.
## Getting Started
This project is a starting point for a Flutter application.
A few resources to get you started if this is your first Flutter project:
- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)
For help getting started with Flutter development, view the
[online documentation](https://docs.flutter.dev/), which offers tutorials,
samples, guidance on mobile development, and a full API reference.

View File

@ -0,0 +1 @@
include: package:wyatt_analysis/analysis_options.flutter.yaml

View File

@ -0,0 +1,13 @@
{
"@@locale": "en",
"youHavePushed": "You have pushed {count} times the bouton !",
"@youHavePushed": {
"placeholders": {
"count": {
"type": "int"
}
}
},
"btnAddFile": "Add file",
"btnAddFileCaption": "Max size: 20MB"
}

View File

@ -0,0 +1,13 @@
{
"@@locale": "en",
"youHavePushed": "You have pushed {count} times the bouton !",
"@youHavePushed": {
"placeholders": {
"count": {
"type": "int"
}
}
},
"btnAddFile": "Add file",
"btnAddFileCaption": "Max size: 20MB"
}

View File

@ -0,0 +1,8 @@
"@@locale": en
youHavePushed: You have pushed {count} times the bouton !
"@youHavePushed":
placeholders:
count:
type: int
btnAddFile: Add file
btnAddFileCaption: "Max size: 20MB"

View File

@ -0,0 +1,64 @@
// Copyright (C) 2023 WYATT GROUP
// Please see the AUTHORS file for details.
//
// 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
// 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 <https://www.gnu.org/licenses/>.
import 'package:flutter/material.dart';
import 'package:flutter_localizations/flutter_localizations.dart';
import 'package:wyatt_i18n/wyatt_i18n.dart';
void main(List<String> args) {
runApp(const App());
}
class App extends StatelessWidget {
const App({super.key});
static const String title = 'Wyatt i18n Example';
@override
Widget build(BuildContext context) {
final I18nDataSource dataSource = NetworkDataSourceImpl(
baseUri: Uri.parse(
'https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages/raw/commit/75f561a19e0484e67e511dbf29601ec5f58544aa/packages/wyatt_i18n/example/assets/',
),
);
final I18nRepository repository =
I18nRepositoryImpl(dataSource: dataSource);
return MaterialApp(
title: title,
theme: ThemeData(
primarySwatch: Colors.blue,
),
localizationsDelegates: [
I18nDelegate(repository: repository),
GlobalMaterialLocalizations.delegate,
GlobalWidgetsLocalizations.delegate
],
home: Scaffold(
appBar: AppBar(
title: const Text(title),
),
body: Builder(
builder: (ctx) => Center(
child: Text(ctx.i18n('youHavePushed', {'count': 654})),
),
),
),
);
}
}

View File

@ -0,0 +1,21 @@
name: wyatt_i18n_example
description: A new Flutter project.
version: 1.0.0
publish_to: "none"
environment:
sdk: ">=2.19.0 <3.0.0"
dependencies:
flutter: { sdk: flutter }
flutter_localizations: { sdk: flutter }
wyatt_i18n:
path: "../"
dev_dependencies:
flutter_test: { sdk: flutter }
wyatt_analysis:
hosted: https://git.wyatt-studio.fr/api/packages/Wyatt-FOSS/pub
version: ^2.4.0
# The following section is specific to Flutter.
flutter:
uses-material-design: true
assets:
- assets/

View File

@ -0,0 +1 @@

Binary file not shown.

After

Width:  |  Height:  |  Size: 917 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.2 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

View File

@ -0,0 +1,59 @@
<!DOCTYPE html>
<html>
<head>
<!--
If you are serving your web app in a path other than the root, change the
href value below to reflect the base path you are serving from.
The path provided below has to start and end with a slash "/" in order for
it to work correctly.
For more details:
* https://developer.mozilla.org/en-US/docs/Web/HTML/Element/base
This is a placeholder for base href that will be replaced by the value of
the `--base-href` argument provided to `flutter build`.
-->
<base href="$FLUTTER_BASE_HREF">
<meta charset="UTF-8">
<meta content="IE=Edge" http-equiv="X-UA-Compatible">
<meta name="description" content="A new Flutter project.">
<!-- iOS meta tags & icons -->
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-status-bar-style" content="black">
<meta name="apple-mobile-web-app-title" content="example">
<link rel="apple-touch-icon" href="icons/Icon-192.png">
<!-- Favicon -->
<link rel="icon" type="image/png" href="favicon.png"/>
<title>example</title>
<link rel="manifest" href="manifest.json">
<script>
// The value below is injected by flutter build, do not touch.
var serviceWorkerVersion = null;
</script>
<!-- This script adds the flutter initialization JS code -->
<script src="flutter.js" defer></script>
</head>
<body>
<script>
window.addEventListener('load', function(ev) {
// Download main.dart.js
_flutter.loader.loadEntrypoint({
serviceWorker: {
serviceWorkerVersion: serviceWorkerVersion,
},
onEntrypointLoaded: function(engineInitializer) {
engineInitializer.initializeEngine().then(function(appRunner) {
appRunner.runApp();
});
}
});
});
</script>
</body>
</html>

View File

@ -0,0 +1,35 @@
{
"name": "example",
"short_name": "example",
"start_url": ".",
"display": "standalone",
"background_color": "#0175C2",
"theme_color": "#0175C2",
"description": "A new Flutter project.",
"orientation": "portrait-primary",
"prefer_related_applications": false,
"icons": [
{
"src": "icons/Icon-192.png",
"sizes": "192x192",
"type": "image/png"
},
{
"src": "icons/Icon-512.png",
"sizes": "512x512",
"type": "image/png"
},
{
"src": "icons/Icon-maskable-192.png",
"sizes": "192x192",
"type": "image/png",
"purpose": "maskable"
},
{
"src": "icons/Icon-maskable-512.png",
"sizes": "512x512",
"type": "image/png",
"purpose": "maskable"
}
]
}

View File

@ -0,0 +1,20 @@
// Copyright (C) 2023 WYATT GROUP
// Please see the AUTHORS file for details.
//
// 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
// 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 <https://www.gnu.org/licenses/>.
export 'enums/format.dart';
export 'exceptions/exceptions.dart';
export 'extensions/build_context_extension.dart';
export 'utils/utils.dart';

View File

@ -0,0 +1,64 @@
// Copyright (C) 2023 WYATT GROUP
// Please see the AUTHORS file for details.
//
// 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
// 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 <https://www.gnu.org/licenses/>.
import 'package:wyatt_i18n/src/core/utils/arb_parser.dart';
import 'package:wyatt_i18n/src/core/utils/json_parser.dart';
import 'package:wyatt_i18n/src/core/utils/parser.dart';
import 'package:wyatt_i18n/src/core/utils/yaml_parser.dart';
/// Enum for i18n file formats and extensions.
///
/// This enum is used to determine the parser to use for a given i18n file.
enum Format {
/// JSON i18n file format.
json,
/// YAML i18n file format.
yaml,
yml,
/// ARB i18n file format.
arb;
/// Returns the [Format] that matches the given [ext].
static Format? fromExtension(String ext) {
for (final format in Format.values) {
if (format.name == ext) {
return format;
}
}
return null;
}
/// Returns the [Format] that matches the given [path].
static Format? extensionOf(String path) =>
fromExtension(path.split('.').last);
/// Returns the [Parser] associated with this [Format].
Parser<String, Map<String, dynamic>> get parser {
switch (this) {
case Format.json:
return const JsonParser();
case Format.yaml:
case Format.yml:
return const YamlParser();
case Format.arb:
return const ArbParser();
}
}
}

View File

@ -0,0 +1,70 @@
// Copyright (C) 2023 WYATT GROUP
// Please see the AUTHORS file for details.
//
// 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
// 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 <https://www.gnu.org/licenses/>.
import 'package:wyatt_architecture/wyatt_architecture.dart';
import 'package:wyatt_i18n/src/core/enums/format.dart';
/// Exception thrown when the i18n file is not found.
///
/// Source can be a file path or a URL.
class SourceNotFoundException extends ClientException {
SourceNotFoundException(String source, {required Format format})
: super('Source `$source` (format: $format) not found.');
}
/// Exception thrown when the i18n file is not valid.
class NoLocaleException extends ClientException {
NoLocaleException()
: super('No `@@locale` key found in the source nor locale provided.');
}
/// Exception thrown when the i18n locale is not valid.
class InvalidLocaleException extends ClientException {
InvalidLocaleException(String locale, String expected)
: super('Invalid locale `$locale`. Expected `$expected`.');
}
/// Exception thrown when the key is not found in the i18n file.
class KeyNotFoundException extends ClientException {
KeyNotFoundException(String key, [Map<String, dynamic> arguments = const {}])
: super(
'Key `$key` not found. ${arguments.isNotEmpty ? '($arguments)' : ''}',
);
}
/// Exception thrown when the searched key requires arguments but none were
/// provided.
class ArgumentsRequiredException extends ClientException {
ArgumentsRequiredException(String key, String value)
: super('Key `$key` requires arguments. ($value)');
}
/// Exception thrown when the key references a malformed value.
class MalformedValueException extends ClientException {
MalformedValueException(String key, String value)
: super('Key `$key` references a malformed value. ($value)');
}
/// Exception thrown when the parser fails.
class ParserException extends ClientException {
ParserException(String message, StackTrace? stackTrace)
: super('$message\n\n$stackTrace');
}
/// Exception thrown when the i18n is not loaded.
class NotLoadedException extends ClientException {
NotLoadedException() : super('I18n not loaded.');
}

View File

@ -0,0 +1,36 @@
// Copyright (C) 2023 WYATT GROUP
// Please see the AUTHORS file for details.
//
// 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
// 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 <https://www.gnu.org/licenses/>.
import 'package:flutter/widgets.dart';
import 'package:wyatt_i18n/wyatt_i18n.dart';
/// Provides extensions for [BuildContext].
extension BuildContextExtension on BuildContext {
/// Returns the current locale of the app.
String get locale => Localizations.localeOf(this).languageCode;
/// Returns the current [I18n] instance.
///
/// Throws a [NotLoadedException] if the [I18n] instance is not loaded.
I18n get i18n {
final i18n = Localizations.of<I18n>(this, I18n);
if (i18n == null) {
throw NotLoadedException();
}
return i18n;
}
}

View File

@ -0,0 +1,34 @@
// Copyright (C) 2023 WYATT GROUP
// Please see the AUTHORS file for details.
//
// 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
// 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 <https://www.gnu.org/licenses/>.
import 'package:wyatt_i18n/src/core/utils/json_parser.dart';
import 'package:wyatt_i18n/src/core/utils/parser.dart';
/// {@template arb_parser}
/// A class that parses a given input of type [String] into a given output
/// of type [Map<String, dynamic>].
/// {@endtemplate}
class ArbParser extends Parser<String, Map<String, dynamic>> {
/// {@macro arb_parser}
const ArbParser() : super();
/// Parses the given [input] of type [String] into a given output of type
/// [Map<String, dynamic>].
///
/// ARB files are JSON files, so we can use the JSON parser.
@override
Map<String, dynamic> parse(String input) => const JsonParser().parse(input);
}

View File

@ -0,0 +1,41 @@
// Copyright (C) 2023 WYATT GROUP
// Please see the AUTHORS file for details.
//
// 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
// 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 <https://www.gnu.org/licenses/>.
import 'dart:convert';
import 'package:flutter/services.dart';
/// A class that contains utility methods for assets.
abstract class AssetsUtils {
/// Checks if the given [assetPath] is a local asset.
///
/// In fact, this method loads the asset and checks if it is null.
static Future<bool> assetExists(String assetPath) async {
final encoded = utf8.encoder.convert(
Uri(path: Uri.encodeFull(assetPath)).path,
);
final asset = await ServicesBinding.instance.defaultBinaryMessenger
.send('flutter/assets', encoded.buffer.asByteData());
return asset != null;
}
/// Cleans the given [path] by removing all the consecutive slashes.
/// For example, `///a///b///c///` becomes `/a/b/c/`.
/// It also removes the first slash if it exists.
static String cleanPath(String path) =>
path.replaceAll(RegExp(r'\/+'), '/').replaceFirst(RegExp(r'^\/'), '');
}

View File

@ -0,0 +1,142 @@
// Copyright (C) 2023 WYATT GROUP
// Please see the AUTHORS file for details.
//
// 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
// 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 <https://www.gnu.org/licenses/>.
import 'package:collection/collection.dart';
import 'package:intl/intl.dart';
import 'package:wyatt_i18n/src/domain/entities/tokens.dart';
import 'package:wyatt_i18n/wyatt_i18n.dart';
/// {@template i18n_file_parser}
/// This class is responsible for parsing the [I18nFile] and returning the
/// translated string.
/// {@endtemplate}
class I18nFileParser extends Parser<String, String> {
/// {@macro i18n_file_parser}
const I18nFileParser({
required this.i18n,
this.arguments = const {},
}) : super();
/// The [I18nFile] to be parsed.
final I18nFile i18n;
/// The arguments to be used in the translation.
final Map<String, dynamic> arguments;
dynamic getArgument(String key) {
final arg = arguments[key];
if (arg == null) {
throw ArgumentsRequiredException(key, 'value');
}
return arg;
}
String pluralToString(Plural token) {
final List<Option?> options = token.options;
final zero =
options.firstWhereOrNull((o) => o!.name == 'zero' || o.name == '=0');
final one =
options.firstWhereOrNull((o) => o!.name == 'one' || o.name == '=1');
final two =
options.firstWhereOrNull((o) => o!.name == 'two' || o.name == '=2');
final few = options.firstWhereOrNull((o) => o!.name == 'few');
final many = options.firstWhereOrNull((o) => o!.name == 'many');
final other = options.firstWhereOrNull((o) => o!.name == 'other');
final zeroStr = zero?.value.map(parsedElementToString).join() ?? '';
final oneStr = one?.value.map(parsedElementToString).join() ?? '';
final twoStr = two?.value.map(parsedElementToString).join() ?? '';
final fewStr = few?.value.map(parsedElementToString).join() ?? '';
final manyStr = many?.value.map(parsedElementToString).join() ?? '';
final otherStr = other?.value.map(parsedElementToString).join() ?? '';
return Intl.plural(
getArgument(token.value) as num,
zero: zeroStr,
two: twoStr,
one: oneStr,
few: fewStr,
other: otherStr,
many: manyStr,
);
}
String genderToString(Gender token) {
final List<Option?> options = token.options;
final other = options.firstWhereOrNull((o) => o!.name == 'other');
final male = options.firstWhereOrNull((o) => o!.name == 'male');
final female = options.firstWhereOrNull((o) => o!.name == 'female');
final otherStr = other?.value.map(parsedElementToString).join() ?? '';
final maleStr = male?.value.map(parsedElementToString).join() ?? '';
final femaleStr = female?.value.map(parsedElementToString).join() ?? '';
return Intl.gender(
getArgument(token.value) as String,
other: otherStr,
female: femaleStr,
male: maleStr,
);
}
String selectToString(Select token) {
final Map<Object, String> cases = {
for (var e in token.options.map(
(o) => MapEntry(
o.name,
o.value.map(parsedElementToString).join(),
),
))
e.key: e.value,
};
return Intl.select(
getArgument(token.value) as String,
cases,
);
}
String parsedElementToString(Token token) {
switch (token.type) {
case TokenType.literal:
return token.value;
case TokenType.plural:
return pluralToString(token as Plural);
case TokenType.gender:
return genderToString(token as Gender);
case TokenType.argument:
return getArgument(token.value).toString();
case TokenType.select:
return selectToString(token as Select);
}
}
@override
String parse(String input, {String? key}) {
String? result;
try {
result = IcuParser().parse(input)?.map(parsedElementToString).join();
if (result == null) {
throw MalformedValueException(key ?? '', input);
}
} on ArgumentsRequiredException catch (_) {
rethrow;
} catch (e) {
throw MalformedValueException(key ?? '', input);
}
return result;
}
}

View File

@ -0,0 +1,179 @@
// Copyright (C) 2023 WYATT GROUP
// Please see the AUTHORS file for details.
//
// 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
// 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 <https://www.gnu.org/licenses/>.
// ignore_for_file: avoid_dynamic_calls, inference_failure_on_untyped_parameter
import 'package:petitparser/petitparser.dart' hide Token;
import 'package:wyatt_i18n/src/domain/entities/tokens.dart';
/// {@template icu_parser}
/// A parser for ICU messages.
/// See https://unicode-org.github.io/icu/userguide/format_parse/messages/
/// for the syntax.
/// {@endtemplate}
class IcuParser {
/// {@macro icu_parser}
IcuParser() {
// There is a cycle here, so we need the explicit
// set to avoid infinite recursion.
interiorText.set(contents.plus() | empty);
}
Parser get openCurly => char('{');
Parser get closeCurly => char('}');
Parser get quotedCurly => (string("'{'") | string("'}'")).map((x) => x[1]);
Parser get icuEscapedText => quotedCurly | twoSingleQuotes;
Parser get curly => openCurly | closeCurly;
Parser get notAllowedInIcuText => curly | char('<');
Parser get icuText => notAllowedInIcuText.neg();
Parser get notAllowedInNormalText => char('{');
Parser get normalText => notAllowedInNormalText.neg();
Parser get messageText =>
(icuEscapedText | icuText).plus().flatten().map(Literal.new);
Parser get nonIcuMessageText => normalText.plus().flatten().map(Literal.new);
Parser get twoSingleQuotes => string("''").map((x) => "'");
Parser get number => digit().plus().flatten().trim().map(int.parse);
Parser get id => (letter() & (word() | char('_')).star()).flatten().trim();
Parser get comma => char(',').trim();
/// Given a list of possible keywords, return a rule that accepts any of them.
/// e.g., given ["male", "female", "other"], accept any of them.
Parser asKeywords(List<String> list) =>
list.map(string).cast<Parser>().reduce((a, b) => a | b).flatten().trim();
Parser get pluralKeyword => asKeywords(
['=0', '=1', '=2', 'zero', 'one', 'two', 'few', 'many', 'other'],
);
Parser get genderKeyword => asKeywords(['female', 'male', 'other']);
SettableParser<dynamic> interiorText = undefined();
Parser get preface => (openCurly & id & comma).map((values) => values[1]);
Parser get pluralLiteral => string('plural');
Parser get pluralClause =>
(pluralKeyword & openCurly & interiorText & closeCurly).trim().map(
(result) => Option(
result[0] as String,
List<Token>.from(
(result[2] is List ? result[2] as List : [result[2]])
.cast<Token>(),
),
),
);
Parser get plural =>
preface & pluralLiteral & comma & pluralClause.plus() & closeCurly;
Parser get intlPlural => plural.map(
(result) => Plural(
result[0] as String,
List<Option>.from(result[3] as Iterable<dynamic>),
),
);
Parser get selectLiteral => string('select');
Parser get genderClause =>
(genderKeyword & openCurly & interiorText & closeCurly).trim().map(
(result) => Option(
result[0] as String,
List<Token>.from(
(result[2] is List ? result[2] as List : [result[2]])
.cast<Token>(),
),
),
);
Parser get gender =>
preface & selectLiteral & comma & genderClause.plus() & closeCurly;
Parser get intlGender => gender.map(
(result) => Gender(
result[0] as String,
List<Option>.from(result[3] as Iterable<dynamic>),
),
);
Parser get selectClause =>
(id & openCurly & interiorText & closeCurly).trim().map(
(result) => Option(
result[0] as String,
List<Token>.from(
(result[2] is List ? result[2] as List : [result[2]])
.cast<Token>(),
),
),
);
Parser get generalSelect =>
preface & selectLiteral & comma & selectClause.plus() & closeCurly;
Parser get intlSelect => generalSelect.map(
(result) => Select(
result[0] as String,
List<Option>.from(result[3] as Iterable<dynamic>),
),
);
Parser get compound => (((parameter | nonIcuMessageText).plus() &
pluralOrGenderOrSelect &
(pluralOrGenderOrSelect | parameter | nonIcuMessageText).star()) |
(pluralOrGenderOrSelect &
(pluralOrGenderOrSelect | parameter | nonIcuMessageText).plus()))
.map((result) => result.expand((x) => x is List ? x : [x]).toList());
Parser get pluralOrGenderOrSelect => intlPlural | intlGender | intlSelect;
Parser get contents => pluralOrGenderOrSelect | parameter | messageText;
Parser get simpleText =>
(nonIcuMessageText | parameter | openCurly).plus().map(
(result) => result
.map((item) => item is String ? Literal(item) : item)
.toList(),
);
Parser get empty => epsilon().map((_) => Literal(''));
Parser get parameter => (openCurly & id & closeCurly)
.map((result) => Argument(result[1] as String));
List<Token>? parse(String message) {
final parsed = (compound | pluralOrGenderOrSelect | simpleText | empty)
.map(
(result) => List<Token>.from(result is List ? result : [result]),
)
.parse(message);
return parsed.isSuccess ? parsed.value : null;
}
}

View File

@ -0,0 +1,40 @@
// Copyright (C) 2023 WYATT GROUP
// Please see the AUTHORS file for details.
//
// 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
// 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 <https://www.gnu.org/licenses/>.
import 'dart:convert';
import 'package:wyatt_i18n/src/core/exceptions/exceptions.dart';
import 'package:wyatt_i18n/src/core/utils/parser.dart';
/// {@template json_parser}
/// A class that parses a given input of type [String] into a given output
/// of type [Map<String, dynamic>].
/// {@endtemplate}
class JsonParser extends Parser<String, Map<String, dynamic>> {
/// {@macro json_parser}
const JsonParser() : super();
/// Parses the given [input] of type [String] into a given output of type
/// [Map<String, dynamic>].
@override
Map<String, dynamic> parse(String input) {
try {
return jsonDecode(input) as Map<String, dynamic>;
} catch (e, s) {
throw ParserException(e.toString(), s);
}
}
}

View File

@ -0,0 +1,26 @@
// Copyright (C) 2023 WYATT GROUP
// Please see the AUTHORS file for details.
//
// 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
// 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 <https://www.gnu.org/licenses/>.
/// {@template parser}
/// A class that parses a given input into a given output.
/// {@endtemplate}
abstract class Parser<I, O> {
/// {@macro parser}
const Parser();
/// Parses the given [input] of type [I] into a given output of type [O].
O parse(I input);
}

View File

@ -0,0 +1,22 @@
// Copyright (C) 2023 WYATT GROUP
// Please see the AUTHORS file for details.
//
// 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
// 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 <https://www.gnu.org/licenses/>.
export 'arb_parser.dart';
export 'i18n_file_parser.dart';
export 'icu_parser.dart';
export 'json_parser.dart';
export 'parser.dart';
export 'yaml_parser.dart';

View File

@ -0,0 +1,40 @@
// Copyright (C) 2023 WYATT GROUP
// Please see the AUTHORS file for details.
//
// 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
// 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 <https://www.gnu.org/licenses/>.
import 'package:wyatt_i18n/src/core/exceptions/exceptions.dart';
import 'package:wyatt_i18n/src/core/utils/parser.dart';
import 'package:yaml/yaml.dart';
/// {@template yaml_parser}
/// A class that parses a given YAML input into a given output.
/// {@endtemplate}
class YamlParser extends Parser<String, Map<String, dynamic>> {
/// {@macro yaml_parser}
const YamlParser() : super();
/// Parses the given [input] of type [String] into a given output of type
/// [Map<String, dynamic>].
@override
Map<String, dynamic> parse(String input) {
try {
final yaml = loadYaml(input) as YamlMap;
return yaml.map((key, value) => MapEntry(key.toString(), value));
} catch (e, s) {
throw ParserException(e.toString(), s);
}
}
}

View File

@ -0,0 +1,19 @@
// Copyright (C) 2023 WYATT GROUP
// Please see the AUTHORS file for details.
//
// 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
// 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 <https://www.gnu.org/licenses/>.
export 'data_sources/assets_file_data_source_impl.dart';
export 'data_sources/network_data_source_impl.dart';
export 'repositories/i18n_repository_impl.dart';

View File

@ -0,0 +1,123 @@
// Copyright (C) 2023 WYATT GROUP
// Please see the AUTHORS file for details.
//
// 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
// 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 <https://www.gnu.org/licenses/>.
import 'package:flutter/services.dart' show AssetBundle, rootBundle;
import 'package:wyatt_i18n/src/core/enums/format.dart';
import 'package:wyatt_i18n/src/core/exceptions/exceptions.dart';
import 'package:wyatt_i18n/src/core/utils/assets_utils.dart';
import 'package:wyatt_i18n/src/domain/data_sources/i18n_data_source.dart';
/// {@template assets_file_data_source_impl}
/// Implementation of [I18nDataSource] that loads i18n files from the assets.
///
/// The [basePath] is the folder where the i18n files are located.
/// The [baseName] is the name of the i18n files without the extension.
/// The [format] is the format of the i18n files.
///
/// For example, if the i18n files are located in the `assets/l10n/` and are
/// named `i18n.en.arb`, `i18n.fr.arb`, etc., then the [basePath]
/// is `l10n` and the [baseName] is `i18n` and the [format] is [Format.arb].
/// {@endtemplate}
class AssetsFileDataSourceImpl extends I18nDataSource {
/// {@macro assets_file_data_source_impl}
AssetsFileDataSourceImpl({
this.basePath = '',
this.baseName = 'i18n',
super.format = Format.arb,
super.defaultLocale = 'en',
}) : super();
/// The folder where the i18n files are located.
///
/// Note: The path is relative to the `assets` folder. So, `assets/l10n/`
/// is `l10n`.
final String basePath;
/// The name of the i18n files without the extension.
final String baseName;
/// The asset bundle used to load the i18n files.
final AssetBundle assetBundle = rootBundle;
/// Tries to load the i18n file from the given [locale].
Future<String> _tryLoad(String? locale) async {
String? content;
final ext = format.name;
final path = AssetsUtils.cleanPath(
locale == null
? '$basePath/$baseName.$defaultLocale.$ext'
: '$basePath/$baseName.$locale.$ext',
);
try {
if (await AssetsUtils.assetExists(path)) {
content = await assetBundle.loadString(path);
}
} catch (_) {
content = null;
}
/// If the i18n file is not found, then we try to load the
/// default i18n file.
if (content == null && locale != null) {
try {
final fallbackPath = AssetsUtils.cleanPath(
'$basePath/$baseName.$defaultLocale.$ext',
);
content = await assetBundle.loadString(fallbackPath);
} catch (_) {
throw SourceNotFoundException(path, format: format);
}
}
/// If the default i18n file is not found, then we throw an exception.
/// This case should happen only if the locale is null.
if (content == null) {
throw SourceNotFoundException(path, format: format);
}
return content;
}
/// Tries to load the i18n file from a given [uri].
/// This method is used when the [uri] is not null.
Future<String> _tryLoadUri(Uri uri) async {
String? content;
try {
content = await assetBundle.loadString(uri.toString());
} catch (_) {
throw SourceNotFoundException(uri.toString(), format: format);
}
return content;
}
/// Loads the i18n file from Assets folder.
///
/// The i18n file must be in [basePath], named [baseName] +
/// `.<locale>.<extension>` and must be specified in the `pubspec.yaml` file.
@override
Future<String> load({required String? locale}) async => _tryLoad(locale);
/// Loads the i18n file from Assets folder.
///
/// If the [uri] is not null, then we try to load the i18n file
/// from the given [uri]. In this case, the [basePath] and the
/// [baseName] are ignored. And there is no fallback.
@override
Future<String> loadFrom(Uri uri) async => _tryLoadUri(uri);
}

View File

@ -0,0 +1,141 @@
// Copyright (C) 2023 WYATT GROUP
// Please see the AUTHORS file for details.
//
// 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
// 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 <https://www.gnu.org/licenses/>.
import 'package:flutter/services.dart';
import 'package:http/http.dart' as http;
import 'package:wyatt_i18n/src/core/enums/format.dart';
import 'package:wyatt_i18n/src/core/exceptions/exceptions.dart';
import 'package:wyatt_i18n/src/core/utils/assets_utils.dart';
import 'package:wyatt_i18n/src/domain/data_sources/i18n_data_source.dart';
/// {@template network_data_source_impl}
/// Implementation of [I18nDataSource] that loads i18n files from the network.
///
/// The [baseUri] is the base uri where the i18n files are located.
/// The [baseName] is the name of the i18n files without the extension.
/// The [fallbackAssetPath] is the path to the fallback i18n files.
/// The [format] is the format of the i18n files.
///
/// For example, if the i18n files are located at `https://example.com/i18n/`
/// and are named `i18n.en.arb`, `i18n.fr.arb`, etc., then the [baseUri] is
/// `https://example.com/i18n/` and the [baseName] is `i18n` and the
/// [format] is [Format.arb].
///
/// If the i18n file for the given locale is not found or if the fetch fails,
/// then the fallback i18n files are loaded from the [fallbackAssetPath] in
/// the root bundle.
///
/// For example, if the fallback i18n files are located in the `assets/l10n/`
/// and are named `i18n.arb`, `i18n.en.arb`, `i18n.fr.arb`, etc., then the
/// [fallbackAssetPath] is `l10n`.
/// {@endtemplate}
class NetworkDataSourceImpl extends I18nDataSource {
/// {@macro network_data_source_impl}
const NetworkDataSourceImpl({
required this.baseUri,
this.baseName = 'i18n',
this.fallbackAssetPath = '',
super.format = Format.arb,
super.defaultLocale = 'en',
}) : super();
/// The base uri where the i18n files are located.
final Uri baseUri;
/// The name of the i18n files without the extension.
final String baseName;
/// The path to the fallback i18n files.
///
/// This is used when the i18n file for the given locale is not found or
/// if the fetch fails.
///
/// Note: The path is relative to the root bundle. So `assets/l10n/` is
/// `l10n`.
final String fallbackAssetPath;
/// Tries to load the i18n file from the given [locale].
Future<String> _tryLoad(String? locale, {Uri? overrideUri}) async {
String? content;
final ext = format.name;
/// If the locale is null, then we try to load the default i18n file from
/// the fallback asset path.
/// Otherwise, we try to load the i18n file for the given locale from the
/// base uri.
final path = AssetsUtils.cleanPath(
locale == null
? '$fallbackAssetPath/$baseName.$defaultLocale.$ext'
: overrideUri?.toString() ?? '$baseUri/$baseName.$locale.$ext',
);
if (locale == null) {
/// Load the default i18n file from the fallback asset path.
try {
if (await AssetsUtils.assetExists(path)) {
content = await rootBundle.loadString(path);
}
} catch (_) {
content = null;
}
} else {
/// Load the i18n file for the given locale from the base uri.
try {
final response = await http.get(Uri.parse(path));
if (response.statusCode >= 200 && response.statusCode < 300) {
content = response.body;
}
} catch (_) {
content = null;
}
}
/// If the i18n file is not found, then we try to load the
/// default i18n file.
if (content == null && locale != null) {
try {
final fallbackPath = AssetsUtils.cleanPath(
'$fallbackAssetPath/$baseName.$defaultLocale.$ext',
);
content = await rootBundle.loadString(fallbackPath);
} catch (_) {
throw SourceNotFoundException(path, format: format);
}
}
/// If the default i18n file is not found, then we throw an exception.
/// This case should happen only if the locale is null.
if (content == null) {
throw SourceNotFoundException(path, format: format);
}
return content;
}
/// Loads the i18n file for the given [locale].
///
/// If the [locale] is null, then the default i18n file is loaded from the
/// fallback asset path.
@override
Future<String> load({required String? locale}) async => _tryLoad(locale);
/// Loads the i18n file from the given [uri].
///
/// If the fetch fails, then the fallback i18n files are loaded from the
/// [fallbackAssetPath] in the root bundle.
@override
Future<String> loadFrom(Uri uri) async => _tryLoad(null, overrideUri: uri);
}

View File

@ -0,0 +1,157 @@
// Copyright (C) 2023 WYATT GROUP
// Please see the AUTHORS file for details.
//
// 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
// 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 <https://www.gnu.org/licenses/>.
import 'package:wyatt_architecture/wyatt_architecture.dart';
import 'package:wyatt_i18n/wyatt_i18n.dart';
import 'package:wyatt_type_utils/wyatt_type_utils.dart' hide Option;
/// {@template i18n_repository_impl}
/// The default implementation of [I18nRepository].
/// {@endtemplate}
class I18nRepositoryImpl extends I18nRepository {
/// {@macro i18n_repository_impl}
I18nRepositoryImpl({
required this.dataSource,
}) : super();
/// The data source used to load the i18n file.
final I18nDataSource dataSource;
/// The current i18n instance.
I18nFile _i18n = const I18nFile.empty();
@override
I18nFile get i18n => _i18n;
Future<I18nFile> _parse(
String content,
Parser<String, Map<String, dynamic>> parser, {
String? locale,
bool strict = false,
}) async {
final parsed = parser.parse(content);
String parsedLocale;
/// Checks if the locale is present in the parsed data.
/// If not, throws an exception.
/// If yes, sets the locale to the parsed locale.
if (parsed.containsKey('@@locale')) {
if (strict) {
/// Checks if the parsed locale is a string.
if (parsed['@@locale'] is! String) {
throw NoLocaleException();
}
/// Checks if the parsed locale is the same as the given locale.
if (locale != null && parsed['@@locale'] as String != locale) {
throw InvalidLocaleException(locale, parsed['@@locale'] as String);
}
}
parsedLocale = parsed['@@locale'] as String;
} else {
if (strict) {
/// Throws an exception if the locale is not present in the parsed data.
throw NoLocaleException();
} else {
/// Sets the locale to the given locale.
/// If the given locale is null, sets the locale to 'null'.
/// This is done to prevent the locale from being null.
/// It should never be null.
parsedLocale = locale ?? 'null';
}
}
return I18nFile(
locale: parsedLocale,
unparsedData: content,
data: parsed,
);
}
@override
FutureOrResult<I18nFile> load({
required String? locale,
bool strict = false,
Parser<String, Map<String, dynamic>>? parser,
}) async =>
await Result.tryCatchAsync<I18nFile, AppException, AppException>(
() async {
final content = await dataSource.load(locale: locale);
return _i18n = await _parse(
content,
parser ?? dataSource.format.parser,
locale: locale,
strict: strict,
);
},
(error) => error,
);
@override
FutureOrResult<I18nFile> loadFrom(
Uri uri, {
Parser<String, Map<String, dynamic>>? parser,
}) async =>
await Result.tryCatchAsync<I18nFile, AppException, AppException>(
() async {
final content = await dataSource.loadFrom(uri);
/// Strict is always true when loading from a uri. Because
/// the locale is not given and can't be inferred.
return _i18n = await _parse(
content,
parser ?? dataSource.format.parser,
strict: true,
);
},
(error) => error,
);
@override
Result<String, AppException> get(
String key, [
Map<String, dynamic> arguments = const {},
]) {
final I18nFileParser parser =
I18nFileParser(i18n: _i18n, arguments: arguments);
if (_i18n.containsKey(key)) {
return Result.tryCatch<String, AppException, AppException>(
() => parser.parse(_i18n[key] as String, key: key),
(error) => error,
);
} else {
throw KeyNotFoundException(key, arguments);
}
}
@override
Result<I18nFile, AppException> getI18n() =>
Result.conditional(!_i18n.isEmpty, _i18n, NotLoadedException());
@override
Result<String, AppException> getLocale() =>
Result.conditional(!_i18n.isEmpty, _i18n.locale, NotLoadedException());
@override
Result<void, AppException> setI18n(I18nFile i18n) {
_i18n = i18n;
return const Ok(null);
}
}

View File

@ -0,0 +1,49 @@
// Copyright (C) 2023 WYATT GROUP
// Please see the AUTHORS file for details.
//
// 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
// 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 <https://www.gnu.org/licenses/>.
import 'package:wyatt_architecture/wyatt_architecture.dart';
import 'package:wyatt_i18n/src/core/enums/format.dart';
/// {@template i18n_data_source}
/// Base class for i18n data sources.
///
/// This class is used to load i18n files from a source.
/// It returns a [Future] that resolves to a [String] containing the i18n file
/// contents.
/// {@endtemplate}
abstract class I18nDataSource extends BaseDataSource {
/// {@macro i18n_data_source}
const I18nDataSource({
this.format = Format.arb,
this.defaultLocale = 'en',
});
/// The format of the i18n file.
final Format format;
/// The default locale.
final String defaultLocale;
/// Loads the i18n file from the source.
/// If [locale] is not `null`, it will load the file with the given [locale].
/// Otherwise, it will load the file from the default location.
Future<String> load({required String? locale});
/// Loads the i18n file from the source.
///
/// This method is used to load the i18n file from the given [Uri].
Future<String> loadFrom(Uri uri);
}

View File

@ -0,0 +1,20 @@
// Copyright (C) 2023 WYATT GROUP
// Please see the AUTHORS file for details.
//
// 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
// 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 <https://www.gnu.org/licenses/>.
export 'data_sources/i18n_data_source.dart';
export 'entities/i18n.dart';
export 'entities/i18n_file.dart';
export 'repositories/i18n_repository.dart';

View File

@ -0,0 +1,60 @@
// Copyright (C) 2023 WYATT GROUP
// Please see the AUTHORS file for details.
//
// 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
// 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 <https://www.gnu.org/licenses/>.
import 'package:wyatt_architecture/wyatt_architecture.dart';
import 'package:wyatt_i18n/wyatt_i18n.dart';
/// {@template i18n}
/// This class is used to store the translations of the application.
/// This entity is used by the I18nDelegate and Flutter's Localizations
/// widget to provide the translations to the application.
/// {@endtemplate}
class I18n extends Entity {
/// {@macro i18n}
I18n({
required this.i18nRepository,
}) : super();
final I18nRepository i18nRepository;
/// Get the translation of the given [key].
/// If the [key] is not found, the [key] itself is returned.
/// If the [key] is found, the translation is returned.
/// If [args] is not null, the translation is formatted with the
/// given arguments.
String get(String key, [Map<String, dynamic>? args]) {
final result = i18nRepository.get(key, args ?? const <String, dynamic>{});
return result.fold(
(value) => value,
(error) => key,
);
}
/// Get the translation of the given [key].
///
/// Note: arguments are not supported.
String operator [](String key) => get(key);
/// Get the translation of the given [key].
String call(String key, [Map<String, dynamic>? args]) => get(key, args);
/// Load the translations from the given [locale].
/// If the [locale] is not found, the default locale is loaded.
Future<void> load(String locale) async {
await i18nRepository.load(locale: locale);
}
}

View File

@ -0,0 +1,54 @@
// Copyright (C) 2023 WYATT GROUP
// Please see the AUTHORS file for details.
//
// 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
// 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 <https://www.gnu.org/licenses/>.
import 'package:equatable/equatable.dart';
import 'package:wyatt_architecture/wyatt_architecture.dart';
/// {@template i18n_file}
/// Data structure for i18n files.
/// {@endtemplate}
class I18nFile extends Entity with EquatableMixin {
/// {@macro i18n_file}
const I18nFile({
required this.locale,
required this.unparsedData,
required this.data,
}) : super();
/// Creates an empty i18n file.
const I18nFile.empty() : this(locale: '', unparsedData: '', data: const {});
/// The locale of the i18n file.
final String locale;
/// The unparsed data of the i18n file.
final String unparsedData;
/// The data of the i18n file.
final Map<String, dynamic> data;
/// Checks if the i18n file contains a key.
bool containsKey(String key) => data.containsKey(key);
/// Gets the value of a key.
dynamic operator [](String key) => data[key];
/// Checks if the i18n file is empty.
bool get isEmpty => data.isEmpty && unparsedData.isEmpty && locale.isEmpty;
@override
List<Object?> get props => [locale, unparsedData, data];
}

View File

@ -0,0 +1,52 @@
// Copyright (C) 2023 WYATT GROUP
// Please see the AUTHORS file for details.
//
// 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
// 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 <https://www.gnu.org/licenses/>.
enum TokenType { literal, argument, plural, gender, select }
class Token {
Token(this.type, this.value);
TokenType type;
String value;
}
class Option {
Option(this.name, this.value);
String name;
List<Token> value;
}
class Literal extends Token {
Literal(String value) : super(TokenType.literal, value);
}
class Argument extends Token {
Argument(String value) : super(TokenType.argument, value);
}
class Gender extends Token {
Gender(String value, this.options) : super(TokenType.gender, value);
List<Option> options;
}
class Plural extends Token {
Plural(String value, this.options) : super(TokenType.plural, value);
List<Option> options;
}
class Select extends Token {
Select(String value, this.options) : super(TokenType.select, value);
List<Option> options;
}

View File

@ -0,0 +1,77 @@
// Copyright (C) 2023 WYATT GROUP
// Please see the AUTHORS file for details.
//
// 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
// 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 <https://www.gnu.org/licenses/>.
import 'package:wyatt_architecture/wyatt_architecture.dart';
import 'package:wyatt_i18n/src/core/utils/parser.dart';
import 'package:wyatt_i18n/src/domain/entities/i18n_file.dart';
import 'package:wyatt_type_utils/wyatt_type_utils.dart';
/// {@template i18n_repository}
/// Base class for i18n repositories.
///
/// This class is used to manage i18n files.
/// {@endtemplate}
abstract class I18nRepository extends BaseRepository {
/// {@macro i18n_repository}
const I18nRepository() : super();
/// The current i18n file.
I18nFile get i18n;
/// Loads the i18n file from the source.
/// If [strict] is `true`, it will throw an NoLocaleException if the
/// `@@locale` key is not found in the i18n file, otherwise it will
/// set the locale to the given [locale].
/// If [parser] is not `null`, it will use the given parser to parse
/// the i18n file. Otherwise, it will use the default parser for the format.
FutureOrResult<I18nFile> load({
required String? locale,
bool strict = false,
Parser<String, Map<String, dynamic>>? parser,
});
/// Loads the i18n file from the given [uri].
/// If [parser] is not `null`, it will use the given parser to parse
/// the i18n file. Otherwise, it will use the default parser for the format.
FutureOrResult<I18nFile> loadFrom(
Uri uri, {
Parser<String, Map<String, dynamic>>? parser,
});
/// Gets the translation for the given [key].
///
/// If [arguments] is not `null`, it will replace the placeholders in the
/// translation with the given arguments.
Result<String, AppException> get(
String key, [
Map<String, dynamic> arguments = const {},
]);
/// Sets the current i18n instance.
///
/// This method is used to set the current i18n instance.
Result<void, AppException> setI18n(I18nFile i18n);
/// Gets the current i18n instance.
///
/// This method is used to get the current i18n instance.
Result<I18nFile, AppException> getI18n();
/// Gets the current locale.
///
/// This method is used to get the current locale.
Result<String, AppException> getLocale();
}

View File

@ -0,0 +1,51 @@
// Copyright (C) 2023 WYATT GROUP
// Please see the AUTHORS file for details.
//
// 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
// 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 <https://www.gnu.org/licenses/>.
import 'package:flutter/cupertino.dart';
import 'package:wyatt_i18n/wyatt_i18n.dart';
/// {@template i18n_delegate}
/// A [LocalizationsDelegate] that loads the [I18n] instance.
/// {@endtemplate}
class I18nDelegate extends LocalizationsDelegate<I18n> {
/// {@macro i18n_delegate}
I18nDelegate({
required this.repository,
});
/// The [I18nRepository] that will be used to load the i18n file.
final I18nRepository repository;
/// The current locale.
Locale? currentLocale;
/// Since we are using the [I18nRepository] to load the i18n file,
/// we don't need to check if the locale is supported.
/// We can just return `true`.
@override
bool isSupported(Locale locale) => true;
@override
Future<I18n> load(Locale locale) async {
await repository.load(locale: locale.languageCode);
return I18n(i18nRepository: repository);
}
@override
bool shouldReload(I18nDelegate old) =>
currentLocale != null || currentLocale != old.currentLocale;
}

View File

@ -0,0 +1,20 @@
// Copyright (C) 2023 WYATT GROUP
// Please see the AUTHORS file for details.
//
// 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
// 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 <https://www.gnu.org/licenses/>.
export 'core/core.dart';
export 'data/data.dart';
export 'domain/domain.dart';
export 'presentation/i18n_delegate.dart';

View File

@ -0,0 +1,22 @@
// Copyright (C) 2023 WYATT GROUP
// Please see the AUTHORS file for details.
//
// 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
// 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 <https://www.gnu.org/licenses/>.
/// This package aims to facilitate and improve the internationalization of
/// your applications. It allows, among other things, to load translation
/// files on the fly during the execution of the application.
library wyatt_i18n;
export 'src/src.dart';

View File

@ -0,0 +1,45 @@
name: wyatt_i18n
description: A package by wyatt studio.
repository: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages/src/branch/master/packages/wyatt_i18n
version: 1.0.0
environment:
sdk: ">=2.19.0 <3.0.0"
dependencies:
collection: ^1.17.0
equatable: ^2.0.5
flutter: {sdk: flutter}
flutter_bloc: ^8.1.2
flutter_localizations: {sdk: flutter}
http: ^0.13.5
intl: ^0.17.0
path: ^1.8.0
petitparser: ^5.1.0
wyatt_architecture:
hosted:
url: https://git.wyatt-studio.fr/api/packages/Wyatt-FOSS/pub/
name: wyatt_architecture
version: 0.1.0+1
wyatt_bloc_helper:
hosted:
url: https://git.wyatt-studio.fr/api/packages/Wyatt-FOSS/pub/
name: wyatt_bloc_helper
version: 2.0.0
wyatt_type_utils:
hosted:
url: https://git.wyatt-studio.fr/api/packages/Wyatt-FOSS/pub/
name: wyatt_type_utils
version: 0.0.4
yaml: ^3.1.1
dev_dependencies:
flutter_test: {sdk: flutter}
dart_code_metrics: ^5.5.1
wyatt_analysis:
hosted: https://git.wyatt-studio.fr/api/packages/Wyatt-FOSS/pub
version: ^2.4.1
# The following section is specific to Flutter.
flutter:
uses-material-design: true

View File

@ -0,0 +1,23 @@
/// The i18n works as follows:
/// 1. The i18n file is loaded from a source.
/// - The i18n file is loaded from the assets folder.
/// - The i18n file can be in json, yaml or ARB format.
/// - The i18n file must contain a `@@locale` key with the locale code.
/// - The i18n file must be named `i18n.<locale>.<extension>`.
/// - The i18n file is loaded from a network source.
/// - The i18n file can be in json, yaml or ARB format.
/// - The i18n file must contain a `@@locale` key with the locale code.
/// - The assets folder must contain a `i18n.<locale>.<extension>` or
/// `i18n.<extension>` files used as a fallback.
/// 2. The i18n file is parsed and the locale is extracted.
/// 3. The i18n file is added to the i18n map.
/// 4. The i18n map is provided to the app.
///
/// The i18n map can be reloaded by calling the `reload` method.
/// This will reload the i18n file from the source and update the i18n map.
/// And update any widgets that are listening to the i18n map.
///
/// A top level BLoC is used to provide the i18n map to the app.
void main() {
}