proformaxml 1.4.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8284cbc28d6d2cabde0247312b5a526ffdb8be758261295757f3b4b132250004
-  data.tar.gz: 0fa49ec56a760ff164eed881b362bcb4307dcf6d789c9d395e65d67945c9654d
+  metadata.gz: d18194bbaa507eb74a566d374f500824deb6d40380291f0a691d9d98d5050466
+  data.tar.gz: 9903f5f2beae7909cb1e02f7e351f41d8c60fc3135a6ad8ea447441d07f696d0
 SHA512:
-  metadata.gz: 16a96f01c9bb5a05008820954da688600b65d01d4733a45204c933d205635977e8e18358b05c20f2d14c898a6fca3b6e005ad84aa20122df8f2f8e3b8471f73e
-  data.tar.gz: 7b743f6b785d69e549bfb0948e19d90fdec93644aca4ae312c7d27c27c7748def994f1ea11e10084fc061567db47e2b14e2e7a7b026378448d7bcbbdb2a5268b
+  metadata.gz: 828392048a14868c751d143d338416a08b283f85d3d16665a3267ea466ec701589851ca711deef2880064c966a6cbb9cbded366c4fddea4da470695f063ce631
+  data.tar.gz: b7b22d6e668c3bbfbba4a8280991c3800b4b340260dfc8096f3c96d1e755e888647c30c0b2f0f0b6d0736284b7716bbc9227be071fbfb7ec81a971151add6504

data/.rubocop/naming.yml

@@ -0,0 +1,4 @@
+# factory bot cop settings
+
+Naming/VariableNumber:
+  EnforcedStyle: snake_case

data/.rubocop/rspec.yml

@@ -26,10 +26,6 @@ RSpec/NestedGroups:
 RSpec/IndexedLet:
   Max: 2
 
-RSpec/FilePath:
-  CustomTransform:
-    ProformaXML: proformaxml
-
 RSpec/SpecFilePathFormat:
   CustomTransform:
     ProformaXML: proformaxml

data/.rubocop.yml

@@ -3,12 +3,14 @@ require:
   - rubocop-performance
   - rubocop-rails
   - rubocop-rspec
+  - rubocop-rspec_rails
 
 inherit_from:
   - .rubocop/factory-bot.yml
   - .rubocop/layout.yml
   - .rubocop/lint.yml
   - .rubocop/metrics.yml
+  - .rubocop/naming.yml
   - .rubocop/rspec.yml
   - .rubocop/style.yml
 

data/Gemfile

@@ -16,7 +16,9 @@ gem 'rspec'
 gem 'rspec-collection_matchers'
 gem 'rspec-github'
 gem 'rubocop'
+gem 'rubocop-factory_bot'
 gem 'rubocop-performance'
 gem 'rubocop-rails'
 gem 'rubocop-rspec'
+gem 'rubocop-rspec_rails'
 gem 'simplecov'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    proformaxml (1.4.0)
+    proformaxml (1.5.1)
       activemodel (>= 5.2.3, < 8.0.0)
       activesupport (>= 5.2.3, < 8.0.0)
       dachsfisch (~> 1.0.0)
@@ -11,24 +11,25 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (7.1.3.4)
-      activesupport (= 7.1.3.4)
-    activesupport (7.1.3.4)
+    activemodel (7.2.1)
+      activesupport (= 7.2.1)
+    activesupport (7.2.1)
       base64
       bigdecimal
-      concurrent-ruby (~> 1.0, >= 1.0.2)
+      concurrent-ruby (~> 1.0, >= 1.3.1)
       connection_pool (>= 2.2.5)
       drb
       i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
       minitest (>= 5.1)
-      mutex_m
-      tzinfo (~> 2.0)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
     ast (2.4.2)
     base64 (0.2.0)
     bigdecimal (3.1.8)
     byebug (11.1.3)
     coderay (1.1.3)
-    concurrent-ruby (1.3.1)
+    concurrent-ruby (1.3.4)
     connection_pool (2.4.1)
     dachsfisch (1.0.0)
       nokogiri (>= 1.14.1, < 2.0.0)
@@ -37,7 +38,7 @@ GEM
     drb (2.2.1)
     factory_bot (6.4.6)
       activesupport (>= 5.0.0)
-    ffi (1.16.3)
+    ffi (1.17.0)
     formatador (1.1.0)
     guard (2.18.1)
       formatador (>= 0.2.4)
@@ -60,20 +61,20 @@ GEM
     listen (3.9.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
+    logger (1.6.0)
     lumberjack (1.2.10)
     method_source (1.1.0)
     mini_portile2 (2.8.7)
-    minitest (5.23.1)
-    mutex_m (0.2.0)
+    minitest (5.25.1)
     nenv (0.3.0)
-    nokogiri (1.16.6)
+    nokogiri (1.16.7)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
     notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    parallel (1.24.0)
-    parser (3.3.1.0)
+    parallel (1.26.3)
+    parser (3.3.4.2)
       ast (~> 2.4.1)
       racc
     pry (0.14.2)
@@ -82,16 +83,16 @@ GEM
     pry-byebug (3.10.1)
       byebug (~> 11.0)
       pry (>= 0.13, < 0.15)
-    racc (1.8.0)
-    rack (3.0.11)
+    racc (1.8.1)
+    rack (3.1.7)
     rainbow (3.1.1)
     rake (13.2.1)
     rb-fsevent (0.11.2)
-    rb-inotify (0.10.1)
+    rb-inotify (0.11.1)
       ffi (~> 1.0)
-    regexp_parser (2.9.1)
-    rexml (3.2.8)
-      strscan (>= 3.0.9)
+    regexp_parser (2.9.2)
+    rexml (3.3.6)
+      strscan
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
@@ -100,7 +101,7 @@ GEM
       rspec-expectations (>= 2.99.0.beta1)
     rspec-core (3.13.0)
       rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.0)
+    rspec-expectations (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-github (2.4.0)
@@ -109,40 +110,37 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.1)
-    rubocop (1.63.5)
+    rubocop (1.65.1)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
+      regexp_parser (>= 2.4, < 3.0)
       rexml (>= 3.2.5, < 4.0)
       rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.31.3)
+    rubocop-ast (1.32.1)
       parser (>= 3.3.1.0)
-    rubocop-capybara (2.20.0)
-      rubocop (~> 1.41)
-    rubocop-factory_bot (2.25.1)
-      rubocop (~> 1.41)
-    rubocop-performance (1.21.0)
+    rubocop-factory_bot (2.26.1)
+      rubocop (~> 1.61)
+    rubocop-performance (1.21.1)
       rubocop (>= 1.48.1, < 2.0)
       rubocop-ast (>= 1.31.1, < 2.0)
-    rubocop-rails (2.24.1)
+    rubocop-rails (2.26.0)
       activesupport (>= 4.2.0)
       rack (>= 1.1)
-      rubocop (>= 1.33.0, < 2.0)
+      rubocop (>= 1.52.0, < 2.0)
       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)
+    rubocop-rspec (3.0.4)
+      rubocop (~> 1.61)
+    rubocop-rspec_rails (2.30.0)
+      rubocop (~> 1.61)
+      rubocop-rspec (~> 3, >= 3.0.1)
     ruby-progressbar (1.13.0)
     rubyzip (2.3.2)
+    securerandom (0.3.1)
     shellany (0.0.1)
     simplecov (0.22.0)
       docile (~> 1.1)
@@ -172,10 +170,12 @@ DEPENDENCIES
   rspec-collection_matchers
   rspec-github
   rubocop
+  rubocop-factory_bot
   rubocop-performance
   rubocop-rails
   rubocop-rspec
+  rubocop-rspec_rails
   simplecov
 
 BUNDLED WITH
-   2.5.11
+   2.5.15

data/lib/proformaxml/services/exporter.rb

@@ -3,14 +3,17 @@
 require 'proformaxml/helpers/export_helpers'
 
 module ProformaXML
-  class Exporter
+  class Exporter < ServiceBase
     include ProformaXML::Helpers::ExportHelpers
 
     def initialize(task:, version: nil)
+      super()
       @files = {}
       @task = task
       @version = version || SCHEMA_VERSIONS.first
-      add_placeholders if @version == '2.0'
+      if @version != SCHEMA_VERSION_LATEST
+        ProformaXML::TransformTask.call(task: @task, from_version: SCHEMA_VERSION_LATEST, to_version: @version)
+      end
     end
 
     def perform
@@ -49,7 +52,7 @@ module ProformaXML
       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.send(:'model-solutions') { model_solutions(xml) } if @task.model_solutions.any?
       xml.tests { tests(xml) }
       add_dachsfisch_node(xml, @task.grading_hints)
     end
@@ -98,15 +101,6 @@ module ProformaXML
       end
     end
 
-    # ms-placeholder only necessary for version 2.0 where model-solutions were mandatory
-    def add_placeholders
-      return if @task.model_solutions&.any?
-
-      file = TaskFile.new(content: '', id: 'ms-placeholder-file', used_by_grader: false, visible: 'no', binary: false)
-      model_solution = ModelSolution.new(id: 'ms-placeholder', files: [file])
-      @task.model_solutions = [model_solution]
-    end
-
     def headers
       {
         'xmlns' => "urn:proforma:v#{@version}",
@@ -117,8 +111,7 @@ module ProformaXML
     end
 
     def validate(doc)
-      validator = ProformaXML::Validator.new doc, @version
-      validator.perform
+      ProformaXML::Validator.call(doc:, expected_version: @version)
     end
 
     def write_to_zip(xmldoc)

data/lib/proformaxml/services/importer.rb

@@ -4,10 +4,11 @@ require 'active_support/core_ext/string'
 require 'proformaxml/helpers/import_helpers'
 
 module ProformaXML
-  class Importer
+  class Importer < ServiceBase
     include ProformaXML::Helpers::ImportHelpers
 
     def initialize(zip:, expected_version: nil)
+      super()
       @zip = zip
       @expected_version = expected_version
 
@@ -18,22 +19,19 @@ module ProformaXML
       @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
+      version_name_extractor = VersionAndNamespaceExtractor.new doc: @doc
+      @pro_ns, @doc_schema_version = version_name_extractor.perform&.values_at(:namespace, :version)
+
       errors = validate
       raise PreImportValidationError.new(errors.map(&:message)) if errors.any?
 
-      @pro_ns = proforma_namespace
       @task_node = @doc.xpath("/#{@pro_ns}:task")
 
       set_data
+      if @doc_schema_version != SCHEMA_VERSION_LATEST
+        ProformaXML::TransformTask.call(task: @task, from_version: @doc_schema_version, to_version: SCHEMA_VERSION_LATEST)
+      end
       @task
     end
 
@@ -111,7 +109,7 @@ module ProformaXML
       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'
+      @task.model_solutions << model_solution
     end
 
     def add_file(file_node)
@@ -147,8 +145,7 @@ module ProformaXML
     end
 
     def validate
-      validator = ProformaXML::Validator.new @doc, @expected_version
-      validator.perform
+      ProformaXML::Validator.call(doc: @doc, expected_version: @expected_version)
     end
   end
 end

data/lib/proformaxml/services/service_base.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module ProformaXML
+  class ServiceBase
+    def self.call(**)
+      new(**).perform
+    end
+  end
+end

data/lib/proformaxml/services/transform_task.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/array/wrap'
+
+module ProformaXML
+  class TransformTask < ServiceBase
+    def initialize(task:, from_version:, to_version:)
+      super()
+      @task = task
+      @from_version = from_version
+      @to_version = to_version
+    end
+
+    def perform
+      if SCHEMA_VERSIONS.include?(@from_version) && SCHEMA_VERSIONS.include?(@to_version)
+
+        method_name = "transform_from_#{@from_version.tr('.', '_')}_to_#{@to_version.tr('.', '_')}"
+
+        send(method_name) if defined? method_name
+      end
+    end
+
+    private
+
+    def transform_from_2_0_to_2_1
+      transform_submission_restrictions_from_2_0_to_2_1 unless @task.submission_restrictions.nil?
+      transform_external_resources_from_2_0_to_2_1 unless @task.external_resources.nil?
+
+      @task.model_solutions.filter! {|model_solution| model_solution.id != 'ms-placeholder' }
+    end
+
+    def transform_external_resources_from_2_0_to_2_1
+      ensure_array(@task.external_resources['external-resources']['external-resource']).each do |external_resource|
+        external_resource['@used-by-grader'] = external_resource['@used-by-grader'] || 'false'
+        external_resource['@visible'] = external_resource['@visible'] || 'no'
+      end
+    end
+
+    def transform_submission_restrictions_from_2_0_to_2_1
+      ensure_array(@task.submission_restrictions['submission-restrictions']['file-restriction']).each do |fr|
+        fr['@use'] = if fr['@required'].nil? || fr.delete('@required') == 'true'
+                       'required'
+                     else
+                       'optional'
+                     end
+      end
+    end
+
+    def transform_from_2_1_to_2_0
+      transform_submission_restrictions_from_2_1_to_2_0 unless @task.submission_restrictions.nil?
+      transform_external_resources_from_2_1_to_2_0 unless @task.external_resources.nil?
+      add_model_solution_placeholder
+    end
+
+    def transform_external_resources_from_2_1_to_2_0
+      ensure_array(@task.external_resources['external-resources']['external-resource']).each do |external_resource|
+        external_resource.delete('@visible')
+        external_resource.delete('@usage-by-lms')
+        external_resource.delete('@used-by-grader')
+      end
+    end
+
+    def transform_submission_restrictions_from_2_1_to_2_0
+      transform_file_restrictions_from_2_1_to_2_0
+      @task.submission_restrictions['submission-restrictions'].delete('description')
+      @task.submission_restrictions['submission-restrictions'].delete('internal-description')
+    end
+
+    def transform_file_restrictions_from_2_1_to_2_0
+      ensure_array(@task.submission_restrictions['submission-restrictions']['file-restriction']).each do |file_restriction|
+        file_restriction['@required'] = (file_restriction['@use'].nil? || file_restriction.delete('@use') == 'required').to_s
+      end
+    end
+
+    # when only one field is present, dachsfisch does not create an array. This method ensure, that we can work with an array
+    def ensure_array(data)
+      Array.wrap(data)
+    end
+
+    def add_model_solution_placeholder
+      return if @task.model_solutions&.any?
+
+      file = TaskFile.new(content: '', id: 'ms-placeholder-file', used_by_grader: false, visible: 'no', binary: false)
+      model_solution = ModelSolution.new(id: 'ms-placeholder', files: [file])
+      @task.model_solutions = [model_solution]
+    end
+  end
+end

data/lib/proformaxml/services/validator.rb

@@ -1,29 +1,22 @@
 # frozen_string_literal: true
 
 module ProformaXML
-  class Validator
-    def initialize(doc, expected_version = nil)
+  class Validator < ServiceBase
+    def initialize(doc:, expected_version: nil)
+      super()
       @doc = doc
       @expected_version = expected_version
     end
 
     def perform
+      version_name_extractor = VersionAndNamespaceExtractor.new doc: @doc
+      @pro_ns, @doc_schema_version = version_name_extractor.perform&.values_at(:namespace, :version)
+
       validate
     end
 
     private
 
-    def doc_schema_version
-      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)
       doc = Nokogiri::XML::Document.new
       doc.add_child(config_node.dup)
@@ -31,9 +24,9 @@ module ProformaXML
     end
 
     def validate
-      return ['no proformaxml version found'] if doc_schema_version.nil?
+      return ['no proformaxml version found'] if @doc_schema_version.nil?
 
-      version = @expected_version || doc_schema_version
+      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.

data/lib/proformaxml/services/version_and_namespace_extractor.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'proformaxml/helpers/export_helpers'
+
+module ProformaXML
+  class VersionAndNamespaceExtractor < ServiceBase
+    def initialize(doc:)
+      super()
+      @doc = doc
+    end
+
+    def perform
+      extract_schema_and_version
+    end
+
+    private
+
+    def extract_schema_and_version
+      namespace_regex = /^urn:proforma:v(\d.*)$/
+      potential_namespaces = @doc.namespaces.filter do |_, href|
+        href.match? namespace_regex
+      end
+      return unless potential_namespaces.length == 1
+
+      {
+        namespace: potential_namespaces.first[0].gsub('xmlns:', ''),
+        version: namespace_regex.match(potential_namespaces.first[1])&.captures&.dig(0),
+      }
+    end
+  end
+end

data/lib/proformaxml/version.rb

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

data/lib/proformaxml.rb

@@ -9,15 +9,19 @@ require 'dachsfisch'
 
 require 'proformaxml/version'
 
+require 'proformaxml/services/service_base'
 require 'proformaxml/services/importer'
 require 'proformaxml/services/exporter'
+require 'proformaxml/services/transform_task'
 require 'proformaxml/services/validator'
+require 'proformaxml/services/version_and_namespace_extractor'
 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
+  SCHEMA_VERSION_LATEST = '2.1'
 
   TEST_TYPE_SCHEMA_NAMES = %w[java-checkstyle regexptest unittest].freeze
   MAX_EMBEDDED_FILE_SIZE_KB = 50

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: proformaxml
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.1
 platform: ruby
 authors:
 - Karol
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-19 00:00:00.000000000 Z
+date: 2024-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -117,6 +117,7 @@ files:
 - ".rubocop/layout.yml"
 - ".rubocop/lint.yml"
 - ".rubocop/metrics.yml"
+- ".rubocop/naming.yml"
 - ".rubocop/rails.yml"
 - ".rubocop/rspec.yml"
 - ".rubocop/style.yml"
@@ -144,7 +145,10 @@ files:
 - lib/proformaxml/models/test.rb
 - lib/proformaxml/services/exporter.rb
 - lib/proformaxml/services/importer.rb
+- lib/proformaxml/services/service_base.rb
+- lib/proformaxml/services/transform_task.rb
 - lib/proformaxml/services/validator.rb
+- lib/proformaxml/services/version_and_namespace_extractor.rb
 - lib/proformaxml/version.rb
 - proformaxml.gemspec
 homepage: https://github.com/openHPI/proformaxml
@@ -167,7 +171,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.5.15
 signing_key:
 specification_version: 4
 summary: Implements parts of ProFormA-XML specification