delocalize 0.1.5 → 0.1.6

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 [name of plugin creator]
+Copyright (c) 2009 Clemens Kofler
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.markdown

@@ -0,0 +1,115 @@
+delocalize
+==========
+
+delocalize provides localized date/time and number parsing functionality for Rails.
+
+Installation
+---------------
+
+You can use delocalize either as a gem (preferred) or as a Rails plugin.
+
+To use the gem version, put the following gem requirement in your `environment.rb`:
+
+    config.gem "delocalize", :source => 'http://gemcutter.org'
+
+To install it as a plugin, fire up your terminal, go to your Rails app and type:
+
+    $ ruby script/plugin install git://github.com/clemens/delocalize.git
+
+
+What does it do? And how do I use it?
+---------------------------------------------------
+
+Delocalize, just as the name suggest, does pretty much the opposite of localize.
+
+In the grey past, if you want your users to be able to input localized data, such as dates and numbers, you had to manually override attribute accessors:
+
+    def price=(price)
+      write_attribute(:price, price.gsub(',', '.'))
+    end
+
+delocalize does this under the covers -- all you need is your regular translation data (as YAML or Ruby file) where you need Rails' standard translations:
+
+    de:
+      number:
+        format:
+          separator: ','
+          delimiter: '.'
+      date:
+        input:
+          formats: [:default, :long, :short] # <- this and ...
+
+        formats:
+          default: "%d.%m.%Y"
+          short: "%e. %b"
+          long: "%e. %B %Y"
+          only_day: "%e"
+
+        day_names: [Sonntag, Montag, Dienstag, Mittwoch, Donnerstag, Freitag, Samstag]
+        abbr_day_names: [So, Mo, Di, Mi, Do, Fr, Sa]
+        month_names: [~, Januar, Februar, März, April, Mai, Juni, Juli, August, September, Oktober, November, Dezember]
+        abbr_month_names: [~, Jan, Feb, Mär, Apr, Mai, Jun, Jul, Aug, Sep, Okt, Nov, Dez]
+        order: [ :day, :month, :year ]
+
+      time:
+        input:
+          formats: [:long, :medium, :short, :default, :time] # <- ... this are the only non-standard keys
+        formats:
+          default: "%A, %e. %B %Y, %H:%M Uhr"
+          short: "%e. %B, %H:%M Uhr"
+          long: "%A, %e. %B %Y, %H:%M Uhr"
+          time: "%H:%M"
+
+        am: "vormittags"
+        pm: "nachmittags"
+
+For dates and times, you have to define input formats which are taken from the actual formats. The important thing here is to define input formats sorted by descending complexity; in other words: the format which contains the most (preferably non-numeric) information should be first in the list because it can produce the most reliable match. Exception: If you think there most complex format is not the one that most users will input, you can put the most-used in front so you save unnecessary iterations.
+
+Careful with formats containing only numbers: It's very hard to produce reliable matches if you provide multiple strictly numeric formats!
+
+delocalize then overrides `to_input_field_tag` in ActionView's `InstanceTag` so you can use localized text fields:
+
+    <% form_for @product do |f| %>
+      <%= f.text_field :name %>
+      <%= f.text_field :released_on %>
+      <%= f.text_field :price %>
+    <% end %>
+  
+In this example, a user can enter the release date and the price just like he's used to in his language, for example:
+
+>  Name: "Couch"  
+>  Released on: "12. Oktober 2009"  
+>  Price: "2.999,90"
+
+When saved, ActiveRecord automatically converts these to a regular Ruby date and number.
+
+Edit forms then also show localized dates/numbers. By default, dates and times are localized using the format named :default in your locale file. So with the above locale file, dates would use `%d.%m.%Y` and times would use `%A, %e. %B %Y, %H:%M Uhr`. Numbers are also formatted using your locale's thousands delimiter and decimal separator.
+
+You can also customize the output using some options:
+
+  The price should always show two decimal digits and we don't need the delimiter:
+      <%= f.text_field :price, :precision => 2, :delimiter => '' %>
+  
+  The `released_on` date should be shown in the `:full` format:
+      <%= f.text_field :released_on, :format => :full %>
+  
+  Since `I18n.localize` supports localizing `strftime` strings, we can also do this:
+      <%= f.text_field :released_on, :format => "%B %Y" %>
+
+### Note
+
+delocalize is most definitely not enterprise-ready! ;-)  
+Or as Yaroslav says: Contains small pieces. Not good for children of age 3 and less. Not enterprise-ready.
+
+### TODO
+
+* Improve test coverage
+* Separate Ruby/Rails stuff to make it usable outside Rails
+* Verify correct behavior with time zones
+* Decide on other ActionView hacks (e.g. `text_field_tag`)
+* Implement AM/PM support
+* Cleanup, cleanup, cleanup ...
+
+Copyright (c) 2009-2010 Clemens Kofler &lt;clemens@railway.at&gt;
+http://www.railway.at/
+Released under the MIT license

data/VERSION

@@ -1 +1 @@
-0.1.5
+0.1.6

data/lib/delocalize/localized_numeric_parser.rb

@@ -8,7 +8,8 @@ module Delocalize
       def parse(value)
         if value.is_a?(String)
           separator = I18n.t(:'number.format.separator')
-          value = value.gsub(/[^0-9\-#{separator}]/, '').gsub(separator, '.')
+          delimiter = I18n.t(:'number.format.delimiter')
+          value = value.gsub(delimiter, '').gsub(separator, '.')
         end
         value
       end

data/lib/delocalize/rails_ext/action_view.rb

@@ -22,7 +22,13 @@ ActionView::Helpers::InstanceTag.class_eval do
           # integers don't need a precision
           opts.merge!(:precision => 0) if column.type == :integer
 
-          options[:value] = number_with_precision(value, opts)
+          hidden_for_integer = field_type == 'hidden' && column.type == :integer
+
+          # the number will be formatted only if it has no errors
+          if object.respond_to?(:errors) && !object.errors.invalid?(method_name)
+            # we don't format integer hidden fields because this breaks nested_attributes
+            options[:value] = number_with_precision(value, opts) unless hidden_for_integer
+          end
         elsif column.date? || column.time?
           options[:value] = value ? I18n.l(value, :format => options.delete(:format)) : nil
         end
@@ -45,4 +51,4 @@ end
 #     end
 #     original_text_field_tag(name, value, options)
 #   end
-# end
+# end

data/lib/delocalize/rails_ext/active_record.rb

@@ -16,8 +16,6 @@ ActiveRecord::Base.class_eval do
         value = Date.parse_localized(value)
       elsif column.time?
         value = Time.parse_localized(value)
-      elsif column.number?
-        value = column.type_cast(convert_number_column_value_with_localization(value))
       end
     end
     write_attribute_without_localization(attr_name, value)
@@ -38,6 +36,24 @@ ActiveRecord::Base.class_eval do
     evaluate_attribute_method attr_name, method_body, "#{attr_name}="
   end
 
+  # overriding to convert numbers with localization
+  # this method belongs to Dirty module
+  def field_changed?(attr, old, value)
+    if column = column_for_attribute(attr)
+      if column.number? && column.null && (old.nil? || old == 0) && value.blank?
+        # For nullable numeric columns, NULL gets stored in database for blank (i.e. '') values.
+        # Hence we don't record it as a change if the value changes from nil to ''.
+        # If an old value of 0 is set to '' we want this to get changed to nil as otherwise it'll
+        # be typecast back to 0 (''.to_i => 0)
+        value = nil
+      else
+        value = column.type_cast(convert_number_column_value_with_localization(value))
+      end
+    end
+
+    old != value
+  end
+
   def convert_number_column_value_with_localization(value)
     value = convert_number_column_value_without_localization(value)
     value = Numeric.parse_localized(value) if I18n.delocalization_enabled?

data/test/delocalize_test.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require File.dirname(__FILE__) + '/test_helper'
 
 class DelocalizeActiveRecordTest < ActiveRecord::TestCase
@@ -32,7 +34,7 @@ class DelocalizeActiveRecordTest < ActiveRecord::TestCase
   end
 
   test "delocalizes localized datetime with year" do
-    time = Time.local(2009, 3, 1, 12, 0, 0)
+    time = Time.gm(2009, 3, 1, 11, 0, 0).in_time_zone
 
     @product.published_at = 'Sonntag, 1. März 2009, 12:00 Uhr'
     assert_equal time, @product.published_at
@@ -42,7 +44,7 @@ class DelocalizeActiveRecordTest < ActiveRecord::TestCase
   end
 
   test "delocalizes localized datetime without year" do
-    time = Time.local(Date.today.year, 3, 1, 12, 0, 0)
+    time = Time.gm(Date.today.year, 3, 1, 11, 0, 0).in_time_zone
 
     @product.published_at = '1. März, 12:00 Uhr'
     assert_equal time, @product.published_at
@@ -50,7 +52,7 @@ class DelocalizeActiveRecordTest < ActiveRecord::TestCase
 
   test "delocalizes localized time" do
     now = Time.current
-    time = Time.local(now.year, now.month, now.day, 9, 0, 0)
+    time = Time.gm(now.year, now.month, now.day, 7, 0, 0).in_time_zone
     @product.cant_think_of_a_sensible_time_field = '09:00 Uhr'
     assert_equal time, @product.cant_think_of_a_sensible_time_field
   end
@@ -61,12 +63,12 @@ class DelocalizeActiveRecordTest < ActiveRecord::TestCase
     @product.released_on = '2009/10/19'
     assert_equal date, @product.released_on
 
-    time = Time.local(2009, 3, 1, 12, 0, 0)
+    time = Time.gm(2009, 3, 1, 11, 0, 0).in_time_zone
     @product.published_at = '2009/03/01 12:00'
     assert_equal time, @product.published_at
 
     now = Time.current
-    time = Time.local(now.year, now.month, now.day, 9, 0, 0)
+    time = Time.gm(now.year, now.month, now.day, 7, 0, 0).in_time_zone
     @product.cant_think_of_a_sensible_time_field = '09:00'
     assert_equal time, @product.cant_think_of_a_sensible_time_field
   end
@@ -131,6 +133,12 @@ class DelocalizeActiveRecordTest < ActiveRecord::TestCase
     @product.weight = "10,34"
     assert @product.weight_changed?
   end
+
+  test "should remember the value before type cast" do
+    @product.price = "asd"
+    assert_equal @product.price, 0
+    assert_equal @product.price_before_type_cast, "asd"
+  end
 end
 
 class DelocalizeActionViewTest < ActionView::TestCase
@@ -195,6 +203,12 @@ class DelocalizeActionViewTest < ActionView::TestCase
       text_field(:product, :cant_think_of_a_sensible_time_field, :format => :time)
   end
 
+  test "integer hidden fields shouldn't be formatted" do
+    @product.times_sold = 1000
+    assert_dom_equal '<input id="product_times_sold" name="product[times_sold]" type="hidden" value="1000" />',
+      hidden_field(:product, :times_sold)
+  end
+
   test "doesn't raise an exception when object is nil" do
     assert_nothing_raised {
       text_field(:not_here, :a_text_field)
@@ -216,6 +230,13 @@ class DelocalizeActionViewTest < ActionView::TestCase
       text_field(:product, :price, :value => "1.499,90")
   end
 
+  test "don't convert type if field has errors" do
+    @product = ProductWithValidation.new(:price => 'this is not a number')
+    @product.valid?
+    assert_dom_equal '<div class="fieldWithErrors"><input id="product_price" name="product[price]" size="30" type="text" value="this is not a number" /></div>',
+      text_field(:product, :price)
+  end
+
   test "doesn't raise an exception when object isn't an ActiveReccord" do
     @product = NonArProduct.new
     assert_nothing_raised {

data/test/test_helper.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 ENV["RAILS_ENV"] = "test"
 #require File.expand_path(File.dirname(__FILE__) + "/../../../../config/environment")
 require File.expand_path(File.dirname(__FILE__) + "/rails_app/config/environment")
@@ -59,6 +61,11 @@ end
 class Product < ActiveRecord::Base
 end
 
+class ProductWithValidation < Product
+  validates_numericality_of :price
+  validates_presence_of :price
+end
+
 config = YAML.load_file(File.dirname(__FILE__) + '/database.yml')
 ActiveRecord::Base.establish_connection(config['test'])
 

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: delocalize
 version: !ruby/object:Gem::Version 
-  version: 0.1.5
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 6
+  version: 0.1.6
 platform: ruby
 authors: 
 - Clemens Kofler
@@ -9,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-17 00:00:00 +01:00
+date: 2010-05-13 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -20,10 +25,9 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README
+- README.markdown
 files: 
 - MIT-LICENSE
-- README
 - Rakefile
 - VERSION
 - init.rb
@@ -43,6 +47,7 @@ files:
 - tasks/distribution.rb
 - tasks/documentation.rb
 - tasks/testing.rb
+- README.markdown
 has_rdoc: true
 homepage: http://github.com/clemens/delocalize
 licenses: []
@@ -56,18 +61,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Localized date/time and number parsing

data/README

@@ -1,117 +0,0 @@
-delocalize
-==========
-
-delocalize provides localized date/time and number parsing functionality for Rails.
-
-Installation
-============
-
-You can use delocalize either as a gem (preferred) or as a Rails plugin.
-
-To use the gem version, put the following gem requirement in your environment.rb:
-
-  config.gem "delocalize", :source => 'http://gemcutter.org'
-
-To install it as a plugin, fire up your terminal, go to your Rails app and type:
-
-  $ ruby script/plugin install git://github.com/clemens/delocalize.git
-
-
-What does it do? And how do I use it?
-=====================================
-
-Delocalize, just as the name suggest, does pretty much the opposite of localize.
-
-In the grey past, ff you want your users to be able to input localized data, such as dates and numbers, you had to manually override attribute accessors:
-
-  def price=(price)
-    write_attribute(:price, price.gsub(',', '.'))
-  end
-
-delocalize does this under the covers - all you need is your regular translation data (as YAML or Ruby file) where you need Rails' standard translations:
-
-  de:
-    number:
-      format:
-        separator: ','
-        delimiter: '.'
-    date:
-      input:
-        formats: [:default, :long, :short] # <- this and ...
-
-      formats:
-        default: "%d.%m.%Y"
-        short: "%e. %b"
-        long: "%e. %B %Y"
-        only_day: "%e"
-
-      day_names: [Sonntag, Montag, Dienstag, Mittwoch, Donnerstag, Freitag, Samstag]
-      abbr_day_names: [So, Mo, Di, Mi, Do, Fr, Sa]
-      month_names: [~, Januar, Februar, März, April, Mai, Juni, Juli, August, September, Oktober, November, Dezember]
-      abbr_month_names: [~, Jan, Feb, Mär, Apr, Mai, Jun, Jul, Aug, Sep, Okt, Nov, Dez]
-      order: [ :day, :month, :year ]
-
-    time:
-      input:
-        formats: [:long, :medium, :short, :default, :time] # <- ... this are the only non-standard keys
-      formats:
-        default: "%A, %e. %B %Y, %H:%M Uhr"
-        short: "%e. %B, %H:%M Uhr"
-        long: "%A, %e. %B %Y, %H:%M Uhr"
-        time: "%H:%M"
-
-      am: "vormittags"
-      pm: "nachmittags"
-
-For dates and times, you have to define input formats which are taken from the actual formats. The important thing here is to define input formats sorted by descending complexity - in other words: The format which contains the most (preferably non-numeric) information should be first in the list because it can produce the most reliable match. Exception: If you think there most complex format is not the one that most users will input, you can put the most-used in front so you save unnecessary iterations.
-
-Careful with formats containing only numbers: It's very hard to produce reliable matches if you provide multiple strictly numeric formats!
-
-delocalize then overrides to_input_field_tag in ActionView's InstanceTag so you can use localized text fields:
-
-  <% form_for @product do |f| %>
-    <%= f.text_field :name %>
-    <%= f.text_field :released_on %>
-    <%= f.text_field :price %>
-  <% end %>
-  
-In this example, a user can enter the release date and the price just like he's used to in his language, for example:
-
-  Name: "Couch"
-  Released on: "12. Oktober 2009"
-  Price: "2.999,90"
-
-When saved, ActiveRecord automatically converts these to a regular Ruby date and number.
-
-Edit forms then also show localized dates/numbers. By default, dates and times are localized using the format named :default in your locale file. So with the above locale file, dates would use "%d.%m.%Y" and times would use "%A, %e. %B %Y, %H:%M Uhr". Numbers are also formatted using your locale's thousands delimiter and decimal separator.
-
-You can also customize the output using some options:
-
-  The price should always show two decimal digits and we don't need the delimiter:
-    <%= f.text_field :price, :precision => 2, :delimiter => '' %>
-  
-  The released_on date should be shown in the :full format:
-    <%= f.text_field :released_on, :format => :full %>
-  
-  Since I18n.localize supportes localizing strftime strings, we can also do this:
-    <%= f.text_field :released_on, :format => "%B %Y" %>
-
-Note
-====
-
-delocalize is most definitely not enterprise-ready! ;-)
-Or as Yaroslav says: Contains small pieces. Not good for children of age 3 and less. Not enterprise-ready.
-
-TODO
-====
-
-* Improve test coverage
-* Separate Ruby/Rails stuff to make it usable outside Rails
-* Verify correct behavior with time zones
-* Decide on other ActionView hacks (e.g. text_field_tag)
-* Implement AM/PM support
-* Cleanup, cleanup, cleanup ...
-
-Copyright (c) 2009 Clemens Kofler <clemens@railway.at>
-www.railway.at
-Released under the MIT license