iknow_view_models 3.6.1 → 3.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f05051b924e9602a09da08b3aec5e5c4de224753d70d29523d66eb34db6947f
-  data.tar.gz: aac9f7453c54bb216d3cf59b438070c2857f186138c8ff871abaf026a94e4ab4
+  metadata.gz: 267212f1572c3f81b65462be6c30e02a12a6562a29d01bd5e0c342a12396acbc
+  data.tar.gz: e8c4addd984351d6df889ba7d75abbe8d5bde7793a48791e24a1b42e7a3fdf42
 SHA512:
-  metadata.gz: 3edbbb12ef310f58fea255589d2e2112cc62760518af31628c1121b0ea1db9634cb5ace9657087bceecd7f1bd38188fe9bec8b7e03c88613b773fafd2c6b7b6a
-  data.tar.gz: b063d4884cf2846bef6baca22bbc7f8533ddb2c876bf5ffa5e456a5834d7729881b0d08aab69ff524b5cf0fd451599346cce022502334f2bba26673b753a8068
+  metadata.gz: 6039dcc05bed20bce4681c322c3509be3f2a276c0a755fb3e27240eec74fd9eddef68f3c272df33554407853065a98e0f4d03a068c8c0e068cfc02be6f73ab67
+  data.tar.gz: 95fb89d93724d5028905612d846534916c4bdacd1bb88009ae434090b183e17d7311bb2709bfa81b08ff3dff45940ced0ce080ff861529c59cbb96671a661b64

data/Gemfile

@@ -13,3 +13,4 @@ gem 'minitest-ci'
 # Override gemspec for development version preferences
 gem 'activerecord',  '~> 7.0.0'
 gem 'activesupport', '~> 7.0.0'
+gem 'actionpack',    '~> 7.0.0'

data/gemfiles/rails_5_2.gemfile

@@ -5,5 +5,6 @@ source 'https://rubygems.org'
 gem 'minitest-ci'
 gem 'activerecord', '~> 5.2.0'
 gem 'activesupport', '~> 5.2.0'
+gem 'actionpack', '~> 5.2.0'
 
 gemspec path: '../'

data/gemfiles/rails_6_0.gemfile

@@ -5,5 +5,6 @@ source 'https://rubygems.org'
 gem 'minitest-ci'
 gem 'activerecord', '~> 6.0.0'
 gem 'activesupport', '~> 6.0.0'
+gem 'actionpack', '~> 6.0.0'
 
 gemspec path: '../'

data/gemfiles/rails_6_1.gemfile

@@ -5,5 +5,6 @@ source 'https://rubygems.org'
 gem 'minitest-ci'
 gem 'activerecord', '~> 6.1.0'
 gem 'activesupport', '~> 6.1.0'
+gem 'actionpack', '~> 6.1.0'
 
 gemspec path: '../'

data/gemfiles/rails_7_0.gemfile

@@ -5,5 +5,6 @@ source "https://rubygems.org"
 gem 'minitest-ci'
 gem "activerecord", "~> 7.0.0"
 gem "activesupport", "~> 7.0.0"
+gem "actionpack", "~> 7.0.0"
 
 gemspec path: '../'

data/iknow_view_models.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.7'
 
+  spec.add_dependency 'actionpack', '>= 5.0'
   spec.add_dependency 'activerecord', '>= 5.0'
   spec.add_dependency 'activesupport', '>= 5.0'
 

data/lib/iknow_view_models/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module IknowViewModels
-  VERSION = '3.6.1'
+  VERSION = '3.6.2'
 end

data/lib/view_model/access_control/composed.rb

@@ -39,7 +39,7 @@ class ViewModel::AccessControl::Composed < ViewModel::AccessControl
           case
           when new_allow
             nil
-          when self.allow_error && other.allow_error
+          when mergeable_error?(self.allow_error) && mergeable_error?(other.allow_error)
             self.allow_error.merge(other.allow_error)
           else
             self.allow_error || other.allow_error
@@ -48,6 +48,12 @@ class ViewModel::AccessControl::Composed < ViewModel::AccessControl
         ComposedResult.new(new_allow, other.veto, new_allow_error, other.veto_error)
       end
     end
+
+    private
+
+    def mergeable_error?(err)
+      err&.is_a?(NoRequiredConditionsError)
+    end
   end
 
   PermissionsCheck = Struct.new(:location, :reason, :error_type, :checker) do
@@ -196,22 +202,54 @@ class ViewModel::AccessControl::Composed < ViewModel::AccessControl
   protected
 
   def check_delegates(env, ifs, unlesses)
-    vetoed_checker = unlesses.detect { |checker| checker.check(env) }
+    veto, veto_error = detect_veto(env, unlesses)
+    allow, allow_error = detect_allow(env, ifs)
+
+    ComposedResult.new(allow, veto, allow_error, veto_error)
+  end
+
+  private
+
+  def detect_veto(env, checkers)
+    checkers.each do |checker|
+      result = checker.check(env)
+      next unless result
 
-    veto = vetoed_checker.present?
-    if veto
-      veto_error = vetoed_checker.error_type.new('Action not permitted because: ' +
-                                                 vetoed_checker.reason,
-                                                 env.view.blame_reference)
+      error =
+        if result.is_a?(StandardError)
+          result
+        else
+          checker.error_type.new('Action not permitted because: ' +
+                                 checker.reason,
+                                 env.view.blame_reference)
+        end
+
+      # short-circuit exit with failure
+      return true, error
     end
 
-    allow = ifs.any? { |checker| checker.check(env) }
+    return false, nil
+  end
+
+  def detect_allow(env, checkers)
+    error = nil
+
+    checkers.each do |checker|
+      result = checker.check(env)
+      next unless result
 
-    unless allow
-      allow_error = NoRequiredConditionsError.new(env.view.blame_reference,
-                                                  ifs.map(&:name))
+      if result.is_a?(StandardError)
+        error ||= result
+      else
+        # short-circuit exit with success
+        return true, nil
+      end
     end
 
-    ComposedResult.new(allow, veto, allow_error, veto_error)
+    error ||= NoRequiredConditionsError.new(
+      env.view.blame_reference,
+      checkers.map(&:name))
+
+    return false, error
   end
 end

data/lib/view_model/access_control.rb

@@ -149,6 +149,14 @@ class ViewModel::AccessControl
   def raise_if_error!(result)
     raise (result.error || yield) unless result.permit?
   end
+
+  # Called from composed access controls via the `env`, this is used to make the
+  # if/unless DSL more readable when returning a custom failure error.
+  def failure(err)
+    raise ArgumentError.new("Unexpected failure type: #{err}") unless err.is_a?(StandardError)
+
+    err
+  end
 end
 
 require 'view_model/access_control/open'

data/test/unit/view_model/access_control_test.rb

@@ -156,6 +156,54 @@ class ViewModel::AccessControlTest < ActiveSupport::TestCase
       assert_equal(2, ex.reasons.count)
     end
 
+    def test_veto_ordering
+      TestAccessControl.visible_if!('always') { true }
+
+      TestAccessControl.visible_unless!('car starts with i') do
+        view.car =~ /^i/
+      end
+
+      TestAccessControl.visible_unless!('car ends with e') do
+        view.car =~ /e$/
+      end
+
+      assert_serializes(ListView, List.create!(car: 'ok'))
+      refute_serializes(ListView, List.create!(car: 'invisible'), /not permitted.*car starts with i/)
+    end
+
+    def test_custom_error_if
+      TestAccessControl.visible_if!('car is visible1') do
+        view.car == 'visible1' ||
+          # In principle a failure() may return any error, but by returning an
+          # AccessControlError we make it possible to test with refute_serializes
+          failure(ViewModel::AccessControlError.new('Custom Error Message', view.blame_reference))
+      end
+
+      TestAccessControl.visible_if!('car is visible2') do
+        view.car == 'visible2' ||
+          # Only the first failure() recorded by a failed if check will be
+          # raised as the error.
+          failure(ViewModel::AccessControlError.new('Should not be seen', view.blame_reference))
+      end
+
+      assert_serializes(ListView, List.create!(car: 'visible1'))
+      assert_serializes(ListView, List.create!(car: 'visible2'))
+      refute_serializes(ListView, List.create!(car: 'bad'), /Custom Error Message/)
+    end
+
+    def test_custom_error_unless
+      TestAccessControl.visible_if!('always') { true }
+
+      TestAccessControl.visible_unless!('car is invisible') do
+        if view.car == 'invisible'
+          failure(ViewModel::AccessControlError.new('Custom Error Message', view.blame_reference))
+        end
+      end
+
+      assert_serializes(ListView, List.create!(car: 'ok'))
+      refute_serializes(ListView, List.create!(car: 'invisible'), /Custom Error Message/)
+    end
+
     def test_inheritance
       child_access_control = Class.new(ViewModel::AccessControl::Composed)
       child_access_control.include_from(TestAccessControl)

data/test/unit/view_model/active_record/cache_test.rb

@@ -15,16 +15,11 @@ require 'view_model/active_record'
 
 DUMMY_RAILS_CACHE = ActiveSupport::Cache::MemoryStore.new
 
-module RailsDummyCache
-  def cache
-    DUMMY_RAILS_CACHE
-  end
+IknowCache.configure! do
+  logger ::ActiveRecord::Base.logger
+  cache DUMMY_RAILS_CACHE
 end
 
-# Ensure we have a dummy Rails, and then prepend our dummy cache
-module Rails; end
-Rails.singleton_class.prepend(RailsDummyCache)
-
 class ViewModel::ActiveRecord
   class CacheTest < ActiveSupport::TestCase
     using ViewModel::Utils::Collections

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: iknow_view_models
 version: !ruby/object:Gem::Version
-  version: 3.6.1
+  version: 3.6.2
 platform: ruby
 authors:
 - iKnow Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-12 00:00:00.000000000 Z
+date: 2022-02-16 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement