poro_validator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 072a8e275c97616be8b4b507107f78f01738b5bb
+  data.tar.gz: 278dc6e7841a98f5e713e0257096ab30aa5a7658
+SHA512:
+  metadata.gz: 982f54f710bf94743d207f6be12375d3a4b7a9f287c37a4962f981d6c49b172c61d436c69ede5db32df11d8c4536328d9d1039c957169a31b7f3fb4d4c1bd313
+  data.tar.gz: 868f211a49e50d7be95c3c2d259db8d9e6f52b6c80c72a6680db16bd59808561311b1b7fcf4c648b05ca54be5a85fe4c38e1677ba61dba9b08aa159ef9902e7a

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, 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, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other 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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :tools do
+  gem 'pry'
+  gem 'pry-byebug'
+  gem 'pry-rescue', github: 'ConradIrwin/pry-rescue'
+  gem 'pry-stack_explorer'
+  gem 'ruby-graphviz'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Kareem Gan
+
+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,382 @@
+# PORO Validator #
+
+[![Gem Version][GV img]][Gem Version]
+[![Build Status][BS img]][Build Status]
+[![Dependency Status][DS img]][Dependency Status]
+[![Code Climate][CC img]][Code Climate]
+[![Coverage Status][CS img]][Coverage Status]
+
+PoroValidator is a lightweight validation library for your
+**P**lain **O**ld **R**uby **O**bjects (hence PoroValidator).
+
+I always believed that validation is a seperate concern and should not be defined in the object
+that you are going to be validating. This validator library aims to seperate the validation to a
+seperate concern giving it great flexibility and scalability.
+
+It is framework agnostic and can be used on any plain old ruby object/entities.
+
+#### ActiveRecord/ActiveModel::Validations
+While [ActiveModel::Validations] is great if you've got simple validation logic,
+it doesn't cut it for complex validations needs. When you have different validation
+for the same object at each point in it's life cycle, you need something more flexible.
+
+The problem with [ActiveModel::Validations] is that it hooks pretty deep into [ActiveRecord].
+The main use case for [ActiveModel::Validations] is to prevent bad data hitting your
+database - which isn't always the case (sometimes we want to allow bad data to go through).
+PoroValidator decouples your validation logic from your object structure. With
+PoroValidator you can define different validation rules for different contexts.
+So instead of *objective* validation where the validation is defined in the object
+you want to validate we define it in a seperate class making it *subjective*.
+
+## Features ##
+- **Familiar, simple and consistent API.**
+- **Framework agnostic, all you need is a PORO**.
+- **Validation logic is decoupled from business logic by creating seperate *validator* classes
+  which allows easy testing for the validator class**.
+- **No magic, caller is in control.**
+- **Invalid validations does not necessitate inability to persist to database**.
+- [**Conditional Validations via `:if` and `:unless`.**](#conditional-validations)
+- [**Nested validations for nested object structures - nicely handling nested errors.**](#nested-validations)
+- [**Composable validations by reusing existing validators.**](#composable-validations)
+- [**Create custom validators.**](#custom-validators)
+- **Overrideable messages either via the ```:message``` option or through the configuration.**
+- **Easily test validator classes.**
+
+## Installation ##
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'poro_validator'
+```
+
+And then execute:
+
+```ruby
+$ bundle install
+```
+
+Or install it yourself as:
+
+```ruby
+$ gem install poro_validator
+```
+
+## Usage ##
+
+### Creating and using the validator ###
+```ruby
+# Create a validator
+class CustomerValidator
+  include PoroValidator.validator
+
+  validates :last_name, presence: true
+  validates :first_name, presence: true
+  validates :age, numeric: { min: 18 }
+end
+
+customer = CustomerDetail.new
+
+# Validate entity
+
+validator = CustomerValidator.new
+validator.valid?(customer) # => false
+validator.errors.full_messages # => ["last name is not present", "..."]
+```
+
+## Validators ##
+
+### Default Validators ###
+- [exclusion_validator](#exclusion-validator)
+- [float_validator](#float-validator)
+- [format_validator](#format-validator)
+- [inclusion_validator](#inclusion-validator)
+- [integer_validator](#integer-validator)
+- [length_validator](#length-validator)
+- [numeric_validator](#numeric-validator)
+- [presence_validator](#presence-validator)
+- [with_validator](#with-validator)
+
+#### Exclusion Validator ####
+##### Option:
+- `in:` responds to an Array, Range or Set
+
+```
+  validates :foo, exclusion: 5..10
+  validates :boo, exclusion: [1,2,3,4,5]
+  validates :zoo, exclusion: { in: [1,2,3,4,5] }
+  validates :moo, exclusion: 5..10, if: proc { false }
+```
+
+#### Float Validator ####
+```
+  validates :foo, float: true
+  validates :boo, float: true, if: proc { false }
+```
+
+#### Format Validator ####
+##### Option
+- `with` pass in regex or string
+
+```
+  validates :foo, format: /[a-z]/
+  validates :boo, format: { with: /[a-z]/ }
+```
+
+#### Inclusion Validator ####
+##### Option
+```
+  validates :foo, inclusion: 1..10
+  validates :boo, inclusion: { in: [1,2,3,4,5] }
+  validates :zoo, inclusion: { in: 1..10 }
+```
+
+#### Integer Validator ####
+```
+  validates :foo, integer: true
+  validates :boo, integer: true, if: proc { false }
+```
+
+#### Length Validator ####
+##### Value must be either a string or can be casted as one
+##### Options:
+- `extremum:` min and max
+- `min:` minimum
+- `max:` maximum
+
+```
+  validates :foo, length: 1..10
+  validates :boo, length: { extremum: 1 }
+  validates :zoo, length: { min: 10, max: 20 }
+  validates :moo, length: { min: 10 }
+  validates :goo, length: { max: 10 }
+  validates :loo, length: 1..10, if: proc { false }
+```
+
+#### Numeric Validator ####
+##### Value must be either an integer or can be casted as one
+##### Options:
+- `extremum:` min and max
+- `min:` minimum
+- `max:` maximum
+
+```
+  validates :foo, numeric: 1..10
+  validates :boo, numeric: { extremum: 5 }
+  validates :zoo, numeric: { min: 10, max: 20 }
+  validates :moo, numeric: { min: 10 }
+  validates :goo, numeric: { max: 20 }
+  validates :loo, numeric: 1..10, if: proc { false }
+```
+
+#### Presence Validator ####
+```
+  validates :foo, presence: true
+  validates :boo, presence: true, if: proc { false }
+```
+
+#### With Validator ####
+Options:
+- `:with` requires an existing validator class to be passed
+
+```
+  validates :foo, with: ExistingValidator
+```
+
+### Custom Validators ###
+Creating validators is easy! Just follow the example below!
+
+```ruby
+module PoroValidator
+  module Validators
+    class CustomValidator < BaseClass
+
+      def validate(attribute, value, options)
+        message = options[:message] || "custom validator message"
+        # your validation logic code goes here..
+
+        # add error message if validation fails
+        errors.add(attribute, message, options)
+      end
+    end
+  end
+end
+```
+
+#### Note when creating custom validators
+You can either define the error message in your validator like shown above or
+define it via the [PoroValidator.configuration](#error-messages)
+
+### Error Messages ###
+
+#### #configure
+The ```message``` configuration object, allows you to change the default error message produced by each validator. The message must be in the form of a lambda or Proc, and may or may not receive an argument. Use the example below for reference when customizing messages.
+
+```ruby
+PoroValidator.configure do |config|
+    config.message.set(:numeric, lambda { "is not a number" })
+    config.message.set(:presence, lambda { "is not present" })
+    config.message.set(:inclusion, lambda { |set| "not in the set: #{set.inspect}")
+    ...
+end
+```
+
+#### #on method
+The `on` method is used to acccess the error messages related to a key or attribute/method.
+
+##### unnested validations
+Pass in either a symbol or a string
+
+```ruby
+validator.errors.on(:attribute) || validator.errors.on("attribute")
+```
+
+##### nested validations
+Pass in a nested hash structure reflective of the object that was validated
+
+```ruby
+validator.errors.on({address: :line1})
+validator.errors.on({address: {city: :locality}})
+validator.errors.on({address: {country: {coordinates: {planent: :name}}}})
+```
+
+## Conditional Validations ##
+You can pass in conditional
+
+```ruby
+class CustomerValidator
+  include PoroValidator.validator
+
+  validates :last_name, presence: { unless: :foo_condition }
+  validates :first_name, presence: { if: lambda { true } }
+  validates :dob, presence: { if: :method_in_the_validator_class }
+  validates :age, presence: { if: :entity_method }
+  validates :address do
+    validates :line1, presence: { if: 'entity.nested_entity.method' }
+  end
+```
+
+## Nested Validations ##
+```ruby
+# validator
+class CustomerDetailValidator
+  include PoroValidator.validator
+
+  validates :customer_id, presence: true
+
+  validates :customer do
+    validates :first_name, presence: true
+    validates :last_name,  presence: true
+  end
+
+  validates :address do
+    validates :line1, presence: true
+    validates :line2, presence: true
+    validates :city,  presence: true
+    validates :country do
+      validates :iso_code,   presence: true
+      validates :short_name, presence: true
+      validates :coordinates do
+        validates :longtitude, presence: true
+        validates :latitude,   presence:true
+        validates :planet do
+          validates :name, presence: true
+        end
+      end
+    end
+  end
+end
+
+entity = CustomerDetailEntity.new
+validator = CustomerDetailValidator.new
+validator.valid?(entity)
+validator.errors.full_messages # => [
+  "customer_id is not present",
+  "{:customer=>:first_name} is not present",
+  "{:customer=>:last_name} is not present",
+  "{:address=>{:country=>{:coordinates=>:longtitude}}} is not present",
+  "{:address=>{:country=>{:coordinates=>:latitude}}} is not present",
+  "{:address=>{:country=>{:coordinates=>{:planet=>:name}}}} is not present"
+]
+```
+
+## Composable Validations ##
+
+```ruby
+# Create a validators
+class CustomerValidator
+  include PoroValidator.validator
+
+  validates :last_name, presence: true
+  validates :first_name, presence: true
+  validates :age, numeric: { min: 18 }
+end
+
+class AddressValidator
+  include PoroValidator.validator
+
+  validates :line1, presence: true
+  validates :lin2, presence: true
+  validates :city, presence: true
+  validates :state, presence: true
+  validates :zip_code, format: /[0-9]/
+end
+
+# Create another validator and use the existing validator class as an option
+
+class CustomerValidator
+  include PoroValidator.validator
+
+  validates :customer, with: CustomerValidator
+  validates :address, with: AddressValidator
+end
+
+# Create an entities
+class CustomerDetailEntity
+  attr_accessor :customer
+  attr_accessor :address
+end
+
+customer_detail = CustomerDetailEntity.new
+
+# Validate entity
+
+validator = CustomerValidator.new
+validator.valid?(customer_detail) # => false
+validator.errors.full_messages # => [
+  "customer" => "last name is not present", ".."
+  "address" => "line1 is not present", ".."
+]
+```
+
+## Maintainers
+
+- [magicalbanana](https://github.com/magicalbanana)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/magicalbanana/poro_validator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](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).
+
+## Copyright
+
+Copyright (c) 2015 Kareem Gan
+
+[Gem Version]: https://badge.fury.io/rb/poro_validator
+[Build Status]: https://travis-ci.org/magicalbanana/poro_validator
+[travis pull requests]: https://travis-ci.org/magicalbanana/poro_validator/pull_requests
+[Dependency Status]: https://gemnasium.com/magicalbanana/poro_validator
+[Code Climate]: https://codeclimate.com/github/magicalbanana/poro_validator
+[Coverage Status]: https://coveralls.io/r/magicalbanana/poro_validator
+
+[GV img]: https://badge.fury.io/rb/poro_validator.svg
+[BS img]: https://travis-ci.org/magicalbanana/poro_validator.svg
+[DS img]: https://gemnasium.com/magicalbanana/poro_validator.svg
+[CC img]: https://codeclimate.com/github/magicalbanana/poro_validator.svg
+[CS img]: https://coveralls.io/repos/magicalbanana/poro_validator/badge.svg?branch=master&service=github
+
+[ActiveModel::Validations]: http://api.rubyonrails.org/classes/ActiveModel/Validations.html
+[ActiveRecord]: http://guides.rubyonrails.org/active_record_validations.html

data/Rakefile

@@ -0,0 +1,139 @@
+require 'rubygems'
+require 'rake'
+require 'date'
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}/version.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def date
+  Date.today.to_s
+end
+
+def rubyforge_project
+  name
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  ENV["COVERAGE"] = "true"
+  t.pattern = Dir.glob('spec/**/*_spec.rb')
+  t.rspec_opts = '--format documentation'
+end
+
+task default: :test
+task test: :spec
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "pry -I ./lib/ -rubygems -r ./lib/#{name}.rb"
+end
+
+#############################################################################
+#
+# Custom tasks (add your own tasks here)
+#
+#############################################################################
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+task release: :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push --tags"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+task build: :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+task gemspec: :validate do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+  #comment this out if your rubyforge_project has a different name
+  replace_header(head, :rubyforge_project)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  spec.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
+
+task :validate do
+  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}"]
+  unless libfiles.empty?
+    puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir."
+    exit!
+  end
+  unless Dir['VERSION*'].empty?
+    puts "A `VERSION` file at root level violates Gem best practices."
+    exit!
+  end
+end