asker-tool 2.2.1 → 2.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb2119553ee0f5bce53f1aebe3468aabb5488ce02c54004c09df4d1256867cf5
-  data.tar.gz: 29bc8b727e10beb791eac5a113751f6d26ec9036cf3158aec583a93505fb3ba5
+  metadata.gz: d29f94512a3e39c8bca78635cf2dd2e8fe17af08a0051e06891d2215b53156c1
+  data.tar.gz: c7171059dff700353dbdcf95b7156ace478c8636c66fff6710980d1f057c3522
 SHA512:
-  metadata.gz: b3f277896c860c2987c25b4088922328f922fa52c8e2bb32ba92b6d90c6b86e05f2c0c9a056f3c69139148266f6bd4443192ca4d6892ee6e6884fb1e6cb3bad4
-  data.tar.gz: f9bb53fa2c7d5ee05566eb19657e4997d84dea2f521e1445a64fb658b06a7b6b1326e8b3d010fa21b5758c8538fc33ed1f675752493db4a366be9ac881944057
+  metadata.gz: f03b51754a35ef5db35b7b6d90431dd6e274ca5944d15e9ea80bf1ac65968576e7e2569758c936f71b56da7c69c0239ae8e48157788b5fe944960213f283fecb
+  data.tar.gz: 813968477e5f6346fc21a28670dc3a151bc390dc97b62f9945954a5b902ec275cef2460a3b1df3fda9ae989dce4663d8afe0def00adc54b2f73d799ce6482bca

data/README.md

@@ -1,6 +1,8 @@
 [![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)
 
-# ASKER (devel 2.3)
+# 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.
 

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,15 +3,11 @@
 require 'singleton'
 require 'inifile'
 require 'rainbow'
+require_relative 'version'
 
 # Global parameters
 class Application
   include Singleton
-
-  VERSION = '2.2.1'
-  NAME = 'asker'
-  GEM = 'asker-tool'
-  CONFIGFILE = 'asker.ini'
   attr_reader :config
 
   def initialize
@@ -19,8 +15,11 @@ class Application
   end
 
   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)

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,117 @@
+
+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'
+    end
+
+    unless line.include? "%table{"
+      @outputs[index][:state] = :err
+      @outputs[index][:msg] = "table must be next to { (Without spaces)"
+    end
+
+    unless line.include? "fields:"
+      @outputs[index][:state] = :err
+      @outputs[index][:msg] = "fields must be next to : (Without spaces)"
+    end
+
+    # TODO
+    #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

data/lib/asker/cli.rb

@@ -2,7 +2,7 @@
 
 require 'rainbow'
 require 'thor'
-require_relative 'application'
+require_relative 'version'
 require_relative '../asker'
 
 ##
@@ -13,7 +13,34 @@ class CLI < Thor
   map ['--version'] => 'version'
   desc 'version', 'Show the program version'
   def version
-    puts "#{Application::NAME} version #{Application::VERSION}"
+    puts "#{Version::NAME} version #{Version::VERSION}"
+    exit 0
+  end
+
+  map ['--init'] => 'init'
+  desc 'init', 'Create default INI config file'
+  def init
+    Asker.init
+    exit 0
+  end
+
+  map ['new','--new'] => 'new_input'
+  desc 'new DIRPATH', 'Create Asker demo input files'
+  ##
+  # Create Asker demo input files
+  # @param dirname (String) Path to folder
+  def new_input(dirname)
+    Asker.new_input(dirname)
+    exit 0
+  end
+
+  map ['--check'] => 'check'
+  desc 'check FILEPATH', 'Check input HAML file syntax'
+  def check(filename)
+    # Enable/disable color output
+    Rainbow.enabled = false if options['color'] == false
+    # Asker start processing input file
+    Asker.check(filename)
   end
 
   map ['f', '-f', '--file'] => 'file'
@@ -38,30 +65,6 @@ class CLI < Thor
     Asker.start(filename)
   end
 
-  map ['--check'] => 'check'
-  desc 'check FILEPATH', 'Check input HAML file syntax'
-  def check(filename)
-    # Enable/disable color output
-    Rainbow.enabled = false if options['color'] == false
-    # Asker start processing input file
-    Asker.check(filename)
-  end
-
-  map ['--init'] => 'init'
-  desc 'init', 'Create default INI config file'
-  def init
-    Asker.init
-  end
-
-  map ['new','--new'] => 'new_input'
-  desc 'new DIRPATH', 'Create Asker demo input files'
-  ##
-  # Create Asker demo input files
-  # @param dirname (String) Path to folder
-  def new_input(dirname)
-    Asker.new_input(dirname)
-  end
-
   ##
   # This actions are equals:
   # * asker demo/foo.haml