xsd-populator 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a1fbb89bcd1d5fe7c9625230958c20b87d5b342c
-  data.tar.gz: 8a73b16dcb2de6df15f5f39a7c31e7a748f01343
+  metadata.gz: f2eda4c1222169e40bd22cd1ec39960cefd5a38b
+  data.tar.gz: 41bc1605eaa36e836aacfbae731f34752c1ece56
 SHA512:
-  metadata.gz: ddf9a33da6ed9f56877f073f620cfa40d67a619e89b84070f77dfb25074c36af12b040842bbd997cdc09668c4cdeb6245a7b3931c29f137bdbfd2110581aa8e3
-  data.tar.gz: ffd6b497de51f6cda4af3e8f2d6597961cc686db808ce559ba26617fa3dd7599e68a95492ab30c80ce81751290ca9deb6c2a18fd2f35e1f6b62529c2a9a1962e
+  metadata.gz: 269167d81605c0f996e2bba757b59dcf71f77e65b08c1c27f162b6d061b7945302e1052368fb71be19b20ae906b2b7507c964c7af0f3e6448f34982bc5b4f167
+  data.tar.gz: 7c13c2ddfb4ec11213427ab6bf7d91a91c5ac725062f13ab4c27f20f19ec99af2a4581f7c3059058808bb59f9e71ad6eb8f8d9ea5528d118e3fc54e7ec7e0d48

data/Gemfile.lock

@@ -1,22 +1,22 @@
 PATH
   remote: .
   specs:
-    xsd-populator (0.0.1)
-      builder
-      data-provider (>= 0.0.1)
-      xsd-reader (>= 0.0.1)
+    xsd-populator (0.2.0)
+      builder (~> 3.2)
+      data-provider (~> 0.2)
+      xsd-reader (~> 0.2)
 
 PATH
   remote: /srv/data-provider
   specs:
-    data-provider (0.0.1)
+    data-provider (0.2.0)
 
 PATH
   remote: /srv/xsd-reader
   specs:
-    xsd-reader (0.1.0)
-      nokogiri
-      rest-client
+    xsd-reader (0.2.0)
+      nokogiri (~> 1.6)
+      rest-client (~> 1.8)
 
 GEM
   remote: https://rubygems.org/
@@ -60,10 +60,10 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  byebug
+  byebug (~> 5.0)
   data-provider!
-  nokogiri
-  rspec
+  nokogiri (~> 1.6)
+  rspec (~> 3.3)
   xsd-populator!
   xsd-reader!
 

data/lib/xsd_populator.rb

@@ -8,6 +8,27 @@ class XsdPopulator
   class ElementNotFoundException < Exception
   end
 
+  class Informer
+    attr_reader :options
+
+    def initialize(_opts = {})
+      @options = _opts || {}
+    end
+
+    def skip?
+      options[:skip] == true
+    end
+
+    def attributes
+      options[:attributes] || {}
+    end
+
+    def namespace
+      options[:namespace]
+    end
+  end # class Informer
+
+
   attr_reader :options
 
   def initialize(_opts = {})
@@ -19,7 +40,7 @@ class XsdPopulator
     # remove some cached values
     @logger = nil if _opts[:logger]
     @xsd_reader = nil if _opts[:xsd_reader] || _opts[:reader]
-    uncache if _opts[:strategy]
+    uncache if (_opts.keys & [:strategy,:element,:xsd_file,:xsd,:xsd_reader,:reader,:provider,:data_provider]).length > 0
   end
 
   def uncache
@@ -64,6 +85,10 @@ class XsdPopulator
     File.write(path, populated_xml)
   end
 
+  def max_recursion
+    options[:max_recursion] || 3
+  end
+
   private
 
   def populate_xml(element_specifier = nil)
@@ -82,11 +107,15 @@ class XsdPopulator
     return xml.target!
   end
 
+  def stack_recursion_count(stack = [])
+    stack.select{|el| el == stack.last}.length - 1
+  end
+
   def build_element(xml, element, provider = self.provider, stack = [])
     # TODO; more sophisticated recursion detection;
     # multiple elements of the same name should be able
     # to occur insid the stack
-    if stack.include?(element.name)
+    if stack_recursion_count(stack + [element.name]) > max_recursion
       logger.warn("XsdPopulator#build_element aborting because of potential endless recursion\n - Current element: #{element.name}\n - stack: #{stack.inspect}")
       return
     end
@@ -97,7 +126,7 @@ class XsdPopulator
     # get node content data from provider
     content_data = provider.nil? ? nil : provider.try_take(stack + [element.name])
     # get attributes content from the provider
-    attributes_data_hash = attributes_data_hash_for(element, provider, stack)
+    attributes_data_hash = nil
 
     if explain_xml? && element.multiple_allowed?
       xml.comment!("Multiple instances of #{element.name} allowed here")
@@ -114,10 +143,17 @@ class XsdPopulator
     # NOTE: this doesn't array-values for single elements, which we don't support (would be turned into a string anway)
 
     content_data.each_with_index do |node_content, idx|
-      # let's see if the provided data is good for building this node, accoridng to the current strategy
+      # let's see if the provided data is good for building this node, according to the current strategy
       next if !build?(element, provider, stack, :content => node_content)
 
-      attributes_hash = attributes_hash_for_index(attributes_data_hash, idx)
+      # value for current element is a content provider?
+      if node_content.respond_to?(:try_take)
+        attributes_hash = attributes_for(element, node_content.respond_to?(:take) ? node_content : provider, stack)
+      else
+        attributes_data_hash ||= attributes_data_hash_for(element, provider, stack)
+        attributes_hash = attributes_hash_for_index(attributes_data_hash, idx)
+        attributes_hash = node_content.attributes.merge(attributes_hash) if node_content.is_a?(Informer) && node_content.attributes.length > 0
+      end
 
       # simple node; name, value, attributes
       if !element.child_elements?
@@ -126,16 +162,23 @@ class XsdPopulator
       end
 
       # complex node
+      child_provider = provider
+
       if node_content.respond_to?(:try_take)
         child_provider = node_content
-      else
-        logger.warn "Got non-nil and non-provider value for element with child elements (value: #{node_content}, element: #{element.name}, stack: #{stack.inspect})" if node_content
+      elsif !node_content.is_a?(Informer)
+        logger.warn "Got non-nil, non-provider and non-infomer value for element with child elements (value: #{node_content}, element: #{element.name}, stack: #{stack.inspect})" if node_content
         # strategy dictates to continue; just use the current element's provider for its children
-        child_provider = provider
       end
 
       # create complex node
-      xml.tag!(element.name, attributes_hash) do
+      node_name = element.name
+
+      if node_content.is_a?(Informer) && node_content.namespace.to_s.length > 0
+        node_name = "#{node_content.namespace}:#{node_name}"
+      end
+
+      xml.tag!(node_name, attributes_hash) do
         # loop over all child node definitions
         element.elements.each do |child|
           # this method call itself recursively for every child node definition of the current element
@@ -182,6 +225,17 @@ class XsdPopulator
     end
   end
 
+  def attributes_for(element, provider, stack)
+    element.attributes.inject({}) do |result, attribute|
+      attribute_data = provider.nil? ? nil : provider.try_take(stack + [element.name, "@#{attribute.name}"])  
+      # attribute_data ||= attribute.type if provider.nil? # assume demo xml
+      if add_attribute?(attribute, provider, stack, :content => attribute_data)
+        result.merge(attribute.name => attribute_data)
+      else
+        result
+      end
+    end
+  end
 
   #
   # Root element
@@ -242,6 +296,9 @@ class XsdPopulator
   def build?(element, provider, stack, opts = {})
     content = opts[:content] || provider.try_take([stack, element.name].flatten.compact)
 
+    # we got an Informer object that tells us explicitly to skip this node? Yes sir.
+    return false if content.is_a?(Informer) && content.skip?
+
     # For comlex nodes we need either;
     # - a data provider or
     # - explicit confirmation to build without providers or

data/spec/xsd_populator_spec.rb

@@ -208,4 +208,123 @@ describe "XsdPopulator for partial layouts" do
       expect(doc.at("/NewReleaseMessage/MessageHeader/SentOnBehalfOf").attributes['LanguageAndScriptCode'].value).to eq 'UK'
     end
   end
+
+  describe 'flexible recursion protection' do
+    it 'allows a couple of repetitions by default' do
+      xml = populator.populate_element(['NewReleaseMessage', 'ResourceList', 'SoundRecording', 'SoundRecordingDetailsByTerritory', 'TechnicalSoundRecordingDetails', 'File'])
+      doc = Nokogiri.XML(xml)
+      expect(doc.at('/File/HashSum/HashSum')).to_not eq nil
+      expect(doc.at('/File/HashSum/HashSum').text).to eq 'xs:string'
+    end
+  end
+
+  describe 'provider data for attributes' do
+    class FileProvider
+      include DataProvider::Base
+
+      # returns two datap provider, each with custom data for the TitleType attribute provider
+      provider ['NewReleaseMessage', 'ResourceList', 'SoundRecording', 'SoundRecordingDetailsByTerritory', 'Title'] do
+        [
+          add_data(:title_type => 'typeA'),
+          add_data(:title_type => 'typeB')
+        ]
+      end
+
+      # the data provided by the above provider should be avialable in the provider below
+      provider ['NewReleaseMessage', 'ResourceList', 'SoundRecording', 'SoundRecordingDetailsByTerritory', 'Title', '@TitleType'] do
+        get_data(:title_type)
+      end
+    end
+
+    it "uses provided data for an element's attribute providers" do
+    populator
+      populator.configure(:provider => FileProvider.new)
+      xml = populator.populate_element(['NewReleaseMessage', 'ResourceList', 'SoundRecording', 'SoundRecordingDetailsByTerritory'])
+      doc = Nokogiri.XML(xml)
+      expect(doc.search('/SoundRecordingDetailsByTerritory/Title').length).to eq 2
+      expect(doc.search('/SoundRecordingDetailsByTerritory/Title').map{|node| node.attributes['TitleType'].value}).to eq ['typeA', 'typeB']
+    end
+  end
 end
+
+describe XsdPopulator::Informer do
+  class InformProvider
+    include DataProvider::Base
+
+    provides(['NewReleaseMessage', 'MessageHeader'] => XsdPopulator::Informer.new(:skip => true))
+    provides(['NewReleaseMessage', 'MessageHeader', 'MessageId'] => 123)
+  end
+
+  let(:xsd_reader){
+    XsdReader::XML.new(:xsd_file => File.expand_path(File.join(File.dirname(__FILE__), 'examples', 'ddex-ern-v36.xsd')))
+  }
+
+  let(:logger){
+    logger = Logger.new(STDOUT)
+    logger.level = Logger::WARN
+    logger    
+  }
+
+  let(:populator){
+    XsdPopulator.new({
+      :reader=> xsd_reader,
+      :logger => logger,
+      :provider => InformProvider.new
+    })
+  }
+
+  it "informs the populator to skip an element" do
+    expect(Nokogiri.XML(populator.populated_xml).at('/NewReleaseMessage/MessageHeader')).to eq nil
+  end
+
+  it "informs the populator to explicitly add a set of attributes to an element" do
+    provider_class = Class.new(Object) do
+      include DataProvider::Base
+
+      provider ['NewReleaseMessage', '@MessageSchemaVersionId']{ '2010/ern-main/32' }
+
+      provider ['NewReleaseMessage']{
+        XsdPopulator::Informer.new(:attributes => {
+          'xmlns:ern' => 'http://ddex.net/xml/2010/ern-main/32', 
+          'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance',
+          'xsi:schemaLocation' => 'http://ddex.net/xml/2010/ern-main/32 http://ddex.net/xml/2010/ern-main/32/ern-main.xsd'
+        })
+      }
+
+      provides(['NewReleaseMessage', 'MessageHeader', 'MessageId'] => 123)
+    end
+
+    populator = XsdPopulator.new({
+      :reader=> xsd_reader,
+      :logger => logger,
+      :provider => provider_class.new
+    })
+
+    el = Nokogiri.XML(populator.populated_xml).at('NewReleaseMessage')
+    expect(el.attributes['schemaLocation'].value).to eq 'http://ddex.net/xml/2010/ern-main/32 http://ddex.net/xml/2010/ern-main/32/ern-main.xsd'
+    expect(el.attributes['MessageSchemaVersionId'].value).to eq '2010/ern-main/32'
+    expect(el.attributes.keys.length).to eq 2
+
+    expect(el.namespace_definitions.map{|nsdef| [nsdef.prefix, nsdef.href]}.sort).to eq([
+      ['ern', 'http://ddex.net/xml/2010/ern-main/32'],
+      ['xsi', 'http://www.w3.org/2001/XMLSchema-instance']
+    ])
+  end
+
+  it "informs the populator to prefix a node with a namespace" do
+    provider_class = Class.new(Object) do
+      include DataProvider::Base
+
+      provider ['NewReleaseMessage']{ XsdPopulator::Informer.new(:namespace => 'ern') }
+      provides(['NewReleaseMessage', 'MessageHeader', 'MessageId'] => 123)
+    end
+
+    populator = XsdPopulator.new({
+      :reader=> xsd_reader,
+      :logger => logger,
+      :provider => provider_class.new
+    })
+
+    expect(Nokogiri.XML(populator.populated_xml).root.name).to eq 'ern:NewReleaseMessage'
+  end
+end

data/xsd-populator.gemspec

@@ -1,24 +1,21 @@
-GEM_NAME="xsd-populator"
-PKG_VERSION='0.1.0'
-
 Gem::Specification.new do |s|
-  s.name = GEM_NAME
-  s.version = PKG_VERSION
+  s.name = "xsd-populator"
+  s.version = '0.2.0'
   s.files = `git ls-files`.split($/)
   s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
 
   s.add_dependency 'builder', '~> 3.2'
-  s.add_dependency 'xsd-reader', '~> 0.1'
-  s.add_dependency 'data-provider', '~> 0.1'
+  s.add_dependency 'xsd-reader', '~> 0.2'
+  s.add_dependency 'data-provider', '~> 0.2'
   s.add_development_dependency 'nokogiri', '~> 1.6'
   s.add_development_dependency 'rspec', '~> 3.3'
   s.add_development_dependency 'byebug', '~> 5.0'
 
   s.author = "Mark van de Korput"
   s.email = "dr.theman@gmail.com"
-  s.date = '2015-07-14'
+  s.date = '2015-08-27'
   s.summary = %q{A Ruby gem to build XML data from XSD schemas}
-  s.description = %q{A library of Ruby classes for generating XML data from XSD schemas (Data providers)}
+  s.description = s.summary
   s.homepage = %q{https://github.com/markkorput/xsd-populator}
   s.license = "MIT"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xsd-populator
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Mark van de Korput
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-14 00:00:00.000000000 Z
+date: 2015-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -30,28 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: data-provider
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -94,8 +94,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
-description: A library of Ruby classes for generating XML data from XSD schemas (Data
-  providers)
+description: A Ruby gem to build XML data from XSD schemas
 email: dr.theman@gmail.com
 executables: []
 extensions: []