xmlparsable 1.5.2 → 1.5.3

data/README.md

@@ -4,80 +4,90 @@ XmlParsable is a simple means to declare how an XML grammar maps to Ruby objects
 perform validation of the input, and it is only able to describe fairly simple structures. It
 relies on LibXML::XML::SaxParser.
 
-1. Declare XML grammar
-
-        require "xmlparsable"
-
-        # Needed only for using the "collection" declaration or
-        # implement your own String#pluralize, String#singularize
-        require "active_support/core_ext"
-
-        class AddressBook
-          include XmlParsable
-
-          class Contact
-            include XmlParsable
-            element :givenname
-            element :familyname
-            element :phone
-            element :email
-            element :spouse,      Contact
-            collection :children, Contact
-            element :birthdate,   DateElement
-            element :updated,     TimeElement
-          end
-
-          collection :contact, Contact
-        end
-
-2. Parse input XML from string, IO, or File
-
-        book = AddressBook.parse(<<-XML)
-          <contacts>
-            <contact>
-              <familyname>Kim</familyname>
-              <givenname>Jong-il</givenname>
-              <birthdate>1942-02-16</birthdate>
-              <updated>2010-01-01T12:45:30</updated>
-              <children>
-                <child><givenname>Sul-song</givenname></child>
-                <child><givenname>Jong-chul</givenname></child>
-                <child><givenname>Jong-un</givenname></child>
-                <child>
-                  <givenname>Jong-nam</givenname>
-                  <spouse>
-                    <givenname>Jong-hui</givenname>
-                    <familyname>Shin</familyname>
-                  </spouse>
-                </child>
-              </children>
-            </contact>
-    
-            <contact>
-              <givenname>Vladimir</givenname>
-              <familyname>Putin</familyname>
-              <email>vlad@gmail.com</email>
-              <spouse>
-                <givenname>Lyudmila</givenname>
-                <familyname>Putina</familyname>
-              </spouse>
-            </contact>
-          </contacts>
-        XML
-
-3. Iterate parsed data
-
-        kim, vlad = book.contacts
-        kim.givenname #=> "Kim"
-        kim.birthdate #=> #<Date: 4860813/2,0,2299161>
-        kim.updated   #=> Fri Jan 01 12:45:30 2010
-    
-        sulsong, jongchul, jongun, jongnam = kim.children
-        jongnam.spouse.givenname  #=> "Jong-hui"
-        jongnam.spouse.familyname #=> "Shin"
-    
-        vlad.email    #=> "vlad@gmail.com"
-        vlad.spouse   #=> #<AddressBook::Contact @givenname="Lyudmila" @familyname="Putina">
+## Quick Example
+
+For more details, see the RSpec examples in `spec/examples`.
+
+### Declare XML grammar
+
+```ruby
+require "xmlparsable"
+
+# Needed only for using the "collection" declaration or
+# implement your own String#pluralize, String#singularize
+require "active_support/core_ext"
+
+class AddressBook
+  include XmlParsable
+
+  class Contact
+    include XmlParsable
+    element :givenname
+    element :familyname
+    element :phone
+    element :email
+    element :spouse,      Contact
+    collection :children, Contact
+    element :birthdate,   DateElement
+    element :updated,     TimeElement
+  end
+
+  collection :contact, Contact
+end
+```
+
+### Parse input XML from string, IO, or File
+
+```ruby
+book = AddressBook.parse(<<-XML)
+  <contacts>
+    <contact>
+      <familyname>Kim</familyname>
+      <givenname>Jong-il</givenname>
+      <birthdate>1942-02-16</birthdate>
+      <updated>2010-01-01T12:45:30</updated>
+      <children>
+        <child><givenname>Sul-song</givenname></child>
+        <child><givenname>Jong-chul</givenname></child>
+        <child><givenname>Jong-un</givenname></child>
+        <child>
+          <givenname>Jong-nam</givenname>
+          <spouse>
+            <givenname>Jong-hui</givenname>
+            <familyname>Shin</familyname>
+          </spouse>
+        </child>
+      </children>
+    </contact>
+
+    <contact>
+      <givenname>Vladimir</givenname>
+      <familyname>Putin</familyname>
+      <email>vlad@gmail.com</email>
+      <spouse>
+        <givenname>Lyudmila</givenname>
+        <familyname>Putina</familyname>
+      </spouse>
+    </contact>
+  </contacts>
+XML
+```
+
+### Iterate parsed data
+
+```ruby
+kim, vlad = book.contacts
+kim.givenname #=> "Kim"
+kim.birthdate #=> #<Date: 4860813/2,0,2299161>
+kim.updated   #=> Fri Jan 01 12:45:30 2010
+
+sulsong, jongchul, jongun, jongnam = kim.children
+jongnam.spouse.givenname  #=> "Jong-hui"
+jongnam.spouse.familyname #=> "Shin"
+
+vlad.email    #=> "vlad@gmail.com"
+vlad.spouse   #=> #<AddressBook::Contact @givenname="Lyudmila" @familyname="Putina">
+```
 
 ## Data Types
 

data/lib/xmlparsable/elements/record.rb

@@ -5,7 +5,7 @@ module XmlParsable
 
       def initialize(name, attributes, parent, target, parsers, arguments)
         @name, @attributes, @parent, @target, @parsers, @elements =
-          name, attributes, parent, target, parsers, Hash.new
+          name, attributes, parent, target, parsers, Hash.new{|h,k| h.fetch(k.to_sym, nil) }
       end
 
       def open(name, attributes)

data/lib/xmlparsable.rb

@@ -43,7 +43,7 @@ module XmlParsable
       attr_name = arguments.fetch(:accessor, elem_name)
 
       if attr_name and not method_defined?(attr_name)
-        define_method(attr_name) { instance_variable_get(:@xmlelems)[elem_name] }
+        define_method(attr_name) { instance_variable_get(:@xmlelems)[elem_name.to_sym] }
       end
     end
 

data/spec/examples/accessors.example

@@ -8,6 +8,7 @@ describe XmlParsable, "accessors" do
         <size>500</size>
         <wise>none</wise>
         <secret>Ovaltine</secret>
+        <a-z>alphabutt</a-z>
       </root>
     XML
   end
@@ -22,6 +23,7 @@ describe XmlParsable, "accessors" do
           include XmlParsable
           element :size
           element :wise
+          element "a-z"
         end
 
         include XmlParsable
@@ -36,14 +38,23 @@ describe XmlParsable, "accessors" do
 
     it "stores elements in `xmlelems`" do
       xml = parser.parse(input)
-      xml.root.xmlelems[:size] = "500"
-      xml.root.xmlelems[:wise] = "none"
+      xml.root.xmlelems[:size].should == "500"
+      xml.root.xmlelems[:wise].should == "none"
+      xml.root.xmlelems[:"a-z"].should == "alphabutt"
+    end
+
+    it "stores elements with 'indifferent access'" do
+      xml = parser.parse(input)
+      xml.root.xmlelems["size"].should == xml.root.xmlelems[:size]
+      xml.root.xmlelems["wise"].should == xml.root.xmlelems[:wise]
+      xml.root.xmlelems["a-z"].should  == xml.root.xmlelems[:"a-z"]
     end
 
     it "creates accessors for elements" do
       xml = parser.parse(input)
       xml.root.xmlelems[:size].should eql(xml.root.size)
       xml.root.xmlelems[:wise].should eql(xml.root.wise)
+      xml.root.xmlelems[:"a-z"].should eql(xml.root.send("a-z"))
     end
   end
 
@@ -60,6 +71,7 @@ describe XmlParsable, "accessors" do
           include XmlParsable
           element :size
           element :wise, accessor: :wisdom
+          element "a-z", accessor: "atoz"
           element :secret, accessor: false
         end
 
@@ -70,9 +82,10 @@ describe XmlParsable, "accessors" do
 
     it "stores elements in `xmlelems`" do
       xml = parser.parse(input)
-      xml.root.xmlelems[:size] == "500"
-      xml.root.xmlelems[:wise] == "none"
-      xml.root.xmlelems[:secret] == "Ovaltine"
+      xml.root.xmlelems[:size].should == "500"
+      xml.root.xmlelems[:wise].should == "none"
+      xml.root.xmlelems[:"a-z"].should == "alphabutt"
+      xml.root.xmlelems[:secret].should == "Ovaltine"
     end
 
     it "doesn't create accessors for hidden elements" do
@@ -83,6 +96,7 @@ describe XmlParsable, "accessors" do
     it "creates accessors for renamed elements" do
       xml = parser.parse(input)
       xml.root.xmlelems[:wise].should eql(xml.root.wisdom)
+      xml.root.xmlelems[:"a-z"].should eql(xml.root.atoz)
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xmlparsable
 version: !ruby/object:Gem::Version
-  version: 1.5.2
+  version: 1.5.3
   prerelease: 
 platform: ruby
 authors: