iknow_view_models 3.6.1 → 3.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f05051b924e9602a09da08b3aec5e5c4de224753d70d29523d66eb34db6947f
-  data.tar.gz: aac9f7453c54bb216d3cf59b438070c2857f186138c8ff871abaf026a94e4ab4
+  metadata.gz: 31ecbd493e6716db0442e309c1566f38c13f676ef72a55ea9708f1537875331f
+  data.tar.gz: b03d5b1b1f0d3ba458f11f5575f379969eea72089f781ef65462ab47e181e158
 SHA512:
-  metadata.gz: 3edbbb12ef310f58fea255589d2e2112cc62760518af31628c1121b0ea1db9634cb5ace9657087bceecd7f1bd38188fe9bec8b7e03c88613b773fafd2c6b7b6a
-  data.tar.gz: b063d4884cf2846bef6baca22bbc7f8533ddb2c876bf5ffa5e456a5834d7729881b0d08aab69ff524b5cf0fd451599346cce022502334f2bba26673b753a8068
+  metadata.gz: 06e8384611d8fe7e93ac6065c11aca651f15b717be02a0818106198b769fe6ea59c843a83fd7cd457089a44a98cda499e7f5a2ae905d6c4b46c04e18c68cd4af
+  data.tar.gz: 3c20e972b8a5011aeae40494bf8d271ec3ef5092bbccb7495ea435a7e99dbf45b89f632e868c56bdf681722251f4432e6bd426dba2bfd9d2ef93cce7fc71c066

data/.circleci/config.yml

@@ -8,7 +8,7 @@ executors:
         default: "2.7"
       pg-version:
         type: string
-        default: "11"
+        default: "12.10"
       gemfile:
         type: string
         default: "Gemfile"
@@ -16,14 +16,14 @@ executors:
       PGHOST: 127.0.0.1
       PGUSER: eikaiwa
     docker:
-      - image: circleci/ruby:<< parameters.ruby-version >>
+      - image: cimg/ruby:<< parameters.ruby-version >>
         environment:
           BUNDLE_JOBS: 3
           BUNDLE_RETRY: 3
           BUNDLE_PATH: vendor/bundle
           RAILS_ENV: test
           BUNDLE_GEMFILE: << parameters.gemfile >>
-      - image: circleci/postgres:<< parameters.pg-version >>-alpine
+      - image: cimg/postgres:<< parameters.pg-version >>
         environment:
           POSTGRES_USER: eikaiwa
           POSTGRES_DB: iknow_view_models
@@ -104,27 +104,27 @@ workflows:
       - test:
           name: 'ruby 2.7 rails 5.2 pg 12'
           ruby-version: "2.7"
-          pg-version: "12"
+          pg-version: "12.10"
           gemfile: gemfiles/rails_5_2.gemfile
       - test:
           name: 'ruby 2.7 rails 6.0 pg 12'
           ruby-version: "2.7"
-          pg-version: "12"
+          pg-version: "12.10"
           gemfile: gemfiles/rails_6_0.gemfile
       - test:
           name: 'ruby 2.7 rails 6.1 pg 12'
           ruby-version: "2.7"
-          pg-version: "12"
+          pg-version: "12.10"
           gemfile: gemfiles/rails_6_1.gemfile
       - test:
           name: 'ruby 3.0 rails 6.1 pg 12'
           ruby-version: "3.0"
-          pg-version: "12"
+          pg-version: "12.10"
           gemfile: gemfiles/rails_6_1.gemfile
       - test:
-          name: 'ruby 3.0 rails 7.0 pg 12'
-          ruby-version: "3.0"
-          pg-version: "12"
+          name: 'ruby 3.1 rails 7.0 pg 13'
+          ruby-version: "3.1"
+          pg-version: "13.6"
           gemfile: gemfiles/rails_7_0.gemfile
       - publish:
           filters:

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.4'
 end

data/lib/view_model/access_control/composed.rb

@@ -39,15 +39,31 @@ class ViewModel::AccessControl::Composed < ViewModel::AccessControl
           case
           when new_allow
             nil
-          when self.allow_error && other.allow_error
-            self.allow_error.merge(other.allow_error)
+          when self.allow_error.nil?
+            other.allow_error
+          when other.allow_error.nil?
+            self.allow_error
+          # Mergeable (standard) errors should be merged if possible; if not
+          # possible, we should take the first non-standard error.
+          when mergeable_error?(self.allow_error)
+            if mergeable_error?(other.allow_error)
+              self.allow_error.merge(other.allow_error)
+            else
+              other.allow_error
+            end
           else
-            self.allow_error || other.allow_error
+            self.allow_error
           end
 
         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
@@ -159,11 +175,10 @@ class ViewModel::AccessControl::Composed < ViewModel::AccessControl
     end
 
     def inspect
-      s = super + '('
-      s += inspect_checks.join(', ')
-      s += " includes checkers: #{@included_checkers.inspect}" if @included_checkers.present?
-      s += ')'
-      s
+      checks = inspect_checks
+      checks << "includes checkers: #{@included_checkers.inspect}" if @included_checkers.present?
+
+      super + '(' + checks.join(', ') + ')'
     end
 
     def inspect_checks
@@ -196,22 +211,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/tree.rb

@@ -192,8 +192,6 @@ class ViewModel::AccessControl::Tree < ViewModel::AccessControl
       def inspect_checks
         checks = super
         if root?
-          checks << 'no root checks'
-        else
           checks << "root_children_visible_if: #{root_children_visible_ifs.map(&:reason)}"            if root_children_visible_ifs.present?
           checks << "root_children_visible_unless: #{root_children_visible_unlesses.map(&:reason)}"   if root_children_visible_unlesses.present?
           checks << "root_children_editable_if: #{root_children_editable_ifs.map(&:reason)}"          if root_children_editable_ifs.present?
@@ -252,16 +250,16 @@ class ViewModel::AccessControl::Tree < ViewModel::AccessControl
 
     def save_root_visibility!(traversal_env)
       result = check_delegates(traversal_env,
-                               self.class.each_check(:root_children_visible_ifs,      ->(a) { a.is_a?(Node) }),
-                               self.class.each_check(:root_children_visible_unlesses, ->(a) { a.is_a?(Node) }))
+                               self.class.each_check(:root_children_visible_ifs,      ->(a) { a < Node }),
+                               self.class.each_check(:root_children_visible_unlesses, ->(a) { a < Node }))
 
       store_descendent_visibility(traversal_env.view, result)
     end
 
     def save_root_editability!(traversal_env)
       result = check_delegates(traversal_env,
-                               self.class.each_check(:root_children_editable_ifs,      ->(a) { a.is_a?(Node) }),
-                               self.class.each_check(:root_children_editable_unlesses, ->(a) { a.is_a?(Node) }))
+                               self.class.each_check(:root_children_editable_ifs,      ->(a) { a < Node }),
+                               self.class.each_check(:root_children_editable_unlesses, ->(a) { a < Node }))
 
       store_descendent_editability(traversal_env.view, result)
     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/lib/view_model/migration/no_path_error.rb

@@ -14,7 +14,7 @@ class ViewModel::Migration::NoPathError < ViewModel::AbstractError
   end
 
   def detail
-    "No migration path for #{vm_name} from #{from} to #{to}"
+    "No migration path for #{vm_name} between client version #{from} and server version #{to}"
   end
 
   def meta

data/lib/view_model.rb

@@ -3,6 +3,7 @@
 # A ViewModel encapsulates a particular aggregation of data calculated via the
 # underlying models and provides a means of serializing it into views.
 require 'jbuilder'
+require 'base64'
 require 'deep_preloader'
 
 class ViewModel

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)
@@ -271,6 +319,26 @@ class ViewModel::AccessControlTest < ActiveSupport::TestCase
       assert_serializes(Tree1View, make_tree('rule:visible_children', 'visible child', 'rule:visible_children', 'visible child'))
     end
 
+    def test_root_inheritance
+      parent_access_control = Class.new(ViewModel::AccessControl::Tree)
+      parent_access_control.view 'Tree1' do
+        visible_if!('true') { true }
+
+        root_children_visible_if!('root children visible') do
+          view.val == 'rule:visible_children'
+        end
+      end
+
+      TestAccessControl.include_from(parent_access_control)
+
+      refute_serializes(Tree1View, make_tree('arbitrary parent',      'invisible child'))
+      assert_serializes(Tree1View, make_tree('rule:visible_children', 'visible child'))
+
+      # nested root
+      refute_serializes(Tree1View, make_tree('rule:visible_children', 'visible child', 'arbitrary parent',      'invisible child'))
+      assert_serializes(Tree1View, make_tree('rule:visible_children', 'visible child', 'rule:visible_children', 'visible child'))
+    end
+
     def test_visibility_veto_from_root
       TestAccessControl.view 'Tree1' do
         root_children_visible_unless!('root children invisible') do

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.4
 platform: ruby
 authors:
 - iKnow Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-12 00:00:00.000000000 Z
+date: 2022-05-31 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
@@ -495,7 +509,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.11
 signing_key: 
 specification_version: 4
 summary: ViewModels provide a means of encapsulating a collection of related data