rom-sql 3.0.0 → 3.3.1

data/lib/rom/sql/order_dsl.rb

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

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rom/sql/associations'
 
 module ROM
@@ -48,7 +50,7 @@ module ROM
           # @see ROM::Command::ClassInterface.build
           #
           # @api public
-          def build(relation, options = EMPTY_HASH)
+          def build(relation, **options)
             command = super
 
             configured_assocs = command.configured_associations
@@ -146,7 +148,7 @@ module ROM
           def with_association(name, opts = EMPTY_HASH)
             self.class.build(
               relation,
-              { **options, associations: associations.merge(name => opts) }
+              **options, associations: associations.merge(name => opts)
             )
           end
         end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module ROM
+  module SQL
+    module Plugin
+      # Nullify relation by
+      #
+      # @api public
+      module Nullify
+        if defined? JRUBY_VERSION
+          # Returns a relation that will never issue a query to the database. It
+          # implements the null object pattern for relations.
+          # Dataset#nullify doesn't work on JRuby, hence we fall back to SQL
+          #
+          # @api public
+          def nullify
+            where { `1 = 0` }
+          end
+        else
+          # Returns a relation that will never issue a query to the database. It
+          # implements the null object pattern for relations.
+          #
+          # @see http://sequel.jeremyevans.net/rdoc-plugins/files/lib/sequel/extensions/null_dataset_rb.html
+          # @example result will always be empty, regardless if records exists
+          #   users.where(name: 'Alice').nullify
+          #
+          # @return [SQL::Relation]
+          #
+          # @api public
+          def nullify
+            new(dataset.where { `1 = 0` }.__send__(__method__))
+          end
+        end
+      end
+    end
+  end
+end

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

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

data/lib/rom/sql/plugins.rb

@@ -1,11 +1,15 @@
+# frozen_string_literal: true
+
 require 'rom/plugins/relation/sql/instrumentation'
 require 'rom/plugins/relation/sql/auto_restrictions'
 
 require 'rom/sql/plugin/associates'
+require 'rom/sql/plugin/nullify'
 require 'rom/sql/plugin/pagination'
 
 ROM.plugins 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
   end

data/lib/rom/sql/projection_dsl.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rom/sql/dsl'
 require 'rom/sql/function'
 
@@ -29,7 +31,7 @@ module ROM
       #   users.select { function(:count, :id).as(:total) }
       #
       # @param [Symbol] name SQL function
-      # @param [Symbol] attr
+      # @param [Symbol] attrs
       #
       # @return [Rom::SQL::Function]
       #

data/lib/rom/sql/rake_task.rb

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

data/lib/rom/sql/relation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rom/sql/types'
 require 'rom/sql/schema'
 require 'rom/sql/attribute'
@@ -35,7 +37,7 @@ module ROM
           table = opts[:from].first
 
           if db.table_exists?(table)
-            select(*schema.map(&:qualified)).order(*schema.project(*schema.primary_key_names).qualified)
+            select(*schema.qualified_projection).order(*schema.project(*schema.primary_key_names).qualified)
           else
             self
           end

data/lib/rom/sql/relation/reading.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rom/support/inflector'
 require 'rom/sql/join_dsl'
 
@@ -807,7 +809,16 @@ module ROM
         #
         # @api public
         def union(relation, options = EMPTY_HASH, &block)
-          new(dataset.__send__(__method__, relation.dataset, options, &block))
+          # We use the original relation name here if both relations have the
+          # same name. This makes it so if the user at some point references
+          # the relation directly by name later on things won't break in
+          # confusing ways.
+          same_relation = name == relation.name
+          alias_name =  same_relation ? name : "#{name.to_sym}__#{relation.name.to_sym}"
+          opts = { alias: alias_name.to_sym, **options }
+
+          new_schema = schema.qualified(opts[:alias])
+          new_schema.(new(dataset.__send__(__method__, relation.dataset, opts, &block)))
         end
 
         # Checks whether a relation has at least one tuple
@@ -882,8 +893,8 @@ module ROM
         #   @yieldparam relation [Array]
         #
         # @api public
-        def lock(options = EMPTY_HASH, &block)
-          clause = lock_clause(options)
+        def lock(**options, &block)
+          clause = lock_clause(**options)
 
           if block
             transaction do
@@ -986,7 +997,7 @@ module ROM
         # @return [SQL::Attribute]
         def query
           attr = schema.to_a[0]
-          subquery = schema.project(attr).(self).dataset.unordered
+          subquery = schema.project(attr).(self).dataset
           SQL::Attribute[attr.type].meta(sql_expr: subquery)
         end
 
@@ -1002,6 +1013,21 @@ module ROM
           new(dataset.__send__(__method__))
         end
 
+        # Wrap other relations using association names
+        #
+        # @example
+        #   tasks.wrap(:owner)
+        #
+        # @param [Array<Symbol>] names A list with association identifiers
+        #
+        # @return [Wrap]
+        #
+        # @api public
+        def wrap(*names)
+          others = names.map { |name| associations[name].wrapped }
+          wrap_around(*others)
+        end
+
         private
 
         # Build a locking clause
@@ -1012,7 +1038,7 @@ module ROM
           stmt << ' OF ' << Array(of).join(', ') if of
 
           if skip_locked
-            raise ArgumentError, "SKIP LOCKED cannot be used with (NO)WAIT clause" if !wait.nil?
+            raise ArgumentError, 'SKIP LOCKED cannot be used with (NO)WAIT clause' if !wait.nil?
 
             stmt << ' SKIP LOCKED'
           else
@@ -1048,9 +1074,11 @@ module ROM
         # @api private
         def __join__(type, other, join_cond = EMPTY_HASH, opts = EMPTY_HASH, &block)
           if other.is_a?(Symbol) || other.is_a?(ROM::Relation::Name)
-            if join_cond.empty?
+            if join_cond.equal?(EMPTY_HASH) && !block
               assoc = associations[other]
               assoc.join(type, self)
+            elsif block
+              __join__(type, other, JoinDSL.new(schema).(&block), opts)
             else
               new(dataset.__send__(type, other.to_sym, join_cond, opts, &block))
             end
@@ -1066,7 +1094,7 @@ module ROM
                 join_opts = EMPTY_HASH
               end
 
-              new(dataset.__send__(type, other.name.to_sym, join_cond, join_opts))
+              new(dataset.__send__(type, other.name.dataset.to_sym, join_cond, join_opts))
             else
               associations[other.name.key].join(type, self, other)
             end

data/lib/rom/sql/relation/writing.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ROM
   module SQL
     class Relation < ROM::Relation

data/lib/rom/sql/restriction_dsl.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rom/sql/dsl'
 
 module ROM
@@ -6,7 +8,13 @@ module ROM
     class RestrictionDSL < DSL
       # @api private
       def call(&block)
-        instance_exec(select_relations(block.parameters), &block)
+        arg, kwargs = select_relations(block.parameters)
+
+        if kwargs.nil?
+          instance_exec(arg, &block)
+        else
+          instance_exec(**kwargs, &block)
+        end
       end
 
       private

data/lib/rom/sql/schema.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rom/schema'
 
 require 'rom/sql/schema/dsl'
@@ -65,6 +67,18 @@ module ROM
         new(map { |attr| attr.qualified(table_alias) })
       end
 
+      # Return a new schema with attributes that are aliased
+      # and marked as qualified
+      #
+      # Intended to be used when passing attributes to `dataset#select`
+      #
+      # @return [Schema]
+      #
+      # @api public
+      def qualified_projection(table_alias = nil)
+        new(map { |attr| attr.qualified_projection(table_alias) })
+      end
+
       # Project a schema
       #
       # @see ROM::Schema#project
@@ -127,7 +141,7 @@ module ROM
       #
       # @api public
       def call(relation)
-        relation.new(relation.dataset.select(*self), schema: self)
+        relation.new(relation.dataset.select(*self.qualified_projection), schema: self)
       end
 
       # Return an empty schema
@@ -142,7 +156,7 @@ module ROM
       # Finalize all attributes by qualifying them and initializing primary key names
       #
       # @api private
-      def finalize_attributes!(options = EMPTY_HASH)
+      def finalize_attributes!(**options)
         super do
           @attributes = map(&:qualified)
         end

data/lib/rom/sql/schema/attributes_inferrer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'dry/core/class_attributes'
 
 module ROM
@@ -22,8 +24,8 @@ module ROM
 
           columns = filter_columns(gateway.connection.schema(dataset))
 
-          inferred = columns.map do |(name, definition)|
-            type = type_builder.(definition)
+          inferred = columns.map do |name, definition|
+            type = type_builder.(**definition)
 
             attr_class.new(type.meta(source: schema.name), name: name) if type
           end.compact
@@ -42,7 +44,7 @@ module ROM
 
         # @api private
         def filter_columns(schema)
-          schema.reject { |(_, definition)| definition[:db_type] == CONSTRAINT_DB_TYPE }
+          schema.reject { |_, definition| definition[:db_type] == CONSTRAINT_DB_TYPE }
         end
       end
     end

data/lib/rom/sql/schema/dsl.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rom/sql/schema/index_dsl'
 
 module ROM
@@ -15,7 +17,7 @@ module ROM
         #
         # @api public
         def indexes(&block)
-          @index_dsl = IndexDSL.new(options, &block)
+          @index_dsl = IndexDSL.new(**options, &block)
         end
 
         private

data/lib/rom/sql/schema/index_dsl.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'set'
 
 module ROM
@@ -19,6 +21,7 @@ module ROM
 
           instance_exec(&block)
         end
+        ruby2_keywords(:initialize) if respond_to?(:ruby2_keywords, true)
 
         # @api public
         def index(*attributes, **options)
@@ -28,7 +31,7 @@ module ROM
         # @api private
         def call(schema_name, attrs)
           attributes = attrs.map do |attr|
-            attr_class.new(attr[:type], attr[:options] || {}).meta(source: schema_name)
+            attr_class.new(attr[:type], **(attr[:options] || {})).meta(source: schema_name)
           end
 
           registry.map { |attr_names, options|
@@ -44,7 +47,7 @@ module ROM
             attributes.find { |a| a.name == name }.unwrap
           end
 
-          Index.new(index_attributes, options)
+          Index.new(index_attributes, **options)
         end
       end
     end

data/lib/rom/sql/schema/inferrer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'set'
 
 require 'rom/sql/schema/type_builder'
@@ -32,9 +34,9 @@ module ROM
         # @api private
         def call(schema, gateway)
           if enabled?
-            infer_from_database(gateway, schema, super)
+            infer_from_database(gateway, schema, **super)
           else
-            infer_from_attributes(gateway, schema, super)
+            infer_from_attributes(gateway, schema, **super)
           end
         rescue Sequel::Error => error
           on_error(schema.name, error)
@@ -54,7 +56,7 @@ module ROM
         end
 
         # @api private
-        def infer_from_attributes(gateway, schema, attributes:, **rest)
+        def infer_from_attributes(_gateway, schema, attributes:, **rest)
           indexes = schema.indexes | indexes_from_attributes(attributes)
           foreign_keys = foreign_keys_from_attributes(attributes)
 
@@ -69,7 +71,8 @@ module ROM
           if gateway.connection.respond_to?(:indexes)
             dataset = schema.name.dataset
 
-            gateway.connection.indexes(dataset).map { |index_name, columns:, unique:, **rest|
+            gateway.connection.indexes(dataset).map { |index_name, definition|
+              columns, unique = definition.values_at(:columns, :unique)
               attrs = columns.map { |name| attributes[name] }
 
               SQL::Index.new(attrs, name: index_name, unique: unique)
@@ -83,7 +86,8 @@ module ROM
         def foreign_keys_from_database(gateway, schema, attributes)
           dataset = schema.name.dataset
 
-          gateway.connection.foreign_key_list(dataset).map { |columns:, table:, key:, **rest|
+          gateway.connection.foreign_key_list(dataset).map { |definition|
+            columns, table, key = definition.values_at(:columns, :table, :key)
             attrs = columns.map { |name| attributes[name] }
 
             SQL::ForeignKey.new(attrs, table, parent_keys: key)
@@ -147,9 +151,9 @@ module ROM
             raise e
           elsif !silent
             warn "[#{dataset}] failed to infer schema. " \
-                 "Make sure tables exist before ROM container is set up. " \
-                 "This may also happen when your migration tasks load ROM container, " \
-                 "which is not needed for migrations as only the connection is required " \
+                 'Make sure tables exist before ROM container is set up. ' \
+                 'This may also happen when your migration tasks load ROM container, ' \
+                 'which is not needed for migrations as only the connection is required ' \
                  "(#{e.message})"
           end
         end

data/lib/rom/sql/schema/type_builder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ROM
   module SQL
     class Schema
@@ -37,9 +39,9 @@ module ROM
 
         def call(primary_key:, db_type:, type:, allow_null:, **rest)
           if primary_key
-            map_pk_type(type, db_type, rest)
+            map_pk_type(type, db_type, **rest)
           else
-            mapped_type = map_type(type, db_type, rest)
+            mapped_type = map_type(type, db_type, **rest)
 
             if mapped_type
               read_type = mapped_type.meta[:read]

data/lib/rom/sql/spec/support.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 if defined? JRUBY_VERSION
   USING_JRUBY = true
 else
@@ -5,15 +7,15 @@ else
 end
 
 if USING_JRUBY
-  SEQUEL_TEST_DB_URI = "jdbc:sqlite::memory:"
+  SEQUEL_TEST_DB_URI = 'jdbc:sqlite::memory:'
 else
-  SEQUEL_TEST_DB_URI = "sqlite::memory"
+  SEQUEL_TEST_DB_URI = 'sqlite::memory'
 end
 
 DB = Sequel.connect(SEQUEL_TEST_DB_URI)
 
 def seed(db = DB)
-  db.run("CREATE TABLE users (id INTEGER PRIMARY KEY, name STRING)")
+  db.run('CREATE TABLE users (id INTEGER PRIMARY KEY, name STRING)')
 
   db[:users].insert(id: 1, name: 'Jane')
   db[:users].insert(id: 2, name: 'Joe')