asker-tool 2.6.0 → 2.7.0

data/lib/asker/data/table.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'row'
-require_relative 'template'
+require_relative "row"
+require_relative "template"
+require_relative "../logger"
 
-# Contains data table information
 class Table
   attr_reader :name, :id
   attr_reader :fields, :sequence
@@ -14,30 +14,25 @@ class Table
   attr_reader :simple
 
   ##
-  # initialize Table object
   # @param concept (Concept)
   # @param xml_data (XML)
   def initialize(concept, xml_data)
     @concept = concept
     read_attributes_from_xml(xml_data)
 
-    @simple = { lang: true, type: true }
-    @types  = ['text']        * @fields.size
-    @langs  = [@concept.lang] * @fields.size
+    @simple = {lang: true, type: true}
+    @types = ["text"] * @fields.size
+    @langs = [@concept.lang] * @fields.size
 
     @datarows = [] # DEV experiment replace row data with row objects
     read_data_from_xml(xml_data)
     @rows = @datarows.map(&:raws)
   end
 
-  ##
-  # Return table name
   def to_s
     @name.to_s
   end
 
-  ##
-  # Return true if table has a sequence defined
   def sequence?
     @sequence.size.positive?
   end
@@ -48,7 +43,7 @@ class Table
   # * types(index) => Return type for fields[index]
   # @param index (Integer)
   def types(index = :all)
-    @types = (['text'] * @fields.size) if @types.nil?
+    @types = (["text"] * @fields.size) if @types.nil?
     return @types if index == :all
 
     @types[index]
@@ -68,75 +63,59 @@ class Table
   ##
   # Fill:fields, name and id from XML input
   # @param xml_data (XML)
-  # rubocop:disable Metrics/AbcSize
   def read_attributes_from_xml(xml_data)
-    # read attributes from XML data
-    t = xml_data.attributes['fields'].to_s.strip.split(',')
+    t = xml_data.attributes["fields"].to_s.strip.split(",")
     t.each(&:strip!)
     @fields = t || []
 
-    @name = ''
+    @name = ""
     @fields.each { |i| @name = "#{@name}$#{i.to_s.strip.downcase}" }
     @id = "#{@concept.name}.#{@name}"
 
     @sequence = []
-    return unless xml_data.attributes['sequence']
+    return unless xml_data.attributes["sequence"]
 
-    @sequence = xml_data.attributes['sequence'].to_s.split(',')
+    @sequence = xml_data.attributes["sequence"].to_s.split(",")
   end
-  # rubocop:enable Metrics/AbcSize
 
-  ##
-  # Build table data from xml input
-  # @param xml_data (XML)
-  # rubocop:disable Metrics/MethodLength
-  # rubocop:disable Metrics/AbcSize
   def read_data_from_xml(xml_data)
     xml_data.elements.each do |i|
       case i.name
-      when 'lang'
+      when "lang"
         read_lang_from_xml(i)
-      when 'row'
+      when "row"
         @datarows << Row.new(self, @datarows.size, i)
-      when 'sequence'
-        @sequence = i.text.split(',')
-      when 'template'
+      when "sequence"
+        @sequence = i.text.split(",")
+      when "template"
         @datarows += Template.new(self, @datarows.size, i).datarows
-      when 'type'
+      when "type"
         read_type_from_xml(i)
       else
-        puts Rainbow("[ERROR] concept/table#xml_data with #{i.name}").red.bright
+        Logger.warn "Table: Tag unkown (concept/table/#{i.name})"
       end
     end
   end
-  # rubocop:enable Metrics/MethodLength
-  # rubocop:enable Metrics/AbcSize
 
-  # rubocop:disable Metrics/MethodLength
-  # rubocop:disable Metrics/AbcSize
-  # rubocop:disable Style/ConditionalAssignment
   def read_lang_from_xml(xml_data)
-    j = xml_data.text.split(',')
+    j = xml_data.text.split(",")
     codes = @langs.map(&:code)
-    return if j.join(',') == codes.join(',')
+    return if j.join(",") == codes.join(",")
 
     simple_off(:lang)
     @langs = []
     j.each do |k|
-      if ['*', ''].include? k.strip
-        @langs << @concept.lang
+      @langs << if ["*", ""].include? k.strip
+        @concept.lang
       else
-        @langs << LangFactory.instance.get(k.strip.to_s)
+        LangFactory.instance.get(k.strip.to_s)
       end
     end
   end
-  # rubocop:enable Metrics/MethodLength
-  # rubocop:enable Metrics/AbcSize
-  # rubocop:enable Style/ConditionalAssignment
 
   def read_type_from_xml(xml_data)
-    j = xml_data.text.split(',')
-    return if j.join(',') == @types.join(',')
+    j = xml_data.text.split(",")
+    return if j.join(",") == @types.join(",")
 
     simple_off(:type)
     @types = []

data/lib/asker/data/template.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: false
 
-require 'rexml/document'
-require_relative 'row'
+require "rexml/document"
+require_relative "row"
 
 # This class process "template" tag used by Tables
 class Template
@@ -19,10 +19,10 @@ class Template
     vars = {}
     v = xml.attributes
     v.keys.each do |i|
-      if i == 'mode'
+      if i == "mode"
         @mode = v[i].to_sym
       else
-        vars[i] = v[i].split(',')
+        vars[i] = v[i].split(",")
       end
     end
     # fill_vars_values(vars,mode)
@@ -34,13 +34,13 @@ class Template
   end
 
   def load_template_from(xml)
-    template = ''
+    template = ""
     xml.elements.each { |i| template << i.to_s + "\n" }
     template
   end
 
   def apply_vars_to_template(vars, template)
-    output = ''
+    output = ""
     return output if vars.size.zero?
 
     max = vars.first[1].size
@@ -57,7 +57,7 @@ class Template
     data = "<template>\n#{data_string}\n</template>"
     xml = REXML::Document.new(data)
     xml.root.elements.each do |i|
-      if i.name == 'row'
+      if i.name == "row"
         datarows << Row.new(table, index, i)
         index += 1
       end

data/lib/asker/data/world.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative '../loader/image_url_loader'
+require_relative "../loader/image_url_loader"
 
 class World
   # TODO: change how World class works ?
@@ -37,7 +37,7 @@ class World
 
       concepts[c.name] = c
       filenames << c.filename
-      contexts  << c.context
+      contexts << c.context
     end
     filenames.uniq!
     contexts.uniq!
@@ -52,7 +52,7 @@ class World
     urls = {}
 
     @concepts&.each_key { |key| searchs << key }
-    @contexts.each { |filter| searchs << filter.join(' ').to_s }
+    @contexts.each { |filter| searchs << filter.join(" ").to_s }
     searchs.each do |search|
       threads << Thread.new { urls[search] = ImageUrlLoader.load(search) }
     end

data/lib/asker/{formatter → deprecated}/question_moodlexml_formatter.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 # Transform Questions into Gift format
 module QuestionMoodleXMLFormatter
   def self.to_s(question)
@@ -18,51 +16,51 @@ module QuestionMoodleXMLFormatter
   def self.choice_to_s(question)
     s = []
 
-    penalties = ['', '%-50%', '%-33.33333%', '%-25%', '%-20%']
+    penalties = ["", "%-50%", "%-33.33333%", "%-25%", "%-20%"]
     penalty = penalties[question.bads.size]
 
     s << "<!-- question: #{question.name}  -->"
     s << '<question type="multichoice">'
-    s << '  <name>'
+    s << "  <name>"
     s << "    <text>#{question.name}</text>"
-    s << '  </name>'
+    s << "  </name>"
     s << '  <questiontext format="html">'
     s << "    <text><![CDATA[#{question.text}]]></text>"
-    s << '  </questiontext>'
+    s << "  </questiontext>"
     s << '  <generalfeedback format="html">'
     s << "    <text>#{question.feedback}</text>"
-    s << '  </generalfeedback>'
-    s << '  <defaultgrade>1.0000000</defaultgrade>'
+    s << "  </generalfeedback>"
+    s << "  <defaultgrade>1.0000000</defaultgrade>"
     s << "  <penalty>#{penalty}</penalty>"
-    s << '  <hidden>0</hidden>'
-    s << '  <single>true</single>'
+    s << "  <hidden>0</hidden>"
+    s << "  <single>true</single>"
     s << "  <shuffleanswers>#{question.shuffle?}</shuffleanswers>"
-    s << '  <answernumbering>abc</answernumbering>'
+    s << "  <answernumbering>abc</answernumbering>"
     s << '  <incorrectfeedback format="html">'
     s << "    <text>#{question.feedback}</text>"
-    s << '  </incorrectfeedback>'
+    s << "  </incorrectfeedback>"
     s << '  <answer fraction="100" format="html">'
     s << "    <text>#{question.good}</text>"
-    s << '  </answer>'
+    s << "  </answer>"
     s << '  <answer fraction="-25" format="html">'
     s << "    <text>#{question.bad[0]}</text>"
-    s << '  </answer>'
-    s << '  </question>'
+    s << "  </answer>"
+    s << "  </question>"
     s << '  <answer fraction="-25" format="html">'
     s << "    <text>#{question.bad[1]}</text>"
-    s << '  </answer>'
-    s << '  </question>'
+    s << "  </answer>"
+    s << "  </question>"
     s << '  <answer fraction="-25" format="html">'
     s << "    <text>#{question.bad[2]}</text>"
-    s << '  </answer>'
-    s << '  </question>'
+    s << "  </answer>"
+    s << "  </question>"
     s
   end
 
-  def self.sanitize(input = '')
+  def self.sanitize(input = "")
     output = input.dup
     output.tr!("\n", " ")
-    output.tr!(":", "\:")
+    output.tr!(":", ":")
     output.tr!("=", "\\=")
     # output.gsub!('{', "\\{")
     # output.gsub!('}', "\\}")

data/lib/asker/displayer/code_displayer.rb

@@ -19,13 +19,13 @@ module CodeDisplayer
 
       e = code.lines.size
       q = code.questions.size
-      factor = 'Unkown'
+      factor = "Unkown"
       factor = (q.to_f / e).round(2).to_s unless e.zero?
       my_screen_table.add_row [Rainbow(File.basename(code.filename)).green,
-                               code.type,
-                               q,
-                               e,
-                               factor]
+        code.type,
+        q,
+        e,
+        factor]
       total_c += 1
       total_q += q
       total_e += e
@@ -33,13 +33,13 @@ module CodeDisplayer
 
     my_screen_table.add_separator
     my_screen_table.add_row [Rainbow("TOTAL = #{total_c}").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.to_s).bright,
+      Rainbow(total_e.to_s).bright,
+      Rainbow((total_q / total_e.to_f).round(2)).bright]
     return unless total_c.positive?
 
-    Logger.verboseln "\n[INFO] Showing CODE statistics"
+    Logger.verboseln "\n[INFO] Showing CODEs statistics"
     Logger.verboseln my_screen_table.to_s
   end
 end

data/lib/asker/displayer/concept_ai_displayer.erb

@@ -1,5 +1,5 @@
 
-[INFO] Showing CONCEPT statistics
+[INFO] Showing CONCEPTs statistics
  * Exclude questions: <%= exclude_questions %>
  * Annotations:
    ├── (d) Definitions     <= Concept.def

data/lib/asker/displayer/concept_ai_displayer.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
 require "erb"
+require "rainbow"
 require "terminal-table"
 require_relative "../application"
 require_relative "../logger"
 
-# Display ConceptAI stat on screen
 class ConceptAIDisplayer
   ##
   # Display ConceptAI stat on screen
@@ -51,7 +51,7 @@ class ConceptAIDisplayer
       factor = "Unkown"
       factor = (t.to_f / e).round(2).to_s unless e.zero?
       screen_table.add_row [Rainbow(concept_ai.concept.name(:screen)).green.bright,
-                            t, e, factor, sd, sb, sf, si, ss, st]
+        t, e, factor, sd, sb, sf, si, ss, st]
 
       total[:q] += t
       total[:e] += e
@@ -71,13 +71,13 @@ class ConceptAIDisplayer
     # Create table TAIL
     screen_table.add_separator
     screen_table.add_row [Rainbow("#{total[:c]} concept/s").bright,
-                          Rainbow(total[:q].to_s).bright,
-                          Rainbow(total[:e].to_s).bright,
-                          Rainbow((total[:q].to_f / total[:e]).round(2)).bright,
-                          total[:sd], total[:sb], total[:sf],
-                          total[:si], total[:ss], total[:st]]
+      Rainbow(total[:q].to_s).bright,
+      Rainbow(total[:e].to_s).bright,
+      Rainbow((total[:q].to_f / total[:e]).round(2)).bright,
+      total[:sd], total[:sb], total[:sf],
+      total[:si], total[:ss], total[:st]]
     export_notes
-    Logger.verboseln "#{screen_table}\n"
+    Logger.info "#{screen_table}\n"
   end
 
   private_class_method def self.export_excluded_questions(screen_table, concepts_ai)
@@ -107,16 +107,16 @@ class ConceptAIDisplayer
       total[:ss] += ss
       total[:st] += st
     end
-    screen_table.add_row [Rainbow('Excluded questions').yellow.bright,
-                          total[:q], '-', '-',
-                          total[:sd], total[:sb],
-                          total[:sf], total[:si],
-                          total[:ss], total[:st]]
+    screen_table.add_row [Rainbow("Excluded questions").yellow.bright,
+      total[:q], "-", "-",
+      total[:sd], total[:sb],
+      total[:sf], total[:si],
+      total[:ss], total[:st]]
   end
 
   private_class_method def self.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.verboseln renderer.result(binding)
+    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
   end
 end

data/lib/asker/displayer/concept_displayer.rb

@@ -7,6 +7,8 @@ module ConceptDisplayer
   # Show concepts on screen
   # @param concepts (Array) List of concept data
   def self.show(concepts)
+    return if concepts.nil? || concepts.size.zero?
+
     show_mode = Application.instance.config["global"]["show_mode"]
     return unless show_mode
 
@@ -14,8 +16,8 @@ module ConceptDisplayer
     Logger.verboseln msg
     case show_mode
     when "resume"
-      s = "* Concepts (#{concepts.count}): "
-      concepts.each { |c| s += c.name + ", " }
+      names = concepts.map { |c| c.name }
+      s = " * Concepts (#{names.count}): #{names.join(",")}"
       Logger.verboseln s
     when "default"
       # Only show Concepts with process attr true

data/lib/asker/displayer/problem_displayer.rb

@@ -0,0 +1,45 @@
+require "terminal-table"
+require_relative "../logger"
+
+module ProblemDisplayer
+  ##
+  # Show all "problem" data on screen
+  # @param problems (Array) List of "problems" data
+  def self.show(problems)
+    return if problems.nil? || problems.size.zero?
+
+    total_p = total_q = total_e = 0
+    my_screen_table = Terminal::Table.new do |st|
+      st << %w[Problem Desc Questions Entries xFactor]
+      st << :separator
+    end
+
+    problems.each do |problem|
+      next unless problem.process?
+
+      e = problem.cases.size
+      problem.asks.each do |ask|
+        e += ask[:steps].size
+        e += 1 if !ask[:answer].nil?
+      end
+
+      q = problem.questions.size
+      factor = "Unkown"
+      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]
+      total_p += 1
+      total_q += q
+      total_e += e
+    end
+    return unless total_p.positive?
+
+    my_screen_table.add_separator
+    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]
+    Logger.verboseln Rainbow("\n[INFO] Showing PROBLEMs statistics").white
+    Logger.verboseln my_screen_table.to_s
+  end
+end

data/lib/asker/displayer/stats_displayer.rb

@@ -1,22 +1,17 @@
 # frozen_string_literal: true
 
-require_relative '../application'
-require_relative 'concept_ai_displayer'
-require_relative 'code_displayer'
+require_relative "../application"
+require_relative "concept_ai_displayer"
+require_relative "code_displayer"
+require_relative "problem_displayer"
 
-# Display Stats on screen.
-# * Display all "Concept AI"
-# * Display all "Code"
 module StatsDisplayer
-  # Display Stats on screen.
-  # * Display all "Concept AI"
-  # * Display all "Code"
-  # @param data (Hash) With concept_ai list and code list
+  # @param data (Hash) With concept_ai, code and problem list
   def self.show(data)
-    return unless Application.instance.config['global']['show_mode']
+    return unless Application.instance.config["global"]["show_mode"]
 
-    # show_final_results
     ConceptAIDisplayer.show(data[:concepts_ai])
     CodeDisplayer.show(data[:codes_ai])
+    ProblemDisplayer.show(data[:problems])
   end
 end

data/lib/asker/exporter/code_gift_exporter.rb

@@ -23,9 +23,9 @@ module CodeGiftExporter
 
   private_class_method def self.head(code)
     s = "\n"
-    s += '// ' + '=' * 50 + "\n"
+    s += "// " + "=" * 50 + "\n"
     s += "// Code #{code.type}: #{code.filename} (#{code.questions.size})\n"
-    s += '// ' + '=' * 50 + "\n"
+    s += "// " + "=" * 50 + "\n"
     s
   end
 end

data/lib/asker/exporter/concept_ai_gift_exporter.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative '../formatter/question_gift_formatter'
+require_relative "../formatter/question_gift_formatter"
 
 # Export ConceptIA data to gift to outputfile
 module ConceptAIGiftExporter
@@ -20,7 +20,7 @@ module ConceptAIGiftExporter
     return unless concept_ai.concept.process?
 
     file.write head(concept_ai.concept.name)
-    Application.instance.config['questions']['stages'].each do |stage|
+    Application.instance.config["questions"]["stages"].each do |stage|
       concept_ai.questions[stage].each do |question|
         file.write(QuestionGiftFormatter.to_s(question))
       end
@@ -33,9 +33,9 @@ module ConceptAIGiftExporter
   # @return String
   private_class_method def self.head(name)
     s = "\n"
-    s += '// ' + '=' * 50 + "\n"
+    s += "// " + "=" * 50 + "\n"
     s += "// Concept name: #{name}\n"
-    s += '// ' + '=' * 50 + "\n"
+    s += "// " + "=" * 50 + "\n"
     s
   end
 end

data/lib/asker/exporter/concept_ai_yaml_exporter.rb

@@ -1,5 +1,5 @@
-require 'yaml'
-require_relative '../formatter/question_hash_formatter'
+require "yaml"
+require_relative "../formatter/question_hash_formatter"
 
 # Use to export data from ConceptIA to YAML format
 module ConceptAIYAMLExporter
@@ -12,11 +12,11 @@ module ConceptAIYAMLExporter
     concepts_ai.each do |concept_ai|
       questions += get_questions_from concept_ai
     end
-    params = { lang: project.get(:lang) ,
-               projectname: project.get(:projectname) }
-    output = { params: params, questions: questions }
+    params = {lang: project.get(:lang),
+              projectname: project.get(:projectname)}
+    output = {params: params, questions: questions}
 
-    yamlfile = File.open(project.get(:yamlpath), 'w')
+    yamlfile = File.open(project.get(:yamlpath), "w")
     yamlfile.write(output.to_yaml)
     yamlfile.close
   end
@@ -25,7 +25,7 @@ module ConceptAIYAMLExporter
     data = []
     return data unless concept_ai.concept.process?
 
-    Application.instance.config['questions']['stages'].each do |stage|
+    Application.instance.config["questions"]["stages"].each do |stage|
       concept_ai.questions[stage].each do |question|
         question.lang = concept_ai.concept.lang
         data << QuestionHashFormatter.to_hash(question)

data/lib/asker/exporter/concept_doc_exporter.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require_relative '../formatter/concept_doc_formatter'
-require_relative '../version'
+require_relative "../formatter/concept_doc_formatter"
+require_relative "../version"
 
 ##
 # Export Concept to Doc file
@@ -9,12 +9,12 @@ module ConceptDocExporter
   ##
   # Export array of concepts to doc
   def self.export_all(concepts, project)
-    file = File.new(project.get(:lessonpath), 'w')
-    file.write('=' * 50 + "\n")
+    file = File.new(project.get(:lessonpath), "w")
+    file.write("=" * 50 + "\n")
     file.write("Created by : #{Asker::NAME} (version #{Asker::VERSION})\n")
     file.write("File       : #{project.get(:lessonname)}\n")
     file.write("Time       : #{Time.new}\n")
-    file.write('=' * 50 + "\n")
+    file.write("=" * 50 + "\n")
 
     concepts.each do |concept|
       file.write(ConceptDocFormatter.to_s(concept)) if concept.process

data/lib/asker/exporter/data_gift_exporter.rb

@@ -1,30 +1,29 @@
 # frozen_string_literal: true
 
-require_relative 'concept_ai_gift_exporter'
-require_relative 'code_gift_exporter'
-require_relative '../version'
-require_relative '../application'
+require_relative "concept_ai_gift_exporter"
+require_relative "code_gift_exporter"
+require_relative "problem_gift_exporter"
+require_relative "../application"
+require_relative "../version"
 
-# Export Data (ConceptIA and Code) to gift to outputfile
 module DataGiftExporter
   ##
-  # Export an array of Data (ConceptAI and Code objects) into GIFT outpufile
+  # 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)
-    file = File.open(project.get(:outputpath), 'w')
-    file.write('// ' + ('=' * 50) + "\n")
-    file.write("// Created by : #{Asker::NAME}")
-    file.write(" (version #{Asker::VERSION})\n")
-    file.write("// File       : #{project.get(:outputname)}\n")
-    file.write("// Time       : #{Time.new}\n")
-    file.write('// ' + ('=' * 50) + "\n\n")
-    category = Application.instance.config['questions']['category']
+    file = File.open(project.get(:outputpath), "w")
+    file.write("// " + ("=" * 50) + "\n")
+    file.write("// #{Asker::NAME}    : version #{Asker::VERSION}\n")
+    file.write("// Filename : #{project.get(:outputname)}\n")
+    file.write("// Datetime : #{Time.new}\n")
+    file.write("// " + ("=" * 50) + "\n\n")
+    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)
     file.close
   end
 end