asker-tool 2.2.0 → 2.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a17926e45cfc0549f76ae3d8ec9c5313565847e3615653f7520344e03eea63f7
-  data.tar.gz: 717620e1a5d56c65dc0ec601de61ffef208f3e21087e71e84a4c421e9e65c67f
+  metadata.gz: 03472461b2c0fd2304386ed597031005721f01c704aa60faab99b877b2f1f391
+  data.tar.gz: 7ed5998cb07871d582458a05df781ba538b871135dd3a423d91939835a90c461
 SHA512:
-  metadata.gz: 9ec3c2b84781c6c723edfbb0e5570edaabb8e26fd0d732bb9fa155d7b6fb5762115a44ba75899af7e0e0b399d6b764562de77dd31b0b2fe128c5dd97b39caf7d
-  data.tar.gz: 3f1aa7b3ce5a9f59f3c373bd246f5fd8e8000a163ec539f943f32144fff057f80b44ae06bc127a31eb3ad71de0bb431d010a737491e57695c202e97534674a69
+  metadata.gz: a3f9036a18868f4a7d38789770f2a63d27072c48831727af59b0c3ad6f0ef056427d0ab351f07e77c8e2323dbba820fe2cebc00d9b2d509209c1d99fe96719cc
+  data.tar.gz: '08f4c7f94bc0aec827a199cb4e641f02a96b470b53ac08270cbfdcef192084e2d8b61a94c11a3f267bfa932acbd51c0bd0b26d303b6fb7dabef8421dc468f818'

data/README.md

@@ -1,9 +1,12 @@
-# ASKER (version 2.2)
+[![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)
+![Gem](https://img.shields.io/gem/dv/asker-tool/2.2.4)
 
-Generate a lot of questions from an _input file_ base on your own _definitions_.
+# ASKER
 
----
-# 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.
 
@@ -11,32 +14,29 @@ ASKER helps trainers to create a huge amount of questions, from a definitions (_
 * 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.
 
-Example: Running `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.
-* 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)
@@ -45,8 +45,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/lib/asker/ai/concept_ai.rb

@@ -46,7 +46,7 @@ class ConceptAI
   ##
   # 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!

data/lib/asker/ai/stages/stage_b.rb

@@ -5,16 +5,13 @@ require 'set'
 require_relative 'base_stage'
 require_relative '../question'
 
-##
-# range b1
 class StageB < BaseStage
   ##
+  # range b1
   # Process table data to generate match questions
   # @param table (Table)
   # @param list1 (Array) Rows that belong to this table
   # @param list2 (Array) List with similar rows (same table name) from the neighbours tables
-  # rubocop:disable Metrics/AbcSize
-  # rubocop:disable Metrics/MethodLength
   def run(table, list1, list2)
     questions = []
     return questions if table.fields.count < 2
@@ -44,12 +41,6 @@ class StageB < BaseStage
   # @param list2 (Array) List with similar rows (same table name) from the neighbours tables
   # @param index1 (Integer) Use this field number
   # @param index2 (Integer) Use this field number
-  # rubocop:disable Metrics/AbcSize
-  # rubocop:disable Metrics/MethodLength
-  # rubocop:disable Metrics/CyclomaticComplexity
-  # rubocop:disable Style/ConditionalAssignment
-  # rubocop:disable Metrics/BlockLength
-  # rubocop:disable Metrics/PerceivedComplexity
   def process_table_match2fields(p_table, list1, list2, index1, index2)
     questions = []
     lang = concept.lang

data/lib/asker/ai/stages/stage_d.rb

@@ -7,12 +7,6 @@ require_relative '../question'
 
 # range d1-d4
 class StageD < BaseStage
-  # rubocop:disable Lint/BooleanSymbol
-  # rubocop:disable Metrics/MethodLength
-  # rubocop:disable Metrics/AbcSize
-  # rubocop:disable Metrics/BlockLength
-  # rubocop:disable Metrics/CyclomaticComplexity
-  # rubocop:disable Metrics/PerceivedComplexity
   def run
     # Stage D: process every definition, I mean every <def> tag
     questions = []
@@ -67,22 +61,22 @@ class StageD < BaseStage
 
       # Question choice => mispelled
       q = Question.new(:choice)
-      q.name = "#{name(:id)}-#{num}-d2def-mispelled"
+      q.name = "#{name(:id)}-#{num}-d2def-misspelled"
       q.text = random_image_for(name(:raw)) + lang.text_for(:d2, name(:decorated), lang.do_mistake_to(t))
       q.good = lang.text_for(:misspelling)
       q.bads << lang.text_for(:true)
       q.bads << lang.text_for(:false)
-      q.feedback = "Definition text mispelled!: #{t}"
+      q.feedback = "Definition text misspelled!: #{t}"
       questions << q
 
       # Question choice => name mispelled
       q = Question.new(:choice)
-      q.name = "#{name(:id)}-#{num}-d2name-mispelled"
+      q.name = "#{name(:id)}-#{num}-d2name-misspelled"
       q.text = random_image_for(name(:raw)) + lang.text_for(:d2, lang.do_mistake_to(name(:raw)), t)
       q.good = lang.text_for(:misspelling)
       q.bads << lang.text_for(:true)
       q.bads << lang.text_for(:false)
-      q.feedback = "Concept name mispelled!: #{name(:raw)}"
+      q.feedback = "Concept name misspelled!: #{name(:raw)}"
       questions << q
 
       # Question choice => true

data/lib/asker/ai/stages/stage_f.rb

@@ -3,8 +3,6 @@
 require_relative 'base_stage'
 require_relative '../question'
 
-# StageF: process tables with 1 field
-# rubocop:disable Metrics/ClassLength
 class StageF < BaseStage
   ##
   # run stage_f: generate guqestion for tables with 1 field
@@ -24,8 +22,6 @@ class StageF < BaseStage
 
   private
 
-  # rubocop:disable Metrics/AbcSize
-  # rubocop:disable Metrics/MethodLength
   def run_only_this_concept(table, list1)
     questions = []
     lang = concept.lang
@@ -69,12 +65,7 @@ class StageF < BaseStage
     end
     questions
   end
-  # rubocop:enable Metrics/AbcSize
-  # rubocop:enable Metrics/MethodLength
 
-  # rubocop:disable Lint/BooleanSymbol
-  # rubocop:disable Metrics/MethodLength
-  # rubocop:disable Metrics/AbcSize
   def make_questions_with(values, table)
     questions = []
     lang = concept.lang
@@ -124,17 +115,11 @@ class StageF < BaseStage
     q.good =  lang.text_for(:misspelling)
     q.bads << lang.text_for(:true)
     q.bads << lang.text_for(:false)
-    q.feedback = "Text #{save} mispelled!"
+    q.feedback = "Text #{save} misspelled!"
     values[0] = save
     questions << q
   end
-  # rubocop:enable Lint/BooleanSymbol
-  # rubocop:enable Metrics/MethodLength
-  # rubocop:enable Metrics/AbcSize
 
-  # rubocop:disable Lint/BooleanSymbol
-  # rubocop:disable Metrics/MethodLength
-  # rubocop:disable Metrics/AbcSize
   def run_with_other_concepts(table, list1, list2)
     questions = []
 
@@ -177,8 +162,4 @@ class StageF < BaseStage
 
     questions
   end
-  # rubocop:enable Lint/BooleanSymbol
-  # rubocop:enable Metrics/MethodLength
-  # rubocop:enable Metrics/AbcSize
 end
-# rubocop:enable Metrics/ClassLength

data/lib/asker/application.rb

@@ -3,31 +3,23 @@
 require 'singleton'
 require 'inifile'
 require 'rainbow'
+require_relative 'version'
 
 # Global parameters
 class Application
   include Singleton
-
-  VERSION = '2.2.0'        # Application version
-  NAME = 'asker'           # Application name
-  HOMEPAGE = "https://github.com/dvarrui/#{NAME}/tree/v2.2"
-  GEM = 'asker-tool'       # Gem name
-  CONFIGFILE = 'asker.ini' # Config filename
   attr_reader :config
 
-  ##
-  # Initialize Application singleton
   def initialize
     reset
   end
 
-  ##
-  # Initialize config values from external "config.ini" file.
-  # rubocop:disable Metrics/AbcSize
-  # rubocop:disable Metrics/MethodLength
   def reset
-    filename = File.join(Dir.pwd, CONFIGFILE)
-    filename = File.join(File.dirname(__FILE__), 'files', CONFIGFILE) unless File.exist? filename
+    filename = File.join(Dir.pwd,
+                         Version::CONFIGFILE)
+    filename = File.join(File.dirname(__FILE__),
+                         'files',
+                          Version::CONFIGFILE) unless File.exist? filename
 
     begin
       @config = IniFile.load(filename)
@@ -42,6 +34,4 @@ class Application
     Rainbow.enabled = false
     Rainbow.enabled = true if @config['global']['color'].downcase == 'yes'
   end
-  # rubocop:enable Metrics/MethodLength
-  # rubocop:enable Metrics/AbcSize
 end

data/lib/asker/check_input/check_haml_data.rb

@@ -0,0 +1,264 @@
+# frozen_string_literal: true
+
+require 'rainbow'
+require 'colorize'
+require_relative 'check_table'
+
+class CheckHamlData
+  include CheckTable
+  attr_reader :inputs, :outputs
+
+  def initialize(filepath)
+    @inputs = File.read(filepath).split("\n")
+    @outputs = []
+    @inputs.each_with_index do |line, index|
+      output = { id: index,
+                 level: 0,
+                 state: :none,
+                 type: :none,
+                 source: line,
+                 msg: '' }
+      @outputs << output
+    end
+    @ok = false
+  end
+
+  def ok?
+   @ok
+  end
+
+  def show
+    @outputs.each do |i|
+      puts "#{i[:id]}: #{i[:state]} [#{i[:type]}] #{i[:msg]}"
+    end
+  end
+
+  def show_errors
+    errors = 0
+    # puts "Line : Error description"
+    puts "\n"
+    @outputs.each do |i|
+      next if i[:state] == :ok
+
+      errors += 1
+      if errors < 11
+        data = { id: i[:id], msg: i[:msg], source: i[:source][0, 40] }
+        order = i[:id] + 1
+        data = { order: order, msg: i[:msg], source: i[:source][0, 40] }
+        print format(' %<order>03d : %<msg>32s. => '.white, data)
+        puts format('%<source>s'.light_yellow, data)
+      end
+      puts '...' if errors == 11
+    end
+
+    if errors.positive?
+      puts "\n[ ASKER ] Please! Revise #{errors.to_s.light_red} error/s\n"
+    end
+    puts 'Syntax OK!'.green if errors.zero?
+  end
+
+  def check
+    @ok = true
+    @inputs.each_with_index do |line, index|
+      check_empty_lines(line, index)
+      check_map(line, index)
+      check_concept(line, index)
+      check_names(line, index)
+      check_tags(line, index)
+      check_def(line, index)
+      check_table(line, index)
+      check_row(line, index)
+      check_col(line, index)
+      check_template(line, index)
+      check_code(line, index)
+      check_type(line, index)
+      check_path(line, index)
+      check_features(line, index)
+      check_unknown(line, index)
+      @ok = false unless @outputs[index][:state] == :ok
+      @ok = false if @outputs[index][:type] == :unkown
+    end
+    @ok
+  end
+
+  private
+
+  def check_empty_lines(line, index)
+    return unless line.strip.size.zero? || line.start_with?('#')
+
+    @outputs[index][:type] = :empty
+    @outputs[index][:level] = -1
+    @outputs[index][:state] = :ok
+  end
+
+  def check_map(line, index)
+    if index.zero?
+      @outputs[index][:type] = :map
+      if line.start_with?('%map{')
+        @outputs[index][:state] = :ok
+      else
+        @outputs[index][:state] = :err
+        @outputs[index][:msg] = 'Start with %map{'
+      end
+    elsif index.positive? && line.include?('%map{')
+      @outputs[index][:state] = :err
+      @outputs[index][:type] = :map
+      @outputs[index][:msg] = 'Write %map on line 0'
+    end
+  end
+
+  def check_concept(line, index)
+    return unless @outputs[index][:state] == :none
+    return unless line.include? '%concept'
+
+    @outputs[index][:type] = :concept
+    @outputs[index][:level] = 1
+    @outputs[index][:state] = :ok
+    if find_parent(index) != :map
+      @outputs[index][:state] = :err
+      @outputs[index][:msg] = 'Parent(map) not found!'
+    elsif line != '  %concept'
+      @outputs[index][:state] = :err
+      @outputs[index][:msg] = 'Write 2 spaces before %concept'
+    end
+  end
+
+  def check_names(line, index)
+    return unless @outputs[index][:state] == :none
+    return unless line.include? '%names'
+
+    @outputs[index][:type] = :names
+    @outputs[index][:level] = 2
+    @outputs[index][:state] = :ok
+    if find_parent(index) != :concept
+      @outputs[index][:state] = :err
+      @outputs[index][:msg] = 'Parent(concept) not found!'
+    elsif !line.start_with? '    %names'
+      @outputs[index][:state] = :err
+      @outputs[index][:msg] = 'Write 4 spaces before %names'
+    end
+  end
+
+  def check_tags(line, index)
+    return unless @outputs[index][:state] == :none
+    return unless line.include? '%tags'
+
+    @outputs[index][:type] = :tags
+    @outputs[index][:level] = 2
+    @outputs[index][:state] = :ok
+    if find_parent(index) != :concept
+      @outputs[index][:state] = :err
+      @outputs[index][:msg] = 'Parent(concept) not found!'
+    elsif !line.start_with? '    %tags'
+      @outputs[index][:state] = :err
+      @outputs[index][:msg] = 'Write 4 spaces before %tags'
+    end
+  end
+
+  def check_def(line, index)
+    return unless @outputs[index][:state] == :none
+    return unless line.include? '%def'
+
+    @outputs[index][:type] = :def
+    @outputs[index][:level] = 2
+    @outputs[index][:state] = :ok
+    if find_parent(index) != :concept
+      @outputs[index][:state] = :err
+      @outputs[index][:msg] = 'Parent(concept) not found!'
+    elsif !line.start_with? '    %def'
+      @outputs[index][:state] = :err
+      @outputs[index][:msg] = 'Write 4 spaces before %def'
+    end
+  end
+
+  def check_code(line, index)
+    return unless @outputs[index][:state] == :none
+    return unless line.include? '%code'
+
+    @outputs[index][:type] = :code
+    @outputs[index][:level] = 1
+    @outputs[index][:state] = :ok
+    if find_parent(index) != :map
+      @outputs[index][:state] = :err
+      @outputs[index][:msg] = 'Parent(map) not found!'
+    elsif line != '  %code'
+      @outputs[index][:state] = :err
+      @outputs[index][:msg] = 'Write 2 spaces before %code'
+    end
+  end
+
+  def check_type(line, index)
+    return unless @outputs[index][:state] == :none
+    return unless line.include? '%type'
+
+    @outputs[index][:type] = :type
+    @outputs[index][:level] = 2
+    @outputs[index][:state] = :ok
+    if find_parent(index) != :code
+      @outputs[index][:state] = :err
+      @outputs[index][:msg] = 'Parent(code) not found!'
+    elsif !line.start_with? '    %type'
+      @outputs[index][:state] = :err
+      @outputs[index][:msg] = 'Write 4 spaces before %type'
+    end
+  end
+
+  def check_path(line, index)
+    return unless @outputs[index][:state] == :none
+    return unless line.include? '%path'
+
+    @outputs[index][:type] = :path
+    @outputs[index][:level] = 2
+    @outputs[index][:state] = :ok
+    if find_parent(index) != :code
+      @outputs[index][:state] = :err
+      @outputs[index][:msg] = 'Parent(code) not found!'
+    elsif !line.start_with? '    %path'
+      @outputs[index][:state] = :err
+      @outputs[index][:msg] = 'Write 4 spaces before %type'
+    end
+  end
+
+  def check_features(line, index)
+    return unless @outputs[index][:state] == :none
+    return unless line.include? '%features'
+
+    @outputs[index][:type] = :features
+    @outputs[index][:level] = 2
+    @outputs[index][:state] = :ok
+    if find_parent(index) != :code
+      @outputs[index][:state] = :err
+      @outputs[index][:msg] = 'Parent(code) not found!'
+    elsif !line.start_with? '    %features'
+      @outputs[index][:state] = :err
+      @outputs[index][:msg] = 'Write 4 spaces before %features'
+    end
+  end
+
+  def check_unknown(line, index)
+    return unless @outputs[index][:state] == :none
+
+    @outputs[index][:type] = :unknown
+    @outputs[index][:level] = count_spaces(line) / 2
+    @outputs[index][:state] = :err
+    @outputs[index][:msg] = "Unknown tag with parent(#{find_parent(index)})!"
+  end
+
+  def find_parent(index)
+    current_level = @outputs[index][:level]
+    return :noparent if current_level.zero?
+
+    i = index - 1
+    while i >= 0
+      return @outputs[i][:type] if @outputs[i][:level] == current_level - 1
+
+      i -= 1
+    end
+    :noparent
+  end
+
+  def count_spaces(line)
+    a = line.split('%')
+    a[0].count(' ')
+  end
+end

data/lib/asker/check_input/check_table.rb

@@ -0,0 +1,104 @@
+
+module CheckTable
+
+  def check_table(line, index)
+    return unless @outputs[index][:state] == :none
+    return unless line.include? '%table'
+
+    @outputs[index][:type] = :table
+    @outputs[index][:level] = 2
+    @outputs[index][:state] = :ok
+    if find_parent(index) != :concept
+      @outputs[index][:state] = :err
+      @outputs[index][:msg] = 'Parent(concept) not found!'
+    elsif !line.start_with? '    %table'
+      @outputs[index][:state] = :err
+      @outputs[index][:msg] = 'Write 4 spaces before %table'
+    #else not /\s+%table{\s?fields:\s?'[A-Za-z,áéíóú]*'\s?}/.match(line)
+    #  @outputs[index][:state] = :err
+    #  @outputs[index][:msg] = 'Table#fields malformed!'
+    end
+  end
+
+  def check_row(line, index)
+    return unless @outputs[index][:state] == :none
+    return unless line.include? '%row'
+
+    @outputs[index][:type] = :row
+    @outputs[index][:state] = :ok
+
+    case count_spaces(line)
+    when 6
+      @outputs[index][:level] = 3
+      parent = find_parent(index)
+      unless %i[table features].include? parent
+        @outputs[index][:state] = :err
+        @outputs[index][:msg] = 'Parent(table/features) not found!'
+      end
+    when 8
+      @outputs[index][:level] = 4
+      if find_parent(index) != :template
+        @outputs[index][:state] = :err
+        @outputs[index][:msg] = 'Parent(template) not found!'
+      end
+    else
+      @outputs[index][:state] = :err
+      @outputs[index][:msg] = 'Write 6 or 8 spaces before %row'
+    end
+  end
+
+  def check_col(line, index)
+    return unless @outputs[index][:state] == :none
+    return unless line.include? '%col'
+
+    @outputs[index][:type] = :col
+    @outputs[index][:state] = :ok
+    case count_spaces(line)
+    when 8
+      @outputs[index][:level] = 4
+      if find_parent(index) != :row
+        @outputs[index][:state] = :err
+        @outputs[index][:msg] = 'Parent(row) not found!'
+      end
+    when 10
+      @outputs[index][:level] = 5
+      if find_parent(index) != :row
+        @outputs[index][:state] = :err
+        @outputs[index][:msg] = 'Parent(row) not found!'
+      end
+    else
+      @outputs[index][:state] = :err
+      @outputs[index][:msg] = 'Write 8 or 10 spaces before %col'
+    end
+    check_text(line, index)
+  end
+
+  def check_text(line, index)
+    return unless @outputs[index][:state] == :ok
+
+    ok = ''
+    %w[< >].each do |char|
+      ok = char if line.include? char
+    end
+    return if ok == ''
+
+    @outputs[index][:state] = :err
+    @outputs[index][:msg] = "Char #{ok} not allow!"
+  end
+
+  def check_template(line, index)
+    return unless @outputs[index][:state] == :none
+    return unless line.include? '%template'
+
+    @outputs[index][:type] = :template
+    @outputs[index][:level] = 3
+    @outputs[index][:state] = :ok
+    if find_parent(index) != :table
+      @outputs[index][:state] = :err
+      @outputs[index][:msg] = 'Parent(concept) not found!'
+    elsif !line.start_with? '      %template'
+      @outputs[index][:state] = :err
+      @outputs[index][:msg] = 'Write 6 spaces before %template'
+    end
+  end
+end

data/lib/asker/check_input.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'rainbow'
+require_relative 'check_input/check_haml_data'
+
+class CheckInput
+  def initialize(verbose = true)
+    @verbose = verbose
+  end
+
+  def file(filepath)
+    @filepath = filepath
+    self
+  end
+
+  def verbose(verbose)
+    @verbose = verbose
+    self
+  end
+
+  def check
+    # Check HAML file syntax
+    exist = check_file_exist
+    return false unless exist
+    check_file_content
+  end
+
+  private
+
+  def check_file_exist
+    if @filepath.nil?
+      raise Rainbow("Can't check nil filename")
+    end
+    unless File.exist? @filepath
+      puts Rainbow('File not found!').red.bright if @verbose
+      return false
+    end
+    unless File.extname(@filepath) == '.haml'
+      puts Rainbow('Only check HAML files!').yellow.bright if @verbose
+      return false
+    end
+    true
+  end
+
+  def check_file_content
+    data = CheckHamlData.new(@filepath)
+    data.check
+    data.show_errors if @verbose
+    data.ok?
+  end
+end