xml-to-hash 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 31d59b40fb3dc7a1871e7c57e920ada8ddb17409
+  data.tar.gz: 8ac9f306b1583f3337df70137d45b116a7f55cad
+SHA512:
+  metadata.gz: 1a34928339763a712c247ac5a4422d35145ad3bb19b0c2b1f40aa21b16255db10b5983831a12304948d94004b273fd68019d8900231fc686982f13b3fc564020
+  data.tar.gz: 65f3a4203ff7d1401b517a27b8a69bdaf69f07b756a82d2eb61991b3477ef0a75dea09b7919d389c27582610ee0bc47cc58173787a9c3fd4b8b297a28b630a01

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.6
+before_install: gem install bundler -v 1.10.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in xml-to-hash.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Maarten Trompper
+
+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,159 @@
+# XML to Hash
+
+Ruby gem to convert XML into Hash (and into JSON). 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'xml-to-hash'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install xml-to-hash
+
+## Usage
+
+```ruby
+include 'xml/to/hash'
+
+xml_string = STR_XML = <<-EOS
+             <?xml version="1.0" encoding="UTF-8" ?>
+             <!DOCTYPE author [
+               <!ELEMENT author (#PCDATA)>
+               <!ENTITY MyParamEntity "Has been expanded">
+               <!ENTITY js "Me">
+             ]>
+             <myRoot>
+                   some text
+                   <!--
+                   In comments we can use ]]>
+                   <
+                   &, ', and ", but %MyParamEntity; will not be expanded-->
+                   <![CDATA[
+                   Character Data block <!-- <, & ' " -->  *and* %MyParamEntity;  
+                   ]]>
+                   <?linebreak?>
+                   <deeper xmlns="lol://some-namespace" how-deep="very-deep">randomtext
+                   <even 
+                     lol:my-attr="just an attribute" 
+                     xmlns:lol=\'lol://my.name.space/\' deeper="true">O</even></deeper>  
+             </myRoot>
+EOS
+
+xml = Nokogiri::XML STR_XML
+hash = xml.to_hash
+
+puts JSON.pretty_generate(hash)
+```
+
+produces
+
+```json
+{
+  "type": "element",
+  "name": "myRoot",
+  "children": [
+    {
+      "type": "text",
+      "content": "\n      some text\n      "
+    },
+    {
+      "type": "comment",
+      "content": "\n      In comments we can use ]]>\n      <\n      &, ', and \", but %MyParamEntity; will not be expanded"
+    },
+    {
+      "type": "text",
+      "content": "\n      "
+    },
+    {
+      "type": "cdata",
+      "content": "\n      Character Data block <!-- <, & ' \" -->  *and* %MyParamEntity;  \n      "
+    },
+    {
+      "type": "text",
+      "content": "\n      "
+    },
+    {
+      "type": "pi",
+      "name": "linebreak"
+    },
+    {
+      "type": "text",
+      "content": "\n      "
+    },
+    {
+      "type": "element",
+      "attrs": [
+        {
+          "name": "how-deep",
+          "value": "very-deep"
+        }
+      ],
+      "name": "deeper",
+      "namespace": {
+        "href": "lol://some-namespace"
+      },
+      "children": [
+        {
+          "type": "text",
+          "content": "randomtext\n      "
+        },
+        {
+          "type": "element",
+          "attrs": [
+            {
+              "name": "my-attr",
+              "value": "just an attribute",
+              "namespace": {
+                "href": "lol://my.name.space/",
+                "prefix": "lol"
+              }
+            },
+            {
+              "name": "deeper",
+              "value": "true"
+            }
+          ],
+          "name": "even",
+          "namespace": {
+            "href": "lol://some-namespace"
+          },
+          "children": [
+            {
+              "type": "text",
+              "content": "O"
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "type": "text",
+      "content": "  \n"
+    }
+  ]
+}
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/digitalheir/xml-to-hash. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "xml/to/hash"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/xml/to/hash.rb

@@ -0,0 +1,150 @@
+require 'xml/to/hash/version'
+require 'nokogiri'
+
+module Xml
+  module To
+    module Hash
+    end
+  end
+end
+module Nokogiri
+  module XML
+    class Node
+
+      # Returns node type as symbol instead of integer
+      def self.get_type int
+        case int
+          # Element node type, see Nokogiri::XML::Node#element?
+          when Nokogiri::XML::Node::ELEMENT_NODE
+            return :element
+          # Attribute node type
+          when Nokogiri::XML::Node::ATTRIBUTE_NODE
+            return :attribute
+          # Text node type, see Nokogiri::XML::Node#text?
+          when Nokogiri::XML::Node::TEXT_NODE
+            return :text
+          # CDATA node type, see Nokogiri::XML::Node#cdata?
+          when Nokogiri::XML::Node::CDATA_SECTION_NODE
+            return :cdata
+          # Entity reference node type
+          when Nokogiri::XML::Node::ENTITY_REF_NODE
+            return :entity_ref
+          # Entity node type
+          when Nokogiri::XML::Node::ENTITY_NODE
+            return :entity
+          # PI node type
+          when Nokogiri::XML::Node::PI_NODE
+            return :pi
+          # Comment node type, see Nokogiri::XML::Node#comment?
+          when Nokogiri::XML::Node::COMMENT_NODE
+            return :comment
+          # Document node type, see Nokogiri::XML::Node#xml?
+          when Nokogiri::XML::Node::DOCUMENT_NODE
+            return :document
+          # Document type node type
+          when Nokogiri::XML::Node::DOCUMENT_TYPE_NODE
+            return :document_type
+          # Document fragment node type
+          when Nokogiri::XML::Node::DOCUMENT_FRAG_NODE
+            return :document_fraf
+          # Notation node type
+          when Nokogiri::XML::Node::NOTATION_NODE
+            return :notation
+          # HTML document node type, see Nokogiri::XML::Node#html?
+          when Nokogiri::XML::Node::HTML_DOCUMENT_NODE
+            return :html_doc
+          # DTD node type
+          when Nokogiri::XML::Node::DTD_NODE
+            return :dtd
+          # Element declaration type
+          when Nokogiri::XML::Node::ELEMENT_DECL
+            return :element_declaration
+          # Attribute declaration type
+          when Nokogiri::XML::Node::ATTRIBUTE_DECL
+            return :attribute_declaration
+          # Entity declaration type
+          when Nokogiri::XML::Node::ENTITY_DECL
+            return :entity_declaration
+          # Namespace declaration type
+          when Nokogiri::XML::Node::NAMESPACE_DECL
+            return :namespace_declaration
+          # XInclude start type
+          when Nokogiri::XML::Node::XINCLUDE_START
+            return :xinclude_start
+          # XInclude end type
+          when Nokogiri::XML::Node::XINCLUDE_END
+            return :xinclude_end
+          # DOCB document node type
+          when Nokogiri::XML::Node::DOCB_DOCUMENT_NODE
+            return :docb_document
+          else
+            return int
+        end
+      end
+
+      # Serialize this Node to a hash
+      #
+      # Example:
+      #    >> Nokogiri::XML '<xml>hello</xml>'
+      #    => {:type=>:element, :name=>"xml", :children=>[{:type=>:text, :content=>"hello"}]}
+      def to_hash
+        Node.obj_for_node root
+      end
+
+      private
+      # Given a Nokigiri XML node, create a Ruby hash 
+      def self.obj_for_node node
+        ret = {
+            type: get_type(node.node_type),
+        }
+        if node.attributes and node.attributes.length > 0
+          ret[:attrs] = []
+          node.attributes
+          node.attributes.each do |key|
+            attr = key[1]
+            attr_o = {
+                name: key[0],
+                value: attr.content
+            }
+            if attr.namespace
+              attr_o[:namespace] = namespace_hash(attr.namespace)
+            end
+            ret[:attrs] << attr_o
+          end
+        end
+        # Treat elements a little bit differently 
+        case node.node_type
+          when Nokogiri::XML::Node::ELEMENT_NODE, Nokogiri::XML::Node::PI_NODE
+            ret[:name] = node.name
+          else
+            ret[:content]= node.content
+        end
+        if node.namespace
+          ret[:namespace] = namespace_hash(node.namespace)
+        end
+
+        # Recurse into children
+        if node.children and node.children.length > 0
+          unless node.element?
+            puts "W-What? Node had children, but was not an element (but a #{get_type node.node_type})"
+          end
+          ret[:children]=[]
+          node.children.each do |child|
+            ret[:children] << obj_for_node(child)
+          end
+        end
+        ret
+      end
+
+      def self.namespace_hash(namespace)
+        hash = {
+            href: namespace.href
+        }
+        if namespace.prefix
+          hash[:prefix] = namespace.prefix
+        end
+        hash
+      end
+    end
+  end
+end

data/lib/xml/to/hash/version.rb

@@ -0,0 +1,7 @@
+module Xml
+  module To
+    module Hash
+      VERSION = '0.9.0'
+    end
+  end
+end

data/xml-to-hash.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'xml/to/hash/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'xml-to-hash'
+  spec.version = Xml::To::Hash::VERSION
+  spec.authors = ['Maarten Trompper']
+  spec.email = ['m.f.a.trompper@uva.nl']
+
+  spec.summary = %q{Transparently convert XML documents to Ruby hashes (...and JSON, and beyond)}
+  spec.description = %q{This gem add a to_hash method to Nokogiri XML nodes into a Ruby hash. We generate a hash, 
+in which all keys are constants. 
+NOTE: This gem ignores fancy stuff like doctypes and entity declarations.}
+  spec.homepage = 'https://github.com/digitalheir/ruby-xml-to-hash'
+  spec.license = 'MIT'
+
+  # # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "http://mygemserver.com"
+  # else
+  #   raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  # end
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 2.4'
+
+  spec.add_runtime_dependency 'nokogiri', '~> 1.6.6.2', '>= 1.6.6.2'
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: xml-to-hash
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Maarten Trompper
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-06-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.6.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.6.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.6.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.6.2
+description: "This gem add a to_hash method to Nokogiri XML nodes into a Ruby hash.
+  We generate a hash, \nin which all keys are constants. \nNOTE: This gem ignores
+  fancy stuff like doctypes and entity declarations."
+email:
+- m.f.a.trompper@uva.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/xml/to/hash.rb
+- lib/xml/to/hash/version.rb
+- xml-to-hash.gemspec
+homepage: https://github.com/digitalheir/ruby-xml-to-hash
+licenses:
+- MIT
+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.4.7
+signing_key: 
+specification_version: 4
+summary: Transparently convert XML documents to Ruby hashes (...and JSON, and beyond)
+test_files: []