tram-policy 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 22af5024252d8e51fc4147c26998ea99f3131cbc
-  data.tar.gz: e5ed607e1ffa5fabb805f611b0f227592c09ead4
+  metadata.gz: 165ccec9b65cb71c73b55cd3f4ec68fe806eaf93
+  data.tar.gz: f0b95281258862f368a2a7f8f9f4c800c6e71231
 SHA512:
-  metadata.gz: e0c48d928ca99dc24d290121d557177c395dd994886b519f51b518b04d99bac2f6324e4257a26171d01e54df9b4d253c42f20d3b643c51ac8c9538d324aabdac
-  data.tar.gz: d93356f5f5e2feb002dad6915f27c90d3094dd2f887b76c4414c08b6b3a0e09d9b2253fdd2a72497dbc5af8a677af827218bc661a9293408bd39a6b3251c9a75
+  metadata.gz: c5b1080576012e698a2664f0d30c61d356993f58895b67c92309567076e87c7d26a6c0eac230d994dcf17ce67b111d73690745ac7910c4ac76dd46e3494bb5a9
+  data.tar.gz: 936c1c08771c15b2f8ab3d48d5e1b3bc7b1e3645fadcec02450c8655ee65333bd3589bae2be28f0690044882f9aeae329ef08576a57d4e7ecf1dfb3f38e5f487

data/CHANGELOG.md

@@ -4,6 +4,15 @@ 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.4] - [2017-12-03]
+
+Some private methods has been refactored
+
+## Internals
+- Renamed `Tram::Policy@__options__` -> `Tram::Policy##__attributes__` (nepalez)
+- Removed `Tram::Policy::Validator##scope` in favor of `Tram::Policy.scope` (nepalez)
+- Refactored spec matcher (nepalez)
+
 ## [0.2.3] - [2017-11-21]
 
 ### Fixed

data/README.md

@@ -172,7 +172,7 @@ end
 
 Class method `.validate` supports several options:
 
-### `stop_on_faiure`
+### `stop_on_failure`
 
 If a selected validation will fail (adds an error to the collection), the following validations won't be executed.
 

data/lib/tram/policy/dsl.rb

@@ -0,0 +1,50 @@
+class Tram::Policy
+  # Class-level DSL for policy objects
+  module DSL
+    # @!method validate(name, opts)
+    # Registers a validator
+    #
+    # @param  [#to_sym, nil] name (nil)
+    # @option opts [Boolean] :stop_on_failure
+    # @return [self]
+    #
+    def validate(name = nil, **opts, &block)
+      local_validators << Validator.new(name, block, opts)
+      self
+    end
+
+    # Policy constructor/validator (alias for [.new])
+    #
+    # @param  [Object] *args
+    # @return [Tram::Policy]
+    #
+    def [](*args)
+      new(*args)
+    end
+
+    # Translation scope for a policy
+    #
+    # @return [Array<String>]
+    #
+    def scope
+      @scope ||= ["tram-policy", *Inflector.underscore(name)]
+    end
+
+    # List of validators defined by a policy per se
+    #
+    # @return [Array<Proc>]
+    #
+    def local_validators
+      @local_validators ||= []
+    end
+
+    # List of all applicable validators from both the policy and its parent
+    #
+    # @return [Array<Proc>]
+    #
+    def validators
+      parent_validators = self == Tram::Policy ? [] : superclass.validators
+      (parent_validators + local_validators).uniq
+    end
+  end
+end

data/lib/tram/policy/rspec.rb

@@ -26,37 +26,20 @@ RSpec::Matchers.define :be_invalid_at do |**tags|
     @tags ||= {}
   end
 
-  def messages
-    @messages ||= {}
-  end
-
   # ****************************************************************************
   # Helpers to provide results for all locales
   # ****************************************************************************
 
-  # Runs block in every available locale
-  def in_available_locales
-    locales = if respond_to?(:available_locales)
-                available_locales
-              else
-                I18n.available_locales
-              end
-
-    locales.flat_map { |locale| I18n.with_locale(locale) { yield } }
-  end
-
   def prepare_localized_results(policy_block, tags, locale)
-    localized_policy = policy_block.call
-    localized_errors = localized_policy&.errors || []
-    self.policy      = localized_policy.inspect
-    errors[locale]   = localized_errors.by_tags(tags)
-    messages[locale] = localized_errors.full_messages
+    I18n.locale    = locale
+    local_policy   = policy_block.call
+    self.policy    = local_policy.inspect
+    errors[locale] = local_policy&.errors&.by_tags(tags)
   end
 
   def prepare_results(policy_block, tags)
     original = I18n.locale
     I18n.available_locales.each do |locale|
-      I18n.locale = locale
       prepare_localized_results(policy_block, tags, locale)
     end
   ensure
@@ -85,9 +68,9 @@ RSpec::Matchers.define :be_invalid_at do |**tags|
 
   def report_errors
     text = "Actual errors:\n"
-    messages.each do |locale, list|
+    errors.each do |locale, local_errors|
       text << "  #{locale}:\n"
-      list.each { |item| text << "  - #{item}\n" }
+      local_errors&.each { |error| text << "  - #{error.full_message}\n" }
     end
     text
   end

data/lib/tram/policy/validator.rb

@@ -1,21 +1,19 @@
 class Tram::Policy
   # @private
   class Validator
-    attr_reader :scope, :name, :block, :stop_on_failure
+    attr_reader :name, :block, :stop_on_failure
 
     def ==(other)
       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)
     end
 
     private
 
-    def initialize(scope, name, block, stop_on_failure: false)
-      @scope = scope
+    def initialize(name, block, stop_on_failure: false)
       @name  = name&.to_sym
       @block = block
       raise "Provide either method name or a block" unless !name ^ !block

data/lib/tram/policy.rb

@@ -10,55 +10,10 @@ module Tram
     require_relative "policy/error"
     require_relative "policy/errors"
     require_relative "policy/validator"
+    require_relative "policy/dsl"
 
     extend Dry::Initializer
-
-    class << self
-      # @!method validate(name, opts)
-      # Registers a validator
-      #
-      # @param  [#to_sym, nil] name (nil)
-      # @option opts [Boolean] :stop_on_failure
-      # @return [self]
-      #
-      def validate(name = nil, **opts, &block)
-        local << Validator.new(scope, name, block, opts)
-        self
-      end
-
-      # Policy constructor/validator (alias for [.new])
-      #
-      # @param  [Object] *args
-      # @return [Tram::Policy]
-      #
-      def [](*args)
-        new(*args)
-      end
-
-      # Translation scope for a policy
-      #
-      # @return [Array<String>]
-      #
-      def scope
-        @scope ||= ["tram-policy", *Inflector.underscore(name)]
-      end
-
-      # List of validators defined by a policy per se
-      #
-      # @return [Array<Proc>]
-      #
-      def local
-        @local ||= []
-      end
-
-      # List of all applicable validators from both the policy and its parent
-      #
-      # @return [Array<Proc>]
-      #
-      def all
-        (((self == Tram::Policy) ? [] : superclass.send(:all)) + local).uniq
-      end
-    end
+    extend DSL
 
     # Translates a message in the scope of current policy
     #
@@ -66,9 +21,9 @@ module Tram
     # @param  [Hash<Symbol, Object>] options
     # @return [String]
     #
-    def t(message, options = {})
+    def t(message, **options)
       return message.to_s unless message.is_a? Symbol
-      I18n.t message, options.merge(scope: @__scope__)
+      I18n.t message, scope: self.class.scope, **options
     end
 
     # Collection of validation errors
@@ -116,7 +71,7 @@ module Tram
     # @return [String]
     #
     def inspect
-      "#<#{self.class.name}[#{@__options__}]>"
+      "#<#{self.class.name}[#{__attributes__}]>"
     end
 
     private
@@ -124,13 +79,15 @@ module Tram
     def initialize(*)
       super
 
-      @__options__ = self.class.dry_initializer.attributes(self)
-
-      self.class.send(:all).each do |validator|
+      self.class.validators.each do |validator|
         size = errors.count
         validator.check(self)
         break if (errors.count > size) && validator.stop_on_failure
       end
     end
+
+    def __attributes__
+      @__attributes__ ||= self.class.dry_initializer.attributes(self)
+    end
   end
 end

data/tram-policy.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name     = "tram-policy"
-  gem.version  = "0.2.3"
+  gem.version  = "0.2.4"
   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.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Viktor Sokolov (gzigzigzeo)
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-21 00:00:00.000000000 Z
+date: 2017-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-initializer
@@ -131,6 +131,7 @@ files:
 - bin/tram-policy
 - lib/tram-policy.rb
 - lib/tram/policy.rb
+- lib/tram/policy/dsl.rb
 - lib/tram/policy/error.rb
 - lib/tram/policy/errors.rb
 - lib/tram/policy/generator.rb