provenience (empty) → 0.1.0.0
raw patch · 7 files changed
+1802/−0 lines, 7 filesdep +aesondep +basedep +blaze-markupsetup-changed
Dependencies added: aeson, base, blaze-markup, containers, data-default, fgl, mtl, pandoc, text, time
Files
- LICENSE.md +675/−0
- README.md +362/−0
- Setup.hs +2/−0
- provenience.cabal +34/−0
- src/Control/Provenience.hs +494/−0
- src/Data/Representation.hs +94/−0
- src/Data/Spreadsheet.hs +141/−0
+ LICENSE.md view
@@ -0,0 +1,675 @@+### GNU GENERAL PUBLIC LICENSE++Version 3, 29 June 2007++Copyright (C) 2007 Free Software Foundation, Inc.+<https://fsf.org/>++Everyone is permitted to copy and distribute verbatim copies of this+license document, but changing it is not allowed.++### Preamble++The GNU General Public License is a free, copyleft license for+software and other kinds of works.++The licenses for most software and other practical works are designed+to take away your freedom to share and change the works. By contrast,+the GNU General Public License is intended to guarantee your freedom+to share and change all versions of a program--to make sure it remains+free software for all its users. We, the Free Software Foundation, use+the GNU General Public License for most of our software; it applies+also to any other work released this way by its authors. You can apply+it to your programs, too.++When we speak of free software, we are referring to freedom, not+price. Our General Public Licenses are designed to make sure that you+have the freedom to distribute copies of free software (and charge for+them if you wish), that you receive source code or can get it if you+want it, that you can change the software or use pieces of it in new+free programs, and that you know you can do these things.++To protect your rights, we need to prevent others from denying you+these rights or asking you to surrender the rights. Therefore, you+have certain responsibilities if you distribute copies of the+software, or if you modify it: responsibilities to respect the freedom+of others.++For example, if you distribute copies of such a program, whether+gratis or for a fee, you must pass on to the recipients the same+freedoms that you received. You must make sure that they, too, receive+or can get the source code. And you must show them these terms so they+know their rights.++Developers that use the GNU GPL protect your rights with two steps:+(1) assert copyright on the software, and (2) offer you this License+giving you legal permission to copy, distribute and/or modify it.++For the developers' and authors' protection, the GPL clearly explains+that there is no warranty for this free software. For both users' and+authors' sake, the GPL requires that modified versions be marked as+changed, so that their problems will not be attributed erroneously to+authors of previous versions.++Some devices are designed to deny users access to install or run+modified versions of the software inside them, although the+manufacturer can do so. This is fundamentally incompatible with the+aim of protecting users' freedom to change the software. The+systematic pattern of such abuse occurs in the area of products for+individuals to use, which is precisely where it is most unacceptable.+Therefore, we have designed this version of the GPL to prohibit the+practice for those products. If such problems arise substantially in+other domains, we stand ready to extend this provision to those+domains in future versions of the GPL, as needed to protect the+freedom of users.++Finally, every program is threatened constantly by software patents.+States should not allow patents to restrict development and use of+software on general-purpose computers, but in those that do, we wish+to avoid the special danger that patents applied to a free program+could make it effectively proprietary. To prevent this, the GPL+assures that patents cannot be used to render the program non-free.++The precise terms and conditions for copying, distribution and+modification follow.++### TERMS AND CONDITIONS++#### 0. Definitions.++"This License" refers to version 3 of the GNU General Public License.++"Copyright" also means copyright-like laws that apply to other kinds+of works, such as semiconductor masks.++"The Program" refers to any copyrightable work licensed under this+License. Each licensee is addressed as "you". "Licensees" and+"recipients" may be individuals or organizations.++To "modify" a work means to copy from or adapt all or part of the work+in a fashion requiring copyright permission, other than the making of+an exact copy. The resulting work is called a "modified version" of+the earlier work or a work "based on" the earlier work.++A "covered work" means either the unmodified Program or a work based+on the Program.++To "propagate" a work means to do anything with it that, without+permission, would make you directly or secondarily liable for+infringement under applicable copyright law, except executing it on a+computer or modifying a private copy. Propagation includes copying,+distribution (with or without modification), making available to the+public, and in some countries other activities as well.++To "convey" a work means any kind of propagation that enables other+parties to make or receive copies. Mere interaction with a user+through a computer network, with no transfer of a copy, is not+conveying.++An interactive user interface displays "Appropriate Legal Notices" to+the extent that it includes a convenient and prominently visible+feature that (1) displays an appropriate copyright notice, and (2)+tells the user that there is no warranty for the work (except to the+extent that warranties are provided), that licensees may convey the+work under this License, and how to view a copy of this License. If+the interface presents a list of user commands or options, such as a+menu, a prominent item in the list meets this criterion.++#### 1. Source Code.++The "source code" for a work means the preferred form of the work for+making modifications to it. "Object code" means any non-source form of+a work.++A "Standard Interface" means an interface that either is an official+standard defined by a recognized standards body, or, in the case of+interfaces specified for a particular programming language, one that+is widely used among developers working in that language.++The "System Libraries" of an executable work include anything, other+than the work as a whole, that (a) is included in the normal form of+packaging a Major Component, but which is not part of that Major+Component, and (b) serves only to enable use of the work with that+Major Component, or to implement a Standard Interface for which an+implementation is available to the public in source code form. A+"Major Component", in this context, means a major essential component+(kernel, window system, and so on) of the specific operating system+(if any) on which the executable work runs, or a compiler used to+produce the work, or an object code interpreter used to run it.++The "Corresponding Source" for a work in object code form means all+the source code needed to generate, install, and (for an executable+work) run the object code and to modify the work, including scripts to+control those activities. However, it does not include the work's+System Libraries, or general-purpose tools or generally available free+programs which are used unmodified in performing those activities but+which are not part of the work. For example, Corresponding Source+includes interface definition files associated with source files for+the work, and the source code for shared libraries and dynamically+linked subprograms that the work is specifically designed to require,+such as by intimate data communication or control flow between those+subprograms and other parts of the work.++The Corresponding Source need not include anything that users can+regenerate automatically from other parts of the Corresponding Source.++The Corresponding Source for a work in source code form is that same+work.++#### 2. Basic Permissions.++All rights granted under this License are granted for the term of+copyright on the Program, and are irrevocable provided the stated+conditions are met. This License explicitly affirms your unlimited+permission to run the unmodified Program. The output from running a+covered work is covered by this License only if the output, given its+content, constitutes a covered work. This License acknowledges your+rights of fair use or other equivalent, as provided by copyright law.++You may make, run and propagate covered works that you do not convey,+without conditions so long as your license otherwise remains in force.+You may convey covered works to others for the sole purpose of having+them make modifications exclusively for you, or provide you with+facilities for running those works, provided that you comply with the+terms of this License in conveying all material for which you do not+control copyright. Those thus making or running the covered works for+you must do so exclusively on your behalf, under your direction and+control, on terms that prohibit them from making any copies of your+copyrighted material outside their relationship with you.++Conveying under any other circumstances is permitted solely under the+conditions stated below. Sublicensing is not allowed; section 10 makes+it unnecessary.++#### 3. Protecting Users' Legal Rights From Anti-Circumvention Law.++No covered work shall be deemed part of an effective technological+measure under any applicable law fulfilling obligations under article+11 of the WIPO copyright treaty adopted on 20 December 1996, or+similar laws prohibiting or restricting circumvention of such+measures.++When you convey a covered work, you waive any legal power to forbid+circumvention of technological measures to the extent such+circumvention is effected by exercising rights under this License with+respect to the covered work, and you disclaim any intention to limit+operation or modification of the work as a means of enforcing, against+the work's users, your or third parties' legal rights to forbid+circumvention of technological measures.++#### 4. Conveying Verbatim Copies.++You may convey verbatim copies of the Program's source code as you+receive it, in any medium, provided that you conspicuously and+appropriately publish on each copy an appropriate copyright notice;+keep intact all notices stating that this License and any+non-permissive terms added in accord with section 7 apply to the code;+keep intact all notices of the absence of any warranty; and give all+recipients a copy of this License along with the Program.++You may charge any price or no price for each copy that you convey,+and you may offer support or warranty protection for a fee.++#### 5. Conveying Modified Source Versions.++You may convey a work based on the Program, or the modifications to+produce it from the Program, in the form of source code under the+terms of section 4, provided that you also meet all of these+conditions:++- a) The work must carry prominent notices stating that you modified+ it, and giving a relevant date.+- b) The work must carry prominent notices stating that it is+ released under this License and any conditions added under+ section 7. This requirement modifies the requirement in section 4+ to "keep intact all notices".+- c) You must license the entire work, as a whole, under this+ License to anyone who comes into possession of a copy. This+ License will therefore apply, along with any applicable section 7+ additional terms, to the whole of the work, and all its parts,+ regardless of how they are packaged. This License gives no+ permission to license the work in any other way, but it does not+ invalidate such permission if you have separately received it.+- d) If the work has interactive user interfaces, each must display+ Appropriate Legal Notices; however, if the Program has interactive+ interfaces that do not display Appropriate Legal Notices, your+ work need not make them do so.++A compilation of a covered work with other separate and independent+works, which are not by their nature extensions of the covered work,+and which are not combined with it such as to form a larger program,+in or on a volume of a storage or distribution medium, is called an+"aggregate" if the compilation and its resulting copyright are not+used to limit the access or legal rights of the compilation's users+beyond what the individual works permit. Inclusion of a covered work+in an aggregate does not cause this License to apply to the other+parts of the aggregate.++#### 6. Conveying Non-Source Forms.++You may convey a covered work in object code form under the terms of+sections 4 and 5, provided that you also convey the machine-readable+Corresponding Source under the terms of this License, in one of these+ways:++- a) Convey the object code in, or embodied in, a physical product+ (including a physical distribution medium), accompanied by the+ Corresponding Source fixed on a durable physical medium+ customarily used for software interchange.+- b) Convey the object code in, or embodied in, a physical product+ (including a physical distribution medium), accompanied by a+ written offer, valid for at least three years and valid for as+ long as you offer spare parts or customer support for that product+ model, to give anyone who possesses the object code either (1) a+ copy of the Corresponding Source for all the software in the+ product that is covered by this License, on a durable physical+ medium customarily used for software interchange, for a price no+ more than your reasonable cost of physically performing this+ conveying of source, or (2) access to copy the Corresponding+ Source from a network server at no charge.+- c) Convey individual copies of the object code with a copy of the+ written offer to provide the Corresponding Source. This+ alternative is allowed only occasionally and noncommercially, and+ only if you received the object code with such an offer, in accord+ with subsection 6b.+- d) Convey the object code by offering access from a designated+ place (gratis or for a charge), and offer equivalent access to the+ Corresponding Source in the same way through the same place at no+ further charge. You need not require recipients to copy the+ Corresponding Source along with the object code. If the place to+ copy the object code is a network server, the Corresponding Source+ may be on a different server (operated by you or a third party)+ that supports equivalent copying facilities, provided you maintain+ clear directions next to the object code saying where to find the+ Corresponding Source. Regardless of what server hosts the+ Corresponding Source, you remain obligated to ensure that it is+ available for as long as needed to satisfy these requirements.+- e) Convey the object code using peer-to-peer transmission,+ provided you inform other peers where the object code and+ Corresponding Source of the work are being offered to the general+ public at no charge under subsection 6d.++A separable portion of the object code, whose source code is excluded+from the Corresponding Source as a System Library, need not be+included in conveying the object code work.++A "User Product" is either (1) a "consumer product", which means any+tangible personal property which is normally used for personal,+family, or household purposes, or (2) anything designed or sold for+incorporation into a dwelling. In determining whether a product is a+consumer product, doubtful cases shall be resolved in favor of+coverage. For a particular product received by a particular user,+"normally used" refers to a typical or common use of that class of+product, regardless of the status of the particular user or of the way+in which the particular user actually uses, or expects or is expected+to use, the product. A product is a consumer product regardless of+whether the product has substantial commercial, industrial or+non-consumer uses, unless such uses represent the only significant+mode of use of the product.++"Installation Information" for a User Product means any methods,+procedures, authorization keys, or other information required to+install and execute modified versions of a covered work in that User+Product from a modified version of its Corresponding Source. The+information must suffice to ensure that the continued functioning of+the modified object code is in no case prevented or interfered with+solely because modification has been made.++If you convey an object code work under this section in, or with, or+specifically for use in, a User Product, and the conveying occurs as+part of a transaction in which the right of possession and use of the+User Product is transferred to the recipient in perpetuity or for a+fixed term (regardless of how the transaction is characterized), the+Corresponding Source conveyed under this section must be accompanied+by the Installation Information. But this requirement does not apply+if neither you nor any third party retains the ability to install+modified object code on the User Product (for example, the work has+been installed in ROM).++The requirement to provide Installation Information does not include a+requirement to continue to provide support service, warranty, or+updates for a work that has been modified or installed by the+recipient, or for the User Product in which it has been modified or+installed. Access to a network may be denied when the modification+itself materially and adversely affects the operation of the network+or violates the rules and protocols for communication across the+network.++Corresponding Source conveyed, and Installation Information provided,+in accord with this section must be in a format that is publicly+documented (and with an implementation available to the public in+source code form), and must require no special password or key for+unpacking, reading or copying.++#### 7. Additional Terms.++"Additional permissions" are terms that supplement the terms of this+License by making exceptions from one or more of its conditions.+Additional permissions that are applicable to the entire Program shall+be treated as though they were included in this License, to the extent+that they are valid under applicable law. If additional permissions+apply only to part of the Program, that part may be used separately+under those permissions, but the entire Program remains governed by+this License without regard to the additional permissions.++When you convey a copy of a covered work, you may at your option+remove any additional permissions from that copy, or from any part of+it. (Additional permissions may be written to require their own+removal in certain cases when you modify the work.) You may place+additional permissions on material, added by you to a covered work,+for which you have or can give appropriate copyright permission.++Notwithstanding any other provision of this License, for material you+add to a covered work, you may (if authorized by the copyright holders+of that material) supplement the terms of this License with terms:++- a) Disclaiming warranty or limiting liability differently from the+ terms of sections 15 and 16 of this License; or+- b) Requiring preservation of specified reasonable legal notices or+ author attributions in that material or in the Appropriate Legal+ Notices displayed by works containing it; or+- c) Prohibiting misrepresentation of the origin of that material,+ or requiring that modified versions of such material be marked in+ reasonable ways as different from the original version; or+- d) Limiting the use for publicity purposes of names of licensors+ or authors of the material; or+- e) Declining to grant rights under trademark law for use of some+ trade names, trademarks, or service marks; or+- f) Requiring indemnification of licensors and authors of that+ material by anyone who conveys the material (or modified versions+ of it) with contractual assumptions of liability to the recipient,+ for any liability that these contractual assumptions directly+ impose on those licensors and authors.++All other non-permissive additional terms are considered "further+restrictions" within the meaning of section 10. If the Program as you+received it, or any part of it, contains a notice stating that it is+governed by this License along with a term that is a further+restriction, you may remove that term. If a license document contains+a further restriction but permits relicensing or conveying under this+License, you may add to a covered work material governed by the terms+of that license document, provided that the further restriction does+not survive such relicensing or conveying.++If you add terms to a covered work in accord with this section, you+must place, in the relevant source files, a statement of the+additional terms that apply to those files, or a notice indicating+where to find the applicable terms.++Additional terms, permissive or non-permissive, may be stated in the+form of a separately written license, or stated as exceptions; the+above requirements apply either way.++#### 8. Termination.++You may not propagate or modify a covered work except as expressly+provided under this License. Any attempt otherwise to propagate or+modify it is void, and will automatically terminate your rights under+this License (including any patent licenses granted under the third+paragraph of section 11).++However, if you cease all violation of this License, then your license+from a particular copyright holder is reinstated (a) provisionally,+unless and until the copyright holder explicitly and finally+terminates your license, and (b) permanently, if the copyright holder+fails to notify you of the violation by some reasonable means prior to+60 days after the cessation.++Moreover, your license from a particular copyright holder is+reinstated permanently if the copyright holder notifies you of the+violation by some reasonable means, this is the first time you have+received notice of violation of this License (for any work) from that+copyright holder, and you cure the violation prior to 30 days after+your receipt of the notice.++Termination of your rights under this section does not terminate the+licenses of parties who have received copies or rights from you under+this License. If your rights have been terminated and not permanently+reinstated, you do not qualify to receive new licenses for the same+material under section 10.++#### 9. Acceptance Not Required for Having Copies.++You are not required to accept this License in order to receive or run+a copy of the Program. Ancillary propagation of a covered work+occurring solely as a consequence of using peer-to-peer transmission+to receive a copy likewise does not require acceptance. However,+nothing other than this License grants you permission to propagate or+modify any covered work. These actions infringe copyright if you do+not accept this License. Therefore, by modifying or propagating a+covered work, you indicate your acceptance of this License to do so.++#### 10. Automatic Licensing of Downstream Recipients.++Each time you convey a covered work, the recipient automatically+receives a license from the original licensors, to run, modify and+propagate that work, subject to this License. You are not responsible+for enforcing compliance by third parties with this License.++An "entity transaction" is a transaction transferring control of an+organization, or substantially all assets of one, or subdividing an+organization, or merging organizations. If propagation of a covered+work results from an entity transaction, each party to that+transaction who receives a copy of the work also receives whatever+licenses to the work the party's predecessor in interest had or could+give under the previous paragraph, plus a right to possession of the+Corresponding Source of the work from the predecessor in interest, if+the predecessor has it or can get it with reasonable efforts.++You may not impose any further restrictions on the exercise of the+rights granted or affirmed under this License. For example, you may+not impose a license fee, royalty, or other charge for exercise of+rights granted under this License, and you may not initiate litigation+(including a cross-claim or counterclaim in a lawsuit) alleging that+any patent claim is infringed by making, using, selling, offering for+sale, or importing the Program or any portion of it.++#### 11. Patents.++A "contributor" is a copyright holder who authorizes use under this+License of the Program or a work on which the Program is based. The+work thus licensed is called the contributor's "contributor version".++A contributor's "essential patent claims" are all patent claims owned+or controlled by the contributor, whether already acquired or+hereafter acquired, that would be infringed by some manner, permitted+by this License, of making, using, or selling its contributor version,+but do not include claims that would be infringed only as a+consequence of further modification of the contributor version. For+purposes of this definition, "control" includes the right to grant+patent sublicenses in a manner consistent with the requirements of+this License.++Each contributor grants you a non-exclusive, worldwide, royalty-free+patent license under the contributor's essential patent claims, to+make, use, sell, offer for sale, import and otherwise run, modify and+propagate the contents of its contributor version.++In the following three paragraphs, a "patent license" is any express+agreement or commitment, however denominated, not to enforce a patent+(such as an express permission to practice a patent or covenant not to+sue for patent infringement). To "grant" such a patent license to a+party means to make such an agreement or commitment not to enforce a+patent against the party.++If you convey a covered work, knowingly relying on a patent license,+and the Corresponding Source of the work is not available for anyone+to copy, free of charge and under the terms of this License, through a+publicly available network server or other readily accessible means,+then you must either (1) cause the Corresponding Source to be so+available, or (2) arrange to deprive yourself of the benefit of the+patent license for this particular work, or (3) arrange, in a manner+consistent with the requirements of this License, to extend the patent+license to downstream recipients. "Knowingly relying" means you have+actual knowledge that, but for the patent license, your conveying the+covered work in a country, or your recipient's use of the covered work+in a country, would infringe one or more identifiable patents in that+country that you have reason to believe are valid.++If, pursuant to or in connection with a single transaction or+arrangement, you convey, or propagate by procuring conveyance of, a+covered work, and grant a patent license to some of the parties+receiving the covered work authorizing them to use, propagate, modify+or convey a specific copy of the covered work, then the patent license+you grant is automatically extended to all recipients of the covered+work and works based on it.++A patent license is "discriminatory" if it does not include within the+scope of its coverage, prohibits the exercise of, or is conditioned on+the non-exercise of one or more of the rights that are specifically+granted under this License. You may not convey a covered work if you+are a party to an arrangement with a third party that is in the+business of distributing software, under which you make payment to the+third party based on the extent of your activity of conveying the+work, and under which the third party grants, to any of the parties+who would receive the covered work from you, a discriminatory patent+license (a) in connection with copies of the covered work conveyed by+you (or copies made from those copies), or (b) primarily for and in+connection with specific products or compilations that contain the+covered work, unless you entered into that arrangement, or that patent+license was granted, prior to 28 March 2007.++Nothing in this License shall be construed as excluding or limiting+any implied license or other defenses to infringement that may+otherwise be available to you under applicable patent law.++#### 12. No Surrender of Others' Freedom.++If conditions are imposed on you (whether by court order, agreement or+otherwise) that contradict the conditions of this License, they do not+excuse you from the conditions of this License. If you cannot convey a+covered work so as to satisfy simultaneously your obligations under+this License and any other pertinent obligations, then as a+consequence you may not convey it at all. For example, if you agree to+terms that obligate you to collect a royalty for further conveying+from those to whom you convey the Program, the only way you could+satisfy both those terms and this License would be to refrain entirely+from conveying the Program.++#### 13. Use with the GNU Affero General Public License.++Notwithstanding any other provision of this License, you have+permission to link or combine any covered work with a work licensed+under version 3 of the GNU Affero General Public License into a single+combined work, and to convey the resulting work. The terms of this+License will continue to apply to the part which is the covered work,+but the special requirements of the GNU Affero General Public License,+section 13, concerning interaction through a network will apply to the+combination as such.++#### 14. Revised Versions of this License.++The Free Software Foundation may publish revised and/or new versions+of the GNU General Public License from time to time. Such new versions+will be similar in spirit to the present version, but may differ in+detail to address new problems or concerns.++Each version is given a distinguishing version number. If the Program+specifies that a certain numbered version of the GNU General Public+License "or any later version" applies to it, you have the option of+following the terms and conditions either of that numbered version or+of any later version published by the Free Software Foundation. If the+Program does not specify a version number of the GNU General Public+License, you may choose any version ever published by the Free+Software Foundation.++If the Program specifies that a proxy can decide which future versions+of the GNU General Public License can be used, that proxy's public+statement of acceptance of a version permanently authorizes you to+choose that version for the Program.++Later license versions may give you additional or different+permissions. However, no additional obligations are imposed on any+author or copyright holder as a result of your choosing to follow a+later version.++#### 15. Disclaimer of Warranty.++THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT+WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR+A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND+PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE+DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR+CORRECTION.++#### 16. Limitation of Liability.++IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR+CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES+ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT+NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR+LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM+TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER+PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.++#### 17. Interpretation of Sections 15 and 16.++If the disclaimer of warranty and limitation of liability provided+above cannot be given local legal effect according to their terms,+reviewing courts shall apply local law that most closely approximates+an absolute waiver of all civil liability in connection with the+Program, unless a warranty or assumption of liability accompanies a+copy of the Program in return for a fee.++END OF TERMS AND CONDITIONS++### How to Apply These Terms to Your New Programs++If you develop a new program, and you want it to be of the greatest+possible use to the public, the best way to achieve this is to make it+free software which everyone can redistribute and change under these+terms.++To do so, attach the following notices to the program. It is safest to+attach them to the start of each source file to most effectively state+the exclusion of warranty; and each file should have at least the+"copyright" line and a pointer to where the full notice is found.++ <one line to give the program's name and a brief idea of what it does.>+ Copyright (C) <year> <name of author>++ This program is free software: you can redistribute it and/or modify+ it under the terms of the GNU General Public License as published by+ the Free Software Foundation, either version 3 of the License, or+ (at your option) any later version.++ This program is distributed in the hope that it will be useful,+ but WITHOUT ANY WARRANTY; without even the implied warranty of+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the+ GNU General Public License for more details.++ You should have received a copy of the GNU General Public License+ along with this program. If not, see <https://www.gnu.org/licenses/>.++Also add information on how to contact you by electronic and paper+mail.++If the program does terminal interaction, make it output a short+notice like this when it starts in an interactive mode:++ <program> Copyright (C) <year> <name of author>+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.+ This is free software, and you are welcome to redistribute it+ under certain conditions; type `show c' for details.++The hypothetical commands \`show w' and \`show c' should show the+appropriate parts of the General Public License. Of course, your+program's commands might be different; for a GUI interface, you would+use an "about box".++You should also get your employer (if you work as a programmer) or+school, if any, to sign a "copyright disclaimer" for the program, if+necessary. For more information on this, and how to apply and follow+the GNU GPL, see <https://www.gnu.org/licenses/>.++The GNU General Public License does not permit incorporating your+program into proprietary programs. If your program is a subroutine+library, you may consider it more useful to permit linking proprietary+applications with the library. If this is what you want to do, use the+GNU Lesser General Public License instead of this License. But first,+please read <https://www.gnu.org/licenses/why-not-lgpl.html>.
+ README.md view
@@ -0,0 +1,362 @@+Motivation+==========++Haskell is a great language for data processing. +You load some data in the IO monad, parse it, +funnel the data through various functions and +write the result back to disk or display it +via a web server. ++The programmer has the `let` and `where` patterns at hand +which can be used to sub-structure a single function, e.g.++ workflow x y = let+ a = f x+ b = g a y+ in h a b++To the environment program, however, +the values of the intermediate steps `a` and `b` +are invisible and the reader does not know you used +the auxiliary functions `f`, `g` and `h`, +although they might be important +when an outsider tries to check the correctness of +the result of the `workflow` function. +This is where the Provenience monad comes in. ++How it works+============++The Provenience monad is an ordinary state monad transformer. +The state is a data flow +[graph](https://hackage.haskell.org/package/fgl "fgl"), +which we call the *variable store*. Nodes are +[Pandoc](https://hackage.haskell.org/package/pandoc "pandoc") renderings +of so-called *variables*. A variable is simply a pair of an ordinary +Haskell value together with its node in the graph. +A computation in the Provenience monad performs any number +of the following five actions. ++* Register a new variable in the variable store +* Provide a description of a registered variable +(in form of a Pandoc [Block](http://hackage.haskell.org/package/pandoc-types/docs/Text-Pandoc-Definition.html#t:Block "Block"))+* Provide a short name for a registered variable (used in hyperlinks)+* Render the value of a registered variable into +its node in the variable store (as a Pandoc `Block`). +There is a class for default rendering methods akin to the `Show` class. +* Apply a variable holding a function to a variable holding a value, +similar to the `<*>` operator of `Applicative` functors. +In the Provenience monad, we write `<%>` instead. ++The fifth action is the only action that adds edges to the +data dependency graph. Suppose we have registered a variable `f` +holding a value of type `a -> b` and a variable `x` holding a +value of type `a`. The description of `f` should explain to the reader +what the function that is the value of `f` does. +The monadic action ++ y <- pure f <%> x++does not register `y` as a new variable; instead `y` points to the same +node in the variable store as `f`. However, the value of `y` is the +application of the value of `f` to the value of `x` and there is now +an edge from `x` to `y` in the data flow graph labelled with the +description of `f`. If `y` is not itself a function +but the desired result, you should overwrite the node's description +(which is still the description of `f`) with a new description of +the value of `y`. ++Why this design choice? Because otherwise partial +application is impossible. If <%> always registered new variables, +then ++ f <%> a <%> b++would register both `f(a)` and `f(a)(b)` as variables, which might not be +what the user intended. But overwriting `f` also means that we can not +re-use the same function variable in several applications. When that is +desired, use a Provenience action producing a variable instead of the +variable itself. Consider the following.++ let f = var succ+ x <- input 4+ y <- f <%> x+ z <- f <%> y++Since the Haskell identifier `f` is bound to a Provenience action +that registers a new variable holding the `succ` function, all +three of `x`, `y` and `z` are distinct variables. +The take-home message is that ++ f <- var succ+ x <- input 4+ y <- pure f <%> x++is a dangerous style because the value of `f` is not what the corresponding +node in the graph is being used for anymore. ++alternative Representation+--------------------------++The variable store also permits to save an alternative representation +of each variable in addition to the Pandoc rendering, +since you might want to provide a machine-readable data flow graph +in addition to a Pandoc document. +Similarly to the <code>IHaskellDisplay</code> class, +each type used in a variable must have a type class instance +that allows automatic conversion into the alternative representation. +If you don't need this feature, simply choose () as the alternative +representation type. +The graph of alternative representations can be extracted from +the variable store. We provide code to assemble the store into a +spreadsheet (of static cells). Foldable structures +of basic values become columns while doubly-nested structures +become tables. +++Example+=======++Continuing the example above, in the Provenience monad you would +write something like the following. Of course it is up to the programmer +to decide how fine-grained the decomposition into Provenience actions +should be. + + workflow x' y' = do+ ---------- register and render the input variables ------------------+ x <- input x' -- register and render x'+ y <- input y'+ x `named` "x" -- links to x show "x" as text+ y `named` "y"+ x <? renderDefault "first item of input data" -- describe x+ y <? renderDefault "second item of input data"+ linkx <- linkto x -- create a hyperlink, used below+ let what_f_does = Para [Str "auxiliary function f applied to ",linkx]+ ---------------------------------------------------------------------+ ------ the actual computation is three lines as in the pure code ----+ a <- func f what_f_does <%> x+ b <- func g (renderDefault "auxiliary function g") <%> a <%> y+ c <- func h (renderDefault "auxiliary function h") <%> a <%> b+ ------ only book-keeping below --------------------------------------+ ---------------------------------------------------------------------+ a `named` "a" >> b `named` "b" >> c `named` "result"+ a <? renderDefault "first intermediate result"+ b <? renderDefault "second intermediate result"+ c <? renderDefault "the workflow result"+ render a >> render b >> render c+ return c++Above, the action `func` registers a new variable and immediately +supplies a description, which is then used as edge label by the +`<%>` operator on the same line. +You see that instead of one line of pure Haskell you are burdened +with writing four kinds of Provenience actions: +*register*, *describe*, *alias* and *render*. But of the four actions, +three are only concerned with providing descriptions that the pure code +did not contain. ++Remarks+=======++This package was inspired by the +[Javelin](https://en.wikipedia.org/wiki/Javelin_Software "wikipedia") +Software. Thanks to John R Levine, one of the authors of Javelin, +for explaining the concepts underlying Javelin. ++By using [Pandoc](https://hackage.haskell.org/package/pandoc "pandoc") +the user has a number of output format choices. +With a little CSS, the above example may be rendered like follows. +Unfortunately, hackage does not allow raw html in markdown, so +you have to convert the markdown yourself. ++(For the sake of example, +we used `f = abs`, `g = replicate` and `h = fmap concat . replicate`). ++<div id="variables">+<div id="provenienceVar1" class="variable" style="border: 2px solid;padding: 10px 40px;width: 400px;border-radius: 25px;">+<div class="shortname" style="font-weight:bold;color:OliveDrab;">+<p>y</p>+</div>+<div class="provenienceKeyword" style="font-weight:bold;">+<p>Used in:</p>+</div>+<ul>+<li><a href="#provenienceVar3" class="outgoing" style="color:DodgerBlue;" title="b">b</a></li>+</ul>+<hr />+<div class="description">+<p>second item of input data</p>+</div>+<div class="valueRendering" style="background-color:#ebebe0;">+<p>t</p>+</div>+</div>+<div id="provenienceVar0" class="variable" style="border: 2px solid;padding: 10px 40px;width: 400px;border-radius: 25px;">+<div class="shortname" style="font-weight:bold;color:OliveDrab;">+<p>x</p>+</div>+<div class="provenienceKeyword" style="font-weight:bold;">+<p>Used in:</p>+</div>+<ul>+<li><a href="#provenienceVar2" class="outgoing" style="color:DodgerBlue;" title="a">a</a></li>+</ul>+<hr />+<div class="description">+<p>first item of input data</p>+</div>+<div class="valueRendering" style="background-color:#ebebe0;">+<p>-4</p>+</div>+</div>+<div id="provenienceVar2" class="variable" style="border: 2px solid;padding: 10px 40px;width: 400px;border-radius: 25px;">+<div class="shortname" style="font-weight:bold;color:OliveDrab;">+<p>a</p>+</div>+<div class="provenienceKeyword" style="font-weight:bold;">+<p>Sources:</p>+</div>+<ul>+<li><a href="#provenienceVar0" class="incoming" style="color:Tomato;" title="x">x</a></li>+</ul>+<div class="edges">+<div class="provenienceKeyword" style="font-weight:bold;">+<p>Construction:</p>+</div>+<p>auxiliary function f applied to <a href="#provenienceVar0" title="x">x</a></p>+</div>+<div class="provenienceKeyword" style="font-weight:bold;">+<p>Used in:</p>+</div>+<ul>+<li><a href="#provenienceVar3" class="outgoing" style="color:DodgerBlue;" title="b">b</a></li>+<li><a href="#provenienceVar4" class="outgoing" style="color:DodgerBlue;" title="result">result</a></li>+</ul>+<hr />+<div class="description">+<p>first intermediate result</p>+</div>+<div class="valueRendering" style="background-color:#ebebe0;">+<p>4</p>+</div>+</div>+<div id="provenienceVar3" class="variable" style="border: 2px solid;padding: 10px 40px;width: 400px;border-radius: 25px;">+<div class="shortname" style="font-weight:bold;color:OliveDrab;">+<p>b</p>+</div>+<div class="provenienceKeyword" style="font-weight:bold;">+<p>Sources:</p>+</div>+<ul>+<li><a href="#provenienceVar1" class="incoming" style="color:Tomato;" title="y">y</a></li>+<li><a href="#provenienceVar2" class="incoming" style="color:Tomato;" title="a">a</a></li>+</ul>+<div class="edges">+<div class="provenienceKeyword" style="font-weight:bold;">+<p>Construction:</p>+</div>+<p>auxiliary function g</p>+</div>+<div class="provenienceKeyword" style="font-weight:bold;">+<p>Used in:</p>+</div>+<ul>+<li><a href="#provenienceVar4" class="outgoing" style="color:DodgerBlue;" title="result">result</a></li>+</ul>+<hr />+<div class="description">+<p>second intermediate result</p>+</div>+<div class="valueRendering" style="background-color:#ebebe0;">+<p>tttt</p>+</div>+</div>+<div id="provenienceVar4" class="variable" style="border: 2px solid;padding: 10px 40px;width: 400px;border-radius: 25px;">+<div class="shortname" style="font-weight:bold;color:OliveDrab;">+<p>result</p>+</div>+<div class="provenienceKeyword" style="font-weight:bold;">+<p>Sources:</p>+</div>+<ul>+<li><a href="#provenienceVar2" class="incoming" style="color:Tomato;" title="a">a</a></li>+<li><a href="#provenienceVar3" class="incoming" style="color:Tomato;" title="b">b</a></li>+</ul>+<div class="edges">+<div class="provenienceKeyword" style="font-weight:bold;">+<p>Construction:</p>+</div>+<p>auxiliary function h</p>+</div>+<hr />+<div class="description">+<p>the workflow result</p>+</div>+<div class="valueRendering" style="background-color:#ebebe0;">+<p>tttttttttttttttt</p>+</div>+</div>+</div>++Alternatives and shortcomings+=============================++Spreadsheets excel at displaying intermediate values, +although comprehending the meaning and intention of +spreadsheet formulas requires experience. Needless to say, +Haskell is way more expressive than the formula language +of contemporary spreadsheets.++Limiting yourself to one of Pandoc's output formats, +you might write a +[haskintex](http://hackage.haskell.org/package/haskintex "haskintex") +document instead of a Provenience expression. +Haskintex may be regarded as a form of literate programming, +and you can use any of the numerous string interpolation packages +or a library for type-safe construction of the target document format +(e.g. +[HaTeX](http://hackage.haskell.org/package/HaTeX "HaTeX"), +[blaze](http://hackage.haskell.org/package/blaze-html "blaze") or +[Pandoc](https://hackage.haskell.org/package/pandoc "pandoc"))+to achieve the same outcome. +However, you will not get the complete data flow graph for free. ++Some programming languages provide interactive *notebooks*, e.g. the +[IPython](https://github.com/ipython "IPython") interactive notebooks +or the [IHaskell](http://hackage.haskell.org/package/ihaskell "ihaskell") +variant. +[Hyper-Haskell](https://github.com/HeinrichApfelmus/hyper-haskell "hyper-haskell") +is another approach to Haskell workbooks and shares some ideas with this package. +[Typed Spreadsheets](http://hackage.haskell.org/package/typed-spreadsheet "typed-spreadsheet") +sort of do what this package does in an interactive way, although it does not show +intermediate results. +Working with large quantities of input data might become unwieldy, however. +Rendering a notebook or interactive spreadsheet, though, requires the underlying language +to be installed on the system. +In contrast the philosophy of Provenience +is that computation and display take place on different machines, +and that a Provenience computation is only a small part +of an actual application. ++Perhaps the biggest shortcoming at present is +the behaviour of `mapM`. +When you `mapM` a Provenience function over a +traversable structure like a list, +each element registers the same number of variables, +whereas your intention probably was to register the +entire traversable structure as input and obtain +a single output variable. +At present you have to do this transformation yourself. ++TODOs+=====++Add support for an actual graph layout of the variable store +by means of a library such as [graphViz](http://hackage.haskell.org/package/graphviz "graphViz"). ++Perhaps it is wise to make usage of variables which meanwhile have been overwritten illegal to use. ++How could one retain the functions in the data flow graph, +making the data flow interactive? +We'd have to map a subset of Haskell onto some serializable type, +e.g. spreadsheet formulas or JavaScript.
+ Setup.hs view
@@ -0,0 +1,2 @@+import Distribution.Simple+main = defaultMain
+ provenience.cabal view
@@ -0,0 +1,34 @@+name: provenience+version: 0.1.0.0+synopsis: Computations that automatically track data dependencies+description: see README.md+license: GPL-3+license-file: LICENSE.md+author: Olaf Klinke olf@aatal-apotheke.de+maintainer: olaf.klinke@phymetric.de+copyright: (c) 2020-2021 Lackmann Phymetric GmbH+homepage: https://hackage.haskell.org/package/provenience+category: Algorithm Visualization+build-type: Simple+extra-source-files: README.md+cabal-version: >=1.10+tested-with: GHC == 7.10.3, GHC == 8.4.4, GHC == 8.6.5++library+ hs-source-dirs: src+ exposed-modules: Control.Provenience+ , Data.Representation+ , Data.Spreadsheet+-- tested against stackage lts-6.35 up to lts-14.22+ build-depends: base >= 4.7 && < 5+ , mtl >= 2.2.1 && <= 2.2.2+ , fgl >= 5.5.3.1 && <= 5.7.0.1+ , pandoc >= 1.16 && <= 2.7.3+ , blaze-markup >= 0.7.1.1 && <= 0.8.2.3+ , aeson >= 0.11.3.0 && <= 1.4.6.0+ , data-default >= 0.5.3 && < 0.8+ , containers >= 0.5.6.2 && <= 0.6.0.1+ , time >= 1.5.0.1 && <= 1.8.0.2+ , text >= 1.2.2.2 && <= 1.2.3.1+ default-language: Haskell2010+ other-extensions: CPP
+ src/Control/Provenience.hs view
@@ -0,0 +1,494 @@+{-| +Module : Control.Provenience +Description : A monad transformer for computations that automatically track data dependencies +Copyright : (c) Olaf Klinke +License : GPL-3 +Maintainer : olaf.klinke@phymetric.de +Stability : experimental + +The Provenience system lets you execute a function on +particular input data while automatically recording +the intermediate results together with a graph of the data flow. +It is inspired by the Javelin software of the 80s which pre-dates +Excel spreadsheets. + +Intermediate results are stored in 'Variable's, +which decorate the data with a description. +Instead of binding data to a Haskell identifier, +you bind data to a 'Variable' and provide a description of +what the data is. +Instead of applying a logical part to intermediate data, +you apply the logical part to intermediate variables. So instead of writing code like + +@ +workflow x y z = let + a = f x y + b = g a z + in h b +@ + +with 'Provenience' you write + +@ +workflow x y z = do + x' <- 'input' x + y' <- 'input' y + z' <- 'input' z + a \<- 'var' f '<%>' x' '<%>' y' + b \<- 'var' g '<%>' a z' + 'return' ('var' h '<%>' b) +@ + +In addition to the above you should provide decoration for the variables which is +used when rendering the data dependency graph. See '<?' and 'named'. +If and how the 'value' of the variable is rendered is controlled +with the 'render' family functions and the 'DefaultRender' class. + +The 'ProvenienceT' transformer has an additional type parameter +for a machine-readable representation of a value. +If you don't care about this, just use the unit type () here +as in the 'Provenience' type. +Otherwise, all calls to 'render' must be done on 'Variable's of types which +have a 'Representation' in the chosen alternative type. +After running the 'ProvenienceT' computation you can extract +the graph containing the alternative representations using 'graphAltReps'. +If the target representation is a spreadsheet, use 'renderSheet' +to obtain a spreadsheet where 'Variable's are blocks of rows +separated by blank rows. +-} + +{-# LANGUAGE CPP,MultiParamTypeClasses,FlexibleInstances,FlexibleContexts,OverloadedStrings,Rank2Types,ScopedTypeVariables #-} +module Control.Provenience ( + -- * Variables + Variable(..) + ,VariableStore + ,var + ,varM + ,input + ,inputM + ,func + -- ** Modifiers + ,StoreUpdate + ,(<?) + ,named + -- ** Rendering + ,linkto + ,render + ,renderWith + ,renderShow + ,DefaultRender(..) + ,Proveniencei18n(..) + ,enProveniencei18n + ,deProveniencei18n + ,renderStore + ,renderSheet + ,graphAltReps + ,graphShortnames + -- * The Provenience monad + ,ProvenienceT(..) + ,Provenience + ,(<%>) + ,(<%%>) + ,runProvenienceT + ,execProvenienceT + ,execProvenience + ,evalProvenienceT + ,evalProvenience + ,sequenceProvenienceT) where +import Control.Monad +import Control.Monad.State.Strict -- package mtl +import Control.Arrow +import Data.Functor.Identity +import Data.Graph.Inductive.Graph -- package fgl +import Data.Graph.Inductive.PatriciaTree +import Data.Graph.Inductive.Query.DFS (topsort) +import Data.Default --package data-default +import Data.Ratio +import Data.Monoid +import Data.Word (Word64) +import Data.Sequence (Seq) +import qualified Data.Sequence as Seq +import Data.Representation +import Data.Spreadsheet +import qualified Data.Set as Set --package containers +import Data.Text (Text,pack,unpack) +import Text.Pandoc -- package pandoc +import Numeric (showHex) + +-- * Types + +-- | The representation of a variable in the data dependency graph. +-- Only a dependent or existential type could hold the actual values. +-- Hence the graph only stores renderings of the variables +-- along with user-supplied descriptions. +-- The type parameter defines an alternative value description, +-- which could be a String, JSON or XML representation. +data VariableDesc alt = VariableDesc { + shortname :: Maybe String, -- ^ a symbol referring to the 'Variable' + description :: Block, -- ^ a description explaining the content + valueRendering :: Block, -- ^ a rendering of the 'Variable's 'value' + altRep :: alt -- ^ alternative representation + } +-- | Variables are internally numbered by 'Node' = 'Int' +-- and have an alternative value 'Representation' @alt@. +-- Futher each variable has a Pandoc 'description' (set by '<?') +-- and optionally a 'shortname' set by 'named' which is a 'String' +-- to be used in hyperlinks. +data VariableStore alt = VariableStore { + dependencyGraph :: Gr (VariableDesc alt) Block, + nextFreeNode :: Node} + +-- | Obtain a graph of all the 'Variable's alternative representations +graphAltReps :: VariableStore alt -> Gr alt Block +graphAltReps = nmap altRep . dependencyGraph + +-- | Obtain a graph of all the 'Variable's short names +graphShortnames :: VariableStore alt -> Gr String Block +graphShortnames = nmap (maybe "" id . shortname) . dependencyGraph + +getDescription :: Node -> VariableStore alt -> Maybe (VariableDesc alt) +getDescription i store = case match i (dependencyGraph store) of + (Nothing,_) -> Nothing + (Just (_,_,desc,_),_) -> Just desc +getShortname :: Node -> VariableStore alt -> Maybe String +getShortname i = getDescription i >=> shortname + +-- | Every 'Variable' has an 'identifier' in the data flow graph. +data Variable a = Variable { + identifier :: Node, + value :: a} +instance Functor Variable where + fmap f x = x {value = f (value x)} +instance Show a => Show (Variable a) where + show v = show (value v) +linkname :: Variable a -> String +linkname = linknode . identifier +linknode :: Node -> String +linknode n = "provenienceVar" ++ showHex n "" + +-- | A 'Monad' transformer that keeps track of data dependencies +type ProvenienceT alt m a = StateT (VariableStore alt) m (Variable a) +-- | @'Provenience' = 'ProvenienceT' () 'Identity'@ +type Provenience a = State (VariableStore ()) (Variable a) +-- | Action on the 'VariableStore' +type StoreUpdate = forall m alt. Monad m => StateT (VariableStore alt) m () + +-- * Rendering + +-- | Class of types with a default rendering method. +-- For the basic types 'renderDefault' equals 'renderShow'. +class DefaultRender a where + renderDefault :: a -> Block +-- | 'render' 'String's as plain text. +#if MIN_VERSION_pandoc(2,8,0) +-- pandoc.types >= 1.20 has Str Text so the instances for Text and String must be swapped +instance DefaultRender String where + renderDefault = Para . pure . Str . pack +#else +instance DefaultRender String where + renderDefault = Para . pure . Str +#endif +instance DefaultRender Block where + renderDefault = id +#if MIN_VERSION_pandoc(2,8,0) +-- pandoc.types >= 1.20 has Str Text so the instances for Text and String must be swapped +instance DefaultRender Text where + renderDefault = Para . pure . Str +#else +instance DefaultRender Text where + renderDefault = Para . pure . Str . unpack +#endif +instance DefaultRender Char where + renderDefault = renderDefault . (pure :: Char -> String) +instance DefaultRender Int where + renderDefault = renderShow +instance DefaultRender Integer where + renderDefault = renderShow +instance DefaultRender Double where + renderDefault = renderShow +#if MIN_VERSION_pandoc(2,8,0) +-- Math expects Text when pandoc-types >= 1.20 +instance DefaultRender (Ratio Integer) where + renderDefault x = Plain [Math InlineMath (pack $ "\\frac{"++(show (numerator x))++"}{"++(show (denominator x))++"}")] +#else +instance DefaultRender (Ratio Integer) where + renderDefault x = Plain [Math InlineMath ("\\frac{"++(show (numerator x))++"}{"++(show (denominator x))++"}")] +#endif + +-- | Supply the 'valueRendering' and 'altRep' for the variable. +renderWith :: (Representation a alt, Monad m) => (a -> Block) -> Variable a -> StateT (VariableStore alt) m () +renderWith method v = modify' (\vs -> changeLabel (identifier v) (\desc -> desc {valueRendering = method (value v), altRep = representation (value v)}) vs) + +-- | Use the 'show' method to render a 'value' as 'Plain' text. +renderShow :: Show a => a -> Block +renderShow = Plain . pure . Str . show + +-- | @'render' = 'renderWith' 'renderDefault'@. +-- You can use this function without providing a 'DefaultRender' instance +-- by using a conversion function to a type that is member of 'DefaultRender': +-- +-- @ +-- \\f -> 'render' . 'fmap' f +-- @ +render :: (Representation a alt, Monad m, DefaultRender a) => Variable a -> StateT (VariableStore alt) m () +render = renderWith renderDefault + +-- | Internationalization of the keywords used in 'renderStore'. +data Proveniencei18n = Proveniencei18n { + i18n_construction :: Inline, -- ^ keyword for the edge labels + i18n_incoming :: Inline, -- ^ keyword for the nodes upstream + i18n_outgoing :: Inline -- ^ keyword for the nodes downstream +} deriving (Show) + +-- | English version +enProveniencei18n :: Proveniencei18n +enProveniencei18n= Proveniencei18n { + i18n_construction = Str "Construction:", + i18n_incoming = Str "Sources:", + i18n_outgoing = Str "Used in:" +} + +-- | German version +deProveniencei18n :: Proveniencei18n +deProveniencei18n = Proveniencei18n { + i18n_construction = Str "Erzeugung:", + i18n_incoming = Str "Quellen:", + i18n_outgoing = Str "Verwendet in:" +} + +-- | default is 'enProveniencei18n' +instance Default Proveniencei18n where + def = enProveniencei18n + +-- | Render the store with Pandoc. For each 'Variable' the following data is written: +-- +-- (1) The variable name given with 'named', +-- 2. The variables linking to this one (if any), +-- 3. The edge labels linking to this variable, +-- 4. The variables depending on this one (if any), +-- 5. The description provided with '<?', +-- 6. A rendering of the value as provided by one of the 'render' family functions. +renderStore :: Proveniencei18n -> VariableStore alt -> Block +renderStore i18n variables = let + nodelist = topsort (dependencyGraph variables) :: [Node] + renderIncoming i = let txt = maybe (show i) id (getShortname i variables) + in Link ("",["incoming"],[]) [Str txt] ('#':linknode i,txt) + renderOutgoing i = let txt = maybe (show i) id (getShortname i variables) + in Link ("",["outgoing"],[]) [Str txt] ('#':linknode i,txt) + renderVariable i = let + Just desc = getDescription i variables + how = foldMap (\(_,_,f) -> Set.singleton f) (inn (dependencyGraph variables) i) + sayhow = if Set.null how then [] else [Div ("",["edges"],[]) $ (Div ("",["provenienceKeyword"],[]) [Para [i18n_construction i18n]]):(Set.toList how)] + short = case shortname desc of + Nothing -> [] + Just name -> [Header 3 ("",["shortname"],[]) [Str name]] + sources = case pre (dependencyGraph variables) i of + [] -> [] + js@(_:_) -> [Div ("",["provenienceKeyword"],[]) [Para [i18n_incoming i18n]],BulletList $ map (pure . Plain . pure . renderIncoming) js] + sinks = case suc (dependencyGraph variables) i of + [] -> [] + js@(_:_) -> [Div ("",["provenienceKeyword"],[]) [Para [i18n_outgoing i18n]],BulletList $ map (pure . Plain . pure . renderOutgoing) js] + in Div (linknode i,["variable"],[]) $ short++sources++sayhow++sinks++[ + HorizontalRule, + Div ("",["description"],[]) [description desc], + Div ("",["valueRendering"],[]) [valueRendering desc]] + (n0,n1) = nodeRange (dependencyGraph variables) + in Div ("variables"++(showHex n0 ("To"++(showHex n1 ""))),["provenienceVariables"],[]) (map renderVariable nodelist) + +-- | When the alternative representation is in terms of spreadsheet rows, +-- we can assemble the 'VariableStore' into a spreadheet. +-- This is analogous to 'renderStore' but only places the data underneath +-- the 'shortname', thus omitting any formatted descriptions. +renderSheet :: forall row sheet. (ToSheet row sheet, ToRow StaticCellValue row) => + Proveniencei18n -> VariableStore (Seq row) -> sheet +renderSheet i18n variables = let + nodelist = topsort (dependencyGraph variables) :: [Node] + emptyRow = cellList ([] :: [StaticCellValue]) + renderVariable :: Node -> Seq row + renderVariable i = let + Just desc = getDescription i variables + short = case shortname desc of + Nothing -> Seq.empty + Just name -> Seq.singleton (cellList [CellText name]) + in short <> altRep desc <> Seq.singleton emptyRow + in chunksToSheet (fmap renderVariable nodelist) + +-- * Graph helper functions +changeLabel :: Node -> (VariableDesc alt -> VariableDesc alt) -> VariableStore alt -> VariableStore alt +changeLabel n f vs = vs {dependencyGraph = chl n f (dependencyGraph vs)} where + chl i f gr = let (mcntxt,gr') = match i gr in case mcntxt of + Nothing -> gr + Just (incoming,_,l,outgoing) -> (incoming,i,f l,outgoing) & gr' + + +-- | Register a new variable with content +-- from a monadic action in the 'VariableStore'. +-- This variable has neither 'description', 'shortname' nor 'valueRendering'. +varM :: Monad m => m a -> ProvenienceT alt m a +varM a = StateT $ \vs -> do + let i = nextFreeNode vs + v <- fmap (Variable i) a + let desc = VariableDesc { + shortname = Nothing, + description = Null, + valueRendering = Null, + altRep = error "no alternative representation supplied" + } + return (v,vs {dependencyGraph = insNode (i,desc) (dependencyGraph vs), nextFreeNode = succ i}) + +-- | Register a new variable in the 'VariableStore'. +-- This variable has neither 'description', 'shortname' nor 'valueRendering'. +-- +-- @ +-- 'var' = 'varM' . 'pure' +-- @ +var :: Monad m => a -> ProvenienceT alt m a +var = varM . pure + +-- | Register a static input variable +-- with content from a monad action +-- which is immediately 'render'ed. +inputM :: (Monad m, Representation a alt, DefaultRender a) => m a -> ProvenienceT alt m a +inputM a = do + x <- varM a + render x + return x + +-- | Register a static input variable which is immediately 'render'ed. +input :: (Monad m, Representation a alt, DefaultRender a) => a -> ProvenienceT alt m a +input a = do + x <- var a + render x + return x + +-- | Combination of 'var' and '<?' that can be used for immediate function application, e.g. +-- +-- @ +-- x \<- 'input' 1 +-- y \<- 'input' 2 +-- xy \<- 'func' (*) ('renderDefault' "*") '<%>' x '<%>' y +-- @ +func :: (Monad m, Default alt) => a -> Block -> ProvenienceT alt m a +func f what = do + v <- var f + v <? what + return v + +infixl 3 <? +-- | The /what is this?/-operator. Changes the 'description' of the computation's result. +-- +-- >>> v <- var 99 +-- >>> v <? renderDefault "bottles of beer on the wall" +(<?) :: Variable a -> Block -> StoreUpdate +v <? about = modify' (\vs -> changeLabel (identifier v) (\desc -> desc {description=about}) vs) + +-- | Provides a 'shortname' symbol for the 'Variable', for use in hyperlinks and other references. +-- +-- >>> v <- var 99 +-- >>> v `named` "beer" +named :: Variable a -> String -> StoreUpdate +v `named` name = modify' (\vs -> changeLabel (identifier v) (\desc -> desc {shortname = Just name}) vs) + +infixl 4 <%>, <%%> +-- | 'Applicative'-style application operator. +-- Replaces the function 'Variable' with its (partial) application +-- and creates an edge from the argument to the result 'Variable' +-- that is labeled with the function description. +-- +-- @ +-- f <- 'func' 'succ' ('renderDefault' "successor") +-- x <- 'input' (5 :: Int) +-- y \<- 'pure' f '<%>' x +-- x '<?' 'renderDefault' "input data" +-- y '<?' 'renderDefault' "The successor of 5" +-- 'render' y +-- @ +-- +-- The above creates the following graph. +-- +-- @ +-- "input data" "successor" "The successor of 5" +-- 5 -----------> 6 +-- @ +-- +-- If you want to re-use a function in several applications then +-- bind @f@ to the 'Provenience' action rather the 'Variable' like below. +-- +-- @ +-- let f = 'func' 'succ' ('renderDefault' "successor") +-- x <- 'input' (5 :: Int) +-- y \<- f '<%>' x +-- z \<- f '<%>' y +-- @ +(<%>) :: Monad m => ProvenienceT alt m (a -> b) -> Variable a -> ProvenienceT alt m b +pf <%> x = ((fmap.fmap) (pure.) pf) <%%> x + +-- | Like above but permit side-effects in the base monad. +(<%%>) :: Monad m => ProvenienceT alt m (a -> m b) -> Variable a -> ProvenienceT alt m b +pf <%%> x = do + f <- pf + StateT $ \store -> case getDescription (identifier f) store of + Nothing -> error ("Node "++(show (identifier f))++" not element of the store.") + Just desc -> let + modification = \vs -> vs {dependencyGraph = insEdge (identifier x, identifier f, description desc) (dependencyGraph vs)} + in do + y <- (value f) (value x) + return (f {value = y},modification store) + +-- | Render a hyperlink to a 'Variable', +-- to be used e.g. in descriptions of downstream variables. +-- Make sure to provide a short name via 'named' before calling 'linkto'. +linkto :: Monad m => Variable a -> StateT (VariableStore alt) m Inline +linkto v = do + store <- get + let linktext = maybe (linkname v) id (getShortname (identifier v) store) + return $ Link nullAttr [Str linktext] ('#':linkname v,linktext) + +-- | Run the Provenience monad and return the value of the result variable +-- together with the 'VariableStore' and its next unused 'Node'. +-- Initialize the 'VariableStore' with an empty graph and start with +-- the given 'Node' identifier. +runProvenienceT :: Monad m => ProvenienceT alt m a -> Node -> m ((a,VariableStore alt),Node) +runProvenienceT p n = fmap ((first value) &&& (nextFreeNode.snd)) (runStateT p st) where + st = VariableStore { + dependencyGraph = empty, + nextFreeNode = n} + +-- | Run multiple 'ProvenienceT' actions using the same pool of 'Node's +-- but returning seperate 'VariableStore's. +-- This is useful when several data flow graphs get +-- embedded into the same document, where hyperlink targets must be unique. +sequenceProvenienceT :: (Traversable t, Monad m) => t (ProvenienceT alt m a) -> m (t (a,VariableStore alt)) +sequenceProvenienceT ps = evalStateT (mapM (StateT . runProvenienceT) ps) 0 where + +-- | run the Provenience monad and return the data dependency graph +execProvenienceT :: Monad m => ProvenienceT alt m a -> Node -> m (VariableStore alt,Node) +execProvenienceT computation n = fmap (snd *** id) (runProvenienceT computation n) +-- | run the Provenience monad and return the data dependency graph +execProvenience :: Provenience a -> Node -> (VariableStore (),Node) +execProvenience computation n = runIdentity (execProvenienceT computation n) + +-- | run the Provenience monad and return the resulting value. +evalProvenienceT :: Monad m => ProvenienceT alt m a -> m a +evalProvenienceT computation = fmap (fst.fst) (runProvenienceT computation 0) +-- | run the Provenience monad and return the resulting value. +evalProvenience :: Provenience a -> a +evalProvenience computation = runIdentity (evalProvenienceT computation) + + +{-- style für HTML-Ausgabe: +<style type="text/css"> +div.variable{ + margin-left: 40px; + border: 2px solid; + padding: 10px 40px; + width: 300px; + border-radius: 25px; +} +div.shortname{font-weight:bold; color:OliveDrab;} +a.incoming {color:Tomato;} +a.outgoing {color:DodgerBlue;} +div.valueRendering {background-color:#ebebe0;} +div.provenienceKeyword {font-weight:bold;} +</style> +--}
+ src/Data/Representation.hs view
@@ -0,0 +1,94 @@+{-# LANGUAGE MultiParamTypeClasses, FlexibleInstances, FlexibleContexts #-}+{-|+Module : Data.Representation+Description : Represent various data in a common type, such as text or tables+Copyright : (c) Olaf Klinke+License : GPL-3+Maintainer : olaf.klinke@phymetric.de+Stability : experimental++Haskell has no dependent types, whence we can store only one type of value +at each node of the data dependency graph. If in addition to Pandoc +you want to extract the data in a machine-readable format, +then set the @alt@ type parameter of your Provenience actions accordingly +and provide 'Representation' instances for all your variable values. +Each call to @render@ or @renderWith@ automatically invokes a call to 'representation'. ++In order to keep the dependency list of this package small +beyond the dependencies of pandoc, we have omitted +many useful instances. +Add your own instances as you see fit, for example ++@+instance Serializable a => Representation a ByteString where+ representation = toByteString+@++For spreadsheet-like representations, ++- basic values become single cells in a single row,+- foldable structures of basic values become single columns,+- doubly-nested structures of basic values become proper tables. ++-}+module Data.Representation where+import Data.Spreadsheet+import Data.Time+import Data.Sequence+import Data.Ratio+import Data.Aeson.Types (Value,ToJSON(..))+import Text.Blaze (Markup,ToMarkup(..))++-- | A representation of type @a@ as type @b@, not necessarily invertible. +class Representation a b where+ representation :: a -> b++-- | The Prelude provides a 'String' representation+instance Show a => Representation a String where+ representation = show++-- | Representation as JSON 'Value's+instance ToJSON a => Representation a Value where+ representation = toJSON++-- | Representation via blaze+instance ToMarkup a => Representation a Markup where+ representation = toMarkup++-- | Dummy instance when no alternative representation is required. +-- @'representation' = 'const' ()@+instance Representation a () where+ representation = const ()+-- @()@ is the terminal object of the category @Hask@++-- single values are single cells in a single row+instance (ToRow StaticCellValue row) => Representation (Ratio Integer) (Seq row) where -- needed to resolve overlap because Ratio could be Foldable+ representation x = pure (cellList [CellNumber x])+instance {-# OVERLAPPABLE #-} (ToRow StaticCellValue row, Real a) => Representation a (Seq row) where+ representation x = pure (cellList [CellNumber (toRational x)])+instance ToRow StaticCellValue row => Representation String (Seq row) where+ representation txt = pure (cellList [CellText txt])+instance ToRow StaticCellValue row => Representation Bool (Seq row) where+ representation b = pure (cellList [CellBool b])+instance ToRow StaticCellValue row => Representation ZonedTime (Seq row) where+ representation t = pure (cellList [CellTime t]) ++-- lists are single columns+instance {-# OVERLAPPABLE #-} (Foldable f, ToRow StaticCellValue row, Real a) => Representation (f a) (Seq row) where+ representation = foldr (\x rows -> (cellList [CellNumber (toRational x)]) <| rows) empty+instance (Foldable f, ToRow StaticCellValue row) => Representation (f String) (Seq row) where+ representation = foldr (\t rows -> (cellList [CellText t]) <| rows) empty+instance (Foldable f, ToRow StaticCellValue row) => Representation (f Bool) (Seq row) where+ representation = foldr (\b rows -> (cellList [CellBool b]) <| rows) empty+instance (Foldable f, ToRow StaticCellValue row) => Representation (f ZonedTime) (Seq row) where+ representation = foldr (\t rows -> (cellList [CellTime t]) <| rows) empty++-- nested lists become tables+instance {-# OVERLAPPABLE #-} (Foldable r, ToRow StaticCellValue row, Traversable c, Real a) => Representation (r (c a)) (Seq row) where+ representation = foldr (\xs rows -> cellList (fmap (CellNumber . toRational) xs) <| rows) empty+instance (Foldable r, ToRow StaticCellValue row, Traversable c) => Representation (r (c String)) (Seq row) where+ representation = foldr (\xs rows -> cellList (fmap CellText xs) <| rows) empty+instance (Foldable r, ToRow StaticCellValue row, Traversable c) => Representation (r (c Bool)) (Seq row) where+ representation = foldr (\xs rows -> cellList (fmap CellBool xs) <| rows) empty+instance (Foldable r, ToRow StaticCellValue row, Traversable c) => Representation (r (c ZonedTime)) (Seq row) where+ representation = foldr (\xs rows -> cellList (fmap CellTime xs) <| rows) empty
+ src/Data/Spreadsheet.hs view
@@ -0,0 +1,141 @@+{-# LANGUAGE MultiParamTypeClasses, FlexibleInstances, FlexibleContexts, ScopedTypeVariables #-}+{-|+Module : Data.Spreadsheet+Description : Least common denominator of spreadsheet formats+Copyright : (c) Olaf Klinke+License : GPL-3+Maintainer : olaf.klinke@phymetric.de+Stability : experimental++Various formats for spreadsheet exist, e.g. +the open office (xlsx) format, +the Microsoft SpreadsheetML format, +the binary Microsoft xls format +and CSV. ++This module defines the least common denominator of static cell data. +The intention is to use chunks of rows as alternative representation type +in your ProvenienceT transformer. +After performing the computation, extract all the spreasheet chunks +and combine into a worksheet using 'chunksToSheet'. ++For example, in order to use the types of the <http://hackage.haskell.org/package/xlsx xlsx> package +which exports the @Cell@ and @CellMap@ types, you should provide the following instances. ++@+instance ToCell Cell where+instance ToSheet 'StaticRow' CellMap where+ rowMap = Data.Map.fromList . foldMap (\\(rowidx,row) -> map (\\(colidx,val) -> ((fromIntegral rowidx,fromIntegral colidx),'staticCell' val)) row)+@++where the first instance aids in writing the second instance. +Then you can use 'SheetChunk' as alternative representation and +produce a @CellMap@ using 'chunksToSheet'.+-}+module Data.Spreadsheet (+ -- * Speadsheet type classes+ ToCell(..),ToRow(..),ToSheet(..),+ -- * Concrete spreadsheet types+ StaticCellValue(..),+ cellBool,cellNumber,cellText,cellTime,+ StaticRow,StaticSheet,SheetChunk,+ chunksToSheet) where+import Data.Time+import Data.Traversable+import Data.Foldable+import Data.Word+import Data.Sequence (Seq)+import qualified Data.Text as T+import Control.Arrow (second)++-- | A static cell value, the initial object of the 'ToCell' class.+data StaticCellValue = CellBool Bool + | CellNumber Rational+ | CellText String+ | CellTime ZonedTime deriving (Show)++-- | generic row type: list of cells with column numbers+type StaticRow = [(Word64,StaticCellValue)]+-- | generic sheet type: list of rows with row numbers+type StaticSheet = [(Word64,StaticRow)]+-- | Part of a spreadsheet which does not yet know +-- its absolute row numbers. +type SheetChunk = Seq StaticRow+-- | Combine several chunks into a worksheet, e.g. +-- +-- @+-- 'chunksToSheet' :: ['SheetChunk'] -> 'StaticSheet'+-- @+chunksToSheet :: (Traversable f, Traversable chunk, Monoid (chunk (Word64,row)), ToSheet row sheet) => + f (chunk row) -> sheet+chunksToSheet = rowMap . foldMap id . snd . mapAccumL (\n chunk -> addIndexFrom n chunk) 1++-- | Cell type supporting static values: Booleans, Numbers, Text and Time. +class ToCell cell where+ staticCell :: StaticCellValue -> cell+instance ToCell StaticCellValue where+ staticCell = id+-- | for building CSV data+instance ToCell T.Text where+ staticCell (CellBool b) = T.pack . quote . show $ b+ staticCell (CellNumber n) = T.pack . show . (fromRational :: Rational -> Double) $ n+ staticCell (CellText s) = T.pack . quote . escapeSemicolon $ s+ staticCell (CellTime t) = T.pack . quote . show $ t++escapeSemicolon :: String -> String+escapeSemicolon = (=<<) e where+ e ';' = "\\;"+ e '\\' = "\\\\"+ e c = [c]+quote :: String -> String+quote = (flip (++) "\"").('"':)++cellBool :: ToCell cell => Bool -> cell+cellBool = staticCell . CellBool+cellNumber :: ToCell cell => Rational -> cell+cellNumber = staticCell . CellNumber+cellText :: ToCell cell => String -> cell+cellText = staticCell . CellText+cellTime :: ToCell cell => ZonedTime -> cell+cellTime = staticCell . CellTime++-- | A @row@ holding several @cell@s+class ToRow cell row where+ cellList :: Traversable f => f cell -> row+ -- ^ default is to number consecutively from 1+ cellList = cellMap . snd . addIndexFrom 1+ cellMap :: Traversable f => f (Word64,cell) -> row+instance ToRow cell [(Word64,cell)] where+ cellMap = Data.Foldable.toList+-- | separates cells with semicolons+instance ToRow T.Text T.Text where+ cellMap = concatWithFrom (T.pack ";") 1 +instance ToRow StaticCellValue T.Text where+ cellMap = concatWithFrom (T.pack ";") 1 . fmap (second staticCell)++-- | A worksheet @sheet@ holding several @row@s. +-- Assemble a worksheet from cells using e.g. either of +-- +-- @+-- import Control.Arrow (second)+-- 'rowMap' . 'fmap' (second 'cellMap')+-- 'rowList' . 'fmap' 'cellList'+-- @+class ToSheet row sheet where+ rowList :: Traversable f => f row -> sheet+ -- ^ default is to number consecutively from 1+ rowList = rowMap . snd . addIndexFrom 1 + rowMap :: Traversable f => f (Word64,row) -> sheet+instance ToSheet row [(Word64,row)] where+ rowMap = Data.Foldable.toList+-- | separates rows by newlines+instance ToSheet T.Text T.Text where+ rowMap = concatWithFrom (T.pack "\n") 1++addIndexFrom :: Traversable f => Word64 -> f b -> (Word64, f (Word64,b))+addIndexFrom i = mapAccumL (\n x -> (n+1,(n,x))) i++-- concat with the right number of separators+concatWithFrom :: (Traversable t, Monoid a) => a -> Int -> t (Word64,a) -> a+concatWithFrom sep i = foldMap id . snd . mapAccumL f i where+ f i (j,x) = let j' = fromIntegral j in (j',mconcat (replicate (j'-i) sep) `mappend` x)