iknow_view_models 3.1.8 → 3.2.4

data/lib/view_model/active_record/visitor.rb

@@ -91,5 +91,4 @@ class ViewModel::ActiveRecord::Visitor
   def reset_state!
     @ignored_associations = Set.new
   end
-
 end

data/lib/view_model/after_transaction_runner.rb

@@ -38,7 +38,6 @@ module ViewModel::AfterTransactionRunner
     end
   end
 
-
   # Override to tie to a specific connection.
   def connection
     ActiveRecord::Base.connection

data/lib/view_model/callbacks.rb

@@ -79,7 +79,7 @@ module ViewModel::Callbacks
             end
           SRC
         else
-          def self.create(callbacks, view, context)
+          def self.create(callbacks, view, context) # rubocop:disable Lint/NestedMethodDefinition
             self.new(callbacks, view, context)
           end
         end
@@ -105,6 +105,7 @@ module ViewModel::Callbacks
     define_singleton_method(:class_callbacks) { base_callbacks }
     define_singleton_method(:all_callbacks) do |&block|
       return to_enum(__method__) unless block
+
       block.call(base_callbacks)
     end
   end
@@ -115,6 +116,7 @@ module ViewModel::Callbacks
       subclass.define_singleton_method(:class_callbacks) { subclass_callbacks }
       subclass.define_singleton_method(:all_callbacks) do |&block|
         return to_enum(__method__) unless block
+
         super(&block)
         block.call(subclass_callbacks)
       end

data/lib/view_model/controller.rb

@@ -88,6 +88,7 @@ module ViewModel::Controller
       if data.blank?
         raise ViewModel::Error.new(status: 400, detail: "No data submitted: #{data.inspect}")
       end
+
       data.map { |el| _extract_param_hash(el) }
     else
       _extract_param_hash(data)
@@ -129,9 +130,18 @@ module ViewModel::Controller
   # untouched. Requires a MultiJson adapter other than ActiveSupport's
   # (modified) JsonGem.
   class CompiledJson
-    def initialize(s);  @s = s; end
-    def to_json(*args); @s;     end
-    def to_s;           @s;     end
+    def initialize(s)
+      @s = s
+    end
+
+    def to_json(*_args)
+      @s
+    end
+
+    def to_s
+      @s
+    end
+
     undef_method :as_json
   end
 

data/lib/view_model/deserialization_error.rb

@@ -15,13 +15,14 @@ class ViewModel
       unless nodes.all? { |n| n.viewmodel_class == first }
         raise ArgumentError.new("All nodes must be of the same type for #{self.class.name}")
       end
+
       first
     end
 
     # A collection of DeserializationErrors
     class Collection < ViewModel::AbstractErrorCollection
-      title "Error(s) occurred during deserialization"
-      code  "DeserializationError.Collection"
+      title 'Error(s) occurred during deserialization'
+      code  'DeserializationError.Collection'
 
       def detail
         "Error(s) occurred during deserialization: #{cause_details}"
@@ -33,7 +34,7 @@ class ViewModel
     class InvalidRequest < DeserializationError
       # Abstract
       status 400
-      title "Invalid request"
+      title 'Invalid request'
     end
 
     # There has been an unexpected internal failure of the ViewModel library.
@@ -145,6 +146,7 @@ class ViewModel
     # association.
     class InvalidAssociationType < InvalidRequest
       attr_reader :association, :target_type
+
       def initialize(association, target_type, node)
         @association = association
         @target_type = target_type
@@ -198,7 +200,7 @@ class ViewModel
       end
 
       def detail
-        errors = missing_nodes.map(&:to_s).join(", ")
+        errors = missing_nodes.map(&:to_s).join(', ')
         "Couldn't find requested member node(s) in association '#{association}': "\
         "#{errors}"
       end
@@ -218,7 +220,7 @@ class ViewModel
       end
 
       def detail
-        "Duplicate views for the same '#{type}' specified: "+ nodes.map(&:to_s).join(", ")
+        "Duplicate views for the same '#{type}' specified: " + nodes.map(&:to_s).join(', ')
       end
 
       def meta
@@ -235,14 +237,14 @@ class ViewModel
       end
 
       def detail
-        "Multiple parents attempted to claim the same owned '#{association_name}' reference: " + nodes.map(&:to_s).join(", ")
+        "Multiple parents attempted to claim the same owned '#{association_name}' reference: " + nodes.map(&:to_s).join(', ')
       end
     end
 
     class ParentNotFound < NotFound
       def detail
-        "Could not resolve release from previous parent for the following owned viewmodel(s): " +
-          nodes.map(&:to_s).join(", ")
+        'Could not resolve release from previous parent for the following owned viewmodel(s): ' +
+          nodes.map(&:to_s).join(', ')
       end
     end
 
@@ -284,7 +286,7 @@ class ViewModel
 
     class ReadOnlyType < DeserializationError
       status 400
-      detail "Deserialization not defined for view type"
+      detail 'Deserialization not defined for view type'
     end
 
     class InvalidAttributeType < InvalidRequest
@@ -326,7 +328,7 @@ class ViewModel
       status 400
 
       def detail
-        errors = nodes.map(&:to_s).join(", ")
+        errors = nodes.map(&:to_s).join(', ')
         "Optimistic lock failure updating nodes: #{errors}"
       end
     end
@@ -408,8 +410,9 @@ class ViewModel
 
         private
 
-        QUOTED_IDENTIFIER   = /\A"(?:[^"]|"")+"/
-        UNQUOTED_IDENTIFIER = /\A(?:\p{Alpha}|_)(?:\p{Alnum}|_)*/
+        QUOTED_IDENTIFIER   = /\A"(?:[^"]|"")+"/.freeze
+        UNQUOTED_IDENTIFIER = /\A(?:\p{Alpha}|_)(?:\p{Alnum}|_)*/.freeze
+
         def parse_identifier(stream)
           if (identifier = stream.slice!(UNQUOTED_IDENTIFIER))
             identifier

data/lib/view_model/error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Abstract base for renderable errors in ViewModel-based APIs. Errors of this
 # type will be caught by ViewModel controllers and rendered in a standard format
 # by ViewModel::ErrorView, which loosely follows errors in JSON-API.
@@ -6,7 +8,7 @@ class ViewModel::AbstractError < StandardError
     # Brief DSL for quickly defining constant attribute values in subclasses
     [:detail, :status, :title, :code].each do |attribute|
       define_method(attribute) do |x|
-        define_method(attribute){ x }
+        define_method(attribute) { x }
       end
     end
   end
@@ -25,7 +27,7 @@ class ViewModel::AbstractError < StandardError
 
   # Human-readable reason for use displaying this error.
   def detail
-    "ViewModel::AbstractError"
+    'ViewModel::AbstractError'
   end
 
   # HTTP status code most appropriate for this error
@@ -40,7 +42,7 @@ class ViewModel::AbstractError < StandardError
 
   # Unique symbol identifying this error type
   def code
-    "ViewModel.AbstractError"
+    'ViewModel.AbstractError'
   end
 
   # Additional information specific to this error type.
@@ -74,8 +76,6 @@ class ViewModel::AbstractError < StandardError
 
   protected
 
-
-
   def format_references(viewmodel_refs)
     viewmodel_refs.map do |viewmodel_ref|
       format_reference(viewmodel_ref)
@@ -85,7 +85,7 @@ class ViewModel::AbstractError < StandardError
   def format_reference(viewmodel_ref)
     {
       ViewModel::TYPE_ATTRIBUTE => viewmodel_ref.viewmodel_class.view_name,
-      ViewModel::ID_ATTRIBUTE   => viewmodel_ref.model_id
+      ViewModel::ID_ATTRIBUTE   => viewmodel_ref.model_id,
     }
   end
 end
@@ -100,12 +100,13 @@ class ViewModel::AbstractErrorWithBlame < ViewModel::AbstractError
     unless @nodes.all? { |n| n.is_a?(ViewModel::Reference) }
       raise ArgumentError.new("#{self.class.name}: 'blame_nodes' must all be of type ViewModel::Reference")
     end
+
     super()
   end
 
   def meta
     {
-      nodes: format_references(nodes)
+      nodes: format_references(nodes),
     }
   end
 end
@@ -117,8 +118,9 @@ class ViewModel::AbstractErrorCollection < ViewModel::AbstractError
   def initialize(causes)
     @causes = Array.wrap(causes)
     unless @causes.present?
-      raise ArgumentError.new("A collection must have at least one cause")
+      raise ArgumentError.new('A collection must have at least one cause')
     end
+
     super()
   end
 
@@ -151,7 +153,7 @@ class ViewModel::AbstractErrorCollection < ViewModel::AbstractError
   protected
 
   def cause_details
-    causes.map(&:detail).join("; ")
+    causes.map(&:detail).join('; ')
   end
 end
 
@@ -180,7 +182,7 @@ end
 class ViewModel::Error < ViewModel::AbstractError
   attr_reader :detail, :status, :title, :code, :meta
 
-  def initialize(status: 400, detail: "ViewModel Error", title: nil, code: nil, meta: {})
+  def initialize(status: 400, detail: 'ViewModel Error', title: nil, code: nil, meta: {})
     @detail = detail
     @status = status
     @title  = title

data/lib/view_model/error_view.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'view_model/record'
 
 # ViewModel for rendering ViewModel::AbstractErrors
@@ -10,7 +12,7 @@ class ViewModel::ErrorView < ViewModel::Record
     def serialize_view(json, serialize_context: nil)
       json.set! :class, exception.class.name
       json.backtrace exception.backtrace
-      if cause = exception.cause
+      if (cause = exception.cause)
         json.cause do
           json.set! :class, cause.class.name
           json.backtrace cause.backtrace

data/lib/view_model/migratable_view.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'view_model/migration'
+require 'view_model/migrator'
+
+require 'rgl/adjacency'
+require 'rgl/dijkstra'
+
+module ViewModel::MigratableView
+  extend ActiveSupport::Concern
+
+  class_methods do
+    def inherited(base)
+      super
+      base.initialize_as_migratable_view
+    end
+
+    def initialize_as_migratable_view
+      @migrations_lock   = Monitor.new
+      @migration_classes = {}
+      @migration_paths   = {}
+      @realized_migration_paths = true
+    end
+
+    def migration_path(from:, to:)
+      @migrations_lock.synchronize do
+        realize_paths! unless @realized_migration_paths
+
+        migrations = @migration_paths.fetch([from, to]) do
+          raise ViewModel::Migration::NoPathError.new(self, from, to)
+        end
+
+        migrations
+      end
+    end
+
+    private
+
+    # Define a migration on this viewmodel
+    def migrates(from:, to:, &block)
+      @migrations_lock.synchronize do
+        builder = ViewModel::Migration::Builder.new
+        builder.instance_exec(&block)
+        @migration_classes[[from, to]] = builder.build!
+        @realized_migration_paths = false
+      end
+    end
+
+    # Internal: find and record possible paths to the current schema version.
+    def realize_paths!
+      @migration_paths.clear
+
+      graph = RGL::DirectedAdjacencyGraph.new
+
+      # Add edges backwards, as we care about paths from the latest version
+      @migration_classes.each_key do |from, to|
+        graph.add_edge(to, from)
+      end
+
+      paths = graph.dijkstra_shortest_paths(Hash.new { 1 }, self.schema_version)
+
+      paths.each do |target_version, path|
+        next if path.length == 1
+
+        # Store the path forwards rather than backwards
+        path_migration_classes = path.reverse.each_cons(2).map do |from, to|
+          @migration_classes.fetch([from, to])
+        end
+
+        key = [target_version, schema_version]
+
+        @migration_paths[key] = path_migration_classes.map(&:new)
+      end
+
+      @realized_paths = true
+    end
+  end
+end

data/lib/view_model/migration.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+class ViewModel::Migration
+  require 'view_model/migration/no_path_error'
+  require 'view_model/migration/one_way_error'
+  require 'view_model/migration/unspecified_version_error'
+
+  def up(view, _references)
+    raise ViewModel::Migration::OneWayError.new(view[ViewModel::TYPE_ATTRIBUTE], :up)
+  end
+
+  def down(view, _references)
+    raise ViewModel::Migration::OneWayError.new(view[ViewModel::TYPE_ATTRIBUTE], :down)
+  end
+
+  # Tiny DSL for defining migration classes
+  class Builder
+    def initialize
+      @up_block = nil
+      @down_block = nil
+    end
+
+    def build!
+      migration = Class.new(ViewModel::Migration)
+      migration.define_method(:up, &@up_block) if @up_block
+      migration.define_method(:down, &@down_block) if @down_block
+      migration
+    end
+
+    private
+
+    def up(&block)
+      check_signature!(block)
+      @up_block = block
+    end
+
+    def down(&block)
+      check_signature!(block)
+      @down_block = block
+    end
+
+    def check_signature!(block)
+      unless block.arity == 2
+        raise RuntimeError.new('Illegal signature for migration method, must be (view, references)')
+      end
+    end
+  end
+end

data/lib/view_model/migration/no_path_error.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+class ViewModel::Migration::NoPathError < ViewModel::AbstractError
+  attr_reader :vm_name, :from, :to
+
+  status 400
+
+  def initialize(viewmodel, from, to)
+    @vm_name = viewmodel.view_name
+    @from = from
+    @to = to
+    super()
+  end
+
+  def detail
+    "No migration path for #{vm_name} from #{from} to #{to}"
+  end
+
+  def meta
+    {
+      viewmodel: vm_name,
+      from: from,
+      to: to,
+    }
+  end
+end

data/lib/view_model/migration/one_way_error.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+class ViewModel::Migration::OneWayError < ViewModel::AbstractError
+  attr_reader :vm_name, :direction
+
+  status 400
+
+  def initialize(vm_name, direction)
+    @vm_name = vm_name
+    @direction = direction
+    super()
+  end
+
+  def detail
+    "One way migration for #{vm_name} cannot be migrated #{direction}"
+  end
+
+  def meta
+    {
+      viewmodel: vm_name,
+      direction: direction,
+    }
+  end
+end