asker-tool 2.6.0 → 2.7.0

data/lib/asker/cli.rb

@@ -1,50 +1,70 @@
 # frozen_string_literal: true
 
-require 'rainbow'
-require 'thor'
-require_relative 'version'
-require_relative '../asker'
+require "rainbow"
+require "thor"
+require_relative "version"
+require_relative "../asker"
 
 ##
 # Command Line User Interface
 class CLI < Thor
-  map ['-h', '--help'] => 'help'
+  map ["-h", "--help"] => "help"
 
-  map ['-v', '--version'] => 'version'
-  desc 'version', 'Show the program version'
+  map ["-v", "--version"] => "version"
+  desc "version", "Show the program version"
   def version
     puts "#{Asker::NAME} version #{Asker::VERSION}"
     exit 0
   end
 
-  map ['--init'] => 'init'
-  desc 'init', 'Create default INI config file'
+  map ["--init"] => "init"
+  desc "init", "Create default INI config file"
   def init
     Asker.init
     exit 0
   end
 
-  map ['new','--new'] => 'create_input'
-  desc 'new DIRPATH', 'Create Asker demo input files'
-  ##
-  # Create Asker demo input files
-  # @param dirname (String) Path to folder
+  map ["new", "--new"] => "create_input"
+  desc "new PATH", "Create Asker sample input file"
+  long_desc <<-LONGDESC
+
+  Create Asker sample input file (HAML format).
+
+  Examples:
+
+  (1) #{Rainbow("asker new foo/bar.haml").aqua}, Create "foo" dir and "bar.haml" file.
+  Path to input file can be relative or absolute.
+
+  (2) #{Rainbow("asker new foo").aqua}, Create "foo" dir and sample HAML file.
+  Path to directory can be relative or absolute.
+
+  LONGDESC
   def create_input(dirname)
     Asker.create_input(dirname)
     exit 0
   end
 
-  map ['--check'] => 'check'
-  desc 'check FILEPATH', 'Check input HAML file syntax'
+  map ["--check"] => "check"
+  desc "check FILEPATH", "Check HAML input file syntax"
+  long_desc <<-LONGDESC
+
+  Check HAML input file syntax.
+
+  Examples:
+
+  (*) #{Rainbow("asker check foo/bar.haml").aqua}, Check "bar.haml" input file.
+  Path to input file can be relative or absolute.
+
+  LONGDESC
   def check(filename)
     # Enable/disable color output
-    Rainbow.enabled = false if options['color'] == false
+    Rainbow.enabled = false if options["color"] == false
     # Asker start processing input file
     Asker.check(filename)
   end
 
-  map ['f', '-f', '--file'] => 'file'
-  desc '[file] FILEPATH', 'Build output files, from HAML/XML input file.'
+  map ["f", "-f", "--file"] => "file"
+  desc "[file] FILEPATH", "Build output files, from HAML/XML input file."
   long_desc <<-LONGDESC
 
   Build questions about contents defined into input file specified.
@@ -53,15 +73,14 @@ class CLI < Thor
 
   Examples:
 
-  (1) #{Rainbow('asker input/foo/foo.haml').aqua}, Build questions from HAML file.
+  (1) #{Rainbow("asker foo/bar.haml").aqua}, Build questions from HAML input file.
+  Path to input file can be relative or absolute.
 
-  (2) #{Rainbow('asker input/foo/foo.xml').aqua}, Build questions from XML file.
-
-  (3) #{Rainbow('asker projects/foo/foo.yaml').aqua}, Build questions from YAML project file.
+  (2) #{Rainbow("asker foo/bar.xml").aqua}, Build questions from XML input file.
+  Path to input file can be relative or absolute.
 
   LONGDESC
   def file(filename)
-    # Asker start processing input file
     Asker.start(filename)
   end
 

data/lib/asker/data/code.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
-require_relative '../ai/code/code_ai_factory'
+require_relative "../ai/code/code_ai_factory"
+require_relative "../logger"
 
 class Code
   attr_reader :dirname, :filename, :type
@@ -23,7 +24,7 @@ class Code
   end
 
   def lines_to_s(lines)
-    out = ''
+    out = ""
     lines.each_with_index do |line, index|
       out << format("%2d| #{line}\n", (index + 1))
     end
@@ -36,7 +37,7 @@ class Code
     return if filepath.nil?
 
     unless File.exist? filepath
-      puts Rainbow("[ERROR] Unkown file #{filepath}").red.bright
+      Logger.warn "Code: Unkown file (#{filepath})"
       return
     end
     content = File.read(filepath)
@@ -45,16 +46,16 @@ class Code
 
   def encode_and_split(text, encoding = :default)
     # Convert text to UTF-8 deleting unknown chars
-    text ||= '' # Ensure text is not nil
-    flag = [:default, 'UTF-8'].include? encoding
-    return text.encode('UTF-8', invalid: :replace).split("\n") if flag
+    text ||= "" # Ensure text is not nil
+    flag = [:default, "UTF-8"].include? encoding
+    return text.encode("UTF-8", invalid: :replace).split("\n") if flag
 
     # Convert text from input ENCODING to UTF-8
-    ec = Encoding::Converter.new(encoding.to_s, 'UTF-8')
+    ec = Encoding::Converter.new(encoding.to_s, "UTF-8")
     begin
       text = ec.convert(text)
-    rescue StandardError => e
-      puts "[ERROR] Encoding: #{e}"
+    rescue => e
+      Logger.warn "Code: Encoding error (#{e}) with filename (#{@filename})"
     end
 
     text.split("\n")

data/lib/asker/data/column.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative "../logger"
+
 # Contain data information for every column
 # Params:
 # * +pRow+ - Parent row for this column
@@ -9,28 +11,27 @@ class Column
   attr_reader :row, :index, :id, :raw, :lang, :type, :simple
 
   ##
-  # initialize Column
   # @param row (Row)
   # @param index (Integer)
   # @param xml_data (XMLdata)
   def initialize(row, index, xml_data)
-    @row    = row
-    @index  = index
-    @id     = "#{@row.id}.#{@index}"
-    @raw    = ''
-    @lang   = @row.langs[@index]
-    @type   = @row.types[@index]
-    @simple = { lang: true, type: true }
+    @row = row
+    @index = index
+    @id = "#{@row.id}.#{@index}"
+    @raw = ""
+    @lang = @row.langs[@index]
+    @type = @row.types[@index]
+    @simple = {lang: true, type: true}
     read_data_from_xml(xml_data)
   end
 
   def to_html
     case @type
-    when 'text'
+    when "text"
       return @raw
-    when 'image_url'
-      return "<img src=\"#{raw}\" alt\=\"image\">"
-    when 'textfile_path'
+    when "image_url"
+      return "<img src=\"#{raw}\" alt=\"image\">"
+    when "textfile_path"
       return "<pre>#{raw}</pre>"
     end
     "ERROR type #{@type}"
@@ -39,7 +40,10 @@ class Column
   private
 
   def read_data_from_xml(xml_data)
-    raise '[ERROR] Column with elements!' if xml_data.elements.count.positive?
+    if xml_data.elements.count.positive?
+      Logger.error "Column: Do not use elements!"
+      exit 1
+    end
 
     @raw = xml_data.text.strip.to_s
 
@@ -49,9 +53,9 @@ class Column
   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 == @lang.code
 
     @lang = LangFactory.instance.get(code)
@@ -60,9 +64,9 @@ class Column
   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 == @type.to_s
 
     @type = type

data/lib/asker/data/concept.rb

@@ -1,14 +1,14 @@
-require 'rainbow'
-require 'rexml/document'
+require "rexml/document"
 
-require_relative '../lang/lang_factory'
-require_relative '../loader/embedded_file'
-require_relative 'table'
-require_relative 'data_field'
+require_relative "../lang/lang_factory"
+require_relative "../loader/embedded_file"
+require_relative "../logger"
+require_relative "table"
+require_relative "data_field"
 
 class Concept
   attr_reader :id        # Unique identifer (Integer)
-  attr_reader :lang      # Lang code (By default is the same as map lang)
+  attr_reader :lang      # Lang object
   attr_reader :context   # Context inherits from map
   attr_reader :names     # Names used to identify or name this concept
   attr_reader :type      # type = text -> Name values are only text
@@ -24,24 +24,16 @@ class Concept
   # @param filename (String)
   # @param lang_code (String)
   # @param context (Array)
-  def initialize(xml_data, filename, lang_code = 'en', context = [])
+  def initialize(xml_data, filename, lang, context)
     @@id += 1
     @id = @@id
 
     @filename = filename
     @process = false
-    @lang = LangFactory.instance.get(lang_code)
-
-    if context.class == Array
-      @context = context
-    elsif context.nil?
-      @context = []
-    else
-      @context = context.split(',')
-      @context.collect!(&:strip)
-    end
-    @names = ['concept.' + @id.to_s]
-    @type  = 'text'
+    @lang = lang # LangFactory.instance.get(lang_code)
+    @context = context
+    @names = ["concept." + @id.to_s]
+    @type = "text"
 
     @data = {}
     @data[:tags] = []
@@ -60,7 +52,7 @@ class Concept
   end
 
   def text
-    @data[:texts][0] || '...'
+    @data[:texts][0] || "..."
   end
 
   def process?
@@ -71,16 +63,14 @@ class Concept
     p = calculate_nearness_to_concept(other)
     return if p.zero?
 
-    @data[:neighbors] << { concept: other, value: p }
+    @data[:neighbors] << {concept: other, value: p}
     # Sort neighbors list
     @data[:neighbors].sort! { |a, b| a[:value] <=> b[:value] }
     @data[:neighbors].reverse!
   end
 
   def calculate_nearness_to_concept(other)
-    a = ProjectData.instance.get(:weights)
-    # Application.instance.config['ai']['formula_weights']
-    weights = a.split(',').map(&:to_f)
+    weights = ProjectData.instance.get(:weights).split(",").map(&:to_f)
 
     max1 = @context.count
     max2 = @data[:tags].count
@@ -105,7 +95,7 @@ class Concept
     end
     @data[:texts].each do |t|
       text = t.clone
-      text.split(' ').each do |word|
+      text.split(" ").each do |word|
         reference_to += 1 unless other.names.index(word.downcase).nil?
       end
     end
@@ -157,26 +147,25 @@ class Concept
       when "table"
         @data[:tables] << Table.new(self, i)
       else
-        text = "   [ERROR] Concept #{name} with unkown attribute: #{i.name}"
-        puts Rainbow(text).color(:red)
+        Logger.warn "Concept #{name} with unkown attribute: #{i.name}"
       end
     end
   end
 
   def process_names(value)
     @names = []
-    j = value.text.split(',')
+    j = value.text.split(",")
     j.each { |k| @names << k.strip }
-    @type = value.attributes['type'].strip if value.attributes['type']
+    @type = value.attributes["type"].strip if value.attributes["type"]
   end
 
   def process_tags(value)
     if value.text.nil? || value.text.size.zero?
-      puts Rainbow("[ERROR] Concept without tags: #{name} ").red.bright
-      exit 1
+      Logger.warn "Concept: Concept #{name} without <tags>"
+      return []
     end
 
-    @data[:tags] = value.text.split(',')
+    @data[:tags] = value.text.split(",")
     @data[:tags].collect!(&:strip)
   end
 
@@ -190,14 +179,12 @@ class Concept
       @data[:images] << EmbeddedFile.load(value.text.strip, File.dirname(@filename))
     when nil
       if value.text.nil?
-        warn Rainbow("[WARN] def: without text!").yellow.bright
+        Logger.warn "Concept: def/text empty!"
       else
         @data[:texts] << value.text.strip
       end
     else
-      msg = "[ERROR] Unknown type: #{value.attributes['type']}"
-      puts Rainbow(msg).red.bright
-      exit 1
+      Logger.warn "Concept: Unknown def/type (#{value.attributes["type"]})"
     end
   end
 end

data/lib/asker/data/data_field.rb

@@ -12,7 +12,7 @@ class DataField
   # initialize DataField
   def initialize(data, id, type)
     @data = data
-    @id   = id.to_i # TODO: revise where it comes from? Is it unique value?
+    @id = id.to_i # TODO: revise where it comes from? Is it unique value?
     @type = type.to_sym
   end
 
@@ -94,7 +94,7 @@ class DataField
   # rubocop:enable Metrics/MethodLength
 
   def to_screen(text)
-    return text[0, 7] + '...' + text[-15, 15] if text.size > 25
+    return text[0, 7] + "..." + text[-15, 15] if text.size > 25
 
     text
   end

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 }