asker-tool 2.1.2

data/lib/asker/application.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'singleton'
+require 'inifile'
+
+# Global parameters
+class Application
+  include Singleton
+
+  VERSION = '2.1.2'    # Application version
+  NAME = 'asker'       # Application name
+  GEM = 'asker-tool' # Gem name
+  attr_reader :config
+
+  ##
+  # Initialize Application singleton
+  def initialize
+    reset
+  end
+
+  ##
+  # Initialize config values from external "config.ini" file.
+  def reset
+    filename = File.join(Dir.pwd, 'config.ini')
+    unless File.exist? filename
+      filename = File.join(File.dirname(__FILE__), 'files', 'config.ini')
+    end
+    @config = IniFile.load(filename)
+  end
+end

data/lib/asker/checker.rb

@@ -0,0 +1,356 @@
+
+require 'rainbow'
+
+module Checker
+  def self.check(filepath)
+    unless File.exist? filepath
+      puts Rainbow("File not found!").red.bright
+      return false
+    end
+    unless File.extname(filepath) == '.haml'
+      puts Rainbow("Only check HAML files!").yellow.bright
+      return false
+    end
+    check_filepath(filepath)
+  end
+
+  def self.check_filepath(filepath)
+    data = Data.new(filepath)
+    data.check
+    data.show_errors
+    data.is_ok?
+  end
+
+  class Data
+    attr_reader :inputs
+    attr_reader :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 is_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
+      @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
+      end
+      puts Rainbow("[ERROR] #{errors} errors from #{@inputs.size} lines!").red.bright if errors > 0
+      puts Rainbow("Syntax OK!").green if errors == 0
+    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
+
+    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
+    end
+
+    def check_map(line, index)
+      if index == 0
+        @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 > 0 and 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 not 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 not 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 not line.start_with? '    %def'
+        @outputs[index][:state] = :err
+        @outputs[index][:msg] = "Write 4 spaces before %def"
+      end
+    end
+
+    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 not line.start_with? '    %table'
+        @outputs[index][:state] = :err
+        @outputs[index][:msg] = "Write 4 spaces before %table"
+      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
+
+      if count_spaces(line) == 6
+        @outputs[index][:level] = 3
+        parent = find_parent(index)
+        unless [:table, :features].include? parent
+          @outputs[index][:state] = :err
+          @outputs[index][:msg] = 'Parent(table/features) not found!'
+        end
+      elsif count_spaces(line) == 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
+      if count_spaces(line) == 8
+        @outputs[index][:level] = 4
+        if find_parent(index) != :row
+          @outputs[index][:state] = :err
+          @outputs[index][:msg] = 'Parent(row) not found!'
+        end
+      elsif count_spaces(line) == 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
+    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 not line.start_with? '      %template'
+        @outputs[index][:state] = :err
+        @outputs[index][:msg] = "Write 6 spaces before %template"
+      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 not 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 not 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 not 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 = i - 1
+      end
+      return :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
+    end
+  end
+end

data/lib/asker/cli.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require 'rainbow'
+require 'thor'
+require_relative 'application'
+require_relative '../asker'
+
+##
+# Command Line User Interface
+class CLI < Thor
+  map ['h', '-h', '--help'] => 'help'
+
+  map ['v', '-v', '--version'] => 'version'
+  desc 'version', 'Show the program version'
+  ##
+  # Show current version
+  def version
+    print Rainbow(Application::NAME).bright.blue
+    puts  " (version #{Rainbow(Application::VERSION).green})"
+  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:
+
+  (1) #{Rainbow('asker input/foo/foo.haml').yellow}, Build questions from HAML file.
+
+  (2) #{Rainbow('asker input/foo/foo.xml').yellow}, Build questions from XML file.
+
+  (3) #{Rainbow('asker file --no-color input/foo/foo.haml').yellow}, Same as (1) but without colors.
+
+  (4) #{Rainbow('asker projects/foo/foo.yaml').yellow}, 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
+  end
+
+  map ['c', '-c', '--check'] => 'check'
+  desc 'check', 'Check input HAML file syntax'
+  ##
+  # Check input file syntax
+  # @param filename (String) Path to input file
+  def check(filename)
+    # Enable/disable color output
+    Rainbow.enabled = false if options['color'] == false
+    # Asker start processing input file
+    Asker.check(filename)
+  end
+
+  ##
+  # This actions are equals:
+  # * asker demo/foo.haml
+  # * asker file demo/fool.haml
+  def method_missing(method, *_args, &_block)
+    file(method.to_s)
+  end
+end