asker-tool 2.1.7 → 2.2.0

data/lib/asker/formatter/concept_string_formatter.rb

@@ -12,12 +12,11 @@ module ConceptStringFormatter
   def self.to_s(concept)
     tt = Terminal::Table.new
     get_tt_rows(concept).each { |row| tt.add_row row }
-    "#{tt}\n"
+    tt.to_s
   end
 
   # rubocop:disable Metrics/AbcSize
   # rubocop:disable Metrics/MethodLength
-  # rubocop:disable Layout/LineLength
   private_class_method def self.get_tt_rows(concept)
     rows = []
     rows << [Rainbow(concept.id.to_s).bright,
@@ -31,13 +30,17 @@ module ConceptStringFormatter
     rows << [Rainbow('Referenced by').blue,
              concept.referenced_by.join(', ')[0...70].to_s]
     rows << format_texts(concept)
-    rows << [Rainbow('.def(images)').blue, concept.images.size.to_s] unless concept.images.size.zero?
+    unless concept.images.size.zero?
+      counter1 = 0
+      concept.images.each { |image|  counter1 += 1 if image[:file] == :none }
+      counter2 = concept.images.size - counter1
+      rows << [Rainbow('.def(images)').blue, "#{counter1} text / #{counter2} file"]
+    end
     rows << format_tables(concept) unless concept.tables.count.zero?
     rows << format_neighbors(concept)
   end
   # rubocop:enable Metrics/AbcSize
   # rubocop:enable Metrics/MethodLength
-  # rubocop:enable Layout/LineLength
 
   private_class_method def self.format_texts(concept)
     list = []

data/lib/asker/formatter/moodle/matching.erb

@@ -0,0 +1,38 @@
+<% unless question.comment.nil? || question.comment.empty? %>
+<!-- question: <%= question.comment %>  -->
+<% end %>
+  <question type="matching">
+    <name>
+      <text><%= question.name %></text>
+    </name>
+    <questiontext format="html">
+      <text><![CDATA[<%= question.text %>]]></text>
+      <% unless question.encode == :none %>
+        <%= question.encode %>
+      <% end %>
+    </questiontext>
+    <generalfeedback format="html">
+      <text><![CDATA[<%= question.feedback.to_s %>]]></text>
+    </generalfeedback>
+    <defaultgrade>1.0000000</defaultgrade>
+    <penalty>0.3333333</penalty>
+    <hidden>0</hidden>
+    <shuffleanswers>true</shuffleanswers>
+    <correctfeedback format="html">
+      <text></text>
+    </correctfeedback>
+    <partiallycorrectfeedback format="html">
+      <text></text>
+    </partiallycorrectfeedback>
+    <incorrectfeedback format="html">
+      <text></text>
+    </incorrectfeedback>
+    <% question.matching.each do |i, j| %>
+    <subquestion format="html">
+      <text><![CDATA[<%= i %>]]></text>
+      <answer>
+        <text><![CDATA[<%= j %>]]></text>
+      </answer>
+    </subquestion>
+    <% end %>
+  </question>

data/lib/asker/formatter/moodle/multichoice.erb

@@ -0,0 +1,49 @@
+<% unless question.comment.nil? || question.comment.empty? %>
+<!-- question: <%= question.comment %>  -->
+<% end %>
+  <question type="multichoice">
+    <name>
+      <text><%= question.name %></text>
+    </name>
+    <questiontext format="html">
+      <text><![CDATA[<%= question.text %>]]></text>
+      <% unless question.encode == :none %>
+        <%= question.encode %>
+      <% end %>
+    </questiontext>
+    <generalfeedback format="html">
+      <text><![CDATA[<%= question.feedback.to_s %>]]></text>
+    </generalfeedback>
+    <defaultgrade>1.0000000</defaultgrade>
+    <penalty>0.3333333</penalty>
+    <hidden>0</hidden>
+    <single>true</single>
+    <shuffleanswers>true</shuffleanswers>
+    <answernumbering>abc</answernumbering>
+    <correctfeedback format="html">
+      <text></text>
+    </correctfeedback>
+    <partiallycorrectfeedback format="html">
+      <text></text>
+    </partiallycorrectfeedback>
+    <incorrectfeedback format="html">
+      <text></text>
+    </incorrectfeedback>
+    <answer fraction="100" format="html">
+      <text><%= question.good %></text>
+      <feedback format="html">
+        <text></text>
+      </feedback>
+    </answer>
+    <%
+      question.bads.shuffle! if question.shuffle?
+      question.bads.each do |i|
+    %>
+    <answer fraction="<%= penalty %>" format="html">
+      <text><![CDATA[<%= i %>]]></text>
+      <feedback format="html">
+        <text></text>
+      </feedback>
+    </answer>
+    <% end %>
+  </question>

data/lib/asker/formatter/moodle/shortanswer.erb

@@ -0,0 +1,30 @@
+<% unless question.comment.nil? || question.comment.empty? %>
+<!-- question: <%= question.comment %>  -->
+<% end %>
+  <question type="shortanswer">
+    <name>
+      <text><%= question.name %></text>
+    </name>
+    <questiontext format="html">
+      <text><![CDATA[<%= question.text %>]]></text>
+      <% unless question.encode == :none %>
+        <%= question.encode %>
+      <% end %>
+    </questiontext>
+    <generalfeedback format="html">
+      <text><![CDATA[<%= question.feedback.to_s %>]]></text>
+    </generalfeedback>
+    <defaultgrade>1.0000000</defaultgrade>
+    <penalty>0.3333333</penalty>
+    <hidden>0</hidden>
+    <usecase>0</usecase>
+    <% question.shorts.uniq! %>
+    <% question.shorts.each do |i| %>
+    <answer fraction="100" format="moodle_auto_format">
+      <text><![CDATA[<%= i %>]]></text>
+      <feedback format="html">
+        <text></text>
+      </feedback>
+    </answer>
+    <% end %>
+  </question>

data/lib/asker/formatter/moodle/truefalse.erb

@@ -0,0 +1,47 @@
+<% unless question.comment.nil? || question.comment.empty? %>
+<!-- question: <%= question.comment %>  -->
+<% end %>
+  <question type="truefalse">
+    <name>
+      <text><%= question.name %></text>
+    </name>
+    <questiontext format="html">
+      <text><![CDATA[<%= question.text %>]]></text>
+      <% unless question.encode == :none %>
+        <%= question.encode %>
+      <% end %>
+    </questiontext>
+    <generalfeedback format="html">
+      <text><![CDATA[<%= question.feedback.to_s %>]]></text>
+    </generalfeedback>
+    <defaultgrade>1.0000000</defaultgrade>
+    <penalty>1.0000000</penalty>
+    <hidden>0</hidden>
+    <% if question.good == 'TRUE' %>
+    <answer fraction="100" format="moodle_auto_format">
+      <text>true</text>
+      <feedback format="html">
+        <text></text>
+      </feedback>
+    </answer>
+    <answer fraction="0" format="moodle_auto_format">
+      <text>false</text>
+      <feedback format="html">
+        <text></text>
+      </feedback>
+    </answer>
+    <% else %>
+    <answer fraction="0" format="moodle_auto_format">
+      <text>true</text>
+      <feedback format="html">
+        <text></text>
+      </feedback>
+    </answer>
+    <answer fraction="100" format="moodle_auto_format">
+      <text>false</text>
+      <feedback format="html">
+        <text></text>
+      </feedback>
+    </answer>
+    <% end %>
+  </question>

data/lib/asker/formatter/question_gift_formatter.rb

@@ -7,50 +7,52 @@ module QuestionGiftFormatter
   # @param question (Question)
   # @return String
   def self.to_s(question)
-    @question = question
+    s = ''
+    return s unless question.encode == :none
+
     # Return question using gift format
-    cond = @question.comment.nil? && @question.comment.empty?
-    s = "// #{@question.comment}\n" unless cond
-    s << "::#{@question.name}::[html]#{sanitize(@question.text)}\n"
+    cond = question.comment.nil? || question.comment.empty?
+    s = "// #{question.comment}\n" unless cond
+    s << "::#{question.name}::[html]#{sanitize(question.text)}\n"
 
-    case @question.type
+    case question.type
     when :choice
       s += "{\n"
-      a = ["  =#{sanitize(@question.good)}\n"]
+      a = ["  =#{sanitize(question.good)}\n"]
       penalties = ['', '%-50%', '%-33.33333%', '%-25%', '%-20%']
-      penalty = penalties[@question.bads.size]
+      penalty = penalties[question.bads.size]
 
-      @question.bads.each { |i| a << ("  ~#{penalty}" + sanitize(i) + "\n") }
-      a.shuffle! if @question.shuffle?
+      question.bads.each { |i| a << ("  ~#{penalty}" + sanitize(i) + "\n") }
+      a.shuffle! if question.shuffle?
       a.each do |i|
         text = i
         text = i[0, 220] + '...(ERROR: text too long)' if text.size > 255
         s << text
       end
-      s += "  #####{sanitize(@question.feedback.to_s)}\n" if @question.feedback
+      s += "  #####{sanitize(question.feedback.to_s)}\n" if question.feedback
       s += "}\n\n"
     when :boolean
-      s << "{#{@question.good}#####{sanitize(@question.feedback.to_s)}}\n\n"
+      s << "{#{question.good}#####{sanitize(question.feedback.to_s)}}\n\n"
     when :match
       s << "{\n"
       a = []
-      @question.matching.each do |i, j|
+      question.matching.each do |i, j|
         i = i[0, 220] + '...(ERROR: text too long)' if i.size > 255
         j = j[0, 220] + '...(ERROR: text too long)' if j.size > 255
         a << "  =#{sanitize(i)} -> #{sanitize(j)}\n"
       end
-      a.shuffle! if @question.shuffle?
+      a.shuffle! if question.shuffle?
       a.each { |i| s << i }
       s << "}\n\n"
     when :short
       s << "{\n"
-      @question.shorts.uniq!
-      @question.shorts.each do |i|
+      question.shorts.uniq!
+      question.shorts.each do |i|
         text = i
         text = i[0, 220] + '...(ERROR: too long)' if text.size > 255
         s << "  =%100%#{text}#\n"
       end
-      s << "  #####{sanitize(@question.feedback.to_s)}\n" if @question.feedback
+      s << "  #####{sanitize(question.feedback.to_s)}\n" if question.feedback
       s << "}\n\n"
     end
     s
@@ -62,10 +64,10 @@ module QuestionGiftFormatter
   # @return String
   def self.sanitize(input = '')
     output = input.dup
-    output.gsub!("#", "\\#")
+    output.gsub!('#', '\#')
     output.gsub!("\n", " ")
-    #output.gsub!(":", "\\:")
-    output.gsub!("=", "\\=")
+    output.gsub!(':', '\:')
+    output.gsub!('=', '\=')
     output.gsub!("\{", "\\{")
     output.gsub!("\}", "\\}")
     output

data/lib/asker/formatter/question_moodle_formatter.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: false
+
+require 'erb'
+
+# Transform Questions into Gift format
+module QuestionMoodleFormatter
+  ##
+  # Convert question object into gift formatted string
+  # @param question (Question)
+  # @return String
+  def self.to_s(question)
+    case question.type
+    when :choice
+      penalties = ['', '-50', '-33.33333', '-25', '-20']
+      penalty = penalties[question.bads.size]
+      template = File.read(File.join(File.dirname(__FILE__), 'moodle', 'multichoice.erb'))
+    when :boolean
+      template = File.read(File.join(File.dirname(__FILE__), 'moodle', 'truefalse.erb'))
+    when :match
+      template = File.read(File.join(File.dirname(__FILE__), 'moodle', 'matching.erb'))
+    when :short
+      template = File.read(File.join(File.dirname(__FILE__), 'moodle', 'shortanswer.erb'))
+    end
+    renderer = ERB.new(template)
+    renderer.result(binding)
+  end
+end

data/lib/asker/lang/lang_factory.rb

@@ -29,7 +29,13 @@ class LangFactory
   # Return Lang object associated to code
   # @param code (String)
   def get(code)
-    @langs[code]
+    return @langs[code] unless @langs[code].nil?
+
+    puts Rainbow("[ERROR] Unkown Lang code: #{code}").bright
+    puts Rainbow('        => Change input file code lang').bright
+    puts Rainbow('        => Revise configuration from config.ini').bright
+    puts Rainbow('        => Revise template files').bright
+    exit 1
   end
 
   ##

data/lib/asker/loader/code_loader.rb

@@ -45,7 +45,7 @@ module CodeLoader
         features << i.text
       else
         msg = Rainbow("[ERROR] features/#{i.name} from #{filename}").color(:red)
-        Logger.verbose msg
+        Logger.verboseln msg
       end
     end
     features

data/lib/asker/loader/content_loader.rb

@@ -13,6 +13,8 @@ module ContentLoader
   # Load XML content into Asker data objects
   # @param filepath (String) File path
   # @param content (String) XML plane text content
+  # rubocop:disable Metrics/MethodLength
+  # rubocop:disable Metrics/AbcSize
   def self.load(filepath, content)
     concepts = []
     codes = []
@@ -37,6 +39,8 @@ module ContentLoader
 
     { concepts: concepts, codes: codes }
   end
+  # rubocop:enable Metrics/MethodLength
+  # rubocop:enable Metrics/AbcSize
 
   ##
   # Read lang attr from input XML data
@@ -71,9 +75,7 @@ module ContentLoader
   private_class_method def self.read_concept(xmldata, filepath, lang, context)
     project = Project.instance
     c = Concept.new(xmldata, filepath, lang, context)
-    if [ File.basename(filepath), :default ].include? project.process_file
-      c.process = true
-    end
+    c.process = true if [File.basename(filepath), :default].include? project.get(:process_file)
     c
   end
 
@@ -84,9 +86,7 @@ module ContentLoader
   private_class_method def self.read_code(xmldata, filepath)
     project = Project.instance
     c = CodeLoader.load(xmldata, filepath)
-    if [ File.basename(filepath), :default ].include? project.process_file
-      c.process = true
-    end
+    c.process = true if [File.basename(filepath), :default].include? project.get(:process_file)
     c
   end
 
@@ -96,7 +96,7 @@ module ContentLoader
   # @param content (String)
   private_class_method def self.raise_error_with(filepath, content)
     msg = Rainbow("[ERROR] ContentLoader: Format error in #{filepath}").red.bright
-    Logger.verbose msg
+    Logger.verboseln msg
     f = File.open('output/error.xml', 'w')
     f.write(content)
     f.close

data/lib/asker/loader/directory_loader.rb

@@ -13,7 +13,7 @@ module DirectoryLoader
     files = (Dir.new(dirname).entries - ['.', '..']).sort
     # Accept only HAML or XML files
     accepted = files.select { |f| %w[.xml .haml].include? File.extname(f) }
-    Logger.verbose " * Input directory  = #{Rainbow(dirname).bright}"
+    Logger.verboseln " * Input directory  = #{Rainbow(dirname).bright}"
     DirectoryLoader.load_files(accepted, dirname)
   end
 
@@ -49,9 +49,9 @@ module DirectoryLoader
   # @param last (Boolean) True if it is the last filename
   def self.load_file(filepath, last = false)
     if last
-      Logger.verbose "   └── Input file   = #{Rainbow(filepath).bright}"
+      Logger.verboseln "   └── Input file   = #{Rainbow(filepath).bright}"
     else
-      Logger.verbose "   ├── Input file   = #{Rainbow(filepath).bright}"
+      Logger.verboseln "   ├── Input file   = #{Rainbow(filepath).bright}"
     end
     FileLoader.load(filepath)
   end

data/lib/asker/loader/embedded_file.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'base64'
+
+# Methods to load embedded files defined into asker input data file
+# Example:
+# * def line with :type = :image_url used to link external file as https://..."
+# * def line with :type = :file used to load local file as image.png or file.txt"
+module EmbeddedFile
+  ##
+  # @param value (String)
+  # @param localdir (String) Input file base folder
+  # @return Hash
+  # rubocop:disable Metrics/MethodLength
+  # rubocop:disable Metrics/AbcSize
+  def self.load(value, localdir)
+    # When filename is an URL
+    if value.start_with?('https://') || value.start_with?('http://')
+      return { text: "<img src=\"#{value}\" alt=\"image\" width=\"400\" height=\"300\">", file: :none }
+    end
+
+    filepath = File.join(localdir, value)
+    unless File.exist?(filepath)
+      # When filename is unkown!
+      Logger.verbose Rainbow("[ERROR] Unknown file! #{filepath}").red.bright
+      exit 1
+    end
+    # When filename is PNG, JPG o JPEG
+    if ['.png', '.jpg', '.jpeg'].include? File.extname(filepath)
+      # converts image into base64 strings
+      text = '<img src="@@PLUGINFILE@@/' + File.basename(filepath) \
+             + '" alt="imagen" class="img-responsive atto_image_button_text-bottom">'
+      data = '<file name="' + File.basename(filepath) + '" path="/" encoding="base64">' \
+             + Base64.strict_encode64(File.open(filepath, 'rb').read) + '</file>'
+      return { text: text, file: data }
+    end
+    # Suposse that filename is TXT file
+    return { text: "<pre>#{File.read(filepath)}</pre>", file: :none } if File.exist?(filepath)
+  end
+  # rubocop:enable Metrics/MethodLength
+  # rubocop:enable Metrics/AbcSize
+end

data/lib/asker/loader/file_loader.rb

@@ -16,7 +16,7 @@ module FileLoader
       file_content = File.read(filename)
     else
       msg = "[ERROR] FileLoader: Format error #{filename}"
-      Logger.verbose msg
+      Logger.verboseln msg
       raise msg
     end
     ContentLoader.load(filename, file_content)

data/lib/asker/loader/image_url_loader.rb

@@ -45,11 +45,12 @@ module ImageUrlLoader
   end
 
   def self.sanitize_string(input)
+    text = input.dup
     r = [ ['á', 'a'], ['é', 'e'], ['í', 'i'], ['ó', 'o'], ['ú', 'u'], ['ñ', 'n'], ['Á', 'A'], ['É', 'E'], ['Í', 'I'], ['Ó', 'O'], ['Ú', 'U'], ['Ñ', 'N']]
-    r.each { |item| input.gsub!(item[0], item[1]) }
+    r.each { |item| text.gsub!(item[0], item[1]) }
     r = ['-', '_', ',', '"']
-    r.each { |item| input.gsub!(item, ' ') }
-    input.split(' ')
+    r.each { |item| text.gsub!(item, ' ') }
+    text.split(' ')
   end
 
   def self.sanitize_array(input)

data/lib/asker/loader/input_loader.rb

@@ -13,7 +13,7 @@ module InputLoader
   def self.load(inputdirs)
     data = { concepts: [], codes: [], world: nil,
              concepts_ai: [], codes_ai: [] }
-    Logger.verbose "\n[INFO] Loading input data"
+    Logger.verboseln "\n[INFO] Loading input data"
     inputdirs.each do |dirname|
       temp = DirectoryLoader.load(dirname)
       data[:concepts] += temp[:concepts]

data/lib/asker/loader/project_loader.rb

@@ -14,22 +14,26 @@ module ProjectLoader
   ##
   # Load project from args
   # @param args (String or Hash)
+  # rubocop:disable Metrics/MethodLength
   def self.load(args)
     project = Project.instance
 
     if args.class == Hash
       project.param.merge!(args)
+      project.open
       return project
     elsif args.class == String
       ProjectLoader.load_from_string(args)
+      project.open
       return project
     end
 
     msg = '[ERROR] ProjectLoader:'
     msg += "Configuration params format is <#{pArgs.class}>!"
-    Logger.verbose Rainbow(msg).red
+    Logger.verboseln Rainbow(msg).red
     raise msg
   end
+  # rubocop:enable Metrics/MethodLength
 
   ##
   # Load project from filepath. Options:
@@ -37,11 +41,13 @@ module ProjectLoader
   # * XML filepath
   # * YAML filepath
   # @param filepath (String)
+  # rubocop:disable Metrics/MethodLength
+  # rubocop:disable Metrics/AbcSize
   def self.load_from_string(filepath)
     project = Project.instance
     unless File.exist?(filepath)
       msg = Rainbow("[ERROR] #{filepath} not found!").red.bright
-      Logger.verbose msg
+      Logger.verboseln msg
       exit 1
     end
 
@@ -51,11 +57,13 @@ module ProjectLoader
       return project
     elsif File.extname(filepath) == '.yaml'
       return load_from_yaml(filepath)
-    else
-      error_loading(filepath)
     end
+    error_loading(filepath)
   end
+  # rubocop:enable Metrics/MethodLength
+  # rubocop:enable Metrics/AbcSize
 
+  # rubocop:disable Security/YAMLLoad
   def self.load_from_yaml(arg)
     project = Project.instance
     project.param.merge!(YAML.load(File.open(arg)))
@@ -63,12 +71,13 @@ module ProjectLoader
     project.set(:projectdir, File.dirname(arg))
     project
   end
+  # rubocop:enable Security/YAMLLoad
 
   ##
   # Error found and exit application.
   def self.error_loading(arg)
     msg = Rainbow("[ERROR] Loading... #{arg}").red.bright
-    Logger.verbose msg
+    Logger.verboseln msg
     exit 1
   end
 end

data/lib/asker/logger.rb

@@ -1,15 +1,21 @@
 # frozen_string_literal: true
 
+require 'singleton'
 require_relative 'application'
-require_relative 'project'
 
 # Display and log project messages
-module Logger
+class Logger
+  include Singleton
+
+  def initialize
+    @logfile = null
+  end
+
   ##
   # Display and log text
   def self.verbose(msg)
-    puts msg if Application.instance.config['global']['verbose'] == 'yes'
-    Project.instance.get(:logfile)&.write("#{msg}\n")
+    print msg if Application.instance.config['global']['verbose'] == 'yes'
+    @logfile&.write(msg)
   end
 
   ##
@@ -17,4 +23,23 @@ module Logger
   def self.verboseln(msg)
     verbose(msg + "\n")
   end
+
+  ##
+  # Create or reset logfile
+  def self.create(project)
+    @logfile = File.open(project.get(:logpath), 'w')
+    @logfile.write('=' * 50 + "\n")
+    @logfile.write("Created by : #{Application::NAME}")
+    @logfile.write(" (version #{Application::VERSION})\n")
+    @logfile.write("File       : #{project.get(:logname)}\n")
+    @logfile.write("Time       : #{Time.new}\n")
+    @logfile.write("Author     : David Vargas Ruiz\n")
+    @logfile.write('=' * 50 + "\n\n")
+  end
+
+  ##
+  # Close Log file
+  def self.close
+    @logfile.close
+  end
 end