knight 0.0.2 → 0.0.3

data/.gitignore

@@ -4,6 +4,7 @@
 .config
 .yardoc
 Gemfile.lock
+Gemfile.local
 InstalledFiles
 _yardoc
 coverage

data/Gemfile

@@ -6,6 +6,6 @@ source 'https://rubygems.org'
 gemspec
 
 group :development, :test do
-  gem 'rontgen'
+  gem 'rontgen', git: 'https://github.com/handiwiguna/rontgen'
   eval_gemfile('Gemfile.dev') if File.exists?('Gemfile.dev')
 end

data/README.md

@@ -20,7 +20,39 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+class User
+  attr_reader :username
+
+  def initialize(username)
+    @username = username
+  end
+end
+user = User.new('john')
+
+validator = Knight::Validator.new(Rule::Presence.new(:username))
+result = validator.run(user)
+result.valid? # => true
+
+
+class UserValidator
+  include Knight::InstanceMethod
+
+  validator.add(Knight::Rule::Presence.new(:username))
+
+  context :login do |validator|
+    validator.add(Knight::Rule::Presence.new(:username))
+    validator.add(Knight::Rule::Presence.new(:password))
+  end
+end
+validator = UserValidator.new(user)
+
+result = validator.run
+result.valid? # => true
+
+result = validator.run(:login)
+result.valid? # => false
+```
 
 ## Contributing
 

data/lib/knight/error.rb

@@ -29,7 +29,7 @@ module Knight
     #
     # @api private
     def initialize(rule, resource)
-      @rule = rule
+      @rule     = rule
       @resource = resource
     end
 
@@ -45,16 +45,22 @@ module Knight
       rule.message % rule.to_hash.merge(value: value)
     end
 
-    private
+    # Return error attribute name
+    #
+    # @return [String]
+    #
+    # @api private
+    def attribute_name
+      rule.attribute_name
+    end
 
-    # Return attribute value
+    # Return error value
     #
     # @return [Object]
     #
     # @api private
     def value
-      attribute = rule.attribute_name
-      resource.public_send(attribute) if resource.respond_to?(attribute)
+      resource.public_send(attribute_name) if resource.respond_to?(attribute_name)
     end
   end
 end

data/lib/knight/instance_methods.rb

@@ -4,6 +4,7 @@ module Knight
 
   # Base functionality that added when included to a class
   module InstanceMethods
+    DEFAULT_CONTEXT = :default
 
     # Return the resource
     #
@@ -42,27 +43,64 @@ module Knight
     #
     #   class RegistrationValidator
     #     include Knight::InstanceMethods
-    #     validator.add(Knight::Rule::Presence.new(:username))
     #   end
     #
-    #   result = RegistrationValidator.new(user).result
+    #   result = RegistrationValidator.new(user).run
     #
     # @return [Result]
     #
     # @api public
-    def run(context = Validator::DEFAULT_CONTEXT)
-      self.class.validator.run(resource, context)
+    def run(context = DEFAULT_CONTEXT)
+      self.class.validator(context).run(resource)
     end
 
     module ClassMethods
 
       # Return the validator object
       #
+      # @example
+      #   class RegistrationValidator
+      #     include Knight::InstanceMethods
+      #
+      #     validator.add(Knight::Rule::Presence.new(:username))
+      #   end
+      #
       # @return [Validator]
       #
+      # @api public
+      def validator(context = DEFAULT_CONTEXT)
+        validators.fetch(context) do |key|
+          validators[key] = Validator.new
+        end
+      end
+
+      # Return the validator object
+      #
+      # @example
+      #   class RegistrationValidator
+      #     include Knight::InstanceMethods
+      #
+      #     context :register do |validator|
+      #       validator.add(Knight::Rule::Presence.new(:username))
+      #     end
+      #   end
+      #
+      # @return [undefined]
+      #
+      # @api public
+      def context(name)
+        yield validator(name)
+      end
+
+      private
+
+      # Return the validators contextual based
+      #
+      # @return [Hash]
+      #
       # @api private
-      def validator
-        @validator = @validator || Validator.new
+      def validators
+        @validators = @validators || {}
       end
     end
   end

data/lib/knight/result.rb

@@ -28,7 +28,7 @@ module Knight
     # @api private
     def initialize(resource, rules)
       @resource = resource
-      @rules = rules
+      @rules    = rules
     end
 
     # Check the result valid or not
@@ -67,6 +67,22 @@ module Knight
       end
     end
 
+    # Return the errors for specific attribute
+    #
+    # @example
+    #   validator = Validator.new(Rule::Presence.new(:username))
+    #   user = User.new(username: 'john')
+    #
+    #   result = validator.run(resource)
+    #   result.on(:username)
+    #
+    # @return [Set(Error)]
+    #
+    # @api public
+    def on(attribute)
+      errors.select { |error| error.attribute_name == attribute }
+    end
+
     private
 
     # Check an attribute to the rule

data/lib/knight/validator.rb

@@ -3,12 +3,20 @@
 module Knight
   class Validator
 
-    DEFAULT_CONTEXT = :default
+    # Return validation rules
+    #
+    # @example
+    #   validator = Validator.new(Rule::Presence.new(:username))
+    #   validator.rules
+    #
+    # @return [Set(Rule)]
+    #
+    # @api public
+    attr_reader :rules
 
     # Initialize a validator
     #
     # @example
-    #   Validator.new
     #   Validator.new(Rule::Presence.new(:username))
     #
     # @param [Array(Rule)] rules
@@ -17,8 +25,7 @@ module Knight
     #
     # @api public
     def initialize(*rules)
-      @rules = {}
-      rules.each { |rule| add(rule) }
+      @rules = Set.new(rules)
     end
 
     # Add a rule
@@ -28,64 +35,29 @@ module Knight
     #   validator.add(Rule::Presence.new(:username))
     #
     # @param [Rule] rule
-    # @param [Symbol] context
     #
     # @return [Set(Rule)]
     #
     # @api public
-    def add(rule, context_name = DEFAULT_CONTEXT)
-      context(context_name) { |rules| rules << rule } if rule
+    def add(rule)
+      rules << rule if rule
     end
 
     # Run the validator
     #
     # @example
-    #   validator = Validator.new(Rule::Presence.new(:username))
     #   user = User.new(username: 'john')
+    #
+    #   validator = Validator.new(Rule::Presence.new(:username))
     #   validator.run(user)
     #
     # @param [Object] resource
-    # @param [Symbol] context
     #
     # @return [Result]
     #
     # @api public
-    def run(resource, context_name = DEFAULT_CONTEXT)
-      Result.new(resource, rules(context_name))
-    end
-
-    # Run the validator
-    #
-    # @example
-    #   validator = Validator.new(Rule::Presence.new(:username))
-    #   validator.rules
-    #
-    # @param [Symbol] context
-    #
-    # @return [Set(Rule)]
-    #
-    # @api public
-    def rules(context_name = DEFAULT_CONTEXT)
-      @rules.fetch(context_name) do |key|
-        @rules[key] = Set.new
-      end
-    end
-
-    # Accept block
-    #
-    # @example
-    #   validator = Validator.new
-    #   validator.context :registration do |context|
-    #     context << Rule::Presence.new(:username)
-    #   end
-    #
-    # @param [Symbol] name
-    #
-    # @return [undefined]
-    #
-    # @api public
-    def context(name)
-      yield rules(name)
+    def run(resource)
+      Result.new(resource, rules)
     end
   end
 end

data/lib/knight/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module Knight
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/spec/integration/knight_spec.rb

@@ -5,17 +5,20 @@ require 'spec_helper'
 describe Knight do
   subject { result.valid? }
 
-  let(:result) { validator.new(resource).run }
+  let(:object) { validator.new(resource) }
+  let(:resource) { user_class.new('john') }
   let(:validator) do
     Class.new do
       include InstanceMethods
       validator.add(Rule::Presence.new(:username))
-      validator.add(Rule::ExactLength.new(:username, 4))
-      validator.add(Rule::Inclusion.new(:username, %w(john bejo)))
-      validator.add(Rule::Format.new(:username, /\Ajo/))
+
+      context :registration do |validator|
+        validator.add(Rule::ExactLength.new(:username, 4))
+        validator.add(Rule::Presence.new(:title))
+        validator.add(Rule::ExactLength.new(:description, 40))
+      end
     end
   end
-
   let(:user_class) do
     Class.new do
       attr_reader :username
@@ -25,6 +28,13 @@ describe Knight do
     end
   end
 
-  let(:resource) { user_class.new('john') }
-  it { should be_true }
+  context 'valid' do
+    let(:result) { object.run }
+    it { should be_true }
+  end
+
+  context 'invalid' do
+    let(:result) { object.run(:registration) }
+    it { should be_false }
+  end
 end

data/spec/spec_helper.rb

@@ -9,7 +9,7 @@ if ENV['COVERAGE'] == 'true'
     Coveralls::SimpleCov::Formatter
   ]
   SimpleCov.start do
-    add_filter "/spec/"
+    add_filter '/spec/'
   end
 end
 

data/spec/unit/knight/instance_methods/class_methods/context_spec.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe InstanceMethods, '.context' do
+
+  let(:described_class) { Class.new { include InstanceMethods } }
+
+  it do
+    described_class.should_receive(:validator).with(:registration).and_return(Validator.new)
+    described_class.context(:registration) do |validator|
+      validator.add Rule::Presence.new(:foo)
+    end
+  end
+end

data/spec/unit/knight/instance_methods/class_methods/included_spec.rb

@@ -3,10 +3,9 @@
 require 'spec_helper'
 
 describe InstanceMethods, '.included' do
-  subject { object }
+  subject { described_class }
 
-  let(:object) { described_class }
-  let(:klass)  { Class.new       }
+  let(:klass)  { Class.new }
 
   it 'delegates to the ancestor' do
     included_ancestor = false
@@ -21,4 +20,10 @@ describe InstanceMethods, '.included' do
     klass.send(:include, subject)
     expect(klass).to respond_to(:validator)
   end
+
+  it 'extends the klass' do
+    klass.singleton_class.should_not include(described_class::ClassMethods)
+    klass.send(:include, subject)
+    klass.singleton_class.should include(described_class::ClassMethods)
+  end
 end

data/spec/unit/knight/instance_methods/class_methods/validator_spec.rb

@@ -3,11 +3,21 @@
 require 'spec_helper'
 
 describe InstanceMethods, '.validator' do
-  subject { described_class.validator }
 
   let(:described_class) { Class.new { include InstanceMethods } }
   let(:object) { described_class.new(double('1')) }
 
-  it { should be_instance_of(Validator) }
-  specify { expect(subject).to equal(object.class.validator) }
+  context 'default context' do
+    subject { described_class.validator }
+
+    it { should be_instance_of(Validator) }
+    specify { expect(subject).to equal(object.class.validator) }
+  end
+
+  context 'registration context' do
+    subject { described_class.validator(:registration) }
+
+    it { should be_instance_of(Validator) }
+    specify { expect(subject).not_to equal(described_class.validator) }
+  end
 end

data/spec/unit/knight/instance_methods/run_spec.rb

@@ -3,27 +3,31 @@
 require 'spec_helper'
 
 describe InstanceMethods, '.run' do
-  subject { object.run }
 
   let(:described_class) do
     Class.new do
       include InstanceMethods
       validator.add(Rule::Presence.new(:username))
-      validator.add(Rule::Presence.new(:title), :registration)
+
+      context :registration do |validator|
+        validator.add(Rule::Presence.new(:username))
+        validator.add(Rule::Presence.new(:title))
+      end
     end
   end
   let(:object) { described_class.new(resource) }
   let(:resource) { double('resource') }
 
-  context 'default context' do
+  context 'run without context' do
     subject { object.run }
+    it { should be_instance_of(Result) }
     specify { expect(subject.rules).to eql(described_class.validator.rules) }
     specify { expect(subject.rules.size).to eql(1) }
   end
 
-  context 'register context' do
+  context 'run with context' do
     subject { object.run(:registration) }
-    specify { expect(subject.rules).to eql(described_class.validator.rules(:registration)) }
-    specify { expect(subject.rules.size).to eql(1) }
+    specify { expect(subject.rules).to eql(described_class.validator(:registration).rules) }
+    specify { expect(subject.rules.size).to eql(2) }
   end
 end

data/spec/unit/knight/result/on_spec.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Result, '#on' do
+  subject { result.on(:foo) }
+
+  let(:klass) do
+    Class.new do
+      attr_reader :foo
+      def initialize(foo)
+        @foo = foo
+      end
+    end
+  end
+
+  let(:result) { validator.run(resource) }
+  let(:validator) { Validator.new(*rules) }
+  let(:resource) { klass.new('bar') }
+  let(:rules) do
+    [
+      Rule::Presence.new(:foo),
+      Rule::ExactLength.new(:foo, 4),
+      Rule::Presence.new(:username),
+      Rule::ExactLength.new(:username, 3)
+    ]
+  end
+
+  specify { expect(subject.size).to eql(1) }
+  specify { expect(result.errors.size).to eql(2) }
+end

data/spec/unit/knight/validator/add_spec.rb

@@ -3,27 +3,17 @@
 require 'spec_helper'
 
 describe Validator, '#add' do
-  subject { validator.rules(context) }
+  subject { validator.rules }
 
   let(:validator) { described_class.new(rule1) }
   let(:rule1) { Rule::ExactLength.new(:username, 10) }
   let(:rule2) { Rule::Presence.new(:username) }
 
   before do
-    validator.add(rule2, :register)
     validator.add(rule2)
     validator.add(nil)
   end
 
-  context 'default_context' do
-    let(:context) { :default }
-    specify { expect(subject.size).to eql(2) }
-    specify { expect(subject).to eql(Set.new([rule1, rule2])) }
-  end
-
-  context 'register' do
-    let(:context) { :register }
-    specify { expect(subject.size).to eql(1) }
-    specify { expect(subject).to eql(Set.new([rule2])) }
-  end
+  specify { expect(subject.size).to eql(2) }
+  specify { expect(subject).to eql(Set.new([rule1, rule2])) }
 end

data/spec/unit/knight/validator/run_spec.rb

@@ -3,24 +3,12 @@
 require 'spec_helper'
 
 describe Validator, '#run' do
+  subject { validator.run(resource) }
 
   let(:validator) { described_class.new(Rule::Presence.new(:username)) }
   let(:resource) { double('resource') }
 
-  before do
-    validator.add(Rule::Presence.new(:title), :register)
-  end
-
-  context 'default context' do
-    subject { validator.run(resource) }
-    it { should be_instance_of(Result) }
-    its(:resource) { should eql(resource) }
-    specify { expect(subject.rules).to eql(validator.rules) }
-  end
-
-  context 'register context' do
-    subject { validator.run(resource, :register) }
-    it { should be_instance_of(Result) }
-    specify { expect(subject.rules).to eql(validator.rules(:register)) }
-  end
+  it { should be_instance_of(Result) }
+  its(:resource) { should eql(resource) }
+  its(:rules) { should eql(validator.rules) }
 end

metadata

@@ -2,14 +2,14 @@
 name: knight
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Handi Wiguna
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-07 00:00:00.000000000 Z
+date: 2013-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   prerelease: false
@@ -75,17 +75,18 @@ files:
 - lib/knight/version.rb
 - metrics/flog.yml
 - metrics/rubocop.yml
-- spec/integration/contextual_validator_spec.rb
 - spec/integration/knight_spec.rb
 - spec/spec_helper.rb
 - spec/unit/knight/error/class_methods/new_spec.rb
 - spec/unit/knight/error/message_spec.rb
+- spec/unit/knight/instance_methods/class_methods/context_spec.rb
 - spec/unit/knight/instance_methods/class_methods/included_spec.rb
 - spec/unit/knight/instance_methods/class_methods/new_spec.rb
 - spec/unit/knight/instance_methods/class_methods/validator_spec.rb
 - spec/unit/knight/instance_methods/run_spec.rb
 - spec/unit/knight/result/class_methods/new_spec.rb
 - spec/unit/knight/result/errors_spec.rb
+- spec/unit/knight/result/on_spec.rb
 - spec/unit/knight/result/valid_predicate_spec.rb
 - spec/unit/knight/rule/class_methods/new_spec.rb
 - spec/unit/knight/rule/error_spec.rb
@@ -111,8 +112,6 @@ files:
 - spec/unit/knight/rule/to_hash_spec.rb
 - spec/unit/knight/validator/add_spec.rb
 - spec/unit/knight/validator/class_methods/new_spec.rb
-- spec/unit/knight/validator/context_spec.rb
-- spec/unit/knight/validator/rules_spec.rb
 - spec/unit/knight/validator/run_spec.rb
 homepage: ''
 licenses: []
@@ -126,7 +125,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       segments:
       - 0
-      hash: 2891558261604624583
+      hash: -2162189312537362928
       version: '0'
   none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
@@ -135,7 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       segments:
       - 0
-      hash: 2891558261604624583
+      hash: -2162189312537362928
       version: '0'
   none: false
 requirements: []
@@ -145,17 +144,18 @@ signing_key:
 specification_version: 3
 summary: ''
 test_files:
-- spec/integration/contextual_validator_spec.rb
 - spec/integration/knight_spec.rb
 - spec/spec_helper.rb
 - spec/unit/knight/error/class_methods/new_spec.rb
 - spec/unit/knight/error/message_spec.rb
+- spec/unit/knight/instance_methods/class_methods/context_spec.rb
 - spec/unit/knight/instance_methods/class_methods/included_spec.rb
 - spec/unit/knight/instance_methods/class_methods/new_spec.rb
 - spec/unit/knight/instance_methods/class_methods/validator_spec.rb
 - spec/unit/knight/instance_methods/run_spec.rb
 - spec/unit/knight/result/class_methods/new_spec.rb
 - spec/unit/knight/result/errors_spec.rb
+- spec/unit/knight/result/on_spec.rb
 - spec/unit/knight/result/valid_predicate_spec.rb
 - spec/unit/knight/rule/class_methods/new_spec.rb
 - spec/unit/knight/rule/error_spec.rb
@@ -181,6 +181,4 @@ test_files:
 - spec/unit/knight/rule/to_hash_spec.rb
 - spec/unit/knight/validator/add_spec.rb
 - spec/unit/knight/validator/class_methods/new_spec.rb
-- spec/unit/knight/validator/context_spec.rb
-- spec/unit/knight/validator/rules_spec.rb
 - spec/unit/knight/validator/run_spec.rb

data/spec/integration/contextual_validator_spec.rb

@@ -1,41 +0,0 @@
-# encoding: utf-8
-
-require 'spec_helper'
-
-describe Knight do
-  subject { result.valid? }
-
-  let(:validator) do
-    Class.new do
-      include InstanceMethods
-      validator.add(Rule::Presence.new(:username))
-      validator.add(Rule::ExactLength.new(:username, 3..4), :registration)
-
-      validator.context :registration do |context|
-        context << Rule::Presence.new(:title)
-        context << Rule::ExactLength.new(:description, 40)
-      end
-    end
-  end
-
-  let(:user_class) do
-    Class.new do
-      attr_reader :username
-      def initialize(username)
-        @username = username
-      end
-    end
-  end
-
-  context 'valid' do
-    let(:result) { validator.new(resource).run }
-    let(:resource) { user_class.new('john') }
-    it { should be_true }
-  end
-
-  context 'invalid' do
-    let(:result) { validator.new(resource).run(:registration) }
-    let(:resource) { user_class.new('john') }
-    it { should be_false }
-  end
-end

data/spec/unit/knight/validator/context_spec.rb

@@ -1,13 +0,0 @@
-# encoding: utf-8
-
-describe Validator, '#context' do
-
-  before do
-    validator.context :registration do |context|
-      context << Rule::Presence.new(:username)
-    end
-  end
-
-  let(:validator) { described_class.new }
-  specify { expect(validator.rules(:registration).size).to eql(1) }
-end

data/spec/unit/knight/validator/rules_spec.rb

@@ -1,29 +0,0 @@
-# encoding: utf-8
-
-require 'spec_helper'
-
-describe Validator, '#rules' do
-
-  let(:validator) { described_class.new(Rule::Presence.new(:username)) }
-  let(:resource) { double('resource') }
-
-  before do
-    validator.add(Rule::Presence.new(:title), :register)
-  end
-
-  context 'default context' do
-    subject { validator.rules }
-    specify { expect(subject.size).to eql(1) }
-  end
-
-  context 'register context' do
-    subject { validator.rules(:register) }
-    specify { expect(subject.size).to eql(1) }
-  end
-
-  context 'not defined context' do
-    subject { validator.rules(:else) }
-    it { should be_instance_of(Set) }
-    specify { expect(subject.size).to eql(0) }
-  end
-end