sullivan 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b993257c0f51eb41768a9c272798cd6ec6caa160
+  data.tar.gz: 5e15408676c3ad43fb4645581120072914ae60aa
+SHA512:
+  metadata.gz: da18cbc61e3cff2bb8e1715126a9e46dd8ead724d719a5c8534eb3717074fac16568ac9127bc461aeb32515d30981400e925e3c7c4e4511abef429f51ce8e675
+  data.tar.gz: 13dece6a3657c7e653b87db7847ef42ad6faee4db2c6ee70cc52d62295ab05f08c4781bb3f5913843dee6a4499a6805797a168bd849cb9475773c71ef5ad34d8

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Go Daddy Operating Company, LLC
+
+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,29 @@
+# Sullivan
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sullivan'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sullivan
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/sullivan/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 new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/sullivan.rb

@@ -0,0 +1,28 @@
+module Sullivan
+  def self.validation(&block)
+    DSL.new.instance_eval(&block)
+  end
+
+  class DSL < BasicObject
+    def method_missing(method_name, *args)
+      constant_name = DSL.camelize(method_name.to_s)
+
+      if ::Sullivan::Validations.const_defined?(constant_name)
+        klass = ::Sullivan::Validations.const_get(constant_name)
+        klass.new(*args)
+      else
+        super
+      end
+    end
+
+    def self.camelize(string)
+      string.split('_').map(&:capitalize).join
+    end
+  end
+end
+
+require 'sullivan/validations/hash.rb'
+require 'sullivan/validations/kind_of.rb'
+require 'sullivan/validations/many.rb'
+require 'sullivan/validations/optional.rb'
+require 'sullivan/validations/string_matching.rb'

data/lib/sullivan/validations/hash.rb

@@ -0,0 +1,35 @@
+module Sullivan
+  module Validations
+    class Hash
+      def initialize(validations)
+        @validations = validations
+      end
+
+      def validate(hash)
+        return 'must be a hash' unless hash.respond_to?(:to_hash)
+        hash = hash.to_hash
+
+        errors = @validations.each_with_object({}) { |(key, validation), h|
+          error = validation.validate(hash[key])
+          h[key] = error unless error.nil?
+        }
+
+        errors.merge! (hash.keys - @validations.keys).each_with_object({}) { |unexpected_key, h| h[unexpected_key] = 'is unexpected' }
+
+        errors unless errors.empty?
+      end
+    end
+
+    class StringHash < Hash
+      def initialize(validations)
+        super stringify_keys(validations)
+      end
+
+      private
+
+      def stringify_keys(hash)
+        hash.each_with_object({}) { |(k, v), h| h[k.to_s] = v }
+      end
+    end
+  end
+end

data/lib/sullivan/validations/kind_of.rb

@@ -0,0 +1,15 @@
+module Sullivan
+  module Validations
+    class KindOf
+      def initialize(klass)
+        @klass = klass
+      end
+
+      def validate(value)
+        unless value.kind_of?(@klass)
+          "must be a kind of #{@klass}"
+        end
+      end
+    end
+  end
+end

data/lib/sullivan/validations/many.rb

@@ -0,0 +1,29 @@
+module Sullivan
+  module Validations
+    class Many
+      def initialize(validation, at_least: nil, at_most: nil)
+        @validation = validation
+        @at_least   = at_least
+        @at_most    = at_most
+      end
+
+      def validate(values)
+        return 'must be an array' unless values.respond_to?(:map)
+        return "must contain at least #{num_elements(@at_least)}" if @at_least && values.size < @at_least
+        return "must contain at most #{num_elements(@at_most)}"   if @at_most  && values.size > @at_most
+
+        errors = values.map do |value|
+          @validation.validate(value)
+        end
+
+        errors unless errors.all?(&:nil?)
+      end
+
+      private
+
+      def num_elements(n)
+        "#{n} #{n == 1 ? 'element' : 'elements'}"
+      end
+    end
+  end
+end

data/lib/sullivan/validations/optional.rb

@@ -0,0 +1,18 @@
+module Sullivan
+  module Validations
+    class Optional
+      def initialize(validation)
+        @validation = validation
+      end
+
+      def validate(value)
+        unless value.nil?
+          error = @validation.validate(value)
+          if error
+            error.respond_to?(:to_str) ? "#{error.to_str}, if present" : error
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sullivan/validations/string_matching.rb

@@ -0,0 +1,20 @@
+module Sullivan
+  module Validations
+    class StringMatching
+      def initialize(regex, error: nil)
+        @regex        = regex
+        @custom_error = error
+      end
+
+      def validate(value)
+        error unless value.respond_to?(:to_str) && value.to_str =~ @regex
+      end
+
+      private
+
+      def error
+        @custom_error || "must be a string matching #{@regex.inspect}"
+      end
+    end
+  end
+end

data/lib/sullivan/version.rb

@@ -0,0 +1,3 @@
+module Sullivan
+  VERSION = "0.0.1"
+end

data/spec/sullivan/validations/hash_spec.rb

@@ -0,0 +1,78 @@
+require 'sullivan/validations/hash'
+require 'sullivan/validations/kind_of'
+
+describe Sullivan::Validations::Hash do
+  def hash(validations)
+    Sullivan::Validations::Hash.new(validations)
+  end
+
+  let(:kind_of_string) { Sullivan::Validations::KindOf.new(String) }
+
+  it 'accepts a hash with matching keys' do
+    error = hash(a: kind_of_string).validate({a: 'a string'})
+    expect(error).to be_nil
+  end
+
+  it 'does not accept a hash with non-matching keys' do
+    error = hash(a: kind_of_string).validate({a: 1})
+    expect(error).to eq({a: 'must be a kind of String'})
+  end
+
+  it 'does not accept a hash with extra keys' do
+    error = hash({}).validate({a: 'a string'})
+    expect(error).to eq({a: 'is unexpected'})
+  end
+
+  it 'does not accept a hash with missing keys' do
+    error = hash(a: kind_of_string).validate({})
+    expect(error).to eq({a: 'must be a kind of String'})
+  end
+
+  it 'does not accept a non-hash' do
+    error = hash({a: kind_of_string}).validate('a')
+    expect(error).to eq('must be a hash')
+  end
+
+  it 'nests' do
+    error = hash(a: hash(b: kind_of_string)).validate({a: {b: 1}})
+    expect(error).to eq({a: {b: 'must be a kind of String'}})
+  end
+end
+
+describe Sullivan::Validations::StringHash do
+  def string_hash(validations)
+    Sullivan::Validations::StringHash.new(validations)
+  end
+
+  let(:kind_of_string) { Sullivan::Validations::KindOf.new(String) }
+
+  it 'accepts a hash with matching keys' do
+    error = string_hash(a: kind_of_string).validate({'a' => 'a string'})
+    expect(error).to be_nil
+  end
+
+  it 'does not accept a hash with non-matching keys' do
+    error = string_hash(a: kind_of_string).validate({'a' => 1})
+    expect(error).to eq({'a' => 'must be a kind of String'})
+  end
+
+  it 'does not accept a hash with extra keys' do
+    error = string_hash({}).validate({'a' => 'a string'})
+    expect(error).to eq({'a' => 'is unexpected'})
+  end
+
+  it 'does not accept a hash with missing keys' do
+    error = string_hash(a: kind_of_string).validate({})
+    expect(error).to eq({'a' => 'must be a kind of String'})
+  end
+
+  it 'does not accept a non-hash' do
+    error = string_hash({'a' => kind_of_string}).validate('a')
+    expect(error).to eq('must be a hash')
+  end
+
+  it 'nests' do
+    error = string_hash(a: string_hash(b: kind_of_string)).validate({'a' => {'b' => 1}})
+    expect(error).to eq({'a' => {'b' => 'must be a kind of String'}})
+  end
+end

data/spec/sullivan/validations/kind_of_spec.rb

@@ -0,0 +1,21 @@
+require 'sullivan/validations/kind_of'
+
+describe Sullivan::Validations::KindOf do
+  let(:validation) { Sullivan::Validations::KindOf.new(String) }
+
+  it 'accepts an object of the given type' do
+    error = validation.validate("a string")
+    expect(error).to be_nil
+  end
+
+  it 'accepts an object of a subtype of the given type' do
+    special_string_class = Class.new(String)
+    error = validation.validate(special_string_class.new("a string"))
+    expect(error).to be_nil
+  end
+
+  it 'does not accept an object of an unrelated type' do
+    error = validation.validate(1)
+    expect(error).to eq("must be a kind of String")
+  end
+end

data/spec/sullivan/validations/many_spec.rb

@@ -0,0 +1,67 @@
+require 'sullivan/validations/many'
+require 'sullivan/validations/kind_of'
+require 'sullivan/validations/hash'
+
+describe Sullivan::Validations::Many do
+  def many(validation, **opts)
+    Sullivan::Validations::Many.new(validation, **opts)
+  end
+
+  def hash(validations)
+    Sullivan::Validations::Hash.new(validations)
+  end
+
+  let(:kind_of_string) { Sullivan::Validations::KindOf.new(String) }
+
+  it 'accepts an empty array' do
+    error = many(kind_of_string).validate([])
+    expect(error).to be_nil
+  end
+
+  it 'accepts an array of matching elements' do
+    error = many(kind_of_string).validate(['a', 'b'])
+    expect(error).to be_nil
+  end
+
+  it 'does not accept an array including a non-matching element' do
+    error = many(kind_of_string).validate(['a', 2])
+    expect(error).to eq([nil, 'must be a kind of String'])
+  end
+
+  it 'accepts an array of matching hashes' do
+    error = many(hash(v: kind_of_string)).validate([{v: 'a'}, {v: 'b'}])
+    expect(error).to be_nil
+  end
+
+  it 'does not accept an array including a non-matching element' do
+    error = many(hash(v: kind_of_string)).validate([{v: 'a'}, {v: 2}])
+    expect(error).to eq([nil, {v: 'must be a kind of String'}])
+  end
+
+  it 'does not accept a non-enumerable' do
+    error = many(hash(v: kind_of_string)).validate('a')
+    expect(error).to eq('must be an array')
+  end
+
+  context "with size requirements" do
+    it 'does not accept an array with too few elements' do
+      error = many(kind_of_string, at_least: 1).validate([])
+      expect(error).to eq('must contain at least 1 element')
+    end
+
+    it 'accepts an array with enough elements' do
+      error = many(kind_of_string, at_least: 1).validate(['a'])
+      expect(error).to be_nil
+    end
+
+    it 'does not accept an array with too many elements' do
+      error = many(kind_of_string, at_most: 2).validate(['a', 'b', 'c'])
+      expect(error).to eq('must contain at most 2 elements')
+    end
+
+    it 'accepts an array with few enough elements' do
+      error = many(kind_of_string, at_most: 2).validate(['a', 'b'])
+      expect(error).to be_nil
+    end
+  end
+end

data/spec/sullivan/validations/optional_spec.rb

@@ -0,0 +1,33 @@
+require 'sullivan/validations/optional'
+
+describe Sullivan::Validations::Optional do
+  def optional(validation)
+    Sullivan::Validations::Optional.new(validation)
+  end
+
+  def hash(validations)
+    Sullivan::Validations::Hash.new(validations)
+  end
+
+  let(:kind_of_string) { Sullivan::Validations::KindOf.new(String) }
+
+  it 'should accept a missing value' do
+    error = optional(kind_of_string).validate(nil)
+    expect(error).to be_nil
+  end
+
+  it 'should accept a present, matching value' do
+    error = optional(kind_of_string).validate('foo')
+    expect(error).to be_nil
+  end
+
+  it 'should reject a present, non-matching value' do
+    error = optional(kind_of_string).validate(123)
+    expect(error).to eq('must be a kind of String, if present')
+  end
+
+  it "doesn't try to add 'if present' to structured errors" do
+    error = optional(hash(a: kind_of_string)).validate(a: 123)
+    expect(error).to eq(a: 'must be a kind of String')
+  end
+end

data/spec/sullivan/validations/string_matching_spec.rb

@@ -0,0 +1,22 @@
+require 'sullivan/validations/string_matching'
+
+describe Sullivan::Validations::StringMatching do
+  def string_matching(validation, **opts)
+    Sullivan::Validations::StringMatching.new(validation, **opts)
+  end
+
+  it "accepts a string which matches" do
+    error = string_matching(/please/).validate('Gimme, please.')
+    expect(error).to be_nil
+  end
+
+  it "does not accept a string which doesn't match" do
+    error = string_matching(/please/).validate('Gimme.')
+    expect(error).to eq('must be a string matching /please/')
+  end
+
+  it "takes a custom message" do
+    error = string_matching(/abc/, error: 'must contain the magic word').validate('Gimme.')
+    expect(error).to eq('must contain the magic word')
+  end
+end

data/spec/sullivan_spec.rb

@@ -0,0 +1,19 @@
+require 'sullivan'
+
+describe Sullivan do
+  describe ".validation" do
+    it "provides a convenient way to access the built-in validations" do
+      v = Sullivan.validation do
+        hash(
+          string_matching: string_matching(/\Al(ol)+\z/, error: "must be be a laugh"),
+          kind_of: kind_of(Numeric),
+        )
+      end
+
+      error = v.validate({})
+
+      expect(error[:string_matching]).to eq("must be be a laugh")
+      expect(error[:kind_of]).to eq("must be a kind of Numeric")
+    end
+  end
+end

data/sullivan.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sullivan/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sullivan"
+  spec.version       = Sullivan::VERSION
+  spec.authors       = ["Peter Jaros"]
+  spec.email         = ["peter.a.jaros@gmail.com"]
+  spec.summary       = %q{A simple, composable way to validate the structure of data.}
+  spec.description   = %q{A simple, composable way to validate the structure of data. "Form ever follows function. This is the law." — Louis Henry Sullivan}
+  spec.homepage      = ""
+  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.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.1.5"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: sullivan
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Peter Jaros
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.5
+description: A simple, composable way to validate the structure of data. "Form ever
+  follows function. This is the law." — Louis Henry Sullivan
+email:
+- peter.a.jaros@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sullivan.rb
+- lib/sullivan/validations/hash.rb
+- lib/sullivan/validations/kind_of.rb
+- lib/sullivan/validations/many.rb
+- lib/sullivan/validations/optional.rb
+- lib/sullivan/validations/string_matching.rb
+- lib/sullivan/version.rb
+- spec/sullivan/validations/hash_spec.rb
+- spec/sullivan/validations/kind_of_spec.rb
+- spec/sullivan/validations/many_spec.rb
+- spec/sullivan/validations/optional_spec.rb
+- spec/sullivan/validations/string_matching_spec.rb
+- spec/sullivan_spec.rb
+- sullivan.gemspec
+homepage: ''
+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.0
+signing_key: 
+specification_version: 4
+summary: A simple, composable way to validate the structure of data.
+test_files:
+- spec/sullivan/validations/hash_spec.rb
+- spec/sullivan/validations/kind_of_spec.rb
+- spec/sullivan/validations/many_spec.rb
+- spec/sullivan/validations/optional_spec.rb
+- spec/sullivan/validations/string_matching_spec.rb
+- spec/sullivan_spec.rb
+has_rdoc: