active_model_validates_intersection_of 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0ef8977cca2302df90c919bd3212ee38c004a503
+  data.tar.gz: 21dab974646c8a4cfed5742a7ad6627316ea350d
+SHA512:
+  metadata.gz: 6452a2c54d3754d6a1947b5e30784bea2a899e0e4e47662dd51dcea9487c34ea801d80b264d1127aed41378ec114b912135c95065143bbaf2c1352b520d4d431
+  data.tar.gz: ebdfcd71070d2e4132dfaed773684a9b8374917461ff6e6bd862242b62c5e46c034c18ab6c742c20adfd4e8788b5fe03f62646501d1442db3a57e0b6795f21e7

data/.gitignore

@@ -0,0 +1,6 @@
+Gemfile.lock
+/coverage/
+/pkg/
+.rspec_status
+.coveralls.yml
+.ruby-version

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.0

data/Gemfile

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

data/README.md

@@ -0,0 +1,88 @@
+# Active Model Validates Intersection Of
+
+![Gem Version](https://img.shields.io/gem/v/active_model_validates_intersection_of.svg?style=flat-square) [![Code Climate](https://img.shields.io/codeclimate/github/rafaelbiriba/active_model_validates_intersection_of.svg?style=flat-square)](https://codeclimate.com/github/rafaelbiriba/active_model_validates_intersection_of) [![Coverage Status](https://img.shields.io/coveralls/rafaelbiriba/active_model_validates_intersection_of/master.svg?style=flat-square)](https://coveralls.io/r/rafaelbiriba/active_model_validates_intersection_of?branch=master) [![Travis](https://img.shields.io/travis/rafaelbiriba/active_model_validates_intersection_of/master.svg?style=flat-square)](https://travis-ci.org/rafaelbiriba/active_model_validates_intersection_of)
+
+A custom validation for Active Model that check if an array is included in another one.
+
+Identical to the method `validates_inclusion_of` from ActiveModel but for array comparison.
+
+Consider an User model that have some set of "default" permissions.
+
+```ruby
+class User < ActiveRecord::Base
+  DEFAULT_PERMISSION = ["read", "write", "share"]
+  validates_intersection_of :permission, in: DEFAULT_ROLES
+end
+```
+
+If you want to validate your user based on an array:
+
+```ruby
+user = User.new(permission: ["read", "share"])
+user.valid? #true
+
+ user = User.new(permission: ["read", "admin"])
+ user.valid? #false
+```
+
+ This active model custom validation **is for you**!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_model_validates_intersection_of'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_model_validates_intersection_of
+
+## Usage
+
+* `in:` parameter is required
+* `message:` is optional
+
+```ruby
+class User < ActiveRecord::Base
+  DEFAULT_PERMISSION = ["read", "write", "share"]
+  validates_intersection_of :permission, in: DEFAULT_ROLES
+end
+```
+
+```ruby
+class User < ActiveRecord::Base
+  DEFAULT_PERMISSION = ["read", "write", "share"]
+  validates_intersection_of :permission, in: DEFAULT_ROLES, message: "invalid permission"
+end
+```
+
+You can also use the custom validation directly:
+
+```ruby
+class User < ActiveRecord::Base
+  DEFAULT_PERMISSION = ["read", "write", "share"]
+  validates_with ActiveModelValidatesIntersectionOf::Validator, attributes: [:permission], in: VALID_ARRAY
+end
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Contributing
+
+First of all, **thank you** for wanting to help!
+
+1. [Fork it](https://help.github.com/articles/fork-a-repo).
+2. Create a feature branch - `git checkout -b more_magic`
+3. Add tests and make your changes
+4. Check if tests are ok - `rake spec`
+5. Commit changes - `git commit -am "Added more magic"`
+6. Push to Github - `git push origin more_magic`
+7. Send a [pull request](https://help.github.com/articles/using-pull-requests)! :heart:

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/active_model_validates_intersection_of.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "active_model_validates_intersection_of/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_model_validates_intersection_of"
+  spec.version       = ActiveModelValidatesIntersectionOf::VERSION
+  spec.authors       = ["Rafael Biriba"]
+  spec.email         = ["biribarj@gmail.com"]
+
+  spec.summary       = "A custom validation for your Active Model that check if an array is included in another one"
+  spec.description   = "A custom validation for your Active Model that check if an array is included in another one"
+  spec.homepage      = "https://github.com/rafaelbiriba/active_model_validates_intersection_of"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^(spec)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activemodel", ">= 4.0.0"
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "coveralls"
+end

data/lib/active_model_validates_intersection_of.rb

@@ -0,0 +1,3 @@
+require "active_model_validates_intersection_of/version.rb"
+require "active_model_validates_intersection_of/inclusion_intersection_validator.rb"
+require "active_model_validates_intersection_of/validates_intersection_of_alias.rb"

data/lib/active_model_validates_intersection_of/inclusion_intersection_validator.rb

@@ -0,0 +1,11 @@
+module ActiveModelValidatesIntersectionOf
+  class Validator < ActiveModel::EachValidator
+    def validate_each(record, attribute, value)
+      delimiter = options[:in]
+      raise(ArgumentError, "An array must be supplied as the :in option of the configuration hash") unless delimiter.kind_of?(Array)
+      if (value - delimiter).any?
+        record.errors.add(attribute, :inclusion, options.except(:in).merge!(value: value))
+      end
+    end
+  end
+end

data/lib/active_model_validates_intersection_of/validates_intersection_of_alias.rb

@@ -0,0 +1,5 @@
+module ActiveModel::Validations::HelperMethods
+  def validates_intersection_of(*attr_names)
+    validates_with ActiveModelValidatesIntersectionOf::Validator, _merge_attributes(attr_names)
+  end
+end

data/lib/active_model_validates_intersection_of/version.rb

@@ -0,0 +1,3 @@
+module ActiveModelValidatesIntersectionOf
+  VERSION = "0.1.0"
+end

data/spec/lib/inclusion_intersection_validator_spec.rb

@@ -0,0 +1,41 @@
+require "spec_helper"
+require_relative "../shared.rb"
+
+RSpec.describe ActiveModelValidatesIntersectionOf::Validator do
+  class BadSetupValidator
+    include ActiveModel::Validations
+    attr_accessor :list
+    validates_with ActiveModelValidatesIntersectionOf::Validator, attributes: [:list]
+  end
+
+  let(:badsetup) { BadSetupValidator.new }
+
+  context "setup" do
+    describe "without an :in configuration" do
+      it_behaves_like "invalid configuration"
+    end
+  end
+
+  VALID_ARRAY = ["a", "b", 1 , 2]
+
+  let(:valid_partial_array) { VALID_ARRAY.sample(2) }
+  let(:invalid_partial_array) { valid_partial_array + ["invalid"] }
+
+  class ListValidator
+    include ActiveModel::Validations
+    attr_accessor :list
+    validates_with ActiveModelValidatesIntersectionOf::Validator, attributes: [:list], in: VALID_ARRAY, message: "not valid"
+  end
+
+  subject { List.new }
+
+  context "validation" do
+    describe "with a valid list" do
+      it_behaves_like "valid object"
+    end
+
+    describe "with an invalid list" do
+      it_behaves_like "invalid object"
+    end
+  end
+end

data/spec/lib/validates_intersection_of_alias_spec.rb

@@ -0,0 +1,41 @@
+require "spec_helper"
+require_relative "../shared.rb"
+
+RSpec.describe ActiveModel::Validations::HelperMethods do
+  class BadSetup
+    include ActiveModel::Validations
+    attr_accessor :list
+    validates_intersection_of :list
+  end
+
+  let(:badsetup) { BadSetup.new }
+
+  context "setup" do
+    describe "without an :in configuration" do
+      it_behaves_like "invalid configuration"
+    end
+  end
+
+  VALID_ARRAY = ["z", "x", 5 , 6]
+
+  let(:valid_partial_array) { VALID_ARRAY.sample(2) }
+  let(:invalid_partial_array) { valid_partial_array + ["invalid"] }
+
+  class List
+    include ActiveModel::Validations
+    attr_accessor :list
+    validates_intersection_of :list, in: VALID_ARRAY, message: "not valid"
+  end
+
+  subject { List.new }
+
+  context "validation" do
+    describe "with a valid list" do
+      it_behaves_like "valid object"
+    end
+
+    describe "with an invalid list" do
+      it_behaves_like "invalid object"
+    end
+  end
+end

data/spec/shared.rb

@@ -0,0 +1,25 @@
+RSpec.shared_examples "invalid configuration" do
+  it "should raise an error" do
+    expect { badsetup.valid? }.to raise_error(ArgumentError)
+  end
+end
+
+RSpec.shared_examples "valid object" do
+  it "the subject should be valid" do
+    subject.list = valid_partial_array
+    expect(subject.valid?).to eq(true)
+  end
+end
+
+RSpec.shared_examples "invalid object" do
+  it "the subject should not be valid" do
+    subject.list = invalid_partial_array
+    expect(subject.valid?).to eq(false)
+  end
+
+  it "the subject should have an error" do
+    subject.list = invalid_partial_array
+    subject.valid?
+    expect(subject.errors.messages).to eq({:list=>["not valid"]})
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require "bundler/setup"
+require "active_model"
+require "active_model_validates_intersection_of"
+require 'coveralls'
+Coveralls.wear!
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: active_model_validates_intersection_of
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rafael Biriba
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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'
+description: A custom validation for your Active Model that check if an array is included
+  in another one
+email:
+- biribarj@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- active_model_validates_intersection_of.gemspec
+- lib/active_model_validates_intersection_of.rb
+- lib/active_model_validates_intersection_of/inclusion_intersection_validator.rb
+- lib/active_model_validates_intersection_of/validates_intersection_of_alias.rb
+- lib/active_model_validates_intersection_of/version.rb
+- spec/lib/inclusion_intersection_validator_spec.rb
+- spec/lib/validates_intersection_of_alias_spec.rb
+- spec/shared.rb
+- spec/spec_helper.rb
+homepage: https://github.com/rafaelbiriba/active_model_validates_intersection_of
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: A custom validation for your Active Model that check if an array is included
+  in another one
+test_files:
+- spec/lib/inclusion_intersection_validator_spec.rb
+- spec/lib/validates_intersection_of_alias_spec.rb
+- spec/shared.rb
+- spec/spec_helper.rb