active_model_validates_intersection_of 0.1.0 → 1.0.0

checksums.yaml

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

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+## v1.0.0 (2017-06-06)
+
+  - Releasing 1.0 version
+  - Adding `:within` parameter support as an alias for `:in`
+
+## v0.1.0 (2017-06-01)
+
+  - Initial release

data/README.md

@@ -11,7 +11,7 @@ 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
+  validates_intersection_of :permission, in: DEFAULT_PERMISSION
 end
 ```
 
@@ -21,8 +21,8 @@ If you want to validate your user based on an array:
 user = User.new(permission: ["read", "share"])
 user.valid? #true
 
- user = User.new(permission: ["read", "admin"])
- user.valid? #false
+user = User.new(permission: ["read", "admin"])
+user.valid? #false
 ```
 
  This active model custom validation **is for you**!
@@ -43,22 +43,28 @@ Or install it yourself as:
 
     $ gem install active_model_validates_intersection_of
 
+If your framework doesn't auto require gems, don't forget to do it after require of `active_model` gem.
+
+    require "active_model"
+    require "active_model_validates_intersection_of"
+
 ## Usage
 
-* `in:` parameter is required
-* `message:` is optional
+* `:in` - Parameter is required
+* `:within` - A synonym(alias) for `:in`
+* `:message` - Specifies a custom error message (optional)
 
 ```ruby
 class User < ActiveRecord::Base
   DEFAULT_PERMISSION = ["read", "write", "share"]
-  validates_intersection_of :permission, in: DEFAULT_ROLES
+  validates_intersection_of :permission, in: DEFAULT_PERMISSION
 end
 ```
 
 ```ruby
 class User < ActiveRecord::Base
   DEFAULT_PERMISSION = ["read", "write", "share"]
-  validates_intersection_of :permission, in: DEFAULT_ROLES, message: "invalid permission"
+  validates_intersection_of :permission, within: DEFAULT_PERMISSION, message: "invalid permission"
 end
 ```
 
@@ -67,7 +73,7 @@ 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
+  validates_with ActiveModelValidatesIntersectionOf::Validator, attributes: [:permission], in: DEFAULT_PERMISSION
 end
 ```
 

data/lib/active_model_validates_intersection_of/{inclusion_intersection_validator.rb → validator.rb}

@@ -1,10 +1,11 @@
 module ActiveModelValidatesIntersectionOf
   class Validator < ActiveModel::EachValidator
     def validate_each(record, attribute, value)
-      delimiter = options[:in]
+      delimiter = options[:in] || options[:within]
       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))
+        record.errors.add(attribute, :inclusion, options.except(:in, :within).merge!(value: value))
       end
     end
   end

data/lib/active_model_validates_intersection_of/version.rb

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

data/lib/active_model_validates_intersection_of.rb

@@ -1,3 +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"
+require "active_model_validates_intersection_of/validator.rb"
+require "validates_intersection_of_alias.rb"

data/spec/lib/validates_intersection_of_alias_spec.rb

@@ -11,31 +11,58 @@ RSpec.describe ActiveModel::Validations::HelperMethods do
   let(:badsetup) { BadSetup.new }
 
   context "setup" do
-    describe "without an :in configuration" do
+    describe "with neither :in nor :within configuration" do
       it_behaves_like "invalid configuration"
     end
   end
 
-  VALID_ARRAY = ["z", "x", 5 , 6]
+  context "validation" do
+    context "with :in option" do
+      class List
+        VALID_ARRAY = ["z", "x", 5 , 6]
+        include ActiveModel::Validations
+        attr_accessor :list
+        validates_intersection_of :list, in: VALID_ARRAY, message: "not valid"
+      end
 
-  let(:valid_partial_array) { VALID_ARRAY.sample(2) }
-  let(:invalid_partial_array) { valid_partial_array + ["invalid"] }
+      let(:valid_partial_array) { List::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 }
 
-  subject { List.new }
+      context "validation" do
+        describe "with a valid list" do
+          it_behaves_like "valid object"
+        end
 
-  context "validation" do
-    describe "with a valid list" do
-      it_behaves_like "valid object"
+        describe "with an invalid list" do
+          it_behaves_like "invalid object"
+        end
+      end
     end
 
-    describe "with an invalid list" do
-      it_behaves_like "invalid object"
+    context "with :within option" do
+      class ListWithinOption
+        VALID_ARRAY = ["z", "x", 5 , 6]
+        include ActiveModel::Validations
+        attr_accessor :list
+        validates_intersection_of :list, within: VALID_ARRAY, message: "not valid"
+      end
+
+      let(:valid_partial_array) { ListWithinOption::VALID_ARRAY.sample(2) }
+      let(:invalid_partial_array) { valid_partial_array + ["invalid"] }
+
+      subject { ListWithinOption.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
   end
 end

data/spec/lib/validator_spec.rb

@@ -0,0 +1,65 @@
+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 "with neither :in nor :within configuration" do
+      it_behaves_like "invalid configuration"
+    end
+  end
+
+  context "validation" do
+    context "with :in option" do
+      class ListValidator
+        VALID_ARRAY = ["a", "b", 1 , 2]
+        include ActiveModel::Validations
+        attr_accessor :list
+        validates_with ActiveModelValidatesIntersectionOf::Validator, attributes: [:list], in: VALID_ARRAY, message: "not valid"
+      end
+
+      let(:valid_partial_array) { ListValidator::VALID_ARRAY.sample(2) }
+      let(:invalid_partial_array) { valid_partial_array + ["invalid"] }
+      subject { ListValidator.new }
+
+      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
+
+    context "with :within option" do
+      class WithinOptionListValidator
+        VALID_ARRAY = ["a", "b", 1 , 2]
+        include ActiveModel::Validations
+        attr_accessor :list
+        validates_with ActiveModelValidatesIntersectionOf::Validator, attributes: [:list], within: VALID_ARRAY, message: "not valid"
+      end
+
+      let(:valid_partial_array) { WithinOptionListValidator::VALID_ARRAY.sample(2) }
+      let(:invalid_partial_array) { valid_partial_array + ["invalid"] }
+
+      subject { WithinOptionListValidator.new }
+
+      context "validation with :in option" 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
+  end
+end

data/spec/spec_helper.rb

@@ -1,7 +1,7 @@
 require "bundler/setup"
 require "active_model"
 require "active_model_validates_intersection_of"
-require 'coveralls'
+require "coveralls"
 Coveralls.wear!
 
 RSpec.configure do |config|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_model_validates_intersection_of
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Rafael Biriba
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-01 00:00:00.000000000 Z
+date: 2017-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -91,16 +91,17 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - 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/validator.rb
 - lib/active_model_validates_intersection_of/version.rb
-- spec/lib/inclusion_intersection_validator_spec.rb
+- lib/validates_intersection_of_alias.rb
 - spec/lib/validates_intersection_of_alias_spec.rb
+- spec/lib/validator_spec.rb
 - spec/shared.rb
 - spec/spec_helper.rb
 homepage: https://github.com/rafaelbiriba/active_model_validates_intersection_of
@@ -129,7 +130,7 @@ 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/lib/validator_spec.rb
 - spec/shared.rb
 - spec/spec_helper.rb

data/spec/lib/inclusion_intersection_validator_spec.rb

@@ -1,41 +0,0 @@
-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