tram-policy 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e014f25ceab7b1bdbea2a67a4ba98245986689c
-  data.tar.gz: 0ed033ca9a5e8a695e78dc8b89e9d927a5373bcb
+  metadata.gz: 23e70750c9bc2efd4c816ae3e9dfb609ffe5d35f
+  data.tar.gz: 4ef00e68121a27bd67d58a883098a7732f4129f2
 SHA512:
-  metadata.gz: 361c6c5af4c893f09d3595eb22ecea7098134c1ddc5ae2854ba9177a35f5a89ea3e6d27142e92f0e66d89b0aa8d17a7373671dc2fbcb5d51e22407a61b33d587
-  data.tar.gz: a899980e7b03a31998d1e183026d9ad675aa865445f6c28392c3ee13bdd23de9e09b2e90f3cb0dd77f572931605e8fe436f372b71b086a4a7464ac4b6c91e6da
+  metadata.gz: ed5ab03576fcc938f987c3908b739f026508a6be32f0e8c6b14492054538fe4731a366bc4425875771784160a7e007eadb8fafdb73376ee470ea50760a881251
+  data.tar.gz: 320d14ef10562cd8a78e682a0d9989f9d9a3c15e60509862800ce7fc2fb185dc66d52345c19645e997d3ca34e670b4c91e8e3f6955f0e40e733d32e61b2d68f9

data/CHANGELOG.md

@@ -4,6 +4,37 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [0.2.0] - [2017-08-19]
+
+### Added
+- Support for unnamed block validators (@nepalez)
+
+  In addition to instance methods:
+
+    validate :some_method
+
+  You can use a block for validation:
+
+    validate { errors.add :blank_name if name.blank? }
+
+- Support for custom scopes (@nepalez)
+
+  Just reload private class method `scope`
+
+- Support for inheritance (@nepalez)
+
+  You can inherit the policy class. A subclass will apply all validators of
+  superclass before those of its own. Every error message will be translated
+  in the scope of policy where it was defined.
+
+### Deleted
+- Reloading of validators
+
+  To follow Liskov substitube principle we run all validators declared anywhere
+  in the policy or its superclasses. Any sub-policy should provide the same
+  level of confidence about validity of object(s) under check as any
+  of its superclasses.
+
 ## [0.1.1] - [2017-08-04]
 
 ### Added
@@ -62,4 +93,5 @@ This is a first public release (@nepalez, @charlie-wasp, @JewelSam, @sergey-chec
 [0.0.2]: https://github.com/tram-rb/tram-policy/compare/v0.0.1...v0.0.2
 [0.0.3]: https://github.com/tram-rb/tram-policy/compare/v0.0.2...v0.0.3
 [0.1.0]: https://github.com/tram-rb/tram-policy/compare/v0.0.3...v0.1.0
-[0.1.1]: https://github.com/tram-rb/tram-policy/compare/v0.1.0...v0.1.1
+[0.1.1]: https://github.com/tram-rb/tram-policy/compare/v0.1.0...v0.1.1
+[0.1.2]: https://github.com/tram-rb/tram-policy/compare/v0.1.1...v0.2.0

data/README.md

@@ -43,7 +43,7 @@ class Article::ReadinessPolicy < Tram::Policy
   # define what methods and in what order we should use to validate an article
   validate :title_presence
   validate :subtitle_presence
-  validate :text_presence
+  validate { errors.add :empty, field: "text", level: "error" if text.empty? }
 
   private
 
@@ -59,13 +59,6 @@ class Article::ReadinessPolicy < Tram::Policy
     # Notice that we can set another level
     errors.add "Subtitle is empty", field: "subtitle", level: "warning"
   end
-
-  def text_presence
-    return unless text.empty?
-    # Adds an error with a translated message. All fields are available
-    # both as error tags, and I18n translation options
-    errors.add :empty_text, field: "text", level: "error"
-  end
 end
 ```
 
@@ -126,12 +119,11 @@ class Article::PublicationPolicy < Tram::Policy
 
   def article_readiness
     # Collects errors tagged by level: "error" from "nested" policy
-    others = Article::ReadinessPolicy[article].errors.by_tags(level: "error")
+    readiness_errors = Article::ReadinessPolicy[article].errors.by_tags(level: "error")
 
     # Merges collected errors to the current ones.
-    # New errors are tagged by source: "readiness".
-    # Notice the block takes _hashified_ errors.
-    errors.merge(others) { |hash| hash[:source] = "readiness" }
+    # New errors are also tagged by source: "readiness".
+    errors.merge(readiness_errors, source: "readiness")
   end
 
   def article_selection
@@ -140,12 +132,16 @@ class Article::PublicationPolicy < Tram::Policy
 end
 ```
 
-As mentioned above, sending a symbolic key to the `errors#add` means the key should be translated by [I18n][i18n]. The only magic under the hood is that a scope for the translation is taken from the full name of current class. All tags are available as options:
+As mentioned above, sending a symbolic key to the `errors#add` means the key should be translated by [I18n][i18n]. The only magic under the hood concerns a scope for the translation. By default it is taken from the full name of current class prepended with `"evil.client.errors"`.
+
+> You can redefine the scope by reloading private method `.scope` of the policy.
+
+All tags are available as options:
 
 ```ruby
 class Article::PublicationPolicy < Tram::Policy
   # ...
-  errors.add :empty_text, field: "text", level: "error"
+  errors.add :empty, field: "text", level: "error"
   # ...
 end
 ```
@@ -154,8 +150,9 @@ end
 # /config/locales/en.yml
 ---
 en:
-  article/publication_policy:
-    empty_text: "Validation %{level}: %{field} is empty"
+  tram-policy:
+    article/publication_policy:
+      empty: "Validation %{level}: %{field} is empty"
 ```
 
 This will provide error message "Validation error: text is empty".
@@ -194,14 +191,6 @@ class Article::ReadinessPolicy < Tram::Policy
 end
 ```
 
-### `if`
-
-[WIP] Not implemented (coming soon in v0.1.0)
-
-### `unless`
-
-[WIP] Not implemented (coming soon in v0.1.0)
-
 ## RSpec matchers
 
 RSpec matchers defined in a file `tram-policy/matcher` (not loaded in runtime).
@@ -297,9 +286,10 @@ end
 # config/tram-policies.en.yml
 ---
 en:
-  user/readiness_policy:
-    blank_name: translation missing
-    blank_email: translation missing
+  tram-policy:
+    user/readiness_policy:
+      blank_name: translation missing
+      blank_email: translation missing
 ```
 
 ```ruby

data/lib/tram/policy.rb

@@ -16,10 +16,11 @@ module Tram
       # Registers a validator
       #
       # @param  [#to_sym, Array<#to_sym>] names
+      # @option opts [Boolean] :stop_on_failure
       # @return [self]
       #
-      def validate(name, **opts)
-        validators[name.to_sym] = opts
+      def validate(name = nil, **opts, &block)
+        local << Validator.new(scope, name, block, opts)
         self
       end
 
@@ -34,13 +35,16 @@ module Tram
 
       private
 
-      def validators
-        @validators ||= {}
+      def scope
+        @scope ||= ["tram-policy", *Inflector.underscore(name)]
       end
 
-      def inherited(klass)
-        super
-        validators.each { |name, opts| klass.validate name, opts }
+      def local
+        @local ||= []
+      end
+
+      def all
+        ((self == Tram::Policy) ? [] : superclass.send(:all)) + local
       end
     end
 
@@ -107,11 +111,10 @@ module Tram
 
     def initialize(*)
       super
-      @__scope__ = ["tram-policy", Inflector.underscore(self.class.name)]
-      self.class.send(:validators).each do |name, opts|
+      self.class.send(:all).each do |validator|
         size = errors.count
-        send(name)
-        break if (errors.count > size) && opts[:stop_on_failure]
+        validator.check(self)
+        break if (errors.count > size) && validator.stop_on_failure
       end
     end
   end

data/lib/tram/policy/inflector.rb

@@ -6,7 +6,7 @@ class Tram::Policy
   else
     module Inflector
       def self.underscore(name)
-        name.dup.tap do |n|
+        name&.dup&.tap do |n|
           n.gsub!(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
           n.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
           n.gsub!("::", "/")
@@ -16,7 +16,7 @@ class Tram::Policy
       end
 
       def self.camelize(name)
-        name.dup.tap do |n|
+        name&.dup&.tap do |n|
           n.gsub!(/(?:\A|_+)(.)/)    { $1.upcase }
           n.gsub!(%r{(?:[/|-]+)(.)}) { "::#{$1.upcase}" }
         end

data/lib/tram/policy/validator.rb

@@ -1,16 +1,26 @@
 class Tram::Policy
   # Describes a validator
   class Validator
-    attr_reader :name, :stop_on_failure
+    attr_reader :scope, :name, :block, :stop_on_failure
 
     def ==(other)
-      other.is_a?(self.class) && other.name == name
+      other.is_a?(self.class) && name && other.name == name
+    end
+
+    def check(object)
+      object.__send__ :instance_variable_set, :@__scope__, scope
+      name ? object.__send__(name) : object.instance_exec(&block)
+    rescue
+      object.__send__ :instance_variable_set, :@__scope__, nil
     end
 
     private
 
-    def initialize(name, stop_on_failure: false)
-      @name = name.to_sym
+    def initialize(scope, name, block, stop_on_failure: false)
+      @scope = scope
+      @name  = name&.to_sym
+      @block = block
+      raise "Provide either method name or a block" unless !name ^ !block
       @stop_on_failure = stop_on_failure
     end
   end

data/spec/fixtures/customer_policy.rb

@@ -1,12 +1,5 @@
 class Test::CustomerPolicy < Tram::Policy
   option :name
 
-  validate :name_presence
-
-  private
-
-  def name_presence
-    return if name
-    errors.add :name_presence, field: "name"
-  end
+  validate { errors.add :name_presence, field: "name" unless name }
 end

data/spec/tram/policy_spec.rb

@@ -19,16 +19,19 @@ RSpec.describe Tram::Policy do
 
   describe ".validate" do
     it "defines validators to be called by initializer in proper order" do
-      expect(user).to receive(:name).once.ordered
-      expect(user).to receive(:email).once.ordered
+      expect(user).to receive(:name).ordered
+      expect(user).to receive(:email).ordered
+      expect(user).to receive(:name).ordered
 
       Test::UserPolicy.new(user)
     end
 
     it "preserves order of parent class validators" do
-      expect(user).to receive(:name).once.ordered
-      expect(user).to receive(:email).once.ordered
-      expect(user).to receive(:login).once.ordered
+      expect(user).to receive(:name).ordered
+      expect(user).to receive(:email).ordered
+      expect(user).to receive(:name).ordered
+      expect(user).to receive(:login).ordered
+      expect(user).to receive(:name).ordered
 
       Test::AdminPolicy.new(user)
     end
@@ -37,19 +40,17 @@ RSpec.describe Tram::Policy do
       before { Test::UserPolicy.validate :name, stop_on_failure: true }
 
       it "stops validation after failure" do
-        expect(user).to receive(:name).once
-        expect(user).not_to receive(:email)
+        expect(user).not_to receive(:login)
 
-        Test::UserPolicy.new(user)
+        Test::AdminPolicy.new(user)
       end
 
       it "continues validation after success" do
         user = double :user, name: "Andy", email: nil, login: nil
 
-        expect(user).to receive(:name).once.ordered
-        expect(user).to receive(:email).once.ordered
+        expect(user).to receive(:login)
 
-        Test::UserPolicy.new(user)
+        Test::AdminPolicy.new(user)
       end
     end
   end

data/tram-policy.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name     = "tram-policy"
-  gem.version  = "0.1.1"
+  gem.version  = "0.2.0"
   gem.author   = ["Viktor Sokolov (gzigzigzeo)", "Andrew Kozin (nepalez)"]
   gem.email    = ["andrew.kozin@gmail.com"]
   gem.homepage = "https://github.com/tram/tram-policy"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tram-policy
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Viktor Sokolov (gzigzigzeo)
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-04 00:00:00.000000000 Z
+date: 2017-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-initializer