asker-tool 2.1.3 → 2.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 649acd19a295cc267a200754428f54c987a688cf6b81487d4ea0f2662bc4968a
-  data.tar.gz: bebb65797eefd45784b3a1db72d0f41c15ec6fca9e8792ca893670712fe425f3
+  metadata.gz: 39bc74c80c6c83d62fb43bee32e10d3c3503880132cbaaa81f5e14115c9286d7
+  data.tar.gz: b60194338ffb8429c665d726b62f784c7a0787efb79db4a079b4c13bcbcd6fe8
 SHA512:
-  metadata.gz: 7aa8c6683ed5931197398b88d2651c06f99fa75f713643bbf04f6c31fbad900d2cdc08efc7ccc6f3ab255de04d6345e7a2751786e760444e91fda4cf84cac1eb
-  data.tar.gz: 3440de3f9bd77a4c0b3d0ce023ef76bf3335dfe555d52d7bea91b7a9148ac0804659803ae5bd662452801e8c1cbdabc6bfe114b9ec4e2a4d74b5b5d3cef3ef8d
+  metadata.gz: 11b8da624fedb21e507ec7f015e8e921d8d2a85efd613e1a85646114e4b505a73f303b96b2a76ce77653cf511143f495dffcb6477959eb43ad139446547e55ae
+  data.tar.gz: f6c64ac247cada2b4099385e77b2e86b953f60d4250a01f2907ff811b92d10d50628ffeb0c1f8921bef5900be3f46bec18f664276e03441e8af7ae7183965f28

data/README.md

@@ -7,41 +7,41 @@ Generate a lot of questions from an _input file_ base on your own _definitions_.
 
 ASKER helps trainers to create a huge amount of questions, from a definitions (_conceptual entities_) input file.
 
-Steps:
-
-1. Create an input file with your definitions (_conceptual entities_).
-1. Run _asker_ and get the results into `output` directory.
-
-Features:
-
 * Free Software [LICENSE](https://github.com/dvarrui/asker/blob/devel/LICENSE).
 * Multiplatform.
-* Input file formats: HAML, XML.
-* Output file format: GIFT (Moodle cuestionairs).
 * Ruby program.
 
+---
+# Installation
+
+1. Install Ruby on your system.
+2. `gem install asker-tool`
+
 ---
 # Usage
 
-To execute ASKER, we use `asker` command, with a path to an input file as argument. For example, to run our `jedi.haml` input file example, we do:
+Steps:
+
+1. Create an input file with your definitions (_conceptual entities_).
+1. Run _asker_ and get the results into `output` directory.
+
+Run `asker` with our example input file as argument (`jedi.haml`):
 
 ```
 asker docs/examples/starwars/jedi.haml
 ```
 
-* The program generates your output files into the `output` directory by default.
-* In this example, we use a demo input definition file `docs/examples/starwars/jedi.haml`, that contains conceptual entities about _"Jedi's"_ context.
-* [Example input files](https://github.com/dvarrui/asker/blob/devel/docs/examples).
-* More examples at `github/dvarrui/asker-inputs` repository.
+* Output files created into the `output` folder.
+* This example use an example input definition file `docs/examples/starwars/jedi.haml`, with concepts about _"Jedi's"_. ;-)
+* More [example input files](https://github.com/dvarrui/asker/tree/devel/docs/examples).
+* More asker input files at `github/dvarrui/asker-inputs` repository.
 
 ---
 # Documentation
 
 * [Installation](https://github.com/dvarrui/asker/blob/devel/docs/install/README.md)
-    1. Install Ruby on your system.
-    2. `gem install asker-tool`
 * [Inputs](https://github.com/dvarrui/asker/blob/devel/docs/inputs/README.md)
-* [Commands](https://github.com/dvarrui/asker/blob/devel/docs/commands.md)
+* [Usage](https://github.com/dvarrui/asker/blob/devel/docs/usage.md)
 * [Contributions](https://github.com/dvarrui/asker/blob/devel/docs/contributions.md)
 * [Base idea](https://github.com/dvarrui/asker/blob/devel/docs/idea.md)
 * [History](https://github.com/dvarrui/asker/blob/devel/docs/history.md)

data/lib/asker.rb

@@ -2,63 +2,23 @@
 
 require 'rainbow'
 
-require_relative 'asker/project'
-require_relative 'asker/data/concept'
-require_relative 'asker/data/world'
-require_relative 'asker/ai/concept_ai'
-require_relative 'asker/formatter/concept_string_formatter'
-require_relative 'asker/exporter/main'
+require_relative 'asker/displayer/concept_displayer'
+require_relative 'asker/displayer/stats_displayer'
+require_relative 'asker/exporter/output_file_exporter'
 require_relative 'asker/loader/project_loader'
 require_relative 'asker/loader/input_loader'
 require_relative 'asker/checker'
+require_relative 'asker/logger'
 require_relative 'asker/skeleton'
 
-# This class does all the job
-# * start
-# * load_input_data
-# * create_output_files, show_create_output_files
-# * create_questions
-# * show_final_results
+##
+# Asker main class
 class Asker
-  # Initialize atributes
-  def initialize
-    @concepts_ai = []
-    @concepts = []
-    @codes = []
-  end
-
-  ##
-  # Start working
-  # @param args (Hash)
-  def start(args = {})
-    load_input_data(args)
-    create_output_files
-    show_final_results
-  end
-
   ##
-  # Load input data
-  # @param args (Hash)
-  def load_input_data(args)
-    ProjectLoader.load(args)
-    Project.instance.open
-    data = InputLoader.load(Project.instance.get(:inputdirs).split(','))
-    @concepts = data[:concepts]
-    @codes = data[:codes]
-    Project.instance.verbose "\n[INFO] Loading data from Internet"
-    @world = World.new(@concepts)
-    ConceptScreenExporter.export_all(@concepts)
-  end
-
-  ##
-  # Create output files
-  # * Gift
-  # * YAML
-  # * TXT Doc
-  def create_output_files
-    show_create_output_files
-    create_questions
-    ConceptDocExporter.new(@concepts).export
+  # Create asker input demo files
+  # @param dirpath (String)
+  def self.create_skeleton(dirpath)
+    Skeleton.create(dirpath)
   end
 
   ##
@@ -69,43 +29,40 @@ class Asker
   end
 
   ##
-  # Create asker input demo files
-  # @param dirpath (String)
-  def self.create_skeleton(dirpath)
-    Skeleton.create(dirpath)
-  end
-
-  private
-
-  def show_create_output_files
-    p = Project.instance
-    p.verbose "\n[INFO] Creating output files"
-    p.verbose "   ├── Gift questions file => #{Rainbow(p.outputpath).bright}"
-    p.verbose "   ├── YAML questions file => #{Rainbow(p.yamlpath).bright}"
-    p.verbose "   └── Lesson file         => #{Rainbow(p.lessonpath).bright}"
+  # Start working
+  # @param filepath (String) HAML or XML filepath
+  def self.start(filepath)
+    project, data = load_input(filepath)
+    ConceptDisplayer.show(data[:concepts], project.get(:show_mode))
+    create_output(project, data)
   end
 
   ##
-  # Create questions for every "concept"
-  # Export output to:
-  # * GIFT format file
-  # * YAML format file
-  # Create questions for every "code"
-  # Export output to GIFT format file
-  def create_questions
-    @concepts.each do |concept|
-      concept_ai = ConceptAI.new(concept, @world)
-      concept_ai.make_questions
-      @concepts_ai << concept_ai
-    end
-    ConceptAIGiftExporter.export_all(@concepts_ai)
-    ConceptAIYAMLExporter.export_all(@concepts_ai)
-    CodeGiftExporter.export_all(@codes) # UNDER DEVELOPMENT
+  # Load input data
+  # @param args (Hash)
+  private_class_method def self.load_input(args)
+    project = ProjectLoader.load(args)
+    project.open # Open output files
+    data = InputLoader.load(project.get(:inputdirs).split(','))
+    [project, data]
   end
 
-  def show_final_results
-    ConceptAIScreenExporter.export_all(@concepts_ai)
-    CodeScreenExporter.export_all(@codes)
-    Project.instance.close
+  ##
+  # Create output files: Gift, YAML, TXT Doc
+  # rubocop:disable Metrics/AbcSize
+  # rubocop:disable Metrics/MethodLength
+  private_class_method def self.create_output(project, data)
+    Logger.verbose "\n[INFO] Creating output files"
+    Logger.verbose '   ├── Gift questions file => ' +
+                   Rainbow(project.get(:outputpath)).bright
+    Logger.verbose '   ├── YAML questions file => ' +
+                   Rainbow(project.get(:yamlpath)).bright
+    Logger.verbose '   └── Lesson file         => ' +
+                   Rainbow(project.get(:lessonpath)).bright
+    OutputFileExporter.export(data, project)
+    StatsDisplayer.show(data, project.get(:show_mode))
+    project.close # Logger use Project.get(:logfile) until the end
   end
+  # rubocop:enable Metrics/AbcSize
+  # rubocop:enable Metrics/MethodLength
 end

data/lib/asker/application.rb

@@ -7,7 +7,7 @@ require 'inifile'
 class Application
   include Singleton
 
-  VERSION = '2.1.3'    # Application version
+  VERSION = '2.1.5'    # Application version
   NAME = 'asker'       # Application name
   GEM = 'asker-tool' # Gem name
   attr_reader :config

data/lib/asker/checker.rb

@@ -1,7 +1,15 @@
 
 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
@@ -14,6 +22,9 @@ module Checker
     check_filepath(filepath)
   end
 
+  ##
+  # Check HAML syntax
+  # @param filepath (String)
   def self.check_filepath(filepath)
     data = Data.new(filepath)
     data.check
@@ -85,6 +96,8 @@ module Checker
       @ok
     end
 
+    private
+
     def check_empty_lines(line, index)
       if line.strip.size.zero? or line.start_with? '#'
         @outputs[index][:type] = :empty
@@ -100,12 +113,12 @@ module Checker
           @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{')
         @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
 
@@ -135,9 +148,9 @@ 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
 
@@ -151,9 +164,9 @@ 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
 
@@ -167,9 +180,9 @@ 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
 
@@ -183,9 +196,9 @@ 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
 
@@ -211,7 +224,7 @@ 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
 
@@ -235,7 +248,7 @@ 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
     end
 
@@ -249,9 +262,9 @@ 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
 
@@ -281,9 +294,9 @@ 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
 
@@ -297,9 +310,9 @@ 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
 
@@ -313,16 +326,17 @@ 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
 
     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,12 +344,14 @@ 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)
@@ -350,7 +366,8 @@ module Checker
       return 8 if line.start_with? '        %'
       return 9 if line.start_with? '         %'
       return 10 if line.start_with? '          %'
-      return -1
+
+      -1
     end
   end
 end

data/lib/asker/cli.rb

@@ -45,7 +45,7 @@ class CLI < Thor
     # Enable/disable color output
     Rainbow.enabled = false if options['color'] == false
     # Asker start processing input file
-    Asker.new.start(filename)
+    Asker.start(filename)
   end
 
   map ['i', '-i', '--init'] => 'init'

data/lib/asker/data/world.rb

@@ -1,6 +1,7 @@
 
 require_relative '../loader/image_url_loader'
 require_relative '../project'
+require_relative '../logger'
 
 class World
   attr_reader :concepts, :filenames, :contexts, :image_urls
@@ -23,6 +24,7 @@ class World
     @filenames.uniq!
     @contexts.uniq!
 
+    Logger.verbose "\n[INFO] Loading data from Internet" if show_progress
     threads = []
     concepts.each do |c|
       print('.') if show_progress