rom-sql 0.6.1 → 0.7.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 092d7392edf6c7ee3ab5ae94c46642226cc9fe9c
-  data.tar.gz: 53c8bcf25ba8f8855b06e8e9f17e26c06c2ec359
+  metadata.gz: 46efc98cee0cbb717be8ea7e8be52c08a488957c
+  data.tar.gz: 7b170fa8ac4f6c827c0feb6bd66e475322d28606
 SHA512:
-  metadata.gz: 07fd1f32d6a6d81068434ed420be539ab0a6781b24cb1601dbffc9c3620d29b2b02201f90cb121f4d33afd03e91faa8f07c47e687af2ff45a9ef57e3d889a749
-  data.tar.gz: 4176a62ba46b000a5248a76cb06e355440e46532c9050199533add0e9c4a3009d56c9e5a137edc70c402ea2a092c68fdc81de2f6f00f817194beb300289447df
+  metadata.gz: 3b2af71d8e33ab121d77365e7c743fa33817ea24daa67f2c87a3b4f1610a97c601482e0147ea77e3bb21fde6180c1e8c21c693f3e0ba9bc0eed0ad7d0221133a
+  data.tar.gz: 3eb3431b48c7739ffdbaf40cbc4a4ed33cef80ddcdfedfd0e3cc89928bb9dbdb4a194aef8626244aedaf7e56ceb952456cee3174660d2b36e48b8b75fccaad3c

data/.rubocop.yml

@@ -29,7 +29,7 @@ Style/AsciiComments:
   Enabled: false
 
 # Allow using braces for value-returning blocks
-Style/Blocks:
+Style/BlockDelimiters:
   Enabled: false
 
 # Documentation checked by Inch CI
@@ -53,10 +53,6 @@ Style/OpMethod:
   Exclude:
     - lib/rom/command_registry.rb
 
-# Even a single escaped slash can be confusing
-Style/RegexpLiteral:
-  MaxSlashes: 0
-
 # Don’t introduce semantic fail/raise distinction
 Style/SignalException:
   EnforcedStyle: only_raise

data/.rubocop_todo.yml

@@ -1,15 +1,21 @@
-# This configuration was generated by `rubocop --auto-gen-config`
-# on 2015-01-25 22:37:25 +0100 using RuboCop version 0.28.0.
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2015-09-26 17:45:40 +0200 using RuboCop version 0.34.2.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 3
+# Offense count: 4
 Metrics/AbcSize:
-  Max: 20
+  Max: 23
 
-# Offense count: 2
+# Offense count: 17
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 118
+
+# Offense count: 5
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 14
+  Max: 17

data/.travis.yml

@@ -3,14 +3,14 @@ sudo: false
 cache: bundler
 bundler_args: --without yard guard benchmarks tools
 before_script:
-  - psql -c 'create database rom;' -U postgres
+  - psql -c 'create database rom_sql;' -U postgres
 script: "bundle exec rake ci"
 rvm:
   - 2.0
   - 2.1
   - 2.2
   - rbx-2
-  - jruby
+  - jruby-9000
   - jruby-head
   - ruby-head
 env:
@@ -19,6 +19,7 @@ env:
     - JRUBY_OPTS='--dev -J-Xmx1024M'
 matrix:
   allow_failures:
+    - rvm: jruby-9000
     - rvm: ruby-head
     - rvm: jruby-head
 notifications:

data/CHANGELOG.md

@@ -1,3 +1,30 @@
+## v0.7.0 to-be-released
+
+### Added
+
+* Repository plugins have been imported:
+  * `view` allows defining a relation view with an explicit header (solnic)
+  * `base_view` defines a base view with all column names as the header (solnic)
+  * `auto_combine` defines a generic `for_combine` method which eager-loads
+    parent/children relation (solnic)
+  * `auto-wrap` defines a generic `for_wrap` method which inner-joins
+    a parent/children relation (solnic)
+* Possibility to check for pending migrations (gotar)
+* `Relation#sum` interface (gotar)
+* `Relation#avg` interface (gotar)
+* `Relation#min` interface (gotar)
+* `Relation#max` interface (gotar)
+* `Relation#union` interface (spscream)
+* `primary_key` macro which allows setting a custom primary key when it cannot be
+   inferred automatically (solnic)
+
+### Changed
+
+* `ROM::SQL.gateway` renamed to `ROM::SQL::Gateway.instance` for migrations (endash)
+* Association macros are now an optional plugin (solnic)
+
+[Compare v0.6.1...HEAD](https://github.com/rom-rb/rom-sql/compare/v0.6.1...HEAD)
+
 ## v0.6.1 2015-09-23
 
 ### Added

data/Gemfile

@@ -5,6 +5,7 @@ gemspec
 group :test do
   gem 'byebug', platforms: :mri
   gem 'anima', '~> 0.2.0'
+  gem 'transproc', github: 'solnic/transproc', branch: 'master'
   gem 'rom', github: 'rom-rb/rom', branch: 'master'
   gem 'rom-support', github: 'rom-rb/rom-support', branch: 'master'
   gem 'rom-mapper', github: 'rom-rb/rom-mapper', branch: 'master'

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

@@ -0,0 +1,45 @@
+module ROM
+  module Plugins
+    module Relation
+      module SQL
+        module AutoCombine
+          # @api private
+          def self.included(klass)
+            super
+            klass.class_eval do
+              include(InstanceInterface)
+              extend(ClassInterface)
+            end
+          end
+
+          module ClassInterface
+            def inherited(klass)
+              super
+              klass.auto_curry :for_combine
+            end
+          end
+
+          module InstanceInterface
+            # Default methods for fetching combined relation
+            #
+            # This method is used by default by `combine`
+            #
+            # @return [SQL::Relation]
+            #
+            # @api private
+            def for_combine(keys, relation)
+              pk, fk = keys.to_a.flatten
+              where(fk => relation.map { |tuple| tuple[pk] })
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+ROM.plugins do
+  adapter :sql do
+    register :auto_combine, ROM::Plugins::Relation::SQL::AutoCombine, type: :relation
+  end
+end

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

@@ -0,0 +1,48 @@
+module ROM
+  module Plugins
+    module Relation
+      module SQL
+        module AutoWrap
+          # @api private
+          def self.included(klass)
+            super
+            klass.class_eval do
+              include(InstanceInterface)
+              extend(ClassInterface)
+            end
+          end
+
+          module ClassInterface
+            def inherited(klass)
+              super
+              klass.auto_curry :for_wrap
+            end
+          end
+
+          module InstanceInterface
+            # Default methods for fetching wrapped relation
+            #
+            # This method is used by default by `wrap` and `wrap_parents`
+            #
+            # @return [SQL::Relation]
+            #
+            # @api private
+            def for_wrap(keys, name)
+              other = __registry__[name]
+
+              inner_join(name, keys)
+                .select(*qualified.header.columns)
+                .select_append(*other.prefix(other.name).qualified.header)
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+ROM.plugins do
+  adapter :sql do
+    register :auto_wrap, ROM::Plugins::Relation::SQL::AutoWrap, type: :relation
+  end
+end

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

@@ -0,0 +1,31 @@
+module ROM
+  module Plugins
+    module Relation
+      module SQL
+        module BaseView
+          # @api private
+          def self.included(klass)
+            super
+            klass.extend(ClassInterface)
+          end
+
+          module ClassInterface
+            def inherited(klass)
+              super
+              klass.view(:base) do
+                header { dataset.columns }
+                relation { select(*attributes(:base)).order(primary_key) }
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+ROM.plugins do
+  adapter :sql do
+    register :base_view, ROM::Plugins::Relation::SQL::BaseView, type: :relation
+  end
+end

data/lib/rom/sql.rb

@@ -1,16 +1,23 @@
-require "sequel"
-require "rom"
+require 'dry-equalizer'
+require 'sequel'
+require 'rom'
 
-require "rom/sql/version"
-require "rom/sql/errors"
-require "rom/sql/plugins"
-require "rom/sql/relation"
-require "rom/sql/gateway"
-require "rom/sql/migration"
+module ROM
+  MissingConfigurationError = Class.new(StandardError)
+end
+
+require 'rom/configuration_dsl'
+
+require 'rom/sql/version'
+require 'rom/sql/errors'
+require 'rom/sql/plugins'
+require 'rom/sql/relation'
+require 'rom/sql/gateway'
+require 'rom/sql/migration'
 
 if defined?(Rails)
-  require "rom/sql/support/active_support_notifications"
-  require "rom/sql/support/rails_log_subscriber"
+  require 'rom/sql/support/active_support_notifications'
+  require 'rom/sql/support/rails_log_subscriber'
 end
 
 ROM.register_adapter(:sql, ROM::SQL)

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

@@ -14,7 +14,7 @@ module ROM
           raise ERROR_MAP[e.class], e
         end
 
-        alias :[] :call
+        alias_method :[], :call
       end
     end
   end

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

@@ -13,7 +13,7 @@ module ROM
       class Update < ROM::Commands::Update
         adapter :sql
 
-        include Deprecations
+        extend Deprecations
 
         include Transaction
         include ErrorWrapper

data/lib/rom/sql/gateway.rb

@@ -19,6 +19,10 @@ module ROM
       include Options
       include Migration
 
+      class << self
+        attr_accessor :instance
+      end
+
       # Return optionally configured logger
       #
       # @return [Object] logger
@@ -63,13 +67,15 @@ module ROM
       # @api public
       def initialize(uri, options = {})
         repo_options = self.class.option_definitions.names
-        conn_options = options.reject { |k,_| repo_options.include?(k) }
+        conn_options = options.reject { |k, _| repo_options.include?(k) }
 
         @connection = connect(uri, conn_options)
         @schema = connection.tables
         add_extensions(Array(options[:extensions])) if options[:extensions]
 
-        super(uri, options.reject { |k,_| conn_options.keys.include?(k) })
+        super(uri, options.reject { |k, _| conn_options.keys.include?(k) })
+
+        self.class.instance = self
       end
 
       # Disconnect from database

data/lib/rom/sql/header.rb

@@ -2,7 +2,7 @@ module ROM
   module SQL
     # @private
     class Header
-      include Equalizer.new(:columns, :table)
+      include Dry::Equalizer(:columns, :table)
 
       attr_reader :columns, :table
 

data/lib/rom/sql/migration.rb

@@ -2,7 +2,8 @@ require 'rom/sql/migration/migrator'
 
 module ROM
   module SQL
-    # Create a database migration for a specific gateway
+    # Trap for the migration runner. To create a migration
+    # on a specific gateway, use ROM::SQL::Gateway#migration
     #
     # @example
     #   ROM.setup(
@@ -21,26 +22,9 @@ module ROM
     #     end
     #   end
     #
-    #   # for a non-default gateway
-    #   ROM::SQL.migration(:other) do
-    #     # ...
-    #   end
-    #
     # @api public
-    def self.migration(gateway = :default, &block)
-      gateways = ROM.boot ? ROM.boot.gateways : ROM.env.gateways
-      gateways[gateway].migration(&block)
-    end
-
-    # Return first sql gateway for migrations
-    #
-    # This is used by migration tasks, they only support a single sql gateway
-    #
-    # @api private
-    def self.gateway
-      ROM.gateways
-        .keys
-        .detect { |gateway| gateway.instance_of?(Gateway) }
+    def self.migration(&block)
+      ROM::SQL::Gateway.instance.migration(&block)
     end
 
     module Migration
@@ -55,6 +39,13 @@ module ROM
         end
       end
 
+      # @see ROM::SQL::Migration.pending?
+      #
+      # @api public
+      def pending_migrations?
+        migrator.pending?
+      end
+
       # @see ROM::SQL.migration
       #
       # @api public

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

@@ -20,6 +20,10 @@ module ROM
           Sequel::Migrator.run(connection, path.to_s, options)
         end
 
+        def pending?
+          !Sequel::Migrator.is_current?(connection, path.to_s)
+        end
+
         def migration(&block)
           Sequel.migration(&block)
         end

data/lib/rom/sql/{relation/associations.rb → plugin/assoc_macros.rb}

@@ -1,7 +1,22 @@
+require 'rom/sql/plugin/assoc_macros/class_interface'
+
 module ROM
   module SQL
-    class Relation < ROM::Relation
-      module Associations
+    module Plugin
+      module AssocMacros
+        # Extends a relation class with assoc-macros and instance-level methods
+        #
+        # @api private
+        def self.included(relation)
+          super
+          relation.extend(ClassInterface)
+        end
+
+        # @api private
+        def model
+          self.class.model
+        end
+
         # Join configured association.
         #
         # Uses INNER JOIN type.

data/lib/rom/sql/plugin/assoc_macros/class_interface.rb

@@ -0,0 +1,128 @@
+module ROM
+  module SQL
+    module Plugin
+      module AssocMacros
+        # Class DSL for SQL relations
+        #
+        # @api private
+        module ClassInterface
+          # @api private
+          def self.prepare(klass)
+            klass.class_eval do
+              class << self
+                attr_reader :model, :associations
+              end
+            end
+            klass.instance_variable_set('@model', Class.new(Sequel::Model))
+            klass.instance_variable_set('@associations', [])
+          end
+
+          # @api private
+          def self.extended(klass)
+            prepare(klass)
+          end
+
+          # Set up model and association ivars for descendant class
+          #
+          # @api private
+          def inherited(klass)
+            super
+            ClassInterface.prepare(klass)
+          end
+
+          # Set up a one-to-many association
+          #
+          # @example
+          #   class Users < ROM::Relation[:sql]
+          #     one_to_many :tasks, key: :user_id
+          #
+          #     def with_tasks
+          #       association_join(:tasks)
+          #     end
+          #   end
+          #
+          # @param [Symbol] name The name of the association
+          # @param [Hash] options The options hash
+          # @option options [Symbol] :key Name of the key to join on
+          # @option options [Hash] :on Additional conditions for join
+          # @option options [Hash] :conditions Additional conditions for WHERE
+          #
+          # @api public
+          def one_to_many(name, options)
+            associations << [__method__, name, { relation: name }.merge(options)]
+          end
+
+          # Set up a many-to-many association
+          #
+          # @example
+          #   class Tasks < ROM::Relation[:sql]
+          #     many_to_many :tags,
+          #       join_table: :task_tags,
+          #       left_key: :task_id,
+          #       right_key: :tag_id,
+          #
+          #     def with_tags
+          #       association_join(:tags)
+          #     end
+          #   end
+          #
+          # @param [Symbol] name The name of the association
+          # @param [Hash] options The options hash
+          # @option options [Symbol] :join_table Name of the join table
+          # @option options [Hash] :left_key Name of the left join key
+          # @option options [Hash] :right_key Name of the right join key
+          # @option options [Hash] :on Additional conditions for join
+          # @option options [Hash] :conditions Additional conditions for WHERE
+          #
+          # @api public
+          def many_to_many(name, options = {})
+            associations << [__method__, name, { relation: name }.merge(options)]
+          end
+
+          # Set up a many-to-one association
+          #
+          # @example
+          #   class Tasks < ROM::Relation[:sql]
+          #     many_to_one :users, key: :user_id
+          #
+          #     def with_users
+          #       association_join(:users)
+          #     end
+          #   end
+          #
+          # @param [Symbol] name The name of the association
+          # @param [Hash] options The options hash
+          # @option options [Symbol] :join_table Name of the join table
+          # @option options [Hash] :key Name of the join key
+          # @option options [Hash] :on Additional conditions for join
+          # @option options [Hash] :conditions Additional conditions for WHERE
+          #
+          # @api public
+          def many_to_one(name, options = {})
+            associations << [__method__, name, { relation: name }.merge(options)]
+          end
+
+          # Finalize the relation by setting up its associations (if any)
+          #
+          # @api private
+          def finalize(relations, relation)
+            return unless relation.dataset.db.table_exists?(dataset)
+
+            model.set_dataset(relation.dataset)
+            model.dataset.naked!
+
+            associations.each do |*args, assoc_opts|
+              options = Hash[assoc_opts]
+              other = relations[options.delete(:relation) || args[1]].model
+              model.public_send(*args, options.merge(class: other))
+            end
+
+            model.freeze
+
+            super
+          end
+        end
+      end
+    end
+  end
+end