proformaxml 0.10.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2230a680b6a36b22867d4c9749199e5ab0e601567998e343e3281a838867f6c7
-  data.tar.gz: 9e8486a4ed110915ff0e9ce4b6e4cf87df3ad02c8c0c94c02824ddd8696a56fc
+  metadata.gz: 81e1724c3c9498d52025b18b5f3e2830fa10c499bcc9a064470f265d6ed9ba34
+  data.tar.gz: 4b7499f6e605ba8dae8ad23e149a06e7e78fa08f91a14f3e8803e70140b02cdc
 SHA512:
-  metadata.gz: 20e9ee57cc1071bf2b8612f3397aeed1a98648f0fc363ddb8e3b22251c77e265208b6fbce75c9fe19cafd5a454fcf97d5f8dd90312a7758a2f86c673db9596ea
-  data.tar.gz: 1c9d253c304209ba0026b766585d851d99e4ea3a626c402d92feb78a245b9ffc7633130ccea1bfe7916315a9118eff54b092b0252c8b88487fccf0547aa70313
+  metadata.gz: c47047c96d5fb1c23233c67bd165a6b088e643bc9b6032c8107afd1e32d8d3cb9c4d2342661bd0b5b2b9da38fee368a058dc2fdfa2aabd34889f49c3e9817c21
+  data.tar.gz: 18e38170e845ad6e148ce0de1f621e57c3b360a19c7e3a875d8be90e1dfaf94fc085aacdd18ab16d6a587116261426e1f6de6939a351d5fdb0a683e218c7ed1d

data/.rubocop/factory-bot.yml

@@ -0,0 +1,5 @@
+# factory bot cop settings
+
+# We need to define own IDs, since we do not store objects in a database with ActiveRecord.
+FactoryBot/IdSequence:
+  Enabled: false

data/.rubocop/rspec.yml

@@ -25,3 +25,11 @@ RSpec/NestedGroups:
 
 RSpec/IndexedLet:
   Max: 2
+
+RSpec/FilePath:
+  CustomTransform:
+    ProformaXML: proformaxml
+
+RSpec/SpecFilePathFormat:
+  CustomTransform:
+    ProformaXML: proformaxml

data/.rubocop.yml

@@ -5,6 +5,7 @@ require:
   - rubocop-rspec
 
 inherit_from:
+  - .rubocop/factory-bot.yml
   - .rubocop/layout.yml
   - .rubocop/lint.yml
   - .rubocop/metrics.yml
@@ -24,7 +25,3 @@ AllCops:
     - 'tmp/**/*'
     - 'out/**/*'
     - 'coverage/**/*'
-
-RSpec/FilePath:
-  CustomTransform:
-    ProformaXML: proformaxml

data/Gemfile

@@ -16,7 +16,6 @@ gem 'rspec'
 gem 'rspec-collection_matchers'
 gem 'rspec-github'
 gem 'rubocop'
-gem 'rubocop-factory_bot'
 gem 'rubocop-performance'
 gem 'rubocop-rails'
 gem 'rubocop-rspec'

data/Gemfile.lock

@@ -1,19 +1,19 @@
 PATH
   remote: .
   specs:
-    proformaxml (0.10.0)
+    proformaxml (1.1.0)
       activemodel (>= 5.2.3, < 8.0.0)
       activesupport (>= 5.2.3, < 8.0.0)
-      dachsfisch (>= 0.1.0, < 1.0.0)
+      dachsfisch (>= 0.2.0, < 1.0.0)
       nokogiri (>= 1.10.2, < 2.0.0)
       rubyzip (>= 1.2.2, < 3.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (7.0.7.2)
-      activesupport (= 7.0.7.2)
-    activesupport (7.0.7.2)
+    activemodel (7.0.8)
+      activesupport (= 7.0.8)
+    activesupport (7.0.8)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -23,15 +23,15 @@ GEM
     byebug (11.1.3)
     coderay (1.1.3)
     concurrent-ruby (1.2.2)
-    dachsfisch (0.1.0)
+    dachsfisch (0.2.0)
       nokogiri (>= 1.14.1, < 2.0.0)
     diff-lcs (1.5.0)
     docile (1.4.0)
-    factory_bot (6.2.1)
+    factory_bot (6.3.0)
       activesupport (>= 5.0.0)
-    ffi (1.15.5)
+    ffi (1.16.1)
     formatador (1.1.0)
-    guard (2.18.0)
+    guard (2.18.1)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
       lumberjack (>= 1.0.12, < 2.0)
@@ -55,7 +55,7 @@ GEM
     lumberjack (1.2.9)
     method_source (1.0.0)
     mini_portile2 (2.8.4)
-    minitest (5.19.0)
+    minitest (5.20.0)
     nenv (0.3.0)
     nokogiri (1.15.4)
       mini_portile2 (~> 2.8.2)
@@ -86,7 +86,7 @@ GEM
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
       rspec-mocks (~> 3.12.0)
-    rspec-collection_matchers (1.2.0)
+    rspec-collection_matchers (1.2.1)
       rspec-expectations (>= 2.99.0.beta1)
     rspec-core (3.12.2)
       rspec-support (~> 3.12.0)
@@ -99,7 +99,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.1)
-    rubocop (1.56.1)
+    rubocop (1.56.4)
       base64 (~> 0.1.1)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
@@ -113,18 +113,18 @@ GEM
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.29.0)
       parser (>= 3.2.1.0)
-    rubocop-capybara (2.18.0)
+    rubocop-capybara (2.19.0)
       rubocop (~> 1.41)
-    rubocop-factory_bot (2.23.1)
+    rubocop-factory_bot (2.24.0)
       rubocop (~> 1.33)
-    rubocop-performance (1.19.0)
+    rubocop-performance (1.19.1)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rails (2.20.2)
+    rubocop-rails (2.21.2)
       activesupport (>= 4.2.0)
       rack (>= 1.1)
       rubocop (>= 1.33.0, < 2.0)
-    rubocop-rspec (2.23.2)
+    rubocop-rspec (2.24.1)
       rubocop (~> 1.33)
       rubocop-capybara (~> 2.17)
       rubocop-factory_bot (~> 2.22)
@@ -140,7 +140,7 @@ GEM
     thor (1.2.2)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.4.2)
+    unicode-display_width (2.5.0)
 
 PLATFORMS
   ruby
@@ -158,7 +158,6 @@ DEPENDENCIES
   rspec-collection_matchers
   rspec-github
   rubocop
-  rubocop-factory_bot
   rubocop-performance
   rubocop-rails
   rubocop-rspec

data/lib/proformaxml/helpers/export_helpers.rb

@@ -26,54 +26,32 @@ module ProformaXML
       def add_test_configuration(xml, test)
         xml.send(:'test-configuration') do
           add_filerefs(xml, test) if test.files
-          add_configuration(xml, test.configuration) unless test.configuration.nil?
-          if test.meta_data
-            xml.send(:'test-meta-data') do
-              meta_data(xml, test.meta_data)
-            end
-          end
+          add_dachsfisch_node(xml, test.configuration)
+          add_dachsfisch_node(xml, test.meta_data)
         end
       end
 
-      def inner_meta_data(xml, namespace, data)
-        data.each do |key, value|
-          case value.class.name
-            when 'Hash'
-              # underscore is used to disambiguate tag names from ruby methods
-              xml[namespace].send("#{key}_") do |meta_data_xml|
-                inner_meta_data(meta_data_xml, namespace, value)
-              end
-            else
-              xml[namespace].send("#{key}_", value)
-          end
-        end
-      end
-
-      def meta_data(xml, meta_data)
-        meta_data.each do |namespace, data|
-          inner_meta_data(xml, namespace, data)
-        end
-      end
-
-      def add_configuration(xml, configuration)
-        xml_snippet = Dachsfisch::JSON2XMLConverter.perform(json: configuration.to_json)
-        configuration.flat_map {|_, val| val['@xmlns'].to_a }.uniq.each do |namespace|
-          xml.doc.root.add_namespace(namespace[0], namespace[1])
+      def add_dachsfisch_node(xml, dachsfisch_node, node_name_fallback = nil)
+        if dachsfisch_node.blank?
+          xml.send(node_name_fallback, '') if node_name_fallback.present?
+          return
         end
+        xml_snippet = Dachsfisch::JSON2XMLConverter.perform(json: dachsfisch_node.to_json)
+        add_namespaces_for_dachsfisch_node(dachsfisch_node, xml)
 
         xml << xml_snippet
       end
 
-      def add_namespaces_to_header(header, custom_namespaces)
-        custom_namespaces.each do |namespace|
-          header["xmlns:#{namespace[:prefix]}"] = namespace[:uri]
-        end
-      end
-
       def add_parent_uuid_and_lang_to_header(header)
         header['lang'] = @task.language if @task.language.present?
         header['parent-uuid'] = @task.parent_uuid if @task.parent_uuid.present?
       end
+
+      def add_namespaces_for_dachsfisch_node(dachsfisch_node, xml)
+        dachsfisch_node.flat_map {|_, val| val['@xmlns'].to_a }.uniq.each do |namespace|
+          xml.doc.root.add_namespace(namespace[0], namespace[1]) unless namespace[0] == '$'
+        end
+      end
     end
   end
 end

data/lib/proformaxml/helpers/import_helpers.rb

@@ -60,7 +60,7 @@ module ProformaXML
         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')
-        test.meta_data = meta_data(meta_data_node, use_namespace: true) if meta_data_node.present?
+        test.meta_data = convert_xml_node_to_json(meta_data_node) if meta_data_node.present?
       end
 
       def extra_configuration_from_test_configuration(test_configuration_node)
@@ -78,29 +78,22 @@ module ProformaXML
         files_from_filerefs(test_configuration_node.search('filerefs'))
       end
 
-      def meta_data(any_data_node, use_namespace: false)
-        # use_namespace forces the use of the namespace as hash key - it should only be used at the entry of the recursion
-        {}.tap do |any_data|
-          any_data_node.children.each do |node|
-            key = (use_namespace ? node.namespace.prefix : any_data_node.name).to_sym
-            any_data[key] = if node.node_type == Nokogiri::XML::Node::TEXT_NODE
-                              node.text
-                            else
-                              # preserve any existing data in the nested hash
-                              (any_data[key] || {}).merge meta_data(node)
-                            end
-          end
-        end
-      end
-
       private
 
       def convert_xml_node_to_json(any_node)
         xml_snippet = Nokogiri::XML::DocumentFragment.new(Nokogiri::XML::Document.new, any_node)
-        xml_snippet.children.first.add_namespace_definition(any_node.namespace.prefix, any_node.namespace.href)
+        all_namespaces(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))
       end
 
+      def all_namespaces(node)
+        node.xpath('.|.//*').map(&:namespace).reject do |ns|
+          ns.prefix.nil?
+        end.map {|ns| {prefix: ns.prefix, href: ns.href} }.uniq
+      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

data/lib/proformaxml/models/task.rb

@@ -8,8 +8,8 @@ require 'proformaxml/errors'
 
 module ProformaXML
   class Task < Base
-    attr_accessor :title, :description, :internal_description, :proglang, :uuid, :parent_uuid,
-      :language, :model_solutions, :files, :tests, :meta_data
+    attr_accessor :title, :description, :internal_description, :proglang, :uuid, :parent_uuid, :language,
+      :model_solutions, :files, :tests, :meta_data, :submission_restrictions, :external_resources, :grading_hints
 
     def initialize(attributes = {})
       super

data/lib/proformaxml/services/exporter.rb

@@ -6,10 +6,9 @@ module ProformaXML
   class Exporter
     include ProformaXML::Helpers::ExportHelpers
 
-    def initialize(task:, custom_namespaces: [], version: nil)
+    def initialize(task:, version: nil)
       @files = {}
       @task = task
-      @custom_namespaces = custom_namespaces
       @version = version || SCHEMA_VERSIONS.first
       add_placeholders if @version == '2.0'
     end
@@ -22,9 +21,9 @@ module ProformaXML
       doc = Nokogiri::XML(xmldoc)
       errors = validate(doc)
 
+      # File.binwrite('../testfile.zip', write_to_zip(xmldoc).string)
       raise PostGenerateValidationError.new(errors) if errors.any?
 
-      # File.open('../testfile.zip', 'wb') { |file| file.write(write_to_zip(xmldoc).string) }
       write_to_zip(xmldoc)
     end
 
@@ -38,7 +37,7 @@ module ProformaXML
         xml.proglang({version: @task.proglang&.dig(:version)}, @task.proglang&.dig(:name))
 
         add_objects_to_xml(xml)
-        add_meta_data(xml)
+        add_dachsfisch_node(xml, @task.meta_data, 'meta-data')
       end
     end
 
@@ -46,14 +45,13 @@ module ProformaXML
       xml.send(:'internal-description', internal_description) if internal_description.present?
     end
 
-    def add_meta_data(xml)
-      xml.send(:'meta-data') { meta_data(xml, @task.meta_data) }
-    end
-
     def add_objects_to_xml(xml)
+      add_dachsfisch_node(xml, @task.submission_restrictions)
       xml.files { files(xml) }
+      add_dachsfisch_node(xml, @task.external_resources)
       xml.send(:'model-solutions') { model_solutions(xml) } if @task.model_solutions.any? || @version == '2.0'
       xml.tests { tests(xml) }
+      add_dachsfisch_node(xml, @task.grading_hints)
     end
 
     def files(xml)
@@ -114,7 +112,6 @@ module ProformaXML
         'xmlns' => "urn:proforma:v#{@version}",
         'uuid' => @task.uuid,
       }.tap do |header|
-        add_namespaces_to_header(header, @custom_namespaces)
         add_parent_uuid_and_lang_to_header(header)
       end
     end

data/lib/proformaxml/services/importer.rb

@@ -26,7 +26,7 @@ module ProformaXML
       @task_node = @doc.xpath('/xmlns:task')
 
       set_data
-      {task: @task, custom_namespaces: @custom_namespaces}
+      @task
     end
 
     private
@@ -38,16 +38,12 @@ module ProformaXML
     end
 
     def set_data
-      set_namespaces
       set_base_data
       set_files
       set_model_solutions
       set_tests
       set_meta_data
-    end
-
-    def set_namespaces
-      @custom_namespaces = @doc.namespaces.except('xmlns').map {|k, v| {prefix: k[6..], uri: v} }
+      set_extra_data
     end
 
     def set_base_data
@@ -82,8 +78,17 @@ module ProformaXML
     end
 
     def set_meta_data
-      meta_data_node = @task_node.xpath('xmlns:meta-data')
-      @task.meta_data = meta_data(meta_data_node, use_namespace: true) if meta_data_node.text.present?
+      meta_data_node = @task_node.xpath('xmlns: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
+      @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
+      @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
+      @task.grading_hints = convert_xml_node_to_json(grading_hints_node) unless grading_hints_node.nil?
     end
 
     def add_model_solution(model_solution_node)

data/lib/proformaxml/version.rb

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

data/proformaxml.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
 
   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 'dachsfisch', '>= 0.2.0', '< 1.0.0'
   spec.add_dependency 'nokogiri', '>= 1.10.2', '< 2.0.0'
   spec.add_dependency 'rubyzip', '>= 1.2.2', '< 3.0.0'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: proformaxml
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Karol
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-22 00:00:00.000000000 Z
+date: 2023-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -56,7 +56,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.2.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 1.0.0
@@ -66,7 +66,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.2.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 1.0.0
@@ -119,6 +119,7 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
+- ".rubocop/factory-bot.yml"
 - ".rubocop/layout.yml"
 - ".rubocop/lint.yml"
 - ".rubocop/metrics.yml"
@@ -172,7 +173,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: Implements parts of ProFormA-XML specification