amount_field_rails3 3.0.0

data/lib/amount_field/form_tag_helper.rb

@@ -0,0 +1,22 @@
+module AmountField #:nodoc:
+  module Helpers #:nodoc:
+    module FormTagHelper
+      include ActionView::Helpers::NumberHelper
+
+      def amount_field_tag(name, value = nil, options = {})
+        format_options = I18n.t(:'number.amount_field.format', :raise => true) rescue {}
+        format_options = format_options.merge(AmountField::ActiveRecord::Validations.configuration)
+        format_options.merge!(options.delete(:format) || {})
+  
+        # if no explicit value is given, we set a formatted one. In case of an error we take the
+        # original value inserted by the user.
+        options[:value] ||= number_with_precision(value.to_s, format_options)
+        options[:name]  = "#{AmountField::Configuration.prefix}_#{name}"
+        options[:class] = "#{options[:class]} #{AmountField::Configuration.css_class}"
+
+        text_field_tag(name, value, options)
+      end
+    
+    end
+  end
+end

data/lib/amount_field/validations.rb

@@ -0,0 +1,129 @@
+module AmountField #:nodoc:
+  module ActiveRecord #:nodoc: 
+    module Validations
+
+      @@configuration = {}
+      mattr_accessor :configuration
+
+      def self.included(base) # :nodoc:
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        
+        def validates_amount_format_of(*attr_names)
+          # code before validates_each is called only once!
+          configuration = attr_names.extract_options!
+
+          define_special_setter(attr_names, configuration)
+
+          # the following code defines the callbacks methods that are called on every validation
+          validates_each(attr_names, configuration) do |record, attr_name, value|
+            # in case there is no assignment via 'amount_field_XXX=' method, we don't need to validate.
+            next unless record.instance_variable_defined?("@#{special_method_name(attr_name)}")
+
+            # get the original assigned value first to always run the validation for this value!
+            # if we us 'before_type_cast' here, we would get the converted value and not the 
+            # original value if we call the validation twice.
+            original_value = record.instance_variable_get("@#{special_method_name(attr_name)}")
+            original_value ||= record.send("#{attr_name}_before_type_cast") || value
+
+            # in case nil or blank is allowed, we don't validate
+            next if configuration[:allow_nil] and original_value.nil?
+            next if configuration[:allow_blank] and original_value.blank?
+
+            converted_value = convert(original_value, format_configuration(configuration))
+
+            if valid_format?(original_value, format_configuration(configuration))
+              # assign converted value to attribute so other validations macro can work on it 
+              # and the getter returns a value
+              record.send("#{attr_name}=", converted_value)
+            else  
+              # assign original value as AssignedValue so multiple calls of this validation will
+              # consider the value still as invalid.
+              record.send("#{attr_name}=", original_value)
+              record.errors.add(attr_name, 
+                build_error_message(configuration[:message], {
+                  :value => original_value, 
+                  :format_example => valid_format_example(format_configuration(configuration))
+                })
+              )
+            end  
+
+          end
+        end
+        
+        private
+
+          def define_special_setter(attr_names, configuration)
+            attr_names.each do |attr_name| 
+              class_eval <<-EOV
+                def #{special_method_name(attr_name)}=(value)
+                  @#{special_method_name(attr_name)} = value
+                  self[:#{attr_name}] = value
+                end
+                
+                def #{special_method_name(attr_name)}  
+                  @#{special_method_name(attr_name)}
+                end
+              EOV
+            end
+          end
+          
+          def special_method_name(attr_name)
+            "#{AmountField::Configuration.prefix}_#{attr_name}"
+          end
+
+          def convert(original_value, configuration)
+            converted_value = original_value.to_s.gsub(configuration[:delimiter].to_s, '')
+            converted_value = converted_value.sub(configuration[:separator].to_s, '.') unless configuration[:separator].blank?
+            converted_value
+          end
+          
+          # we have to read the configuration every time to get the current I18n value
+          def format_configuration(configuration)
+            format_options = I18n.t(:'number.amount_field.format', :raise => true) rescue {}
+            # update it with a maybe given default configuration                         
+            format_options = format_options.merge(AmountField::ActiveRecord::Validations.configuration)
+            # update it with a maybe given explicit configuration via the macro                         
+            format_options.update(configuration)
+          end
+
+          def valid_format?(value, configuration)
+            return false if !value.kind_of?(String) || value.blank?
+
+            # add ,00 to 1234 
+            if !value.include?(configuration[:separator].to_s) && !configuration[:separator].blank?
+              value = "#{value}#{configuration[:separator]}#{'0' * configuration[:precision].to_i}"
+            end   
+
+            cs = configuration[:separator]
+            cd = "\\#{configuration[:delimiter] || ' '}"
+            cp = configuration[:precision]
+
+            # (1234 | 123.456),00 
+            !(value =~ /\A[-\+]{0,1}((\d*)|(\d{0,3}(#{cd}\d{3})*))#{cs}\d{0,#{cp}}\z/).nil?
+          end
+          
+          def valid_format_example(configuration)
+            s = 'd'
+            s << "#{configuration[:delimiter]}" unless configuration[:delimiter].nil?
+            s << "ddd"
+            s << "#{configuration[:separator]}" unless configuration[:separator].nil?
+            s << "#{'d' * configuration[:precision].to_i}" unless configuration[:precision].nil?
+            s
+          end
+
+          def build_error_message(explicit_message, options = {})
+            if explicit_message.blank?
+              I18n.t('errors.messages.invalid_amount_format', options)
+            else
+              I18n.interpolate(explicit_message, options)
+            end
+          end
+          
+      end
+      
+    end
+  end
+end

data/lib/amount_field/version.rb

@@ -0,0 +1,3 @@
+module AmountField
+  VERSION = "3.0.0"
+end

data/locale/de.yml

@@ -0,0 +1,10 @@
+de:
+  errors:
+    messages:
+      invalid_amount_format: "'%{value}' ist ein ungültiges Format (%{format_example})"
+  number:
+    amount_field:
+      format:
+        separator: ","
+        delimiter: "."
+        precision: 2

data/locale/en.yml

@@ -0,0 +1,11 @@
+en:
+  errors:
+    messages:
+      invalid_amount_format: "'%{value}' is not a valid amount format (%{format_example})"
+  number:
+    amount_field:
+      format:
+        separator: "."
+        delimiter: ","
+        precision: 2
+        

data/test/form_helper_test.rb

@@ -0,0 +1,264 @@
+# -*- encoding: utf-8 -*-
+
+require 'test_helper'
+
+##
+# Taken from the FormHelperTest in Rails 2.3
+#
+# We are testing the FormBuilder- and FormHelper-Version at once.
+#
+class FormHelperTest < ActionView::TestCase
+  tests AmountField::Helpers::FormHelper
+
+  class MyFormBuilder < ActionView::Helpers::FormBuilder
+  end
+
+  def setup
+    @controller = Class.new do
+      attr_reader :url_for_options
+      def url_for(options)
+        @url_for_options = options
+        "http://www.example.com"
+      end
+    end
+    @controller = @controller.new
+    @test_product = TestProduct.new(:price => 1234.56)
+
+    AmountField::Configuration.prefix = 'amount_field'
+    AmountField::Configuration.css_class = 'amount_field'
+  end
+  
+  def test_products_path
+    "/products"
+  end
+
+  def test_product_path
+    "/products"
+  end
+  
+  test "amount_field form helper with locale de" do
+    with_locale('de') do
+      output_buffer = form_for(@test_product, :builder => MyFormBuilder) do |f|
+        concat f.amount_field(:price)
+      end
+
+      expected_input =
+        "<input class=' amount_field' id='test_product_price'" +
+        " name='test_product[amount_field_price]' size='30' type='text' value='1.234,56' />"
+    
+      assert_dom_equal expected_input, amount_field(:test_product, :price)
+      assert_dom_equal expected_form(expected_input), output_buffer
+    end  
+  end
+
+  test "amount_field form helper with locale en" do
+    with_locale('en') do
+      output_buffer = form_for(@test_product, :builder => MyFormBuilder) do |f|
+        concat f.amount_field(:price)
+      end
+
+      expected_input =
+        "<input name='test_product[amount_field_price]' size='30' type='text'" +
+        " class=' amount_field' id='test_product_price' value='1,234.56' />"
+
+      assert_dom_equal expected_input, amount_field(:test_product, :price)
+      assert_dom_equal expected_form(expected_input), output_buffer
+    end  
+  end
+
+  test "configured prefix is use in amount_field" do
+    with_locale('de') do
+      AmountField::Configuration.prefix = 'my_prefix'
+      output_buffer = form_for(@test_product, :builder => MyFormBuilder) do |f|
+        concat f.amount_field(:price)
+      end
+
+      expected_input =
+        "<input class=' amount_field' name='test_product[my_prefix_price]' size='30' type='text'" +
+        " id='test_product_price' value='1.234,56' />"
+      
+      assert_dom_equal expected_input, amount_field(:test_product, :price)
+      assert_dom_equal expected_form(expected_input), output_buffer
+      AmountField::Configuration.prefix = 'amount_field'
+    end  
+  end
+  
+  test "configured css class is use in amount_field" do
+    with_locale('de') do
+      AmountField::Configuration.css_class = 'my_class'
+      output_buffer = form_for(@test_product, :builder => MyFormBuilder) do |f|
+        concat f.amount_field(:price)
+      end
+
+      expected_input =
+        "<input name='test_product[amount_field_price]' size='30' type='text'" +
+        " class=' my_class' id='test_product_price' value='1.234,56' />"
+
+      assert_dom_equal expected_input, amount_field(:test_product, :price)
+      assert_dom_equal expected_form(expected_input), output_buffer
+      AmountField::Configuration.css_class = 'amount_field'
+    end  
+  end
+
+  test "default configuration format overwrite I18n configuration" do
+    with_configuration({ :delimiter => '@', :separator => '/', :precision => 2}) do
+      output_buffer = form_for(@test_product, :builder => MyFormBuilder) do |f|
+        concat f.amount_field(:price)
+      end
+
+      expected_input =
+        "<input name='test_product[amount_field_price]' size='30' type='text'" +
+        " class=' amount_field' id='test_product_price' value='1@234/56' />"
+
+      assert_dom_equal expected_input, amount_field(:test_product, :price)
+      assert_dom_equal expected_form(expected_input), output_buffer
+    end  
+  end
+
+  test "explicit format overwrite default configuration" do
+    format = { :delimiter => '@', :separator => '/', :precision => 3 }
+    with_locale('de') do
+      output_buffer = form_for(@test_product, :builder => MyFormBuilder) do |f|
+        concat f.amount_field(:price, :format => format)
+      end
+
+      expected_input =
+        "<input name='test_product[amount_field_price]' size='30' type='text'" +
+        " class=' amount_field' id='test_product_price' value='1@234/560' />"
+
+      assert_dom_equal expected_input, amount_field(:test_product, :price, :format => format)
+      assert_dom_equal expected_form(expected_input), output_buffer
+      assert_equal({}, AmountField::ActiveRecord::Validations.configuration)
+    end                
+  end
+  
+  test "we show the original value for an invalid value" do
+    @test_product = TestProduct.new(:amount_field_price => "x")
+    @test_product.valid?
+    output_buffer = form_for(@test_product, :builder => MyFormBuilder) do |f|
+      concat f.amount_field(:price)
+    end
+
+    expected_input =
+      "<div class='field_with_errors'>" +
+      "<input name='test_product[amount_field_price]' size='30'" + 
+      "       class=' amount_field' type='text' id='test_product_price' value='x' />" +
+      "</div>" 
+
+    assert_dom_equal expected_input, amount_field(:test_product, :price)
+    assert_dom_equal expected_form(expected_input), output_buffer
+  end
+  
+  test "we show the given value instead of the invalid value" do
+    @test_product = TestProduct.new(:amount_field_price => "x")
+    @test_product.valid?
+    output_buffer = form_for(@test_product, :builder => MyFormBuilder) do |f|
+      concat f.amount_field(:price, :value => 4711)
+    end
+
+    expected_input =
+      "<div class='field_with_errors'>" +
+      "<input name='test_product[amount_field_price]' size='30'" + 
+      "       class=' amount_field' type='text' id='test_product_price' value='4711' />" +
+      "</div>" 
+    
+    assert_dom_equal expected_input, amount_field(:test_product, :price, :value => 4711)
+    assert_dom_equal expected_form(expected_input), output_buffer
+  end
+
+  test "we use the object from options if given" do
+    @test_product1 = TestProduct.new(:amount_field_price => "6543.21")
+    @test_product1.valid?
+    test_product2 = TestProduct.new(:amount_field_price => "1234.56")
+    test_product2.valid?
+    output_buffer = form_for(@test_product1, :builder => MyFormBuilder) do |f|
+      concat f.amount_field(:price, :object => test_product2)
+    end
+
+    expected_input =
+      "<input name='test_product[amount_field_price]' size='30'" + 
+      "       class=' amount_field' type='text' id='test_product_price' value='1,234.56' />"
+    
+    assert_dom_equal expected_input, amount_field(:test_product, :price, :object => test_product2)
+    assert_dom_equal expected_form(expected_input), output_buffer
+  end
+  
+  test "consider option name if given" do
+    @test_product = TestProduct.new(:amount_field_price => "47.11")
+    output_buffer = form_for(@test_product, :builder => MyFormBuilder) do |f|
+      concat f.amount_field(:price, :name => 'article')
+    end
+
+    expected_input =
+      "<input name='article' size='30'" + 
+      "       class=' amount_field' type='text' id='test_product_price' value='47.11' />"
+    
+    assert_dom_equal expected_input, amount_field(:test_product, :price, :name => 'article', :value => 47.11)
+    assert_dom_equal expected_form(expected_input), output_buffer
+  end
+
+  test "consider option id if given" do
+    @test_product = TestProduct.new(:amount_field_price => "63.41")
+    output_buffer = form_for(@test_product, :builder => MyFormBuilder) do |f|
+      concat f.amount_field(:price, :name => 'article', :id => 'my_id')
+    end
+
+    expected_input =
+      "<input name='article' size='30'" + 
+      "       class=' amount_field' type='text' id='my_id' value='63.41' />"
+    
+    assert_dom_equal expected_input, amount_field(:test_product, :price, :name => 'article', :id => 'my_id', :value => 63.41)
+    assert_dom_equal expected_form(expected_input), output_buffer
+  end
+
+  test "invalid negative value is displayed with current format options" do
+    with_locale('de') do
+      class MyTestProduct < ActiveRecord::Base
+        set_table_name 'test_products'
+        validates_amount_format_of :price
+        validates_numericality_of :price, :greater_than_or_equal_to => 0.0
+      end
+      @test_product = MyTestProduct.new(:amount_field_price => "-0,1")
+      @test_product.valid?
+
+      output_buffer = form_for(@test_product, :url => test_products_path, :builder => MyFormBuilder) do |f|
+        concat f.amount_field(:price)
+      end
+
+      assert_match /value="-0,1"/, output_buffer
+    end
+  end
+
+  test "invalid positive value is displayed with current format options" do
+    with_locale('de') do
+      class MyTestProduct < ActiveRecord::Base
+        set_table_name 'test_products'
+        validates_amount_format_of :price
+        validates_numericality_of :price, :less_than_or_equal_to => 10.0
+      end
+      @test_product = MyTestProduct.new(:amount_field_price => "12,34")
+      @test_product.valid?
+
+      output_buffer = form_for(@test_product, :url => test_products_path, :builder => MyFormBuilder) do |f|
+        concat f.amount_field(:price)
+      end
+
+      assert_match /value="12,34"/, output_buffer
+    end
+  end
+  
+  protected
+  
+    def protect_against_forgery?
+      false
+    end
+    
+    def expected_form(expected_input_field)
+      expected_form =
+        "<form accept-charset='UTF-8' action='/products' class='new_test_product' id='new_test_product' method='post'>" +
+        "<div style='margin:0;padding:0;display:inline'>" +
+        "<input name='utf8' type='hidden' value='&#x2713;' /></div>" +
+        "#{expected_input_field}</form>"
+    end
+    
+end

data/test/form_tag_helper_test.rb

@@ -0,0 +1,47 @@
+require 'test_helper'
+
+class FormTagHelperTest < ActionView::TestCase
+  tests AmountField::Helpers::FormTagHelper
+
+  test "return an input field with the special amount field name attribute" do
+    assert_match /name="amount_field_price"/, amount_field_tag(:price, 1234.56)
+  end
+
+  test "return an value attribute with a formatted value for german locale" do
+    with_locale('de') do
+      assert_match /value="1.234,56"/, amount_field_tag(:price, 1234.56)
+    end
+  end
+
+  test "return an value attribute with a formatted value for english locale" do
+    with_locale('en') do
+      assert_match /value="1,234.56"/, amount_field_tag(:price, 1234.56)
+    end
+  end
+
+  test "default css class is used in combination with given class" do
+    assert_match /class="foo #{AmountField::Configuration.css_class}"/, amount_field_tag(:price, 1234.56, :class => 'foo')
+  end
+  
+  test "configured prefix is use in amount_field" do
+    AmountField::Configuration.prefix = 'my_prefix'
+    assert_match /name="my_prefix_price"/, amount_field_tag(:price, 1234.56)
+    AmountField::Configuration.prefix = 'amount_field'
+  end
+
+  test "configured css class is use in amount_field" do
+    AmountField::Configuration.css_class = 'my_class'
+    assert_match /class=" my_class"/, amount_field_tag(:price, 1234.56)
+    AmountField::Configuration.css_class = 'amount_field'
+  end
+
+  test "explicit format overwrite default configuration" do
+    assert_match /value="1@234#560"/, amount_field_tag(:price, 1234.56, :format => { :delimiter => '@', :separator => '#', :precision => 3})
+    assert_equal({}, AmountField::ActiveRecord::Validations.configuration)
+  end
+  
+  test "we show the given value from the options instead of the argument" do
+    assert_match /value="42"/, amount_field_tag(:price, 1234.56, :value => 42)
+  end
+  
+end