info_extra.md

Entrega 1

Planificacion

Se desarrolla un esqumea para los datos. Se considera los objetos y las clases. Se hace un dibujo o esquema para poder visualizar las relaciones. Las relaciones son acotadas. Se considera la necesidad de una entidad que trabaje con archivos para separar el comportamiento de la logica del modelo. Funciona como un adaptador.

Se toma nota de los requisitos a partir del enunciado y se escriben breves historias de usuario y se aggrupan en epicas para dividir la funcionalidad en partes y priorizar. Se consideran algunas tareas adicionales de modelado y de diseño.

Se planifica con Jira.

Options

Se toma la decision de usar opciones en la linea de comandos.

Dry::CLI::Command documentation

Definicion de Excepciones

Se toma la decision de definir errores especifico al Modelo en el archivo error.rb del modulo Polycon::Model.

Modulo Store

Extra libraries (included)

Dir documentation FileUtils documentation

Gemas (not included )

Dry::Files documentation

Correr bundle install al clonar el repo.

Se incluye en la libreria el modulo Polycon::Store que tiene metodos relacionados con el manejo de archivos. Incluye metodos helper para saber si existen archivos. Tambien sabe crear directorios, para el archivo root y para guardar profesionales. Y sabe leer archivos de turnos de Polycon.

Se considero usar un modulo llamado Utils o Helpers pero no por ahora ya que Store maneja las responsabilidades de archivos para Polycon. La utilidad de un modulo Utils que haga queries por existencia de archivos o directorios se hace redundante para esta funcionalidad. No se descarta crear este modulo como forma de modularizar las validaciones y otras utilities si fuera necesario.

Al principio se usaban las clases principalmente Dir y FileUtils adentro de Store, pero luego investgando las gemas de 'dry-rb', se instala la gema Dry::Files ya que se adecua de una manera mas limpia a las utilidades necesarias para el sistema de archivos, y tiene una agilidad deseable para modificar archivos. Sin embargo, se usa FileUtils y Dir adonde se considera necesario y adonde Dry::Files no alcanza.

Esta gema define sus propios errores Dry::File::Error y Dry::File::IOError.

Metodos (clase e instancia)

Originalmente la mayoria de los metodos eran de clase, se refactoriza para usar metodos de instancia para toda la funcionalidad que actua sobre una sola instancia (editar, borrar). Se utiliza metodos de clase para creacion, en la busqueda de una instancia desde un archivo o cuando se debe trabajar sobre varias instancias.

Refactoring a futuro

Se agregan metodos to_h a professional y appointment para tener mayor facilidad de refactorizar algunas funcionalidades en un futuro.

Entrega 2

Mejoras en el codigo

Se cambian :: por . en los llamados a metodos de Store. Se pasan todos los strings concatenados a interpolacion. Se freezea las constantes.

Se refactoriza las clases del modelo para quitarle todas las referencias al filesystem (@path etc), aprovechando el modulo Store al 100%. Se deshace con una idea de un Store como agnostico, se hace que store conozca appointments y professionals y tenga metodos especailizados para estos. Se agrega un metodo de appointments que devuelve todos los appointments para professionals, y appointments? que devuelve true si tiene appointments.

Se agrega tests usando 'minitest' para testear la funcionalidad de Polycon.

Se hacen refactorings estrcuturales en base a estos dos ultimos puntos, mejorando toda la funcionalidad.

Se incluye un nuevo modulo utils para poner todas las validaciones del modelo.

Module Exports

Se implementa una nueva clase heredando de Dry::CLI::Commands para los comandos del modulo exports. Se implementa usando un argumento para la fecha y una opcion para profesional.

Se crea un directorio exports en la raiz y se hacen los autoloads necesarios en Polycon.

Se elige Prawn Table para hacer las exportaciones de las grillas de los turnos.

Tests

Para correr los tests, ejecutar ruby test/spec.rb en el root del proyecto.

Entrega 3

 Rails

Se borra la app CLI, mantendiendo lo minimo. Se crea una nueva aplicacion rails en la raiz "Polycon".

Usuarios

Se implementa un modelo de Usuarios. Se deja en views passwords y sign_up por las dudas de implementar mas funcionalidad. Por la misma razon se elige la opcion :trackable, ya que podria ser util a futuro.

 Gemas

 Base de Datos

Se utiliza sqlite3 para todos los ambientes por facilidad, con posibilidad de utilizar mysql2 mas adelante dado el tiempo.

 Autenticacion y Autorizacion

Se utilizan las gemas devise para autenticacion y cancancan para autorizacion. Se permite solo al usuario Admin acceder al CRUD de usuarios. Se crea una contraseña pero luego al editar no se edita (hay restricciones). A futuro se puede permitir cambiar el perfil de cada usuario por ese mismo usuario y permitir cambio de contraseña.

 Validacion de fechas

Se utiliza la gema validates timeliness para validacion de fechas en los modelos. Se valida que los turnos se hagan adentro de un rango de horarios y tambien que no sean durante los fines de semana.

 Rest-Client

Se utiliza la gema rest-client como ayuda para popular la base de datos con un API.

Will Paginate

Se utiliza una gema para paginacion del listado de todos los turnos, para poder navegarlos mas facilmente.

Queda pendiente algun tipo de filtrado sobre el mismo listado. Posiblemente un filtrado por fecha, ya que por profesionales se puede ir directamente al profesional y ver sus turnos.

Whenever (no implementada)

Se considera utilizaren algun momento la gema Whenever para elminar turnos antiguos, aunque no se considera prioritario, ya que quizas se quiere mantener esa informacion en el sistema.

Exports

Se agregan rutas, modelo, controlador y vistas para facilitar la exportacion de las grillas. Se refactoriza la logica de exportacion y se saca afuera algunos metodos en Utils. Se crea un formulario y se hacecn las validaciones en el modelo usando ActiveModel. Al inicializar el modelo Export se crean los objetos de fecha y de profesional correspondientes.

Estilos

Se agrega bootstrap y se modifican algunos estilos usando sass (styles.scss en assets).

Notas

Preguntas Entrega 1

• herencia de errores en la jerarquia de namespaces
• separacion utils de storage para el futuro
• como usar options en dry::cli
• como hacer monkey patching dentro de un programa asi? (agregar funcionalidad a Dry::Files)
• Porque no se rescatan todos los argument errors para algunos metodos a pesar de estar en el rescue
• ver adonde hacer el save de appointments / profesionals, esta bien tenerlo afuera o volver a ponerlo en en create?

Preguntas Entrega 2

• Que libreria me conviene usar para exports?

    HAML or Slim - no hay mucha diferencia con ERB. Para PDF hasta ahora encontre Prawn y Origami Otras opciones de templating son Erector y Liquid. Tambien existe un wrapper de Handlebar.js para ruby.
  

• Crear PDFs en Ruby (prawn)

• Doumentacion PrawnTable

• Object Table puede ser una gema intermedia interesante https://github.com/lincheney/ruby-object-table

• hacer que el modulo de exports sea clase

• includes del mixin Prawn::Views quizas sea mas elegante/eficiente?

• como hacer que sea mas eficiente / elegante el agregar appointments a grillas? (linea muy larga, O(n^3))

Errores / Bugs

• Al renombrar la separacion de nombre y apellido no se hace correctamente

• Cuestiones de lanzamiento de excepciones

• Necesito preguntar en "create" si ya existe el profesional? solo estoy creando un objeto. Como mucho, en save() deberia haber ese chequeo

• Ordenar los appointment por fecha en el List sin fecha

• A futuro: Agarrar todos los appointment del sistema?

• Pasar cancel y reschedule a metodos de instancia

• From file tiene bug - se guardan las variables "correctamente" pero reescribe el to_s de tal manera que queda "notas" como representacion. Esto solo se ve si hago "puts appointment". Si hago "puts appointment.variable, imprime correctamente las variables.

• Chequear que la hora esta en un rango

• (guardar rango en clase no hardcoradearlo) para evitar bug de que se crea bien aunque no se pasen bien los horarios y quede 00-00. validar que los turnos sean entre el rango de las grillas (constante global?)

• validar que el telefono es un numero

• falta poder comparar los horarios poner un appointment en la grilla

• Para insertar appointments en la grilla semanal, comparar el dia de la semana del date con el dia de semana, se usa metodo de instancia de Date .wday, lunes es 1, martes es 2 etc.

• mejorar los estilos para las grillas

• mejorar la eficiencia para la generacion de las grillas

• en la semana, dos appointments que tienen el mismo dia y horario se pisan

• No se puede redireccionar luego send_data en la accion de exportar (exports#create). Esto no permite mostrar flash messages al usuario tampoco, y se traba el formulario. En un momento funciono (usando rutas resources, lo cual admitia una funcionalidad "oculta" de rails, por lo cual se puede hacer, pero sobraban rutas para el uso que yo le quiero dar al controlador).