tram-policy 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d9eceeea7e032619394e2a9c57b3a780031e6716e99115ab4d7f70aaa215730
-  data.tar.gz: 39fa500a2789eb528aac666711652ee0c7b9ed3a3a7d9b197333b133e94b17a3
+  metadata.gz: d2d94489718b8070f78e8a4792e67902336e87d03da02d216fe49069767684fb
+  data.tar.gz: 4c9e417c8a39f18e0faf75c2b7bae22f7d3aa0e53c2c9486e068910f59837f2f
 SHA512:
-  metadata.gz: 0654b385b2dc583a467824fc473e9873408297795fc172ed70313d25ef9a352d34802640e10a8f68e861122dedbc6146678d225c4fff2d60510901a62f30d2e9
-  data.tar.gz: c45529180fc6e8d99ab3b071ac3fc886b41bc84bf0b57769ad83ccbe046b0b03ea03d026fc974e6acd842c6e2807219707ea83cfbd258f1b27ea078465d52ba1
+  metadata.gz: 71862e68041ee87d414f60bcf79c5f84f4996db5bc1ddc143628598dc29f0ca4a9816c7669b63a1c10e9e737e371800ff9ad1b214ed814753ce4c393c3877165
+  data.tar.gz: 6278ffc6803fdb5ab6f96bc4c4d2a38ad7758e2eb723fca763234aa647e2ba6b1854220059d2ce0cc182215042b2926080ad39f39eb815614610850d12e2d72c

data/.gitignore

@@ -9,3 +9,4 @@
 /tmp/
 /*.gem
 .rspec_status
+.idea/

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/).
 
+## [2.0.0] - [2019-07-04]
+
+### Changed
+
+- [BREAKING] separate `Tram::Policy::Errors` from a policy (nepalez, sclinede)
+  
+  Instead of the policy, the collection refers to the explicit scope used for error messages' translation.
+  This change breaks the signature of `Tram::Policy::Error` and `Tram::Policy::Errors`.
+
 ## [1.0.1] - [2019-05-06]
 
 ### Added
@@ -202,3 +211,4 @@ This is a first public release (@nepalez, @charlie-wasp, @JewelSam, @sergey-chec
 [0.4.0]: https://github.com/tram-rb/tram-policy/compare/v0.3.1...v0.4.0
 [1.0.0]: https://github.com/tram-rb/tram-policy/compare/v0.4.0...v1.0.0
 [1.0.1]: https://github.com/tram-rb/tram-policy/compare/v1.0.0...v1.0.1
+[2.0.0]: https://github.com/tram-rb/tram-policy/compare/v1.0.1...v2.0.0

data/lib/tram/policy.rb

@@ -40,7 +40,7 @@ module Tram
     # @return [Tram::Policy::Errors]
     #
     def errors
-      @errors ||= Errors.new(self)
+      @errors ||= Errors.new(scope: scope)
     end
 
     # The array of error items for lazy translation

data/lib/tram/policy/error.rb

@@ -12,10 +12,10 @@ class Tram::Policy
     # If another error is send to the constructor, the error returned unchanged
     #
     # @param  [Tram::Policy::Error, #to_s] value
-    # @param  [Hash<Symbol, Object>] opts
+    # @param  [Hash<Symbol, Object>] tags
     # @return [Tram::Policy::Error]
     #
-    def self.new(value, **opts)
+    def self.new(value, **tags)
       value.instance_of?(self) ? value : super
     end
 
@@ -27,7 +27,7 @@ class Tram::Policy
     # @return [Hash<Symbol, Object>] error tags
     attr_reader :tags
 
-    # The list of arguments for [I18n.t]
+    # List of arguments for [I18n.t]
     #
     # @return [Array]
     #
@@ -36,7 +36,7 @@ class Tram::Policy
     end
     alias to_a item
 
-    # The text of error message translated to the current locale
+    # Text of error message translated to the current locale
     #
     # @return [String]
     #
@@ -60,8 +60,8 @@ class Tram::Policy
     # @param [Proc] block
     # @return [Object]
     #
-    def fetch(tag, default = Dry::Initializer::UNDEFINED, &block)
-      if default == Dry::Initializer::UNDEFINED
+    def fetch(tag, default = UNDEFINED, &block)
+      if default == UNDEFINED
         tags.fetch(tag.to_sym, &block)
       else
         tags.fetch(tag.to_sym, default, &block)
@@ -92,9 +92,13 @@ class Tram::Policy
 
     private
 
+    UNDEFINED = Dry::Initializer::UNDEFINED
+    DEFAULT_SCOPE = %w[tram-policy errors].freeze
+
     def initialize(key, **tags)
       @key  = key
       @tags = tags
+      @tags[:scope] = @tags.fetch(:scope) { DEFAULT_SCOPE } if key.is_a?(Symbol)
     end
 
     def respond_to_missing?(*)

data/lib/tram/policy/errors.rb

@@ -1,4 +1,5 @@
 class Tram::Policy
+  #
   # Enumerable collection of unique unordered validation errors
   #
   # Notice: A collection is context-dependent;
@@ -8,11 +9,9 @@ class Tram::Policy
   class Errors
     include Enumerable
 
-    # @!attribute [r] policy
-    #
-    # @return [Tram::Policy] the poplicy errors provided by
-    #
-    attr_reader :policy
+    # @!attribute [r] scope
+    # @return [Array<String>] the scope for error messages' translation
+    attr_reader :scope
 
     # @!method add(message, tags)
     # Adds error message to the collection
@@ -22,9 +21,12 @@ class Tram::Policy
     # @return [self] the collection
     #
     def add(message, **tags)
-      tags = tags.merge(scope: policy.scope) unless tags.key?(:scope)
       raise ArgumentError.new("Error message should be defined") unless message
-      tap { @set << Tram::Policy::Error.new(message, **tags) }
+
+      tap do
+        tags = tags.merge(scope: scope) if message.is_a?(Symbol)
+        @set << Tram::Policy::Error.new(message, **tags)
+      end
     end
 
     # Iterates by collected errors
@@ -47,7 +49,7 @@ class Tram::Policy
       list = each_with_object(Set.new) do |error, obj|
         obj << error if error.contain?(key, tags)
       end
-      self.class.new(policy, list)
+      self.class.new(scope: scope, errors: list)
     end
 
     # @!method empty?
@@ -101,9 +103,9 @@ class Tram::Policy
 
     private
 
-    def initialize(policy, errors = [])
-      @policy = policy
-      @set    = Set.new(errors)
+    def initialize(**options)
+      @scope = options[:scope] || Error::DEFAULT_SCOPE
+      @set   = Set.new options[:errors].to_a
     end
   end
 end

data/spec/tram/policy/error_spec.rb

@@ -1,11 +1,12 @@
 RSpec.describe Tram::Policy::Error do
   subject(:error) { described_class.new :bad, options }
 
-  let(:options) { { level: "warning", scope: %w[tram-policy] } }
+  let(:scope)   { %w[tram-policy] }
+  let(:options) { { level: "warning", scope: scope } }
 
   describe "#item" do
     subject { error.item }
-    it { is_expected.to eq [:bad, level: "warning", scope: %w[tram-policy]] }
+    it { is_expected.to eq [:bad, level: "warning", scope: scope] }
   end
 
   describe "#message" do

data/spec/tram/policy/errors_spec.rb

@@ -1,6 +1,6 @@
 RSpec.describe Tram::Policy::Errors do
-  let(:policy) { double :policy, scope: %w[tram-policy] }
-  let(:errors) { described_class.new(policy) }
+  let(:scope)  { %w[tram-policy] }
+  let(:errors) { described_class.new(scope: scope) }
 
   describe ".new" do
     subject { errors }
@@ -8,7 +8,7 @@ RSpec.describe Tram::Policy::Errors do
     it { is_expected.to be_kind_of Enumerable }
     it { is_expected.to respond_to :empty? }
     it { is_expected.to be_empty }
-    its(:policy) { is_expected.to eql policy }
+    its(:scope) { is_expected.to eql scope }
   end
 
   describe "#add" do
@@ -21,7 +21,7 @@ RSpec.describe Tram::Policy::Errors do
 
       expect(error).to be_kind_of Tram::Policy::Error
       expect(error)
-        .to eq [:omg, level: "info", field: "name", scope: %w[tram-policy]]
+        .to eq [:omg, level: "info", field: "name", scope: scope]
     end
   end
 
@@ -45,11 +45,11 @@ RSpec.describe Tram::Policy::Errors do
   end
 
   describe "#merge" do
-    let(:other) { described_class.new(policy) }
+    let(:other) { described_class.new(scope: scope) }
 
     before do
-      errors.add "D'OH!", level: "disaster"
-      other.add  "OUCH!", level: "error"
+      errors.add :"D'OH!", level: "disaster"
+      other.add  "OUCH!",  level: "error"
     end
 
     context "without a block:" do
@@ -58,8 +58,8 @@ RSpec.describe Tram::Policy::Errors do
       it "merges other collection as is" do
         expect(subject).to be_a Tram::Policy::Errors
         expect(subject.items).to match_array [
-          ["D'OH!", level: "disaster", scope: %w[tram-policy]],
-          ["OUCH!", level: "error",    scope: %w[tram-policy]]
+          [:"D'OH!", level: "disaster", scope: scope],
+          ["OUCH!", level: "error"]
         ]
       end
     end
@@ -70,8 +70,8 @@ RSpec.describe Tram::Policy::Errors do
       it "merges filtered collection as is" do
         expect(subject).to be_a Tram::Policy::Errors
         expect(subject.items).to match_array [
-          ["D'OH!", level: "disaster", scope: %w[tram-policy]],
-          ["OUCH!", level: "error",    scope: %w[tram-policy], source: "Homer"]
+          [:"D'OH!", level: "disaster", scope: scope],
+          ["OUCH!", level: "error", source: "Homer"]
         ]
       end
     end
@@ -82,8 +82,8 @@ RSpec.describe Tram::Policy::Errors do
       it "merges other collection with given options" do
         expect(subject).to be_a Tram::Policy::Errors
         expect(subject.items).to match_array [
-          ["D'OH!", level: "disaster", scope: %w[tram-policy]],
-          ["OUCH!", level: "error",    scope: %w[tram-policy], source: "Homer"]
+          [:"D'OH!", level: "disaster", scope: scope],
+          ["OUCH!", level: "error", source: "Homer"]
         ]
       end
     end
@@ -94,8 +94,8 @@ RSpec.describe Tram::Policy::Errors do
       it "merges filtered collection with given options" do
         expect(subject).to be_a Tram::Policy::Errors
         expect(subject.items).to match_array [
-          ["D'OH!", level: "disaster", scope: %w[tram-policy]],
-          ["OUCH!", level: "error",    scope: %w[tram-policy], id: 5, age: 4]
+          [:"D'OH!", level: "disaster", scope: scope],
+          ["OUCH!", level: "error", id: 5, age: 4]
         ]
       end
     end
@@ -125,8 +125,8 @@ RSpec.describe Tram::Policy::Errors do
 
       it "returns selected errors only" do
         expect(subject).to match_array [
-          [:foo, field: "name",  level: "error", scope: %w[tram-policy]],
-          [:foo, field: "email", level: "error", scope: %w[tram-policy]]
+          [:foo, field: "name",  level: "error", scope: scope],
+          [:foo, field: "email", level: "error", scope: scope]
         ]
       end
     end

data/spec/tram/policy_spec.rb

@@ -63,8 +63,8 @@ RSpec.describe Tram::Policy do
   describe "#errors" do
     subject { policy.errors }
 
-    its(:class)  { is_expected.to eq Tram::Policy::Errors }
-    its(:policy) { is_expected.to eql policy }
+    its(:class) { is_expected.to eq Tram::Policy::Errors }
+    its(:scope) { is_expected.to eql policy.scope }
   end
 
   describe "#valid?" do

data/tram-policy.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name     = "tram-policy"
-  gem.version  = "1.0.1"
+  gem.version  = "2.0.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: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Viktor Sokolov (gzigzigzeo)
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-06 00:00:00.000000000 Z
+date: 2019-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-initializer