daily_affirmation 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 067ab891f1fade3f4a26150786cfcc87ee472280
-  data.tar.gz: f05e7558ace028cfecd5b4d9d43220943bf1eaae
+  metadata.gz: 8bebab94b6507fded2c3c6b8620064c31753fbd7
+  data.tar.gz: 7ec0f8b962d6981a99f62d3475524437ecdec690
 SHA512:
-  metadata.gz: cb9978830c16cbce9d3d7e27c028ade54c5ffd3a567600e32a36c1598b1636b105392a44217f75654f09f80c392b063907bb8c7e196b5a0852496ede8dfb794c
-  data.tar.gz: e3288aef6c9dd1ff25b5742199dd2e184973e8fb10d6f4818c5f0f7facf3f8f5a084acb51e337731d3f6b3d900f21566f4dc1ca15a94bbb1422516458d78994f
+  metadata.gz: b73c9f489458982f747535fa715dd90f6a10d8f7cf7814b9f00c247b99aa521f4b53a1a70d56794b38961aabeef41f4722ac98931afd535bc160a21460aa6dbf
+  data.tar.gz: 3cd11055f9b7fc591796320fb951324d522481835e69e8e588bf6360a425f9e642945d8929ce86189d1f13b1c984ba0d8df4022ca8013793aa83a4627ec17e99

data/README.md

@@ -51,12 +51,12 @@ TeamAffirmation.new(team1).valid? #=> false
     
 ## Roadmap
 
-- Provide all the validations ActiveModel does
-- Add a way to build custom validations (example validating a password)
+- Allow error messages to use i18n.
+- Add a way to build custom validations (example validating a password).
 
 ## Contributing
 
-1. Fork it
+1. Fork it ( http://github.com/teamsnap/daily_affirmation/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/daily_affirmation.gemspec

@@ -21,4 +21,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 3.0.0.beta1"
+  spec.add_development_dependency "i18n", "~> 0.6.9"
 end

data/lib/daily_affirmation/validator.rb

@@ -16,11 +16,28 @@ module DailyAffirmation
     end
 
     def error_message
-      raise StandardError, "must implement #error_message"
+      i18n_error_message(:none)
     end
 
     private
 
     attr_accessor :object, :attribute, :value, :opts
+
+    def i18n_error_message(type, default: "#{attribute} failed validation")
+      if defined?(I18n)
+        args = opts.merge(
+          {
+            :default => [
+              :"daily_affirmation.errors.messages.#{type}", default
+            ],
+            :attribute => attribute,
+            :value => value
+          }
+        )
+        I18n.t(:"daily_affirmation.errors.messages.#{type}.#{attribute}", args)
+      else
+        default
+      end
+    end
   end
 end

data/lib/daily_affirmation/validators/absence_validator.rb

@@ -9,7 +9,9 @@ module DailyAffirmation
       end
 
       def error_message
-        @error_message ||= "#{attribute} must be blank"
+        @error_message ||= i18n_error_message(
+          :absence, :default => "#{attribute} must be blank"
+        )
       end
     end
   end

data/lib/daily_affirmation/validators/acceptance_validator.rb

@@ -8,7 +8,9 @@ module DailyAffirmation
       end
 
       def error_message
-        @error_message ||= "#{attribute} must be accepted"
+        @error_message ||= i18n_error_message(
+          :acceptance, :default => "#{attribute} must be accepted"
+        )
       end
     end
   end

data/lib/daily_affirmation/validators/confirmation_validator.rb

@@ -8,7 +8,9 @@ module DailyAffirmation
       end
 
       def error_message
-        @error_message ||= "#{attribute} doesn't match confirmation"
+        @error_message ||= i18n_error_message(
+          :confirmation, :default => "#{attribute} doesn't match confirmation"
+        )
       end
     end
   end

data/lib/daily_affirmation/validators/exclusion_validator.rb

@@ -9,7 +9,9 @@ module DailyAffirmation
       end
 
       def error_message
-        @error_message ||= "#{attribute} is reserved"
+        @error_message ||= i18n_error_message(
+          :exclusion, :default => "#{attribute} is reserved"
+        )
       end
     end
   end

data/lib/daily_affirmation/validators/format_validator.rb

@@ -8,7 +8,9 @@ module DailyAffirmation
       end
 
       def error_message
-        @error_message ||= "#{attribute} is invalid"
+        @error_message ||= i18n_error_message(
+          :format, :default => "#{attribute} is invalid"
+        )
       end
     end
   end

data/lib/daily_affirmation/validators/inclusion_validator.rb

@@ -8,7 +8,10 @@ module DailyAffirmation
       end
 
       def error_message
-        @error_message ||= "#{attribute} is not included in #{opts[:list]}"
+        @error_message ||= i18n_error_message(
+          :inclusion,
+          :default => "#{attribute} is not included in #{opts[:list]}"
+        )
       end
     end
   end

data/lib/daily_affirmation/validators/length_validator.rb

@@ -8,7 +8,10 @@ module DailyAffirmation
       end
 
       def error_message
-        @error_message ||= "#{attribute} is the wrong length (allowed #{opts[:range]})"
+        @error_message ||= i18n_error_message(
+          :length,
+          :default => "#{attribute} is the wrong length (allowed #{opts[:range]})"
+        )
       end
     end
   end

data/lib/daily_affirmation/validators/numericality_validator.rb

@@ -8,7 +8,9 @@ module DailyAffirmation
       end
 
       def error_message
-        @error_message ||= "#{attribute} is not a number"
+        @error_message ||= i18n_error_message(
+          :numericality, :default => "#{attribute} is not a number"
+        )
       end
     end
   end

data/lib/daily_affirmation/validators/presence_validator.rb

@@ -8,7 +8,9 @@ module DailyAffirmation
       end
 
       def error_message
-        @error_message ||= "#{attribute} can't be blank"
+        @error_message ||= i18n_error_message(
+          :presence, :default => "#{attribute} can't be blank"
+        )
       end
 
       private

data/lib/daily_affirmation/version.rb

@@ -1,3 +1,3 @@
 module DailyAffirmation
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/spec/support/default.yml

@@ -0,0 +1,4 @@
+en:
+  daily_affirmation:
+    errors:
+      messages:

data/spec/support/generic.yml

@@ -0,0 +1,5 @@
+en:
+  daily_affirmation:
+    errors:
+      messages:
+        none: "egads man, you must have %{attribute} (%{range}, %{value})"

data/spec/support/specific.yml

@@ -0,0 +1,6 @@
+en:
+  daily_affirmation:
+    errors:
+      messages:
+        none:
+          age: must include age yo!

data/spec/validator_spec.rb

@@ -11,14 +11,55 @@ describe "Validator" do
     )
   end
 
-  it "requires #error_message to be implemented" do
+  it "uses a generic error message if one is not provied" do
     cls = Class.new(DailyAffirmation::Validator) do
       def valid?; false; end
     end
     obj = double(:age => 13)
 
-    expect { cls.new(obj, :age).affirm }.to raise_error(
-      StandardError, "must implement #error_message"
-    )
+    expect(cls.new(obj, :age).error_message).to eq("age failed validation")
+  end
+
+  context "i18n required" do
+    before(:all) { require "i18n" }
+    after(:all) { Object.send(:remove_const, :I18n) if defined?(I18n) }
+
+    it "uses specific translation if available" do
+      I18n.load_path = [File.expand_path("../support/specific.yml", __FILE__)]
+      I18n.backend.load_translations
+
+      cls = Class.new(DailyAffirmation::Validator) do
+        def valid?; false; end
+      end
+      obj = double(:age => 13)
+
+      expect(cls.new(obj, :age).error_message).to eq("must include age yo!")
+    end
+
+    it "uses generic translation if specific is not available" do
+      I18n.load_path = [File.expand_path("../support/generic.yml", __FILE__)]
+      I18n.backend.load_translations
+
+      cls = Class.new(DailyAffirmation::Validator) do
+        def valid?; false; end
+      end
+      obj = double(:age => 13)
+
+      expect(cls.new(obj, :age, :range => 10..20).error_message).to eq(
+        "egads man, you must have age (10..20, 13)"
+      )
+    end
+
+    it "uses default if both translations are unavailable" do
+      I18n.load_path = [File.expand_path("../support/default.yml", __FILE__)]
+      I18n.backend.load_translations
+
+      cls = Class.new(DailyAffirmation::Validator) do
+        def valid?; false; end
+      end
+      obj = double(:age => 13)
+
+      expect(cls.new(obj, :age).error_message).to eq("age failed validation")
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: daily_affirmation
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Shane Emmons
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.0.0.beta1
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.9
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.9
 description: A simple library for external validations of POROs
 email:
 - oss@teamsnap.com
@@ -80,6 +94,9 @@ files:
 - lib/daily_affirmation/version.rb
 - spec/daily_affirmation_spec.rb
 - spec/spec_helper.rb
+- spec/support/default.yml
+- spec/support/generic.yml
+- spec/support/specific.yml
 - spec/validator_spec.rb
 - spec/validators/absence_validator_spec.rb
 - spec/validators/acceptance_validator_spec.rb
@@ -117,6 +134,9 @@ summary: A simple library for external validations of POROs
 test_files:
 - spec/daily_affirmation_spec.rb
 - spec/spec_helper.rb
+- spec/support/default.yml
+- spec/support/generic.yml
+- spec/support/specific.yml
 - spec/validator_spec.rb
 - spec/validators/absence_validator_spec.rb
 - spec/validators/acceptance_validator_spec.rb