formatted_date 1.0.0

data/CHANGELOG.rdoc

@@ -0,0 +1,3 @@
+== 1.0.0 released 2009-11-10
+
+* Primeiro release

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Ícaro Leopoldino da Motta
+
+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,96 @@
+= FormattedDate
+
+Esse plugin foi escrito para dar conta da falta de customiza��o do Rails em
+rela��o a datas em formul�rios.
+
+O comportamento padr�o do Rails ao se atribuir um dado valor para um atributo de
+data � mantido. O que muda � que agora s�o realizadas duas convers�es. A
+primeira � feita pelo plugin e tenta converter o valor passado para uma data de
+acordo com o formato definido (padr�o brasileiro). Depois essa data � passada
+ao Rails no formato que ele gosta (padr�o americano).
+
+FormattedDate tamb�m oferece valida��o inteligente automaticamente. O padr�o �
+n�o aceitar datas inv�lidas (datas em branco ou <tt>nil</tt> n�o s�o
+consideradas inv�lidas). Para capturar esses erros existe o famoso
+<tt>validates_presence_of</tt>.
+
+----
+
+=== Configura��o
+
+No arquivo <i>config/environment.rb</i> adicione o seguinte:
+
+  config.gem 'formatted_date', :source => 'http://gemcutter.org'
+  
+E ent�o execute a task:
+
+  rake gems:install
+  
+----
+
+=== Exemplos
+
+No seu modelo chame o m�todo <tt>formatted_date</tt> e passe o nome dos
+atributos e suas op��es.
+
+  formatted_date :created_at, :publicacao
+  
+O formato padr�o assumido � o brasileiro (dd/mm/YYYY). Mas voc� pode querer um
+formul�rio com datas em outro formato, por exemplo.
+
+  formatted_date :publicacao, :format => '%d/%m/%Y - %Hh %Mmin'
+  
+Evidentemente voc� pode chamar o m�todo m�ltiplas vezes caso queira passar
+op��es diferentes para cada atributo.
+
+  formatted_date :date, :validate => false
+  formatted_date :publicacao, :default => Time.current, :message => :invalid
+  
+No exemplo acima voc� viu que existem outras op��es, as quais est�o listadas
+abaixo.
+
+<tt>format</tt>::
+  Aceita qualquer formato que o m�todo <tt>strftime</tt> suporte.
+<tt>default</tt>::
+  O padr�o � <tt>nil</tt>, mas qualquer valor pode ser passado.
+<tt>validate</tt>::
+  Valor booleano para dizer se o plugin deve adicionar uma mensagem de erro caso
+  a data n�o seja v�lida. Padr�o <tt>true</tt>.
+<tt>message</tt>::
+  Mensagem a ser exibida caso ocorra algum erro na convers�o para uma data.
+  O padr�o � uma mensagem do tipo <tt>invalid</tt> definida no seu arquivo de
+  localiza��o.
+<tt>type</tt>::
+  Caso o atributo seja do tipo <i>date</i> voc� deve avisar o plugin passando
+  o s�mbolo <tt>:date</tt> ou a constante <tt>Date</tt>.
+<tt>range</tt>::
+  Intervalo v�lido para a(s) data(s). Deve ser do tipo <tt>Range</tt>.
+  Padr�o: 1850 � 2038.
+  
+----
+
+=== M�dulo de Convers�o
+
+Voc� n�o est� limitado a utilizar esse plugin somente para formatar datas
+corretamente em formul�rios. Ele vem com um m�dulo para convers�es -
+<tt>FormattedDate::Conversion</tt>. Utilize-o caso queira converter datas
+arbitr�rias (n�o s�o atributos de modelos).
+
+Voc� tem acesso � dois m�todos para convers�o. Ambos tem o mesmo comportamento
+e aceitam as mesmas op��es do plugin, exceto as op��es de valida��o
+(<i>message</i> e <i>validate</i>).
+
+* to_datetime
+  FormattedDate::Conversion.to_datetime('26/11/1986')
+  # => Qua, 26 Nov 1986 00:00:00 +0000
+* to_date
+  FormattedDate::Conversion.to_date('26/11/1986')
+  # => Wed, 26 Nov 1986
+  
+Uma funcionalidade diferente desses m�todos � que eles retornam um
+<tt>Array</tt> caso voc� passe mais de uma data. Por exemplo:
+
+  inicio, fim = FormattedDate::Conversion.to_datetime(params[:inicio], params[:fim])
+  
+
+Copyright (c) 2009 �caro Leopoldino da Motta, released under the MIT license

data/init.rb

@@ -0,0 +1 @@
+require 'formatted_date'

data/lib/formatted_date.rb

@@ -0,0 +1,4 @@
+require 'formatted_date/conversion_plugin'
+require 'formatted_date/formatting'
+
+ActiveRecord::Base.extend FormattedDate

data/lib/formatted_date/conversion.rb

@@ -0,0 +1,57 @@
+module FormattedDate
+  
+  module Conversion
+    
+    DefaultOptions = FormattedDate::DefaultOptions.tap { |opts| opts.delete(:message); opts.delete(:validate) }
+    
+    #
+    # Tenta fazer a convers�o de cada uma das datas. Em caso de erro,
+    # o valor da op��o <tt>default</tt> � retornado.
+    # O retorno final � um array (se mais de uma data foi passada) com
+    # as datas convertidas (tipo date) de acordo com o formato
+    # especificado pela op��o <tt>format</tt>.
+    #
+    # Exemplos:
+    #   hoje = FormattedDate::Conversion.to_date('08/06/2009', :default => Date.today)
+    #   inicio, fim = FormattedDate::Conversion.to_date('6-6-6', '12-12-12', :format => '%d-%m-%y')
+    #
+    def self.to_date(*args)
+      convert *args.push(Date)
+    end
+    
+    #
+    # Idem ao m�todo date, s� que a convers�o � para um <tt>datetime</tt>.
+    #
+    def self.to_datetime(*args)
+      convert *args.push(DateTime)
+    end
+    
+    private
+    
+      def self.convert(*args)
+        klass = args.pop
+        options = args.extract_options!.reverse_merge(DefaultOptions)
+          
+        dates = args.map do |date|
+          if date.is_a? String
+            if date.blank?
+              options[:default]
+            else
+              begin
+                parsed = klass.strptime(date, options[:format])
+                options[:range].include?(parsed.year) ? parsed : options[:default]
+              rescue ArgumentError
+                options[:default]
+              end
+            end
+          elsif date.is_a?(Time) || date.is_a?(Date)
+            date
+          else
+            options[:default]
+          end
+        end
+        dates.many? ? dates : dates.first
+      end
+  end
+end
+

data/lib/formatted_date/conversion_plugin.rb

@@ -0,0 +1,80 @@
+require 'ostruct'
+
+module FormattedDate
+  
+  class ConversionPlugin #:nodoc:
+    
+    VALID        = 0
+    INVALID      = 1
+    PARSE_FAIL   = 2
+    OUT_OF_RANGE = 3
+    
+    def initialize(input, options = {})
+      @input   = input
+      @output  = nil
+      @options = OpenStruct.new(options)
+      @status  = INVALID
+    end
+    
+    #
+    # Possible conversion methods: <tt>to_date</tt> and <tt>to_datetime</tt>.
+    #
+    def convert!
+      send @options.conversion_method
+    end
+    
+    def valid?
+      @status == VALID
+    end
+    
+    def invalid?
+      !valid?
+    end
+    
+    #
+    # This is a way to to know if the conversion failed because of a bad input.
+    #
+    def failed_to_parse?
+      @status == PARSE_FAIL
+    end
+    
+    def out_of_range?
+      @status == OUT_OF_RANGE
+    end
+    
+    private
+    
+      def perform_conversion(klass)
+        @status, @output = if @input.is_a? String
+          if @input.blank?
+            [INVALID, @options.default]
+          else
+            begin
+              parsed = klass.strptime(@input, @options.format)
+              if @options.range.include? parsed.year
+                [VALID, parsed]
+              else
+                [OUT_OF_RANGE, @options.default]
+              end
+            rescue ArgumentError
+              [PARSE_FAIL, @options.default]
+            end
+          end
+        elsif @input.is_a?(Time) || @input.is_a?(Date)
+          [VALID, @input]
+        else
+          [INVALID, @options.default]
+        end
+        
+        @output
+      end
+      
+      def to_date
+        perform_conversion Date
+      end
+      
+      def to_datetime
+        perform_conversion DateTime
+      end
+  end
+end

data/lib/formatted_date/formatting.rb

@@ -0,0 +1,78 @@
+module FormattedDate
+  
+  DefaultOptions = {
+    :format   => '%d/%m/%Y',
+    :default  => nil,
+    :validate => true,
+    :range    => 1850..2038,
+    :message  => :invalid,
+    :type     => :datetime
+  }
+
+  #
+  # Formata as datas de acordo com o formato passado.
+  #
+  # Leia o <i>README</i> para mais informa��es.
+  #
+  def formatted_date(*args)
+    options = args.extract_options!.reverse_merge(DefaultOptions)
+
+    message = options[:message] || :invalid
+    type = options[:type] || :datetime
+    
+    if type.to_s.downcase == 'date'
+      options[:conversion_method] = :to_date
+      options[:db_format]         = '%Y-%m-%d'
+    else
+      options[:conversion_method] = :to_datetime
+      options[:db_format]         = '%Y-%m-%d %H:%M:%S'
+    end
+
+    args.map(&:to_s).each do |name|
+      
+      #
+      # Este � o m�todo que o Rails chama quando est� colocando datas em
+      # campos de formul�rio.
+      # Ele est� sendo sobrescrito para que retorne uma data no formato dado
+      # pela op��o <format>.
+      #
+      define_method "#{name}_before_type_cast" do
+        if self[name].is_a?(Time) || self[name].is_a?(Date)
+          self[name].strftime(options[:format])
+        else
+          self.read_attribute_before_type_cast(name)
+        end
+      end
+
+      #
+      # M�todo de atribui��o.
+      #
+      define_method "#{name}=" do |value|
+        conv = ConversionPlugin.new(value, options)
+        date = conv.convert!
+        if conv.valid?
+          self[name] = date.strftime(options[:db_format])
+        else # data inv�lida
+          # O Rails automaticamente tentar� converter esta data, mas n�s
+          # sabemos que ela � inv�lida. De qualquer forma � necess�rio porque
+          # depois n�s devemos ser capazes de resgatar a data sem o cast
+          # (valor de entrada original).
+          self[name] = value
+          
+          if options[:validate]
+            self.class.class_eval do
+              validate do |record|
+                if conv.failed_to_parse?
+                  # Limpa os erros relacionados a este atributo e adiciona
+                  # um outro (padr�o <invalid>).
+                  record.errors.instance_eval { @errors.delete(name) }
+                  record.errors.add(name, message)
+                end
+              end
+            end
+          end
+        end
+      end # end define_method
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require 'formatted_date'

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: formatted_date
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- "\xC3\x8Dcaro Leopoldino da Motta"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-10 00:00:00 -02:00
+default_executable: 
+dependencies: []
+
+description: Customize o formato de datas no Rails.
+email: icaro.ldm@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- CHANGELOG.rdoc
+files: 
+- init.rb
+- README.rdoc
+- CHANGELOG.rdoc
+- LICENSE
+- rails/init.rb
+- lib/formatted_date/conversion.rb
+- lib/formatted_date/conversion_plugin.rb
+- lib/formatted_date/formatting.rb
+- lib/formatted_date.rb
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: Customize o formato de datas no Rails.
+test_files: []
+