xsd-populator 0.1.0

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+# loads and runs all tests for the rxsd project
+#
+# Copyright (C) 2010 Mohammed Morsi <movitto@yahoo.com>
+# Licensed under the AGPLv3+ http://www.gnu.org/licenses/agpl.txt
+
+require 'rspec'
+
+CURRENT_DIR=File.dirname(__FILE__)
+$: << File.expand_path(CURRENT_DIR + "/../lib")
+
+require 'xsd_populator'
+require 'byebug'
+require 'nokogiri'

data/spec/xsd_explanation_provider_spec.rb

@@ -0,0 +1,44 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require 'xsd_explanation_provider'
+
+describe XsdExplanationProvider do
+  let(:logger){
+    logger = Logger.new(STDOUT)
+    logger.level = Logger::WARN
+    logger
+  }
+
+  let(:populator){
+    XsdPopulator.new(:xsd_file => File.expand_path(File.join(File.dirname(__FILE__), 'examples', 'ddex-ern-v36.xsd')), :logger => logger)
+  }
+
+  let(:provider){
+    XsdExplanationProvider.new(:data => {:xsd_reader => populator.xsd_reader}, :logger => logger)
+  }
+
+  it "requires an xsd reader" do
+    msg = expect{ XsdExplanationProvider.new(:logger => logger).take(:something) }.to raise_error(RuntimeError, 'XsdExplanationProvider needs an xsd reader')
+  end
+
+  it "gives itself for complex elements" do
+    expect(provider.take('NewReleaseMessage')).to eq provider
+    expect(provider.take(['NewReleaseMessage', 'MessageHeader'])).to eq provider
+  end
+
+  it "gives the element type for simple elements" do
+    expect(provider.take(['NewReleaseMessage', 'MessageHeader', 'MessageId'])).to eq 'xs:string'
+  end
+
+  it "gives the attribute type for attributes" do
+    expect(provider.take(['NewReleaseMessage', 'MessageHeader', '@LanguageAndScriptCode'])).to eq 'xs:string'
+  end
+
+  it "is the default fallback provider for XsdPopulators without a specified provider" do
+    expect(populator.provider.class).to eq XsdExplanationProvider
+    xml = populator.populate_element(['NewReleaseMessage', 'MessageHeader', 'MessageSender'])
+    # puts xml
+    doc = Nokogiri.XML(xml)
+    expect(doc.at('/MessageSender/PartyId').text).to eq 'xs:string'
+    expect(doc.at('/MessageSender').attributes['LanguageAndScriptCode'].value).to eq 'xs:string'
+  end
+end # describe XsdExplanationProvider

data/spec/xsd_populator_spec.rb

@@ -0,0 +1,211 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe XsdPopulator do
+  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)
+  }
+
+  describe "#configure" do
+    it "lets you change the configuration options at runtime" do
+      expect(populator.xsd_reader).to eq xsd_reader
+      expect(populator.logger).to eq logger
+      expect(populator.options[:relative_provider]).to eq nil
+      # save current configuration
+      old_options = populator.options.merge(:relative_provider => nil)
+      # reconfigure with invalid data
+      populator.configure({:reader => :dummy, :logger => :lagger, :relative_provider => :absolutely})
+      # some assertion
+      expect(populator.xsd_reader).to eq :dummy
+      expect(populator.logger).to eq :lagger
+      expect(populator.options[:relative_provider]).to eq :absolutely
+      # restore configuration
+      populator.configure old_options
+      # verify 
+      expect(populator.xsd_reader).to eq xsd_reader
+      expect(populator.logger).to eq logger
+      expect(populator.options[:relative_provider]).to eq nil
+    end
+  end
+
+  describe "#uncache" do
+    it "lets you clear the populated_xml cache" do
+      # first create a dummy cache, because producing the full XML will take too much time
+      populator.instance_variable_set('@populated_xml', :dummy_value)
+      # verify the above instance variable is used to cache populaed_xml
+      expect(populator.populated_xml).to eq :dummy_value
+      # do it!
+      populator.uncache
+      # verify the cache instance var is clear
+      expect(populator.instance_variable_get('@populated_xml')).to eq nil
+    end
+  end
+
+  # # TAKES LONG
+  # it "should generate xml without data and include comments" do
+  #   expect(doc.root_node.name).to eq 'NewReleaseMessage'
+  # end
+
+  # # TAKES LONG
+  # it "writes to file" do
+  #   @populator.write_file(File.dirname(__FILE__) + '/examples/ddex-ern-v36.xml')
+  # end
+
+  # TAKES LONG
+  # it "it lets you specify a root-level element" do
+  #   populator = XsdPopulator.new(:xsd_reader => @populator.xsd_reader, :element => 'CatalogListMessage')
+  #   populator.write_file(File.dirname(__FILE__) + '/examples/ddex-ern-v36-CatalogListMessage2.xml')
+  # end
+end
+
+describe "XsdPopulator for partial layouts" do
+  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({
+      :element => ['NewReleaseMessage', 'MessageHeader'],
+      :reader=> xsd_reader,
+      :logger => logger,
+      :strategy => :complete
+    })
+  }
+
+  it "lets you specify any specific element as root element at initialization" do
+    doc = Nokogiri.XML(populator.populated_xml)
+    expect(doc.root.name).to eq 'MessageHeader'
+    expect(doc.root.element_children.map(&:name)).to eq ["MessageThreadId", "MessageId", "MessageFileName", "MessageSender", "SentOnBehalfOf", "MessageRecipient", "MessageCreatedDateTime", "MessageAuditTrail", "Comment", "MessageControlType"]
+    expect(doc.root.at('MessageSender').at('PartyName').at('FullName').attributes['LanguageAndScriptCode'].value).to eq "xs:string"
+    expect(doc.root.at('MessageSender').at('PartyName').at('FullNameAsciiTranscribed').attributes).to eq({})
+  end
+
+  it "lets you specify any specific element to populate" do
+    xml = populator.populate_element([:NewReleaseMessage, :MessageHeader, :MessageSender])
+    doc = Nokogiri.XML(xml)
+    expect(doc.root.name).to eq 'MessageSender'
+    expect(doc.root.element_children.map(&:name)).to eq ['PartyId', 'PartyName', 'TradingName']
+  end
+
+  describe ':relative_provider options' do
+    class RelativeProviderTester
+      include DataProvider::Base
+
+      provides({
+        # for default/full stsack strategy
+        ['NewReleaseMessage', 'MessageHeader', 'MessageId'] => 'Full ID',
+        # for :relative_provider => true strategies with MessageHeader as root element
+        ['MessageHeader', 'MessageId'] => 'Relative Version1',
+        # for :relative_provider => true strategies with MessageId as root element
+        ['MessageId'] => 'Relative Version2'
+      })
+    end
+
+    it "by default uses the full stack for provider ids" do
+      populator.configure(:provider => RelativeProviderTester.new)
+      expect(Nokogiri.XML(populator.populated_xml).at('/MessageHeader/MessageId').text).to eq 'Full ID'
+      expect(Nokogiri.XML(populator.populate_element(['NewReleaseMessage', 'MessageHeader', 'MessageId'])).at('/MessageId').text).to eq 'Full ID'
+    end
+
+    it "uses 'relative' provider ids when the :relative_provider option is true" do
+      populator.configure(:provider => RelativeProviderTester.new, :relative_provider => true)
+      # MessageHeader is root element
+      expect(Nokogiri.XML(populator.populated_xml).at('/MessageHeader/MessageId').text).to eq 'Relative Version1'
+      # MessageId is root element
+      expect(Nokogiri.XML(populator.populate_element(['NewReleaseMessage', 'MessageHeader', 'MessageId'])).at('/MessageId').text).to eq 'Relative Version2'
+    end
+  end
+
+  describe XsdPopulator::ElementNotFoundException do
+    it 'is thrown when a specified root element cannot be found' do
+      expect{ populator.populate_element('InvalidNode') }.to raise_error(XsdPopulator::ElementNotFoundException)
+      pop = XsdPopulator.new(:xsd_reader => xsd_reader, :element => ['NewReleaseMessage', 'Foo'], :logger => logger)
+      expect{pop.populated_xml}.to raise_error(XsdPopulator::ElementNotFoundException)
+    end
+  end
+
+  describe :strategy do
+    class StrategyProvider
+      include DataProvider::Base
+
+      provides({
+        ['NewReleaseMessage', 'DealList', 'ReleaseDeal'] => 'Invalid value; ReleaseDeal is a complex node with child-nodes, it should get a DataProvider, not a string',
+        ['NewReleaseMessage', 'ReleaseList'] => 'Invalid again',
+        ['NewReleaseMessage', 'ResourceList'] => StrategyProvider.new,
+        ['NewReleaseMessage', 'WorkList', 'MusicalWork', 'MusicalWorkId'] => lambda{ [StrategyProvider.new] * 3 },
+        ['NewReleaseMessage', 'MessageHeader', 'SentOnBehalfOf', '@LanguageAndScriptCode'] => 'UK'
+      })
+    end
+
+    let(:populator){
+      XsdPopulator.new({
+        # :element => ['NewReleaseMessage', 'MessageHeader'], # We're going for 'FULL' render this time 
+        :reader => xsd_reader,
+        :provider => StrategyProvider.new,
+        :logger => logger
+      })
+    }
+
+    it "defaults to the :smart strategy which doesn't add nodes for which no (valid) data is provided, unless there are providers available for any its offspring nodes" do
+      xml = populator.populated_xml
+      doc = Nokogiri.XML(xml)
+      # There's a provider available for ReleaseDeal, an offspring of DealList, and
+      # even though it will return invalid data, it will still cause the DealList node to be created
+      expect(doc.search("/NewReleaseMessage/DealList").length).to eq 1
+      expect(doc.search("/NewReleaseMessage/DealList/ReleaseDeal").length).to eq 0
+      # There is a provider for ReleaseList itself, but it returns invalid data; it will not be created
+      expect(doc.search("/NewReleaseMessage/ReleaseList").length).to eq 0
+      # There is a provider with valid data (a DataProvider object) for ResourceList, it will be created
+      expect(doc.search("/NewReleaseMessage/ResourceList").length).to eq 1
+      # There is no data provider for WorkList, but there is for one of it descendents so it's created
+      expect(doc.search("/NewReleaseMessage/WorkList").length).to eq 1
+      # for MusicalWorkId multiple data providers are provided,
+      # so multiple nodes will be created. All of them will be empty though...
+      expect(doc.search("/NewReleaseMessage/WorkList/MusicalWork/MusicalWorkId").map{|mw| mw.element_children.length}).to eq [0]*3
+    end
+
+    it "adds empty simple nodes when :strategy is :all_simple_elements" do
+      populator.configure(:strategy => :nil_to_empty)
+      doc = Nokogiri.XML(xml = populator.populated_xml)
+      expect(doc.search("/NewReleaseMessage/DealList").length).to eq 1 # jsut like 
+      expect(doc.search("/NewReleaseMessage/DealList/ReleaseDeal").length).to eq 0
+      expect(doc.search("/NewReleaseMessage/ReleaseList").length).to eq 0
+      expect(doc.search("/NewReleaseMessage/ResourceList").length).to eq 1
+      expect(doc.search("/NewReleaseMessage/WorkList").length).to eq 1
+      expect(doc.search("/NewReleaseMessage/WorkList/MusicalWork/MusicalWorkId").map{|mw| mw.element_children.length}).to eq [4]*3
+    end
+
+    it "builds all the nodes it can find if the :strategy option is set to :complete" do
+      populator.configure(:strategy => :complete, :element => ['NewReleaseMessage', 'WorkList'])
+      doc = Nokogiri.XML(xml = populator.populated_xml)
+      expect(doc.search("/WorkList").length).to eq 1
+      expect(doc.search("/WorkList/MusicalWork/MusicalWorkId").map{|n| n.search("./ISWC").length}).to eq [1]*3
+    end
+
+    it "by default doesn't add provider-less attributes" do
+      xml = populator.populated_xml
+      doc = Nokogiri.XML(xml)
+      expect(doc.at("/NewReleaseMessage").attributes['MessageSchemaVersionId'].value).to eq '' # required attribute
+      expect(doc.at("/NewReleaseMessage").attributes['ReleaseProfileVersionId']).to eq nil
+      expect(doc.at("/NewReleaseMessage").attributes['LanguageAndScriptCode']).to eq nil
+      expect(doc.at("/NewReleaseMessage").attributes['LanguageAndScriptCode']).to eq nil
+      expect(doc.at("/NewReleaseMessage/MessageHeader").attributes['LanguageAndScriptCode']).to eq nil
+      expect(doc.at("/NewReleaseMessage/MessageHeader/SentOnBehalfOf").attributes['LanguageAndScriptCode'].value).to eq 'UK'
+    end
+  end
+end

data/xsd-populator.gemspec

@@ -0,0 +1,24 @@
+GEM_NAME="xsd-populator"
+PKG_VERSION='0.1.0'
+
+Gem::Specification.new do |s|
+  s.name = GEM_NAME
+  s.version = PKG_VERSION
+  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_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.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.homepage = %q{https://github.com/markkorput/xsd-populator}
+  s.license = "MIT"
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: xsd-populator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mark van de Korput
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: xsd-reader
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: data-provider
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: A library of Ruby classes for generating XML data from XSD schemas (Data
+  providers)
+email: dr.theman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/ddex_provider.rb
+- lib/xsd_explanation_provider.rb
+- lib/xsd_populator.rb
+- spec/ddex_spec.rb
+- spec/examples/MessageHeader.xml
+- spec/examples/avs.xsd
+- spec/examples/ddex-ern-v36-CatalogListMessage.xml
+- spec/examples/ddex-ern-v36-MessageHeader.xml
+- spec/examples/ddex-ern-v36-NewReleaseMessage.xml
+- spec/examples/ddex-ern-v36.xsd
+- spec/spec_helper.rb
+- spec/xsd_explanation_provider_spec.rb
+- spec/xsd_populator_spec.rb
+- xsd-populator.gemspec
+homepage: https://github.com/markkorput/xsd-populator
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A Ruby gem to build XML data from XSD schemas
+test_files: []