rom-sql 1.0.0.beta3 → 1.0.0.rc1

data/lib/rom/sql/restriction_dsl.rb

@@ -2,6 +2,7 @@ require 'rom/sql/dsl'
 
 module ROM
   module SQL
+    # @api private
     class RestrictionDSL < DSL
       # @api private
       def call(&block)

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

@@ -4,15 +4,50 @@ require 'rom/sql/association'
 module ROM
   module SQL
     class Schema < ROM::Schema
+      # Additional schema DSL for definition SQL associations
+      #
+      # This DSL is exposed in `associations do .. end` blocks in schema defintions.
+      #
+      # @api public
       class AssociationsDSL < BasicObject
-        attr_reader :source, :registry
+        # @!attribute [r] source
+        #   @return [Relation::Name] The source relation
+        attr_reader :source
 
+        # @!attribute [r] registry
+        #   @return [RelationRegistry] Relations registry from a rom container
+        attr_reader :registry
+
+        # @api private
         def initialize(source, &block)
           @source = source
           @registry = {}
           instance_exec(&block)
         end
 
+        # Establish a one-to-many association
+        #
+        # @example using relation identifier
+        #   has_many :tasks
+        #
+        # @example with a :through option
+        #   # this establishes many-to-many association
+        #   has_many :tasks, through: :users_tasks
+        #
+        # @example using aliased association with a custom view
+        #   has_many :posts, as: :published_posts, view: :published
+        #
+        # @example using custom target relation
+        #   has_many :user_posts, relation: :posts
+        #
+        # @param [Symbol] target The target relation identifier
+        # @param [Hash] options A hash with additional options
+        #
+        # @return [Associations::OneToMany]
+        #
+        # @see #many_to_many
+        #
+        # @api public
         def one_to_many(target, options = {})
           if options[:through]
             many_to_many(target, options)
@@ -22,6 +57,22 @@ module ROM
         end
         alias_method :has_many, :one_to_many
 
+        # Establish a one-to-one association
+        #
+        # @example using relation identifier
+        #   one_to_one :addresses, as: :address
+        #
+        # @example with an intermediate join relation
+        #   one_to_one :tasks, as: :priority_task, through: :assignments
+        #
+        # @param [Symbol] target The target relation identifier
+        # @param [Hash] options A hash with additional options
+        #
+        # @return [Associations::OneToOne]
+        #
+        # @see #belongs_to
+        #
+        # @api public
         def one_to_one(target, options = {})
           if options[:through]
             one_to_one_through(target, options)
@@ -30,36 +81,103 @@ module ROM
           end
         end
 
+        # Establish a one-to-one association with a :through option
+        #
+        # @example
+        #   one_to_one_through :users, as: :author, through: :users_posts
+        #
+        # @return [Associations::OneToOneThrough]
+        #
+        # @api public
         def one_to_one_through(target, options = {})
           add(Association::OneToOneThrough.new(source, target, options))
         end
 
+        # Establish a many-to-many association
+        #
+        # @example using relation identifier
+        #   many_to_many :tasks, through: :users_tasks
+        #
+        # @param [Symbol] target The target relation identifier
+        # @param [Hash] options A hash with additional options
+        #
+        # @return [Associations::OneToOne]
+        #
+        # @see #one_to_many
+        #
+        # @api public
         def many_to_many(target, options = {})
           add(Association::ManyToMany.new(source, target, options))
         end
 
+        # Establish a many-to-one association
+        #
+        # @example using relation identifier
+        #   many_to_one :users, as: :author
+        #
+        # @param [Symbol] target The target relation identifier
+        # @param [Hash] options A hash with additional options
+        #
+        # @return [Associations::OneToOne]
+        #
+        # @see #one_to_many
+        #
+        # @api public
         def many_to_one(target, options = {})
           add(Association::ManyToOne.new(source, target, options))
         end
 
+        # Shortcut for many_to_one which sets alias automatically
+        #
+        # @example with an alias (relation identifier is inferred via pluralization)
+        #   belongs_to :user
+        #
+        # @example with an explicit alias
+        #   belongs_to :users, as: :author
+        #
+        # @see #many_to_one
+        #
+        # @return [Associations::ManyToOne]
+        #
+        # @api public
         def belongs_to(name, options = {})
           many_to_one(dataset_name(name), {as: name}.merge(options))
         end
 
+        # Shortcut for one_to_one which sets alias automatically
+        #
+        # @example with an alias (relation identifier is inferred via pluralization)
+        #   one_to_one :address
+        #
+        # @example with an explicit alias and a custom view
+        #   one_to_one :posts, as: :priority_post, view: :prioritized
+        #
+        # @see #one_to_one
+        #
+        # @return [Associations::ManyToOne]
+        #
+        # @api public
         def has_one(name, options = {})
           one_to_one(dataset_name(name), {as: name}.merge(options))
         end
 
+        # Return an association set for a schema
+        #
+        # @return [AssociationSet]
+        #
+        # @api private
         def call
           AssociationSet.new(registry)
         end
 
         private
 
+        # @api private
         def add(association)
           registry[association.name] = association
         end
 
+        # @api private
         def dataset_name(name)
           ::Dry::Core::Inflector.pluralize(name).to_sym
         end

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

@@ -1,23 +1,65 @@
-require 'rom/sql/type'
+require 'rom/sql/attribute'
 require 'rom/sql/schema/inferrer'
 require 'rom/sql/schema/associations_dsl'
 
 module ROM
   module SQL
     class Schema < ROM::Schema
+      # Extended schema DSL
+      #
+      # @api private
       class DSL < ROM::Schema::DSL
         attr_reader :associations_dsl
 
+        # Define associations for a relation
+        #
+        # @example
+        #   class Users < ROM::Relation[:sql]
+        #     schema(infer: true) do
+        #       associations do
+        #         has_many :tasks
+        #         has_many :posts
+        #         has_many :posts, as: :priority_posts, view: :prioritized
+        #         belongs_to :account
+        #       end
+        #     end
+        #   end
+        #
+        #   class Posts < ROM::Relation[:sql]
+        #     schema(infer: true) do
+        #       associations do
+        #         belongs_to :users, as: :author
+        #       end
+        #     end
+        #
+        #     view(:prioritized) do
+        #       where { priority <= 3 }
+        #     end
+        #   end
+        #
+        # @return [AssociationDSL]
+        #
+        # @api public
         def associations(&block)
           @associations_dsl = AssociationsDSL.new(relation, &block)
         end
 
+        # Return a schema
+        #
+        # @api private
         def call
           SQL::Schema.define(
-            relation, opts.merge(attributes: attributes.values, type_class: SQL::Type)
+            relation, opts.merge(attributes: attributes.values, attr_class: SQL::Attribute)
           )
         end
 
+        private
+
+        # Return schema opts
+        #
+        # @return [Hash]
+        #
+        # @api private
         def opts
           opts = { inferrer: inferrer }
 

data/lib/rom/sql/version.rb

@@ -1,5 +1,5 @@
 module ROM
   module SQL
-    VERSION = '1.0.0.beta3'.freeze
+    VERSION = '1.0.0.rc1'.freeze
   end
 end

data/rom-sql.gemspec

@@ -20,9 +20,9 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'sequel', '~> 4.42'
   spec.add_runtime_dependency 'dry-equalizer', '~> 0.2'
-  spec.add_runtime_dependency 'dry-types', '~> 0.9'
+  spec.add_runtime_dependency 'dry-types', '~> 0.9', '>= 0.9.4'
   spec.add_runtime_dependency 'dry-core', '~> 0.2', '>= 0.2.3'
-  spec.add_runtime_dependency 'rom', '~> 3.0.0.beta'
+  spec.add_runtime_dependency 'rom', '~> 3.0.0.rc'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake', '~> 10.0'

data/spec/extensions/sqlite/types_spec.rb

@@ -0,0 +1,11 @@
+RSpec.describe 'ROM::SQL::Types' do
+  describe 'ROM::SQL::Types::SQLite::Object' do
+    let(:type) { ROM::SQL::Types::SQLite::Object }
+
+    it 'passes an object of any type' do
+      [Object.new, 1, true, BasicObject.new].each do |obj|
+        expect(type[obj]).to be obj
+      end
+    end
+  end
+end

data/spec/integration/plugins/associates_spec.rb

@@ -192,4 +192,83 @@ RSpec.describe 'Plugins / :associates' do
       end
     end
   end
+
+  with_adapters :sqlite do
+    context 'with Update command' do
+      subject(:command) do
+        container.commands[:tasks][:update].with_association(:user).by_pk(jane_task[:id])
+      end
+
+      let(:john) do
+        container.commands[:users][:create].call(name: 'John')
+      end
+
+      let(:jane) do
+        container.commands[:users][:create].call(name: 'Jane')
+      end
+
+      let(:jane_task) do
+        container.commands[:tasks][:create].call(user_id: jane[:id], title: 'Jane Task')
+      end
+
+      let(:john_task) do
+        container.commands[:tasks][:create].call(user_id: john[:id], title: 'John Task')
+      end
+
+      before do
+        conf.relation_classes[1].class_eval do
+          schema(infer: true) do
+            associations do
+              belongs_to :user
+            end
+          end
+        end
+
+        conf.commands(:users) do
+          define(:create) do
+            result :one
+          end
+        end
+
+        conf.commands(:tasks) do
+          define(:create) do
+            result :one
+          end
+
+          define(:update) do
+            result :one
+          end
+        end
+      end
+
+      it 'automatically sets FK prior execution' do
+        expect(command.curry(title: 'Another John task').call(john)).
+          to eql(id: jane_task[:id], user_id: john[:id], title: 'Another John task')
+      end
+    end
+  end
+
+  context 'misconfigured assocs', :sqlite do
+    subject(:command) do
+      container.commands[:users][:create]
+    end
+
+    context 'when keys are missing in class-level config' do
+      before do
+        conf.commands(:users) do
+          define(:create) do
+            associates :tasks
+          end
+        end
+      end
+
+      it 'raises error' do
+        expect { command }.
+          to raise_error(
+               ROM::SQL::Plugin::Associates::MissingJoinKeysError,
+               ':create command for :users relation is missing join keys configuration for :tasks association'
+             )
+      end
+    end
+  end
 end

data/spec/integration/schema/inferrer/postgres_spec.rb

@@ -24,6 +24,7 @@ RSpec.describe 'ROM::SQL::Schema::PostgresInferrer', :postgres do
       column :hw_address, "macaddr"
       rainbow :color
       point :center
+      xml :page
     end
   end
 
@@ -69,7 +70,8 @@ RSpec.describe 'ROM::SQL::Schema::PostgresInferrer', :postgres do
           name: :center,
           source: source,
           read: ROM::SQL::Types::PG::PointTR.optional
-        )
+        ),
+        page: ROM::SQL::Types::String.optional.meta(name: :page, source: source)
       )
     end
   end

data/spec/integration/schema/inferrer/sqlite_spec.rb

@@ -7,6 +7,7 @@ RSpec.describe 'ROM::SQL::Schema::SqliteInferrer', :sqlite do
     conn.create_table :test_inferrence do
       tinyint :tiny
       int8 :big
+      column :dummy, nil
     end
   end
 
@@ -31,6 +32,7 @@ RSpec.describe 'ROM::SQL::Schema::SqliteInferrer', :sqlite do
     expect(schema.to_h).to eql(
       tiny: ROM::SQL::Types::Int.optional.meta(name: :tiny, source: source),
       big: ROM::SQL::Types::Int.optional.meta(name: :big, source: source),
+      dummy: ROM::SQL::Types::SQLite::Object.optional.meta(name: :dummy, source: source)
     )
   end
 end

data/spec/shared/database_setup.rb

@@ -21,7 +21,7 @@ shared_context 'database setup' do
     %i(task_tags users_tasks tasks tags
        subscriptions cards accounts
        posts users
-       rabbits carrots
+       rabbits carrots notes
        puppies schema_migrations
     ).each do |name|
       conn.drop_table?(name)
@@ -91,6 +91,15 @@ shared_context 'database setup' do
       String :name, null: false
       TrueClass :cute, null: false, default: true
     end
+
+    conn.create_table :notes do
+      primary_key :id
+      String :text, null: false
+      DateTime :created_at, null: false
+      DateTime :updated_at, null: false
+      DateTime :completed_at
+      Date :written
+    end
   end
 
   after do

data/spec/spec_helper.rb

@@ -47,7 +47,7 @@ Dir[root.join('support/**/*')].each { |f| require f }
 require 'dry/core/deprecations'
 Dry::Core::Deprecations.set_logger!(root.join('../log/deprecations.log'))
 
-ROM::SQL.load_extensions(:postgres)
+ROM::SQL.load_extensions(:postgres, :sqlite)
 
 require 'dry-types'
 module Types

data/spec/support/helpers.rb

@@ -11,11 +11,11 @@ module Helpers
     ROM::SQL::Schema.define(
       name,
       attributes: attrs.map { |key, value| value.meta(name: key, source: ROM::Relation::Name.new(name)) },
-      type_class: ROM::SQL::Type
+      attr_class: ROM::SQL::Attribute
     )
   end
 
   def define_type(name, id, **opts)
-    ROM::SQL::Type.new(ROM::Types.const_get(id).meta(name: name, **opts))
+    ROM::SQL::Attribute.new(ROM::Types.const_get(id).meta(name: name, **opts))
   end
 end