~hacktivista/leanweb

9d692e1d166b291d052085d7f1481df59a0fd3f3 — Felix Freeman 19 days ago
Initial commit. Working LeanWeb 0.1
A  => .gitignore +4 -0
@@ 1,4 @@
Gemfile.lock
.yardoc/
doc/
pkg/

A  => .rubocop.yml +14 -0
@@ 1,14 @@
AllCops:
  NewCops: enable

Layout/LineLength:
  Max: 80

Layout/EmptyLines:
  Enabled: False

Style/MethodCallWithArgsParentheses:
  Enabled: True

Metrics/MethodLength:
  CountAsOne: ['array', 'hash', 'heredoc']

A  => .yardopts +2 -0
@@ 1,2 @@
--markup markdown
- README.md LICENSE

A  => Gemfile +5 -0
@@ 1,5 @@
# frozen_string_literal: true

source 'https://rubygems.org'

gemspec

A  => LICENSE +620 -0
@@ 1,620 @@
                   HACKTIVISTA GENERAL PUBLIC LICENSE
                      Version 0.1, 19 November 2021

 Copyright (C) 2021 Felix Freeman <libsys@hacktivista.org>
 Everyone is permitted to copy and distribute verbatim copies
 of this license document, but changing it is not allowed.

                            Preamble

  The Hacktivista General Public License is a free, copyleft license for
software and other kinds of works.  It's based on the GNU Affero General
Public License version 3, but it's not approved nor endorsed by the GNU
Project or the Free Software Foundation.

  This License has the same objectives as its GNU predecesors, to
guarantee your freedom to share and change all versions of a program.
In contrast to GNU licenses, it doesn't allow for exceptions to this
rule in specific cases, such as internal corporate usage, conveying the
covered works to every user that receives a copy according to its terms;
effectively making sure its free for all its users.

  It accomplishes its objective by changing only the second and third
paragraph on section 2 and deleting the GNU GPL compatibility clauses on
section 13. Other minor changes replace references to GNU or the FSF.

  This License by no means prohibits the private usage of the covered
works, it simply does not enforce it.  It's a purely libre software
license with strong copyleft.

  The precise terms and conditions for copying, distribution and
modification follow.

                       TERMS AND CONDITIONS

  0. Definitions.

  "This License" refers to version 0.1 of the Hacktivista 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.  Conveying of the covered work takes effect when any person, be
natural or legal, receives a copy of it under the conditions stated
below.  Even if the person is making or running the covered works on
behalf of other person.

  Conveying 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. Remote Network Interaction

  Notwithstanding any other provision of this License, if you modify the
Program, your modified version must prominently offer all users
interacting with it remotely through a computer network (if your version
supports such interaction) an opportunity to receive the Corresponding
Source of your version by providing access to the Corresponding Source
from a network server at no charge, through some standard or customary
means of facilitating copying of software.

  14. Revised Versions of this License.

  The authors may publish revised and/or new versions of the Hacktivista
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 Hacktivista 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 on <https://hacktivista.org/licenses/>.
If the Program does not specify a version number of the Hacktivista
General Public License, you may choose any version of the license
identified by its name ever published on that website.

  If the Program specifies that a proxy can decide which future versions
of the Hacktivista General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.

  Later license versions may give you additional or different
permissions.  However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.

  15. Disclaimer of Warranty.

  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

  16. Limitation of Liability.

  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.

  17. Interpretation of Sections 15 and 16.

  If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.

                     END OF TERMS AND CONDITIONS

            How to Apply These Terms to Your New Programs

  If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.

  To do so, attach the following notices to the program.  It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.

<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year>  <name of author>

    This program is free software: you can redistribute it and/or modify
    it under the terms of the Hacktivista General Public License as
    published on <https://hacktivista.org/licenses/>, either version 0.1
    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
    Hacktivista General Public License for more details.

    You should have received a copy of the Hacktivista General Public
    License along with this program.  If not, refer to its publication.

Also add information on how to contact you by electronic and paper mail.

  If your software can interact with users remotely through a computer
network, you should also make sure that it provides a way for users to
get its source.  For example, if your program is a web application, its
interface could display a "Source" link that leads users to an archive
of the code.  There are many ways you could offer source, and different
solutions will be better for different programs; see section 13 for the
specific requirements.

  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-like
licenses, see <https://www.gnu.org/licenses/>.

A  => README.md +83 -0
@@ 1,83 @@
# LeanWeb

LeanWeb is a minimal hybrid static / dynamic web framework.

LeanWeb a *very* lean MVC framework on top of Rack that works for static and
dynamic content alike. The idea is to build static websites first, but not
having to rely on dirty tricks for adding dynamism when needed.

It currently only supports ERB files by default and [.haml](https://haml.info)
files as input for views, but support for Markdown and org-mode is expected
*soonish*.

## Developing with LeanWeb

### Getting started

Install the `leanweb` gem on your system.

Create a new project with `leanweb new <project-directory>`.

You're ready to go!

- Place your static files on `public/`
- Place your controllers on `src/controllers/` (inheriting from
  `LeanWeb::Controller`)
- Place your views on `src/views/`
- Setup your routes on `routes.rb`, check API documentation to know how.
- Setup your Rack middleware on `config.ru`

You can run a development server with `rackup`.

### API documentation

API documentation is in YARD, you can access a web version on
<https://leanweb.hacktivista.org>. Specially relevant are docs on
`Route#initialize` and `Controller#render`.

### Environment variables

- `LEANWEB_ROOT_PATH` defines the route to the project, defaults to current
  directory.
- `RACK_ENV` if set to `development`, serves static files and routes too, else
  it will only serve dynamic routes.

You'll not need to configure neither with the default configuration.

### Deployment

Build static files with `rake build`. This might be all you need to do for
static websites.

If your website has dynamic routes, serve with `rackup -E deployment`. Then
configure your webserver to serve dynamic routes by listening to port `9292` and
static files on `public/`.

## Contributing

Source code is available on <https://git.hacktivista.org/leanweb>.

Bug reports and patches are welcome on
<https://lists.hacktivista.org/hacktivista-dev>.

### Testing

Only tested contributions are accepted. Run tests with `rake test`.

### Source based installation

Simply run `rake install` or `rake install:local`.

## License

LeanWeb is libre software released under the Hacktivista General Public License
0.1 or any later version. Which means it works exactly as the GNU AGPL license
but every copy counts as distribution, even for "internal usage".

To comply with license terms, if you modify this software you must prominently
provide the means to access the source code of your version of the software
easily and free of charge to any person that has access to it, even users which
access through a network (i.e. web browser).

Any modification or inclusion of this source code will inherit the same license,
that is, it can't be sublicensed.

A  => Rakefile +16 -0
@@ 1,16 @@
# frozen_string_literal: true

require 'bundler/gem_tasks'
require 'rake/testtask'

Rake::TestTask.new(:test) do |t|
  t.libs << 'test'
  t.libs << 'lib'
  t.test_files = FileList['test/**/*_test.rb']
end

require 'rubocop/rake_task'

RuboCop::RakeTask.new

task default: %i[test rubocop]

A  => bin/leanweb +109 -0
@@ 1,109 @@
#!/usr/bin/env ruby
# frozen_string_literal: true

# Copyright 2022 Felix Freeman <libsys@hacktivista.org>
#
# This file is part of "LeanWeb" and licensed under the terms of the Hacktivista
# General Public License version 0.1 or (at your option) any later version. You
# should have received a copy of this license along with the software. If not,
# see <https://hacktivista.org/licenses/>.

require 'fileutils'
require 'leanweb'

# Script for building a new project.

files = [
  {
    filename: 'Gemfile',
    # TODO: Use {LeanWeb::VERSION} when v1 is reached.
    content: <<~RUBY
      # frozen_string_literal: true

      source 'https://rubygems.org'

      gem 'leanweb', '~> 0.1'
      gem 'rake'
    RUBY
  }, {
    filename: 'config.ru',
    content: <<~RUBY
      # frozen_string_literal: true

      require 'leanweb'

      if ENV['RACK_ENV'] == 'development'
        use(Rack::Reloader, 0)
        use(Rack::Static, urls: [''], root: 'public', cascade: true)
      end

      app = LeanWeb::App.init
      run app
    RUBY
  }, {
    filename: 'routes.rb',
    content: <<~RUBY
      # frozen_string_literal: true

      [{ path: '/' }]
    RUBY
  }, {
    filename: 'Rakefile',
    content: <<~RUBY
      # frozen_string_literal: true

      require 'leanweb'

      task default: %w[build]

      task :build do
        LeanWeb::App.init.build_static
      end
    RUBY
  }, {
    filename: 'src/controllers/main.rb',
    content: <<~RUBY
      # frozen_string_literal: true

      require 'leanweb'

      # Main controller is the default controller.
      class MainController < LeanWeb::Controller
        def index_get
          render 'index.haml'
        end
      end
    RUBY
  }, {
    filename: 'src/views/index.haml',
    content: <<~HAML
      !!!
      %html
        %head
          %meta{charset: "utf-8"}
          %meta{name: "viewport", content: "width=device-width, initial-scale=1"}
          %title LeanWeb framework
        %body
          %h1 It works!
    HAML
  }
]

if !(1..2).include?(ARGV.size) || ARGV[0] != 'new'
  puts 'Usage: leanweb new [directory]'
  exit(1)
end

begin
  path = ARGV[1] || '.'
  FileUtils.mkdir_p(path)
  FileUtils.cd(path)
  FileUtils.mkdir_p(['public', 'src/controllers', 'src/views'])
  files.each { |file| File.write(file[:filename], file[:content]) }
  `git init`
  `bundle install`
  puts("Project '#{File.basename(Dir.getwd)}' successfully created.")
rescue # rubocop:disable Style/RescueStandardError
  puts('Woops! Something went wrong.')
  raise
end

A  => leanweb.gemspec +34 -0
@@ 1,34 @@
# frozen_string_literal: true

require_relative 'lib/leanweb'

Gem::Specification.new do |spec|
  spec.name = 'leanweb'
  spec.version = LeanWeb::VERSION
  spec.authors = ['Felix Freeman']
  spec.email = ['libsys@hacktivista.org']
  spec.license = 'LicenseRef-LICENSE'

  spec.summary = 'LeanWeb is a minimal hybrid static / dynamic web framework'
  spec.homepage = 'https://leanweb.hacktivista.org'
  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')

  spec.metadata['homepage_uri'] = spec.homepage
  spec.metadata['source_code_uri'] = 'https://git.hacktivista.org/leanweb'
  spec.metadata['rubygems_mfa_required'] = 'true'
  spec.metadata['yard.run'] = 'yri'

  spec.files = Dir['lib/**/*.rb'] + ['bin/leanweb']
  spec.require_paths = ['lib']
  spec.bindir = 'bin'
  spec.executables << 'leanweb'

  spec.add_dependency('haml')
  spec.add_dependency('rack')

  spec.add_development_dependency('minitest')
  spec.add_development_dependency('rake')
  spec.add_development_dependency('rubocop')
  spec.add_development_dependency('rubocop-minitest')
  spec.add_development_dependency('yard')
end

A  => lib/leanweb.rb +30 -0
@@ 1,30 @@
# frozen_string_literal: true

# Copyright 2022 Felix Freeman <libsys@hacktivista.org>
#
# This file is part of "LeanWeb" and licensed under the terms of the Hacktivista
# General Public License version 0.1 or (at your option) any later version. You
# should have received a copy of this license along with the software. If not,
# see <https://hacktivista.org/licenses/>.

# LeanWeb is a minimal hybrid static / dynamic web framework.
module LeanWeb
  VERSION = '0.1.3'

  ROOT_PATH = ENV['LEANWEB_ROOT_PATH'] || Dir.pwd
  CONTROLLER_PATH = "#{ROOT_PATH}/src/controllers"
  VIEW_PATH = "#{ROOT_PATH}/src/views"
  PUBLIC_PATH = "#{ROOT_PATH}/public"

  MEDIA_EXTENSIONS = {
    nil => '.html',
    'application/javascript' => '.js',
    'application/json' => '.json',
    'text/html' => '.html',
    'text/plain' => '.txt'
  }.freeze

  autoload :Route, 'leanweb/route.rb'
  autoload :Controller, 'leanweb/controller.rb'
  autoload :App, 'leanweb/app.rb'
end

A  => lib/leanweb/app.rb +77 -0
@@ 1,77 @@
# frozen_string_literal: true

# Copyright 2022 Felix Freeman <libsys@hacktivista.org>
#
# This file is part of "LeanWeb" and licensed under the terms of the Hacktivista
# General Public License version 0.1 or (at your option) any later version. You
# should have received a copy of this license along with the software. If not,
# see <https://hacktivista.org/licenses/>.

require 'rack'

module LeanWeb
  # App resolves and builds static files from routes.
  class App
    attr_accessor :routes

    # @param routes [Hash] Hash of routes with {Route} attributes.
    def initialize(routes)
      @routes = routes
    end

    # Entry point for dynamic routes (Rack).
    #
    # @param env [Hash] `env` for Rack.
    def call(env)
      request = Rack::Request.new(env)
      route = @routes.find do |r|
        (r[:method] || 'GET') == request.request_method && begin
          r[:path] =~ request.path
        rescue TypeError
          r[:path] == request.path
        end
      end
      return [404, {}, ['Not found']] unless route_exists?(route)

      Route.new(**route).respond(request)
    end

    # Build static routes to files.
    def build_static
      @routes.each do |route|
        route = Route.new(**route)
        next unless route.static

        begin
          route.static.each { |seed| route.build(route.seed_path(seed)) }
        rescue NoMethodError
          route.build
        end
      end
    end

    # Initialize by evaluating the routes file.
    #
    # Do this here so users don't freak out for using eval and rubocop is happy
    # on client side.
    #
    # @param file [String] Routes file.
    def self.init(file = 'routes.rb')
      new(eval(File.read(file))) # rubocop:disable Security/Eval
    end

    protected

    # Check if route exists.
    #
    # If not on development environment, serve only dynamic routes.
    #
    # @param route [Hash]
    def route_exists?(route)
      return false if route.nil? \
        || (ENV['RACK_ENV'] != 'development' && route[:static] != false)

      true
    end
  end
end

A  => lib/leanweb/controller.rb +87 -0
@@ 1,87 @@
# frozen_string_literal: true

# Copyright 2022 Felix Freeman <libsys@hacktivista.org>
#
# This file is part of "LeanWeb" and licensed under the terms of the Hacktivista
# General Public License version 0.1 or (at your option) any later version. You
# should have received a copy of this license along with the software. If not,
# see <https://hacktivista.org/licenses/>.

require 'rack'

module LeanWeb
  # Controller is a base controller with `@route`, `@request` and `@response`
  # private attributes that will be shared with your views when you {#render}
  # Haml documents.
  #
  # Even if you don't {#render}, you can use the `.finish` method from
  # `Rack::Response` on `@response` to return a proper `Rack` response.
  class Controller
    # @param route [Route]
    # @param request [Rack::Request]
    def initialize(route, request = nil)
      @route = route
      @request = request
      @response = Rack::Response.new(nil, 200)
    end

    # Render magic. Supports ERB (default) and .haml files.
    #
    # Depending on {Route#path} and {#render} `path` you will render different
    # documents:
    #
    # - {Route#path} `/a/b/c` and `render('d')` will render `src/views/a/b/d`
    # - {Route#path} `/a/b/c/` and `render('d')` will render `src/views/a/b/c/d`
    # - `render('~/custom')` will render `src/views/custom`
    # - `render('/custom')` will render `/custom`
    #
    # @param path [String] Might be an absolute path or a relative path to
    #   `src/views/` + the parent path of the last non-capture-group on
    #   `@route.path`. You can also make it relative to {LeanWeb::VIEW_PATH} by
    #   prepending `~`.
    # @param content_type [String] Defaults to the proper Content-Type for file
    #   extension, `text/plain` on unknown files.
    # @return [Rack::Request#finish] A valid rack response.
    def render(path, content_type = nil) # rubocop:disable Metrics/MethodLength
      path = absolute_view_path(path)
      content = File.read(path)
      case File.extname(path)
      when '.haml'
        require('haml')
        @response.write(Haml::Engine.new(content).render(binding))
        @response.set_header('Content-Type', content_type || 'text/html')
      else
        require('erb')
        @response.write(ERB.new(content).result(binding))
        @response.set_header('Content-Type', content_type || 'text/plain')
      end
      @response.finish
    end

    protected

    # @param relative_path [String]
    # @return [String] Full path.
    def absolute_view_path(relative_path)
      case relative_path[0]
      when '/'
        relative_path
      when '~'
        relative_path.sub('~', LeanWeb::VIEW_PATH)
      else
        "#{view_path_by_route_path}/#{relative_path}"
      end
    end

    def view_path_by_route_path
      LeanWeb::VIEW_PATH +
        if @route.path.instance_of?(Regexp)
          @route.str_path.sub(%r{/?\(.*}, '')
        elsif @route.path[-1] != '/'
          File.dirname(@route.path)
        else
          @route.path.chomp('/')
        end
    end
  end
end

A  => lib/leanweb/route.rb +168 -0
@@ 1,168 @@
# frozen_string_literal: true

# Copyright 2022 Felix Freeman <libsys@hacktivista.org>
#
# This file is part of "LeanWeb" and licensed under the terms of the Hacktivista
# General Public License version 0.1 or (at your option) any later version. You
# should have received a copy of this license along with the software. If not,
# see <https://hacktivista.org/licenses/>.


module LeanWeb
  # Action for {Route#action}.
  Action = Struct.new(:file, :controller, :action, keyword_init: true)

  # A single route which routes with the {#respond} method. It can also {#build}
  # an static file.
  class Route
    attr_reader :path, :method, :action, :static

    # A new instance of Route.
    #
    # @param path [String, Regexp] Path matcher, can be an String or Regexp with
    #   positional or named capture groups, `@action` will receive these as
    #   positional or named arguments.
    # @param method [String, nil] Must be an HTTP verb such as `GET` or `POST`.
    # @param action [Proc, Hash, String, nil] References a Method/Proc to be
    #   triggered. It can be:
    #
    #   - A full hash `{ file: 'val', controller: 'val', action: 'val' }`.
    #   - A hash with `{ 'file' => 'action' }` only (which has a controller
    #     class name `{File}Controller`).
    #   - A simple string (which will consider file `main.rb` and controller
    #     `MainController`). Defaults to "{#path_basename}_{#method}", (ex:
    #     `index_get`).
    #   - It can also be a `Proc`.
    #
    # @param static [Boolean|Array] Defines a route as static. Set to `false` to
    #   say it can only work dynamically. You can also supply an array of arrays
    #   or hashes to generate static files based on that positional or keyword
    #   params.
    def initialize(path:, method: 'GET', action: nil, static: true)
      @path = path
      @method = method
      self.action = action
      @static = static
    end

    # Last identifier on a path, returns `index` for `/`.
    def path_basename
      str_path[-1] == '/' ? 'index' : File.basename(str_path)
    end

    # @param request [Rack::Request]
    # @return [Array] a valid rack response.
    def respond(request)
      return respond_proc(request) if @action.instance_of?(Proc)

      respond_method(request)
    end

    # String path, independent if {#path} is Regexp or String.
    def str_path
      @path.source.gsub(/[\^$]/, '')
    rescue NoMethodError
      @path
    end

    # On Regexp paths, return a string valid for making a request to this route.
    #
    # @param seed [Array, Hash] Seeds to use as replacement on capture groups.
    # @return [String] sown path.
    def seed_path(seed)
      sown_path = str_path
      if seed.instance_of?(Hash)
        seed.each { |key, val| sown_path.sub!(/\(\?<#{key}>[^)]+\)/, val) }
      else
        seed.each { |val| sown_path.sub!(/\([^)]+\)/, val) }
      end
      sown_path
    end

    # Build this route as an static file and place it relative to
    #   {LeanWeb::PUBLIC_PATH}.
    #
    # @param request_path [String] Request path for dynamic (regex) routes.
    def build(request_path = @path)
      response = respond(
        Rack::Request.new(
          { 'PATH_INFO' => request_path, 'REQUEST_METHOD' => 'GET' }
        )
      )
      out_path = output_path(request_path, response[1]['Content-Type'] || nil)
      FileUtils.mkdir_p(File.dirname(out_path))

      File.write(out_path, response[2][0])
    end

    protected

    # Assign value to `@action`.
    def action=(value)
      @action = if value.instance_of?(Proc)
                  value
                else
                  Action.new(**prepare_action_hash(value))
                end
    end

    # @param value [Hash, String, nil] Check {#initialize} action param for
    #   valid input.
    # @return [Hash] valid hash for {Action}.
    def prepare_action_hash(value)
      begin
        value[:file], value[:action] = value.first \
          unless %i[file controller action].include?(value.keys.first)
      rescue NoMethodError
        value = { action: value }
      end
      value[:file] ||= 'main'
      value[:controller] ||= "#{value[:file].capitalize}Controller"
      value[:action] ||= "#{path_basename}_#{@method.downcase}"
      value
    end

    # @param request [Rack::Request]
    # @return [Array] a valid Rack response.
    def respond_method(request)
      params = action_params(request.path)
      require_relative("#{LeanWeb::CONTROLLER_PATH}/#{@action.file}")
      controller = Object.const_get(@action.controller).new(self, request)
      return controller.public_send(@action.action, **params)\
        if params.instance_of?(Hash)

      controller.public_send(@action.action, *params)
    end

    # @param request [Rack::Request]
    # @return [Array] a valid Rack response.
    def respond_proc(request)
      params = action_params(request.path)
      return @action.call(**params) if params.instance_of?(Hash)

      @action.call(*params)
    end

    # @param request_path [String]
    # @return [Array, Hash]
    def action_params(request_path)
      return nil unless @path.instance_of?(Regexp)

      matches = @path.match(request_path)
      return matches.named_captures.transform_keys(&:to_sym)\
        if matches.named_captures != {}

      matches.captures
    end

    # Output path for public file.
    #
    # @param path [String]
    # @param content_type [String]
    # @return [String] absolute route to path + extension based on content_type.
    def output_path(path, content_type)
      path += 'index' if path[-1] == '/'
      "#{LeanWeb::PUBLIC_PATH}#{path}#{LeanWeb::MEDIA_EXTENSIONS[content_type]}"
    end
  end
end

A  => test/.rubocop.yml +6 -0
@@ 1,6 @@
inherit_from: ../.rubocop.yml

require: rubocop-minitest

Metrics/ClassLength:
  Enabled: False

A  => test/app_test.rb +129 -0
@@ 1,129 @@
# frozen_string_literal: true

# Copyright 2022 Felix Freeman <libsys@hacktivista.org>
#
# This file is part of "LeanWeb" and licensed under the terms of the Hacktivista
# General Public License version 0.1 or (at your option) any later version. You
# should have received a copy of this license along with the software. If not,
# see <https://hacktivista.org/licenses/>.

require 'fileutils'
require 'rack'
require 'test_helper'

# App tests.
class AppTest < Minitest::Test
  def test_call__unknown_route
    app = LeanWeb::App.new([{ path: '/' }])
    assert_equal([404, {}, ['Not found']], app.call(env('/unknown')))
  end

  def test_call__string_path
    app = LeanWeb::App.new(
      [{
        path: '/',
        action: -> { Rack::Response.new('index').finish }
      }]
    )
    assert_equal([200, {}, ['index']], app.call(env('/')))
  end

  def test_call__regex_path
    app = LeanWeb::App.new(
      [{
        path: %r{^/regex/(.+)$},
        action: ->(param) { Rack::Response.new(param).finish }
      }]
    )
    assert_equal([200, {}, ['path']], app.call(env('/regex/path')))
  end

  def test_call__development_serve_static_routes
    app = LeanWeb::App.new(
      [
        { path: '/static', static: true, action: -> { [200, {}, ['static']] } },
        { path: '/dynamic',
          static: false,
          action: -> { [200, {}, ['dynamic']] } }
      ]
    )
    assert_equal([200, {}, ['static']], app.call(env('/static')))
    assert_equal([200, {}, ['dynamic']], app.call(env('/dynamic')))
  end

  def test_call__non_development_serve_only_dynamic_routes
    ENV['RACK_ENV'] = 'any'
    app = LeanWeb::App.new(
      [
        { path: '/static', static: true, action: -> { [200, {}, ['static']] } },
        { path: '/dynamic',
          static: false,
          action: -> { [200, {}, ['dynamic']] } }
      ]
    )
    assert_equal([404, {}, ['Not found']], app.call(env('/static')))
    assert_equal([200, {}, ['dynamic']], app.call(env('/dynamic')))
    ENV['RACK_ENV'] = 'development'
  end

  def test_build_static__string_paths
    FileUtils.mkdir_p(LeanWeb::PUBLIC_PATH)
    LeanWeb::App.new(
      [
        { path: '/', action: -> { [200, {}, ['index']] } },
        {
          path: '/inner/test',
          action: -> { [200, { 'Content-Type' => 'text/plain' }, ['test']] }
        }, {
          path: '/json_test',
          action: lambda do
            [200, { 'Content-Type' => 'application/json' }, ['test']]
          end
        }
      ]
    ).build_static
    assert_equal('index', File.read("#{LeanWeb::PUBLIC_PATH}/index.html"))
    assert_equal('test', File.read("#{LeanWeb::PUBLIC_PATH}/inner/test.txt"))
    assert_equal('test', File.read("#{LeanWeb::PUBLIC_PATH}/json_test.json"))
    FileUtils.rm_r(LeanWeb::PUBLIC_PATH)
  end

  def test_build_static__regex_paths
    FileUtils.mkdir_p(LeanWeb::PUBLIC_PATH)
    LeanWeb::App.new(
      [
        {
          path: %r{^/positional/(.+)$},
          action: ->(param) { [200, {}, [param]] },
          static: [['route1'], ['route2']]
        }, {
          path: %r{^/positional/([^/]+)/(.+)$},
          action: ->(param1, param2) { [200, {}, ["#{param1} #{param2}"]] },
          static: [%w[route1-1 route1-2], %w[route2-1 route2-2]]
        }, {
          path: %r{^/named/(?<named1>[^/]+)/(?<named2>.+)$},
          action: ->(named1:, named2:) { [200, {}, ["#{named1} #{named2}"]] },
          static: [
            { named1: 'route1-1', named2: 'route1-2' },
            { named1: 'route2-1', named2: 'route2-2' }
          ]
        }
      ]
    ).build_static
    ['/positional/route1', '/positional/route2',
     '/positional/route1-1/route1-2', '/positional/route2-1/route2-2',
     '/named/route1-1/route1-2', '/named/route2-1/route2-2'].each do |path|
      assert_path_exists("#{LeanWeb::PUBLIC_PATH}/#{path}.html")
    end
    FileUtils.rm_r(LeanWeb::PUBLIC_PATH)
  end

  def test_init__from_routes_file
    Tempfile.create do |file|
      file.write("[{ path: '/' }]")
      file.rewind
      app = LeanWeb::App.init(file.path)
      assert_equal('/', app.routes[0][:path])
    end
  end
end

A  => test/controller_test.rb +135 -0
@@ 1,135 @@
# frozen_string_literal: true

# Copyright 2022 Felix Freeman <libsys@hacktivista.org>
#
# This file is part of "LeanWeb" and licensed under the terms of the Hacktivista
# General Public License version 0.1 or (at your option) any later version. You
# should have received a copy of this license along with the software. If not,
# see <https://hacktivista.org/licenses/>.

require 'tempfile'
require 'fileutils'
require 'securerandom'
require 'test_helper'

# Controller tests.
class ControllerTest < Minitest::Test
  def test_render__relative_path_index
    FileUtils.mkdir_p("#{LeanWeb::VIEW_PATH}/inner/path")
    File.open("#{LeanWeb::VIEW_PATH}/inner/path/index.html", 'w') do |file|
      file.write('im an index')
      file.rewind
      route = LeanWeb::Route.new(path: '/inner/path/')
      controller = LeanWeb::Controller.new(route)
      assert_equal(
        'im an index',
        controller.render('index.html')[2][0]
      )
    end
    FileUtils.rm_r("#{LeanWeb::VIEW_PATH}/inner")
  end

  def test_render__view_path
    Tempfile.create('', LeanWeb::VIEW_PATH) do |file|
      file.write('content')
      file.rewind
      route = LeanWeb::Route.new(path: '/any/path')
      controller = LeanWeb::Controller.new(route)
      assert_equal(
        'content',
        controller.render("~/#{File.basename(file.path)}")[2][0]
      )
    end
  end

  def test_render__relative_path
    write_view('content', '.txt') do |route, file|
      controller = LeanWeb::Controller.new(route)
      assert_equal(
        'content',
        controller.render(File.basename(file.path))[2][0]
      )
    end
  end

  def test_render__relative_path_regex # rubocop:disable Metrics/MethodLength
    inner_dir = "/#{SecureRandom.alphanumeric(10)}"
    view_path = LeanWeb::VIEW_PATH + inner_dir
    FileUtils.mkdir_p(view_path)
    Tempfile.create(['', '.txt'], view_path) do |file|
      file.write('content')
      file.rewind
      controller = LeanWeb::Controller.new(
        LeanWeb::Route.new(path: Regexp.new("#{inner_dir}/(.+)"))
      )
      assert_equal(
        'content',
        controller.render(File.basename(file.path))[2][0]
      )
    end
    FileUtils.rm_r(view_path)
  end

  def test_render__absolute_path
    write_view('content') do |route, file|
      controller = LeanWeb::Controller.new(route)
      assert_equal(
        'content',
        controller.render(file.path)[2][0]
      )
    end
  end

  def test_render__with_request
    write_view('= @request', '.haml') do |route, file|
      controller = LeanWeb::Controller.new(
        route, "I'm not really a request"
      )
      assert_equal(
        "I'm not really a request\n",
        controller.render(file.path)[2][0]
      )
    end
  end

  def test_render__haml_filetype
    write_view('%p haml', '.haml') do |route, file|
      controller = LeanWeb::Controller.new(route)
      assert_equal("<p>haml</p>\n", controller.render(file.path)[2][0])
    end
  end

  def test_render__unknown_filetype
    write_view('<%= @request %>', '.asdasd') do |route, file|
      controller = LeanWeb::Controller.new(route, 'hey')
      assert_equal('hey', controller.render(file.path)[2][0])
    end
  end

  def test_render__with_content_type
    write_view('') do |route, file|
      controller = LeanWeb::Controller.new(route, 'hey')
      assert_equal(
        'text/test',
        controller.render(file.path, 'text/test')[1]['Content-Type']
      )
    end
  end

  protected

  # Writes a view on a random file and opens a block for working with it.
  # @param content [String] Code to be evaluated inside view.
  # @param file_extension [String] in `.ext` format.
  # @yieldparam [LeanWeb::Route] route to request this view.
  # @yieldparam [Tempfile] this view file.
  def write_view(content, file_extension = nil)
    FileUtils.mkdir_p(LeanWeb::VIEW_PATH)
    Tempfile.create(['', file_extension], LeanWeb::VIEW_PATH) do |file|
      route_path = "/#{File.basename(file.path, file_extension || '')}"
      file.write(content)
      file.rewind
      yield(LeanWeb::Route.new(path: route_path), file)
    end
  end
end

A  => test/route_test.rb +239 -0
@@ 1,239 @@
# frozen_string_literal: true

# Copyright 2022 Felix Freeman <libsys@hacktivista.org>
#
# This file is part of "LeanWeb" and licensed under the terms of the Hacktivista
# General Public License version 0.1 or (at your option) any later version. You
# should have received a copy of this license along with the software. If not,
# see <https://hacktivista.org/licenses/>.

require 'rack'
require 'test_helper'

# Route tests.
class RouteTest < Minitest::Test
  def test_new__path_only
    route = LeanWeb::Route.new(path: '/')
    assert_equal(
      ['/', 'GET', %w[main MainController index_get], true],
      route_to_array(route)
    )
  end

  def test_new__action_string
    route = LeanWeb::Route.new(path: '/', action: 'action')
    assert_equal(
      %w[main MainController action],
      Array(route.action)
    )
  end

  def test_new__action_tuple
    route = LeanWeb::Route.new(path: '/', action: { 'controller' => 'action' })
    assert_equal(
      %w[controller ControllerController action],
      Array(route.action)
    )
  end

  def test_new__action_file_only_hash
    route = LeanWeb::Route.new(path: '/', action: { file: 'file' })
    assert_equal(
      %w[file FileController index_get],
      Array(route.action)
    )
  end

  def test_new__action_controller_only_hash
    route = LeanWeb::Route.new(path: '/', action: { controller: 'controller' })
    assert_equal(
      %w[main controller index_get],
      Array(route.action)
    )
  end

  def test_new__action_action_only_hash
    route = LeanWeb::Route.new(path: '/', action: { action: 'action' })
    assert_equal(
      %w[main MainController action],
      Array(route.action)
    )
  end

  def test_new__action_full_hash
    route = LeanWeb::Route.new(
      path: '/',
      action: { file: 'file', controller: 'controller', action: 'action' }
    )
    assert_equal(
      %w[file controller action],
      Array(route.action)
    )
  end

  def test_new__all_params
    route = LeanWeb::Route.new(
      path: '/path', method: 'POST', action: 'path_post', static: false
    )
    assert_equal(
      ['/path', 'POST', %w[main MainController path_post], false],
      route_to_array(route)
    )
  end

  def test_path_basename__simple
    route = LeanWeb::Route.new(path: '/simple_path')
    assert_equal('simple_path', route.path_basename)
  end

  def test_path_basename__nested
    route = LeanWeb::Route.new(path: '/a/nested/path')
    assert_equal('path', route.path_basename)
  end

  def test_path_basename__index
    route = LeanWeb::Route.new(path: '/')
    assert_equal('index', route.path_basename)
  end

  def test_path_basename__nested_index
    route = LeanWeb::Route.new(path: '/nested/')
    assert_equal('index', route.path_basename)
  end

  def test_respond__method_no_params
    write_controller(
      'Rack::Response.new("default_action").finish'
    ) do |action|
      route = LeanWeb::Route.new(path: '/', action: action)
      assert_equal(
        [200, {}, ['default_action']],
        route.respond(Rack::Request.new(env('/')))
      )
    end
  end

  def test_respond__method_positional_params
    write_controller(
      'Rack::Response.new("#{param1} #{param2}").finish', # rubocop: disable all
      'positional_get(param1, param2)'
    ) do |action|
      route = LeanWeb::Route.new(
        path: %r{^/method/pos/([^/]+)/(.+)$},
        action: action
      )
      assert_equal(
        [200, {}, ['dynamic route']],
        route.respond(Rack::Request.new(env('/method/pos/dynamic/route')))
      )
    end
  end

  def test_respond__method_keyword_params
    write_controller(
      'Rack::Response.new("#{named1} #{named2}").finish', # rubocop: disable all
      'named_get(named1:, named2:)'
    ) do |action|
      route = LeanWeb::Route.new(
        path: %r{^/method/named/(?<named1>[^/]+)/(?<named2>.+)$},
        action: action
      )
      assert_equal(
        [200, {}, ['dynamic route']],
        route.respond(Rack::Request.new(env('/method/named/dynamic/route')))
      )
    end
  end

  def test_respond__proc
    route = LeanWeb::Route.new(
      path: '/',
      action: -> { Rack::Response.new('proc_response').finish }
    )
    assert_equal(
      [200, {}, ['proc_response']],
      route.respond(Rack::Request.new(env('/')))
    )
  end

  def test_respond__proc_positional_params
    route = LeanWeb::Route.new(
      path: %r{^/proc/positional/([^/]+)/(.+)$},
      action: lambda do |param1, param2|
        Rack::Response.new("#{param1} #{param2}").finish
      end
    )
    assert_equal(
      [200, {}, ['dynamic route']],
      route.respond(Rack::Request.new(env('/proc/positional/dynamic/route')))
    )
  end

  def test_respond__proc_keyword_params
    route = LeanWeb::Route.new(
      path: %r{^/proc/named/(?<named1>[^/]+)/(?<named2>.+)$},
      action: lambda do |named1:, named2:|
        Rack::Response.new("#{named1} #{named2}").finish
      end
    )
    assert_equal(
      [200, {}, ['dynamic route']],
      route.respond(Rack::Request.new(env('/proc/named/dynamic/route')))
    )
  end

  def test_seed_path__hash
    route = LeanWeb::Route.new(path: %r{^/(?<named1>[^/]+)/(?<named2>.+)$})
    assert_equal(
      '/hash/path',
      route.seed_path({ named1: 'hash', named2: 'path' })
    )
  end

  def test_seed_path__array
    route = LeanWeb::Route.new(path: %r{^/([^/]+)/(.+)$})
    assert_equal('/hash/path', route.seed_path(%w[hash path]))
  end

  protected

  def route_to_array(route)
    [route.path, route.method, Array(route.action), route.static]
  end

  def random_word(length = 10)
    chars = [*('a'..'z')]
    word = ''
    length.times { word += chars[rand(chars.size)] }
    word
  end

  # Writes a controller on a random file and opens a block for working with it.
  # @param response [String] Code to be evaluated inside action.
  # @param action [String] Defaults to random word. You can use params too.
  # @param controller [String] Defaults to random word.
  # @yieldparam [Hash] ready-to-use Route action hash.
  # @yieldparam [Tempfile] this controller file.
  def write_controller(
    response, action = random_word, controller = random_word.capitalize
  )
    FileUtils.mkdir_p(LeanWeb::CONTROLLER_PATH)
    Tempfile.create(['', '.rb'], LeanWeb::CONTROLLER_PATH) do |file|
      file.write(
        <<~RUBY
          require 'leanweb'
          require 'rack'
          class #{controller} < LeanWeb::Controller
            def #{action}
              #{response}
            end
          end
        RUBY
      )
      file.rewind
      yield({ file: File.basename(file.path, '.rb'),
              controller: controller,
              action: action.sub(/\(.*/, '') }, file)
    end
  end
end

A  => test/test_helper.rb +20 -0
@@ 1,20 @@
# frozen_string_literal: true

# Copyright 2022 Felix Freeman <libsys@hacktivista.org>
#
# This file is part of "LeanWeb" and licensed under the terms of the Hacktivista
# General Public License version 0.1 or (at your option) any later version. You
# should have received a copy of this license along with the software. If not,
# see <https://hacktivista.org/licenses/>.

ENV['LEANWEB_ROOT_PATH'] = '/tmp/leanweb'
ENV['RACK_ENV'] = 'development'

$LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
require 'leanweb'

require 'minitest/autorun'

def env(request_path, request_method = 'GET')
  { 'PATH_INFO' => request_path, 'REQUEST_METHOD' => request_method }
end