asker-tool 2.4.5 → 2.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c936c3b95ba797cf9a1fd0652fa9b5d3154c11ebf1d1b62e3febf3a194581374
-  data.tar.gz: 5e642c8e1ce5e0f700190c9b9caca1bdb13952a44cfe1d02837cb50cae3a8c5e
+  metadata.gz: ecd775d21f7d85f15daa5307be5947fc9d36d22dccd8448bf477c885ea639758
+  data.tar.gz: d145bb6b6ae9af56a917f9c98ccd8f33e09b0e9640c93382854d20c733714bd5
 SHA512:
-  metadata.gz: b3433f6b80c5e89417580637175c9e11de2cfae9960b52d347deb39881e52dac34df53a53225cfc4f9766bc2b24a2717927e5ec139e0811557db1126062f96e3
-  data.tar.gz: 97ebd51f2c232487dd51b39bb9083d23d9dba25e1c29da54c3817d4d7d04a15e2c4b99bd6ac03e1423945595f3b448b7603a9cbeef505e8f7b1c6e02e03b31ed
+  metadata.gz: 87f02c406e8a659bcad86e246982b1192aae902476939fb77e69f533fb648b7962054068a5084f06c0ac6f8cf8349bce8602e55f8e2f20d973f645801cbc6a09
+  data.tar.gz: b030b96ca377a1170961dbf1c6aa1026493756baea1e58a455e4bf454e13cb7af47a53f72807d66f2dbb8c0b93d12ff10881bda617897205f69fb0a977f83844

data/README.md

@@ -11,7 +11,6 @@ ASKER helps trainers to create a huge amount of questions, from a definitions (_
 
 * Free Software [LICENSE](LICENSE).
 * Multiplatform.
-* [Ruby program](https://rubygems.org/gems/asker-tool)
 
 ## Installation
 
@@ -22,20 +21,14 @@ ASKER helps trainers to create a huge amount of questions, from a definitions (_
 
 ## Usage
 
-Steps:
-
-1. Create an input file with your inputs (_conceptual map_).
-1. Run _asker_ and get the results into `output` directory.
-
-Example: Running `asker` with our example input file as argument (`acdc.haml`):
-
-```
+1. **Create input file** with your content (_conceptual map_). Examples at [Asker inputs folder](./docs/examples).
+2. **Run `asker PATH/TO/INPUT`**. Example: Create questions from ACDC input example file:
+```bash
 asker docs/examples/bands/acdc.haml
 ```
+3. Output files created into the `output` folder.
 
-* Output files created into the `output` folder.
-* More [example input files](./docs/examples).
-* More asker input files at [github/dvarrui/asker-inputs](https://github.com/dvarrui/asker-inputs) repository.
+> More input examples at [dvarrui/asker-input](https://github.com/dvarrui/asker-inputs) repository.
 
 ## Documentation
 
@@ -43,6 +36,7 @@ asker docs/examples/bands/acdc.haml
 * [Videos](docs/videos.md)
 * [Inputs](docs/inputs/README.md)
 * [Usage](docs/usage.md)
+* [Reference](docs/reference.md)
 * [Contributions](docs/contributions.md)
 * [Problem to solve](docs/idea.md)
 * [History](docs/history.md)
@@ -50,4 +44,3 @@ asker docs/examples/bands/acdc.haml
 ## Contact
 
 * **Email**: `teuton.software@protonmail.com`
-* **Twitter**: `@SoftwareTeuton`

data/lib/asker/ai/stages/stage_d.rb

@@ -5,7 +5,8 @@ require 'set'
 require_relative 'base_stage'
 require_relative '../question'
 
-# range d1-d4
+##
+# range d1-d4: d1choice, d1none-misspelled, d1none
 class StageD < BaseStage
   def run
     # Stage D: process every definition, I mean every <def> tag
@@ -15,6 +16,7 @@ class StageD < BaseStage
     lang = concept.lang
     # for every <text> do this
     concept.texts.each do |t|
+      # s => concept name, none and neighbors
       s = Set.new [name(:raw), lang.text_for(:none)]
       concept.neighbors.each { |n| s.add n[:concept].name(:decorated) }
       a = s.to_a
@@ -81,13 +83,20 @@ class StageD < BaseStage
 
       # Question choice => true
       q = Question.new(:choice)
-      q.name = "#{name(:id)}-#{num}-d2true"
+      q.name = "#{name(:id)}-#{num}-d2true-misspelled"
       q.text = random_image_for(name(:raw)) + lang.text_for(:d2, name(:raw), t)
       q.good =  lang.text_for(:true)
       q.bads << lang.text_for(:misspelling)
       q.bads << lang.text_for(:false)
       questions << q
 
+      # Question boolean => true
+      q = Question.new(:boolean)
+      q.name = "#{name(:id)}-#{num}-d2true"
+      q.text = random_image_for(name(:raw)) + lang.text_for(:d2, name(:raw), t)
+      q.good = 'TRUE'
+      questions << q
+
       # Question choice => false
       if a.size > 1
         q = Question.new(:choice)
@@ -97,6 +106,13 @@ class StageD < BaseStage
         q.bads << lang.text_for(:misspelling)
         q.bads << lang.text_for(:true)
         questions << q
+
+        # Question boolean => false
+        q = Question.new(:boolean)
+        q.name = "#{name(:id)}-#{num}-d2false"
+        q.text = random_image_for(name(:raw)) + lang.text_for(:d2, a[1], t)
+        q.good = 'FALSE'
+        questions << q
       end
 
       # Question hidden name questions
@@ -130,10 +146,4 @@ class StageD < BaseStage
 
     questions
   end
-  # rubocop:enable Lint/BooleanSymbol
-  # rubocop:enable Metrics/MethodLength
-  # rubocop:enable Metrics/AbcSize
-  # rubocop:enable Metrics/BlockLength
-  # rubocop:enable Metrics/CyclomaticComplexity
-  # rubocop:enable Metrics/PerceivedComplexity
 end

data/lib/asker/exporter/output_file_exporter.rb

@@ -3,11 +3,9 @@ require_relative 'concept_doc_exporter'
 require_relative 'data_gift_exporter'
 require_relative 'data_moodle_exporter'
 
-# Export Output data:
-# * Gift (ConceptAI, Code)
-# * YAML
-# * Doc (txt)
-# * Moodle XML (ConceptAI, Code)
+##
+# Export Output data files
+# * YAML, Doc (txt), Gift (ConceptAI, Code) and Moodle XML (ConceptAI, Code)
 module OutputFileExporter
   def self.export(data, project)
     config = Application.instance.config

data/lib/asker/files/asker.ini

@@ -1,4 +1,5 @@
 [global]
+version = ">= 2.5.0"
 ; Connect Google and download find images URLs
 ; Accept yes|no
 internet = yes

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

@@ -4,13 +4,13 @@
     %names AC/DC, ACDC
     %tags rock, band, australia
     %def Australian rock band formed by Scottish-born brothers Malcolm and Angus Young
-    %table{ fields: 'members'}
+    %table{ fields: 'members' }
       %row Bon Scott
       %row Angus Young
       %row Malcolm Young
       %row Phil Rudd
       %row Cliff Williams
-    %table{ fields: 'attribute, value'}
+    %table{ fields: 'attribute, value' }
       %row
         %col Genres
         %col Hard rock blues rock rock and roll
@@ -20,7 +20,7 @@
       %row
         %col Formed in
         %col Sydney
-    %table{ fields: 'Albums', sequence: 'Albums sorted by date'}
+    %table{ fields: 'Albums', sequence: 'Albums sorted by date' }
       %row Albums High Voltage
       %row Powerage
       %row Highway to Hell

data/lib/asker/files/language/ca/templates.yaml

@@ -12,9 +12,9 @@
 :f1: 'Els seguents elements son "<%=text2%>" del concepte <b><%=text1%></b>:<ul><li><%=text3%></li></ul>'
 :f2: "Els seguents elements son \"<%=text2%>\".<br/>Selecciona l'opció que no pertanyi al concepte <b><%=text1%></b>."
 :f3: 'Els seguents elements son "<%=text2%>" del concepte <b><%=text1%></b>:<br><p><%=text3%></p>(Coloca cada paraula a la seva posició correcta dins el text)'
-:i1: "<%=text1%><br/>Escull l'opció que millor es correspongui amb la imatge anterior.<br/>"
-:i2: '<%=text1%><br/>La imatge/text anterior correspo a <b><%=text2%></b>.'
-:i3: "<%=text1%><br/>Escriu l'opció <%=text2%>, que millor correspongui amb la imatge anterior.<br/>"
+:i1: "<%=text1%><br/>Escull l'opció que millor es correspongui amb el fitxer anterior.<br/>"
+:i2: '<%=text1%><br/>El fitxer anterior correspo a <b><%=text2%></b>.'
+:i3: "<%=text1%><br/>Escriu l'opció <%=text2%>, que millor correspongui amb el fitxer imatge anterior.<br/>"
 :i4: '<%=text1%><br/>Definició: <i><%=text2%></i><br/><br/>(Coloca cada palabra en su posición correcta dentro del texto)'
 :s1: 'En relació al concepte <b><%=text1%></b>, ordena cada/les/els "<%=text2%>" per tal que es compleixi el criteri "<%=text3%>".<br/>'
 :t1table: "Concepte <b><%=text1%></b><br/><%=text2%>: [*]<br/><%=text3%>: \"<%=text4%>\"<br/>Escull l'opció correcta.<br/>"

data/lib/asker/files/language/du/templates.yaml

@@ -12,9 +12,9 @@
 :f1: 'Die folgenden Elemente sind "<%=text2%>" des Begriffs <b><%=text1%></b>:<ul><li><%=text3%></li></ul>'
 :f2: 'Die folgenden Elemente sind "<%=text2%>".<br/>Wählen Sie die Antwortmöglichkeit aus, die nicht zum Begriff <b><%=text1%></b> passt.'
 :f3: 'Die folgenden Elemente sind "<%=text2%>" des Begriffs <b><%=text1%></b>:<br><p><%=text3%></p>(Setzen Sie die Wörter in die Lücken ein)'
-:i1: '<%=text1%><br/>EWählen Sie die Antwortmöglichkeit, die am besten zu dem gezeigten Bild passt.<br/>'
-:i2: '<%=text1%><br/>Das gezeigte Bild gehört zu <b><%=text2%></b>.'
-:i3: '<%=text1%><br/>Setzen Sie die Antwort ein <%=text2%>, qdie am besten zu dem gezeigten Bild passt.<br/>'
+:i1: '<%=text1%><br/>EWählen Sie die Antwortmöglichkeit, die am besten zu dem gezeigten Datei passt.<br/>'
+:i2: '<%=text1%><br/>Das gezeigte Datei gehört zu <b><%=text2%></b>.'
+:i3: '<%=text1%><br/>Setzen Sie die Antwort ein <%=text2%>, qdie am besten zu dem gezeigten Datei passt.<br/>'
 :i4: '<%=text1%><br/>Bedeutung: <i><%=text2%></i><br/><br/>(Setzen Sie die Wörter in die Lücken ein)'
 :s1: 'Beziehen Sie sich auf den Begriff <b><%=text1%></b>, und ordnen Sie die "<%=text2%>" richtigen Lösungen zu "<%=text3%>".<br/>'
 :t1table: 'Begriff <b><%=text1%></b><br/><%=text2%>: [*]<br/><%=text3%>: "<%=text4%>"<br/>Wählen Sie die richtige Lösung aus.<br/>'

data/lib/asker/files/language/en/templates.yaml

@@ -12,9 +12,9 @@
 :f1: 'The next items are "<%=text2%>" from <b><%=text1%></b> concept:<br/><ul><li><%=text3%></li></ul>'
 :f2: 'The next items are "<%=text2%>".<br/>Choose the option that not belongs concept <b><%=text1%></b>.'
 :f3: 'The next items are "<%=text2%>" from <b><%=text1%></b> concept:<br><p><%=text3%></p>(Put every word into the right position)'
-:i1: '<%=text1%><br/>Choose the best association for the previous image.<br/>'
-:i2: '<%=text1%><br/>The previous image/text corresponds to <b><%=text2%></b>.'
-:i3: '<%=text1%><br/>Write the best answer <%=text2%>, for the previous image.<br/>'
+:i1: '<%=text1%><br/>Choose the best association for the previous file.<br/>'
+:i2: '<%=text1%><br/>The previous file corresponds to <b><%=text2%></b>.'
+:i3: '<%=text1%><br/>Write the best answer <%=text2%>, for the previous file.<br/>'
 :i4: '<%=text1%><br/>Definition:<br/> <i><%=text2%></i><br/><br/>(Put every word in the right text position)'
 :s1: "About <b><%=text1%></b> concept, sort every \"<%=text2%>\", so It is true that \"<%=text3%>\".<br/>"
 :t1table: '<b>Concept <%=text1%></b><br/><%=text2%>: [*]<br/><%=text3%>: "<%=text4%>"<br/>Choose the right answer.<br/>'

data/lib/asker/files/language/es/templates.yaml

@@ -12,9 +12,9 @@
 :f1: 'Los siguientes elementos son "<%=text2%>" del concepto <b><%=text1%></b>:<ul><li><%=text3%></li></ul>'
 :f2: 'Los siguientes elementos son "<%=text2%>".<br/>Selecciona la opción que no pertenezca al concepto <b><%=text1%></b>.'
 :f3: 'Los siguientes elementos son "<%=text2%>" del concepto <b><%=text1%></b>:<br><p><%=text3%></p>(Coloca cada palabra en su posición correcta dentro del texto)'
-:i1: '<%=text1%><br/>Elige la opción que mejor se corresponda con la imagen anterior.<br/>'
-:i2: '<%=text1%><br/>La imagen/texto anterior corresponde a <b><%=text2%></b>.'
-:i3: '<%=text1%><br/>Escribe la opción <%=text2%>, que mejor corresponda con la imagen anterior.<br/>'
+:i1: '<%=text1%><br/>Elige la opción que mejor se corresponda con el fichero anterior.<br/>'
+:i2: '<%=text1%><br/>El fichero anterior corresponde a <b><%=text2%></b>.'
+:i3: '<%=text1%><br/>Escribe la opción <%=text2%>, que mejor corresponda con el fichero anterior.<br/>'
 :i4: '<%=text1%><br/>Definición: <i><%=text2%></i><br/><br/>(Coloca cada palabra en su posición correcta dentro del texto)'
 :s1: 'En relación al concepto <b><%=text1%></b>, ordena cada/las/los "<%=text2%>" de modo que se cumpla el criterio "<%=text3%>".<br/>'
 :t1table: 'Concepto <b><%=text1%></b><br/><%=text2%>: [*]<br/><%=text3%>: "<%=text4%>"<br/>Elige la opción correcta.<br/>'

data/lib/asker/files/language/fr/templates.yaml

@@ -12,9 +12,9 @@
 :f1: 'Les éléments suivants sont "<%=text2%>" du concept <b><%=text1%></b>:<ul><li><%=text3%></li></ul>'
 :f2: "Les éléments suivants sont \"<%=text2%>\".<br/>Sélectionnez l'option qui n'appartient pas au concept <b><%=text1%></b>."
 :f3: 'Les éléments suivants sont "<%=text2%>" du concept <b><%=text1%></b>:<br><p><%=text3%></p>(Mettez chaque mot à la bonne position dans le texte)'
-:i1: "<%=text1%><br/>Choisissez l'option qui correspond le mieux à l'image précédente.<br/>"
-:i2: "<%=text1%><br/>L'image précédente correspond à <b><%=text2%></b>."
-:i3: "<%=text1%><br/>Écrivez l'option <%=text2%>, qui correspond le mieux à l'image précédente.<br/>"
+:i1: "<%=text1%><br/>Choisissez l'option qui correspond le mieux à le fichier précédente.<br/>"
+:i2: "<%=text1%><br/>Le fichier précédente correspond à <b><%=text2%></b>."
+:i3: "<%=text1%><br/>Écrivez l'option <%=text2%>, qui correspond le mieux à le fichier précédente.<br/>"
 :i4: '<%=text1%><br/>Définition: <i><%=text2%></i><br/><br/>(Mettez chaque mot à la bonne position dans le texte)'
 :s1: "Par rapport au concept <b><%=text1%></b>, mettez dans l'ordre chaque \"<%=text2%>\" afin que le critère soit rempli \"<%=text3%>\".<br/>"
 :t1table: "Concept <b><%=text1%></b><br/><%=text2%>: [*]<br/><%=text3%>: \"<%=text4%>\"<br/>Choisissez l'option correcte.<br/>"

data/lib/asker/loader/embedded_file.rb

@@ -1,4 +1,3 @@
-# frozen_string_literal: true
 
 require 'base64'
 
@@ -11,32 +10,120 @@ module EmbeddedFile
   # @param value (String)
   # @param localdir (String) Input file base folder
   # @return Hash
-  # rubocop:disable Metrics/MethodLength
-  # rubocop:disable Metrics/AbcSize
   def self.load(value, localdir)
-    # When filename is an URL
-    if value.start_with?('https://') || value.start_with?('http://')
-      return { text: "<img src=\"#{value}\" alt=\"image\" width=\"400\" height=\"300\">", file: :none }
+    return load_image(value, localdir) if is_image? value
+    return load_audio(value, localdir) if is_audio? value
+    return load_video(value, localdir) if is_video? value
+
+    if is_url? value
+      Logger.verbose Rainbow("[ERROR] Unkown URL type!: #{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
+      # return { text: "URI error", file: :none, type: :unkown }
+      exit 1
+    end
+
+    # Suposse that filename is TEXT file
+    return { text: "<pre>#{File.read(filepath)}</pre>", file: :none, type: :text }
+  end
+
+  def self.is_audio?(filename)
+    extens = ['.mp3', '.ogg', '.wav']
+    extens.each {|ext| return true if filename.downcase.end_with?(ext) }
+    false
+  end
+
+  def self.is_image?(filename)
+    extens = ['.jpg', '.jpeg', '.png']
+    extens.each {|ext| return true if filename.downcase.end_with?(ext) }
+    false
+  end
+
+  def self.is_video?(filename)
+    extens = ['.mp4', '.ogv']
+    extens.each {|ext| return true if filename.downcase.end_with?(ext) }
+    false
+  end
+
+  def self.is_url?(value)
+    return true if value.start_with?('https://') || value.start_with?('http://')
+    false
+  end
+
+  def self.load_audio(value, localdir)
+    output = { text: :error, file: :none, type: :audio}
+
+    if is_url? value
+      output[:text] = "<audio src=\"#{value}\" controls></audio>"
+      output[:file] = :none
+      output[:type] = :url
+      return output
+    end
+
+    filepath = File.join(localdir, value)
+    unless File.exist?(filepath)
+      Logger.verbose Rainbow("[ERROR] Audio file no exists!: #{filepath}").red.bright
+      exit 1
+    end
+    output[:text] = '<audio controls><source src="@@PLUGINFILE@@/' + File.basename(filepath) \
+                    + '">Your browser does not support the audio tag.</audio>'
+    output[:file] = '<file name="' + File.basename(filepath) \
+                    + '" path="/" encoding="base64">' \
+                    + Base64.strict_encode64(File.open(filepath, 'rb').read) + '</file>'
+    output[:type] = :audio
+    output
+  end
+
+  def self.load_image(value, localdir)
+    output = { text: :error, file: :none, type: :image}
+
+    if is_url? value
+      output[:text] = "<img src=\"#{value}\" alt=\"image\" width=\"400\" height=\"300\">"
+      output[:file] = :none
+      output[:type] = :url
+      return output
     end
 
     filepath = File.join(localdir, value)
     unless File.exist?(filepath)
-      # When filename is unkown!
       Logger.verbose Rainbow("[ERROR] Unknown file! #{filepath}").red.bright
       exit 1
     end
-    # When filename is PNG, JPG o JPEG
-    if ['.png', '.jpg', '.jpeg'].include? File.extname(filepath)
-      # converts image into base64 strings
-      text = '<img src="@@PLUGINFILE@@/' + File.basename(filepath) \
-             + '" alt="imagen" class="img-responsive atto_image_button_text-bottom">'
-      data = '<file name="' + File.basename(filepath) + '" path="/" encoding="base64">' \
-             + Base64.strict_encode64(File.open(filepath, 'rb').read) + '</file>'
-      return { text: text, file: data }
+    output[:text] = '<img src="@@PLUGINFILE@@/' + File.basename(filepath) \
+                    + '" alt="imagen" class="img-responsive atto_image_button_text-bottom">'
+    output[:file] = '<file name="' + File.basename(filepath) \
+                    + '" path="/" encoding="base64">' \
+                    + Base64.strict_encode64(File.open(filepath, 'rb').read) + '</file>'
+    output[:type] = :image
+    output
+  end
+
+  def self.load_video(value, localdir)
+    output = { text: :error, file: :none, type: :video}
+
+    if is_url? value
+      output[:text] = "<video controls width=\"400\" height=\"300\">" \
+                      + "<source src=\"#{value}\"/></video>"
+      output[:file] = :none
+      output[:type] = :url
+      return output
+    end
+
+    filepath = File.join(localdir, value)
+    unless File.exist?(filepath)
+      Logger.verbose Rainbow("[ERROR] Unknown file! #{filepath}").red.bright
+      exit 1
     end
-    # Suposse that filename is TXT file
-    return { text: "<pre>#{File.read(filepath)}</pre>", file: :none } if File.exist?(filepath)
+    output[:text] = '<video controls><source src="@@PLUGINFILE@@/' + File.basename(filepath) \
+                    + '"/>Your browser does not support the video tag.</video>'
+    output[:file] = '<file name="' + File.basename(filepath) \
+                    + '" path="/" encoding="base64">' \
+                    + Base64.strict_encode64(File.open(filepath, 'rb').read) + '</file>'
+    output[:type] = :video
+    output
   end
-  # rubocop:enable Metrics/MethodLength
-  # rubocop:enable Metrics/AbcSize
 end

data/lib/asker/version.rb

@@ -1,6 +1,6 @@
 
 class Asker
-  VERSION = '2.4.5'
+  VERSION = '2.5.1'
   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.4.5
+  version: 2.5.1
 platform: ruby
 authors:
 - David Vargas Ruiz
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-16 00:00:00.000000000 Z
+date: 2022-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: haml