at_least_one_existence_validator 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3954273706e84504375e65ad52e247d801f4aae8
-  data.tar.gz: e395b26ba404d7e974e2416badc71d744d7a44c4
+  metadata.gz: 5f62a850a7099112e9ee71a5d9ffee840abc1b04
+  data.tar.gz: 5c917ebafa5fb5fe21f6f1565ece0b81b17dbae4
 SHA512:
-  metadata.gz: 4f351becc9673be022135f1d32c1c817f1419f95c9e527bc49de68c31dc7fdc916754d578144880bd65d4bf35307bd5e863f3a514c695cad9c1aa198ebf60f06
-  data.tar.gz: c48f9bba4b9e782f05122d2e6e6f35abe5433e34d6cfea2b95cb38c6b1e08d4b3ba0eee7b1e69b5d1032fd3a3e56efd401aa25de68f944fbbb619e5ed02fa925
+  metadata.gz: 508a2aa970b537f4a468115b1f141e0af297cc1c9d1e6f2591e30a6fdc6c313eb4e7cf3983471429a88afcc89569b288affa1b5c7a2ce377561310e9532bd777
+  data.tar.gz: 62479c235d285084d2209b2e75dc23ade20fa4b8a2f2765b3243ca776c1449a2a221b9d04e79e6f38d6acf56ccd43bcfac07a7f4af208cb812ff93db8fac88d0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - ruby-head
+  - jruby-19mode # JRuby in 1.9 mode
+  - jruby-head
+  - rbx-19mode
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Valeriy Utyaganov
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,75 @@
+at\_least\_one\_existence\_validator [![Build Status](https://travis-ci.org/USAWal/at_least_one_existence_validator.png)](https://travis-ci.org/USAWal/at_least_one_existence_validator)
+====================================
+
+Easy to use Rails active model validator which tests whether an associated collection will have any objects after saving. It's useful with one-to-many and many-to-many relationships.
+
+Installation
+------------
+
+Add to the `Gemfile`:
+```ruby
+gem 'at_least_one_validator'
+```
+After adding, install it
+```shell
+bundle install
+```
+
+Usage
+-----
+
+Given you have 'Author' model and 'Book' model respectively. Obviously author can write many books and book can be written by many authors but a book must have at least one author, so eventually you have something like this:
+
+```ruby
+class Author < ActiveRecord::Base
+  has_and_belongs_to_many :books
+end
+
+class Book   < ActiveRecord::Base
+  has_and_belongs_to_many :authors
+end
+```
+
+If you want to use **at_least_one_existence_validator**, you just need to add helper method ```validates_at_least_one_existence_of```to the model class and list all the collections you want to be validated as parameters. Let's do it:
+
+```ruby
+class Author < ActiveRecord::Base
+  has_and_belongs_to_many :books
+end
+
+class Book   < ActiveRecord::Base
+  has_and_belongs_to_many :authors
+
+  validates_at_least_one_existence_of :authors
+end
+```
+
+This code will test whether the authors of the tested book are marked for destruction or authors are already blank. If they are, validator will add default error message.
+
+Configuring
+-----------
+
+The default error message for English locale is "must have at least one item.". You can specify your own error message adding it with ```at_least_one:``` key to localization backend. Using previous example and standard i18n localization mechanism for static content we do the next:
+
+```ruby
+# file project_root/config/locales/en.yml
+en:
+  activerecord:
+    errors:
+      models:
+        book:
+          attributes:
+            authors:
+              at_least_one: 'must have at least one author.'
+```
+
+Message for **at_least_one_existence_validator** scoped by book and its authors is changed now.
+
+Contributing
+------------
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |task|
+  task.libs << 'test'
+end
+
+task default: :test

data/at_least_one_existence_validator.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'at_least_one_existence_validator/version'
+
+Gem::Specification.new do |spec|
+  spec.name                  = "at_least_one_existence_validator"
+  spec.version               = AtLeastOneExistenceValidator::VERSION
+  spec.authors               = ["Valeriy Utyaganov"]
+  spec.email                 = ["usawal@gmail.com"]
+  spec.description           = %q{This validator tests whether associated collection is going to be empty after saving. It will be passed if at least one association of the specified collection will exist. The validator provides helper method and default error message.}
+  spec.summary               = %q{Validator for associated collection}
+  spec.homepage              = "http://github.com/USAWal/at_least_one_existence_validator"
+  spec.license               = "MIT"
+
+  spec.files                 = `git ls-files`.split($/)
+  spec.executables           = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files            = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths         = ["lib", "locales"]
+
+  spec.required_ruby_version = ">= 1.9.3"
+
+  spec.add_runtime_dependency     "activemodel", ">= 3"
+
+  spec.add_development_dependency "bundler"    , "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "activerecord"
+end

data/lib/at_least_one_existence_validator.rb

@@ -1,3 +1,4 @@
+require 'active_model'
 require 'active_model/validations/at_least_one_existence_validator'
 require 'active_support/i18n'
 

data/lib/at_least_one_existence_validator/version.rb

@@ -1,3 +1,3 @@
 module AtLeastOneExistenceValidator
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/locales/ru.yml

@@ -1,3 +1,5 @@
+# coding: utf-8
+
 ru:
   errors:
     messages:

data/test/test_at_least_one_existence_validator.rb

@@ -0,0 +1,60 @@
+# coding: utf-8
+
+require 'test/unit'
+require 'at_least_one_existence_validator'
+require 'active_record'
+require 'test_helper'
+
+class ValidatorTest < Test::Unit::TestCase
+  def test_helper_method_existence
+    assert_respond_to ActiveRecord::Base, :validates_at_least_one_existence_of, "ActiveRecord::Base doesn't have helper method"
+  end
+
+  def test_omitted_authors
+    validate book_with_omitted_authors, "Validator is passed if collection is nil"
+  end
+
+  def test_rphaned_book
+    validate orphaned_book, "Validator is passed if collection is empty"
+  end
+
+  def test_book_with_an_author
+    validate book_with_an_author      , "Validator isn't passed if collection has only one item", 0
+    validate book_with_an_author(true), "Validator passed if the only item of its collection is marked for destruction"
+  end
+
+  def test_book_with_some_authors
+    validate book_with_some_authors, "Validator isn't passed if all items of its collection are not marked for destruction", 0
+    validate book_with_some_authors([true, false]*2), "Validator isn't passed if some items of its collection are not marked for destruction", 0
+    validate book_with_some_authors([true]*5), "Validator is passed if all the items of its collection are marked for destruction"
+  end
+
+  def test_error_message
+    messages = {
+      en: 'must have at least one item.',
+      ru: 'должен иметь, по крайней мере, один элемент.'
+    }
+
+    missed_locales   = messages.keys          - I18n.available_locales
+    assert missed_locales.empty?, "Missed locales: #{missed_locales.to_s}"
+
+    surplus_locales  = I18n.available_locales - messages.keys
+    assert surplus_locales.empty?, "Surplus locales: #{surplus_locales.to_s}"
+
+    I18n.available_locales.each do |locale|
+      I18n.locale = locale
+      expected    = messages[locale]
+      actual      = I18n.t 'errors.messages.at_least_one'
+      assert_equal expected, actual, "Expected message is '#{expected}', actual message is '#{actual}', locale is '#{locale.to_s}'"
+    end
+  end
+
+  include TestHelper
+
+  private
+
+  def validate tested_book, message, errors_size = 1
+    assert_nothing_raised { ActiveModel::Validations::AtLeastOneExistenceValidator.new({ attributes: [:authors] }).validate tested_book }
+    assert tested_book.errors.size == errors_size, message
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,63 @@
+module TestHelper
+  private
+
+  class Book
+    attr_accessor :authors
+    attr_reader   :errors
+
+    def initialize
+      @authors = []
+      @errors  = []
+      @errors.define_singleton_method(:add) { |attribute, message| self << { attribute: attribute, message: message } }
+    end
+
+    def read_attribute_for_validation(attribute)
+      self.send(attribute.to_sym)
+    end
+  end
+
+  class Author
+    attr_accessor :books
+
+    def initialize
+      @books   = []
+    end
+
+    def marked_for_destruction?
+      @marked_for_desctruction || false
+    end
+
+    def mark_for_destruction
+      @marked_for_desctruction = true
+    end
+  end
+
+  def book_with_omitted_authors; Book.new              ; end
+
+  def orphaned_book            ; book                  ; end
+
+  def book_with_an_author(marked_for_destruction = false)
+    book_by [author(marked_for_destruction)]
+  end
+
+  def book_with_some_authors(config = [false] * 5)
+    book(config.map { |item| author item })
+  end
+
+  private
+
+  def book(authors = [])
+    Book.new.tap do |book|
+      book.authors.concat authors
+    end
+  end
+
+  alias_method :book_by, :book
+
+  def author(marked = false)
+    Author.new.tap do |author|
+      author.mark_for_destruction if marked
+    end
+  end
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: at_least_one_existence_validator
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Valeriy Utyaganov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-12 00:00:00.000000000 Z
+date: 2013-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -25,7 +25,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -38,28 +66,34 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: |2
-      This validator tests whether associated collection is going to be empty
-      after saving. It will be passed if at least one association
-      of the specified collection will exist. The validator provides
-      helper method and default error message.
-email: usawal@gmail.com
+description: This validator tests whether associated collection is going to be empty
+  after saving. It will be passed if at least one association of the specified collection
+  will exist. The validator provides helper method and default error message.
+email:
+- usawal@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/at_least_one_existence_validator.rb
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- at_least_one_existence_validator.gemspec
 - lib/active_model/validations/at_least_one_existence_validator.rb
+- lib/at_least_one_existence_validator.rb
 - lib/at_least_one_existence_validator/version.rb
 - locales/en.yml
 - locales/ru.yml
+- test/test_at_least_one_existence_validator.rb
+- test/test_helper.rb
 homepage: http://github.com/USAWal/at_least_one_existence_validator
 licenses:
 - MIT
 metadata: {}
-post_install_message: "    Thank you for installing!'\n    validates_at_least_one_existence_of
-  - helper method\n    :at_least_one                       - key for error message
-  in i18n \n"
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -68,7 +102,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
@@ -80,4 +114,6 @@ rubygems_version: 2.0.5
 signing_key: 
 specification_version: 4
 summary: Validator for associated collection
-test_files: []
+test_files:
+- test/test_at_least_one_existence_validator.rb
+- test/test_helper.rb