mini_transformer 0.0.1

data/.gitignore

@@ -0,0 +1,28 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+.DS_Store
+
+# Thumbnails
+._*
+
+# Files that might appear on external disk
+.Spotlight-V100
+.Trashes
+
+.idea/workspace.xml

data/.rvmrc

@@ -0,0 +1,3 @@
+rvm use 1.9.2
+rvm gemset create mini_transformer
+rvm gemset use mini_transformer

data/.travis.yml

@@ -0,0 +1,3 @@
+rvm:
+  - 1.9.2
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in mini_transformer.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,22 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^lib/(.+)\.rb$})                           { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('spec/spec_helper.rb')                        { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+  # Capybara request specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/requests/#{m[1]}_spec.rb" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,20 @@
+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.

data/README.md

@@ -0,0 +1,75 @@
+# Mini Transformer - [![Build Status](https://secure.travis-ci.org/jwang/mini_transformer.png)](http://travis-ci.org/jwang/mini_transformer)
+
+# 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 input.json and input.xml, 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
+* [Nokogiri](nokogiri.org)
+* ActiveSupport
+* [JSON](http://flori.github.com/json)
+* [Thor](https://github.com/wycats/thor)
+
+### Development Dependencies
+* [RSpec 2](https://www.relishapp.com/rspec)
+* [guard](https://github.com/guard/guard)
+* [guard-rspec](https://github.com/guard/guard-rspec)
+* [simplecov](https://github.com/colszowka/simplecov)
+* rb-fsevent (Mac OSX only)
+* [growl_notify (Mac OSX only)](https://github.com/scottdavis/growl_notify)
+
+### Additional Information
+* [Test Coverage](http://johntwang.com/mini_transformer/coverage)
+* [Travis CI Build Status](http://travis-ci.org/jwang/mini_transformer)
+
+
+#### 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.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "./spec/**/*_spec.rb"
+end

data/bin/mini_transform

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+require 'mini_transformer'
+
+begin
+  require "mini_transformer/cli"
+  MiniTransformer::CLI.start
+end

data/lib/mini_transformer.rb

@@ -0,0 +1,124 @@
+require 'rbconfig'
+require 'fileutils'
+require 'open-uri'
+require 'json'
+require 'yaml'
+require 'nokogiri'
+require 'active_support/inflector' # added for .underscore and .dasherize
+require "thor"
+require "mini_transformer/version"
+require "mini_transformer/cli"
+require "mini_transformer/book"
+require "mini_transformer/key_list"
+require "mini_transformer/entry"
+require "mini_transformer/html"
+
+module MiniTransformer
+  class Parser
+    def setup(json_input_filename, xml_input_filename, output=nil, format="html", mapping=nil)
+      if File.exists?(xml_input_filename) && File.exists?(json_input_filename)
+        xml_input_file = File.open(xml_input_filename)
+        json_input = File.open(json_input_filename)
+        json_contents = ""
+        json_input.each do |line|
+          json_contents = json_contents + line
+        end
+        json_data = JSON.parse json_contents
+
+        if File.extname(xml_input_filename) == ".xml"
+          @document = Nokogiri::XML(xml_input_file, nil, 'UTF-8')
+        end
+      else
+        raise "File Not Found."
+      end
+
+      unless output.nil?
+        # set up the ouput HTML file to write to
+        @output = output
+      end
+
+      unless mapping.nil?
+        @mapping = open(mapping) {|f| YAML.load(f) }
+      end
+
+      @book = Book.new
+      @book.key_list = KeyList.new
+
+      @book.title = json_data["title"] if json_data["title"]
+      @book.type = json_data["type"] if json_data["type"]
+      @book.uid = json_data["uid"] if json_data["uid"]
+
+      xml_input_file.close
+      json_input.close
+    end
+
+    def validate
+      if !@document.errors.empty?
+        raise "Malformed XML"
+      end
+      @document.errors
+    end
+
+    def parse
+      @book.id = @document.root.attribute_nodes.first.content if @document.root.attribute_nodes.size > 0
+      @book.introduction = @document.xpath("//Book//Introduction//Para")
+
+      keylist = @document.xpath("//Book//KeyList")
+      entries = @document.xpath("//Book//KeyList//Entries")
+
+      @book.key_list.name = keylist.at_xpath("//Name").text
+      @book.key_list.key_label = keylist.at_xpath("//KeyLabel").text
+      @book.key_list.description_label = keylist.at_xpath("//DescriptionLabel").text
+      @book.key_list.entries = Array.new
+
+      entries.children.each do |entry|
+        if entry.class == Nokogiri::XML::Element
+          book_entry = Entry.new
+          entry.children.each do |child|
+            if child.class == Nokogiri::XML::Element
+              if child.name == "KeyName"
+                book_entry.key_name = child.content
+              elsif child.name == "Description"
+                book_entry.description = child.content
+              end
+            end
+          end
+          @book.key_list.entries << book_entry
+        end
+      end
+    end
+
+    def to_json
+      json = JSON.pretty_generate @book
+      # Save the JSON file
+      if @output
+        File.open(@output, "w") { |f| f << json }
+      else
+        if @book.uid.nil?
+          File.open("output.json", "w") { |f| f << json }
+        else
+          File.open("#{@book.uid}.json", "w") { |f| f << json }
+        end
+      end
+    end
+
+    def to_html
+      html = MiniTransformer::generate_html(@book, @mapping)
+
+      # Save the HTML file
+      if @output
+        File.open(@output, "w") { |f| f << html }
+      else
+        if @book.uid.nil?
+          File.open("output.html", "w") { |f| f << html }
+        else
+          File.open("#{@book.uid}.html", "w") { |f| f << html }
+        end
+      end
+
+      # return the HTML file as a string
+      html
+    end
+
+  end
+end

data/lib/mini_transformer/book.rb

@@ -0,0 +1,17 @@
+module MiniTransformer
+  class Book
+    attr_accessor :id, :title, :uid, :type, :introduction, :key_list
+
+    def to_json(*a)
+      {
+        'uid'   => self.uid,
+        'type'  => self.type,
+        'title' => self.title,
+        'id'    => self.id,
+        'introduction' => self.introduction,
+        "key-list" => self.key_list.to_json
+      }.to_json(*a)
+    end
+
+  end
+end

data/lib/mini_transformer/cli.rb

@@ -0,0 +1,33 @@
+module MiniTransformer
+  class CLI < Thor
+    include Thor::Actions
+    
+    desc "transform [JSON, XML, OUTPUT, FORMAT, MAPPING]", "Transform the files into format"
+    def transform(json, xml, output=nil, format="html", mapping=nil)
+      if output.nil?
+        output = "#{Dir.pwd}/test.html"
+      end
+
+      @parser = MiniTransformer::Parser.new
+      @parser.setup(json, xml, output, format, mapping)
+      @parser.validate
+      @parser.parse
+
+      if format == "json"
+        @parser.to_json
+      else
+        @parser.to_html
+      end
+      
+    end
+    map %w(-t --transform) => :transform
+
+    desc "version", "Prints the bundler's version information"
+    def version
+      puts "Mini Transform version #{MiniTransformer::VERSION}"
+      "Mini Transform version #{MiniTransformer::VERSION}"
+      #Bundler.ui.info "Bundler version #{Bundler::VERSION}"
+    end
+    map %w(-v --version) => :version
+  end
+end

data/lib/mini_transformer/entry.rb

@@ -0,0 +1,13 @@
+module MiniTransformer
+  class Entry
+    attr_accessor :key_name, :description
+    
+    def to_json(*a)
+      {
+        'key-name'   => self.key_name,
+        'description'  => self.description
+      }.to_json(*a)
+    end
+    
+  end
+end

data/lib/mini_transformer/format.xsl

@@ -0,0 +1,45 @@
+<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
+  <xsl:output method="html" version="5.0" encoding="UTF-8" indent="yes"/>
+  <xsl:param name="indent-increment" select="'  '"/>
+  <xsl:template name="newline">
+    <xsl:text disable-output-escaping="yes">
+</xsl:text>
+  </xsl:template>
+
+  <xsl:template match="comment() | processing-instruction()">
+    <xsl:param name="indent" select="''"/>
+    <xsl:call-template name="newline"/>
+    <xsl:value-of select="$indent"/>
+    <xsl:copy />
+  </xsl:template>
+
+  <xsl:template match="text()">
+    <xsl:param name="indent" select="''"/>
+    <xsl:call-template name="newline"/>
+    <xsl:value-of select="$indent"/>
+    <xsl:value-of select="normalize-space(.)"/>
+  </xsl:template>
+
+  <xsl:template match="text()[normalize-space(.)='']"/>
+
+  <xsl:template match="*">
+    <xsl:param name="indent" select="''"/>
+    <xsl:call-template name="newline"/>
+    <xsl:value-of select="$indent"/>
+      <xsl:choose>
+       <xsl:when test="count(child::*) > 0">
+        <xsl:copy>
+         <xsl:copy-of select="@*"/>
+         <xsl:apply-templates select="*|text()">
+           <xsl:with-param name="indent" select="concat ($indent, $indent-increment)"/>
+         </xsl:apply-templates>
+         <xsl:call-template name="newline"/>
+         <xsl:value-of select="$indent"/>
+        </xsl:copy>
+       </xsl:when>
+       <xsl:otherwise>
+        <xsl:copy-of select="."/>
+       </xsl:otherwise>
+     </xsl:choose>
+  </xsl:template>
+</xsl:stylesheet>

data/lib/mini_transformer/html.rb

@@ -0,0 +1,94 @@
+module MiniTransformer
+
+  def self.generate_html(resource, mapping=nil)
+    #puts "generate html"
+    builder = Nokogiri::HTML::Builder.new(:encoding => 'utf-8') do |doc|
+      doc.html(:lang=> "en") {
+        doc.head {
+          doc.meta(:id => "book-resource-type", :content => resource.type)
+          doc.meta(:id => "identifier", :content => "//apple_ref/doc/uid/#{resource.uid}")
+          doc.title(resource.title)
+        }
+
+        doc.body() {
+          doc.header {
+            doc.text "\n"
+            resource.introduction.children.each do |para|
+              doc.p(para.text)
+            end
+            doc.text "\n"
+          }
+
+          doc.text "\n"
+
+          doc.details {
+            doc.text "\n"
+            doc.summary(:class => "key-list-name") {doc.text resource.key_list.name}
+            doc.text "\n"
+          }
+
+          doc.div(:class => "key-list") {
+            doc.text "\n"
+            doc.span(:class => "key-label") {
+              doc.text resource.key_list.key_label
+            }
+            doc.text "\n"
+            doc.span(:class => "description-label") {
+              doc.text resource.key_list.description_label
+            }
+            doc.text "\n"
+
+            if mapping
+              doc.send(mapping['entries'], :class => 'entries') {
+                resource.key_list.entries.each do |entry|
+                  if mapping['entry']
+                    doc.send(mapping['entry'], :class => 'entry') {
+                      doc.send(mapping['key-name'], :class => 'key-name') {
+                        doc.text entry.key_name
+                      }
+                      doc.send(mapping['key-description'], :class => 'key-description') {
+                        doc.text entry.description
+                      }
+                    }
+                  else
+                    doc.send(mapping['key-name'], :class => 'key-name') {
+                      doc.text entry.key_name
+                    }
+                    doc.send(mapping['key-description'], :class => 'key-description') {
+                      doc.text entry.description
+                    }
+                  end
+                end
+              }
+            else
+              doc.dl(:class => "entries") {
+                resource.key_list.entries.each do |entry|
+                  doc.dt(:class => 'key-name') {
+                    doc.text entry.key_name
+                  }
+                  doc.dd(:class => 'key-description') {
+                    doc.text entry.description
+                  }
+                end
+              }
+            end
+          }
+        }
+      }
+    end
+
+    html = builder.to_html
+          
+    # Use an XSLT Stylesheet to pretty generate the HTML file. Adjustments follow.
+    xsl = Nokogiri::XSLT(File.read(File.join(File.dirname(__FILE__), "format.xsl")))
+    html = xsl.apply_to(Nokogiri::HTML html).to_s
+    
+    # Nokogiri's HTML Builder creates an HTML4 file and cannot be easily changed due to DTD Validation
+    html = html.gsub(/<!DOCTYPE html PUBLIC \"-\/\/W3C\/\/DTD HTML 4.0 Transitional\/\/EN\" \"http:\/\/www.w3.org\/TR\/REC-html40\/loose.dtd">\n/, '<!DOCTYPE html>')
+    
+    # Realign the meta tag that is added by the XSLT transform with Nokogiri
+    html = html.gsub(/<meta http-equiv=\"Content-Type\" content=\"text\/html; charset=UTF-8\">\s+$/, '    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">')
+    html = html.gsub(/UTF-8/, 'utf-8')
+  end
+
+end

data/lib/mini_transformer/key_list.rb

@@ -0,0 +1,14 @@
+module MiniTransformer
+  class KeyList
+    attr_accessor :name, :key_label, :description_label, :entries
+    
+    def to_json(*a)
+      {
+        'name'   => self.name,
+        'key-label'  => self.key_label,
+        'description-label' => self.description_label#,
+      }.to_json(*a)
+    end
+    
+  end
+end

data/lib/mini_transformer/version.rb

@@ -0,0 +1,3 @@
+module MiniTransformer
+  VERSION = "0.0.1"
+end

data/mini_transformer.gemspec

@@ -0,0 +1,36 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "mini_transformer/version"
+
+Gem::Specification.new do |s|
+  s.name        = "mini_transformer"
+  s.version     = MiniTransformer::VERSION
+  s.authors     = ["John Wang"]
+  s.email       = ["john@johntwang.com"]
+  s.homepage    = "https://github.com/jwang/mini_transformer"
+  s.summary     = %q{A converter for XML and JSON to HTML and JSON.}
+  s.description = %q{A configurable converter for XML and JSON to HTML and JSON.}
+
+  s.rubyforge_project = "mini_transformer"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  #s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.executables   = %w(mini_transform)
+  s.require_paths = ["lib"]
+  # specify any dependencies here; for example:
+
+   s.add_development_dependency "rspec"
+   s.add_development_dependency 'guard-rspec'
+   s.add_development_dependency 'mocha'
+   #s.add_development_dependency 'rb-fsevent'
+   #s.add_development_dependency 'growl_notify'
+   s.add_development_dependency 'rake'
+   s.add_development_dependency 'simplecov'
+   
+   s.add_runtime_dependency "nokogiri"
+   s.add_runtime_dependency 'activesupport'
+   s.add_runtime_dependency 'i18n'
+   s.add_runtime_dependency 'json'
+   s.add_runtime_dependency "thor"
+end

data/spec/fixtures/TP40010215.html

@@ -0,0 +1,31 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+    <meta id="book-resource-type" content="Reference">
+    <meta id="identifier" content="//apple_ref/doc/uid/TP40010215">
+    <title>Example of a Key List (a list of key/value pairs)</title>
+  </head>
+  <body>
+    <header>
+      <p>This book describes some common User Interface elements.</p>
+      <p>Use standard elements in favor of custom elements.
+          Do not create custom elements without a good reason.</p>
+    </header>
+    <details>
+      <summary class="key-list-name">Standard symbols for use in menus</summary>
+    </details>
+    <div class="key-list">
+      <span class="key-label">Symbol</span>
+      <span class="description-label">Meaning</span>
+      <dl class="entries">
+        <dt class="key-name">✓</dt>
+        <dd class="key-description">In the Window menu, the active document; in other menus, a setting that applies to the entire selection</dd>
+        <dt class="key-name">–</dt>
+        <dd class="key-description">A setting that applies to only part of the selection</dd>
+        <dt class="key-name">•</dt>
+        <dd class="key-description">A window with unsaved changes (typically, when Auto Save is not available)</dd>
+      </dl>
+    </div>
+  </body>
+</html>

data/spec/fixtures/bad_xml.xml

@@ -0,0 +1,4 @@
+<root>
+  <open>foo
+    <closed>bar</closed>
+</root>

data/spec/fixtures/input.json

@@ -0,0 +1,5 @@
+{
+  "title"  :  "Example of a Key List (a list of key/value pairs)",
+  "type" : "Reference",
+  "uid" : "TP40010215"
+}

data/spec/fixtures/input.xml

@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<Book id="23">
+  <Introduction>
+    <Para>This book describes some common User Interface elements.</Para>
+    <Para>Use standard elements in favor of custom elements.
+          Do not create custom elements without a good reason.</Para>
+  </Introduction>
+  <KeyList>
+    <Name>Standard symbols for use in menus</Name>
+    <KeyLabel>Symbol</KeyLabel>
+    <DescriptionLabel>Meaning</DescriptionLabel>
+    <Entries>
+       <Entry>
+          <KeyName>✓</KeyName>
+          <Description>In the Window menu, the active document; in other menus, a setting that applies to the entire selection</Description>
+      </Entry>
+      <Entry>
+        <KeyName>–</KeyName>
+        <Description>A setting that applies to only part of the selection</Description>
+      </Entry>
+      <Entry>
+        <KeyName>•</KeyName>
+        <Description>A window with unsaved changes (typically, when Auto Save is not available)</Description>
+      </Entry>
+    </Entries>
+  </KeyList>
+</Book>

data/spec/fixtures/mapping.yml

@@ -0,0 +1,3 @@
+entries: dl
+key-name: dt
+key-description: dd

data/spec/fixtures/no_uid.json

@@ -0,0 +1,4 @@
+{
+  "title"  :  "Example of a Key List (a list of key/value pairs)",
+  "type" : "Reference"
+}

data/spec/fixtures/ol_mapping.yml

@@ -0,0 +1,3 @@
+entries: ol
+key-name: li
+key-description: li

data/spec/fixtures/table_mapping.yml

@@ -0,0 +1,4 @@
+entries: table
+entry: tr
+key-name: td
+key-description: td

data/spec/fixtures/ul_mapping.yml

@@ -0,0 +1,3 @@
+entries: ul
+key-name: li
+key-description: li

data/spec/mini_transformer/book_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+require 'mini_transformer'
+require 'mini_transformer/book'
+
+describe "Book" do
+
+  context "Given a new Book" do
+    it "should respond to all Book attributes" do
+      @book = MiniTransformer::Book.new
+      expect { @book.title }.to_not raise_error
+      @book.respond_to?(:title).should be_true
+      @book.respond_to?(:id).should be_true
+      @book.respond_to?(:uid).should be_true
+      @book.respond_to?(:introduction).should be_true
+      @book.respond_to?(:key_list).should be_true
+      @book.respond_to?(:type).should be_true
+
+      @book.respond_to?(:adfadfasfasdff).should be_false
+    end
+  end
+end

data/spec/mini_transformer/cli_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+require 'mini_transformer'
+require 'mini_transformer/cli'
+
+describe "CLI" do
+  it "should check for a version" do
+    mini_transform :version, :exitstatus => true
+    @exitstatus.should eq(0)
+    out.should == "Mini Transform version 0.0.1"
+  end
+
+  it "should be able to check version with -v" do
+    mini_transform "-v"
+    out.should == "Mini Transform version 0.0.1"
+  end
+  
+  it "should be able to check version with --version" do
+    mini_transform "--version"
+    out.should == "Mini Transform version 0.0.1"
+  end
+end
+
+describe "MiniTransformer::CLI" do
+  
+  before(:all) do
+    @cli = MiniTransformer::CLI.new
+  end
+  
+  it "should check version" do
+    @cli.version.should == "Mini Transform version 0.0.1"
+  end
+  
+  it "should run a minitransformer with input.json input.xml" do
+    @cli.transform("#{FIXTURES_DIR}/input.json", "#{FIXTURES_DIR}/input.xml")
+  end
+  
+  it "should raise an error if the either the input.json or input.xml cannot be found" do
+    expect { @cli.transform("input.json", "input.xml") }.to raise_error(RuntimeError, "File Not Found.")
+  end
+  
+  
+  it "should be able to export out to json if format=json is given" do
+    @cli.transform("#{FIXTURES_DIR}/input.json", "#{FIXTURES_DIR}/input.xml", "ouput.json", "json")
+  end
+  
+end

data/spec/mini_transformer/entry_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+require 'mini_transformer'
+require 'mini_transformer/entry'
+
+describe "Entry" do
+
+  context "Given a new Entry" do
+    it "should respond to all Entry attributes" do
+      @entry = MiniTransformer::Entry.new
+      expect { @entry.key_name }.to_not raise_error
+      @entry.respond_to?(:key_name).should be_true
+      @entry.respond_to?(:description).should be_true
+    end
+    
+    it "should convert to JSON" do
+      @entry = MiniTransformer::Entry.new
+      @entry.key_name = "-"
+      @entry.description = "A setting that applies to only part of the selection"
+      json = @entry.to_json
+      expect { JSON.parse json }.to_not raise_error(JSON::JSONError)
+    end
+    
+  end
+end

data/spec/mini_transformer/key_list_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+require 'mini_transformer'
+require 'mini_transformer/key_list'
+
+describe "KeyList" do
+  context "Given a new KeyList" do
+    it "should respond to all KeyList attributes" do
+      @key_list = MiniTransformer::KeyList.new
+      expect { @key_list.name }.to_not raise_error
+      @key_list.respond_to?(:name).should be_true
+      @key_list.respond_to?(:key_label).should be_true
+      @key_list.respond_to?(:description_label).should be_true
+      @key_list.respond_to?(:entries).should be_true
+    end
+  end
+end

data/spec/mini_transformer_spec.rb

@@ -0,0 +1,146 @@
+require 'spec_helper'
+require 'mini_transformer'
+require 'nokogiri'
+
+describe MiniTransformer do
+  FIXTURES_DIR = File.join(File.dirname(__FILE__), "fixtures")
+  describe "Version" do
+    it "should have a version" do
+      MiniTransformer::VERSION.should_not be_nil
+    end
+  end
+
+  describe "Parser" do
+    before(:all) do
+      @parser = MiniTransformer::Parser.new
+      @file = File.new(File.join(FIXTURES_DIR, "input.xml"), 'rb')
+      @json = File.new(File.join(FIXTURES_DIR, "input.json"), 'rb')
+    end
+
+    it "should Ensure Valid file" do
+      badly_formed = <<-EOXML
+      <root>
+        <open>foo
+          <closed>bar</closed>
+      </root>
+      EOXML
+
+      bad_doc  = Nokogiri::XML badly_formed
+    end
+
+    it "should raise exception if passed in a bad file" do
+      expect { @parser.setup(@json, "input.xml") }.to raise_error(RuntimeError, "File Not Found.")
+    end
+
+    it "should setup with good XML" do
+      expect { @parser.setup(@json.path, @file.path) }.to_not raise_error
+    end
+
+    it "should validate the XML format before continuing" do
+      @parser.setup(@json.path, @file.path)
+      @parser.validate.should be_empty
+    end
+
+    it "should have errors on invalid XML" do
+      @bad_file = File.new(File.join(FIXTURES_DIR, "bad_xml.xml"), 'rb')
+      @parser.setup(@json.path, @bad_file.path)
+      expect { @parser.validate }.to raise_error(RuntimeError, "Malformed XML")
+    end
+
+    it "should parse" do
+      @parser.setup(@json.path, @file.path)
+      @parser.validate
+      @parser.parse
+    end
+
+    context "HTML" do
+      it "should create a HTML doc" do
+        @result_file = File.open(File.join(FIXTURES_DIR, "TP40010215.html"), 'rb:UTF-8')
+        @parser.setup(@json.path, @file.path)
+        @parser.validate
+        @parser.parse
+
+        @result_doc = ""
+        @result_file.each do |line|
+          @result_doc = @result_doc + line
+        end
+        @result_file.close
+        @parser.to_html.should eq(@result_doc)
+      end
+
+      it "should create an output.html file if UID is not present in JSON" do
+        json_uid = File.new(File.join(FIXTURES_DIR, "no_uid.json"), 'rb')
+        @parser.setup(json_uid.path, @file.path)
+        @parser.validate
+        @parser.parse
+        @parser.to_html
+        File.exists?('output.html').should be_true
+      end
+
+    end
+
+    context "JSON Format" do
+      it "should export to JSON with uid if filename is nil" do
+        @parser.setup(@json.path, @file.path, nil, 'json')
+        @parser.validate
+        @parser.parse
+        @parser.to_json
+        File.exists?('TP40010215.json').should be_true
+      end
+
+      it "should export to output.json if no UID exists in json input" do
+        json_uid = File.new(File.join(FIXTURES_DIR, "no_uid.json"), 'rb')
+        @parser.setup(json_uid.path, @file.path, nil, 'json')
+        @parser.validate
+        @parser.parse
+        @parser.to_json
+        File.exists?('output.json').should be_true
+      end
+
+      it "should export to JSON if the format specified is 'json'" do
+        @parser.setup(@json.path, @file.path, "output.json", 'json')
+        @parser.validate
+        @parser.parse
+        @parser.to_json
+        File.exists?('output.json').should be_true
+      end
+
+    end
+
+    context "Mappings" do
+      it "should accept a valid mapping for the children" do
+        mapping = File.open(File.join(FIXTURES_DIR, "mapping.yml"), 'rb:UTF-8')
+        @parser.setup(@json.path, @file.path, "altered.html", 'html', mapping.path)
+        @parser.validate
+        @parser.parse
+        @parser.to_html
+      end
+
+      it "should accept a valid ol mapping for the children" do
+        mapping = File.open(File.join(FIXTURES_DIR, "ol_mapping.yml"), 'rb:UTF-8')
+        @parser.setup(@json.path, @file.path, "ol.html", 'html', mapping.path)
+        @parser.validate
+        @parser.parse
+        @parser.to_html
+      end
+
+      it "should accept a valid ul mapping for the children" do
+        mapping = File.open(File.join(FIXTURES_DIR, "ul_mapping.yml"), 'rb:UTF-8')
+        @parser.setup(@json.path, @file.path, "ul.html", 'html', mapping.path)
+        @parser.validate
+        @parser.parse
+        @parser.to_html
+      end
+
+      it "should accept a valid table mapping for the children" do
+        mapping = File.open(File.join(FIXTURES_DIR, "table_mapping.yml"), 'rb:UTF-8')
+        @parser.setup(@json.path, @file.path, "table.html", 'html', mapping.path)
+        @parser.validate
+        @parser.parse
+        @parser.to_html
+      end
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,34 @@
+require 'simplecov'
+SimpleCov.start do
+  add_filter "/spec/"
+end
+$:.unshift File.expand_path('..', __FILE__)
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'rspec'
+require 'mini_transformer'
+
+# Require the correct version of popen for the current platform
+if RbConfig::CONFIG['host_os'] =~ /mingw|mswin/
+  begin
+    require 'win32/open3'
+  rescue LoadError
+    abort "Run `gem install win32-open3` to be able to run specs"
+  end
+else
+  require 'open3'
+end
+
+Dir["#{File.expand_path('../support', __FILE__)}/*.rb"].each do |file|
+  require file
+end
+
+RSpec.configure do |config|
+  #config.include Spec::Builders
+  config.include Spec::Helpers
+  #config.include Spec::Indexes
+  #config.include Spec::Matchers
+  #config.include Spec::Path
+  #config.include Spec::Rubygems
+  #config.include Spec::Platforms
+  #config.include Spec::Sudo
+end

data/spec/support/helpers.rb

@@ -0,0 +1,57 @@
+module Spec
+  module Helpers    
+    attr_reader :out, :err, :exitstatus
+
+    def lib
+      File.expand_path('../../../lib', __FILE__)
+    end
+
+    def mini_transform(cmd, options = {})
+      #p "mini transforming"
+      expect_err  = options.delete(:expect_err)
+      exitstatus = options.delete(:exitstatus)
+      #options["no-color"] = true unless options.key?("no-color") || cmd.to_s[0..3] == "exec"
+
+      mini_transform = File.expand_path('../../../bin/mini_transform', __FILE__)
+
+      #requires = options.delete(:requires) || []
+      #requires << File.expand_path('../fakeweb/'+options.delete(:fakeweb)+'.rb', __FILE__) if options.key?(:fakeweb)
+      #requires << File.expand_path('../artifice/'+options.delete(:artifice)+'.rb', __FILE__) if options.key?(:artifice)
+      #requires_str = requires.map{|r| "-r#{r}"}.join(" ")
+
+      #env = (options.delete(:env) || {}).map{|k,v| "#{k}='#{v}' "}.join
+      args = options.map do |k,v|
+        v == true ? " --#{k}" : " --#{k} #{v}" if v
+      end.join
+
+      cmd = "#{Gem.ruby} -I#{lib} #{mini_transform} #{cmd}#{args}"
+      #p "cmd: #{cmd}"
+      if exitstatus
+        sys_status(cmd)
+      else
+        sys_exec(cmd, expect_err){|i| yield i if block_given? }
+      end
+    end
+    
+    def sys_status(cmd)
+      @err = nil
+      @out = %x{#{cmd}}.strip
+      @exitstatus = $?.exitstatus
+    end
+    
+    def sys_exec(cmd, expect_err = false)
+      Open3.popen3(cmd.to_s) do |stdin, stdout, stderr|
+        @in_p, @out_p, @err_p = stdin, stdout, stderr
+
+        yield @in_p if block_given?
+        @in_p.close
+        @out = @out_p.read_available_bytes.strip unless @out_p.closed?
+        @err = @err_p.read_available_bytes.strip unless @err_p.closed?
+      end
+
+      puts @err unless expect_err || @err.empty? || !$show_err
+      @out
+    end
+    
+  end
+end

data/spec/support/ruby_ext.rb

@@ -0,0 +1,20 @@
+class IO
+  def read_available_bytes(chunk_size = 16384, select_timeout = 0.02)
+    buffer = []
+
+    return "" if closed? || eof?
+    # IO.select cannot be used here due to the fact that it
+    # just does not work on windows
+    while true
+      begin
+        IO.select([self], nil, nil, select_timeout)
+        break if eof? # stop raising :-(
+        buffer << self.readpartial(chunk_size)
+      rescue(EOFError)
+        break
+      end
+    end
+
+    return buffer.join
+  end
+end

metadata

@@ -0,0 +1,208 @@
+--- !ruby/object:Gem::Specification
+name: mini_transformer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- John Wang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-07 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70175232360960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70175232360960
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &70175232360540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70175232360540
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &70175232360120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70175232360120
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70175232359640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70175232359640
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70175232359160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70175232359160
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &70175232358680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70175232358680
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70175232358120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70175232358120
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: &70175232357500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70175232357500
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &70175232356540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70175232356540
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: &70175232356120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70175232356120
+description: A configurable converter for XML and JSON to HTML and JSON.
+email:
+- john@johntwang.com
+executables:
+- mini_transform
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/mini_transform
+- lib/mini_transformer.rb
+- lib/mini_transformer/book.rb
+- lib/mini_transformer/cli.rb
+- lib/mini_transformer/entry.rb
+- lib/mini_transformer/format.xsl
+- lib/mini_transformer/html.rb
+- lib/mini_transformer/key_list.rb
+- lib/mini_transformer/version.rb
+- mini_transformer.gemspec
+- spec/fixtures/TP40010215.html
+- spec/fixtures/bad_xml.xml
+- spec/fixtures/input.json
+- spec/fixtures/input.xml
+- spec/fixtures/mapping.yml
+- spec/fixtures/no_uid.json
+- spec/fixtures/ol_mapping.yml
+- spec/fixtures/table_mapping.yml
+- spec/fixtures/ul_mapping.yml
+- spec/mini_transformer/book_spec.rb
+- spec/mini_transformer/cli_spec.rb
+- spec/mini_transformer/entry_spec.rb
+- spec/mini_transformer/key_list_spec.rb
+- spec/mini_transformer_spec.rb
+- spec/spec_helper.rb
+- spec/support/helpers.rb
+- spec/support/ruby_ext.rb
+homepage: https://github.com/jwang/mini_transformer
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: mini_transformer
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A converter for XML and JSON to HTML and JSON.
+test_files:
+- spec/fixtures/TP40010215.html
+- spec/fixtures/bad_xml.xml
+- spec/fixtures/input.json
+- spec/fixtures/input.xml
+- spec/fixtures/mapping.yml
+- spec/fixtures/no_uid.json
+- spec/fixtures/ol_mapping.yml
+- spec/fixtures/table_mapping.yml
+- spec/fixtures/ul_mapping.yml
+- spec/mini_transformer/book_spec.rb
+- spec/mini_transformer/cli_spec.rb
+- spec/mini_transformer/entry_spec.rb
+- spec/mini_transformer/key_list_spec.rb
+- spec/mini_transformer_spec.rb
+- spec/spec_helper.rb
+- spec/support/helpers.rb
+- spec/support/ruby_ext.rb