asker-tool 2.5.9 → 2.7.0

data/lib/asker/data/problem.rb

@@ -0,0 +1,112 @@
+require_relative "../logger"
+
+class Problem
+  attr_accessor :lang
+  attr_accessor :context
+  attr_accessor :process
+  attr_accessor :filename
+  attr_accessor :varnames
+  attr_accessor :cases
+  attr_accessor :descs
+  attr_accessor :asks
+  attr_accessor :questions
+
+  @@id = 0
+  def initialize
+    @@id += 1
+    @id = @@id
+    @lang = nil
+    @context = nil
+    @process = false
+    @filename = "?"
+    @varnames = []
+    @cases = []
+    @descs = []
+    @asks = []
+    @questions = []
+  end
+
+  def self.from(values)
+    problem = Problem.new
+    fields = %i[filename varnames cases descs asks]
+    fields.each do |fieldname|
+      methodname = "#{fieldname}=".to_sym
+      problem.send(methodname, values[fieldname])
+    end
+    problem.validate
+    problem
+  end
+
+  def desc
+    @descs.first
+  end
+
+  def process?
+    @process
+  end
+
+  def name
+    "problem#{@id}"
+  end
+
+  def validate
+    validate_varnames
+    validate_cases
+    validate_asks
+    validate_descs
+  end
+
+  private
+
+  def validate_varnames
+    if !@varnames.size.zero? && @cases.size.zero?
+      Logger.warn "Problem: No problem/varnames defined with no problem/case"
+    end
+
+    @varnames.each_with_index do |varname1, index1|
+      @varnames.each_with_index do |varname2, index2|
+        next if index1 == index2
+        if varname1.include? varname2
+          Logger.error "Problem: varname(#{varname1}) includes varname(#{varname2}). Change one of them!"
+          exit 1
+        end
+      end
+    end
+  end
+
+  def validate_cases
+    @cases.each do |acase|
+      if acase.size != @varnames.size
+        Logger.error "Problem: problem/cases size not equal to problem/varnames size"
+        Logger.error "       : cases size #{acase.size} (#{acase.join(",")})"
+        Logger.error "       : varnames size #{@varnames.size} (#{@varnames.join(",")})"
+        exit 1
+      end
+    end
+  end
+
+  def validate_asks
+    if @asks.size.zero?
+      Logger.warn "Problem: No problem/ask"
+    end
+
+    @asks.each do |ask|
+      Logger.warn "Problem: No problem/ask/text" if ask[:text].nil?
+      if ask[:answer].nil? && ask[:steps].size.zero?
+        Logger.error "Problem: No problem/ask/answer and no problem/ask/steps"
+        exit 1
+      end
+      if !ask[:answer].nil? && !ask[:steps].size.zero?
+        Logger.error "Problem: Choose problem/ask/answer or problem/ask/steps"
+        exit 1
+      end
+      if ask[:steps].size > 0 && ask[:steps].size < 4
+        Logger.warn "Problem: problem/ask/steps less than 4"
+      end
+    end
+  end
+
+  def validate_descs
+    # require "debug"; binding.break
+  end
+end

data/lib/asker/data/project_data.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'singleton'
+require "singleton"
 
 class ProjectData
   include Singleton
@@ -11,11 +11,11 @@ class ProjectData
   end
 
   def reset
-    @default = { inputbasedir: FileUtils.pwd,
-                 stages: { d: true, b: true, f: true, i: true, s: true, t: true },
-                 threshold: 0.5,
-                 outputdir: 'output',
-                 weights: '1, 1, 1' }
+    @default = {inputbasedir: FileUtils.pwd,
+                stages: {d: true, b: true, f: true, i: true, s: true, t: true},
+                threshold: 0.5,
+                outputdir: "output",
+                weights: "1, 1, 1"}
     @param = {}
   end
 
@@ -36,17 +36,15 @@ class ProjectData
   # IMPORTANT: We need at least these values
   # * process_file
   # * inputdirs
-  # rubocop:disable Metrics/MethodLength
-  # rubocop:disable Metrics/AbcSize
   def open
-    ext = File.extname(@param[:process_file]) || '.haml'
+    ext = File.extname(@param[:process_file]) || ".haml"
     @param[:projectname] = @param[:projectname] ||
-                           File.basename(@param[:process_file], ext)
+      File.basename(@param[:process_file], ext)
 
-    @param[:logname] = "#{@param[:projectname]}-log.txt"
+    @param[:logname] = "#{@param[:projectname]}.log"
     @param[:outputname] = "#{@param[:projectname]}-gift.txt"
-    @param[:lessonname] = "#{@param[:projectname]}-doc.txt"
-    @param[:yamlname] = "#{@param[:projectname]}.yaml"
+    @param[:lessonname] = "#{@param[:projectname]}.txt"
+    @param[:yamlname] = "#{@param[:projectname]}-questions.yaml"
     @param[:moodlename] = "#{@param[:projectname]}-moodle.xml"
 
     outputdir = get(:outputdir)
@@ -58,6 +56,4 @@ class ProjectData
 
     Dir.mkdir(outputdir) unless Dir.exist?(outputdir)
   end
-  # rubocop:enable Metrics/MethodLength
-  # rubocop:enable Metrics/AbcSize
 end

data/lib/asker/data/row.rb

@@ -1,9 +1,8 @@
 # frozen_string_literal: true
 
-require_relative 'column'
+require_relative "column"
+require_relative "../logger"
 
-##
-# Row objects
 class Row
   attr_reader :table, :index, :id
   attr_reader :langs, :types, :raws, :columns
@@ -15,14 +14,14 @@ class Row
   # @param index (Integer)
   # @param xml_data (XML)
   def initialize(table, index, xml_data)
-    @table   = table
-    @index   = index
-    @id      = "#{@table.id}.#{@index}"
-    @langs   = @table.langs
-    @types   = @table.types
-    @raws    = []
+    @table = table
+    @index = index
+    @id = "#{@table.id}.#{@index}"
+    @langs = @table.langs
+    @types = @table.types
+    @raws = []
     @columns = []
-    @simple  = { lang: true, type: true }
+    @simple = {lang: true, type: true}
     read_data_from_xml(xml_data)
   end
 
@@ -40,14 +39,17 @@ class Row
       build_row_with_n_columns(xml_data)
     end
 
-    raise "[ERROR] Row: #{xml_data}" unless @columns.size == @table.fields.size
+    unless @columns.size == @table.fields.size
+      Logger.error "Row: columns size != table.fields.size (#{xml_data})"
+      exit 1
+    end
   end
 
   def build_row_with_1_column(xml_data)
     # When row tag only has text, we add this text as one value array
     # This is usefull for tables with only one columns
     @columns = [Column.new(self, @raws.size, xml_data)]
-    @raws    = [xml_data.text.strip.to_s]
+    @raws = [xml_data.text.strip.to_s]
 
     # read attributes from XML data
     read_lang_from_xml(xml_data)
@@ -55,9 +57,9 @@ class Row
   end
 
   def read_lang_from_xml(xml_data)
-    return unless xml_data.attributes['lang']
+    return unless xml_data.attributes["lang"]
 
-    code = xml_data.attributes['lang'].strip
+    code = xml_data.attributes["lang"].strip
     return if code == @langs[0].code
 
     @langs = [LangFactory.instance.get(code)]
@@ -66,9 +68,9 @@ class Row
   end
 
   def read_type_from_xml(xml_data)
-    return unless xml_data.attributes['type']
+    return unless xml_data.attributes["type"]
 
-    type = xml_data.attributes['type'].strip
+    type = xml_data.attributes["type"].strip
     return if type == @types[0]
 
     @types = [type]
@@ -80,11 +82,11 @@ class Row
   def build_row_with_n_columns(xml_data)
     xml_data.elements.each do |i|
       case i.name
-      when 'lang'
+      when "lang"
         read_langs_from_xml(i)
-      when 'type'
+      when "type"
         read_types_from_xml(i)
-      when 'col'
+      when "col"
         # When row has several columns, we add every value to the array
         @columns << Column.new(self, @raws.size, i) # Column Objects
         @raws << i.text.to_s
@@ -94,9 +96,9 @@ class Row
   # rubocop:enable Metrics/MethodLength
 
   def read_langs_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(",")
 
     @langs = []
     j.each { |k| @langs << LangFactory.instance.get(k.strip.to_s) }
@@ -105,8 +107,8 @@ class Row
   end
 
   def read_types_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(",")
 
     @types = []
     j.each { |k| @types << k.strip.to_s }

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