rom-core 4.2.1 → 5.0.0

data/lib/rom/command_compiler.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rom/support/inflector'
 
 require 'rom/initializer'

data/lib/rom/command_proxy.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rom/support/inflector'
 
 module ROM

data/lib/rom/command_registry.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'concurrent/map'
 
 require 'rom/constants'
@@ -41,15 +43,19 @@ module ROM
     # If mapper is set command will be turned into a composite command with
     # auto-mapping
     #
-    # @example
-    #   create_user = rom.commands[:users][:create]
-    #   create_user[name: 'Jane']
+    # @overload [](name)
+    #   @param [Symbol] name The command identifier from the registry
+    #   @example
+    #     create_user = rom.commands[:users][:create]
+    #     create_user[name: 'Jane']
     #
-    #   # with mapping, assuming :entity mapper is registered for :users relation
-    #   create_user = rom.commands[:users].map_with(:entity)[:create]
-    #   create_user[name: 'Jane'] # => result is send through :entity mapper
+    #     # with mapping, assuming :entity mapper is registered for :users relation
+    #     create_user = rom.commands[:users].map_with(:entity)[:create]
+    #     create_user[name: 'Jane'] # => result is sent through :entity mapper
     #
-    # @param [Symbol] name The name of a registered command
+    # @overload [](*args)
+    #   @param [Array] *args {CommandCompiler} arguments
+    #   @see CommandCompiler#call
     #
     # @return [Command,Command::Composite]
     #

data/lib/rom/commands.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rom/commands/create'
 require 'rom/commands/update'
 require 'rom/commands/delete'

data/lib/rom/commands/class_interface.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'dry/core/class_builder'
 require 'rom/support/inflector'
 
@@ -105,8 +107,8 @@ module ROM
       #   end
       #
       # @param [Symbol] plugin
-      # @param [Hash] _options
-      # @option _options [Symbol] :adapter (:default) first adapter to check for plugin
+      # @param [Hash] options
+      # @option options [Symbol] :adapter (:default) first adapter to check for plugin
       #
       # @api public
       def use(plugin, options = EMPTY_HASH)

data/lib/rom/commands/composite.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rom/pipeline'
 
 module ROM

data/lib/rom/commands/create.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rom/command'
 
 module ROM

data/lib/rom/commands/delete.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rom/command'
 
 module ROM

data/lib/rom/commands/graph.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rom/initializer'
 require 'rom/pipeline'
 require 'rom/commands/graph/class_interface'

data/lib/rom/commands/graph/class_interface.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rom/commands/graph/input_evaluator'
 
 module ROM

data/lib/rom/commands/graph/input_evaluator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ROM
   module Commands
     class Graph

data/lib/rom/commands/lazy.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rom/commands/composite'
 require 'rom/commands/graph'
 

data/lib/rom/commands/lazy/create.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ROM
   module Commands
     class Lazy

data/lib/rom/commands/lazy/delete.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ROM
   module Commands
     class Lazy

data/lib/rom/commands/lazy/update.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ROM
   module Commands
     class Lazy

data/lib/rom/commands/update.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rom/command'
 
 module ROM

data/lib/rom/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'forwardable'
 
 require 'rom/environment'

data/lib/rom/configuration_dsl.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rom/configuration_dsl/relation'
 require 'rom/configuration_dsl/command_dsl'
 

data/lib/rom/configuration_dsl/command.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rom/support/inflector'
 require 'dry/core/class_builder'
 

data/lib/rom/configuration_dsl/command_dsl.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rom/configuration_dsl/command'
 
 module ROM

data/lib/rom/configuration_dsl/relation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'dry/core/class_builder'
 require 'rom/support/inflector'
 

data/lib/rom/configuration_plugin.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rom/plugin_base'
 
 module ROM

data/lib/rom/constants.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'dry/core/constants'
 
 # Constants and errors common in the whole library
@@ -20,6 +22,7 @@ module ROM
   EnvAlreadyFinalizedError = Class.new(StandardError)
   RelationAlreadyDefinedError = Class.new(StandardError)
   MapperAlreadyDefinedError = Class.new(StandardError)
+  MapperMisconfiguredError = Class.new(StandardError)
   NoRelationError = Class.new(StandardError)
   InvalidRelationName = Class.new(StandardError)
   CommandError = Class.new(StandardError)

data/lib/rom/container.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'dry/container'
 
 require 'rom/cache'

data/lib/rom/core.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'dry/equalizer'
 require 'dry/core/constants'
 
@@ -9,7 +11,8 @@ require 'rom/configuration_plugin'
 require 'rom/plugin'
 require 'rom/schema_plugin'
 require 'rom/relation'
-require 'rom-mapper'
+require 'rom/mapper'
+require 'rom/processor/transproc'
 require 'rom/mapper/configuration_plugin'
 require 'rom/commands'
 

data/lib/rom/create_container.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rom/configuration'
 require 'rom/environment'
 require 'rom/setup'

data/lib/rom/data_proxy.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ROM
   # Helper module for dataset classes
   #

data/lib/rom/enumerable_dataset.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rom/initializer'
 require 'rom/data_proxy'
 

data/lib/rom/environment.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rom/support/configurable'
 require 'rom/gateway'
 

data/lib/rom/gateway.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'dry/core/class_attributes'
 
 require 'rom/transaction'

data/lib/rom/global.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rom/plugin_registry'
 require 'rom/global/plugin_dsl'
 

data/lib/rom/global/plugin_dsl.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ROM
   module Global
     # plugin registration DSL

data/lib/rom/header.rb

@@ -0,0 +1,198 @@
+# frozen_string_literal: true
+
+require 'rom/header/attribute'
+
+module ROM
+  # Header provides information about data mapping of a specific relation
+  #
+  # Processors use headers to build objects that process raw relations that go
+  # through mappers.
+  #
+  # @private
+  class Header
+    include Enumerable
+    include Dry::Equalizer(:attributes, :model)
+
+    # @return [Class] optional model associated with a header
+    #
+    # @api private
+    attr_reader :model
+
+    # @api private
+    attr_reader :reject_keys
+
+    # @api private
+    attr_reader :copy_keys
+
+    # @api private
+    attr_reader :attributes
+
+    # @return [Hash] attribute key/name mapping for all primitive attributes
+    #
+    # @api private
+    attr_reader :mapping
+
+    # @return [Array] all attribute keys that are in a tuple
+    #
+    # @api private
+    attr_reader :tuple_keys
+
+    # @return [Array] all attribute names that are popping from a tuple
+    #
+    # @api private
+    attr_reader :pop_keys
+
+    # Coerce array with attribute definitions into a header object
+    #
+    # @param [Array<Array>] input attribute name/option pairs
+    # @param [Hash] options
+    #
+    # @return [Header]
+    #
+    # @api private
+    def self.coerce(input, options = {})
+      if input.instance_of?(self)
+        input
+      else
+        attributes = input.each_with_object({}) { |pair, h|
+          h[pair.first] = Attribute.coerce(pair)
+        }
+
+        new(attributes, options)
+      end
+    end
+
+    # @api private
+    def initialize(attributes, options = {})
+      @options = options
+      @model = options[:model]
+      @copy_keys = options.fetch(:copy_keys, false)
+      @reject_keys = options.fetch(:reject_keys, false)
+
+      @attributes = attributes
+      initialize_mapping
+      initialize_tuple_keys
+      initialize_pop_keys
+    end
+
+    # Iterate over attributes
+    #
+    # @yield [Attribute]
+    #
+    # @api private
+    def each
+      attributes.each_value { |attribute| yield(attribute) }
+    end
+
+    # Return if there are any aliased attributes
+    #
+    # @api private
+    def aliased?
+      any?(&:aliased?)
+    end
+
+    # Return attribute keys
+    #
+    # An attribute key corresponds to tuple attribute names
+    #
+    # @api private
+    def keys
+      attributes.keys
+    end
+
+    # Return attribute identified by its name
+    #
+    # @return [Attribute]
+    #
+    # @api private
+    def [](name)
+      attributes.fetch(name)
+    end
+
+    # Return all Combined attributes
+    #
+    # @return [Array<Combined>]
+    #
+    # @api private
+    def combined
+      by_type(Combined)
+    end
+
+    # Returns all attributes that require preprocessing
+    #
+    # @return [Array<Group,Fold>]
+    #
+    # @api private
+    def preprocessed
+      by_type(Group, Fold)
+    end
+
+    # Returns all attributes that require postprocessing
+    #
+    # @return [Array<Ungroup,Unfold>]
+    #
+    # @api private
+    def postprocessed
+      by_type(Ungroup, Unfold)
+    end
+
+    # Return all Wrap attributes
+    #
+    # @return [Array<Wrap>]
+    #
+    # @api private
+    def wraps
+      by_type(Wrap)
+    end
+
+    # Return all non-primitive attributes that don't require mapping
+    #
+    # @return [Array<Group,Fold,Ungroup,Unfold,Wrap,Unwrap>]
+    #
+    # @api private
+    def non_primitives
+      preprocessed + wraps
+    end
+
+    # Return all primitive attributes that require mapping
+    #
+    # @return [Array<Attribute>]
+    #
+    # @api private
+    def primitives
+      to_a - non_primitives
+    end
+
+    private
+
+    # Find all attribute matching specific attribute class (not kind)
+    #
+    # @return [Array<Attribute>]
+    #
+    # @api private
+    def by_type(*types)
+      select { |attribute| types.include?(attribute.class) }
+    end
+
+    # Set mapping hash from primitive attributes
+    #
+    # @api private
+    def initialize_mapping
+      @mapping = primitives.map(&:mapping).reduce(:merge) || {}
+    end
+
+    # Set all tuple keys from all attributes going deep into Wrap and Group too
+    #
+    # @api private
+    def initialize_tuple_keys
+      @tuple_keys = mapping.keys.flatten + non_primitives.flat_map(&:tuple_keys)
+    end
+
+    # Set all tuple keys from all attributes popping from Unwrap and Ungroup
+    #
+    # @api private
+    def initialize_pop_keys
+      @pop_keys = mapping.values + non_primitives.flat_map(&:tuple_keys)
+    end
+  end
+end