rom-sql 3.5.0 → 4.0.0.alpha1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72190a3c5b2df9cf0bc5db0ba2a4cae185f88e87dfa9ad7d0f7cf3967c1fe048
-  data.tar.gz: acd353e5348e8c797275829dacfedb445289e5e76d636df4b5cb7b40c1f48e7b
+  metadata.gz: a6a932fc53433b38ce71cb363a4e29e4fef4f949849f47d2b4f2bb2bc8e6cf35
+  data.tar.gz: da89ced65458c9facaffe74e365eb8bf81f0ee18718aba6b2e92da0717ef0f5c
 SHA512:
-  metadata.gz: 93bc3e2cb1873865a886d221d34ff164a7d83de2ddaec4f6f3d99daf65465a14ded348c546151ae9d44e6eae6ca4dded468cc7386ff4513d6b02bab843485f14
-  data.tar.gz: 6c45fd11d745c05d1f536700c1cb246dd358e09668a406377281486b3d062c366db847dea96e457170e518e104baf64bb296f41613dd0099b5ffb7e839cd7679
+  metadata.gz: e6648c04e92f83b529942d6b46587e577523b27aba2bfd0cdacfd37c69a8594ca0bf63df564d8f13ec288dece1e837e9163eab96eeb068b455dab00567b9fe44
+  data.tar.gz: ef78eaaacc3810bc7accf3e3fa5fc38df951f20b4df0ed57dd333adba2a90d450aebf84318d81541b2770731f1b4af21289ad66040c3d822ba4e240dd0bfb056

data/CHANGELOG.md

@@ -1,16 +1,30 @@
 <!--- DO NOT EDIT THIS FILE - IT'S AUTOMATICALLY GENERATED VIA DEVTOOLS --->
 
-## 3.5.0 2021-03-26
+## 4.0.0.alpha1 2022-04-15
 
+See [rom 6.0 upgrade guide](https://github.com/rom-rb/rom/wiki/6.0-Upgrade-Guide).
 
-### Fixed
+### Changed
+
+- [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)
+
+[Compare v3.5.0...v4.0.0.alpha1](https://github.com/rom-rb/rom-sql/compare/v3.5.0...v4.0.0.alpha1)
+
+## 3.5.0 2021-03-26
 
-- Restored 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)
 
+### Fixed
+
+- Restore the fix for #390 that was lost by an accident in 3.3.3 and 3.4.0 (@solnic)
+
+
 [Compare v3.4.0...v3.5.0](https://github.com/rom-rb/rom-sql/compare/v3.4.0...v3.5.0)
 
 ## 3.4.0 2021-03-19

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
 

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,15 +27,16 @@ 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
@@ -46,7 +47,7 @@ module ROM
               next if index.partial?
 
               attributes = index.to_a
-              meth_name = :"by_#{ attributes.map(&:name).join('_and_') }"
+              meth_name = :"by_#{attributes.map(&:name).join("_and_")}"
 
               next if generated.include?(meth_name)
 
@@ -78,7 +79,7 @@ module ROM
 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,18 +28,14 @@ module ROM
         #
         # @api public
         module Instrumentation
-          extend Notifications::Listener
+          extend Dry::Effects.Reader(:registry)
 
-          subscribe('configuration.relations.registry.created') do |event|
-            registry = event[:registry]
+          def self.apply(target, notifications:, **)
+            db = registry.gateways[target.config.component.gateway].connection
 
-            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
+            return if db.respond_to?(:rom_instrumentation?)
 
-            db_notifications.each do |db, notifications|
-              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
@@ -56,6 +54,7 @@ module ROM
 
             # @api private
             def initialize(name, notifications)
+              super()
               @name = name
               @notifications = notifications
               define_log_connection_yield
@@ -68,6 +67,8 @@ module ROM
               name = self.name
               notifications = self.notifications
 
+              define_method(:rom_instrumentation?) { true }
+
               define_method(:log_connection_yield) do |*args, &block|
                 notifications.instrument(:sql, name: name, query: args[0]) do
                   super(*args, &block)
@@ -90,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

@@ -28,15 +28,15 @@ module ROM
             def explain(format: :text, **options)
               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,23 +13,24 @@ 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
-            #
-            # @option :headline [String] Append a expression to the selected columns aliased to headline that contains an extract of the matched text.
+            #   # => 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.  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 :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 :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]
             #
@@ -47,7 +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,16 +9,16 @@ 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"
@@ -31,8 +31,11 @@ module ROM
               end
 
               conn.extension(:pg_streaming)
+
+              target.include(Streaming)
             end
 
+            # @api private
             def self.included(klass)
               super
               ROM::Relation::Graph.include(Combined)
@@ -46,11 +49,11 @@ 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"
               end
@@ -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]
               #
@@ -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
@@ -17,10 +17,10 @@ module ROM
 
           schema =
             if left.schema.key?(foreign_key)
-              if target != self.target
-                target.schema.merge(join_schema)
-              else
+              if target == self.target
                 left.schema.uniq.project(*columns)
+              else
+                target.schema.merge(join_schema)
               end
             else
               target_schema
@@ -50,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

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"

data/lib/rom/sql/attribute.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
-require 'sequel/core'
-require 'dry/core/cache'
+require "sequel/core"
+require "dry/core/cache"
 
-require 'rom/attribute'
+require "rom/attribute"
 
-require 'rom/sql/type_extensions'
-require 'rom/sql/projection_dsl'
-require 'rom/sql/attribute_wrapping'
-require 'rom/sql/attribute_aliasing'
+require "rom/sql/type_extensions"
+require "rom/sql/projection_dsl"
+require "rom/sql/attribute_wrapping"
+require "rom/sql/attribute_aliasing"
 
 module ROM
   module SQL
@@ -280,7 +280,7 @@ module ROM
       # @return [SQL::Function]
       #
       # @api public
-      def concat(other, sep = ' ')
+      def concat(other, sep = " ")
         Function.new(type).concat(self, sep, other)
       end
 
@@ -366,7 +366,7 @@ module ROM
       def case(mapping)
         mapping = mapping.dup
         otherwise = mapping.delete(:else) do
-          raise ArgumentError, 'provide the default case using the :else keyword'
+          raise ArgumentError, "provide the default case using the :else keyword"
         end
 
         type = mapping.values[0].type

data/lib/rom/sql/attribute_aliasing.rb

@@ -19,8 +19,7 @@ module ROM
           sql_expr: alias_sql_expr(sql_expr, new_alias_name)
         )
       end
-      alias as aliased
-
+      alias_method :as, :aliased
 
       # Return true if this attribute is an aliased projection
       #
@@ -46,7 +45,7 @@ module ROM
       #
       # @api private
       def aliased_projection?
-        self.meta[:sql_expr].is_a?(Sequel::SQL::AliasedExpression)
+        meta[:sql_expr].is_a?(Sequel::SQL::AliasedExpression)
       end
 
       private

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'rom/sql/commands/error_wrapper'
+require "rom/sql/commands/error_wrapper"
 
 module ROM
   module SQL
@@ -9,7 +9,7 @@ module ROM
       #
       # @api public
       class Create < ROM::Commands::Create
-        adapter :sql
+        config.component.adapter = :sql
 
         include ErrorWrapper
 
@@ -60,10 +60,11 @@ module ROM
         # Yields tuples for insertion or return an enumerator
         #
         # @api private
-        def with_input_tuples(tuples)
+        def with_input_tuples(tuples, &block)
           input_tuples = Array([tuples]).flatten(1).map
           return input_tuples unless block_given?
-          input_tuples.each { |tuple| yield(tuple) }
+
+          input_tuples.each(&block)
         end
       end
     end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'rom/sql/commands/error_wrapper'
+require "rom/sql/commands/error_wrapper"
 
 module ROM
   module SQL
@@ -9,7 +9,7 @@ module ROM
       #
       # @api public
       class Delete < ROM::Commands::Delete
-        adapter :sql
+        config.component.adapter = :sql
 
         include ErrorWrapper
 

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'rom/sql/commands/error_wrapper'
+require "rom/sql/commands/error_wrapper"
 
 module ROM
   module SQL
@@ -9,7 +9,7 @@ module ROM
       #
       # @api public
       class Update < ROM::Commands::Update
-        adapter :sql
+        config.component.adapter = :sql
 
         include ErrorWrapper
 
@@ -52,10 +52,11 @@ module ROM
         # Yields tuples for insertion or return an enumerator
         #
         # @api private
-        def with_input_tuples(tuples)
+        def with_input_tuples(tuples, &block)
           input_tuples = Array([tuples]).flatten(1).map
           return input_tuples unless block_given?
-          input_tuples.each { |tuple| yield(tuple) }
+
+          input_tuples.each(&block)
         end
       end
     end

data/lib/rom/sql/commands.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'rom/commands'
+require "rom/commands"
 
-require 'rom/sql/commands/create'
-require 'rom/sql/commands/update'
-require 'rom/sql/commands/delete'
+require "rom/sql/commands/create"
+require "rom/sql/commands/update"
+require "rom/sql/commands/delete"

data/lib/rom/sql/dsl.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'concurrent/map'
-require 'rom/support/inflector'
-require 'rom/constants'
+require "concurrent/map"
+require "rom/support/inflector"
+require "rom/constants"
 
 module ROM
   module SQL