tram-policy 1.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 54f65bae74cb48be0cc7d481cb3abd8528f43749
-  data.tar.gz: 4a100e49ec40986bc4f8781304169e6ecd2d5baf
+SHA256:
+  metadata.gz: 3bf029c2eff265f0a29f13d7f1c44b8f8a1a9d5a336a61a9804c9740142eba17
+  data.tar.gz: ccee1509e523eeb4e55208b357e561f03100844d32ec3a14d879ad6991b8f538
 SHA512:
-  metadata.gz: 107d99cdd79742b7ae85b5b1f8783f5eb6114c864cbfb7732251c2a4542261effec81ec171d61dbc0da6787ca576efc581dae43f76f75ef4a16d2d7934edea9f
-  data.tar.gz: 3dc2b45735369a9097b525b1681ea8dee24ed84675bc8cfde67b1f87394647f345abedd45db4c12d3725d3cd56df8193e70b8c92e5ec62e9e1c14970097c6ee8
+  metadata.gz: d193c0d20344f0ab8c2b015e7a5eee330ef4fec64182c298ad750b06081894d6d8f51d89c064bc8aa7561e7f8d68ccd3f03f55a4378677781ba0bdf4e8376cd0
+  data.tar.gz: 0b0214db5420f51dadb31028d1a75b2cb54b762ccf013d6948a6eb47fb2b6ca4825dfe747921b80aa732de0b27e89faf74a353a005a5c0237c0267df8681a421

data/.gitignore

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

data/.travis.yml

@@ -8,18 +8,15 @@ script:
   - bundle exec rubocop
 rvm:
   - 2.3.0
-  - 2.4.0
+  - 2.6.2
   - ruby-head
-  - jruby-9.1.0.0
-  - rbx-3
+  - jruby-9.2.7.0
+  - truffleruby
 env:
   global:
     - JRUBY_OPTS='--dev -J-Xmx1024M'
 matrix:
   allow_failures:
-    - rvm: rbx-3
     - rvm: ruby-head
     - rvm: jruby-head
-  include:
-    - rvm: jruby-head
-      before_install: gem install bundler --no-ri --no-rdoc
+    - rvm: truffleruby

data/CHANGELOG.md

@@ -4,6 +4,35 @@ 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.1.0] - [2021-11-30]
+
+### Fixed
+- Difference between last positional and keyword arguments in Ruby 3.0+ (mrexox)
+
+## [2.0.1] - [2019-11-14]
+
+### Fixed
+- Allow translation :scope to be customized in the #merge operation (sclinede)
+  Before the fix, the customized value was always replaced by the default value.
+
+## [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
+- Support of `dry-initializer` v3.0+ (nepalez)
+
+### Fixed
+- Fix be_invalid RSpec matcher if non-policy model is passed (Envek)
+- Disable translation check for non-strings in rspec matcher (Envek)
+
 ## [1.0.0] - [2018-02-17]
 
 ### Changed
@@ -191,3 +220,8 @@ This is a first public release (@nepalez, @charlie-wasp, @JewelSam, @sergey-chec
 [0.3.0]: https://github.com/tram-rb/tram-policy/compare/v0.2.5...v0.3.0
 [0.3.1]: https://github.com/tram-rb/tram-policy/compare/v0.3.0...v0.3.1
 [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
+[2.0.1]: https://github.com/tram-rb/tram-policy/compare/v2.0.0...v2.0.1
+[2.1.0]: https://github.com/tram-rb/tram-policy/compare/v2.0.1...v2.1.0

data/README.md

@@ -7,7 +7,6 @@ Policy Object Pattern
 
 [![Gem Version][gem-badger]][gem]
 [![Build Status][travis-badger]][travis]
-[![Dependency Status][gemnasium-badger]][gemnasium]
 [![Inline docs][inch-badger]][inch]
 
 ## Intro
@@ -128,7 +127,7 @@ You can change the root scope if you will (this could be useful in libraries):
 
 ```ruby
 class MyGemPolicy < Tram::Policy
-  scope "mygem", "policies" # inherited by subclasses
+  root_scope "mygem", "policies" # inherited by subclasses
 end
 
 class Article::ReadinessPolicy < MyGemPolicy
@@ -338,8 +337,6 @@ The gem is available as open source under the terms of the [MIT License](http://
 [codeclimate]: https://codeclimate.com/github/tram-rb/tram-policy
 [gem-badger]: https://img.shields.io/gem/v/tram-policy.svg?style=flat
 [gem]: https://rubygems.org/gems/tram-policy
-[gemnasium-badger]: https://img.shields.io/gemnasium/tram-rb/tram-policy.svg?style=flat
-[gemnasium]: https://gemnasium.com/tram-rb/tram-policy
 [inch-badger]: http://inch-ci.org/github/tram-rb/tram-policy.svg
 [inch]: https://inch-ci.org/github/tram-rb/tram-policy
 [travis-badger]: https://img.shields.io/travis/tram-rb/tram-policy/master.svg?style=flat

data/lib/tram/policy/dsl.rb

@@ -18,8 +18,8 @@ class Tram::Policy
     # @param  [Object] *args
     # @return [Tram::Policy]
     #
-    def [](*args)
-      new(*args)
+    def [](*args, **kwargs)
+      new(*args, **kwargs)
     end
 
     # Sets the root scope of the policy and its subclasses

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,17 +92,21 @@ 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?(*)
       true
     end
 
-    def method_missing(name, *args, &block)
-      args.any? || block ? super : tags[name]
+    def method_missing(name, *args, **kwargs, &block)
+      args.any? || kwargs.any? || block ? super : tags[name]
     end
   end
 end

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 = { scope: scope }.merge(tags) 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/lib/tram/policy/rspec.rb

@@ -17,8 +17,11 @@ RSpec::Matchers.define :be_invalid_at do |**tags|
 
   def missed_translations
     @missed_translations ||= \
-      errors.flat_map { |rec| rec.values_at(*locales) }
-            .select { |message| message.start_with? "translation missing" }
+      errors
+        .flat_map { |rec| rec.values_at(*locales) }
+        .select do |message|
+          message.is_a?(String) && message.start_with?("translation missing")
+        end
   end
 
   def report_errors
@@ -57,10 +60,12 @@ end
 
 RSpec::Matchers.define :be_invalid do
   match do |policy|
+    return expect(policy.valid?).to(be_falsey) unless policy.is_a?(Tram::Policy)
     expect(policy).to be_invalid_at
   end
 
   match_when_negated do |policy|
+    return expect(policy.valid?).to(be_truthy) unless policy.is_a?(Tram::Policy)
     expect(policy).not_to be_invalid_at
   end
 end

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
@@ -101,7 +101,7 @@ module Tram
 
     private
 
-    def initialize(*)
+    def initialize(*, **)
       super
 
       self.class.validators.each do |validator|

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/rspec_spec.rb

@@ -46,4 +46,19 @@ RSpec.describe "RSpec support:" do
         .to raise_error RSpec::Expectations::ExpectationNotMetError
     end
   end
+
+  describe "to be_invalid" do
+    subject { double("model") }
+
+    it "fails with valid non-policy object" do
+      allow(subject).to receive(:valid?).and_return(true)
+      expect { expect(subject).to be_invalid }
+        .to raise_error RSpec::Expectations::ExpectationNotMetError
+    end
+
+    it "passes with invalid non-policy object" do
+      allow(subject).to receive(:valid?).and_return(false)
+      expect { expect(subject).to be_invalid }.not_to raise_error
+    end
+  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,9 +1,9 @@
 Gem::Specification.new do |gem|
   gem.name     = "tram-policy"
-  gem.version  = "1.0.0"
+  gem.version  = "2.1.0"
   gem.author   = ["Viktor Sokolov (gzigzigzeo)", "Andrew Kozin (nepalez)"]
   gem.email    = "andrew.kozin@gmail.com"
-  gem.homepage = "https://github.com/tram/tram-policy"
+  gem.homepage = "https://github.com/tram-rb/tram-policy"
   gem.summary  = "Policy Object Pattern"
   gem.license  = "MIT"
 
@@ -14,7 +14,7 @@ Gem::Specification.new do |gem|
 
   gem.required_ruby_version = ">= 2.3"
 
-  gem.add_runtime_dependency "dry-initializer", "~> 2.0"
+  gem.add_runtime_dependency "dry-initializer", "> 2", "< 4"
   gem.add_runtime_dependency "i18n", "~> 1.0"
 
   gem.add_development_dependency "rake", "> 10"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tram-policy
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Viktor Sokolov (gzigzigzeo)
@@ -9,22 +9,28 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-17 00:00:00.000000000 Z
+date: 2021-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-initializer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '2'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '2'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
@@ -154,7 +160,7 @@ files:
 - spec/tram/policy/validation_error_spec.rb
 - spec/tram/policy_spec.rb
 - tram-policy.gemspec
-homepage: https://github.com/tram/tram-policy
+homepage: https://github.com/tram-rb/tram-policy
 licenses:
 - MIT
 metadata: {}
@@ -173,8 +179,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Policy Object Pattern