diff --git a/Changelog.md b/Changelog.md
new file mode 100644
--- /dev/null
+++ b/Changelog.md
@@ -0,0 +1,29 @@
+### 22 Aug 2015
+- Bumped up the resolver for stack-7.10.yaml from `resolver: ghc-7.10` to `resolver: lts-3.0`
+- Changed travis.yaml to reflect guidelines in [https://github.com/commercialhaskell/stack/wiki/FAQ](https://github.com/commercialhaskell/stack/wiki/FAQ)
+- Added travis_long from [https://github.com/fpco/ide-backend/blob/master/travis_long](https://github.com/fpco/ide-backend/blob/master/travis_long)
+- Removed example cats/
+- Cleans up after ghc's -ddump-hi -ddump-to-file
+- Fixed [issue #3](https://github.com/urbanslug/wai-devel/issues/3)
+
+
+### 11 Oct 2015
+- Added support for cabal binary.
+- Can find dependencies from stack's extra-deps field of stack.yaml
+- Added better test coverage.
+
+
+### 21 Dec 2015
+- Change license to MIT to better go with other WAI projects.
+- Added --version or -v to print wai-devel version.
+
+
+### 11 Feb 2016
+- Build progress in the browser
+- Pushed the resolver up to lts-5.2
+- Fixed haddocks
+- Fixed issue #16
+
+### 12 Feb 2016
+- Version bump 0.0.0.3
+- Fixed issue #21
diff --git a/LICENSE b/LICENSE
--- a/LICENSE
+++ b/LICENSE
@@ -1,674 +1,20 @@
- GNU GENERAL PUBLIC LICENSE
- Version 3, 29 June 2007
-
- Copyright (C) 2007 Free Software Foundation, Inc.
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-
- Preamble
-
- The GNU General Public License is a free, copyleft license for
-software and other kinds of works.
-
- The licenses for most software and other practical works are designed
-to take away your freedom to share and change the works. By contrast,
-the GNU General Public License is intended to guarantee your freedom to
-share and change all versions of a program--to make sure it remains free
-software for all its users. We, the Free Software Foundation, use the
-GNU General Public License for most of our software; it applies also to
-any other work released this way by its authors. You can apply it to
-your programs, too.
-
- When we speak of free software, we are referring to freedom, not
-price. Our General Public Licenses are designed to make sure that you
-have the freedom to distribute copies of free software (and charge for
-them if you wish), that you receive source code or can get it if you
-want it, that you can change the software or use pieces of it in new
-free programs, and that you know you can do these things.
-
- To protect your rights, we need to prevent others from denying you
-these rights or asking you to surrender the rights. Therefore, you have
-certain responsibilities if you distribute copies of the software, or if
-you modify it: responsibilities to respect the freedom of others.
-
- For example, if you distribute copies of such a program, whether
-gratis or for a fee, you must pass on to the recipients the same
-freedoms that you received. You must make sure that they, too, receive
-or can get the source code. And you must show them these terms so they
-know their rights.
-
- Developers that use the GNU GPL protect your rights with two steps:
-(1) assert copyright on the software, and (2) offer you this License
-giving you legal permission to copy, distribute and/or modify it.
-
- For the developers' and authors' protection, the GPL clearly explains
-that there is no warranty for this free software. For both users' and
-authors' sake, the GPL requires that modified versions be marked as
-changed, so that their problems will not be attributed erroneously to
-authors of previous versions.
-
- Some devices are designed to deny users access to install or run
-modified versions of the software inside them, although the manufacturer
-can do so. This is fundamentally incompatible with the aim of
-protecting users' freedom to change the software. The systematic
-pattern of such abuse occurs in the area of products for individuals to
-use, which is precisely where it is most unacceptable. Therefore, we
-have designed this version of the GPL to prohibit the practice for those
-products. If such problems arise substantially in other domains, we
-stand ready to extend this provision to those domains in future versions
-of the GPL, as needed to protect the freedom of users.
-
- Finally, every program is threatened constantly by software patents.
-States should not allow patents to restrict development and use of
-software on general-purpose computers, but in those that do, we wish to
-avoid the special danger that patents applied to a free program could
-make it effectively proprietary. To prevent this, the GPL assures that
-patents cannot be used to render the program non-free.
-
- The precise terms and conditions for copying, distribution and
-modification follow.
-
- TERMS AND CONDITIONS
-
- 0. Definitions.
-
- "This License" refers to version 3 of the GNU General Public License.
-
- "Copyright" also means copyright-like laws that apply to other kinds of
-works, such as semiconductor masks.
-
- "The Program" refers to any copyrightable work licensed under this
-License. Each licensee is addressed as "you". "Licensees" and
-"recipients" may be individuals or organizations.
-
- To "modify" a work means to copy from or adapt all or part of the work
-in a fashion requiring copyright permission, other than the making of an
-exact copy. The resulting work is called a "modified version" of the
-earlier work or a work "based on" the earlier work.
-
- A "covered work" means either the unmodified Program or a work based
-on the Program.
-
- To "propagate" a work means to do anything with it that, without
-permission, would make you directly or secondarily liable for
-infringement under applicable copyright law, except executing it on a
-computer or modifying a private copy. Propagation includes copying,
-distribution (with or without modification), making available to the
-public, and in some countries other activities as well.
-
- To "convey" a work means any kind of propagation that enables other
-parties to make or receive copies. Mere interaction with a user through
-a computer network, with no transfer of a copy, is not conveying.
-
- An interactive user interface displays "Appropriate Legal Notices"
-to the extent that it includes a convenient and prominently visible
-feature that (1) displays an appropriate copyright notice, and (2)
-tells the user that there is no warranty for the work (except to the
-extent that warranties are provided), that licensees may convey the
-work under this License, and how to view a copy of this License. If
-the interface presents a list of user commands or options, such as a
-menu, a prominent item in the list meets this criterion.
-
- 1. Source Code.
-
- The "source code" for a work means the preferred form of the work
-for making modifications to it. "Object code" means any non-source
-form of a work.
-
- A "Standard Interface" means an interface that either is an official
-standard defined by a recognized standards body, or, in the case of
-interfaces specified for a particular programming language, one that
-is widely used among developers working in that language.
-
- The "System Libraries" of an executable work include anything, other
-than the work as a whole, that (a) is included in the normal form of
-packaging a Major Component, but which is not part of that Major
-Component, and (b) serves only to enable use of the work with that
-Major Component, or to implement a Standard Interface for which an
-implementation is available to the public in source code form. A
-"Major Component", in this context, means a major essential component
-(kernel, window system, and so on) of the specific operating system
-(if any) on which the executable work runs, or a compiler used to
-produce the work, or an object code interpreter used to run it.
-
- The "Corresponding Source" for a work in object code form means all
-the source code needed to generate, install, and (for an executable
-work) run the object code and to modify the work, including scripts to
-control those activities. However, it does not include the work's
-System Libraries, or general-purpose tools or generally available free
-programs which are used unmodified in performing those activities but
-which are not part of the work. For example, Corresponding Source
-includes interface definition files associated with source files for
-the work, and the source code for shared libraries and dynamically
-linked subprograms that the work is specifically designed to require,
-such as by intimate data communication or control flow between those
-subprograms and other parts of the work.
-
- The Corresponding Source need not include anything that users
-can regenerate automatically from other parts of the Corresponding
-Source.
-
- The Corresponding Source for a work in source code form is that
-same work.
-
- 2. Basic Permissions.
-
- All rights granted under this License are granted for the term of
-copyright on the Program, and are irrevocable provided the stated
-conditions are met. This License explicitly affirms your unlimited
-permission to run the unmodified Program. The output from running a
-covered work is covered by this License only if the output, given its
-content, constitutes a covered work. This License acknowledges your
-rights of fair use or other equivalent, as provided by copyright law.
-
- You may make, run and propagate covered works that you do not
-convey, without conditions so long as your license otherwise remains
-in force. You may convey covered works to others for the sole purpose
-of having them make modifications exclusively for you, or provide you
-with facilities for running those works, provided that you comply with
-the terms of this License in conveying all material for which you do
-not control copyright. Those thus making or running the covered works
-for you must do so exclusively on your behalf, under your direction
-and control, on terms that prohibit them from making any copies of
-your copyrighted material outside their relationship with you.
-
- Conveying under any other circumstances is permitted solely under
-the conditions stated below. Sublicensing is not allowed; section 10
-makes it unnecessary.
-
- 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
-
- No covered work shall be deemed part of an effective technological
-measure under any applicable law fulfilling obligations under article
-11 of the WIPO copyright treaty adopted on 20 December 1996, or
-similar laws prohibiting or restricting circumvention of such
-measures.
-
- When you convey a covered work, you waive any legal power to forbid
-circumvention of technological measures to the extent such circumvention
-is effected by exercising rights under this License with respect to
-the covered work, and you disclaim any intention to limit operation or
-modification of the work as a means of enforcing, against the work's
-users, your or third parties' legal rights to forbid circumvention of
-technological measures.
-
- 4. Conveying Verbatim Copies.
-
- You may convey verbatim copies of the Program's source code as you
-receive it, in any medium, provided that you conspicuously and
-appropriately publish on each copy an appropriate copyright notice;
-keep intact all notices stating that this License and any
-non-permissive terms added in accord with section 7 apply to the code;
-keep intact all notices of the absence of any warranty; and give all
-recipients a copy of this License along with the Program.
-
- You may charge any price or no price for each copy that you convey,
-and you may offer support or warranty protection for a fee.
-
- 5. Conveying Modified Source Versions.
-
- You may convey a work based on the Program, or the modifications to
-produce it from the Program, in the form of source code under the
-terms of section 4, provided that you also meet all of these conditions:
-
- a) The work must carry prominent notices stating that you modified
- it, and giving a relevant date.
-
- b) The work must carry prominent notices stating that it is
- released under this License and any conditions added under section
- 7. This requirement modifies the requirement in section 4 to
- "keep intact all notices".
-
- c) You must license the entire work, as a whole, under this
- License to anyone who comes into possession of a copy. This
- License will therefore apply, along with any applicable section 7
- additional terms, to the whole of the work, and all its parts,
- regardless of how they are packaged. This License gives no
- permission to license the work in any other way, but it does not
- invalidate such permission if you have separately received it.
-
- d) If the work has interactive user interfaces, each must display
- Appropriate Legal Notices; however, if the Program has interactive
- interfaces that do not display Appropriate Legal Notices, your
- work need not make them do so.
-
- A compilation of a covered work with other separate and independent
-works, which are not by their nature extensions of the covered work,
-and which are not combined with it such as to form a larger program,
-in or on a volume of a storage or distribution medium, is called an
-"aggregate" if the compilation and its resulting copyright are not
-used to limit the access or legal rights of the compilation's users
-beyond what the individual works permit. Inclusion of a covered work
-in an aggregate does not cause this License to apply to the other
-parts of the aggregate.
-
- 6. Conveying Non-Source Forms.
-
- You may convey a covered work in object code form under the terms
-of sections 4 and 5, provided that you also convey the
-machine-readable Corresponding Source under the terms of this License,
-in one of these ways:
-
- a) Convey the object code in, or embodied in, a physical product
- (including a physical distribution medium), accompanied by the
- Corresponding Source fixed on a durable physical medium
- customarily used for software interchange.
-
- b) Convey the object code in, or embodied in, a physical product
- (including a physical distribution medium), accompanied by a
- written offer, valid for at least three years and valid for as
- long as you offer spare parts or customer support for that product
- model, to give anyone who possesses the object code either (1) a
- copy of the Corresponding Source for all the software in the
- product that is covered by this License, on a durable physical
- medium customarily used for software interchange, for a price no
- more than your reasonable cost of physically performing this
- conveying of source, or (2) access to copy the
- Corresponding Source from a network server at no charge.
-
- c) Convey individual copies of the object code with a copy of the
- written offer to provide the Corresponding Source. This
- alternative is allowed only occasionally and noncommercially, and
- only if you received the object code with such an offer, in accord
- with subsection 6b.
-
- d) Convey the object code by offering access from a designated
- place (gratis or for a charge), and offer equivalent access to the
- Corresponding Source in the same way through the same place at no
- further charge. You need not require recipients to copy the
- Corresponding Source along with the object code. If the place to
- copy the object code is a network server, the Corresponding Source
- may be on a different server (operated by you or a third party)
- that supports equivalent copying facilities, provided you maintain
- clear directions next to the object code saying where to find the
- Corresponding Source. Regardless of what server hosts the
- Corresponding Source, you remain obligated to ensure that it is
- available for as long as needed to satisfy these requirements.
-
- e) Convey the object code using peer-to-peer transmission, provided
- you inform other peers where the object code and Corresponding
- Source of the work are being offered to the general public at no
- charge under subsection 6d.
-
- A separable portion of the object code, whose source code is excluded
-from the Corresponding Source as a System Library, need not be
-included in conveying the object code work.
-
- A "User Product" is either (1) a "consumer product", which means any
-tangible personal property which is normally used for personal, family,
-or household purposes, or (2) anything designed or sold for incorporation
-into a dwelling. In determining whether a product is a consumer product,
-doubtful cases shall be resolved in favor of coverage. For a particular
-product received by a particular user, "normally used" refers to a
-typical or common use of that class of product, regardless of the status
-of the particular user or of the way in which the particular user
-actually uses, or expects or is expected to use, the product. A product
-is a consumer product regardless of whether the product has substantial
-commercial, industrial or non-consumer uses, unless such uses represent
-the only significant mode of use of the product.
-
- "Installation Information" for a User Product means any methods,
-procedures, authorization keys, or other information required to install
-and execute modified versions of a covered work in that User Product from
-a modified version of its Corresponding Source. The information must
-suffice to ensure that the continued functioning of the modified object
-code is in no case prevented or interfered with solely because
-modification has been made.
-
- If you convey an object code work under this section in, or with, or
-specifically for use in, a User Product, and the conveying occurs as
-part of a transaction in which the right of possession and use of the
-User Product is transferred to the recipient in perpetuity or for a
-fixed term (regardless of how the transaction is characterized), the
-Corresponding Source conveyed under this section must be accompanied
-by the Installation Information. But this requirement does not apply
-if neither you nor any third party retains the ability to install
-modified object code on the User Product (for example, the work has
-been installed in ROM).
-
- The requirement to provide Installation Information does not include a
-requirement to continue to provide support service, warranty, or updates
-for a work that has been modified or installed by the recipient, or for
-the User Product in which it has been modified or installed. Access to a
-network may be denied when the modification itself materially and
-adversely affects the operation of the network or violates the rules and
-protocols for communication across the network.
-
- Corresponding Source conveyed, and Installation Information provided,
-in accord with this section must be in a format that is publicly
-documented (and with an implementation available to the public in
-source code form), and must require no special password or key for
-unpacking, reading or copying.
-
- 7. Additional Terms.
-
- "Additional permissions" are terms that supplement the terms of this
-License by making exceptions from one or more of its conditions.
-Additional permissions that are applicable to the entire Program shall
-be treated as though they were included in this License, to the extent
-that they are valid under applicable law. If additional permissions
-apply only to part of the Program, that part may be used separately
-under those permissions, but the entire Program remains governed by
-this License without regard to the additional permissions.
-
- When you convey a copy of a covered work, you may at your option
-remove any additional permissions from that copy, or from any part of
-it. (Additional permissions may be written to require their own
-removal in certain cases when you modify the work.) You may place
-additional permissions on material, added by you to a covered work,
-for which you have or can give appropriate copyright permission.
-
- Notwithstanding any other provision of this License, for material you
-add to a covered work, you may (if authorized by the copyright holders of
-that material) supplement the terms of this License with terms:
-
- a) Disclaiming warranty or limiting liability differently from the
- terms of sections 15 and 16 of this License; or
-
- b) Requiring preservation of specified reasonable legal notices or
- author attributions in that material or in the Appropriate Legal
- Notices displayed by works containing it; or
-
- c) Prohibiting misrepresentation of the origin of that material, or
- requiring that modified versions of such material be marked in
- reasonable ways as different from the original version; or
-
- d) Limiting the use for publicity purposes of names of licensors or
- authors of the material; or
-
- e) Declining to grant rights under trademark law for use of some
- trade names, trademarks, or service marks; or
-
- f) Requiring indemnification of licensors and authors of that
- material by anyone who conveys the material (or modified versions of
- it) with contractual assumptions of liability to the recipient, for
- any liability that these contractual assumptions directly impose on
- those licensors and authors.
-
- All other non-permissive additional terms are considered "further
-restrictions" within the meaning of section 10. If the Program as you
-received it, or any part of it, contains a notice stating that it is
-governed by this License along with a term that is a further
-restriction, you may remove that term. If a license document contains
-a further restriction but permits relicensing or conveying under this
-License, you may add to a covered work material governed by the terms
-of that license document, provided that the further restriction does
-not survive such relicensing or conveying.
-
- If you add terms to a covered work in accord with this section, you
-must place, in the relevant source files, a statement of the
-additional terms that apply to those files, or a notice indicating
-where to find the applicable terms.
-
- Additional terms, permissive or non-permissive, may be stated in the
-form of a separately written license, or stated as exceptions;
-the above requirements apply either way.
-
- 8. Termination.
-
- You may not propagate or modify a covered work except as expressly
-provided under this License. Any attempt otherwise to propagate or
-modify it is void, and will automatically terminate your rights under
-this License (including any patent licenses granted under the third
-paragraph of section 11).
-
- However, if you cease all violation of this License, then your
-license from a particular copyright holder is reinstated (a)
-provisionally, unless and until the copyright holder explicitly and
-finally terminates your license, and (b) permanently, if the copyright
-holder fails to notify you of the violation by some reasonable means
-prior to 60 days after the cessation.
-
- Moreover, your license from a particular copyright holder is
-reinstated permanently if the copyright holder notifies you of the
-violation by some reasonable means, this is the first time you have
-received notice of violation of this License (for any work) from that
-copyright holder, and you cure the violation prior to 30 days after
-your receipt of the notice.
-
- Termination of your rights under this section does not terminate the
-licenses of parties who have received copies or rights from you under
-this License. If your rights have been terminated and not permanently
-reinstated, you do not qualify to receive new licenses for the same
-material under section 10.
-
- 9. Acceptance Not Required for Having Copies.
-
- You are not required to accept this License in order to receive or
-run a copy of the Program. Ancillary propagation of a covered work
-occurring solely as a consequence of using peer-to-peer transmission
-to receive a copy likewise does not require acceptance. However,
-nothing other than this License grants you permission to propagate or
-modify any covered work. These actions infringe copyright if you do
-not accept this License. Therefore, by modifying or propagating a
-covered work, you indicate your acceptance of this License to do so.
-
- 10. Automatic Licensing of Downstream Recipients.
-
- Each time you convey a covered work, the recipient automatically
-receives a license from the original licensors, to run, modify and
-propagate that work, subject to this License. You are not responsible
-for enforcing compliance by third parties with this License.
-
- An "entity transaction" is a transaction transferring control of an
-organization, or substantially all assets of one, or subdividing an
-organization, or merging organizations. If propagation of a covered
-work results from an entity transaction, each party to that
-transaction who receives a copy of the work also receives whatever
-licenses to the work the party's predecessor in interest had or could
-give under the previous paragraph, plus a right to possession of the
-Corresponding Source of the work from the predecessor in interest, if
-the predecessor has it or can get it with reasonable efforts.
-
- You may not impose any further restrictions on the exercise of the
-rights granted or affirmed under this License. For example, you may
-not impose a license fee, royalty, or other charge for exercise of
-rights granted under this License, and you may not initiate litigation
-(including a cross-claim or counterclaim in a lawsuit) alleging that
-any patent claim is infringed by making, using, selling, offering for
-sale, or importing the Program or any portion of it.
-
- 11. Patents.
-
- A "contributor" is a copyright holder who authorizes use under this
-License of the Program or a work on which the Program is based. The
-work thus licensed is called the contributor's "contributor version".
-
- A contributor's "essential patent claims" are all patent claims
-owned or controlled by the contributor, whether already acquired or
-hereafter acquired, that would be infringed by some manner, permitted
-by this License, of making, using, or selling its contributor version,
-but do not include claims that would be infringed only as a
-consequence of further modification of the contributor version. For
-purposes of this definition, "control" includes the right to grant
-patent sublicenses in a manner consistent with the requirements of
-this License.
-
- Each contributor grants you a non-exclusive, worldwide, royalty-free
-patent license under the contributor's essential patent claims, to
-make, use, sell, offer for sale, import and otherwise run, modify and
-propagate the contents of its contributor version.
-
- In the following three paragraphs, a "patent license" is any express
-agreement or commitment, however denominated, not to enforce a patent
-(such as an express permission to practice a patent or covenant not to
-sue for patent infringement). To "grant" such a patent license to a
-party means to make such an agreement or commitment not to enforce a
-patent against the party.
-
- If you convey a covered work, knowingly relying on a patent license,
-and the Corresponding Source of the work is not available for anyone
-to copy, free of charge and under the terms of this License, through a
-publicly available network server or other readily accessible means,
-then you must either (1) cause the Corresponding Source to be so
-available, or (2) arrange to deprive yourself of the benefit of the
-patent license for this particular work, or (3) arrange, in a manner
-consistent with the requirements of this License, to extend the patent
-license to downstream recipients. "Knowingly relying" means you have
-actual knowledge that, but for the patent license, your conveying the
-covered work in a country, or your recipient's use of the covered work
-in a country, would infringe one or more identifiable patents in that
-country that you have reason to believe are valid.
-
- If, pursuant to or in connection with a single transaction or
-arrangement, you convey, or propagate by procuring conveyance of, a
-covered work, and grant a patent license to some of the parties
-receiving the covered work authorizing them to use, propagate, modify
-or convey a specific copy of the covered work, then the patent license
-you grant is automatically extended to all recipients of the covered
-work and works based on it.
-
- A patent license is "discriminatory" if it does not include within
-the scope of its coverage, prohibits the exercise of, or is
-conditioned on the non-exercise of one or more of the rights that are
-specifically granted under this License. You may not convey a covered
-work if you are a party to an arrangement with a third party that is
-in the business of distributing software, under which you make payment
-to the third party based on the extent of your activity of conveying
-the work, and under which the third party grants, to any of the
-parties who would receive the covered work from you, a discriminatory
-patent license (a) in connection with copies of the covered work
-conveyed by you (or copies made from those copies), or (b) primarily
-for and in connection with specific products or compilations that
-contain the covered work, unless you entered into that arrangement,
-or that patent license was granted, prior to 28 March 2007.
-
- Nothing in this License shall be construed as excluding or limiting
-any implied license or other defenses to infringement that may
-otherwise be available to you under applicable patent law.
-
- 12. No Surrender of Others' Freedom.
-
- If conditions are imposed on you (whether by court order, agreement or
-otherwise) that contradict the conditions of this License, they do not
-excuse you from the conditions of this License. If you cannot convey a
-covered work so as to satisfy simultaneously your obligations under this
-License and any other pertinent obligations, then as a consequence you may
-not convey it at all. For example, if you agree to terms that obligate you
-to collect a royalty for further conveying from those to whom you convey
-the Program, the only way you could satisfy both those terms and this
-License would be to refrain entirely from conveying the Program.
-
- 13. Use with the GNU Affero General Public License.
-
- Notwithstanding any other provision of this License, you have
-permission to link or combine any covered work with a work licensed
-under version 3 of the GNU Affero General Public License into a single
-combined work, and to convey the resulting work. The terms of this
-License will continue to apply to the part which is the covered work,
-but the special requirements of the GNU Affero General Public License,
-section 13, concerning interaction through a network will apply to the
-combination as such.
-
- 14. Revised Versions of this License.
-
- The Free Software Foundation may publish revised and/or new versions of
-the GNU General Public License from time to time. Such new versions will
-be similar in spirit to the present version, but may differ in detail to
-address new problems or concerns.
-
- Each version is given a distinguishing version number. If the
-Program specifies that a certain numbered version of the GNU General
-Public License "or any later version" applies to it, you have the
-option of following the terms and conditions either of that numbered
-version or of any later version published by the Free Software
-Foundation. If the Program does not specify a version number of the
-GNU General Public License, you may choose any version ever published
-by the Free Software Foundation.
-
- If the Program specifies that a proxy can decide which future
-versions of the GNU General Public License can be used, that proxy's
-public statement of acceptance of a version permanently authorizes you
-to choose that version for the Program.
-
- Later license versions may give you additional or different
-permissions. However, no additional obligations are imposed on any
-author or copyright holder as a result of your choosing to follow a
-later version.
-
- 15. Disclaimer of Warranty.
-
- THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
-APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
-HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
-OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
-THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
-IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
-ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
-
- 16. Limitation of Liability.
-
- IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
-WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
-THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
-GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
-USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
-DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
-PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
-EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
-SUCH DAMAGES.
-
- 17. Interpretation of Sections 15 and 16.
-
- If the disclaimer of warranty and limitation of liability provided
-above cannot be given local legal effect according to their terms,
-reviewing courts shall apply local law that most closely approximates
-an absolute waiver of all civil liability in connection with the
-Program, unless a warranty or assumption of liability accompanies a
-copy of the Program in return for a fee.
-
- END OF TERMS AND CONDITIONS
-
- How to Apply These Terms to Your New Programs
-
- If you develop a new program, and you want it to be of the greatest
-possible use to the public, the best way to achieve this is to make it
-free software which everyone can redistribute and change under these terms.
-
- To do so, attach the following notices to the program. It is safest
-to attach them to the start of each source file to most effectively
-state the exclusion of warranty; and each file should have at least
-the "copyright" line and a pointer to where the full notice is found.
-
-
- Copyright (C)
-
- This program is free software: you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published by
- the Free Software Foundation, either version 3 of the License, or
- (at your option) any later version.
-
- This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU General Public License for more details.
-
- You should have received a copy of the GNU General Public License
- along with this program. If not, see .
-
-Also add information on how to contact you by electronic and paper mail.
-
- If the program does terminal interaction, make it output a short
-notice like this when it starts in an interactive mode:
-
- Copyright (C)
- 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.
+Copyright (c) 2015 Njagi Mwaniki, http://www.blog.urbanslug.com/
-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".
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
- You should also get your employer (if you work as a programmer) or school,
-if any, to sign a "copyright disclaimer" for the program, if necessary.
-For more information on this, and how to apply and follow the GNU GPL, see
-.
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
- 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
-.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/README.md b/README.md
new file mode 100644
--- /dev/null
+++ b/README.md
@@ -0,0 +1,44 @@
+### wai-devel
+
+[](https://gitter.im/urbanslug/wai-devel?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[](https://travis-ci.org/urbanslug/wai-devel)
+
+Development server for [WAI] compliant haskell web applications.
+
+### Installation
+#### From hackage
+- stack install wai-devel
+or
+- cabal install wai-devel
+
+#### From source
+- cd wai-devel
+- stack build
+- stack install
+or
+- cd wai-devel
+- cabal build
+- cabal install
+
+The wai-devel binary will now be in your ~/.local/bin you can use it freely.
+
+
+### Usage
+See the [wiki].
+
+### Contributing
+No contributing page yet. Just read the haddocks.
+See the [wai-devel minimal reproduction in the wiki].
+
+### Issues
+Doesn't recompile on changes in Template Haskell files. Here is the [specific issue].
+
+### Coming next
+- Provide a dashboard page with compilation status, GC stats, and other such useful meta-information.
+- Port to windows. This depends on ide-backend getting ported to Windows.
+
+
+[WAI]: http://www.yesodweb.com/book/web-application-interface
+[wiki]: https://github.com/urbanslug/wai-devel/wiki
+[specific issue]: https://github.com/fpco/ide-backend/issues/313
+[wai-devel minimal reproduction in the wiki]: https://github.com/urbanslug/wai-devel/wiki/Minimal-reproduction.
diff --git a/app/Main.hs b/app/Main.hs
new file mode 100644
--- /dev/null
+++ b/app/Main.hs
@@ -0,0 +1,15 @@
+{-|
+Module : Main
+Description : The main module for the wai-devel executable.
+Copyright : (c) 2015 Njagi Mwaniki
+License : MIT
+Maintainer : njagi@urbanslug.com
+Stability : experimental
+Portability : POSIX
+-}
+module Main where
+
+import DevelMain
+
+main :: IO ()
+main = develMain
diff --git a/build.hamlet b/build.hamlet
new file mode 100644
--- /dev/null
+++ b/build.hamlet
@@ -0,0 +1,74 @@
+$doctype 5
+
+
+
+ Building wai-devel
+ <style>
+ body {
+ background: #e6e6e6;
+ color: #444;
+ text-shadow: 1px 1px 1px #ffffff;
+ font-size: 30px;
+ font-family: georgia, serif;
+ }
+ .wrap {
+ margin: auto;
+ width: 75%;
+ }
+ #build-log {
+ background: white;
+ color: black;
+ margin: auto;
+ width: 80%;
+ font-size: 16px;
+ }
+ #build-log, ul {
+ list-style: none;
+ }
+ h1 {
+ margin-bottom: 0;
+ }
+ h2 {
+ margin-top: 0;
+ font-size: medium;
+ font-style: italic;
+ color: #546369;
+ }
+ header {
+ padding-bottom: 0.25em;
+ border-bottom: 1px solid #ccc;
+ color: #1a6e8e;
+ }
+ header, #header{
+ font-size: smaller;
+ }
+ footer {
+ color: black;
+ text-align: center;
+ width: 70%;
+ position: absolute;
+ border-top: 1px solid #ccc;
+ padding: 12px 0px 12px 0px;
+ bottom:0;
+ z-index: 1;
+ font-size: small;
+ }
+ #sc {
+ font-size: small;
+ }
+ <body>
+ <div class="wrap">
+ <header>
+ <small>wai-devel
+ <h2>We’re building your application.
+
+ <div id="sc">
+ <script>
+ document.write(new Date())
+
+ <div id="build-log">
+ <ul id="build-log-ul">
+ $forall log <- lstt
+ <li>#{log}
+
+ <footer>Made in Nairobi with love ❤.
diff --git a/refreshing.html b/refreshing.html
deleted file mode 100644
--- a/refreshing.html
+++ /dev/null
@@ -1,86 +0,0 @@
-<!doctype html>
-<html>
- <head>
- <meta charset='utf-8'>
- <title>Building wai-devel
-
-
-
-
- wai-devel
-
The application isn’t built
-
We’ll keep trying to refresh every second
-
-
-
Meanwhile, here is a motivational message:
-
-
You are a beautiful person making a beautiful web site.
-
Keep going, you’ve nearly fixed the bug!
-
Check your posture, don’t lean over too much.
-
Get a glass of water, keep hydrated.
-
-
-
-
-
-
-
diff --git a/src/Devel.hs b/src/Devel.hs
--- a/src/Devel.hs
+++ b/src/Devel.hs
@@ -1,8 +1,8 @@
{-|
Module : Devel
Description : An entry point for GHC to compile yesod-devel.
-Copyright : (c)
-License : GPL-3
+Copyright : (c) 2015 Njagi Mwaniki
+License : MIT
Maintainer : njagi@urbanslug.com
Stability : experimental
Portability : POSIX
@@ -18,9 +18,11 @@
import Devel.ReverseProxy (cyclePorts)
import Devel.Build (build)
+import Data.IORef
+
-- | Build and run our haskell application.
-buildAndRun :: FilePath -> String -> Bool -> IO ()
-buildAndRun buildFile runFunction isReverseProxy = do
+buildAndRun :: FilePath -> String -> [String] -> Bool -> IO ()
+buildAndRun buildFile runFunction watchDirectories isReverseProxy = do
-- set Environment variables: GHC_PACKAGE_PATH and PATH
-- Needed for ide-backend to provide sessionConfig
@@ -50,12 +52,16 @@
then setEnv "PORT" (show toProxyPort)
else setEnv "PORT" (show fromProxyPort)
+ iStrLst <- newIORef [] :: IO (IORef [String])
+
-- We call the build function only the first time we want to build our application.
build
buildFile -- The target file, should contain the function we wish to call.
runFunction -- The function we want to call.
- isReverseProxy -- Use reverse proxying? Default to True.
+ watchDirectories -- Other directories to watch for file changes in.
+ isReverseProxy -- Use reverse proxying? Default to True.
sessionConfig -- We need this when compiling.
(fromProxyPort, toProxyPort) -- The port we reverse proxy to and from.
Nothing -- Maybe IdeSession
False -- To rebuild or not to.
+ iStrLst
diff --git a/src/Devel/Build.hs b/src/Devel/Build.hs
--- a/src/Devel/Build.hs
+++ b/src/Devel/Build.hs
@@ -1,11 +1,14 @@
{-|
Module : Devel.Compile
Description : For building and running your WAI application.
-Copyright : (c)
-License : GPL-3
+Copyright : (c) 2015 Njagi Mwaniki
+License : MIT
Maintainer : njagi@urbanslug.com
Stability : experimental
Portability : POSIX
+
+Does the actual building of your code.
+Most of the work wai-devel does is coordinated from here.
-}
{-# LANGUAGE OverloadedStrings #-}
@@ -33,17 +36,35 @@
import Devel.ReverseProxy (startReverseProxy)
import Devel.Watch
+import Data.IORef
-- | Compiles and calls run on your WAI application.
-build :: FilePath -> String -> Bool -> SessionConfig -> (Int, Int) -> Maybe IdeSession -> Bool -> IO ()
-build buildFile runFunction isReverseProxy sessionConfig (fromProxyPort, toProxyPort) mSession isRebuild = do
+build :: FilePath
+ -> String
+ -> [String]
+ -> Bool
+ -> SessionConfig
+ -> (Int, Int)
+ -> Maybe IdeSession
+ -> Bool
+ -> IORef [String]
+ -> IO ()
+build buildFile
+ runFunction
+ watchDirectories
+ isReverseProxy
+ sessionConfig
+ (fromProxyPort, toProxyPort)
+ mSession
+ isRebuild
+ iStrLst = do
- (initialSession, extensionList, includeTargets) <- initCompile sessionConfig mSession
+ (initialSession, extensionList, includeTargets, additionalWatch) <- initCompile watchDirectories sessionConfig mSession
-- Do this if isRebuild is False.
unless isRebuild $
if isReverseProxy then
- do _ <- forkIO $ startReverseProxy (fromProxyPort, toProxyPort)
+ do _ <- forkIO $ startReverseProxy (fromProxyPort, toProxyPort) iStrLst
putStrLn $ "Starting devel application at http://localhost:" ++
show fromProxyPort
else
@@ -51,31 +72,36 @@
show fromProxyPort
- (updatedSession, update) <-
+ (updatedSession, update) <-
if isRebuild
then return (initialSession, mempty)
else compile initialSession buildFile extensionList includeTargets
- eitherSession <- finishCompile (updatedSession, update)
+ eitherSession <- finishCompile (updatedSession, update) iStrLst
+ let -- clearLog :: IORef [String] -> IO ()
+ clearLog = do
+ _ <- readIORef iStrLst
+ writeIORef iStrLst ([] :: [String])
+
case eitherSession of
Left _ -> do
-- Listen for changes in the current working directory.
isDirty <- newTVarIO False
- _ <- forkIO $ watch isDirty includeTargets
+ _ <- forkIO $ watch isDirty includeTargets additionalWatch
-- Block until relevant change is made then carry on with program execution.
_ <- checkForChange isDirty
-- Stop the current app.
putStrLn "\n\nRebuilding...\n\n"
-
_ <- shutdownSession updatedSession
+ _ <- clearLog
+
-- Coming to fix.
- build buildFile runFunction False sessionConfig (fromProxyPort, toProxyPort) Nothing False
-
+ build buildFile runFunction watchDirectories False sessionConfig (fromProxyPort, toProxyPort) Nothing False iStrLst
Right session -> do
-- run the session
(runActionsRunResult, threadId) <- run session buildFile runFunction
@@ -84,17 +110,21 @@
isDirty <- newTVarIO False
-- Watch for changes in the current working directory.
- watchId <- forkIO $ watch isDirty includeTargets
+ watchId <- forkIO $ watch isDirty includeTargets additionalWatch
-- Block until relevant change is made then carry on with program execution.
_ <- checkForChange isDirty
killThread watchId
-
+
+ _ <- clearLog
+
-- Stop the current app.
_ <- stopApp runActionsRunResult threadId
putStrLn "\n\nRebuilding...\n\n"
- build buildFile runFunction isReverseProxy sessionConfig (fromProxyPort, toProxyPort) (Just session) True
+ build buildFile runFunction watchDirectories isReverseProxy sessionConfig (fromProxyPort, toProxyPort) (Just session) True iStrLst
+
+
run :: IdeSession -> FilePath -> String -> IO (RunActions RunResult, ThreadId)
diff --git a/src/Devel/CmdArgs.hs b/src/Devel/CmdArgs.hs
--- a/src/Devel/CmdArgs.hs
+++ b/src/Devel/CmdArgs.hs
@@ -1,25 +1,30 @@
{-|
Module : Devel.Args
Description : For handling command line arguments.
-Copyright : (c)
-License : GPL-3
+Copyright : (c) 2015 Njagi Mwaniki
+License : MIT
Maintainer : njagi@urbanslug.com
Stability : experimental
Portability : POSIX
+
+We handle command line arguments for yesod devel here.
-}
module Devel.CmdArgs
( cmdArgs
, CmdArgs (..)
) where
-import Options.Applicative
+import Data.List.Split (splitOn)
+import Options.Applicative
--- | Command line arguments for yesod devel.
--- All arguments are optional.
+
+-- | All arguments are optional.
data CmdArgs = CmdArgs
- { buildFile :: FilePath
- , runFunction :: String
- , isReverseProxy :: Bool -- By default reverse proxy should be True
+ { buildFile :: FilePath
+ , runFunction :: String
+ , watchDirectories :: [String]
+ , versionNumber :: Bool -- By default this should be False.
+ , isReverseProxy :: Bool -- By default reverse proxy should be True
} deriving (Show, Eq)
cmdArgs :: Parser CmdArgs
@@ -36,8 +41,17 @@
<> value "develMain"
<> metavar "FUNCTION"
<> help "The function you want run. Default is `develMain`.")
+ <*> (splitOn "," <$> strOption
+ (long "watch-directories"
+ <> short 'w'
+ <> value []
+ <> metavar "DIRECTORY-LIST"
+ <> help "A comma-separated list of directories to watch for any changes (not just .hs files)."))
+ <*> flag False True
+ (long "version"
+ <> short 'v'
+ <> help "Print the version of wai-devel you are using." )
<*> flag True False
(long "no-reverse-proxy"
<> short 'r'
<> help "use `-r` to disable reverse proxying." )
-
diff --git a/src/Devel/Compile.hs b/src/Devel/Compile.hs
--- a/src/Devel/Compile.hs
+++ b/src/Devel/Compile.hs
@@ -1,8 +1,8 @@
{-|
Module : Devel.Compile
Description : Attempts to compile the WAI application.
-Copyright : (c)
-License : GPL-3
+Copyright : (c) 2015 Njagi Mwaniki
+License : MIT
Maintainer : njagi@urbanslug.com
Stability : experimental
Portability : POSIX
@@ -44,13 +44,15 @@
import System.FilePath.Posix (takeExtension, pathSeparator)
import System.Directory (doesFileExist)
-import Data.List (union, delete, isInfixOf, nub)
+import Data.List (union, delete, isInfixOf, nub, (\\))
import Data.Maybe (fromMaybe)
import Control.Monad (filterM)
+import Data.IORef
+
-- |Initialize the compilation process.
-initCompile :: SessionConfig -> Maybe IdeSession -> IO (IdeSession, [GhcExtension], [FilePath])
-initCompile sessionConfig mSession = do
+initCompile :: [String] -> SessionConfig -> Maybe IdeSession -> IO (IdeSession, [GhcExtension], [FilePath], [FilePath])
+initCompile watchDirectories sessionConfig mSession = do
-- Initialize the session
session <- case mSession of
Just session -> return session
@@ -61,7 +63,8 @@
-- This is "rebuilding" the cabal file.
(extensionList, srcDir, cabalSrcList) <- getExtensions
sourceList <- getSourceList srcDir cabalSrcList
- return (session, extensionList, sourceList)
+ additionalWatchList <- fmap concat (mapM getRecursiveContents watchDirectories)
+ return (session, extensionList, sourceList, additionalWatchList)
getSourceList :: [FilePath] -> [FilePath] -> IO [FilePath]
getSourceList srcDir cabalSrcList = do
@@ -85,11 +88,11 @@
-- nub to remove duplicates yet again.
sourceList = nub $ delete "app/DevelMain.hs" $ delete "app/devel.hs" sourceList'
-
- return sourceList
+ -- Drop leading "./" in filepaths with `map (\x -> x \\ "./") sourceList`
+ return $ map (\x -> x \\ "./") sourceList -- sourceList
--- | Contains code regarding target files and coming up with the IdeSession update.
+-- | Determining the target files and creating the session update.
compile :: IdeSession -> FilePath -> [GhcExtension] -> [FilePath] -> IO (IdeSession, IdeSessionUpdate)
compile session buildFile extensionList sourceList = do
@@ -104,11 +107,19 @@
return (session, update)
--- |The final part of the compilation process.
-finishCompile :: (IdeSession, IdeSessionUpdate) -> IO (Either [SourceError'] IdeSession)
-finishCompile (session, update) = do
- _ <- updateSession session update print
+-- |Finalising compilation process.
+finishCompile :: (IdeSession, IdeSessionUpdate) -> IORef [String] -> IO (Either [SourceError'] IdeSession)
+finishCompile (session, update) iStrLst = do
+ let printer upLst = do
+ lstt <- readIORef iStrLst
+ let str = show upLst
+ newLst = lstt ++ [str]
+ _ <- putStrLn str
+ writeIORef iStrLst newLst
+
+ _ <- updateSession session update printer
+
-- Customizing error showing.
errorList' <- getSourceErrors session
let errorList = case filterErrors errorList' of
@@ -116,7 +127,13 @@
_ -> prettyPrintErrors errorList'
-- We still want to see errors and warnings on the terminal.
- mapM_ putStrLn $ prettyPrintErrors errorList'
+ let prettyErrors = prettyPrintErrors errorList'
+ errorsToBrowser = do
+ lstt <- readIORef iStrLst
+ writeIORef iStrLst $ lstt ++ prettyErrors
+
+ _ <- errorsToBrowser
+ mapM_ putStrLn $ prettyErrors
return $ case errorList of
[] -> Right session
diff --git a/src/Devel/Config.hs b/src/Devel/Config.hs
--- a/src/Devel/Config.hs
+++ b/src/Devel/Config.hs
@@ -1,8 +1,8 @@
{-|
Module : Devel.Config
Description : To have wai-devel depend on it's environment a lot less.
-Copyright : (c)
-License : GPL-3
+Copyright : (c) 2015 Njagi Mwaniki
+License : MIT
Maintainer : njagi@urbanslug.com
Stability : experimental
Portability : POSIX
diff --git a/src/Devel/Modules.hs b/src/Devel/Modules.hs
--- a/src/Devel/Modules.hs
+++ b/src/Devel/Modules.hs
@@ -1,8 +1,8 @@
{-|
Module : Devel.Modules
Description : For handling modules and Filepath matters.
-Copyright : (c)
-License : GPL-3
+Copyright : (c) 2015 Njagi Mwaniki
+License : MIT
Maintainer : njagi@urbanslug.com
Stability : experimental
Portability : POSIX
diff --git a/src/Devel/Paths.hs b/src/Devel/Paths.hs
--- a/src/Devel/Paths.hs
+++ b/src/Devel/Paths.hs
@@ -1,8 +1,8 @@
{-|
Module : Devel.Paths
Description : For filepath related matters.
-Copyright : (c)
-License : GPL-3
+Copyright : (c) 2015 Njagi Mwaniki
+License : MIT
Maintainer : njagi@urbanslug.com
Stability : experimental
Portability : POSIX
@@ -69,6 +69,7 @@
-- We want to take these files out.
let patterns :: [Pattern]
patterns = [ (compile "*.*~")
+ , (compile ".#*")
, (compile "*.hi")
, (compile "*.dump-hi")
, (compile "*.o")
diff --git a/src/Devel/ReverseProxy.hs b/src/Devel/ReverseProxy.hs
--- a/src/Devel/ReverseProxy.hs
+++ b/src/Devel/ReverseProxy.hs
@@ -1,13 +1,13 @@
{-|
Module : Devel.ReverseProxy
Description : Reverse proxies and starts warp on localhost:\.
-Copyright : (c)
-License : GPL-3
+Copyright : (c) 2015 Njagi Mwaniki
+License : MIT
Maintainer : njagi@urbanslug.com
Stability : experimental
Portability : POSIX
-Reverse proxying and other socket realated activities.
+Reverse proxying and other network realated activities.
-}
{-# LANGUAGE OverloadedStrings, ScopedTypeVariables, TemplateHaskell #-}
module Devel.ReverseProxy
@@ -22,36 +22,38 @@
import Network.HTTP.Client (newManager, defaultManagerSettings)
import Network.HTTP.Types (status200)
--- import Network.Wai.Handler.Warp (runSettingsSocket, defaultSettings, run)
+
import Network.Wai.Handler.Warp (run)
import Control.Exception
import Network.Socket
import Data.Streaming.Network (bindPortTCP)
-import qualified Data.ByteString.Lazy as LB
-import Data.FileEmbed (embedFile)
import Network.Wai (Application, responseLBS)
+import Data.IORef
+import Text.Hamlet
+import Text.Blaze.Html.Renderer.Utf8 (renderHtml)
-startReverseProxy :: (Int, Int) -> IO ()
-startReverseProxy (fromProxyPort, toProxyPort) = do
+startReverseProxy :: (Int, Int) -> IORef [String] -> IO ()
+startReverseProxy (fromProxyPort, toProxyPort) iStrLst = do
mgr <- newManager defaultManagerSettings
let onException' :: SomeException -> Application
- onException' _ _ respond = do
- let refreshHtml = LB.fromChunks $ return $(embedFile "refreshing.html")
+ onException' _ _ respond =do
+ lstt <- readIORef iStrLst
respond $ responseLBS status200
[ ("content-type", "text/html")
, ("Refresh", "1")
]
- refreshHtml
+ (renderHtml $(shamletFile "build.hamlet"))
- let proxyApp = waiProxyTo
- (\_ -> return $ WPRProxyDest $ ProxyDest "0.0.0.0" toProxyPort)
- onException'
- mgr
+
+ proxyApp = waiProxyTo
+ (\_ -> return $ WPRProxyDest $ ProxyDest "0.0.0.0" toProxyPort)
+ onException'
+ mgr
-- runSettingsSocket defaultSettings sock proxyApp
run fromProxyPort proxyApp
diff --git a/src/Devel/Types.hs b/src/Devel/Types.hs
--- a/src/Devel/Types.hs
+++ b/src/Devel/Types.hs
@@ -1,8 +1,8 @@
{-|
Module : Devel.Build
Description : Attempts to compile the WAI application.
-Copyright : (c)
-License : GPL-3
+Copyright : (c) 2015 Njagi Mwaniki
+License : MIT
Maintainer : njagi@urbanslug.com
Stability : experimental
Portability : POSIX
diff --git a/src/Devel/Watch.hs b/src/Devel/Watch.hs
--- a/src/Devel/Watch.hs
+++ b/src/Devel/Watch.hs
@@ -1,14 +1,14 @@
{-|
Module : Devel.Watch
Description : Watch for changes in the current working direcory.
-Copyright : (c)
-License : GPL-3
+Copyright : (c) 2015 Njagi Mwaniki
+License : MIT
Maintainer : njagi@urbanslug.com
Stability : experimental
Portability : POSIX
Actually checks only for modified files.
-Added or removed files don't trigger new builds.
+Added or removed files don't trigger rebuilds.
-}
{-# LANGUAGE OverloadedStrings, CPP #-}
module Devel.Watch where
@@ -36,13 +36,14 @@
import Devel.Paths
-watch :: TVar Bool -> [FilePath] -> IO ()
-watch isDirty includeTargets = do
+watch :: TVar Bool -> [FilePath] -> [FilePath] -> IO ()
+watch isDirty watchSource watchOther = do
-- Get files to watch.
- files <- getFilesToWatch includeTargets
+ files <- getFilesToWatch watchSource
-- Making paths to watch a list of absolute paths.
dir <- getCurrentDirectory
- let pathsToWatch = map (\fp -> dir ++ (pathSeparator: fp)) files
+ let sourceToWatch = map (\fp -> dir ++ (pathSeparator: fp)) files
+ let otherToWatch = map (\fp -> dir ++ (pathSeparator: fp)) watchOther
-- Actual file watching.
manager <- startManagerConf defaultConfig
@@ -54,20 +55,20 @@
getPath (Added fp _) = fp
getPath (Modified fp _) = fp
getPath (Removed fp _) = fp
-
- isModified = getPath event `elem` pathsToWatch
-
- atomically $ writeTVar isDirty isModified)
-
+
+ isModified = getPath event `elem` (sourceToWatch ++ otherToWatch)
+ atomically $ do readTVar isDirty >>= check . not
+ writeTVar isDirty isModified)
+
#else
- (\event -> do
+ (\event -> do
pathMod' <- case toText $ eventPath event of
Right text -> return $ unpack text -- Gives an abs path
Left text -> fail $ unpack text
-
- let isModified = pathMod' `elem` pathsToWatch
-
- atomically $ writeTVar isDirty isModified)
+
+ let isModified = pathMod' `elem` (sourceToWatch ++ otherToWatch)
+ atomically $ do readTVar isDirty >>= check . not
+ writeTVar isDirty isModified)
#endif
_ <- forever $ threadDelay maxBound
diff --git a/src/DevelMain.hs b/src/DevelMain.hs
new file mode 100644
--- /dev/null
+++ b/src/DevelMain.hs
@@ -0,0 +1,38 @@
+{-|
+Module : Main
+Description : The main module of the executable.
+Copyright : (c) 2015 Njagi Mwaniki
+License : MIT
+Maintainer : njagi@urbanslug.com
+Stability : experimental
+Portability : POSIX
+-}
+module DevelMain where
+
+import Devel
+import Devel.CmdArgs
+import Options.Applicative
+
+
+import Paths_wai_devel (version)
+import Data.Version (showVersion)
+
+develMain :: IO ()
+develMain = do
+ cmdArgs' <- execParser opts
+
+ let isReverseProxy' = isReverseProxy cmdArgs'
+ buildFile' = buildFile cmdArgs'
+ watchDirectories' = filter (/= "") $ watchDirectories cmdArgs'
+ runFunction' = runFunction cmdArgs'
+ isPrintVersion = versionNumber cmdArgs'
+
+ if isPrintVersion
+ then putStrLn $ "wai-devel version: " ++ showVersion version -- print version number and exit.
+ else buildAndRun buildFile' runFunction' watchDirectories' isReverseProxy'
+
+ where opts :: ParserInfo CmdArgs
+ opts = info (helper <*> cmdArgs)
+ (fullDesc
+ <> progDesc "For WAI complaint haskell web applications"
+ <> header "wai-devel: development server for haskell web applications." )
diff --git a/src/Main.hs b/src/Main.hs
deleted file mode 100644
--- a/src/Main.hs
+++ /dev/null
@@ -1,29 +0,0 @@
-{-|
-Module : Main
-Description : The main module of the executable.
-Copyright : (c)
-License : GPL-3
-Maintainer : njagi@urbanslug.com
-Stability : experimental
-Portability : POSIX
--}
-module Main where
-
-import Devel
-import Devel.CmdArgs
-import Options.Applicative
-
-main :: IO ()
-main = do
- cmdArgs' <- execParser opts
-
- let isReverseProxy' = isReverseProxy cmdArgs'
- buildFile' = buildFile cmdArgs'
- runFunction' = runFunction cmdArgs'
-
- buildAndRun buildFile' runFunction' isReverseProxy'
- where opts :: ParserInfo CmdArgs
- opts = info (helper <*> cmdArgs)
- (fullDesc
- <> progDesc "For WAI complaint haskell web applications"
- <> header "wai-devel: development server for haskell web applications." )
diff --git a/tests/Devel/CmdArgsSpec.hs b/tests/Devel/CmdArgsSpec.hs
new file mode 100644
--- /dev/null
+++ b/tests/Devel/CmdArgsSpec.hs
@@ -0,0 +1,18 @@
+-- Test for command line arguments module.
+module Devel.CmdArgsSpec where
+
+import Test.Hspec
+import Devel.CmdArgs
+
+main :: IO ()
+main = hspec spec
+
+spec :: Spec
+spec = do
+ describe "Command line arguments." $ do
+ it "We can create values of type CmdArgs" $ do
+ let cmdArgs' = CmdArgs "Application.hs" "runDevel" [] False True
+ cmdArgs' `shouldBe` (CmdArgs "Application.hs" "runDevel" [] False True :: CmdArgs)
+ it "Creates values of type Parser CmdArgs" $ do
+ -- How to test that cmdArgs actually creates values of type Parser CmdArgs?
+ "to do" `shouldBe` "to do"
diff --git a/tests/Devel/ConfigSpec.hs b/tests/Devel/ConfigSpec.hs
new file mode 100644
--- /dev/null
+++ b/tests/Devel/ConfigSpec.hs
@@ -0,0 +1,30 @@
+module Devel.ConfigSpec where
+
+import Test.Hspec
+import Devel.Config
+
+main :: IO ()
+main = hspec spec
+
+spec :: Spec
+spec = do
+ describe "Able to extract PATH and package database from `stack path` output" $ do
+ it "Able to extract bin-path (PATH) when there is a bin-path in the key part of the association list" $
+ -- wut?
+ getPath ("bin-path", "bin-path: ~/bin/path/found") `shouldBe` "bin-path:~/bin/path/found"
+
+ it "Gives an empty string when bin-path isn't in the association list" $
+ getPath ("not-bin-path", "ghc-paths: ~/not/bin/path") `shouldBe` ""
+
+ it "Able to extract ghc-package-path (GHC_PACKAGE_PATH) whe it's part of the association list" $
+ -- wut?
+ getPkgDb ("ghc-package-path", "ghc-package-path: ~/pkg/db/found") `shouldBe` "ghc-package-path:~/pkg/db/found"
+
+ it "Gives an empty string when snapshot-pkg-db isn't in the association list" $
+ getPkgDb ("not-snapshot-pkg-db", "ghc-paths: ~/not/pkg/db") `shouldBe` ""
+
+
+ describe "setConfig doesn't throw an exception." $
+ it "setConfig gives back a unit ()." $ do
+ value <- setConfig
+ value `shouldBe` ()
diff --git a/tests/Devel/ReverseProxySpec.hs b/tests/Devel/ReverseProxySpec.hs
new file mode 100644
--- /dev/null
+++ b/tests/Devel/ReverseProxySpec.hs
@@ -0,0 +1,48 @@
+module Devel.ReverseProxySpec where
+
+import Test.Hspec
+import Control.Concurrent
+import Devel.ReverseProxy
+
+import Data.IORef
+
+main :: IO ()
+main = hspec spec
+
+spec :: Spec
+spec = do
+ describe "Reverse proxing" $
+ it "Starts a reverse proxy server from 3000 to 3001" $ do
+ iStrLst <- newIORef [] :: IO (IORef [String])
+ tId <- forkIO $ startReverseProxy (3000, 3001) iStrLst
+ threadDelay 100
+ killThread tId
+ tId `shouldBe` tId
+
+ describe "Port cycling" $
+ it "Can cycle ports" $ do
+ p <- cyclePorts 3000
+ p `shouldBe` 3001
+
+ describe "Socket creation" $ do
+ it "Can create a socket at a given port." $ {-do
+ _ <- createSocket 66542
+ bool <- checkPort 66542
+ bool `shouldBe` False-}
+ pendingWith "How to create a socket in the tests without getting permission denied error?"
+
+
+
+ it "Can create a socket safely." $ do
+ (_, pNum) <- createSocketSafe 6666
+ pNum `shouldBe` 6667
+
+ describe "Check ports" $ do
+ it "checkPort is True when port is free" $ do
+ bool <- checkPort 54323
+ bool `shouldBe` True
+ it "checkPort is False when port is taken" $ {-do
+ _ <- createSocket 6666
+ bool <- checkPort 6666
+ bool `shouldBe` False-}
+ pendingWith "How to create a socket in the tests without getting permission denied error?"
diff --git a/tests/Devel/WatchSpec.hs b/tests/Devel/WatchSpec.hs
new file mode 100644
--- /dev/null
+++ b/tests/Devel/WatchSpec.hs
@@ -0,0 +1,32 @@
+module Devel.WatchSpec where
+
+import Test.Hspec
+import Devel.Watch
+
+import Control.Monad.STM
+import Control.Concurrent.STM.TVar
+import Control.Concurrent
+
+main :: IO ()
+main = hspec spec
+
+spec :: Spec
+spec = do
+ describe "Checking for change watching." $
+ it "checkForChange successfully changes value of isDirty." $ do
+ isDirty <- newTVarIO False
+ _ <- forkIO $ changeIsDirty isDirty
+ checkForChange isDirty
+ isDirtyBool <- atomically $ readTVar isDirty
+ isDirtyBool `shouldBe` False
+
+ describe "File watching" $
+ it "Modifies isDirty when required file changes."
+ pending
+
+
+
+changeIsDirty :: TVar Bool -> IO ()
+changeIsDirty isDirty = do
+ _ <- threadDelay 10000
+ atomically $ writeTVar isDirty True
diff --git a/tests/DevelSpec.hs b/tests/DevelSpec.hs
new file mode 100644
--- /dev/null
+++ b/tests/DevelSpec.hs
@@ -0,0 +1,22 @@
+-- Tests for Devel.hs
+module DevelSpec where
+
+import Test.Hspec
+import Devel
+import Control.Concurrent
+
+main :: IO ()
+main = hspec spec
+
+spec :: Spec
+spec = -- How does one test that a bottom effectful computation has done what is expected?
+ describe "buildAndRun is able to successfully call build." $ do
+ it "Able to apply configs from setConfig" $
+ pendingWith "Is it even possible to test for this?"
+ it "buildAndRun is able to pick up the value of PORT" $
+ pendingWith "Is it even possible to test for this?"
+ it "Successfully calls build. Does not throw an exception." $ do
+ tId <- forkIO $ buildAndRun "Application.hs" "develMain" [] True
+ threadDelay 100
+ killThread tId
+ tId `shouldBe` tId
diff --git a/tests/MainSpec.hs b/tests/MainSpec.hs
new file mode 100644
--- /dev/null
+++ b/tests/MainSpec.hs
@@ -0,0 +1,19 @@
+-- Tests for Main function.
+module MainSpec where
+
+import Test.Hspec
+import DevelMain as M
+import Control.Concurrent (forkIO, threadDelay, killThread)
+
+main :: IO ()
+main = hspec spec
+
+spec :: Spec
+spec = -- How does one test that a bottom effectful computation has done what is expected?
+ describe "Program has a working main function" $
+ it "Gets cmd arguments from cmdArgs and calls successfully `buildAndRun`." $ do
+ tId <- forkIO M.develMain
+ threadDelay 100
+ killThread tId
+ tId `shouldBe` tId
+
diff --git a/wai-devel.cabal b/wai-devel.cabal
--- a/wai-devel.cabal
+++ b/wai-devel.cabal
@@ -1,22 +1,24 @@
name: wai-devel
-version: 0.0.0.2
+version: 0.0.0.3
synopsis: A web server for the development of WAI compliant web applications.
description: A development server for WAI applications.
homepage: https://github.com/urbanslug/wai-devel
-license: GPL-3
+license: MIT
license-file: LICENSE
author: Njagi Mwaniki
maintainer: njagi@urbanslug.com
--- copyright:
+-- copyright:
category: Web
build-type: Simple
-extra-source-files: refreshing.html
+extra-source-files: build.hamlet
+ , README.md
+ , Changelog.md
cabal-version: >=1.10
library
ghc-options: -Wall
exposed-modules: Devel
- , Main
+ , DevelMain
, Devel.Watch
, Devel.CmdArgs
, Devel.ReverseProxy
@@ -24,8 +26,12 @@
, Devel.Compile
, Devel.Types
, Devel.Build
+
other-modules: Devel.Paths
, Devel.Modules
+ -- Cabal generated modules.
+ -- Note to self: If errors, move to exposed modules.
+ , Paths_wai_devel
-- other-extensions:
build-depends: base >= 4.7 && <5.0
@@ -42,10 +48,10 @@
, http-client >= 0.4 && < 0.5
, http-conduit >= 2.1 && < 2.2
, http-reverse-proxy >= 0.4 && < 0.5
- , http-types >= 0.8 && < 0.9
+ , http-types >= 0.8 && < 0.10
, ide-backend >= 0.10 && < 0.11
, network >= 2.6 && < 2.7
- , optparse-applicative >= 0.11 && < 0.12
+ , optparse-applicative >= 0.11 && < 0.13
, process >= 1.2 && < 1.3
, shakespeare >= 2.0 && < 2.1
, stm >= 2.4 && < 2.5
@@ -54,10 +60,11 @@
, text >= 1.2 && < 1.3
, time >= 1.4 && < 1.6
, transformers >= 0.3 && < 0.5
- , wai >= 3.0 && < 3.1
- , warp >= 3.0 && < 3.2
+ , wai >= 3.0 && < 4.0
+ , warp >= 3.0 && < 4.0
, file-embed >= 0.0 && < 0.1
, websockets >= 0.9 && < 1.1
+ , split >= 0.1 && < 0.3
hs-source-dirs: src
default-language: Haskell2010
@@ -65,57 +72,25 @@
executable wai-devel
ghc-options: -Wall
main-is: Main.hs
- other-modules: Devel
- Devel.CmdArgs
- Devel.Build
- Devel.Compile
- Devel.Config
- Devel.Modules
- Devel.Paths
- Devel.ReverseProxy
- Devel.Types
- Devel.Watch
+ other-modules:
-- other-extensions:
build-depends: base
- , Cabal-ide-backend
- , Glob
- , MissingH
- , blaze-html
- , bytestring
- , directory
- , filepath
- , fsnotify
- , ghc
- , http-client
- , http-conduit
- , http-reverse-proxy
- , http-types
- , ide-backend
- , network
- , optparse-applicative
- , process
- , shakespeare
- , stm
- , streaming-commons
- , system-filepath
- , text
- , time
- , transformers
- , wai
, wai-devel
- , warp
- , file-embed
- , websockets
- hs-source-dirs: src
+ hs-source-dirs: app
default-language: Haskell2010
test-suite tests
ghc-options: -Wall
type: exitcode-stdio-1.0
main-is: Spec.hs
- -- exposed-modules:
- -- other-modules: Tests.Watch
+ -- exposed-modules:
+ other-modules: Devel.CmdArgsSpec
+ , Devel.ConfigSpec
+ , Devel.ReverseProxySpec
+ , Devel.WatchSpec
+ , DevelSpec
+ , MainSpec
hs-source-dirs: tests
build-depends: base
, hspec >= 2.1 && < 3.0