asker-tool 2.1.3 → 2.2.0

data/lib/asker/checker.rb

@@ -1,29 +1,46 @@
+# frozen_string_literal: true
 
 require 'rainbow'
 
+##
+# Check HAML file syntax
 module Checker
+  ##
+  # Check:
+  # * file exist
+  # * filename extension
+  # * and HAML syntax
+  # @param filepath (String)
   def self.check(filepath)
     unless File.exist? filepath
-      puts Rainbow("File not found!").red.bright
+      puts Rainbow('File not found!').red.bright
       return false
     end
     unless File.extname(filepath) == '.haml'
-      puts Rainbow("Only check HAML files!").yellow.bright
+      puts Rainbow('Only check HAML files!').yellow.bright
       return false
     end
     check_filepath(filepath)
   end
 
+  ##
+  # Check HAML syntax
+  # @param filepath (String)
   def self.check_filepath(filepath)
     data = Data.new(filepath)
     data.check
     data.show_errors
-    data.is_ok?
+    data.ok?
   end
 
+  ##
+  # Internal class that revise syntax
+  # rubocop:disable Metrics/ClassLength
   class Data
     attr_reader :inputs
     attr_reader :outputs
+
+    # rubocop:disable Metrics/MethodLength
     def initialize(filepath)
       @inputs = File.read(filepath).split("\n")
       @outputs = []
@@ -38,8 +55,9 @@ module Checker
       end
       @ok = false
     end
+    # rubocop:enable Metrics/MethodLength
 
-    def is_ok?
+    def ok?
       @ok
     end
 
@@ -49,18 +67,33 @@ module Checker
       end
     end
 
+    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/MethodLength
     def show_errors
       errors = 0
+      # puts "Line : Error description"
       @outputs.each do |i|
         next if i[:state] == :ok
+
         errors += 1
-        puts "%02d" % i[:id] + ": %s." % i[:msg] + " => #{i[:source][0,40]}" if errors < 11
-        puts "..." if errors == 11
+        if errors < 11
+          data = { id: i[:id], msg: i[:msg], source: i[:source][0, 40] }
+          puts format(' %<id>03d : %<msg>s. => %<source>s', data)
+        end
+        puts '...' if errors == 11
+      end
+
+      if errors.positive?
+        puts Rainbow("[ERROR] #{errors} errors " \
+                     "from #{@inputs.size} lines!").red.bright
       end
-      puts Rainbow("[ERROR] #{errors} errors from #{@inputs.size} lines!").red.bright if errors > 0
-      puts Rainbow("Syntax OK!").green if errors == 0
+      puts Rainbow('Syntax OK!').green if errors.zero?
     end
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/MethodLength
 
+    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/AbcSize
     def check
       @ok = true
       @inputs.each_with_index do |line, index|
@@ -84,31 +117,41 @@ module Checker
       end
       @ok
     end
+    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/AbcSize
+
+    private
 
     def check_empty_lines(line, index)
-      if line.strip.size.zero? or line.start_with? '#'
-        @outputs[index][:type] = :empty
-        @outputs[index][:level] = -1
-        @outputs[index][:state] = :ok
-      end
+      return unless line.strip.size.zero? || line.start_with?('#')
+
+      @outputs[index][:type] = :empty
+      @outputs[index][:level] = -1
+      @outputs[index][:state] = :ok
     end
 
+    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/AbcSize
     def check_map(line, index)
-      if index == 0
+      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{'"
+          @outputs[index][:msg] = 'Start with %map{'
         end
-      elsif index > 0 and line.include?('%map{')
+      elsif index.positive? && line.include?('%map{')
         @outputs[index][:state] = :err
         @outputs[index][:type] = :map
-        @outputs[index][:msg] = "Write '%map' on line 0"
+        @outputs[index][:msg] = 'Write %map on line 0'
       end
     end
+    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/AbcSize
 
+    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/AbcSize
     def check_concept(line, index)
       return unless @outputs[index][:state] == :none
       return unless line.include? '%concept'
@@ -124,7 +167,11 @@ module Checker
         @outputs[index][:msg] = 'Write 2 spaces before %concept'
       end
     end
+    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/AbcSize
 
+    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/MethodLength
     def check_names(line, index)
       return unless @outputs[index][:state] == :none
       return unless line.include? '%names'
@@ -135,12 +182,16 @@ module Checker
       if find_parent(index) != :concept
         @outputs[index][:state] = :err
         @outputs[index][:msg] = 'Parent(concept) not found!'
-      elsif not line.start_with? '    %names'
+      elsif !line.start_with? '    %names'
         @outputs[index][:state] = :err
-        @outputs[index][:msg] = "Write 4 spaces before %names"
+        @outputs[index][:msg] = 'Write 4 spaces before %names'
       end
     end
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/MethodLength
 
+    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/MethodLength
     def check_tags(line, index)
       return unless @outputs[index][:state] == :none
       return unless line.include? '%tags'
@@ -151,12 +202,16 @@ module Checker
       if find_parent(index) != :concept
         @outputs[index][:state] = :err
         @outputs[index][:msg] = 'Parent(concept) not found!'
-      elsif not line.start_with? '    %tags'
+      elsif !line.start_with? '    %tags'
         @outputs[index][:state] = :err
-        @outputs[index][:msg] = "Write 4 spaces before %tags"
+        @outputs[index][:msg] = 'Write 4 spaces before %tags'
       end
     end
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/MethodLength
 
+    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/MethodLength
     def check_def(line, index)
       return unless @outputs[index][:state] == :none
       return unless line.include? '%def'
@@ -167,12 +222,16 @@ module Checker
       if find_parent(index) != :concept
         @outputs[index][:state] = :err
         @outputs[index][:msg] = 'Parent(concept) not found!'
-      elsif not line.start_with? '    %def'
+      elsif !line.start_with? '    %def'
         @outputs[index][:state] = :err
-        @outputs[index][:msg] = "Write 4 spaces before %def"
+        @outputs[index][:msg] = 'Write 4 spaces before %def'
       end
     end
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/MethodLength
 
+    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/MethodLength
     def check_table(line, index)
       return unless @outputs[index][:state] == :none
       return unless line.include? '%table'
@@ -183,12 +242,16 @@ module Checker
       if find_parent(index) != :concept
         @outputs[index][:state] = :err
         @outputs[index][:msg] = 'Parent(concept) not found!'
-      elsif not line.start_with? '    %table'
+      elsif !line.start_with? '    %table'
         @outputs[index][:state] = :err
-        @outputs[index][:msg] = "Write 4 spaces before %table"
+        @outputs[index][:msg] = 'Write 4 spaces before %table'
       end
     end
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/MethodLength
 
+    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/MethodLength
     def check_row(line, index)
       return unless @outputs[index][:state] == :none
       return unless line.include? '%row'
@@ -199,7 +262,7 @@ module Checker
       if count_spaces(line) == 6
         @outputs[index][:level] = 3
         parent = find_parent(index)
-        unless [:table, :features].include? parent
+        unless %i[table features].include? parent
           @outputs[index][:state] = :err
           @outputs[index][:msg] = 'Parent(table/features) not found!'
         end
@@ -211,10 +274,14 @@ module Checker
         end
       else
         @outputs[index][:state] = :err
-        @outputs[index][:msg] = "Write 6 or 8 spaces before %row"
+        @outputs[index][:msg] = 'Write 6 or 8 spaces before %row'
       end
     end
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/MethodLength
 
+    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/MethodLength
     def check_col(line, index)
       return unless @outputs[index][:state] == :none
       return unless line.include? '%col'
@@ -235,10 +302,28 @@ module Checker
         end
       else
         @outputs[index][:state] = :err
-        @outputs[index][:msg] = "Write 8 or 10 spaces before %col"
+        @outputs[index][:msg] = 'Write 8 or 10 spaces before %col'
       end
+      check_text(line, index)
     end
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/MethodLength
 
+    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
+
+    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/AbcSize
     def check_template(line, index)
       return unless @outputs[index][:state] == :none
       return unless line.include? '%template'
@@ -249,12 +334,16 @@ module Checker
       if find_parent(index) != :table
         @outputs[index][:state] = :err
         @outputs[index][:msg] = 'Parent(concept) not found!'
-      elsif not line.start_with? '      %template'
+      elsif !line.start_with? '      %template'
         @outputs[index][:state] = :err
-        @outputs[index][:msg] = "Write 6 spaces before %template"
+        @outputs[index][:msg] = 'Write 6 spaces before %template'
       end
     end
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/MethodLength
 
+    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/AbcSize
     def check_code(line, index)
       return unless @outputs[index][:state] == :none
       return unless line.include? '%code'
@@ -270,7 +359,11 @@ module Checker
         @outputs[index][:msg] = 'Write 2 spaces before %code'
       end
     end
+    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/AbcSize
 
+    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/AbcSize
     def check_type(line, index)
       return unless @outputs[index][:state] == :none
       return unless line.include? '%type'
@@ -281,12 +374,16 @@ module Checker
       if find_parent(index) != :code
         @outputs[index][:state] = :err
         @outputs[index][:msg] = 'Parent(code) not found!'
-      elsif not line.start_with? '    %type'
+      elsif !line.start_with? '    %type'
         @outputs[index][:state] = :err
-        @outputs[index][:msg] = "Write 4 spaces before %type"
+        @outputs[index][:msg] = 'Write 4 spaces before %type'
       end
     end
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/MethodLength
 
+    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/AbcSize
     def check_path(line, index)
       return unless @outputs[index][:state] == :none
       return unless line.include? '%path'
@@ -297,12 +394,16 @@ module Checker
       if find_parent(index) != :code
         @outputs[index][:state] = :err
         @outputs[index][:msg] = 'Parent(code) not found!'
-      elsif not line.start_with? '    %path'
+      elsif !line.start_with? '    %path'
         @outputs[index][:state] = :err
-        @outputs[index][:msg] = "Write 4 spaces before %type"
+        @outputs[index][:msg] = 'Write 4 spaces before %type'
       end
     end
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/MethodLength
 
+    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/AbcSize
     def check_features(line, index)
       return unless @outputs[index][:state] == :none
       return unless line.include? '%features'
@@ -313,16 +414,19 @@ module Checker
       if find_parent(index) != :code
         @outputs[index][:state] = :err
         @outputs[index][:msg] = 'Parent(code) not found!'
-      elsif not line.start_with? '    %features'
+      elsif !line.start_with? '    %features'
         @outputs[index][:state] = :err
-        @outputs[index][:msg] = "Write 4 spaces before %features"
+        @outputs[index][:msg] = 'Write 4 spaces before %features'
       end
     end
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/MethodLength
 
     def check_unknown(line, index)
       return unless @outputs[index][:state] == :none
+
       @outputs[index][:type] = :unknown
-      @outputs[index][:level] = count_spaces(line)/2
+      @outputs[index][:level] = count_spaces(line) / 2
       @outputs[index][:state] = :err
       @outputs[index][:msg] = "Unknown tag with parent(#{find_parent(index)})!"
     end
@@ -330,27 +434,20 @@ module Checker
     def find_parent(index)
       current_level = @outputs[index][:level]
       return :noparent if current_level.zero?
+
       i = index - 1
-      while(i >= 0)
+      while i >= 0
         return @outputs[i][:type] if @outputs[i][:level] == current_level - 1
-        i = i - 1
+
+        i -= 1
       end
-      return :noparent
+      :noparent
     end
 
     def count_spaces(line)
-      return 0 if line.start_with? '%'
-      return 1 if line.start_with? ' %'
-      return 2 if line.start_with? '  %'
-      return 3 if line.start_with? '   %'
-      return 4 if line.start_with? '    %'
-      return 5 if line.start_with? '     %'
-      return 6 if line.start_with? '      %'
-      return 7 if line.start_with? '       %'
-      return 8 if line.start_with? '        %'
-      return 9 if line.start_with? '         %'
-      return 10 if line.start_with? '          %'
-      return -1
+      a = line.split('%')
+      a[0].count(' ')
     end
   end
+  # rubocop:enable Metrics/ClassLength
 end

data/lib/asker/cli.rb

@@ -15,52 +15,32 @@ class CLI < Thor
   ##
   # Show current version
   def version
-    print Rainbow(Application::NAME).bright.blue
-    puts  " (version #{Rainbow(Application::VERSION).green})"
+    puts "#{Application::NAME} version #{Application::VERSION}"
   end
 
   map ['f', '-f', '--file'] => 'file'
   desc 'file NAME', 'Build output files, from HAML/XML input file.'
-  option :color, type: :boolean
   long_desc <<-LONGDESC
-  Create output files, from input file (HAML/XML format).
 
   Build questions about contents defined into input file specified.
 
-  Examples:
+  Create output files, from input file (HAML/XML format).
 
-  (1) #{Rainbow('asker input/foo/foo.haml').yellow}, Build questions from HAML file.
+  Examples:
 
-  (2) #{Rainbow('asker input/foo/foo.xml').yellow}, Build questions from XML file.
+  (1) #{Rainbow('asker input/foo/foo.haml').aqua}, Build questions from HAML file.
 
-  (3) #{Rainbow('asker file --no-color input/foo/foo.haml').yellow}, Same as (1) but without colors.
+  (2) #{Rainbow('asker input/foo/foo.xml').aqua}, Build questions from XML file.
 
-  (4) #{Rainbow('asker projects/foo/foo.yaml').yellow}, Build questions from YAML project file.
+  (3) #{Rainbow('asker projects/foo/foo.yaml').aqua}, Build questions from YAML project file.
 
   LONGDESC
   ##
   # Create questions from input file
   # @param filename (String) Path to input file
   def file(filename)
-    # Enable/disable color output
-    Rainbow.enabled = false if options['color'] == false
     # Asker start processing input file
-    Asker.new.start(filename)
-  end
-
-  map ['i', '-i', '--init'] => 'init'
-  desc 'init', 'Create default INI config fie'
-  ##
-  # Create default INI config file
-  def init
-    src = File.join(File.dirname(__FILE__), 'files', 'config.ini')
-    dst = File.join(Dir.pwd, 'config.ini')
-    if File.exist? dst
-      puts "[WARN] Exists file! => #{Rainbow(File.basename(dst)).yellow.bright}"
-    else
-      FileUtils.cp(src, dst)
-      puts "[ OK ] Create file  => #{Rainbow(File.basename(dst)).green}"
-    end
+    Asker.start(filename)
   end
 
   map ['c', '-c', '--check'] => 'check'
@@ -75,14 +55,29 @@ class CLI < Thor
     Asker.check(filename)
   end
 
-  map ['n', '-b', '--new', 'new'] => 'create_skeleton'
-  desc 'new', 'Create Asker demo input files'
+  map ['h', '-h', '--homepage', 'homepage'] => 'show_homepage'
+  desc 'homepage', 'Documentation homepage'
+  ##
+  # Show documentation homepage
+  def show_homepage()
+    puts Application::HOMEPAGE
+  end
+
+  map ['i', '-i', '--init'] => 'init'
+  desc 'init', 'Create default INI config file'
+  ##
+  # Create default INI config file
+  def init
+    Asker.create_configuration
+  end
+
+  map ['n', '-n', '--new', 'new'] => 'create_input'
+  desc 'new [FOLDER]', 'Create Asker demo input files'
   ##
   # Create Asker demo input files
   # @param dirname (String) Path to folder
-  def create_skeleton(dirname)
-    # Asker start processing input file
-    Asker.create_skeleton(dirname)
+  def create_input(dirname)
+    Asker.create_input(dirname)
   end
 
   ##
@@ -92,4 +87,14 @@ class CLI < Thor
   def method_missing(method, *_args, &_block)
     file(method.to_s)
   end
+
+  def respond_to_missing?(_method_name)
+    true
+  end
+
+  ##
+  # Thor stop and show messages on screen on failure
+  def self.exit_on_failure?
+    true
+  end
 end

data/lib/asker/data/code.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require_relative '../ai/code/code_ai_factory'
+require_relative '../project'
+require_relative '../logger'
+require_relative '../formatter/code_string_formatter'
+
+##
+# Code data object
+class Code
+  attr_reader :dirname, :filename, :type
+  attr_accessor :process, :features
+  attr_reader :lines, :questions
+
+  ##
+  # Initialize Code object
+  # @param dirname (String)
+  # @param filename (String)
+  # @param type (String)
+  def initialize(dirname, filename, type)
+    @dirname = dirname
+    @filename = filename
+    @type = type
+    @filepath = File.join(@dirname, @filename)
+    @process = false
+    @features = []
+    @lines = load(@filepath)
+    @questions = []
+  end
+
+  def process?
+    @process
+  end
+
+  def lines_to_s(lines)
+    out = ''
+    lines.each_with_index do |line, index|
+      out << format("%2d| #{line}\n", (index + 1))
+    end
+    out
+  end
+
+  def debug
+    Logger.verbose CodeStringFormatter.to_s(self)
+  end
+
+  private
+
+  def load(filepath)
+    return if filepath.nil?
+
+    unless File.exist? filepath
+      Logger.verboseln Rainbow("[ERROR] Unkown file #{filepath}").red.bright
+      return
+    end
+    content = File.read(filepath)
+    encode_and_split(content)
+  end
+
+  def encode_and_split(text, encoding = :default)
+    # Convert text to UTF-8 deleting unknown chars
+    text ||= '' # Ensure text is not nil
+    flag = [:default, 'UTF-8'].include? encoding
+    return text.encode('UTF-8', invalid: :replace).split("\n") if flag
+
+    # Convert text from input ENCODING to UTF-8
+    ec = Encoding::Converter.new(encoding.to_s, 'UTF-8')
+    begin
+      text = ec.convert(text)
+    rescue StandardError => e
+      puts "[ERROR] Encoding: #{e}"
+    end
+
+    text.split("\n")
+  end
+end

data/lib/asker/data/column.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 # Contain data information for every column
 # Params:
@@ -9,10 +8,15 @@
 class Column
   attr_reader :row, :index, :id, :raw, :lang, :type, :simple
 
+  ##
+  # initialize Column
+  # @param row (Row)
+  # @param index (Integer)
+  # @param xml_data (XMLdata)
   def initialize(row, index, xml_data)
     @row    = row
     @index  = index
-    @id     = @row.id + '.' + @index.to_s
+    @id     = "#{@row.id}.#{@index}"
     @raw    = ''
     @lang   = @row.langs[@index]
     @type   = @row.types[@index]
@@ -28,35 +32,41 @@ class Column
       return "<img src=\"#{raw}\" alt\=\"image\">"
     when 'textfile_path'
       return "<pre>#{raw}</pre>"
-    else
-      return "ERROR type #{@type}"
     end
+    "ERROR type #{@type}"
   end
 
   private
 
   def read_data_from_xml(xml_data)
-    raise '[ERROR] Column XML data with elements!' if xml_data.elements.count.positive?
+    raise '[ERROR] Column with elements!' if xml_data.elements.count.positive?
 
     @raw = xml_data.text.strip.to_s
 
     # read attributes from XML input data
-    if xml_data.attributes['lang']
-      code = xml_data.attributes['lang'].strip
-      if code != @lang.code
-        @lang = LangFactory.instance.get(code)
-        @simple[:lang] = false
-        @row.simple_off(:lang)
-      end
-    end
+    read_lang_from_xml(xml_data)
+    read_type_from_xml(xml_data)
+  end
 
-    if xml_data.attributes['type']
-      type = xml_data.attributes['type'].strip
-      if type != @type.to_s
-        @type = type
-        @simple[:type] = false
-        @row.simple_off(:type)
-      end
-    end
+  def read_lang_from_xml(xml_data)
+    return unless xml_data.attributes['lang']
+
+    code = xml_data.attributes['lang'].strip
+    return if code == @lang.code
+
+    @lang = LangFactory.instance.get(code)
+    @simple[:lang] = false
+    @row.simple_off(:lang)
+  end
+
+  def read_type_from_xml(xml_data)
+    return unless xml_data.attributes['type']
+
+    type = xml_data.attributes['type'].strip
+    return if type == @type.to_s
+
+    @type = type
+    @simple[:type] = false
+    @row.simple_off(:type)
   end
 end