iknow_view_models 3.2.0 → 3.2.5

data/lib/view_model/references.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ViewModel
   # A bucket for configuration, used for serializing and deserializing.
   class References
@@ -17,14 +19,15 @@ class ViewModel
     # under which the data is stored. If the data is not present, will compute
     # it by calling the given block.
     def add_reference(value)
-      if (ref = @ref_by_value[value]).present?
-        ref
-      else
+      ref = @ref_by_value[value]
+
+      unless ref.present?
         ref = new_ref!(value)
         @ref_by_value[value] = ref
         @value_by_ref[ref] = value
-        ref
       end
+
+      ref
     end
 
     def clear!
@@ -41,7 +44,7 @@ class ViewModel
         hash = Digest::SHA256.base64digest("#{vm_ref.viewmodel_class.name}.#{vm_ref.model_id}")
         "ref:h:#{hash}"
       else
-        'ref:i:%06d' % (@last_ref += 1)
+        format('ref:i:%06<count>d', count: (@last_ref += 1))
       end
     end
   end

data/lib/view_model/registry.rb

@@ -6,13 +6,14 @@ class ViewModel::Registry
   DEFERRED_NAME = Object.new
 
   class << self
-    delegate :for_view_name, :register, :default_view_name, :infer_model_class_name, :clear_removed_classes!,
+    delegate :for_view_name, :register, :default_view_name, :infer_model_class_name,
+             :clear_removed_classes!, :all, :roots,
              to: :instance
   end
 
   def initialize
     @lock = Monitor.new
-    @viewmodel_classes_by_name  = {}
+    @viewmodel_classes_by_name = {}
     @deferred_viewmodel_classes = []
   end
 
@@ -33,6 +34,17 @@ class ViewModel::Registry
     end
   end
 
+  def all
+    @lock.synchronize do
+      resolve_deferred_classes
+      @viewmodel_classes_by_name.values
+    end
+  end
+
+  def roots
+    all.select { |c| c.root? }
+  end
+
   def register(viewmodel, as: DEFERRED_NAME)
     @lock.synchronize do
       @deferred_viewmodel_classes << [viewmodel, as]

data/lib/view_model/schemas.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 require 'json_schema'
 
@@ -9,7 +11,8 @@ class ViewModel::Schemas
 
   ID_SCHEMA =
     { 'oneOf' => [{ 'type' => 'integer' },
-                  { 'type' => 'string', 'format' => 'uuid' }] }
+                  { 'type' => 'string', 'format' => 'uuid' },] }.freeze
+
   ID = JsonSchema.parse!(ID_SCHEMA)
 
   VIEWMODEL_UPDATE_SCHEMA =
@@ -20,8 +23,9 @@ class ViewModel::Schemas
                          ViewModel::ID_ATTRIBUTE      => ID_SCHEMA,
                          ViewModel::NEW_ATTRIBUTE     => { 'type' => 'boolean' },
                          ViewModel::VERSION_ATTRIBUTE => { 'type' => 'integer' } },
-      'required'    => [ViewModel::TYPE_ATTRIBUTE]
-    }
+      'required'    => [ViewModel::TYPE_ATTRIBUTE],
+    }.freeze
+
   VIEWMODEL_UPDATE = JsonSchema.parse!(VIEWMODEL_UPDATE_SCHEMA)
 
   VIEWMODEL_REFERENCE_SCHEMA =
@@ -31,7 +35,8 @@ class ViewModel::Schemas
       'properties'           => { ViewModel::REFERENCE_ATTRIBUTE => { 'type' => 'string' } },
       'additionalProperties' => false,
       'required'             => [ViewModel::REFERENCE_ATTRIBUTE],
-    }
+    }.freeze
+
   VIEWMODEL_REFERENCE = JsonSchema.parse!(VIEWMODEL_REFERENCE_SCHEMA)
 
   def self.verify_schema!(schema, value)

data/lib/view_model/serialization_error.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 class ViewModel::SerializationError < ViewModel::AbstractError
   attr_reader :detail
+
   status 400
-  code "SerializationError"
+  code 'SerializationError'
 
   def initialize(detail)
     @detail = detail

data/lib/view_model/serialize_context.rb

@@ -38,10 +38,10 @@ class ViewModel::SerializeContext < ViewModel::TraversalContext
 
     while references.present?
       extract_referenced_views!.each do |ref, value|
-        unless serialized_refs.has_key?(ref)
-          serialized_refs[ref] = Jbuilder.new do |j|
-            ViewModel.serialize(value, j, serialize_context: reference_context)
-          end
+        next if serialized_refs.has_key?(ref)
+
+        serialized_refs[ref] = Jbuilder.new do |j|
+          ViewModel.serialize(value, j, serialize_context: reference_context)
         end
       end
     end

data/lib/view_model/test_helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ##
 # Helpers useful for writing tests for viewmodel implementations
 module ViewModel::TestHelpers
@@ -51,11 +53,13 @@ module ViewModel::TestHelpers
 
   def assert_consistent_record(viewmodel, been_there: Set.new)
     return if been_there.include?(viewmodel.model)
+
     been_there << viewmodel.model
 
-    if viewmodel.is_a?(ViewModel::ActiveRecord)
+    case viewmodel
+    when ViewModel::ActiveRecord
       assert_model_represents_database(viewmodel.model, been_there: been_there)
-    elsif viewmodel.is_a?(ViewModel::Record)
+    when ViewModel::Record
       viewmodel.class._members.each do |name, attribute_data|
         if attribute_data.attribute_viewmodel
           assert_consistent_record(viewmodel.send(name), been_there: been_there)
@@ -66,6 +70,7 @@ module ViewModel::TestHelpers
 
   def assert_model_represents_database(model, been_there: Set.new)
     return if been_there.include?(model)
+
     been_there << model
 
     refute(model.new_record?, 'model represents database entity')
@@ -83,7 +88,7 @@ module ViewModel::TestHelpers
       next unless association.loaded?
 
       case
-      when association.target == nil
+      when association.target.nil?
         assert_nil(database_model.association(reflection.name).target,
                    'in memory nil association matches database')
       when reflection.collection?

data/lib/view_model/test_helpers/arvm_builder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ViewModel::TestHelpers::ARVMBuilder
   attr_reader :name, :model, :viewmodel, :namespace
 
@@ -46,16 +48,16 @@ class ViewModel::TestHelpers::ARVMBuilder
       instance_eval(&block)
     end
 
-    raise "Model not created in ARVMBuilder"     unless model
-    raise "Schema not created in ARVMBuilder"    unless model.table_exists?
-    raise "ViewModel not created in ARVMBuilder" unless (viewmodel || @no_viewmodel)
+    raise 'Model not created in ARVMBuilder'     unless model
+    raise 'Schema not created in ARVMBuilder'    unless model.table_exists?
+    raise 'ViewModel not created in ARVMBuilder' unless viewmodel || @no_viewmodel
 
     # Force the realization of the view model into the library's lookup
     # table. If this doesn't happen the library may have conflicting entries in
     # the deferred table, and will allow viewmodels to leak between tests.
     unless @no_viewmodel || !(@viewmodel < ViewModel::Record)
       resolved = ViewModel::Registry.for_view_name(viewmodel.view_name)
-      raise "Failed to register expected new class!" unless resolved == @viewmodel
+      raise 'Failed to register expected new class!' unless resolved == @viewmodel
     end
   end
 
@@ -70,7 +72,7 @@ class ViewModel::TestHelpers::ARVMBuilder
   private
 
   def viewmodel_name
-    self.name + "View"
+    self.name + 'View'
   end
 
   def define_schema(&block)
@@ -84,10 +86,11 @@ class ViewModel::TestHelpers::ARVMBuilder
 
   def define_model(&block)
     model_name = name
-    _namespace = namespace
-    @model = Class.new(@model_base) do |c|
-      raise "Model already defined: #{model_name}" if _namespace.const_defined?(model_name, false)
-      _namespace.const_set(model_name, self)
+    model_namespace = namespace
+    @model = Class.new(@model_base) do |_c|
+      raise "Model already defined: #{model_name}" if model_namespace.const_defined?(model_name, false)
+
+      model_namespace.const_set(model_name, self)
       class_eval(&block)
       reset_column_information
     end
@@ -96,13 +99,15 @@ class ViewModel::TestHelpers::ARVMBuilder
 
   def define_viewmodel(&block)
     vm_name = viewmodel_name
-    _namespace = namespace
-    @viewmodel = Class.new(@viewmodel_base) do |c|
-      raise "Viewmodel alreay defined: #{vm_name}" if _namespace.const_defined?(vm_name, false)
-      _namespace.const_set(vm_name, self)
+    vm_namespace = namespace
+    @viewmodel = Class.new(@viewmodel_base) do |_c|
+      raise "Viewmodel alreay defined: #{vm_name}" if vm_namespace.const_defined?(vm_name, false)
+
+      vm_namespace.const_set(vm_name, self)
       class_eval(&block)
     end
-    raise "help help" if @viewmodel.name.nil?
+    raise 'help help' if @viewmodel.name.nil?
+
     @viewmodel
   end
 

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/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
@@ -94,7 +98,7 @@ module ControllerTestModels
             end
           end
 
-          down do |view, refs|
+          down do |view, _refs|
             view['old_name'] = view.delete('name')
           end
         end
@@ -143,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
 
@@ -183,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
 
@@ -191,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
@@ -205,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
 
@@ -230,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
@@ -247,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
@@ -262,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
@@ -270,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