asker-tool 2.1.5 → 2.2.1

data/lib/asker/loader/code_loader.rb

@@ -3,7 +3,7 @@
 require 'rainbow'
 require 'rexml/document'
 require_relative '../logger'
-require_relative '../code/code'
+require_relative '../data/code'
 
 # Read XML info about Code input data
 module CodeLoader
@@ -24,7 +24,7 @@ module CodeLoader
   # @param xmldata (XML Object)
   # @param filename (String) File name that contains data
   # @return Code object
-  def self.read_codedata_from_xml(xmldata, filename)
+  private_class_method def self.read_codedata_from_xml(xmldata, filename)
     data = { path: '?', type: '?', features: [] }
     xmldata.elements.each do |i|
       data[:path] = i.text if i.name == 'path'
@@ -38,14 +38,14 @@ module CodeLoader
   # Read features data from XML input
   # @param xmldata (XML object)
   # @return Array with features (Strings)
-  def self.read_features(xmldata, filename)
+  private_class_method def self.read_features(xmldata, filename)
     features = []
     xmldata.elements.each do |i|
       if i.name == 'row'
         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

@@ -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,6 +12,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 = []
@@ -31,21 +32,23 @@ 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
 
     { concepts: concepts, codes: codes }
   end
+  # rubocop:enable Metrics/MethodLength
+  # rubocop:enable Metrics/AbcSize
 
   ##
   # Read lang attr from input XML data
   # @param xmldata (XML Object)
-  def self.read_lang_attribute(xmldata)
+  private_class_method def self.read_lang_attribute(xmldata)
     begin
       lang = xmldata.root.attributes['lang']
     rescue StandardError
-      lang = Project.instance.lang
+      lang = ProjectData.instance.lang
     end
     lang
   end
@@ -53,7 +56,7 @@ module ContentLoader
   ##
   # Read context attr from input XML data
   # @param xmldata (XML Object)
-  def self.read_context_attribute(xmldata)
+  private_class_method def self.read_context_attribute(xmldata)
     begin
       context = xmldata.root.attributes['context']
     rescue StandardError
@@ -68,12 +71,10 @@ module ContentLoader
   # @param filepath (String)
   # @param lang
   # @param context
-  def self.read_concept(xmldata, filepath, lang, context)
-    project = Project.instance
+  private_class_method def self.read_concept(xmldata, filepath, lang, context)
+    project = ProjectData.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
 
@@ -81,18 +82,19 @@ module ContentLoader
   # Read code from input XML data
   # @param xmldata (XML Object)
   # @param filepath (String)
-  def self.read_code(xmldata, filepath)
-    project = Project.instance
+  private_class_method def self.read_code(xmldata, filepath)
+    project = ProjectData.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
 
-  def self.raise_error_with(filepath, content)
-    msg = Rainbow("[ERROR] ContentLoader: Format error in #{filepath}").red.bright
-    Logger.verbose msg
+  ##
+  # Raise error and save content into error.file
+  # @param filepath (String)
+  # @param content (String)
+  private_class_method def self.raise_error_with(filepath, content)
+    puts Rainbow("[ERROR] ContentLoader: Format error in #{filepath}").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.verbose " * 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.verbose "   └── Input file   = #{Rainbow(filepath).bright}"
-    else
-      Logger.verbose "   ├── Input file   = #{Rainbow(filepath).bright}"
-    end
     FileLoader.load(filepath)
   end
 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

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 
-require 'haml'
 require_relative 'content_loader'
-require_relative '../logger'
+require_relative 'haml_loader'
 
 # Methods that load a filename and return list of concepts
 module FileLoader
@@ -11,23 +10,13 @@ module FileLoader
   # @param filename (String) File name to be load
   def self.load(filename)
     if File.extname(filename).casecmp('.haml').zero?
-      file_content = load_haml filename
+      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.verbose msg
+      puts "[ERROR] FileLoader: Format error #{filename}"
       raise msg
     end
     ContentLoader.load(filename, file_content)
   end
-
-  ##
-  # Load HAML file name
-  # @param filename (String) HAML file name
-  def self.load_haml(filename)
-    template = File.read(filename)
-    haml_engine = Haml::Engine.new(template)
-    haml_engine.render
-  end
 end

data/lib/asker/loader/haml_loader.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+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
+  end
+end

data/lib/asker/loader/image_url_loader.rb

@@ -1,8 +1,6 @@
 
 require 'net/http'
 require 'uri'
-require_relative '../project'
-require_relative '../application'
 
 # Search URL images on Internet
 # Methods:
@@ -12,9 +10,6 @@ require_relative '../application'
 module ImageUrlLoader
   # Search "input" images on Google and return URL
   def self.load(input = [])
-    param = Application.instance.config['global']['internet'] || 'yes'
-    return [] unless param == 'yes'
-
     filters = []
     if input.class == String
       filters += sanitize_string(input.clone)
@@ -39,20 +34,21 @@ module ImageUrlLoader
         end
       end
     rescue
-      Project.instance.verboseln '[ERROR] ImageUrlLoader'
-      Project.instance.verboseln " => #{search_url}"
-      Project.instance.verboseln ' => Check Internet connections'
-      Project.instance.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
 
   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

@@ -3,39 +3,37 @@
 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)
-    data = { concepts: [], codes: [], world: nil, concepts_ai: [] }
-    Logger.verbose "\n[INFO] Loading input data"
-
-    # inputdirs = project.inputdirs.split(',')
+  def self.load(inputdirs, internet = true)
+    data = { concepts: [], codes: [], world: nil,
+             concepts_ai: [], codes_ai: [] }
+    #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])
-    # Create ConceptAI data and make concept questions
+    data[:world] = World.new(data[:concepts], internet)
+    # Create ConceptAI data (ConceptAI = concept + questions)
     data[:concepts].each do |concept|
-      concept_ai = ConceptAI.new(concept, data[:world])
-      concept_ai.make_questions
-      data[:concepts_ai] << concept_ai
+      data[:concepts_ai] << ConceptAI.new(concept, data[:world])
+    end
+    # Create CodeAI data (CodeAI = code + questions)
+    data[:codes].each do |code|
+      data[:codes_ai] << CodeAIFactory.get(code)
     end
-    # Make code questions
-    data[:codes].each(&:make_questions)
     data
   end
 end

data/lib/asker/loader/project_loader.rb

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 
 require 'yaml'
-require_relative '../project'
-require_relative '../logger'
+require_relative '../data/project_data'
 
 # Load params into Project class using arg input
 # * load
@@ -14,22 +13,26 @@ module ProjectLoader
   ##
   # Load project from args
   # @param args (String or Hash)
+  # rubocop:disable Metrics/MethodLength
   def self.load(args)
-    project = Project.instance
+    project = ProjectData.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
+    puts Rainbow(msg).red
     raise msg
   end
+  # rubocop:enable Metrics/MethodLength
 
   ##
   # Load project from filepath. Options:
@@ -37,12 +40,14 @@ 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
+    project = ProjectData.instance
     unless File.exist?(filepath)
-      msg = Rainbow("[WARN] ProjectLoader.load: #{arg} dosn't exists!").yellow.bright
-      project.verbose msg
-      raise msg
+      msg = Rainbow("[ERROR] #{filepath} not found!").red.bright
+      puts msg
+      exit 1
     end
 
     if File.extname(filepath) == '.haml' || File.extname(filepath) == '.xml'
@@ -51,22 +56,27 @@ module ProjectLoader
       return project
     elsif File.extname(filepath) == '.yaml'
       return load_from_yaml(filepath)
-    else
-      load_error(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 = ProjectData.instance
     project.param.merge!(YAML.load(File.open(arg)))
     project.set(:configfilename, arg)
     project.set(:projectdir, File.dirname(arg))
     project
   end
+  # rubocop:enable Security/YAMLLoad
 
-  def self.load_error(arg)
-    msg = Rainbow("[ERROR] ProjectLoader.Input unkown: #{arg}").red.bright
-    Project.instance.verbose msg
-    raise msg
+  ##
+  # Error found and exit application.
+  def self.error_loading(arg)
+    msg = Rainbow("[ERROR] Loading... #{arg}").red.bright
+    puts msg
+    exit 1
   end
 end

data/lib/asker/logger.rb

@@ -1,20 +1,47 @@
 # frozen_string_literal: true
 
-require_relative 'project'
+require 'singleton'
+require_relative 'application'
 
 # Display and log project messages
-module Logger
-  ##
-  # Display and log text
+class Logger
+  include Singleton
+  @attr_verbose = 'yes'
+
+  def set_verbose(value)
+    @attr_verbose = value
+  end
+
   def self.verbose(msg)
-    project = Project.instance
-    puts msg if project.get(:verbose)
-    project.get(:logfile)&.write("#{msg}\n")
+    print msg if @attr_verbose == 'yes'
+    @logfile&.write(msg)
   end
 
-  ##
-  # Display and log text line
   def self.verboseln(msg)
     verbose(msg + "\n")
   end
+
+  def log(msg)
+    verbose(msg)
+  end
+
+  def logln(msg)
+    verboseln(msg)
+  end
+  ##
+  # Create or reset logfile
+  def self.create(logpath, logname)
+    @logfile = File.open(logpath, 'w')
+    @logfile.write('=' * 50 + "\n")
+    @logfile.write("Created by : #{Application::NAME}")
+    @logfile.write(" (version #{Application::VERSION})\n")
+    @logfile.write("File       : #{logname}\n")
+    @logfile.write("Time       : #{Time.new}\n")
+    @logfile.write("Author     : David Vargas Ruiz\n")
+    @logfile.write('=' * 50 + "\n\n")
+  end
+
+  def self.close
+    @logfile.close
+  end
 end

data/lib/asker/skeleton.rb

@@ -2,6 +2,7 @@
 
 require 'fileutils'
 require 'rainbow'
+require_relative 'application'
 
 # Skeleton: create skeleton for asker input files
 # * create
@@ -12,27 +13,36 @@ require 'rainbow'
 module Skeleton
   ##
   # Create skeleton for asker input files
-  # @param dirpath (String) Folder path to save example files
-  def self.create(dirpath)
-    puts "\n[INFO] Creating #{Rainbow(dirpath).bright} project skeleton"
+  # @param inputpath (String)
+  # rubocop:disable Metrics/MethodLength
+  def self.create_input(inputpath)
+    puts "\n[INFO] Creating example input #{Rainbow(inputpath).bright}"
+    if File.extname(inputpath) == '.haml'
+      dirpath = File.dirname(inputpath)
+      filename = File.basename(inputpath)
+    else
+      dirpath = inputpath
+      filename = 'example-concept.haml'
+    end
     create_dir dirpath
-    copy_files_into(dirpath)
+    source = File.join(File.dirname(__FILE__), 'files/example-concept.haml')
+    copyfile(source, File.join(dirpath, filename))
   end
+  # rubocop:enable Metrics/MethodLength
 
   ##
-  # Copy lib/asker/files into Folder
-  # @param dirpath (String)
-  def self.copy_files_into(dirpath)
-    # Directory and files: example-concept.haml
-    source = File.join(File.dirname(__FILE__), 'files/example-concept.haml')
-    target = File.join(dirpath, 'example-concept.haml')
-    copyfile(source, target)
+  # Create default configuration files
+  def self.create_configuration
+    puts "\n[INFO] Creating configuration files"
+    src = File.join(File.dirname(__FILE__), 'files', Application::CONFIGFILE)
+    dst = File.join(Application::CONFIGFILE)
+    copyfile(src, dst)
   end
 
   ##
   # Create folder
   # @param dirpath (String)
-  def self.create_dir(dirpath)
+  private_class_method def self.create_dir(dirpath)
     if Dir.exist? dirpath
       puts "* Exists dir!       => #{Rainbow(dirpath).yellow}"
     else
@@ -49,7 +59,7 @@ module Skeleton
   # Copy target file to dest
   # @param target (String)
   # @param dest (String)
-  def self.copyfile(target, dest)
+  private_class_method def self.copyfile(target, dest)
     if File.exist? dest
       puts "* Exists file!      => #{Rainbow(dest).yellow}"
       return true