tram-policy 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 23e70750c9bc2efd4c816ae3e9dfb609ffe5d35f
-  data.tar.gz: 4ef00e68121a27bd67d58a883098a7732f4129f2
+  metadata.gz: 0f05aaf4884e7456c1649ac556bdb9510596e69b
+  data.tar.gz: a7179cf1a45d8fa9a637bbf1114e9368ebbcb998
 SHA512:
-  metadata.gz: ed5ab03576fcc938f987c3908b739f026508a6be32f0e8c6b14492054538fe4731a366bc4425875771784160a7e007eadb8fafdb73376ee470ea50760a881251
-  data.tar.gz: 320d14ef10562cd8a78e682a0d9989f9d9a3c15e60509862800ce7fc2fb185dc66d52345c19645e997d3ca34e670b4c91e8e3f6955f0e40e733d32e61b2d68f9
+  metadata.gz: 1f8c7ca5fdf009cad77ccc6b622c36111304c2db5221cb6a109c59b0bd89e443e3521d0e41b0b5c73a0b3c31bffee8a169968bf1aaedf9eb5ae681c047a6284f
+  data.tar.gz: bb4d737514915ca82b2947b014c6542f8342bb32375ff1a8b604ddc3e96c608279a44ad47fcf808097ccac0cdab7859a9aadd0702f3911762128557969e50904

data/.travis.yml

@@ -6,19 +6,16 @@ bundler_args: --without benchmarks tools
 script:
   - bundle exec rake spec
 rvm:
-  - 2.2
   - 2.3.0
   - 2.4.0
-  - jruby-9000
-  - rbx-2
-  - rbx-3
   - ruby-head
+  - jruby-9.1.0.0
+  - rbx-3
 env:
   global:
     - JRUBY_OPTS='--dev -J-Xmx1024M'
 matrix:
   allow_failures:
-    - rvm: rbx-2
     - rvm: rbx-3
     - rvm: ruby-head
     - rvm: jruby-head

data/CHANGELOG.md

@@ -4,6 +4,11 @@ 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.1] - [2017-08-28]
+
+### Changed
+- Updated dependency from [dry-initializer] to v2.0.0 (nepalez)
+
 ## [0.2.0] - [2017-08-19]
 
 ### Added
@@ -88,10 +93,12 @@ The gem is battle-tested for production (in a real commertial project).
 ## [0.0.1] - [2017-04-18]
 This is a first public release (@nepalez, @charlie-wasp, @JewelSam, @sergey-chechaev)
 
+[dry-initializer]: https://github.com/dry-rb/dry-initializer
 [Unreleased]: https://github.com/tram-rb/tram-policy
 [0.0.1]: https://github.com/tram-rb/tram-policy/releases/tag/v0.0.1
 [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.2]: https://github.com/tram-rb/tram-policy/compare/v0.1.1...v0.2.0
+[0.2.0]: https://github.com/tram-rb/tram-policy/compare/v0.1.1...v0.2.0
+[0.2.1]: https://github.com/tram-rb/tram-policy/compare/v0.2.0...v0.2.1

data/README.md

@@ -8,7 +8,6 @@ Policy Object Pattern
 [![Gem Version][gem-badger]][gem]
 [![Build Status][travis-badger]][travis]
 [![Dependency Status][gemnasium-badger]][gemnasium]
-[![Code Climate][codeclimate-badger]][codeclimate]
 [![Inline docs][inch-badger]][inch]
 
 ## Intro
@@ -132,7 +131,7 @@ 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 concerns a scope for the translation. By default it is taken from the full name of current class prepended with `"evil.client.errors"`.
+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 `"tram-policy"`.
 
 > You can redefine the scope by reloading private method `.scope` of the policy.
 

data/lib/tram/policy/error.rb

@@ -6,6 +6,7 @@ class Tram::Policy
   #         from one collection of [Tram::Policy::Errors] to another.
   #
   class Error
+    # @!method self.new(value, opts)
     # Builds an error
     #
     # If another error is send to the constructor, the error returned unchanged

data/lib/tram/policy/errors.rb

@@ -14,6 +14,7 @@ class Tram::Policy
     #
     attr_reader :policy
 
+    # @!method add(message, tags)
     # Adds error message to the collection
     #
     # @param [#to_s] message Either a message, or a symbolic key for translation
@@ -37,9 +38,10 @@ class Tram::Policy
       @set.each { |error| yield(error) }
     end
 
+    # @!method by_tags(filter)
     # Selects errors filtered by tags
     #
-    # @param  [Hash<Symbol, Object>] filter
+    # @param  [Hash<Symbol, Object>] filter List of options to filter by
     # @return [Hash<Symbol, Object>]
     #
     def by_tags(**filter)
@@ -47,6 +49,7 @@ class Tram::Policy
       reject { |error| (filter - error.to_h.to_a).any? }
     end
 
+    # @!method empty?
     # Checks whether a collection is empty
     #
     # @return [Boolean]
@@ -71,11 +74,14 @@ class Tram::Policy
       @set.map(&:full_message).sort
     end
 
+    # @!method merge(other, options)
     # Merges other collection to the current one and returns new collection
     # with the current scope
     #
-    # param [Tram::Policy::Errors] other Collection to be merged
-    # yieldparam [Hash<Symbol, Object>]
+    # @param [Tram::Policy::Errors] other   Collection to be merged
+    # @param [Hash<Symbol, Object>] options Options to be added to merged errors
+    # @yieldparam [Hash<Symbol, Object>] hash of error options
+    # @return [self]
     #
     # @example Add some tag to merged errors
     #   policy.merge(other) { |err| err[:source] = "other" }

data/lib/tram/policy/generator.rb

@@ -5,6 +5,7 @@ module Tram
   class Policy
     require_relative "inflector"
 
+    # @private
     class Generator < Thor::Group
       include Thor::Actions
 

data/lib/tram/policy/inflector.rb

@@ -1,9 +1,12 @@
 class Tram::Policy
   if Object.const_defined? "ActiveSupport::Inflector"
+    # @private
     Inflector = ActiveSupport::Inflector
   elsif Object.const_defined? "Inflecto"
+    # @private
     Inflector = ::Inflecto
   else
+    # @private
     module Inflector
       def self.underscore(name)
         name&.dup&.tap do |n|

data/lib/tram/policy/validator.rb

@@ -1,5 +1,5 @@
 class Tram::Policy
-  # Describes a validator
+  # @private
   class Validator
     attr_reader :scope, :name, :block, :stop_on_failure
 

data/lib/tram/policy.rb

@@ -1,6 +1,7 @@
 require "dry-initializer"
 require "i18n"
 
+# Top-level scope for Tram collection of gems
 module Tram
   # Base class for policy objects with composable validation errors
   class Policy
@@ -13,9 +14,10 @@ module Tram
     extend Dry::Initializer
 
     class << self
+      # @!method validate(name, opts)
       # Registers a validator
       #
-      # @param  [#to_sym, Array<#to_sym>] names
+      # @param  [#to_sym, nil] name (nil)
       # @option opts [Boolean] :stop_on_failure
       # @return [self]
       #
@@ -44,7 +46,7 @@ module Tram
       end
 
       def all
-        ((self == Tram::Policy) ? [] : superclass.send(:all)) + local
+        (((self == Tram::Policy) ? [] : superclass.send(:all)) + local).uniq
       end
     end
 
@@ -54,7 +56,7 @@ 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__)
     end
@@ -111,6 +113,9 @@ module Tram
 
     def initialize(*)
       super
+
+      @__options__ = self.class.dry_initializer.attributes(self)
+
       self.class.send(:all).each do |validator|
         size = errors.count
         validator.check(self)

data/spec/fixtures/admin_policy.rb

@@ -1,5 +1,3 @@
-require_relative "user_policy"
-
 class Test::AdminPolicy < Test::UserPolicy
   validate :login
   validate :name

data/spec/fixtures/user_policy.rb

@@ -1,7 +1,7 @@
 class Test::UserPolicy < Tram::Policy
   param :user
 
-  validate :name
+  validate "name"
   validate "email"
   validate "name"
 

data/spec/spec_helper.rb

@@ -1,8 +1,3 @@
-begin
-  require "pry"
-rescue
-  nil
-end
 require "bundler/setup"
 require "tram/policy"
 require "tram/policy/rspec"

data/tram-policy.gemspec

@@ -1,8 +1,8 @@
 Gem::Specification.new do |gem|
   gem.name     = "tram-policy"
-  gem.version  = "0.2.0"
+  gem.version  = "0.2.1"
   gem.author   = ["Viktor Sokolov (gzigzigzeo)", "Andrew Kozin (nepalez)"]
-  gem.email    = ["andrew.kozin@gmail.com"]
+  gem.email    = "andrew.kozin@gmail.com"
   gem.homepage = "https://github.com/tram/tram-policy"
   gem.summary  = "Policy Object Pattern"
   gem.license  = "MIT"
@@ -12,9 +12,9 @@ Gem::Specification.new do |gem|
   gem.extra_rdoc_files = Dir["README.md", "LICENSE", "CHANGELOG.md"]
   gem.executables      = %w[tram-policy]
 
-  gem.required_ruby_version = ">= 2.2"
+  gem.required_ruby_version = ">= 2.3"
 
-  gem.add_runtime_dependency "dry-initializer", "~> 1.4"
+  gem.add_runtime_dependency "dry-initializer", "~> 2.0"
   gem.add_runtime_dependency "i18n", "~> 0.8"
 
   gem.add_development_dependency "rake", "> 10"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tram-policy
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Viktor Sokolov (gzigzigzeo)
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-19 00:00:00.000000000 Z
+date: 2017-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-initializer
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
@@ -110,8 +110,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.19'
 description: 
-email:
-- andrew.kozin@gmail.com
+email: andrew.kozin@gmail.com
 executables:
 - tram-policy
 extensions: []
@@ -166,7 +165,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.2'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="