asker-tool 2.5.7 → 2.5.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42ff9bc31f925d733370fa0eed5363373896f46bcff68ed6552da791daed093b
-  data.tar.gz: fe534a02711ec5289a33ecb6ffdd46f7b8b3676a32cb70e3ff5b49accc0968e9
+  metadata.gz: 211d45e28562281dbadb99c156ae2e630d28bae27d4314f74771c7637de889b7
+  data.tar.gz: 16625618a4b4a26753727abbe6f1c59e51bd63eb99573fd929a3d98b06cdcd39
 SHA512:
-  metadata.gz: e32134c90d0317e5145380eb738bfddb2aabd59347c4b8ebd7550624de65798a85aea7c069559682e1e56554643325da8c1275e24394b3273ffa543c0e358bfc
-  data.tar.gz: '0199c498bd8f3034de7ebfd56cc8f5c2d3bf0baca9c40b8744a639e43e848544104f09a274abf98859f83753da880d9a8b4ff02cda0aec0cbafe9357f0e44c23'
+  metadata.gz: e2ac75d61319e1c833d72dc8224da00df81f57636fa5f1f61e887cc5ddff47a98bd6f2e389de58c142c77c224ea1dd87ad3971479c50b1024a691626bae13a8e
+  data.tar.gz: 34aa413ffac40f922b18ec07ecefec8fe7d2132bd2f20f3929ae87f7666958adefd75cc3bd6c67c12078f004a1ce61e743837a46e55c78c85a454e13d073e184

data/README.md

@@ -5,16 +5,13 @@
 
 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.
 
-![logo](./docs/images/logo.png)
-
-ASKER helps trainers to create a huge amount of questions, from a definitions (_conceptual entities_) input file.
+Asker helps trainers to create a huge amount of questions, from a definitions (_conceptual entities_) input file.
 
-* Free Software [LICENSE](LICENSE).
-* Multiplatform.
+![logo](./docs/images/logo.png)
 
-## Installation
+# Installation
 
-First install Ruby and then:
+At first install Ruby and then:
 
 ```
 gem install asker-tool
@@ -22,12 +19,17 @@ gem install asker-tool
 
 > REMEMBER: Update Asker with `gem update asker-tool`
 
-## Usage
+# Usage
 
-1. **Create input file** with your contents (_conceptual map_). [Here are some examples](./docs/examples).
-2. **Run `asker PATH/TO/INPUT`**. Let's see an example creating questions from ACDC input example file:
+| Step | Action                | Description |
+| ---: | --------------------- | ----------- |
+| 1    | Create your **input file** | Create input file with your contents (_conceptual map_). Here are some [examples](./docs/examples). And more examples at this [repository](https://github.com/dvarrui/asker-inputs).
+| 2    | **Run `asker`** | `asker PATH/TO/INPUT` |
+| 3    | Choose your **output files** | Output files saved into the `output` folder |
 
-```
+Let's see an example creating questions from ACDC input example file:
+
+```console
 ❯ asker docs/examples/bands/acdc.haml
 
 +--------------------+-----------+---------+---------+---+---+----+---+---+----+
@@ -40,11 +42,12 @@ gem install asker-tool
 +--------------------+-----------+---------+---------+---+---+----+---+---+----+
 ```
 
-3. **Output files** are saved into the `output` folder.
+# Features
 
-> More input examples at [asker-input  repository](https://github.com/dvarrui/asker-inputs).
+* [Free Software License](LICENSE).
+* Multiplatform.
 
-## Documentation
+# Documentation
 
 * [Installation](docs/install/README.md)
 * [Videos](docs/videos.md)
@@ -55,6 +58,15 @@ gem install asker-tool
 * [Problem to solve](docs/idea.md)
 * [History](docs/history.md)
 
-## Contact
+# Contact
 
 * **Email**: `teuton.software@protonmail.com`
+
+# Contributing
+
+1. Make sure you have Ruby installed
+1. Fork it
+1. Create your feature branch (`git checkout -b my-new-feature`)
+1. Commit your changes (`git commit -am 'Add some feature'`)
+1. Push to the branch (`git push origin my-new-feature`)
+1. Create new Pull Request.

data/lib/asker/check_input/check_haml_data.rb

@@ -32,7 +32,6 @@ class CheckHamlData
 
   def show_errors
     errors = 0
-    # puts "Line : Error description"
     puts "\n"
     @outputs.each do |i|
       next if i[:state] == :ok
@@ -164,9 +163,15 @@ class CheckHamlData
     if find_parent(index) != :concept
       @outputs[index][:state] = :err
       @outputs[index][:msg] = 'Parent(concept) not found!'
-    elsif !line.match(/^\s\s\s\s%def\s/)
+    elsif !line.match(/^\s\s\s\s%def[\s{]/)
       @outputs[index][:state] = :err
       @outputs[index][:msg] = 'Write 4 spaces before %def'
+    else
+      items = line.strip.split
+      if items.size < 2
+        @outputs[index][:state] = :err
+        @outputs[index][:msg] = '%def has no definition'
+      end
     end
   end
 

data/lib/asker/check_input.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require 'rainbow'
 require_relative 'check_input/check_haml_data'
 

data/lib/asker/data/concept.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require 'rainbow'
 require 'rexml/document'
 
@@ -8,10 +6,6 @@ require_relative '../loader/embedded_file'
 require_relative 'table'
 require_relative 'data_field'
 
-##
-# Store Concept information
-# rubocop:disable Metrics/ClassLength
-# rubocop:disable Style/ClassVars
 class Concept
   attr_reader :id        # Unique identifer (Integer)
   attr_reader :lang      # Lang code (By default is the same as map lang)
@@ -30,8 +24,6 @@ class Concept
   # @param filename (String)
   # @param lang_code (String)
   # @param context (Array)
-  # rubocop:disable Metrics/MethodLength
-  # rubocop:disable Metrics/AbcSize
   def initialize(xml_data, filename, lang_code = 'en', context = [])
     @@id += 1
     @id = @@id
@@ -62,8 +54,6 @@ class Concept
 
     read_data_from_xml(xml_data)
   end
-  # rubocop:enable Metrics/MethodLength
-  # rubocop:enable Metrics/AbcSize
 
   def name(option = :raw)
     DataField.new(@names[0], @id, @type).get(option)
@@ -87,12 +77,9 @@ class Concept
     @data[:neighbors].reverse!
   end
 
-  # rubocop:disable Metrics/MethodLength
-  # rubocop:disable Metrics/AbcSize
-  # rubocop:disable Metrics/CyclomaticComplexity
   def calculate_nearness_to_concept(other)
     a = ProjectData.instance.get(:weights)
-    #Application.instance.config['ai']['formula_weights']
+    # Application.instance.config['ai']['formula_weights']
     weights = a.split(',').map(&:to_f)
 
     max1 = @context.count
@@ -110,12 +97,7 @@ class Concept
     max = (max1 * weights[0] + max2 * weights[1] + max3 * weights[2])
     (alike * 100.0 / max)
   end
-  # rubocop:enable Metrics/MethodLength
-  # rubocop:enable Metrics/AbcSize
-  # rubocop:enable Metrics/CyclomaticComplexity
 
-  # rubocop:disable Metrics/MethodLength
-  # rubocop:disable Metrics/AbcSize
   def try_adding_references(other)
     reference_to = 0
     @data[:tags].each do |i|
@@ -132,8 +114,6 @@ class Concept
     @data[:reference_to] << other.name
     other.data[:referenced_by] << name
   end
-  # rubocop:enable Metrics/MethodLength
-  # rubocop:enable Metrics/AbcSize
 
   def tags
     @data[:tags]
@@ -165,17 +145,16 @@ class Concept
 
   private
 
-  # rubocop:disable Metrics/MethodLength
   def read_data_from_xml(xml_data)
     xml_data.elements.each do |i|
       case i.name
-      when 'names'
+      when "names"
         process_names(i)
-      when 'tags'
+      when "tags"
         process_tags(i)
-      when 'def'
+      when "def"
         process_def(i)
-      when 'table'
+      when "table"
         @data[:tables] << Table.new(self, i)
       else
         text = "   [ERROR] Concept #{name} with unkown attribute: #{i.name}"
@@ -183,7 +162,6 @@ class Concept
       end
     end
   end
-  # rubocop:enable Metrics/MethodLength
 
   def process_names(value)
     @names = []
@@ -194,7 +172,7 @@ class Concept
 
   def process_tags(value)
     if value.text.nil? || value.text.size.zero?
-      puts Rainbow("[ERROR] Concept #{name} has tags empty!").red.briht
+      puts Rainbow("[ERROR] Concept without tags: #{name} ").red.briht
       exit 1
     end
 
@@ -202,26 +180,24 @@ class Concept
     @data[:tags].collect!(&:strip)
   end
 
-  # rubocop:disable Metrics/AbcSize
-  # rubocop:disable Metrics/MethodLength
   def process_def(value)
-    case value.attributes['type']
-    when 'image_url'
+    case value.attributes["type"]
+    when "image_url"
       # Link with remote image
       @data[:images] << EmbeddedFile.load(value.text.strip, File.dirname(@filename))
-    when 'file'
+    when "file"
       # Load local images and text files
       @data[:images] << EmbeddedFile.load(value.text.strip, File.dirname(@filename))
     when nil
-      @data[:texts] << value.text.strip
+      if value.text.nil?
+        warn Rainbow("[WARN] def: without text!").yellow.bright
+      else
+        @data[:texts] << value.text.strip
+      end
     else
       msg = "[ERROR] Unknown type: #{value.attributes['type']}"
       puts Rainbow(msg).red.bright
       exit 1
     end
   end
-  # rubocop:enable Metrics/AbcSize
-  # rubocop:enable Metrics/MethodLength
 end
-# rubocop:enable Metrics/ClassLength
-# rubocop:enable Style/ClassVars

data/lib/asker/loader/content_loader.rb

@@ -1,10 +1,8 @@
-# frozen_string_literal: true
-
-require 'rainbow'
-require 'rexml/document'
-require_relative '../data/concept'
-require_relative 'code_loader'
-require_relative '../data/project_data'
+require "rainbow"
+require "rexml/document"
+require_relative "code_loader"
+require_relative "../data/concept"
+require_relative "../data/project_data"
 
 # Define methods that load data from XML contents
 module ContentLoader
@@ -25,28 +23,28 @@ module ContentLoader
 
     xmlcontent.root.elements.each do |xmldata|
       case xmldata.name
-      when 'concept'
+      when "concept"
         concepts << read_concept(xmldata, filepath, lang, context)
-      when 'code'
+      when "code"
         codes << read_code(xmldata, filepath)
       else
-        puts Rainbow("[ERROR] Unkown tag <#{xmldata.name}>").red
+        puts Rainbow("[ERROR] Unkown tag: #{xmldata.name}").red
+        puts Rainbow("[INFO ] Only 'concept' and 'code' are available at this level").red
       end
     end
 
     { concepts: concepts, codes: codes }
   end
-  # rubocop:enable Metrics/MethodLength
-  # rubocop:enable Metrics/AbcSize
 
   ##
   # Read lang attr from input XML data
   # @param xmldata (XML Object)
   private_class_method def self.read_lang_attribute(xmldata)
     begin
-      lang = xmldata.root.attributes['lang']
+      lang = xmldata.root.attributes["lang"]
     rescue StandardError
       lang = ProjectData.instance.lang
+      puts Rainbow("[WARN ] Default lang: #{lang}").yellow
     end
     lang
   end
@@ -56,9 +54,10 @@ module ContentLoader
   # @param xmldata (XML Object)
   private_class_method def self.read_context_attribute(xmldata)
     begin
-      context = xmldata.root.attributes['context']
+      context = xmldata.root.attributes["context"]
     rescue StandardError
-      context = 'unknown'
+      context = "unknown"
+      puts Rainbow("[WARN ] Default context: #{context}").yellow
     end
     context
   end

data/lib/asker/loader/directory_loader.rb

@@ -27,25 +27,17 @@ module DirectoryLoader
   end
 
   ##
-  # Load accepted files from dirname directory
+  # Load files from dirname directory
   # @param filenames (Array) File name list
   # @param dirname (String) Base directory
   def self.load_files(filenames, dirname)
     output = { concepts: [], codes: [] }
     filenames.each do |filename|
       filepath = File.join(dirname, filename)
-      data = DirectoryLoader.load_file(filepath, filename == filenames.last)
+      data = FileLoader.load(filepath)
       output[:concepts] += data[:concepts]
       output[:codes] += data[:codes]
     end
     output
   end
-
-  ##
-  # Load one input file
-  # @param filepath (String) Path to input file
-  # @param last (Boolean) True if it is the last filename
-  def self.load_file(filepath, last = false)
-    FileLoader.load(filepath)
-  end
 end

data/lib/asker/loader/embedded_file.rb

@@ -1,4 +1,3 @@
-
 require 'base64'
 
 # Methods to load embedded files defined into asker input data file
@@ -16,13 +15,13 @@ module EmbeddedFile
     return load_video(value, localdir) if is_video? value
 
     if is_url? value
-      Logger.verbose Rainbow("[ERROR] Unkown URL type!: #{value}").red.bright
+      Logger.verbose Rainbow("[ERROR] EmbebbedFile. Unkown URL: #{value}").red.bright
       exit 1
     end
 
     filepath = File.join(localdir, value)
     unless File.exist?(filepath)
-      Logger.verbose Rainbow("[ERROR] File does not exist!: #{filepath}").red.bright
+      Logger.verbose Rainbow("[ERROR] EmbeddedFile. File does not exist!: #{filepath}").red.bright
       # return { text: "URI error", file: :none, type: :unkown }
       exit 1
     end

data/lib/asker/loader/file_loader.rb

@@ -1,9 +1,9 @@
-# frozen_string_literal: true
+require_relative "content_loader"
+require_relative "haml_loader"
 
-require_relative 'content_loader'
-require_relative 'haml_loader'
-
-# Methods that load a filename and return list of concepts
+##
+# Load a filename and return a Hash with concepts list and code list
+# return { concepts: [], codes: [] }
 module FileLoader
   def self.load(filename)
     if File.extname(filename).casecmp('.haml').zero?

data/lib/asker/loader/haml_loader.rb

@@ -1,4 +1,4 @@
-require 'haml'
+require "haml"
 
 module HamlLoader
   def self.load(filename)

data/lib/asker/loader/input_loader.rb

@@ -1,10 +1,7 @@
-# frozen_string_literal: true
-
 require_relative 'directory_loader'
 require_relative '../ai/concept_ai'
 require_relative '../data/world'
 
-# Load DATA defined into our Project
 module InputLoader
   ##
   # Load input data from every input directory
@@ -12,7 +9,6 @@ module InputLoader
   def self.load(inputdirs, internet = true)
     data = { concepts: [], codes: [], world: nil,
              concepts_ai: [], codes_ai: [] }
-    #Logger.verboseln "\n[INFO] Loading input data"
     inputdirs.each do |dirname|
       temp = DirectoryLoader.load(dirname)
       data[:concepts] += temp[:concepts]

data/lib/asker/version.rb

@@ -1,5 +1,5 @@
 class Asker
-  VERSION = "2.5.7"
+  VERSION = "2.5.9"
   NAME = "asker"
   GEM = "asker-tool"
   CONFIGFILE = "asker.ini"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asker-tool
 version: !ruby/object:Gem::Version
-  version: 2.5.7
+  version: 2.5.9
 platform: ruby
 authors:
 - David Vargas Ruiz
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-26 00:00:00.000000000 Z
+date: 2023-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: haml