XML到Hash的转换:Nori删除了最深的XML元素的属性

时间:2016-03-01 22:40:27

标签: ruby xml hash

摘要

我在我的机器上使用Ruby(ruby 2.1.2p95 (2014-05-08) [x86_64-linux-gnu],在生产环境中使用ruby 1.9.3p484 (2013-11-22 revision 43786) [x86_64-linux])和Nori将XML文档(最初使用Nokogiri进行处理以进行一些验证)转换为Ruby Hash,但后来我发现Nori正在删除最深层XML元素的属性。

问题详情和复制

为此,我使用类似以下的代码:

xml  = Nokogiri::XML(File.open('file.xml')) { |config| config.strict.noblanks }
hash = Nori.new.parse xml.to_s

除一种情况外,代码通常按预期工作。每当Nori解析XML文本时,它都会从叶元素(即没有子元素的元素)中删除元素属性。

例如,以下文件:

<?xml version="1.0"?>
<root>
  <objects>
    <object>
      <fields>
        <id>1</id>
        <name>The name</name>
        <description>A description</description>
      </fields>
    </object>
  </objects>
</root>

...被转换为预期的Hash(为简洁起见省略了一些输出):

irb(main):066:0> xml = Nokogiri::XML(txt) { |config| config.strict.noblanks }
irb(main):071:0> ap Nori.new.parse(xml.to_s), :indent => -2
{
  "root" => {
    "objects" => {
      "object" => {
        "fields" => {
          "id"   => "1",
          "name" => "The name"
          "description" => "A description"
        }
      }
    }
  }
}

当元素属性用于没有子元素的元素时,会出现问题。例如,以下文档未按预期转换:

<?xml version="1.0"?>
<root>
  <objects>
    <object id="1">
      <fields>
        <field name="Name">The name</field>
        <field name="Description">A description</field>
      </fields>
    </object>
  </objects>
</root>

Nori.new.parse(xml.to_s)显示的awesome_print显示最深<field>元素的属性缺席

irb(main):131:0> ap Nori.new.parse(xml.to_s), :indent => -2
{
  "root" => {
    "objects" => {
      "object" => {
        "fields" => {
          "field" => [
            [0] "The name",
            [1] "A description"
          ]
        },
        "@id"    => "1"
      }
    }
  }
}

Hash只将其值作为列表,不是我想要的。我希望<field>元素保留其属性,就像它们的父元素一样(例如,请@id="1"查看<object>),而不是因为它们的属性被切断。

即使文档被修改为如下所示,它仍然没有按预期工作:

<?xml version="1.0"?>
<root>
  <objects>
    <object id="1">
      <fields>
        <Name type="string">The name</Name>
        <Description type="string">A description</Description>
      </fields>
    </object>
  </objects>
</root>

它产生以下Hash:

{
  "root" => {
    "objects" => {
      "object" => {
        "fields" => {
          "Name"        => "The name",
          "Description" => "A description"
        },
        "@id"    => "1"
      }
    }
  }
}

缺少每个字段条目的type="whatever"属性。

搜索最终将我带到Issue #59,最后一篇文章(从2015年8月开始)说明他无法在Nori的代码中找到错误。&#34;

结论

所以,我的问题是:你是否有人知道一种解决Nori问题的方法(例如可能是一个设置),这将允许我使用我的原始模式(即没有孩子的元素中的属性)?如果是这样,您可以共享一个能够正确处理此问题的代码段吗?

我不得不重新设计我的XML架构并在大约三次更改代码才能使其正常工作,所以如果有办法让Nori表现出来,而我根本就没有意识到这一点,我想知道它是什么。

我希望避免尽可能多地安装更多库,以便使我最初想要使用的架构结构正常工作,但我希望能够如果它被证明有效的可能性。 (我必须再次重新考虑代码......)框架肯定是矫枉过正的,所以请:建议Ruby on Rails或类似的全栈解决方案

请注意,基于(不情愿)重新设计的架构,我目前的解决方案正在运行,但生成和处理比原始解决方案更复杂,我想回到更简单/更浅的架构。

1 个答案:

答案 0 :(得分:3)

Nori实际上没有删除属性,它们只是没有打印。

如果你运行ruby脚本:

require 'nori'

data = Nori.new(empty_tag_value: true).parse(<<XML)
<?xml version="1.0"?>
<root>
  <objects>
    <object>
      <fields>
        <field name="Name">The name</field>
        <field name="Description">A description</field>
      </fields>
    </object>
  </objects>
</root>
XML

field_list = data['root']['objects']['object']['fields']['field']

puts "text: '#{field_list[0]}' data: #{field_list[0].attributes}"
puts "text: '#{field_list[1]}' data: #{field_list[1].attributes}"

你应该得到输出

["The name", "A description"]
text: 'The name' data: {"name"=>"Name"}
text: 'A description' data: {"name"=>"Description"}

清楚地显示属性存在,但inspect方法不显示(p(x)函数与puts x.inspect相同)。

您会注意到puts field_list.inspect输出["The name", "A description"]。但field_list[0].attributes打印属性键和数据。

如果您希望pp显示此内容,则可以重载inspect中的Nori::StringWithAttributes方法。

class Nori
  class StringWithAttributes < String
    def inspect
      [attributes, String.new(self)].inspect
    end
  end
end

或者,如果您想更改输出,可以重载self.new方法,使其返回不同的数据结构。

class Nori
  class MyText < Array
    def attributes=(data)
      self[1] = data
    end
    attr_accessor :text
    def initialize(text)
      self[0] = text
      self[1] = {}
    end
  end
  class StringWithAttributes < String
    def self.new(x)
      MyText.new(x)
    end
  end
end

并以元组形式访问数据

puts "text: '#{data['root']['objects']['object']['fields']['field'][0].first}' data: #{ data['root']['objects']['object']['fields']['field'][0].last}"

这样就可以将数据设置为JSON或YAML,因为文本项看起来像带有2个元素的数组。 pp也有效。

{"root"=>
  {"objects"=>
    {"object"=>
      {"fields"=>
        {"field"=>
          [["The name", {"name"=>"Name"}],
           ["A description", {"name"=>"Description"}]]},
       "bob"=>[{"@id"=>"id1"}, {"@id"=>"id2"}],
       "bill"=>
        [{"p"=>["one", {}], "@id"=>"bid1"}, {"p"=>["two", {}], "@id"=>"bid2"}],
       "@id"=>"1"}}}}

这应该做你想要的。

require 'awesome_print'
require 'nori'

# Copyright (c) 2016 G. Allen Morris III
#
# Awesome Print is freely distributable under the terms of MIT license.
# See LICENSE file or http://www.opensource.org/licenses/mit-license.php
#------------------------------------------------------------------------------
module AwesomePrint
  module Nori

    def self.included(base)
      base.send :alias_method, :cast_without_nori, :cast
      base.send :alias_method, :cast, :cast_with_nori
    end

    # Add Nori XML Node and NodeSet names to the dispatcher pipeline.
    #-------------------------------------------------------------------
    def cast_with_nori(object, type)
      cast = cast_without_nori(object, type)
      if defined?(::Nori::StringWithAttributes) && object.is_a?(::Nori::StringWithAttributes)
        cast = :nori_xml_node
      end
      cast
    end

    #-------------------------------------------------------------------
    def awesome_nori_xml_node(object)
      return %Q|["#{object}", #{object.attributes}]|
    end
  end
end

AwesomePrint::Formatter.send(:include, AwesomePrint::Nori)

data = Nori.new(empty_tag_value: true).parse(<<XML)
<?xml version="1.0"?>
<root>
  <objects>
    <object>
      <fields>
        <field name="Name">The name</field>
        <field name="Description">A description</field>
      </fields>
    </object>
  </objects>
</root>
XML

ap data

输出为:

{
    "root" => {
        "objects" => {
            "object" => {
                "fields" => {
                    "field" => [
                        [0] ["The name", {"name"=>"Name"}],
                        [1] ["A description", {"name"=>"Description"}]
                    ]
                }
            }
        }
    }
}