asker-tool 2.2.0 → 2.2.4

data/lib/asker/cli.rb

@@ -2,24 +2,49 @@
 
 require 'rainbow'
 require 'thor'
-require_relative 'application'
+require_relative 'version'
 require_relative '../asker'
 
 ##
 # Command Line User Interface
 class CLI < Thor
-  map ['h', '-h', '--help'] => 'help'
+  map ['--help'] => 'help'
 
-  map ['v', '-v', '--version'] => 'version'
+  map ['--version'] => 'version'
   desc 'version', 'Show the program version'
-  ##
-  # Show current version
   def version
-    puts "#{Application::NAME} version #{Application::VERSION}"
+    puts "#{Version::NAME} version #{Version::VERSION}"
+    exit 0
+  end
+
+  map ['--init'] => 'init'
+  desc 'init', 'Create default INI config file'
+  def init
+    Asker.init
+    exit 0
+  end
+
+  map ['new','--new'] => 'new_input'
+  desc 'new DIRPATH', 'Create Asker demo input files'
+  ##
+  # Create Asker demo input files
+  # @param dirname (String) Path to folder
+  def new_input(dirname)
+    Asker.new_input(dirname)
+    exit 0
+  end
+
+  map ['--check'] => 'check'
+  desc 'check FILEPATH', 'Check input HAML file syntax'
+  def check(filename)
+    # Enable/disable color output
+    Rainbow.enabled = false if options['color'] == false
+    # Asker start processing input file
+    Asker.check(filename)
   end
 
   map ['f', '-f', '--file'] => 'file'
-  desc 'file NAME', 'Build output files, from HAML/XML input file.'
+  desc '[file] FILEPATH', 'Build output files, from HAML/XML input file.'
   long_desc <<-LONGDESC
 
   Build questions about contents defined into input file specified.
@@ -35,51 +60,11 @@ class CLI < Thor
   (3) #{Rainbow('asker projects/foo/foo.yaml').aqua}, Build questions from YAML project file.
 
   LONGDESC
-  ##
-  # Create questions from input file
-  # @param filename (String) Path to input file
   def file(filename)
     # Asker start processing input file
     Asker.start(filename)
   end
 
-  map ['c', '-c', '--check'] => 'check'
-  desc 'check', 'Check input HAML file syntax'
-  ##
-  # Check input file syntax
-  # @param filename (String) Path to input file
-  def check(filename)
-    # Enable/disable color output
-    Rainbow.enabled = false if options['color'] == false
-    # Asker start processing input file
-    Asker.check(filename)
-  end
-
-  map ['h', '-h', '--homepage', 'homepage'] => 'show_homepage'
-  desc 'homepage', 'Documentation homepage'
-  ##
-  # Show documentation homepage
-  def show_homepage()
-    puts Application::HOMEPAGE
-  end
-
-  map ['i', '-i', '--init'] => 'init'
-  desc 'init', 'Create default INI config file'
-  ##
-  # Create default INI config file
-  def init
-    Asker.create_configuration
-  end
-
-  map ['n', '-n', '--new', 'new'] => 'create_input'
-  desc 'new [FOLDER]', 'Create Asker demo input files'
-  ##
-  # Create Asker demo input files
-  # @param dirname (String) Path to folder
-  def create_input(dirname)
-    Asker.create_input(dirname)
-  end
-
   ##
   # This actions are equals:
   # * asker demo/foo.haml

data/lib/asker/data/code.rb

@@ -1,22 +1,12 @@
 # frozen_string_literal: true
 
 require_relative '../ai/code/code_ai_factory'
-require_relative '../project'
-require_relative '../logger'
-require_relative '../formatter/code_string_formatter'
 
-##
-# Code data object
 class Code
   attr_reader :dirname, :filename, :type
   attr_accessor :process, :features
   attr_reader :lines, :questions
 
-  ##
-  # Initialize Code object
-  # @param dirname (String)
-  # @param filename (String)
-  # @param type (String)
   def initialize(dirname, filename, type)
     @dirname = dirname
     @filename = filename
@@ -40,17 +30,13 @@ class Code
     out
   end
 
-  def debug
-    Logger.verbose CodeStringFormatter.to_s(self)
-  end
-
   private
 
   def load(filepath)
     return if filepath.nil?
 
     unless File.exist? filepath
-      Logger.verboseln Rainbow("[ERROR] Unkown file #{filepath}").red.bright
+      puts Rainbow("[ERROR] Unkown file #{filepath}").red.bright
       return
     end
     content = File.read(filepath)

data/lib/asker/data/concept.rb

@@ -3,8 +3,6 @@
 require 'rainbow'
 require 'rexml/document'
 
-require_relative '../application'
-require_relative '../logger'
 require_relative '../lang/lang_factory'
 require_relative '../loader/embedded_file'
 require_relative 'table'
@@ -24,7 +22,7 @@ class Concept
   attr_reader :data      # Data about this concept
   attr_accessor :process # (Boolean) if it is necesary generate questions
 
-  @@id = 0 # Global Concept counter
+  @@id = 0 # Global Concept counter (concept identifier)
 
   ##
   # Initilize Concept
@@ -93,7 +91,8 @@ class Concept
   # rubocop:disable Metrics/AbcSize
   # rubocop:disable Metrics/CyclomaticComplexity
   def calculate_nearness_to_concept(other)
-    a = Application.instance.config['ai']['formula_weights']
+    a = ProjectData.instance.get(:weights)
+    #Application.instance.config['ai']['formula_weights']
     weights = a.split(',').map(&:to_f)
 
     max1 = @context.count
@@ -180,7 +179,7 @@ class Concept
         @data[:tables] << Table.new(self, i)
       else
         text = "   [ERROR] Concept #{name} with unkown attribute: #{i.name}"
-        Logger.verboseln Rainbow(text).color(:red)
+        puts Rainbow(text).color(:red)
       end
     end
   end
@@ -195,7 +194,7 @@ class Concept
 
   def process_tags(value)
     if value.text.nil? || value.text.size.zero?
-      Logger.verboseln Rainbow("[ERROR] Concept #{name} has tags empty!").red.briht
+      puts Rainbow("[ERROR] Concept #{name} has tags empty!").red.briht
       exit 1
     end
 
@@ -208,14 +207,16 @@ class Concept
   def process_def(value)
     case value.attributes['type']
     when 'image_url'
+      # Link with remote image
       @data[:images] << EmbeddedFile.load(value.text.strip, File.dirname(@filename))
     when 'file'
+      # Load local images and text files
       @data[:images] << EmbeddedFile.load(value.text.strip, File.dirname(@filename))
     when nil
       @data[:texts] << value.text.strip
     else
       msg = "[ERROR] Unknown type: #{value.attributes['type']}"
-      Logger.verboseln Rainbow(msg).red.bright
+      puts Rainbow(msg).red.bright
       exit 1
     end
   end

data/lib/asker/{project.rb → data/project_data.rb}

@@ -1,43 +1,30 @@
 # frozen_string_literal: true
 
 require 'singleton'
-require 'rainbow'
-require_relative 'application'
-require_relative 'logger'
 
-# Contains Project data and methods
-class Project
+class ProjectData
   include Singleton
   attr_reader :default, :param
 
-  ##
-  # Initialize
   def initialize
     reset
   end
 
-  ##
-  # Reset project params
   def reset
     @default = { inputbasedir: FileUtils.pwd,
                  stages: { d: true, b: true, f: true, i: true, s: true, t: true },
-                 threshold: 0.5 }
+                 threshold: 0.5,
+                 outputdir: 'output',
+                 weights: '1, 1, 1' }
     @param = {}
   end
 
-  ##
-  # Get value param
-  # @param key (Symbol) key
   def get(key)
     return @param[key] unless @param[key].nil?
 
     @default[key]
   end
 
-  ##
-  # Set value param
-  # @param key (Symbol) key
-  # @param value (String) value
   def set(key, value)
     @param[key] = value
   end
@@ -52,7 +39,6 @@ class Project
   # rubocop:disable Metrics/MethodLength
   # rubocop:disable Metrics/AbcSize
   def open
-    config = Application.instance.config
     ext = File.extname(@param[:process_file]) || '.haml'
     @param[:projectname] = @param[:projectname] ||
                            File.basename(@param[:process_file], ext)
@@ -63,7 +49,7 @@ class Project
     @param[:yamlname] = "#{@param[:projectname]}.yaml"
     @param[:moodlename] = "#{@param[:projectname]}-moodle.xml"
 
-    outputdir = config['output']['folder']
+    outputdir = get(:outputdir)
     @param[:logpath] = File.join(outputdir, get(:logname))
     @param[:outputpath] = File.join(outputdir, get(:outputname))
     @param[:lessonpath] = File.join(outputdir, get(:lessonname))
@@ -71,10 +57,6 @@ class Project
     @param[:moodlepath] = File.join(outputdir, get(:moodlename))
 
     Dir.mkdir(outputdir) unless Dir.exist?(outputdir)
-    Logger.create(self) # Create log file where to save log messages
-    Logger.verboseln '[INFO] Project open'
-    Logger.verboseln '   ├── inputdirs    = ' + Rainbow(get(:inputdirs)).bright
-    Logger.verboseln '   └── process_file = ' + Rainbow(get(:process_file)).bright
   end
   # rubocop:enable Metrics/MethodLength
   # rubocop:enable Metrics/AbcSize

data/lib/asker/data/world.rb

@@ -1,22 +1,14 @@
 # frozen_string_literal: true
 
 require_relative '../loader/image_url_loader'
-require_relative '../project'
-require_relative '../logger'
 
-##
-# World data
 class World
   attr_reader :concepts, :filenames, :contexts, :image_urls
 
-  ##
-  # Initialize World object
-  # @param concepts (Array)
-  # @param show_progress (Boolean)
-  def initialize(concepts, show_progress = true)
+  def initialize(concepts, internet = true)
     find_neighbors_for_every_concept(concepts)
     @concepts, @filenames, @contexts = get_lists_from(concepts)
-    @image_urls = find_url_images_from_internet(show_progress)
+    @image_urls = find_url_images_from_internet(internet)
   end
 
   ##
@@ -57,10 +49,9 @@ class World
   # rubocop:disable Metrics/AbcSize
   # rubocop:disable Metrics/CyclomaticComplexity
   # rubocop:disable Metrics/PerceivedComplexity
-  def find_url_images_from_internet(show_progress)
-    return {} unless Application.instance.config['global']['internet'] == 'yes'
+  def find_url_images_from_internet(internet)
+    return {} unless internet
 
-    Logger.verbose "\n[INFO] Loading data from Internet" if show_progress
     threads = []
     searchs = []
     urls = {}
@@ -68,11 +59,9 @@ class World
     @concepts&.each_key { |key| searchs << key }
     @contexts.each { |filter| searchs << filter.join(' ').to_s }
     searchs.each do |search|
-      Logger.verbose('.') if show_progress
       threads << Thread.new { urls[search] = ImageUrlLoader.load(search) }
     end
     threads.each(&:join) # wait for all threads to finish
-    Logger.verbose("\n") if show_progress
     urls
   end
   # rubocop:enable Metrics/MethodLength

data/lib/asker/displayer/concept_ai_displayer.rb

@@ -39,6 +39,7 @@ class ConceptAIDisplayer
       next unless concept_ai.concept.process?
 
       e = concept_ai.concept.texts.size
+      e += concept_ai.concept.images.size
       concept_ai.concept.tables.each { |t| e += t.fields.size * t.rows.size }
 
       sd = sb = sf = 0

data/lib/asker/exporter/concept_ai_moodle_exporter.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative '../formatter/question_moodle_formatter'
+require_relative '../version'
 
 # Export ConceptIA data to gift to moodlefile
 module ConceptAIMoodleExporter
@@ -13,8 +14,8 @@ module ConceptAIMoodleExporter
     file.write("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n")
     file.write("<quiz>\n")
     file.write("<!--\n#{('=' * 50)}\n")
-    file.write(" Created by : #{Application::NAME}")
-    file.write(" (version #{Application::VERSION})\n")
+    file.write(" Created by : #{Version::NAME}")
+    file.write(" (version #{Version::VERSION})\n")
     file.write(" File       : #{project.get(:moodlename)}\n")
     file.write(" Time       : #{Time.new}\n")
     file.write(" Author     : David Vargas Ruiz\n")

data/lib/asker/exporter/concept_doc_exporter.rb

@@ -1,18 +1,17 @@
 # frozen_string_literal: true
 
 require_relative '../formatter/concept_doc_formatter'
+require_relative '../version'
 
 ##
 # Export Concept to Doc file
 module ConceptDocExporter
   ##
-  # Export arrya of concepts to doc
-  # rubocop:disable Metrics/AbcSize
-  # rubocop:disable Metrics/MethodLength
+  # Export array of concepts to doc
   def self.export_all(concepts, project)
     file = File.new(project.get(:lessonpath), 'w')
     file.write('=' * 50 + "\n")
-    file.write("Created by : #{Application::NAME} (version #{Application::VERSION})\n")
+    file.write("Created by : #{Version::NAME} (version #{Version::VERSION})\n")
     file.write("File       : #{project.get(:lessonname)}\n")
     file.write("Time       : #{Time.new}\n")
     file.write("Author     : David Vargas Ruiz\n")
@@ -23,6 +22,4 @@ module ConceptDocExporter
     end
     file.close
   end
-  # rubocop:enable Metrics/AbcSize
-  # rubocop:enable Metrics/MethodLength
 end

data/lib/asker/exporter/data_gift_exporter.rb

@@ -2,6 +2,8 @@
 
 require_relative 'concept_ai_gift_exporter'
 require_relative 'code_gift_exporter'
+require_relative '../version'
+require_relative '../application'
 
 # Export Data (ConceptIA and Code) to gift to outputfile
 module DataGiftExporter
@@ -12,8 +14,8 @@ module DataGiftExporter
   def self.export_all(data, project)
     file = File.open(project.get(:outputpath), 'w')
     file.write('// ' + ('=' * 50) + "\n")
-    file.write("// Created by : #{Application::NAME}")
-    file.write(" (version #{Application::VERSION})\n")
+    file.write("// Created by : #{Version::NAME}")
+    file.write(" (version #{Version::VERSION})\n")
     file.write("// File       : #{project.get(:outputname)}\n")
     file.write("// Time       : #{Time.new}\n")
     file.write("// Author     : David Vargas Ruiz\n")

data/lib/asker/files/language/en/templates.yaml

@@ -13,7 +13,7 @@
 :f2: 'The next items are "<%=text2%>".<br/>Choose the option that not belongs concept <b><%=text1%></b>.'
 :f3: 'The next items are "<%=text2%>" from <b><%=text1%></b> concept:<br><p><%=text3%></p>(Put every word into the right position)'
 :i1: '<%=text1%><br/>Choose the best association for the previous image.<br/>'
-:i2: '<%=text1%><br/>The previous image corresponds to <b><%=text2%></b>.'
+:i2: '<%=text1%><br/>The previous image/text corresponds to <b><%=text2%></b>.'
 :i3: '<%=text1%><br/>Write the best answer <%=text2%>, for the previous image.<br/>'
 :i4: '<%=text1%><br/>Definition:<br/> <i><%=text2%></i><br/><br/>(Put every word in the right text position)'
 :s1: "About <b><%=text1%></b> concept, sort every \"<%=text2%>\", so It is true that \"<%=text3%>\".<br/>"

data/lib/asker/files/language/es/templates.yaml

@@ -13,7 +13,7 @@
 :f2: 'Los siguientes elementos son "<%=text2%>".<br/>Selecciona la opción que no pertenezca al concepto <b><%=text1%></b>.'
 :f3: 'Los siguientes elementos son "<%=text2%>" del concepto <b><%=text1%></b>:<br><p><%=text3%></p>(Coloca cada palabra en su posición correcta dentro del texto)'
 :i1: '<%=text1%><br/>Elige la opción que mejor se corresponda con la imagen anterior.<br/>'
-:i2: '<%=text1%><br/>La imagen anterior corresponde a <b><%=text2%></b>.'
+:i2: '<%=text1%><br/>La imagen/texto anterior corresponde a <b><%=text2%></b>.'
 :i3: '<%=text1%><br/>Escribe la opción <%=text2%>, que mejor corresponda con la imagen anterior.<br/>'
 :i4: '<%=text1%><br/>Definición: <i><%=text2%></i><br/><br/>(Coloca cada palabra en su posición correcta dentro del texto)'
 :s1: 'En relación al concepto <b><%=text1%></b>, ordena cada/las/los "<%=text2%>" de modo que se cumpla el criterio "<%=text3%>".<br/>'

data/lib/asker/formatter/concept_doc_formatter.rb

@@ -3,10 +3,6 @@
 require 'rainbow'
 require 'terminal-table'
 
-require_relative '../project'
-
-##
-# Formatter Concept to Doc
 module ConceptDocFormatter
   ##
   # Formatter Concept into Doc

data/lib/asker/loader/content_loader.rb

@@ -4,8 +4,7 @@ require 'rainbow'
 require 'rexml/document'
 require_relative '../data/concept'
 require_relative 'code_loader'
-require_relative '../logger'
-require_relative '../project'
+require_relative '../data/project_data'
 
 # Define methods that load data from XML contents
 module ContentLoader
@@ -13,8 +12,6 @@ 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 = []
@@ -33,7 +30,7 @@ module ContentLoader
       when 'code'
         codes << read_code(xmldata, filepath)
       else
-        Logger.verboseln Rainbow("[ERROR] Unkown tag <#{xmldata.name}>").red
+        puts Rainbow("[ERROR] Unkown tag <#{xmldata.name}>").red
       end
     end
 
@@ -49,7 +46,7 @@ module ContentLoader
     begin
       lang = xmldata.root.attributes['lang']
     rescue StandardError
-      lang = Project.instance.lang
+      lang = ProjectData.instance.lang
     end
     lang
   end
@@ -73,7 +70,7 @@ module ContentLoader
   # @param lang
   # @param context
   private_class_method def self.read_concept(xmldata, filepath, lang, context)
-    project = Project.instance
+    project = ProjectData.instance
     c = Concept.new(xmldata, filepath, lang, context)
     c.process = true if [File.basename(filepath), :default].include? project.get(:process_file)
     c
@@ -84,7 +81,7 @@ module ContentLoader
   # @param xmldata (XML Object)
   # @param filepath (String)
   private_class_method def self.read_code(xmldata, filepath)
-    project = Project.instance
+    project = ProjectData.instance
     c = CodeLoader.load(xmldata, filepath)
     c.process = true if [File.basename(filepath), :default].include? project.get(:process_file)
     c
@@ -95,8 +92,9 @@ module ContentLoader
   # @param filepath (String)
   # @param content (String)
   private_class_method def self.raise_error_with(filepath, content)
-    msg = Rainbow("[ERROR] ContentLoader: Format error in #{filepath}").red.bright
-    Logger.verboseln msg
+    msg =  "[ERROR] ContentLoader: Format error in #{filepath}\n"
+    msg += "        Take a look at ouput/error.xml"
+    puts Rainbow(msg).red.bright
     f = File.open('output/error.xml', 'w')
     f.write(content)
     f.close

data/lib/asker/loader/directory_loader.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require_relative 'file_loader'
-require_relative '../logger'
 
 # Load input data from one directory
 module DirectoryLoader
@@ -13,7 +12,6 @@ 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.verboseln " * Input directory  = #{Rainbow(dirname).bright}"
     DirectoryLoader.load_files(accepted, dirname)
   end
 
@@ -24,7 +22,7 @@ module DirectoryLoader
     return if Dir.exist? dirname
 
     msg = Rainbow("[ERROR] #{dirname} directory dosn't exist!").color(:red)
-    Logger.verboseln msg
+    puts msg
     raise msg
   end
 
@@ -48,11 +46,6 @@ module DirectoryLoader
   # @param filepath (String) Path to input file
   # @param last (Boolean) True if it is the last filename
   def self.load_file(filepath, last = false)
-    if last
-      Logger.verboseln "   └── Input file   = #{Rainbow(filepath).bright}"
-    else
-      Logger.verboseln "   ├── Input file   = #{Rainbow(filepath).bright}"
-    end
     FileLoader.load(filepath)
   end
 end

data/lib/asker/loader/file_loader.rb

@@ -2,21 +2,16 @@
 
 require_relative 'content_loader'
 require_relative 'haml_loader'
-require_relative '../logger'
 
 # Methods that load a filename and return list of concepts
 module FileLoader
-  ##
-  # Load asker data from file
-  # @param filename (String) File name to be load
   def self.load(filename)
     if File.extname(filename).casecmp('.haml').zero?
       file_content = HamlLoader.load filename
     elsif File.extname(filename).casecmp('.xml').zero?
       file_content = File.read(filename)
     else
-      msg = "[ERROR] FileLoader: Format error #{filename}"
-      Logger.verboseln msg
+      puts "[ERROR] FileLoader: Format error #{filename}"
       raise msg
     end
     ContentLoader.load(filename, file_content)

data/lib/asker/loader/haml_loader.rb

@@ -4,12 +4,16 @@ require 'haml'
 
 # HAML file loader
 module HamlLoader
-  ##
-  # Load HAML file name
-  # @param filename (String) HAML file name
   def self.load(filename)
     template = File.read(filename)
-    haml_engine = Haml::Engine.new(template)
-    haml_engine.render
+    begin
+      haml_engine = Haml::Engine.new(template)
+      return haml_engine.render
+    rescue StandardError => e
+      puts "[ERROR] HamlLoader: Can't load <#{filename}> file!"
+      puts "  => #{e}"
+      exit 0
+    end
   end
+
 end

data/lib/asker/loader/image_url_loader.rb

@@ -1,8 +1,6 @@
 
 require 'net/http'
 require 'uri'
-require_relative '../application'
-require_relative '../logger'
 
 # Search URL images on Internet
 # Methods:
@@ -36,10 +34,10 @@ module ImageUrlLoader
         end
       end
     rescue
-      Logger.verboseln '[ERROR] ImageUrlLoader'
-      Logger.verboseln " => #{search_url}"
-      Logger.verboseln ' => Check Internet connections'
-      Logger.verboseln ' => Ensure URL is well formed'
+      puts '[ERROR] ImageUrlLoader'
+      puts " => #{search_url}"
+      puts ' => Check Internet connections'
+      puts ' => Ensure URL is well formed'
     end
     image_urls
   end

data/lib/asker/loader/input_loader.rb

@@ -3,30 +3,29 @@
 require_relative 'directory_loader'
 require_relative '../ai/concept_ai'
 require_relative '../data/world'
-require_relative '../logger'
 
 # Load DATA defined into our Project
 module InputLoader
   ##
   # Load input data from every input directory
   # @param inputdirs (Array)
-  def self.load(inputdirs)
+  def self.load(inputdirs, internet = true)
     data = { concepts: [], codes: [], world: nil,
              concepts_ai: [], codes_ai: [] }
-    Logger.verboseln "\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[:codes] += temp[:codes]
     end
-    create_questions(data)
+    create_questions(data, internet)
   end
 
-  private_class_method def self.create_questions(data)
+  private_class_method def self.create_questions(data, internet)
     # Create World data
     # * Calculate concept neighbours
     # * TO-DO: Calculate code neighbours
-    data[:world] = World.new(data[:concepts])
+    data[:world] = World.new(data[:concepts], internet)
     # Create ConceptAI data (ConceptAI = concept + questions)
     data[:concepts].each do |concept|
       data[:concepts_ai] << ConceptAI.new(concept, data[:world])