violated 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: db0d0c235783bdf4ea30a7894d85a8f8a1ea51ee
+  data.tar.gz: 8529cb5a53bf75caa91dc19fcb884b69a0fd2e32
+SHA512:
+  metadata.gz: 38b42ff487c4e5c8ea56c2f9bd3775274475e7780d97a121b1bf2c4f1a7b438604c97e5463b8d48bb1b45a70e688bd39028e886e11ddf5aff9fda982b062f40f
+  data.tar.gz: c31af8e061d840ad88ec68e70f4d670ebb5ed68ad31aea85d817e757c38746f000354bc125298293495ca1308758590e3be62791caf56b6615bff59b048eecbe

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--warnings
+--require spec_helper

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 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,104 @@
+# Violated
+
+Violated is a simple gem to do validation of any object.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'violated'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install violated
+
+## Usage
+
+### Quick start
+
+Add validation to any object by including `Violated.new`:
+
+    class Person
+      include Violated.new
+    end
+
+Then you can define the violations like this:
+
+    class Person
+      attr_reader :name
+
+      include Violated.new
+
+      violate(:name).when_not :present
+    end
+
+Or multiple per field:
+
+    class Person
+      attr_reader :name
+
+      include Violated.new
+
+      violate(:name).when_not :present, [:unique, ->(attr) { uniqueness_check_for_your_application }]
+    end
+
+You can see if the object is valid:
+
+    person.valid?
+
+and lookup the violations if not:
+
+    person.violations
+
+### Built-in validators
+
+#### :present
+
+    violate(:attr).when_not :present
+
+This fails with a required reason, when the attribute is not present.
+
+#### :unique
+    violate(:attr).when_not [:unique, ->(attr) { uniqueness_check_for_your_application }]
+
+This fails with a duplicate reason, when the lambda given returns true.
+
+### Creating your own validators
+
+First create the validator, a validator must be at least initialized with a field and it must respond to validate with an object:
+
+    class CustomValidator
+      def initialize(field)
+        @field = field
+      end
+
+      def validate(object)
+        object.violations << Violated::Violation.new(@field, :custom) if object.violates?(@field)
+      end
+    end
+
+Register it with the `Registry`:
+
+    Violated::Registry.register :custom, CustomValidator
+
+Use it in your class:
+
+    class Person
+      attr_reader :name
+
+      include Violated.new
+
+      violate(:name).when_not :custom
+    end
+
+## Contributing
+
+1. Fork it ( https://github.com/ThijsWouters/violated/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/lib/violated.rb

@@ -0,0 +1,10 @@
+require 'violated/version'
+require 'violated/violated'
+require 'violated/validators/presence_validator'
+require 'violated/validators/unique_validator'
+
+module Violated
+  def self.new
+    Violated.new
+  end
+end

data/lib/violated/registry.rb

@@ -0,0 +1,18 @@
+module Violated
+  module Registry
+    def self.register(name, klass)
+      validations[name] = klass
+    end
+
+    def self.get(name)
+      validations[name]
+    end
+
+    private
+    def self.validations
+      @validations ||= Hash.new do |_, name|
+        raise "#{name} not registered"
+      end
+    end
+  end
+end

data/lib/violated/validators/presence_validator.rb

@@ -0,0 +1,20 @@
+require 'violated/registry'
+require 'violated/violation'
+
+module Violated
+  class PresenceValidator
+    def initialize(_)
+    end
+
+    def reason
+      :required
+    end
+
+    def valid?(value)
+      !value.nil? && !value.empty?
+    end
+  end
+
+end
+
+Violated::Registry.register :present, Violated::PresenceValidator

data/lib/violated/validators/unique_validator.rb

@@ -0,0 +1,20 @@
+require 'violated/registry'
+require 'violated/violation'
+
+module Violated
+  class UniqueValidator
+    def initialize(_, unique_check)
+      @unique_check = unique_check
+    end
+
+    def reason
+      :duplicate
+    end
+
+    def valid?(value)
+      !@unique_check.call(value)
+    end
+  end
+end
+
+Violated::Registry.register :unique, Violated::UniqueValidator

data/lib/violated/version.rb

@@ -0,0 +1,3 @@
+module Violated
+  VERSION = '0.0.1'
+end

data/lib/violated/violated.rb

@@ -0,0 +1,44 @@
+require_relative 'violator'
+
+module Violated
+  class Violated < Module
+    module ClassMethods
+      def violates(field)
+        violator_hash[field]
+      end
+
+      def violators
+        violator_hash.values
+      end
+
+      def clear_violators
+        violator_hash.clear
+      end
+
+      def violator_hash
+        @violator_hash ||= Hash.new do |hash, field|
+          hash[field] = Violator.new(field)
+        end
+      end
+    end
+
+    module InstanceMethods
+      def valid?
+        violations.empty?
+      end
+
+      def violations
+        @violations ||= [].tap do |violations|
+          self.class.violators.each do |violator|
+            violations.concat(violator.violations_for(self))
+          end
+        end
+      end
+    end
+
+    def included(other)
+      other.send(:include, InstanceMethods)
+      other.send(:extend, ClassMethods)
+    end
+  end
+end

data/lib/violated/violation.rb

@@ -0,0 +1,3 @@
+module Violated
+  Violation = Struct.new(:field, :reason)
+end

data/lib/violated/violator.rb

@@ -0,0 +1,31 @@
+require_relative 'registry'
+
+module Violated
+  class Violator
+    def initialize(field)
+      @field = field
+    end
+
+    def when_not(*validators)
+      validators.each do |validator|
+        if Array === validator
+          validator_type, *args = *validator
+        else
+          validator_type, args = validator, []
+        end
+
+        self.validators << Registry.get(validator_type).new(@field, *args)
+      end
+    end
+
+    def validators
+      @validators ||= []
+    end
+
+    def violations_for(object)
+      validators.reject { |validator| validator.valid?(object.send(@field)) }.map do |violation|
+        Violation.new(@field, violation.reason)
+      end
+    end
+  end
+end

data/spec/built-in_validators/presence_validator_spec.rb

@@ -0,0 +1,25 @@
+RSpec.describe ':present' do
+  let(:test_class) { Struct.new(:name) do
+    include Violated.new
+
+    violates(:name).when_not :present
+  end }
+
+  context 'value is filled in' do
+    subject { test_class.new('Test Testington') }
+
+    it_behaves_like 'a valid object'
+  end
+
+  context 'value is nil' do
+    subject { test_class.new(nil) }
+
+    it_behaves_like 'an invalid object', [:name], [:required]
+  end
+
+  context 'value is empty' do
+    subject { test_class.new('') }
+
+    it_behaves_like 'an invalid object', [:name], [:required]
+  end
+end

data/spec/built-in_validators/unique_validator_spec.rb

@@ -0,0 +1,19 @@
+RSpec.describe ':unique' do
+  let(:test_class) { Struct.new(:name) do
+    include Violated.new
+
+    violates(:name).when_not [:unique, ->(name) { name == 'Exist Existington' }]
+  end }
+
+  context 'name is unique' do
+    subject { test_class.new('Test Testington') }
+
+    it_behaves_like 'a valid object'
+  end
+
+  context 'name is not unique' do
+    subject { test_class.new('Exist Existington') }
+
+    it_behaves_like 'an invalid object', [:name], [:duplicate]
+  end
+end

data/spec/custom_validators/custom_validator_spec.rb

@@ -0,0 +1,44 @@
+RSpec.describe 'custom validator' do
+  let(:test_class) {
+    Struct.new(:name) do
+      include Violated.new
+
+      violates(:name).when_not :custom
+    end
+  }
+  subject { test_class.new }
+
+  before do
+    Violated::Registry.register :custom, custom_validator
+  end
+
+  context 'with a failing validator' do
+    let(:custom_validator) { Class.new do
+      def initialize(_)
+      end
+
+      def reason
+        :custom
+      end
+
+      def valid?(_)
+        false
+      end
+    end }
+
+    it_behaves_like 'an invalid object', [:name], [:custom]
+  end
+
+  context 'with a succeeding validator' do
+    let(:custom_validator) { Class.new do
+      def initialize(_)
+      end
+
+      def valid?(_)
+        true
+      end
+    end }
+
+    it_behaves_like 'a valid object'
+  end
+end

data/spec/multiple_violations/multiple_violations_per_field_spec.rb

@@ -0,0 +1,25 @@
+RSpec.describe 'multiple violations per field' do
+  let(:test_class) {Struct.new(:name) do
+    include Violated.new
+
+    violates(:name).when_not :present, [:unique, ->(name) { name == '' }]
+  end}
+
+  context 'no violations' do
+    subject { test_class.new('Test Testington') }
+
+    it_behaves_like 'a valid object'
+  end
+
+  context 'name is not present but unique (1 violation)' do
+    subject { test_class.new(nil) }
+
+    it_behaves_like 'an invalid object', [:name], [:required]
+  end
+
+  context 'name is not present and exists (2 violations)' do
+    subject { test_class.new('') }
+
+    it_behaves_like 'an invalid object', [:name, :name], [:required, :duplicate]
+  end
+end

data/spec/multiple_violations/violates_multiple_fields_spec.rb

@@ -0,0 +1,26 @@
+RSpec.describe 'violates multiple fields' do
+  let(:test_class) { Struct.new(:name, :address) do
+    include Violated.new
+
+    violates(:name).when_not :present
+    violates(:address).when_not :present
+  end }
+
+  context 'no violations' do
+    subject { test_class.new('Test Testington', '123 Avenuestreet, Township') }
+
+    it_behaves_like 'a valid object'
+  end
+
+  context 'one violation' do
+    subject { test_class.new('Test Testington', '') }
+
+    it_behaves_like 'an invalid object', [:address], [:required]
+  end
+
+  context 'two violations' do
+    subject { test_class.new('', '') }
+
+    it_behaves_like 'an invalid object', [:name, :address], [:required, :required]
+  end
+end

data/spec/shared_examples.rb

@@ -0,0 +1,35 @@
+RSpec.shared_examples 'a valid object' do
+  describe '#valid?' do
+    it 'returns true' do
+      expect(subject).to be_valid
+    end
+  end
+
+  describe '#violations' do
+    it 'is empty' do
+      expect(subject.violations).to be_empty
+    end
+  end
+end
+
+RSpec.shared_examples 'an invalid object' do |expected_fields, expected_reasons|
+  describe '#valid?' do
+    it 'returns false' do
+      expect(subject).not_to be_valid
+    end
+  end
+
+  describe '#violations' do
+    it "contains #{expected_fields.count} violation(s)" do
+      expect(subject.violations.count).to eq(expected_fields.count)
+    end
+
+    it "contains the #{expected_reasons} reasons" do
+      expect(subject.violations.map(&:reason)).to contain_exactly(*expected_reasons)
+    end
+
+    it "contains the #{expected_fields} fields" do
+      expect(subject.violations.map(&:field)).to contain_exactly(*expected_fields)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+require 'violated'
+require 'shared_examples'
+
+RSpec.configure do |config|
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.profile_examples = 10
+
+  config.order = :random
+
+  Kernel.srand config.seed
+
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :expect
+    mocks.verify_partial_doubles = true
+  end
+end

data/violated.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'violated/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'violated'
+  spec.version = Violated::VERSION
+  spec.authors = ['Thijs Wouters']
+  spec.email = ['thijs@morewood.be']
+  spec.summary = 'A simple gem to do validation'
+  spec.description = spec.summary
+  spec.homepage = 'https://github.com/ThijsWouters/violated'
+  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.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end
+

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: violated
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Thijs Wouters
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-14 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: '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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple gem to do validation
+email:
+- thijs@morewood.be
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/violated.rb
+- lib/violated/registry.rb
+- lib/violated/validators/presence_validator.rb
+- lib/violated/validators/unique_validator.rb
+- lib/violated/version.rb
+- lib/violated/violated.rb
+- lib/violated/violation.rb
+- lib/violated/violator.rb
+- spec/built-in_validators/presence_validator_spec.rb
+- spec/built-in_validators/unique_validator_spec.rb
+- spec/custom_validators/custom_validator_spec.rb
+- spec/multiple_violations/multiple_violations_per_field_spec.rb
+- spec/multiple_violations/violates_multiple_fields_spec.rb
+- spec/shared_examples.rb
+- spec/spec_helper.rb
+- violated.gemspec
+homepage: https://github.com/ThijsWouters/violated
+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 gem to do validation
+test_files:
+- spec/built-in_validators/presence_validator_spec.rb
+- spec/built-in_validators/unique_validator_spec.rb
+- spec/custom_validators/custom_validator_spec.rb
+- spec/multiple_violations/multiple_violations_per_field_spec.rb
+- spec/multiple_violations/violates_multiple_fields_spec.rb
+- spec/shared_examples.rb
+- spec/spec_helper.rb