sanatio 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 479bf5da1408bc5c3ff984ad7baa6899a49a5152
+  data.tar.gz: 1dff2a76f7fe9f3393ee37b4312df7a30cf9e6a0
+SHA512:
+  metadata.gz: 3703329eb46d2bd728dab0e55c0e38a59f3569fbe005767f36f2d23952c588ffde5e8e27a48ea93496ac9e7e2e77823bc0ca14f5072d109c4758c0399e00ccad
+  data.tar.gz: 74bf2a27049e5d97281505679c3a71fde78d10176844fc6f987e94546148efa7761bd3a1a34b29c2b1fe96fb4fe561c071826fda580b281da425ddfc300f65d9

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.ruby-version
+.ruby-gemset

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 2.2
+  - 2.1
+  - 2.0
+  - 1.9.3
+  - 1.9.2
+  - 1.8.7
+  - jruby-18mode
+  - jruby-19mode
+  - rbx

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, 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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sanatio.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Thijs Wouters
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Thijs Wouters
+
+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,86 @@
+# Sanatio
+
+![Build status](https://travis-ci.org/ThijsWouters/sanatio.svg)
+
+Sanatio is a gem that does validation. It has no external dependencies.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sanatio'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sanatio
+
+## Usage
+
+### One-time validation
+
+If you only need a validation in a single place. You can use a block.
+
+If your block evaluates to a falsey value, then the validation fails with the reason that is given.
+
+With field level validation:
+
+```ruby
+class Person
+  include Sanatio
+
+  def initialize(name)
+    @name = name
+  end
+
+  attr_reader :name
+
+  ensure_that(:name).is { !nil? }.reason = :not_nil
+end
+
+person = Person.new(nil)
+error = person.errors.first
+error.field # :name
+error.reason # :not_nil
+person.valid? # false
+```
+
+Or, with a class level validation:
+
+```ruby
+class Person
+  include Sanatio
+
+  def initialize(name)
+    @name = name
+  end
+
+  attr_reader :name
+
+  ensure_that(self).is { !name.nil? }.reason = :name_not_nil
+end
+
+person = Person.new(nil)
+error = person.errors.first
+error.reason # :name_not_nil
+person.valid? # false
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/sanatio/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,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList["**/test_*.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sanatio"
+
+# 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,9 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+gem install bundler
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sanatio/class_validator.rb

@@ -0,0 +1,23 @@
+require 'sanatio/usage_error'
+
+module Sanatio
+  class ClassValidator
+    attr_accessor :reason
+
+    def initialize
+    end
+
+    def is(&validation_block)
+      unless block_given?
+        raise UsageError.new("self")
+      end
+
+      @validation_block = validation_block
+      self
+    end
+
+    def valid?(object)
+      object.instance_eval(&@validation_block)
+    end
+  end
+end

data/lib/sanatio/error.rb

@@ -0,0 +1,13 @@
+require 'forwardable'
+
+module Sanatio
+  class Error
+    extend Forwardable
+
+    def_delegators :@validation, :field, :reason
+
+    def initialize(validation)
+      @validation = validation
+    end
+  end
+end

data/lib/sanatio/field_validator.rb

@@ -0,0 +1,25 @@
+require 'sanatio/usage_error'
+
+module Sanatio
+  class FieldValidator
+    attr_reader :field
+    attr_accessor :reason
+
+    def initialize(field)
+      @field = field
+    end
+
+    def is(&validation_block)
+      unless block_given?
+        raise UsageError.new(":#{field}")
+      end
+
+      @validation_block = validation_block
+      self
+    end
+
+    def valid?(object)
+      object.send(@field).instance_eval &@validation_block
+    end
+  end
+end

data/lib/sanatio/usage_error.rb

@@ -0,0 +1,7 @@
+module Sanatio
+  class UsageError < StandardError
+    def initialize(target)
+      super("You need to give a block to #is. The correct usage is:\nensure_that(#{target}).is { validation_test }")
+    end
+  end
+end

data/lib/sanatio/validator_factory.rb

@@ -0,0 +1,14 @@
+require "sanatio/field_validator"
+require "sanatio/class_validator"
+
+module Sanatio
+  module ValidatorFactory
+    def self.create(target)
+      if target.instance_of? Class
+        ClassValidator.new
+      else
+        FieldValidator.new(target)
+      end
+    end
+  end
+end

data/lib/sanatio/version.rb

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

data/lib/sanatio.rb

@@ -0,0 +1,34 @@
+require "sanatio/version"
+require "sanatio/error"
+require "sanatio/validator_factory"
+
+module Sanatio
+  module ClassMethods
+    def ensure_that(target)
+      ValidatorFactory.create(target).tap do |validator|
+        validators << validator
+      end
+    end
+
+    def validators
+      @validation ||= []
+    end
+  end
+
+  module InstanceMethods
+    def valid?
+      errors.empty?
+    end
+
+    def errors
+      self.class.validators.reject do |validator|
+        validator.valid?(self)
+      end.map(&Error.method(:new))
+    end
+  end
+
+  def self.included(other)
+    other.send(:include, InstanceMethods)
+    other.send(:extend, ClassMethods)
+  end
+end

data/sanatio.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sanatio/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sanatio"
+  spec.version       = Sanatio::VERSION
+  spec.authors       = ["Thijs Wouters"]
+  spec.email         = ["thijs@morewood.be"]
+
+  spec.summary       = "A gem for validation, without all the dependencies."
+  spec.homepage      = "https://github.com/ThijsWouters/sanatio"
+  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.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: sanatio
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Thijs Wouters
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-04-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: 
+email:
+- thijs@morewood.be
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sanatio.rb
+- lib/sanatio/class_validator.rb
+- lib/sanatio/error.rb
+- lib/sanatio/field_validator.rb
+- lib/sanatio/usage_error.rb
+- lib/sanatio/validator_factory.rb
+- lib/sanatio/version.rb
+- sanatio.gemspec
+homepage: https://github.com/ThijsWouters/sanatio
+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.4.6
+signing_key: 
+specification_version: 4
+summary: A gem for validation, without all the dependencies.
+test_files: []