asker-tool 2.1.5 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39bc74c80c6c83d62fb43bee32e10d3c3503880132cbaaa81f5e14115c9286d7
-  data.tar.gz: b60194338ffb8429c665d726b62f784c7a0787efb79db4a079b4c13bcbcd6fe8
+  metadata.gz: cb2119553ee0f5bce53f1aebe3468aabb5488ce02c54004c09df4d1256867cf5
+  data.tar.gz: 29bc8b727e10beb791eac5a113751f6d26ec9036cf3158aec583a93505fb3ba5
 SHA512:
-  metadata.gz: 11b8da624fedb21e507ec7f015e8e921d8d2a85efd613e1a85646114e4b505a73f303b96b2a76ce77653cf511143f495dffcb6477959eb43ad139446547e55ae
-  data.tar.gz: f6c64ac247cada2b4099385e77b2e86b953f60d4250a01f2907ff811b92d10d50628ffeb0c1f8921bef5900be3f46bec18f664276e03441e8af7ae7183965f28
+  metadata.gz: b3f277896c860c2987c25b4088922328f922fa52c8e2bb32ba92b6d90c6b86e05f2c0c9a056f3c69139148266f6bd4443192ca4d6892ee6e6884fb1e6cb3bad4
+  data.tar.gz: f9bb53fa2c7d5ee05566eb19657e4997d84dea2f521e1445a64fb658b06a7b6b1326e8b3d010fa21b5758c8538fc33ed1f675752493db4a366be9ac881944057

data/README.md

@@ -1,43 +1,40 @@
-# ASKER (version 2.1)
+[![Gem Version](https://badge.fury.io/rb/asker-tool.svg)](https://badge.fury.io/rb/asker-tool)
 
-Generate a lot of questions from an _input file_ base on your own _definitions_.
+# ASKER (devel 2.3)
 
----
-# Description
+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)
 
 ASKER helps trainers to create a huge amount of questions, from a definitions (_conceptual entities_) input file.
 
-* Free Software [LICENSE](https://github.com/dvarrui/asker/blob/devel/LICENSE).
+* Free Software [LICENSE](https://github.com/dvarrui/asker/blob/devel/LICENSE.txt).
 * Multiplatform.
 * Ruby program.
 
----
-# Installation
+## Installation
 
 1. Install Ruby on your system.
 2. `gem install asker-tool`
 
----
-# Usage
+## Usage
 
 Steps:
 
 1. Create an input file with your definitions (_conceptual entities_).
 1. Run _asker_ and get the results into `output` directory.
 
-Run `asker` with our example input file as argument (`jedi.haml`):
+Example: Running `asker` with our example input file as argument (`acdc.haml`):
 
 ```
-asker docs/examples/starwars/jedi.haml
+asker docs/examples/bands/acdc.haml
 ```
 
 * Output files created into the `output` folder.
-* This example use an example input definition file `docs/examples/starwars/jedi.haml`, with concepts about _"Jedi's"_. ;-)
-* More [example input files](https://github.com/dvarrui/asker/tree/devel/docs/examples).
+* More [example input files](./docs/examples).
 * More asker input files at `github/dvarrui/asker-inputs` repository.
 
----
-# Documentation
+## Documentation
 
 * [Installation](https://github.com/dvarrui/asker/blob/devel/docs/install/README.md)
 * [Inputs](https://github.com/dvarrui/asker/blob/devel/docs/inputs/README.md)
@@ -46,8 +43,7 @@ asker docs/examples/starwars/jedi.haml
 * [Base idea](https://github.com/dvarrui/asker/blob/devel/docs/idea.md)
 * [History](https://github.com/dvarrui/asker/blob/devel/docs/history.md)
 
----
-# Contact
+## Contact
 
 * **Email**: `teuton.software@protonmail.com`
 * **Twitter**: `@SoftwareTeuton`

data/bin/asker

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
 require 'asker/cli'
+
 # Start Asker command line interface
 CLI.start(ARGV)

data/lib/asker/ai/ai.rb

@@ -6,14 +6,14 @@ require_relative 'ai_calculate'
 # Description: Method to be included into every ConceptAI instance.
 # * make_questions: use AI to fill @questions Array
 module AI
-  include AI_calculate
+  include AICalculate
 
   def make_questions
-    return unless process?
+    return unless concept.process?
 
     make_questions_stages_di
     # Process every table of this concept
-    tables.each do |tab|
+    concept.tables.each do |tab|
       list1, list2 = get_list1_and_list2_from(tab)
       make_questions_stages_bsf(tab, list1, list2)
       make_questions_stages_t(tab, list1, list2)
@@ -23,11 +23,13 @@ module AI
     exclude_questions
   end
 
+  # Make questions for states D and I
   def make_questions_stages_di
     @questions[:d] = StageD.new(self).run  # Process every def{type=text}
     @questions[:i] = StageI.new(self).run  # Process every def{type=image_url}
   end
 
+  # Make questions for stages B, S and F
   def make_questions_stages_bsf(tab, list1, list2)
     # Stage B: process table to make match questions
     @questions[:b] += StageB.new(self).run(tab, list1, list2)
@@ -37,6 +39,7 @@ module AI
     @questions[:f] += StageF.new(self).run(tab, list1, list2)
   end
 
+  # Make questions for stage T
   def make_questions_stages_t(tab, list1, list2)
     # Stage T: process_tableXfields
     list3 = list1 + list2
@@ -46,6 +49,8 @@ module AI
     end
   end
 
+  # rubocop:disable Metrics/AbcSize
+  # rubocop:disable Metrics/MethodLength
   def exclude_questions
     param = Application.instance.config['questions']['exclude']
     return if param.nil?
@@ -61,6 +66,8 @@ module AI
     @questions = input
     @excluded_questions = output
   end
+  # rubocop:enable Metrics/AbcSize
+  # rubocop:enable Metrics/MethodLength
 
   def string_has_this_tags?(input, tags)
     flag = false

data/lib/asker/ai/ai_calculate.rb

@@ -1,29 +1,39 @@
 # frozen_string_literal: true
 
 # Methods that calculate something
-module AI_calculate
-  def get_list1_and_list2_from(ltable)
+module AICalculate
+  ##
+  # Calculate and return list1 and list2
+  # * return list1 (Array) List with all the rows from the table
+  # * return list2 (Array) List with similar rows (same table name) from the neighbours tables
+  # @param p_table (Table)
+  # rubocop:disable Metrics/MethodLength
+  # rubocop:disable Metrics/AbcSize
+  def get_list1_and_list2_from(p_table)
     # create <list1> with all the rows from the table
     list1 = []
     count = 1
-    ltable.rows.each do |i|
+    p_table.rows.each do |i|
       list1 << { id: count, weight: 0, data: i }
       count += 1
     end
 
     # create a <list2> with similar rows (same table name) from the neighbours tables
     list2 = []
-    neighbors.each do |n|
+    concept.neighbors.each do |n|
       n[:concept].tables.each do |t2|
-        next if t2.name != ltable.name
+        next if t2.name != p_table.name
+
         t2.rows.each do |i|
           list2 << { id: count, weight: 0, data: i }
           count += 1
         end
       end
     end
-    return list1, list2
+    [list1, list2]
   end
+  # rubocop:enable Metrics/MethodLength
+  # rubocop:enable Metrics/AbcSize
 
   def calculate_nearness_between_texts(text1, text2)
     return 0.0 if text2.nil? || text2.empty?
@@ -34,6 +44,8 @@ module AI_calculate
     (count * 100 / words.count)
   end
 
+  # rubocop:disable Metrics/MethodLength
+  # rubocop:disable Metrics/AbcSize
   def reorder_list_with_row(list, row)
     # evaluate every row of the list2
     list.each do |r|
@@ -52,4 +64,6 @@ module AI_calculate
     list.sort! { |a, b| a[:weight] <=> b[:weight] }
     list.reverse!
   end
+  # rubocop:enable Metrics/MethodLength
+  # rubocop:enable Metrics/AbcSize
 end

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

@@ -0,0 +1,104 @@
+# frozen_string_literal: false
+
+require_relative '../../lang/lang_factory'
+require_relative '../../ai/question'
+
+##
+# BaseCodeAI class
+class BaseCodeAI
+  attr_reader :questions
+
+  ##
+  # Create CodeAI object from Code data
+  # @param code (Code)
+  def initialize(code)
+    @code = code
+    @lines = code.lines
+    @num = 0
+    @questions = []
+    make_questions
+  end
+
+  ##
+  # Return the name of code
+  # @return String
+  def name
+    File.basename(@code.filename)
+  end
+
+  def process?
+    @code.process?
+  end
+
+  def type
+    @code.type
+  end
+
+  def filename
+    @code.filename
+  end
+
+  def lines
+    @code.lines
+  end
+
+  ##
+  # Counter
+  # @return count
+  def num
+    @num += 1
+  end
+
+  ##
+  # Clone array
+  # @param array (Array)
+  # @return Array
+  def clone_array(array)
+    out = []
+    array.each { |item| out << item.dup }
+    out
+  end
+
+  ##
+  # Convert an array of lines into one String
+  # @param lines (Array)
+  # @return String
+  # rubocop:disable Style/FormatString
+  def lines_to_s(lines)
+    out = ''
+    lines.each_with_index do |line, index|
+      out << "%2d: #{line}\n" % (index + 1)
+    end
+    out
+  end
+
+  ##
+  # Convert an array of lines into one HTML String
+  # @param lines (Array)
+  # @return String
+  def lines_to_html(lines)
+    out = ''
+    lines.each_with_index do |line, index|
+      out << "%2d: #{line}</br>" % (index + 1)
+    end
+    out
+  end
+  # rubocop:enable Style/FormatString
+
+  ##
+  # Make questions
+  def make_questions
+    list = find_make_methods
+    list.each { |m| @questions += send m }
+    @questions
+  end
+
+  private
+
+  def find_make_methods
+    list = public_methods.sort
+    list.select! { |name| name.to_s.start_with? 'make_' }
+    list.delete(:make_questions)
+    list
+  end
+end

data/lib/asker/{code/ai → ai/code}/code_ai_factory.rb

@@ -1,15 +1,25 @@
 
+require 'rainbow'
 require_relative 'javascript_code_ai'
+require_relative 'problem_code_ai'
 require_relative 'python_code_ai'
 require_relative 'ruby_code_ai'
 require_relative 'sql_code_ai'
 
+##
+# CodeAI factory
 module CodeAIFactory
+  ##
+  # Return CodeAI associated to Code.type
+  # @param code (Code)
+  # @return CodeAI
   def self.get(code)
     type = code.type
     case type
     when :javascript
       return JavascriptCodeAI.new(code)
+    when :problem
+      return ProblemCodeAI.new(code)
     when :python
       return PythonCodeAI.new(code)
     when :ruby
@@ -19,7 +29,7 @@ module CodeAIFactory
     when :vagrantfile
       return RubyCodeAI.new(code)
     else
-      puts "[ERROR] <#{type}> is not valid type"
+      puts Rainbow("[ERROR] <#{type}> is not valid type").red.bright
     end
     nil
   end

data/lib/asker/{code/ai → ai/code}/javascript_code_ai.rb

@@ -4,12 +4,9 @@ require_relative '../../ai/question'
 require_relative 'base_code_ai'
 
 class JavascriptCodeAI < BaseCodeAI
-  def initialize(data_object)
-    @data_object = data_object
-    @lines = data_object.lines
+  def initialize(code)
     @lang = LangFactory.instance.get('javascript')
-    @num = 0
-    @questions = []
+    super code
   end
 
   def make_comment_error

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

@@ -0,0 +1,176 @@
+
+require_relative '../../lang/lang_factory'
+require_relative '../../ai/question'
+require_relative 'base_code_ai'
+
+##
+# Class for RubyCodeAI objects
+class ProblemCodeAI < BaseCodeAI
+  def initialize(code)
+    @reduce = 1
+    @reduce = 4 if code.lines.size > 25
+    @lang = LangFactory.instance.get('es')
+    super code
+  end
+
+  ##
+  # Make errors about comments
+  def make_comment_error
+    questions = []
+    error_lines = []
+    @lines.each_with_index do |line,index|
+      if line.strip.start_with?('#')
+        lines = clone_array @lines
+        lines[index].sub!('#','').strip!
+
+        q = Question.new(:short)
+        q.name = "#{name}-#{num}-uncomment"
+        q.text = @lang.text_for(:code1,lines_to_html(lines))
+        q.shorts << (index+1)
+        q.feedback = 'Comment symbol removed'
+        questions << q
+      elsif line.strip.size>0
+        lines = clone_array @lines
+        lines[index]='# ' + lines[index]
+
+        q = Question.new(:short)
+        q.name = "#{name}-#{num}-comment"
+        q.text = @lang.text_for(:code1,lines_to_html(lines))
+        q.shorts << (index+1)
+        q.feedback = 'Comment symbol added'
+        questions << q
+      end
+    end
+    questions.shuffle[0,@lines.size/@reduce]
+  end
+
+  ##
+  # Make questions without errors
+  def make_no_error_changes
+    questions = []
+    empty_lines = []
+    used_lines = []
+    @lines.each_with_index do |line,index|
+      if line.strip.size.zero?
+        empty_lines << index
+      else
+        used_lines << index
+      end
+    end
+
+    used_lines.each do |index|
+      lines = clone_array(@lines)
+      lines.insert(index, ' ' * (rand(4).to_i + 1))
+      if @lines.size < 4 || rand(2) == 0
+        q = Question.new(:short)
+        q.name = "#{name}-#{num}-codeok"
+        q.text = @lang.text_for(:code1,lines_to_html(lines))
+        q.shorts << '0'
+        q.feedback = 'Code is OK'
+        questions << q
+      else
+        q = Question.new(:choice)
+        q.name = "#{name}-#{num}-codeok"
+        q.text = @lang.text_for(:code2,lines_to_html(lines))
+        others = (1..@lines.size).to_a.shuffle!
+        q.good = '0'
+        q.bads << others[0].to_s
+        q.bads << others[1].to_s
+        q.bads << others[2].to_s
+        q.feedback = 'Code is OK'
+      end
+    end
+
+    questions.shuffle[0,@lines.size/@reduce]
+  end
+
+  ##
+  # Make questions with syntax errors
+  def make_syntax_error
+    questions = []
+
+    @lang.mistakes.each_pair do |key,values|
+      error_lines = []
+      @lines.each_with_index do |line,index|
+        error_lines << index if line.include?(key.to_s)
+      end
+
+      v = values.split(',')
+      v.each do |value|
+        error_lines.each do |index|
+          lines = clone_array(@lines)
+          lines[index].sub!(key.to_s, value)
+          if @lines.size < 4 || rand(2) == 0
+            q = Question.new(:short)
+            q.name = "#{name}-#{num}-syntaxerror"
+            q.text = @lang.text_for(:code1,lines_to_html(lines))
+            q.shorts << (index+1)
+            q.feedback = "Syntax error: '#{value}' must be '#{key}'"
+          else
+            q = Question.new(:choice)
+            q.name = "#{name}-#{num}-syntaxerror"
+            q.text = @lang.text_for(:code2,lines_to_html(lines))
+            others = (1..@lines.size).to_a.shuffle!
+            others.delete(index+1)
+            q.good = (index + 1).to_s
+            q.bads << others[0].to_s
+            q.bads << others[1].to_s
+            q.bads << others[2].to_s
+            q.feedback = "Syntax error: '#{value}' must be '#{key}'"
+          end
+          questions << q
+        end
+      end
+    end
+    questions.shuffle[0,@lines.size/@reduce]
+  end
+
+  ##
+  # Make questions with variable errors
+  def make_variable_error
+    questions = []
+    error_lines = []
+    @lines.each_with_index do |line, index|
+      # Search Variable assignment
+      m = /\s*(\w*)\s*\=\w*/.match(line)
+      i = []
+      unless m.nil?
+        varname = (m.values_at 1)[0]
+        # Search used Variable
+        @lines.each_with_index do |line2, index2|
+          next if index >= index2
+          i << index2 if line2.include?(varname)
+        end
+      end
+      next if i.size == 0
+      i.shuffle!
+      i.each do |k|
+        lines = clone_array @lines
+        temp = lines[index]
+        lines[index] = lines[k]
+        lines[k] = temp
+
+        if rand(2) == 0
+          q = Question.new(:short)
+          q.name = "#{name}-#{num}-variable"
+          q.text = @lang.text_for(:code1, lines_to_html(lines))
+          q.shorts << (index + 1)
+          q.feedback = "Variable error! Swapped lines #{(index+1)} with #{(k+1)}"
+        else
+          q = Question.new(:choice)
+          q.name = "#{name}-#{num}-variable"
+          q.text = @lang.text_for(:code2, lines_to_html(lines))
+          others = (1..@lines.size).to_a.shuffle!
+          others.delete(index+1)
+          q.good = (index + 1).to_s
+          q.bads << others[0].to_s
+          q.bads << others[1].to_s
+          q.bads << others[2].to_s
+          q.feedback = "Variable error! Swapped lines #{(index+1)} with #{(k+1)}"
+        end
+        questions << q
+      end
+    end
+    questions.shuffle[0,@lines.size/@reduce]
+  end
+end

data/lib/asker/{code/ai → ai/code}/python_code_ai.rb

@@ -4,12 +4,9 @@ require_relative '../../ai/question'
 require_relative 'base_code_ai'
 
 class PythonCodeAI < BaseCodeAI
-  def initialize(data_object)
-    @data_object = data_object
-    @lines = data_object.lines
+  def initialize(code)
     @lang = LangFactory.instance.get('python')
-    @num = 0
-    @questions = []
+    super code
   end
 
   def make_comment_error

data/lib/asker/{code/ai → ai/code}/ruby_code_ai.rb

@@ -3,17 +3,18 @@ require_relative '../../lang/lang_factory'
 require_relative '../../ai/question'
 require_relative 'base_code_ai'
 
+##
+# Class for RubyCodeAI objects
 class RubyCodeAI < BaseCodeAI
-  def initialize(data_object)
-    @data_object = data_object
-    @lines = data_object.lines
-    @lang = LangFactory.instance.get('ruby')
-    @num = 0
-    @questions = []
+  def initialize(code)
     @reduce = 1
-    @reduce = 4 if @lines.size > 25
+    @reduce = 4 if code.lines.size > 25
+    @lang = LangFactory.instance.get('ruby')
+    super code
   end
 
+  ##
+  # Make errors about comments
   def make_comment_error
     questions = []
     error_lines = []
@@ -43,6 +44,8 @@ class RubyCodeAI < BaseCodeAI
     questions.shuffle[0,@lines.size/@reduce]
   end
 
+  ##
+  # Make questions without errors
   def make_no_error_changes
     questions = []
     empty_lines = []
@@ -81,6 +84,8 @@ class RubyCodeAI < BaseCodeAI
     questions.shuffle[0,@lines.size/@reduce]
   end
 
+  ##
+  # Make questions with syntax errors
   def make_syntax_error
     questions = []
 
@@ -120,6 +125,8 @@ class RubyCodeAI < BaseCodeAI
     questions.shuffle[0,@lines.size/@reduce]
   end
 
+  ##
+  # Make questions with variable errors
   def make_variable_error
     questions = []
     error_lines = []

data/lib/asker/{code/ai → ai/code}/sql_code_ai.rb

@@ -4,12 +4,9 @@ require_relative '../../ai/question'
 require_relative 'base_code_ai'
 
 class SQLCodeAI < BaseCodeAI
-  def initialize(data_object)
-    @data_object = data_object
-    @lines = data_object.lines
+  def initialize(code)
     @lang = LangFactory.instance.get('sql')
-    @num = 0
-    @questions = []
+    super code
   end
 
   def make_comment_error

data/lib/asker/ai/concept_ai.rb

@@ -17,14 +17,21 @@ class ConceptAI
   attr_reader :questions
   attr_reader :excluded_questions
 
+  ##
+  # Initialize ConcepAI
+  # @param concept (Concept)
+  # @param world (World)
   def initialize(concept, world)
     @concept = concept
     @world = world
     @questions = { d: [], b: [], f: [], i: [], s: [], t: [] }
     @excluded_questions = { d: [], b: [], f: [], i: [], s: [], t: [] }
-    @num = 0 # Used to add a unique number to every question
+    @num = 0 # Add a unique number to every question
+    make_questions
   end
 
+  ##
+  # Generates and return new "num" value
   def num
     @num += 1
     @num.to_s
@@ -32,11 +39,14 @@ class ConceptAI
 
   # If a method call is missing, then delegate to concept parent.
   def method_missing(method, *args, &block)
+    raise "[DEBUG] ConceptAI.#{method}(#{args})"
     @concept.send(method, *args, &block)
   end
 
+  ##
+  # Generates random image URL
   def random_image_for(_conceptname)
-    return '' if rand <= Project.instance.get(:threshold)
+    return '' if rand <= ProjectData.instance.get(:threshold)
 
     keys = @world.image_urls.keys
     keys.shuffle!
@@ -44,6 +54,6 @@ class ConceptAI
     return '' if values.nil?
 
     values.shuffle!
-    "<img src=\"#{values[0]}\" alt\=\"image\"><br/>"
+    "<img src=\"#{values[0]}\" alt=\"image\"><br/>"
   end
 end