iknow_view_models 3.1.6 → 3.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6fc1b45c59ce7be7ea1052ef27c81bf46ca556ed5d36119cf35cd3b8ecb5b07a
-  data.tar.gz: a667a697d8c71947884707f99d9d2bc6cb53361565cf153c8e28186a92b8e7db
+  metadata.gz: a86b2b9fdc89ee421bcb155ae29e3ac4f2c809be4d40e483a405337f8729a7f9
+  data.tar.gz: 8fd1c498264a0eefe30d9c3c6a35c4f005a94aaf71b03d37044a23212cb90eb4
 SHA512:
-  metadata.gz: c30f535e0a125a591519b1a7de0101176031afcff50d1656388cacf7bc8dc1f400c816ccefc19f7a0454fbb768911801c25ab4335ea567cab55d354f4a70aeae
-  data.tar.gz: d2a75cde7251e75ce400544efc02f19890edec7604131fad67ccaa8ddd37f6e51af8b72f14c3b40f33ef219c278558f550cbcabb4aad4d05fff5b0549612fc4b
+  metadata.gz: c2a2fd321cf605709eb398771cd6cc475869e80c59d5a4934a2cf5429cfa3e1a6a5e3e74f358227793ff2cc7ce10a1eff46fe3c4db20e859d49d54be306b4afb
+  data.tar.gz: cfb7009b02acbebce85d3ad41205549430370710633d51176ac8596acf6a83fb98f0e76132bf850baf37da36acfe402afc21d00c8996f66ca2a98f62a9380dc1

data/.circleci/config.yml

@@ -102,15 +102,15 @@ workflows:
   build:
     jobs:
       - test:
-          name: 'ruby 2.6 rails 5.2 pg 11'
+          name: 'ruby 2.6 rails 5.2 pg 12'
           ruby-version: "2.6"
-          pg-version: "11"
+          pg-version: "12"
           gemfile: gemfiles/rails_5_2.gemfile
       - test:
-          name: 'ruby 2.6 rails 6.0 pg 11'
-          ruby-version: "2.6"
-          pg-version: "11"
-          gemfile: gemfiles/rails_6_0_beta.gemfile
+          name: 'ruby 2.7 rails 6.0 pg 12'
+          ruby-version: "2.7"
+          pg-version: "12"
+          gemfile: gemfiles/rails_6_0.gemfile
       - publish:
           filters:
             branches:

data/.rubocop.yml

@@ -0,0 +1,18 @@
+AllCops:
+  TargetRubyVersion: 2.7
+  Exclude:
+    - Appraisals
+    - Gemfile
+    - Rakefile
+    - 'gemfiles/*'
+    - 'nix/gem/**/*'
+
+inherit_gem:
+  rubocop-iknow: rubocop.yml
+
+Metrics/BlockNesting:
+  Enabled: false
+Lint/IneffectiveAccessModifier:
+  Enabled: false
+Lint/UselessAccessModifier:
+  Enabled: false

data/Appraisals

@@ -1,9 +1,9 @@
-appraise "rails-5-2" do
-  gem "activerecord", "~> 5.2.0"
-  gem "activesupport", "~> 5.2.0"
+appraise 'rails-5-2' do
+  gem 'activerecord', '~> 5.2.0'
+  gem 'activesupport', '~> 5.2.0'
 end
 
-appraise "rails-6-0-beta" do
-  gem "activerecord", "~> 6.0.0.beta"
-  gem "activesupport", "~> 6.0.0.beta"
+appraise 'rails-6-0' do
+  gem 'activerecord', '~> 6.0.0'
+  gem 'activesupport', '~> 6.0.0'
 end

data/Gemfile

@@ -3,9 +3,13 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in cerego_view_models.gemspec
 gemspec
 
+# Add our linter rules as a development dependency
+gem 'rubocop'
+gem 'rubocop-iknow'
+
 # Test metadata collection for circleci
 gem 'minitest-ci'
 
 # Override gemspec for development version preferences
-gem 'activerecord',  '~> 5.2.0'
-gem 'activesupport', '~> 5.2.0'
+gem 'activerecord',  '~> 6.0.0'
+gem 'activesupport', '~> 6.0.0'

data/Rakefile

@@ -1,5 +1,5 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
 Rake::TestTask.new do |t|
   t.libs << 'test'
@@ -8,14 +8,14 @@ Rake::TestTask.new do |t|
   t.verbose = true
 end
 
-desc "Open an IRB console with the test helpers"
+desc 'Open an IRB console with the test helpers'
 task :test_console do
   ruby %{-r bundler/setup -Ilib -e 'load "test/helpers/arvm_test_models.rb"' -r irb -e 'IRB.start(__FILE__)'}
 end
 
-desc "Open a Pry console with the test helpers"
+desc 'Open a Pry console with the test helpers'
 task 'test_console:pry' do
-  ruby %{-r bundler/setup -Ilib  -e 'load "test/helpers/arvm_test_models.rb"' -r pry -e 'Pry.start'}
+  ruby %(-r bundler/setup -Ilib  -e 'load "test/helpers/arvm_test_models.rb"' -r pry -e 'Pry.start')
 end
 
 task :default => :test

data/gemfiles/rails_5_2.gemfile

@@ -1,9 +1,9 @@
 # This file was generated by Appraisal
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-gem "minitest-ci"
-gem "activerecord", "~> 5.2.0"
-gem "activesupport", "~> 5.2.0"
+gem 'minitest-ci'
+gem 'activerecord', '~> 5.2.0'
+gem 'activesupport', '~> 5.2.0'
 
-gemspec path: "../"
+gemspec path: '../'

data/gemfiles/rails_6_0.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source 'https://rubygems.org'
+
+gem 'minitest-ci'
+gem 'activerecord', '~> 6.0.0'
+gem 'activesupport', '~> 6.0.0'
+
+gemspec path: '../'

data/iknow_view_models.gemspec

@@ -1,50 +1,52 @@
 # frozen_string_literal: true
-# coding: utf-8
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'iknow_view_models/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "iknow_view_models"
+  spec.name          = 'iknow_view_models'
   spec.version       = IknowViewModels::VERSION
-  spec.authors       = ["iKnow Team"]
-  spec.email         = ["edge@iknow.jp"]
-  spec.summary       = "ViewModels provide a means of encapsulating a collection of related data and specifying its JSON serialization."
-  spec.description   = ""
-  spec.homepage      = "https://github.com/iknow/cerego_view_models"
-  spec.license       = "MIT"
+  spec.authors       = ['iKnow Team']
+  spec.email         = ['edge@iknow.jp']
+  spec.summary       = 'ViewModels provide a means of encapsulating a collection of related data and specifying its JSON serialization.'
+  spec.description   = ''
+  spec.homepage      = 'https://github.com/iknow/cerego_view_models'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "activerecord", ">= 5.0"
-  spec.add_dependency "activesupport", ">= 5.0"
-
-  spec.add_dependency "acts_as_manual_list"
-  spec.add_dependency "deep_preloader", ">= 1.0.1"
-  spec.add_dependency "iknow_cache"
-  spec.add_dependency "iknow_params", "~> 2.2.0"
-  spec.add_dependency "safe_values"
-  spec.add_dependency "keyword_builder"
-
-  spec.add_dependency "concurrent-ruby"
-  spec.add_dependency "jbuilder"
-  spec.add_dependency "json_schema"
-  spec.add_dependency "lazily"
-  spec.add_dependency "renum"
-  spec.add_dependency "oj"
-
-  spec.add_development_dependency "appraisal"
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "byebug"
-  spec.add_development_dependency "method_source"
-  spec.add_development_dependency "minitest-hooks"
-  spec.add_development_dependency "pg", '~> 0.18' # As of 5.1.4, Rails runtime check excludes pg 1.x, see #31669
-  spec.add_development_dependency "pry"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec-expectations"
-  spec.add_development_dependency "sqlite3"
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = 2.6
+
+  spec.add_dependency 'activerecord', '>= 5.0'
+  spec.add_dependency 'activesupport', '>= 5.0'
+
+  spec.add_dependency 'acts_as_manual_list'
+  spec.add_dependency 'deep_preloader', '>= 1.0.1'
+  spec.add_dependency 'iknow_cache'
+  spec.add_dependency 'iknow_params', '~> 2.2.0'
+  spec.add_dependency 'keyword_builder'
+  spec.add_dependency 'safe_values'
+
+  spec.add_dependency 'concurrent-ruby'
+  spec.add_dependency 'jbuilder'
+  spec.add_dependency 'json_schema'
+  spec.add_dependency 'lazily'
+  spec.add_dependency 'oj'
+  spec.add_dependency 'renum'
+  spec.add_dependency 'rgl'
+
+  spec.add_development_dependency 'appraisal'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'method_source'
+  spec.add_development_dependency 'minitest-hooks'
+  spec.add_development_dependency 'pg'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec-expectations'
+  spec.add_development_dependency 'sqlite3'
 end

data/lib/iknow_view_models.rb

@@ -1,10 +1,12 @@
-require "iknow_view_models/version"
-require "view_model"
-require "view_model/controller"
-require "view_model/active_record"
-require "view_model/active_record/controller"
-require "view_model/active_record/singular_nested_controller"
-require "view_model/active_record/collection_nested_controller"
+# frozen_string_literal: true
+
+require 'iknow_view_models/version'
+require 'view_model'
+require 'view_model/controller'
+require 'view_model/active_record'
+require 'view_model/active_record/controller'
+require 'view_model/active_record/singular_nested_controller'
+require 'view_model/active_record/collection_nested_controller'
 
 module IknowViewModels
 end

data/lib/iknow_view_models/version.rb

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

data/lib/view_model.rb

@@ -6,14 +6,19 @@ require 'jbuilder'
 require 'deep_preloader'
 
 class ViewModel
-  REFERENCE_ATTRIBUTE = "_ref"
-  ID_ATTRIBUTE        = "id"
-  TYPE_ATTRIBUTE      = "_type"
-  VERSION_ATTRIBUTE   = "_version"
-  NEW_ATTRIBUTE       = "_new"
-
-  Metadata = Struct.new(:id, :view_name, :schema_version, :new) do
-    alias :new? :new
+  REFERENCE_ATTRIBUTE = '_ref'
+  ID_ATTRIBUTE        = 'id'
+  TYPE_ATTRIBUTE      = '_type'
+  VERSION_ATTRIBUTE   = '_version'
+  NEW_ATTRIBUTE       = '_new'
+
+  # Migrations leave a metadata attribute _migrated on any views that they
+  # alter. This attribute is accessible as metadata when deserializing migrated
+  # input, and is included in the output serialization sent to clients.
+  MIGRATED_ATTRIBUTE  = '_migrated'
+
+  Metadata = Struct.new(:id, :view_name, :schema_version, :new, :migrated) do
+    alias_method :new?, :new
   end
 
   class << self
@@ -23,6 +28,7 @@ class ViewModel
     attr_writer   :view_name
 
     def inherited(subclass)
+      super
       subclass.initialize_as_viewmodel
     end
 
@@ -38,6 +44,7 @@ class ViewModel
           # try to auto-detect based on class name
           match = /(.*)View$/.match(self.name)
           raise ArgumentError.new("Could not auto-determine ViewModel name from class name '#{self.name}'") if match.nil?
+
           ViewModel::Registry.default_view_name(match[1])
         end
     end
@@ -72,6 +79,7 @@ class ViewModel
       end
 
       attr_accessor attr
+
       define_method("deserialize_#{attr}") do |value, references: {}, deserialize_context: self.class.new_deserialize_context|
         self.public_send("#{attr}=", value)
       end
@@ -99,8 +107,9 @@ class ViewModel
       type_name      = hash.delete(ViewModel::TYPE_ATTRIBUTE)
       schema_version = hash.delete(ViewModel::VERSION_ATTRIBUTE)
       new            = hash.delete(ViewModel::NEW_ATTRIBUTE) { false }
+      migrated       = hash.delete(ViewModel::MIGRATED_ATTRIBUTE) { false }
 
-      Metadata.new(id, type_name, schema_version, new)
+      Metadata.new(id, type_name, schema_version, new, migrated)
     end
 
     def extract_reference_only_metadata(hash)
@@ -108,7 +117,7 @@ class ViewModel
       id             = hash.delete(ViewModel::ID_ATTRIBUTE)
       type_name      = hash.delete(ViewModel::TYPE_ATTRIBUTE)
 
-      Metadata.new(id, type_name, nil, false)
+      Metadata.new(id, type_name, nil, false, false)
     end
 
     def extract_reference_metadata(hash)
@@ -116,7 +125,7 @@ class ViewModel
       hash.delete(ViewModel::REFERENCE_ATTRIBUTE)
     end
 
-    def is_update_hash?(hash)
+    def is_update_hash?(hash) # rubocop:disable Naming/PredicateName
       ViewModel::Schemas.verify_schema!(ViewModel::Schemas::VIEWMODEL_UPDATE, hash)
       hash.has_key?(ViewModel::ID_ATTRIBUTE) &&
         !hash.fetch(ViewModel::ActiveRecord::NEW_ATTRIBUTE, false)
@@ -192,12 +201,12 @@ class ViewModel
         end
 
         member_names.each do |attr|
-          if view_hash.has_key?(attr)
-            viewmodel.public_send("deserialize_#{attr}",
-                                  view_hash[attr],
-                                  references: references,
-                                  deserialize_context: deserialize_context)
-          end
+          next unless view_hash.has_key?(attr)
+
+          viewmodel.public_send("deserialize_#{attr}",
+                                view_hash[attr],
+                                references: references,
+                                deserialize_context: deserialize_context)
         end
 
         deserialize_context.run_callback(ViewModel::Callbacks::Hook::BeforeValidate, viewmodel)
@@ -234,6 +243,11 @@ class ViewModel
       schema_version == self.schema_version
     end
 
+    def schema_hash(schema_versions)
+      version_string = schema_versions.to_a.sort.join(',')
+      Base64.urlsafe_encode64(Digest::MD5.digest(version_string))
+    end
+
     def preload_for_serialization(viewmodels, serialize_context: new_serialize_context, include_referenced: true, lock: nil)
       Array.wrap(viewmodels).group_by(&:class).each do |type, views|
         DeepPreloader.preload(views.map(&:model),

data/lib/view_model/access_control.rb

@@ -13,11 +13,12 @@ require 'view_model/access_control_error'
 class ViewModel::AccessControl
   Result = Struct.new(:permit, :error) do
     def initialize(permit, error: nil)
-      raise ArgumentError.new("Successful AccessControl::Result may not have an error") if permit && error
+      raise ArgumentError.new('Successful AccessControl::Result may not have an error') if permit && error
+
       super(permit, error)
     end
 
-    alias :permit? :permit
+    alias_method :permit?, :permit
 
     # Merge this result with another access control result. Takes a block
     # returning a result, and returns a combined result for both tests. Access
@@ -129,6 +130,7 @@ class ViewModel::AccessControl
     if @initial_editability_store.has_key?(view.object_id)
       raise RuntimeError.new("Access control data already recorded for view #{view.to_reference}")
     end
+
     @initial_editability_store[view.object_id] = initial_editability
   end
 
@@ -136,6 +138,7 @@ class ViewModel::AccessControl
     unless @initial_editability_store.has_key?(view.object_id)
       raise RuntimeError.new("No access control data recorded for view #{view.to_reference}")
     end
+
     @initial_editability_store.delete(view.object_id)
   end
 

data/lib/view_model/access_control/composed.rb

@@ -8,8 +8,9 @@
 class ViewModel::AccessControl::Composed < ViewModel::AccessControl
   ComposedResult = Struct.new(:allow, :veto, :allow_error, :veto_error) do
     def initialize(allow, veto, allow_error, veto_error)
-      raise ArgumentError.new("Non-vetoing result may not have a veto error") if veto_error  && !veto
-      raise ArgumentError.new("Allowing result may not have a allow error")   if allow_error && allow
+      raise ArgumentError.new('Non-vetoing result may not have a veto error') if veto_error  && !veto
+      raise ArgumentError.new('Allowing result may not have a allow error')   if allow_error && allow
+
       super
     end
 
@@ -64,7 +65,7 @@ class ViewModel::AccessControl::Composed < ViewModel::AccessControl
     attr_reader :reasons
 
     def initialize(nodes, reasons)
-      super("Action not permitted because none of the possible conditions were met.", nodes)
+      super('Action not permitted because none of the possible conditions were met.', nodes)
       @reasons = reasons
     end
 
@@ -92,7 +93,7 @@ class ViewModel::AccessControl::Composed < ViewModel::AccessControl
     end
 
     def initialize_as_composed_access_control
-      @included_checkers   = []
+      @included_checkers = []
 
       @edit_valid_ifs      = []
       @edit_valid_unlesses = []
@@ -152,15 +153,16 @@ class ViewModel::AccessControl::Composed < ViewModel::AccessControl
       @included_checkers.each do |ancestor|
         next unless visited.add?(ancestor)
         next if include_ancestor && !include_ancestor.call(ancestor)
+
         ancestor.each_check(check_name) { |x| yield x }
       end
     end
 
     def inspect
-      s = super + "("
-      s += inspect_checks.join(", ")
+      s = super + '('
+      s += inspect_checks.join(', ')
       s += " includes checkers: #{@included_checkers.inspect}" if @included_checkers.present?
-      s += ")"
+      s += ')'
       s
     end
 
@@ -174,7 +176,6 @@ class ViewModel::AccessControl::Composed < ViewModel::AccessControl
       checks << "edit_valid_unless: #{@edit_valid_unlesses.map(&:reason)}" if @edit_valid_unlesses.present?
       checks
     end
-
   end
 
   # final
@@ -199,7 +200,7 @@ class ViewModel::AccessControl::Composed < ViewModel::AccessControl
 
     veto = vetoed_checker.present?
     if veto
-      veto_error = vetoed_checker.error_type.new("Action not permitted because: " +
+      veto_error = vetoed_checker.error_type.new('Action not permitted because: ' +
                                                  vetoed_checker.reason,
                                                  env.view.blame_reference)
     end