louche 0.0.1 → 0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 95dae9aded657e8a50393dff79f4aa990a85a85a
-  data.tar.gz: 77e8c4cd58abda5885700f4ab51958a4909ba985
+  metadata.gz: 4fb1ff2a90ab738a9cc157e1941ad7f81a8766db
+  data.tar.gz: 5cfc8efcf777ef57f988c788715ad197549ba682
 SHA512:
-  metadata.gz: a12afab71e59a21419e1e36d4110ec9acf7c66bb6fcf013d1b4b886b33c618c2fa722a1a2e6ccc7bba45faf2dfccc23082e5b0a4257918496b654b6830c2f9c8
-  data.tar.gz: b3bc2a87ea079190ef8bd1c003a113efcbbb23a13da9ff57c7fdc60b58b420b7eed6b2d2ddade2099e29fea1be95ecd9e93a477cf1fee1975f2b9cd4daf5f0e0
+  metadata.gz: b2485bba9066234d23c656ea1b50676737eaeda547f60e0c7b08d2e842e36baf05a8eb3efdc8a14c66e14ae94a8a1ad6447224e129c0f5991d02296e95ebd630
+  data.tar.gz: 1442e35ad3da1b2fa5029fcc13e3fffe7d2726f4bae934d0fb2b3083b18a338f5531bd2b3aabd53d737906c80254ff796ccb25b2de9ef49f2ee7a11503b988fe

data/.rspec

@@ -0,0 +1 @@
+--colour

data/.travis.yml

@@ -0,0 +1,19 @@
+language: ruby
+
+rvm:
+  - 2.0.0
+  - 1.9.3
+
+gemfile:
+  - gemfiles/Gemfile.activemodel-4.1
+  - gemfiles/Gemfile.activemodel-4.0
+
+script: "echo 'DO IT' && bundle exec rake spec"
+
+notifications:
+  hipchat:
+    rooms:
+      secure: "TF6e2Z/HSTFH2g5j8kILrJvEMyYF6Lx5uFIFp/VbTHc6XzaZ1Ot5DjcZr8aychcObYKNVW01/DTCcJ9Acs1GOVuBVgUZbRWUhvlBVAOAElYLJhOTDveYUiARXIwnmXgOZmZRuBagJqqHKBzoIo8XTO3l68txs1tHZA+sSvNJoWQ="
+    template:
+      - '%{repository}#%{build_number} (%{branch} - %{commit} : %{author}): %{message} (<a href="%{build_url}">Build</a>/<a href="%{compare_url}">Changes</a>)'
+    format: 'html'

data/Gemfile

@@ -1,4 +1,2 @@
 source 'https://rubygems.org'
-
-# Specify your gem's dependencies in louche.gemspec
 gemspec

data/README.md

@@ -1,4 +1,13 @@
-# Louche
+<p align="center">
+  <a href="https://github.com/mirego/microscope">
+    <img src="http://i.imgur.com/FhNZIjg.png" alt="Louche" />
+  </a>
+  <br />
+  Louche adds common validators for ActiveModel/ActiveRecord classes.
+  <br /><br />
+  <a href="https://rubygems.org/gems/louche"><img src="https://badge.fury.io/rb/louche.png" /></a>
+  <a href="https://travis-ci.org/mirego/louche"><img src="https://travis-ci.org/mirego/louche.png?branch=master" /></a>
+</p>
 
 ---
 
@@ -14,10 +23,80 @@ gem 'louche'
 
 Louche provides a few validators to use in your ActiveModel/ActiveRecord classes:
 
-* `EmailValidator`
-* `URLValidator`
-* `PhoneNumberValidator`
-* `PostalCodeValidator`
+### `EmailValidator`
+
+```ruby
+class User < ActiveRecord::Base
+  validates :email, email: true
+end
+
+User.new(email: 'foo@example.com').valid? # => true
+User.new(email: 'foo@example').valid? # => false
+```
+
+### `URLValidator`
+
+```ruby
+class User < ActiveRecord::Base
+  validates :website, url: true
+end
+
+User.new(website: 'http://example.com').valid? # => true
+User.new(website: 'example.$$$').valid? # => false
+```
+
+### `PhoneNumberValidator`
+
+```ruby
+class User < ActiveRecord::Base
+  validates :phone_number, phone_number: true
+end
+
+user = User.new(phone_number: '514 555-2525')
+user.valid? # => true
+user.phone_number # => '5145552525'
+
+user = User.new(phone_number: '555-2525')
+user.valid? # => false
+user.phone_number # '5552525'
+```
+
+### `PostalCodeValidator`
+
+```ruby
+class User < ActiveRecord::Base
+  validates :postal_code, postal_code: true
+end
+
+user = User.new(postal_code: 'G0R 2T0')
+user.valid? # => true
+user.postal_code # => 'G0R2T0'
+
+user = User.new(postal_code: 'L -0- L')
+user.valid? # => false
+user.postal_code # => 'L0L'
+```
+
+### `ArrayValidator`
+
+```ruby
+class Tag < Struct.new(:name)
+  def valid?
+    name.present?
+  end
+end
+
+class User < ActiveRecord::Base
+  validates :tags, array: true
+
+  def tags=(tags)
+    super tags.map { |tag| Tag.new(tag) }
+  end
+end
+
+User.new(tags: ['food', 'beer', 'code']).valid? # => true
+User.new(tags: ['food', '', 'code']).valid? # => false
+```
 
 ## License
 

data/Rakefile

@@ -1,2 +1,11 @@
-require "bundler/gem_tasks"
+require 'bundler'
+require 'rake'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
+task default: :spec
+
+desc 'Run all specs'
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.pattern = 'spec/**/*_spec.rb'
+end

data/gemfiles/Gemfile.activemodel-4.0

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec path: '../'
+
+gem 'activemodel', '~> 4.0.0'

data/gemfiles/Gemfile.activemodel-4.1

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec path: '../'
+
+gem 'activemodel', '~> 4.1.0'

data/lib/louche.rb

@@ -1,4 +1,13 @@
 require 'louche/version'
 
+require 'active_model'
+require 'active_support/core_ext/hash'
+
+require 'louche/validators/array_validator'
+require 'louche/validators/email_validator'
+require 'louche/validators/phone_number_validator'
+require 'louche/validators/postal_code_validator'
+require 'louche/validators/url_validator'
+
 module Louche
 end

data/lib/louche/validators/array_validator.rb

@@ -0,0 +1,18 @@
+class ArrayValidator < ActiveModel::EachValidator
+  def initialize(options)
+    options.reverse_merge!(message: :invalid_array)
+    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?)
+    else
+      add_error(record, attribute, value)
+    end
+  end
+
+  def add_error(record, attribute, value)
+    record.errors.add(attribute, options.fetch(:message), value: value)
+  end
+end

data/lib/louche/validators/email_validator.rb

@@ -0,0 +1,13 @@
+class EmailValidator < ActiveModel::EachValidator
+  def initialize(options)
+    options.reverse_merge!(message: :invalid_email)
+    options.reverse_merge!(regex: /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\z/i)
+    super
+  end
+
+  def validate_each(record, attribute, value)
+    unless value =~ options.fetch(:regex)
+      record.errors.add(attribute, options.fetch(:message), value: value)
+    end
+  end
+end

data/lib/louche/validators/phone_number_validator.rb

@@ -0,0 +1,21 @@
+class PhoneNumberValidator < ActiveModel::EachValidator
+  def initialize(options)
+    options.reverse_merge!(message: :invalid_phone_number)
+    options.reverse_merge!(regex: /\d{10,}/)
+    options.reverse_merge!(cleanup_regex: /[^\d]/)
+    super
+  end
+
+  def validate_each(record, attribute, value)
+    value = PhoneNumberValidator.format_number(value, options.fetch(:cleanup_regex))
+    record.send(:"#{attribute}=", value)
+
+    unless value =~ options.fetch(:regex)
+      record.errors.add(attribute, options.fetch(:message), value: value)
+    end
+  end
+
+  def self.format_number(number, regex)
+    number.try(:gsub, regex, '')
+  end
+end

data/lib/louche/validators/postal_code_validator.rb

@@ -0,0 +1,21 @@
+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!(cleanup_regex: /[^a-z0-9]/i)
+    super
+  end
+
+  def validate_each(record, attribute, value)
+    value = PostalCodeValidator.format_code(value, options.fetch(:cleanup_regex))
+    record.send(:"#{attribute}=", value)
+
+    unless value =~ options.fetch(:regex)
+      record.errors.add(attribute, options.fetch(:message), value: value)
+    end
+  end
+
+  def self.format_code(postal_code, regex)
+    postal_code.try(:gsub, regex, '')
+  end
+end

data/lib/louche/validators/url_validator.rb

@@ -0,0 +1,27 @@
+class URLValidator < ActiveModel::EachValidator
+  def initialize(options)
+    options.reverse_merge!(schemes: %w(http https))
+    options.reverse_merge!(message: :invalid_url)
+    super
+  end
+
+  def validate_each(record, attribute, value)
+    unless self.class.valid_url?(value, options)
+      record.errors.add(attribute, options.fetch(:message), value: value)
+    end
+  end
+
+  def self.valid_url?(url, options)
+    schemes = [*options.fetch(:schemes)].map(&:to_s)
+
+    if URI::regexp(schemes).match(url)
+      begin
+        URI.parse(url)
+      rescue URI::InvalidURIError
+        false
+      end
+    else
+      false
+    end
+  end
+end

data/lib/louche/version.rb

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

data/louche.gemspec

@@ -18,6 +18,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", '~> 1.6'
+  spec.add_dependency 'activemodel', '>= 4.0.0'
+
+  spec.add_development_dependency 'rspec', '~> 3.0.0.beta2'
+  spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'rake'
 end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+$:.unshift File.expand_path('../lib', __FILE__)
+
+require 'rspec'
+require 'louche'
+
+RSpec.configure do |config|
+end

data/spec/validators/array_validator_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe ArrayValidator do
+  describe :validate_each do
+    let(:validator) { described_class.new(options) }
+    let(:options) { { attributes: [attribute] } }
+    let(:record) { double('ActiveRecord::Base', errors: errors) }
+    let(:errors) { double('ActiveModel::Errors') }
+    let(:attribute) { :items }
+
+    shared_examples 'a successful validator' do
+      before { expect(errors).to_not receive(:add) }
+      specify { validator.validate_each(record, attribute, value) }
+    end
+
+    shared_examples 'an erroneous validator' do
+      before do
+        expect(errors).to receive(:add).with(attribute, :invalid_array, value: value)
+      end
+
+      specify { validator.validate_each(record, attribute, value) }
+    end
+
+    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 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

data/spec/validators/email_validator_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe EmailValidator do
+  describe :validate_each do
+    let(:validator) { described_class.new(options) }
+    let(:options) { { attributes: [attribute] } }
+    let(:record) { double('ActiveRecord::Base', errors: errors) }
+    let(:errors) { double('ActiveModel::Errors') }
+    let(:attribute) { :contact_email }
+
+    shared_examples 'a successful validator' do
+      before { expect(errors).to_not receive(:add) }
+      specify { validator.validate_each(record, attribute, value) }
+    end
+
+    shared_examples 'an erroneous validator' do
+      before do
+        expect(errors).to receive(:add).with(attribute, :invalid_email, value: value)
+      end
+
+      specify { validator.validate_each(record, attribute, value) }
+    end
+
+    context 'with an invalid value' do
+      context 'with missing @' do
+        let(:value) { 'exomel.com' }
+        it_behaves_like 'an erroneous validator'
+      end
+
+      context 'with missing TLD' do
+        let(:value) { 'example@exomelcom' }
+        it_behaves_like 'an erroneous validator'
+      end
+    end
+
+    context 'with valid value' do
+      let(:value) { 'example@exomel.com' }
+      it_behaves_like 'a successful validator'
+    end
+  end
+end

data/spec/validators/phone_number_validator_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe PhoneNumberValidator do
+  describe :validate_each do
+    let(:validator) { described_class.new(options) }
+    let(:options) { { attributes: [attribute] } }
+    let(:record) { double('ActiveRecord::Base', errors: errors) }
+    let(:errors) { double('ActiveModel::Errors') }
+    let(:attribute) { :phone }
+
+    before { allow(record).to receive(:phone=).with(expected_stored_value) }
+
+    shared_examples 'a successful validator' do
+      before { expect(errors).to_not receive(:add) }
+      specify { validator.validate_each(record, attribute, value) }
+    end
+
+    shared_examples 'an erroneous validator' do
+      before do
+        expect(errors).to receive(:add).with(attribute, :invalid_phone_number, value: expected_stored_value)
+      end
+
+      specify { validator.validate_each(record, attribute, value) }
+    end
+
+    context 'with an invalid value' do
+      context 'with missing digits' do
+        let(:value) { '555-2525' }
+        let(:expected_stored_value) { '5552525' }
+        it_behaves_like 'an erroneous validator'
+      end
+
+      context 'containing invalid characters' do
+        let(:value) { '514 555-252A' }
+        let(:expected_stored_value) { '514555252' }
+        it_behaves_like 'an erroneous validator'
+      end
+    end
+
+    context 'with valid value' do
+      context 'with spaces and dashes' do
+        let(:value) { '514 555-2525' }
+        let(:expected_stored_value) { '5145552525' }
+
+        it_behaves_like 'a successful validator'
+      end
+
+      context 'without spaces' do
+        let(:value) { '5145552525' }
+        let(:expected_stored_value) { '5145552525' }
+
+        it_behaves_like 'a successful validator'
+      end
+    end
+  end
+end

data/spec/validators/postal_code_validator_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe PostalCodeValidator do
+  describe :validate_each do
+    let(:validator) { described_class.new(options) }
+    let(:options) { { attributes: [attribute] } }
+    let(:record) { double('ActiveRecord::Base', errors: errors) }
+    let(:errors) { double('ActiveModel::Errors') }
+    let(:attribute) { :postal_code }
+
+    before { allow(record).to receive(:postal_code=).with(expected_stored_value) }
+
+    shared_examples 'a successful validator' do
+      before { expect(errors).to_not receive(:add) }
+      specify { validator.validate_each(record, attribute, value) }
+    end
+
+    shared_examples 'an erroneous validator' do
+      before do
+        expect(errors).to receive(:add).with(attribute, :invalid_postal_code, value: expected_stored_value)
+      end
+
+      specify { validator.validate_each(record, attribute, value) }
+    end
+
+    context 'with an invalid value' do
+      context 'with missing characters' do
+        let(:value) { 'G0R 2T' }
+        let(:expected_stored_value) { 'G0R2T' }
+
+        it_behaves_like 'an erroneous validator'
+      end
+
+      context 'with invalid characters' do
+        let(:value) { 'GOR2T$' }
+        let(:expected_stored_value) { 'GOR2T' }
+
+        it_behaves_like 'an erroneous validator'
+      end
+    end
+
+    context 'with valid value' do
+      context 'with spaces' do
+        let(:value) { ' G 0R 2T 0 ' }
+        let(:expected_stored_value) { 'G0R2T0' }
+
+        it_behaves_like 'a successful validator'
+      end
+
+      context 'without spaces' do
+        let(:value) { 'G0R2T0' }
+        let(:expected_stored_value) { 'G0R2T0' }
+
+        it_behaves_like 'a successful validator'
+      end
+    end
+  end
+end

data/spec/validators/url_validator_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe URLValidator do
+  describe :validate_each do
+    let(:validator) { described_class.new(options) }
+    let(:options) { { attributes: [attribute] } }
+    let(:record) { double('ActiveRecord::Base', errors: errors) }
+    let(:errors) { double('ActiveModel::Errors') }
+    let(:attribute) { :website_url }
+
+    shared_examples 'a successful validator' do
+      before { expect(errors).to_not receive(:add) }
+      specify { validator.validate_each(record, attribute, value) }
+    end
+
+    shared_examples 'an erroneous validator' do
+      before do
+        expect(errors).to receive(:add).with(attribute, :invalid_url, value: value)
+      end
+
+      specify { validator.validate_each(record, attribute, value) }
+    end
+
+    context 'with an invalid value' do
+      context 'with missing protocol' do
+        let(:value) { 'exomel.com' }
+        it_behaves_like 'an erroneous validator'
+      end
+
+      context 'containing invalid characters' do
+        let(:value) { 'http://www.$%.com' }
+        it_behaves_like 'an erroneous validator'
+      end
+    end
+
+    context 'with valid value' do
+      let(:value) { 'http://exomel.com' }
+      it_behaves_like 'a successful validator'
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: louche
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: '0.1'
 platform: ruby
 authors:
 - Rémi Prévost
@@ -10,6 +10,34 @@ bindir: bin
 cert_chain: []
 date: 2014-05-01 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -46,13 +74,28 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.md
 - README.md
 - Rakefile
+- gemfiles/Gemfile.activemodel-4.0
+- gemfiles/Gemfile.activemodel-4.1
 - lib/louche.rb
+- lib/louche/validators/array_validator.rb
+- lib/louche/validators/email_validator.rb
+- lib/louche/validators/phone_number_validator.rb
+- lib/louche/validators/postal_code_validator.rb
+- lib/louche/validators/url_validator.rb
 - lib/louche/version.rb
 - louche.gemspec
+- spec/spec_helper.rb
+- spec/validators/array_validator_spec.rb
+- spec/validators/email_validator_spec.rb
+- spec/validators/phone_number_validator_spec.rb
+- spec/validators/postal_code_validator_spec.rb
+- spec/validators/url_validator_spec.rb
 homepage: https://github.com/mirego/louche
 licenses:
 - BSD-3 Clause
@@ -77,4 +120,10 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Louche provides common validators for ActiveModel/ActiveRecord classes
-test_files: []
+test_files:
+- spec/spec_helper.rb
+- spec/validators/array_validator_spec.rb
+- spec/validators/email_validator_spec.rb
+- spec/validators/phone_number_validator_spec.rb
+- spec/validators/postal_code_validator_spec.rb
+- spec/validators/url_validator_spec.rb