formeze 1.2.0 → 1.3.0

data/README.md

@@ -169,3 +169,36 @@ end
 
 Formeze will automatically define optional "utf8" and "authenticity_token"
 fields on every form so that you don't have to specify those manually.
+
+
+Integration with I18n
+---------------------
+
+Formeze integrates with [I18n](http://edgeguides.rubyonrails.org/i18n.html)
+so that you can define custom error messages and field labels within your
+locales (useful both for localization, and when working with designers).
+
+For example, here is how you would change the "required" error message
+(which defaults to "is required"):
+
+```yaml
+# config/locales/en.yml
+en:
+  formeze:
+    errors:
+      required: "cannot be blank"
+```
+
+And here is an example of how you would set a custom label for fields named
+"first_name" (for which the default label would be "First name"):
+
+```yaml
+# config/locales/en.yml
+en:
+  formeze:
+    labels:
+      first_name: "First Name"
+```
+
+Labels defined in this way apply globally to all Formeze forms, but can be
+overridden using the label field option which will take precedence.

data/formeze.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'formeze'
-  s.version = '1.2.0'
+  s.version = '1.3.0'
   s.platform = Gem::Platform::RUBY
   s.authors = ['Tim Craft']
   s.email = ['mail@timcraft.com']
@@ -8,5 +8,6 @@ Gem::Specification.new do |s|
   s.description = 'A little library for handling form data/input'
   s.summary = 'See description'
   s.files = Dir.glob('{lib,spec}/**/*') + %w(README.md Rakefile.rb formeze.gemspec)
+  s.add_development_dependency('i18n', ['~> 0.6.0'])
   s.require_path = 'lib'
 end

data/lib/formeze.rb

@@ -18,22 +18,26 @@ module Formeze
       @name, @options = name, options
     end
 
-    def validate(value, &error)
+    def validate(value, &block)
       if value !~ /\S/ # blank
-        error.call(:'is required') if required?
+        block.call(error(:required, 'is required')) if required?
       else
-        error.call(:'has too many lines') if !multiline? && value.lines.count > 1
+        block.call(error(:not_multiline, 'cannot contain newlines')) if !multiline? && value.lines.count > 1
 
-        error.call(:'has too many characters') if value.chars.count > char_limit
+        block.call(error(:too_long, 'is too long')) if value.chars.count > char_limit
 
-        error.call(:'has too many words') if word_limit? && value.scan(/\w+/).length > word_limit
+        block.call(error(:too_long, 'is too long')) if word_limit? && value.scan(/\w+/).length > word_limit
 
-        error.call(:'is invalid') if pattern? && value !~ pattern
+        block.call(error(:no_match, 'is invalid')) if pattern? && value !~ pattern
 
-        error.call(:'is invalid') if values? && !values.include?(value)
+        block.call(error(:bad_value, 'is invalid')) if values? && !values.include?(value)
       end
     end
 
+    def error(i18n_key, default)
+      translate(i18n_key, scope: [:formeze, :errors], default: default)
+    end
+
     def key
       @key ||= @name.to_s
     end
@@ -43,7 +47,11 @@ module Formeze
     end
 
     def label
-      @label ||= @options.fetch(:label) { Label.new(name) }
+      if @options.has_key?(:label)
+        @options[:label]
+      else
+        translate(name, scope: [:formeze, :labels], default: Label.new(name))
+      end
     end
 
     def required?
@@ -101,6 +109,14 @@ module Formeze
     def defined_unless
       @options.fetch(:defined_unless)
     end
+
+    def translate(key, options)
+      if defined?(I18n)
+        I18n.translate(key, options)
+      else
+        options.fetch(:default)
+      end
+    end
   end
 
   module ArrayAttrAccessor

data/spec/formeze_spec.rb

@@ -1,6 +1,7 @@
 require 'minitest/autorun'
 
-require 'formeze'
+require_relative '../lib/formeze'
+require 'i18n'
 
 class FormWithField
   Formeze.setup(self)
@@ -480,3 +481,29 @@ describe 'RailsForm' do
     end
   end
 end
+
+describe 'I18n integration' do
+  before do
+    I18n.backend = I18n::Backend::Simple.new
+  end
+
+  after do
+    I18n.backend = I18n::Backend::Simple.new
+  end
+
+  it 'should be possible to override the default error messages' do
+    I18n.backend.store_translations :en, {formeze: {errors: {required: 'cannot be blank'}}}
+
+    form = FormWithField.new
+    form.parse('title=')
+    form.errors.first.to_s.must_equal('Title cannot be blank')
+  end
+
+  it 'should be possible to set labels globally' do
+    I18n.backend.store_translations :en, {formeze: {labels: {title: 'TITLE'}}}
+
+    form = FormWithField.new
+    form.parse('title=')
+    form.errors.first.to_s.must_equal('TITLE is required')
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: formeze
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-14 00:00:00.000000000 Z
-dependencies: []
+date: 2012-08-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
 description: A little library for handling form data/input
 email:
 - mail@timcraft.com
@@ -43,7 +59,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.16
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: See description