serega 0.21.0 → 0.30.0

data/lib/serega/plugins/batch/lib/loaders.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-class Serega
-  module SeregaPlugins
-    module Batch
-      # Lists batch loaders registered during serialization
-      class SeregaBatchLoaders
-        # BatchLoaders instance methods
-        module InstanceMethods
-          #
-          # Initializes or fetches already initialized batch loader
-          #
-          # @param plan_point [Serega::SeregaPlanPoint] current plan point
-          # @param object_serializer[Serega::SeregaObjectSerializer] current object serializer
-          #
-          # @return [Serega::SeregaPlugins::Batch::SeregaBatchLoader] Batch Loader
-          #
-          def get(plan_point, object_serializer)
-            batch_loaders[plan_point] ||= self.class.serializer_class::SeregaBatchLoader.new(object_serializer, plan_point)
-          end
-
-          #
-          # Loads all registered batches and removes them from registered list
-          #
-          def load_all
-            return unless defined?(@batch_loaders)
-
-            while (_point, batch_loader = batch_loaders.shift)
-              batch_loader.load
-            end
-          end
-
-          private
-
-          def batch_loaders
-            @batch_loaders ||= {}.compare_by_identity
-          end
-        end
-
-        include InstanceMethods
-        extend Serega::SeregaHelpers::SerializerClassHelper
-      end
-    end
-  end
-end

data/lib/serega/plugins/batch/lib/modules/attribute.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-class Serega
-  module SeregaPlugins
-    module Batch
-      #
-      # Serega::SeregaAttribute additional/patched class methods
-      #
-      # @see Serega::SeregaAttribute
-      #
-      module AttributeInstanceMethods
-        #
-        # @return [nil, Hash] :batch option
-        #
-        attr_reader :batch
-
-        private
-
-        def set_normalized_vars(normalizer)
-          super
-          @batch = normalizer.batch
-        end
-      end
-    end
-  end
-end

data/lib/serega/plugins/batch/lib/modules/attribute_normalizer.rb

@@ -1,78 +0,0 @@
-# frozen_string_literal: true
-
-class Serega
-  module SeregaPlugins
-    module Batch
-      #
-      # SeregaAttributeNormalizer additional/patched instance methods
-      #
-      # @see SeregaAttributeNormalizer::AttributeInstanceMethods
-      #
-      module AttributeNormalizerInstanceMethods
-        #
-        # Returns normalized attribute :batch option with prepared :key and
-        # :default options. Option :loader will be prepared at serialization
-        # time as loaders are usually defined after attributes.
-        #
-        # @return [Hash] attribute :batch normalized options
-        #
-        def batch
-          return @batch if instance_variable_defined?(:@batch)
-
-          @batch = prepare_batch
-        end
-
-        private
-
-        #
-        # Patch for original `prepare_hide` method
-        #
-        # Marks attribute hidden if auto_hide option was set and attribute has batch loader
-        #
-        def prepare_hide
-          res = super
-          return res unless res.nil?
-
-          if batch
-            self.class.serializer_class.config.batch.auto_hide || nil
-          end
-        end
-
-        def prepare_batch
-          batch = init_opts[:batch]
-          return unless batch
-
-          loader = prepare_batch_loader(batch[:loader])
-
-          id_method = batch[:id_method] || self.class.serializer_class.config.batch.id_method
-          id_method = prepare_batch_id_method(id_method)
-
-          {loader: loader, id_method: id_method, default: default}
-        end
-
-        def prepare_batch_id_method(id_method)
-          return proc { |object| object.public_send(id_method) } if id_method.is_a?(Symbol)
-
-          params_count = SeregaUtils::ParamsCount.call(id_method, max_count: 2)
-          case params_count
-          when 0 then proc { id_method.call }
-          when 1 then proc { |object| id_method.call(object) }
-          else id_method
-          end
-        end
-
-        def prepare_batch_loader(loader)
-          loader = self.class.serializer_class.config.batch.loaders.fetch(loader) if loader.is_a?(Symbol)
-
-          params_count = SeregaUtils::ParamsCount.call(loader, max_count: 3)
-          case params_count
-          when 0 then proc { loader.call }
-          when 1 then proc { |object| loader.call(object) }
-          when 2 then proc { |object, context| loader.call(object, context) }
-          else loader
-          end
-        end
-      end
-    end
-  end
-end

data/lib/serega/plugins/batch/lib/modules/check_attribute_params.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-class Serega
-  module SeregaPlugins
-    module Batch
-      #
-      # Serega::SeregaValidations::CheckAttributeParams additional/patched class methods
-      #
-      # @see Serega::SeregaValidations::CheckAttributeParams
-      #
-      module CheckAttributeParamsInstanceMethods
-        private
-
-        def check_opts
-          super
-
-          CheckOptBatch.call(opts, block, self.class.serializer_class)
-        end
-      end
-    end
-  end
-end

data/lib/serega/plugins/batch/lib/modules/config.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-class Serega
-  module SeregaPlugins
-    module Batch
-      #
-      # Config class additional/patched instance methods
-      #
-      # @see Serega::SeregaConfig
-      #
-      module ConfigInstanceMethods
-        #
-        # Returns all batch loaders registered for current serializer
-        #
-        # @return [Serega::SeregaPlugins::Batch::BatchConfig] configuration for batch loaded attributes
-        #
-        def batch
-          @batch ||= BatchConfig.new(opts.fetch(:batch))
-        end
-      end
-    end
-  end
-end

data/lib/serega/plugins/batch/lib/modules/object_serializer.rb

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-class Serega
-  module SeregaPlugins
-    module Batch
-      #
-      # SeregaObjectSerializer additional/patched class methods
-      #
-      # @see Serega::SeregaObjectSerializer
-      #
-      module SeregaObjectSerializerInstanceMethods
-        private
-
-        def attach_value(object, point, container)
-          batch = point.batch
-          return super unless batch
-
-          remember_key_for_batch_loading(batch, object, point, container)
-        end
-
-        def remember_key_for_batch_loading(batch, object, point, container)
-          id = batch[:id_method].call(object, context)
-          batch_loader(point).remember(id, container)
-          container[point.name] = nil # Reserve attribute place in resulted hash. We will set correct value later
-        end
-
-        def batch_loader(point)
-          batch_loaders = opts[:batch_loaders]
-          raise_batch_plugin_for_serializer_not_defined(point) unless batch_loaders
-          batch_loaders.get(point, self)
-        end
-
-        def raise_batch_plugin_for_serializer_not_defined(point)
-          root_plan = point.plan
-          root_plan = plan.parent_plan_point.plan while root_plan.parent_plan_point
-          current_serializer = root_plan.serializer_class
-          nested_serializer = self.class.serializer_class
-
-          raise SeregaError,
-            "Plugin :batch must be added to current serializer (#{current_serializer})" \
-            " to load attributes with :batch option in nested serializer (#{nested_serializer})"
-        end
-      end
-    end
-  end
-end

data/lib/serega/plugins/batch/lib/modules/plan_point.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-class Serega
-  module SeregaPlugins
-    module Batch
-      #
-      # Serega::SeregaPlanPoint additional/patched class methods
-      #
-      # @see SeregaAttribute
-      #
-      module PlanPointInstanceMethods
-        #
-        # Returns attribute :batch option with prepared loader
-        # @return [Hash] attribute :batch option
-        #
-        def batch
-          attribute.batch
-        end
-      end
-    end
-  end
-end

data/lib/serega/plugins/batch/lib/plugins_extensions/activerecord_preloads.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-class Serega
-  module SeregaPlugins
-    module Batch
-      #
-      # Extensions (mini-plugins) that are enabled when :batch plugin used with other plugins
-      #
-      module PluginsExtensions
-        #
-        # Extension that is used when :batch plugin used with :active_record_preloads plugin
-        #
-        module ActiveRecordPreloads
-          #
-          # BatchLoader additional/patched instance methods
-          #
-          # @see Serega::SeregaPlugins::Batch::SeregaBatchLoader
-          #
-          module BatchLoaderInstanceMethods
-            private
-
-            # Preloads required associations to batch-loaded records
-            def keys_values
-              data = super
-
-              if point.child_plan
-                associations = point.preloads
-                return data if associations.empty?
-
-                records = data.values
-                records.flatten!(1)
-
-                ActiverecordPreloads::Preloader.preload(records, associations)
-              end
-
-              data
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/serega/plugins/batch/lib/plugins_extensions/formatters.rb

@@ -1,54 +0,0 @@
-# frozen_string_literal: true
-
-class Serega
-  module SeregaPlugins
-    module Batch
-      #
-      # Extensions (mini-plugins) that are enabled when :batch plugin used with other plugins
-      #
-      module PluginsExtensions
-        #
-        # Extension that is used when batch plugin used with :formatters plugin
-        #
-        module Formatters
-          #
-          # BatchLoader additional/patched instance methods
-          #
-          # @see Serega::SeregaPlugins::Batch::SeregaBatchLoader
-          #
-          module BatchLoaderInstanceMethods
-            private
-
-            # Format values after they are prepared
-            def keys_values
-              data = super
-
-              formatter = point.attribute.formatter
-              data.transform_values! { |value| formatter.call(value) } if formatter
-
-              data
-            end
-          end
-
-          #
-          # SeregaAttribute additional/patched instance methods
-          #
-          # @see Serega::SeregaAttribute
-          #
-          module SeregaAttributeInstanceMethods
-            # Normalized formatter block or callable instance
-            # @return [#call, nil] Normalized formatter block or callable instance
-            attr_reader :formatter
-
-            private
-
-            def set_normalized_vars(normalizer)
-              super
-              @formatter = normalizer.formatter
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/serega/plugins/batch/lib/plugins_extensions/if.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-class Serega
-  module SeregaPlugins
-    module Batch
-      #
-      # Extensions (mini-plugins) that are enabled when :batch plugin used with other plugins
-      #
-      module PluginsExtensions
-        #
-        # Extension that is used when :if plugin is loaded
-        #
-        module If
-          #
-          # SeregaObjectSerializer additional/patched class methods
-          #
-          # @see Serega::SeregaObjectSerializer
-          #
-          module ObjectSerializerInstanceMethods123
-            private
-
-            # Removes key added by `batch` plugin at the start of serialization to preserve attributes ordering
-            def attach_final_value(value, point, container)
-              container.delete(point.name) if super == SeregaPlugins::If::KEY_SKIPPED
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/serega/plugins/batch/lib/plugins_extensions/preloads.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-class Serega
-  module SeregaPlugins
-    module Batch
-      #
-      # Extensions (mini-plugins) that are enabled when :batch plugin used with other plugins
-      #
-      module PluginsExtensions
-        #
-        # Extension that is used when :preloads plugin is loaded
-        #
-        module Preloads
-          #
-          # Attribute additional/patched instance methods
-          #
-          # @see Serega::SeregaPlugins::Preloads::AttributeNormalizerInstanceMethods
-          #
-          module AttributeNormalizerInstanceMethods
-            private
-
-            # Do not add any preloads automatically when batch option provided
-            def prepare_preloads
-              opts = init_opts
-              return if opts.key?(:batch) && !opts.key?(:preload)
-
-              super
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/serega/plugins/batch/lib/validations/check_batch_opt_id_method.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-class Serega
-  module SeregaPlugins
-    module Batch
-      #
-      # Validator for option :id_method in attribute :batch option
-      #
-      class CheckBatchOptIdMethod
-        class << self
-          #
-          # Checks option :id_method of attribute :batch option
-          #
-          # @param id [nil, #call] Attribute :batch option :id_method
-          #
-          # @raise [SeregaError] validation error
-          #
-          # @return [void]
-          #
-          def call(id)
-            return if id.is_a?(Symbol)
-
-            raise SeregaError, must_be_callable unless id.respond_to?(:call)
-
-            SeregaValidations::Utils::CheckExtraKeywordArg.call(id, "batch option :id_method")
-            params_count = SeregaUtils::ParamsCount.call(id, max_count: 2)
-            raise SeregaError, params_count_error if params_count > 2
-          end
-
-          private
-
-          def params_count_error
-            "Invalid :batch option :id_method. It can accept maximum 2 parameters (object, context)"
-          end
-
-          def must_be_callable
-            "Invalid :batch option :id_method. It must be a Symbol, a Proc or respond to #call"
-          end
-        end
-      end
-    end
-  end
-end

data/lib/serega/plugins/batch/lib/validations/check_batch_opt_loader.rb

@@ -1,59 +0,0 @@
-# frozen_string_literal: true
-
-class Serega
-  module SeregaPlugins
-    module Batch
-      #
-      # Validator for option :loader in attribute :batch option
-      #
-      class CheckBatchOptLoader
-        class << self
-          #
-          # Checks option :loader of attribute :batch option
-          #
-          # @param loader [nil, #call] Attribute :batch option :loader
-          #
-          # @raise [SeregaError] validation error
-          #
-          # @return [void]
-          #
-          def call(loader, serializer_class)
-            if loader.is_a?(Symbol)
-              check_symbol(loader, serializer_class)
-            else
-              check_callable(loader)
-            end
-          end
-
-          private
-
-          def check_symbol(loader_name, serializer_class)
-            defined_loaders = serializer_class.config.batch.loaders
-            return if defined_loaders[loader_name]
-
-            raise SeregaError, <<~ERR.strip
-              Please define loader before adding it to attribute.
-                Example: `config.batch.define(:#{loader_name}) { |ids| ... }`
-            ERR
-          end
-
-          def check_callable(loader)
-            raise SeregaError, must_be_callable unless loader.respond_to?(:call)
-
-            SeregaValidations::Utils::CheckExtraKeywordArg.call(loader, ":batch option :loader")
-            params_count = SeregaUtils::ParamsCount.call(loader, max_count: 3)
-            raise SeregaError, params_count_error if params_count > 3
-          end
-
-          def params_count_error
-            "Invalid :batch option :loader. It can accept maximum 3 parameters (ids, context, plan)"
-          end
-
-          def must_be_callable
-            "Invalid :batch option :loader. It must be a Symbol, a Proc or respond to :call"
-          end
-        end
-      end
-    end
-  end
-end

data/lib/serega/plugins/batch/lib/validations/check_opt_batch.rb

@@ -1,62 +0,0 @@
-# frozen_string_literal: true
-
-class Serega
-  module SeregaPlugins
-    module Batch
-      #
-      # Attribute `:batch` option validator
-      #
-      class CheckOptBatch
-        class << self
-          #
-          # Checks attribute :batch  option
-          #
-          # @param opts [Hash] Attribute options
-          #
-          # @raise [SeregaError] Attribute validation error
-          #
-          # @return [void]
-          #
-          def call(opts, block, serializer_class)
-            return unless opts.key?(:batch)
-
-            SeregaValidations::Utils::CheckOptIsHash.call(opts, :batch)
-
-            batch = opts[:batch]
-            SeregaValidations::Utils::CheckAllowedKeys.call(batch, %i[id_method loader], :batch)
-
-            check_batch_opt_id_method(batch, serializer_class)
-            check_batch_opt_loader(batch, serializer_class)
-            check_usage_with_other_params(opts, block)
-          end
-
-          private
-
-          def check_batch_opt_id_method(batch, serializer_class)
-            return if !batch.key?(:id_method) && serializer_class.config.batch.id_method
-
-            id_method = batch[:id_method]
-            raise SeregaError, "Option :id_method must present inside :batch option" unless id_method
-
-            CheckBatchOptIdMethod.call(id_method)
-          end
-
-          def check_batch_opt_loader(batch, serializer_class)
-            loader = batch[:loader]
-            raise SeregaError, "Option :loader must present inside :batch option" unless loader
-
-            CheckBatchOptLoader.call(loader, serializer_class)
-          end
-
-          def check_usage_with_other_params(opts, block)
-            raise SeregaError, "Option :batch can not be used together with option :method" if opts.key?(:method)
-            raise SeregaError, "Option :batch can not be used together with option :value" if opts.key?(:value)
-            raise SeregaError, "Option :batch can not be used together with option :const" if opts.key?(:const)
-            raise SeregaError, "Option :batch can not be used together with option :delegate" if opts.key?(:delegate)
-            raise SeregaError, "Option :batch can not be used together with block" if block
-          end
-        end
-      end
-    end
-  end
-end

data/lib/serega/plugins/preloads/lib/format_user_preloads.rb

@@ -1,60 +0,0 @@
-# frozen_string_literal: true
-
-class Serega
-  module SeregaPlugins
-    module Preloads
-      #
-      # Utility that helps to transform user provided preloads to hash
-      #
-      class FormatUserPreloads
-        class << self
-          #
-          # Transforms user provided preloads to hash
-          #
-          # @param value [Array,Hash,String,Symbol,nil,false] preloads
-          #
-          # @return [Hash] preloads transformed to hash
-          #
-          def call(value)
-            case value
-            when Array then array_to_hash(value)
-            when FalseClass then nil_to_hash(value)
-            when Hash then hash_to_hash(value)
-            when NilClass then nil_to_hash(value)
-            when String then string_to_hash(value)
-            when Symbol then symbol_to_hash(value)
-            else raise Serega::SeregaError,
-              "Preload option value can consist from Symbols, Arrays, Hashes (#{value.class} #{value.inspect} was provided)"
-            end
-          end
-
-          private
-
-          def array_to_hash(values)
-            values.each_with_object({}) do |value, obj|
-              obj.merge!(call(value))
-            end
-          end
-
-          def hash_to_hash(values)
-            values.each_with_object({}) do |(key, value), obj|
-              obj[key.to_sym] = call(value)
-            end
-          end
-
-          def nil_to_hash(_value)
-            {}
-          end
-
-          def string_to_hash(value)
-            {value.to_sym => {}}
-          end
-
-          def symbol_to_hash(value)
-            {value => {}}
-          end
-        end
-      end
-    end
-  end
-end

data/lib/serega/plugins/preloads/lib/modules/attribute.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-class Serega
-  module SeregaPlugins
-    module Preloads
-      #
-      # Serega::SeregaAttribute additional/patched instance methods
-      #
-      # @see Serega::SeregaAttribute::AttributeInstanceMethods
-      #
-      module AttributeInstanceMethods
-        # @return [Hash, nil] normalized preloads of current attribute
-        attr_reader :preloads
-
-        # @return [Array] normalized preloads_path of current attribute
-        attr_reader :preloads_path
-
-        private
-
-        def set_normalized_vars(normalizer)
-          super
-          @preloads = normalizer.preloads
-          @preloads_path = normalizer.preloads_path
-        end
-      end
-    end
-  end
-end