asker-tool 2.7.2 → 2.9.0

data/lib/asker/data/project_data.rb

@@ -11,7 +11,8 @@ class ProjectData
   end
 
   def reset
-    @default = {inputbasedir: FileUtils.pwd,
+    # @default = {inputbasedir: FileUtils.pwd,
+    @default = {inputbasedir: Dir.pwd,
                 stages: {d: true, b: true, f: true, i: true, s: true, t: true},
                 threshold: 0.5,
                 outputdir: "output",
@@ -44,7 +45,7 @@ class ProjectData
     @param[:logname] = "#{@param[:projectname]}.log"
     @param[:outputname] = "#{@param[:projectname]}-gift.txt"
     @param[:lessonname] = "#{@param[:projectname]}.txt"
-    @param[:yamlname] = "#{@param[:projectname]}-questions.yaml"
+    @param[:yamlname] = "#{@param[:projectname]}.yaml"
     @param[:moodlename] = "#{@param[:projectname]}-moodle.xml"
 
     outputdir = get(:outputdir)

data/lib/asker/displayer/code_displayer.rb

@@ -1,11 +1,11 @@
 require "terminal-table"
 require_relative "../logger"
 
-module CodeDisplayer
+class CodeDisplayer
   ##
   # Show all "code" data on screen
   # @param codes (Array) List of "code" data
-  def self.show(codes)
+  def call(codes)
     return if codes.nil? || codes.size.zero?
 
     total_c = total_q = total_e = 0

data/lib/asker/displayer/concept_ai_displayer.rb

@@ -10,7 +10,7 @@ class ConceptAIDisplayer
   ##
   # Display ConceptAI stat on screen
   # @param concepts_ai (Array)
-  def self.show(concepts_ai)
+  def call(concepts_ai)
     stages = Application.instance.config["questions"]["stages"]
     # Create table HEAD
     screen_table = Terminal::Table.new do |st|
@@ -80,7 +80,9 @@ class ConceptAIDisplayer
     Logger.info "#{screen_table}\n"
   end
 
-  private_class_method def self.export_excluded_questions(screen_table, concepts_ai)
+  private
+
+  def export_excluded_questions(screen_table, concepts_ai)
     # Create table BODY
     total = {}
     total[:q] = total[:c] = 0
@@ -114,7 +116,7 @@ class ConceptAIDisplayer
       total[:ss], total[:st]]
   end
 
-  private_class_method def self.export_notes
+  def export_notes
     exclude_questions = Application.instance.config["questions"]["exclude"].to_s
     renderer = ERB.new(File.read(File.join(File.dirname(__FILE__), "concept_ai_displayer.erb")))
     Logger.info Rainbow(renderer.result(binding)).white

data/lib/asker/displayer/concept_displayer.rb

@@ -2,11 +2,11 @@ require_relative "../application"
 require_relative "../formatter/concept_string_formatter"
 require_relative "../logger"
 
-module ConceptDisplayer
+class ConceptDisplayer
   ##
   # Show concepts on screen
   # @param concepts (Array) List of concept data
-  def self.show(concepts)
+  def call(concepts)
     return if concepts.nil? || concepts.size.zero?
 
     show_mode = Application.instance.config["global"]["show_mode"]

data/lib/asker/displayer/problem_displayer.rb

@@ -1,16 +1,16 @@
 require "terminal-table"
 require_relative "../logger"
 
-module ProblemDisplayer
+class ProblemDisplayer
   ##
   # Show all "problem" data on screen
   # @param problems (Array) List of "problems" data
-  def self.show(problems)
+  def call(problems)
     return if problems.nil? || problems.size.zero?
 
-    total_p = total_q = total_e = 0
+    total_p = total_q = total_e = total_a = total_s = 0
     my_screen_table = Terminal::Table.new do |st|
-      st << %w[Problem Desc Questions Entries xFactor]
+      st << %w[Problem Desc Questions Entries xFactor a s]
       st << :separator
     end
 
@@ -23,14 +23,19 @@ module ProblemDisplayer
         e += 1 if !ask[:answer].nil?
       end
 
+      desc = Rainbow(problem.desc[0, 24]).green
       q = problem.questions.size
       factor = "Unknown"
       factor = (q.to_f / e).round(2).to_s unless e.zero?
-      desc = Rainbow(problem.desc[0, 24]).green
-      my_screen_table.add_row [problem.name, desc, q, e, factor]
+      a = problem.stats[:answer]
+      s = problem.stats[:steps]
+
+      my_screen_table.add_row [problem.name, desc, q, e, factor, a, s]
       total_p += 1
       total_q += q
       total_e += e
+      total_a += a
+      total_s += s
     end
     return unless total_p.positive?
 
@@ -38,7 +43,9 @@ module ProblemDisplayer
     my_screen_table.add_row [Rainbow("TOTAL = #{total_p}").bright, "",
       Rainbow(total_q.to_s).bright,
       Rainbow(total_e.to_s).bright,
-      Rainbow((total_q / total_e.to_f).round(2)).bright]
+      Rainbow((total_q / total_e.to_f).round(2)).bright,
+      Rainbow(total_a.to_s).bright,
+      Rainbow(total_s.to_s).bright]
     Logger.verboseln Rainbow("\n[INFO] Showing PROBLEMs statistics").white
     Logger.verboseln my_screen_table.to_s
   end

data/lib/asker/displayer/stats_displayer.rb

@@ -10,8 +10,8 @@ module StatsDisplayer
   def self.show(data)
     return unless Application.instance.config["global"]["show_mode"]
 
-    ConceptAIDisplayer.show(data[:concepts_ai])
-    CodeDisplayer.show(data[:codes_ai])
-    ProblemDisplayer.show(data[:problems])
+    ConceptAIDisplayer.new.call(data[:concepts_ai])
+    CodeDisplayer.new.call(data[:codes_ai])
+    ProblemDisplayer.new.call(data[:problems])
   end
 end

data/lib/asker/exporter/doc/format_code2doc.rb

@@ -0,0 +1,17 @@
+class FormatCode2Doc
+  def call(code)
+    out = ""
+    title = "#{code.filename} (#{code.type})"
+    out << ("-" * title.size + "\n")
+    out << "#{title}\n"
+    if code.features.size.positive?
+      out << "* features: #{code.features.join(", ")}"
+    end
+    out << "\n"
+    code.lines.each_with_index do |line, index|
+      out << "#{index} | #{line}\n"
+    end
+    out << "\n"
+    out
+  end
+end

data/lib/asker/exporter/doc/format_concept2doc.rb

@@ -0,0 +1,30 @@
+require "terminal-table"
+
+class FormatConcept2Doc
+  def call(concept)
+    out = ""
+    title = concept.names.join(", ")
+    out << ("-" * title.size + "\n")
+    out << "#{title}\n"
+    concept.texts.each { |text| out << "* #{text}\n" }
+    concept.images.each do |data|
+      out << "* (#{data[:type]}) #{data[:url]}\n"
+    end
+    out << "\n"
+    concept.tables.each do |table|
+      out << format_table(table)
+    end
+    out
+  end
+
+  private
+
+  def format_table(table)
+    my_screen_table = Terminal::Table.new do |st|
+      st << table.fields
+      st << :separator
+      table.rows.each { |r| st.add_row r }
+    end
+    "#{my_screen_table}\n"
+  end
+end

data/lib/asker/exporter/doc/format_problem2doc.rb

@@ -0,0 +1,41 @@
+class FormatProblem2Doc
+  def initialize(problem)
+    @problem = problem
+  end
+
+  def call
+    # attr_accessor :varnames
+    # attr_accessor :cases
+    out = ""
+    title = "Problem: #{@problem.name}"
+    out << ("-" * title.size + "\n")
+    out << "#{title}\n"
+    desc = replace_case_values(@problem.desc)
+    out << "#{desc}\n"
+    @problem.asks.each_with_index do |ask, index|
+      text = replace_case_values(ask[:text])
+      out << "#{index + 1}) #{text}\n"
+      if ask[:answer]
+        answer = replace_case_values(ask[:answer])
+        out << "   #{answer}\n"
+      else
+        ask[:steps].each do |step|
+          step = replace_case_values(step)
+          out << "   #{step}\n"
+        end
+      end
+    end
+    out << "\n"
+    out << "\n"
+    out
+  end
+
+  private
+
+  def replace_case_values(text)
+    output = text.clone
+    keyvalues = @problem.varnames.zip @problem.cases[0]
+    keyvalues.each { |varname, value | output.gsub!(varname, value) }
+    output
+  end
+end

data/lib/asker/exporter/export2doc.rb

@@ -0,0 +1,41 @@
+require_relative "doc/format_code2doc"
+require_relative "doc/format_concept2doc"
+require_relative "doc/format_problem2doc"
+require_relative "../version"
+
+class Export2Doc
+  def call(data, project)
+    file_open(project)
+    export_codes(data[:codes])
+    export_concepts(data[:concepts])
+    export_problems(data[:problems])
+    @file.close
+  end
+
+  private
+
+  def file_open(project)
+    @file = File.new(project.get(:lessonpath), "w")
+    @file.write("Asker    : version #{Asker::VERSION}\n")
+    @file.write("Filename : #{project.get(:lessonname)}\n")
+    @file.write("Datetime : #{Time.new}\n\n")
+  end
+
+  def export_codes(codes)
+    codes.each do |code|
+      @file.write(FormatCode2Doc.new.call(code)) if code.process
+    end
+  end
+
+  def export_concepts(concepts)
+    concepts.each do |concept|
+      @file.write(FormatConcept2Doc.new.call(concept)) if concept.process
+    end
+  end
+
+  def export_problems(problems)
+    problems.each do |problem|
+      @file.write(FormatProblem2Doc.new(problem).call) if problem.process
+    end
+  end
+end

data/lib/asker/exporter/{data_gift_exporter.rb → export2gift.rb}

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 
-require_relative "concept_ai_gift_exporter"
-require_relative "code_gift_exporter"
-require_relative "problem_gift_exporter"
+require_relative "gift/export_code2gift"
+require_relative "gift/export_concept2gift"
+require_relative "gift/export_problem2gift"
 require_relative "../application"
 require_relative "../version"
 
-module DataGiftExporter
+class Export2Gift
   ##
   # Export an array of Data (ConceptAIs, Codes and Problems objects) into GIFT file
   # @param data (Hash)
   # @param project (Project)
-  def self.export_all(data, project)
+  def call(data, project)
     file = File.open(project.get(:outputpath), "w")
     file.write("// " + ("=" * 50) + "\n")
     file.write("// #{Asker::NAME}    : version #{Asker::VERSION}\n")
@@ -21,9 +21,9 @@ module DataGiftExporter
     category = Application.instance.config["questions"]["category"]
     file.write("$CATEGORY: $course$/#{category}\n") unless category.nil?
 
-    ConceptAIGiftExporter.export_all(data[:concepts_ai], file)
-    CodeGiftExporter.export_all(data[:codes_ai], file)
-    ProblemGiftExporter.new.call(data[:problems], file)
+    ExportConcept2Gift.new.call(data[:concepts_ai], file)
+    ExportCode2Gift.new.call(data[:codes_ai], file)
+    ExportProblem2Gift.new.call(data[:problems], file)
     file.close
   end
 end

data/lib/asker/exporter/{data_moodle_exporter.rb → export2moodle_xml.rb}

@@ -1,9 +1,9 @@
 require_relative "../application"
 require_relative "../version"
-require_relative "../formatter/question_moodle_formatter"
+require_relative "../formatter/question2moodle_xml"
 
-module DataMoodleExporter
-  def self.call(data, project)
+class Export2MoodleXML
+  def call(data, project)
     file = File.open(project.get(:moodlepath), "w")
     add_header(file, project)
 
@@ -14,7 +14,9 @@ module DataMoodleExporter
     close(file)
   end
 
-  def self.add_header(file, project)
+  private
+
+  def add_header(file, project)
     file.write("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n")
     file.write("<quiz>\n")
     file.write("<!--\n#{"=" * 50}\n")
@@ -25,37 +27,37 @@ module DataMoodleExporter
     file
   end
 
-  def self.close(file)
+  def close(file)
     file.write("</quiz>\n")
     file.close
   end
 
-  def self.export_concepts(concepts:, file:)
+  def export_concepts(concepts:, file:)
     concepts.each do |concept_ai|
       next unless concept_ai.concept.process?
 
       Application.instance.config["questions"]["stages"].each do |stage|
         concept_ai.questions[stage].each do |question|
-          file.write(QuestionMoodleFormatter.to_s(question))
+          file.write(Question2MoodleXML.new.format(question))
         end
       end
     end
   end
 
-  def self.export_codes(codes:, file:)
+  def export_codes(codes:, file:)
     codes.each do |code|
       next unless code.process?
       code.questions.each do |question|
-        file.write QuestionMoodleFormatter.to_s(question)
+        file.write Question2MoodleXML.new.format(question)
       end
     end
   end
 
-  def self.export_problems(problems:, file:)
+  def export_problems(problems:, file:)
     problems.each do |problem|
       next unless problem.process?
       problem.questions.each do |question|
-        file.write QuestionMoodleFormatter.to_s(question)
+        file.write Question2MoodleXML.new.format(question)
       end
     end
   end

data/lib/asker/exporter/export2yaml.rb

@@ -0,0 +1,70 @@
+require "yaml"
+require_relative "../formatter/question2hash"
+
+class Export2YAML
+  ##
+  # Export array of ConceptAI objects from Project to YAML output file
+  # @param concepts_ai (Array)
+  # @param project (Project)
+  def call(data, project)
+    questions = []
+    questions += get_questions_from_codes(data)
+    questions += get_questions_from_concepts(data)
+    questions += get_questions_from_problems(data)
+
+    output = {
+      lang: project.get(:lang_code),
+      projectname: project.get(:projectname),
+      questions: questions
+    }
+
+    yamlfile = File.open(project.get(:yamlpath), "w")
+    yamlfile.write(output.to_yaml)
+    yamlfile.close
+  end
+
+  private
+
+  def get_questions_from_codes(data)
+    questions = []
+    data[:codes].each do |code|
+      next unless code.process
+      code.questions.each do |question|
+        questions << Question2Hash.new.format(question)
+      end
+    end
+    questions
+  end
+
+  def get_questions_from_concepts(data)
+    questions = []
+    data[:concepts_ai].each do |concept_ai|
+      questions += get_questions_from_concept concept_ai
+    end
+    questions
+  end
+
+  def get_questions_from_concept(concept_ai)
+    questions = []
+    return questions unless concept_ai.concept.process?
+
+    Application.instance.config["questions"]["stages"].each do |stage|
+      concept_ai.questions[stage].each do |question|
+        question.lang = concept_ai.concept.lang
+        questions << Question2Hash.new.format(question)
+      end
+    end
+    questions
+  end
+
+  def get_questions_from_problems(data)
+    questions = []
+    data[:problems].each do |problem|
+      next unless problem.process
+      problem.questions.each do |question|
+        questions << Question2Hash.new.format(question)
+      end
+    end
+    questions
+  end
+end

data/lib/asker/exporter/export_action.rb

@@ -0,0 +1,18 @@
+require_relative "export2doc"
+require_relative "export2gift"
+require_relative "export2moodle_xml"
+require_relative "export2yaml"
+
+##
+# Export Output data files
+# * YAML, Doc (txt), Gift (ConceptAI, Code) and Moodle XML (ConceptAI, Code)
+class ExportAction
+  def call(data, project)
+    output = Application.instance.config["output"]
+
+    Export2Doc.new.call(data, project) if output["doc"] == "yes"
+    Export2Gift.new.call(data, project) if output["gift"] == "yes"
+    Export2MoodleXML.new.call(data, project) if output["moodle"] == "yes"
+    Export2YAML.new.call(data, project) if output["yaml"] == "yes"
+  end
+end

data/lib/asker/exporter/{code_gift_exporter.rb → gift/export_code2gift.rb}

@@ -1,17 +1,18 @@
-require_relative "../formatter/question_gift_formatter"
+require_relative "question_gift_formatter"
 
-module CodeGiftExporter
+class ExportCode2Gift
   ##
   # Export an Array of codes to gift format file
   # @param codes (Array)
-  def self.export_all(codes, file)
+  def call(codes, file)
     codes.each { |code| export(code, file) }
   end
 
+  private
+
   ##
   # Export 1 code to gift format file
-  # @param code (Code)
-  def self.export(code, file)
+  def export(code, file)
     return false unless code.process?
 
     file.write head(code)
@@ -21,7 +22,7 @@ module CodeGiftExporter
     true
   end
 
-  private_class_method def self.head(code)
+  def head(code)
     s = "\n"
     s += "// " + "=" * 50 + "\n"
     s += "// Code #{code.type}: #{code.filename} (#{code.questions.size})\n"

data/lib/asker/exporter/{concept_ai_gift_exporter.rb → gift/export_concept2gift.rb}

@@ -1,22 +1,21 @@
-# frozen_string_literal: true
+require_relative "question_gift_formatter"
 
-require_relative "../formatter/question_gift_formatter"
-
-# Export ConceptIA data to gift to outputfile
-module ConceptAIGiftExporter
+class ExportConcept2Gift
   ##
   # Export an array of ConceptAI objects from Project into GIFT outpufile
   # @param concepts_ai (Array)
   # @param file (File)
-  def self.export_all(concepts_ai, file)
+  def call(concepts_ai, file)
     concepts_ai.each { |concept_ai| export(concept_ai, file) }
   end
 
+  private
+
   ##
   # Export 1 concept_ai from project
   # @param concept_ai (ConceptAI)
   # @param file (File)
-  private_class_method def self.export(concept_ai, file)
+  def export(concept_ai, file)
     return unless concept_ai.concept.process?
 
     file.write head(concept_ai.concept.name)
@@ -31,7 +30,7 @@ module ConceptAIGiftExporter
   # Convert Concept name into gift format head
   # @param name (String)
   # @return String
-  private_class_method def self.head(name)
+  def head(name)
     s = "\n"
     s += "// " + "=" * 50 + "\n"
     s += "// Concept name: #{name}\n"

data/lib/asker/exporter/{problem_gift_exporter.rb → gift/export_problem2gift.rb}

@@ -1,6 +1,6 @@
-require_relative "../formatter/question_gift_formatter"
+require_relative "question_gift_formatter"
 
-class ProblemGiftExporter
+class ExportProblem2Gift
   ##
   # Export an Array of problems to gift format file
   # @param problems (Array)

data/lib/asker/{formatter → exporter/gift}/question_gift_formatter.rb

@@ -1,6 +1,3 @@
-# frozen_string_literal: false
-
-# Transform Questions into Gift format
 module QuestionGiftFormatter
   ##
   # Convert question object into gift formatted string

data/lib/asker/formatter/concept_string_formatter.rb

@@ -3,7 +3,6 @@
 require "rainbow"
 require "terminal-table"
 
-# Define methods to transform Concept into String
 module ConceptStringFormatter
   ##
   # Formatter Concept to String

data/lib/asker/formatter/{question_hash_formatter.rb → question2hash.rb}

@@ -1,6 +1,7 @@
-# Transform Questions into YAML format
-module QuestionHashFormatter
-  def self.to_hash(question)
+require_relative "../logger"
+
+class Question2Hash
+  def format(question)
     @question = question
     # Return question using YAML format
     s = {}
@@ -9,23 +10,30 @@ module QuestionHashFormatter
     s[:text] = sanitize(@question.text)
     s[:type] = @question.type
     s[:feedback] = sanitize(@question.feedback.to_s)
-    s[:lang] = @question.lang.code.to_sym
     case @question.type
+    when :boolean
+      s[:answer] = @question.good
     when :choice
       s[:answer] = sanitize(@question.good)
       s[:options] = (@question.bads + [@question.good]).shuffle
-    when :boolean
-      s[:answer] = @question.good
+    when :ddmatch
+      s[:answer] = @question.matching
     when :match
       s[:answer] = @question.matching
+    when :ordering
+      s[:answer] = @question.ordering
     when :short
       @question.shorts.uniq!
       s[:answer] = @question.shorts
+    else
+      Logger.warn "[WARN] Question2Hash: Unkown type (#{@question.type})"
     end
     s
   end
 
-  def self.sanitize(input = "")
+  private
+
+  def sanitize(input = "")
     output = input.dup
     output.gsub!("#", "\\#")
     output.tr!("\n", " ")

data/lib/asker/formatter/{question_moodle_formatter.rb → question2moodle_xml.rb}

@@ -1,15 +1,13 @@
-# frozen_string_literal: false
-
 require "erb"
 require_relative "../application"
 
 # Transform Questions into Gift format
-class QuestionMoodleFormatter
+class Question2MoodleXML
   ##
   # Convert question object into gift formatted string
   # @param question (Question)
   # @return String
-  def self.to_s(question)
+  def format(question)
     case question.type
     when :choice
       fractions = Application.instance.config["questions"]["fractions"]
@@ -31,7 +29,7 @@ class QuestionMoodleFormatter
     when :short
       template = File.read(File.join(File.dirname(__FILE__), "moodle", "shortanswer.erb"))
     else
-      warn "[ERROR] QuestionMoodleFormatter: Unknown type (#{question.type})"
+      warn "[ERROR] Question2MoodleXML: Unknown type (#{question.type})"
       exit 1
     end
     renderer = ERB.new(template)

data/lib/asker/loader/code_loader.rb

@@ -13,7 +13,7 @@ module CodeLoader
   def self.call(xmldata, filepath)
     data = read_codedata_from_xml(xmldata, File.basename(filepath))
     code = Code.new(File.dirname(filepath), data[:path], data[:type])
-    code.features << data[:features]
+    code.features = data[:features]
     code
   end
 

data/lib/asker/loader/content_loader.rb

@@ -48,6 +48,7 @@ class ContentLoader
       lang_code = ProjectData.instance.lang
       Logger.warn "ContentLoader: Applying default lang (#{lang_code})"
     end
+    ProjectData.instance.set(:lang_code, lang_code)
     LangFactory.instance.get(lang_code)
   end