is_hash_valid 1.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b8bbbdef9cccd7f6cd83e79af707b7c3b8ec73c5
+  data.tar.gz: b117e808c72081f7750c337b7883324f81491051
+SHA512:
+  metadata.gz: 822ecd1710f9bbb776f8835aee77aa5558563141bfa88b960ceccf90de8aa2f9a7b3eb21e8849b6247279b11775ca17a5e87522f98bfe6f56b30119f0a63d240
+  data.tar.gz: 728d64354fb8f0b97b3bd71a5da012d4268c5b567ceb0af204d83a3e1515f9c1326cabca0aa5054ff7b55f1bc096e526323989a8e30ad82b282cf12fc2964ae4

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format d

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Ben Janecke
+
+MIT License
+
+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,84 @@
+# IsHashValid
+
+A simple hash validator that allows you to do complex validations with custom error messages.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'is_hash_valid'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install is_hash_valid
+
+## Usage
+
+### Roll your own validator 
+
+```ruby
+class SnobbyValidator < IsHashValid::Validator
+  def initialize(hash)
+    super hash {
+      name: {
+        be_royal: "Must be of royalty"
+      },
+      age: {
+        over18: "No minors allowed"
+      }
+    }
+  end
+
+  def over18(value)
+    value > 18
+  end
+
+  def be_royal(value)
+    value.scan(/King|Queen/).empty? ? false : true
+  end
+end
+
+valid = SnobbyValidator.new({ name: 'King Richard', age: 9001 })
+invalid = SnobbyValidator.new({ name: 'Timmy', age: 8 })
+
+valid.valid? #true
+valid.errors # {}
+
+invalid.valid? #false
+invalid.errors # { errors: { name: [ "Must be of royalty "], age: ["No minors allowed"] } }
+
+```
+
+### Or use some of the baked in validators
+
+```ruby
+invalid = IsHashValid::Validator.new({ name: 2 }, { 
+  name: {
+    not_empty: "Name may not be empty",
+    be_string: "Name must be a string"
+  } 
+})
+
+invalid.valid? #false
+invalid.errors # { errors: { name: [ "Name may not be empty", "Name must be a string" ] } }
+```
+
+Current baked in validators are 
+
+* not_empty
+* be_string
+* required
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/is_hash_valid/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/is_hash_valid.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'is_hash_valid/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "is_hash_valid"
+  spec.version       = IsHashValid::VERSION
+  spec.authors       = ["Ben Janecke"]
+  spec.email         = ["benjanecke@gmail.com"]
+  spec.summary       = %q{A simple hash validator.}
+  spec.description   = %q{A simple hash validator that allows you to do complex validations with custom error messages.}
+  spec.homepage      = "https://github.com/BenJanecke/is_hash_valid"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2.0"
+end

data/lib/is_hash_valid/validator.rb

@@ -0,0 +1,33 @@
+require_relative 'validators'
+
+module IsHashValid
+  class Validator
+    include IsHashValid::Validators
+
+    def initialize(hash, validators)
+      @hash = hash
+      @validators = validators
+      @errors = { }
+      validate
+    end
+
+    def valid?
+      @errors.empty? ? true : false
+    end
+
+    def errors
+      { errors: @errors }
+    end
+
+    def validate
+      @validators.each do |field, validators|
+        validators.each do |validator, message|
+          if !self.send(validator.to_sym, @hash[field.to_sym])
+            @errors[field] = [] unless @errors.has_key? field
+            @errors[field].push(message)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/is_hash_valid/validators.rb

@@ -0,0 +1,16 @@
+module IsHashValid
+  module Validators
+    def required(value)
+      value ? true : false
+    end
+
+    def not_empty(value)
+      return false unless value.is_a? String
+      value.empty? ? false : true
+    end
+
+    def be_string(value)
+      value.is_a? String
+    end
+  end
+end

data/lib/is_hash_valid/version.rb

@@ -0,0 +1,3 @@
+module IsHashValid
+  VERSION = "1.1.1"
+end

data/lib/is_hash_valid.rb

@@ -0,0 +1,6 @@
+require "is_hash_valid/version"
+require "is_hash_valid/validator"
+require "is_hash_valid/validators"
+
+module IsHashValid
+end

data/spec/is_hash_valid/validator_spec.rb

@@ -0,0 +1,91 @@
+require "spec_helper"
+require "./lib/is_hash_valid/validator"
+
+describe IsHashValid::Validator do
+  subject { IsHashValid::Validator.new({}, {}) }
+
+  describe "#initialize" do
+    it "expects @hash to be set" do
+      expect(subject.instance_variable_get(:@hash)).to eq({})
+    end
+
+    it "expects @validators to be set" do
+      expect(subject.instance_variable_get(:@validators)).to eq({})
+    end
+  end
+
+  describe "#valid?" do
+    it "expects true by default" do
+      expect(subject.valid?).to eq(true)
+    end
+  end
+
+  describe "#errors" do
+    it "expects an empty hash by default" do
+      expect(subject.errors).to eq({ errors: {} })
+    end
+  end
+
+  describe "given a hash with a name attribute that may not be empty" do
+    describe "when name is empty" do
+      subject do
+        IsHashValid::Validator.new({ name: "" }, {
+          name: {
+            not_empty: "Name may not be empty"
+          }
+        })
+      end
+
+      describe "#valid?" do
+        it { expect(subject.valid?).to eq(false) }
+      end
+
+      describe "#errors" do
+        it { expect(subject.errors).to eq({ errors: { name: [ "Name may not be empty" ] } }) }
+      end
+    end
+
+    describe "when name is not empty" do
+      subject do
+        IsHashValid::Validator.new({ name: "I'm not empty :D" }, {
+          name: {
+            not_empty: 'Name may not be empty'
+          }
+        })
+      end
+
+      describe "#valid?" do
+        it { expect(subject.valid?).to eq(true) }
+      end
+
+      describe "#errors" do
+        it { expect(subject.errors).to eq({ errors: { } }) }
+      end
+
+    end
+  end
+
+  describe "given a subclass with a custom validator" do
+    class SubclassWithCustomValidator < IsHashValid::Validator
+      def be_royal(value)
+        value.scan(/King|Queen/).empty? ? false : true
+      end
+    end
+
+    describe "when I run 2 validators on name that both fail" do
+      subject do
+        SubclassWithCustomValidator.new({ name: "" }, {
+          name: {
+            not_empty: "Name may not be empty",
+            be_royal: "Name must be royal"
+          }
+        })
+      end
+
+      describe "#errors" do
+        it { expect(subject.errors).to eq({ errors: { name: [ "Name may not be empty", "Name must be royal" ] } }) }
+      end
+
+    end
+  end
+end

data/spec/is_hash_valid/validators_spec.rb

@@ -0,0 +1,40 @@
+require "spec_helper"
+require "./lib/is_hash_valid/validators"
+
+describe "Validators" do
+  subject { class ValidatorsSpec; include IsHashValid::Validators end.new }
+
+  describe "required" do
+    describe "given a empty string" do
+      it { expect(subject.required("")).to eq(true) }
+    end
+
+    describe "given nil" do
+      it { expect(subject.required(nil)).to eq(false) }
+    end
+  end
+
+  describe "not_empty" do
+    describe "given a empty string" do
+      it { expect(subject.not_empty("")).to eq(false) }
+    end
+
+    describe "given a string with a value" do
+      it { expect(subject.not_empty("I'm not empty!")).to eq(true) }
+    end
+  end
+
+  describe "be_string" do
+    describe "given a empty string" do
+      it { expect(subject.be_string("")).to eq(true) }
+    end
+
+    describe "given a integer" do
+      it { expect(subject.be_string(2)).to eq(false) }
+    end
+
+    describe "given a bool" do
+      it { expect(subject.be_string(true)).to eq(false) }
+    end
+  end
+end

data/spec/is_hash_valid/version_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+require './lib/is_hash_valid/version.rb'
+
+describe "Version" do
+  it { expect(IsHashValid::VERSION).to eq("1.1.1") }
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: is_hash_valid
+version: !ruby/object:Gem::Version
+  version: 1.1.1
+platform: ruby
+authors:
+- Ben Janecke
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+description: A simple hash validator that allows you to do complex validations with
+  custom error messages.
+email:
+- benjanecke@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- is_hash_valid.gemspec
+- lib/is_hash_valid.rb
+- lib/is_hash_valid/validator.rb
+- lib/is_hash_valid/validators.rb
+- lib/is_hash_valid/version.rb
+- spec/is_hash_valid/validator_spec.rb
+- spec/is_hash_valid/validators_spec.rb
+- spec/is_hash_valid/version_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/BenJanecke/is_hash_valid
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A simple hash validator.
+test_files:
+- spec/is_hash_valid/validator_spec.rb
+- spec/is_hash_valid/validators_spec.rb
+- spec/is_hash_valid/version_spec.rb
+- spec/spec_helper.rb