xsd_model 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 804d3f69f695bf3916304c9da3b0d8c443353b0e
-  data.tar.gz: e2370ef66bf2977e7dc4be65f01fe5b9010efd5d
+SHA256:
+  metadata.gz: 78eefc3199301e8ff68c5f5c02b79a8f37fbd9470e3d03caceaa8413e80b79e4
+  data.tar.gz: cf94bd3c8e147022aec2adff305a7f9d5ebd89866cb14d43251e6fb1cabea8af
 SHA512:
-  metadata.gz: 1d0eb4bf82bba8439bfa36f847572a092f9dba3ecf449eeb697a6b28ea5a9dae7ca81dd711172eabdc7fc95062d1c2b7db9a7e2c4dd7291877b17b909e9c702d
-  data.tar.gz: 66748ca9aa4cbe7218d5f95ec658495b1fdb5a5bf38889369e7b0df923f0d570804ee5734a1be0db59512311102892ba336e479deef28403f30445aa2bec592a
+  metadata.gz: 45afad446b42ebac359a2094bacba94e6ff44f977884e37421ce512f4787e9fab0d11597cc85ed275df4f96a3b707cf856b868f14b7b94478544cf675326e0c8
+  data.tar.gz: e35713ed455f837308d74297ed294b30dfb251b6d607267c173552a0a6045c6ee261208f417cf01fb1183b5a7447589b1851923080af7a60d6152bed1f09d32d

data/README.md

@@ -1,20 +1,74 @@
 # XsdModel [![Build Status](https://travis-ci.org/Masa331/xsd_model.svg?branch=master)](https://travis-ci.org/Masa331/xsd_model)
 
-*Note that this can be unstable until 1.0.0*
-
-Takes a XSD string and parses it into a tree structure of nodes. A lot similar to Nokogiri but with few more useful methods.
+Schema Definition (XSD) parser.
 
 Content:
 1. [About](#about)
-2. [Api](#api)
+2. [Usage](#usage)
 5. [License](#license)
 
 ## About
 
-This gem provides a parser which takes XSD in a string and outputs tree structure of objects much like Nokogiri(which is internally used for parsing) does with XML. Each returned object represents one specific XSD core element and implements specific API to simplify the work with XSD. As it's written under the top heading, the API can be unstable until 1.0.0 and might miss some core XSD elements, attribute accessors, etc.
+XsdModel parses a XML Schema Definition (XSD) and returns tree structure of objects representing XSD nodes. Each object implements specific API simplify the work with XSD.
+
+## Usage
+
+### Basics
+
+Suppose you have following schema in a schema.xsd file:
+```
+<?xml version="1.0"?>
+<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
+
+<xs:element name="note">
+  <xs:complexType>
+    <xs:sequence>
+      <xs:element name="to" type="xs:string"/>
+      <xs:element name="from" type="xs:string"/>
+      <xs:element name="heading" type="xs:string"/>
+      <xs:element name="body" type="xs:string"/>
+    </xs:sequence>
+  </xs:complexType>
+</xs:element>
+
+</xs:schema>
+```
 
-## Api
+To parse it:
+```
+require('xsd_model')
+raw = File.read('schema.xsd')
+xsd = XsdModel.parse(raw)
+#=> #<XsdModel::Elements::Document:0x000056471a3b7cb8
+#@children=
+# [#<XsdModel::Elements::Schema:0x000056471a4659a8
+#   @children=
+#    [#<XsdModel::Elements::Text:0x000056471a4307d0>,
+#     #<XsdModel::Elements::Element:0x000056471a400dc8
+#      @children=
+#       [#<XsdModel::Elements::Text:0x000056471a3b3898>,
+#        #<XsdModel::Elements::ComplexType:0x000056471a403668
+#         @children=
+#          [#<XsdModel::Elements::Text:0x000056471a3b2a10>,
+#           #<XsdModel::Elements::Sequence:0x000056471a3d8ff8
+#            @children=
+#             [#<XsdModel::Elements::Text:0x000056471a3b19f8>,
+#              #<XsdModel::Elements::Element:0x000056471a3b0cd8>,
+#              #<XsdModel::Elements::Text:0x000056471a3c71b8>,
+#              #<XsdModel::Elements::Element:0x000056471a3c62b8>,
+#              #<XsdModel::Elements::Text:0x000056471a3c54f8>,
+#              #<XsdModel::Elements::Element:0x000056471a3c47b0>,
+#              #<XsdModel::Elements::Text:0x000056471a3dbaa0>,
+#              #<XsdModel::Elements::Element:0x000056471a3da830>,
+#              #<XsdModel::Elements::Text:0x000056471a3d9930>]>,
+#           #<XsdModel::Elements::Text:0x000056471a403cf8>]>,
+#        #<XsdModel::Elements::Text:0x000056471a4014a8>]>,
+#     #<XsdModel::Elements::Text:0x000056471a4660b0>],
+#   >],
+#>
+```
 
+### TODO
 * basic parsing
 * ignore option
 * collect only option

data/lib/xsd_model/elements/base_element.rb

@@ -9,15 +9,14 @@ module XsdModel
 
       XSD_URI = 'http://www.w3.org/2001/XMLSchema'
 
-      attr_accessor :children, :attributes, :namespaces
+      attr_accessor :children, :attributes, :namespaces, :css_path
       attribute_method :name, :type, :ref
 
-      def initialize(*args)
-        hashes, rest = args.partition { |arg| arg.is_a? Hash }
-
-        @children = rest.flatten
-        @attributes = hashes[0] || {}
-        @namespaces = hashes[1] || {}
+      def initialize(*args, attributes: {}, namespaces: {}, css_path: '')
+        @children = args.flatten
+        @attributes = attributes
+        @namespaces = namespaces
+        @css_path = css_path
       end
 
       def xmlns_prefix

data/lib/xsd_model/elements/import.rb

@@ -10,7 +10,9 @@ module XsdModel
       def load(options = {})
         xml_string = File.read(schema_location)
 
-        XsdModel.parse(xml_string, options).schema
+        schema = XsdModel.parse(xml_string, options).schema
+        schema.source = schema_location
+        schema
       end
     end
   end

data/lib/xsd_model/elements/include.rb

@@ -10,7 +10,9 @@ module XsdModel
       def load(options = {})
         xml_string = File.read(schema_location)
 
-        XsdModel.parse(xml_string, options).schema
+        schema = XsdModel.parse(xml_string, options).schema
+        schema.source = schema_location
+        schema
       end
     end
   end

data/lib/xsd_model/elements/schema.rb

@@ -4,8 +4,14 @@ module XsdModel
       include BaseElement
       extend AttributeMethods
 
+      attr_accessor :source
       attribute_method 'targetNamespace'
 
+      def initialize(*args, attributes: {}, namespaces: {}, css_path: '')
+        super
+        @source = '(initial)'
+      end
+
       def collect_imported_schemas(options = {})
         _collect_imported_schemas(self, options)
       end

data/lib/xsd_model/parser.rb

@@ -29,7 +29,7 @@ module XsdModel
       attributes = node.attributes.transform_values(&:value)
       namespaces = node.namespaces
 
-      klass.new(children, attributes, namespaces)
+      klass.new(children, attributes: attributes, namespaces: namespaces, css_path: node.css_path)
     end
 
     def collect_children(node)

data/xsd_model.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'xsd_model'
-  spec.version       = '0.6.0'
+  spec.version       = '0.7.0'
   spec.authors       = ['Premysl Donat']
   spec.email         = ['pdonat@seznam.cz']
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xsd_model
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Premysl Donat
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-11 00:00:00.000000000 Z
+date: 2019-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -182,8 +182,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: XSD parser