asker-tool 2.1.5 → 2.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39bc74c80c6c83d62fb43bee32e10d3c3503880132cbaaa81f5e14115c9286d7
-  data.tar.gz: b60194338ffb8429c665d726b62f784c7a0787efb79db4a079b4c13bcbcd6fe8
+  metadata.gz: 31954f483d7ed78c542d50fcbfd3ce9419d49cca87a89a6dd717e9832e870386
+  data.tar.gz: 2dc8133f935ec289cafa318392d2575542f3083c165d0e86b6902ef7fbc2a427
 SHA512:
-  metadata.gz: 11b8da624fedb21e507ec7f015e8e921d8d2a85efd613e1a85646114e4b505a73f303b96b2a76ce77653cf511143f495dffcb6477959eb43ad139446547e55ae
-  data.tar.gz: f6c64ac247cada2b4099385e77b2e86b953f60d4250a01f2907ff811b92d10d50628ffeb0c1f8921bef5900be3f46bec18f664276e03441e8af7ae7183965f28
+  metadata.gz: c107cb11e05e15e635d4fd8e6c8ba04389a2fd70a1e0f03e4f468d61d8bb01b5b45083a9f162c2e0221359fefef14fa96f02f78af32b74a074fb7f673fceb0a1
+  data.tar.gz: 7f7e4305c1c2ec88e81245d3402f27f5ae1590b87ddfa45932cc19dfcf8c4d3d6d9d6326cbf6e03941194e71ceb65922bf85ca15f5dce6d1abc97293295ac6d5

data/README.md

@@ -7,7 +7,7 @@ Generate a lot of questions from an _input file_ base on your own _definitions_.
 
 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.
 
@@ -25,14 +25,13 @@ 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 (`jedi.haml`):
 
 ```
 asker docs/examples/starwars/jedi.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 asker input files at `github/dvarrui/asker-inputs` repository.
 

data/bin/asker

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

data/lib/asker.rb

@@ -17,8 +17,14 @@ class Asker
   ##
   # Create asker input demo files
   # @param dirpath (String)
-  def self.create_skeleton(dirpath)
-    Skeleton.create(dirpath)
+  def self.create_input(dirpath)
+    Skeleton.create_input(dirpath)
+  end
+
+  ##
+  # Create asker configuration files
+  def self.create_configuration
+    Skeleton.create_configuration
   end
 
   ##
@@ -33,7 +39,7 @@ class Asker
   # @param filepath (String) HAML or XML filepath
   def self.start(filepath)
     project, data = load_input(filepath)
-    ConceptDisplayer.show(data[:concepts], project.get(:show_mode))
+    ConceptDisplayer.show(data[:concepts])
     create_output(project, data)
   end
 
@@ -50,7 +56,6 @@ class Asker
   ##
   # Create output files: Gift, YAML, TXT Doc
   # rubocop:disable Metrics/AbcSize
-  # rubocop:disable Metrics/MethodLength
   private_class_method def self.create_output(project, data)
     Logger.verbose "\n[INFO] Creating output files"
     Logger.verbose '   ├── Gift questions file => ' +
@@ -60,9 +65,8 @@ class Asker
     Logger.verbose '   └── Lesson file         => ' +
                    Rainbow(project.get(:lessonpath)).bright
     OutputFileExporter.export(data, project)
-    StatsDisplayer.show(data, project.get(:show_mode))
+    StatsDisplayer.show(data)
     project.close # Logger use Project.get(:logfile) until the end
   end
   # rubocop:enable Metrics/AbcSize
-  # rubocop:enable Metrics/MethodLength
 end

data/lib/asker/ai/ai.rb

@@ -46,6 +46,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 +63,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/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