rom-core 4.1.2 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22cd77ab1a0e834086636f81a34fcb75f478888443aecf3981373711f1b548e4
-  data.tar.gz: 9a7192effd457c250e869b1d954d3dde62661601f4d9869521a83e35f3936811
+  metadata.gz: 12b984e8882e2b0701f33ed7b7d906f0a92ce8e5393599e48faf97ffede6010f
+  data.tar.gz: 560e9607957ac6099f11b00361d62e0b71086a4fbae82f0b41cbd18db830da4f
 SHA512:
-  metadata.gz: c6e2618fcfab0987ebfca06da11ef83c0e5a1d0506facf18abbd892b14ebf7cf9151a8cf9fb65458909320046ae0490478285ab9c3cc7babc0aa4bacb027d2a7
-  data.tar.gz: a9df678dc56e35366db45796e72f50ca003b72213083e110cc8f7b5a87be84979f8c4739d6aa161becd45e2560d11a66bc0a8044d18cf9207bfbd4fb58739346
+  metadata.gz: b7250d01edf599791ac6383e3c9ab40f41f7fc343edf8e002490bf33552bd9597cea3a24896741d9a5f1fd1b84a1b3bad684b6246557d1d890c54fbe7e8e2b64
+  data.tar.gz: bf2df36a73419a74bf07afccc4c1743f40e87533924942f8bf1af89513d0a59d968e678d7d2cc5eb6b7793ec685e19b7addc6a2e24ff3adbbc38d45cac106dc6

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+# v4.2.0 2018-03-29
+
+## Fixed
+
+* `Relation#map_with` applies auto-mapping prior custom mappers (solnic)
+* `Relation#map_to` works along with `Relation#map_with` (solnic)
+* `Relation#commands` no longers tries to map results through all custom registered mappers (solnic)
+
+## Added
+
+* Custom `MapperCompiler` subclass can provide mapper options via `mapper_options(...)` class attribute (solnic)
+
+[Compare v4.1.2...v4.2.0](https://github.com/rom-rb/rom/compare/v4.1.2...v4.2.0)
+
 # v4.1.2 2018-02-03
 
 ## Fixed

data/lib/rom/memory/relation.rb

@@ -17,6 +17,25 @@ module ROM
       adapter :memory
       schema_class Memory::Schema
 
+      # @!method take(amount)
+      #   @param (see Dataset#take)
+      #   @return [Relation]
+      #   @see Dataset#take
+      #
+      # @!method join(*args)
+      #   @param (see Dataset#take)
+      #   @return [Relation]
+      #   @see Dataset#join
+      #
+      # @!method restrict(criteria = nil)
+      #   @param (see Dataset#restrict)
+      #   @return [Relation]
+      #   @see Dataset#restrict
+      #
+      # @!method order(*fields)
+      #   @param (see Dataset#order)
+      #   @return [Relation]
+      #   @see Dataset#order
       forward :take, :join, :restrict, :order
 
       # Project a relation with provided attribute names

data/lib/rom/plugin_registry.rb

@@ -87,7 +87,7 @@ module ROM
   class PluginRegistryBase < Registry
     include Dry::Equalizer(:elements, :plugin_type)
 
-    # !@attribute [r] plugin_type
+    # @!attribute [r] plugin_type
     #   @return [Class] Typically ROM::PluginBase or its descendant
     option :plugin_type
 

data/lib/rom/relation.rb

@@ -217,7 +217,7 @@ module ROM
     def each
       return to_enum unless block_given?
 
-      if auto_struct?
+      if auto_map?
         mapper.(dataset.map { |tuple| output_schema[tuple] }).each { |struct| yield(struct) }
       else
         dataset.each { |tuple| yield(output_schema[tuple]) }
@@ -496,15 +496,12 @@ module ROM
       mappers[to_ast]
     end
 
-    # Maps the wrapped relation with other mappers available in the registry
+    # Maps relation with custom mappers available in the registry
     #
-    # @overload map_with(model)
-    #   Map tuples to the provided custom model class
-    #
-    #   @example
-    #     users.map_with(MyUserModel)
-    #
-    #   @param [Class>] model Your custom model class
+    # When `auto_map` is enabled, your mappers will be applied after performing
+    # default auto-mapping. This means that you can compose complex relations
+    # and have them auto-mapped, and use much simpler custom mappers to adjust
+    # resulting data according to your requirements.
     #
     # @overload map_with(*mappers)
     #   Map tuples using registered mappers
@@ -515,37 +512,32 @@ module ROM
     #   @param [Array<Symbol>] mappers A list of mapper identifiers
     #
     # @overload map_with(*mappers, auto_map: true)
-    #   Map tuples using auto-mapping and custom registered mappers
-    #
-    #   If `auto_map` is enabled, your mappers will be applied after performing
-    #   default auto-mapping. This means that you can compose complex relations
-    #   and have them auto-mapped, and use much simpler custom mappers to adjust
-    #   resulting data according to your requirements.
+    #   Map tuples using custom registered mappers and enforce auto-mapping
     #
     #   @example
     #     users.map_with(:my_mapper, :my_other_mapper, auto_map: true)
     #
     #   @param [Array<Symbol>] mappers A list of mapper identifiers
     #
-    # @return [Relation] A new relation proxy with pipelined relation
+    # @return [Relation::Composite] Mapped relation
     #
     # @api public
     def map_with(*names, **opts)
       super(*names).with(opts)
     end
 
-    # Return a new relation that will map its tuples to instance of the provided class
+    # Return a new relation that will map its tuples to instances of the provided class
     #
     # @example
     #   users.map_to(MyUserModel)
     #
     # @param [Class] klass Your custom model class
     #
-    # @return [Relation::Composite]
+    # @return [Relation]
     #
     # @api public
     def map_to(klass, **opts)
-      with(opts.merge(auto_struct: true, meta: { model: klass }))
+      with(opts.merge(auto_map: false, auto_struct: true, meta: { model: klass }))
     end
 
     # Return a new relation with an aliased name

data/lib/rom/relation/class_interface.rb

@@ -128,7 +128,7 @@ module ROM
       # @api private
       attr_reader :schema_proc
 
-      # !@attribute [r] relation_name
+      # @!attribute [r] relation_name
       #   @return [Name] Qualified relation name
       def relation_name
         raise MissingSchemaError.new(self) unless defined?(@relation_name)

data/lib/rom/relation/combined.rb

@@ -51,7 +51,7 @@ module ROM
       #
       # @api public
       def call(*args)
-        left = root.with(auto_struct: false).call(*args)
+        left = root.with(auto_map: false, auto_struct: false).call(*args)
 
         right =
           if left.empty?

data/lib/rom/relation/commands.rb

@@ -36,14 +36,17 @@ module ROM
       #
       # @api public
       def command(type, mapper: nil, use: EMPTY_ARRAY, plugins_options: EMPTY_HASH, **opts)
-        base_command = commands.key?(type) ? commands[type] : commands[type, adapter, to_ast, use, plugins_options, opts]
+        base_command =
+          if commands.key?(type)
+            commands[type]
+          else
+            commands[type, adapter, to_ast, use, plugins_options, opts]
+          end
 
         command =
           if mapper
             base_command >> mappers[mapper]
-          elsif mappers.any? && !base_command.is_a?(CommandProxy)
-            mappers.reduce(base_command) { |a, (_, e)| a >> e }
-          elsif auto_struct? || auto_map?
+          elsif auto_map?
             base_command >> self.mapper
           else
             base_command

data/lib/rom/relation/composite.rb

@@ -29,6 +29,13 @@ module ROM
       end
       alias_method :[], :call
 
+      # @see Relation#map_to
+      #
+      # @api public
+      def map_to(klass)
+        self >> left.map_to(klass).mapper
+      end
+
       private
 
       # @api private

data/lib/rom/relation/graph.rb

@@ -59,11 +59,11 @@ module ROM
       #
       # @see Relation#map_with
       #
-      # @return [Graph]
+      # @return [Relation::Composite]
       #
       # @api public
-      def map_with(*args)
-        self.class.new(root.map_with(*args), nodes)
+      def map_with(*names, **opts)
+        names.reduce(self.class.new(root.with(opts), nodes)) { |a, e| a >> mappers[e] }
       end
 
       # Map graph tuples to custom objects

data/lib/rom/relation/wrap.rb

@@ -27,7 +27,7 @@ module ROM
       # @api public
       def call(*args)
         if auto_map?
-          Loaded.new(self, mapper.(relation.with(auto_struct: false)))
+          Loaded.new(self, mapper.(relation.with(auto_map: false, auto_struct: false)))
         else
           Loaded.new(self, relation.(*args))
         end

data/lib/rom/schema.rb

@@ -139,7 +139,7 @@ module ROM
     #
     # This can be used by views to generate a new relation automatically.
     # In example a schema can project a relation, join any additional relations
-    # if it uncludes attributes from other relations etc.
+    # if it includes attributes from other relations etc.
     #
     # Default implementation is a no-op and it simply returns back untouched relation
     #

data/lib/rom/schema/inferrer.rb

@@ -7,6 +7,21 @@ module ROM
       extend Dry::Core::ClassAttributes
       extend Initializer
 
+      # @!method self.attributes_inferrer
+      #   @overload attributes_inferrer
+      #     @return [Proc]
+      #
+      #   @overload attributes_inferrer(value)
+      #     @param value [Proc]
+      #     @return [Proc]
+      #
+      # @!method self.attr_class
+      #   @overload attr_class
+      #     @return [Class(ROM::Attribute)]
+      #
+      #   @overload attr_class(value)
+      #     @param value [Class(ROM::Attribute)]
+      #     @return [Class(ROM::Attribute)]
       defines :attributes_inferrer, :attr_class
 
       MissingAttributesError = Class.new(StandardError) do
@@ -26,12 +41,18 @@ module ROM
 
       include Dry::Equalizer(:options)
 
+      # @!attribute [r] attr_class
+      #   @return [Class(ROM::Attribute)]
       option :attr_class, default: -> { self.class.attr_class }
 
+      # @!attribute [r] enabled
+      #   @return [Boolean]
       option :enabled, default: -> { true }
 
       alias_method :enabled?, :enabled
 
+      # @!attribute [r] attributes_inferrer
+      #   @return [ROM::Schema::AttributesInferrer]
       option :attributes_inferrer, default: -> { self.class.attributes_inferrer }
 
       # @api private

data/lib/rom/version.rb

@@ -1,5 +1,5 @@
 module ROM
   module Core
-    VERSION = '4.1.2'.freeze
+    VERSION = '4.2.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rom-core
 version: !ruby/object:Gem::Version
-  version: 4.1.2
+  version: 4.2.0
 platform: ruby
 authors:
 - Piotr Solnica
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-03 00:00:00.000000000 Z
+date: 2018-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -304,7 +304,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: Ruby Object Mapper