pretty_xml 0.0.1.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f9ddb5c5ac6e75fbbf8834e28a558fab97eb6133
+  data.tar.gz: 4e12ffe7d20324d64996197f8f3d3fa6fac35a9f
+SHA512:
+  metadata.gz: f7a38ed02a4a1a376d2ca41413262b4539e1499f9365b9b97e1ea05aebad3c31e73972936a19b04efa45d3389fb23f28034220f4a62c15e8a2b8349e988ce34f
+  data.tar.gz: 3c9f74139adb91e6a2fa294e66c6200aed620131906c01ed047546413fbe232f9551b8178714683ffe35537b92f0c35ce89df6ba1df76f2069baf28467b2ebb5

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 dcorrigan
+
+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,73 @@
+pretty_xml
+===============
+
+This is pre-1.0 and probably unstable. Use at your own risk
+
+I don't recommend using this unless you are sure a human will have to read your XML file.
+
+Non-features:
+
+  - `pretty_xml` does not support namespaced nodes yet.
+  - deletes all linebreaks from input
+
+## Use
+
+`pretty_xml` expects that three main parameters be passed:
+
+  1. `block`: elements that should have internal and external linebreaks
+  2. `compact`: elements that should have external linebreaks
+  3. `inline`: elements that should have neither internal not external linebreaks
+
+Additional parameters are:
+
+  1. `preserve_whitespace`: retain standalone whitespace only text nodes within compact and inline elements 
+  2. `tab`: specifies the kind of space that should be used for indenting the output.
+
+Less common parameters:
+
+  1. `close_tags`: a list of tags that need explicit closing tags in the output (as in HTML5, `<a id="something"></a>` is correct, but a self-closing `<a id="something"/>` will not be parsed correctly in all cases)
+  2. `control_chars`: options are `:named` or `:hex` for `<`, `>`, and `&` as literal characters in output; defaults to `:named`
+
+Use these parameters within a hash to initialize an instance of the `PrettyXML::PrettyPrint` class. To prettyprint a document, pass a `Nokogiri::XML::Document` or a string as an argument to the `pp` method.
+
+## Example
+
+    doc = '<root>  <block>
+     <p> 
+    </p>
+        
+        </block><p>stuff<i> </i></p>  
+        
+        <structure>
+                           <div>
+                           <p>yo yo<i/></p>
+    </div>
+    </structure></root>'
+
+    options = {
+      :block => %w(root block structure div),
+      :compact => %w(p),
+      :inline => %w(i),
+      :preserve_whitespace => true,
+      :delete_all_linebreaks => true,
+      :tab => '  '
+    }
+
+    puts PrettyXML::PrettyPrint.new(options).pp(doc)
+
+returns
+
+    <?xml version="1.0"?>
+    <root>
+      <block>
+        <p> </p>
+      </block>
+      <p>stuff<i> </i></p>
+      <structure>
+        <div>
+          <p>yo yo<i/></p>
+        </div>
+      </structure>
+    </root>
+
+## Pretty HTML

data/etc/xhtml.yml

@@ -0,0 +1,117 @@
+:block:
+  - address
+  - article
+  - aside
+  - blockquote
+  - body
+  - colgroup
+  - datalist
+  - details
+  - div
+  - dl
+  - figure
+  - footer
+  - form
+  - head
+  - header
+  - hgroup 
+  - html
+  - iframe
+  - main
+  - map
+  - math
+  - menu
+  - nav
+  - object
+  - ol
+  - optgroup
+  - pre
+  - section
+  - select
+  - svg
+  - table
+  - tbody
+  - tfoot
+  - thead
+  - tr
+  - ul
+:compact:
+  - area
+  - audio
+  - base
+  - button
+  - canvas
+  - caption
+  - col
+  - dd
+  - dt
+  - embed
+  - figcaption
+  - h1
+  - h2
+  - h3
+  - h4
+  - h5
+  - h6
+  - hr
+  - img
+  - input
+  - keygen
+  - label
+  - legend
+  - li
+  - link
+  - menuitem
+  - meta
+  - noscript
+  - option
+  - output
+  - p
+  - param
+  - progress
+  - script
+  - source
+  - style
+  - summary
+  - td
+  - template
+  - textarea
+  - th
+  - title
+  - track
+  - video
+:inline:
+  - a
+  - abbr
+  - b
+  - bdi
+  - bdo
+  - br
+  - cite
+  - code
+  - data
+  - del
+  - dfn
+  - em
+  - i
+  - ins
+  - kbd
+  - mark
+  - meter
+  - q
+  - rp
+  - rt
+  - ruby
+  - s
+  - samp
+  - small
+  - span
+  - strong
+  - sub
+  - sup
+  - time
+  - u
+  - var
+  - wbr
+
+

data/lib/config.rb

@@ -0,0 +1,15 @@
+require 'yaml'
+
+module PrettyXML
+  def self.root
+    File.expand_path '../..', __FILE__
+  end
+
+  def self.etc
+    File.join(root, 'etc')
+  end
+
+  def self.load_config(config)
+    YAML.load(File.read(File.join(PrettyXML.etc, config)))
+  end
+end

data/lib/pretty_xml.rb

@@ -0,0 +1,5 @@
+require 'nokogiri'
+require 'config'
+require 'sax'
+require 'printers'
+

data/lib/printers.rb

@@ -0,0 +1,2 @@
+require 'printers/pretty_print'
+require 'printers/xhtml'

data/lib/printers/pretty_print.rb

@@ -0,0 +1,30 @@
+module PrettyXML
+  class PrettyPrint
+    attr_reader :printer, :handler
+
+    def initialize(options)
+      @handler = SaxPrinter.new(options)
+      @printer = Nokogiri::XML::SAX::Parser.new(handler)
+    end
+
+    def pp(doc)
+      d = verify_doc(doc)
+      dn = doctype_node(doc)
+      instrs = []
+      pretty = ''
+      handler.pretty = pretty
+      handler.instructions = instrs
+      printer.parse(d)
+      instrs << dn if dn
+      instrs.empty? ? pretty : "#{instrs.join("\n")}\n#{pretty}"
+    end
+
+    def verify_doc(doc)
+      doc.is_a?(Nokogiri::XML::Document) ? doc.to_xml : doc
+    end
+
+    def doctype_node(doc)
+      doc[/<!DOCTYPE[^>]*>/]
+    end
+  end
+end

data/lib/printers/xhtml.rb

@@ -0,0 +1,25 @@
+module PrettyXML
+  class XHTML < PrettyXML::PrettyPrint
+    VOID = %w(area base br col embed hr img input keygen link meta param source track wbr)
+
+    def initialize(options)
+      @elements = PrettyXML.load_config('xhtml.yml')
+      options[:close_tags] = explicit_closing_tags
+      options[:control_chars] = :hex
+      options.merge!(@elements)
+      super
+    end
+
+    def explicit_closing_tags
+      @elements.values.flatten - VOID
+    end
+
+    def parsed_doc?(doc)
+      doc.is_a?(Nokogiri::HTML::Document) or doc.is_a?(Nokogiri::XML::Document)
+    end
+
+    def verify_doc(doc)
+      parsed_doc?(doc) ? doc.to_xml : doc
+    end
+  end
+end

data/lib/sax.rb

@@ -0,0 +1 @@
+require 'sax/sax_printer'

data/lib/sax/sax_printer.rb

@@ -0,0 +1,174 @@
+class SaxPrinter < Nokogiri::XML::SAX::Document
+  attr_accessor :pretty, :instructions
+
+  CCS = {
+    amp: {named: '&amp;', hex: '&x26;'},
+    lt: {named: '&lt;', hex: '&x3c;'},
+    gt: {named: '&gt;', hex: '&x3e;'},
+  }
+  XMLDEC_ATTRS = %w(version encoding standalone)
+
+  def initialize(options)
+    set_options_as_ivars(options)
+  end
+
+  def start_element_namespace(name, attrs = [], prefix = nil, uri = nil, ns = [])
+    if @use_ns
+      super
+    else
+      start_element(name, attrs.map { |a| [a.localname, a.value] })
+    end
+  end
+
+  def xmldec_attrs(args)
+    XMLDEC_ATTRS.each_with_index.to_a.map { |t, i| " #{t}=\"#{args[i]}\"" if args[i] }.compact.join
+  end
+
+  def xmldecl(*args)
+    opts = xmldec_attrs(args)
+    instructions << "<?xml#{opts}?>"
+  end
+
+  def processing_instruction(name, content)
+    instructions << "<?#{name} #{content}?>"
+  end
+
+  def start_document
+    @depth = 0
+    @opens = []
+  end
+
+  def set_element_types(options)
+    @block = Set.new(options[:block])
+    @compact = Set.new(options[:compact])
+    @inline = Set.new(options[:inline])
+  end
+
+  def set_control_vars(options)
+    @whitespace = options.include?(:preserve_whitespace) ?  options[:preserve_whitespace] : true
+    @close_tags = options[:close_tags] ? Set.new(options[:close_tags]) : []
+    @ccs = options[:control_chars] || :named
+    @use_ns = options[:use_namespaces]
+    @tab = options[:tab] || '  '
+  end
+
+  def set_options_as_ivars(options)
+    set_element_types(options)
+    set_control_vars(options)
+  end
+
+  def block?(name)
+    @block.include?(name)
+  end
+
+  def compact?(name)
+    @compact.include?(name)
+  end
+
+  def inline?(name)
+    @inline.include?(name)
+  end
+
+  def in_inline?
+    inline?(@opens[-1])
+  end
+
+  def in_compact?
+    compact?(@opens[-1])
+  end
+
+  def in_block?
+    block?(@opens[-1])
+  end
+
+  def ws_adder
+    ws = @tab * (@depth - 1)
+    pretty.empty? ? ws : "\n#{ws}"
+  end
+
+  def start_element(name, attributes)
+    @depth += 1
+    space_before_open(name)
+    add_opening_tag(name, attributes)
+    @opens << name
+    @open_tag = name
+  end
+
+  def space_before_open(name)
+    increment_space if block?(name) or compact?(name)
+  end
+
+  def increment_space
+    pretty << ws_adder
+  end
+
+  def end_element(name)
+    space_before_close(name)
+    self_closing?(name) ? pretty[-1] = '/>' : pretty << "</#{name}>"
+    @depth -= 1
+    @open_tag = nil
+    @opens.pop
+  end
+
+  def self_closing?(name)
+    @open_tag == name and !@close_tags.include?(name)
+  end
+
+  def space_before_close(name)
+    increment_space if block?(name) and @depth != 0
+  end
+
+  def add_opening_tag(name, attrs)
+    tag = attrs.empty? ? "<#{name}>" : tag_with_attrs(name, attrs)
+    pretty << tag
+  end
+
+  def tag_with_attrs(name, attrs)
+    attr_str = attrs.map { |n, v| "#{n}=\"#{v}\""}.join(' ')
+    "<#{name} #{attr_str}>"
+  end
+
+  def end_document
+  end
+
+  def characters(string)
+    return false if ws_only_in_block?(string)
+    handle_whitespace(string)
+    unless string.empty?
+      @open_tag = nil
+      sanitize(string)
+      pretty << string
+    end
+  end
+
+  def ws_only_in_block?(string)
+    string[/^\s*$/] and in_block?
+  end
+
+  def whitespace?
+    @whitespace and below_block?
+  end
+
+  def below_block?
+    in_inline? or in_compact?
+  end
+
+  def handle_whitespace(string)
+    string.gsub!(/[\r\n]/, '')
+    string.gsub!(/^\s+|\s+$/, '') unless whitespace?
+  end
+
+  def comment(string)
+    pretty << "<!--#{string}-->"
+  end
+
+  def sanitize(string)
+    string.gsub!(/&/, CCS[:amp][@ccs])
+    string.gsub!(/</, CCS[:lt][@ccs])
+    string.gsub!(/>/, CCS[:gt][@ccs])
+  end
+
+  def error(string)
+    fail Nokogiri::XML::SyntaxError.new(string)
+  end
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: pretty_xml
+version: !ruby/object:Gem::Version
+  version: 0.0.1.5
+platform: ruby
+authors:
+- Dan Corrigan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Accepts element lists as block, compact, and inline parameters and a
+  tab parameter to create a new instance. When pp method is called with a Nokogiri::XML::Document
+  or XML string as argument, the method returns a string formatted according to the
+  logic of the element lists. For optional parameters, see README.
+email:
+- df.corrigan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- etc/xhtml.yml
+- lib/config.rb
+- lib/pretty_xml.rb
+- lib/printers.rb
+- lib/printers/pretty_print.rb
+- lib/printers/xhtml.rb
+- lib/sax.rb
+- lib/sax/sax_printer.rb
+homepage: http://github.com/dcorrigan/pretty_xml
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: For printing human-readable XML docs
+test_files: []