nom-xml 0.0.4 → 0.0.5

data/README.md

@@ -2,16 +2,18 @@
 
 [![Build Status](https://secure.travis-ci.org/cbeer/nom.png)](http://travis-ci.org/cbeer/nom)
 
-A library to help you tame sprawling XML schemas
+A library to help you tame sprawling XML schemas.
 
-NOM allows you to define a “terminology” to ease translation between XML and ruby objects – you can query the xml for Nodes or node values without ever writing a line of XPath.
+NOM allows you to define a “terminology” to ease translation between XML and ruby objects – you can query the xml for Nodes or node values without ever writing a line of XPath. NOM is built on top of [nokogiri](http://nokogiri.org) decorators, which means you can mix-and-match NOM accessors with nokogiri xpaths, xml manipulation, and traversing and it will just work.
 
 
 Some Handy Links
 ----------------
-[API](http://rubydoc.info/github/cbeer/nom) - A reference to NOM's classes
-[#projecthydra](http://webchat.freenode.net/?channels=#projecthydra) on irc.freenode.net
-[Project Hydra Google Group](http://groups.google.com/group/hydra-tech) - community mailing list and forum
+Here are some resources to help you learn more about nom-xml:
+
+- [API](http://rubydoc.info/github/cbeer/nom) - A reference to NOM's classes
+- [#projecthydra](http://webchat.freenode.net/?channels=#projecthydra) on irc.freenode.net
+- [Project Hydra Google Group](http://groups.google.com/group/hydra-tech) - community mailing list and forum
 
 An Example
 ---------------
@@ -45,6 +47,9 @@ An Example
 ```
 
 ```ruby
+require 'nom/xml'
+
+# load the source document as normal
 doc = Nokogiri::XML my_source_document
 
 doc.set_terminology do |t|

data/lib/nom/xml/decorators/terminology.rb

@@ -24,8 +24,9 @@ module Nom::XML::Decorators::Terminology
                      self.xpath(xpath, self.document.terminology_namespaces)
                  end
 
+
         m = t.options[:accessor]
-        case
+        return_value = case
           when m.nil?
             result
           when m.is_a?(Symbol)
@@ -35,6 +36,13 @@ module Nom::XML::Decorators::Terminology
           else
             raise "Unknown accessor class: #{m.class}"
         end
+
+
+        if return_value and (t.options[:single] or (return_value.length == 1 and return_value.first.is_a? Nokogiri::XML::Attr))
+          return return_value.first
+        end
+
+        return return_value
       end
     end
 
@@ -48,7 +56,7 @@ module Nom::XML::Decorators::Terminology
 
     self.parent.term_accessors.select do |k,term|
       self.parent.xpath(term.local_xpath, self.document.terminology_namespaces).include? self
-    end
+    end.map { |k, term| term }
   end
 
   protected
@@ -76,7 +84,7 @@ module Nom::XML::Decorators::Terminology
   def child_terms
     h = {}
 
-    terms.each do |k,term|
+    terms.each do |term|
 
       term.terms.each do |k1, v1|
         h[k1] = v1

data/lib/nom/xml/nokogiri_extension.rb

@@ -22,7 +22,7 @@ module Nom::XML
 
     def set_terminology options = {}, &block
       @terminology_namespaces = options[:namespaces]
-      @terminology = Nom::XML::Terminology.new &block
+      @terminology = Nom::XML::Terminology.new(options, &block)
     end
 
     def terminology_namespaces

data/lib/nom/xml/term.rb

@@ -61,6 +61,10 @@ module Nom::XML
       terms.key? term
     end
 
+    def flatten
+      [self, terms.map { |k,v| v.flatten }].flatten
+    end
+
     protected
     def add_term method, options = {}, *args, &block
       terms[method] = Term.new(self, method, options, *args, &block)

data/lib/nom/xml/terminology.rb

@@ -1,12 +1,18 @@
 module Nom::XML
   class Terminology < Term
-    def initialize *args, &block
+
+    def initialize options = {}, *args, &block
       @terms = {}
+      @options = options || {}
       in_edit_context do
         yield(self) if block_given?
       end
     end
 
+    def namespaces
+      options[:namespaces] || {}
+    end
+
     def xpath
       nil
     end

data/lib/nom/xml/version.rb

@@ -1,5 +1,5 @@
 module Nom
   module XML
-    VERSION = '0.0.4'
+    VERSION = '0.0.5'
   end
 end

data/spec/examples/mods_example_spec.rb

@@ -0,0 +1,93 @@
+require 'spec_helper'
+
+describe "Namespaces example" do
+
+  let(:file) { File.open(File.join(File.dirname(__FILE__), '..', 'fixtures', 'mods_document.xml'), 'r') }
+  let(:xml) { Nokogiri::XML(file) }
+
+  subject {
+
+     xml.set_terminology(:namespaces => { 'mods' => 'http://www.loc.gov/mods/v3'}) do |t|
+
+      t.author :path => '//mods:name' do |n|
+        n.valueURI :path => '@valueURI'
+        n.namePart :path => 'mods:namePart', :single => true, :index_as => [:type_1]
+      end
+
+      t.corporate_authors :path => '//mods:name[@type="corporate"]'
+      t.personal_authors :path => 'mods:name[@type="personal"]' do |n|
+        n.roleTerm :path => 'mods:role/mods:roleTerm', :index_as => [:type_1]
+
+        n.name_role_pair :path => '.', :accessor => lambda { |node| node.roleTerm.text + ": " + node.namePart.text }
+
+    #    n.name_object :path => '.', :accessor => lambda { |node| ModsName.new node }
+      end
+
+      t.language :path => 'mods:language' do |n|
+        n.value :path => 'mods:languageTerm', :accessor => :text
+      end
+     
+     end
+
+     xml.nom!
+
+     xml
+  }
+
+  it "should return nodesets by default" do
+    subject.personal_authors.should be_a_kind_of(Nokogiri::XML::NodeSet)
+  end
+
+  it "should return single elements on demand" do
+    subject.personal_authors.first.namePart.should be_a_kind_of(Nokogiri::XML::Element)
+  end
+
+  it "should return attributes as single-valued" do
+    subject.personal_authors.first.valueURI.should be_a_kind_of(Nokogiri::XML::Attr)
+  end
+
+  it "should share terms over matched nodes" do
+    subject.personal_authors.first.namePart.text.should == "Alterman, Eric"
+  end
+
+  it "should return single elements out of nodesets correctly" do
+    subject.personal_authors.namePart.should be_a_kind_of(Nokogiri::XML::NodeSet)
+  end
+
+  it "should create enumerable objects" do
+    subject.personal_authors.should respond_to(:each)
+    subject.personal_authors.should have(1).node
+  end
+
+  it "should provide accessors" do
+    eric =subject.personal_authors.first
+ 
+    eric.namePart.text.should == "Alterman, Eric"
+    eric.roleTerm.text.should == "creator"
+  end
+
+  it "should let you mix and match xpaths and nom accessors" do
+    subject.language.value.should include('eng')
+    subject.xpath('//mods:language', 'mods' => 'http://www.loc.gov/mods/v3').value.should include('eng')
+  end
+
+  it "should work with attributes" do
+    eric =subject.personal_authors.first
+    eric.valueURI.to_s.should == 'http://id.loc.gov/authorities/names/n92101908'
+  end
+
+  it "should allow you to access a term from the node" do
+    subject.personal_authors.namePart.terms.map { |term|term.options[:index_as] }.flatten.should include(:type_1)
+  end
+
+  it "should let you go from a terminology to nodes" do
+    subject.terminology.flatten.length.should == 10
+
+    subject.terminology.flatten.select { |x| x.options[:index_as] }.length.should == 2
+
+    subject.terminology.flatten.select { |x| x.options[:index_as] }.each do |term|
+      subject.xpath(term.xpath, subject.terminology.namespaces)
+    end
+  end
+
+end

data/spec/examples/template_registry_example_spec.rb

@@ -23,7 +23,7 @@ describe "Template Registry example" do
 
     xml.set_terminology do |t|
       t.a
-      t.b
+      t.b :template => :asdf
       t.b_ref :path => 'b'
 
       t.c do |c|

data/spec/fixtures/mods_document.xml

@@ -0,0 +1,106 @@
+
+<?xml version='1.0' encoding='UTF-8' ?>
+<mods xmlns:xlink="http://www.w3.org/1999/xlink" version="3.4"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.loc.gov/mods/v3"
+  xsi:schemaLocation="http://www.loc.gov/mods/v3 http://www.loc.gov/standards/mods/v3/mods-3-4.xsd">
+
+  <titleInfo>
+    <title>Sound and fury</title>
+    <subTitle>the making of the punditocracy</subTitle>
+  </titleInfo>
+
+  <name type="personal" authorityURI="http://id.loc.gov/authorities/names"
+    valueURI="http://id.loc.gov/authorities/names/n92101908">
+    <namePart>Alterman, Eric</namePart>
+    <role>
+      <roleTerm type="text">creator</roleTerm>
+    </role>
+  </name>
+
+  <typeOfResource>text</typeOfResource>
+
+  <genre authority="marcgt">bibliography</genre>
+
+  <originInfo>
+    <place>
+      <placeTerm authority="marccountry" type="code"
+        authorityURI="http://id.loc.gov/vocabulary/countries"
+        valueURI="http://id.loc.gov/vocabulary/countries/nyu">nyu</placeTerm>
+    </place>
+    <place>
+      <placeTerm type="text">Ithaca, N.Y</placeTerm>
+    </place>
+    <publisher>Cornell University Press</publisher>
+    <dateIssued>c1999</dateIssued>
+    <dateIssued encoding="marc">1999</dateIssued>
+    <issuance>monographic</issuance>
+  </originInfo>
+
+  <language>
+    <languageTerm authority="iso639-2b" type="code"
+      authorityURI="http://id.loc.gov/vocabulary/iso639-2"
+      valueURI="http://id.loc.gov/vocabulary/iso639-2/eng">eng</languageTerm>
+  </language>
+
+  <physicalDescription>
+    <form authority="marcform">print</form>
+    <extent>vii, 322 p. ; 23 cm.</extent>
+  </physicalDescription>
+
+  <note type="statement of responsibility">Eric Alterman.</note>
+  <note>Includes bibliographical references (p. 291-312) and index.</note>
+
+  <subject authority="lcsh" authorityURI="http://id.loc.gov/authorities/subjects">
+    <topic valueURI="http://id.loc.gov/authorities/subjects/sh85070736">Journalism</topic>
+    <topic valueURI="http://id.loc.gov/authorities/subjects/sh00005651">Political aspects</topic>
+    <geographic valueURI="http://id.loc.gov/authorities/names/n78095330">United States</geographic>
+  </subject>
+
+  <subject authority="lcsh" authorityURI="http://id.loc.gov/authorities/subjects">
+    <geographic valueURI="http://id.loc.gov/authorities/names/n78095330">United States</geographic>
+    <topic valueURI="http://id.loc.gov/authorities/subjects/sh2002011436">Politics and
+      government</topic>
+    <temporal valueURI="http://id.loc.gov/authorities/subjects/sh2002012476">20th century</temporal>
+  </subject>
+
+  <subject authority="lcsh" authorityURI="http://id.loc.gov/authorities/subjects"
+    valueURI="http://id.loc.gov/authorities/subjects/sh2008107507">
+    <topic valueURI="http://id.loc.gov/authorities/subjects/sh85081863">Mass media</topic>
+    <topic valueURI="http://id.loc.gov/authorities/subjects/sh00005651">Political aspects</topic>
+    <geographic valueURI="http://id.loc.gov/authorities/names/n78095330">United States</geographic>
+  </subject>
+
+  <subject authority="lcsh" authorityURI="http://id.loc.gov/authorities/subjects"
+    valueURI="http://id.loc.gov/authorities/subjects/sh2010115992">
+    <topic valueURI="http://id.loc.gov/authorities/subjects/sh85133490">Television and
+      politics</topic>
+    <geographic valueURI="http://id.loc.gov/authorities/names/n78095330">United States</geographic>
+  </subject>
+
+  <subject authority="lcsh" authorityURI="http://id.loc.gov/authorities/subjects"
+    valueURI="http://id.loc.gov/authorities/subjects/sh2008109555">
+    <topic valueURI="http://id.loc.gov/authorities/subjects/sh85106514">Press and politics</topic>
+    <geographic valueURI="http://id.loc.gov/authorities/names/n78095330">United States</geographic>
+  </subject>
+
+  <subject authority="lcsh" authorityURI="http://id.loc.gov/authorities/subjects" valueURI="http://id.loc.gov/authorities/subjects/sh2010115993.html">
+    <topic valueURI="http://id.loc.gov/authorities/subjects/sh2006004518.html">Television talk shows</topic>
+    <geographic valueURI="http://id.loc.gov/authorities/names/n78095330">United States</geographic>
+  </subject>
+
+  <classification authority="lcc">PN4888.P6 A48 1999</classification>
+  <classification edition="21" authority="ddc">071/.3</classification>
+
+  <identifier type="isbn">0801486394 (pbk. : acid-free, recycled paper)</identifier>
+  <identifier type="lccn">99042030</identifier>
+
+  <recordInfo>
+    <descriptionStandard>aacr</descriptionStandard>
+    <recordContentSource>DLC</recordContentSource>
+    <recordCreationDate encoding="marc">990730</recordCreationDate>
+    <recordChangeDate encoding="iso8601">20000406144503.0</recordChangeDate>
+    <recordIdentifier>11761548</recordIdentifier>
+    <recordOrigin>Converted from MARCXML to MODS version 3.4 using MARC21slim2MODS3-4.xsl (Revision
+      1.74), valueURIs and authorityURIs added by hand 20120123</recordOrigin>
+  </recordInfo>
+</mods>

data/spec/lib/terminology_decorator_spec.rb

@@ -114,7 +114,7 @@ describe "Nutrition" do
       end
 
       it "should find the right term" do
-        subject.terms.keys.should include(:a)
+        subject.terms.map { |x| x.name }.should include(:a)
       end
     end
 
@@ -126,7 +126,7 @@ describe "Nutrition" do
       end
 
       it "should find the right terms" do
-        subject.terms.keys.should include(:b, :b_ref)
+        subject.terms.map { |x| x.name }.should include(:b, :b_ref)
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nom-xml
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-14 00:00:00.000000000 Z
+date: 2012-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -147,9 +147,11 @@ files:
 - lib/nom/xml/terminology.rb
 - lib/nom/xml/version.rb
 - nom.gemspec
+- spec/examples/mods_example_spec.rb
 - spec/examples/namespaced_example_spec.rb
 - spec/examples/nutrition_example_spec.rb
 - spec/examples/template_registry_example_spec.rb
+- spec/fixtures/mods_document.xml
 - spec/fixtures/nutrition.xml
 - spec/fixtures/xml_namespaces.xml
 - spec/lib/nodeset_decorator_spec.rb
@@ -172,7 +174,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1606554633515477206
+      hash: 4581122629078918118
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -181,7 +183,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1606554633515477206
+      hash: 4581122629078918118
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -189,9 +191,11 @@ signing_key:
 specification_version: 3
 summary: asdf
 test_files:
+- spec/examples/mods_example_spec.rb
 - spec/examples/namespaced_example_spec.rb
 - spec/examples/nutrition_example_spec.rb
 - spec/examples/template_registry_example_spec.rb
+- spec/fixtures/mods_document.xml
 - spec/fixtures/nutrition.xml
 - spec/fixtures/xml_namespaces.xml
 - spec/lib/nodeset_decorator_spec.rb