xsd-reader 0.0.1

data/spec/schema_spec.rb

@@ -0,0 +1,17 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe XsdReader do
+  before :all do
+    @reader ||= XsdReader::XML.new(:xsd_file => File.expand_path(File.join(File.dirname(__FILE__), 'examples', 'ddex-ern-v36.xsd')))
+  end
+
+  describe XsdReader::Schema do
+    before :each do
+      @schema = @reader.schema
+    end
+
+    it "gives a element readers" do
+      expect(@schema.elements.map(&:class)).to eq [XsdReader::Element]*2
+    end
+  end
+end # describe XsdReader

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+# 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_reader'
+require 'byebug'

data/spec/xml_spec.rb

@@ -0,0 +1,24 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe XsdReader do
+
+  before :all do
+    @reader ||= XsdReader::XML.new(:xsd_file => File.expand_path(File.join(File.dirname(__FILE__), 'examples', 'ddex-ern-v36.xsd')))
+  end
+
+  describe XsdReader::XML do
+    it "gives a schema_node" do
+      expect(@reader.schema_node.name).to eq 'schema'
+      expect(@reader.schema_node.namespaces).to eq({"xmlns:xs"=>"http://www.w3.org/2001/XMLSchema", "xmlns:ern"=>"http://ddex.net/xml/ern/36", "xmlns:avs"=>"http://ddex.net/xml/avs/avs"})
+    end
+
+    it "gives a schema reader" do
+      expect(@reader.schema.class).to eq XsdReader::Schema
+    end
+
+    it "gives an elements shortcut to its schema's shortcuts" do
+      expect(@reader.elements.map(&:name)).to eq @reader.schema.elements.map(&:name)
+    end
+  end
+
+end # describe XsdReader

data/spec/xsd_reader_spec.rb

@@ -0,0 +1,62 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe XsdReader do
+
+  before :all do
+    @reader ||= XsdReader::XML.new(:xsd_file => File.expand_path(File.join(File.dirname(__FILE__), 'examples', 'ddex-ern-v36.xsd')))
+  end
+
+  it "gives all child element definitions for a certain node through the `elements` method" do
+    expect(@reader.elements.map(&:name)).to eq ['NewReleaseMessage', 'CatalogListMessage']
+    expect(@reader.elements[0].elements[0].name).to eq 'MessageHeader'
+  end
+
+  it "gives a child element object through the square brackets ([]) operator (matching by name)" do
+    expect(@reader['NewReleaseMessage'].name).to eq 'NewReleaseMessage'
+    # this supports linking:
+    expect(@reader['NewReleaseMessage']['ReleaseList']['Release'].attributes.map(&:name)).to eq ["LanguageAndScriptCode", "IsMainRelease"]
+  end
+
+  it "gives a specific element in the hierarchy when passing an array argument to the square brackets ([]) operator" do
+    # this supports linking:
+    expect(@reader[['NewReleaseMessage', 'ResourceList', 'SoundRecording']].name).to eq 'SoundRecording'
+    expect(@reader[['NewReleaseMessage', 'ResourceList', 'SoundRecording']].multiple_allowed?).to eq true
+  end
+
+  it "provides a `child_elements?` convenience method" do
+    expect(@reader['NewReleaseMessage'].child_elements?).to be true
+    expect(@reader['NewReleaseMessage']['MessageHeader']['MessageThreadId'].child_elements?).to be false
+  end
+
+  it "provides `min_occurs` and `max_occurs` reader methods" do
+    expect(@reader['NewReleaseMessage']['ResourceList'].min_occurs).to eq nil
+    expect(@reader['NewReleaseMessage']['ResourceList']['SoundRecording'].min_occurs).to eq 0
+    expect(@reader['NewReleaseMessage']['ResourceList']['SoundRecording'].max_occurs).to eq :unbounded
+  end
+
+  it "provides a boolean `multiple_allowed?` method, indicating if multiple instances of this element are allowed" do
+    # byebug
+    expect(@reader['NewReleaseMessage']['ResourceList'].multiple_allowed?).to be false
+    expect(@reader['NewReleaseMessage']['ResourceList']['SoundRecording'].multiple_allowed?).to be true
+  end
+
+  it "provides a `required?` method, indicating if an element is required to be there" do
+    expect(@reader['NewReleaseMessage'].required?).to be true
+    expect(@reader['NewReleaseMessage']['ResourceList'].required?).to be true
+    expect(@reader['NewReleaseMessage']['CollectionList'].required?).to be false
+  end
+
+  it "provides an `optional?` convenience method, as an opposite of `required?`" do
+    expect(@reader['NewReleaseMessage'].optional?).to be false
+    expect(@reader['NewReleaseMessage']['ResourceList'].optional?).to be false
+    expect(@reader['NewReleaseMessage']['CollectionList'].optional?).to be true
+  end
+
+  # it "gives an array recursive parent names `ancestors` method" do
+  #   skip 'Not yet (properly) imlemented'
+  #   # byebug
+  #   expect(@reader.ancestors).to eq []
+  #   expect(@reader['NewReleaseMessage'].ancestors).to eq []
+  #   expect(@reader['NewReleaseMessage']['DealList']['ReleaseDeal'].ancestors.map(&:name)).to eq ['NewReleasMessage', 'DealList']
+  # end
+end

data/xsd-reader.gemspec

@@ -0,0 +1,20 @@
+GEM_NAME="xsd-reader"
+PKG_VERSION='0.0.1'
+
+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 'nokogiri'
+  s.add_development_dependency 'rspec'
+
+  s.author = "Mark van de Korput"
+  s.email = "dr.theman@gmail.com"
+  s.date = '2015-07-05'
+  s.description = %q{A library of Ruby classes for quick and convenient usage of xsd schemas}
+  s.summary = %q{A library of Ruby classes for flexible access of xsd schemas}
+  s.homepage = %q{https://github.com/markkorput/xsd-reader}
+  s.license = "MIT"
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: xsd-reader
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mark van de Korput
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A library of Ruby classes for quick and convenient usage of xsd schemas
+email: dr.theman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/xsd_reader.rb
+- lib/xsd_reader/attribute.rb
+- lib/xsd_reader/choice.rb
+- lib/xsd_reader/complex_type.rb
+- lib/xsd_reader/element.rb
+- lib/xsd_reader/extension.rb
+- lib/xsd_reader/schema.rb
+- lib/xsd_reader/sequence.rb
+- lib/xsd_reader/shared.rb
+- lib/xsd_reader/simple_content.rb
+- lib/xsd_reader/xml.rb
+- spec/attribute_spec.rb
+- spec/element_spec.rb
+- spec/examples/ddex-ern-v36.xsd
+- spec/schema_spec.rb
+- spec/spec_helper.rb
+- spec/xml_spec.rb
+- spec/xsd_reader_spec.rb
+- xsd-reader.gemspec
+homepage: https://github.com/markkorput/xsd-reader
+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 library of Ruby classes for flexible access of xsd schemas
+test_files: []