caligrafo 0.1.1 → 0.1.2

data/.gitignore

@@ -3,3 +3,4 @@
 coverage
 rdoc
 pkg
+test/*.txt

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/caligrafo.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{caligrafo}
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Lucas de Castro"]
-  s.date = %q{2009-10-26}
+  s.date = %q{2009-10-30}
   s.description = %q{DSL para geração de arquivos texto.}
   s.email = %q{castro.lucas@gmail.com}
   s.extra_rdoc_files = [
@@ -25,8 +25,9 @@ Gem::Specification.new do |s|
      "VERSION",
      "caligrafo.gemspec",
      "lib/caligrafo.rb",
-     "test/arquivo_esperado.txt",
      "test/caligrafo_test.rb",
+     "test/formatador_test.rb",
+     "test/leitura_test.rb",
      "test/test_helper.rb"
   ]
   s.homepage = %q{http://github.com/lucasdecastro/caligrafo}
@@ -36,7 +37,9 @@ Gem::Specification.new do |s|
   s.summary = %q{DSL para geração de arquivos texto.}
   s.test_files = [
     "test/test_helper.rb",
-     "test/caligrafo_test.rb"
+     "test/caligrafo_test.rb",
+     "test/formatador_test.rb",
+     "test/leitura_test.rb"
   ]
 
   if s.respond_to? :specification_version then

data/lib/caligrafo.rb

@@ -2,6 +2,7 @@ module Caligrafo
   def self.included(base)
     base.instance_eval do
       include InstanceMethods
+      extend  ClassMethods
     end
   end
 
@@ -11,6 +12,231 @@ module Caligrafo
       arquivo.criar_arquivo
       nome_arquivo    
     end
+
+    def escrever_arquivo(nome, &bloco)
+      estrutura = self.class.instance_variable_get "@arquivo"
+       
+      File.open(nome, 'w') do |file|
+        file.extend ArquivoExtensao
+        file.estrutura = estrutura
+        file.linha = ''
+        file.numero_linha = 1
+        file.objeto = self
+        file.bloco = bloco
+
+        bloco.call file
+      end
+
+      nome
+    end
+
+    def ler_arquivo(nome, &bloco)
+      estrutura = self.class.instance_variable_get "@arquivo"
+      raise 'A estrutura nao foi definida' if estrutura.nil?
+
+      File.open(nome, 'r') do |file|
+        while linha = file.gets
+          linha.extend LinhaArquivoExtensao
+          linha.arquivo = estrutura
+          linha.descobrir_secao
+
+          bloco.call linha
+        end
+      end
+    end
+  end
+
+  module ArquivoExtensao
+    attr_accessor :objeto, :indice, :linha, :numero_linha, :bloco, :estrutura
+
+    def secao(nome, &bloco)
+      if self.objeto.respond_to? nome
+        objetos = self.objeto.send nome
+        objetos = [objetos] if objetos.nil? or !objetos.is_a?(Array)
+      else
+        objetos = [objeto]
+      end
+
+      objetos.each_with_index do |objeto, index|
+        self.objeto = objeto
+        self.indice = index
+
+        bloco.call objeto
+        nova_linha
+      end
+
+      self.objeto = self.bloco.binding.send :eval, "self"
+    end
+
+    def nova_linha
+      self.linha = ''
+      self.numero_linha += 1
+      self.print "\n"
+    end
+
+    def imprimir(*args)
+      campo = Campo.new(*args)
+      valor_campo = campo.valor_para(objeto)
+
+      posicao = campo.posicao
+      if posicao
+        valor_campo = valor_campo.rjust(posicao - self.linha.size + 1)
+      end
+
+      self.linha << valor_campo
+      self.print valor_campo
+    end
+  end
+
+  module LinhaArquivoExtensao
+    attr_accessor :arquivo
+
+    def secao
+      if @secao
+        @secao.nome
+      end
+    end
+     
+    def secao?(nome_secao)
+      @arquivo.secoes.find {|s| s.nome == nome_secao }
+    end
+
+    def ler(nome_campo)
+      if @secao
+        campo = @secao.campos.find {|c| c.nome == nome_campo }
+        campo.ler(self) if campo
+      end
+    end
+
+    def ler_campos
+      if @secao
+        hash = {}
+        @secao.campos.each {|c| hash[c.nome] = c.ler(self) }
+        hash
+      end
+    end
+
+    def descobrir_secao
+      @secao = @arquivo.secoes.find {|s| s.dessa_linha?(self) }
+    end
+  end
+
+  module Helpers
+    def executar(bloco)
+      self.class.send :define_method, :executar_bloco, &bloco
+      self.executar_bloco
+    end
+
+    def extrair_opcoes(args)
+      args.last.is_a?(Hash) ? args.pop : {}
+    end
+  end
+
+  module ClassMethods
+
+    def arquivo(&bloco)
+      @arquivo = Arquivo.new
+      @arquivo.executar bloco
+    end
+
+    class Arquivo
+      include Caligrafo::Helpers
+
+      attr_accessor :bloco
+
+      def secoes
+        @secoes ||= []
+      end
+
+      def secao(nome, &bloco)
+        secao = Secao.new(nome, bloco)
+        secoes << secao
+        secao.executar bloco
+      end
+    end
+
+    class Secao
+      include Caligrafo::Helpers
+
+      attr_accessor :nome, :bloco
+
+      def initialize(nome, bloco)
+        @nome = nome
+        @bloco = bloco
+      end
+
+      def campos
+        @campos ||= []
+      end
+
+      def campo(nome, *opcoes)
+        campo = Campo.new(self, nome, *opcoes)
+        self.campos << campo
+        campo
+      end
+
+      def dessa_linha?(linha)
+        linha =~ /^#{campos.first.valor_padrao}/
+      end
+    end
+
+    class Campo
+      include Caligrafo::Helpers
+
+      attr_accessor :secao, :nome, :inicio, :fim, :formatador, :valor_padrao
+
+      def initialize(secao, nome, *args)
+        self.secao = secao
+        self.nome = nome
+       
+        opcoes = extrair_opcoes(args)
+        self.inicio     = opcoes.delete(:inicio)
+        self.fim        = opcoes.delete(:fim)
+        self.formatador = Formatador.pesquisar_por_nome(opcoes.delete(:formato))
+
+        if args.first
+          self.valor_padrao = args.first
+          opcoes[:tamanho]  = self.valor_padrao.to_s.size
+        end
+
+        if opcoes.key? :posicao
+          posicao = opcoes.delete(:posicao)
+          self.inicio = posicao.first
+          self.fim    = posicao.last
+        else
+          ajustar_inicio_e_fim(opcoes.delete(:tamanho))
+        end
+      end
+
+      def tamanho
+        if self.fim and self.inicio
+          self.fim - self.inicio + 1 # Inclui o ultimo elemento
+        else
+          nil
+        end
+      end
+
+      def ler(linha)
+        fim = self.fim || 0
+        linha[(self.inicio - 1)..(fim - 1)]
+      end
+
+      private
+      def ajustar_inicio_e_fim(tamanho)
+        self.inicio ||= calcular_inicio
+        self.fim    ||= self.inicio + tamanho - 1 if tamanho
+      end
+
+      def calcular_inicio
+        campo_anterior = self.secao.campos.last
+        if campo_anterior
+          ultima_posicao = campo_anterior.fim
+          ultima_posicao + 1
+        else
+          1
+        end
+      end
+    end
   end
 
   module Formatador
@@ -66,6 +292,7 @@ module Caligrafo
       def tipos
         [Date]
       end
+
       def formatar(valor, opcoes={})
         valor.strftime('%Y%m%d')
       end
@@ -118,7 +345,7 @@ module Caligrafo
       # não estariam disponíveis. ;)
       self.class.send :define_method, :executar_bloco, &bloco 
 
-      self.objeto = bloco.binding.eval "self"
+      self.objeto = bloco.binding.send :eval, "self"
 
       File.open(nome, 'w') do |file|
         self.file = file
@@ -143,7 +370,7 @@ module Caligrafo
         nova_linha
       end
 
-      self.objeto = self.bloco.binding.eval "self"
+      self.objeto = self.bloco.binding.send :eval, "self"
     end
 
     def nova_linha
@@ -227,5 +454,6 @@ class ::Fixnum
   def espacos
     ' ' * self
   end
+  alias espaco espacos
 end
 

data/test/caligrafo_test.rb

@@ -2,68 +2,57 @@ require 'test_helper'
 require 'caligrafo'
 require 'ostruct'
 
-class Telefone < Caligrafo::Formatador::Base
-  def formatar(valor, opcoes={})
-    valor.gsub(/(\d\d)(\d\d)(\d\d\d\d)(\d\d\d\d)/,'\1 \2 \3-\4') 
-  end
-end
-Caligrafo::Formatador.registrar :fone, Telefone
 
 class Portifolio < OpenStruct
   include Caligrafo
 
   def gerar_arquivo(nome_arquivo)
-
-    criar_arquivo nome_arquivo do
-      secao :cabecalho do
-        imprimir :nome,  :tamanho => 50        # Textos são alinhados à esquerda.
-        imprimir :idade, :tamanho => 3         # Números são alinhados à direita com zeros à esquerda.
-        imprimir :salario                      # Decimais possuem duas casas decimais.
-        imprimir 5.espacos                     # Quando o 1º parâmetro não for um símbolo ele será o conteúdo.
-        imprimir numero_linha, :posicao => 100 # 'numero_linha' é um método que guarda a linha corrente do arquivo.
+    escrever_arquivo nome_arquivo do |f|
+      f.secao :cabecalho do
+        f.imprimir :nome,  :tamanho => 50        # Textos são alinhados à esquerda.
+        f.imprimir :idade, :tamanho => 3         # Números são alinhados à direita com zeros à esquerda.
+        f.imprimir :salario                      # Decimais possuem duas casas decimais.
+        f.imprimir 5.espacos                     # Quando o 1º parâmetro não for um símbolo ele será o conteúdo.
+        f.imprimir f.numero_linha, :posicao => 100 # 'numero_linha' é um método que guarda a linha corrente do arquivo.
       end
 
-      secao :telefones do |telefone|                  # telefones é um método. Escreve uma linha pora cada objeto retornado.
-        imprimir :descricao,   "Fone##{indice + 1}: " # Valor fixo sendo usado como 2º parâmetro.
-                                                      # O 1º fica sendo usado apenas para descrição.
-                                                      # 'indice' é um método que guarda o indice do elemento no array.
-        imprimir telefone,     :formato => :fone      # Usando um formatador personalizado.
-        imprimir numero_linha, :posicao => 100        # posicao é usado para pular para uma coluna. Até lá tudo será vazio (' ').
+      f.secao :telefones do |telefone|                    # telefones é um método. Escreve uma linha pora cada objeto retornado.
+        f.imprimir :descricao,   "Fone##{f.indice + 1}: " # Valor fixo sendo usado como 2º parâmetro.
+                                                          # O 1º fica sendo usado apenas para descrição.
+                                                          # 'indice' é um método que guarda o indice do elemento no array.
+        f.imprimir telefone,  :formato => :fone           # Usando um formatador personalizado.
+        f.imprimir f.numero_linha, :posicao => 100        # posicao é usado para pular para uma coluna. Até lá tudo será vazio (' ').
       end
 
-      secao :sites do |site|                         
-        imprimir :downcase                      # Podemos chamar o método do item nas seções.
-        imprimir numero_linha, :posicao => 100
+      f.secao :sites do |site|                         
+        f.imprimir :downcase                      # Podemos chamar o método do item nas seções.
+        f.imprimir f.numero_linha, :posicao => 100
       end
 
-      secao :rodape do 
-        imprimir 'FIM'                          # Uma nova linha é criada sempre que saimos ou entramos numa seção.
-        imprimir numero_linha, :posicao => 100  # Como não definimos o tamanho, ficará alinhado à esquerda, mesmo sendo número.
+      f.secao :rodape do 
+        f.imprimir 'FIM'                          # Uma nova linha é criada sempre que saimos ou entramos numa seção.
+        f.imprimir f.numero_linha, :posicao => 100  # Como não definimos o tamanho, ficará alinhado à esquerda, mesmo sendo número.
       end
     end
   end
 end
 
-class CaligrafoTest < Test::Unit::TestCase
-  def setup
-    @target = 'test/arquivo_gerado.txt'
-  end
-
-  def teardown
-    File.delete @target rescue nil 
+class Telefone < Caligrafo::Formatador::Base
+  def formatar(valor, opcoes={})
+    valor.gsub(/(\d\d)(\d\d)(\d\d\d\d)(\d\d\d\d)/,'\1 \2 \3-\4') if valor
   end
+end
+Caligrafo::Formatador.registrar :fone, Telefone
 
-  def test_gerar_arquivo_texto
+class CaligrafoTest < Test::Unit::TestCase
+  def test_gerar_arquivo
     pessoa = Portifolio.new :nome => 'Lucas da Silva', 
                             :idade => 25, 
                             :salario => 90_000.5,
                             :telefones => ['558622223333', '558699991234'],
                             :sites => ['Google.com', 'Blip.tv', 'SlideShare.net']
-    pessoa.gerar_arquivo @target
-
-    nome_arquivo_esperado = 'test/arquivo_esperado.txt'
-    File.open(nome_arquivo_esperado, 'w') do |file|
-      file.puts <<-EOF
+    pessoa.gerar_arquivo 'test/arquivo_gerado.txt'
+    assert_file_content  'test/arquivo_gerado.txt', <<-EOF
 Lucas da Silva                                    0259000050                                        1
 Fone#1: 55 86 2222-3333                                                                             2
 Fone#2: 55 86 9999-1234                                                                             3
@@ -72,17 +61,5 @@ blip.tv
 slideshare.net                                                                                      6
 FIM                                                                                                 7
     EOF
-    end
-
-    assert_equal_files nome_arquivo_esperado, @target
-  end
-
-  def test_pesquisar_formatador_inexistente
-    assert_raise Caligrafo::Formatador::FormatadorNaoEncontrado do
-      Caligrafo::Formatador.pesquisar_por_nome! :bolinha
-    end
-    assert_nothing_raised do
-      Caligrafo::Formatador.pesquisar_por_nome! :numerico
-    end
   end
 end

data/test/formatador_test.rb

@@ -0,0 +1,35 @@
+require 'test_helper'
+require 'caligrafo'
+require 'ostruct'
+
+
+class FormatadorTest < Test::Unit::TestCase
+
+  def test_formatador_default
+    test_formatador Caligrafo::Formatador::Base, 12, 10, '12        ' 
+  end
+
+  def test_formatador_personalizado
+    test_formatador Telefone, '558632323344', 15, '55 86 3232-3344' 
+  end
+
+  def test_pesquisar_formatador_inexistente
+    assert_raise Caligrafo::Formatador::FormatadorNaoEncontrado do
+      Caligrafo::Formatador.pesquisar_por_nome! :bolinha
+    end
+
+    assert_nothing_raised do
+      Caligrafo::Formatador.pesquisar_por_nome! :numerico
+    end
+  end
+
+  private
+  def test_formatador(formatador, valor_original, tamanho, valor_esperado)
+    f = formatador.new
+
+    valor_formatado  = f.formatar valor_original
+    valor_preenchido = f.preencher valor_formatado, tamanho
+    assert_equal valor_esperado, valor_preenchido
+  end
+
+end

data/test/leitura_test.rb

@@ -0,0 +1,82 @@
+require 'test_helper'
+require 'caligrafo'
+
+
+class LeituraTest < Test::Unit::TestCase
+
+  class Exemplo
+    include Caligrafo
+
+    attr_accessor :posicao, :nome, :situacao
+
+    arquivo do
+      secao :cabecalho do
+        campo :fixo,        '01'
+        campo :com_tamanho, :tamanho => 5
+        campo :com_fim,     :fim => 10 
+        campo :com_range,   :posicao => 11..15
+        campo :com_inicio,  :inicio => 20, :formato => :decimal
+      end
+
+      secao :corpo do
+        campo :vazio
+      end
+    end
+
+   def smile
+     ':)'
+   end
+
+    def ler(nome_arquivo)
+      ler_arquivo nome_arquivo do |linha|
+        if linha.secao? :cabecalho
+          self.posicao = linha.ler(:fixo)
+          self.nome = linha.ler_campos[:com_tamanho]
+        end
+      end
+    end
+  end
+
+  def test_ler_arquivo
+    arquivo = 'test/tmp.txt'
+    File.open(arquivo, 'w') do |file|
+      file.puts <<-EOF
+0100005:)          150
+      EOF
+    end
+    
+    exemplo = Exemplo.new
+    exemplo.ler(arquivo)
+    assert_equal '01', exemplo.posicao
+    assert_equal '00005', exemplo.nome
+  end
+
+  def test_dsl_com_informacoes_do_arquivo
+    arquivo = Exemplo.instance_variable_get "@arquivo"
+    assert arquivo
+    
+    cabecalho = arquivo.secoes.first
+    assert_equal :cabecalho, cabecalho.nome
+
+    registros = arquivo.secoes.last
+    assert_equal :corpo, registros.nome
+
+    campos = cabecalho.campos
+    assert_equal 5, campos.size
+
+    test_campo campos[0], :nome => :fixo, :inicio => 1, :fim => 2, :tamanho => 2, :valor_padrao => '01'
+    test_campo campos[1], :nome => :com_tamanho, :inicio => 3, :fim => 7, :tamanho => 5
+    test_campo campos[2], :nome => :com_fim, :inicio => 8, :fim => 10, :tamanho => 3
+    test_campo campos[3], :nome => :com_range, :inicio => 11, :fim => 15, :tamanho => 5
+    test_campo campos[4], :nome => :com_inicio, :inicio => 20, :fim => nil, :tamanho => nil
+
+    assert_equal Caligrafo::Formatador::Decimal, campos[4].formatador.class
+  end
+
+  private
+  def test_campo(campo, comparacoes = {})
+    for campo_do_campo, valor_esperado in comparacoes
+      assert_equal valor_esperado, campo.send(campo_do_campo), "campo #{campo.nome} nao bateu no #{campo_do_campo}"
+    end
+  end
+end

data/test/test_helper.rb

@@ -17,20 +17,22 @@ class Test::Unit::TestCase
     expected = File.new(expected, 'r') if expected.is_a? String
     given    = File.new(given, 'r')    if given.is_a? String
 
-    expected_text = expected.read
-    given_text    = given.read
+    assert_file_content given, expected.read
+  end
 
-    lines_of_given_text = given_text.lines.to_a
-  
-    expected_text.each_with_index do |line, index|
+  def assert_file_content(file, content)
+    given = File.new(file, 'r') if file.is_a? String
+    lines_of_given_text = given.read.lines.to_a
+    
+    content.each_with_index do |line, index|
       begin
         assert_equal line, lines_of_given_text[index]
       rescue Test::Unit::AssertionFailedError => e
         column = Diff::LCS.diff(line, lines_of_given_text[index]).first.first.position + 1
         raise Test::Unit::AssertionFailedError, "Line #{index + 1} dont match on column #{column}:\n#{e.message}"
       end
-      if expected_text.to_a.size < given_text.to_a.size
-        assert_equal expected_text, given_text 
+      if content.to_a.size < given.read.to_a.size
+        assert_equal content, given.read
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: caligrafo
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Lucas de Castro
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-26 00:00:00 -03:00
+date: 2009-10-30 00:00:00 -03:00
 default_executable: 
 dependencies: []
 
@@ -31,8 +31,9 @@ files:
 - VERSION
 - caligrafo.gemspec
 - lib/caligrafo.rb
-- test/arquivo_esperado.txt
 - test/caligrafo_test.rb
+- test/formatador_test.rb
+- test/leitura_test.rb
 - test/test_helper.rb
 has_rdoc: true
 homepage: http://github.com/lucasdecastro/caligrafo
@@ -65,3 +66,5 @@ summary: "DSL para gera\xC3\xA7\xC3\xA3o de arquivos texto."
 test_files: 
 - test/test_helper.rb
 - test/caligrafo_test.rb
+- test/formatador_test.rb
+- test/leitura_test.rb

data/test/arquivo_esperado.txt

@@ -1,7 +0,0 @@
-Lucas da Silva                                    0259000050                                        1
-Fone#1: 55 86 2222-3333                                                                             2
-Fone#2: 55 86 9999-1234                                                                             3
-google.com                                                                                          4
-blip.tv                                                                                             5
-slideshare.net                                                                                      6
-FIM                                                                                                 7