asker-tool 2.1.6 → 2.2.2

data/lib/asker/data/concept.rb

@@ -3,21 +3,26 @@
 require 'rainbow'
 require 'rexml/document'
 
-require_relative '../application'
-require_relative '../logger'
 require_relative '../lang/lang_factory'
+require_relative '../loader/embedded_file'
 require_relative 'table'
 require_relative 'data_field'
 
 ##
 # Store Concept information
+# rubocop:disable Metrics/ClassLength
+# rubocop:disable Style/ClassVars
 class Concept
-  attr_reader :id, :lang, :context
-  attr_reader :names, :type, :filename
-  attr_reader :data
-  attr_accessor :process
+  attr_reader :id        # Unique identifer (Integer)
+  attr_reader :lang      # Lang code (By default is the same as map lang)
+  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
+  attr_reader :filename  # Filename where this concept is defined
+  attr_reader :data      # Data about this concept
+  attr_accessor :process # (Boolean) if it is necesary generate questions
 
-  @@id = 0    # Concept counter
+  @@id = 0 # Global Concept counter (concept identifier)
 
   ##
   # Initilize Concept
@@ -25,6 +30,8 @@ class Concept
   # @param filename (String)
   # @param lang_code (String)
   # @param context (Array)
+  # rubocop:disable Metrics/MethodLength
+  # rubocop:disable Metrics/AbcSize
   def initialize(xml_data, filename, lang_code = 'en', context = [])
     @@id += 1
     @id = @@id
@@ -46,16 +53,17 @@ class Concept
 
     @data = {}
     @data[:tags] = []
-    @data[:texts] = []
-    @data[:images] = []         # TODO: By now, We'll treat images separated from texts
-    @data[:textfile_paths] = [] # TODO: By now, We'll treat this separated from texts
+    @data[:texts] = []          # Used by standard def inputs
+    @data[:images] = []         # Used by [type => file and type => image_url] def inputs
     @data[:tables] = []
     @data[:neighbors] = []
     @data[:reference_to] = []
     @data[:referenced_by] = []
 
-	  read_data_from_xml(xml_data)
+    read_data_from_xml(xml_data)
   end
+  # rubocop:enable Metrics/MethodLength
+  # rubocop:enable Metrics/AbcSize
 
   def name(option = :raw)
     DataField.new(@names[0], @id, @type).get(option)
@@ -79,8 +87,12 @@ class Concept
     @data[:neighbors].reverse!
   end
 
+  # rubocop:disable Metrics/MethodLength
+  # 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
@@ -98,8 +110,12 @@ class Concept
     max = (max1 * weights[0] + max2 * weights[1] + max3 * weights[2])
     (alike * 100.0 / max)
   end
+  # rubocop:enable Metrics/MethodLength
+  # rubocop:enable Metrics/AbcSize
+  # rubocop:enable Metrics/CyclomaticComplexity
 
   # rubocop:disable Metrics/MethodLength
+  # rubocop:disable Metrics/AbcSize
   def try_adding_references(other)
     reference_to = 0
     @data[:tags].each do |i|
@@ -117,9 +133,34 @@ class Concept
     other.data[:referenced_by] << name
   end
   # rubocop:enable Metrics/MethodLength
+  # rubocop:enable Metrics/AbcSize
+
+  def tags
+    @data[:tags]
+  end
 
-  def method_missing(method)
-    @data[method]
+  def texts
+    @data[:texts]
+  end
+
+  def images
+    @data[:images]
+  end
+
+  def tables
+    @data[:tables]
+  end
+
+  def neighbors
+    @data[:neighbors]
+  end
+
+  def reference_to
+    @data[:reference_to]
+  end
+
+  def referenced_by
+    @data[:referenced_by]
   end
 
   private
@@ -137,8 +178,8 @@ class Concept
       when 'table'
         @data[:tables] << Table.new(self, i)
       else
-        text = "   [ERROR] <#{i.name}> unkown XML attribute for concept #{name}"
-        Logger.verbose Rainbow(text).color(:red)
+        text = "   [ERROR] Concept #{name} with unkown attribute: #{i.name}"
+        puts Rainbow(text).color(:red)
       end
     end
   end
@@ -153,7 +194,8 @@ class Concept
 
   def process_tags(value)
     if value.text.nil? || value.text.size.zero?
-      raise '[Error] tags label empty!'
+      puts Rainbow("[ERROR] Concept #{name} has tags empty!").red.briht
+      exit 1
     end
 
     @data[:tags] = value.text.split(',')
@@ -164,17 +206,22 @@ class Concept
   # rubocop:disable Metrics/MethodLength
   def process_def(value)
     case value.attributes['type']
-    when 'image'
-      msg = "[DEBUG] Concept#read_xml: image #{Rainbow(value.text).bright}"
-      Project.instance.verbose Rainbow(msg).yellow
     when 'image_url'
-      @data[:images] << value.text.strip
-    when 'textfile_path'
-      @data[:textfile_paths] << value.text.strip
-    else
+      # 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']}"
+      puts Rainbow(msg).red.bright
+      exit 1
     end
   end
   # rubocop:enable Metrics/AbcSize
   # rubocop:enable Metrics/MethodLength
 end
+# rubocop:enable Metrics/ClassLength
+# rubocop:enable Style/ClassVars

data/lib/asker/data/project_data.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'singleton'
+
+class ProjectData
+  include Singleton
+  attr_reader :default, :param
+
+  def initialize
+    reset
+  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' }
+    @param = {}
+  end
+
+  def get(key)
+    return @param[key] unless @param[key].nil?
+
+    @default[key]
+  end
+
+  def set(key, value)
+    @param[key] = value
+  end
+
+  ##
+  # Open new project
+  # * setting new params and
+  # * creating output files
+  # 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'
+    @param[:projectname] = @param[:projectname] ||
+                           File.basename(@param[:process_file], ext)
+
+    @param[:logname] = "#{@param[:projectname]}-log.txt"
+    @param[:outputname] = "#{@param[:projectname]}-gift.txt"
+    @param[:lessonname] = "#{@param[:projectname]}-doc.txt"
+    @param[:yamlname] = "#{@param[:projectname]}.yaml"
+    @param[:moodlename] = "#{@param[:projectname]}-moodle.xml"
+
+    outputdir = get(:outputdir)
+    @param[:logpath] = File.join(outputdir, get(:logname))
+    @param[:outputpath] = File.join(outputdir, get(:outputname))
+    @param[:lessonpath] = File.join(outputdir, get(:lessonname))
+    @param[:yamlpath] = File.join(outputdir, get(:yamlname))
+    @param[:moodlepath] = File.join(outputdir, get(:moodlename))
+
+    Dir.mkdir(outputdir) unless Dir.exist?(outputdir)
+  end
+  # rubocop:enable Metrics/MethodLength
+  # rubocop:enable Metrics/AbcSize
+end

data/lib/asker/data/table.rb

@@ -114,6 +114,7 @@ class Table
 
   # rubocop:disable Metrics/MethodLength
   # rubocop:disable Metrics/AbcSize
+  # rubocop:disable Style/ConditionalAssignment
   def read_lang_from_xml(xml_data)
     j = xml_data.text.split(',')
     codes = @langs.map(&:code)
@@ -131,6 +132,7 @@ class Table
   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(',')

data/lib/asker/data/template.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 
 require 'rexml/document'
 require_relative 'row'
@@ -40,7 +41,8 @@ class Template
 
   def apply_vars_to_template(vars, template)
     output = ''
-    return if vars.size.zero?
+    return output if vars.size.zero?
+
     max = vars.first[1].size
     (1..max).each do |index|
       t = template.dup

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
 
   ##
@@ -55,11 +47,11 @@ class World
 
   # rubocop:disable Metrics/MethodLength
   # rubocop:disable Metrics/AbcSize
-  def find_url_images_from_internet(show_progress)
-    param = Application.instance.config['global']['internet'] || 'yes'
-    return {} unless param == 'yes'
+  # rubocop:disable Metrics/CyclomaticComplexity
+  # rubocop:disable Metrics/PerceivedComplexity
+  def find_url_images_from_internet(internet)
+    return {} unless internet
 
-    Logger.verbose "\n[INFO] Loading data from Internet" if show_progress
     threads = []
     searchs = []
     urls = {}
@@ -67,13 +59,13 @@ class World
     @concepts&.each_key { |key| searchs << key }
     @contexts.each { |filter| searchs << filter.join(' ').to_s }
     searchs.each do |search|
-      print('.') if show_progress
       threads << Thread.new { urls[search] = ImageUrlLoader.load(search) }
     end
     threads.each(&:join) # wait for all threads to finish
-    print("\n") if show_progress
     urls
   end
   # rubocop:enable Metrics/MethodLength
   # rubocop:enable Metrics/AbcSize
+  # rubocop:enable Metrics/CyclomaticComplexity
+  # rubocop:enable Metrics/PerceivedComplexity
 end

data/lib/asker/displayer/code_displayer.rb

@@ -5,6 +5,11 @@ require_relative '../logger'
 
 # Export Code into Screen
 module CodeDisplayer
+  ##
+  # Show all "code" data on screen
+  # @param codes (Array) List of "code" data
+  # rubocop:disable Metrics/AbcSize
+  # rubocop:disable Metrics/MethodLength
   def self.show(codes)
     return if codes.nil? || codes.size.zero?
 
@@ -42,4 +47,6 @@ module CodeDisplayer
     Logger.verboseln "\n[INFO] Showing CODE statistics"
     Logger.verboseln my_screen_table.to_s
   end
+  # rubocop:enable Metrics/AbcSize
+  # rubocop:enable Metrics/MethodLength
 end

data/lib/asker/displayer/concept_ai_displayer.erb

@@ -0,0 +1,10 @@
+
+[INFO] Showing CONCEPT statistics
+ * Exclude questions: <%= exclude_questions %>
+ * Annotations:
+   ├── (d) Definitions     <= Concept.def
+   ├── (b) Table Matching  <= Concept.table.rows.columns
+   ├── (f) Tables 1 Field  <= Concept.table.fields.size==1
+   ├── (i) Images URL      <= Concept.def{:type => 'file'}
+   ├── (s) Sequences       <= Concept.table{:sequence => '...'}
+   └── (t) Table Rows&Cols <= Concept.table.rows.columns

data/lib/asker/displayer/concept_ai_displayer.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'erb'
 require 'terminal-table'
 require_relative '../application'
 require_relative '../logger'
@@ -9,11 +10,15 @@ class ConceptAIDisplayer
   ##
   # Display ConceptAI stat on screen
   # @param concepts_ai (Array)
+  # rubocop:disable Metrics/MethodLength
+  # rubocop:disable Metrics/AbcSize
+  # rubocop:disable Metrics/CyclomaticComplexity
+  # rubocop:disable Metrics/PerceivedComplexity
   def self.show(concepts_ai)
     stages = Application.instance.config['questions']['stages']
     # Create table HEAD
     screen_table = Terminal::Table.new do |st|
-      title = ['Concept', 'Questions', 'Entries', 'xFactor']
+      title = %w[Concept Questions Entries xFactor]
       %w[d b f i s t].each do |i|
         if stages.include? i.to_sym
           title << i
@@ -31,10 +36,11 @@ class ConceptAIDisplayer
     total[:si] = total[:ss] = total[:st] = 0
 
     concepts_ai.each do |concept_ai|
-      next unless concept_ai.process?
+      next unless concept_ai.concept.process?
 
-      e = concept_ai.texts.size
-      concept_ai.tables.each { |t| e += t.fields.size * t.rows.size }
+      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
       si = ss = st = 0
@@ -48,7 +54,7 @@ class ConceptAIDisplayer
 
       factor = 'Unkown'
       factor = (t.to_f / e).round(2).to_s unless e.zero?
-      screen_table.add_row [Rainbow(concept_ai.name(:screen)).green.bright,
+      screen_table.add_row [Rainbow(concept_ai.concept.name(:screen)).green.bright,
                             t, e, factor, sd, sb, sf, si, ss, st]
 
       total[:q] += t
@@ -75,9 +81,15 @@ class ConceptAIDisplayer
                           total[:sd], total[:sb], total[:sf],
                           total[:si], total[:ss], total[:st]]
     export_notes
-    Logger.verbose "#{screen_table}\n"
+    Logger.verboseln "#{screen_table}\n"
   end
+  # rubocop:enable Metrics/MethodLength
+  # rubocop:enable Metrics/AbcSize
+  # rubocop:enable Metrics/CyclomaticComplexity
+  # rubocop:enable Metrics/PerceivedComplexity
 
+  # rubocop:disable Metrics/MethodLength
+  # rubocop:disable Metrics/AbcSize
   private_class_method def self.export_excluded_questions(screen_table, concepts_ai)
     # Create table BODY
     total = {}
@@ -86,7 +98,7 @@ class ConceptAIDisplayer
     total[:si] = total[:ss] = total[:st] = 0
 
     concepts_ai.each do |concept_ai|
-      next unless concept_ai.process?
+      next unless concept_ai.concept.process?
 
       sd = concept_ai.excluded_questions[:d].size
       sb = concept_ai.excluded_questions[:b].size
@@ -111,22 +123,12 @@ class ConceptAIDisplayer
                           total[:sf], total[:si],
                           total[:ss], total[:st]]
   end
+  # rubocop:enable Metrics/MethodLength
+  # rubocop:enable Metrics/AbcSize
 
   private_class_method def self.export_notes
-    Logger.verbose "\n[INFO] Showing CONCEPT statistics\n"
-    Logger.verbose ' * Exclude questions: ' +
-                   Application.instance.config['questions']['exclude'].to_s
-    Logger.verbose ' * Annotations:'
-    Logger.verbose '   ├── (d) Definitions     <= Concept.def'
-    Logger.verbose '   ├── (b) Table Matching  <= ' \
-                   'Concept.table.rows.columns'
-    Logger.verbose '   ├── (f) Tables 1 Field  <= Concept.table.fields.size==1'
-    Logger.verbose '   ├── (i) Images URL      <= ' \
-                   "Concept.def{:type => 'image_url'}"
-    Logger.verbose '   ├── (s) Sequences       <= ' \
-                   "Concept.table{:sequence => '...'}"
-    Logger.verbose '   └── (t) Table Rows&Cols <= ' \
-                  'Concept.table.rows.columns'
-    Logger.verbose "\n"
+    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)
   end
 end

data/lib/asker/displayer/concept_displayer.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 require_relative '../application'
 require_relative '../formatter/concept_string_formatter'
@@ -7,23 +8,27 @@ require_relative '../logger'
 module ConceptDisplayer
   ##
   # Show concepts on screen
-  # @param concepts (Array)
+  # @param concepts (Array) List of concept data
+  # rubocop:disable Metrics/AbcSize
+  # rubocop:disable Metrics/MethodLength
   def self.show(concepts)
     show_mode = Application.instance.config['global']['show_mode']
     return unless show_mode
 
     msg = "\n[INFO] Showing concept data (#{Rainbow(show_mode).bright})"
-    Logger.verbose msg
+    Logger.verboseln msg
     case show_mode
     when 'resume'
       s = "* Concepts (#{concepts.count}): "
       concepts.each { |c| s += c.name + ', ' }
-      Logger.verbose s
+      Logger.verboseln s
     when 'default'
       # Only show Concepts with process attr true
       concepts.each do |c|
-        Logger.verbose ConceptStringFormatter.to_s(c) if c.process?
+        Logger.verboseln ConceptStringFormatter.to_s(c) if c.process?
       end
     end
   end
+  # rubocop:enable Metrics/AbcSize
+  # rubocop:enable Metrics/MethodLength
 end

data/lib/asker/displayer/stats_displayer.rb

@@ -1,9 +1,17 @@
+# frozen_string_literal: true
+
 require_relative '../application'
 require_relative 'concept_ai_displayer'
 require_relative 'code_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
   def self.show(data)
     return unless Application.instance.config['global']['show_mode']
 

data/lib/asker/exporter/concept_ai_gift_exporter.rb

@@ -1,6 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-require_relative '../project'
 require_relative '../formatter/question_gift_formatter'
 
 # Export ConceptIA data to gift to outputfile
@@ -8,16 +7,19 @@ module ConceptAIGiftExporter
   ##
   # Export an array of ConceptAI objects from Project into GIFT outpufile
   # @param concepts_ai (Array)
-  # @param project (Project)
-  def self.export_all(concepts_ai, project)
-    concepts_ai.each { |concept_ai| export(concept_ai, project) }
+  # @param file (File)
+  def self.export_all(concepts_ai, file)
+    concepts_ai.each { |concept_ai| export(concept_ai, file) }
   end
 
-  private_class_method def self.export(concept_ai, project)
-    return unless concept_ai.process?
+  ##
+  # Export 1 concept_ai from project
+  # @param concept_ai (ConceptAI)
+  # @param file (File)
+  private_class_method def self.export(concept_ai, file)
+    return unless concept_ai.concept.process?
 
-    file = project.get(:outputfile)
-    file.write head(concept_ai.name)
+    file.write head(concept_ai.concept.name)
     Application.instance.config['questions']['stages'].each do |stage|
       concept_ai.questions[stage].each do |question|
         file.write(QuestionGiftFormatter.to_s(question))
@@ -25,7 +27,11 @@ module ConceptAIGiftExporter
     end
   end
 
-  def self.head(name)
+  ##
+  # Convert Concept name into gift format head
+  # @param name (String)
+  # @return String
+  private_class_method def self.head(name)
     s = "\n"
     s += '// ' + '=' * 50 + "\n"
     s += "// Concept name: #{name}\n"

data/lib/asker/exporter/concept_ai_moodle_exporter.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative '../formatter/question_moodle_formatter'
+
+# Export ConceptIA data to gift to moodlefile
+module ConceptAIMoodleExporter
+  ##
+  # Export an array of ConceptAI objects from Project into Moodle format file
+  # @param concepts_ai (Array)
+  # @param project (Project)
+  def self.export_all(concepts_ai, project)
+    file = File.open(project.get(:moodlepath), 'w')
+    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(" File       : #{project.get(:moodlename)}\n")
+    file.write(" Time       : #{Time.new}\n")
+    file.write(" Author     : David Vargas Ruiz\n")
+    file.write("#{('=' * 50)}\n-->\n\n")
+
+    concepts_ai.each { |concept_ai| export(concept_ai, file) }
+
+    file.write("</quiz>\n")
+    file.close
+  end
+
+  ##
+  # Export 1 concept_ai from project
+  # @param concept_ai (ConceptAI)
+  # @param file (File)
+  # rubocop:disable Metrics/AbcSize
+  private_class_method def self.export(concept_ai, file)
+    return unless concept_ai.concept.process?
+
+    Application.instance.config['questions']['stages'].each do |stage|
+      concept_ai.questions[stage].each do |question|
+        file.write(QuestionMoodleFormatter.to_s(question))
+      end
+    end
+  end
+  # rubocop:enable Metrics/AbcSize
+end

data/lib/asker/exporter/concept_ai_yaml_exporter.rb

@@ -17,16 +17,19 @@ module ConceptAIYAMLExporter
     params = { lang: project.get(:lang) ,
                projectname: project.get(:projectname) }
     output = { params: params, questions: questions }
-    project.get(:yamlfile).write(output.to_yaml)
+
+    yamlfile = File.open(project.get(:yamlpath), 'w')
+    yamlfile.write(output.to_yaml)
+    yamlfile.close
   end
 
   private_class_method def self.get_questions_from(concept_ai)
     data = []
-    return data unless concept_ai.process?
+    return data unless concept_ai.concept.process?
 
     Application.instance.config['questions']['stages'].each do |stage|
       concept_ai.questions[stage].each do |question|
-        question.lang = concept_ai.lang
+        question.lang = concept_ai.concept.lang
         data << QuestionHashFormatter.to_hash(question)
       end
     end

data/lib/asker/exporter/concept_doc_exporter.rb

@@ -7,9 +7,22 @@ require_relative '../formatter/concept_doc_formatter'
 module ConceptDocExporter
   ##
   # Export arrya of concepts to doc
-  def self.export_all(concepts, file)
+  # rubocop:disable Metrics/AbcSize
+  # rubocop:disable Metrics/MethodLength
+  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("File       : #{project.get(:lessonname)}\n")
+    file.write("Time       : #{Time.new}\n")
+    file.write("Author     : David Vargas Ruiz\n")
+    file.write('=' * 50 + "\n")
+
     concepts.each do |concept|
       file.write(ConceptDocFormatter.to_s(concept)) if concept.process
     end
+    file.close
   end
+  # rubocop:enable Metrics/AbcSize
+  # rubocop:enable Metrics/MethodLength
 end