No commit activity in last 3 years
No release in over 3 years
A configurable converter for XML and JSON to HTML and JSON.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

Runtime

 Project Readme

Mini Transformer - Build Status

Description

Mini Transformer takes a pair of input files, JSON and XML, then converts it to HTML5 or JSON format. It also supports a mapping of the children elements to HTML elements via YAML mapping file.

Installation

gem install mini_transformer

Usage

mini_transform transform [JSON, XML, OUTPUT=nil, FORMAT=html, MAPPING=nil]

Requires the json and xml file names, if neither is provided or found, a File Not Found error will occur.

Options

  • An output file name such as output.html. Defaults to UID tag or output if not available.
  • 2 different output formats supported, html or json. Defaults to html.
  • A YAML mapping configuration file for the entries tags to convert to HTML tags. Only available for html output format. Defaults to dt and dd tags.

Example Usage

mini_transform transform input.json, input.xml
mini_transform transform input.json, input.xml, out.json, json
mini_transform transform input.json, input.xml, nil, json
mini_transform transform input.json, input.xml, out.html, html, mapping.yml
mini_transform transform input.json, input.xml, nil, html, mapping.yml

Configuration

Example Mapping YAML - mapping.yml
entries: dl key-name: dt key-description: dd

Dependencies

Development Dependencies

Additional Information

Known Issues

  • Ruby 1.8.7 alphabetizes the meta tags. Meaning :id and :content are swapped when written to file.

MIT License

Copyright (c) 2011 John Wang, http://johntwang.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.