rspec-i18n 0.2.1 → 1.0.0

data/.gitignore

@@ -0,0 +1,13 @@
+pkg
+pkg/*
+doc
+coverage*
+tmtags
+.DS_Store
+.emacs-project
+*~
+email.txt
+tmp
+*.sw?
+spec/spec_files.txt
+tags

data/History.rdoc

@@ -1,3 +1,18 @@
+=== Version 1.0.0
+
+* enhancements
+  * Support for rspec 1.3
+  * Add the translation of following matchers: be_close, be_instance_of, 
+    be_kind_of, eql, equal, exist, have(have_exactly), have_at_least, 
+    have_at_most, include, match, raise_error(raise_exception), satisfy
+  * Add the translation of subject keywords(subject, its, should and should_not)
+  * Add the matchers and hooks in executable list keywords
+  * Removing the cucumber dependency and add term-ansicolor and    
+    terminal-table dependency
+  * Add the be predicates for the rspec 1.3
+  * Refactoring Parser::NaturalLanguage.get(SpecI18n.spec_language) 
+    duplications
+
 === Version 0.2.1
 
 This release has some bugfixes in the command_line executable
@@ -14,8 +29,8 @@ This release has improvements to the commandline and some fixes internals
 
 This is the first preview release of Rspec-i18n, a Internacionalization Development library for Ruby.
 
-* Added translation to all the base keywords(describe, it, should, should_not, 
+* Added translation to all the base keywords(describe, it, should, should_not,
   before(:each), before(:all), before(:suite), after(:each), after(:all),
   after(:suite))
 * Added a languages.yml. Will be translated to all languages.
-* Added a simple parser for the read the languages in languages.yml.
+* Added a simple parser for the read the languages in languages.yml.

data/License.txt

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2009 Tomás D'Stefano
+Copyright (c) 2009-2010 Tomás D'Stefano
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -1,5 +1,9 @@
 = Rspec-i18n
 
+* http://github.com/tomas-stefano/rspec-i18n/wikis
+* http://gemcutter.org/gems/rspec-i18n
+* http://rspec-i18n.lighthouseapp.com
+
 == Description
 
 The Rspec-i18n gem provide a easy way to write specs in any language you
@@ -11,8 +15,9 @@ But if you don't prefer that, you'll like the Rspec-i18n.
 
 == Synopsis
   
-Rspec-i18n will supports any language you want(See languages.yml file). This is 
-Portuguese(Brazil):
+Rspec-i18n will supports any language you want
+(See http://github.com/tomas-stefano/rspec-i18n/blob/master/lib/spec-i18n/languages.yml file). 
+This is Portuguese(Brazil):
     
     require 'spec'
     require 'spec-i18n'
@@ -26,7 +31,7 @@ Portuguese(Brazil):
 
     # In spec/pessoa_spec.rb
 
-	require 'spec_helper'
+    require 'spec_helper'
 	
     descreva Pessoa do
       antes(:de_cada) do
@@ -41,11 +46,17 @@ Portuguese(Brazil):
 
 == Examples
 
-See more examples in the examples folder
+See more examples in http://github.com/tomas-stefano/rspec-i18n/blob/master/examples/i18n
 
 == Listing the available languages
 
-    spec-i18n --language help (NOT YET IMPLEMENTED)
+    rspec-i18n --language help
+
+== Listing the available keywords for the language
+
+	rspec-i18n --language pt
+	
+	rspec-i18n --language es
 
 == Adding a new language or completing a existing one(based on Cucumber implementation)
 
@@ -53,7 +64,7 @@ See more examples in the examples folder
   2. Add your language keywords to languages.yml
   3. Commit and push your changes - then send a pull request at Github
 
-  ** OBS: Hints for better words in languages.yml are Welcome =D.
+** OBS: Hints for better words in languages.yml are Welcome =D.
 
 == Install
 

data/Rakefile

@@ -12,7 +12,7 @@ POST_MESSAGE = <<-POST_INSTALL_MESSAGE
 
 Thank you for installing rspec-i18n-#{SpecI18n::VERSION}
 Please be sure to read http://wiki.github.com/tomas-stefano/rspec-i18n/upgrading
-for important information about this release.
+for information about this release.
 
 Remember: 'TDD is a muscle. You have to exercise it.' =) (Brian Liles)
 
@@ -29,11 +29,13 @@ begin
     gemspec.homepage = "http://github.com/tomas-stefano/rspec-i18n"
     gemspec.authors = ["Tomas D'Stefano"]
 
-    gemspec.add_dependency('rspec', '>= 1.2.9')
-    gemspec.add_dependency('cucumber', '>= 0.5.3')
+    gemspec.add_dependency('rspec', '>= 1.3.0')
+    gemspec.add_dependency('terminal-table', '>= 1.4.2')
+    gemspec.add_dependency('term-ansicolor', '1.0.4')
 
     gemspec.add_development_dependency('rspec', '>= 1.2.9')
-    gemspec.add_development_dependency('cucumber', '>= 0.5.3')
+    gemspec.add_development_dependency('terminal-table', '>= 1.4.2')
+    gemspec.add_development_dependency('term-ansicolor', '1.0.4')
     
     gemspec.post_install_message = POST_MESSAGE
   end

data/TODO.txt

@@ -1,25 +1,24 @@
 == Refactoring
 
-* The SpecI18n::Parser::NaturalLanguage.get(SpecI18n.spec_language) is duplicated in 
-  some places - check a better way to implement this
 * Simplified more and more tests!
 * Find the right module for the example group specs(it/example) (I think =>
   Spec::Example::ExampleGroupMethods but I think I was wrong)
+* Need better hints for the 'its' word
 
 == Future
 
-* Translate all matchers
-* Translate subjects
 * Translate shared examples
+* Translate nil, true, false and empty.
 * Put a #language header in the spec_helper file (Cucumber Style) instead load from config(maintain the two options)
 * Create the directory features to test with Cucumber
+* Verifying if it's possible to translate error and success messages
 * Make the describe/it i18n available from a class 
 	
 	Example:
 	#	class PilhaSpec < Spec::ExampleGroup
 	#     descreva Pilha, "sem nenhum elemento"
 	#
-	#     antes
+	#     antes do
 	#       @pilha = Pilha.new
 	#     end
 	#
@@ -30,3 +29,4 @@
 	#   end
 	
 * Check a better way to manipulating the mocks and stubs for i18n (What do you think?)
+* Verify the following matchers: simple_matcher, wrap_expectation, respond_to, change and match_unless_raises.

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
-:major: 0
-:minor: 2
+:major: 1
+:minor: 0
 :build: 
-:patch: 1
+:patch: 0

data/examples/i18n/pt/person_spec.rb

@@ -1,5 +1,4 @@
 require 'rubygems'
-require 'spec'
 require 'spec-i18n'
 
 Spec::Runner.configure do |config|
@@ -7,23 +6,40 @@ Spec::Runner.configure do |config|
 end
 
 class Pessoa
-  attr_reader :idade
-  def initialize(nome, sobrenome, idade=0)
+  attr_accessor :idade
+  def initialize(nome, sobrenome, opcoes={})
     @nome = nome
     @sobrenome = sobrenome
-    @idade = idade
+    @idade = opcoes[:idade]
   end
   
   def nome_completo
     "#{@nome} #{@sobrenome}"
   end
+
+  def maior_de_idade?
+    return true if @idade >= 18
+    false
+  end
+
+  def pronto_para_votar?
+    maior_de_idade?
+  end
+
+  def pronto_para_dirigir?
+    maior_de_idade?
+  end
+
+  def autorizado_a_beber?
+    maior_de_idade?
+  end
 end
 
-# Silly Tests
+# Silly Tests for show to you how to use this library in portuguese language
 descreva Pessoa do
   
   antes(:de_todos) do
-    @pessoa = Pessoa.new("Tomás", "D'Stefano")
+    @pessoa = Pessoa.new("Homer", "Simpson")
   end
   
   antes(:de_cada) do
@@ -37,13 +53,102 @@ descreva Pessoa do
   depois(:de_cada) do
     @outras_pessoas = []
   end
-  
-  exemplo "deve retornar o nome completo" do
-    @pessoa.nome_completo.deve == "Tomás D'Stefano"
+
+  depois(:suite) do
+    @pessoas = []
   end
-  
-  especificar "a idade é opcional" do
-    Pessoa.new("Aaromn", "Monkey", 20).idade.deve == 20
+
+  exemplo 'deve ser uma instancia da classe Pessoa' do
+    @pessoa.deve ser_instancia_de(Pessoa)
+  end
+
+  exemplo 'deve incluir uma pessoa' do
+    @pessoas.deve incluir(@pessoa)
+  end
+
+  exemplo 'deve ser do tipo Pessoa' do
+    @pessoa.deve ser_do_tipo(Pessoa)
+  end
+
+  exemplo 'deve ter pelo menos uma pessoa' do
+    @pessoas.deve ter_no_minimo(1).items
+  end
+
+  exemplo 'deve ter exatamente duas pessoas' do
+    @pessoas << @pessoa
+    @pessoas.deve ter_exatamente(2).items
+  end
+
+  exemplo 'deve ter no maximo tres pessoas' do
+    @pessoas = []
+    @pessoas.deve ter_no_maximo(3).items
   end
   
+  contexto "Nome completo" do
+    
+    antes(:de_cada_exemplo) do
+      @pessoa = Pessoa.new("Tomás", "D'Stefano")
+    end
+  
+    exemplo "deve retornar o nome completo" do
+      @pessoa.nome_completo.deve ==("Tomás D'Stefano")
+    end
+    
+    exemplo 'nome completo não pode ser nulo' do
+      @pessoa.nome_completo.nao_deve ser_igual_a(nil)
+    end
+    
+  end
+
+  contexto "a idade" do
+      
+    antes(:de_todos_exemplos) do
+      @pessoa = Pessoa.new("Aaromn", "Monkey", :idade => 20)
+    end
+
+    especificar "deve ser opcional" do
+      @pessoa.idade.deve ser_igual_a(20)
+    end
+  end
+
+  contexto 'maior de idade' do
+    assunto { Pessoa.new('Aaron', 'Monkey', :idade => 18) }
+
+    exemplo "deve estar pronto para votar" do
+      deve estar_pronto_para_votar
+    end
+
+    exemplo "deve ser maior de idade" do
+      deve ser_maior_de_idade
+    end
+
+    exemplo "deve estar pronto para dirigir" do
+      assunto.deve estar_pronto_para_dirigir
+    end
+
+    exemplo "deve estar autorizado para beber =D" do
+      assunto.deve estar_autorizado_a_beber
+    end
+  end
+
+  contexto 'menor de idade' do
+    assunto { Pessoa.new('Aaron', 'Monkey', :idade => 17) }
+
+    exemplo "nao deve estar pronto para votar" do
+      nao_deve estar_pronto_para_votar
+    end
+
+    exemplo "nao deve ser maior de idade" do
+      nao_deve ser_maior_de_idade
+    end
+    
+    exemplo "nao deve estar pronto para votar" do
+      assunto.nao_deve estar_pronto_para_votar
+    end
+    
+    exemplo "nao deve estar autorizado para beber =(" do
+      assunto.nao_deve estar_autorizado_a_beber
+    end
+  end
+
 end

data/lib/spec-i18n/command_line/language_help_formatter.rb

@@ -1,7 +1,5 @@
-require 'cucumber'
-require 'cucumber/formatter/pretty'
-require 'cucumber/formatter/unicode'
-require 'cucumber/cli/language_help_formatter'
+require 'term/ansicolor'
+require 'terminal-table/import'
 require 'spec-i18n/parser'
   
 module SpecI18n
@@ -9,26 +7,81 @@ module SpecI18n
     class LanguageHelpFormatter
       
       class << self
+        include SpecI18n::Parser
+        include Term::ANSIColor
+        
+        String.class_eval do
+          include Term::ANSIColor
+        end
         
         # Cucumber print table is loading 
         # because I don't want reiventing the wheel
         #
         def list_languages_and_exit(io)
-          raw = SpecI18n::Parser::NaturalLanguage.list_languages
-          print_table io, raw, :check_lang => false
+          languages = list_languages
+          
+          languages_table = table do
+            self.headings = ['Language', 'Name', 'Native']
+            languages.each do |language|
+              add_row language
+            end
+          end
+          
+          print_table io, languages_table, :exit => true
         end
         
         def list_keywords_and_exit(io, lang)
-          language = SpecI18n::Parser::NaturalLanguage.get(lang)
-          raw = SpecI18n::Parser::NaturalLanguage.list_keywords(lang)
-          print_table io, raw, :incomplete => language.incomplete?
+          
+          language = NaturalLanguage.get(lang)
+          
+          keywords = list_basic_keywords(language)
+          
+          print_table io, table(nil, *keywords)
+          
+          advanced_keywords = list_advanced_keywords(io, language)
+          
+          print_table io, advanced_keywords, :exit => true
+        end
+        
+        def list_languages
+          languages = SpecI18n::SPEC_LANGUAGES.keys.sort.map do |lang|
+            [ lang, grep_value(lang, 'name'), grep_value(lang, 'native') ]
+          end
+        end
+        
+        def grep_value(lang, key)
+          SpecI18n::SPEC_LANGUAGES[lang][key]
+        end
+        
+        def list_basic_keywords(language)
+          NaturalLanguage::BASIC_KEYWORDS.map do |keyword|
+            words = language.keywords[keyword]            
+            [ keyword, words.split('|').join(' / ')] 
+          end
+        end
+        
+        def list_advanced_keywords(io, language)
+          NaturalLanguage::ADVANCED_KEYWORDS.map do |keyword|
+            language_keywords = [keyword]
+            language.keywords[keyword].map do |key, values|
+              language_keywords << [key, values.to_s.split('|').join(' / ')]
+            end
+            
+            keywords_table = table do
+              self.headings = [language_keywords.shift]
+              language_keywords.each do |keywords|
+                add_row keywords
+              end
+            end
+            
+            keywords_table
+            
+          end
         end
         
-        def print_table(io, raw, options)
-          table = Cucumber::Ast::Table.new(raw)
-          formatter = Cucumber::Cli::LanguageHelpFormatter.new(nil, io, options)
-          Cucumber::Ast::TreeWalker.new(nil, [formatter]).visit_multiline_arg(table)
-          Kernel.exit(0)
+        def print_table(io, raw, options={})
+          io.puts raw.to_s.send(options[:color] || :green).bold
+          Kernel.exit(0) if options[:exit]
         end
       end
       

data/lib/spec-i18n/command_line/options.rb

@@ -13,34 +13,35 @@ module SpecI18n
       def parse!(args)
         @args = args
         @args.extend(::OptionParser::Arguable)
-        
         @args.options do |opts|
-          opts.banner = [ "Usage: rspec-i18n [options] [LANGUAGE]", "",
-            "Examples:",
-            "rspec-i18n --language help",
-            "rspec-i18n --language pt"].join("\n")
-            
-          opts.on("-l LANGUAGE", "--language LANGUAGE", 
-            "List keywords for a particular language",
+          opts.banner = [ "Usage: rspec-i18n [options] [LANGUAGE]", "", "Examples:",
+            "rspec-i18n --language help", "rspec-i18n --language pt"].join("\n")            
+          opts.on("-l LANGUAGE", "--language LANGUAGE", "List keywords for a particular language",
             %{Run with "--language help" to see all languages}) do |language|
-            if language == 'help'
-              LanguageHelpFormatter.list_languages_and_exit(@output_stream)
-            else
-              LanguageHelpFormatter.list_keywords_and_exit(@output_stream, language)
-            end
+            print_languages(language)
           end
           opts.on_tail("-v", "--version", "Show version.") do
-            @output_stream.puts SpecI18n::VERSION
-            Kernel.exit(0)
+            print_and_exit(SpecI18n::VERSION)
           end
           opts.on_tail("-h", "--help", "You're looking at it.") do
-            @output_stream.puts opts.help
-            Kernel.exit(0)
+            print_and_exit(opts.help)
           end
         end.parse!
         self
       end
       
+      def print_languages(language)
+        if language == 'help'
+          LanguageHelpFormatter.list_languages_and_exit(@output_stream)
+        else
+          LanguageHelpFormatter.list_keywords_and_exit(@output_stream, language)
+        end
+      end
+      
+      def print_and_exit(message)
+        @output_stream.puts message
+        Kernel.exit(0)
+      end
     end
   end
 end

data/lib/spec-i18n/dsl/main.rb

@@ -8,7 +8,7 @@ module Spec
       # 
       # Register alias for the language specified
       def register_adverbs
-        language = SpecI18n::Parser::NaturalLanguage.get(SpecI18n.spec_language)
+        language = SpecI18n.natural_language
         @adverbs = language.dsl_keywords
         @adverbs.each do |key, values|
           values.map { |value| alias_method value, key }

data/lib/spec-i18n/example/before_and_after_hooks.rb

@@ -3,17 +3,16 @@ module Spec
     module BeforeAndAfterHooks
       
       def register_hooks
-        language = SpecI18n::Parser::NaturalLanguage.get(SpecI18n.spec_language)
+        language = SpecI18n.natural_language
         language.before_and_after_keywords.each do |key, values|
           values.map { |value| alias_method value, key }
         end
       end
   
       def before_parts(scope)
-        if SpecI18n.spec_language
-          language = SpecI18n::Parser::NaturalLanguage.get(SpecI18n.spec_language)
-          scope = grep_the_scope(scope, language.hooks_params_keywords)
-        end
+        
+        scope = grep_language_and_scope(scope) || scope
+        
         case scope
         when :each; before_each_parts
         when :all; before_all_parts
@@ -22,16 +21,22 @@ module Spec
       end
       
       def after_parts(scope)
-        if SpecI18n.spec_language
-          language = SpecI18n::Parser::NaturalLanguage.get(SpecI18n.spec_language)
-          scope = grep_the_scope(scope, language.hooks_params_keywords)
-        end
+        
+        scope = grep_language_and_scope(scope) || scope
+        
         case scope
         when :each; after_each_parts
         when :all; after_all_parts
         when :suite; after_suite_parts
         end
       end
+      
+      def grep_language_and_scope(scope)
+        if SpecI18n.spec_language
+          language = SpecI18n.natural_language
+          scope = grep_the_scope(scope, language.hooks_params_keywords)
+        end
+      end
 
       # Receive a String Scope and return the scope in english for
       # the rspec run the right method

data/lib/spec-i18n/example/example_group_methods.rb

@@ -3,7 +3,7 @@ module Spec
     module ExampleGroupMethods
       
         def self.register_example_adverbs
-          language = SpecI18n::Parser::NaturalLanguage.get(SpecI18n.spec_language)
+          language = SpecI18n.natural_language
           @adverbs = language.example_group_keywords
           @adverbs.each do |key, values|
             values.map do |value|

data/lib/spec-i18n/example/subject.rb

@@ -0,0 +1,29 @@
+module Spec
+  module Example
+    module Subject
+      module ExampleGroupMethods
+        # TODO: Removing Duplications
+        class << self
+          def register_subjects
+            language = SpecI18n.natural_language
+            subject_and_its_keywords = language.subject_keywords.merge(language.its_keywords)
+            subject_and_its_keywords.each do |key, values|
+              values.map { |value| alias_method value, key }
+            end
+          end
+        end
+      end
+      module ExampleMethods
+        class << self
+          def register_subjects
+            language = SpecI18n.natural_language
+            subject_and_expectation_keywords = language.subject_keywords.merge(language.expectation_keywords)
+            subject_and_expectation_keywords.each do |key, values|
+              values.map { |value| alias_method value, key }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/spec-i18n/example.rb

@@ -1,2 +1,3 @@
 require 'spec-i18n/example/before_and_after_hooks'
-require 'spec-i18n/example/example_group_methods'
+require 'spec-i18n/example/example_group_methods'
+require 'spec-i18n/example/subject'

data/lib/spec-i18n/expectations/extensions/kernel.rb

@@ -1,6 +1,6 @@
 module Kernel
   def register_expectations_keywords
-    language = SpecI18n::Parser::NaturalLanguage.get(SpecI18n.spec_language)
+    language = SpecI18n.natural_language
     @adverbs = language.expectation_keywords
     @adverbs.each do |key, values|
       values.map { |value| alias_method value, key }