extra_validations 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a352c493f0a5a9e7079bf9d25fc69d6f866a9589
-  data.tar.gz: c4b3e96aca1b7773ebe74d4bc95206c8a6c95706
+  metadata.gz: b6c67fad9b6d632a739ee5597a3587f26c604b0e
+  data.tar.gz: 7c92df5f7924b4da49e673871c93a14f50299602
 SHA512:
-  metadata.gz: fd6f237ae867ba6da83839a14576c24172d52c81d416d7e5c19fe924103e496bff10e135878f9ebe92d7dc0340658d4dd6917568bffd44f4795bc1a6580185a8
-  data.tar.gz: a1f33cbedc6e08dd42f28bab7ae2d8de21cb8d0a81277abc08356f19a9dd74ce4129a9ed5f38f5618996090422247956f4c4117678b396104bf7b4d300908a2f
+  metadata.gz: 3930615ba2c63ca0dc24d2aa078e63eca5b06e2480bd08a7e045a1b9bd3f74e1c32a151d33c7a9e1879d895f5e2eb15d6417ea0ccb07b1ea320e3baf365fd890
+  data.tar.gz: 62bae244afdbb9a59395cb05f0d33f14a49b8a42c0629df4e99e2f50a90c6ca30241725d1db6f40a6826e13548e0281b5f42da2b771c56f4f0264f5798c3d00b

data/.travis.yml

@@ -1,4 +1,7 @@
 language: ruby
 rvm:
+  - 2.0.0
+  - 2.1.0
   - 2.2.0
+  - ruby-head
 script: bundle exec rspec

data/README.md

@@ -1,8 +1,9 @@
 # ExtraValidations
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/extra_validations`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Build Status][travis_badge]][travis_link]
+[![Code Climate][cclimate_badge]][cclimate_link]
 
-TODO: Delete this and the text above, and describe your gem
+This gem provides some extra validations for ActiveModel objects.
 
 ## Installation
 
@@ -22,18 +23,59 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+The following validators are available:
+
+Collection length:
+
+```ruby
+validates :attr, collection_length: { in: 1..5 }
+```
+
+Collection members validator (ensures that each member of the collection is
+valid):
+
+```ruby
+validates :attr, collection: true
+```
+
+Existence validator:
+
+```ruby
+validates :model_id, existence: ->(value) { Model.exists?(value) }
+```
+
+Nested validator (ensures that the object is valid):
+
+```ruby
+validates :model, nested: true
+```
+
+Uniqueness validator:
+
+```ruby
+validates :email, uniqueness: ->(email) { Model.exists?(email: email) }
+```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`, and then
+run `bundle exec rake release` to create a git tag for the version, push git
+commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/extra_validations/fork )
+1. Fork it ( https://github.com/estoulendo/extra_validations/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`)
 5. Create a new Pull Request
+
+[travis_badge]: https://travis-ci.org/estoulendo/extra_validations.svg?branch=master
+[travis_link]: https://travis-ci.org/estoulendo/extra_validations
+[cclimate_badge]: https://codeclimate.com/github/estoulendo/extra_validations/badges/gpa.svg
+[cclimate_link]: https://codeclimate.com/github/estoulendo/extra_validations

data/extra_validations.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'activemodel', '~> 4.2'
-  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.2', '>= 3.2.0'
 end

data/lib/extra_validations.rb

@@ -5,6 +5,7 @@ require 'extra_validations/collection_length_validator'
 require 'extra_validations/collection_validator'
 require 'extra_validations/nested_validator'
 require 'extra_validations/existence_validator'
+require 'extra_validations/uniqueness_validator'
 
 I18n.load_path.unshift(*Dir[File.expand_path(
   File.join(%w(extra_validations locale *.yml)), File.dirname(__FILE__))])

data/lib/extra_validations/collection_length_validator.rb

@@ -1,11 +1,35 @@
 module ExtraValidations
+  # Validates the length of a collection.
+  #
+  # Suppose that you have the following class:
+  #
+  #   class Book
+  #     include ActiveModel::Model
+  #     include ExtraValidations
+  #
+  #     attr_accessor :authors
+  #
+  #     validates :authors, collection_length: 1..5
+  #   end
+  #
+  # This validator will make sure that the _authors_ array will have at least
+  # 1 item and at most 5 items:
+  #
+  #   book = Book.new
+  #   book.authors = []
+  #   book.valid? # => false
+  #
+  #   book.authors = [Author.new]
+  #   book.valid? # => true
+  #
   class CollectionLengthValidator < ActiveModel::EachValidator
     def check_validity!
-      unless options[:in].is_a?(Range)
-        fail ArgumentError, ':in must be a Range'
-      end
+      fail ArgumentError, ':in must be a Range' unless options[:in].is_a?(Range)
     end
 
+    # @param record An object that has ActiveModel::Validations included
+    # @param attribute [Symbol]
+    # @param collection [Array]
     def validate_each(record, attribute, collection)
       min = options[:in].begin
       max = options[:in].end

data/lib/extra_validations/collection_validator.rb

@@ -1,5 +1,36 @@
 module ExtraValidations
+  # Makes sure that each member of the collection is a valid object.
+  #
+  # Suppose that you have the following class:
+  #
+  #   class Book
+  #     include ActiveModel::Model
+  #     include ExtraValidations
+  #
+  #     attr_accessor :authors
+  #
+  #     validates :authors, collection: true
+  #   end
+  #
+  # This validator will call +#valid?+ for each member of the collection:
+  #
+  #   book = Book.new
+  #   book.authors = [invalid_author1, valid_author1]
+  #   book.valid? # => false
+  #
+  #   book.authors = [valid_author1, valid_author2]
+  #   book.valid? # => true
+  #
+  # Each validation error found on members will be appended on to the errors
+  # object:
+  #
+  #   book.errors.messages # => {:"authors/1/name"=>["can't be blank"]}
+  #
   class CollectionValidator < ActiveModel::EachValidator
+    # @param record An object that has ActiveModel::Validations included
+    # @param attribute [Symbol]
+    # @param collection [Array] An array of objects that have
+    #   ActiveModel::Validations included
     def validate_each(record, attribute, collection)
       return if collection.blank?
 

data/lib/extra_validations/existence_validator.rb

@@ -1,4 +1,27 @@
 module ExtraValidations
+  # Makes sure that an object/record exists.
+  #
+  # Suppose that you have the following class:
+  #
+  #   class Book
+  #     include ActiveModel::Model
+  #     include ExtraValidations
+  #
+  #     attr_accessor :author_id
+  #
+  #     validates :author_id, existence: -> (id) { Author.exists?(id) }
+  #   end
+  #
+  # This validator will execute the given block and, if it returns false, the
+  # object will not be valid:
+  #
+  #   book = Book.new
+  #   book.author_id = 100
+  #   book.valid? # => false
+  #
+  #   book.author_id = Author.first.id
+  #   book.valid? # => true
+  #
   class ExistenceValidator < ActiveModel::EachValidator
     def check_validity!
       unless options[:with].is_a?(Proc)
@@ -6,6 +29,9 @@ module ExtraValidations
       end
     end
 
+    # @param record An object that has ActiveModel::Validations included
+    # @param attribute [Symbol]
+    # @param id [Integer]
     def validate_each(record, attribute, id)
       return if id.blank?
 

data/lib/extra_validations/locale/en.yml

@@ -8,3 +8,4 @@ en:
         one: "must have at most one"
         other: "must have at most %{count}"
       not_found: "not found"
+      taken: "has already been taken"

data/lib/extra_validations/nested_validator.rb

@@ -1,5 +1,34 @@
 module ExtraValidations
+  # Makes sure that the nested object is valid.
+  #
+  # Suppose that you have the following class:
+  #
+  #   class Book
+  #     include ActiveModel::Model
+  #     include ExtraValidations
+  #
+  #     attr_accessor :author
+  #
+  #     validates :author, nested: true
+  #   end
+  #
+  # This validator will call +#valid?+ on the nested object:
+  #
+  #   book = Book.new
+  #   book.author = invalid_author
+  #   book.valid? # => false
+  #
+  #   book.author = valid_author
+  #   book.valid? # => true
+  #
+  # Each validation error found will be appended on to the errors object:
+  #
+  #   book.errors.messages # => {:"author/name"=>["can't be blank"]}
+  #
   class NestedValidator < ActiveModel::EachValidator
+    # @param record An object that has ActiveModel::Validations included
+    # @param attribute [Symbol]
+    # @param nested An object that has ActiveModel::Validations included
     def validate_each(record, attribute, nested)
       return if !nested || nested.valid?
 

data/lib/extra_validations/uniqueness_validator.rb

@@ -0,0 +1,42 @@
+module ExtraValidations
+  # Makes sure that an object/record is unique.
+  #
+  # Suppose that you have the following class:
+  #
+  #   class User
+  #     include ActiveModel::Model
+  #     include ExtraValidations
+  #
+  #     attr_accessor :email
+  #
+  #     validates :email, uniqueness: ->(email) { User.exists?(email: email) }
+  #   end
+  #
+  # This validator will execute the given block and, if it returns true, the
+  # object will not be valid:
+  #
+  #   user = User.new
+  #   user.email = 'foo@example.com'
+  #   user.valid? # => false
+  #
+  #   user.email = 'bar@example.com'
+  #   user.valid? # => true
+  #
+  class UniquenessValidator < ActiveModel::EachValidator
+    def check_validity!
+      unless options[:with].is_a?(Proc)
+        fail ArgumentError, ':with must be a Proc'
+      end
+    end
+
+    # @param record An object that has ActiveModel::Validations included
+    # @param attribute [Symbol]
+    # @param value
+    def validate_each(record, attribute, value)
+      return if value.blank?
+
+      exists = options[:with].call(value)
+      record.errors.add(attribute, :taken) if exists
+    end
+  end
+end

data/lib/extra_validations/version.rb

@@ -1,3 +1,3 @@
 module ExtraValidations
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: extra_validations
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Lenon Marcel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-03-30 00:00:00.000000000 Z
+date: 2015-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -28,16 +28,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -95,6 +95,7 @@ files:
 - lib/extra_validations/existence_validator.rb
 - lib/extra_validations/locale/en.yml
 - lib/extra_validations/nested_validator.rb
+- lib/extra_validations/uniqueness_validator.rb
 - lib/extra_validations/version.rb
 homepage: https://github.com/estoulendo/extra_validations
 licenses: []