asker-tool 2.1.3 → 2.2.0

data/lib/asker/data/world.rb

@@ -1,48 +1,31 @@
+# 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
 
-  def initialize(concepts, show_progress=true)
+  ##
+  # Initialize World object
+  # @param concepts (Array)
+  # @param show_progress (Boolean)
+  def initialize(concepts, show_progress = true)
     find_neighbors_for_every_concept(concepts)
-
-    @concepts   = {}
-    @filenames  = []
-    @contexts   = []
-    @image_urls = {}
-
-    concepts.each do |c|
-      if c.process
-        @concepts[c.name] = c
-        @filenames << c.filename
-        @contexts  << c.context
-      end
-    end
-    @filenames.uniq!
-    @contexts.uniq!
-
-    threads = []
-    concepts.each do |c|
-      print('.') if show_progress
-      # puts "[DEBUG] #{c.name}\n"
-      # filter = [ c.name.clone ] + c.context.clone
-      filter = c.name.clone
-      threads << Thread.new { @image_urls[c.name] = ImageUrlLoader::load(filter) }
-    end
-    @contexts.each do |filter|
-      print('.') if show_progress
-      threads << Thread.new { @image_urls[ filter.join('.').to_s ] = ImageUrlLoader::load(filter) }
-    end
-    threads.each { |t| t.join } # wait for all threads to finish
-    print("\n") if show_progress
+    @concepts, @filenames, @contexts = get_lists_from(concepts)
+    @image_urls = find_url_images_from_internet(show_progress)
   end
 
+  ##
+  # For every concept... find its neighbors
+  # @param concepts (Array)
   def find_neighbors_for_every_concept(concepts)
     concepts.each do |i|
       concepts.each do |j|
-        if (i.id!=j.id) then
+        if i.id != j.id
           i.try_adding_neighbor(j)
           i.try_adding_references(j)
         end
@@ -50,4 +33,50 @@ class World
     end
   end
 
+  private
+
+  # rubocop:disable Metrics/MethodLength
+  def get_lists_from(input)
+    concepts = {}
+    filenames = []
+    contexts = []
+    input.each do |c|
+      next unless c.process
+
+      concepts[c.name] = c
+      filenames << c.filename
+      contexts  << c.context
+    end
+    filenames.uniq!
+    contexts.uniq!
+    [concepts, filenames, contexts]
+  end
+  # rubocop:enable Metrics/MethodLength
+
+  # rubocop:disable Metrics/MethodLength
+  # 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'
+
+    Logger.verbose "\n[INFO] Loading data from Internet" if show_progress
+    threads = []
+    searchs = []
+    urls = {}
+
+    @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
+  # rubocop:enable Metrics/AbcSize
+  # rubocop:enable Metrics/CyclomaticComplexity
+  # rubocop:enable Metrics/PerceivedComplexity
 end

data/lib/asker/{exporter/code_screen_exporter.rb → displayer/code_displayer.rb}

@@ -1,12 +1,17 @@
 # frozen_string_literal: true
 
 require 'terminal-table'
+require_relative '../logger'
 
 # Export Code into Screen
-module CodeScreenExporter
-  def self.export_all(codes)
-    project = Project.instance
-    return if project.show_mode == :none || codes.nil? || codes.size.zero?
+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?
 
     total_c = total_q = total_e = 0
     my_screen_table = Terminal::Table.new do |st|
@@ -39,7 +44,9 @@ module CodeScreenExporter
                              Rainbow((total_q / total_e.to_f).round(2)).bright]
     return unless total_c.positive?
 
-    project.verboseln "\n[INFO] Showing CODE statistics"
-    project.verboseln my_screen_table.to_s
+    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

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+require 'erb'
+require 'terminal-table'
+require_relative '../application'
+require_relative '../logger'
+
+# Display ConceptAI stat on screen
+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 = %w[Concept Questions Entries xFactor]
+      %w[d b f i s t].each do |i|
+        if stages.include? i.to_sym
+          title << i
+          next
+        end
+        title << Rainbow(i).yellow.bright
+      end
+      st << title
+      st << :separator
+    end
+    # Create table BODY
+    total = {}
+    total[:q] = total[:e] = total[:c] = 0
+    total[:sd] = total[:sb] = total[:sf] = 0
+    total[:si] = total[:ss] = total[:st] = 0
+
+    concepts_ai.each do |concept_ai|
+      next unless concept_ai.concept.process?
+
+      e = concept_ai.concept.texts.size
+      concept_ai.concept.tables.each { |t| e += t.fields.size * t.rows.size }
+
+      sd = sb = sf = 0
+      si = ss = st = 0
+      sd = concept_ai.questions[:d].size if stages.include? :d
+      sb = concept_ai.questions[:b].size if stages.include? :b
+      sf = concept_ai.questions[:f].size if stages.include? :f
+      si = concept_ai.questions[:i].size if stages.include? :i
+      ss = concept_ai.questions[:s].size if stages.include? :s
+      st = concept_ai.questions[:t].size if stages.include? :t
+      t = sd + sb + sf + si + ss + st
+
+      factor = 'Unkown'
+      factor = (t.to_f / e).round(2).to_s unless e.zero?
+      screen_table.add_row [Rainbow(concept_ai.concept.name(:screen)).green.bright,
+                            t, e, factor, sd, sb, sf, si, ss, st]
+
+      total[:q] += t
+      total[:e] += e
+      total[:c] += 1
+      total[:sd] += sd
+      total[:sb] += sb
+      total[:sf] += sf
+      total[:si] += si
+      total[:ss] += ss
+      total[:st] += st
+    end
+    return if total[:c].zero? # No concepts to be process?
+
+    # Add row with excluded questions
+    export_excluded_questions(screen_table, concepts_ai)
+
+    # Create table TAIL
+    screen_table.add_separator
+    screen_table.add_row [Rainbow("TOTAL = #{total[:c]}").bright,
+                          Rainbow(total[:q].to_s).bright,
+                          Rainbow(total[:e].to_s).bright,
+                          Rainbow((total[:q].to_f / total[:e]).round(2)).bright,
+                          total[:sd], total[:sb], total[:sf],
+                          total[:si], total[:ss], total[:st]]
+    export_notes
+    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 = {}
+    total[:q] = total[:c] = 0
+    total[:sd] = total[:sb] = total[:sf] = 0
+    total[:si] = total[:ss] = total[:st] = 0
+
+    concepts_ai.each do |concept_ai|
+      next unless concept_ai.concept.process?
+
+      sd = concept_ai.excluded_questions[:d].size
+      sb = concept_ai.excluded_questions[:b].size
+      sf = concept_ai.excluded_questions[:f].size
+      si = concept_ai.excluded_questions[:i].size
+      ss = concept_ai.excluded_questions[:s].size
+      st = concept_ai.excluded_questions[:t].size
+      t = sd + sb + sf + si + ss + st
+
+      total[:q] += t
+      total[:c] += 1
+      total[:sd] += sd
+      total[:sb] += sb
+      total[:sf] += sf
+      total[:si] += si
+      total[:ss] += ss
+      total[:st] += st
+    end
+    screen_table.add_row [Rainbow('Excluded questions').yellow.bright,
+                          total[:q], '-', '-',
+                          total[:sd], total[:sb],
+                          total[:sf], total[:si],
+                          total[:ss], total[:st]]
+  end
+  # rubocop:enable Metrics/MethodLength
+  # rubocop:enable Metrics/AbcSize
+
+  private_class_method def self.export_notes
+    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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative '../application'
+require_relative '../formatter/concept_string_formatter'
+require_relative '../logger'
+
+# Show Concept Data on screen
+module ConceptDisplayer
+  ##
+  # Show concepts on screen
+  # @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.verboseln msg
+    case show_mode
+    when 'resume'
+      s = "* Concepts (#{concepts.count}): "
+      concepts.each { |c| s += c.name + ', ' }
+      Logger.verboseln s
+    when 'default'
+      # Only show Concepts with process attr true
+      concepts.each do |c|
+        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

@@ -0,0 +1,22 @@
+# 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']
+
+    # show_final_results
+    ConceptAIDisplayer.show(data[:concepts_ai])
+    CodeDisplayer.show(data[:codes_ai])
+  end
+end

data/lib/asker/exporter/code_gift_exporter.rb

@@ -1,31 +1,30 @@
 # frozen_string_literal: true
 
-require_relative '../project'
 require_relative '../formatter/question_gift_formatter'
 
-# UNDER DEVELOPMENT
 # Use to export questions from Code to gift format
 module CodeGiftExporter
-  def self.export_all(codes)
-    codes.each do |code|
-      code.make_questions
-      export code
-    end
+  ##
+  # Export an Array of codes to gift format file
+  # @param codes (Array)
+  def self.export_all(codes, file)
+    codes.each { |code| export(code, file) }
   end
 
-  def self.export(code)
+  ##
+  # Export 1 code to gift format file
+  # @param code (Code)
+  def self.export(code, file)
     return false unless code.process?
 
-    file = Project.instance.outputfile
     file.write head(code)
-
     code.questions.each do |question|
       file.write QuestionGiftFormatter.to_s(question)
     end
     true
   end
 
-  def self.head(code)
+  private_class_method def self.head(code)
     s = "\n"
     s += '// ' + '=' * 50 + "\n"
     s += "// Code #{code.type}: #{code.filename} (#{code.questions.size})\n"

data/lib/asker/exporter/concept_ai_gift_exporter.rb

@@ -1,29 +1,37 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-require_relative '../project'
 require_relative '../formatter/question_gift_formatter'
 
-# Use to export data from ConceptIA to gift format
+# Export ConceptIA data to gift to outputfile
 module ConceptAIGiftExporter
-  def self.export_all(concepts_ai)
-    concepts_ai.each { |concept_ai| export(concept_ai) }
+  ##
+  # Export an array of ConceptAI objects from Project into GIFT outpufile
+  # @param concepts_ai (Array)
+  # @param file (File)
+  def self.export_all(concepts_ai, file)
+    concepts_ai.each { |concept_ai| export(concept_ai, file) }
   end
-  
-  def self.export(concept_ai)
-    return unless concept_ai.process?
 
-    file = Project.instance.outputfile
-    file.write head(concept_ai.name)
+  ##
+  # 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?
 
-    stages = Project.instance.stages
-    stages.each_key do |stage|
+    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))
       end
     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

@@ -1,30 +1,35 @@
 # encoding: utf-8
 
 require 'yaml'
-require_relative '../project'
 require_relative '../formatter/question_hash_formatter'
 
 # Use to export data from ConceptIA to YAML format
 module ConceptAIYAMLExporter
-  def self.export_all(concepts_ai)
+  ##
+  # Export array of ConceptAI objects from Project to YAML output file
+  # @param concepts_ai (Array)
+  # @param project (Project)
+  def self.export_all(concepts_ai, project)
     questions = []
     concepts_ai.each do |concept_ai|
       questions += get_questions_from concept_ai
     end
-    project = Project.instance
     params = { lang: project.get(:lang) ,
                projectname: project.get(:projectname) }
     output = { params: params, questions: questions }
-    project.yamlfile.write(output.to_yaml)
+
+    yamlfile = File.open(project.get(:yamlpath), 'w')
+    yamlfile.write(output.to_yaml)
+    yamlfile.close
   end
 
-  def self.get_questions_from(concept_ai)
+  private_class_method def self.get_questions_from(concept_ai)
     data = []
-    return data unless concept_ai.process?
-    stages = Project.instance.stages
-    stages.each_key do |stage|
+    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

@@ -1,21 +1,28 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-require_relative '../project'
 require_relative '../formatter/concept_doc_formatter'
 
-class ConceptDocExporter
+##
+# Export Concept to Doc file
+module ConceptDocExporter
+  ##
+  # Export arrya of concepts to doc
+  # 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")
 
-  def initialize(concepts)
-    @concepts = concepts
-  end
-
-  def export
-    file = Project.instance.lessonfile
-    @concepts.each do |concept|
-      if concept.process
-        file.write(ConceptDocFormatter.to_s(concept))
-      end
+    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

data/lib/asker/exporter/data_gift_exporter.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative 'concept_ai_gift_exporter'
+require_relative 'code_gift_exporter'
+
+# Export Data (ConceptIA and Code) to gift to outputfile
+module DataGiftExporter
+  ##
+  # Export an array of Data (ConceptAI and Code objects) into GIFT outpufile
+  # @param data (Hash)
+  # @param project (Project)
+  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("// File       : #{project.get(:outputname)}\n")
+    file.write("// Time       : #{Time.new}\n")
+    file.write("// Author     : David Vargas Ruiz\n")
+    file.write('// ' + ('=' * 50) + "\n\n")
+    category = Application.instance.config['questions']['category']
+    file.write("$CATEGORY: $course$/#{category}\n") unless category.nil?
+
+    ConceptAIGiftExporter.export_all(data[:concepts_ai], file)
+    CodeGiftExporter.export_all(data[:codes_ai], file)
+
+    file.close
+  end
+end

data/lib/asker/exporter/output_file_exporter.rb

@@ -0,0 +1,21 @@
+require_relative 'concept_ai_moodle_exporter'
+require_relative 'concept_ai_yaml_exporter'
+require_relative 'concept_doc_exporter'
+require_relative 'data_gift_exporter'
+
+# Export Output data:
+# * Gift (ConceptAI, Code)
+# * YAML
+# * Doc (txt)
+module OutputFileExporter
+  def self.export(data, project)
+    config = Application.instance.config
+    DataGiftExporter.export_all(data, project) if config['output']['gift'] == 'yes'
+    ConceptAIYAMLExporter.export_all(data[:concepts_ai], project) if config['output']['yaml'] == 'yes'
+    ConceptDocExporter.export_all(data[:concepts], project) if config['output']['doc'] == 'yes'
+    # ConceptAIGiftExporter.export_all(data[:concepts_ai], project) if config['output']['gift'] == 'yes'
+    # CodeGiftExporter.export_all(data[:codes_ai], project.get(:outputfile)) if config['output']['gift'] == 'yes'
+    # UNDER DEVELOPMENT
+    ConceptAIMoodleExporter.export_all(data[:concepts_ai], project) if config['output']['moodle'] == 'yes'
+  end
+end