Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

688 lines (523 sloc) 41.552 kB

MundoPepino

¡Bienvenidas y bienvenidos al MundoPepino!

MundoPepino es un conjunto de pasos genéricos para testear una aplicación Rails utilizando Cucumber.

¿Por qué un MundoPepino?

Expresar el comportamiento de una aplicación utilizando lenguaje natural tiene que lidiar con el hecho de que una misma frase puede ser expresada de muchas formas diferentes. Este hecho puede conducirnos fácilmente hacia una explosión de definiciones que dificulte su mantenimiento y, por ende, el de la aplicación en la que son utilizadas.

Al mismo tiempo existen expresiones que son de uso frecuente cuando describimos una aplicación, sobre todo si para ello empleamos un estilo imperativo (como pueden ser por ejemplo las interacciones que realizamos desde un navegador). MundoPepino es un intento de definir e implementar dichas expresiones comunes de tal forma que sólo nos preocupemos por aquellas que, por necesidad o conveniencia, consideremos específicas de la aplicación que estamos desarrollando.

Por otro lado, cuando el idioma utilizado no es inglés es necesario evitar las posibles ambigüedades que genera la traducción de nuestra aplicación. Para posibilitar un lenguaje ubicuo, MundoPepino fuerza la vinculación de las distintas partes de la aplicación (modelos, atributos, acciones y rutas) con los términos con los que nos referimos a las mismas desde nuestras características/features.

Recursos

Toma de contacto

sudo gem install mundo-pepino
rails mi_app; cd mi_app
script/generate cucumber
script/generate mundo_pepino
script/generate caracteristica Orchard Huerto name:string:nombre area:integer:área longitude:string:longitud latitude:string:latitud used:boolean:usado
script/generate scaffold Orchard name:string area:integer longitude:string latitude:string used:boolean
rake db:migrate
rake caracteristicas

En este punto deberíamos obtener dos errores, ambos debidos a que el scaffold genera las vistas en inglés y el generador de caracteristica los espera en castellano. El primero es el botón "Create" y el segundo el enlace "Destroy":

$EDITOR app/views/orchards/index.html.erb # "Borrar" en lugar de "Destroy"
$EDITOR app/views/orchards/new.html.erb # "Crear" en lugar de "Create"
rake caracteristicas

Ahora sí, los escenarios deberían ser válidos, sin errores ni definiciones pendientes. Para tener precargado el entorno utilizando Spork bastaría con añadir --spork al script/generate cucumber y meter la opción --drb dentro del profile y/o de la tarea de rake.

El generador mundo_pepino nos prepara el entorno para utilizar las definiciones de MundoPepino sin copiarnos las mismas en features/steps_definitions, cargándolas directamente desde su código. Existe otro generador equivalente llamado mundo_pepino_steps que hace lo mismo pero copiando dichas definiciones dentro de features/steps_definitions.

La intención del generador de características es más didáctica que pragmática. Ofrece un ejemplo simple que podemos toquetear para probar el MundoPepino. Por otro lado se limita a hacer exactamente lo mismo que hace generate feature de Cucumber, exceptuando el hecho de que no genera un fichero de definiciones específicas para la nueva caracteristica (ya que las utilizadas están comprendidas dentro de las definiciones genéricas ya implementadas en MundoPepino).

El primer paso del primer escenario generado por caracteristica en el fichero features/gestion_de_huertos.feature es la siguiente:

Dado que visito la página de nuevo/a Huerto

Para que MundoPepino sepa que cuando hablamos de Huerto nos estamos refiriendo al modelo Orchard es necesario realizar lo que llamamos un "mapeo de modelo". El generador de hecho nos lo ha metido en mundo_pepino_es_ES.rb:

MundoPepino.configure do |config|
  config.model_mappings = {
    /^huertos?$/i => Orchard
  }
  config.field_mappings = { ... }
  config.page_mappings = { ... }
end

De forma similar se pueden definir mapeos para los atributos (field_mappings, p.e /^usado$/i => :used) y las rutas de la aplicación (page_mappings, p.e. /^la portada$/ => "/").

Del mapeo de atributos lo más destacable es la convención de que, si no se le indica lo contrario, el nombre del campo que guarda el nombre de cualquier modelo es name. Este mapeo nos permite escribir frases como Dado que tengo un usuario llamado "Casimiro" sin necesidad de hacer referencia al nombre del campo en el que debe guardarse Casimiro.

Es recomendable para evitar problemas que los valores en el mapeo de atributos sean símbolos en lugar de cadenas ya que algunas factorias (p.e. FixtureReplacement) los quieren así.

Un poquito sobre la filosofía de MundoPepino

El objetivo de MundoPepino es que escribir las características comunes de nuestra aplicación sin preocuparnos por su implementación e intentando recoger las distintas formas de expresar cada concepto para reducir la necesidad de consultar su documentación.

Para lograr su cometido MundoPepino se apoya en tres pilares principalmente:

  • Definir convenciones generales que reduzcan el número de posibilidades de expresar un paso.
  • Aprovechar toda la potencia de las expresiones regulares para que la definición de un paso capture el mayor número de posible formas de expresarlo.
  • Uso indiscriminado de metaprogramación de cara a reducir el código necesario para implementar sus pasos.

El uso de expresiones regulares complejas puede dificultar la lectura y comprensión de las definiciones de los pasos. Algo similar ocurre con el uso de metaprogramación en su implementación. La metaprogramación también puede empeorar el feedback que obtenemos cuando no se está cumpliendo una expectativa.

MundoPepino vive con estos inconvenientes porque confía en que merezcan la pena a medio/largo plazo, pero comprende y respeta que OtrosMundos ataquen el problema con una visión completamente distinta. Con un ejemplo se ve mejor parte de los pros y contras de MundoPepino. Cucumber genera, entre otros, los siguientes pasos en webrat_steps.rb:

Then /^I should see "([^\"]*)"$/ do |text|
  response.should contain(text)
end
Then /^I should see "([^\"]*)" within "([^\"]*)"$/ do |text, selector|
  within(selector) do |content|
    content.should contain(text)
  end
end

Similares a estas dos definiciones, en webrat_steps.rb hay otras dos que niegan lo que estas afirman. Similares a esas cuatro (las dos de arriba más sus negaciones), hay también otras cuatro que comprueban la existencia de una expresión regular en lugar de un texto concreto. Código y expresiones regulares sencillas, pero un total de ocho definiciones para hacer prácticamente lo mismo en todas ellas.

Para resolver lo mismo que resuelven esas ocho definiciones MundoPepino tiene sólo una definición:

Entonces /^(#{_veo_o_no_}) el texto (.+?)(?: #{_dentro_de_} ['"]?(.+?)["']?)?$/i do |should, text, selector|
  within selector || 'html' do
    response.send shouldify(should), contain(text.to_unquoted.to_translated.to_regexp)
  end
end

Dicha definición nos permite escribir veo el texto, debo ver el texto y debería ver el texto (así como sus correspondientes negaciones). Además, si optamos por buscar una expresion regular en lugar de texto, dicha expresión puede llevar modificadores de modo (por ejemplo /i para que ignore mayúsculas y minúsculas), algo que no es posible con las actuales definiciones presentes en webrat_steps.rb.

Pero lo más importante, el hecho de que sea DRY nos permite añadir mejoras más cómodamente. Por ejemplo, añadir debería estar viendo el texto como otra forma de expresar este paso consistiría en añadir deber[íi]a estar viendo en la definición del fragmento de expresión regular _veo_o_no_:

def _veo_o_no_
  '(?:no )?(?:veo|debo ver|deber[ií]a ver|deber[íi]a estar viendo)'
end

Y, por el mismo precio, resulta que al haber modificado _veo_o_no_ todos los pasos que lo utilicen tendrán también esta nueva forma de ser expresados.

Primera convención y como saltársela: campo name para el nombre en todos los modelos

Como acabamos de comentar:

Dado que tengo un usuario llamado "Casimiro"

MundoPepino, por convención, intentará guardar "Casimiro" en el campo name del modelo contra el que esté mapeado "usuario". Vamos a tirar de imaginación y continuemos asumiendo que dicho modelo es User.

Si queremos saltarnos la convención y que "Casimiro" se guarde en el campo login tendremos que indicarlo con un mapeo de atributo similar al siguiente:

config.model_mappings = {
  /^User::name$/ => :login
}

Si lo que nos interesa es cambiar la convención globalmente, es decir, que siempre se utilice otro nombre de campo para el nombre, simplemente tendriamos que quitar el modelo y los dos dos puntos del mapeo anterior. Por ejemplo, si queremos que dicho nombre de campo fuese title sería algo como:

config.model_mappings = {
  /^name$/ => :title
}

Relación con modelo utilizando un nombre que no se corresponde con el mismo

Con un ejemplo se entiende mejor, creo. Tenemos un modelo User y un modelo Garden y este último "belongs_to :author, class_name => 'User'", de tal forma que a_garden.author nos devuelve un User.

Bien, pues para que la siguiente característica funcione correctamente:

Dado que tenemos un usuario llamado "Fidel"
   Y que tenemos un jardín cuyo autor es "Fidel"

Tengo que meter los siguentes mapeos en nuestro entorno:

  • En el mapeo de modelos (model_mappings):

    /^autor(es)?$/i => User

  • En el mapeo de campos (field_mappings):

    /^autor(es)?$/i => :author

  • Un mapeo adicional entre el nombre del campo en inglés y su modelo asociado (relation_model_mappings):

    'author' => User

Para una relación has_many en la que se utilice :class_name hay que proceder de la misma manera.

Definiciones implementadas en MundoPepino

Cada definición existente en MundoPepino tiene al menos un escenario que comprueba:

  • por un lado que la expresión regular machea las posibles formas de expresarla,

  • y por otro que la implementación lleva a cabo lo que se supone que debe hacer.

Para todos los escenarios podríamos tener una narrativa genérica que expresase algo como lo siguiente:

Característica: implementación de pasos habituales
  Para escribir sólo la definición de los pasos específicos de mi proyecto
  Como usuario de Cucumber
  Quiero tener los pasos más habituales definidos, implementados y bien documentados

Cada definición ha sido separada en un fichero .feature específico para poder enlazarlas con markdown desde este README. La característica features/mundo-pepino.feature pretente ser todo lo contrario, un compendio de escenarios que muestren las posibilidades que ofrece más alla de una definición concreta (la aplicación que MundoPepino utiliza para correr estos tests se encuentra en features/support/app).

Como convención general, aunque MundoPepino pretende ser lo más flexible posible en general, y con las comillas en particular, los nombres correspondientes a modelos y campos pueden ir sin comillas pero los valores deben ir entre comillas (simples o dobles). Por ejemplo:

Dado que tenemos un artículo que tiene como título "Título del artículo"

En el ejemplo, "artículo" y "título" hacen referencia a un modelo y a un campo respectivamente y no van entre comillas (aunque podrían ir si quisiéramos) mientras que "Título del artículo" es el valor que se asignará en "título" y como tal va entrecomillado (y si quitásemos sus comillas la expresión no sería reconocida o lo sería incorrectamente).

MundoPepino soporta el uso de claves I18n en lugar de literales "a pincho" (o "hardcoded") en la mayoría de interacciones con el navegador (p.e. "Cuando pincho en el botón app.send" en lugar de "Cuando pincho en el botón 'Enviar'") así como en las comprobaciones de existencia de textos (p.e. "Debería ver el texto 'activerecord.models.user'" en lugar de "Debería ver el texto 'Usuario'").

Se puede utilizar la interpolación separando el hash con los parámetros de la clave con una coma sin espacios. Por ejemplo:

Entonces debería ver la etiqueta H1 con el valor "app.users.new_friend,{:name => 'Lucas'}"

Dado el contexto (Givens)

Convenciones generales:

  • utilización de "que" para comenzar todas las definiciones para evitar falta de concordancia de género y número (p.e. "Dado que tenemos tres personas")
  • creación de nuevos recursos utilizando verbo tener en tercena persona plural (p.e. "Dado que tenemos tres lechugas")
  • asignación de valores con el verbo tener en tercera persona (p.e. "Dado que dichas Acelgas tienen como variedad Amarilla de Lyon")
  • todas las definiciones para "Cuando algo ocurre" (o Then's, ver más abajo) son válidas también como "Dado el contexto" incorporándoles el prefijo "que" (p.e. "Dado que visito la portada").

Estoy en una página (alias de Solicitud de una página)

ejemplos

Página específica opcionalmente indicada con un nombre coloquial
Dado que estoy en la portada
Página asociada a un recurso concreto
Dado que estoy en la página del huerto "H-01"
Página asociada al último recurso definido de un modelo concreto
Dado que estoy en la página de dicho huerto
Página asociada al último recurso definido
Dado que estoy en su página
Índice o listado de un recursos de un modelo
Dado que estoy en la página de Tomates
Página de creación de un recurso
Dado que estoy en la página de creación de Tomate
Página de edición de un recurso
Dado que estoy en la página de edición del huerto "H-01"
Página relativa a una visitada con anterioridad
Dado que estoy en la siguiente página

Creación de uno o varios registros asignándoles opcionalmente un nombre

Dado que tenemos Un Producto llamado "Acelgas" 

más ejemplos

Creación de uno o varios registros con un valor en un campo

Dado que tenemos un huerto cuya área es de "1200" metros cuadrados

más ejemplos

Creación de uno o varios recursos a partir de una step table

Dado que tenemos el siguiente Huerto:
       | nombre   | área | latitud  | latitud   | abono   |
       | Secano-1 | 35   | N 40° 44 | W 003° 48 | FSF-315 |

más ejemplos

Asignación de un valor en un campo de un recurso concreto

Dado que el Tomate "A" tiene como variedad "Raf"

más ejemplos

Asignación de valores desde una fit-table en un recurso concreto

 Y que el huerto "A" tiene:
   | longitud | latitud | area | bancal  |
   |     12   |    10   |  15  | patatas |

más ejemplos

Asignación de un valor en un campo del último (o últimos) recurso mencionado

Dado que dichas Acelgas tienen como Variedad "Gigante carmesí"

más ejemplos

Asignación simple a un campo has_many de un recurso concreto

Dado que el huerto "H-01" tiene dos bancales "Bancal de Acelgas y Bancal de Tomates"

más ejemplos (has_many estándar) - más ejemplos (has_many polimórfico) - más ejemplos (has_many through)

Asignación simple a un campo has_many del último recurso mencionado

Dado que dicho Huerto tiene Tres Bancales "Acelgas, Tomates y Pepinos"

más ejemplos (has_many normal) - más ejemplos (has_many polimórfico) - más ejemplos (has_many through)

Asignación en campo has_many de un recurso concreto desde una step-table

Dado que el huerto "H-01" tiene los siguientes bancales:
       | nombre | longitud | cultivo |  matas |
       |  A-01  |    12    | Patatas |     16 |
       |  A-02  |    12    | Tomates |     18 |

más ejemplos (has_many normal) - más ejemplos (has_many polimórfico) - más ejemplos (has_many through)

Asignación en campo has_many del último recurso mencionado desde una step-table

Dado que dicho Huerto tiene los siguientes Bancales:
       | nombre | longitud | cultivo |  matas |
       |  A-01  |    12    | Patatas |     16 |
       |  A-02  |    12    | Tomates |     18 |

más ejemplos (has_many normal) - más ejemplos (has_many polimórfico) - más ejemplos (has_many through)

Cuando algo ocurre (Whens)

Convenciones generales:

  • frases escritas en tiempo presente en primera persona del singular
  • todas las definiciones son válidas también para definir contexto (en "Dados" o "Givens") incorporándoles el prefijo "que" (p.e. "Dado que visito la portada").

Solicitud de página

ejemplos

Página específica opcionalmente indicada con un nombre coloquial
Cuando visito la portada
Página asociada a un recurso concreto
Cuando visito la página del huerto "H-01"
Página asociada al último recurso definido de un modelo concreto
Cuando visito la página de dicho huerto
Página asociada al último recurso definido
Cuando visito su página
Índice o listado de un recursos de un modelo
Cuando visito la página de Tomates
Página de creación de un recurso
Cuando visito la página de creación de Tomate
Página de edición de un recurso
Cuando visito la página de edición del huerto "H-01"
Página relativa a una visitada con anterioridad
Cuando visito la siguiente página

Pincho/pulso en un enlace

ejemplos

Indicando su texto (o id) opcionalmente dentro de un selector concreto
Cuando pulso el enlace "Volver" dentro de .navigation_links
Página específica opcionalmente indicada con un nombre coloquial
Cuando pulso el enlace a la portada
Página asociada a un recurso concreto
Cuando pulso el enlace a la página del huerto "H-01"
Página asociada al último recurso definido de un modelo concreto
Cuando pulso el enlace a la página de dicho huerto
Página asociada al último recurso definido
Cuando pulso el enlace a su página
Índice o listado de un recursos de un modelo
Cuando pulso el enlace a la página de Tomates
Página de creación de un recurso
Cuando pulso el enlace a la página de creación de Tomate
Página de edición de un recurso
Cuando pulso el enlace a la página de edición del huerto "H-01"
Página relativa a una visitada con anterioridad
Cuando pulso el enlace a la siguiente página

Pincho/pulso un bóton (submit)

Cuando pulso en el botón Enviar

más ejemplos

Pincho/pulso una serie de bótones y/o enlaces

Cuando pincho en los siguientes enlaces:
  | presentación        |
  | galería de huertos  |
  | cultivos de regadío |

más ejemplos

Adjunto un fichero (file)

Cuando adjunto el fichero "images/cucumber.jpg" en Fotografía actual

más ejemplos

Elijo una opción (radiobutton)

Cuando elijo "Tomates verdes"

más ejemplos

Marco (o desmarco) una casilla (checkbox)

Cuando marco "color verde"

más ejemplos

Relleno/completo un campo con un texto (text o textarea)

 Cuando completo 'nombre' con 'Wadus'

más ejemplos

Relleno/completo un campo (text o textarea) de un atributo anidado

 Cuando relleno el email del usuario 'Antonio' con 'wadus@example.com'

más ejemplos

Relleno/completo varios campos (text o textarea) desde una step-table

 Cuando completo:
   | Campo    | Valor    |
   | Nombre   | Lechuga  |
   | Color    | Verde    |

más ejemplos

Selecciono opción/opciones

Selecciono una opción de una lista (select)
 Cuando selecciono "Hortalizas" en el listado de "Tipos de cultivo"
Selecciono fecha y hora sin especificar en que campo
 Cuando selecciono 1 de septiembre de 1998, 12:46 como fecha y hora
Selecciono fecha y hora para un campo concreto
 Cuando selecciono 2 de mayo de 1998, 12:46 como fecha y hora de "Cosechado"
Selecciono una hora sin especificar en que campo
 Cuando selecciono 6:45PM como hora
Selecciono una hora para un campo concreto
 Cuando selecciono 2:45PM como hora del "café"
Selecciono fecha sin especificar en que campo
 Cuando selecciono 1 de septiembre de 1998 como fecha
Selecciono fecha para un campo concreto
 Cuando selecciono 2 de marzo de 2009 como fecha para el comienzo de la poda

más ejemplos

Borro el enésimo recurso desde la página de su índice (index)

 Cuando borro el Bancal en 6ª posición

más ejemplos

Entonces pasa (Thens)

Convenciones generales:

  • frases escritas en primera persona del singular (excepto comprobaciones en bbdd)
  • para expresar que algo es visible utiliza "veo" o "debo ver" (o "no veo" y "no debo ver")
  • las comprobaciones del contenido de la base de datos se escriben haciendo una referencia explícita a la misma en primera persona del plural ("tenemos en base de datos") o en tercera del singular ("tiene en base de datos"). Esta verbosidad es intencionada debido a que dichas comprobaciones están desaconsejadas, haciendo así menos limpio y un poco más costoso su uso.

Debería estar en una página

Distinguimos entre los seis tipos de página que tienen sentido aquí (todos excepto el de página relativa). ejemplos

Página específica opcionalmente indicada con un nombre coloquial
Entonces debo estar en la portada
Página asociada a un recurso concreto
Entonces debo estar en la página del huerto "H-01"
Página asociada al último recurso definido de un modelo concreto
Entonces debo estar en la página de dicho huerto
Página asociada al último recurso definido
Entonces debo estar en su página
Índice o listado de un recursos de un modelo
Entonces debo estar en la página de Tomates
Página de creación de un recurso
Entonces debo estar en la página de creación de Tomate
Página de edición de un recurso
Entonces debo estar en la página de edición del huerto "H-01"

Veo (o no) un texto opcionalmente dentro de un selector concreto

Entonces debo ver el texto "IVA incluido"

más ejemplos

Veo (o no) una serie de textos expresados en una step-table (sin cabeceras)

Entonces debo ver los siguientes textos:
 | Muestras de tomate       |
 | Restos de lechuga        |
 | Treinta kilos de melones |

más ejemplos

Veo (o no) una etiqueta/selector opcionalmente con un contenido concreto

Entonces no debo ver la etiqueta "div.title a" con el valor "Surco"

más ejemplos

Veo (o no) una etiqueta/selector con varios contenidos indicados en una step-table

Entonces no debo ver los siguientes textos dentro de la etiqueta "div.title a":
 | Surco   |
 | Lechuga |

más ejemplos

Veo (o no) varios selectores opcionalmente determinados valores (step-table)

Entonces debería ver los siguientes selectores:
         | Selector       | Valor                  |
         | h1             | Mundo Pepino           |

[más ejemplos]/mundo-pepino/tree/master/features/es_ES/veo-etiquetas-con-valores.feature

Veo (o no) un campo con un contenido concreto

Entonces debería ver el campo "nombre" con "Wadus"

[más ejemplos]/mundo-pepino/tree/master/features/es_ES/veo-campo-con-valor.feature

Leo (o no) un texto, quitando las etiquetas HTML

Entonces debo leer el texto "IVA incluido"

más ejemplos

Leo (o no), quitando las etiquetas HTML, una serie de textos expresados en una step-table

Entonces debo leer los siguientes textos:
 | Muestras de tomate       |
 | Restos de lechuga        |

más ejemplos

Veo (o no) un enlace a una página

ejemplos

Página específica opcionalmente indicada con un nombre coloquial
Entonces debo ver un enlace a la portada
Página asociada a un recurso concreto
Entonces debo ver un enlace a la página del huerto "H-01"
Página asociada al último recurso definido de un modelo concreto
Entonces debo ver un enlace a la página de dicho huerto
Página asociada al último recurso definido
Entonces debo ver un enlace a su página
Índice o listado de un recursos de un modelo
Entonces debo ver un enlace a la página de Tomates
Página de creación de un recurso
Entonces debo ver un enlace a la página de creación de Tomate
Página de edición de un recurso
Entonces debo ver un enlace a la página de edición del huerto "H-01"
Página relativa a una visitada con anterioridad
Entonces debo ver un enlace a la siguiente página

Veo marcada (o desmarcada) una casilla (checkbox)

Entonces veo marcado "Acepto las condiciones del servicio"

más ejemplos

Veo una tabla con determinados valores en sus celdas

Entonces veo la tabla "bancales" con el siguiente contenido:
  | nombre | longitud | cultivo |  matas |
  |  A-01  |    12    | Patatas |     16 |
  |  A-02  |    12    | Tomates |     18 |

más ejemplos

Veo un formulario con determinados campos convenientemente etiquetados

Entonces veo un formulario con los siguientes campos:
  | Etiqueta   | Tipo      |
  | Login      | textfield |
  | Contraseña | password  |
  | Entrar     | submit    |

más ejemplos

Tenemos en BBDD uno o más registros de un modelo opcionalmente con un nombre concreto

Entonces tenemos en la base de datos un Abono llamado "FSF-03"

más ejemplos

Tenemos en BBDD un valor en un campo de un registro concreto

Entonces el Huerto "H-02" tiene en base de datos como Área "2" hectáreas

más ejemplos

Tenemos en BBDD un valor en un campo del registro mencionando anteriormente

Entonces tiene en base de datos como Área "2" hectáreas

más ejemplos

Tenemos en BBDD una asociación has_many en un registro concreto

Entonces el Huerto "H-02" tiene en base de datos un Bancal "A"

más ejemplos

Tenemos en BBDD una asociación has_many en un registro mencionando anteriormente

Entonces tiene en base de datos un Bancal "B"

más ejemplos

Tenemos en BBDD un número concreto de registros en una asociación has_many de un registro padre concreto

Entonces el Huerto "H-02" tiene en base de datos tres Bancales

más ejemplos

Tenemos en BBDD un número concreto de registros en una asociación has_many de un registro mencionando anteriormente

Entonces tiene en base de datos siete Bancales

más ejemplos

Instalación

Como gema:

gem install mundo-pepino

Como plugin (ver dependencias más abajo):

script/plugin install git://github.com/nando/mundo-pepino.git

Dependencias

Si instalamos la gema junto con ella deberían quedar instaladas todas sus dependencias excepto Capybara y/o Webrat (ver más abajo).

Si instalamos mundo-pepino como plugin debemos tener instaladas las gemas o plugins de cucumber, cucumber-rails, webrat, rspec y rspec-rails. Por ejemplo, para instalar todas ellas como plugins:

gem install term-ansicolor treetop diff-lcs nokogiri # dependencias de Cucumber
script/plugin install git://github.com/aslakhellesoy/cucumber.git
script/plugin install git://github.com/aslakhellesoy/cucumber-rails.git
script/plugin install git://github.com/dchelimsky/rspec.git
script/plugin install git://github.com/dchelimsky/rspec-rails.git

Además necesitamos instalar la gema o plugin StringMapper:

gem install string-mapper

o

script/plugin install git://github.com/nando/string-mapper.git

Si hacemos uso de alguno de los pasos que hacen referencia a la selección de un mes como parte de una fecha en un formulario necesitamos que el método strftime devuelva en nombre del mes en castellano cuando se utilice "%B". Para conseguirlo, tenemos entre otras las siguientes opciones (ver más abajo):

  • instalar el módulo ruby-locale,
  • o redefinir la función strftime para lograr dicho comportamiento.

Capybara o Webrat

Para manejar los pasos que hacen referencia a interacciones del usuario con el navegador MundoPepino depende de Capybara o Webrat. Es necesario tener instalada alguna de dichas gemas y que además el entorno de Cucumber las cargue convenientemente (tal y como hace en el env.rb que genera generate cucumber).

La gema de MundoPepino no depende directamente de ninguna de dichas gemas y maneja esta dependencia en tiempo de ejecución, quejándose cuando lanzamos los tests sin que ninguna de ellas esté cargada en el entorno.

FixtureReplacement

De fábrica MundoPepino utiliza ActiveRecord para incorporar a la BBDD los datos que soliciten los escenarios.

Opcionalmente MundoPepino puede utilizar FixtureReplacement haciendo dicha tarea más simple y permitiéndo que los textos se centren en los objetivos de los escenarios sin preocuparse por el modelo de datos subyacente.

Para ello por un lado tenemos que instalar el plugin:

script/plugin install http://thmadb.com/public_svn/plugins/fixture_replacement2/
script/generate fixture_replacement

...y por otro, al final de mundo_pepino_es_ES.rb tenemos que incluir FixtureReplacement como módulo de nuestro mundo pepino (más sobre esto en A Whole New World):

class MiMundo < MundoPepino
  include FixtureReplacement
end

World do
  MiMundo.new
end 

FactoryGirl

Otra opción es utilizar FactoryGirl

Para ello por un lado tenemos que instalar la gema (para más información sobre FactoryGirl consultar (aquí)[http://github.com/thoughtbot/factory_girl/]):

gem install thoughtbot-factory_girl --source http://gems.github.com

...y por otro, al final de env.rb (que el generador de cucumber deja dentro del directorio features/support) tenemos que requerir la librería seguida de la definición de nuestras factorias:

require 'factory_girl'
require File.expand_path(File.dirname(__FILE__) + '/app/db/factories')

También se debe incluir un fichero donde se definan las factories a utilizar en nuestro mundo-pepino, como ejemplo consultar el fichero de factories que se encuentra en el directorio features/support/app/db/factories

Selección de un mes en formularios

Para los pasos que hacen referencia a la selección de un mes en una fecha la implementación actual (de Webrat y la extensión de MP para Capybara) busca en nuestro HTML un mes cuyo nombre sea el devuelto por strftime('%B') en una instancia de Time creada a partir de la fecha facilitada. En Ruby, si no hacemos nada para remediarlo, esto es sinónimo del nombre del mes de dicha fecha en inglés.

La opción más simple para resolver este problema es redefinir strftime para que devuelva el nombre del mes en el locale de la aplicación. Por ejemplo:

class Time
  alias :strftime_nolocale :strftime
  def strftime(format)
    format = format.dup
    format.gsub!(/%B/, I18n.translate('date.month_names')[self.mon])
    self.strftime_nolocale(format)
  end
end

Otra opción sería instalar ruby-locale. ruby-locale es un (viejo) módulo que añade soporte para locales en Ruby al que se hace referencia desde el wiki de Rails. Instalándolo en el sistema tendremos la posibilidad de que strftime('%B') devuelva el nombre del mes en castellano.

Para instalarlo nos bajamos su código fuente y lo compilamos e instalamos en el sistema:

ruby extconf.rb
make
sudo make install
irb
irb> require 'locale'
=> true
irb> Time.now.strftime('%B')
=> "January"
irb> Locale.setlocale(Locale::LC_TIME, "es_ES.UTF-8")
=> "es_ES"
irb> Time.now.strftime('%B')
=> "enero" 

Por último, para que los helpers de Rails relacionados con la selección de fechas muestren los meses en castellano es necesario hacer uso de la opción :use_month_names, pasándole en la misma un array con los nombres de los doce meses que deseamos utilizar. Por ejemplo, en algún punto de nuestra aplicación definimos el array con los meses con:

Meses = %w(enero febrero marzo abril mayo junio julio agosto septiembre octubre noviembre diciembre)

Y posteriormente en las vistas llamamos al helper con algo parecido a:

<%= pepino.datetime_select :harvested_at, :use_month_names => Meses %>

Uso

generate mundo_pepino

rails_root$ script/generate mundo_pepino
      exists  features/step_definitions
      create  features/step_definitions/mundo_pepino_es_ES.rb
      exists  lib/tasks
      create  lib/tasks/mundo_pepino.rake

En mundo_pepino_es_ES.rb tenemos lo siguiente:

require 'mundo_pepino/es_ES'    # Cargamos las definiciones en castellano
MundoPepino.configure do |c|
  c.models_to_clean = []        # Array con los modelos que serán limpiados 
                                # antes de lanzar cada escenario.
  c.model_mappings = {}         # Hash con el mapeo de los modelos a partir
                                # de sus equivalencias en castellano.
  c.field_mappings = {}         # Hash con el mapeo de los campos.
class MiMundo < MundoPepino     # Ejemplo de uso del MundoPepio con herencia. 
  # include FixtureReplacement  # FR listo para entrar en acción. Meter aquí 
  # def mi_funcion; ...; end    # las funciones específicas que necesitemos
end                             # desde nuestras definiciones.
Before do                       # La limpieza de modelos propiamente dicha... 
  MundoPepino.clean_models
end                             # ...se realizará antes de cada escenario.
                                # Finalmente le pedimos a Cucumber que
World(MiMundo)                  # utilice una instancia de nuestro mundo como
                                # ámbito local de nuestros escenarios.

Por otro lado mundo_pepino.rake añade una tarea llamada caracteristicas que lanza con la opción --language es todos los ficheros con extensión .feature que tengamos dentro del directorio caracteristicas.

generate caracteristica

Se trata del generador equivalente a script/generate feature de Cucumber:

$ script/generate caracteristica Orchard Huerto name:string:nombre area:integer:área used:boolean:usado
model_cleaning  added Orchard (Orchard.destroy_all call before each scenario)
model_mapping   added /huertos?$/i => Orchard
field_mapping   added /nombres?$/i => :name
field_mapping   added /áreas?$/i => :area
field_mapping   added /usados?$/i => :used
      create  caracteristicas/gestion_de_huertos.feature

El fichero gestion_de_huertos.feature tendría:

Característica: Gestión de Huertos
  Para [beneficio]
  Como [sujeto]
  Quiero [característica/comportamiento]

  Escenario: Añadir un/a nuevo/a Huerto
    Dado que visito la página de nuevo/a Huerto
    Cuando relleno nombre con "nombre 0"
         Y relleno área con "0"
         Y relleno usado con "true"
         Y pulso el botón "Crear"
    Entonces debería ver el texto "nombre 0"
           Y debería ver el texto "0"
           Y debería ver el texto "true"

  Escenario: Borrar Huerto
    Dado que tenemos los/las siguientes Huertos:
      |nombre|área|usado|
      |nombre 1|1|false|
      |nombre 2|2|true|
      |nombre 3|3|false|
      |nombre 4|4|true|
    Cuando borro el/la Huerto en la tercera posición
    Entonces debería ver una tabla con los siguientes contenidos:
      |nombre|área|usado|
      |nombre 1|1|false|
      |nombre 2|2|true|
      |nombre 4|4|true|

A diferencia de generate feature aquí no se crea un fichero step_definitions.rb con definiciones e implementaciones específicas ya que las mismas se encuentran dentro de las tratadas genéricamente dentro del MundoPepino.

License

Copyright 2008, The Cocktail Experience. Fernando García Samblas

This is free software released under the GPL License (see license agreement in COPYING).

Jump to Line
Something went wrong with that request. Please try again.