asker-tool 2.1.2

data/docs/revise/buenas-practicas/03-descripcion.md

@@ -0,0 +1,63 @@
+
+
+# Descripción de la práctica
+
+**darts-of-teacher** es un programa informático de licencia Open Source,
+que ayuda al profesor a crear una gran cantidad de preguntas
+de forma sencilla, a partir de una mapa conceptual.
+
+Los pasos son:
+1. El profesor crea un fichero con el mapa conceptual que quiere trabajar.
+2. Ejecutamos el programa *darts*.
+3. La aplicación lee el fichero de entrada y crea un fichero de salida con las preguntas del tema o unidad didáctica.
+
+---
+
+# El problema de corregir
+
+Como profesor, una de las tareas más aburridas es corregir el mismo ejercicio
+repetido a cada alumno del grupo, todos los años igual. Los cuestionarios
+tipo test son actividades para los que ya existen aplicaciones que los corrigen
+de forma automática. Por ejemplo, tenemos los cuestionarios de la plataforma
+de e-learning Moodle.
+
+En estos casos, el profesor dispone de tiempo para emplearlo en el análisis de
+los resultados obtenidos. Y para aplicar dicho conocimiento en la mejora del
+trabajo, intentado nuevas formas de hacer las cosas, crear nuevas actividades
+o modificar las existentes o depurar el contenido de los temas, para
+encontrar una manera de mejorar el proceso de enseñanza-aprendizaje.
+
+---
+
+# El problema de crear preguntas
+
+El gran problema con los cuestionarios tipo test es que sólo son útiles para
+evaluar características medibles o cuantificables. De modo que podemos
+estar limitados si queremos evaluar aspectos más abstractos o generales.
+Pero podemos enfocar este problema desde otro punto de vista. Veamos.
+
+Si tengo un problema abierto y abstracto, su solución tendrá un conjunto de
+pasos o hítos que pueden ser medibles. De modo que podemos transformar
+un problema abierto en un conjunto de muchos microproblemas cerrados.
+Y ahí es donde vamos a concentrar nuestra atención para medir esas
+características cuantificables.
+
+Además, si "bombardeamos" al estudiante con una gran cantidad de preguntas
+diferentes sobre el mismo concepto, probablemente podremos estar cerca de
+conocer/medir el grado de asimilación por parte del estudiante de dichos
+conceptos.
+
+El problema que teníamos de dedicar tiempo a corregir lo hemos eliminado
+pero ahora tenemos el problema de dedicar tiempo a crear las preguntas.
+
+---
+
+# La solución
+
+Para resolver el problema de crear las preguntas tenemos **darts-of-teacher**.
+Este programa multiplataforma de licencia libre se encarga de crear
+cientos de preguntas por nosotros a partir de un mapa conceptual de la unidad
+o del tema que queramos trabajar.
+
+Podemos descargar la aplicación del siguiente URL:
+https://github.com/dvarrui/darts-of-teacher

data/docs/revise/buenas-practicas/04-resultados.md

@@ -0,0 +1,17 @@
+
+# Resultados
+
+## Para el profesor
+
+Con la herramienta **darts-of-teacher** el profesor consigue reducir drásticamente
+el tiempo necesario para crear bancos de preguntas de los cuestionarios.
+
+Si manualmente se puede tardar 1 mes en hacer 500 preguntas, con
+**darts-of-teacher** tardamos 30 minutos.
+
+El profesor está más feliz porque no pierde tanto tiempo.
+
+## Para los alumnos
+
+Los alumnos están contentos de que algunas (no todas) de las actividades
+sean cuestionarios puesto que de esta forma consiguen un feedback inmediato.

data/docs/revise/buenas-practicas/05-reproducir.md

@@ -0,0 +1,10 @@
+
+# Para reproducir la práctica docente
+
+1. Ir a la web del proyecto: https://github.com/dvarrui/darts-of-teacher
+2. Leer la documentación para instalar el programa.
+3. Aprender a usar la herramienta:
+    * Leer la documentación.
+    * Consultar los ejemplos para saber cómo empezar.
+    * Ver los vídeos de YouTube y/o
+    * Consultar con <dvarrui@gmail.com>.

data/docs/revise/ejemplos/01/README.md

@@ -0,0 +1,27 @@
+
+# Ejemplo 01
+
+Vamos crear un concepto sobre los personajes de StarWars.
+
+## Input
+
+Creamos el fichero [`starwars.xml`](./starwars.xml),
+con el concepto `obiwan` con una definición.
+
+> Entendemos por `definición` una descripción textual que identifica de
+forma inequívoca al concepto al que se refiere.
+
+## Ejecución
+
+Para ejecutar *darts* usando como entrada el fichero las definiciones del concepto,
+hacemos:
+
+`./darts file docs/es/ejemplos/01/starwars.xml`,
+
+Vemos que aparece en pantalla la siguiente [información](./starwars.xml-log.txt).
+
+## Output
+
+Dentro del directorio `output`, se han creado varios ficheros de salida.
+Entre ellos, el fichero [starwars-gift.txt](./starwars-gift.txt) con las preguntas
+en formato Gift, preparadas para cargarse en un cuestionario como los de Moodle.

data/docs/revise/ejemplos/02/README.md

@@ -0,0 +1,31 @@
+
+# Ejemplo 02
+
+En el ejemplo anterior usamos un fichero en formato XML, en este ejemplo vamos
+a usar el mismo contenido pero usando formato HAML.
+
+HAML produce un XML equivalente. La diferencia está en que no hay etiquetas
+de cierre, las etiquetas comenzan por % y para crear anidamiento se usan 2 espacios.
+
+## Input
+
+Vamos ahora el fichero fichero del ejercicio anterior [`starwars.haml`](./starwars.haml)
+pero en formato HAML, con el concepto `obiwan` con una definición.
+
+> Entendemos por `definición` una descripción textual que identifica de
+forma inequívoca al concepto al que se refiere.
+
+## Ejecución
+
+Para ejecutar *darts* usando como entrada el fichero las definiciones del concepto,
+hacemos:
+
+`./darts file docs/es/ejemplos/02/starwars.haml`,
+
+Vemos que aparece en pantalla la siguiente [información](./starwars-log.txt).
+
+## Output
+
+Dentro del directorio `output`, se han creado varios ficheros de salida.
+Entre ellos, el fichero [starwars-gift.txt](./starwars-gift.txt) con las preguntas
+en formato Gift, preparadas para cargarse en un cuestionario como los de Moodle.

data/docs/revise/ejemplos/03/README.md

@@ -0,0 +1,31 @@
+
+# Ejemplo 03
+
+Vamos a ampliar las definiciones del concepto `obiwan`.
+
+## Input
+
+Hemos modificado el fichero [`starwars.haml`](./starwars.haml),
+ampliando las definiciones del concepto `obiwan`.
+
+Además hemos incluido
+una definición de tipo `image_url`. Esto es, un URL a una imagen, la cual
+identifica de forma inequívoca el conceto al cual se refiere.
+
+> Por tanto, podemos tener definiciones de texto y URL a una imagen.
+
+## Ejecución
+
+Para ejecutar *darts* usando como entrada el fichero con los conceptos, hacemos:
+
+`./darts file docs/es/ejemplos/03/starwars.haml`
+
+Vemos que aparece en pantalla la siguiente [información](./starwars-log.txt).
+
+## Output
+
+Se ha generado este [fichero](./starwars-gift.txt) con las preguntas en
+format Gift, preparadas para cargarse en Moodle.
+
+> Podemos comprobar como al aumentar las definiciones aumenta significativamente
+el número de preguntas que se generan.

data/docs/revise/ejemplos/04/README.md

@@ -0,0 +1,37 @@
+
+# Ejemplo 04
+
+Vamos a incluir más conceptos que tengan que ver con personajes de starwars
+dentro del mismo mapa.
+
+## Input
+
+Consultar el fichero [`starwars.haml`](./starwars.haml) de entrada,
+con los nuevos conceptos.
+
+Hemos incluido en cada concepto una etiqueta con el nombre "tags". tags es una
+lista de términos que ayuda a definir el concepto. Es como una nube de palabras.
+Esta lista (tags) se usa para evaluar cuańto de cerca está la definición de un
+concepto con respecto a otro semánticamente. Bueno, es una aproximación.
+
+Esta valor de distancia semántica entre conceptos ayuda a formar preguntas
+más difíciles para el alumno, proponiéndole varias alternativas, no al azar, sino
+aquellas que tengan una "semántica" más parecida.
+
+Cuantos más conceptos tenga el mapa, más complejas serán las preguntas y más
+difícil responder al alumno.
+
+## Ejecución
+
+Para ejecutar *darts* usando como entrada el fichero con los conceptos, hacemos:
+
+`./darts file docs/es/ejemplos/04/starwars.haml`
+
+Vemos que aparece en pantalla la siguiente [información](./starwars-log.txt).
+
+## Output
+
+Se ha generado este [fichero](./starwars-gift.txt) con las preguntas en
+format Gift, preparadas para cargarse en Moodle.
+
+Podemos comprobar como al incluir más conceptos aumentan las preguntas.

data/docs/revise/ejemplos/05/README.md

@@ -0,0 +1,25 @@
+
+# Ejemplo 05
+
+Vamos a ampliar aún más el mapa conceptual añadiendo definiciones a todos
+los conceptos del mapa.
+
+## Input
+
+Hemos modificado el fichero [`starwars.haml`](./starwars.haml),
+añadiendo definiciones al resto de conceptos del mapa.
+
+## Ejecución
+
+Para ejecutar *darts* usando como entrada el fichero con los conceptos, hacemos:
+
+`./darts file docs/es/ejemplos/05/starwars.haml`
+
+Vemos que aparece en pantalla la siguiente [información](./starwars-log.txt).
+
+## Output
+
+Se ha generado este [fichero](./starwars-gift.txt) con las preguntas en
+format Gift, preparadas para cargarse en Moodle.
+
+Al incluir más conceptos aumenta el número de preguntas que se generan.

data/docs/revise/ejemplos/06/README.md

@@ -0,0 +1,43 @@
+
+# Ejemplo 06
+
+Vamos a ampliar aún más el concepto `obiwan`, pero ahora vamos a incluir
+nueva información en forma de "tablas".
+
+## Input
+
+Hemos modificado el fichero [`starwars.haml`](./starwars.haml),
+ampliando la información del concepto `obiwan` con "tablas". Éstas sirven
+para incluir nueva información que acompaña al concepto pero
+que no puede ser "definición" porque no identifica al concepto
+(No es un valor único de dicho concepto).
+
+> Usamos **definiciones** para representar información que sólo posee dicho concepto.
+Es informacion única para él.
+> Usamos las **tablas** para representar información asociada al concepto pero
+no de forma única. Estos datos se pueden repetir en otros conceptos del mapa conceptual.
+
+Por ejemplo, vamos a añadir "tabla" con información de "atributo,valor".
+Esto es un conjunto de atributos del personaje "obiwan" junto con el valor de
+cada uno.
+
+Las "tablas" pueden tener tienen uno o dos campos. Cada campo tiene que tener
+un nombre.
+
+> En el futuro se podrán hacer tablas con más de 2 campos. Por ahora, no.
+
+## Ejecución
+
+Para ejecutar *darts* usando como entrada el fichero con los conceptos, hacemos:
+
+`./darts file docs/es/ejemplos/06/starwars.haml`
+
+Vemos que aparece en pantalla la siguiente [información](./starwars-log.txt).
+
+## Output
+
+Se ha generado este [fichero](./starwars-gift.txt) con las preguntas en
+format Gift, preparadas para cargarse en Moodle.
+
+> Podemos comprobar como al incluir las tablas sigue aumentando
+el número de preguntas que se generan.

data/docs/revise/ejemplos/README.md

@@ -0,0 +1,11 @@
+
+# Ejemplos
+
+|Ejemplo  | Descripción |
+|-------- |------------ |
+|[ejemplo 01](01/README.md) | Crear un concepto con una definición |
+|[ejemplo 02](02/README.md) | Cambiar XML por HAML |
+|[ejemplo 03](03/README.md) | Añadimos más definiciones y una imagen al concepto |
+|[ejemplo 04](04/README.md) | Incluimos más conceptos dentro del mismo mapa pero sin definirlos |
+|[ejemplo 05](05/README.md) | Añadimos definiciones a todos los conceptos del mapa |
+|[ejemplo 06](06/README.md) | Usamos tablas para añadir más información a un concepto |

data/docs/revise/projects.md

@@ -0,0 +1,74 @@
+
+*Extra configuration params*
+===========================
+
+=begin
+lConfig={ 
+	#category => :none,
+	#formula_weights => [1,1,1],
+	#outputdir => 'output',
+	#logname => 'default.log',
+	#verbose => true,
+	#:show_mode => :default
+	:outputname => 'asir1-idp1314-gift.txt',
+	:lesson_file => 'asir1-idp1314-lesson.txt',
+	:lesson_separator => ' |',
+	:inputdirs => 'input/idp', 
+	:process_file => 'idp-u1.xml'
+}
+=end
+
+
+Los parámetros más importantes son:
+* **:inputdirs**: Una lista de todos los directorios de entrada separados
+  por comas. Por defecto será *input*. Se aconseja hacer subdirectorios
+  dentro de input para organizar los ficheros XML, e incluir los subdirectorios
+  dentro de este parámetro. 
+* **:process_file**: Como los directorios de entrada pueden contener un número
+  elevado de ficheros XML (Cosa además muy recomendable), este parámetro
+  indica el nombre del fichero XML que se desea procesar en este momento.
+
+El resto no es obligatorio especificarlos, y de podrían dejar los valores por defecto.
+
+Ejemplo de script con más parámetros:
+
+	require_relative 'sys/interviewer'
+
+	lConfig={ 
+		:category => :none,
+		:formula_weights => [1,1,1],
+		:outputdir => 'output',
+		:outputname => 'default.txt',
+		:logname => 'default.log',
+		:verbose => true,
+		:show_mode => :full
+		:lesson_file => 'lesson.txt',
+		:lesson_separator => ' |',
+		:inputdirs => 'input/idp,input/etc', 
+		:process_file => 'commands.xml'
+	}
+
+	Interviewer.instance.run(lConfig)
+
+Pero si quieres saber más, ahí van otros parámetros que podemos configurar 
+al ejecutar la herramienta:
+* **:outputdir**: Nombre del directorio de salida. Por defecto será *output*.
+* **:outputname**: Nombre del fichero de salida donde se guardarán las preguntas
+  generadas.
+* **:lesson_file**: Cuando se indica este parámetro se crea un fichero de 
+  salida con el contenido de los conceptos en modo texto.
+* **:lesson_separator**: Por defecto es |. Es un caracter separador para las
+  distintas columnas de las tablas.
+* **:category**: Nombre de la categoría Moodle donde se cargarán las preguntas.
+  Por defecto no se establece ninguna categoría Moodle.
+* **:formula_weights**: Son pesos que se utilizarán en la fórmula que calcula
+  la proximidad o cercanía entre dos conceptos diferentes.
+* **:logname**: Nombre del fichero de log. Este fichero registra las acciones
+  realizadas por script. Por defecto toma el valor *default.log*.
+* **:verbose**: Si es *true* se emiten mensajes por pantalla de los pasos
+  realizados. Por defecto toma el valor *true*.
+* **:show_mode**: Cuando la herramienta termina muestra por pantalla un resumen
+  de los datos procesados. El valor por defecto es *:default*. Además acepta
+  los valores *:none* para no mostrar salida, y *:resume* que muestra un
+  breve resumen.
+

data/lib/asker.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+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/loader/project_loader'
+require_relative 'asker/loader/input_loader'
+require_relative 'asker/checker'
+
+# This class does all the job
+# * start
+# * load_input_data
+# * create_output_files, show_create_output_files
+# * create_questions
+# * show_final_results
+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
+  end
+
+  ##
+  # Checking input file syntax
+  # @param filepath (String)
+  def self.check(filepath)
+    Checker.check(filepath)
+  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}"
+  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
+  end
+
+  def show_final_results
+    ConceptAIScreenExporter.export_all(@concepts_ai)
+    CodeScreenExporter.export_all(@codes)
+    Project.instance.close
+  end
+end