feat: move a card between statuses #3
22 changed files with 2802 additions and 2 deletions
2
.gitignore
vendored
Normal file
2
.gitignore
vendored
Normal file
|
@ -0,0 +1,2 @@
|
|||
/test/databases/*.db
|
||||
/canal
|
35
.golangci.yaml
Normal file
35
.golangci.yaml
Normal file
|
@ -0,0 +1,35 @@
|
|||
---
|
||||
run:
|
||||
concurrency: 2
|
||||
timeout: 1m
|
||||
issues-exit-code: 1
|
||||
tests: true
|
||||
|
||||
output:
|
||||
format: colored-line-number
|
||||
print-issues-lines: true
|
||||
print-linter-name: true
|
||||
uniq-by-line: true
|
||||
sort-results: true
|
||||
|
||||
linters-settings:
|
||||
exhaustivestruct:
|
||||
struct-patterns:
|
||||
- 'forge.dananglin.me.uk/code/dananglin/pelican.Status'
|
||||
- 'forge.dananglin.me.uk/code/dananglin/pelican.Card'
|
||||
lll:
|
||||
line-length: 140
|
||||
testpackage:
|
||||
skip-regexp: (internal)_test\.go
|
||||
|
||||
linters:
|
||||
enable-all: true
|
||||
disable:
|
||||
- gomnd
|
||||
fast: false
|
||||
|
||||
issues:
|
||||
exclude-rules:
|
||||
- path: db_internal_test.go
|
||||
linters:
|
||||
- funlen
|
674
LICENSE
Normal file
674
LICENSE
Normal 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.
|
||||
|
||||
Canal
|
||||
Copyright (C) 2021 Dan Anglin
|
||||
|
||||
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:
|
||||
|
||||
Canal Copyright (C) 2021 Dan Anglin
|
||||
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>.
|
19
README.md
19
README.md
|
@ -1,3 +1,18 @@
|
|||
# pelican
|
||||
# Canal
|
||||
|
||||
A simple Kanban board for the terminal
|
||||
## Summary
|
||||
|
||||
Canal is a simple Kanban board for your terminal.
|
||||
|
||||
## Storage
|
||||
|
||||
Data is stored in a [BoltDB](https://github.com/etcd-io/bbolt) database.
|
||||
For Linux the default the database file is located at $XDG\_DATA\_HOME/canal/canal.db
|
||||
If $XDG\_DATA\_HOME is not set then the default location is $HOME/.local/share/canal/canal.db by default.
|
||||
For all other operating systems the default location is $HOME/.canal/canal.db.
|
||||
|
||||
## Keybindings
|
||||
|
||||
## Inspiration
|
||||
|
||||
[The toukan project](https://github.com/witchard/toukan).
|
||||
|
|
15
cmd/canal/main.go
Normal file
15
cmd/canal/main.go
Normal file
|
@ -0,0 +1,15 @@
|
|||
package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"codeflow.dananglin.me.uk/apollo/canal/internal/ui"
|
||||
)
|
||||
|
||||
func main() {
|
||||
canal := ui.NewUI()
|
||||
|
||||
if err := canal.Run(); err != nil {
|
||||
fmt.Printf("Error: an error occurred while running Canal, %s", err)
|
||||
}
|
||||
}
|
20
go.mod
Normal file
20
go.mod
Normal file
|
@ -0,0 +1,20 @@
|
|||
module codeflow.dananglin.me.uk/apollo/canal
|
||||
|
||||
go 1.20
|
||||
|
||||
require (
|
||||
github.com/gdamore/tcell/v2 v2.6.0
|
||||
github.com/magefile/mage v1.14.0
|
||||
github.com/rivo/tview v0.0.0-20230320095235-84f9c0ff9de8
|
||||
go.etcd.io/bbolt v1.3.7
|
||||
)
|
||||
|
||||
require (
|
||||
github.com/gdamore/encoding v1.0.0 // indirect
|
||||
github.com/lucasb-eyer/go-colorful v1.2.0 // indirect
|
||||
github.com/mattn/go-runewidth v0.0.14 // indirect
|
||||
github.com/rivo/uniseg v0.4.3 // indirect
|
||||
golang.org/x/sys v0.5.0 // indirect
|
||||
golang.org/x/term v0.5.0 // indirect
|
||||
golang.org/x/text v0.7.0 // indirect
|
||||
)
|
50
go.sum
Normal file
50
go.sum
Normal file
|
@ -0,0 +1,50 @@
|
|||
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
|
||||
github.com/gdamore/encoding v1.0.0 h1:+7OoQ1Bc6eTm5niUzBa0Ctsh6JbMW6Ra+YNuAtDBdko=
|
||||
github.com/gdamore/encoding v1.0.0/go.mod h1:alR0ol34c49FCSBLjhosxzcPHQbf2trDkoo5dl+VrEg=
|
||||
github.com/gdamore/tcell/v2 v2.6.0 h1:OKbluoP9VYmJwZwq/iLb4BxwKcwGthaa1YNBJIyCySg=
|
||||
github.com/gdamore/tcell/v2 v2.6.0/go.mod h1:be9omFATkdr0D9qewWW3d+MEvl5dha+Etb5y65J2H8Y=
|
||||
github.com/lucasb-eyer/go-colorful v1.2.0 h1:1nnpGOrhyZZuNyfu1QjKiUICQ74+3FNCN69Aj6K7nkY=
|
||||
github.com/lucasb-eyer/go-colorful v1.2.0/go.mod h1:R4dSotOR9KMtayYi1e77YzuveK+i7ruzyGqttikkLy0=
|
||||
github.com/magefile/mage v1.14.0 h1:6QDX3g6z1YvJ4olPhT1wksUcSa/V0a1B+pJb73fBjyo=
|
||||
github.com/magefile/mage v1.14.0/go.mod h1:z5UZb/iS3GoOSn0JgWuiw7dxlurVYTu+/jHXqQg881A=
|
||||
github.com/mattn/go-runewidth v0.0.14 h1:+xnbZSEeDbOIg5/mE6JF0w6n9duR1l3/WmbinWVwUuU=
|
||||
github.com/mattn/go-runewidth v0.0.14/go.mod h1:Jdepj2loyihRzMpdS35Xk/zdY8IAYHsh153qUoGf23w=
|
||||
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
|
||||
github.com/rivo/tview v0.0.0-20230320095235-84f9c0ff9de8 h1:wthS/rREJ6WlALtQ3Ysp4Cty/qiY2LNslV90U71bNg0=
|
||||
github.com/rivo/tview v0.0.0-20230320095235-84f9c0ff9de8/go.mod h1:nVwGv4MP47T0jvlk7KuTTjjuSmrGO4JF0iaiNt4bufE=
|
||||
github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc=
|
||||
github.com/rivo/uniseg v0.4.3 h1:utMvzDsuh3suAEnhH0RdHmoPbU648o6CvXxTx4SBMOw=
|
||||
github.com/rivo/uniseg v0.4.3/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88=
|
||||
github.com/stretchr/testify v1.8.1 h1:w7B6lhMri9wdJUVmEZPGGhZzrYTPvgJArz7wNPgYKsk=
|
||||
github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY=
|
||||
go.etcd.io/bbolt v1.3.7 h1:j+zJOnnEjF/kyHlDDgGnVL/AIqIJPq8UoB2GSNfkUfQ=
|
||||
go.etcd.io/bbolt v1.3.7/go.mod h1:N9Mkw9X8x5fupy0IKsmuqVtoGDyxsaDlbk4Rd05IAQw=
|
||||
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
|
||||
golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
|
||||
golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4=
|
||||
golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
|
||||
golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg=
|
||||
golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c=
|
||||
golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
||||
golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
||||
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
|
||||
golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||
golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||
golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||
golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||
golang.org/x/sys v0.5.0 h1:MUK/U/4lj1t1oPg0HfuXDN/Z1wv31ZJ/YcPiGccS4DU=
|
||||
golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||
golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
|
||||
golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
|
||||
golang.org/x/term v0.5.0 h1:n2a8QNdAb0sZNpU9R1ALUXBbY+w51fCQDN+7EdxNBsY=
|
||||
golang.org/x/term v0.5.0/go.mod h1:jMB1sMXY+tzblOD4FWmEbocvup2/aLOaQEp7JmGp78k=
|
||||
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
|
||||
golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
|
||||
golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
|
||||
golang.org/x/text v0.7.0 h1:4BRB4x83lYWy72KwLD/qYDuTu7q9PjSagHvijDw7cLo=
|
||||
golang.org/x/text v0.7.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8=
|
||||
golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
|
||||
golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
|
||||
golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc=
|
||||
golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
|
||||
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
|
312
internal/board/board.go
Normal file
312
internal/board/board.go
Normal file
|
@ -0,0 +1,312 @@
|
|||
package board
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"encoding/gob"
|
||||
"fmt"
|
||||
"sort"
|
||||
|
||||
"codeflow.dananglin.me.uk/apollo/canal/internal/database"
|
||||
bolt "go.etcd.io/bbolt"
|
||||
)
|
||||
|
||||
type Board struct {
|
||||
db *bolt.DB
|
||||
}
|
||||
|
||||
// Open reads the board from the database.
|
||||
// If no board exists then a new one will be created.
|
||||
func Open(path string) (Board, error) {
|
||||
db, err := database.OpenDatabase(path)
|
||||
if err != nil {
|
||||
return Board{}, fmt.Errorf("unable to open the database, %w", err)
|
||||
}
|
||||
|
||||
board := Board{
|
||||
db: db,
|
||||
}
|
||||
|
||||
statusList, err := board.StatusList()
|
||||
if err != nil {
|
||||
return Board{}, err
|
||||
}
|
||||
|
||||
if len(statusList) == 0 {
|
||||
newStatusList := defaultStatusList()
|
||||
|
||||
boltItems := make([]database.BoltItem, len(newStatusList))
|
||||
|
||||
for i := range newStatusList {
|
||||
boltItems[i] = &newStatusList[i]
|
||||
}
|
||||
|
||||
if _, err := database.WriteMany(db, database.StatusBucket, boltItems); err != nil {
|
||||
return Board{}, fmt.Errorf("unable to save the default status list to the database, %w", err)
|
||||
}
|
||||
}
|
||||
|
||||
return board, nil
|
||||
}
|
||||
|
||||
// Close closes the project's Kanban board.
|
||||
func (b *Board) Close() error {
|
||||
if b.db == nil {
|
||||
return nil
|
||||
}
|
||||
|
||||
if err := b.db.Close(); err != nil {
|
||||
return fmt.Errorf("error closing the database, %w", err)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// StatusList returns the ordered list of statuses from the database.
|
||||
func (b *Board) StatusList() ([]Status, error) {
|
||||
data, err := database.ReadAll(b.db, database.StatusBucket)
|
||||
if err != nil {
|
||||
return []Status{}, fmt.Errorf("unable to read the status list, %w", err)
|
||||
}
|
||||
|
||||
statuses := make([]Status, len(data))
|
||||
|
||||
for ind, d := range data {
|
||||
buf := bytes.NewBuffer(d)
|
||||
|
||||
decoder := gob.NewDecoder(buf)
|
||||
|
||||
var status Status
|
||||
|
||||
if err := decoder.Decode(&status); err != nil {
|
||||
return []Status{}, fmt.Errorf("unable to decode data, %w", err)
|
||||
}
|
||||
|
||||
statuses[ind] = status
|
||||
}
|
||||
|
||||
sort.Sort(ByStatusOrder(statuses))
|
||||
|
||||
return statuses, nil
|
||||
}
|
||||
|
||||
// Status returns a single status from the database.
|
||||
func (b *Board) Status(id int) (Status, error) {
|
||||
data, err := database.Read(b.db, database.StatusBucket, id)
|
||||
if err != nil {
|
||||
return Status{}, fmt.Errorf("unable to read status [%d] from the database, %w", id, err)
|
||||
}
|
||||
|
||||
var status Status
|
||||
|
||||
buf := bytes.NewBuffer(data)
|
||||
|
||||
decoder := gob.NewDecoder(buf)
|
||||
|
||||
if err := decoder.Decode(&status); err != nil {
|
||||
return Status{}, fmt.Errorf("unable to decode data into a Status object, %w", err)
|
||||
}
|
||||
|
||||
return status, nil
|
||||
}
|
||||
|
||||
type StatusArgs struct {
|
||||
Name string
|
||||
Order int
|
||||
}
|
||||
|
||||
// CreateStatus creates a status in the database.
|
||||
func (b *Board) CreateStatus(args StatusArgs) error {
|
||||
status := Status{
|
||||
ID: -1,
|
||||
Name: args.Name,
|
||||
Order: args.Order,
|
||||
CardIds: nil,
|
||||
}
|
||||
|
||||
if _, err := database.Write(b.db, database.StatusBucket, &status); err != nil {
|
||||
return fmt.Errorf("unable to write the status to the database, %w", err)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
type UpdateStatusArgs struct {
|
||||
StatusID int
|
||||
StatusArgs
|
||||
}
|
||||
|
||||
// UpdateStatus modifies an existing status in the database.
|
||||
func (b *Board) UpdateStatus(args UpdateStatusArgs) error {
|
||||
status, err := b.Status(args.StatusID)
|
||||
if err != nil {
|
||||
return fmt.Errorf("unable to retrieve the status from the database, %w", err)
|
||||
}
|
||||
|
||||
if len(args.Name) > 0 {
|
||||
status.Name = args.Name
|
||||
}
|
||||
|
||||
if args.Order > 0 {
|
||||
status.Order = args.Order
|
||||
}
|
||||
|
||||
if _, err := database.Write(b.db, database.StatusBucket, &status); err != nil {
|
||||
return fmt.Errorf("unable to write the status to the database, %w", err)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// TODO: Finish implementation.
|
||||
// func (b *Board) DeleteStatus() error {
|
||||
// return nil
|
||||
// }
|
||||
|
||||
type MoveToStatusArgs struct {
|
||||
CardID int
|
||||
CurrentStatusID int
|
||||
NextStatusID int
|
||||
}
|
||||
|
||||
// MoveToStatus moves a card between statuses.
|
||||
func (b *Board) MoveToStatus(args MoveToStatusArgs) error {
|
||||
currentStatus, err := b.Status(args.CurrentStatusID)
|
||||
if err != nil {
|
||||
return fmt.Errorf("unable to get the card's current status [%d], %w", args.CurrentStatusID, err)
|
||||
}
|
||||
|
||||
nextStatus, err := b.Status(args.NextStatusID)
|
||||
if err != nil {
|
||||
return fmt.Errorf("unable to get the card's next status [%d], %w", args.NextStatusID, err)
|
||||
}
|
||||
|
||||
nextStatus.AddCardID(args.CardID)
|
||||
currentStatus.RemoveCardID(args.CardID)
|
||||
|
||||
boltItems := []database.BoltItem{¤tStatus, &nextStatus}
|
||||
|
||||
if _, err := database.WriteMany(b.db, database.StatusBucket, boltItems); err != nil {
|
||||
return fmt.Errorf("unable to update the statuses in the database, %w", err)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
type CardArgs struct {
|
||||
NewTitle string
|
||||
NewContent string
|
||||
}
|
||||
|
||||
// CreateCard creates a card in the database.
|
||||
func (b *Board) CreateCard(args CardArgs) (int, error) {
|
||||
statusList, err := b.StatusList()
|
||||
if err != nil {
|
||||
return 0, fmt.Errorf("unable to read the status list, %w", err)
|
||||
}
|
||||
|
||||
if len(statusList) == 0 {
|
||||
return 0, statusListEmptyError{}
|
||||
}
|
||||
|
||||
card := Card{
|
||||
ID: -1,
|
||||
Title: args.NewTitle,
|
||||
Content: args.NewContent,
|
||||
}
|
||||
|
||||
cardID, err := database.Write(b.db, database.CardBucket, &card)
|
||||
if err != nil {
|
||||
return 0, fmt.Errorf("unable to write card to the database, %w", err)
|
||||
}
|
||||
|
||||
initialStatus := statusList[0]
|
||||
|
||||
initialStatus.AddCardID(cardID)
|
||||
|
||||
id, err := database.Write(b.db, database.StatusBucket, &initialStatus)
|
||||
if err != nil {
|
||||
return 0, fmt.Errorf("unable to write the %s status to the database, %w", initialStatus.Name, err)
|
||||
}
|
||||
|
||||
return id, nil
|
||||
}
|
||||
|
||||
// Card returns a Card value from the database.
|
||||
func (b *Board) Card(id int) (Card, error) {
|
||||
data, err := database.Read(b.db, database.CardBucket, id)
|
||||
if err != nil {
|
||||
return Card{}, fmt.Errorf("unable to read card [%d] from the database, %w", id, err)
|
||||
}
|
||||
|
||||
var card Card
|
||||
|
||||
buf := bytes.NewBuffer(data)
|
||||
|
||||
decoder := gob.NewDecoder(buf)
|
||||
|
||||
if err := decoder.Decode(&card); err != nil {
|
||||
return Card{}, fmt.Errorf("unable to decode data, %w", err)
|
||||
}
|
||||
|
||||
return card, nil
|
||||
}
|
||||
|
||||
// CardList returns a list of Card values from the database.
|
||||
// TODO: function needs testing.
|
||||
func (b *Board) CardList(ids []int) ([]Card, error) {
|
||||
data, err := database.ReadMany(b.db, database.CardBucket, ids)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("unable to read card list from the database, %w", err)
|
||||
}
|
||||
|
||||
cards := make([]Card, len(data))
|
||||
|
||||
for ind, d := range data {
|
||||
buf := bytes.NewBuffer(d)
|
||||
|
||||
decoder := gob.NewDecoder(buf)
|
||||
|
||||
var card Card
|
||||
|
||||
if err := decoder.Decode(&card); err != nil {
|
||||
return nil, fmt.Errorf("unable to decode data, %w", err)
|
||||
}
|
||||
|
||||
cards[ind] = card
|
||||
}
|
||||
|
||||
return cards, nil
|
||||
}
|
||||
|
||||
type UpdateCardArgs struct {
|
||||
CardID int
|
||||
CardArgs
|
||||
}
|
||||
|
||||
// UpdateCard modifies an existing card in the database.
|
||||
func (b *Board) UpdateCard(args UpdateCardArgs) error {
|
||||
card, err := b.Card(args.CardID)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if len(args.NewTitle) > 0 {
|
||||
card.Title = args.NewTitle
|
||||
}
|
||||
|
||||
if len(args.NewContent) > 0 {
|
||||
card.Content = args.NewContent
|
||||
}
|
||||
|
||||
if _, err := database.Write(b.db, database.CardBucket, &card); err != nil {
|
||||
return fmt.Errorf("unable to write card to the database, %w", err)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// DeleteCard deletes a card from the database.
|
||||
// TODO: finish implementation.
|
||||
//func (b *Board) DeleteCard(id int) error {
|
||||
// return nil
|
||||
//}
|
18
internal/board/card.go
Normal file
18
internal/board/card.go
Normal file
|
@ -0,0 +1,18 @@
|
|||
package board
|
||||
|
||||
// Card represents a card on a Kanban board.
|
||||
type Card struct {
|
||||
ID int
|
||||
Title string
|
||||
Content string
|
||||
}
|
||||
|
||||
// UpdateId updates the ID of the Card value.
|
||||
func (c *Card) UpdateId(id int) {
|
||||
c.ID = id
|
||||
}
|
||||
|
||||
// Id returns the ID of the Card value.
|
||||
func (c *Card) Id() int {
|
||||
return c.ID
|
||||
}
|
177
internal/board/card_lifecycle_test.go
Normal file
177
internal/board/card_lifecycle_test.go
Normal file
|
@ -0,0 +1,177 @@
|
|||
package board_test
|
||||
|
||||
import (
|
||||
"os"
|
||||
"path/filepath"
|
||||
"reflect"
|
||||
"testing"
|
||||
|
||||
"codeflow.dananglin.me.uk/apollo/canal/internal/board"
|
||||
)
|
||||
|
||||
func TestCardLifecycle(t *testing.T) {
|
||||
t.Log("Testing the lifecycle of a card.")
|
||||
|
||||
projectDir, err := projectRoot()
|
||||
if err != nil {
|
||||
t.Fatalf(err.Error())
|
||||
}
|
||||
|
||||
testDBPath := filepath.Join(projectDir, "test", "databases", "Board_TestCardLifecycle.db")
|
||||
os.Remove(testDBPath)
|
||||
|
||||
b, err := board.Open(testDBPath)
|
||||
if err != nil {
|
||||
t.Fatalf("Unable to open the test Kanban board, %s.", err)
|
||||
}
|
||||
|
||||
defer func() {
|
||||
_ = b.Close()
|
||||
}()
|
||||
|
||||
initialCardTitle := "A test card."
|
||||
initialCardContent := "Ensure that this card is safely stored in the database."
|
||||
expectedCardID := 1
|
||||
|
||||
t.Run("Test Create Card", testCreateCard(b, initialCardTitle, initialCardContent, expectedCardID))
|
||||
|
||||
t.Run("Test Read Card", testReadCard(b, expectedCardID, initialCardTitle, initialCardContent))
|
||||
|
||||
modifiedCardTitle := "Test card updated."
|
||||
modifiedCardContent1 := "Ensure that this card is safely updated in the database."
|
||||
|
||||
t.Run("Test Update Card", testUpdateCard(b, expectedCardID, modifiedCardTitle, modifiedCardContent1))
|
||||
|
||||
modifiedCardContent2 := "Updated card content only."
|
||||
|
||||
t.Run("Test Update Card Content", testUpdateCardContent(b, expectedCardID, modifiedCardTitle, modifiedCardContent2))
|
||||
}
|
||||
|
||||
func testCreateCard(b board.Board, title, content string, wantID int) func(t *testing.T) {
|
||||
return func(t *testing.T) {
|
||||
t.Log("When the card is created and saved to the database.")
|
||||
|
||||
args := board.CardArgs{
|
||||
NewTitle: title,
|
||||
NewContent: content,
|
||||
}
|
||||
|
||||
if _, err := b.CreateCard(args); err != nil {
|
||||
t.Fatalf("ERROR: Unable to create the test card, %s.", err)
|
||||
}
|
||||
|
||||
statusList, err := b.StatusList()
|
||||
if err != nil {
|
||||
t.Fatalf("ERROR: Unable to run `ReadStatusList`, %s.", err)
|
||||
}
|
||||
|
||||
if len(statusList) == 0 {
|
||||
t.Fatal("ERROR: The status list appears to be empty.")
|
||||
}
|
||||
|
||||
cardIDs := statusList[0].CardIds
|
||||
|
||||
if len(cardIDs) != 1 {
|
||||
t.Fatalf("ERROR: Unexpected number of cards in the default status, want: %d, got %d.", 1, len(cardIDs))
|
||||
}
|
||||
|
||||
if gotID := cardIDs[0]; wantID != gotID {
|
||||
t.Errorf("%s\tUnexpected card ID found in the default status, want: %d, got %d.", failure, wantID, gotID)
|
||||
} else {
|
||||
t.Logf("%s\tExpected card ID found in the default status, got %d.", success, gotID)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func testReadCard(b board.Board, cardID int, wantTitle, wantContent string) func(t *testing.T) {
|
||||
return func(t *testing.T) {
|
||||
t.Log("When a card is read from the database.")
|
||||
|
||||
card, err := b.Card(cardID)
|
||||
if err != nil {
|
||||
t.Fatalf("ERROR: Unable to read test card, %s.", err)
|
||||
}
|
||||
|
||||
if card.Title != wantTitle {
|
||||
t.Errorf("%s\tUnexpected card title received, want: %s, got: %s.", failure, wantTitle, card.Title)
|
||||
} else {
|
||||
t.Logf("%s\tExpected card title received, got: %s.", success, card.Title)
|
||||
}
|
||||
|
||||
if card.Content != wantContent {
|
||||
t.Errorf("%s\tUnexpected card content received, want: %s, got: %s.", failure, wantContent, card.Content)
|
||||
} else {
|
||||
t.Logf("%s\tExpected card content received, got: %s.", success, card.Content)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func testUpdateCard(b board.Board, cardID int, newTitle, newContent string) func(t *testing.T) {
|
||||
return func(t *testing.T) {
|
||||
t.Log("When a card is updated in the database.")
|
||||
|
||||
args := board.UpdateCardArgs{
|
||||
CardID: cardID,
|
||||
CardArgs: board.CardArgs{
|
||||
NewTitle: newTitle,
|
||||
NewContent: newContent,
|
||||
},
|
||||
}
|
||||
|
||||
if err := b.UpdateCard(args); err != nil {
|
||||
t.Fatalf("ERROR: Unable to update the test card, %s", err)
|
||||
}
|
||||
|
||||
got, err := b.Card(cardID)
|
||||
if err != nil {
|
||||
t.Fatalf("ERROR: Unable to read the modified test card, %s", err)
|
||||
}
|
||||
|
||||
want := board.Card{
|
||||
ID: cardID,
|
||||
Title: newTitle,
|
||||
Content: newContent,
|
||||
}
|
||||
|
||||
if !reflect.DeepEqual(got, want) {
|
||||
t.Errorf("%s\tUnexpected card read from the database: want %+v, got %+v", failure, want, got)
|
||||
} else {
|
||||
t.Logf("%s\tExpected card read from the database: got %+v", success, got)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func testUpdateCardContent(b board.Board, cardID int, expectedTitle, newContent string) func(t *testing.T) {
|
||||
return func(t *testing.T) {
|
||||
t.Log("When (and only when) a card's content is updated in the database.")
|
||||
|
||||
args := board.UpdateCardArgs{
|
||||
CardID: cardID,
|
||||
CardArgs: board.CardArgs{
|
||||
NewTitle: "",
|
||||
NewContent: newContent,
|
||||
},
|
||||
}
|
||||
|
||||
if err := b.UpdateCard(args); err != nil {
|
||||
t.Fatalf("ERROR: Unable to update the test card, %s", err)
|
||||
}
|
||||
|
||||
got, err := b.Card(cardID)
|
||||
if err != nil {
|
||||
t.Fatalf("ERROR: Unable to read the modified test card, %s", err)
|
||||
}
|
||||
|
||||
want := board.Card{
|
||||
ID: cardID,
|
||||
Title: expectedTitle,
|
||||
Content: newContent,
|
||||
}
|
||||
|
||||
if !reflect.DeepEqual(got, want) {
|
||||
t.Errorf("%s\tUnexpected card read from the database, want: %+v, got: %+v", failure, want, got)
|
||||
} else {
|
||||
t.Logf("%s\tExpected card read from the database, got: %+v", success, got)
|
||||
}
|
||||
}
|
||||
}
|
7
internal/board/errors.go
Normal file
7
internal/board/errors.go
Normal file
|
@ -0,0 +1,7 @@
|
|||
package board
|
||||
|
||||
type statusListEmptyError struct{}
|
||||
|
||||
func (e statusListEmptyError) Error() string {
|
||||
return "the status list must not be empty"
|
||||
}
|
21
internal/board/helpers_test.go
Normal file
21
internal/board/helpers_test.go
Normal file
|
@ -0,0 +1,21 @@
|
|||
package board_test
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"os"
|
||||
"path/filepath"
|
||||
)
|
||||
|
||||
const (
|
||||
success = "\u2713"
|
||||
failure = "\u2717"
|
||||
)
|
||||
|
||||
func projectRoot() (string, error) {
|
||||
cwd, err := os.Getwd()
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("unable to get the current working directory, %w", err)
|
||||
}
|
||||
|
||||
return filepath.Join(cwd, "..", ".."), nil
|
||||
}
|
119
internal/board/status.go
Normal file
119
internal/board/status.go
Normal file
|
@ -0,0 +1,119 @@
|
|||
package board
|
||||
|
||||
import (
|
||||
"sort"
|
||||
)
|
||||
|
||||
// Status represents the status of the Kanban board.
|
||||
type Status struct {
|
||||
ID int
|
||||
Name string
|
||||
CardIds []int
|
||||
Order int
|
||||
}
|
||||
|
||||
// UpdateId updates the ID of the Status value.
|
||||
func (s *Status) UpdateId(id int) {
|
||||
s.ID = id
|
||||
}
|
||||
|
||||
// Id returns the ID of the Status value.
|
||||
func (s *Status) Id() int {
|
||||
return s.ID
|
||||
}
|
||||
|
||||
// AddCardID adds a card ID to the status' list of card IDs.
|
||||
func (s *Status) AddCardID(cardID int) {
|
||||
// Create a new list if it does not exist
|
||||
// and then return.
|
||||
if s.CardIds == nil {
|
||||
s.CardIds = []int{cardID}
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
// Sort list if not sorted.
|
||||
if !sort.IntsAreSorted(s.CardIds) {
|
||||
sort.Ints(s.CardIds)
|
||||
}
|
||||
|
||||
// Get index of the card's ID if it already exists in the list.
|
||||
// Return if it already exists in the list
|
||||
ind := sort.SearchInts(s.CardIds, cardID)
|
||||
|
||||
if ind <= len(s.CardIds) && cardID == s.CardIds[ind] {
|
||||
return
|
||||
}
|
||||
|
||||
s.CardIds = append(s.CardIds, cardID)
|
||||
sort.Ints(s.CardIds)
|
||||
}
|
||||
|
||||
// RemoveCardID removes a card ID from the status' list of card IDs.
|
||||
func (s *Status) RemoveCardID(cardID int) {
|
||||
if s.CardIds == nil {
|
||||
return
|
||||
}
|
||||
|
||||
// Sort list if not sorted.
|
||||
if !sort.IntsAreSorted(s.CardIds) {
|
||||
sort.Ints(s.CardIds)
|
||||
}
|
||||
|
||||
// Get index of id.
|
||||
// If the card ID is somehow not in the list, then ind
|
||||
// will be the index where the id can be inserted.
|
||||
ind := sort.SearchInts(s.CardIds, cardID)
|
||||
|
||||
if ind >= len(s.CardIds) || cardID != s.CardIds[ind] {
|
||||
return
|
||||
}
|
||||
|
||||
if len(s.CardIds) == 1 {
|
||||
s.CardIds = nil
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
// use append to eliminate the id from the new slice
|
||||
s.CardIds = append(s.CardIds[:ind], s.CardIds[ind+1:]...)
|
||||
}
|
||||
|
||||
// ByStatusOrder implements sort.Interface for []Status based on the Order field.
|
||||
type ByStatusOrder []Status
|
||||
|
||||
func (s ByStatusOrder) Len() int {
|
||||
return len(s)
|
||||
}
|
||||
|
||||
func (s ByStatusOrder) Swap(i, j int) {
|
||||
s[i], s[j] = s[j], s[i]
|
||||
}
|
||||
|
||||
func (s ByStatusOrder) Less(i, j int) bool {
|
||||
return s[i].Order < s[j].Order
|
||||
}
|
||||
|
||||
// defaultStatusList returns the default list of statuses.
|
||||
func defaultStatusList() []Status {
|
||||
return []Status{
|
||||
{
|
||||
ID: -1,
|
||||
Name: "To Do",
|
||||
Order: 1,
|
||||
CardIds: nil,
|
||||
},
|
||||
{
|
||||
ID: -1,
|
||||
Name: "Doing",
|
||||
Order: 2,
|
||||
CardIds: nil,
|
||||
},
|
||||
{
|
||||
ID: -1,
|
||||
Name: "Done",
|
||||
Order: 3,
|
||||
CardIds: nil,
|
||||
},
|
||||
}
|
||||
}
|
192
internal/board/status_lifecycle_test.go
Normal file
192
internal/board/status_lifecycle_test.go
Normal file
|
@ -0,0 +1,192 @@
|
|||
package board_test
|
||||
|
||||
import (
|
||||
"os"
|
||||
"path/filepath"
|
||||
"reflect"
|
||||
"testing"
|
||||
|
||||
"codeflow.dananglin.me.uk/apollo/canal/internal/board"
|
||||
)
|
||||
|
||||
func TestStatusLifecycle(t *testing.T) {
|
||||
t.Log("Testing the lifecycle of a status.")
|
||||
|
||||
projectDir, err := projectRoot()
|
||||
if err != nil {
|
||||
t.Fatalf(err.Error())
|
||||
}
|
||||
|
||||
testDBPath := filepath.Join(projectDir, "test", "databases", "Board_TestStatusLifecycle.db")
|
||||
os.Remove(testDBPath)
|
||||
|
||||
kanban, err := board.Open(testDBPath)
|
||||
if err != nil {
|
||||
t.Fatalf("Unable to open the test Kanban board, %s.", err)
|
||||
}
|
||||
|
||||
defer func() {
|
||||
_ = kanban.Close()
|
||||
}()
|
||||
|
||||
// We've opened a new board with the default list of statuses: To Do, Doing, Done
|
||||
statusOnHoldName := "On Hold"
|
||||
statusOnHoldExpectedID := 4
|
||||
statusOnHoldOrder := 4
|
||||
|
||||
t.Run("Test Create Status", testCreateStatus(kanban, statusOnHoldName, statusOnHoldOrder))
|
||||
|
||||
t.Run("Test Read Status", testReadStatus(kanban, statusOnHoldExpectedID, statusOnHoldName))
|
||||
|
||||
t.Run("Test Status Update", testUpdateStatus(kanban, 2, "In Progress"))
|
||||
// Rearrange the board so the order is To Do, On Hold, In Progress, Done
|
||||
// Move a Card ID from To Do to In Progress
|
||||
t.Run("Test Move Card To Status", testMoveCardToStatus(kanban))
|
||||
}
|
||||
|
||||
func testCreateStatus(b board.Board, name string, order int) func(t *testing.T) {
|
||||
return func(t *testing.T) {
|
||||
t.Log("When the status is created and saved to the database.")
|
||||
|
||||
args := board.StatusArgs{
|
||||
Name: name,
|
||||
Order: order,
|
||||
}
|
||||
|
||||
if err := b.CreateStatus(args); err != nil {
|
||||
t.Fatalf("ERROR: Unable to create the new status, %v.", err)
|
||||
}
|
||||
|
||||
t.Logf("%s\tStatus '%s' was successfully saved to the database.", success, name)
|
||||
}
|
||||
}
|
||||
|
||||
func testReadStatus(b board.Board, statusID int, wantName string) func(t *testing.T) {
|
||||
return func(t *testing.T) {
|
||||
t.Log("When the status is read from the database.")
|
||||
|
||||
status, err := b.Status(statusID)
|
||||
if err != nil {
|
||||
t.Fatalf("ERROR: Unable to read the test status, %v", err)
|
||||
}
|
||||
|
||||
if status.Name != wantName {
|
||||
t.Errorf("%s\tUnexpected status received from the database, want: '%s', got: '%s'", failure, wantName, status.Name)
|
||||
} else {
|
||||
t.Logf("%s\tSuccessfully received the '%s' status from the database.", success, status.Name)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func testUpdateStatus(kanban board.Board, statusID int, newName string) func(t *testing.T) {
|
||||
return func(t *testing.T) {
|
||||
t.Log("When the status' name is updated in the database.")
|
||||
|
||||
args := board.UpdateStatusArgs{
|
||||
StatusID: statusID,
|
||||
StatusArgs: board.StatusArgs{
|
||||
Name: newName,
|
||||
Order: -1,
|
||||
},
|
||||
}
|
||||
if err := kanban.UpdateStatus(args); err != nil {
|
||||
t.Fatalf("ERROR: Unable to update the status, %v", err)
|
||||
} else {
|
||||
t.Logf("%s\tStatus successfully updated.", success)
|
||||
}
|
||||
|
||||
t.Log("Verifying the new status.")
|
||||
|
||||
status, err := kanban.Status(statusID)
|
||||
if err != nil {
|
||||
t.Fatalf("ERROR: Unable to retrieve the status from the database, %v", err)
|
||||
}
|
||||
|
||||
want := board.Status{
|
||||
ID: statusID,
|
||||
Name: newName,
|
||||
CardIds: nil,
|
||||
Order: 2,
|
||||
}
|
||||
|
||||
if !reflect.DeepEqual(status, want) {
|
||||
t.Errorf("%s\tUnexpected status received from the database, want: %+v, got: %+v", failure, want, status)
|
||||
} else {
|
||||
t.Logf("%s\tExpected status name received from the database, got: %+v", success, status)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// func testRearrangeBoard() func(t *testing.T) {
|
||||
// return func(t *testing.T) {
|
||||
// }
|
||||
// }
|
||||
|
||||
func testMoveCardToStatus(b board.Board) func(t *testing.T) {
|
||||
return func(t *testing.T) {
|
||||
t.Log("When moving a card between statuses.")
|
||||
|
||||
title := "Test card."
|
||||
|
||||
cardArgs := board.CardArgs{
|
||||
NewTitle: title,
|
||||
NewContent: "",
|
||||
}
|
||||
|
||||
cardID, err := b.CreateCard(cardArgs)
|
||||
if err != nil {
|
||||
t.Fatalf("ERROR: Unable to create the card in the database, %v", err)
|
||||
}
|
||||
|
||||
statusList, err := b.StatusList()
|
||||
if err != nil {
|
||||
t.Fatalf("ERROR: Unable to retrieve the list of statuses from the database, %v", err)
|
||||
}
|
||||
|
||||
status0 := statusList[0]
|
||||
status2 := statusList[2]
|
||||
|
||||
moveArgs := board.MoveToStatusArgs{
|
||||
CardID: cardID,
|
||||
CurrentStatusID: status0.ID,
|
||||
NextStatusID: status2.ID,
|
||||
}
|
||||
|
||||
if err := b.MoveToStatus(moveArgs); err != nil {
|
||||
t.Fatalf("ERROR: Unable to move the Card ID from '%s' to '%s', %v", status0.Name, status2.Name, err)
|
||||
}
|
||||
|
||||
t.Logf("Verifying that the card has moved to '%s'", status2.Name)
|
||||
|
||||
statusList, err = b.StatusList()
|
||||
if err != nil {
|
||||
t.Fatalf("ERROR: Unable to retrieve the list of statuses from the database, %v", err)
|
||||
}
|
||||
|
||||
status0 = statusList[0]
|
||||
status2 = statusList[2]
|
||||
|
||||
if len(status0.CardIds) != 0 {
|
||||
t.Errorf("%s\tUnexpected number of card IDs found in '%s', want: 0, got: %d", failure, status0.Name, len(status0.CardIds))
|
||||
} else {
|
||||
t.Logf("%s\tThe number of card IDs in '%s' is now %d", success, status0.Name, len(status0.CardIds))
|
||||
}
|
||||
|
||||
if len(status2.CardIds) != 1 {
|
||||
t.Errorf("%s\tUnexpected number of card IDs found in '%s', want: 1, got: %d", failure, status2.Name, len(status2.CardIds))
|
||||
} else {
|
||||
t.Logf("%s\tThe number of card IDs in '%s' is now %d", success, status2.Name, len(status2.CardIds))
|
||||
}
|
||||
|
||||
card, err := b.Card(status2.CardIds[0])
|
||||
if err != nil {
|
||||
t.Fatalf("ERROR: Unable to retrieve the card from the database, %v", err)
|
||||
}
|
||||
|
||||
if card.Title != title {
|
||||
t.Errorf("%s\tUnexpected card title found in '%s', want: '%s', got: '%s'", success, status2.Name, title, card.Title)
|
||||
} else {
|
||||
t.Logf("%s\tExpected card title found in '%s', got: '%s'", success, status2.Name, card.Title)
|
||||
}
|
||||
}
|
||||
}
|
286
internal/database/database.go
Normal file
286
internal/database/database.go
Normal file
|
@ -0,0 +1,286 @@
|
|||
package database
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"encoding/gob"
|
||||
"fmt"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"runtime"
|
||||
"strconv"
|
||||
"time"
|
||||
|
||||
bolt "go.etcd.io/bbolt"
|
||||
)
|
||||
|
||||
const (
|
||||
StatusBucket string = "status"
|
||||
CardBucket string = "card"
|
||||
)
|
||||
|
||||
type BoltItem interface {
|
||||
UpdateId(int)
|
||||
Id() int
|
||||
}
|
||||
|
||||
// OpenDatabase opens the database, at a given path, for reading and writing.
|
||||
// If the file does not exist it will be created.
|
||||
func OpenDatabase(path string) (*bolt.DB, error) {
|
||||
var err error
|
||||
|
||||
path = dbPath(path)
|
||||
|
||||
if err = mkDataDir(path); err != nil {
|
||||
return nil, fmt.Errorf("unable to make the data directory, %w", err)
|
||||
}
|
||||
|
||||
opts := bolt.Options{
|
||||
Timeout: 1 * time.Second,
|
||||
}
|
||||
|
||||
var db *bolt.DB
|
||||
|
||||
if db, err = bolt.Open(path, 0o600, &opts); err != nil {
|
||||
return nil, fmt.Errorf("unable to open database at %s, %w", path, err)
|
||||
}
|
||||
|
||||
if err = ensureBuckets(db); err != nil {
|
||||
return nil, fmt.Errorf("unable to ensure the required buckets are in the database, %w", err)
|
||||
}
|
||||
|
||||
return db, nil
|
||||
}
|
||||
|
||||
// Read retrieves a Bolt item from a specified bucket and returns the data in bytes.
|
||||
func Read(db *bolt.DB, bucketName string, id int) ([]byte, error) {
|
||||
bucket := []byte(bucketName)
|
||||
|
||||
var data []byte
|
||||
|
||||
if err := db.View(func(tx *bolt.Tx) error {
|
||||
b := tx.Bucket(bucket)
|
||||
|
||||
if b == nil {
|
||||
return bucketNotExistError{bucket: string(bucket)}
|
||||
}
|
||||
|
||||
data = b.Get([]byte(strconv.Itoa(id)))
|
||||
|
||||
return nil
|
||||
}); err != nil {
|
||||
return nil, fmt.Errorf("error while reading the Bolt item from the database, %w", err)
|
||||
}
|
||||
|
||||
return data, nil
|
||||
}
|
||||
|
||||
// ReadMany reads one or more Bolt items from the specified bucket.
|
||||
func ReadMany(db *bolt.DB, bucketName string, ids []int) ([][]byte, error) {
|
||||
bucket := []byte(bucketName)
|
||||
|
||||
var output [][]byte
|
||||
|
||||
err := db.View(func(tx *bolt.Tx) error {
|
||||
b := tx.Bucket(bucket)
|
||||
|
||||
if b == nil {
|
||||
return bucketNotExistError{bucket: bucketName}
|
||||
}
|
||||
|
||||
for _, v := range ids {
|
||||
data := b.Get([]byte(strconv.Itoa(v)))
|
||||
output = append(output, data)
|
||||
}
|
||||
|
||||
return nil
|
||||
})
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("error while retrieving the data from the database, %w", err)
|
||||
}
|
||||
|
||||
return output, nil
|
||||
}
|
||||
|
||||
// ReadAll retrieves all the Bolt Items from the specified bucket.
|
||||
func ReadAll(db *bolt.DB, bucketName string) ([][]byte, error) {
|
||||
bucket := []byte(bucketName)
|
||||
|
||||
var output [][]byte
|
||||
|
||||
err := db.View(func(tx *bolt.Tx) error {
|
||||
b := tx.Bucket(bucket)
|
||||
|
||||
if b == nil {
|
||||
return bucketNotExistError{bucket: bucketName}
|
||||
}
|
||||
|
||||
if err := b.ForEach(func(_, v []byte) error {
|
||||
output = append(output, v)
|
||||
|
||||
return nil
|
||||
}); err != nil {
|
||||
return fmt.Errorf("unable to load status, %w", err)
|
||||
}
|
||||
|
||||
return nil
|
||||
})
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("error while loading statuses from the database, %w", err)
|
||||
}
|
||||
|
||||
return output, nil
|
||||
}
|
||||
|
||||
// Write creates or updates a Bolt item to a specified bucket.
|
||||
func Write(db *bolt.DB, bucketName string, item BoltItem) (int, error) {
|
||||
bucket := []byte(bucketName)
|
||||
|
||||
err := db.Update(func(tx *bolt.Tx) error {
|
||||
var err error
|
||||
b := tx.Bucket(bucket)
|
||||
|
||||
if b == nil {
|
||||
return bucketNotExistError{bucket: string(bucket)}
|
||||
}
|
||||
|
||||
if item.Id() < 1 {
|
||||
var id uint64
|
||||
if id, err = b.NextSequence(); err != nil {
|
||||
return fmt.Errorf("unable to generate an ID for the card, %w", err)
|
||||
}
|
||||
item.UpdateId(int(id))
|
||||
}
|
||||
|
||||
buf := new(bytes.Buffer)
|
||||
encoder := gob.NewEncoder(buf)
|
||||
if err = encoder.Encode(item); err != nil {
|
||||
return fmt.Errorf("unable to encode data, %w", err)
|
||||
}
|
||||
|
||||
if err = b.Put([]byte(strconv.Itoa(item.Id())), buf.Bytes()); err != nil {
|
||||
return fmt.Errorf("unable to write the card to the bucket, %w", err)
|
||||
}
|
||||
|
||||
return nil
|
||||
})
|
||||
if err != nil {
|
||||
return 0, fmt.Errorf("error while saving the card to the database, %w", err)
|
||||
}
|
||||
|
||||
return item.Id(), nil
|
||||
}
|
||||
|
||||
// WriteMany saves one or more Bolt items to the status bucket.
|
||||
func WriteMany(db *bolt.DB, bucketName string, items []BoltItem) ([]int, error) {
|
||||
if len(items) == 0 {
|
||||
return []int{}, nil
|
||||
}
|
||||
|
||||
ids := make([]int, len(items))
|
||||
|
||||
bucket := []byte(bucketName)
|
||||
|
||||
err := db.Update(func(tx *bolt.Tx) error {
|
||||
b := tx.Bucket(bucket)
|
||||
|
||||
if b == nil {
|
||||
return bucketNotExistError{bucket: string(bucket)}
|
||||
}
|
||||
|
||||
for i, v := range items {
|
||||
var err error
|
||||
|
||||
if v.Id() < 1 {
|
||||
var id uint64
|
||||
if id, err = b.NextSequence(); err != nil {
|
||||
return fmt.Errorf("unable to generate ID, %w", err)
|
||||
}
|
||||
v.UpdateId(int(id))
|
||||
}
|
||||
|
||||
buf := new(bytes.Buffer)
|
||||
encoder := gob.NewEncoder(buf)
|
||||
if err = encoder.Encode(v); err != nil {
|
||||
return fmt.Errorf("unable to encode data, %w", err)
|
||||
}
|
||||
|
||||
if err = b.Put([]byte(strconv.Itoa(v.Id())), buf.Bytes()); err != nil {
|
||||
return fmt.Errorf("unable to add the Bolt Item to the %s bucket, %w", bucketName, err)
|
||||
}
|
||||
|
||||
ids[i] = v.Id()
|
||||
}
|
||||
|
||||
return nil
|
||||
})
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("error while saving the Bolt Items to the database, %w", err)
|
||||
}
|
||||
|
||||
return ids, nil
|
||||
}
|
||||
|
||||
// dbPath returns the path to the database file. If a path is given then that is returned. Otherwise the default path is returned.
|
||||
// For linux, the default location of the database file is $XDG_DATA_HOME/canal/canal.db. If the XDG_DATA_HOME environment
|
||||
// variable is not set then it will default to $HOME/.local/share/canal/canal.db. For all other operating systems the default
|
||||
// location is $HOME/.canal/canal.db.
|
||||
func dbPath(path string) string {
|
||||
if len(path) > 0 {
|
||||
filepath.Dir(path)
|
||||
|
||||
return path
|
||||
}
|
||||
|
||||
dbFilename := "canal.db"
|
||||
|
||||
var dataDir string
|
||||
|
||||
goos := runtime.GOOS
|
||||
switch goos {
|
||||
case "linux":
|
||||
dataHome := os.Getenv("XDG_DATA_HOME")
|
||||
|
||||
if len(dataHome) == 0 {
|
||||
dataHome = filepath.Join(os.Getenv("HOME"), ".local", "share")
|
||||
}
|
||||
|
||||
dataDir = filepath.Join(dataHome, "canal")
|
||||
default:
|
||||
dataDir = filepath.Join(os.Getenv("HOME"), ".canal")
|
||||
}
|
||||
|
||||
path = filepath.Join(dataDir, dbFilename)
|
||||
|
||||
return path
|
||||
}
|
||||
|
||||
// mkDataDir creates the data directory of a given path to the database.
|
||||
func mkDataDir(path string) error {
|
||||
dir := filepath.Dir(path)
|
||||
|
||||
if err := os.MkdirAll(dir, 0o700); err != nil {
|
||||
return fmt.Errorf("error while making directory %s, %w", dir, err)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// ensureBuckets ensures that the required buckets are created in the database.
|
||||
func ensureBuckets(db *bolt.DB) error {
|
||||
buckets := []string{StatusBucket, CardBucket}
|
||||
|
||||
err := db.Update(func(tx *bolt.Tx) error {
|
||||
for _, v := range buckets {
|
||||
if _, err := tx.CreateBucketIfNotExists([]byte(v)); err != nil {
|
||||
return fmt.Errorf("unable to ensure that %s bucket is created in the database, %w", v, err)
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
})
|
||||
if err != nil {
|
||||
return fmt.Errorf("error while ensuring buckets exist in the database, %w", err)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
347
internal/database/database_test.go
Normal file
347
internal/database/database_test.go
Normal file
|
@ -0,0 +1,347 @@
|
|||
package database_test
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"encoding/gob"
|
||||
"fmt"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"reflect"
|
||||
"testing"
|
||||
|
||||
"codeflow.dananglin.me.uk/apollo/canal/internal/board"
|
||||
"codeflow.dananglin.me.uk/apollo/canal/internal/database"
|
||||
bolt "go.etcd.io/bbolt"
|
||||
)
|
||||
|
||||
func TestOpenDataBaseXDGDataDir(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
projectDir, err := projectRoot()
|
||||
if err != nil {
|
||||
t.Fatalf(err.Error())
|
||||
}
|
||||
|
||||
testXdgDataHome := filepath.Join(projectDir, "test", "databases", "xdg_data_dir")
|
||||
defer os.RemoveAll(testXdgDataHome)
|
||||
|
||||
if err := os.Setenv("XDG_DATA_HOME", testXdgDataHome); err != nil {
|
||||
t.Fatalf("An error occurred whilst setting the XDG_DATA_HOME environment variable, %s", err)
|
||||
}
|
||||
|
||||
defer func() {
|
||||
_ = os.Unsetenv("XDG_DATA_HOME")
|
||||
}()
|
||||
|
||||
db, err := database.OpenDatabase("")
|
||||
if err != nil {
|
||||
t.Fatalf("An error occurred whilst opening the test database, %s.", err)
|
||||
}
|
||||
|
||||
_ = db.Close()
|
||||
|
||||
wantDB := filepath.Join(testXdgDataHome, "canal", "canal.db")
|
||||
|
||||
// ensure that the database file exists
|
||||
_, err = os.Stat(wantDB)
|
||||
if err != nil {
|
||||
t.Fatalf("Unable to get file information of the test database, %s", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestWriteAndReadStatusList(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
var db *bolt.DB
|
||||
|
||||
var err error
|
||||
|
||||
projectDir, err := projectRoot()
|
||||
if err != nil {
|
||||
t.Fatalf(err.Error())
|
||||
}
|
||||
|
||||
testDB := filepath.Join(projectDir, "test", "databases", "Database_TestWriteAndReadStatusList.db")
|
||||
os.Remove(testDB)
|
||||
|
||||
if db, err = database.OpenDatabase(testDB); err != nil {
|
||||
t.Fatalf("An error occurred whilst opening the test database %s, %s.", testDB, err)
|
||||
}
|
||||
|
||||
defer func() {
|
||||
_ = db.Close()
|
||||
}()
|
||||
|
||||
testWriteStatusList(t, db)
|
||||
testReadStatusList(t, db)
|
||||
}
|
||||
|
||||
func testWriteStatusList(t *testing.T, db *bolt.DB) {
|
||||
t.Helper()
|
||||
|
||||
newStatusList := []board.Status{
|
||||
{
|
||||
ID: -1,
|
||||
Name: "Backlog",
|
||||
CardIds: []int{1, 14, 9, 10},
|
||||
Order: 1,
|
||||
},
|
||||
{
|
||||
ID: -1,
|
||||
Name: "Next",
|
||||
CardIds: []int{2, 5, 12},
|
||||
Order: 2,
|
||||
},
|
||||
{
|
||||
ID: -1,
|
||||
Name: "In progress",
|
||||
CardIds: []int{3, 14},
|
||||
Order: 3,
|
||||
},
|
||||
{
|
||||
ID: -1,
|
||||
Name: "Finished!",
|
||||
CardIds: []int{4, 6, 7, 8, 11, 13},
|
||||
Order: 4,
|
||||
},
|
||||
}
|
||||
|
||||
boltItems := make([]database.BoltItem, len(newStatusList))
|
||||
|
||||
for i := range newStatusList {
|
||||
boltItems[i] = &newStatusList[i]
|
||||
}
|
||||
|
||||
if _, err := database.WriteMany(db, database.StatusBucket, boltItems); err != nil {
|
||||
t.Fatalf("An error occurred whilst writing the initial status list to the database, %s", err)
|
||||
}
|
||||
}
|
||||
|
||||
func testReadStatusList(t *testing.T, db *bolt.DB) {
|
||||
t.Helper()
|
||||
|
||||
data, err := database.ReadAll(db, database.StatusBucket)
|
||||
if err != nil {
|
||||
t.Fatalf("An error occurred whilst reading the modified status list from the database, %s", err)
|
||||
}
|
||||
|
||||
got := make([]board.Status, len(data))
|
||||
|
||||
for i, d := range data {
|
||||
buf := bytes.NewBuffer(d)
|
||||
|
||||
decoder := gob.NewDecoder(buf)
|
||||
|
||||
var s board.Status
|
||||
|
||||
if err := decoder.Decode(&s); err != nil {
|
||||
t.Fatalf("An error occurred whilst decoding data, %s", err)
|
||||
}
|
||||
|
||||
got[i] = s
|
||||
}
|
||||
|
||||
want := []board.Status{
|
||||
{
|
||||
ID: 1,
|
||||
Name: "Backlog",
|
||||
CardIds: []int{1, 14, 9, 10},
|
||||
Order: 1,
|
||||
},
|
||||
{
|
||||
ID: 2,
|
||||
Name: "Next",
|
||||
CardIds: []int{2, 5, 12},
|
||||
Order: 2,
|
||||
},
|
||||
{
|
||||
ID: 3,
|
||||
Name: "In progress",
|
||||
CardIds: []int{3, 14},
|
||||
Order: 3,
|
||||
},
|
||||
{
|
||||
ID: 4,
|
||||
Name: "Finished!",
|
||||
CardIds: []int{4, 6, 7, 8, 11, 13},
|
||||
Order: 4,
|
||||
},
|
||||
}
|
||||
|
||||
if !reflect.DeepEqual(got, want) {
|
||||
t.Errorf("Unexpected status list read from the database: got %+v, want %+v", got, want)
|
||||
} else {
|
||||
t.Logf("Expected status list read from the database: got %+v", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestReadAndWriteCards(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
var db *bolt.DB
|
||||
|
||||
var err error
|
||||
|
||||
projectDir, err := projectRoot()
|
||||
if err != nil {
|
||||
t.Fatalf(err.Error())
|
||||
}
|
||||
|
||||
testDB := filepath.Join(projectDir, "test", "databases", "Database_TestReadWriteCard.db")
|
||||
os.Remove(testDB)
|
||||
|
||||
if db, err = database.OpenDatabase(testDB); err != nil {
|
||||
t.Fatalf("An error occurred whilst opening the test database %s, %s.", testDB, err)
|
||||
}
|
||||
|
||||
defer func() {
|
||||
_ = db.Close()
|
||||
}()
|
||||
|
||||
singleCard := board.Card{
|
||||
ID: -1,
|
||||
Title: "A test task.",
|
||||
Content: "This task should be completed.",
|
||||
}
|
||||
|
||||
singleCardID := testWriteOneCard(t, db, singleCard)
|
||||
testReadOneCard(t, db, singleCardID)
|
||||
|
||||
manyCards := []board.Card{
|
||||
{
|
||||
ID: -1,
|
||||
Title: "Test card A.",
|
||||
Content: "This is test card A.",
|
||||
},
|
||||
{
|
||||
ID: -1,
|
||||
Title: "Test card B.",
|
||||
Content: "This is test card B.",
|
||||
},
|
||||
{
|
||||
ID: -1,
|
||||
Title: "Test card C.",
|
||||
Content: "This is test card C.",
|
||||
},
|
||||
}
|
||||
|
||||
manyCardIDs := testWriteManyCard(t, db, manyCards)
|
||||
testReadManyCards(t, db, manyCardIDs)
|
||||
}
|
||||
|
||||
func testWriteOneCard(t *testing.T, db *bolt.DB, card board.Card) int {
|
||||
t.Helper()
|
||||
|
||||
cardID, err := database.Write(db, database.CardBucket, &card)
|
||||
if err != nil {
|
||||
t.Fatalf("An error occurred whilst writing the card to the database, %s", err)
|
||||
}
|
||||
|
||||
return cardID
|
||||
}
|
||||
|
||||
func testReadOneCard(t *testing.T, db *bolt.DB, cardID int) {
|
||||
t.Helper()
|
||||
|
||||
data, err := database.Read(db, database.CardBucket, cardID)
|
||||
if err != nil {
|
||||
t.Fatalf("An error occurred whilst loading the modified from the database, %s", err)
|
||||
}
|
||||
|
||||
var got board.Card
|
||||
|
||||
buf := bytes.NewBuffer(data)
|
||||
|
||||
decoder := gob.NewDecoder(buf)
|
||||
|
||||
if err := decoder.Decode(&got); err != nil {
|
||||
t.Fatalf("Unable to decode data, %s", err)
|
||||
}
|
||||
|
||||
want := board.Card{
|
||||
ID: 1,
|
||||
Title: "A test task.",
|
||||
Content: "This task should be completed.",
|
||||
}
|
||||
|
||||
if !reflect.DeepEqual(got, want) {
|
||||
t.Errorf("Unexpected card read from the database: got %+v, want %+v", got, want)
|
||||
} else {
|
||||
t.Logf("Expected card read from the database: got %+v", got)
|
||||
}
|
||||
}
|
||||
|
||||
func testWriteManyCard(t *testing.T, db *bolt.DB, cards []board.Card) []int {
|
||||
t.Helper()
|
||||
|
||||
boltItems := make([]database.BoltItem, len(cards))
|
||||
|
||||
for i := range cards {
|
||||
boltItems[i] = &cards[i]
|
||||
}
|
||||
|
||||
ids, err := database.WriteMany(db, database.CardBucket, boltItems)
|
||||
if err != nil {
|
||||
t.Fatalf("An error occurred whilst writing many cards to the database, %s", err)
|
||||
}
|
||||
|
||||
return ids
|
||||
}
|
||||
|
||||
func testReadManyCards(t *testing.T, db *bolt.DB, cardIDs []int) {
|
||||
t.Helper()
|
||||
|
||||
data, err := database.ReadMany(db, database.CardBucket, cardIDs)
|
||||
if err != nil {
|
||||
t.Fatalf("An error occurred whilst reading the data from the database, %s", err)
|
||||
}
|
||||
|
||||
got := make([]board.Card, len(data))
|
||||
|
||||
for i, d := range data {
|
||||
buf := bytes.NewBuffer(d)
|
||||
|
||||
decoder := gob.NewDecoder(buf)
|
||||
|
||||
var c board.Card
|
||||
|
||||
if err := decoder.Decode(&c); err != nil {
|
||||
t.Fatalf("An error occurred whilst decoding data, %s", err)
|
||||
}
|
||||
|
||||
got[i] = c
|
||||
}
|
||||
|
||||
want := []board.Card{
|
||||
{
|
||||
ID: 2,
|
||||
Title: "Test card A.",
|
||||
Content: "This is test card A.",
|
||||
},
|
||||
{
|
||||
ID: 3,
|
||||
Title: "Test card B.",
|
||||
Content: "This is test card B.",
|
||||
},
|
||||
{
|
||||
ID: 4,
|
||||
Title: "Test card C.",
|
||||
Content: "This is test card C.",
|
||||
},
|
||||
}
|
||||
|
||||
if !reflect.DeepEqual(got, want) {
|
||||
t.Errorf("Unexpected list of cards read from the database: got %+v, want %+v", got, want)
|
||||
} else {
|
||||
t.Logf("Expected list of cards read from the database: got %+v", got)
|
||||
}
|
||||
}
|
||||
|
||||
func projectRoot() (string, error) {
|
||||
cwd, err := os.Getwd()
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("unable to get the current working directory, %w", err)
|
||||
}
|
||||
|
||||
return filepath.Join(cwd, "..", ".."), nil
|
||||
}
|
11
internal/database/errors.go
Normal file
11
internal/database/errors.go
Normal file
|
@ -0,0 +1,11 @@
|
|||
package database
|
||||
|
||||
import "fmt"
|
||||
|
||||
type bucketNotExistError struct {
|
||||
bucket string
|
||||
}
|
||||
|
||||
func (e bucketNotExistError) Error() string {
|
||||
return fmt.Sprintf("bucket %s does not exist", e.bucket)
|
||||
}
|
114
internal/ui/column.go
Normal file
114
internal/ui/column.go
Normal file
|
@ -0,0 +1,114 @@
|
|||
package ui
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"strconv"
|
||||
|
||||
"codeflow.dananglin.me.uk/apollo/canal/internal/board"
|
||||
"github.com/gdamore/tcell/v2"
|
||||
"github.com/rivo/tview"
|
||||
)
|
||||
|
||||
type column struct {
|
||||
statusID int
|
||||
cards *tview.List
|
||||
}
|
||||
|
||||
func (u *UI) newColumn(status board.Status) (column, error) {
|
||||
cardList := tview.NewList()
|
||||
|
||||
cardList.SetBorder(true)
|
||||
cardList.ShowSecondaryText(false)
|
||||
cardList.SetTitle(" " + status.Name + " ")
|
||||
cardList.SetHighlightFullLine(true)
|
||||
cardList.SetSelectedFocusOnly(true)
|
||||
cardList.SetWrapAround(false)
|
||||
|
||||
cardList.SetInputCapture(func(event *tcell.EventKey) *tcell.EventKey {
|
||||
switch event.Rune() {
|
||||
case 'q':
|
||||
u.pages.ShowPage(quitPageName)
|
||||
u.SetFocus(u.quit)
|
||||
case 'a':
|
||||
u.pages.ShowPage(addPageName)
|
||||
u.SetFocus(u.add)
|
||||
case 'h':
|
||||
u.shiftColumnFocus(shiftLeft)
|
||||
case 'l':
|
||||
u.shiftColumnFocus(shiftRight)
|
||||
case 'j':
|
||||
cur := cardList.GetCurrentItem()
|
||||
if cur == cardList.GetItemCount()-1 {
|
||||
cur = 0
|
||||
} else {
|
||||
cur++
|
||||
}
|
||||
cardList.SetCurrentItem(cur)
|
||||
case 'k':
|
||||
cur := cardList.GetCurrentItem()
|
||||
cur--
|
||||
cardList.SetCurrentItem(cur)
|
||||
case 'm':
|
||||
u.pages.ShowPage(movePageName)
|
||||
u.SetFocus(u.move)
|
||||
}
|
||||
|
||||
return event
|
||||
})
|
||||
|
||||
if status.CardIds != nil && len(status.CardIds) > 0 {
|
||||
cards, err := u.board.CardList(status.CardIds)
|
||||
if err != nil {
|
||||
return column{}, fmt.Errorf("unable to get the card list. %w", err)
|
||||
}
|
||||
|
||||
for _, c := range cards {
|
||||
id := strconv.Itoa(c.ID)
|
||||
cardList.AddItem(fmt.Sprintf("[%s] %s", id, c.Title), id, 0, nil)
|
||||
}
|
||||
}
|
||||
|
||||
u.flex.AddItem(cardList, 0, 1, false)
|
||||
|
||||
c := column{
|
||||
statusID: status.ID,
|
||||
cards: cardList,
|
||||
}
|
||||
|
||||
return c, nil
|
||||
}
|
||||
|
||||
func (u *UI) setColumnFocus() {
|
||||
u.SetFocus(u.columns[u.focusedColumn].cards)
|
||||
}
|
||||
|
||||
func (u *UI) shiftColumnFocus(s int) {
|
||||
switch s {
|
||||
case shiftRight:
|
||||
if u.focusedColumn == len(u.columns)-1 {
|
||||
u.focusedColumn = 0
|
||||
} else {
|
||||
u.focusedColumn++
|
||||
}
|
||||
case shiftLeft:
|
||||
if u.focusedColumn == 0 {
|
||||
u.focusedColumn = len(u.columns) - 1
|
||||
} else {
|
||||
u.focusedColumn--
|
||||
}
|
||||
}
|
||||
|
||||
u.setColumnFocus()
|
||||
}
|
||||
|
||||
func (u *UI) updateColumns(statusList []board.Status) {
|
||||
u.flex.Clear()
|
||||
|
||||
columns := make([]column, len(statusList))
|
||||
|
||||
for i := range statusList {
|
||||
columns[i], _ = u.newColumn(statusList[i])
|
||||
}
|
||||
|
||||
u.columns = columns
|
||||
}
|
86
internal/ui/modalinput.go
Normal file
86
internal/ui/modalinput.go
Normal file
|
@ -0,0 +1,86 @@
|
|||
package ui
|
||||
|
||||
import (
|
||||
"github.com/gdamore/tcell/v2"
|
||||
"github.com/rivo/tview"
|
||||
)
|
||||
|
||||
type modalInput struct {
|
||||
*tview.Form
|
||||
frame *tview.Frame
|
||||
text string
|
||||
done func(string, bool)
|
||||
}
|
||||
|
||||
func NewModalInput() *modalInput {
|
||||
form := tview.NewForm()
|
||||
m := modalInput{
|
||||
Form: form,
|
||||
frame: tview.NewFrame(form),
|
||||
text: "",
|
||||
done: nil,
|
||||
}
|
||||
|
||||
m.SetButtonsAlign(tview.AlignCenter).
|
||||
SetButtonBackgroundColor(tview.Styles.PrimitiveBackgroundColor).
|
||||
SetButtonTextColor(tview.Styles.PrimaryTextColor).
|
||||
SetBackgroundColor(tview.Styles.ContrastBackgroundColor).
|
||||
SetBorderPadding(0, 0, 0, 0)
|
||||
|
||||
m.AddInputField("", "", 50, nil, func(text string) {
|
||||
m.text = text
|
||||
})
|
||||
|
||||
m.AddButton("OK", func() {
|
||||
if m.done != nil {
|
||||
m.done(m.text, true)
|
||||
}
|
||||
})
|
||||
|
||||
m.AddButton("Cancel", func() {
|
||||
if m.done != nil {
|
||||
m.done(m.text, false)
|
||||
}
|
||||
})
|
||||
|
||||
m.frame.SetBorders(0, 0, 1, 0, 0, 0).
|
||||
SetBorder(true).
|
||||
SetBackgroundColor(tview.Styles.ContrastBackgroundColor).
|
||||
SetBorderPadding(1, 1, 1, 1)
|
||||
|
||||
return &m
|
||||
}
|
||||
|
||||
func (m *modalInput) SetValue(text string) {
|
||||
m.Clear(false)
|
||||
m.AddInputField("", text, 50, nil, func(text string) {
|
||||
m.text = text
|
||||
})
|
||||
}
|
||||
|
||||
func (m *modalInput) SetDoneFunc(handler func(string, bool)) *modalInput {
|
||||
m.done = handler
|
||||
return m
|
||||
}
|
||||
|
||||
func (m *modalInput) Draw(screen tcell.Screen) {
|
||||
buttonsWidth := 50
|
||||
screenWidth, screenHeight := screen.Size()
|
||||
width := screenWidth / 3
|
||||
|
||||
if width < buttonsWidth {
|
||||
width = buttonsWidth
|
||||
}
|
||||
|
||||
height := 7
|
||||
width += 4
|
||||
|
||||
// Set the modal's position and size.
|
||||
x := (screenWidth - width) / 2
|
||||
y := (screenHeight - height) / 2
|
||||
m.SetRect(x, y, width, height)
|
||||
|
||||
// Draw the frame.
|
||||
m.frame.SetRect(x, y, width, height)
|
||||
m.frame.Draw(screen)
|
||||
}
|
226
internal/ui/ui.go
Normal file
226
internal/ui/ui.go
Normal file
|
@ -0,0 +1,226 @@
|
|||
package ui
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"strconv"
|
||||
|
||||
"codeflow.dananglin.me.uk/apollo/canal/internal/board"
|
||||
"github.com/gdamore/tcell/v2"
|
||||
"github.com/rivo/tview"
|
||||
)
|
||||
|
||||
const (
|
||||
shiftLeft int = iota
|
||||
shiftRight
|
||||
)
|
||||
|
||||
const (
|
||||
mainPageName string = "main"
|
||||
quitPageName string = "quit"
|
||||
addPageName string = "add"
|
||||
movePageName string = "move"
|
||||
)
|
||||
|
||||
type UI struct {
|
||||
*tview.Application
|
||||
|
||||
columns []column
|
||||
flex *tview.Flex
|
||||
pages *tview.Pages
|
||||
focusedColumn int
|
||||
board board.Board
|
||||
quit *tview.Modal
|
||||
add *modalInput
|
||||
move *tview.Flex
|
||||
}
|
||||
|
||||
// NewUI returns a new UI value.
|
||||
func NewUI() UI {
|
||||
ui := UI{
|
||||
Application: tview.NewApplication(),
|
||||
pages: tview.NewPages(),
|
||||
flex: tview.NewFlex(),
|
||||
quit: tview.NewModal(),
|
||||
add: NewModalInput(),
|
||||
focusedColumn: 0,
|
||||
columns: nil,
|
||||
move: nil,
|
||||
board: board.Board{},
|
||||
}
|
||||
|
||||
ui.init()
|
||||
|
||||
return ui
|
||||
}
|
||||
|
||||
// closeBoard closes the board.
|
||||
func (u *UI) closeBoard() {
|
||||
_ = u.board.Close()
|
||||
}
|
||||
|
||||
// init initialises the UI.
|
||||
func (u *UI) init() {
|
||||
u.pages.AddPage(mainPageName, u.flex, true, true)
|
||||
|
||||
u.initQuitModal()
|
||||
u.pages.AddPage(quitPageName, u.quit, false, false)
|
||||
|
||||
u.initAddInputModal()
|
||||
u.pages.AddPage(addPageName, u.add, false, false)
|
||||
|
||||
u.SetInputCapture(func(event *tcell.EventKey) *tcell.EventKey {
|
||||
switch event.Rune() {
|
||||
case 'o':
|
||||
if u.flex.HasFocus() && len(u.columns) == 0 {
|
||||
_ = u.openBoard("")
|
||||
}
|
||||
}
|
||||
|
||||
return event
|
||||
})
|
||||
|
||||
u.SetRoot(u.pages, true)
|
||||
}
|
||||
|
||||
// initAddInputModal initialises the add input modal.
|
||||
func (u *UI) initAddInputModal() {
|
||||
doneFunc := func(text string, success bool) {
|
||||
if success {
|
||||
_ = u.newCard(text, "")
|
||||
}
|
||||
|
||||
u.pages.HidePage(addPageName)
|
||||
u.setColumnFocus()
|
||||
}
|
||||
|
||||
u.add.SetDoneFunc(doneFunc)
|
||||
}
|
||||
|
||||
// initQuitModal initialises the quit modal.
|
||||
func (u *UI) initQuitModal() {
|
||||
quitDoneFunc := func(_ int, buttonLabel string) {
|
||||
switch buttonLabel {
|
||||
case "Quit":
|
||||
u.shutdown()
|
||||
default:
|
||||
u.pages.SwitchToPage(mainPageName)
|
||||
u.setColumnFocus()
|
||||
}
|
||||
}
|
||||
|
||||
u.quit.SetText("Do you want to quit the application?").
|
||||
AddButtons([]string{"Quit", "Cancel"}).
|
||||
SetDoneFunc(quitDoneFunc)
|
||||
}
|
||||
|
||||
// newCard creates and saves a new card to the database.
|
||||
func (u *UI) newCard(title, content string) error {
|
||||
args := board.CardArgs{
|
||||
NewTitle: title,
|
||||
NewContent: content,
|
||||
}
|
||||
|
||||
if _, err := u.board.CreateCard(args); err != nil {
|
||||
return fmt.Errorf("unable to create card, %w", err)
|
||||
}
|
||||
|
||||
_ = u.refresh()
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// openBoard opens the kanban board.
|
||||
func (u *UI) openBoard(path string) error {
|
||||
b, err := board.Open(path)
|
||||
if err != nil {
|
||||
return fmt.Errorf("unable to load board, %w", err)
|
||||
}
|
||||
|
||||
u.board = b
|
||||
|
||||
if err = u.refresh(); err != nil {
|
||||
return fmt.Errorf("error refreshing the board, %w", err)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// refresh refreshes the UI.
|
||||
func (u *UI) refresh() error {
|
||||
statusList, err := u.board.StatusList()
|
||||
if err != nil {
|
||||
return fmt.Errorf("unable to get the status list, %w", err)
|
||||
}
|
||||
|
||||
u.updateColumns(statusList)
|
||||
|
||||
u.updateMovePage(statusList)
|
||||
|
||||
u.setColumnFocus()
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// shutdown shuts down the application.
|
||||
func (u *UI) shutdown() {
|
||||
u.closeBoard()
|
||||
u.Stop()
|
||||
}
|
||||
|
||||
func (u *UI) updateMovePage(statusList []board.Status) {
|
||||
if u.pages.HasPage(movePageName) {
|
||||
u.pages.RemovePage(movePageName)
|
||||
}
|
||||
|
||||
move := tview.NewFlex()
|
||||
|
||||
statusSelection := tview.NewList()
|
||||
statusSelection.SetBorder(true)
|
||||
statusSelection.ShowSecondaryText(false)
|
||||
statusSelection.SetHighlightFullLine(true)
|
||||
statusSelection.SetSelectedFocusOnly(true)
|
||||
statusSelection.SetWrapAround(false)
|
||||
|
||||
doneFunc := func() {
|
||||
u.pages.HidePage(movePageName)
|
||||
u.setColumnFocus()
|
||||
}
|
||||
|
||||
statusSelection.SetDoneFunc(doneFunc)
|
||||
|
||||
selectedFunc := func(_ int, _, secondary string, _ rune) {
|
||||
currentStatusID := u.columns[u.focusedColumn].statusID
|
||||
|
||||
nextStatusID, err := strconv.Atoi(secondary)
|
||||
if err != nil {
|
||||
nextStatusID = 0
|
||||
}
|
||||
|
||||
currentItem := u.columns[u.focusedColumn].cards.GetCurrentItem()
|
||||
_, cardIDText := u.columns[u.focusedColumn].cards.GetItemText(currentItem)
|
||||
cardID, _ := strconv.Atoi(cardIDText)
|
||||
|
||||
args := board.MoveToStatusArgs{
|
||||
CardID: cardID,
|
||||
CurrentStatusID: currentStatusID,
|
||||
NextStatusID: nextStatusID,
|
||||
}
|
||||
_ = u.board.MoveToStatus(args)
|
||||
|
||||
u.pages.HidePage(movePageName)
|
||||
_ = u.refresh()
|
||||
}
|
||||
|
||||
statusSelection.SetSelectedFunc(selectedFunc)
|
||||
|
||||
for _, status := range statusList {
|
||||
id := strconv.Itoa(status.ID)
|
||||
statusSelection.AddItem(fmt.Sprintf("\u25C9 %s", status.Name), id, 0, nil)
|
||||
}
|
||||
|
||||
move.AddItem(statusSelection, 0, 1, true)
|
||||
|
||||
u.move = move
|
||||
|
||||
u.pages.AddPage(movePageName, move, false, false)
|
||||
}
|
73
magefiles/magefile.go
Normal file
73
magefiles/magefile.go
Normal file
|
@ -0,0 +1,73 @@
|
|||
//go:build mage
|
||||
|
||||
package main
|
||||
|
||||
import (
|
||||
"os"
|
||||
"strings"
|
||||
|
||||
"github.com/magefile/mage/sh"
|
||||
)
|
||||
|
||||
const (
|
||||
binary = "canal"
|
||||
)
|
||||
|
||||
var Default = Build
|
||||
|
||||
// Test run the go tests
|
||||
// To enable verbose mode set CANAL_TEST_VERBOSE=1.
|
||||
// To enable coverage mode set CANAL_TEST_COVER=1.
|
||||
func Test() error {
|
||||
goTest := sh.RunCmd("go", "test")
|
||||
|
||||
args := []string{"./..."}
|
||||
|
||||
if os.Getenv("CANAL_TEST_VERBOSE") == "1" {
|
||||
args = append(args, "-v")
|
||||
}
|
||||
|
||||
if os.Getenv("CANAL_TEST_COVER") == "1" {
|
||||
args = append(args, "-cover")
|
||||
}
|
||||
|
||||
return goTest(args...)
|
||||
}
|
||||
|
||||
// Lint runs golangci-lint against the code.
|
||||
func Lint() error {
|
||||
return sh.RunV("golangci-lint", "run", "--color", "always")
|
||||
}
|
||||
|
||||
// Build build the executable
|
||||
func Build() error {
|
||||
main := "./cmd/canal/main.go"
|
||||
return sh.Run("go", "build", "-o", binary, main)
|
||||
}
|
||||
|
||||
// Clean clean the workspace
|
||||
func Clean() error {
|
||||
if err := sh.Rm(binary); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if err := sh.Run("go", "clean", "./..."); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
testDBDir := "./test/databases"
|
||||
|
||||
files, err := os.ReadDir(testDBDir)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
for _, f := range files {
|
||||
filename := f.Name()
|
||||
if strings.HasSuffix(filename, ".db") {
|
||||
sh.Rm(testDBDir + "/" + filename)
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
0
test/databases/.gitkeep
Normal file
0
test/databases/.gitkeep
Normal file
Loading…
Reference in a new issue