louche 0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4fb1ff2a90ab738a9cc157e1941ad7f81a8766db
-  data.tar.gz: 5cfc8efcf777ef57f988c788715ad197549ba682
+  metadata.gz: 839b489c21dd4febb6445eac53431b1311f963c8
+  data.tar.gz: cd5ff1e1590caae21eccbc39827ef606a827fd9e
 SHA512:
-  metadata.gz: b2485bba9066234d23c656ea1b50676737eaeda547f60e0c7b08d2e842e36baf05a8eb3efdc8a14c66e14ae94a8a1ad6447224e129c0f5991d02296e95ebd630
-  data.tar.gz: 1442e35ad3da1b2fa5029fcc13e3fffe7d2726f4bae934d0fb2b3083b18a338f5531bd2b3aabd53d737906c80254ff796ccb25b2de9ef49f2ee7a11503b988fe
+  metadata.gz: 031b9b212bb204a480757619a23cc2461d7cade08399be80805db6842d1e545d29676d02640dff102d2eaa78902e5f06e46741556ee4739641f7a1343bbc008b
+  data.tar.gz: a7376d5cc340e05ec58296b91e33ffc842d0a48eaa7a29bb1dfdec7a0fed541c7c26acfe09a7f9647e3c8794f728667dafc8c4c2243f1c42e53ab9526a9434f1

data/README.md

@@ -1,6 +1,6 @@
 <p align="center">
-  <a href="https://github.com/mirego/microscope">
-    <img src="http://i.imgur.com/FhNZIjg.png" alt="Louche" />
+  <a href="https://github.com/mirego/louche">
+    <img src="http://i.imgur.com/qCu7dpr.png" alt="Louche" />
   </a>
   <br />
   Louche adds common validators for ActiveModel/ActiveRecord classes.
@@ -25,6 +25,8 @@ Louche provides a few validators to use in your ActiveModel/ActiveRecord classes
 
 ### `EmailValidator`
 
+#### Example
+
 ```ruby
 class User < ActiveRecord::Base
   validates :email, email: true
@@ -34,8 +36,17 @@ User.new(email: 'foo@example.com').valid? # => true
 User.new(email: 'foo@example').valid? # => false
 ```
 
+#### Options
+
+| Option     | Description
+|------------|-----------------------------------------------------
+| `:regex`   | The regex used to validate the email (default: `/\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\z/i`)
+| `:message` | The ActiveRecord message added to the record errors (default: `:invalid_email`)
+
 ### `URLValidator`
 
+#### Example
+
 ```ruby
 class User < ActiveRecord::Base
   validates :website, url: true
@@ -45,8 +56,17 @@ User.new(website: 'http://example.com').valid? # => true
 User.new(website: 'example.$$$').valid? # => false
 ```
 
+#### Options
+
+| Option     | Description
+|------------|-----------------------------------------------------
+| `:schemes` | The URI schemes to allow (default: `%w(http https)`)
+| `:message` | The ActiveRecord message added to the record errors (default: `:invalid_url`)
+
 ### `PhoneNumberValidator`
 
+#### Example
+
 ```ruby
 class User < ActiveRecord::Base
   validates :phone_number, phone_number: true
@@ -61,8 +81,18 @@ user.valid? # => false
 user.phone_number # '5552525'
 ```
 
+#### Options
+
+| Option           | Description
+|------------------|-----------------------------------------------------
+| `:regex`         | The regex used to validate the number (default: `/\A\d{10,}\z/`)
+| `:cleanup_regex` | The regex used to validate clean the input before validating/saving it (default: `/[^\d]/`)
+| `:message`       | The ActiveRecord message added to the record errors (default: `:invalid_phone_number`)
+
 ### `PostalCodeValidator`
 
+#### Example
+
 ```ruby
 class User < ActiveRecord::Base
   validates :postal_code, postal_code: true
@@ -77,8 +107,18 @@ user.valid? # => false
 user.postal_code # => 'L0L'
 ```
 
+#### Options
+
+| Option           | Description
+|------------------|-----------------------------------------------------
+| `:regex`         | The regex used to validate the code (default: `/\A[a-z]\d[a-z]\d[a-z]\d\z/i`)
+| `:cleanup_regex` | The regex used to validate clean the input before validating/saving it (default: `/[^a-z0-9]/i`)
+| `:message`       | The ActiveRecord message added to the record errors (default: `:invalid_postal_code`)
+
 ### `ArrayValidator`
 
+#### Example
+
 ```ruby
 class Tag < Struct.new(:name)
   def valid?
@@ -98,6 +138,29 @@ User.new(tags: ['food', 'beer', 'code']).valid? # => true
 User.new(tags: ['food', '', 'code']).valid? # => false
 ```
 
+#### Options
+
+| Option             | Description
+|--------------------|-----------------------------------------------------
+| `:message`         | The ActiveRecord message added to the record errors (default: `:invalid_array`)
+| `:validity_method` | The method that will be sent to each array item (default: `:valid?`)
+
+## Localized error messages
+
+Louche uses standard ActiveRecord messages. Here’s what your
+`config/locales/activerecord.en.yml` file could look like:
+
+```yaml
+en:
+  errors:
+    messages:
+      invalid_email: is not a valid email address
+      invalid_url: is not a valid URL
+      invalid_phone_number: is not a valid phone number
+      invalid_postal_code: is not a valid postal code
+      invalid_array: contains invalid items
+```
+
 ## License
 
 `Louche` is © 2014 [Mirego](http://www.mirego.com) and may be freely distributed under the [New BSD license](http://opensource.org/licenses/BSD-3-Clause).  See the [`LICENSE.md`](https://github.com/mirego/louche/blob/master/LICENSE.md) file.

data/lib/louche/validators/array_validator.rb

@@ -1,12 +1,14 @@
 class ArrayValidator < ActiveModel::EachValidator
   def initialize(options)
     options.reverse_merge!(message: :invalid_array)
+    options.reverse_merge!(validity_method: :valid?)
     super
   end
 
   def validate_each(record, attribute, value)
     if value.is_a?(Array)
-      add_error(record, attribute, value) if value.empty? || !value.map.all?(&:valid?)
+      validity_method = options.fetch(:validity_method)
+      add_error(record, attribute, value) if value.empty? || !value.map.all?(&validity_method)
     else
       add_error(record, attribute, value)
     end

data/lib/louche/validators/phone_number_validator.rb

@@ -1,7 +1,7 @@
 class PhoneNumberValidator < ActiveModel::EachValidator
   def initialize(options)
     options.reverse_merge!(message: :invalid_phone_number)
-    options.reverse_merge!(regex: /\d{10,}/)
+    options.reverse_merge!(regex: /\A\d{10,}\z/)
     options.reverse_merge!(cleanup_regex: /[^\d]/)
     super
   end

data/lib/louche/validators/postal_code_validator.rb

@@ -1,7 +1,7 @@
 class PostalCodeValidator < ActiveModel::EachValidator
   def initialize(options)
     options.reverse_merge!(message: :invalid_postal_code)
-    options.reverse_merge!(regex: /^[a-z]\d[a-z]\d[a-z]\d$/i)
+    options.reverse_merge!(regex: /\A[a-z]\d[a-z]\d[a-z]\d\z/i)
     options.reverse_merge!(cleanup_regex: /[^a-z0-9]/i)
     super
   end

data/lib/louche/version.rb

@@ -1,3 +1,3 @@
 module Louche
-  VERSION = '0.1'
+  VERSION = '0.1.1'
 end

data/spec/validators/array_validator_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe ArrayValidator do
   describe :validate_each do
     let(:validator) { described_class.new(options) }
-    let(:options) { { attributes: [attribute] } }
+    let(:options) { { attributes: [attribute], validity_method: validity_method } }
     let(:record) { double('ActiveRecord::Base', errors: errors) }
     let(:errors) { double('ActiveModel::Errors') }
     let(:attribute) { :items }
@@ -21,29 +21,60 @@ describe ArrayValidator do
       specify { validator.validate_each(record, attribute, value) }
     end
 
-    let(:valid_item) { double('ArrayItem', valid?: true) }
-    let(:invalid_item) { double('ArrayItem', valid?: false) }
+    context 'with default validity method' do
+      let(:validity_method) { :valid? }
+      let(:valid_item) { double('ArrayItem', valid?: true) }
+      let(:invalid_item) { double('ArrayItem', valid?: false) }
 
-    context 'with an invalid value' do
-      context 'with non-Array valud' do
-        let(:value) { valid_item }
-        it_behaves_like 'an erroneous validator'
-      end
+      context 'with an invalid value' do
+        context 'with non-Array value' do
+          let(:value) { valid_item }
+          it_behaves_like 'an erroneous validator'
+        end
+
+        context 'with value containing invalid item' do
+          let(:value) { [valid_item, invalid_item] }
+          it_behaves_like 'an erroneous validator'
+        end
 
-      context 'with value containing invalid item' do
-        let(:value) { [valid_item, invalid_item] }
-        it_behaves_like 'an erroneous validator'
+        context 'with empty value' do
+          let(:value) { [] }
+          it_behaves_like 'an erroneous validator'
+        end
       end
 
-      context 'with empty value' do
-        let(:value) { [] }
-        it_behaves_like 'an erroneous validator'
+      context 'with valid value' do
+        let(:value) { [valid_item, valid_item, valid_item] }
+        it_behaves_like 'a successful validator'
       end
     end
 
-    context 'with valid value' do
-      let(:value) { [valid_item, valid_item, valid_item] }
-      it_behaves_like 'a successful validator'
+    context 'with custom validity method' do
+      let(:validity_method) { :really_valid? }
+      let(:valid_item) { double('ArrayItem', really_valid?: true) }
+      let(:invalid_item) { double('ArrayItem', really_valid?: false) }
+
+      context 'with an invalid value' do
+        context 'with non-Array value' do
+          let(:value) { valid_item }
+          it_behaves_like 'an erroneous validator'
+        end
+
+        context 'with value containing invalid item' do
+          let(:value) { [valid_item, invalid_item] }
+          it_behaves_like 'an erroneous validator'
+        end
+
+        context 'with empty value' do
+          let(:value) { [] }
+          it_behaves_like 'an erroneous validator'
+        end
+      end
+
+      context 'with valid value' do
+        let(:value) { [valid_item, valid_item, valid_item] }
+        it_behaves_like 'a successful validator'
+      end
     end
   end
 end

data/spec/validators/phone_number_validator_spec.rb

@@ -51,6 +51,12 @@ describe PhoneNumberValidator do
 
         it_behaves_like 'a successful validator'
       end
+
+      context 'containing trailing characters' do
+        let(:value) { '  514 555-2525  ' }
+        let(:expected_stored_value) { '5145552525' }
+        it_behaves_like 'a successful validator'
+      end
     end
   end
 end

data/spec/validators/postal_code_validator_spec.rb

@@ -53,6 +53,13 @@ describe PostalCodeValidator do
 
         it_behaves_like 'a successful validator'
       end
+
+      context 'with trailing characters' do
+        let(:value) { '  G0R2T0  ' }
+        let(:expected_stored_value) { 'G0R2T0' }
+
+        it_behaves_like 'a successful validator'
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: louche
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: 0.1.1
 platform: ruby
 authors:
 - Rémi Prévost
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-01 00:00:00.000000000 Z
+date: 2014-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel