asker-tool 2.1.7 → 2.2.3

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

@@ -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.verbose 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,20 +34,21 @@ 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
 
   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,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.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[: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])

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,11 +40,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
+    project = ProjectData.instance
     unless File.exist?(filepath)
       msg = Rainbow("[ERROR] #{filepath} not found!").red.bright
-      Logger.verbose msg
+      puts msg
       exit 1
     end
 
@@ -51,24 +56,27 @@ 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 = 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
 
   ##
   # Error found and exit application.
   def self.error_loading(arg)
     msg = Rainbow("[ERROR] Loading... #{arg}").red.bright
-    Logger.verbose msg
+    puts msg
     exit 1
   end
 end

data/lib/asker/logger.rb

@@ -1,20 +1,47 @@
 # frozen_string_literal: true
 
-require_relative 'application'
-require_relative 'project'
+require 'singleton'
+require_relative 'version'
 
 # 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)
-    puts msg if Application.instance.config['global']['verbose'] == 'yes'
-    Project.instance.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 : #{Version::NAME}")
+    @logfile.write(" (version #{Version::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 'version'
 
 # Skeleton: create skeleton for asker input files
 # * create
@@ -33,8 +34,8 @@ module Skeleton
   # Create default configuration files
   def self.create_configuration
     puts "\n[INFO] Creating configuration files"
-    src = File.join(File.dirname(__FILE__), 'files', 'config.ini')
-    dst = File.join('config.ini')
+    src = File.join(File.dirname(__FILE__), 'files', Version::CONFIGFILE)
+    dst = File.join(Version::CONFIGFILE)
     copyfile(src, dst)
   end
 

data/lib/asker/version.rb

@@ -0,0 +1,9 @@
+
+# Global parameters
+module Version
+  VERSION = '2.2.3'
+  NAME = 'asker'
+  GEM = 'asker-tool'
+  CONFIGFILE = 'asker.ini'
+  HOMEPAGE = "https://github.com/teuton-software/#{NAME}/tree/v2.2"
+end

data/lib/asker.rb

@@ -2,71 +2,100 @@
 
 require 'rainbow'
 
+require_relative 'asker/skeleton'
+require_relative 'asker/check_input'
+
 require_relative 'asker/displayer/concept_displayer'
 require_relative 'asker/displayer/stats_displayer'
 require_relative 'asker/exporter/output_file_exporter'
-require_relative 'asker/loader/project_loader'
-require_relative 'asker/loader/input_loader'
-require_relative 'asker/checker'
 require_relative 'asker/logger'
-require_relative 'asker/skeleton'
 
-##
-# Asker main class
+require_relative 'asker/loader/project_loader'
+require_relative 'asker/loader/input_loader'
 class Asker
-  ##
-  # Create asker input demo files
-  # @param dirpath (String)
-  def self.create_input(dirpath)
-    Skeleton.create_input(dirpath)
+  def self.init
+    Skeleton.create_configuration
   end
 
-  ##
-  # Create asker configuration files
-  def self.create_configuration
-    Skeleton.create_configuration
+  def self.new_input(dirpath)
+    Skeleton.create_input(dirpath)
   end
 
-  ##
-  # Checking input file syntax
-  # @param filepath (String)
   def self.check(filepath)
-    Checker.check(filepath)
+    CheckInput.new.file(filepath).check
   end
 
-  ##
-  # Start working
-  # @param filepath (String) HAML or XML filepath
   def self.start(filepath)
-    project, data = load_input(filepath)
+    project_data, data = load_input(filepath)
     ConceptDisplayer.show(data[:concepts])
-    create_output(project, data)
+    create_output(project_data, data)
   end
 
-  ##
-  # Load input data
-  # @param args (Hash)
   private_class_method def self.load_input(args)
-    project = ProjectLoader.load(args)
-    project.open # Open output files
-    data = InputLoader.load(project.get(:inputdirs).split(','))
-    [project, data]
+    init_project_data
+    project_data = ProjectLoader.load(args)
+    init_logger(project_data)
+
+    inputdirs = project_data.get(:inputdirs).split(',')
+    internet = Application.instance.config['global']['internet'] == 'yes'
+    data = InputLoader.load(inputdirs, internet)
+    [project_data, data]
+  end
+
+  private_class_method def self.init_project_data()
+    project_data = ProjectData.instance
+    outputdir = Application.instance.config['output']['folder']
+    project_data.set(:outputdir, outputdir)
+
+    formula_weights = Application.instance.config['ai']['formula_weights']
+    project_data.set(:weights, formula_weights)
+  end
+
+  private_class_method def self.init_logger(project_data)
+    # Create log file where to save log messages
+    Logger.create(project_data.get(:logpath),
+                  project_data.get(:logname))
+    Logger.instance.set_verbose(Application.instance.config['verbose'])
+    Logger.verboseln '[INFO] Project open'
+    Logger.verboseln '   ├── inputdirs    = ' + Rainbow(project_data.get(:inputdirs)).bright
+    Logger.verboseln '   └── process_file = ' + Rainbow(project_data.get(:process_file)).bright
   end
 
-  ##
-  # Create output files: Gift, YAML, TXT Doc
-  # rubocop:disable Metrics/AbcSize
   private_class_method def self.create_output(project, data)
-    Logger.verbose "\n[INFO] Creating output files"
-    Logger.verbose '   ├── Gift questions file => ' +
-                   Rainbow(project.get(:outputpath)).bright
-    Logger.verbose '   ├── YAML questions file => ' +
-                   Rainbow(project.get(:yamlpath)).bright
-    Logger.verbose '   └── Lesson file         => ' +
-                   Rainbow(project.get(:lessonpath)).bright
+    Logger.verboseln "\n[INFO] Creating output files"
+    m = '   ├── Gift questions file => '
+    m += if Application.instance.config['output']['gift'] == 'yes'
+           Rainbow(project.get(:outputpath)).bright
+         else
+           "#{project.get(:outputpath)} (No)"
+         end
+    Logger.verboseln m
+
+    m = '   ├── Lesson file         => '
+    m += if Application.instance.config['output']['doc'] == 'yes'
+           Rainbow(project.get(:lessonpath)).bright
+         else
+           "#{project.get(:lessonpath)} (No)"
+         end
+    Logger.verboseln m
+
+    m = '   ├── YAML questions file => '
+    m += if Application.instance.config['output']['yaml'] == 'yes'
+           Rainbow(project.get(:yamlpath)).bright
+         else
+           "#{project.get(:yamlpath)} (No)"
+         end
+    Logger.verboseln m
+
+    m = '   └── Moodle XML file     => '
+    m += if Application.instance.config['output']['moodle'] == 'yes'
+           Rainbow(project.get(:moodlepath)).bright
+         else
+           "#{project.get(:moodlepath)} (No)"
+         end
+    Logger.verboseln m
     OutputFileExporter.export(data, project)
     StatsDisplayer.show(data)
-    project.close # Logger use Project.get(:logfile) until the end
+    Logger.close
   end
-  # rubocop:enable Metrics/AbcSize
 end