validation_profiler 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 009ab57e0d9f853b5579576803bfd2fefa1369fe
-  data.tar.gz: 9c4f0fdff2487fdc274bb05bb6c977f3d6e10cef
+  metadata.gz: 7be2894803b988aa43fe3a86cfe093e5587b6a5f
+  data.tar.gz: 9f66612e86d070d44f00a2ac78430cc85e08399d
 SHA512:
-  metadata.gz: 04dc04f887ae68b8754ebbc5064ddc5d25ffc353b309084759d426d8e4de5d982643bfe950d4af4e9b7c611cf26af3f2590eddd86f19265b4e65bcf9b37540fb
-  data.tar.gz: 3e35caa074aa7e880cd1d6eb66764c44706790c39107faaa3b36de800876a742d478cda9aa7586cb197dcf6bf59d155a716bc4d82fedd48a077b12dd79b9ed55
+  metadata.gz: 8b5cff7ae9c92fd45a564512a28a287d97b20a3b2f8afe3748421e4bfb4b3c2d162a68455d29ee5b90bb126f55885eb0767b85c21c89ddb4b8aa61cb80042149
+  data.tar.gz: 9ff70cec914fea2c6b2e1fca817783ff9bea54d0bfc98e44dd54311ff89c39732a09aa3b249f18c6835d70d89fdee3b6d582530b84c6d4ea0110f15bfc07a2de

data/lib/validation_profiler/rules/rules.rb

@@ -1,4 +1,3 @@
-require 'pry'
 
 class InvalidRuleAttributes < StandardError
 

data/lib/validation_profiler/rules/validation_rule_manager.rb

@@ -1,4 +1,3 @@
-require 'pry'
 require_relative '../../../lib/validation_profiler/rules/rules'
 
 # This is the manager class that holds all registered validation rules.

data/lib/validation_profiler/version.rb

@@ -1,3 +1,3 @@
 module ValidationProfiler
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/validation_profiler.rb

@@ -1,5 +1,4 @@
 require "validation_profiler/version"
-require 'pry'
 class Class
 
   # Specifies a validation rule to use within a validation profile.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: validation_profiler
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - vaughanbrittonsage
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-19 00:00:00.000000000 Z
+date: 2016-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -60,20 +60,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- CODE_OF_CONDUCT.md
-- Gemfile
-- LICENSE.txt
-- README.md
-- Rakefile
 - bin/console
 - bin/setup
 - lib/validation_profiler.rb
 - lib/validation_profiler/rules/rules.rb
 - lib/validation_profiler/rules/validation_rule_manager.rb
 - lib/validation_profiler/version.rb
-- validation_profiler.gemspec
 homepage: https://github.com/vaughanbrittonsage/validation_profiler
 licenses:
 - MIT

data/.gitignore

@@ -1,9 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/

data/.rspec

@@ -1,2 +0,0 @@
---color
---require spec_helper

data/CODE_OF_CONDUCT.md

@@ -1,49 +0,0 @@
-# Contributor Code of Conduct
-
-As contributors and maintainers of this project, and in the interest of
-fostering an open and welcoming community, we pledge to respect all people who
-contribute through reporting issues, posting feature requests, updating
-documentation, submitting pull requests or patches, and other activities.
-
-We are committed to making participation in this project a harassment-free
-experience for everyone, regardless of level of experience, gender, gender
-identity and expression, sexual orientation, disability, personal appearance,
-body size, race, ethnicity, age, religion, or nationality.
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery
-* Personal attacks
-* Trolling or insulting/derogatory comments
-* Public or private harassment
-* Publishing other's private information, such as physical or electronic
-  addresses, without explicit permission
-* Other unethical or unprofessional conduct
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-By adopting this Code of Conduct, project maintainers commit themselves to
-fairly and consistently applying these principles to every aspect of managing
-this project. Project maintainers who do not follow or enforce the Code of
-Conduct may be permanently removed from the project team.
-
-This code of conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community.
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting a project maintainer at vaughan.britton@sage.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. Maintainers are
-obligated to maintain confidentiality with regard to the reporter of an
-incident.
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 1.3.0, available at
-[http://contributor-covenant.org/version/1/3/0/][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -1,6 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in validation_profiler.gemspec
-gemspec
-
-require 'pry'

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2016 vaughanbrittonsage
-
-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

@@ -1,297 +0,0 @@
-# ValidationProfiler
-
-Welcome to ValidationProfiler. This is a validation framework that allows you to seperate validation logic away from your objects and into validation profiles that can be re-used and changed without affecting your objects.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'validation_profiler'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install validation_profiler
-
-## Usage
-
-First you need to create a validation profile to hold the validation logic you want to apply, validation profiles must inherit from the ValidationProfile base class or another validation profile.
-
-    class SignUpValidationProfile < ValidationProfile
-	    .....
-    end
-
-Then you specify validation rules that should be checked when this profile is validated against an object.
-
-    class SignUpValidationProfile < ValidationProfile
-	    validates :age, :min, { value: 18 }
-	    validates :email, :email
-	    ..... 
-    end
-
-When specifying a validation rule you need to specify the following arguments:
-
- - Field name
- - Rule key
- - Hash containing any options required for the validation rule
-
-So if we take another look at the first validation rule we specified in the **SignUpValidationProfile** above:
-
-	Field name = :age
-	Rule key = :min 
-	Attributes Hash = { value: 18 }
-
-This validation statement will be interpreted as: 
-*"The field :age must have a minimum value of 18"*
-
-To use a validation profile you need to make a call to the **ValidationManager** class, and pass the object you want to validate along with the profile you want to use for the validation:
-
-    #create the validation manager
-    manager = ValidationManager.new
-    
-    #call the validate method and pass the object and profile
-    result = manager.validate(user, profile)
-
-Calls to the validate method will return a **ValidationManagerResult** that will detail the results of the validation.
-
-A **ValidationManagerResult** has the following attributes:
-
- - #outcome = [Boolean] overall outcome of the validation (passed or failed)
- - #errors = [Array] containing details of each field error that occurred during validation.
-
-Each item in the errors array has the following attributes:
-
- - #field = The name of the field that this error occurred for.
- - #message = A message that describes the validation error 
-
-## Validation Rules
-
-**RequiredValidationRule**
-
-This rule is used to specify a field must contain a value:
-
-    validates :name, :required
-
-Attributes:
-
- - **:message** [String] [Optional]
- This is used to allow a custom error message to be specified. 
-
-
-----------
-
-
-**LengthValidationRule**
-
-This rule is used to specify a [String] or [Array] must be of a certain length:
-
-    validates :name, :length, { min: 5, max: 10 }
-
-Attributes:
-
- - **:min** [Numeric]
- This is used to specify the minimum length of the field value.
- 
- - **:max** [Numeric]
- This is used to specify the maximum length of the field value.
- 
- > **:min** & **:max** can be included together or independently providing at least 1 is specified.
- 
- - **:message** [String] [Optional]
- This is used to allow a custom error message to be specified. 
- 
- - **:required** [Boolean] [Default=True] [Optional]
- This is used to specify if this rule should only be executed when the field contains a value.
- > **True** always executes, **False** only executes when the field contains a value)*
- 
-
-----------
-
-**MinValidationRule**
-
-This rule is used to specify a minimum value a [DateTime] or [Numeric] field must have.
-
-Attributes:
-
- - **:value** [Numeric/DateTime]
- This is used to specify the minimum value of the field.
- 
- - **:message** [String] [Optional]
- This is used to allow a custom error message to be specified. 
- 
- - **:required** [Boolean] [Default=True] [Optional]
-	 This is used to specify if this rule should only be executed when the field contains a value.
-> **True** always executes, **False** only executes when the field contains a value)*
- 
-----------
-
-**MaxValidationRule**
-
-This rule is used to specify a maximum value a [DateTime] or [Numeric] field must have.
-
-Attributes:
-
- - **:value** [Numeric/DateTime]
- This is used to specify the maximum value of the field.
- 
- - **:message** [String] [Optional]
- This is used to allow a custom error message to be specified. 
- 
- - **:required** [Boolean] [Default=True] [Optional]
- This is used to specify if this rule should only be executed the field contains a value.
-> **True** always executes, **False** only executes when the field contains a value)*
-
-----------
-
-**EmailValidationRule**
-
-This rule is used to specify a field value must contain a valid email address.
-
-Attributes:
-
- - **:message** [String] [Optional]
- This is used to allow a custom error message to be specified. 
- 
- - **:required** [Boolean] [Default=True] [Optional]
- This is used to specify if this rule should only be executed when the field contains a value.
-> **True** always executes, **False** only executes when the field contains a value)*
-
-----------
-
-**RegexValidationRule**
-
-This rule is used to specify a regex pattern that a field value must validate against.
-
-Attributes:
-
- - **:regex** [Regex]
-This is used to specify the regex pattern.
-
- - **:message** [String] [Optional]
- This is used to allow a custom error message to be specified. 
- 
- - **:required** [Boolean] [Default=True] [Optional]
- This is used to specify if this rule should only be executed when the field contains a value.
-> **True** always executes, **False** only executes when the field contains a value)*
-
-----------
-
-**MatchValidationRule**
-
-This rule is used to specify a field value must match the value of another field.
-
-Attributes:
-
- - **:field** [Symbol]
-This is used to specify the name of the other field this field's value must match.
-
- - **:message** [String] [Optional]
- This is used to allow a custom error message to be specified. 
- 
- - **:required** [Boolean] [Default=True] [Optional]
- This is used to specify if this rule should only be executed when the field contains a value.
- > **True** always executes, **False** only executes when the field contains a value)
-
-----------
-
-**ConditionValidationRule**
-
-This rule is used to specify a condition statement.
-
-e.g.
-
-> format:
-> 
-> When [:condition_field] [:condition_expression] [:condition_value] then [:field] [:field_expression] [:field_value]
->
->could be read as:
->
-> When :age >= 18 then :accept == true
-
-Attributes:
-
- - **:condition_field** [Symbol]
-This is used to specify the name of the condition field.
-
- - **:condition_expression** [String]
-This is used to specify the expression to use between the condition_field and the condition_value.
-
-> **Supported expression types:**
-> '=='
-> '>'
-> '>='
-> '<'
-> '<='
-> '!='
-   
-
- - **:condition_value** [String/Numeric/DateTime/nil]
-This is used to specify the value to use for the condition statement.
-
- - **:field_expression** [String]
-This is used to specify the expression to use between the field's value and the field_value attribute.
-
- - **:field_value** [String/Numeric/DateTime/nil]
-This is used to specify the value to use for the field statement.
- 
- - **:message** [String] [Optional]
- This is used to allow a custom error message to be specified. 
- 
- - **:required** [Boolean] [Default=True] [Optional]
- This is used to specify if this rule should only be executed when the field contains a value.
- > **True** always executes, **False** only executes when the field contains a value)
-
-----------
-
-##Custom Validation Rules
-
-To create a custom validation rule you must create a class that inherits from the **ValidationRule** base class and implement the #error_message and #validate methods, see the **RequiredValidationRule** below as an example:
-
-    class RequiredValidationRule < ValidationRule
-	    #implement this method to return the error message when
-	    #this rule fails validation
-	    def error_message(field, attributes = {})
-		    #check if custom message was specified
-		    if attributes[:message] == nil
-			    #return default method
-		      "#{field} is not valid"
-		    else
-			    #return custom message
-		      attributes[:message]
-		    end
-		end
-
-		def validate(obj, field, attributes = {})
-			#attempt to get the field value from the object
-			field_value = get_field_value(obj, field)
-			
-			if field_value == nil
-		      return false
-		    end
-
-		    return !field_value.empty?
-		end
-    end
-
-The **ValidationRule** base class provides the *#get_field_value(obj, field)* method to cater for fetching the field value from the object to perform the validation against.
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. You can also 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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/vaughanbrittonsage/validation_profiler. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
-
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/Rakefile

@@ -1,2 +0,0 @@
-require "bundler/gem_tasks"
-task :default => :spec

data/validation_profiler.gemspec

@@ -1,25 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'validation_profiler/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "validation_profiler"
-  spec.version       = ValidationProfiler::VERSION
-  spec.authors       = ["vaughanbrittonsage"]
-  spec.email         = ["vaughanbritton@gmail.com"]
-
-  spec.summary       = 'A Validation framework for creating validation profiles, allowing for the separation & reuse of validation logic from the object being validated.'
-  spec.description   = 'A Validation framework for creating validation profiles, allowing for the separation & reuse of validation logic from the object being validated.'
-  spec.homepage      = "https://github.com/vaughanbrittonsage/validation_profiler"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.11"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-end