amount_field 1.4.0

data/History.txt

@@ -0,0 +1,38 @@
+== 1.4.0 2009-10-06
+
+* fix: negative values like '-1,00', '-1,0', '-1,' or '-1' are considered valid
+* add test for '-value' and '+value'
+* more test values and easier usage in tests
+
+== 1.3.0 2009-09-06
+
+* fix: helper amount_field_tag no works as expected (accepting name and value instead of object and method)
+* add helper amount_field for ActionView::Base and amount_field for ActionView::Helpers::FormBuilder
+* use an instance variable internally for the original assigned value and remove class AssignedValue
+
+== 1.2.0 2009-09-04
+
+* fix: an invalid value is still invalid after multiple calls to valid?
+
+== 1.1.0 2009-08-31
+
+* Fix "undefined method `to_f' for [...]:Array" by supported attribute of type float 
+  (even if it is not a good idea to use float for amount because of rounding errors)
+* Default configuration uses I18n.t('number.amount_field.format') from the plugin file
+  amount_field/locale/(en|de).yml. This means the default configuration depends on I18n.locale
+  and is not necessarily the german format by default anymore.
+* The delimiter, separator and precision are now optional, so "1.234,00", "1234,00" and "1234" are
+  all valid at the same time.
+
+== 1.0.2 2009-08-07
+
+* fix typo and update readme concerning installation
+
+== 1.0.1 2009-08-07
+
+* Bugfix: a given format option for one amount field does not manipulate the default configuration
+
+== 1.0.0 2009-07-28
+
+* Initial release
+

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [Thomas Baustert]
+
+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/Manifest

@@ -0,0 +1,20 @@
+History.txt
+MIT-LICENSE
+Manifest
+README.rdoc
+Rakefile
+init.rb
+install.rb
+lib/amount_field.rb
+lib/amount_field/configuration.rb
+lib/amount_field/form_helper.rb
+lib/amount_field/form_tag_helper.rb
+lib/amount_field/validations.rb
+locale/de.yml
+locale/en.yml
+test/form_helper_test.rb
+test/form_tag_helper_test.rb
+test/models/test_product.rb
+test/test_helper.rb
+test/validations_test.rb
+uninstall.rb

data/README.rdoc

@@ -0,0 +1,181 @@
+= AmountField
+
+Rails gem/plugin that accepts (amount) values in german or us format like 1.234,56 or 1,234.56".
+
+Only tested for Rails 2.3. It may works with older versions but I haven't tested it.
+Drop me a line if you encounter problems.
+
+== Installation
+
+As Gem:
+
+  $ gem sources -a http://gems.github.com (you only have to do this once)
+  $ sudo gem install thomasbaustert-amount_field
+
+As plugin:
+
+  $ script/plugin install git://github.com/thomasbaustert/amount_field.git
+
+== Example
+
+First: Use the helper <tt>amount_field</tt> instead of the <tt>text_field</tt> helper:
+
+  <% form_for(@product) do |f| %>
+    <%= f.amount_field :price %>
+     ...    
+  <% end %>
+
+  <% form_for(@product) do |f| %>
+    <%= amount_field :product, :price %>
+     ...    
+  <% end %>
+
+The helper <tt>amount_field_tag</tt> is provided too, but you have to handle the validation on
+your own:
+
+  <% form_tag(:action => "create", {}) do -%> 
+    <%= amount_field_tag :price, 1234.56 %>
+  ...  
+
+Second: Use the validation macro <tt>validates_amount_format_of</tt> in your model:
+
+  class Product < ActiveRecord::Base
+    validates_amount_format_of :price
+    validates_numericality_of :price
+    validates_presence_of :price
+    ...
+  end
+  
+Note! Make sure you always call <tt>validates_amount_format_of</tt> *before* every 
+other validation macro for the same attribute (e.g. before <tt>validates_numericality_of</tt>
+and <tt>validates_presence_of</tt> for <tt>price</tt>).
+
+== Configuration
+
+The following configuration is supported:
+
+=== Format Configuration
+
+Definition:
+  
+  Delimiter = thousand separator (e.g. '.' in 1.234.567)
+  Separator = separator of value and decimal places (e.g. ',' in 12,56)
+  Precision = number of decimal places
+
+The default format configuration is defined via Rails I18n and accessable through the key
+<tt>number.amount_field.format</tt> from the file <tt>amount_field/locale/(en|de).yml</tt>. 
+
+Example:
+
+  I18n.locale = :de
+  I18n.t('number.amount_field.format') # => { :precision => 2, :delimiter => '.', :separator => ',' }
+
+Currently only the locale <tt>de</tt> and<tt>en</tt> are supported.
+
+If you want to define the default configuration independent from I18n, you can set it as follows:
+
+  AmountField::ActiveRecord::Validations.configuration = 
+    { :precision => 1, :delimiter => ',', :separator => '.' }
+
+An explicitly defined format will overwrite the default configuration for that attribute:
+  
+  validates_amount_format_of :price, :separator => '.', :delimiter => ',', :precision => 1
+  # VALID: "1,234.5" (1234.5)
+
+Standard Rails options like <tt>:allow_blank</tt>, or <tt>:allow_nil</tt> are supported:
+
+  validates_amount_format_of :price, :allow_blank => true
+
+=== CSS class and prefix
+  
+By default the input field contains the CSS class <tt>amount_field</tt> so you can define
+a CSS layout for every amount field like:
+
+  input.amount_field {
+    text-align:right;
+  }
+  
+The method prefix and the CSS class can be changed as follows:
+
+  AmountField::Configuration.prefix = "my_prefix"
+  AmountField::Configuration.css_class = "my_class"
+
+That  will create the html:
+
+  <input name="product[my_prefix_price]" class=" my_class"...
+
+and the appropriate method <tt>my_prefix_price=(value)</tt>.
+
+== Input
+
+By default delimiter, separator and precision are optional, so "1.234,00", "1234,00" and "1234"
+are all valid for the german locale (de) at the same time.
+
+In all other cases the validation will fail and add an error message to the original 
+attribute (e.g. <tt>price</tt>). (See Error Messages)
+
+== Output
+
+The helper <tt>amount_field</tt> uses the Rails helper <tt>number_with_precision</tt> internally
+and passes the plugin format configuration as an argument. A value like 1234.56 is therefore
+displayed as "1.234,56" for the locale <tt>de</tt> and "1,234.56" for the locale <tt>en</tt>.
+
+You can explicitly set the format configuration with the option <tt>format</tt>:
+
+  amount_field(:price, :format => { :separator => '', ... })
+  
+And it is possible to pass the value explicitly:  
+  
+  amount_field(:price, :value => ...)
+
+== Error Messages
+
+By default the german and english messages are taken from the file 
+<tt>amount_field/locale/(en|de).yml</tt> through the key 
+<tt>activerecord.errors.messages.invalid_amount_format</tt>.
+
+You can define your own by adding your Yaml file to the load path like:
+
+  # environment.rb
+  I18n.load_path << "#{RAILS_ROOT}/locale/en.yml"
+
+  # "#{RAILS_ROOT}/locale/en.yml"
+  de:
+    activerecord:
+      errors:
+        messages:
+          invalid_amount_format: "bla ... '{{value}}' blub ...  ({{format_example}})"
+    
+The placeholder <tt>{{value}}</tt> is substituted with the given value (e.g. "1.x") and 
+<tt>{{format_example}}</tt> with a valid example of the currently accepted format (e.g. 'd.ddd,dd').
+
+== How does it work?
+
+Basically the helper <tt>amount_field</tt> defines a input field like so:
+
+  <input name="product[amount_field_price]" class=" amount_field"...
+  
+The validation macro <tt>validates_amount_format_of</tt> defines a special setter method
+<tt>amount_field_price=(value)</tt> that accept the value. After successfully format 
+validation the original parameter is converted to a ruby value (e.g. "1.234,56" to 1234.56)
+and assigned to the original attribute <tt>price</tt>. Following validation macros work on
+the converted value. That's why it is currently important to call 
+<tt>validates_amount_format_of</tt> before every other macro.
+  
+== Running Tests
+
+You need a database <tt>gem_amount_field_test</tt> to run all tests.
+See test_helper.rb for details.
+
+== Credits
+
+* Michael Schiller (for feedback and ideas)
+ 
+== Contact
+
+For comments and question feel free to contact me: business@thomasbaustert.de
+
+If you are using the plugin, consider recommending me at workingwithrails.com:
+http://workingwithrails.com/person/6131-thomas-baustert
+
+Copyright (c) 2009 [Thomas Baustert], released under the MIT license

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('amount_field', '1.4.0') do |p|
+  p.description   = "Rails gem/plugin that accepts (amount) values in german or us format like 1.234,56 or 1,234.56"
+  p.url           = "http://github.com/thomasbaustert/amount_field"
+  p.author        = "Thomas Baustert"
+  p.email         =" business@thomasbaustert.de"
+  p.ignore_pattern = ["tmp/*", "script/*"]
+  p.development_dependencies = []
+end

data/amount_field.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{amount_field}
+  s.version = "1.4.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Thomas Baustert"]
+  s.date = %q{2009-10-06}
+  s.description = %q{Rails gem/plugin that accepts (amount) values in german or us format like 1.234,56 or 1,234.56}
+  s.email = %q{ business@thomasbaustert.de}
+  s.extra_rdoc_files = ["README.rdoc", "lib/amount_field.rb", "lib/amount_field/configuration.rb", "lib/amount_field/form_helper.rb", "lib/amount_field/form_tag_helper.rb", "lib/amount_field/validations.rb"]
+  s.files = ["History.txt", "MIT-LICENSE", "Manifest", "README.rdoc", "Rakefile", "init.rb", "install.rb", "lib/amount_field.rb", "lib/amount_field/configuration.rb", "lib/amount_field/form_helper.rb", "lib/amount_field/form_tag_helper.rb", "lib/amount_field/validations.rb", "locale/de.yml", "locale/en.yml", "test/form_helper_test.rb", "test/form_tag_helper_test.rb", "test/models/test_product.rb", "test/test_helper.rb", "test/validations_test.rb", "uninstall.rb", "amount_field.gemspec"]
+  s.homepage = %q{http://github.com/thomasbaustert/amount_field}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Amount_field", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{amount_field}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Rails gem/plugin that accepts (amount) values in german or us format like 1.234,56 or 1,234.56}
+  s.test_files = ["test/form_helper_test.rb", "test/form_tag_helper_test.rb", "test/models/test_product.rb", "test/test_helper.rb", "test/validations_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/init.rb

@@ -0,0 +1,4 @@
+# Include hook code here
+
+require 'amount_field'
+

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/amount_field.rb

@@ -0,0 +1,22 @@
+# AmountField
+
+require 'amount_field/validations'
+require 'amount_field/form_helper'
+require 'amount_field/form_tag_helper'
+
+ActiveRecord::Base.class_eval do
+  include AmountField::ActiveRecord::Validations
+end
+
+ActionView::Helpers::FormBuilder.class_eval do
+  include AmountField::Helpers::FormBuilder
+end
+
+ActionView::Base.class_eval do
+  include AmountField::Helpers::FormHelper
+  include AmountField::Helpers::FormTagHelper
+end
+
+I18n.load_path << "#{File.dirname(__FILE__)}/../locale/en.yml"
+I18n.load_path << "#{File.dirname(__FILE__)}/../locale/de.yml"
+

data/lib/amount_field/configuration.rb

@@ -0,0 +1,20 @@
+module AmountField
+  class Configuration
+
+    ##
+    # Defines the prefix for the special setter method name: 
+    #   def #{prefix}_xxx=(value) ...
+    #   end
+    #
+    @@prefix = 'amount_field'
+    mattr_accessor :prefix
+
+    ##
+    # Defines the CSS class name for the <tt>amount_field</tt> helper.
+    #   <input ...class="... #{css_class}" .../>
+    #
+    @@css_class = 'amount_field'
+    mattr_accessor :css_class
+    
+  end
+end

data/lib/amount_field/form_helper.rb

@@ -0,0 +1,62 @@
+module AmountField #:nodoc:
+  module Helpers #:nodoc:
+
+    module FormHelper #:nodoc:
+
+      include ActionView::Helpers::NumberHelper
+
+      def amount_field(object_name, method, 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) || {})
+
+        object = options.delete(:object) || instance_variable_get("@#{object_name}")
+        
+        # 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.
+        unless object.errors.on(method)
+          options[:value] ||= number_with_precision(object.send(method), format_options)
+        else
+          options[:value] ||= object.send("#{method}_before_type_cast")
+        end
+        options[:name]  = "#{object_name}[#{AmountField::Configuration.prefix}_#{method}]"
+        options[:class] = "#{options[:class]} #{AmountField::Configuration.css_class}"
+        options[:id]    ||= "#{object_name}_#{method}"
+
+        text_field(object_name, method, options)
+      end
+
+    end
+
+    module FormBuilder #:nodoc:
+
+      include ActionView::Helpers::NumberHelper
+
+      def amount_field(method, options = {})
+        #todo try to remove redundant code by using: @template.amount_field(object, method, 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 (explicit_object = options.delete(:object))
+          self.object = explicit_object
+        end
+            
+        # 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.
+        unless object.errors.on(method)
+          options[:value] ||= number_with_precision(object.send(method), format_options)
+        else
+          options[:value] ||= object.send("#{method}_before_type_cast")
+        end
+        options[:name]  = "#{object_name}[#{AmountField::Configuration.prefix}_#{method}]"
+        options[:class] = "#{options[:class]} #{AmountField::Configuration.css_class}"
+        
+        text_field(method, options)
+      end
+
+    end
+
+  end
+end
+

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