lutaml-xsd 0.1.0 → 1.0.1

data/lib/lutaml/xsd/schema.rb

@@ -0,0 +1,180 @@
+# frozen_string_literal: true
+
+module Lutaml
+  module Xsd
+    # rubocop:disable Metrics/ClassLength
+    class Schema < Model::Serializable
+      attribute :id, :string
+      attribute :lang, :string
+      attribute :xmlns, :string
+      attribute :version, :string
+      attribute :imported, :boolean
+      attribute :final_default, :string
+      attribute :block_default, :string
+      attribute :target_namespace, :string
+      attribute :element_form_default, :string
+      attribute :attribute_form_default, :string
+      attribute :imports, Import, collection: true
+      attribute :includes, Include, collection: true
+
+      attribute :group, Group, collection: true
+      attribute :import, Import, collection: true
+      attribute :element, Element, collection: true
+      attribute :include, Include, collection: true
+      attribute :notation, Notation, collection: true
+      attribute :redefine, Redefine, collection: true
+      attribute :attribute, Attribute, collection: true
+      attribute :annotation, Annotation, collection: true
+      attribute :simple_type, SimpleType, collection: true
+      attribute :complex_type, ComplexType, collection: true
+      attribute :attribute_group, AttributeGroup, collection: true
+
+      xml do
+        root "schema", mixed: true
+        namespace "http://www.w3.org/2001/XMLSchema", "xsd"
+
+        map_element :group, to: :group
+        map_element :element, to: :element
+        map_element :redefine, to: :redefine
+        map_element :notation, to: :notation
+        map_element :attribute, to: :attribute
+        map_element :annotation, to: :annotation
+        map_element :simpleType, to: :simple_type
+        map_element :complexType, to: :complex_type
+        map_element :attributeGroup, to: :attribute_group
+        map_element :import, to: :import, with: { from: :import_from_schema, to: :import_to_schema }
+        map_element :include, to: :include, with: { from: :include_from_schema, to: :include_to_schema }
+
+        map_attribute :attributeFormDefault, to: :attribute_form_default
+        map_attribute :elementFormDefault, to: :element_form_default
+        map_attribute :targetNamespace, to: :target_namespace
+        map_attribute :finalDefault, to: :final_default
+        map_attribute :blockDefault, to: :block_default
+        map_attribute :version, to: :version
+        map_attribute :id, to: :id
+        map_attribute :lang, to: :lang
+      end
+
+      def import_from_schema(model, value)
+        value.each do |schema|
+          setup_import_and_include("import", model, schema, namespace: schema["attributes"]["namespace"])
+        end
+      end
+
+      def import_to_schema(model, parent, _doc)
+        return if model.imported
+
+        model.imported = true
+        model.imports.each do |imported_schema|
+          parent.add_child(imported_schema.to_xml)
+        end
+      end
+
+      def include_from_schema(model, value)
+        value.each do |schema|
+          setup_import_and_include("include", model, schema)
+        end
+      end
+
+      def include_to_schema(model, parent, _doc)
+        model.includes.each_with_index do |schema_hash, index|
+          parent.add_child(schema_hash.to_xml)
+          model.includes.delete_at(index)
+        end
+      end
+
+      private
+
+      def setup_import_and_include(klass, model, schema, args = {})
+        instance = init_instance_of(klass, schema["attributes"] || {}, args)
+        annotation_object(instance, schema)
+        model.send("#{klass}s") << instance
+        schema_path = instance.schema_path
+        return if self.class.in_progress?(schema_path) || schema_path.nil?
+
+        self.class.add_in_progress(schema_path)
+        model.send(klass) << insert_in_processed_schemas(instance)
+        self.class.remove_in_progress(schema_path)
+      end
+
+      def dig_schema_location(schema_hash)
+        schema_hash&.dig("__schema_location", :schema_location)
+      end
+
+      def schema_location?(schema_hash)
+        schema_hash&.dig("__schema_location")&.key?(:schema_location)
+      end
+
+      def init_instance_of(klass, schema_hash, args = {})
+        args[:id] = schema_hash["id"]
+        args[:schema_path] = dig_schema_location(schema_hash)
+        Lutaml::Xsd.const_get(klass.capitalize).new(**args)
+      end
+
+      def insert_in_processed_schemas(instance)
+        parsed_schema = schema_by_location_or_instance(instance)
+        return unless parsed_schema
+
+        self.class.schema_processed(instance.schema_path, parsed_schema)
+        parsed_schema
+      end
+
+      def schema_by_location_or_instance(instance)
+        schema_path = instance.schema_path
+        return unless schema_path && Glob.location?
+
+        self.class.processed_schemas[schema_path] ||
+          Lutaml::Xsd.parse(
+            instance.fetch_schema,
+            location: Glob.location,
+            nested_schema: true
+          )
+      end
+
+      def annotation_object(instance, schema)
+        elements = schema["elements"] || {}
+        annotation_key = elements.keys.find { |key| key.include?("annotation") }
+        return unless annotation_key
+
+        instance.annotation = Annotation.apply_mappings(elements[annotation_key], :xml)
+      end
+
+      class << self
+        def reset_processed_schemas
+          @processed_schemas = {}
+        end
+
+        def processed_schemas
+          @processed_schemas ||= {}
+        end
+
+        def schema_processed?(location)
+          processed_schemas[location]
+        end
+
+        def schema_processed(location, schema)
+          return if location.nil?
+
+          processed_schemas[location] = schema
+        end
+
+        def in_progress
+          @in_progress ||= []
+        end
+
+        def in_progress?(location)
+          in_progress.include?(location)
+        end
+
+        def add_in_progress(location)
+          in_progress << location
+        end
+
+        def remove_in_progress(location)
+          in_progress.delete(location)
+        end
+      end
+    end
+    # rubocop:enable Metrics/ClassLength
+  end
+end

data/lib/lutaml/xsd/selector.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Lutaml
+  module Xsd
+    class Selector < Model::Serializable
+      attribute :id, :string
+      attribute :xpath, :string
+      attribute :annotation, Annotation
+
+      xml do
+        root "selector", mixed: true
+        namespace "http://www.w3.org/2001/XMLSchema", "xsd"
+
+        map_attribute :id, to: :id
+        map_attribute :xpath, to: :xpath
+        map_element :annotation, to: :annotation
+      end
+    end
+  end
+end

data/lib/lutaml/xsd/sequence.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Lutaml
+  module Xsd
+    class Choice < Model::Serializable; end
+
+    class Sequence < Model::Serializable
+      attribute :id, :string
+      attribute :min_occurs, :string
+      attribute :max_occurs, :string
+      attribute :annotation, Annotation
+      attribute :sequence, Sequence, collection: true
+      attribute :element, Element, collection: true
+      attribute :choice, Choice, collection: true
+      attribute :group, Group, collection: true
+      attribute :any, Any, collection: true
+
+      xml do
+        root "sequence", mixed: true
+        namespace "http://www.w3.org/2001/XMLSchema", "xsd"
+
+        map_attribute :id, to: :id
+        map_attribute :minOccurs, to: :min_occurs
+        map_attribute :maxOccurs, to: :max_occurs
+        map_element :annotation, to: :annotation
+        map_element :sequence, to: :sequence
+        map_element :element, to: :element
+        map_element :choice, to: :choice
+        map_element :group, to: :group
+        map_element :any, to: :any
+      end
+    end
+  end
+end

data/lib/lutaml/xsd/simple_content.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Lutaml
+  module Xsd
+    class SimpleContent < Model::Serializable
+      attribute :id, :string
+      attribute :base, :string
+      attribute :annotation, Annotation
+      attribute :extension, ExtensionSimpleContent
+      attribute :restriction, RestrictionSimpleContent
+
+      xml do
+        root "simpleContent", mixed: true
+        namespace "http://www.w3.org/2001/XMLSchema", "xsd"
+
+        map_attribute :id, to: :id
+        map_attribute :base, to: :base
+        map_element :restriction, to: :restriction
+        map_element :annotation, to: :annotation
+        map_element :extension, to: :extension
+      end
+    end
+  end
+end

data/lib/lutaml/xsd/simple_type.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Lutaml
+  module Xsd
+    class SimpleType < Model::Serializable
+      attribute :id, :string
+      attribute :name, :string
+      attribute :final, :string
+      attribute :list, List
+      attribute :union, Union
+      attribute :annotation, Annotation
+      attribute :restriction, RestrictionSimpleType
+
+      xml do
+        root "simpleType", mixed: true
+        namespace "http://www.w3.org/2001/XMLSchema", "xsd"
+
+        map_attribute :id, to: :id
+        map_attribute :name, to: :name
+        map_attribute :final, to: :final
+        map_element :list, to: :list
+        map_element :union, to: :union
+        map_element :annotation, to: :annotation
+        map_element :restriction, to: :restriction
+      end
+    end
+  end
+end

data/lib/lutaml/xsd/total_digits.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Lutaml
+  module Xsd
+    class TotalDigits < Model::Serializable
+      attribute :id, :string
+      attribute :value, :string
+      attribute :fixed, :string
+      attribute :annotation, Annotation
+
+      xml do
+        root "totalDigits", mixed: true
+        namespace "http://www.w3.org/2001/XMLSchema", "xsd"
+
+        map_attribute :id, to: :id
+        map_attribute :value, to: :value
+        map_attribute :fixed, to: :fixed
+        map_element :annotation, to: :annotation
+      end
+    end
+  end
+end

data/lib/lutaml/xsd/union.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Lutaml
+  module Xsd
+    class Union < Model::Serializable
+      attribute :id, :string
+      attribute :member_types, :string, default: -> { "" }
+      attribute :annotation, Annotation
+      attribute :simple_type, SimpleType, collection: true
+
+      xml do
+        root "union", mixed: true
+        namespace "http://www.w3.org/2001/XMLSchema", "xsd"
+
+        map_attribute :id, to: :id
+        map_attribute :memberTypes, to: :member_types
+        map_element :annotation, to: :annotation
+        map_element :simpleType, to: :simple_type
+      end
+    end
+  end
+end

data/lib/lutaml/xsd/unique.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Lutaml
+  module Xsd
+    class Unique < Model::Serializable
+      attribute :id, :string
+      attribute :name, :string
+      attribute :selector, Selector
+      attribute :annotation, Annotation
+      attribute :field, Field, collection: true
+
+      xml do
+        root "unique", mixed: true
+        namespace "http://www.w3.org/2001/XMLSchema", "xsd"
+
+        map_attribute :id, to: :id
+        map_attribute :name, to: :name
+        map_element :annotation, to: :annotation
+        map_element :selector, to: :selector
+        map_element :field, to: :field
+      end
+    end
+  end
+end

data/lib/lutaml/xsd/version.rb

@@ -2,6 +2,6 @@
 
 module Lutaml
   module Xsd
-    VERSION = "0.1.0"
+    VERSION = "1.0.1"
   end
 end

data/lib/lutaml/xsd/white_space.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Lutaml
+  module Xsd
+    class WhiteSpace < Model::Serializable
+      attribute :id, :string
+      attribute :fixed, :string
+      attribute :value, :string
+
+      xml do
+        root "whiteSpace", mixed: true
+        namespace "http://www.w3.org/2001/XMLSchema", "xsd"
+
+        map_attribute :id, to: :id
+        map_attribute :fixed, to: :fixed
+        map_attribute :value, to: :value
+      end
+    end
+  end
+end

data/lib/lutaml/xsd/xsd.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Lutaml
+  module Xsd
+    class Error < StandardError; end
+
+    module_function
+
+    def parse(xsd, location: nil, nested_schema: false)
+      Schema.reset_processed_schemas unless nested_schema
+
+      Glob.path_or_url(location)
+      Schema.from_xml(xsd)
+    end
+  end
+end

data/lib/lutaml/xsd.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
-require_relative "xsd/version"
+require "zeitwerk"
+require "lutaml/model"
+require_relative "xsd/xsd"
 
-module Lutaml
-  module Xsd
-    class Error < StandardError; end
-    # Your code goes here...
-  end
-end
+Lutaml::Model::Config.xml_adapter_type = :nokogiri
+
+loader = Zeitwerk::Loader.for_gem(warn_on_extra_files: true)
+loader.push_dir("#{__dir__}/xsd", namespace: Lutaml::Xsd)
+loader.ignore("#{__dir__}/lib/lutaml/xsd.rb")
+loader.setup

data/lutaml-xsd.gemspec

@@ -31,4 +31,7 @@ Gem::Specification.new do |spec|
   end
 
   spec.test_files = `git ls-files -- {spec}/*`.split("\n")
+
+  spec.add_dependency "lutaml-model", "~> 0.5"
+  spec.add_dependency "zeitwerk"
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: lutaml-xsd
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-19 00:00:00.000000000 Z
-dependencies: []
+date: 2025-01-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lutaml-model
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  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'
 description: Parser and builder for XML Schema Definition (XSD) files.
 email:
 - open.source@ribose.com
@@ -25,13 +53,60 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
-- LICENSE.txt
-- README.md
+- LICENSE.md
+- README.adoc
 - Rakefile
 - bin/console
 - bin/setup
 - lib/lutaml/xsd.rb
+- lib/lutaml/xsd/all.rb
+- lib/lutaml/xsd/annotation.rb
+- lib/lutaml/xsd/any.rb
+- lib/lutaml/xsd/any_attribute.rb
+- lib/lutaml/xsd/appinfo.rb
+- lib/lutaml/xsd/attribute.rb
+- lib/lutaml/xsd/attribute_group.rb
+- lib/lutaml/xsd/choice.rb
+- lib/lutaml/xsd/complex_content.rb
+- lib/lutaml/xsd/complex_type.rb
+- lib/lutaml/xsd/documentation.rb
+- lib/lutaml/xsd/element.rb
+- lib/lutaml/xsd/enumeration.rb
+- lib/lutaml/xsd/extension_complex_content.rb
+- lib/lutaml/xsd/extension_simple_content.rb
+- lib/lutaml/xsd/field.rb
+- lib/lutaml/xsd/fraction_digits.rb
+- lib/lutaml/xsd/glob.rb
+- lib/lutaml/xsd/group.rb
+- lib/lutaml/xsd/import.rb
+- lib/lutaml/xsd/include.rb
+- lib/lutaml/xsd/key.rb
+- lib/lutaml/xsd/keyref.rb
+- lib/lutaml/xsd/length.rb
+- lib/lutaml/xsd/list.rb
+- lib/lutaml/xsd/max_exclusive.rb
+- lib/lutaml/xsd/max_inclusive.rb
+- lib/lutaml/xsd/max_length.rb
+- lib/lutaml/xsd/min_exclusive.rb
+- lib/lutaml/xsd/min_inclusive.rb
+- lib/lutaml/xsd/min_length.rb
+- lib/lutaml/xsd/notation.rb
+- lib/lutaml/xsd/pattern.rb
+- lib/lutaml/xsd/redefine.rb
+- lib/lutaml/xsd/restriction_complex_content.rb
+- lib/lutaml/xsd/restriction_simple_content.rb
+- lib/lutaml/xsd/restriction_simple_type.rb
+- lib/lutaml/xsd/schema.rb
+- lib/lutaml/xsd/selector.rb
+- lib/lutaml/xsd/sequence.rb
+- lib/lutaml/xsd/simple_content.rb
+- lib/lutaml/xsd/simple_type.rb
+- lib/lutaml/xsd/total_digits.rb
+- lib/lutaml/xsd/union.rb
+- lib/lutaml/xsd/unique.rb
 - lib/lutaml/xsd/version.rb
+- lib/lutaml/xsd/white_space.rb
+- lib/lutaml/xsd/xsd.rb
 - lutaml-xsd.gemspec
 - sig/lutaml/xsd.rbs
 homepage: https://github.com/lutaml/expressir
@@ -57,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
+rubygems_version: 3.3.27
 signing_key:
 specification_version: 4
 summary: Library for XML Schema Definition (XSD) files

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2024 suleman-uzair
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.

data/README.md

@@ -1,43 +0,0 @@
-# Lutaml::Xsd
-
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/lutaml/xsd`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-## Installation
-
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
-Install the gem and add to the application's Gemfile by executing:
-
-```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
-```
-
-If bundler is not being used to manage dependencies, install the gem by executing:
-
-```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
-```
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/lutaml-xsd. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/lutaml-xsd/blob/master/CODE_OF_CONDUCT.md).
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the Lutaml::Xsd project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/lutaml-xsd/blob/master/CODE_OF_CONDUCT.md).