asker-tool 2.1.2 → 2.1.7

data/lib/asker/{exporter/code_screen_exporter.rb → displayer/code_displayer.rb}

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
 require 'terminal-table'
+require_relative '../logger'
 
 # Export Code into Screen
-module CodeScreenExporter
-  def self.export_all(codes)
-    project = Project.instance
-    return if project.show_mode == :none || codes.nil? || codes.size.zero?
+module CodeDisplayer
+  def self.show(codes)
+    return if codes.nil? || codes.size.zero?
 
     total_c = total_q = total_e = 0
     my_screen_table = Terminal::Table.new do |st|
@@ -39,7 +39,7 @@ module CodeScreenExporter
                              Rainbow((total_q / total_e.to_f).round(2)).bright]
     return unless total_c.positive?
 
-    project.verboseln "\n[INFO] Showing CODE statistics"
-    project.verboseln my_screen_table.to_s
+    Logger.verboseln "\n[INFO] Showing CODE statistics"
+    Logger.verboseln my_screen_table.to_s
   end
 end

data/lib/asker/displayer/concept_ai_displayer.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+require 'terminal-table'
+require_relative '../application'
+require_relative '../logger'
+
+# Display ConceptAI stat on screen
+class ConceptAIDisplayer
+  ##
+  # Display ConceptAI stat on screen
+  # @param concepts_ai (Array)
+  def self.show(concepts_ai)
+    stages = Application.instance.config['questions']['stages']
+    # Create table HEAD
+    screen_table = Terminal::Table.new do |st|
+      title = ['Concept', 'Questions', 'Entries', 'xFactor']
+      %w[d b f i s t].each do |i|
+        if stages.include? i.to_sym
+          title << i
+          next
+        end
+        title << Rainbow(i).yellow.bright
+      end
+      st << title
+      st << :separator
+    end
+    # Create table BODY
+    total = {}
+    total[:q] = total[:e] = total[:c] = 0
+    total[:sd] = total[:sb] = total[:sf] = 0
+    total[:si] = total[:ss] = total[:st] = 0
+
+    concepts_ai.each do |concept_ai|
+      next unless concept_ai.process?
+
+      e = concept_ai.texts.size
+      concept_ai.tables.each { |t| e += t.fields.size * t.rows.size }
+
+      sd = sb = sf = 0
+      si = ss = st = 0
+      sd = concept_ai.questions[:d].size if stages.include? :d
+      sb = concept_ai.questions[:b].size if stages.include? :b
+      sf = concept_ai.questions[:f].size if stages.include? :f
+      si = concept_ai.questions[:i].size if stages.include? :i
+      ss = concept_ai.questions[:s].size if stages.include? :s
+      st = concept_ai.questions[:t].size if stages.include? :t
+      t = sd + sb + sf + si + ss + st
+
+      factor = 'Unkown'
+      factor = (t.to_f / e).round(2).to_s unless e.zero?
+      screen_table.add_row [Rainbow(concept_ai.name(:screen)).green.bright,
+                            t, e, factor, sd, sb, sf, si, ss, st]
+
+      total[:q] += t
+      total[:e] += e
+      total[:c] += 1
+      total[:sd] += sd
+      total[:sb] += sb
+      total[:sf] += sf
+      total[:si] += si
+      total[:ss] += ss
+      total[:st] += st
+    end
+    return if total[:c].zero? # No concepts to be process?
+
+    # Add row with excluded questions
+    export_excluded_questions(screen_table, concepts_ai)
+
+    # Create table TAIL
+    screen_table.add_separator
+    screen_table.add_row [Rainbow("TOTAL = #{total[:c]}").bright,
+                          Rainbow(total[:q].to_s).bright,
+                          Rainbow(total[:e].to_s).bright,
+                          Rainbow((total[:q].to_f / total[:e]).round(2)).bright,
+                          total[:sd], total[:sb], total[:sf],
+                          total[:si], total[:ss], total[:st]]
+    export_notes
+    Logger.verbose "#{screen_table}\n"
+  end
+
+  private_class_method def self.export_excluded_questions(screen_table, concepts_ai)
+    # Create table BODY
+    total = {}
+    total[:q] = total[:c] = 0
+    total[:sd] = total[:sb] = total[:sf] = 0
+    total[:si] = total[:ss] = total[:st] = 0
+
+    concepts_ai.each do |concept_ai|
+      next unless concept_ai.process?
+
+      sd = concept_ai.excluded_questions[:d].size
+      sb = concept_ai.excluded_questions[:b].size
+      sf = concept_ai.excluded_questions[:f].size
+      si = concept_ai.excluded_questions[:i].size
+      ss = concept_ai.excluded_questions[:s].size
+      st = concept_ai.excluded_questions[:t].size
+      t = sd + sb + sf + si + ss + st
+
+      total[:q] += t
+      total[:c] += 1
+      total[:sd] += sd
+      total[:sb] += sb
+      total[:sf] += sf
+      total[:si] += si
+      total[:ss] += ss
+      total[:st] += st
+    end
+    screen_table.add_row [Rainbow('Excluded questions').yellow.bright,
+                          total[:q], '-', '-',
+                          total[:sd], total[:sb],
+                          total[:sf], total[:si],
+                          total[:ss], total[:st]]
+  end
+
+  private_class_method def self.export_notes
+    Logger.verbose "\n[INFO] Showing CONCEPT statistics\n"
+    Logger.verbose ' * Exclude questions: ' +
+                   Application.instance.config['questions']['exclude'].to_s
+    Logger.verbose ' * Annotations:'
+    Logger.verbose '   ├── (d) Definitions     <= Concept.def'
+    Logger.verbose '   ├── (b) Table Matching  <= ' \
+                   'Concept.table.rows.columns'
+    Logger.verbose '   ├── (f) Tables 1 Field  <= Concept.table.fields.size==1'
+    Logger.verbose '   ├── (i) Images URL      <= ' \
+                   "Concept.def{:type => 'image_url'}"
+    Logger.verbose '   ├── (s) Sequences       <= ' \
+                   "Concept.table{:sequence => '...'}"
+    Logger.verbose '   └── (t) Table Rows&Cols <= ' \
+                  'Concept.table.rows.columns'
+    Logger.verbose "\n"
+  end
+end

data/lib/asker/displayer/concept_displayer.rb

@@ -0,0 +1,29 @@
+
+require_relative '../application'
+require_relative '../formatter/concept_string_formatter'
+require_relative '../logger'
+
+# Show Concept Data on screen
+module ConceptDisplayer
+  ##
+  # Show concepts on screen
+  # @param concepts (Array)
+  def self.show(concepts)
+    show_mode = Application.instance.config['global']['show_mode']
+    return unless show_mode
+
+    msg = "\n[INFO] Showing concept data (#{Rainbow(show_mode).bright})"
+    Logger.verbose msg
+    case show_mode
+    when 'resume'
+      s = "* Concepts (#{concepts.count}): "
+      concepts.each { |c| s += c.name + ', ' }
+      Logger.verbose s
+    when 'default'
+      # Only show Concepts with process attr true
+      concepts.each do |c|
+        Logger.verbose ConceptStringFormatter.to_s(c) if c.process?
+      end
+    end
+  end
+end

data/lib/asker/displayer/stats_displayer.rb

@@ -0,0 +1,14 @@
+require_relative '../application'
+require_relative 'concept_ai_displayer'
+require_relative 'code_displayer'
+
+# Display Stats on screen.
+module StatsDisplayer
+  def self.show(data)
+    return unless Application.instance.config['global']['show_mode']
+
+    # show_final_results
+    ConceptAIDisplayer.show(data[:concepts_ai])
+    CodeDisplayer.show(data[:codes_ai])
+  end
+end

data/lib/asker/exporter/code_gift_exporter.rb

@@ -1,31 +1,30 @@
 # frozen_string_literal: true
 
-require_relative '../project'
 require_relative '../formatter/question_gift_formatter'
 
-# UNDER DEVELOPMENT
 # Use to export questions from Code to gift format
 module CodeGiftExporter
-  def self.export_all(codes)
-    codes.each do |code|
-      code.make_questions
-      export code
-    end
+  ##
+  # Export an Array of codes to gift format file
+  # @param codes (Array)
+  def self.export_all(codes, file)
+    codes.each { |code| export(code, file) }
   end
 
-  def self.export(code)
+  ##
+  # Export 1 code to gift format file
+  # @param code (Code)
+  def self.export(code, file)
     return false unless code.process?
 
-    file = Project.instance.outputfile
     file.write head(code)
-
     code.questions.each do |question|
       file.write QuestionGiftFormatter.to_s(question)
     end
     true
   end
 
-  def self.head(code)
+  private_class_method def self.head(code)
     s = "\n"
     s += '// ' + '=' * 50 + "\n"
     s += "// Code #{code.type}: #{code.filename} (#{code.questions.size})\n"

data/lib/asker/exporter/concept_ai_gift_exporter.rb

@@ -1,29 +1,41 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require_relative '../project'
 require_relative '../formatter/question_gift_formatter'
 
-# Use to export data from ConceptIA to gift format
+# Export ConceptIA data to gift to outputfile
 module ConceptAIGiftExporter
-  def self.export_all(concepts_ai)
-    concepts_ai.each { |concept_ai| export(concept_ai) }
+  ##
+  # Export an array of ConceptAI objects from Project into GIFT outpufile
+  # @param concepts_ai (Array)
+  # @param project (Project)
+  def self.export_all(concepts_ai, project)
+    concepts_ai.each { |concept_ai| export(concept_ai, project) }
   end
-  
-  def self.export(concept_ai)
+
+  ##
+  # Export 1 concept_ai from project
+  # @param concept_ai (ConceptAI)
+  # @param project (Project)
+  # rubocop:disable Metrics/AbcSize
+  private_class_method def self.export(concept_ai, project)
     return unless concept_ai.process?
 
-    file = Project.instance.outputfile
+    file = project.get(:outputfile)
     file.write head(concept_ai.name)
-
-    stages = Project.instance.stages
-    stages.each_key do |stage|
+    Application.instance.config['questions']['stages'].each do |stage|
       concept_ai.questions[stage].each do |question|
         file.write(QuestionGiftFormatter.to_s(question))
       end
     end
   end
+  # rubocop:enable Metrics/AbcSize
 
-  def self.head(name)
+  ##
+  # Convert Concept name into gift format head
+  # @param name (String)
+  # @return String
+  private_class_method def self.head(name)
     s = "\n"
     s += '// ' + '=' * 50 + "\n"
     s += "// Concept name: #{name}\n"

data/lib/asker/exporter/concept_ai_yaml_exporter.rb

@@ -1,28 +1,30 @@
 # encoding: utf-8
 
 require 'yaml'
-require_relative '../project'
 require_relative '../formatter/question_hash_formatter'
 
 # Use to export data from ConceptIA to YAML format
 module ConceptAIYAMLExporter
-  def self.export_all(concepts_ai)
+  ##
+  # Export array of ConceptAI objects from Project to YAML output file
+  # @param concepts_ai (Array)
+  # @param project (Project)
+  def self.export_all(concepts_ai, project)
     questions = []
     concepts_ai.each do |concept_ai|
       questions += get_questions_from concept_ai
     end
-    project = Project.instance
     params = { lang: project.get(:lang) ,
                projectname: project.get(:projectname) }
     output = { params: params, questions: questions }
-    project.yamlfile.write(output.to_yaml)
+    project.get(:yamlfile).write(output.to_yaml)
   end
 
-  def self.get_questions_from(concept_ai)
+  private_class_method def self.get_questions_from(concept_ai)
     data = []
     return data unless concept_ai.process?
-    stages = Project.instance.stages
-    stages.each_key do |stage|
+
+    Application.instance.config['questions']['stages'].each do |stage|
       concept_ai.questions[stage].each do |question|
         question.lang = concept_ai.lang
         data << QuestionHashFormatter.to_hash(question)

data/lib/asker/exporter/concept_doc_exporter.rb

@@ -1,21 +1,15 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-require_relative '../project'
 require_relative '../formatter/concept_doc_formatter'
 
-class ConceptDocExporter
-
-  def initialize(concepts)
-    @concepts = concepts
-  end
-
-  def export
-    file = Project.instance.lessonfile
-    @concepts.each do |concept|
-      if concept.process
-        file.write(ConceptDocFormatter.to_s(concept))
-      end
+##
+# Export Concept to Doc file
+module ConceptDocExporter
+  ##
+  # Export arrya of concepts to doc
+  def self.export_all(concepts, file)
+    concepts.each do |concept|
+      file.write(ConceptDocFormatter.to_s(concept)) if concept.process
     end
   end
-
 end

data/lib/asker/exporter/output_file_exporter.rb

@@ -0,0 +1,18 @@
+require_relative 'concept_ai_gift_exporter'
+require_relative 'code_gift_exporter'
+require_relative 'concept_ai_yaml_exporter'
+require_relative 'concept_doc_exporter'
+
+# Export Output data:
+# * Gift (ConceptAI, Code)
+# * YAML
+# * Doc (txt)
+module OutputFileExporter
+  def self.export(data, project)
+    ConceptAIGiftExporter.export_all(data[:concepts_ai], project)
+    # UNDER DEVELOPMENT
+    CodeGiftExporter.export_all(data[:codes_ai], project.get(:outputfile))
+    ConceptAIYAMLExporter.export_all(data[:concepts_ai], project)
+    ConceptDocExporter.export_all(data[:concepts], project.get(:lessonfile))
+  end
+end

data/lib/asker/files/config.ini

@@ -3,7 +3,44 @@
 ; Accept yes|no
 internet = no
 
+; Output files will be save into output folder.
+outputdir = output
+
+; Display on screen messages about program progress
+; Accept yes|no
+verbose = yes
+color = yes
+
+; Accept resume|default
+show_mode = default
+
+[languages]
+; Default code language
+default = en
+
+; List of code languages to be loaded
+; Accept yes|no
+en = yes
+es = yes
+javascript = yes
+math = no
+python = yes
+ruby = yes
+sql = yes
+
+[ai]
+
+; Concept formula weights to find neighbors: context, tags, tables
+formula_weights = 1, 1, 1
+
 [questions]
+
+; List of values d,b,f,i,s,t
+stages = d,b,f,i,s,t
+
+; Questions category
+category =
+
 ; Exclude questions with this texts into their names.
 ; Accept Comma separated strings.
 exclude =

data/lib/asker/files/example-concept.haml

@@ -0,0 +1,29 @@
+%map{ :lang => 'en', :context => 'music, band', :version => '1'}
+
+  %concept
+    %names AC/DC, ACDC
+    %tags rock, band, australia
+    %def Australian rock band formed by Scottish-born brothers Malcolm and Angus Young
+    %table{ :fields => 'members'}
+      %row Bon Scott
+      %row Angus Young
+      %row Malcolm Young
+      %row Phil Rudd
+      %row Cliff Williams
+    %table{ :fields => 'attribute, value'}
+      %row
+        %col Genres
+        %col Hard rock blues rock rock and roll
+      %row
+        %col Years active
+        %col 1973-present
+      %row
+        %col Formed in
+        %col Sydney
+    %table{ :fields => 'Albums', :sequence => 'Albums sorted by date'}
+      %row Albums High Voltage
+      %row Powerage
+      %row Highway to Hell
+      %row Back in Black
+      %row Ballbreaker
+      %row Rock or Bust