rom-sql 3.7.0 → 4.0.0.alpha1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a9c8d40ae3b5ea461ba889492c74ad82533ac881777d6aa2d8b120cb9c0196d
-  data.tar.gz: 3965d8abb7bf6a215b9c76ffe1acc4e697d9e9c4c07cd0ed1f33840cb089111f
+  metadata.gz: a6a932fc53433b38ce71cb363a4e29e4fef4f949849f47d2b4f2bb2bc8e6cf35
+  data.tar.gz: da89ced65458c9facaffe74e365eb8bf81f0ee18718aba6b2e92da0717ef0f5c
 SHA512:
-  metadata.gz: 10ccbbcb73895cb55a998ff673666878f7ae4d103aca84ba286fa0f0b4b0a0ce068524a6d110cf9ffd0139f5b9eef8a6c7b7f40e407d4f9b6a72eba314d6af28
-  data.tar.gz: 2c4aa7721bb02e20edd71d574ab878c405a6325a53602e77a71d30c72eb0c249033aa20944aca2460047c0a0be0def9534dd0ef611d627e4f6710743cb829df5
+  metadata.gz: e6648c04e92f83b529942d6b46587e577523b27aba2bfd0cdacfd37c69a8594ca0bf63df564d8f13ec288dece1e837e9163eab96eeb068b455dab00567b9fe44
+  data.tar.gz: ef78eaaacc3810bc7accf3e3fa5fc38df951f20b4df0ed57dd333adba2a90d450aebf84318d81541b2770731f1b4af21289ad66040c3d822ba4e240dd0bfb056

data/CHANGELOG.md

@@ -1,83 +1,29 @@
 <!--- DO NOT EDIT THIS FILE - IT'S AUTOMATICALLY GENERATED VIA DEVTOOLS --->
 
-## 3.7.0 2025-01-08
-
-### Changed
-
-- Minimum Ruby version is now 3.1 (@flash-gordon)
-
-[Compare v3.6.5...v3.7.0](https://github.com/rom-rb/rom-sql/compare/v3.6.5...v3.7.0)
-
-## 3.6.5 2024-12-25
-
-
-### Fixed
-
-- Fix syntax error under Ruby 3.4 (@flash-gordon)
-
-[Compare v3.6.4...v3.6.5](https://github.com/rom-rb/rom-sql/compare/v3.6.4...v3.6.5)
-
-## 3.6.4 2024-07-01
-
-
-### Fixed
-
-- Excessive logging when same gateway is shared between multiple containers (@flash-gordon)
-- Warning about using color option from active-support log subscriber (@flash-gordon + @bendangelo)
-
-
-[Compare v3.6.3...v3.6.4](https://github.com/rom-rb/rom-sql/compare/v3.6.3...v3.6.4)
-
-## 3.6.3 2024-05-06
-
-
-### Fixed
-
-- Fix using `.filter` with a block for aggregate functions (@flash-gordon)
+## 4.0.0.alpha1 2022-04-15
 
+See [rom 6.0 upgrade guide](https://github.com/rom-rb/rom/wiki/6.0-Upgrade-Guide).
 
-[Compare v3.6.2...v3.6.3](https://github.com/rom-rb/rom-sql/compare/v3.6.2...v3.6.3)
-
-## 3.6.2 2024-01-09
-
-
-### Fixed
-
-- Fix Hash.new warning in Ruby 3.3 (@flash-gordon)
-
-
-[Compare v3.6.1...v3.6.2](https://github.com/rom-rb/rom-sql/compare/v3.6.1...v3.6.2)
+### Changed
 
-## 3.6.1 2022-11-22
+- [internal] all plugins have been ported to the new API (via #402) (@solnic)
+- [internal] `:default_views` plugin was added and it's enabled by default (via #402) (@solnic)
+- [internal] `indexes` schema DSL is now a plugin called `:schema_indexes` (via #402) (@solnic)
+- [internal] `Gateway#command` is now used to instantiate sql-specific commands (via #402) (@solnic)
 
-### Fixed
+[Compare v3.5.0...v4.0.0.alpha1](https://github.com/rom-rb/rom-sql/compare/v3.5.0...v4.0.0.alpha1)
 
-- Mapping of cidr types in PostgreSQL to IPAddr values (@flash-gordon)
-
-[Compare v3.6.0...v3.6.1](https://github.com/rom-rb/rom-sql/compare/v3.6.0...v3.6.1)
+## 3.5.0 2021-03-26
 
-## 3.6.0 2022-11-11
 
 ### Added
 
-- Add ROM::SQL::RakeSupport.migration_options for passing custom options to migrator (@wuarmin)
-
-### Changed
-
-- Upgraded to the latest versions of dry-rb dependencies, compatible with rom 5.3 (@flash-gordon)
-
-[Compare v3.5.0...v3.6.0](https://github.com/rom-rb/rom-sql/compare/v3.5.0...v3.6.0)
-
-## 3.5.0 2021-03-26
-
+- Support for using partial indixes in PG upsert commands (issue #394 fixed via #395) (@smaximov)
 
 ### Fixed
 
-- Restored the fix for #390 that was lost by an accident in 3.3.3 and 3.4.0 (@solnic)
+- Restore the fix for #390 that was lost by an accident in 3.3.3 and 3.4.0 (@solnic)
 
-### Added
-
-- Support for using partial indixes in PG upsert commands (issue #394 fixed via #395) (@smaximov)
 
 [Compare v3.4.0...v3.5.0](https://github.com/rom-rb/rom-sql/compare/v3.4.0...v3.5.0)
 

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-2020 rom-rb team
+Copyright (c) 2015-2021 rom-rb team
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

data/README.md

@@ -10,7 +10,7 @@
 [![CI Status](https://github.com/rom-rb/rom-sql/workflows/ci/badge.svg)][actions]
 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/8e2cbaf78af44185876c8fa41540d7ea)][codacy]
 [![Codacy Badge](https://api.codacy.com/project/badge/Coverage/8e2cbaf78af44185876c8fa41540d7ea)][codacy]
-[![Inline docs](http://inch-ci.org/github/rom-rb/rom-sql.svg?branch=master)][inchpages]
+[![Inline docs](http://inch-ci.org/github/rom-rb/rom-sql.svg?branch=main)][inchpages]
 
 ## Links
 
@@ -21,7 +21,8 @@
 
 This library officially supports the following Ruby versions:
 
-* MRI >= `3.1`
+* MRI >= `2.5`
+* jruby >= `9.2`
 
 ## License
 

data/lib/rom/plugins/relation/sql/auto_restrictions.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'rom/support/notifications'
+require "dry/effects"
 
 module ROM
   module Plugins
@@ -27,20 +27,19 @@ module ROM
         #
         # @api public
         module AutoRestrictions
-          extend Notifications::Listener
+          extend Dry::Effects.Reader(:registry)
 
-          subscribe('configuration.relations.schema.set', adapter: :sql) do |event|
-            schema = event[:schema]
-            relation = event[:relation]
+          # @api private
+          def self.apply(target, **)
+            methods, mod = AutoRestrictions.restriction_methods(registry.schemas.canonical(target))
 
-            methods, mod = AutoRestrictions.restriction_methods(schema)
-            relation.include(mod)
-            methods.each { |meth| relation.auto_curry(meth) }
+            target.class_eval do
+              include(mod)
+              methods.each { |meth| auto_curry(meth) }
+            end
           end
 
           # @api private
-          #
-          # rubocop:disable Metrics/AbcSize
           def self.restriction_methods(schema)
             mod = Module.new
 
@@ -74,14 +73,13 @@ module ROM
             [methods, mod]
           end
         end
-        # rubocop:enable Metrics/AbcSize
       end
     end
   end
 end
 
 ROM.plugins do
-  adapter :sql do
+  adapter(:sql) do
     register :auto_restrictions, ROM::Plugins::Relation::SQL::AutoRestrictions, type: :relation
   end
 end

data/lib/rom/plugins/relation/sql/default_views.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require "dry/effects"
+
+module ROM
+  module Plugins
+    module Relation
+      module SQL
+        # @api private
+        module DefaultViews
+          extend Dry::Effects.Reader(:registry)
+
+          # @api private
+          def self.apply(target, **)
+            define_default_views!(target, registry.schemas.canonical(target))
+          end
+
+          # @api private
+          def self.define_default_views!(target, schema)
+            if schema.primary_key.size > 1
+              # @!method by_pk(val1, val2)
+              #   Return a relation restricted by its composite primary key
+              #
+              #   @param [Array] args A list with composite pk values
+              #
+              #   @return [SQL::Relation]
+              #
+              #   @api public
+              target.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+                undef :by_pk if method_defined?(:by_pk)
+
+                def by_pk(#{schema.primary_key.map(&:name).join(", ")})
+                  where(#{schema.primary_key.map { |attr| "schema.canonical[:#{attr.name}] => #{attr.name}" }.join(", ")})
+                end
+              RUBY
+            else
+              # @!method by_pk(pk)
+              #   Return a relation restricted by its primary key
+              #
+              #   @param [Object] pk The primary key value
+              #
+              #   @return [SQL::Relation]
+              #
+              #   @api public
+              target.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+                undef :by_pk if method_defined?(:by_pk)
+
+                def by_pk(pk)
+                  if primary_key.nil?
+                    raise MissingPrimaryKeyError.new(
+                      "Missing primary key for :\#{schema.name}"
+                    )
+                  end
+                  where(schema.canonical[schema.canonical.primary_key_name].qualified => pk)
+                end
+              RUBY
+            end
+          end
+
+          # @api private
+          def self.primary_key_columns(db, table)
+            names = db.respond_to?(:primary_key) ? Array(db.primary_key(table)) : [:id]
+            names.map { |col| :"#{table}__#{col}" }
+          end
+        end
+      end
+    end
+  end
+end
+
+ROM.plugins do
+  adapter(:sql) do
+    register :default_views, ROM::Plugins::Relation::SQL::DefaultViews, type: :relation
+  end
+end

data/lib/rom/plugins/relation/sql/instrumentation.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "dry/effects"
+
 module ROM
   module Plugins
     module Relation
@@ -26,24 +28,14 @@ module ROM
         #
         # @api public
         module Instrumentation
-          extend Notifications::Listener
-
-          subscribe('configuration.relations.registry.created') do |event|
-            registry = event[:registry]
+          extend Dry::Effects.Reader(:registry)
 
-            relations = registry.select { |_, r|
-              r.adapter == :sql && r.respond_to?(:notifications)
-            }.to_h
-            db_notifications = relations.values.map { |r|
-              [r.dataset.db, r.notifications]
-            }.uniq.to_h
+          def self.apply(target, notifications:, **)
+            db = registry.gateways[target.config.component.gateway].connection
 
-            db_notifications.each do |db, notifications|
-              next if db.respond_to?(:rom_instrumentation?)
+            return if db.respond_to?(:rom_instrumentation?)
 
-              instrumenter = Instrumenter.new(db.database_type, notifications)
-              db.extend(instrumenter)
-            end
+            db.extend(Instrumenter.new(db.database_type, notifications))
           end
 
           # This stateful module is used to extend database connection objects
@@ -63,7 +55,6 @@ module ROM
             # @api private
             def initialize(name, notifications)
               super()
-
               @name = name
               @notifications = notifications
               define_log_connection_yield
@@ -100,7 +91,7 @@ module ROM
 end
 
 ROM.plugins do
-  adapter :sql do
+  adapter(:sql) do
     register :instrumentation, ROM::Plugins::Relation::SQL::Instrumentation, type: :relation
   end
 end

data/lib/rom/plugins/relation/sql/postgres/explain.rb

@@ -26,17 +26,17 @@ module ROM
             #
             # @api public
             def explain(format: :text, **options)
-              bool_options = options.map { "#{_1.to_s.upcase} #{!!_2}" } # rubocop:disable Style/DoubleNegation
+              bool_options = options.map { |opt, value| "#{opt.to_s.upcase} #{!!value}" }
               format_option = "FORMAT #{format.to_s.upcase}"
-              explain_value = [format_option, *bool_options].join(', ')
+              explain_value = [format_option, *bool_options].join(", ")
 
               query = "EXPLAIN (#{explain_value}) #{dataset.sql}"
 
-              rows = dataset.with_sql(query).map(:'QUERY PLAN')
+              rows = dataset.with_sql(query).map(:"QUERY PLAN")
 
               case format
               when :json
-                rows[0][0]['Plan']
+                rows[0][0]["Plan"]
               else
                 rows.join("\n")
               end
@@ -49,7 +49,7 @@ module ROM
 end
 
 ROM.plugins do
-  adapter :sql do
+  adapter(:sql) do
     register :pg_explain, ROM::Plugins::Relation::SQL::Postgres::Explain, type: :relation
   end
 end

data/lib/rom/plugins/relation/sql/postgres/full_text_search.rb

@@ -13,48 +13,32 @@ module ROM
             # By default, searching for the inclusion of any of the terms in any of the cols.
             #
             # @example
-            #   posts.full_text_search([:title, :content], 'apples', language: 'english')
             #   # => Relation which match the 'apples' phrase
+            #   posts.full_text_search([:title, :content], 'apples', language: 'english')
             #
-            # @option :headline [String]
-            #   Append a expression to the selected columns aliased
-            #   to headline that contains an extract of the matched text.
-            #
-            # @option :language [String]
-            #   The language to use for the search (default: 'simple')
-            #
-            # @option :plain [Boolean]
-            #   Whether a plain search should be used (default: false).
-            #   In this case, terms should be a single string, and it will do a search
-            #   where cols contains all of the words in terms.
+            # @option :headline [String] Append a expression to the selected columns aliased to headline that contains
+            #   an extract of the matched text.
+            # @option :language [String] The language to use for the search (default: 'simple')
+            # @option :plain [Boolean] Whether a plain search should be used (default: false). In this case, terms
+            #   should be a single string, and it will do a search where cols contains all of the words in terms.
             #   This ignores search operators in terms.
-            #
-            # @option :phrase [Boolean]
-            #   Similar to :plain, but also adding an ILIKE filter to ensure
-            #   that returned rows also include the exact phrase used.
-            #
-            # @option :rank [Boolean]
-            #   Set to true to order by the rank, so that closer matches are returned first.
-            #
-            # @option :to_tsquery [Symbol]
-            #   Can be set to :plain or :phrase to specify the function to use
-            #   to convert the terms to a ts_query.
-            #
-            # @option :tsquery [Boolean]
-            #   Specifies the terms argument is already a valid SQL expression returning a tsquery,
-            #   and can be used directly in the query.
-            #
-            # @option :tsvector [Boolean]
-            #   Specifies the cols argument is already a valid SQL expression returning a tsvector,
-            #   and can be used directly in the query.
+            # @option :phrase [Boolean] Similar to :plain, but also adding an ILIKE filter to ensure that returned rows
+            #   also include the exact phrase used.
+            # @option :rank [Boolean] Set to true to order by the rank, so that closer matches are returned first.
+            # @option :to_tsquery [Symbol] Can be set to :plain or :phrase to specify the function to use to convert
+            #   the terms to a ts_query.
+            # @option :tsquery [Boolean] Specifies the terms argument is already a valid SQL expression returning
+            #    a tsquery, and can be used directly in the query.
+            # @option :tsvector [Boolean] Specifies the cols argument is already a valid SQL expression returning
+            #   a tsvector, and can be used directly in the query.
             #
             # @return [Relation]
             #
             # @see https://www.postgresql.org/docs/current/textsearch.html PostgreSQL docs
             #
             # @api public
-            def full_text_search(...)
-              new dataset.__send__(__method__, ...)
+            def full_text_search(*args, &block)
+              new dataset.__send__(__method__, *args, &block)
             end
           end
         end
@@ -64,9 +48,8 @@ module ROM
 end
 
 ROM.plugins do
-  adapter :sql do
-    register :pg_full_text_search,
-             ROM::Plugins::Relation::SQL::Postgres::FullTextSearch,
-             type: :relation
+  adapter(:sql) do
+    register :pg_full_text_search, ROM::Plugins::Relation::SQL::Postgres::FullTextSearch,
+type: :relation
   end
 end

data/lib/rom/plugins/relation/sql/postgres/streaming.rb

@@ -9,30 +9,33 @@ module ROM
           #
           # @api public
           module Streaming
-            extend Notifications::Listener
+            extend Dry::Effects.Reader(:registry)
 
             class StreamingNotSupportedError < StandardError; end
 
-            subscribe('configuration.gateway.connected') do |opts|
-              conn = opts[:connection]
+            def self.apply(target, **_opts)
+              conn = registry.gateways[target.config.component.gateway].connection
 
-              next unless conn.database_type.to_sym == :postgres
+              return unless conn.database_type.to_sym == :postgres
 
-              next if defined?(JRUBY_VERSION)
+              return if defined?(JRUBY_VERSION)
 
               begin
-                require 'sequel_pg'
+                require "sequel_pg"
               rescue LoadError
-                raise StreamingNotSupportedError, 'add sequel_pg to Gemfile to use pg_streaming'
+                raise StreamingNotSupportedError, "add sequel_pg to Gemfile to use pg_streaming"
               end
 
               unless Sequel::Postgres.supports_streaming?
-                raise StreamingNotSupportedError, 'postgres version does not support streaming'
+                raise StreamingNotSupportedError, "postgres version does not support streaming"
               end
 
               conn.extension(:pg_streaming)
+
+              target.include(Streaming)
             end
 
+            # @api private
             def self.included(klass)
               super
               ROM::Relation::Graph.include(Combined)
@@ -46,13 +49,13 @@ module ROM
               # @see https://github.com/jeremyevans/sequel_pg#streaming- sequel_pg docs
               #
               # @example
-              #   posts.steam_each { |post| puts CSV.generate_line(post) }
+              #   posts.stream_each { |post| puts CSV.generate_line(post) }
               #
               # @return [Relation]
               #
-              # @api publicY_VERSION
+              # @api public
               def stream_each
-                raise StreamingNotSupportedError, 'not supported on jruby'
+                raise StreamingNotSupportedError, "not supported on jruby"
               end
             else
               # Allows you to stream returned rows one at a time, instead of
@@ -61,7 +64,7 @@ module ROM
               # @see https://github.com/jeremyevans/sequel_pg#streaming- sequel_pg docs
               #
               # @example
-              #   posts.steam_each { |post| puts CSV.generate_line(post) }
+              #   posts.stream_each { |post| puts CSV.generate_line(post) }
               #
               # @return [Relation]
               #
@@ -80,7 +83,7 @@ module ROM
 
               module Combined
                 def stream_each
-                  raise StreamingNotSupportedError, 'not supported on combined relations'
+                  raise StreamingNotSupportedError, "not supported on combined relations"
                 end
               end
 
@@ -102,7 +105,7 @@ module ROM
 end
 
 ROM.plugins do
-  adapter :sql do
+  adapter(:sql) do
     register :pg_streaming, ROM::Plugins::Relation::SQL::Postgres::Streaming, type: :relation
   end
 end

data/lib/rom/sql/associations/many_to_many.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'rom/associations/many_to_many'
-require 'rom/sql/associations/core'
-require 'rom/sql/associations/self_ref'
+require "rom/associations/many_to_many"
+require "rom/sql/associations/core"
+require "rom/sql/associations/self_ref"
 
 module ROM
   module SQL
@@ -12,8 +12,6 @@ module ROM
         include Associations::SelfRef
 
         # @api public
-        #
-        # rubocop:disable Metrics/AbcSize
         def call(target: self.target)
           left = join_assoc.(target: target)
 
@@ -36,7 +34,6 @@ module ROM
             schema.(relation)
           end
         end
-        # rubocop:enable Metrics/AbcSize
 
         # @api public
         def join(type, source = self.source, target = self.target)
@@ -53,7 +50,7 @@ module ROM
 
         # @api public
         def join_keys
-          { source_attr => target_attr }
+          {source_attr => target_attr}
         end
 
         # @api public

data/lib/rom/sql/associations/many_to_one.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'rom/associations/many_to_one'
-require 'rom/sql/associations/core'
-require 'rom/sql/associations/self_ref'
+require "rom/associations/many_to_one"
+require "rom/sql/associations/core"
+require "rom/sql/associations/self_ref"
 
 module ROM
   module SQL
@@ -12,8 +12,6 @@ module ROM
         include Associations::SelfRef
 
         # @api public
-        #
-        # rubocop:disable Metrics/AbcSize
         def call(target: self.target, preload: false)
           if preload
             schema = target.schema.qualified
@@ -43,7 +41,6 @@ module ROM
             schema.(relation)
           end
         end
-        # rubocop:enable Metrics/AbcSize
 
         # @api public
         def join(type, source = self.source, target = self.target)

data/lib/rom/sql/associations/one_to_many.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'rom/associations/one_to_many'
-require 'rom/sql/associations/core'
-require 'rom/sql/associations/self_ref'
+require "rom/associations/one_to_many"
+require "rom/sql/associations/core"
+require "rom/sql/associations/self_ref"
 
 module ROM
   module SQL

data/lib/rom/sql/associations/one_to_one.rb

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

data/lib/rom/sql/associations/one_to_one_through.rb

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

data/lib/rom/sql/associations/self_ref.rb

@@ -11,7 +11,7 @@ module ROM
 
         # @api public
         def join_keys
-          { source_attr => target_attr }
+          {source_attr => target_attr}
         end
 
         # @api public

data/lib/rom/sql/associations.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'rom/sql/associations/many_to_many'
-require 'rom/sql/associations/many_to_one'
-require 'rom/sql/associations/one_to_many'
-require 'rom/sql/associations/one_to_one'
-require 'rom/sql/associations/one_to_one_through'
+require "rom/sql/associations/many_to_many"
+require "rom/sql/associations/many_to_one"
+require "rom/sql/associations/one_to_many"
+require "rom/sql/associations/one_to_one"
+require "rom/sql/associations/one_to_one_through"