caligrafo 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Lucas de Castro
+
+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.rdoc

@@ -0,0 +1,18 @@
+= caligrafo
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Lucas de Castro. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,39 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "caligrafo"
+    gem.summary = %Q{DSL para geração de arquivos texto.}
+    gem.description = %Q{DSL para geração de arquivos texto.}
+    gem.email = "castro.lucas@gmail.com"
+    gem.homepage = "http://github.com/lucasdecastro/caligrafo"
+    gem.authors = ["Lucas de Castro"]
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "caligrafo #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/caligrafo.gemspec

@@ -0,0 +1,51 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{caligrafo}
+  s.version = "0.1.0"
+
+  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-24}
+  s.description = %q{DSL para geração de arquivos texto.}
+  s.email = %q{castro.lucas@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "caligrafo.gemspec",
+     "lib/caligrafo.rb",
+     "test/arquivo_esperado.txt",
+     "test/caligrafo_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/lucasdecastro/caligrafo}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{DSL para geração de arquivos texto.}
+  s.test_files = [
+    "test/test_helper.rb",
+     "test/caligrafo_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lib/caligrafo.rb

@@ -0,0 +1,211 @@
+module Caligrafo
+  def self.included(base)
+    base.instance_eval do
+      include InstanceMethods
+    end
+  end
+
+  module InstanceMethods
+    def criar_arquivo(nome_arquivo, &bloco)
+      arquivo = Arquivo.new(nome_arquivo, bloco)
+      arquivo.criar_arquivo
+      nome_arquivo    
+    end
+  end
+
+  module Formatador
+    def self.formatos
+      @@formatos
+    end
+  
+    def self.registrar(nome, formatador)
+      @@formatos ||= {}
+      @@formatos[nome] = formatador.new
+    end
+
+    def self.pesquisar(tipo)
+      formatador = @@formatos.values.find { |f| f.tipos.include? tipo }
+      formatador ||= @@formatos[:default]
+    end
+
+    class Base
+      attr_reader :tipos, :alinhamento, :preenchimento
+
+      def initialize
+        @tipos = []
+        @alinhamento = :esquerda
+        @preenchimento = ' '
+      end
+
+      def formatar(valor, opcoes = {})
+        valor.to_s
+      end
+
+      def preencher(string, tamanho)
+        if self.alinhamento == :direita
+          string = string.rjust tamanho, self.preenchimento
+        else
+          string = string.ljust tamanho, self.preenchimento
+        end
+ 
+        string = string[0..(tamanho - 1)] if string.size > tamanho
+        string
+      end
+    end
+
+    class Numerico < Base
+      def initialize
+        @tipos = [Fixnum]
+      end
+
+      def alinhamento
+        :direita
+      end
+
+      def preenchimento
+        '0'
+      end
+    end
+
+    class Decimal < Numerico
+      def initialize
+         @tipos = [Float]
+      end
+
+      def formatar(valor, opcoes = {})
+         ('%.2f' % valor).gsub('.','')
+      end
+    end
+
+    self.registrar :default, Base
+    self.registrar :numerico, Numerico
+    self.registrar :decimal, Decimal
+  end
+
+  class Arquivo
+    attr_reader   :nome, :bloco
+    attr_accessor :objeto, :indice, :linha, :numero_linha, :file
+
+    def initialize(nome, bloco)
+      @nome = nome
+      @bloco = bloco
+      @linha = ''
+      @numero_linha = 1
+    end
+
+    def criar_arquivo
+      # Se eu simplesmente chamasse o bloco, os método de Arquivo
+      # não estariam disponíveis. ;)
+      self.class.send :define_method, :executar_bloco, &bloco 
+
+      self.objeto = bloco.binding.eval "self"
+
+      File.open(nome, 'w') do |file|
+        self.file = file
+        executar_bloco
+      end
+
+      nome
+    end
+
+    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.eval "self"
+    end
+
+    def nova_linha
+      self.linha = ''
+      self.numero_linha += 1
+      self.file.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.file.print valor_campo
+    end
+  end
+
+  # campo :nome
+  # campo :profisao, 'Programador'
+  # campo :idade, 46, :posicao => 12
+  # campo :tentativas, :alinhamento => :esquerda, :tamanho => 10
+  # campo :salario, :formato => :decimal
+  # campo 'FIM'
+  class Campo
+    attr_accessor :nome, :valor, :posicao, :formato, :tamanho, :opcoes_para_formatador
+
+    def initialize(*args)
+      opcoes = (args.last.is_a?(Hash) ? args.pop : {})
+      @formato = opcoes.delete(:formato)
+      @posicao = opcoes.delete(:posicao)
+      @tamanho = opcoes.delete(:tamanho)
+      @opcoes_para_formatador = opcoes
+
+      if args.first.is_a? Symbol
+        @nome = args.first
+        @valor = args[1]
+      else
+        @valor = args.first
+      end
+    end
+
+    def valor_para(objeto)
+      valor = if chamar_metodo?
+        begin
+          objeto.send(self.nome) 
+        rescue Exception => e
+          raise "Erro ao chamar #{self.nome.inspect} em #{objeto}: #{e.message}"
+        end
+      else
+        self.valor
+      end
+
+      formatar(valor)
+    end
+
+    private
+    def chamar_metodo?
+      (self.nome && self.valor.nil?)
+    end
+    def formatar(valor)
+      if self.formato
+        formatador = Caligrafo::Formatador.formatos[self.formato]
+      else
+        formatador = Formatador.pesquisar valor.class 
+      end
+
+      string = formatador.formatar(valor, self.opcoes_para_formatador)
+      string = formatador.preencher(string, self.tamanho) if self.tamanho
+      string
+    end
+  end
+end
+
+# TODO criar arquivo de extensoes.
+class ::Fixnum
+  def espacos
+    ' ' * self
+  end
+end
+

data/test/arquivo_esperado.txt

@@ -0,0 +1,7 @@
+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

data/test/caligrafo_test.rb

@@ -0,0 +1,78 @@
+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.
+      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 (' ').
+      end
+
+      secao :sites do |site|                         
+        imprimir :downcase                      # Podemos chamar o método do item nas seções.
+        imprimir 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.
+      end
+    end
+  end
+end
+
+class CaligrafoTest < Test::Unit::TestCase
+  def setup
+    @target = 'test/arquivo_gerado.txt'
+  end
+  def teardown
+    File.delete @target rescue nil 
+  end
+
+  def test_gerar_arquivo_texto
+    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
+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
+    EOF
+    end
+
+    assert_equal_files nome_arquivo_esperado, @target
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,37 @@
+require 'rubygems'
+require 'test/unit'
+require 'diff/lcs'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'caligrafo'
+
+class String
+  def first_diff(other)
+    self.diff(other).first.first.position rescue nil
+  end
+end
+
+class Test::Unit::TestCase
+  def assert_equal_files(expected, given)
+    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
+
+    lines_of_given_text = given_text.lines.to_a
+  
+    expected_text.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 
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: caligrafo
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Lucas de Castro
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-24 00:00:00 -03:00
+default_executable: 
+dependencies: []
+
+description: "DSL para gera\xC3\xA7\xC3\xA3o de arquivos texto."
+email: castro.lucas@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- caligrafo.gemspec
+- lib/caligrafo.rb
+- test/arquivo_esperado.txt
+- test/caligrafo_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/lucasdecastro/caligrafo
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: "DSL para gera\xC3\xA7\xC3\xA3o de arquivos texto."
+test_files: 
+- test/test_helper.rb
+- test/caligrafo_test.rb