proformaxml 0.10.0

data/lib/proformaxml/services/validator.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module ProformaXML
+  class Validator
+    def initialize(doc, expected_version = nil)
+      @doc = doc
+      @expected_version = expected_version
+    end
+
+    def perform
+      validate
+    end
+
+    private
+
+    def doc_schema_version
+      @doc_schema_version ||= /^urn:proforma:v(.*)$/.match(@doc.namespaces['xmlns'])&.captures&.dig(0)
+    end
+
+    def node_as_doc_with_namespace(config_node)
+      doc = Nokogiri::XML::Document.new
+      doc.add_child(config_node.dup)
+      doc
+    end
+
+    def validate
+      return ['no proformaxml version found'] if doc_schema_version.nil?
+
+      version = @expected_version || doc_schema_version
+      return ['version not supported'] unless SCHEMA_VERSIONS.include? version
+
+      # Both validations return an array of errors, which are empty if the validation was successful.
+      validate_task(version) + validate_test_configuration
+    end
+
+    def validate_task(version)
+      Nokogiri::XML::Schema(File.open(SCHEMA_FORMAT_PATH % version)).validate(@doc)
+    end
+
+    def validate_test_configuration
+      @doc.xpath('/xmlns:task/xmlns:tests/xmlns:test/xmlns:test-configuration').flat_map do |test_config|
+        test_config.children.flat_map do |config_node|
+          next [] unless config_node.namespace&.href&.start_with?('urn:proforma:tests:')
+          next [] unless TEST_TYPE_SCHEMA_NAMES.include? config_node.name
+
+          schema = Nokogiri::XML::Schema(File.read(SCHEMA_FORMAT_PATH % config_node.name))
+          schema.validate(node_as_doc_with_namespace(config_node))
+        end
+      end
+    end
+  end
+end

data/lib/proformaxml/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ProformaXML
+  VERSION = '0.10.0'
+end

data/lib/proformaxml.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'active_model'
+require 'nokogiri'
+require 'zip'
+require 'base64'
+require 'securerandom'
+require 'dachsfisch'
+
+require 'proformaxml/version'
+
+require 'proformaxml/services/importer'
+require 'proformaxml/services/exporter'
+require 'proformaxml/services/validator'
+require 'proformaxml/models/task'
+
+module ProformaXML
+  SCHEMA_PATH = File.join(File.dirname(File.expand_path(__FILE__)), '../assets/schemas')
+  SCHEMA_FORMAT_PATH = "#{SCHEMA_PATH}/proforma-%s.xsd".freeze
+  SCHEMA_VERSIONS = %w[2.1 2.0].freeze
+
+  TEST_TYPE_SCHEMA_NAMES = %w[java-checkstyle regexptest unittest].freeze
+  MAX_EMBEDDED_FILE_SIZE_KB = 50
+end

data/proformaxml.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative 'lib/proformaxml/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'proformaxml'
+  spec.version       = ProformaXML::VERSION
+  spec.authors       = ['Karol']
+  spec.email         = ['git@koehn.pro']
+
+  spec.summary       = 'Implements parts of ProFormA-XML specification'
+  spec.description   = 'Offers datastructure and (de)serializer according to ProFormA-XML specification.'
+  spec.homepage      = 'https://github.com/openHPI/proformaxml'
+  spec.license       = 'MIT'
+
+  spec.required_ruby_version = '>= 3.2'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
+    end
+  end
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{\Aexe/}) {|f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activemodel', '>= 5.2.3', '< 8.0.0'
+  spec.add_dependency 'activesupport', '>= 5.2.3', '< 8.0.0'
+  spec.add_dependency 'dachsfisch', '>= 0.1.0', '< 1.0.0'
+  spec.add_dependency 'nokogiri', '>= 1.10.2', '< 2.0.0'
+  spec.add_dependency 'rubyzip', '>= 1.2.2', '< 3.0.0'
+
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

metadata

@@ -0,0 +1,179 @@
+--- !ruby/object:Gem::Specification
+name: proformaxml
+version: !ruby/object:Gem::Version
+  version: 0.10.0
+platform: ruby
+authors:
+- Karol
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-08-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 8.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 8.0.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 8.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 8.0.0
+- !ruby/object:Gem::Dependency
+  name: dachsfisch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.10.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.10.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Offers datastructure and (de)serializer according to ProFormA-XML specification.
+email:
+- git@koehn.pro
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop/layout.yml"
+- ".rubocop/lint.yml"
+- ".rubocop/metrics.yml"
+- ".rubocop/rails.yml"
+- ".rubocop/rspec.yml"
+- ".rubocop/style.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- SECURITY.md
+- assets/schemas/proforma-2.0.xsd
+- assets/schemas/proforma-2.1.xsd
+- assets/schemas/proforma-java-checkstyle.xsd
+- assets/schemas/proforma-regexptest.xsd
+- assets/schemas/proforma-unittest.xsd
+- lib/proformaxml.rb
+- lib/proformaxml/errors.rb
+- lib/proformaxml/helpers/export_helpers.rb
+- lib/proformaxml/helpers/import_helpers.rb
+- lib/proformaxml/models/base.rb
+- lib/proformaxml/models/model_solution.rb
+- lib/proformaxml/models/task.rb
+- lib/proformaxml/models/task_file.rb
+- lib/proformaxml/models/test.rb
+- lib/proformaxml/services/exporter.rb
+- lib/proformaxml/services/importer.rb
+- lib/proformaxml/services/validator.rb
+- lib/proformaxml/version.rb
+- proformaxml.gemspec
+homepage: https://github.com/openHPI/proformaxml
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: Implements parts of ProFormA-XML specification
+test_files: []