object_validator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 38e5163cdd4b657e8c6cf4ea098963cbe68a16da
+  data.tar.gz: da5812ecd141e5547c4e0b724da391ec751b8178
+SHA512:
+  metadata.gz: b3d118fd0e4643bf821a588539add77271fbeb4c32e3a62c888d2f28c77e3f511d3c9439d3aeeaceab8a370299d31ab0fc56f427458b9cc24e84fab45ddc7412
+  data.tar.gz: e5521efa582b8cb9ac67e4947532775d6343b27fce17362b3b264943d0795fd8672fcc10d1c234baad7d00fb809f498d44ce6d1002ab6c1199cfe6dd15795131

data/.gitignore

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

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# 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 nsweeting@gmail.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

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Nicholas Sweeting
+
+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,137 @@
+# ObjectValidator
+
+ObjectValidator is a set of simple module mixins for validating Plain Old Ruby Object data. A lightweight alternative to ActiveModel. As of now it has small set of validations - but these are easily extensible.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'object_validator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install object_validator
+
+## Usage
+
+To include validation on an object, we must do:
+
+```ruby
+include ObjectValidator::Validate
+```
+
+So, given a Person object, we would have:
+
+```ruby
+class Person
+  include ObjectValidator::Validate
+
+  attr_accessor :name, :email, :details, :age, :uri
+end
+```
+
+We must then create an accompanying Validator object. The Validator object must be named appropriately. This is simply the name of the object in question, with the addition of 'Validator'. With our Person object, it would look like this.
+
+```ruby
+class PersonValidator
+  include ObjectValidator::Validator
+
+  validates :name, presence: true, type: String
+  validates :details, keys: [:number, :street, :phone]
+  validates :age, greater_than: 0
+  validates :uri, with: { proc: proc { |p| p.uri.length > 5 }, msg: 'is too short' }
+end
+```
+
+With this, we can now do the following with our Person object.
+
+```ruby
+person = Person.new
+person.valid? => false
+person.errors => #<ObjectValidator::Errors:0x0055b508b1b9b8 @all={:name=>["must not be Nil", "must be a String"], :details=>["does not contain required Hash keys"], :age=>["value is less than required"], :uri=>["is too short"]}>
+person.errors.full_messages = > ["Name must not be Nil.", "Name must be a String.", "Details does not contain required Hash keys.", "Age value is less than required.", "Uri is too short."]
+```
+
+As of now, the following validations are available:
+
+#### Presence
+Checks whether the attribute is nil or empty.
+
+```ruby
+validates :example, presence: true
+```
+
+#### Type
+Checks whether the attribute is of a certain type.
+
+```ruby
+validates :example, type: String
+```
+
+#### Keys
+Checks whether the attribute is a Hash and contains certain keys.
+
+```ruby
+validates :example, keys: [:number, :street, :phone]
+```
+
+#### Greater Than
+Checks whether the attribute is Numeric and greater than a value.
+
+```ruby
+validates :example, greater_than: 0
+```
+
+#### With
+A general purpose validator. The proc will be run, and a returned value of true will result in a pass. The proc will be passed the object being validated. You must also assign a custom message.
+
+```ruby
+validates :example, with: { proc: proc { |e| e.example.length > 5 }, msg: 'is too short' }
+```
+
+## Adding Validations
+
+You can easily add more validations. Simply create a new class within ObjectValidator::Checks. The name of the class represents the key that can be used for validation. Within the check, you will have access to the following:
+
+* name - The symbol of the attribute being validated.
+* method - The attribute being validated.
+* value - The value that is passed to the check.
+* errors - The error object for the object we are validating.
+
+For example, this is the Type check.
+
+```ruby
+module ObjectValidator
+  module Checks
+    class Type < Base
+      def call
+        return if method.is_a?(value)
+        errors.add(name, "must be a #{value.name}")
+      end
+    end
+  end
+end
+```
+
+Simply return if the check passes. Otherwise, we can add a new error.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. 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/[USERNAME]/object_validator. 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

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "object_validator"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/object_validator/checks/greater_than.rb

@@ -0,0 +1,10 @@
+module ObjectValidator
+  module Checks
+    class GreaterThan < Base
+      def call
+        return if method.is_a?(Numeric) && method > value
+        errors.add(name, 'value is less than required')
+      end
+    end
+  end
+end

data/lib/object_validator/checks/keys.rb

@@ -0,0 +1,11 @@
+module ObjectValidator
+  module Checks
+    class Keys < Base
+      def call
+        return if method.is_a?(Hash) &&
+                  value.each { |key| break false unless method.key?(key) }
+        errors.add(name, 'does not contain required Hash keys')
+      end
+    end
+  end
+end

data/lib/object_validator/checks/presence.rb

@@ -0,0 +1,12 @@
+module ObjectValidator
+  module Checks
+    class Presence < Base
+      def call
+        presence = !method.nil? || method.respond_to?(:empty?) && !method.empty?
+        return if value == presence
+        errors.add(name, 'must not be Nil') if value
+        errors.add(name, 'must be Nil') unless value
+      end
+    end
+  end
+end

data/lib/object_validator/checks/type.rb

@@ -0,0 +1,10 @@
+module ObjectValidator
+  module Checks
+    class Type < Base
+      def call
+        return if method.is_a?(value)
+        errors.add(name, "must be a #{value.name}")
+      end
+    end
+  end
+end

data/lib/object_validator/checks/with.rb

@@ -0,0 +1,11 @@
+module ObjectValidator
+  module Checks
+    class With < Base
+      def call
+        fail unless value[:proc].call(object)
+      rescue
+        errors.add(name, value[:msg])
+      end
+    end
+  end
+end

data/lib/object_validator/errors.rb

@@ -0,0 +1,22 @@
+module ObjectValidator
+  class Errors
+    attr_accessor :all
+
+    def initialize
+      @all = {}
+      @full_messages = []
+    end
+
+    def add(name, msg)
+      (@all[name] ||= []) << msg
+    end
+
+    def full_messages
+      @all.map do |error|
+        attr, errors = *error
+        errors.each { |e| @full_messages << "#{attr.to_s.capitalize} #{e}." }
+      end
+      @full_messages
+    end
+  end
+end

data/lib/object_validator/validate.rb

@@ -0,0 +1,19 @@
+module ObjectValidator
+  module Validate
+    def valid?
+      @validator = validator_klass.new(self)
+      @validator.valid?
+    end
+
+    def errors
+      return Errors.new unless defined?(@validator)
+      @validator.errors
+    end
+
+    private
+
+    def validator_klass
+      @validator_klass ||= Object.const_get("#{self.class.name}Validator")
+    end
+  end
+end

data/lib/object_validator/validator.rb

@@ -0,0 +1,66 @@
+module ObjectValidator
+  module Validator
+    def self.included(base)
+      base.extend(ClassMethods)
+      base.send(:include, InstanceMethods)
+    end
+
+    module InstanceMethods
+      attr_reader :object, :errors
+
+      def initialize(object)
+        @object = object
+        @errors = Errors.new
+      end
+
+      def valid?
+        self.class.checks.each { |args| call_checks(*args) }
+        @errors.all.empty?
+      end
+
+      private
+
+      def call_checks(name, checks)
+        checks.each do |check|
+          klass = check.first.to_s.split('_').collect(&:capitalize).join
+          klass = Object.const_get("ObjectValidator::Checks::#{klass}")
+          klass.new(@object, @errors, name, check.last).call
+        end
+      end
+    end
+
+    module ClassMethods
+      def validates(*args)
+        create_check(args)
+      end
+
+      def checks
+        @checks
+      end
+
+      private
+
+      def create_check(args)
+        @checks = [] unless defined?(@checks)
+        @checks << args
+      end
+    end
+  end
+
+  module Checks
+    class Base
+      attr_accessor :object, :errors, :name, :value
+
+      def initialize(object, errors, name, value)
+        @object = object
+        @errors = errors
+        @name = name
+        @value = value
+      end
+
+      def method
+        @method ||= @object.send(@name)
+      end
+    end
+  end
+end

data/lib/object_validator/version.rb

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

data/lib/object_validator.rb

@@ -0,0 +1,11 @@
+require 'object_validator/version'
+require 'object_validator/validate'
+require 'object_validator/validator'
+require 'object_validator/errors'
+
+#Checks
+require 'object_validator/checks/greater_than'
+require 'object_validator/checks/keys'
+require 'object_validator/checks/presence'
+require 'object_validator/checks/type'
+require 'object_validator/checks/with'

data/object_validator.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'object_validator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "object_validator"
+  spec.version       = ObjectValidator::VERSION
+  spec.authors       = ["Nicholas Sweeting"]
+  spec.email         = ["nsweeting@gmail.com"]
+
+  spec.summary       = 'A lightweight validator for Plain Old Ruby Objects.'
+  spec.description   = 'A lightweight validator for Plain Old Ruby Objects.'
+  spec.homepage      = 'https://github.com/nsweeting/object_validator'
+  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.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: object_validator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nicholas Sweeting
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: A lightweight validator for Plain Old Ruby Objects.
+email:
+- nsweeting@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/object_validator.rb
+- lib/object_validator/checks/greater_than.rb
+- lib/object_validator/checks/keys.rb
+- lib/object_validator/checks/presence.rb
+- lib/object_validator/checks/type.rb
+- lib/object_validator/checks/with.rb
+- lib/object_validator/errors.rb
+- lib/object_validator/validate.rb
+- lib/object_validator/validator.rb
+- lib/object_validator/version.rb
+- object_validator.gemspec
+homepage: https://github.com/nsweeting/object_validator
+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.5.0
+signing_key: 
+specification_version: 4
+summary: A lightweight validator for Plain Old Ruby Objects.
+test_files: []
+has_rdoc: