iknow_view_models 3.1.8 → 3.2.4

data/lib/view_model/traversal_context.rb

@@ -21,6 +21,7 @@ class ViewModel::TraversalContext
   end
 
   attr_reader :shared_context
+
   delegate :access_control, :callbacks, to: :shared_context
 
   def self.new_child(*args)
@@ -118,7 +119,7 @@ class ViewModel::TraversalContext
 
   def nearest_root_viewmodel
     if root?
-      raise RuntimeError.new("Attempted to find nearest root from a root context. This is probably not what you wanted.")
+      raise RuntimeError.new('Attempted to find nearest root from a root context. This is probably not what you wanted.')
     elsif parent_context.root?
       parent_viewmodel
     else

data/nix/dependencies.nix

@@ -0,0 +1,5 @@
+{pkgs}:
+{
+  ruby = pkgs.ruby_2_7;
+  postgresql = pkgs.postgresql_12;
+}

data/nix/gem/generate.rb

@@ -7,6 +7,7 @@
 # This workaround is from https://github.com/manveru/bundix/issues/10#issuecomment-405879379
 
 require 'shellwords'
+require 'uri'
 
 def sh(*args)
   warn args.shelljoin
@@ -20,7 +21,7 @@ require 'bundler'
 
 lockfile = Bundler::LockfileParser.new(File.read('Gemfile.lock'))
 gems = lockfile.specs.select { |spec| spec.source.is_a?(Bundler::Source::Rubygems) }
-sources = [URI('https://rubygems.org/')] | gems.map(&:source).flat_map(&:remotes)
+sources = gems.map(&:source).flat_map(&:remotes).uniq
 
 FileUtils.mkdir_p 'nix/gem'
 Dir.chdir 'nix/gem' do

data/shell.nix

@@ -1,10 +1,15 @@
-with import <nixpkgs> {};
+{ pkgs ? import <nixpkgs> {} }:
 
+with pkgs;
+
+let
+  dependencies = import ./nix/dependencies.nix { inherit pkgs; };
+in
 (bundlerEnv {
   name = "iknow-view-models-shell";
   gemdir = ./nix/gem;
 
-  gemConfig = (defaultGemConfig.override { postgresql = postgresql_11; });
+  gemConfig = (defaultGemConfig.override { inherit (dependencies) postgresql; });
 
-  ruby = ruby_2_6;
+  inherit (dependencies) ruby;
 }).env

data/test/.rubocop.yml

@@ -0,0 +1,14 @@
+inherit_from: ../.rubocop.yml
+
+Lint/NestedMethodDefinition:
+  Enabled: false
+Lint/ConstantDefinitionInBlock:
+  Enabled: false
+Layout/MultilineBlockLayout:
+  Enabled: false
+Layout/HashAlignment:
+  Enabled: false
+Layout/BlockEndNewline:
+  Enabled: false
+Style/Semicolon:
+  Enabled: false

data/test/helpers/arvm_test_models.rb

@@ -1,19 +1,22 @@
-require_relative "test_access_control.rb"
+# frozen_string_literal: true
 
-require "iknow_view_models"
-require "view_model/active_record"
-require "view_model/active_record/controller"
+require_relative 'test_access_control'
 
-require "acts_as_manual_list"
+require 'iknow_view_models'
+require 'view_model/active_record'
+require 'view_model/active_record/controller'
+
+require 'acts_as_manual_list'
 
 db_config_path = File.join(File.dirname(__FILE__), '../config/database.yml')
-db_config = YAML.load(File.open(db_config_path))
-raise "Test database configuration missing" unless db_config["test"]
-ActiveRecord::Base.establish_connection(db_config["test"])
+db_config = YAML.safe_load(File.open(db_config_path))
+raise 'Test database configuration missing' unless db_config['test']
+
+ActiveRecord::Base.establish_connection(db_config['test'])
 
 # Remove test tables if any exist
 %w[labels parents children targets poly_ones poly_twos owners
-     grand_parents categories tags parents_tags].each do |t|
+   grand_parents categories tags parents_tags].each do |t|
   ActiveRecord::Base.connection.execute("DROP TABLE IF EXISTS #{t} CASCADE")
 end
 

data/test/helpers/arvm_test_utilities.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support'
 require 'minitest/hooks'
 
@@ -10,7 +12,7 @@ unless ViewModel::Config.configured?
   end
 end
 
-require_relative 'query_logging.rb'
+require_relative 'query_logging'
 
 ActiveSupport::TestCase.include(Minitest::Hooks)
 
@@ -91,7 +93,7 @@ module ARVMTestUtilities
 
   def enable_logging!
     if ENV['DEBUG']
-      ActiveRecord::Base.logger = Logger.new(STDERR)
+      ActiveRecord::Base.logger = Logger.new($stderr)
     end
   end
 
@@ -170,7 +172,7 @@ module ARVMTestUtilities
         {
           ViewModel::ActiveRecord::TYPE_ATTRIBUTE   => type::NAME,
           ViewModel::ActiveRecord::VALUES_ATTRIBUTE => values,
-        }.merge(rest.transform_keys(&:to_s))
+        }.merge(rest.transform_keys(&:to_s)),
       )
     end
 

data/test/helpers/controller_test_helpers.rb

@@ -1,11 +1,15 @@
-require "iknow_view_models"
-require "view_model/active_record"
-require "view_model/active_record/controller"
+# frozen_string_literal: true
 
-require_relative "../helpers/arvm_test_utilities.rb"
-require_relative "../helpers/arvm_test_models.rb"
+require 'iknow_view_models'
+require 'view_model/active_record'
+require 'view_model/active_record/controller'
 
-require "acts_as_manual_list"
+require_relative '../helpers/arvm_test_utilities'
+require_relative '../helpers/arvm_test_models'
+
+require 'action_controller'
+
+require 'acts_as_manual_list'
 
 # models for ARVM controller test
 module ControllerTestModels
@@ -79,11 +83,25 @@ module ControllerTestModels
       end
       define_viewmodel do
         root!
+        self.schema_version = 2
+
         attributes   :name
         associations :label, :target
         association  :children
         association  :poly, viewmodels: [:PolyOne, :PolyTwo]
         association  :category, external: true
+
+        migrates from: 1, to: 2 do
+          up do |view, _refs|
+            if view.has_key?('old_name')
+              view['name'] = view.delete('old_name')
+            end
+          end
+
+          down do |view, _refs|
+            view['old_name'] = view.delete('name')
+          end
+        end
       end
     end
 
@@ -129,27 +147,25 @@ end
 
 ## Dummy Rails Controllers
 class DummyController
-  attr_reader :params, :status
+  attr_reader :params, :headers, :status
 
-  def initialize(**params)
-    # in Rails 5, this will not be a hash, which weakens the value of the test.
-    @params = params.with_indifferent_access
+  def initialize(headers: {}, params: {})
+    @params = ActionController::Parameters.new(params)
+    @headers = ActionDispatch::Http::Headers.from_hash({}).merge!(headers)
     @status = 200
   end
 
   def invoke(method)
-    begin
-      self.public_send(method)
-    rescue Exception => ex
-      handler = self.class.rescue_block(ex.class)
-      case handler
-      when nil
-        raise
-      when Symbol
-        self.send(handler, ex)
-      when Proc
-        self.instance_exec(ex, &handler)
-      end
+    self.public_send(method)
+  rescue StandardError => ex
+    handler = self.class.rescue_block(ex.class)
+    case handler
+    when nil
+      raise
+    when Symbol
+      self.send(handler, ex)
+    when Proc
+      self.instance_exec(ex, &handler)
     end
   end
 
@@ -169,7 +185,8 @@ class DummyController
   end
 
   def json_response
-    raise "Not a JSON response" unless @content_type == 'application/json'
+    raise 'Not a JSON response' unless @content_type == 'application/json'
+
     @response_body
   end
 
@@ -177,9 +194,15 @@ class DummyController
     JSON.parse(json_response)
   end
 
+  # for request.params and request.headers
+  def request
+    self
+  end
+
   class << self
     def inherited(subclass)
       subclass.initialize_rescue_blocks
+      super
     end
 
     def initialize_rescue_blocks
@@ -191,11 +214,10 @@ class DummyController
     end
 
     def rescue_block(type)
-      @rescue_blocks.to_a.reverse.detect { |btype, h| type <= btype }.try(&:last)
+      @rescue_blocks.to_a.reverse.detect { |btype, _h| type <= btype }.try(&:last)
     end
 
-    def etag(*)
-    end
+    def etag(*); end
   end
 end
 
@@ -216,14 +238,15 @@ end
 
 module CallbackTracing
   attr_reader :callback_tracer
+
   delegate :hook_trace, to: :callback_tracer
 
-  def new_deserialize_context(**args)
+  def new_deserialize_context(**_args)
     @callback_tracer ||= CallbackTracer.new
     super(callbacks: [@callback_tracer])
   end
 
-  def new_serialize_context(**args)
+  def new_serialize_context(**_args)
     @callback_tracer ||= CallbackTracer.new
     super(callbacks: [@callback_tracer])
   end
@@ -233,14 +256,14 @@ module ControllerTestControllers
   def before_all
     super
 
-    Class.new(DummyController) do |c|
+    Class.new(DummyController) do |_c|
       Object.const_set(:ParentController, self)
       include ViewModel::ActiveRecord::Controller
       include CallbackTracing
       self.access_control = ViewModel::AccessControl::Open
     end
 
-    Class.new(DummyController) do |c|
+    Class.new(DummyController) do |_c|
       Object.const_set(:ChildController, self)
       include ViewModel::ActiveRecord::Controller
       include CallbackTracing
@@ -248,7 +271,7 @@ module ControllerTestControllers
       nested_in :parent, as: :children
     end
 
-    Class.new(DummyController) do |c|
+    Class.new(DummyController) do |_c|
       Object.const_set(:LabelController, self)
       include ViewModel::ActiveRecord::Controller
       include CallbackTracing
@@ -256,7 +279,7 @@ module ControllerTestControllers
       nested_in :parent, as: :label
     end
 
-    Class.new(DummyController) do |c|
+    Class.new(DummyController) do |_c|
       Object.const_set(:TargetController, self)
       include ViewModel::ActiveRecord::Controller
       include CallbackTracing

data/test/helpers/match_enumerator.rb

@@ -14,6 +14,7 @@ module MiniTest::Assertions
 
     def result
       return false unless @actual.respond_to? :to_a
+
       @extra_items = difference_between_enumerators(@actual, @expected)
       @missing_items = difference_between_enumerators(@expected, @actual)
       @extra_items.empty? & @missing_items.empty?

data/test/helpers/query_logging.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Test mixin that allows queries executed in a block to be introspected.
 #
 # Code run within a `log_queries` block will collect data. Collected data is
@@ -9,7 +11,6 @@
 require 'active_support/subscriber'
 
 module QueryLogging
-
   # ActiveRecord integration
   class QueryLogger < ActiveSupport::Subscriber
     @log              = false

data/test/helpers/test_access_control.rb

@@ -1,5 +1,6 @@
-require "iknow_view_models"
+# frozen_string_literal: true
 
+require 'iknow_view_models'
 
 class TestAccessControl < ViewModel::AccessControl
   attr_accessor :editable_checks, :visible_checks
@@ -41,13 +42,14 @@ class TestAccessControl < ViewModel::AccessControl
   def valid_edit_changes(ref)
     all = all_valid_edit_changes(ref)
     raise "Expected single change for ref '#{ref}'; found #{all}" unless all.size == 1
+
     all.first
   end
 
   def all_valid_edit_changes(ref)
     @valid_edit_checks
-      .select { | cref, _changes| cref == ref }
-      .map    { |_cref,  changes| changes }
+      .select { |cref, _changes| cref == ref }
+      .map    { |_cref, changes| changes }
   end
 
   def was_edited?(ref)

data/test/helpers/viewmodel_spec_helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'view_model'
 require 'view_model/test_helpers'
 
@@ -77,7 +79,7 @@ module ViewModelSpecHelpers
       ViewModel::TestHelpers::ARVMBuilder::Spec.new(
         schema:    ->(t) { t.string :name },
         model:     ->(m) {},
-        viewmodel: ->(v) { root!; attribute :name }
+        viewmodel: ->(_v) { root!; attribute :name },
       )
     end
 
@@ -85,7 +87,7 @@ module ViewModelSpecHelpers
       ViewModel::TestHelpers::ARVMBuilder::Spec.new(
         schema:    ->(t) { t.string :name },
         model:     ->(m) {},
-        viewmodel: ->(v) { attribute :name }
+        viewmodel: ->(_v) { attribute :name },
       )
     end
 
@@ -120,12 +122,12 @@ module ViewModelSpecHelpers
     def model_attributes
       f = subject_association_features
       super.merge(schema:    ->(t) { t.references :child, foreign_key: true },
-                  model:     ->(m) { belongs_to :child, inverse_of: :model, dependent: :destroy },
-                  viewmodel: ->(v) { association :child, **f })
+                  model:     ->(_m) { belongs_to :child, inverse_of: :model, dependent: :destroy },
+                  viewmodel: ->(_v) { association :child, **f })
     end
 
     def child_attributes
-      super.merge(model: ->(m) { has_one :model, inverse_of: :child })
+      super.merge(model: ->(_m) { has_one :model, inverse_of: :child })
     end
 
     # parent depends on child, ensure it's touched first
@@ -139,11 +141,76 @@ module ViewModelSpecHelpers
     end
   end
 
+  module ParentAndBelongsToChildWithMigration
+    extend ActiveSupport::Concern
+    include ViewModelSpecHelpers::ParentAndBelongsToChild
+    def model_attributes
+      super.merge(
+        schema: ->(t) { t.integer :new_field, default: 1, null: false },
+        viewmodel: ->(_v) {
+          self.schema_version = 4
+
+          attribute :new_field
+
+          # add: old_field (one-way)
+          migrates from: 1, to: 2 do
+            down do |view, _refs|
+              view.delete('old_field')
+            end
+          end
+
+          # rename: old_field -> mid_field
+          migrates from: 2, to: 3 do
+            up do |view, _refs|
+              if view.has_key?('old_field')
+                view['mid_field'] = view.delete('old_field') + 1
+              end
+            end
+
+            down do |view, _refs|
+              view['old_field'] = view.delete('mid_field') - 1
+            end
+          end
+
+          # rename: mid_field -> new_field
+          migrates from: 3, to: 4 do
+            up do |view, _refs|
+              if view.has_key?('mid_field')
+                view['new_field'] = view.delete('mid_field') + 1
+              end
+            end
+
+            down do |view, _refs|
+              view['mid_field'] = view.delete('new_field') - 1
+            end
+          end
+        })
+    end
+
+    def child_attributes
+      super.merge(
+        viewmodel: ->(_v) {
+          self.schema_version = 3
+
+          # delete: former_field
+          migrates from: 2, to: 3 do
+            up do |view, _refs|
+              view.delete('former_field')
+            end
+
+            down do |view, _refs|
+              view['former_field'] = 'reconstructed'
+            end
+          end
+        })
+    end
+  end
+
   module ParentAndSharedBelongsToChild
     extend ActiveSupport::Concern
     include ViewModelSpecHelpers::ParentAndBelongsToChild
     def child_attributes
-      super.merge(viewmodel: ->(v) { root! })
+      super.merge(viewmodel: ->(_v) { root! })
     end
   end
 
@@ -157,11 +224,11 @@ module ViewModelSpecHelpers
           t.string :name
           t.integer :next_id
         },
-        model:     ->(m) {
+        model:     ->(_m) {
           belongs_to :next, class_name: self.name, inverse_of: :previous, dependent: :destroy
           has_one :previous, class_name: self.name, foreign_key: :next_id, inverse_of: :next
         },
-        viewmodel: ->(v) {
+        viewmodel: ->(_v) {
           # Not a root
           association :next
           attribute :name
@@ -180,15 +247,15 @@ module ViewModelSpecHelpers
     def model_attributes
       f = subject_association_features
       super.merge(
-        model:     ->(m) { has_one :child, inverse_of: :model, dependent: :destroy },
-        viewmodel: ->(v) { association :child, **f }
+        model:     ->(_m) { has_one :child, inverse_of: :model, dependent: :destroy },
+        viewmodel: ->(_v) { association :child, **f },
       )
     end
 
     def child_attributes
       super.merge(
         schema: ->(t) { t.references :model, foreign_key: true },
-        model:  ->(m) { belongs_to :model, inverse_of: :child }
+        model:  ->(_m) { belongs_to :model, inverse_of: :child },
       )
     end
 
@@ -207,7 +274,7 @@ module ViewModelSpecHelpers
     extend ActiveSupport::Concern
     include ViewModelSpecHelpers::ParentAndHasOneChild
     def child_attributes
-      super.merge(viewmodel: ->(v) { root! })
+      super.merge(viewmodel: ->(_v) { root! })
     end
   end
 
@@ -218,15 +285,15 @@ module ViewModelSpecHelpers
     def model_attributes
       f = subject_association_features
       super.merge(
-        model:     ->(m) { has_many :children, inverse_of: :model, dependent: :destroy },
-        viewmodel: ->(v) { association :children, **f }
+        model:     ->(_m) { has_many :children, inverse_of: :model, dependent: :destroy },
+        viewmodel: ->(_v) { association :children, **f },
       )
     end
 
     def child_attributes
       super.merge(
         schema: ->(t) { t.references :model, foreign_key: true },
-        model:  ->(m) { belongs_to :model, inverse_of: :children }
+        model:  ->(_m) { belongs_to :model, inverse_of: :children },
       )
     end
 
@@ -245,7 +312,7 @@ module ViewModelSpecHelpers
     extend ActiveSupport::Concern
     include ViewModelSpecHelpers::ParentAndHasManyChildren
     def child_attributes
-      super.merge(viewmodel: ->(v) { root! })
+      super.merge(viewmodel: ->(_v) { root! })
     end
   end
 
@@ -271,12 +338,11 @@ module ViewModelSpecHelpers
         table = model.table_name
         model.connection.execute <<-SQL
             ALTER TABLE #{table} ADD CONSTRAINT #{table}_unique_on_model_and_position UNIQUE(model_id, position) DEFERRABLE INITIALLY DEFERRED
-          SQL
+        SQL
       end
     end
   end
 
-
   module ParentAndExternalSharedChild
     extend ActiveSupport::Concern
     include ViewModelSpecHelpers::ParentAndSharedBelongsToChild
@@ -293,15 +359,15 @@ module ViewModelSpecHelpers
     def model_attributes
       f = subject_association_features
       super.merge(
-        model:     ->(m) { has_many :model_children, inverse_of: :model, dependent: :destroy },
-        viewmodel: ->(v) { association :children, through: :model_children, through_order_attr: :position, **f }
+        model:     ->(_m) { has_many :model_children, inverse_of: :model, dependent: :destroy },
+        viewmodel: ->(_v) { association :children, through: :model_children, through_order_attr: :position, **f },
       )
     end
 
     def child_attributes
       super.merge(
-        model: ->(m) { has_many :model_children, inverse_of: :child, dependent: :destroy },
-        viewmodel: ->(v) { root! }
+        model: ->(_m) { has_many :model_children, inverse_of: :child, dependent: :destroy },
+        viewmodel: ->(_v) { root! },
       )
     end