proformaxml 1.2.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 606acc3bf478e597146722128fa681af0e50985af661a74d302de9c3ab2b5b37
-  data.tar.gz: 474a73f7e5a09f850d9c8b9e5a4fb90b93953d2ceece434750f91f5a8581b633
+  metadata.gz: 8284cbc28d6d2cabde0247312b5a526ffdb8be758261295757f3b4b132250004
+  data.tar.gz: 0fa49ec56a760ff164eed881b362bcb4307dcf6d789c9d395e65d67945c9654d
 SHA512:
-  metadata.gz: d482b1a2a9ad647fe971577eeb6e5d19210e08b51bcdab7cc2daecea68cd1cc1389b80ff9da2d75cf628dd36999241655549a29ad41c9c666a9db4c698a7216d
-  data.tar.gz: d5b0f74efc13fda6dbf91d55799321d694db0961b9d80d07bed395e6f202a0dc8ba935a2437fac82f51d455623af7b208df0b2e3f9e3fc264f1763488ec42031
+  metadata.gz: 16a96f01c9bb5a05008820954da688600b65d01d4733a45204c933d205635977e8e18358b05c20f2d14c898a6fca3b6e005ad84aa20122df8f2f8e3b8471f73e
+  data.tar.gz: 7b743f6b785d69e549bfb0948e19d90fdec93644aca4ae312c7d27c27c7748def994f1ea11e10084fc061567db47e2b14e2e7a7b026378448d7bcbbdb2a5268b

data/.rubocop.yml

@@ -13,7 +13,7 @@ inherit_from:
   - .rubocop/style.yml
 
 AllCops:
-  TargetRubyVersion: 3.2
+  TargetRubyVersion: 3.3
   TargetRailsVersion: 7.0 # for ActiveSupport
   UseCache: True
   NewCops: enable

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    proformaxml (1.2.0)
+    proformaxml (1.4.0)
       activemodel (>= 5.2.3, < 8.0.0)
       activesupport (>= 5.2.3, < 8.0.0)
       dachsfisch (~> 1.0.0)
@@ -11,9 +11,9 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (7.1.1)
-      activesupport (= 7.1.1)
-    activesupport (7.1.1)
+    activemodel (7.1.3.4)
+      activesupport (= 7.1.3.4)
+    activesupport (7.1.3.4)
       base64
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
@@ -24,21 +24,20 @@ GEM
       mutex_m
       tzinfo (~> 2.0)
     ast (2.4.2)
-    base64 (0.1.1)
-    bigdecimal (3.1.4)
+    base64 (0.2.0)
+    bigdecimal (3.1.8)
     byebug (11.1.3)
     coderay (1.1.3)
-    concurrent-ruby (1.2.2)
+    concurrent-ruby (1.3.1)
     connection_pool (2.4.1)
     dachsfisch (1.0.0)
       nokogiri (>= 1.14.1, < 2.0.0)
-    diff-lcs (1.5.0)
+    diff-lcs (1.5.1)
     docile (1.4.0)
-    drb (2.1.1)
-      ruby2_keywords
-    factory_bot (6.3.0)
+    drb (2.2.1)
+    factory_bot (6.4.6)
       activesupport (>= 5.0.0)
-    ffi (1.16.1)
+    ffi (1.16.3)
     formatador (1.1.0)
     guard (2.18.1)
       formatador (>= 0.2.4)
@@ -54,27 +53,27 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    i18n (1.14.1)
+    i18n (1.14.5)
       concurrent-ruby (~> 1.0)
-    json (2.6.3)
+    json (2.7.2)
     language_server-protocol (3.17.0.3)
-    listen (3.8.0)
+    listen (3.9.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
-    lumberjack (1.2.9)
-    method_source (1.0.0)
-    mini_portile2 (2.8.4)
-    minitest (5.20.0)
-    mutex_m (0.1.2)
+    lumberjack (1.2.10)
+    method_source (1.1.0)
+    mini_portile2 (2.8.7)
+    minitest (5.23.1)
+    mutex_m (0.2.0)
     nenv (0.3.0)
-    nokogiri (1.15.4)
+    nokogiri (1.16.6)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
     notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    parallel (1.23.0)
-    parser (3.2.2.4)
+    parallel (1.24.0)
+    parser (3.3.1.0)
       ast (~> 2.4.1)
       racc
     pry (0.14.2)
@@ -83,63 +82,66 @@ GEM
     pry-byebug (3.10.1)
       byebug (~> 11.0)
       pry (>= 0.13, < 0.15)
-    racc (1.7.1)
-    rack (3.0.8)
+    racc (1.8.0)
+    rack (3.0.11)
     rainbow (3.1.1)
-    rake (13.0.6)
+    rake (13.2.1)
     rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    regexp_parser (2.8.2)
-    rexml (3.2.6)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
+    regexp_parser (2.9.1)
+    rexml (3.2.8)
+      strscan (>= 3.0.9)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
     rspec-collection_matchers (1.2.1)
       rspec-expectations (>= 2.99.0.beta1)
-    rspec-core (3.12.2)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.3)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
+      rspec-support (~> 3.13.0)
     rspec-github (2.4.0)
       rspec-core (~> 3.0)
-    rspec-mocks (3.12.6)
+    rspec-mocks (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.1)
-    rubocop (1.57.1)
-      base64 (~> 0.1.1)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.63.5)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.2.4)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.28.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.29.0)
-      parser (>= 3.2.1.0)
-    rubocop-capybara (2.19.0)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
+    rubocop-capybara (2.20.0)
       rubocop (~> 1.41)
-    rubocop-factory_bot (2.24.0)
-      rubocop (~> 1.33)
-    rubocop-performance (1.19.1)
-      rubocop (>= 1.7.0, < 2.0)
-      rubocop-ast (>= 0.4.0)
-    rubocop-rails (2.21.2)
+    rubocop-factory_bot (2.25.1)
+      rubocop (~> 1.41)
+    rubocop-performance (1.21.0)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-rails (2.24.1)
       activesupport (>= 4.2.0)
       rack (>= 1.1)
       rubocop (>= 1.33.0, < 2.0)
-    rubocop-rspec (2.24.1)
-      rubocop (~> 1.33)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-rspec (2.29.2)
+      rubocop (~> 1.40)
       rubocop-capybara (~> 2.17)
       rubocop-factory_bot (~> 2.22)
+      rubocop-rspec_rails (~> 2.28)
+    rubocop-rspec_rails (2.28.3)
+      rubocop (~> 1.40)
     ruby-progressbar (1.13.0)
-    ruby2_keywords (0.0.5)
     rubyzip (2.3.2)
     shellany (0.0.1)
     simplecov (0.22.0)
@@ -148,7 +150,8 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    thor (1.2.2)
+    strscan (3.1.0)
+    thor (1.3.1)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.5.0)
@@ -175,4 +178,4 @@ DEPENDENCIES
   simplecov
 
 BUNDLED WITH
-   2.4.18
+   2.5.11

data/lib/proformaxml/helpers/import_helpers.rb

@@ -23,7 +23,7 @@ module ProformaXML
         if object.is_a? Hash
           object[name] = value
         else
-          object.send("#{name}=", value)
+          object.send(:"#{name}=", value)
         end
       end
 
@@ -56,10 +56,10 @@ module ProformaXML
       end
 
       def add_test_configuration(test, test_node)
-        test_configuration_node = test_node.xpath('xmlns:test-configuration')
+        test_configuration_node = test_node.xpath("#{@pro_ns}:test-configuration")
         test.files = test_files_from_test_configuration(test_configuration_node)
         test.configuration = extra_configuration_from_test_configuration(test_configuration_node)
-        meta_data_node = test_node.xpath('xmlns:test-configuration').xpath('xmlns:test-meta-data')
+        meta_data_node = test_node.xpath("#{@pro_ns}:test-configuration").xpath("#{@pro_ns}:test-meta-data")
         test.meta_data = convert_xml_node_to_json(meta_data_node) if meta_data_node.present?
       end
 
@@ -75,28 +75,35 @@ module ProformaXML
       end
 
       def test_files_from_test_configuration(test_configuration_node)
-        files_from_filerefs(test_configuration_node.search('filerefs'))
+        files_from_filerefs(test_configuration_node.xpath("#{@pro_ns}:filerefs"))
       end
 
       private
 
       def convert_xml_node_to_json(any_node)
         xml_snippet = Nokogiri::XML::DocumentFragment.new(Nokogiri::XML::Document.new, any_node)
-        all_namespaces(any_node).each do |namespace|
+        all_namespaces_without_default(any_node).each do |namespace|
           xml_snippet.children.first.add_namespace_definition(namespace[:prefix], namespace[:href])
         end
-        JSON.parse(Dachsfisch::XML2JSONConverter.perform(xml: xml_snippet.to_xml))
+        xml_without_custom_default_ns = xml_snippet.to_xml.gsub(%r{(</?)#{custom_default_namespace_prefix(any_node)}:}, '\1')
+        JSON.parse(Dachsfisch::XML2JSONConverter.perform(xml: xml_without_custom_default_ns))
       end
 
-      def all_namespaces(node)
+      def all_namespaces_without_default(node)
         node.xpath('.|.//*').map(&:namespace).reject do |ns|
-          ns.prefix.nil?
+          ns.prefix.nil? || ns.href.match?(/^urn:proforma:v\d.*$/)
         end.map {|ns| {prefix: ns.prefix, href: ns.href} }.uniq
       end
 
+      def custom_default_namespace_prefix(node)
+        node.xpath('.|.//*').map(&:namespace).filter do |ns|
+          ns.href.match?(/^urn:proforma:v\d.*$/)
+        end.map(&:prefix).first
+      end
+
       def value_from_node(name, node, attribute)
         xml_name = name.is_a?(Array) ? name[0] : name
-        attribute ? node.attribute(xml_name)&.value : node.xpath("xmlns:#{xml_name}").text
+        attribute ? node.attribute(xml_name)&.value : node.xpath("#{@pro_ns}:#{xml_name}").text
       end
 
       def content_from_file_tag(file_tag, binary)

data/lib/proformaxml/services/importer.rb

@@ -12,18 +12,26 @@ module ProformaXML
       @expected_version = expected_version
 
       xml = filestring_from_zip('task.xml')
-      raise PreImportValidationError if xml.nil?
+      raise PreImportValidationError.new(['no task_xml found']) if xml.blank?
 
       @doc = Nokogiri::XML(xml, &:noblanks)
       @task = Task.new
     end
 
+    def proforma_namespace
+      namespace_regex = /^urn:proforma:v\d.*$/
+      namespaces = @doc.namespaces.filter do |_, href|
+        href.match? namespace_regex
+      end
+      namespaces.first.first.gsub('xmlns:', '')
+    end
+
     def perform
       errors = validate
+      raise PreImportValidationError.new(errors.map(&:message)) if errors.any?
 
-      raise PreImportValidationError.new(errors) if errors.any?
-
-      @task_node = @doc.xpath('/xmlns:task')
+      @pro_ns = proforma_namespace
+      @task_node = @doc.xpath("/#{@pro_ns}:task")
 
       set_data
       @task
@@ -37,11 +45,17 @@ module ProformaXML
       end
     end
 
+    def remove_referenced_files
+      referenced_files = (@task.tests.map(&:files) + @task.model_solutions.map(&:files)).flatten
+      @task.files.reject! {|f| referenced_files.include? f }
+    end
+
     def set_data
       set_base_data
       set_files
       set_model_solutions
       set_tests
+      remove_referenced_files
       set_meta_data
       set_extra_data
     end
@@ -57,44 +71,44 @@ module ProformaXML
     end
 
     def set_proglang
-      return if @task_node.xpath('xmlns:proglang').text.blank?
+      return if @task_node.xpath("#{@pro_ns}:proglang").text.blank?
 
-      @task.proglang = {name: @task_node.xpath('xmlns:proglang').text,
-                        version: @task_node.xpath('xmlns:proglang').attribute('version').value.presence}.compact
+      @task.proglang = {name: @task_node.xpath("#{@pro_ns}:proglang").text,
+                        version: @task_node.xpath("#{@pro_ns}:proglang").attribute('version').value.presence}.compact
     end
 
     def set_files
-      @task_node.search('files//file').each {|file_node| add_file file_node }
+      @task_node.xpath("#{@pro_ns}:files//#{@pro_ns}:file").each {|file_node| add_file file_node }
     end
 
     def set_tests
-      @task_node.search('tests//test').each {|test_node| add_test test_node }
+      @task_node.xpath("#{@pro_ns}:tests//#{@pro_ns}:test").each {|test_node| add_test test_node }
     end
 
     def set_model_solutions
-      @task_node.search('model-solutions//model-solution').each do |model_solution_node|
+      @task_node.xpath("#{@pro_ns}:model-solutions//#{@pro_ns}:model-solution").each do |model_solution_node|
         add_model_solution model_solution_node
       end
     end
 
     def set_meta_data
-      meta_data_node = @task_node.xpath('xmlns:meta-data').first
+      meta_data_node = @task_node.xpath("#{@pro_ns}:meta-data").first
       @task.meta_data = convert_xml_node_to_json(meta_data_node) if meta_data_node.text.present?
     end
 
     def set_extra_data
-      submission_restrictions_node = @task_node.xpath('xmlns:submission-restrictions').first
+      submission_restrictions_node = @task_node.xpath("#{@pro_ns}:submission-restrictions").first
       @task.submission_restrictions = convert_xml_node_to_json(submission_restrictions_node) unless submission_restrictions_node.nil?
-      external_resources_node = @task_node.xpath('xmlns:external-resources').first
+      external_resources_node = @task_node.xpath("#{@pro_ns}:external-resources").first
       @task.external_resources = convert_xml_node_to_json(external_resources_node) unless external_resources_node.nil?
-      grading_hints_node = @task_node.xpath('xmlns:grading-hints').first
+      grading_hints_node = @task_node.xpath("#{@pro_ns}:grading-hints").first
       @task.grading_hints = convert_xml_node_to_json(grading_hints_node) unless grading_hints_node.nil?
     end
 
     def add_model_solution(model_solution_node)
       model_solution = ModelSolution.new
       model_solution.id = model_solution_node.attributes['id'].value
-      model_solution.files = files_from_filerefs(model_solution_node.search('filerefs'))
+      model_solution.files = files_from_filerefs(model_solution_node.xpath("#{@pro_ns}:filerefs"))
       set_value_from_xml(object: model_solution, node: model_solution_node, name: 'description')
       set_value_from_xml(object: model_solution, node: model_solution_node, name: 'internal-description')
       @task.model_solutions << model_solution unless model_solution.files.first&.id == 'ms-placeholder-file'
@@ -125,9 +139,9 @@ module ProformaXML
 
     def files_from_filerefs(filerefs_node)
       [].tap do |files|
-        filerefs_node.search('fileref').each do |fileref_node|
+        filerefs_node.xpath("#{@pro_ns}:fileref").each do |fileref_node|
           fileref = fileref_node.attributes['refid'].value
-          files << @task.files.delete(@task.files.detect {|file| file.id == fileref })
+          files << @task.files.detect {|file| file.id == fileref }
         end
       end
     end

data/lib/proformaxml/services/validator.rb

@@ -14,7 +14,14 @@ module ProformaXML
     private
 
     def doc_schema_version
-      @doc_schema_version ||= /^urn:proforma:v(.*)$/.match(@doc.namespaces['xmlns'])&.captures&.dig(0)
+      namespace_regex = /^urn:proforma:v(\d.*)$/
+      potential_namespaces = @doc.namespaces.filter do |_, href|
+        href.match? namespace_regex
+      end
+      return nil unless potential_namespaces.length == 1
+
+      @pro_ns = potential_namespaces.first[0].gsub('xmlns:', '')
+      @doc_schema_version ||= namespace_regex.match(potential_namespaces.first[1])&.captures&.dig(0)
     end
 
     def node_as_doc_with_namespace(config_node)
@@ -38,7 +45,7 @@ module ProformaXML
     end
 
     def validate_test_configuration
-      @doc.xpath('/xmlns:task/xmlns:tests/xmlns:test/xmlns:test-configuration').flat_map do |test_config|
+      @doc.xpath("/#{@pro_ns}:task/#{@pro_ns}:tests/#{@pro_ns}:test/#{@pro_ns}: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

data/lib/proformaxml/version.rb

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

data/proformaxml.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/openHPI/proformaxml'
   spec.license       = 'MIT'
 
-  spec.required_ruby_version = '>= 3.2'
+  spec.required_ruby_version = '>= 3.3'
 
   # 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.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: proformaxml
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Karol
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-25 00:00:00.000000000 Z
+date: 2024-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -160,14 +160,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.2'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Implements parts of ProFormA-XML specification