rom-sql 3.5.0 → 4.0.0.alpha1

data/lib/rom/sql/gateway.rb

@@ -1,15 +1,17 @@
 # frozen_string_literal: true
 
-require 'logger'
-require 'sequel/core'
+require "logger"
+require "sequel/core"
 
-require 'dry/core/constants'
+require "dry/core/constants"
 
-require 'rom/types'
-require 'rom/gateway'
-require 'rom/sql/migration'
-require 'rom/sql/commands'
-require 'rom/sql/transaction'
+require "rom/setup"
+require "rom/types"
+require "rom/gateway"
+require "rom/sql/migration"
+require "rom/sql/commands"
+require "rom/sql/transaction"
+require "rom/support/notifications"
 
 module ROM
   module SQL
@@ -17,6 +19,8 @@ module ROM
     #
     # @api public
     class Gateway < ROM::Gateway
+      extend Notifications
+
       include Dry::Core::Constants
       include Migration
 
@@ -81,13 +85,18 @@ module ROM
       def initialize(uri, options = EMPTY_HASH)
         @connection = connect(uri, options)
         load_extensions(Array(options[:extensions]))
-        Notifications.trigger("configuration.gateway.connected", connection: @connection)
+        notifications.trigger("sql.gateway.connected", connection: @connection)
 
         @options = options
 
         super
       end
 
+      # @api private
+      def notifications
+        @notifications ||= Notifications.event_bus(:sql)
+      end
+
       # Disconnect from the gateway's database
       #
       # @api public
@@ -152,15 +161,15 @@ module ROM
       # Create a table using the configured connection
       #
       # @api public
-      def create_table(*args, &block)
-        connection.create_table(*args, &block)
+      def create_table(...)
+        connection.create_table(...)
       end
 
       # Drops a table
       #
       # @api public
-      def drop_table(*args, &block)
-        connection.drop_table(*args, &block)
+      def drop_table(...)
+        connection.drop_table(...)
       end
 
       # Returns a list of datasets inferred from table names
@@ -205,6 +214,26 @@ module ROM
         connection.run(statement)
       end
 
+      # Build an SQL-specific command
+      #
+      # @return [Command]
+      #
+      # @api public
+      def command(klass, relation:, **opts)
+        return super unless relation.dataset.db.database_type == :postgres
+
+        ext =
+          if klass < Commands::Create
+            Postgres::Commands::Create
+          elsif klass < Commands::Update
+            Postgres::Commands::Update
+          end
+
+        klass.include(ext) if ext
+
+        super
+      end
+
       private
 
       # Connect to database or reuse established connection instance
@@ -236,18 +265,16 @@ module ROM
 
         # this will be default in Sequel 5.0.0 and since we don't rely
         # on dataset mutation it is safe to enable it already
-        connection.extension(:freeze_datasets) unless RUBY_ENGINE == 'rbx'
+        connection.extension(:freeze_datasets) unless RUBY_ENGINE == "rbx"
 
         # for ROM::SQL::Relation#nullify
         connection.extension(:null_dataset)
       end
 
       # @api private
-      def transaction_runner(_)
+      def transaction_runner(**)
         ROM::SQL::Transaction.new(connection)
       end
     end
   end
-
-  Configuration.register_event("configuration.gateway.connected")
 end

data/lib/rom/sql/group_dsl.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'rom/sql/dsl'
+require "rom/sql/dsl"
 
 module ROM
   module SQL

data/lib/rom/sql/index.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "dry/core/equalizer"
+
 module ROM
   module SQL
     # @api private

data/lib/rom/sql/join_dsl.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'rom/sql/restriction_dsl'
+require "rom/sql/restriction_dsl"
 
 module ROM
   module SQL

data/lib/rom/sql/mapper_compiler.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'rom/mapper_compiler'
+require "rom/mapper_compiler"
 
 module ROM
   module SQL
@@ -9,7 +9,7 @@ module ROM
         name, _, meta_options = node
 
         if meta_options[:wrapped]
-          [extract_wrapped_name(node), from: meta_options[:alias]]
+          [extract_wrapped_name(node), {from: meta_options[:alias]}]
         else
           [name]
         end

data/lib/rom/sql/migration/migrator.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require 'pathname'
+require "pathname"
 
-require 'rom/types'
-require 'rom/initializer'
+require "rom/types"
+require "rom/initializer"
 
-require 'rom/sql/migration/runner'
-require 'rom/sql/migration/inline_runner'
-require 'rom/sql/migration/writer'
+require "rom/sql/migration/runner"
+require "rom/sql/migration/inline_runner"
+require "rom/sql/migration/writer"
 
 module ROM
   module SQL
@@ -16,8 +16,8 @@ module ROM
       class Migrator
         extend Initializer
 
-        DEFAULT_PATH = 'db/migrate'.freeze
-        VERSION_FORMAT = '%Y%m%d%H%M%S'.freeze
+        DEFAULT_PATH = "db/migrate"
+        VERSION_FORMAT = "%Y%m%d%H%M%S"
         DEFAULT_INFERRER = Schema::Inferrer.new.suppress_errors.freeze
 
         param :connection
@@ -43,8 +43,8 @@ module ROM
 
         # @api private
         def create_file(name, version = generate_version, **options)
-          sequence = options[:sequence] ? '%03d' % options[:sequence] : nil
-          filename = "#{ version }#{ sequence }_#{ name }.rb"
+          sequence = options[:sequence] ? "%03d" % options[:sequence] : nil
+          filename = "#{version}#{sequence}_#{name}.rb"
           content = options[:content] || migration_file_content
           path = options[:path] || self.path
           dirname = Pathname(path)
@@ -63,7 +63,7 @@ module ROM
 
         # @api private
         def migration_file_content
-          File.read(Pathname(__FILE__).dirname.join('template.rb').realpath)
+          File.read(Pathname(__FILE__).dirname.join("template.rb").realpath)
         end
 
         # @api private

data/lib/rom/sql/migration/runner.rb

@@ -54,6 +54,7 @@ module ROM
           end
         end
 
+        # rubocop:disable Metrics/AbcSize
         def alter_table(diff)
           return if diff.meta?
 
@@ -68,9 +69,7 @@ module ROM
                 when SchemaDiff::AttributeChanged
                   if attribute.type_changed?
                     from, to = attribute.current.unwrap, attribute.target.unwrap
-                    raise UnsupportedConversion.new(
-                      "Don't know how to convert #{from.inspect} to #{to.inspect}"
-                    )
+                    raise UnsupportedConversion, "Don't know how to convert #{from.inspect} to #{to.inspect}"
                   end
 
                   if attribute.nullability_changed?
@@ -94,6 +93,7 @@ module ROM
             end
           end
         end
+        # rubocop:enable Metrics/AbcSize
 
         def alter_foreign_keys(diff, foreign_key_changes)
           return if foreign_key_changes.empty?

data/lib/rom/sql/migration/schema_diff.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'rom/sql/type_serializer'
+require "rom/sql/type_serializer"
 
 module ROM
   module SQL
@@ -46,7 +46,6 @@ module ROM
         end
 
         class TableAltered < TableDiff
-
           option :attribute_changes, default: -> { EMPTY_ARRAY }
 
           option :index_changes, default: -> { EMPTY_ARRAY }
@@ -135,10 +134,10 @@ module ROM
         class IndexAdded < IndexDiff
           def options
             options = {}
-            options[:name] = index.name if !index.name.nil?
+            options[:name] = index.name unless index.name.nil?
             options[:unique] = true if index.unique?
-            options[:type] = index.type if !index.type.nil?
-            options[:where] = index.predicate if !index.predicate.nil?
+            options[:type] = index.type unless index.type.nil?
+            options[:where] = index.predicate unless index.predicate.nil?
             options
           end
         end
@@ -146,7 +145,7 @@ module ROM
         class IndexRemoved < IndexDiff
           def options
             options = {}
-            options[:name] = index.name if !index.name.nil?
+            options[:name] = index.name unless index.name.nil?
             options
           end
         end
@@ -210,8 +209,8 @@ module ROM
           }.map { |name, target_attr|
             [name, [target_attr, current[name]]]
           }.to_h
-          added_attributes = target.select { |name, _| !current.key?(name) }
-          removed_attributes = current.select { |name, _| !target.key?(name) }
+          added_attributes = target.reject { |name, _| current.key?(name) }
+          removed_attributes = current.reject { |name, _| target.key?(name) }
 
           map_attributes(removed_attributes, AttributeRemoved) +
             map_attributes(added_attributes, AttributeAdded) +

data/lib/rom/sql/migration/writer.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
-require 'rom/sql/migration/recorder'
+require "rom/sql/migration/recorder"
 
 module ROM
   module SQL
     module Migration
       # @api private
       class Writer
-        MIGRATION_BEGIN = "ROM::SQL.migration do\n  change do".freeze
-        MIGRATION_END = "\n  end\nend\n".freeze
+        MIGRATION_BEGIN = "ROM::SQL.migration do\n  change do"
+        MIGRATION_END = "\n  end\nend\n"
 
         attr_reader :yield_migration
 
@@ -33,14 +33,14 @@ module ROM
         def write(operations, buffer, indent)
           operations.each do |operation|
             op, args, nested = operation
-            buffer << indent << op.to_s << ' '
+            buffer << indent << op.to_s << " "
             write_arguments(buffer, args)
 
-            if !nested.empty?
-              buffer << ' do'
-              write(nested, buffer, indent + '  ')
-              buffer << indent << 'end'
-            end
+            next if nested.empty?
+
+            buffer << " do"
+            write(nested, buffer, indent + "  ")
+            buffer << indent << "end"
           end
         end
 
@@ -51,9 +51,9 @@ module ROM
             options = EMPTY_HASH
           end
 
-          buffer << args.map(&:inspect).join(', ')
+          buffer << args.map(&:inspect).join(", ")
           options.each do |key, value|
-            buffer << ', ' << key.to_s << ': ' << value.inspect
+            buffer << ", " << key.to_s << ": " << value.inspect
           end
         end
 
@@ -61,7 +61,7 @@ module ROM
           create_or_alter, args = op
           table_name = args[0]
 
-          "#{create_or_alter.to_s.sub('_table', '')}_#{table_name}"
+          "#{create_or_alter.to_s.sub("_table", "")}_#{table_name}"
         end
       end
     end

data/lib/rom/sql/migration.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'rom/sql/migration/migrator'
-require 'rom/sql/migration/schema_diff'
+require "rom/sql/migration/migrator"
+require "rom/sql/migration/schema_diff"
 
 module ROM
   module SQL
@@ -141,12 +141,8 @@ module ROM
       end
 
       # @api public
-      def auto_migrate!(conf, options = EMPTY_HASH)
-        schemas = conf.relation_classes(self).map do |klass|
-          klass.schema_proc.call.finalize_attributes!(gateway: self)
-        end
-
-        migrator.auto_migrate!(self, schemas, options)
+      def auto_migrate!(setup, options = EMPTY_HASH)
+        migrator.auto_migrate!(self, setup.registry.relations.map(&:schema), options)
       end
 
       private

data/lib/rom/sql/order_dsl.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'rom/sql/dsl'
+require "rom/sql/dsl"
 
 module ROM
   module SQL

data/lib/rom/sql/plugin/associates.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'rom/sql/associations'
+require "rom/sql/associations"
 
 module ROM
   module SQL
@@ -16,7 +16,7 @@ module ROM
           def initialize(name, relation, opts)
             @name = name
             @assoc = relation.associations[name]
-            @opts = { assoc: assoc, keys: assoc.join_keys }
+            @opts = {assoc: assoc, keys: assoc.join_keys}
             @opts.update(parent: opts[:parent]) if opts[:parent]
           end
 
@@ -25,7 +25,7 @@ module ROM
           end
 
           def to_hash
-            { associate: opts }
+            {associate: opts}
           end
         end
 
@@ -35,11 +35,10 @@ module ROM
             extend ClassMethods
             include InstanceMethods
 
-            defines :associations
-
-            associations Hash.new
+            setting :associations, default: {}, reader: true
 
             option :associations, default: -> { self.class.associations }
+
             option :configured_associations, default: -> { EMPTY_ARRAY }
           end
           super
@@ -47,6 +46,39 @@ module ROM
 
         # @api public
         module ClassMethods
+          # @api private
+          def create_class(relation:, rel_meta: {}, parent_relation: nil, **, &block)
+            klass = super
+
+            if relation && rel_meta[:combine_type]
+              setup_associates(klass, relation, parent_relation)
+            end
+
+            klass
+          end
+
+          # Sets up `associates` plugin for a given command class and relation
+          #
+          # @param [Class] klass The command class
+          # @param [Relation] relation The relation for the command
+          #
+          # @api private
+          def setup_associates(klass, relation, parent_relation)
+            assoc_name =
+              if relation.associations.key?(parent_relation)
+                parent_relation
+              else
+                singular_name = relation.inflector.singularize(parent_relation).to_sym
+                singular_name if relation.associations.key?(singular_name)
+              end
+
+            if assoc_name
+              klass.associates(assoc_name)
+            else
+              klass.associates(parent_relation)
+            end
+          end
+
           # @see ROM::Command::ClassInterface.build
           #
           # @api public
@@ -57,16 +89,17 @@ module ROM
 
             associate_options = command.associations.map { |(name, opts)|
               next if configured_assocs.include?(name)
+
               AssociateOptions.new(name, relation, opts)
             }.compact
 
             before_hooks = associate_options.reject(&:after?).map(&:to_hash)
             after_hooks = associate_options.select(&:after?).map(&:to_hash)
 
-            command.
-              with(configured_associations: configured_assocs + associate_options.map(&:name)).
-              before(*before_hooks).
-              after(*after_hooks)
+            command
+              .with(configured_associations: configured_assocs + associate_options.map(&:name))
+              .before(*before_hooks)
+              .after(*after_hooks)
           end
 
           # Set command to associate tuples with a parent tuple using provided keys
@@ -96,7 +129,9 @@ module ROM
                     "#{name} association is already defined for #{self.class}"
             end
 
-            associations(associations.merge(name => options))
+            associations[name] = options
+
+            self
           end
         end
 
@@ -109,6 +144,8 @@ module ROM
           # @return [Array<Hash>]
           #
           # @api public
+          #
+          # rubocop:disable Lint/UnusedMethodArgument
           def associate(tuples, curried_parent = nil, assoc:, keys:, parent: curried_parent)
             result_type = result
 
@@ -137,6 +174,7 @@ module ROM
 
             result_type == :one ? output_tuples[0] : output_tuples
           end
+          # rubocop:enable Lint/UnusedMethodArgument
 
           # Return a new command with the provided association
           #

data/lib/rom/sql/plugin/pagination.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
-require 'rom/initializer'
+require "dry/core/equalizer"
+
+require "rom/initializer"
 
 module ROM
   module SQL
@@ -53,7 +55,7 @@ module ROM
           # @api public
           def prev_page
             num = current_page - 1
-            num if num > 0
+            num if num.positive?
           end
 
           # Return total number of tuples
@@ -100,7 +102,7 @@ module ROM
             per_page = per_page.to_i
 
             self.class.new(
-              dataset.offset((current_page-1)*per_page).limit(per_page),
+              dataset.offset((current_page - 1) * per_page).limit(per_page),
               current_page: current_page, per_page: per_page
             )
           end

data/lib/rom/sql/plugin/schema_indexes.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "dry/effects"
+require "rom/sql/schema/index_dsl"
+
+module ROM
+  module SQL
+    module Plugin
+      module SchemaIndexes
+        # @api public
+        module DSL
+          # Define indexes within a block
+          #
+          # @api public
+          def indexes(&block)
+            index_dsl.instance_eval(&block)
+          end
+
+          # @api private
+          def configure
+            super
+            config.options.update(indexes: index_dsl.(config.id, attributes.values))
+          end
+
+          private
+
+          # @api private
+          def index_dsl
+            @index_dsl ||= Schema::IndexDSL.new(attr_class: config.attr_class)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rom/sql/plugins.rb

@@ -1,16 +1,19 @@
 # frozen_string_literal: true
 
-require 'rom/plugins/relation/sql/instrumentation'
-require 'rom/plugins/relation/sql/auto_restrictions'
+require "rom/plugins/relation/sql/instrumentation"
+require "rom/plugins/relation/sql/default_views"
+require "rom/plugins/relation/sql/auto_restrictions"
 
-require 'rom/sql/plugin/associates'
-require 'rom/sql/plugin/nullify'
-require 'rom/sql/plugin/pagination'
+require "rom/sql/plugin/associates"
+require "rom/sql/plugin/nullify"
+require "rom/sql/plugin/pagination"
+require "rom/sql/plugin/schema_indexes"
 
 ROM.plugins do
-  adapter :sql do
+  adapter(:sql) do
     register :nullify, ROM::SQL::Plugin::Nullify, type: :relation
     register :pagination, ROM::SQL::Plugin::Pagination, type: :relation
     register :associates, ROM::SQL::Plugin::Associates, type: :command
+    register :indexes, ROM::SQL::Plugin::SchemaIndexes, type: :schema
   end
 end

data/lib/rom/sql/projection_dsl.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'rom/sql/dsl'
-require 'rom/sql/function'
+require "rom/sql/dsl"
+require "rom/sql/function"
 
 module ROM
   module SQL

data/lib/rom/sql/rake_task.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 
-require 'rake'
-load 'rom/sql/tasks/migration_tasks.rake'
+require "rake"
+load "rom/sql/tasks/migration_tasks.rake"