asker-tool 2.1.2 → 2.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db562740b610fc29b5dd47354892919aa3041bc383f8ff6c818421f7a6ec5654
-  data.tar.gz: 9eab6c83ed23bbceb48ff54c6a1e29bfae0f2b1f0fe4ecf52a9b6d27f1d0df30
+  metadata.gz: 180880dc684b6b39dabf66bf31366cee9e8b9793af6e92d256948edf36f5fcc7
+  data.tar.gz: 9c6cd45c7b3ec9b9dbde3d720092a8eabcbc98f3dd4056a413247cdd0d7b3a2e
 SHA512:
-  metadata.gz: a9ef725d0968201216c953d237268bcbdbd96be1ffcb4888a9b4ab3a93150e69d4b97c37ec8bef16208efae484650ad5aad2acb74185ce2b913092e3eb1f2277
-  data.tar.gz: 030dfc6afaece6e49b2f70401cadc7a2aba7bbdde2f2fc4cfa8e161128f541e1d7ba239ea312aa19c59c1e6ce9fb74ec355638bc0cfd430749740a0a0e7f476b
+  metadata.gz: 1238e0b8c18a6a37f0731479d39039559c1f2adb7b3c8372c1965f81bb9e946ed37637e7e420d6e188a0811d9da9f652eda53b6c8dd67d4d7f6a79bebf7bb2b7
+  data.tar.gz: fbefae58aa69fd054a900945867c88082548042d7306227fedb1f553b48773e4fb0354913ff5bfa029c206679b7d38f4562212798dd7814de98f319d0ae71d63

data/README.md

@@ -7,41 +7,40 @@ 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.
 
-Steps:
-
-1. Create an input file with your definitions (_conceptual entities_).
-1. Run _asker_ and get the results into `output` directory.
-
-Features:
-
-* Free Software [LICENSE](https://github.com/dvarrui/asker/blob/devel/LICENSE).
+* Free Software [LICENSE](https://github.com/dvarrui/asker/blob/devel/LICENSE.txt).
 * Multiplatform.
-* Input file formats: HAML, XML.
-* Output file format: GIFT (Moodle cuestionairs).
 * Ruby program.
 
+---
+# Installation
+
+1. Install Ruby on your system.
+2. `gem install asker-tool`
+
 ---
 # Usage
 
-To execute ASKER, we use `asker` command, with a path to an input file as argument. For example, to run our `jedi.haml` input file example, we do:
+Steps:
+
+1. Create an input file with your definitions (_conceptual entities_).
+1. Run _asker_ and get the results into `output` directory.
+
+Example: Running `asker` with our example input file as argument (`jedi.haml`):
 
 ```
 asker docs/examples/starwars/jedi.haml
 ```
 
-* The program generates your output files into the `output` directory by default.
-* In this example, we use a demo input definition file `docs/examples/starwars/jedi.haml`, that contains conceptual entities about _"Jedi's"_ context.
-* [Example input files](https://github.com/dvarrui/asker/blob/devel/docs/examples).
-* More examples at `github/dvarrui/asker-inputs` repository.
+* Output files created into the `output` folder.
+* More [example input files](https://github.com/dvarrui/asker/tree/devel/docs/examples).
+* More asker input files at `github/dvarrui/asker-inputs` repository.
 
 ---
 # Documentation
 
 * [Installation](https://github.com/dvarrui/asker/blob/devel/docs/install/README.md)
-    1. Install Ruby on your system.
-    2. `gem install asker-tool`
 * [Inputs](https://github.com/dvarrui/asker/blob/devel/docs/inputs/README.md)
-* [Commands](https://github.com/dvarrui/asker/blob/devel/docs/commands.md)
+* [Usage](https://github.com/dvarrui/asker/blob/devel/docs/usage.md)
 * [Contributions](https://github.com/dvarrui/asker/blob/devel/docs/contributions.md)
 * [Base idea](https://github.com/dvarrui/asker/blob/devel/docs/idea.md)
 * [History](https://github.com/dvarrui/asker/blob/devel/docs/history.md)

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

@@ -2,62 +2,29 @@
 
 require 'rainbow'
 
-require_relative 'asker/project'
-require_relative 'asker/data/concept'
-require_relative 'asker/data/world'
-require_relative 'asker/ai/concept_ai'
-require_relative 'asker/formatter/concept_string_formatter'
-require_relative 'asker/exporter/main'
+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'
 
-# This class does all the job
-# * start
-# * load_input_data
-# * create_output_files, show_create_output_files
-# * create_questions
-# * show_final_results
+##
+# Asker main class
 class Asker
-  # Initialize atributes
-  def initialize
-    @concepts_ai = []
-    @concepts = []
-    @codes = []
-  end
-
   ##
-  # Start working
-  # @param args (Hash)
-  def start(args = {})
-    load_input_data(args)
-    create_output_files
-    show_final_results
+  # Create asker input demo files
+  # @param dirpath (String)
+  def self.create_input(dirpath)
+    Skeleton.create_input(dirpath)
   end
 
   ##
-  # Load input data
-  # @param args (Hash)
-  def load_input_data(args)
-    ProjectLoader.load(args)
-    Project.instance.open
-    data = InputLoader.load(Project.instance.get(:inputdirs).split(','))
-    @concepts = data[:concepts]
-    @codes = data[:codes]
-    Project.instance.verbose "\n[INFO] Loading data from Internet"
-    @world = World.new(@concepts)
-    ConceptScreenExporter.export_all(@concepts)
-  end
-
-  ##
-  # Create output files
-  # * Gift
-  # * YAML
-  # * TXT Doc
-  def create_output_files
-    show_create_output_files
-    create_questions
-    ConceptDocExporter.new(@concepts).export
+  # Create asker configuration files
+  def self.create_configuration
+    Skeleton.create_configuration
   end
 
   ##
@@ -67,37 +34,39 @@ class Asker
     Checker.check(filepath)
   end
 
-  private
-
-  def show_create_output_files
-    p = Project.instance
-    p.verbose "\n[INFO] Creating output files"
-    p.verbose "   ├── Gift questions file => #{Rainbow(p.outputpath).bright}"
-    p.verbose "   ├── YAML questions file => #{Rainbow(p.yamlpath).bright}"
-    p.verbose "   └── Lesson file         => #{Rainbow(p.lessonpath).bright}"
+  ##
+  # Start working
+  # @param filepath (String) HAML or XML filepath
+  def self.start(filepath)
+    project, data = load_input(filepath)
+    ConceptDisplayer.show(data[:concepts])
+    create_output(project, data)
   end
 
   ##
-  # Create questions for every "concept"
-  # Export output to:
-  # * GIFT format file
-  # * YAML format file
-  # Create questions for every "code"
-  # Export output to GIFT format file
-  def create_questions
-    @concepts.each do |concept|
-      concept_ai = ConceptAI.new(concept, @world)
-      concept_ai.make_questions
-      @concepts_ai << concept_ai
-    end
-    ConceptAIGiftExporter.export_all(@concepts_ai)
-    ConceptAIYAMLExporter.export_all(@concepts_ai)
-    CodeGiftExporter.export_all(@codes) # UNDER DEVELOPMENT
+  # 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]
   end
 
-  def show_final_results
-    ConceptAIScreenExporter.export_all(@concepts_ai)
-    CodeScreenExporter.export_all(@codes)
-    Project.instance.close
+  ##
+  # 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
+    OutputFileExporter.export(data, project)
+    StatsDisplayer.show(data)
+    project.close # Logger use Project.get(:logfile) until the end
   end
+  # rubocop:enable Metrics/AbcSize
 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