enum_attributes_validation 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2fd6e05a56f58024f5393bc168563c041e1954b5
-  data.tar.gz: 22209197eed9c900e6230fbd3f3d58235093a8f5
+  metadata.gz: 355752203802ce0a6de195b9263267011473a55a
+  data.tar.gz: da2be498bfe9b5616bb2af20b5618b09ecad7c86
 SHA512:
-  metadata.gz: 2c16cb855fab91a5c1d0cf188f00e26c67b76bbdc4260459bc7eaf494930be6cb2982b7b155c36bab78632b1d70e9e98db34404cc77b3759f682155f484e551a
-  data.tar.gz: 07776dece012a1663646221c2f3e844b1205c14648fc89f17dcfb62161f0af6b20bd96e068fa28ba7abb97263360d170b0c8908f0adbd4f82f838bfce48e69d8
+  metadata.gz: b01b8c222a306fe8dd916c6752dead5db0e3bcb34010e1a84f3c52dcff7eb8d48aee491f2e549f00d13e2441bd4148d125c568c566183bafd6b6e310ac82b5b6
+  data.tar.gz: 2e67752331b376feb444d4ea28b6036aba4020aa0d29b551a87b032aba186d6eb4146541e015e588e97d85ba55e22078eef1abd09937e65609b9666c9fcd215e

data/Gemfile.lock

@@ -1,7 +1,9 @@
 PATH
   remote: .
   specs:
-    enum_attributes_validation (0.1.4)
+    enum_attributes_validation (0.1.7)
+      activerecord
+      activesupport
 
 GEM
   remote: https://rubygems.org/
@@ -18,11 +20,27 @@ GEM
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     arel (8.0.0)
+    byebug (10.0.0)
     concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
     i18n (0.9.1)
       concurrent-ruby (~> 1.0)
     minitest (5.10.3)
     rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    sqlite3 (1.3.13)
     thread_safe (0.3.6)
     tzinfo (1.2.4)
       thread_safe (~> 0.1)
@@ -34,8 +52,12 @@ DEPENDENCIES
   activerecord
   activesupport
   bundler (~> 1.16)
+  byebug
   enum_attributes_validation!
+  i18n
   rake (~> 10.0)
+  rspec (~> 3.4)
+  sqlite3
 
 BUNDLED WITH
    1.16.0

data/README.md

@@ -1,6 +1,7 @@
+
 # EnumAttributesValidation
 
-Enum Attributes Validation provides validation functionality for enum attributes in models.
+Enum Attributes Validation provides validation functionality for enum attributes in models. It validates **inclusion** for the specified enum keys. If values are **nil** the record is saved.
 
 ## Installation
 
@@ -20,19 +21,72 @@ Or install it yourself as:
 
 ## Usage
 
-Use built in method to specify which enum attributes you want to validate with inclusion.
+Use built in method to specify which enum attributes you want to validate.
+
+```ruby
+class Dog < ApplicationRecord
+  enum gender: { male: 0, female: 1 }
+  enum hair_color: { brown: 0, black: 1, blonde: 2 }
+
+  validate_enum_attributes :gender, :hair_color
+end
+
+dog = Dog.new(hair_color: :brown, gender: :female)
+dog.save
+# => <Dog gender: "female", hair_color: "brown" >
+
+dog = Dog.new
+dog.save
+# => <Dog gender: nil, hair_color: nil >
+
+dog = Dog.new(hair_color: nil, gender: nil)
+dog.save
+# => <Dog gender: nil, hair_color: nil >
+```
+
+Or use the singular method.
 
 ```ruby
-class Comment < ApplicationRecord
-  enum gender { male: 0, female: 1 }
+class Dog < ApplicationRecord
+  enum gender: { male: 0, female: 1 }
+  enum hair_color: { brown: 0, black: 1, blonde: 2 }
 
-  validate_enum_attributes :gender
+  validate_enum_attribute :gender
 end
 ```
 
+
+### Custom error messages
+
+To show a custom error message:
+
+```ruby
+class Dog < ApplicationRecord
+  enum gender: { male: 0, female: 1 }
+
+  validate_enum_attribute :gender, message: "Some string msg..."
+end
+```
+
+### Translations
+
+To use translations you need to update your locale file as follows
+
+```yml
+en:
+  activerecord:
+    errors:
+      models:
+        #your_model_name#:
+          attributes:
+            #your_attribute_name#::
+              invalid_enum: "can't be %{value}. Valid values are: %{valid_values}"
+
+```
+
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/enum_attributes_validation.
+Bug reports and pull requests are welcome on GitHub at https://github.com/CristiRazvi/enum_attributes_validation.
 
 ## License
 

data/lib/enum_attributes_validation.rb

@@ -1,4 +1,4 @@
-require "enum_attributes_validation/version"
+require 'enum_attributes_validation/version'
 require 'active_support'
 require 'active_record'
 
@@ -16,22 +16,28 @@ module EnumAttributesValidation
 
       def check_enum_invalid_attributes
         if enum_invalid_attributes.present?
-          enum_invalid_attributes.each do |key, value|
-            errors.add(key, "invalid #{value}")
+          enum_invalid_attributes.each do |key, opts|
+            if opts[:message]
+              self.errors.add(:base, opts[:message])
+            else
+              self.errors.add(key, :invalid_enum, value: opts[:value], valid_values: self.class.send(key.to_s.pluralize).keys.sort.join(', '), default: "value provided (#{opts[:value]}) is invalid")
+            end
           end
         end
       end
   end
 
   class_methods do
-    def validate_enum_attributes(*attributes)
+    def validate_enum_attributes(*attributes, **opts)
       attributes.each do |attribute|
         string_attribute = attribute.to_s
 
         define_method (string_attribute+"=").to_sym do |argument|
-          string_argument = argument.to_s
-          self[string_attribute] = string_argument                  if self.class.send(string_attribute.pluralize).keys.include?(string_argument)
-          self.enum_invalid_attributes[attribute] = string_argument unless self.class.send(string_attribute.pluralize).keys.include?(string_argument)
+          unless argument.nil?
+            string_argument = argument.to_s
+            self[string_attribute]                  = string_argument                    if     self.class.send(string_attribute.pluralize).keys.include?(string_argument)
+            self.enum_invalid_attributes[attribute] = opts.merge(value: string_argument) unless self.class.send(string_attribute.pluralize).keys.include?(string_argument)
+          end
         end
       end
     end

data/lib/enum_attributes_validation/version.rb

@@ -1,3 +1,3 @@
 module EnumAttributesValidation
-  VERSION = "0.1.6"
+  VERSION = "0.1.7"
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: enum_attributes_validation
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Cristi Stefan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-11 00:00:00.000000000 Z
+date: 2018-02-11 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +66,76 @@ dependencies:
     - - "~>"
       - !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.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: byebug
+  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: i18n
+  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: Enum Attributes Validation provides validation functionality for enum
   attributes in models.
 email:
@@ -75,7 +173,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Validate model enum attributes