rieles 0.0.3 → 0.0.4

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
+source "http://rubygems.org"
 
 # Specify your gem's dependencies in rieles.gemspec
 gemspec

data/README.rdoc

@@ -0,0 +1,40 @@
+= Rieles
+
+Incluye diversos archivos para trabajar en Español. El archivo de inflections para pluralizar y singularizar, el archivo de locale para los mensajes, y los templates erb para que el scaffold genere las vistas en Español.
+
+== Instalación
+
+Agrega esta línea al Gemfile de tu aplicación:
+
+    gem 'rieles'
+
+Después ejecuta:
+
+    $ bundle
+
+O instálala de la siguiente manera:
+
+    $ gem install rieles
+
+== Uso
+
+¡Listo! Con esto ya tienes los inflections y locales en Español. Puedes probar entrando a una consola:
+
+    $ rails console
+
+y obteniendo el plural o singular de alguna palabra en Español, por ejemplo:
+
+    'riel'.pluralize
+    'rieles'.singularize
+
+Igualmente, los mensajes de error de active record y las vistas generadas por el scaffold se mostrarán en Español
+
+== Personalización (recomendada)
+
+Se recomienda instalar los archivos de inflections, locales y la estructura de las vistas para adaptarlos a tus necesidades
+
+    $ gem generate rieles:install
+
+Si haces esto, la gema puede quedar en el grupo 'development', lo que significa que no será necesaria en producción. En el Gemfile debe aparecer como:
+
+    gem 'rieles', :group => :development

data/Rakefile

@@ -1,2 +1 @@
-#!/usr/bin/env rake
 require "bundler/gem_tasks"

data/app/views/application/_error_messages.html.erb

@@ -0,0 +1,17 @@
+<% if target.errors.any? %>
+  <% gender ||= target.class.name.ends_with?("a") ? "female" : "male" %>
+  <% model_name ||= target.class.name.underscore.humanize.downcase %>
+  <div id="error_explanation">
+    <h2>
+      <%= t('activerecord.errors.template.header', :count => target.errors.count, :model => model_name, :article => (gender == "male" ? "El" : "La")) %>
+    </h2>
+    <%= t('activerecord.errors.template.body') %>
+    <ul>
+      <% target.errors.full_messages.each do |msg| %>
+        <li>
+        <%= msg %>
+        </li>
+      <% end %>
+    </ul>
+  </div>
+<% end %>

data/lib/config/initializer/inflections.rb

@@ -1,28 +1,144 @@
+# encoding: UTF-8
 # Be sure to restart your server when you modify this file.
 
+##############################################################################
+# Inflections para trabajar en Español.
+# Por omisión, rails obtiene el singular y el plural según las reglas en
+# Inglés. La regla más básica consiste en agregar una 's' al final de la
+# palabra al obtener su plural, y eliminar la 's' al final para obtener el
+# singular. En español, esta regla se cumple la mayoría de las veces, pero no
+# siempre, por lo que es necesario especificar algunas más para las
+# excepciones.
+#
+# Las reglas para la formación del plural en Español son muy completas (y
+# complejas), en algunas ocasiones dependen de la acentuación. No se pretende
+# contemplar todas las posibilidades, sólo las más comunes.
+##############################################################################
+
 ActiveSupport::Inflector.inflections do |inflect|
+
+  # La regla básica en Español es similar al Inglés, el plural de las palabras 
+  # terminadas en vocal se obtiene agregándole una 's' al final. Sin embargo, 
+  # para formar correctamente el plural de palabras como doctor, camion, 
+  # universidad o pastel, se aplica una regla distinta: las palabras que 
+  # terminen con r, n, d, l se convierten a plural agregando la sílaba "es", 
+  # de otra forma, el plural se obtendrían como doctors, camions, universidads 
+  # y pastels.
   inflect.plural(/([rndlj])([A-Z]|_|$)/, '\1es\2')
   inflect.plural(/([aeiou])([A-Z]|_|$)/, '\1s\2')
+
+  # Las reglas anteriores funcionan incluso cuando son palabras compuestas por
+  # dos o más palabras, siempre y cuando, todas sean del mismo tipo, es decir,
+  # que ambas terminen con r, n, d o l, o bien, que ambas terminen en vocal;
+  # por ejemplo "doctor_operacion", o "libro_revista", serán pluralizadas
+  # correctamente a "doctores_operaciones" y "libros_revistas" respectivamente.
+  # Sin embargo, si las palabras no son del mismo tipo, la pluralización no
+  # ocurre correctamente. Por ejemplo, "autor_libro" es pluralizado como
+  # "autor_libros", y "paciente_doctor" es pluralizado como
+  # "paciente_doctores". Esto sucede porque al pluralizar, rails aplica sólo
+  # la última regla que coincida y omite las demás.
+  # Para soportar palabras compuestas, es necesario agregar otras reglas.
   inflect.plural(/([aeiou])([A-Z]|_)([a-z]+)([rndlj])([A-Z]|_|$)/, 
                  '\1s\2\3\4es\5')
   inflect.plural(/([rndlj])([A-Z]|_)([a-z]+)([aeiou])([A-Z]|_|$)/, 
                  '\1es\2\3\4s\5')
-  inflect.plural(/(z)$/i, 'ces')
+  # Con estas reglas, ya se pueden traducir correctamente las palabras compuestas
+  # de dos palabras aunque no sean del mismo tipo.
+  # Se pueden agregar, de la misma manera, reglas para cuando se trate de tres
+  # palabras compuestas, pero esto significa tomar en cuenta más combinaciones.
+  # En la mayoría de los casos, creo que es suficiente con estas dos.
+
+  # Para obtener correctamente el plural de palablas como maiz => maices,
+  # pez => peces, las palabras terminadas en z se cambian la z por c, y
+  # se agrega "es"
+  inflect.plural(/z([A-Z]|_|$)$/i, 'ces\1')
+
+  #-----------------------------------------------------------------------------
 
+  # Para singularizar, generalmente basta con eliminar la 's' del final, pero
+  # palabras como doctores y universidades se convertirían erróneamente como
+  # doctore y universidade.
+  # Podemos agregar una nueva regla, cuando la palabra termina en "es", eliminar 
+  # esa sílaba, pero esto tampoco es del todo cierto, ya que funciona con 
+  # palabras como "doctores" o "camiones", porque su singular son "doctor" y 
+  # "camion", respectivamente. Sin embargo, hay otras palabras que se 
+  # convertirían erróneamente, como semestres, por ejemplo, que al eliminar la 
+  # sílaba "es" del final, se singularizaría como 'semestr'. Para evitar eso, se 
+  # obliga que la palabra que termina en "es" y venga precedida de r, n, d o l, 
+  # deba también ser precedida por una vocal.
+  # Para que la epresión no quede tan extensa, vamos a utilizar unas variables
+  # para almacenar parte de la misma. También nos servirá para no tener que
+  # repetir la mistra estructura.
+
+  # Primero, definimos las palabras que terminen en 'es', precedido de r, n, d, 
+  # l o j, precedido de una vocal.
   final_plural_rndlj = /([aeiou][rndlj])es([A-Z]|_|$)/
-  final_plural_vocal = /((?<![aeiou][rndlj])[aeiou])s([A-Z]|_|$)/
+  # Después, definimos las palabras que terminen en vocal seguida de una 's'. En 
+  # caso de que esa vocal sea la e, entonces no debe ser precedida de alguna 
+  # combinación de vocal + r, n, d, l o j.
+  final_plural_vocal = /((?<![aeiou][rndlj])e|a|i|o|u)s([A-Z]|_|$)/
+  # Lsas palabras compuestas serán las siguientes: la primera palabra es con r,
+  # n, d, l o j, seguida de una palabra terminada en vocal. La segunda palabra
+  # compuesta, será al revés.
   palabra_compuesta_1 = /#{final_plural_rndlj}([a-z]+)#{final_plural_vocal}/
   palabra_compuesta_2 = /#{final_plural_vocal}([a-z]+)#{final_plural_rndlj}/
 
-  inflect.singular(/(ia)$/i, '\1')
+  # las palabras terminadas en ia ya están en singular
+  inflect.singular(/(ia)([A-Z]|_|$)$/i, '\1')
+
+  # Utilizando las variables creadas anteriormente, se generan las nuevas reglas
+  # para obtener el singular de las palabras sencillas y compuetas que terminen
+  # tanto en vocal, como en r, n, d, l, o j.
   inflect.singular(final_plural_rndlj, '\1\2')
   inflect.singular(final_plural_vocal, '\1\2')
   inflect.singular(palabra_compuesta_1, '\1\2\3\4\5')
   inflect.singular(palabra_compuesta_2, '\1\2\3\4\5')
+
+  # Para singularizar palabras con 'ces', como 'maices'
   inflect.singular(/ces$/, 'z')
-  
+
+  #-----------------------------------------------------------------------------
+
+  # Las palabras en singular que terminan con s son un caso especial, ya que 
+  # rails infiere que ya están en plural, lo cual es falso. Por ejemplo, pais.
+  # Es necesario indicar que el plural de pais es paises y viceversa. Esto se
+  # puede hacer declarándolo como irregular:
   inflect.irregular 'pais', 'paises'
+  # Pero es necesario agregar otra regla. Pais termina en s, pero ya está en
+  # singular, por lo que hay que indicarle a rails que no elimine la s final.
   inflect.singular /(pais)([A-Z]|_|$)/, '\1\2'
 
+  # Ejemplos cuyo plural y singular sea el mismo
   inflect.uncountable %w( campus lunes martes miercoles jueves viernes )
+
+  #-----------------------------------------------------------------------------
+
+  # Otros ejemplos de palabras irregulares
+  # En ocasiones, quisiéramos aplicar reglas específicas que no cumplen con las
+  # generales. Por ejemplo, si a estas alturas tratamos de obtener el plural de
+  # "hermano_de_sangre", el resultado sería "hermanos_des_sangres", así que,
+  # para estos casos, es necesario agregar reglas para indicar estos
+  # comportamientos 'irregulares'.
+
+  #inflect.irregular 'hermano_de_sangre', 'hermanos_de_sangre'
+  #inflect.irregular 'HermanoDeSangre', 'HermanosDeSangre'
+
+  # NOTA: es necesario indicar los dos modos (underscore y camelcase) porque el
+  # método irregular no soporta expresiones regulares
+
+  # Caso especial en el que la última palabra termina con 's' desde su versión
+  # en singular (caso similar al de pais, pero en esta ocasión, con palabras
+  # compuestas)
+
+  #inflect.singular 'calificacion_matematicas', 'calificacion_matematicas'
+  #inflect.singular 'CalificacionMatematicas', 'CalificacionMatematicas'
+  #inflect.irregular 'calificacion_matematicas', 'calificaciones_matematicas'
+  #inflect.irregular 'CalificacionMatematicas', 'CalificacionesMatematicas'
+
+  # NOTA: por claridad, se indican los dos modos (underscore y camelcase)
+  # porque el método irregular no soporta expresiones regulares, aunque en el
+  # caso del singular sí, por lo que se puede escribir también de la siguiente
+  # manera:
+  #inflect.singular /([Cc])(alificacion)(_m|M)(atematicas)/, '\1\2\3\4'
+
 end

data/lib/rieles/version.rb

@@ -1,3 +1,3 @@
 module Rieles
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/rieles.gemspec

@@ -16,5 +16,5 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = Rieles::VERSION
 
-  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'generator_spec'
 end

data/spec/inflections_spec.rb

@@ -4,11 +4,11 @@ require 'rieles'
 
 describe 'Inflections' do
   def singulares
-    %w(riel camion hospital universidad reloj semestre mesa calle)
+    %w(riel camion hospital universidad reloj semestre mesa ave bola materia)
   end
 
   def plurales
-    %w(rieles camiones hospitales universidades relojes semestres mesas calles)
+    %w(rieles camiones hospitales universidades relojes semestres mesas aves bolas materias)
   end
 
   describe 'Pluralizaciones' do
@@ -29,6 +29,7 @@ describe 'Inflections' do
     it 'debe pluralizar casos especiales' do
       'pais'.pluralize.should == 'paises'
       'maiz'.pluralize.should == 'maices'
+      'materia'.pluralize.should == 'materias'
     end
 
     it 'no debe pluralizar palabras que ya estén en plural' do
@@ -36,7 +37,7 @@ describe 'Inflections' do
       'camiones_grandes'.pluralize.should == 'camiones_grandes'
       'universidades_hospitales_doctores'.pluralize.should == 'universidades_hospitales_doctores'
       'paises'.pluralize.should == 'paises'
-      'lunes'.singularize.should == 'lunes'
+      'lunes'.pluralize.should == 'lunes'
     end
   end
 
@@ -62,6 +63,7 @@ describe 'Inflections' do
     it 'debe singularize casos especiales' do
       'paises'.singularize.should == 'pais'
       'maices'.singularize.should == 'maiz'
+      'materias'.singularize.should == 'materia'
     end
 
     it 'no debe singularizar palabras que ya estén en singular' do
@@ -70,6 +72,7 @@ describe 'Inflections' do
       'universidad_hospital_doctor'.singularize.should == 'universidad_hospital_doctor'
       'pais'.singularize.should == 'pais'
       'lunes'.singularize.should == 'lunes'
+      'materia'.singularize.should == 'materia'
     end
   end
 end

data/spec/lib/generators/rieles/install_generator_spec.rb

@@ -0,0 +1,25 @@
+# encoding: UTF-8
+require 'rails/all'
+require "generator_spec/test_case"
+require 'generators/rieles/install_generator'
+
+describe Rieles::InstallGenerator do
+  include GeneratorSpec::TestCase
+  destination File.expand_path("../../tmp", __FILE__)
+
+  before(:all) do
+    prepare_destination
+    run_generator
+  end
+
+  it "crea los archivos de inflections, el locale en español, y los templates del scaffold" do
+    assert_file "config/initializers/inflections.rb", File.read('lib/config/initializer/inflections.rb')
+    assert_file "config/locales/es.yml", File.read('lib/config/locales/es.yml')
+    assert_file "lib/templates/erb/scaffold/new.html.erb", File.read('lib/templates/erb/scaffold/new.html.erb')
+    assert_file "lib/templates/erb/scaffold/show.html.erb", File.read('lib/templates/erb/scaffold/show.html.erb')
+    assert_file "lib/templates/erb/scaffold/edit.html.erb", File.read('lib/templates/erb/scaffold/edit.html.erb')
+    assert_file "lib/templates/erb/scaffold/index.html.erb", File.read('lib/templates/erb/scaffold/index.html.erb')
+    assert_file "lib/templates/erb/scaffold/_form.html.erb", File.read('lib/templates/erb/scaffold/_form.html.erb')
+    assert_file "app/views/application/_error_messages.html.erb", File.read('app/views/application/_error_messages.html.erb')
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rieles
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,10 +9,10 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-29 00:00:00.000000000 Z
+date: 2012-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: generator_spec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -38,9 +38,9 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
-- LICENSE
-- README.md
+- README.rdoc
 - Rakefile
+- app/views/application/_error_messages.html.erb
 - lib/config/initializer/inflections.rb
 - lib/config/locales/es.yml
 - lib/generators/rieles/USAGE
@@ -54,6 +54,7 @@ files:
 - lib/templates/erb/scaffold/show.html.erb
 - rieles.gemspec
 - spec/inflections_spec.rb
+- spec/lib/generators/rieles/install_generator_spec.rb
 homepage: ''
 licenses: []
 post_install_message: 
@@ -80,3 +81,4 @@ specification_version: 3
 summary: Instala inflections, locales y templates de scaffold para trabajar en Español.
 test_files:
 - spec/inflections_spec.rb
+- spec/lib/generators/rieles/install_generator_spec.rb

data/LICENSE

@@ -1,22 +0,0 @@
-Copyright (c) 2012 Azarel Doroteo Pacheco
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,29 +0,0 @@
-# Rieles
-
-TODO: Write a gem description
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'rieles'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install rieles
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request