asker-tool 2.5.4 → 2.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2f9eaec9a8bb085529b1b131f6e7184b769796f452096c7e9813da191425a70
-  data.tar.gz: 25d938ce101b69c2171de314270207d17d1783008968fb0be7c21f228070c44f
+  metadata.gz: 832b26de49f5819f39da3e149c4360caa77e91b0cf1418b4225a35c81a9e197d
+  data.tar.gz: 8d6ba5c39fde26b38819e4c330f4ad6070811335e04839721fae4a35536c6581
 SHA512:
-  metadata.gz: f62278acb1f78b567aae35e41256d36ff76503fd3c46939f2f0f83a414b3b817ddb515d79ee9cb557352555683cc1918af02001ada4d2f44343a0be9850cc7d6
-  data.tar.gz: d27246c82c93285ff411ff73fd3d265e7503efce6c9037f2462147103c24e15db728553363f565043dc5443b78d3d3e73ac114f27d0ef66245ff72e333d85ee1
+  metadata.gz: df48a9dabc8ebb8614a67986d29c9d2110fdd8cfb6d793b7e10ab0a87120c0a78b00e44acff79a8d1b02edfa5d50823625e4e44c916e249f0c8e5f1eca42cb58
+  data.tar.gz: 184c5afbb7563d7cc96d9077b01339c2099b28479d616fc60c53afa29db68edde9de1c5aea6c42d2c56016e5fbd3ac95993b299d01413976abe2e9915695c858

data/README.md

@@ -1,8 +1,8 @@
+# ASKER
+
 [![Gem Version](https://badge.fury.io/rb/asker-tool.svg)](https://badge.fury.io/rb/asker-tool)
 ![GitHub](https://img.shields.io/github/license/dvarrui/asker)
 
-# ASKER
-
 Generate a lot of questions from an _input_ text file with on your own _definitions_. In a way, this _input file_ is a concept map.
 
 ![logo](./docs/images/logo.png)
@@ -14,21 +14,35 @@ ASKER helps trainers to create a huge amount of questions, from a definitions (_
 
 ## Installation
 
-1. Install Ruby on your system.
-2. Install Asker on your system: `sudo gem install asker-tool`
+First install Ruby and then:
+
+```
+gem install asker-tool
+```
 
-> REMEMBER: To update Asker execute `sudo gem update asker-tool`
+> REMEMBER: Update Asker with `gem update asker-tool`
 
 ## Usage
 
-1. **Create input file** with your content (_conceptual map_). Examples at [Asker inputs folder](./docs/examples).
-2. **Run `asker PATH/TO/INPUT`**. Example: Create questions from ACDC input example file:
-```bash
-asker docs/examples/bands/acdc.haml
+1. **Create input file** with your contents (_conceptual map_). [Here are some examples](./docs/examples).
+2. **Run `asker PATH/TO/INPUT`**. Let's see an example creating questions from ACDC input example file:
+
 ```
-3. Output files created into the `output` folder.
+❯ asker docs/examples/bands/acdc.haml
+
++--------------------+-----------+---------+---------+---+---+----+---+---+----+
+| Concept            | Questions | Entries | xFactor | d | b | f  | i | s | t  |
++--------------------+-----------+---------+---------+---+---+----+---+---+----+
+| AC/DC              | 45        | 18      | 2.5     | 7 | 0 | 15 | 0 | 3 | 20 |
+| Excluded questions | 0         | -       | -       | 0 | 0 | 0  | 0 | 0 | 0  |
++--------------------+-----------+---------+---------+---+---+----+---+---+----+
+| 1 concept/s        | 45        | 18      | 2.5     | 7 | 0 | 15 | 0 | 3 | 20 |
++--------------------+-----------+---------+---------+---+---+----+---+---+----+
+```
+
+3. **Output files** are saved into the `output` folder.
 
-> More input examples at [dvarrui/asker-input](https://github.com/dvarrui/asker-inputs) repository.
+> More input examples at [asker-input  repository](https://github.com/dvarrui/asker-inputs).
 
 ## Documentation
 

data/lib/asker/ai/code/javascript_code_ai.rb

@@ -5,14 +5,14 @@ require_relative 'base_code_ai'
 
 class JavascriptCodeAI < BaseCodeAI
   def initialize(code)
-    @lang = LangFactory.instance.get('javascript')
+    @lang = LangFactory.instance.get("javascript")
     super code
   end
 
   def make_comment_error
     questions = []
-    error_lines = []
-    @lines.each_with_index do |line,index|
+    # error_lines = []
+    @lines.each_with_index do |line, index|
       if line.strip.start_with?('//')
         lines = clone_array @lines
         lines[index].sub!('//','').strip!
@@ -117,7 +117,7 @@ class JavascriptCodeAI < BaseCodeAI
 
   def make_variable_error
     questions = []
-    error_lines = []
+    # error_lines = []
     @lines.each_with_index do |line, index|
       # Search Variable assignment
       m = /var\s*(\w*);\s*\w*/.match(line)

data/lib/asker/ai/code/problem_code_ai.rb

@@ -17,7 +17,7 @@ class ProblemCodeAI < BaseCodeAI
   # Make errors about comments
   def make_comment_error
     questions = []
-    error_lines = []
+    # error_lines = []
     @lines.each_with_index do |line,index|
       if line.strip.start_with?('#')
         lines = clone_array @lines
@@ -129,7 +129,7 @@ class ProblemCodeAI < BaseCodeAI
   # Make questions with variable errors
   def make_variable_error
     questions = []
-    error_lines = []
+    # error_lines = []
     @lines.each_with_index do |line, index|
       # Search Variable assignment
       m = /\s*(\w*)\s*\=\w*/.match(line)

data/lib/asker/ai/code/python_code_ai.rb

@@ -11,8 +11,8 @@ class PythonCodeAI < BaseCodeAI
 
   def make_comment_error
     questions = []
-    error_lines = []
-    @lines.each_with_index do |line,index|
+    # error_lines = []
+    @lines.each_with_index do |line, index|
       if line.strip.start_with?('#')
         lines = clone_array @lines
         lines[index].sub!('#','').strip!
@@ -117,7 +117,7 @@ class PythonCodeAI < BaseCodeAI
 
   def make_variable_error
     questions = []
-    error_lines = []
+    # error_lines = []
     @lines.each_with_index do |line, index|
       # Search Variable assignment
       m = /\s*(\w*)\s*\=\w*/.match(line)

data/lib/asker/ai/code/ruby_code_ai.rb

@@ -1,15 +1,12 @@
+require_relative "../../lang/lang_factory"
+require_relative "../../ai/question"
+require_relative "base_code_ai"
 
-require_relative '../../lang/lang_factory'
-require_relative '../../ai/question'
-require_relative 'base_code_ai'
-
-##
-# Class for RubyCodeAI objects
 class RubyCodeAI < BaseCodeAI
   def initialize(code)
     @reduce = 1
     @reduce = 4 if code.lines.size > 25
-    @lang = LangFactory.instance.get('ruby')
+    @lang = LangFactory.instance.get("ruby")
     super code
   end
 
@@ -17,8 +14,8 @@ class RubyCodeAI < BaseCodeAI
   # Make errors about comments
   def make_comment_error
     questions = []
-    error_lines = []
-    @lines.each_with_index do |line,index|
+    # error_lines = []
+    @lines.each_with_index do |line, index|
       if line.strip.start_with?('#')
         lines = clone_array @lines
         lines[index].sub!('#','').strip!
@@ -129,7 +126,7 @@ class RubyCodeAI < BaseCodeAI
   # Make questions with variable errors
   def make_variable_error
     questions = []
-    error_lines = []
+    # error_lines = []
     @lines.each_with_index do |line, index|
       # Search Variable assignment
       m = /\s*(\w*)\s*\=\w*/.match(line)

data/lib/asker/ai/code/sql_code_ai.rb

@@ -10,7 +10,6 @@ class SQLCodeAI < BaseCodeAI
   end
 
   def make_comment_error
-    error_lines = []
     questions = []
     @lines.each_with_index do |line,index|
       if line.include?('//')

data/lib/asker/application.rb

@@ -1,9 +1,7 @@
-# frozen_string_literal: true
-
-require 'singleton'
-require 'inifile'
-require 'rainbow'
-require_relative 'version'
+require "singleton"
+require "inifile"
+require "rainbow"
+require_relative "version"
 
 # Global parameters
 class Application

data/lib/asker/data/world.rb

@@ -3,6 +3,7 @@
 require_relative '../loader/image_url_loader'
 
 class World
+  # TODO: change how World class works ?
   attr_reader :concepts, :filenames, :contexts, :image_urls
 
   def initialize(concepts, internet = true)
@@ -27,7 +28,6 @@ class World
 
   private
 
-  # rubocop:disable Metrics/MethodLength
   def get_lists_from(input)
     concepts = {}
     filenames = []
@@ -43,12 +43,7 @@ class World
     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(internet)
     return {} unless internet
 
@@ -61,11 +56,7 @@ class World
     searchs.each do |search|
       threads << Thread.new { urls[search] = ImageUrlLoader.load(search) }
     end
-    threads.each(&:join) # wait for all threads to finish
+    threads.each(&:join)
     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

@@ -1,15 +1,10 @@
-# frozen_string_literal: true
+require "terminal-table"
+require_relative "../logger"
 
-require 'terminal-table'
-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?
 
@@ -47,6 +42,4 @@ 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.rb

@@ -74,7 +74,7 @@ class ConceptAIDisplayer
 
     # Create table TAIL
     screen_table.add_separator
-    screen_table.add_row [Rainbow("TOTAL = #{total[:c]}").bright,
+    screen_table.add_row [Rainbow("#{total[:c]} concept/s").bright,
                           Rainbow(total[:q].to_s).bright,
                           Rainbow(total[:e].to_s).bright,
                           Rainbow((total[:q].to_f / total[:e]).round(2)).bright,

data/lib/asker/displayer/concept_displayer.rb

@@ -1,10 +1,7 @@
-# frozen_string_literal: true
-
 require_relative '../application'
 require_relative '../formatter/concept_string_formatter'
-require_relative '../logger'
+require_relative "../logger"
 
-# Show Concept Data on screen
 module ConceptDisplayer
   ##
   # Show concepts on screen

data/lib/asker/exporter/code_gift_exporter.rb

@@ -1,7 +1,5 @@
+require_relative "../formatter/question_gift_formatter"
 
-require_relative '../formatter/question_gift_formatter'
-
-# Use to export questions from Code to gift format
 module CodeGiftExporter
   ##
   # Export an Array of codes to gift format file

data/lib/asker/exporter/concept_doc_exporter.rb

@@ -14,7 +14,6 @@ module ConceptDocExporter
     file.write("Created by : #{Asker::NAME} (version #{Asker::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|

data/lib/asker/exporter/data_gift_exporter.rb

@@ -18,7 +18,6 @@ module DataGiftExporter
     file.write(" (version #{Asker::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?

data/lib/asker/exporter/data_moodle_exporter.rb

@@ -15,7 +15,6 @@ module DataMoodleExporter
     file.write(" (version #{Asker::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")
 
     data[:concepts_ai].each do |concept_ai|

data/lib/asker/lang/text_actions.rb

@@ -6,13 +6,13 @@ module TextActions
   ##
   # Return text indicated by lang code...
   def text_for(option, *input)
-    text1 = input[0]
-    text2 = input[1]
-    text3 = input[2]
-    text4 = input[3]
-    text5 = input[4]
-    text6 = input[5]
-    text7 = input[6]
+    @_text1 = input[0] # FIXME: done to avoid linter complaints.
+    @_text2 = input[1]
+    @_text3 = input[2]
+    @_text4 = input[3]
+    @_text5 = input[4]
+    @_text6 = input[5]
+    @_text7 = input[6]
 
     # Check if exists option before use it
     raise "[ERROR] Unkown template #{option}" if @templates[option].nil?
@@ -21,6 +21,34 @@ module TextActions
     renderer.result(binding)
   end
 
+  def text1
+    @_text1
+  end
+
+  def text2
+    @_text2
+  end
+
+  def text3
+    @_text3
+  end
+
+  def text4
+    @_text4
+  end
+
+  def text5
+    @_text5
+  end
+
+  def text6
+    @_text6
+  end
+
+  def text7
+    @_text7
+  end
+
   ##
   # Convert input text into output text struct
   # @param input (String) Input text
@@ -38,14 +66,14 @@ module TextActions
 	      # if <word> is a conector and <pFilter>==true Then Choose this <word>
 	      # if <word> isn't a conector and <pFilter>==true and <word>.length>1 Then Choose this <word>
         if (flag and filter) || (!flag and !filter and word.length > 1)
-		      output_words << {:word => word, :row => rowindex, :col => colindex }
-		      row << (output_words.size-1)
-	      else
-		      row << word
+          output_words << {:word => word, :row => rowindex, :col => colindex }
+          row << (output_words.size-1)
+        else
+          row << word
         end
-	    end
-	    row << '.'
-	    output_lines << row
+      end
+      row << '.'
+      output_lines << row
     end
 
     indexes = []

data/lib/asker/loader/haml_loader.rb

@@ -1,19 +1,17 @@
-# frozen_string_literal: true
-
 require 'haml'
 
-# HAML file loader
 module HamlLoader
   def self.load(filename)
     template = File.read(filename)
     begin
-      haml_engine = Haml::Engine.new(template)
-      return haml_engine.render
+      # INFO <haml 5.1> 20221223
+      #   haml_engine = Haml::Engine.new(template)
+      #   return haml_engine.render
+      return Haml::Template.new { template }.render
     rescue StandardError => e
       puts "[ERROR] HamlLoader: Can't load <#{filename}> file!"
       puts "  => #{e}"
       exit 0
     end
   end
-
 end

data/lib/asker/logger.rb

@@ -1,19 +1,16 @@
-# frozen_string_literal: true
+require "singleton"
+require_relative "version"
 
-require 'singleton'
-require_relative 'version'
-
-# Display and log project messages
 class Logger
   include Singleton
-  @attr_verbose = 'yes'
+  @attr_verbose = "yes"
 
   def set_verbose(value)
     @attr_verbose = value
   end
 
   def self.verbose(msg)
-    print msg if @attr_verbose == 'yes'
+    print msg if @attr_verbose == "yes"
     @logfile&.write(msg)
   end
 
@@ -28,16 +25,14 @@ class Logger
   def logln(msg)
     verboseln(msg)
   end
-  ##
-  # Create or reset logfile
-  def self.create(logpath, logname)
+
+  def self.create(logpath)
     @logfile = File.open(logpath, 'w')
     @logfile.write('=' * 50 + "\n")
     @logfile.write("Created by : #{Asker::NAME}")
     @logfile.write(" (version #{Asker::VERSION})\n")
-    @logfile.write("File       : #{logname}\n")
+    @logfile.write("File       : #{File.basename(logpath)}\n")
     @logfile.write("Time       : #{Time.new}\n")
-    @logfile.write("Author     : David Vargas Ruiz\n")
     @logfile.write('=' * 50 + "\n\n")
   end
 

data/lib/asker/version.rb

@@ -1,6 +1,6 @@
 
 class Asker
-  VERSION = "2.5.4"
+  VERSION = "2.5.5"
   NAME = "asker"
   GEM = "asker-tool"
   CONFIGFILE = "asker.ini"

data/lib/asker.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require 'rainbow'
 require 'colorize'
 
@@ -13,8 +11,8 @@ require_relative 'asker/logger'
 
 require_relative 'asker/loader/project_loader'
 require_relative 'asker/loader/input_loader'
-class Asker
 
+class Asker
   def self.init
     Skeleton.create_configuration
   end
@@ -54,9 +52,7 @@ class Asker
   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.create(project_data.get(:logpath))
     Logger.instance.set_verbose(Application.instance.config['verbose'])
     Logger.verboseln '[INFO] Project open'
     Logger.verboseln '   ├── inputdirs    = ' + Rainbow(project_data.get(:inputdirs)).bright
@@ -64,38 +60,6 @@ class Asker
   end
 
   private_class_method def self.create_output(project, data)
-    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)
     Logger.close

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asker-tool
 version: !ruby/object:Gem::Version
-  version: 2.5.4
+  version: 2.5.5
 platform: ruby
 authors:
 - David Vargas Ruiz
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-15 00:00:00.000000000 Z
+date: 2022-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: haml
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: inifile
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -241,7 +241,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.4
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="