Catmandu-XSD-0.05000755000765000024 013547037252 13735 5ustar00hochstenstaff000000000000README100644000765000024 2033013547037252 14714 0ustar00hochstenstaff000000000000Catmandu-XSD-0.05NAME Catmandu::XSD - Modules for handling XML data with XSD compilation SYNOPSIS ## Converting XML to YAML/JSON/CSV/etc # Compile an XSD schema file and parse one shiporder.xml file catmandu convert XSD --root '{}shiporder' --schemas demo/order/*.xsd to YAML < shiporder.xml # Same as above but parse more than one file into an array of records catmandu convert XSD --root '{}shiporder' --schemas demo/order/*.xsd --files 'data/*.xml' to YAML # Same as above but all array of records are in a XML container file catmandu convert XSD --root '{}shiporder' --schemas demo/order/*.xsd --xpath '/Container/List//Record/Payload/*' to YAML < data/container.xml ## Convert an YAML/JSON/CSV into XML validated against an XSD schemas # Convert one shiporder YAML to XML catmandu convert YAML to XSD --root '{}shiporder' --schemas demo/order/*.xsd < shiporder.YAML # Same as above but store multiple shiporders in the YAML into a separate file catmandu convert YAML to XSD --root '{}shiporder' --schemas demo/order/*.xsd --split 1 < shiporder.YAML # Same as above but use template toolkit to pack the XML into an container # (The xml record is stored in the 'xml' key which can be retrieved in the # template by [% xml %]) catmandu convert YAML to XSD --root '{}shiporder' --schemas demo/order/*.xsd --template_before t/xml_header.tt --template t/xml_record.tt --template t/xml_footer.tt < shiporder.YAML ## Example documents # Show an example how a valid XML document needs to be structured for an # XSD scheme. catmandu convert XSD --root {}shiporder --schemas "t/demo/order/*xsd" --example 1 to YAML DESCRIPTION Catmandu::XSD contains modules for handling XML data within the Catmandu framework. Parsing and serializing is based on XML::Compile. There are two modules available for handling XML data in the Catmandu framework: Catmandu::XML and Catmandu::XSD. The former one can be used when no XML schema is available for the data. It provides a simple interface to read in XML data and transform it to other formats. Because Catmandu::XML doesn't depend on an XSD schema, it can't know which fields in the input XML files are sequences or single value elements. Each record is parsed on its own. A record with content: test will be parsed into a YAML output like: catmandu XML to YAML < test.xml -- bar: test A record with content: test test will be parsed into a YAL output like: catmandu XML to YAML < test2.xml -- bar: - test - test In the first case 'bar' will contain a string, in the second case an array. This might no be what you want in some programming projects. E.g. when you need the 'bar' field to be always an array of values, then you an XSD schema file is required containing the exact structure of the XML document: test.xsd: And now the test.xml and test2.xml can be parsed with help of Catmandu::XSD: catmandu XSD --root '{}foo' --schemas test.xsd to YAML < test.xml -- bar: - test catmandu XSD --root '{}foo' --schemas test.xsd to YAML < test2.xml -- bar: - test - test WILDCARDS Some XSD Schema allow for any or anyAttribute specifications in the schema. The Catmandu::XSD modules can't guess in these cases what the schema implementation is. These nodes will be parsed as XML::LibXML::Nodes in the resulting documents. Catmandu output formats such as Catmandu::Exporter::JSON can't handle these XML::LibXML::Node nodes. You have to implement yourself a Catmandu::Fix to translate these values in to plain string, array or hash elements. But in general a round trip should be problematic: catmandu XSD --root ... --schema wildcard.xsd to XSD --root ... --schema wildcard.xsd < data.xml MIXED ELEMENTS ComplexType and ComplexContent in the XSD schema can be declared with the attribute. This means that in the XML documents simple text and XML elements can be mixed as in: Hello, I'm John how can I help you? In these cases it is not know if the elements are required as an hash or should be ignored. By defaults Catmandu::XSD will parse these elements as XML::LibXML::Nodes documents. This behavious can be changed by setting the 'mixed' flag: # All mixed elements will be XML::LibXML::Node-s catmandu XSD --root ... --schema mixed.xsd < data.xml # The mixed elements will be ignored, only the text will survive # # Hello, I'm John how can I help you? # # => Hello, I'm John how can I help you? catmandu XSD --root ... --schema mixed.xsd --mixed TEXTUAL < data.xml # The mixed text will be ignored, only the elements will survive # # Hello, I'm John how can I help you? # # => { name => 'John' , bold => 'help' } catmandu XSD --root ... --schema mixed.xsd --mixed STRUCTURAL < data.xml # The mixed elements will be a plain XML fragment string # # Hello, I'm John how can I help you? # # => $r = 'Hello, I'm John how can I help you?' catmandu XSD --root ... --schema mixed.xsd --mixed XML_STRING < data.xml MODULES Catmandu::Importer::XSD Parse and validate XML data using an XSD file for structural data. Catmandu::Exporter::XSD Serialize and validate XML data using an XSD file for structural data. Catmandu::Fix::xpath_map Map XML from XSD-any elements into data fields using XPath expressions. BUGS, QUESTIONS, HELP Use the github issue tracker for any bug reports or questions on this module: https://github.com/LibreCat/Catmandu-XSD/issues DISCLAIMER This module is based on XML::Compile and the Catmandu framework. XML::Compile is the workhorse that forms the core of this module to compile XSD file into parser and serializers. Catmandu is used to transform parsed XML into any format you like. Catmandu contains a simple DSL languages called Catmandu::Fix to create small scripts to manipulate data. The Catmandu toolkit is used by many university libraries to process metadata collections. For more information on Catmandu visit: http://librecat.org/Catmandu/ or follow the blog posts at: https://librecatproject.wordpress.com/ AUTHOR Patrick Hochstenbach , patrick.hochstenbach at ugent.be LICENSE AND COPYRIGHT This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License. See http://dev.perl.org/licenses/ for more information. SEE ALSO XML::Compile , Catmandu , Template , Catmandu::XML Changes100644000765000024 55213547037252 15273 0ustar00hochstenstaff000000000000Catmandu-XSD-0.05Revision history for Catmandu-XSD 0.05 2019-10-08 09:45:43 CEST - Fixing dependencies [manwar] 0.04 2016-10-30 17:14:36 CET - Adding xpath_map support 0.03 2016-10-13 09:15:33 CEST - Fixing documentation errors 0.02 2016-10-12 16:50:30 CEST - Adding support for handling defined fields 0.01 2016-10-12 14:56:00 CEST - Initial release LICENSE100644000765000024 4370513547037252 15054 0ustar00hochstenstaff000000000000Catmandu-XSD-0.05This software is copyright (c) 2019 by Patrick Hochstenbach. This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. Terms of the Perl programming language system itself a) the GNU General Public License as published by the Free Software Foundation; either version 1, or (at your option) any later version, or b) the "Artistic License" --- The GNU General Public License, Version 1, February 1989 --- This software is Copyright (c) 2019 by Patrick Hochstenbach. This is free software, licensed under: The GNU General Public License, Version 1, February 1989 GNU GENERAL PUBLIC LICENSE Version 1, February 1989 Copyright (C) 1989 Free Software Foundation, Inc. 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The license agreements of most software companies try to keep users at the mercy of those companies. By contrast, our General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. The General Public License applies to the Free Software Foundation's software and to any other program whose authors commit to using it. You can use it for your programs, too. When we speak of free software, we are referring to freedom, not price. Specifically, the General Public License is designed to make sure that you have the freedom to give away or sell copies of free software, 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 make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. For example, if you distribute copies of a such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must tell them their rights. We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. The precise terms and conditions for copying, distribution and modification follow. GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License Agreement applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any work containing the Program or a portion of it, either verbatim or with modifications. Each licensee is addressed as "you". 1. You may copy and distribute 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 and disclaimer of warranty; keep intact all the notices that refer to this General Public License and to the absence of any warranty; and give any other recipients of the Program a copy of this General Public License along with the Program. You may charge a fee for the physical act of transferring a copy. 2. You may modify your copy or copies of the Program or any portion of it, and copy and distribute such modifications under the terms of Paragraph 1 above, provided that you also do the following: a) cause the modified files to carry prominent notices stating that you changed the files and the date of any change; and b) cause the whole of any work that you distribute or publish, that in whole or in part contains the Program or any part thereof, either with or without modifications, to be licensed at no charge to all third parties under the terms of this General Public License (except that you may choose to grant warranty protection to some or all third parties, at your option). c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the simplest and most usual way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this General Public License. d) You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. Mere aggregation of another independent work with the Program (or its derivative) on a volume of a storage or distribution medium does not bring the other work under the scope of these terms. 3. You may copy and distribute the Program (or a portion or derivative of it, under Paragraph 2) in object code or executable form under the terms of Paragraphs 1 and 2 above provided that you also do one of the following: a) accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Paragraphs 1 and 2 above; or, b) accompany it with a written offer, valid for at least three years, to give any third party free (except for a nominal charge for the cost of distribution) a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Paragraphs 1 and 2 above; or, c) accompany it with the information you received as to where the corresponding source code may be obtained. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form alone.) Source code for a work means the preferred form of the work for making modifications to it. For an executable file, complete source code means all the source code for all modules it contains; but, as a special exception, it need not include source code for modules which are standard libraries that accompany the operating system on which the executable file runs, or for standard header files or definitions files that accompany that operating system. 4. You may not copy, modify, sublicense, distribute or transfer the Program except as expressly provided under this General Public License. Any attempt otherwise to copy, modify, sublicense, distribute or transfer the Program is void, and will automatically terminate your rights to use the Program under this License. However, parties who have received copies, or rights to use copies, from you under this General Public License will not have their licenses terminated so long as such parties remain in full compliance. 5. By copying, distributing or modifying the Program (or any work based on the Program) you indicate your acceptance of this license to do so, and all its terms and conditions. 6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. 7. The Free Software Foundation may publish revised and/or new versions of the 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 a version number of the license which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the license, you may choose any version ever published by the Free Software Foundation. 8. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 9. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, 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. 10. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE 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. END OF TERMS AND CONDITIONS Appendix: 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 humanity, 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 convey 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) 19yy 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 1, 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, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301 USA Also add information on how to contact you by electronic and paper mail. If the program is interactive, make it output a short notice like this when it starts in an interactive mode: Gnomovision version 69, Copyright (C) 19xx name of author Gnomovision 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, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (a program to direct compilers to make passes at assemblers) written by James Hacker. , 1 April 1989 Ty Coon, President of Vice That's all there is to it! --- The Artistic License 1.0 --- This software is Copyright (c) 2019 by Patrick Hochstenbach. This is free software, licensed under: The Artistic License 1.0 The Artistic License Preamble The intent of this document is to state the conditions under which a Package may be copied, such that the Copyright Holder maintains some semblance of artistic control over the development of the package, while giving the users of the package the right to use and distribute the Package in a more-or-less customary fashion, plus the right to make reasonable modifications. Definitions: - "Package" refers to the collection of files distributed by the Copyright Holder, and derivatives of that collection of files created through textual modification. - "Standard Version" refers to such a Package if it has not been modified, or has been modified in accordance with the wishes of the Copyright Holder. - "Copyright Holder" is whoever is named in the copyright or copyrights for the package. - "You" is you, if you're thinking about copying or distributing this Package. - "Reasonable copying fee" is whatever you can justify on the basis of media cost, duplication charges, time of people involved, and so on. (You will not be required to justify it to the Copyright Holder, but only to the computing community at large as a market that must bear the fee.) - "Freely Available" means that no fee is charged for the item itself, though there may be fees involved in handling the item. It also means that recipients of the item may redistribute it under the same conditions they received it. 1. You may make and give away verbatim copies of the source form of the Standard Version of this Package without restriction, provided that you duplicate all of the original copyright notices and associated disclaimers. 2. You may apply bug fixes, portability fixes and other modifications derived from the Public Domain or from the Copyright Holder. A Package modified in such a way shall still be considered the Standard Version. 3. You may otherwise modify your copy of this Package in any way, provided that you insert a prominent notice in each changed file stating how and when you changed that file, and provided that you do at least ONE of the following: a) place your modifications in the Public Domain or otherwise make them Freely Available, such as by posting said modifications to Usenet or an equivalent medium, or placing the modifications on a major archive site such as ftp.uu.net, or by allowing the Copyright Holder to include your modifications in the Standard Version of the Package. b) use the modified Package only within your corporation or organization. c) rename any non-standard executables so the names do not conflict with standard executables, which must also be provided, and provide a separate manual page for each non-standard executable that clearly documents how it differs from the Standard Version. d) make other distribution arrangements with the Copyright Holder. 4. You may distribute the programs of this Package in object code or executable form, provided that you do at least ONE of the following: a) distribute a Standard Version of the executables and library files, together with instructions (in the manual page or equivalent) on where to get the Standard Version. b) accompany the distribution with the machine-readable source of the Package with your modifications. c) accompany any non-standard executables with their corresponding Standard Version executables, giving the non-standard executables non-standard names, and clearly documenting the differences in manual pages (or equivalent), together with instructions on where to get the Standard Version. d) make other distribution arrangements with the Copyright Holder. 5. You may charge a reasonable copying fee for any distribution of this Package. You may charge any fee you choose for support of this Package. You may not charge a fee for this Package itself. However, you may distribute this Package in aggregate with other (possibly commercial) programs as part of a larger (possibly commercial) software distribution provided that you do not advertise this Package as a product of your own. 6. The scripts and library files supplied as input to or produced as output from the programs of this Package do not automatically fall under the copyright of this Package, but belong to whomever generated them, and may be sold commercially, and may be aggregated with this Package. 7. C or perl subroutines supplied by you and linked into this Package shall not be considered part of this Package. 8. The name of the Copyright Holder may not be used to endorse or promote products derived from this software without specific prior written permission. 9. THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. The End cpanfile100644000765000024 63513547037252 15506 0ustar00hochstenstaff000000000000Catmandu-XSD-0.05requires 'perl', 'v5.10.1'; on 'test', sub { requires 'Test::Simple', '1.001003'; requires 'Test::More', '1.001003'; requires 'Test::Exception', '0'; requires 'XML::XPath', '1.13'; }; requires 'Moo', '0'; requires 'namespace::clean', '0'; requires 'Catmandu', '>= 1.0'; requires 'Catmandu::Template' , '0'; requires 'XML::Compile', '0'; requires 'XML::Compile::Cache', '0'; requires 'XML::LibXML', '0'; dist.ini100644000765000024 4513547037252 15421 0ustar00hochstenstaff000000000000Catmandu-XSD-0.05author=Patrick Hochstenbach [@Milla] Build.PL100644000765000024 26113547037252 15271 0ustar00hochstenstaff000000000000Catmandu-XSD-0.05# This Build.PL for Catmandu-XSD was generated by Dist::Zilla::Plugin::ModuleBuildTiny 0.015. use strict; use warnings; use v5.10.1; use Module::Build::Tiny 0.034; Build_PL(); META.yml100644000765000024 220013547037252 15261 0ustar00hochstenstaff000000000000Catmandu-XSD-0.05--- abstract: 'Modules for handling XML data with XSD compilation' author: - 'Patrick Hochstenbach' build_requires: Test::Exception: '0' Test::More: '1.001003' Test::Simple: '1.001003' XML::XPath: '1.13' configure_requires: Module::Build::Tiny: '0.034' dynamic_config: 0 generated_by: 'Dist::Milla version v1.0.17, Dist::Zilla version 6.008, CPAN::Meta::Converter version 2.150005' license: perl meta-spec: url: http://module-build.sourceforge.net/META-spec-v1.4.html version: '1.4' name: Catmandu-XSD no_index: directory: - eg - examples - inc - share - t - xt requires: Catmandu: '1.0' Catmandu::Template: '0' Moo: '0' XML::Compile: '0' XML::Compile::Cache: '0' XML::LibXML: '0' namespace::clean: '0' perl: v5.10.1 resources: bugtracker: https://github.com/LibreCat/Catmandu-XSD/issues homepage: https://github.com/LibreCat/Catmandu-XSD repository: https://github.com/LibreCat/Catmandu-XSD.git version: '0.05' x_contributors: - 'Mohammad S Anwar ' - 'Patrick Hochstenbach ' x_serialization_backend: 'YAML::Tiny version 1.69' MANIFEST100644000765000024 155113547037252 15151 0ustar00hochstenstaff000000000000Catmandu-XSD-0.05# This file was automatically generated by Dist::Zilla::Plugin::Manifest v6.008. Build.PL Changes LICENSE MANIFEST META.json META.yml README catmandu.yml cpanfile dist.ini lib/Catmandu/Exporter/XSD.pm lib/Catmandu/Fix/xpath_map.pm lib/Catmandu/Importer/XSD.pm lib/Catmandu/XSD.pm t/Catmandu-Exporter-XSD.t t/Catmandu-Fix-xpath_map.t t/Catmandu-Importer-XSD.t t/Catmandu-XSD.t t/author-pod-syntax.t t/demo/ead/ead2.xsd t/demo/ead/test.xml t/demo/ead/xlink.xsd t/demo/mets/mets.xml t/demo/mets/mets.xsd t/demo/mets/xlink.xsd t/demo/mods/mods-3-3.xsd t/demo/mods/mods-3-6.xsd t/demo/mods/test.xml t/demo/mods/test2.xml t/demo/mods/xlink.xsd t/demo/mods/xml.xsd t/demo/order/id_0.xml t/demo/order/id_1.xml t/demo/order/list.xml t/demo/order/order.xsd t/demo/order/test.xml t/demo/order/test2.xml t/demo/order/xml_footer.tt t/demo/order/xml_header.tt t/demo/order/xml_record.tt META.json100644000765000024 377713547037252 15455 0ustar00hochstenstaff000000000000Catmandu-XSD-0.05{ "abstract" : "Modules for handling XML data with XSD compilation", "author" : [ "Patrick Hochstenbach" ], "dynamic_config" : 0, "generated_by" : "Dist::Milla version v1.0.17, Dist::Zilla version 6.008, CPAN::Meta::Converter version 2.150005", "license" : [ "perl_5" ], "meta-spec" : { "url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec", "version" : 2 }, "name" : "Catmandu-XSD", "no_index" : { "directory" : [ "eg", "examples", "inc", "share", "t", "xt" ] }, "prereqs" : { "configure" : { "requires" : { "Module::Build::Tiny" : "0.034" } }, "develop" : { "requires" : { "Dist::Milla" : "v1.0.17", "Test::Pod" : "1.41" } }, "runtime" : { "requires" : { "Catmandu" : "1.0", "Catmandu::Template" : "0", "Moo" : "0", "XML::Compile" : "0", "XML::Compile::Cache" : "0", "XML::LibXML" : "0", "namespace::clean" : "0", "perl" : "v5.10.1" } }, "test" : { "requires" : { "Test::Exception" : "0", "Test::More" : "1.001003", "Test::Simple" : "1.001003", "XML::XPath" : "1.13" } } }, "release_status" : "stable", "resources" : { "bugtracker" : { "web" : "https://github.com/LibreCat/Catmandu-XSD/issues" }, "homepage" : "https://github.com/LibreCat/Catmandu-XSD", "repository" : { "type" : "git", "url" : "https://github.com/LibreCat/Catmandu-XSD.git", "web" : "https://github.com/LibreCat/Catmandu-XSD" } }, "version" : "0.05", "x_contributors" : [ "Mohammad S Anwar ", "Patrick Hochstenbach " ], "x_serialization_backend" : "Cpanel::JSON::XS version 3.0239" } catmandu.yml100644000765000024 312113547037252 16332 0ustar00hochstenstaff000000000000Catmandu-XSD-0.05--- importer: order: package: XSD options: root: "{}shiporder" schemas: t/demo/order/*.xsd #xpath: /Container/List//Record/Payload/* ead: package: XSD options: root: "{urn:isbn:1-931666-22-9}ead" schemas: demo/ead/*.xsd mods: package: XSD options: root: "{http://www.loc.gov/mods/v3}mods" schemas: - "t/demo/mods/mods-3-6.xsd" - "t/demo/mods/xlink.xsd" - "t/demo/mods/xml.xsd" mets: package: XSD options: root: "{http://www.loc.gov/METS/}mets" schemas: t/demo/mets/*.xsd exporter: ead: package: XSD options: root: "{urn:isbn:1-931666-22-9}ead" schemas: t/demo/ead/*.xsd order: package: XSD options: root: "{}shiporder" schemas: t/demo/order/*.xsd # split: 1 # split_directory: demo/order # split_pattern: id_%s.xml template_before: t/demo/order/xml_header.tt template: t/demo/order/xml_record.tt template_after: t/demo/order/xml_footer.tt mods: package: XSD options: root: "{http://www.loc.gov/mods/v3}mods" schemas: - t/demo/mods/mods-3-6.xsd - t/demo/mods/xlink.xsd - t/demo/mods/xml.xsd mets: package: XSD options: root: "{http://www.loc.gov/METS/}mets" schemas: t/demo/mets/*.xsd t000755000765000024 013547037252 14121 5ustar00hochstenstaff000000000000Catmandu-XSD-0.05Catmandu-XSD.t100644000765000024 1317413547037252 16664 0ustar00hochstenstaff000000000000Catmandu-XSD-0.05/t#!perl use strict; use warnings; use Test::More; use Catmandu; use Catmandu::Util qw(:io); use XML::LibXML::XPathContext; BEGIN { use_ok 'Catmandu::XSD'; } require_ok 'Catmandu::XSD'; binmode(STDOUT, ":utf8"); { my $xsd = Catmandu::XSD->new( root => "{}shiporder" , schemas => "t/demo/order/*.xsd" , ); ok $xsd , 'got an xsd for shiporders'; my $xml = read_file("t/demo/order/id_0.xml"); my $perl = $xsd->parse($xml); ok $perl , 'parsed order/id_0.xml'; is $perl->{orderperson} , 'John Smith' , 'shiporder.orderperson'; is $perl->{item}->[0]->{price} , '10.90' , 'shipoder.item[0].price'; my $out = $xsd->to_xml($perl); ok $out , 'to_xml(shiporder)'; like $out , qr/.*.*/ , 'looks like xml'; } { my $xsd = Catmandu::XSD->new( root => "{urn:isbn:1-931666-22-9}ead", schemas => "t/demo/ead/*.xsd" , ); ok $xsd , 'got an xsd for ead'; my $xml = read_file("t/demo/ead/test.xml"); my $perl = $xsd->parse($xml); ok $perl , 'parsed ead/test.xml'; is $perl->{eadheader} ->{filedesc} ->{titlestmt} ->{titleproper} ->[0] ->{encodinganalog} , "Title" , 'ead.eadheader.filedesc.titlestmt.titleproper[0][@encodinganalog]'; is $perl->{eadheader} ->{filedesc} ->{titlestmt} ->{titleproper} ->[0] ->{_} ->textContent, 'Prudence Wayland-Smith Papers' , 'ead.eadheader.filedesc.titlestmt.titleproper[0]'; is $perl->{archdesc} ->{did} ->{head} ->{_} ->textContent , 'Overview of the Collection' , 'ead.did[0].head'; } { my $xsd = Catmandu::XSD->new( root => "{urn:isbn:1-931666-22-9}ead", schemas => "t/demo/ead/*.xsd" , mixed => 'TEXTUAL' ); ok $xsd , 'got an xsd for ead TEXTUAL mode'; my $xml = read_file("t/demo/ead/test.xml"); my $perl = $xsd->parse($xml); ok $perl , 'parsed ead/test.xml'; is $perl->{eadheader} ->{filedesc} ->{titlestmt} ->{titleproper} ->[0] ->{encodinganalog} , "Title" , 'ead.eadheader.filedesc.titlestmt.titleproper[0][@encodinganalog]'; is $perl->{eadheader} ->{filedesc} ->{titlestmt} ->{titleproper} ->[0] ->{_} , 'Prudence Wayland-Smith Papers' , 'ead.eadheader.filedesc.titlestmt.titleproper[0]'; is $perl->{archdesc} ->{did} ->{head} ->{_} , 'Overview of the Collection' , 'ead.did[0].head'; } { my $xsd = Catmandu::XSD->new( root => "{http://www.loc.gov/mods/v3}mods", schemas => [ "t/demo/mods/mods-3-3.xsd" , "t/demo/mods/xlink.xsd" , "t/demo/mods/xml.xsd" , ] ); ok $xsd , 'got an xsd for mods'; my $xml = read_file("t/demo/mods/test.xml"); my $perl = $xsd->parse($xml); ok $perl , 'parsed mods/test.xml'; my $mods = $perl->{gr_modsGroup}; is [choose($mods,'name')] ->[0] ->{ID} , 'ug_802001229613' , 'mods.name[0][@ID]'; is choose($mods,'language') ->{languageTerm} ->[0] ->{authority} , 'iso639-2b' , 'mods.language.languageTerm[0][@authority]'; is choose($mods,'language') ->{languageTerm} ->[0] ->{_} , 'eng' , 'mods.language.languageTerm[0][@authority].text()'; like choose($mods,'abstract') ->{_} , qr/^Wastewater treatment plants/ , 'mods.abstract'; } { my $xsd = Catmandu::XSD->new( root => "{http://www.loc.gov/mods/v3}mods", schemas => [ "t/demo/mods/mods-3-6.xsd" , "t/demo/mods/xlink.xsd" , "t/demo/mods/xml.xsd" , ] ); ok $xsd , 'got an xsd for mods'; my $xml = read_file("t/demo/mods/test2.xml"); my $perl = $xsd->parse($xml); ok $perl , 'parsed mods/test.xml'; my $mods = $perl->{gr_modsGroup}; my $holding_external = [ choose($mods,'location') ]->[0]->{holdingExternal}->{_}; my $xc = XML::LibXML::XPathContext->new($holding_external); ok $xc , 'created a xpath context for holdings'; $xc->registerNs('dcterms','http://purl.org/dc/elements/1.1/'); is $xc->findvalue('//dcterms:accessRights') , 'restricted' , 'dcterms:accessRights'; } { my $xsd = Catmandu::XSD->new( root => "{http://www.loc.gov/METS/}mets", schemas => [ "t/demo/mets/mets.xsd" , "t/demo/mets/xlink.xsd" , ] , prefixes => [ { 'http://www.loc.gov/mods/v3' => 'mods' } ] ); ok $xsd , 'got an xsd for mets'; my $xml = read_file("t/demo/mets/mets.xml"); my $perl = $xsd->parse($xml); ok $perl , 'parsed mets/mets.xml'; my $mods = $perl->{dmdSec}->[0]->{mdWrap}->{xmlData}->{'{http://www.loc.gov/mods/v3}mods'}->[0]; my $xc = XML::LibXML::XPathContext->new($mods); ok $xc , 'created a xpath context for holdings'; $xc->registerNs('mods','http://www.loc.gov/mods/v3'); is $xc->findvalue('mods:titleInfo/mods:title') , 'Alabama blues' , 'mods:title'; my $out = $xsd->to_xml($perl); ok $out , 'got xml'; like $out , qr/{$key} if $key eq $name; } wantarray ? @ret : pop @ret; } Catmandu000755000765000024 013547037252 16160 5ustar00hochstenstaff000000000000Catmandu-XSD-0.05/libXSD.pm100644000765000024 2524113547037252 17340 0ustar00hochstenstaff000000000000Catmandu-XSD-0.05/lib/Catmandupackage Catmandu::XSD; use Moo; use Catmandu::Util; use XML::Compile; use XML::Compile::Cache; use XML::Compile::Util 'pack_type'; our $VERSION = '0.05'; has 'root' => (is => 'ro' , required => 1); has 'schemas' => (is => 'ro' , required => 1 , coerce => sub { my ($value) = @_; if (Catmandu::Util::is_array_ref($value)) { return $value; } elsif ($value =~ /\*/) { my @files = glob($value); \@files; } else { my @files = split(/,/,$value); \@files; } }); has 'mixed' => (is => 'ro' , default => sub { 'ATTRIBUTES' }); has 'any_element' => (is => 'ro' , default => sub { 'TAKE_ALL' } , coerce => sub { my $val = $_[0]; if (defined $val && $val eq 'XML_STRING') { return sub { my ($path, $node , $handler) = @_; if ($node && ref($node)) { my $str = ''; for (@$node) { $str .= $_->toString; } ('_',$str); } else { $node; } }; } else { $val; } }); has 'prefixes' => (is => 'ro' , coerce => sub { my ($value) = @_; if (Catmandu::Util::is_array_ref($value)) { return $value; } elsif (defined($value)) { my $ret = []; for (split(/,/,$value)) { my ($ns,$url) = split(/:/,$_,2); push @$ret , { $ns => $url }; } return $ret; } else { undef; } }); has '_reader' => (is => 'ro'); has '_writer' => (is => 'ro'); sub BUILD { my ($self) = @_; my $schema = XML::Compile::Cache->new($self->schemas); $schema->addHook( action => 'READER' , after => sub { my ($xml, $data, $path) = @_; delete $data->{_MIXED_ELEMENT_MODE} if Catmandu::Util::is_hash_ref($data); $data; } ); $self->{_reader} = $schema->compile( READER => $self->root, mixed_elements => $self->mixed , any_element => $self->any_element , sloppy_floats => 'true', sloppy_integers => 'true' , ); $self->{_writer} = $schema->compile( WRITER => $self->root, prefixes => $self->prefixes, sloppy_floats => 'true', sloppy_integers => 'true' , ); $schema = undef; } sub template { my ($self) = @_; my $schema = XML::Compile::Cache->new($self->schemas); $schema->template('PERL', $self->root , show => 'ALL'); } sub parse { my ($self,$input) = @_; $self->_reader->($input); } sub to_xml { my ($self,$data) = @_; my $doc = XML::LibXML::Document->new('1.0', 'UTF-8'); my $xml = $self->_writer->($doc, $data); $doc->setDocumentElement($xml); $doc->toString(1); } 1; __END__ =encoding utf8 =head1 NAME Catmandu::XSD - Modules for handling XML data with XSD compilation =head1 SYNOPSIS ## Converting XML to YAML/JSON/CSV/etc # Compile an XSD schema file and parse one shiporder.xml file catmandu convert XSD --root '{}shiporder' --schemas demo/order/*.xsd to YAML < shiporder.xml # Same as above but parse more than one file into an array of records catmandu convert XSD --root '{}shiporder' --schemas demo/order/*.xsd --files 'data/*.xml' to YAML # Same as above but all array of records are in a XML container file catmandu convert XSD --root '{}shiporder' --schemas demo/order/*.xsd --xpath '/Container/List//Record/Payload/*' to YAML < data/container.xml ## Convert an YAML/JSON/CSV into XML validated against an XSD schemas # Convert one shiporder YAML to XML catmandu convert YAML to XSD --root '{}shiporder' --schemas demo/order/*.xsd < shiporder.YAML # Same as above but store multiple shiporders in the YAML into a separate file catmandu convert YAML to XSD --root '{}shiporder' --schemas demo/order/*.xsd --split 1 < shiporder.YAML # Same as above but use template toolkit to pack the XML into an container # (The xml record is stored in the 'xml' key which can be retrieved in the # template by [% xml %]) catmandu convert YAML to XSD --root '{}shiporder' --schemas demo/order/*.xsd --template_before t/xml_header.tt --template t/xml_record.tt --template t/xml_footer.tt < shiporder.YAML ## Example documents # Show an example how a valid XML document needs to be structured for an # XSD scheme. catmandu convert XSD --root {}shiporder --schemas "t/demo/order/*xsd" --example 1 to YAML =head1 DESCRIPTION L contains modules for handling XML data within the L framework. Parsing and serializing is based on L. There are two modules available for handling XML data in the Catmandu framework: L and L. The former one can be used when no XML schema is available for the data. It provides a simple interface to read in XML data and transform it to other formats. Because L doesn't depend on an XSD schema, it can't know which fields in the input XML files are sequences or single value elements. Each record is parsed on its own. A record with content: test will be parsed into a YAML output like: catmandu XML to YAML < test.xml -- bar: test A record with content: test test will be parsed into a YAL output like: catmandu XML to YAML < test2.xml -- bar: - test - test In the first case 'bar' will contain a string, in the second case an array. This might no be what you want in some programming projects. E.g. when you need the 'bar' field to be always an array of values, then you an XSD schema file is required containing the exact structure of the XML document: test.xsd: And now the test.xml and test2.xml can be parsed with help of Catmandu::XSD: catmandu XSD --root '{}foo' --schemas test.xsd to YAML < test.xml -- bar: - test catmandu XSD --root '{}foo' --schemas test.xsd to YAML < test2.xml -- bar: - test - test =head1 WILDCARDS Some XSD Schema allow for C or C specifications in the schema. The L modules can't guess in these cases what the schema implementation is. These nodes will be parsed as Ls in the resulting documents. Catmandu output formats such as L can't handle these XML::LibXML::Node nodes. You have to implement yourself a L to translate these values in to plain string, array or hash elements. But in general a round trip should be problematic: catmandu XSD --root ... --schema wildcard.xsd to XSD --root ... --schema wildcard.xsd < data.xml =head1 MIXED ELEMENTS ComplexType and ComplexContent in the XSD schema can be declared with the C<> attribute. This means that in the XML documents simple text and XML elements can be mixed as in: Hello, I'm John how can I help you? In these cases it is not know if the elements are required as an hash or should be ignored. By defaults L will parse these elements as Ls documents. This behavious can be changed by setting the 'mixed' flag: # All mixed elements will be XML::LibXML::Node-s catmandu XSD --root ... --schema mixed.xsd < data.xml # The mixed elements will be ignored, only the text will survive # # Hello, I'm John how can I help you? # # => Hello, I'm John how can I help you? catmandu XSD --root ... --schema mixed.xsd --mixed TEXTUAL < data.xml # The mixed text will be ignored, only the elements will survive # # Hello, I'm John how can I help you? # # => { name => 'John' , bold => 'help' } catmandu XSD --root ... --schema mixed.xsd --mixed STRUCTURAL < data.xml # The mixed elements will be a plain XML fragment string # # Hello, I'm John how can I help you? # # => $r = 'Hello, I'm John how can I help you?' catmandu XSD --root ... --schema mixed.xsd --mixed XML_STRING < data.xml =head1 MODULES =over =item L Parse and validate XML data using an XSD file for structural data. =item L Serialize and validate XML data using an XSD file for structural data. =item L Map XML from XSD-any elements into data fields using XPath expressions. =back =head1 BUGS, QUESTIONS, HELP Use the github issue tracker for any bug reports or questions on this module: https://github.com/LibreCat/Catmandu-XSD/issues =head1 DISCLAIMER This module is based on L and the L framework. L is the workhorse that forms the core of this module to compile XSD file into parser and serializers. L is used to transform parsed XML into any format you like. Catmandu contains a simple DSL languages called L to create small scripts to manipulate data. The L toolkit is used by many university libraries to process metadata collections. For more information on Catmandu visit: http://librecat.org/Catmandu/ or follow the blog posts at: https://librecatproject.wordpress.com/ =head1 AUTHOR Patrick Hochstenbach , C<< patrick.hochstenbach at ugent.be >> =head1 LICENSE AND COPYRIGHT This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License. See L for more information. =head1 SEE ALSO L , L , L