atomic_assessments_import 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4da5264007a4f90b2beb7c2237855d31229aac3e7266d8c2c6a47a30d364177b
+  data.tar.gz: 2d592d63a61a4888c5df9e4c374d68083b91c8db0fbef079330af3417a440912
+SHA512:
+  metadata.gz: f7ee30d1484fbf993757311a0b76f2ddcfa2aa3dffc64b2bfb1ff42e5a02693cf27dad1c42f684bd8659955b8a5306024440ce462a99d37f8dceeb139dcb5d28
+  data.tar.gz: 514f3ac7e9d57e41cbcac462c3f8d55593e282584ddd827c1851d74008cc4549ef2271e83afa83c76e7a9babc6f867f2815d634bb76ca6f0db5350b4451d4741

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,56 @@
+require:
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 3.3
+
+Style/TrailingCommaInArguments:
+  Description: 'Checks for trailing comma in argument lists.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
+  EnforcedStyleForMultiline: comma
+  Enabled: false
+
+Style/TrailingCommaInArrayLiteral:
+  Description: 'Checks for trailing comma in array literals.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
+  EnforcedStyleForMultiline: comma
+  Enabled: true
+
+Style/TrailingCommaInHashLiteral:
+  Description: 'Checks for trailing comma in hash literals.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
+  EnforcedStyleForMultiline: comma
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+Style/StringLiterals:
+  Description: 'Checks if uses of quotes match the configured preference.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#consistent-string-literals'
+  EnforcedStyle: double_quotes
+  Enabled: true
+
+Metrics/AbcSize:
+  Max: 50
+
+Metrics/CyclomaticComplexity:
+  Max: 20
+
+Metrics/MethodLength:
+  Max: 50
+
+Metrics/ClassLength:
+  Max: 200
+
+RSpec/MultipleExpectations:
+  Max: 16
+
+Style/Documentation:
+  Enabled: false
+
+Style/NegatedIf:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-09-27
+
+- Initial release

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Atomic Jolt
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,110 @@
+# AtomicAssessmentsImports
+
+Import converters for atomic assessments
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add atomic_assessments_imports
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install atomic_assessments_imports
+
+## Conversion scripts
+
+Convert a CSV to a learnosity archive:
+
+    $ bin/convert input.csv output.zip
+
+Convert a CSV to json:
+
+    $ bin/convert_to_json input.csv
+
+## CSV input format
+
+CSV Columns:
+
+### Question ID
+  External question id.  Importing the same question ID twice will overwrite previous imports
+### Title
+  Item title
+### Tag: tag_type
+  Entries in this column represent tag names in type "tag_type".  This column can be repeated any number of times with multiple tag types.
+### Question Text
+  Question stem
+### Question Type
+  Question type. One of:
+  - Multiple choice (default)
+### Template
+  Question type template.  One of:
+  - Standard (default)
+  - Block layout
+  - Multiple response
+  - Block layout multiple response
+  - Choice matrix
+  - Choice matrix inline
+  - Choice matrix labels
+  "Standard" and "Block layout" are single response question types.  The other templates are multiple response.
+### Correct Answer
+  Correct response option, e.g. "A"
+  For multiple response questions, use a semicolon separator.  e.g. "A;C;D"
+### Option A
+  Text for option A
+### Option B
+  Text for option B
+### Option C through Option O
+  Text for subsequent options
+### Option A Feedback
+  Feedback for option A
+### Option B Feedback
+  Feedback for option B
+### Option C Feedback through Option O Feedback
+  Feedback for subsequent options
+### Scoring Type
+  Learnosity scoring type.  One of:
+  - Partial Match Per Response (default)
+  - Partial Match
+  - Exact Match
+### Shuffle options
+  Whether to shuffle answers. One of:
+  - Yes
+  - No (default)
+### Points
+  Question points (default 1)
+### General Feedback
+  General feedback
+### Correct Feedback
+  Correct feedback
+### Partially Correct Feedback
+  Partially correct feedback
+### Incorrect Feedback
+  Incorrect feedback
+### Distractor Rationale
+  Distractor rationale feedback
+### Stimulus review
+  Stimulus (review only)
+### Acknowledgements
+  Acknowledgements
+### Instructor stimulus
+  Instructor stimulus
+### Sample Answer
+  Sample answer
+### Description
+  Item description
+### Alignment URL
+  URL used to generate standard alignment tags. This column can be repeated.
+
+
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/atomicjolt/atomic_assessments_imports.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/atomic_assessments_import/csv/converter.rb

@@ -0,0 +1,146 @@
+# frozen_string_literal: true
+
+require "byebug"
+require "csv"
+require "active_support/core_ext/digest/uuid"
+
+require_relative "questions/question"
+require_relative "questions/multiple_choice"
+require_relative "utils"
+
+module AtomicAssessmentsImport
+  module CSV
+    class Converter
+      HEADERS = [
+        "question id",
+        "title",
+        /tag: *[a-zA-Z0-9_].*/,
+        "question text",
+        "question type",
+        "template",
+        "correct answer",
+        /option [a-o]/,
+        /option [a-o] feedback/,
+        "scoring type",
+        "shuffle options",
+        "points",
+        "general feedback",
+        "correct feedback",
+        "partially correct feedback",
+        "incorrect feedback",
+        "distractor rationale",
+        "stimulus review",
+        "acknowledgements",
+        "instructor stimulus",
+        "sample answer",
+        "description",
+        "alignment url",
+      ].freeze
+
+      def initialize(file)
+        @file = file
+      end
+
+      def convert
+        items = []
+        questions = []
+
+        ::CSV.foreach(
+          @file,
+          headers: true,
+          header_converters: lambda do |header|
+            normalized = header.strip
+            normalized =
+              if (m = normalized.match(/^tag:(.+)$/i))
+                "tag:#{m[1].strip}"
+              else
+                normalized.downcase
+              end
+            if !HEADERS.find { |h| h.is_a?(Regexp) ? h =~ normalized : h == normalized }
+              raise ArgumentError, "Unknown column: #{header}"
+            end
+
+            normalized
+          end,
+          converters: ->(data) { data&.strip }
+        ) do |row|
+          item, question_widgets = convert_row(row)
+
+          items << item
+          questions += question_widgets
+        rescue StandardError => e
+          raise e, "Error processing row: #{row.inspect} - #{e.message}"
+        end
+
+        {
+          activities: [],
+          items:,
+          questions:,
+          features: [],
+          errors: [],
+        }
+      end
+
+      private
+
+      def tags(row)
+        tags = {}
+        row.headers.each.with_index do |header, idx|
+          if header&.start_with?("tag:")
+            tag_name = header.gsub(/^tag:/, "").to_sym
+            tags[tag_name] ||= []
+            tags[tag_name] << row[idx] if row[idx].present?
+          end
+        end
+        if alignment_urls(row).present?
+          tags[:lrn_aligned] = alignment_urls(row).map do |url|
+            Digest::UUID.uuid_v5(Digest::UUID::URL_NAMESPACE, url)
+          end
+        end
+        tags
+      end
+
+      def alignment_urls(row)
+        if row.headers.include?("alignment url")
+          row.headers.filter_map.with_index do |header, idx|
+            row[idx] if header == "alignment url" && row[idx].present?
+          end
+        end.presence
+      end
+
+      def convert_row(row)
+        question = Questions::Question.load(row)
+        item = {
+          reference: SecureRandom.uuid,
+          title: row["title"] || "",
+          status: "published",
+          tags: tags(row),
+          metadata: {
+            import_date: Time.now.iso8601,
+            **{
+              question_id: row["question id"],
+              alignment: alignment_urls(row),
+            }.compact,
+          },
+          description: row["description"] || "",
+          questions: [
+            {
+              reference: question.reference,
+              type: question.question_type,
+            },
+          ],
+          features: [],
+          definition: {
+            widgets: [
+              {
+                reference: question.reference,
+                widget_type: "response",
+              },
+            ]
+          },
+        }
+        [item, [question.to_learnosity]]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,104 @@
+# 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 ArgumentError, "Missing correct answer" if correct_responses.empty?
+          raise ArgumentError, "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"
+            { type: "horizontal" }
+          else
+            raise NotImplementedError, "Unknown template"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,86 @@
+# 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 NotImplementedError, "Unknown 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 NotImplementedError, "Unknown 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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "byebug"
+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

data/lib/atomic_assessments_import/csv.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "csv/converter"
+
+module AtomicAssessmentsImport
+  module CSV
+  end
+end

data/lib/atomic_assessments_import/export.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module AtomicAssessmentsImport
+  module Export
+    def self.create(path, data)
+      AtomicAssessmentsImport::Writer.new(path).open do |writer|
+        writer.write("export.json", { version: 2.0 }.to_json)
+
+        data[:activities].each do |activity|
+          writer.write("activities/#{activity[:reference]}.json", activity.to_json)
+        end
+
+        data[:questions].each do |question|
+          writer.write("questions/#{question[:reference]}.json", question.to_json)
+        end
+
+        data[:items].each do |item|
+          writer.write("items/#{item[:reference]}.json", item.to_json)
+        end
+      end
+    end
+  end
+end

data/lib/atomic_assessments_import/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module AtomicAssessmentsImport
+  VERSION = "0.1.0"
+end

data/lib/atomic_assessments_import/writer.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "zip"
+
+module AtomicAssessmentsImport
+  class Writer
+    def initialize(path)
+      @path = path
+    end
+
+    def open
+      @zip = Zip::File.open(@path, Zip::File::CREATE)
+      yield self
+    ensure
+      @zip.close
+    end
+
+    def write(filename, content)
+      raise "Zip file is not open" unless @zip
+
+      @zip.get_output_stream(filename) { |file| file.write(content) }
+    end
+  end
+end

data/lib/atomic_assessments_import.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "active_support/all"
+require "mimemagic"
+require_relative "atomic_assessments_import/version"
+require_relative "atomic_assessments_import/csv"
+require_relative "atomic_assessments_import/writer"
+require_relative "atomic_assessments_import/export"
+
+module AtomicAssessmentsImport
+  class Error < StandardError; end
+
+  def self.convert(path)
+    type = MimeMagic.by_path(path)&.type
+
+    converter =
+      case type
+      when "text/csv"
+        CSV::Converter.new(path)
+      else
+        raise ArgumentError, "Unsupported file type"
+      end
+
+    converter.convert
+  end
+
+  def self.convert_to_aa_format(input_path, output_path)
+    result = convert(input_path)
+    AtomicAssessmentsImport::Export.create(output_path, result)
+    {
+      errors: result[:errors],
+    }
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: atomic_assessments_import
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sean Collings
+- Matt Petro
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-02-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mimemagic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Importer to Convert different formats to AA's import format
+email:
+- support@atomicjolt.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE
+- README.md
+- Rakefile
+- 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/export.rb
+- lib/atomic_assessments_import/version.rb
+- lib/atomic_assessments_import/writer.rb
+homepage: https://github.com/atomicjolt/atomic_assessments_import
+licenses: []
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: Importer to Convert different formats to AA's import format
+test_files: []