xsd-reader 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 710c9e3e4de93c6dacc984039a5edd9ee6b3ecfd
-  data.tar.gz: a5ec41749313855ecc1ae5ee7f5a1e2857d2b0a0
+  metadata.gz: 400a3673c38ae983e49e7d63dfd1dc80daaa027e
+  data.tar.gz: 0e2be864321537a953e21a63bd33f520f5b0d679
 SHA512:
-  metadata.gz: 815a9a1fbd373319aaed9052f04776974f55b1ce2420848818d1a4cd8a77b79a20e03b71bbc6f876da57ee20ce1bf1145d29ebf7a283cc9e165bb5b0fe57c167
-  data.tar.gz: 0e5fc4939b74f755cb3e165133f90435d570cfbac5cf76e3c6bd73ca95be9cf9205d36d01f077076f1f03bf6bbc867009f945dfd62e25ca8e24228ba5142cd64
+  metadata.gz: cd2dcc16a9996af3ee4898e6f4d039245d52946bf2429fcf2952400c305acf94947afd324ecd81a70458ea357bdac7305310a459dd442cfc79bda12558771a89
+  data.tar.gz: 0998edb3ce6a52e8202c277db093e71b997d2cc7c921c6dc95428bec33caaed1be925d5b8e8dbf9c45a235a13c08bfde70902184e74fc06d2a9c869705c7fa7f

data/lib/xsd_reader/complex_type.rb

@@ -3,10 +3,6 @@ module XsdReader
   class ComplexType
     include Shared
 
-    def name
-      node.attributes['name'] ? node.attributes['name'].value : nil
-    end
-
     def attributes
       super + (simple_content ? simple_content.attributes : [])
     end

data/lib/xsd_reader/shared.rb

@@ -49,11 +49,29 @@ module XsdReader
     # attribute properties
     #
     def name
-      node.attributes['name'].value
+      name_local || name_referenced
     end
 
+    def name_local
+      node.attributes['name'] ? node.attributes['name'].value : nil
+    end
+
+    def name_referenced
+      referenced_element ? referenced_element.name : nil
+    end
+
+    def ref
+      node.attributes['ref'] ? node.attributes['ref'].value : nil
+    end
+
+    def referenced_element
+      ref && schema ? schema.elements.find{|el| el.name == ref} : nil
+    end
+
+
     def type
-      node.attributes['type'] ? node.attributes['type'].value : nil
+      type = node.attributes['type'] ? node.attributes['type'].value : nil
+      type || (referenced_element ? referenced_element.type : nil)
     end
 
     def type_name
@@ -64,6 +82,7 @@ module XsdReader
       type ? type.split(':').first : nil
     end
 
+
     # base stuff belongs to extension type objects only, but let's be flexible
     def base
       node.attributes['base'] ? node.attributes['base'].value : nil
@@ -77,6 +96,7 @@ module XsdReader
       base ? base.split(':').first : nil
     end
 
+
     #
     # Node to class mapping
     #
@@ -135,7 +155,9 @@ module XsdReader
     end
 
     def all_elements
-      @all_elements ||= ordered_elements + (linked_complex_type ? linked_complex_type.ordered_elements : [])
+      @all_elements ||= ordered_elements +
+        (linked_complex_type ? linked_complex_type.all_elements : []) + 
+        (referenced_element ? referenced_element.all_elements : [])
     end
 
     def child_elements?
@@ -143,7 +165,8 @@ module XsdReader
     end
 
     def attributes
-      @attributes ||= map_children('xs:attribute')
+      @attributes ||= map_children('xs:attribute') #+
+        #(referenced_element ? referenced_element.attributes : [])
     end
 
     def sequences
@@ -159,7 +182,7 @@ module XsdReader
     end
 
     def complex_type
-      complex_types.first || linked_complex_type
+      complex_types.first || linked_complex_type || (referenced_element ? referenced_element.complex_type : nil)
     end
 
     def linked_complex_type

data/spec/element_spec.rb

@@ -10,80 +10,57 @@ describe XsdReader::Element do
     reader.elements[0]
   }
 
-  it "gives the element's name" do
-    expect(element.name).to eq 'NewReleaseMessage'
-  end
+  let(:referencing_reader){
+    XsdReader::XML.new(:xsd_file => File.expand_path('examples/referencing.xsd', File.dirname(__FILE__)))
+  }
 
-  it "gives a complex type reader" do
-    expect(element.complex_type.class).to eq XsdReader::ComplexType
-  end
+  describe '#[]' do
+    it "gives an element's child" do
+      expect(reader['NewReleaseMessage']).to eq reader.elements[0]
+    end
 
-  it "gives child elements defined within a complex type" do
-    # byebug
-    expect(element.elements.map(&:name)).to eq [
-      "MessageHeader",
-      "UpdateIndicator",
-      "IsBackfill",
-      "CatalogTransfer",
-      "WorkList",
-      "CueSheetList",
-      "ResourceList",
-      "CollectionList",
-      "ReleaseList",
-      "DealList"]
+    it "gives an element's child through reference element" do
+      expect(referencing_reader['Album', 'Tracks', 'Track', 'ISRC'].type).to eq 'xs:NCName'
+    end
   end
 
-  describe "External type definition" do
-    let(:header){
-      element.elements.first
-    }
-
-    it "gives the type name" do
-      expect(header.type_name).to eq 'MessageHeader'
+  describe '#name' do
+    it "gives the element's name" do
+      expect(element.name).to eq 'NewReleaseMessage'
     end
 
-    it "gives the type namespace" do
-      expect(header.type_namespace).to eq 'ern'
+    it "gives the element's name obtained through reference" do
+      expect(referencing_reader.elements[0].elements[0].name).to eq 'Source'
     end
+  end
 
-    it "gives the type string" do
-      expect(header.type).to eq 'ern:MessageHeader'
+  describe '#ref' do
+    it "gives an element's ref attribute value" do
+      expect(referencing_reader['Album']['Source'].ref).to eq 'Source'
     end
 
-    it "gives the remote complex_type, linked by type" do
-      expect(header.complex_type.name).to eq 'MessageHeader'
+    it "returns nil when attribute available" do
+      expect(element.ref).to eq nil
     end
+  end
 
-    it "includes child elements defined in external the complex type type definitions" do
-      expected = [
-        "MessageThreadId",
-        "MessageId",
-        "MessageFileName",
-        "MessageSender",
-        "SentOnBehalfOf",
-        "MessageRecipient",
-        "MessageCreatedDateTime",
-        "MessageAuditTrail",
-        "Comment",
-        "MessageControlType"]
+  describe '#type' do
+    it "gives the type of an element" do
+      expect(reader['NewReleaseMessage']['MessageHeader'].type).to eq 'ern:MessageHeader'
+    end
 
-      expect(header.elements.map(&:name)).to eq expected
-      expect(header.complex_type.all_elements.map(&:name)).to eq expected
+    it "gives the type of an elements obtained through the referenced element" do
+      expect(referencing_reader['Album']['Source'].type).to eq 'xs:string'
     end
   end
 
-  describe "#elements" do
-
-    it "includes elements within a choice node" do
-      el = element.elements[3]
-      expect(el.name).to eq 'CatalogTransfer'
-      elements_without = ["CatalogTransferCompleted", "EffectiveTransferDate", "CatalogReleaseReferenceList", "TransferringFrom", "TransferringTo"]
-      elements_with = ["CatalogTransferCompleted", "EffectiveTransferDate", "CatalogReleaseReferenceList", "TerritoryCode", "ExcludedTerritoryCode", "TransferringFrom", "TransferringTo"]
-      expect(el.complex_type.sequences.map{|seq| seq.elements}.flatten.map(&:name)).to eq elements_without
-      expect(el.complex_type.all_elements.map(&:name)).to eq elements_with
-      expect(el.complex_type.sequences[0].choices.map{|ch| ch.elements}.flatten.map(&:name)).to eq elements_with - elements_without      
+  describe '#complex_type' do
+    it "gives a complex type reader" do
+      expect(element.complex_type.class).to eq XsdReader::ComplexType
     end
+  end
 
+  describe "#elements" do
     it "gives child elements in the right order" do
       expected = [
         "CommercialModelType",
@@ -116,6 +93,109 @@ describe XsdReader::Element do
 
       expect(reader['NewReleaseMessage']['DealList']['ReleaseDeal']['Deal']['DealTerms'].elements.map(&:name)).to eq expected
     end
+
+    it "includes elements within a choice node" do
+      el = element.elements[3]
+      expect(el.name).to eq 'CatalogTransfer'
+      elements_without = ["CatalogTransferCompleted", "EffectiveTransferDate", "CatalogReleaseReferenceList", "TransferringFrom", "TransferringTo"]
+      elements_with = ["CatalogTransferCompleted", "EffectiveTransferDate", "CatalogReleaseReferenceList", "TerritoryCode", "ExcludedTerritoryCode", "TransferringFrom", "TransferringTo"]
+      expect(el.complex_type.sequences.map{|seq| seq.elements}.flatten.map(&:name)).to eq elements_without
+      expect(el.complex_type.all_elements.map(&:name)).to eq elements_with
+      expect(el.complex_type.sequences[0].choices.map{|ch| ch.elements}.flatten.map(&:name)).to eq elements_with - elements_without      
+    end
+
+    it "gives child elements defined within a complex type" do
+      # byebug
+      expect(element.elements.map(&:name)).to eq [
+        "MessageHeader",
+        "UpdateIndicator",
+        "IsBackfill",
+        "CatalogTransfer",
+        "WorkList",
+        "CueSheetList",
+        "ResourceList",
+        "CollectionList",
+        "ReleaseList",
+        "DealList"]
+    end
+
+    it "gives child elements defined in the referenced element" do
+      expect( referencing_reader['Album', 'Tracks'].elements.map(&:name) ).to eq ['Track']
+      expect(referencing_reader['Album', 'Tracks', 'Track'].elements.map(&:name)).to eq [
+        'ISRC',
+        'Artist',
+        'Title',
+        'DiscNumber',
+        'TrackNumber',
+        'Duration',
+        'Label',
+        'Company',
+        'CompanyCountry',
+        'RecordedCountry',
+        'RecordedYear',
+        'ReleaseDate',
+        'Contributors']
+    end
+  end
+
+  describe '#attributes' do
+    it "gives attributes defined in a complexType" do
+      expected = [
+        "MessageSchemaVersionId",
+        "BusinessProfileVersionId",
+        "ReleaseProfileVersionId",
+        "LanguageAndScriptCode"]
+      expect(element.attributes.map(&:name)).to eq expected
+      expect(element.complex_type.attributes.map(&:name)).to eq expected
+    end
+
+    it "gives attributes defined in a simpleContent extension" do
+      expect(element['ResourceList']['SoundRecording']['SoundRecordingDetailsByTerritory']['DisplayArtist']['ArtistRole'].attributes.map(&:name)).to eq ["Namespace", "UserDefinedValue"]
+    end
+
+    it "gives attributes defined in the referenced element" do
+      expect(referencing_reader['Album', 'Tracks', 'Track'].attributes).to eq []
+      expect(referencing_reader['Album', 'Tracks', 'Track', 'Contributors', 'Contributor'].attributes.map(&:name)).to eq ['credited']
+    end
+  end
+
+  describe "External type definition" do
+    let(:header){
+      element.elements.first
+    }
+
+    it "gives the type name" do
+      expect(header.type_name).to eq 'MessageHeader'
+    end
+
+    it "gives the type namespace" do
+      expect(header.type_namespace).to eq 'ern'
+    end
+
+    it "gives the type string" do
+      expect(header.type).to eq 'ern:MessageHeader'
+    end
+
+    it "gives the remote complex_type, linked by type" do
+      expect(header.complex_type.name).to eq 'MessageHeader'
+    end
+
+    it "includes child elements defined in external the complex type type definitions" do
+      expected = [
+        "MessageThreadId",
+        "MessageId",
+        "MessageFileName",
+        "MessageSender",
+        "SentOnBehalfOf",
+        "MessageRecipient",
+        "MessageCreatedDateTime",
+        "MessageAuditTrail",
+        "Comment",
+        "MessageControlType"]
+
+      expect(header.elements.map(&:name)).to eq expected
+      expect(header.complex_type.all_elements.map(&:name)).to eq expected
+    end
   end
 
   # # this is pretty slow...
@@ -152,21 +232,4 @@ describe XsdReader::Element do
   #     expect(element.family_tree['DealList']['ReleaseDeal']['Deal']['DealTerms']['RightsClaimPolicy']['Condition']['Unit']).to eq 'type:UnitOfConditionValue'
   #   end
   # end
-
-  describe '#attributes' do
-    it "gives attributes defined in a complexType" do
-      expected = [
-        "MessageSchemaVersionId",
-        "BusinessProfileVersionId",
-        "ReleaseProfileVersionId",
-        "LanguageAndScriptCode"]
-      expect(element.attributes.map(&:name)).to eq expected
-      expect(element.complex_type.attributes.map(&:name)).to eq expected
-    end
-
-    it "gives attributes defined in a simpleContent extension" do
-      expect(element['ResourceList']['SoundRecording']['SoundRecordingDetailsByTerritory']['DisplayArtist']['ArtistRole'].attributes.map(&:name)).to eq ["Namespace", "UserDefinedValue"]
-    end
-  end
-
 end

data/spec/examples/referencing.xsd

@@ -0,0 +1,70 @@
+<?xml version="1.0" encoding="utf-8" standalone="no"?>
+<xs:schema xmlns:xs='http://www.w3.org/2001/XMLSchema' elementFormDefault='qualified'>
+    <xs:element name='Album'>
+        <xs:complexType>
+            <xs:sequence>
+                <xs:element ref='Source'/>
+                <xs:element ref='Tracks'/>
+            </xs:sequence>
+        </xs:complexType>
+    </xs:element>
+    <xs:element name='Source' type='xs:string'/>
+    <xs:element name='Tracks'>
+        <xs:complexType>
+            <xs:sequence>
+                <xs:element ref='Track'/>
+            </xs:sequence>
+        </xs:complexType>
+    </xs:element>
+    <xs:element name='Track'>
+        <xs:complexType>
+            <xs:sequence>
+                <xs:element ref='ISRC'/>
+                <xs:element ref='Artist'/>
+                <xs:element ref='Title'/>
+                <xs:element ref='DiscNumber'/>
+                <xs:element ref='TrackNumber'/>
+                <xs:element ref='Duration'/>
+                <xs:element ref='Label'/>
+                <xs:element ref='Company'/>
+                <xs:element ref='CompanyCountry'/>
+                <xs:element ref='RecordedCountry'/>
+                <xs:element ref='RecordedYear'/>
+                <xs:element ref='ReleaseDate'/>
+                <xs:element ref='Contributors'/>
+            </xs:sequence>
+        </xs:complexType>
+    </xs:element>
+    <xs:element name='ISRC' type='xs:NCName'/>
+    <xs:element name='DiscNumber' type='xs:integer'/>
+    <xs:element name='TrackNumber' type='xs:integer'/>
+    <xs:element name='Duration' type='xs:integer'/>
+    <xs:element name='RecordedCountry' type='xs:NCName'/>
+    <xs:element name='RecordedYear' type='xs:integer'/>
+    <xs:element name='Contributors'>
+        <xs:complexType>
+            <xs:sequence>
+                <xs:element maxOccurs='unbounded' ref='Contributor'/>
+            </xs:sequence>
+        </xs:complexType>
+    </xs:element>
+    <xs:element name='Contributor'>
+        <xs:complexType>
+            <xs:sequence>
+                <xs:element ref='Name'/>
+                <xs:element ref='Role'/>
+                <xs:element ref='Instrument'/>
+            </xs:sequence>
+          	<xs:attribute name="credited" type="xs:boolean" />
+        </xs:complexType>
+    </xs:element>
+    <xs:element name='Name' type='xs:string'/>
+    <xs:element name='Role' type='xs:NCName'/>
+    <xs:element name='Instrument' type='xs:NCName'/>
+    <xs:element name='Title' type='xs:string'/>
+    <xs:element name='Artist' type='xs:string'/>
+    <xs:element name='Label' type='xs:string'/>
+    <xs:element name='Company' type='xs:string'/>
+    <xs:element name='CompanyCountry' type='xs:NCName'/>
+    <xs:element name='ReleaseDate' type='xs:NMTOKEN'/>
+</xs:schema>

data/spec/xsd_reader_spec.rb

@@ -44,7 +44,7 @@ describe XsdReader do
   end
 
   describe "#all_elements" do
-    it "includes elements from linked complex types fmor an imported schema" do
+    it "includes elements from linked complex types from an imported schema" do
       el = v32['NewReleaseMessage']['CollectionList']['Collection']['Title']
       expect(el.all_elements.map(&:name)).to eq ['TitleText', 'SubTitle']
     end
@@ -192,4 +192,82 @@ describe XsdReader do
       expect(el.complex_type).to be ct
     end
   end
+
+  describe "referenced elements" do
+    let(:reader){
+      XsdReader::XML.new(:xsd_file => File.expand_path('examples/referencing.xsd', File.dirname(__FILE__)))
+    }
+
+    let(:element){
+      reader['Album', 'Tracks', 'Track', 'Contributors', 'Contributor']
+    }
+
+    describe '#referenced_element' do
+      it 'gives the referenced element' do
+        expect(element.referenced_element.class).to eq XsdReader::Element
+        expect(element.referenced_element.name).to eq 'Contributor'
+        expect(element.referenced_element).to_not eq element
+      end
+    end
+
+    describe '#elements' do
+      it "gives alements of the referenced element" do
+        expect(element.elements.map(&:name)).to eq ['Name', 'Role', 'Instrument']
+      end
+    end
+
+    describe '#attributes' do
+      it "gives the attributes of the referenced element" do
+        expect(element.attributes.map(&:name)).to eq ['credited']
+      end
+    end
+
+    describe '#[]' do
+      it "lets the caller acces elements of the referenced element" do
+        expect(element['Role'].type).to eq 'xs:NCName'
+      end
+
+      it "lets the caller access attributes of the referened element" do
+        expect(element['@credited'].type).to eq 'xs:boolean'
+      end
+    end
+
+    describe '#name' do
+      it "gives the name of the referenced element" do
+        expect(element.name).to eq 'Contributor'
+      end
+    end
+
+    describe '#type' do
+      it "gives the type of the referenced element" do
+        expect(element.type).to eq nil
+        expect(reader['Album', 'Source'].type).to eq 'xs:string'
+      end
+    end
+
+    describe '#complex_type' do
+      it "gives the complex type object of the referenced element" do
+        expect(element.complex_type.sequences.first.elements.map(&:name)).to eq ['Name', 'Role', 'Instrument']
+      end
+    end
+
+    describe '#simple_contents' do
+      it "it includes the referenced element's simple content objects" do
+        skip 'not yet implemented'
+      end
+    end
+
+    describe '#complex_contents' do
+      it "it includes the referenced element's complex content objects" do
+        skip 'not yet implemented'
+      end
+    end
+
+    describe '#extensions' do
+      it "it includes the referenced element's extension objects" do
+        skip 'not yet implemented'
+      end
+    end
+    
+  end
 end

data/xsd-reader.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "xsd-reader"
-  s.version = '0.2.0'
+  s.version = '0.3.0'
   s.files = `git ls-files`.split($/)
   s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xsd-reader
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Mark van de Korput
@@ -103,6 +103,7 @@ files:
 - spec/examples/ddex-v32/iso639a2.xsd
 - spec/examples/ddex-v36/avs.xsd
 - spec/examples/ddex-v36/ddex-ern-v36.xsd
+- spec/examples/referencing.xsd
 - spec/extension_spec.rb
 - spec/import_spec.rb
 - spec/schema_spec.rb