github-to-canvas-quiz 0.1.0

data/lib/github_to_canvas_quiz/parser/canvas/answer/multiple_dropdowns.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module GithubToCanvasQuiz
+  module Parser
+    module Canvas
+      module Answer
+        class MultipleDropdowns < Base
+          def parse
+            Model::Answer::MultipleDropdowns.new(
+              title: title,
+              text: data['text'],
+              comments: comments,
+              blank_id: data['blank_id']
+            )
+          end
+
+          private
+
+          def title
+            data.fetch('weight', 0).positive? ? 'Correct' : 'Incorrect'
+          end
+
+          def comments
+            choose_text(data.fetch('comments', ''), data.fetch('comments_html', ''))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/github_to_canvas_quiz/parser/canvas/answer/short_answer.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module GithubToCanvasQuiz
+  module Parser
+    module Canvas
+      module Answer
+        class ShortAnswer < Base
+          def parse
+            Model::Answer::ShortAnswer.new(
+              title: title,
+              text: data['text'],
+              comments: comments
+            )
+          end
+
+          private
+
+          def title
+            data.fetch('weight', 0).positive? ? 'Correct' : 'Incorrect'
+          end
+
+          def comments
+            choose_text(data.fetch('comments', ''), data.fetch('comments_html', ''))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/github_to_canvas_quiz/parser/canvas/answer/true_false.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module GithubToCanvasQuiz
+  module Parser
+    module Canvas
+      module Answer
+        class TrueFalse < Base
+          def parse
+            Model::Answer::TrueFalse.new(
+              title: title,
+              text: data['text'],
+              comments: comments
+            )
+          end
+
+          private
+
+          def title
+            data.fetch('weight', 0).positive? ? 'Correct' : 'Incorrect'
+          end
+
+          def comments
+            choose_text(data.fetch('comments', ''), data.fetch('comments_html', ''))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/github_to_canvas_quiz/parser/canvas/answer.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'answer/base'
+require_relative 'answer/fill_in_multiple_blanks'
+require_relative 'answer/matching'
+require_relative 'answer/multiple_answers'
+require_relative 'answer/multiple_choice'
+require_relative 'answer/multiple_dropdowns'
+require_relative 'answer/short_answer'
+require_relative 'answer/true_false'
+
+module GithubToCanvasQuiz
+  module Parser
+    module Canvas
+      module Answer
+        CLASSES = {
+          'fill_in_multiple_blanks_question' => FillInMultipleBlanks,
+          'matching_question' => Matching,
+          'multiple_answers_question' => MultipleAnswers,
+          'multiple_choice_question' => MultipleChoice,
+          'multiple_dropdowns_question' => MultipleDropdowns,
+          'short_answer_question' => ShortAnswer,
+          'true_false_question' => TrueFalse
+        }.freeze
+
+        def self.for(type, data)
+          raise UnknownQuestionType, type unless CLASSES.key?(type)
+
+          CLASSES[type].new(data).parse
+        end
+      end
+    end
+  end
+end

data/lib/github_to_canvas_quiz/parser/canvas/helpers.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module GithubToCanvasQuiz
+  module Parser
+    module Canvas
+      module Helpers
+        def choose_text(text, html)
+          html.empty? ? text : clean_html(html)
+        end
+
+        def clean_html(html)
+          html = remove_canvas_cruft(html)
+          HTMLEntities.new.decode(html)
+        end
+
+        def remove_canvas_cruft(html)
+          nodes = Nokogiri::HTML5.fragment(html)
+          nodes.css('.screenreader-only').remove
+          cleaned_html = nodes.to_html
+          cleaned_html.gsub(/\(?Links to an external site.\)?/, '')
+        end
+      end
+    end
+  end
+end

data/lib/github_to_canvas_quiz/parser/canvas/question.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module GithubToCanvasQuiz
+  module Parser
+    module Canvas
+      class Question
+        include Helpers
+
+        attr_reader :data
+
+        def initialize(data)
+          @data = data
+        end
+
+        def parse
+          Model::Question.new(
+            course_id: data['course_id'],
+            quiz_id: data['quiz_id'],
+            id: data['id'],
+            type: data['question_type'],
+            name: data['question_name'],
+            description: clean_html(data['question_text']),
+            sources: sources,
+            answers: answers,
+            distractors: distractors
+          )
+        end
+
+        private
+
+        def sources
+          html = data['neutral_comments_html']
+          return unless html
+
+          Nokogiri::HTML5.fragment(html).css('a').map do |node|
+            {
+              'name' => clean_html(node.content),
+              'url' => node['href']
+            }
+          end
+        end
+
+        def answers
+          data['answers'].map do |answer|
+            Answer.for(data['question_type'], answer)
+          end
+        end
+
+        def distractors
+          (data['matching_answer_incorrect_matches'] || '').split("\n")
+        end
+      end
+    end
+  end
+end

data/lib/github_to_canvas_quiz/parser/canvas/quiz.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module GithubToCanvasQuiz
+  module Parser
+    module Canvas
+      # Parses a quiz from the Canvas API and returns a Quiz
+      class Quiz
+        include Helpers
+
+        attr_reader :data
+
+        def initialize(data)
+          @data = data
+        end
+
+        def parse
+          Model::Quiz.new(
+            course_id: data['course_id'],
+            id: data['id'],
+            repo: repo,
+            title: data['title'],
+            description: description
+          )
+        end
+
+        private
+
+        # Remove header elements
+        def description
+          nodes = Nokogiri::HTML5.fragment(data['description'])
+          nodes.css('#git-data-element').remove
+          nodes.css('.fis-header').remove
+          nodes.to_html.strip
+        end
+
+        # Parse the repo from the #git-data-element
+        def repo
+          data_element = Nokogiri::HTML5.fragment(data['description']).css('#git-data-element').first
+          data_element ? data_element['data-repo'] : nil
+        end
+      end
+    end
+  end
+end

data/lib/github_to_canvas_quiz/parser/markdown/answer/base.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module GithubToCanvasQuiz
+  module Parser
+    module Markdown
+      module Answer
+        class Base
+          include Helpers::NodeParser
+
+          attr_reader :answer_nodes, :comment, :title
+
+          def initialize(title, nodes)
+            @title = title
+            scanner = Helpers::NodeScanner.new(nodes)
+            @answer_nodes = scanner.scan_before('blockquote') || scanner.scan_rest
+            @comment = scanner.eof? ? '' : scanner.scan_rest.first.inner_html.strip
+          end
+        end
+      end
+    end
+  end
+end

data/lib/github_to_canvas_quiz/parser/markdown/answer/fill_in_multiple_blanks.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module GithubToCanvasQuiz
+  module Parser
+    module Markdown
+      module Answer
+        class FillInMultipleBlanks < Base
+          def parse
+            text, blank_id = parse_text_from_nodes(answer_nodes, 'li')
+            Model::Answer::FillInMultipleBlanks.new(
+              title: title,
+              text: text,
+              comments: comment,
+              blank_id: blank_id
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/github_to_canvas_quiz/parser/markdown/answer/matching.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module GithubToCanvasQuiz
+  module Parser
+    module Markdown
+      module Answer
+        class Matching < Base
+          def parse
+            left, right = parse_text_from_nodes(answer_nodes, 'li')
+
+            Model::Answer::Matching.new(
+              title: title,
+              left: left,
+              right: right,
+              text: left,
+              comments: comment
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/github_to_canvas_quiz/parser/markdown/answer/multiple_answers.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module GithubToCanvasQuiz
+  module Parser
+    module Markdown
+      module Answer
+        class MultipleAnswers < Base
+          def parse
+            text = answer_nodes.to_html.strip
+
+            Model::Answer::MultipleAnswers.new(
+              title: title,
+              text: text,
+              comments: comment
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/github_to_canvas_quiz/parser/markdown/answer/multiple_choice.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module GithubToCanvasQuiz
+  module Parser
+    module Markdown
+      module Answer
+        class MultipleChoice < Base
+          def parse
+            Model::Answer::MultipleChoice.new(
+              title: title,
+              text: answer_nodes.to_html.strip,
+              comments: comment
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/github_to_canvas_quiz/parser/markdown/answer/multiple_dropdowns.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module GithubToCanvasQuiz
+  module Parser
+    module Markdown
+      module Answer
+        class MultipleDropdowns < Base
+          def parse
+            text, blank_id = parse_text_from_nodes(answer_nodes, 'li')
+            Model::Answer::MultipleDropdowns.new(
+              title: title,
+              text: text,
+              comments: comment,
+              blank_id: blank_id
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/github_to_canvas_quiz/parser/markdown/answer/short_answer.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module GithubToCanvasQuiz
+  module Parser
+    module Markdown
+      module Answer
+        class ShortAnswer < Base
+          def parse
+            text = parse_text_from_nodes(answer_nodes, 'p').first
+
+            Model::Answer::ShortAnswer.new(
+              title: title,
+              text: text,
+              comments: comment
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/github_to_canvas_quiz/parser/markdown/answer/true_false.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module GithubToCanvasQuiz
+  module Parser
+    module Markdown
+      module Answer
+        class TrueFalse < Base
+          def parse
+            text = parse_text_from_nodes(answer_nodes, 'p').first
+
+            Model::Answer::TrueFalse.new(
+              title: title,
+              text: text,
+              comments: comment
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/github_to_canvas_quiz/parser/markdown/answer.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'answer/base'
+require_relative 'answer/fill_in_multiple_blanks'
+require_relative 'answer/matching'
+require_relative 'answer/multiple_answers'
+require_relative 'answer/multiple_choice'
+require_relative 'answer/multiple_dropdowns'
+require_relative 'answer/short_answer'
+require_relative 'answer/true_false'
+
+module GithubToCanvasQuiz
+  module Parser
+    module Markdown
+      module Answer
+        CLASSES = {
+          'fill_in_multiple_blanks_question' => FillInMultipleBlanks,
+          'matching_question' => Matching,
+          'multiple_answers_question' => MultipleAnswers,
+          'multiple_choice_question' => MultipleChoice,
+          'multiple_dropdowns_question' => MultipleDropdowns,
+          'short_answer_question' => ShortAnswer,
+          'true_false_question' => TrueFalse
+        }.freeze
+
+        def self.for(type, title, nodes)
+          raise UnknownQuestionType, type unless CLASSES.key?(type)
+
+          CLASSES[type].new(title, nodes).parse
+        end
+      end
+    end
+  end
+end

data/lib/github_to_canvas_quiz/parser/markdown/base.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module GithubToCanvasQuiz
+  module Parser
+    module Markdown
+      class Base
+        attr_reader :frontmatter, :markdown
+
+        def initialize(markdown)
+          # Separate the frontmatter and the rest of the markdown content
+          parsed = if Pathname(markdown).exist?
+                     FrontMatterParser::Parser.parse_file(markdown)
+                   else
+                     FrontMatterParser::Parser.new(:md).call(markdown)
+                   end
+          @frontmatter = parsed.front_matter
+          @markdown = parsed.content
+        end
+      end
+    end
+  end
+end

data/lib/github_to_canvas_quiz/parser/markdown/helpers/node_parser.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module GithubToCanvasQuiz
+  module Parser
+    module Markdown
+      module Helpers
+        module NodeParser
+          def parse_text_from_nodes(nodes, selector)
+            nodes.css(selector).map do |node|
+              parse_text_from_node(node)
+            end
+          end
+
+          def parse_text_from_node(node)
+            CGI.unescapeHTML(node.content).strip
+          end
+        end
+      end
+    end
+  end
+end