rom-core 4.2.1 → 5.0.0

data/lib/rom/registry.rb

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

data/lib/rom/relation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'dry/core/class_attributes'
 
 require 'rom/struct'
@@ -279,7 +281,7 @@ module ROM
 
     # Create a graph node for a given association identifier
     #
-    # @param [Symbol, Relation::Name]
+    # @param [Symbol, Relation::Name] name
     #
     # @return [Relation]
     #
@@ -292,7 +294,7 @@ module ROM
 
     # Return a graph node prepared by the given association
     #
-    # @param [Association] An association object
+    # @param [Association] assoc An association object
     #
     # @return [Relation]
     #

data/lib/rom/relation/class_interface.rb

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

data/lib/rom/relation/combined.rb

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

data/lib/rom/relation/commands.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ROM
   class Relation
     # Extensions for relation classes which provide access to commands

data/lib/rom/relation/composite.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rom/relation/loaded'
 require 'rom/relation/materializable'
 require 'rom/pipeline'

data/lib/rom/relation/curried.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'dry/equalizer'
 
 require 'rom/types'
@@ -35,7 +37,7 @@ module ROM
 
       # @!attribute [r] arity
       #   @return [Integer] View's arity
-      option :arity, type: Types::Strict::Int
+      option :arity, type: Types::Strict::Integer
 
       # @!attribute [r] curry_args
       #   @return [Array] Arguments that will be passed to curried view

data/lib/rom/relation/graph.rb

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

data/lib/rom/relation/loaded.rb

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

data/lib/rom/relation/materializable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ROM
   class Relation
     # Interface for objects that can be materialized into a loaded relation

data/lib/rom/relation/name.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'dry/equalizer'
 require 'concurrent/map'
 

data/lib/rom/relation/view_dsl.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ROM
   class Relation
     # ViewDSL is exposed in `Relation.view` method

data/lib/rom/relation/wrap.rb

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

data/lib/rom/relation_registry.rb

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

data/lib/rom/schema.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'dry/equalizer'
 
 require 'rom/constants'
@@ -62,6 +64,19 @@ module ROM
 
     DEFAULT_INFERRER = Inferrer.new(enabled: false).freeze
 
+    type_transformation = lambda do |key|
+      k = if key.default?
+            key.constructor { |value| value.nil? ? Undefined : value }
+          else
+            key
+          end
+      k.required(false)
+    end
+
+    HASH_SCHEMA = Types::Coercible::Hash.
+                    schema(EMPTY_HASH).
+                    with_type_transform(type_transformation)
+
     extend Initializer
 
     include Dry::Equalizer(:name, :attributes, :associations)
@@ -104,7 +119,7 @@ module ROM
 
     alias_method :to_ary, :attributes
 
-    # Define a relation schema from plain rom types
+    # Define a relation schema from plain rom types and optional options
     #
     # Resulting schema will decorate plain rom types with adapter-specific types
     # By default `Attribute` will be used
@@ -123,9 +138,27 @@ module ROM
       ) { |schema| yield(schema) if block_given? }
     end
 
+    # Builds a representation of the information needed to create an
+    # attribute.
+    #
+    # This representation is consumed by `Schema.define` in order to create
+    # the actual attributes.
+    #
+    # @return [Hash] A hash with `:type` and `:options` keys.
+    #
+    # @api private
+    def self.build_attribute_info(type, options)
+      {
+        type: type,
+        options: options
+      }
+    end
+
     # @api private
     def self.attributes(attributes, attr_class)
-      attributes.map { |type| attr_class.new(type) }
+      attributes.map do |attr|
+        attr_class.new(attr[:type], attr.fetch(:options))
+      end
     end
 
     # @api private
@@ -389,7 +422,7 @@ module ROM
     #
     # @api private
     def to_output_hash
-      Types::Coercible::Hash.schema(
+      HASH_SCHEMA.schema(
         map { |attr| [attr.key, attr.to_read_type] }.to_h
       )
     end
@@ -403,7 +436,7 @@ module ROM
     #
     # @api private
     def to_input_hash
-      Types::Coercible::Hash.schema(
+      HASH_SCHEMA.schema(
         map { |attr| [attr.name, attr.to_write_type] }.to_h
       )
     end
@@ -451,8 +484,8 @@ module ROM
     # @api private
     def initialize_primary_key_names
       if primary_key.size > 0
-        set!(:primary_key_name, primary_key[0].meta[:name])
-        set!(:primary_key_names, primary_key.map { |type| type.meta[:name] })
+        set!(:primary_key_name, primary_key[0].name)
+        set!(:primary_key_names, primary_key.map(&:name))
       end
     end
 

data/lib/rom/schema/associations_dsl.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rom/support/inflector'
 
 require 'rom/associations/definitions'
@@ -110,7 +112,7 @@ module ROM
       # @param [Symbol] target The target relation identifier
       # @param [Hash] options A hash with additional options
       #
-      # @return [Associations::OneToOne]
+      # @return [Associations::ManyToMany]
       #
       # @see #one_to_many
       #
@@ -127,7 +129,7 @@ module ROM
       # @param [Symbol] target The target relation identifier
       # @param [Hash] options A hash with additional options
       #
-      # @return [Associations::OneToOne]
+      # @return [Associations::ManyToOne]
       #
       # @see #one_to_many
       #
@@ -163,7 +165,7 @@ module ROM
       #
       # @see #one_to_one
       #
-      # @return [Associations::ManyToOne]
+      # @return [Associations::OneToOne]
       #
       # @api public
       def has_one(target, options = {})

data/lib/rom/schema/dsl.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'dry/equalizer'
 
 require 'rom/types'
@@ -36,7 +38,10 @@ module ROM
       option :adapter, default: -> { :default }
 
       # @!attribute [r] attributes
-      #   @return [Hash] A hash with attributes defined by the DSL
+      #   @return [Hash<Symbol, Hash>] A hash with attribute names as
+      #   keys and attribute representations as values.
+      #
+      #   @see [Schema.build_attribute_info]
       attr_reader :attributes
 
       # @!attribute [r] plugins
@@ -61,18 +66,22 @@ module ROM
         @definition = block
       end
 
-      # Defines a relation attribute with its type
+      # Defines a relation attribute with its type and options.
+      #
+      # When only options are given, type is left as nil. It makes
+      # sense when it is used alongside an schema inferrer, which will
+      # populate the type.
       #
       # @see Relation.schema
       #
       # @api public
-      def attribute(name, type, options = EMPTY_HASH)
+      def attribute(name, type_or_options, options = EMPTY_HASH)
         if attributes.key?(name)
           ::Kernel.raise ::ROM::AttributeAlreadyDefinedError,
                          "Attribute #{ name.inspect } already defined"
         end
 
-        attributes[name] = build_type(name, type, options)
+        attributes[name] = build_attribute_info(name, type_or_options, options)
       end
 
       # Define associations for a relation
@@ -108,18 +117,38 @@ module ROM
         @associations_dsl = AssociationsDSL.new(relation, &block)
       end
 
-      # Builds a type instance from a name, options and a base type
+      # Builds a representation of the information needed to create an
+      # attribute. It returns a hash with `:type` and `:options` keys.
+      #
+      # @return [Hash]
+      #
+      # @see [Schema.build_attribute_info]
+      #
+      # @api private
+      def build_attribute_info(name, type_or_options, options = EMPTY_HASH)
+        type, options = if type_or_options.is_a?(::Hash)
+                          [nil, type_or_options]
+                        else
+                          [build_type(type_or_options, options), options]
+                        end
+        Schema.build_attribute_info(
+          type,
+          options.merge(name: name)
+        )
+      end
+
+      # Builds a type instance from base type and meta options
       #
       # @return [Dry::Types::Type] Type instance
       #
       # @api private
-      def build_type(name, type, options = EMPTY_HASH)
+      def build_type(type, options = EMPTY_HASH)
         if options[:read]
-          type.meta(name: name, source: relation, read: options[:read])
-        elsif type.optional? && !type.meta[:read] && type.right.meta[:read]
-          type.meta(name: name, source: relation, read: type.right.meta[:read].optional)
+          type.meta(source: relation, read: options[:read])
+        elsif type.optional? && type.meta[:read]
+          type.meta(source: relation, read: type.meta[:read].optional)
         else
-          type.meta(name: name, source: relation)
+          type.meta(source: relation)
         end
       end
 
@@ -128,7 +157,8 @@ module ROM
       # @api public
       def primary_key(*names)
         names.each do |name|
-          attributes[name] = attributes[name].meta(primary_key: true)
+          attributes[name][:type] =
+            attributes[name][:type].meta(primary_key: true)
         end
         self
       end

data/lib/rom/schema/inferrer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'dry/core/class_attributes'
 
 module ROM
@@ -81,9 +83,25 @@ module ROM
 
       # @api private
       def merge_attributes(defined, inferred)
-        defined_names = defined.map(&:name)
-
-        defined + inferred.reject { |attr| defined_names.include?(attr.name) }
+        type_lookup = lambda do |attrs, name|
+          attrs.find { |a| a.name == name }.type
+        end
+        defined_with_type, defined_names =
+          defined.each_with_object([[], []]) do |attr, (attrs, names)|
+            attrs << if attr.type.nil?
+                       attr.class.new(
+                         type_lookup.(inferred, attr.name),
+                         attr.options
+                       )
+                     else
+                       attr
+                     end
+            names << attr.name
+          end
+
+        defined_with_type + inferred.reject do |attr|
+          defined_names.include?(attr.name)
+        end
       end
     end
   end

data/lib/rom/schema_plugin.rb

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

data/lib/rom/setup.rb

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

data/lib/rom/setup/auto_registration.rb

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

data/lib/rom/setup/auto_registration_strategies/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rom/types'
 require 'rom/initializer'
 
@@ -9,7 +11,7 @@ module ROM
     class Base
       extend Initializer
 
-      PathnameType = Types.Definition(Pathname).constrained(type: Pathname)
+      PathnameType = Types.Instance(Pathname)
 
       EXTENSION_REGEX = /\.rb\z/
 

data/lib/rom/setup/auto_registration_strategies/custom_namespace.rb

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

data/lib/rom/setup/auto_registration_strategies/no_namespace.rb

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

data/lib/rom/setup/auto_registration_strategies/with_namespace.rb

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

data/lib/rom/setup/finalize.rb

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

data/lib/rom/setup/finalize/finalize_commands.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rom/registry'
 require 'rom/command_compiler'
 require 'rom/command_registry'