atomic_assessments_import 0.3.0 → 0.5.0

data/lib/atomic_assessments_import.rb

@@ -7,26 +7,44 @@ require_relative "atomic_assessments_import/version"
 require_relative "atomic_assessments_import/csv"
 require_relative "atomic_assessments_import/writer"
 require_relative "atomic_assessments_import/export"
+require_relative "atomic_assessments_import/exam_soft"
 
 module AtomicAssessmentsImport
   class Error < StandardError; end
 
-  def self.convert(path)
+  def self.register_converter(mime_type, source, klass)
+    @converters ||= {}
+    @converters[[mime_type, source]] = klass
+  end
+
+  def self.convert(path, import_from)
     type = MimeMagic.by_path(path)&.type
+    converter_class = @converters[[type, import_from]]
+    
+    raise "Unsupported file type: #{type} from #{import_from == nil ? "Unspecified Source" : import_from}. Make sure the file type conversion is available for the specified source." unless converter_class
+    
+    converter_class.new(path).convert
+  end
 
-    converter =
-      case type
-      when "text/csv"
-        CSV::Converter.new(path)
-      else
-        raise "Unsupported file type"
-      end
+  ######################
+  # Register converters: format is register_converter(mime_type, source, class)
+  ######################
+  # CSV converter - csv is the original/default importer so it can be used with either source specified as "csv" or with no source specified
+  register_converter("text/csv", "csv", CSV::Converter)
+  register_converter("text/csv", nil, CSV::Converter)
 
-    converter.convert
-  end
+  # ExamSoft converters
+  ## rtf
+  register_converter("application/rtf", "examsoft", ExamSoft::Converter)
+  ## docx
+  register_converter("application/vnd.openxmlformats-officedocument.wordprocessingml.document", "examsoft", ExamSoft::Converter)
+  ## html
+  register_converter("text/html", "examsoft", ExamSoft::Converter) 
+  register_converter("application/xhtml+xml", "examsoft", ExamSoft::Converter)
 
-  def self.convert_to_aa_format(input_path, output_path)
-    result = convert(input_path)
+  
+  def self.convert_to_aa_format(input_path, output_path, import_from: nil)
+    result = convert(input_path, import_from)
     AtomicAssessmentsImport::Export.create(output_path, result)
     {
       errors: result[:errors],

metadata

@@ -1,11 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: atomic_assessments_import
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Sean Collings
 - Matt Petro
+- Jacob Schwartz
 bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
@@ -80,6 +81,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pandoc-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
 description: Importer to Convert different formats to AA's import format
 email:
 - support@atomicjolt.com
@@ -93,13 +108,36 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- docs/plans/2026-02-11-flexible-examsoft-importer-design.md
+- docs/plans/2026-02-11-flexible-examsoft-importer-plan.md
 - lib/atomic_assessments_import.rb
 - lib/atomic_assessments_import/csv.rb
 - lib/atomic_assessments_import/csv/converter.rb
-- lib/atomic_assessments_import/csv/questions/multiple_choice.rb
-- lib/atomic_assessments_import/csv/questions/question.rb
-- lib/atomic_assessments_import/csv/utils.rb
+- lib/atomic_assessments_import/exam_soft.rb
+- lib/atomic_assessments_import/exam_soft/chunker.rb
+- lib/atomic_assessments_import/exam_soft/chunker/heading_split_strategy.rb
+- lib/atomic_assessments_import/exam_soft/chunker/horizontal_rule_split_strategy.rb
+- lib/atomic_assessments_import/exam_soft/chunker/metadata_marker_strategy.rb
+- lib/atomic_assessments_import/exam_soft/chunker/numbered_question_strategy.rb
+- lib/atomic_assessments_import/exam_soft/chunker/strategy.rb
+- lib/atomic_assessments_import/exam_soft/converter.rb
+- lib/atomic_assessments_import/exam_soft/extractor.rb
+- lib/atomic_assessments_import/exam_soft/extractor/correct_answer_detector.rb
+- lib/atomic_assessments_import/exam_soft/extractor/feedback_detector.rb
+- lib/atomic_assessments_import/exam_soft/extractor/metadata_detector.rb
+- lib/atomic_assessments_import/exam_soft/extractor/options_detector.rb
+- lib/atomic_assessments_import/exam_soft/extractor/question_stem_detector.rb
+- lib/atomic_assessments_import/exam_soft/extractor/question_type_detector.rb
 - lib/atomic_assessments_import/export.rb
+- lib/atomic_assessments_import/questions/cloze_dropdown.rb
+- lib/atomic_assessments_import/questions/essay.rb
+- lib/atomic_assessments_import/questions/fill_in_the_blank.rb
+- lib/atomic_assessments_import/questions/matching.rb
+- lib/atomic_assessments_import/questions/multiple_choice.rb
+- lib/atomic_assessments_import/questions/ordering.rb
+- lib/atomic_assessments_import/questions/question.rb
+- lib/atomic_assessments_import/questions/short_answer.rb
+- lib/atomic_assessments_import/utils.rb
 - lib/atomic_assessments_import/version.rb
 - lib/atomic_assessments_import/writer.rb
 homepage: https://github.com/atomicjolt/atomic_assessments_import
@@ -119,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.1
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Importer to Convert different formats to AA's import format
 test_files: []

data/lib/atomic_assessments_import/csv/questions/multiple_choice.rb

@@ -1,104 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "question"
-
-module AtomicAssessmentsImport
-  module CSV
-    module Questions
-      class MultipleChoice < Question
-        QUESTION_INDEXES = ("a".."o").to_a.freeze
-
-        def question_type
-          "mcq"
-        end
-
-        def question_data
-          raise "Missing correct answer" if correct_responses.empty?
-          raise "Missing options" if options.empty?
-
-          super.deep_merge(
-            {
-              multiple_responses: multiple_responses,
-              options: options,
-              validation: {
-                scoring_type: scoring_type,
-                valid_response: {
-                  score: points,
-                  value: correct_responses,
-                },
-                rounding: "none",
-                penalty: 1,
-              },
-              shuffle_options: Utils.parse_boolean(@row["shuffle options"], default: false),
-              ui_style: ui_style,
-            }
-          )
-        end
-
-        def metadata
-          super.merge(
-            {
-              distractor_rationale_response_level: distractor_rationale_response_level,
-            }
-          )
-        end
-
-        def options
-          QUESTION_INDEXES.filter_map.with_index do |value, cnt|
-            key = "option #{value}"
-            if @row[key].present?
-              {
-                label: @row[key],
-                value: cnt.to_s,
-              }
-            end
-          end
-        end
-
-        def correct_responses
-          correct = @row["correct answer"]&.split(";")&.map(&:strip)&.map(&:downcase) || []
-
-          correct.filter_map do |value|
-            QUESTION_INDEXES.find_index(value).to_s
-          end
-        end
-
-        def distractor_rationale_response_level
-          QUESTION_INDEXES.map do |value|
-            key = "option #{value} feedback"
-            @row[key].presence || ""
-          end.reverse.drop_while(&:blank?).reverse
-        end
-
-        def multiple_responses
-          case @row["template"]&.downcase
-          when "multiple response", "block layout multiple response", "choice matrix",
-            "choice matrix inline", "choice matrix labels"
-            true
-          else
-            false
-          end
-        end
-
-        def ui_style
-          case @row["template"]&.downcase
-          when "multiple response"
-            { type: "horizontal" }
-          when "block layout", "block layout multiple response"
-            { choice_label: "upper-alpha", type: "block" }
-          when "choice matrix"
-            { horizontal_lines: false, type: "table" }
-          when "choice matrix inline"
-            { horizontal_lines: false, type: "inline" }
-          when "choice matrix labels"
-            { stem_numeration: "upper-alpha", horizontal_lines: false, type: "table" }
-          when nil, "", "multiple choice", "standard"
-            { type: "horizontal" }
-          else
-            raise "Unknown template: #{@row["template"]}"
-          end
-        end
-      end
-    end
-  end
-end

data/lib/atomic_assessments_import/csv/questions/question.rb

@@ -1,86 +0,0 @@
-# frozen_string_literal: true
-
-module AtomicAssessmentsImport
-  module CSV
-    module Questions
-      class Question
-        def initialize(row)
-          @row = row
-          # @question_reference = Digest::UUID.uuid_v5(Digest::UUID::URL_NAMESPACE, "#{@item_url}/question")
-          @reference = SecureRandom.uuid
-        end
-
-        def self.load(row)
-          case row["question type"]
-          when nil, "", /multiple choice/i, /mcq/i
-            MultipleChoice.new(row)
-          else
-            raise "Unknown question type #{row['question type']}"
-          end
-        end
-
-        attr_reader :reference
-
-        def question_type
-          raise NotImplementedError
-        end
-
-        def question_data
-          {
-            stimulus: @row["question text"],
-            type: question_type,
-            metadata: metadata,
-            **{
-              stimulus_review: @row["stimulus review"],
-              instructor_stimulus: @row["instructor stimulus"],
-            }.compact,
-          }
-        end
-
-        def metadata
-          {
-            distractor_rationale: @row["distractor rationale"],
-            sample_answer: @row["sample answer"],
-            acknowledgements: @row["acknowledgements"],
-            general_feedback: @row["general feedback"],
-            correct_feedback: @row["correct feedback"],
-            partially_correct_feedback: @row["partially correct feedback"],
-            incorrect_feedback: @row["incorrect feedback"],
-          }.compact
-        end
-
-        def scoring_type
-          case @row["scoring type"]
-          when nil, "", /Partial Match Per Response/i
-            "partialMatchV2"
-          when /Partial Match/i
-            "partialMatch"
-          when /Exact Match/i
-            "exactMatch"
-          else
-            raise "Unknown scoring type #{@row['scoring type']}"
-          end
-        end
-
-        def points
-          if @row["points"].blank?
-            1
-          else
-            Float(@row["points"])
-          end
-        rescue ArgumentError
-          1
-        end
-
-        def to_learnosity
-          {
-            type: question_type,
-            widget_type: "response",
-            reference: @reference,
-            data: question_data,
-          }
-        end
-      end
-    end
-  end
-end

data/lib/atomic_assessments_import/csv/utils.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-require "csv"
-require "active_support/core_ext/digest/uuid"
-
-require_relative "questions/question"
-require_relative "questions/multiple_choice"
-
-module AtomicAssessmentsImport
-  module CSV
-    module Utils
-      def self.parse_boolean(value, default:)
-        case value&.downcase
-        when "true", "yes", "y", "1"
-          true
-        when "false", "no", "n", "0"
-          false
-        else
-          default
-        end
-      end
-    end
-  end
-end